propublica-nonprofit-explorer-sdk/dist/models/organization.d.ts

SDK for ProPublica Nonprofit Explorer API

import { z } from 'zod';
export declare const OrganizationSchema: z.ZodObject<{
    id: z.ZodNumber;
    ein: z.ZodNumber;
    name: z.ZodString;
    careofname: z.ZodNullable<z.ZodString>;
    address: z.ZodNullable<z.ZodString>;
    city: z.ZodNullable<z.ZodString>;
    state: z.ZodNullable<z.ZodString>;
    zipcode: z.ZodNullable<z.ZodString>;
    exemption_number: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
    subsection_code: z.ZodNullable<z.ZodNumber>;
    affiliation_code: z.ZodNullable<z.ZodNumber>;
    classification_codes: z.ZodNullable<z.ZodOptional<z.ZodString>>;
    ruling_date: z.ZodNullable<z.ZodOptional<z.ZodString>>;
    deductibility_code: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
    foundation_code: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
    activity_codes: z.ZodNullable<z.ZodOptional<z.ZodString>>;
    organization_code: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
    exempt_organization_status_code: z.ZodNullable<z.ZodNumber>;
    tax_period: z.ZodNullable<z.ZodString>;
    asset_code: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
    income_code: z.ZodNullable<z.ZodNumber>;
    filing_requirement_code: z.ZodNullable<z.ZodNumber>;
    pf_filing_requirement_code: z.ZodNullable<z.ZodNumber>;
    accounting_period: z.ZodNullable<z.ZodNumber>;
    asset_amount: z.ZodNullable<z.ZodNumber>;
    income_amount: z.ZodNullable<z.ZodNumber>;
    revenue_amount: z.ZodNullable<z.ZodNumber>;
    ntee_code: z.ZodNullable<z.ZodString>;
    sort_name: z.ZodNullable<z.ZodString>;
    created_at: z.ZodNullable<z.ZodCoercedDate<unknown>>;
    updated_at: z.ZodNullable<z.ZodCoercedDate<unknown>>;
    data_source: z.ZodNullable<z.ZodString>;
    have_extracts: z.ZodNullable<z.ZodBoolean>;
    have_pdfs: z.ZodNullable<z.ZodBoolean>;
    latest_object_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
}, z.core.$strip>;
/**
 * Organization object
 */
export type IOrganization = z.infer<typeof OrganizationSchema>;
export declare const OrganizationResponseSchema: z.ZodObject<{
    organization: z.ZodObject<{
        id: z.ZodNumber;
        ein: z.ZodNumber;
        name: z.ZodString;
        careofname: z.ZodNullable<z.ZodString>;
        address: z.ZodNullable<z.ZodString>;
        city: z.ZodNullable<z.ZodString>;
        state: z.ZodNullable<z.ZodString>;
        zipcode: z.ZodNullable<z.ZodString>;
        exemption_number: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
        subsection_code: z.ZodNullable<z.ZodNumber>;
        affiliation_code: z.ZodNullable<z.ZodNumber>;
        classification_codes: z.ZodNullable<z.ZodOptional<z.ZodString>>;
        ruling_date: z.ZodNullable<z.ZodOptional<z.ZodString>>;
        deductibility_code: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
        foundation_code: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
        activity_codes: z.ZodNullable<z.ZodOptional<z.ZodString>>;
        organization_code: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
        exempt_organization_status_code: z.ZodNullable<z.ZodNumber>;
        tax_period: z.ZodNullable<z.ZodString>;
        asset_code: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
        income_code: z.ZodNullable<z.ZodNumber>;
        filing_requirement_code: z.ZodNullable<z.ZodNumber>;
        pf_filing_requirement_code: z.ZodNullable<z.ZodNumber>;
        accounting_period: z.ZodNullable<z.ZodNumber>;
        asset_amount: z.ZodNullable<z.ZodNumber>;
        income_amount: z.ZodNullable<z.ZodNumber>;
        revenue_amount: z.ZodNullable<z.ZodNumber>;
        ntee_code: z.ZodNullable<z.ZodString>;
        sort_name: z.ZodNullable<z.ZodString>;
        created_at: z.ZodNullable<z.ZodCoercedDate<unknown>>;
        updated_at: z.ZodNullable<z.ZodCoercedDate<unknown>>;
        data_source: z.ZodNullable<z.ZodString>;
        have_extracts: z.ZodNullable<z.ZodBoolean>;
        have_pdfs: z.ZodNullable<z.ZodBoolean>;
        latest_object_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
    }, z.core.$strip>;
    data_source: z.ZodString;
    api_version: z.ZodNumber;
    filings_with_data: z.ZodArray<z.ZodObject<{
        ein: z.ZodOptional<z.ZodNumber>;
        tax_prd: z.ZodNumber;
        tax_prd_yr: z.ZodNumber;
        formtype: z.ZodEnum<{
            '990': number;
            '990_EZ': number;
            '990_PF': number;
        }>;
        formtype_str: z.ZodOptional<z.ZodString>;
        pdf_url: z.ZodNullable<z.ZodString>;
        updated: z.ZodOptional<z.ZodCoercedDate<unknown>>;
        subseccd: z.ZodOptional<z.ZodNumber>;
        totrevenue: z.ZodOptional<z.ZodNumber>;
        totfuncexpns: z.ZodOptional<z.ZodNumber>;
        totassetsend: z.ZodOptional<z.ZodNumber>;
        totliabend: z.ZodOptional<z.ZodNumber>;
        pct_compnsatncurrofcr: z.ZodOptional<z.ZodNumber>;
        tax_pd: z.ZodOptional<z.ZodNullable<z.ZodString>>;
        unrelbusinccd: z.ZodOptional<z.ZodString>;
        initiationfees: z.ZodOptional<z.ZodNumber>;
        grsrcptspublicuse: z.ZodOptional<z.ZodNumber>;
        grsincmembers: z.ZodOptional<z.ZodNumber>;
        grsincother: z.ZodOptional<z.ZodNumber>;
        totcntrbgfts: z.ZodOptional<z.ZodNumber>;
        totprgmrevnue: z.ZodOptional<z.ZodNumber>;
        invstmntinc: z.ZodOptional<z.ZodNumber>;
        txexmptbndsproceeds: z.ZodOptional<z.ZodNumber>;
        royaltsinc: z.ZodOptional<z.ZodNumber>;
        grsrntsreal: z.ZodOptional<z.ZodNumber>;
        grsrntsprsnl: z.ZodOptional<z.ZodNumber>;
        rntlexpnsreal: z.ZodOptional<z.ZodNumber>;
        rntlexpnsprsnl: z.ZodOptional<z.ZodNumber>;
        rntlincreal: z.ZodOptional<z.ZodNumber>;
        rntlincprsnl: z.ZodOptional<z.ZodNumber>;
        netrntlinc: z.ZodOptional<z.ZodNumber>;
        grsalesecur: z.ZodOptional<z.ZodNumber>;
        grsalesothr: z.ZodOptional<z.ZodNumber>;
        cstbasisecur: z.ZodOptional<z.ZodNumber>;
        cstbasisothr: z.ZodOptional<z.ZodNumber>;
        gnlsecur: z.ZodOptional<z.ZodNumber>;
        gnlsothr: z.ZodOptional<z.ZodNumber>;
        netgnls: z.ZodOptional<z.ZodNumber>;
        grsincfndrsng: z.ZodOptional<z.ZodNumber>;
        lessdirfndrsng: z.ZodOptional<z.ZodNumber>;
        netincfndrsng: z.ZodOptional<z.ZodNumber>;
        grsincgaming: z.ZodOptional<z.ZodNumber>;
        lessdirgaming: z.ZodOptional<z.ZodNumber>;
        netincgaming: z.ZodOptional<z.ZodNumber>;
        grsalesinvent: z.ZodOptional<z.ZodNumber>;
        lesscstofgoods: z.ZodOptional<z.ZodNumber>;
        netincsales: z.ZodOptional<z.ZodNumber>;
        miscrevtot11e: z.ZodOptional<z.ZodNumber>;
        compnsatncurrofcr: z.ZodOptional<z.ZodNumber>;
        othrsalwages: z.ZodOptional<z.ZodNumber>;
        payrolltx: z.ZodOptional<z.ZodNumber>;
        profndraising: z.ZodOptional<z.ZodNumber>;
        txexmptbndsend: z.ZodOptional<z.ZodNumber>;
        secrdmrtgsend: z.ZodOptional<z.ZodNumber>;
        unsecurednotesend: z.ZodOptional<z.ZodNumber>;
        retainedearnend: z.ZodOptional<z.ZodNumber>;
        totnetassetend: z.ZodOptional<z.ZodNumber>;
        nonpfrea: z.ZodOptional<z.ZodString>;
        gftgrntsrcvd170: z.ZodOptional<z.ZodNumber>;
        txrevnuelevied170: z.ZodOptional<z.ZodNumber>;
        srvcsval170: z.ZodOptional<z.ZodNumber>;
        grsinc170: z.ZodOptional<z.ZodNumber>;
        grsrcptsrelated170: z.ZodOptional<z.ZodNumber>;
        totgftgrntrcvd509: z.ZodOptional<z.ZodNumber>;
        grsrcptsadmissn509: z.ZodOptional<z.ZodNumber>;
        txrevnuelevied509: z.ZodOptional<z.ZodNumber>;
        srvcsval509: z.ZodOptional<z.ZodNumber>;
        subtotsuppinc509: z.ZodOptional<z.ZodNumber>;
        totsupp509: z.ZodOptional<z.ZodNumber>;
    }, z.core.$strip>>;
    filings_without_data: z.ZodArray<z.ZodObject<{
        ein: z.ZodOptional<z.ZodNumber>;
        tax_prd: z.ZodNumber;
        tax_prd_yr: z.ZodNumber;
        formtype: z.ZodEnum<{
            '990': number;
            '990_EZ': number;
            '990_PF': number;
        }>;
        formtype_str: z.ZodOptional<z.ZodString>;
        pdf_url: z.ZodNullable<z.ZodString>;
        updated: z.ZodOptional<z.ZodCoercedDate<unknown>>;
        subseccd: z.ZodOptional<z.ZodNumber>;
        totrevenue: z.ZodOptional<z.ZodNumber>;
        totfuncexpns: z.ZodOptional<z.ZodNumber>;
        totassetsend: z.ZodOptional<z.ZodNumber>;
        totliabend: z.ZodOptional<z.ZodNumber>;
        pct_compnsatncurrofcr: z.ZodOptional<z.ZodNumber>;
        tax_pd: z.ZodOptional<z.ZodNullable<z.ZodString>>;
        unrelbusinccd: z.ZodOptional<z.ZodString>;
        initiationfees: z.ZodOptional<z.ZodNumber>;
        grsrcptspublicuse: z.ZodOptional<z.ZodNumber>;
        grsincmembers: z.ZodOptional<z.ZodNumber>;
        grsincother: z.ZodOptional<z.ZodNumber>;
        totcntrbgfts: z.ZodOptional<z.ZodNumber>;
        totprgmrevnue: z.ZodOptional<z.ZodNumber>;
        invstmntinc: z.ZodOptional<z.ZodNumber>;
        txexmptbndsproceeds: z.ZodOptional<z.ZodNumber>;
        royaltsinc: z.ZodOptional<z.ZodNumber>;
        grsrntsreal: z.ZodOptional<z.ZodNumber>;
        grsrntsprsnl: z.ZodOptional<z.ZodNumber>;
        rntlexpnsreal: z.ZodOptional<z.ZodNumber>;
        rntlexpnsprsnl: z.ZodOptional<z.ZodNumber>;
        rntlincreal: z.ZodOptional<z.ZodNumber>;
        rntlincprsnl: z.ZodOptional<z.ZodNumber>;
        netrntlinc: z.ZodOptional<z.ZodNumber>;
        grsalesecur: z.ZodOptional<z.ZodNumber>;
        grsalesothr: z.ZodOptional<z.ZodNumber>;
        cstbasisecur: z.ZodOptional<z.ZodNumber>;
        cstbasisothr: z.ZodOptional<z.ZodNumber>;
        gnlsecur: z.ZodOptional<z.ZodNumber>;
        gnlsothr: z.ZodOptional<z.ZodNumber>;
        netgnls: z.ZodOptional<z.ZodNumber>;
        grsincfndrsng: z.ZodOptional<z.ZodNumber>;
        lessdirfndrsng: z.ZodOptional<z.ZodNumber>;
        netincfndrsng: z.ZodOptional<z.ZodNumber>;
        grsincgaming: z.ZodOptional<z.ZodNumber>;
        lessdirgaming: z.ZodOptional<z.ZodNumber>;
        netincgaming: z.ZodOptional<z.ZodNumber>;
        grsalesinvent: z.ZodOptional<z.ZodNumber>;
        lesscstofgoods: z.ZodOptional<z.ZodNumber>;
        netincsales: z.ZodOptional<z.ZodNumber>;
        miscrevtot11e: z.ZodOptional<z.ZodNumber>;
        compnsatncurrofcr: z.ZodOptional<z.ZodNumber>;
        othrsalwages: z.ZodOptional<z.ZodNumber>;
        payrolltx: z.ZodOptional<z.ZodNumber>;
        profndraising: z.ZodOptional<z.ZodNumber>;
        txexmptbndsend: z.ZodOptional<z.ZodNumber>;
        secrdmrtgsend: z.ZodOptional<z.ZodNumber>;
        unsecurednotesend: z.ZodOptional<z.ZodNumber>;
        retainedearnend: z.ZodOptional<z.ZodNumber>;
        totnetassetend: z.ZodOptional<z.ZodNumber>;
        nonpfrea: z.ZodOptional<z.ZodString>;
        gftgrntsrcvd170: z.ZodOptional<z.ZodNumber>;
        txrevnuelevied170: z.ZodOptional<z.ZodNumber>;
        srvcsval170: z.ZodOptional<z.ZodNumber>;
        grsinc170: z.ZodOptional<z.ZodNumber>;
        grsrcptsrelated170: z.ZodOptional<z.ZodNumber>;
        totgftgrntrcvd509: z.ZodOptional<z.ZodNumber>;
        grsrcptsadmissn509: z.ZodOptional<z.ZodNumber>;
        txrevnuelevied509: z.ZodOptional<z.ZodNumber>;
        srvcsval509: z.ZodOptional<z.ZodNumber>;
        subtotsuppinc509: z.ZodOptional<z.ZodNumber>;
        totsupp509: z.ZodOptional<z.ZodNumber>;
    }, z.core.$strip>>;
}, z.core.$strip>;
/**
 * Organization response object
 */
export type IOrganizationResponse = z.infer<typeof OrganizationResponseSchema>;
export declare function validateOrganizationResponse(response: IOrganizationResponse): IOrganizationResponse;