@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Interface GetAccountFinancialsSuccess

    Financial data retrieved successfully

    interface GetAccountFinancialsSuccess {
        account: AccountReference;
        currency: string;
        period: DateRange;
        timezone: string;
        spend?: { total_spend: number; media_buy_count?: number };
        credit?: {
            credit_limit: number;
            available_credit: number;
            utilization_percent?: number;
        };
        balance?: {
            available: number;
            last_top_up?: { amount: number; date: string };
        };
        payment_status?: "suspended"
        | "current"
        | "past_due";
        payment_terms?: PaymentTerms;
        invoices?: {
            invoice_id: string;
            period?: DateRange;
            amount: number;
            status: "draft" | "past_due" | "issued" | "paid" | "void";
            due_date?: string;
            paid_date?: string;
        }[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    account currency period timezone spend? credit? balance? payment_status? payment_terms? invoices? context? ext?

    Properties

    account: AccountReference
    currency: string

    ISO 4217 currency code for all monetary amounts in this response

    ^[A-Z]{3}$

    period: DateRange
    timezone: string

    IANA timezone of the seller's billing day boundaries (e.g., 'America/New_York'). All dates in this response — period, invoice periods, due dates — are calendar dates in this timezone. This may differ from Account.timezone or a feature-specific cap/reporting timezone when the upstream platform uses distinct clocks; buyers MUST use this value for financial periods rather than infer equality.

    spend?: { total_spend: number; media_buy_count?: number }

    Spend summary for the period

    Type Declaration

    • total_spend: number

      Total spend in the period, in currency

      0

    • Optionalmedia_buy_count?: number

      Number of active media buys in the period

      0

    credit?: {
        credit_limit: number;
        available_credit: number;
        utilization_percent?: number;
    }

    Credit status. Present for credit-based accounts (payment_terms like net_30).

    Type Declaration

    • credit_limit: number

      Maximum outstanding balance allowed

      0

    • available_credit: number

      Remaining credit available (credit_limit minus outstanding balance)

    • Optionalutilization_percent?: number

      Credit utilization as a percentage (0-100)

      0

      100

    balance?: { available: number; last_top_up?: { amount: number; date: string } }

    Prepay balance. Present for prepay accounts.

    Type Declaration

    • available: number

      Remaining prepaid balance

      0

    • Optionallast_top_up?: { amount: number; date: string }

      Most recent balance top-up

      • amount: number

        Top-up amount

        0

      • date: string

        Date of top-up

        date

    payment_status?: "suspended" | "current" | "past_due"

    Overall payment status. current: all obligations met. past_due: one or more invoices overdue. suspended: account suspended due to payment issues.

    payment_terms?: PaymentTerms
    invoices?: {
        invoice_id: string;
        period?: DateRange;
        amount: number;
        status: "draft" | "past_due" | "issued" | "paid" | "void";
        due_date?: string;
        paid_date?: string;
    }[]

    Recent invoices. Sellers may limit the number returned.

    Type Declaration

    • invoice_id: string

      Seller-assigned invoice identifier

    • Optionalperiod?: DateRange
    • amount: number

      Invoice total in currency

      0

    • status: "draft" | "past_due" | "issued" | "paid" | "void"

      Invoice status

    • Optionaldue_date?: string

      Payment due date

      date

    • Optionalpaid_date?: string

      Date payment was received. Present when status is 'paid'.

      date

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties