Type Alias ReportingObligation

Type Declaration

• reporting_obligation_id: string

• delivery_config_id: string

• delivery_config_version: number

• report_definition_id: string

• feed_purpose: ReportingFeedPurpose

• reporting_profile: string

• account_id: string

• media_buy_ids: ReportingMediaBuyID[]

  Exact frozen media-buy denominator resolved for this period, including buys with zero rows. An empty array is the definitive zero-buy set; omission is never used to mean all, empty, or unknown.

• scope_resolved_at: string

  Instant at which the configured scope was resolved and frozen for this obligation. For all_media_buys, include every caller-authorized account media buy whose effective flight overlaps the half-open period and was known by this cutoff. Later-created or backdated buys do not rewrite this obligation.

• coverage: ReportingCoverage

• period: { start: string; end: string; source_timezone: string }

• expected_at: string

• schedule: ReportingSchedule

• Optionaldestination_ref?: string

  Immutable caller-owned destination generation selected by this account-authorized obligation. The account/configuration join—not possession of this reusable reference—authorizes disclosure. Present when and only when the obligation’s configuration selects a managed-delivery offering; Core (API-delivered) obligations omit every destination and materialization field.

• required_finality: ReportingFinality

• reconciliation_mode: ReportingReconciliationMode

• reconciliation_status: "not_required" | "pending" | "accepted" | "rejected"

  Consumer agreement state for the current required revision. A later superseding revision returns a receipt-required obligation to pending until that revision is accepted.

• health: ReportingHealth

• production_status: "not_due" | "pending" | "published" | "failed"

  Whether any revision has been produced for this obligation. published includes zero-row revisions.

• revision_count: number

  Number of revision records for this obligation in the consistent ledger snapshot.

• Optionalconsumer_status_count?: number

  Complete number of immutable authenticated consumer status statements associated with this obligation in the ledger snapshot, whether originally joined by reporting_obligation_id or by the exact configuration-generation, report-definition, and period key before the obligation existed. Core status-sync history is counted independently from Reconciled Billing receipts.

• Optionalcurrent_consumer_status_id?: string

  Current unsuperseded consumer status statement associated with this obligation by seller ID or its exact logical period key. Omitted when consumer_status_count is zero.

• Optionaladjustment_count?: number

  Number of immutable post-official reporting adjustment records for this obligation in the consistent ledger snapshot.

• Optionalmaterialization_count?: number

  Number of materialization records for this obligation's revisions in the consistent ledger snapshot. Present iff the obligation is managed-delivery (destination_ref present).

• Optionalsuccessful_materialization_count?: number

  Number of available/delivered verified materializations in the consistent ledger snapshot. Present iff the obligation is managed-delivery (destination_ref present).

• Optionalreceipt_count?: number

  Complete number of authenticated receipts associated with this obligation in the ledger snapshot. Present iff reconciliation_mode is consumer_receipt.

• Optionalaccepted_receipt_count?: number

  Number of accepted receipts. At most one current accepted receipt per consumer and revision contributes to reconciliation_status. Present iff reconciliation_mode is consumer_receipt.

• Optionaladjustment_receipt_count?: number

  Number of authenticated receipts for adjustments targeting this obligation's official revision. Reconciled Billing only.

• Optionalaccepted_adjustment_receipt_count?: number

  Number of accepted adjustment receipts. Reconciled Billing buyers do not post an adjustment until their exact digest is accepted.

• Optionalpending_adjustment_count?: number

  Number of applicable adjustments without an accepted receipt. Reconciled Billing complete/healthy requires zero.

• issues: ReportingStatusIssue[]

• Optionalresource_retained_until?: string

  Minimum time through which at least one verified materialization for a completed obligation remains readable. Managed-delivery only; Core revisions are retained per status_retention_days and readable through the existing API transports.