Skip to main content

Get Inventory Reconciliation Opening Breakdown

GET 
/api/ledger/reconciliation/inventory/opening-breakdown

The opening reconciliation breakdown for inventory vs the accounting provider — a 3-way comparison per earmarked inventory control account at the opening date: the SKU inventory valuation (what the stock is worth), the internal ledger balance (what has been journaled), and the provider general-ledger balance (what has synced), plus the divergence between provider and valuation. The SKU valuation sums every valuation stream for the account: warehouse stock (standard and Amazon FBA inventory, broken down per warehouse) plus the account-level positions with no warehouse behind them — inventory in transit (including Amazon FC-to-FC and AWD-to-FBA stock in flight), Amazon AWD stock, prepaid purchases (invoiced but not yet received) and goods received not invoiced — so it ties to the Inventory Valuation report at the same date. The provider balance and divergence are reported at the account level, since a provider account has no warehouse dimension. Warehouses that currently hold no stock are still listed so an account's full warehouse footprint is visible; an account valued only by account-level streams returns an empty warehouse list with a non-zero valuation.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Every figure is an end-of-day position, so a window's opening is the close of the day before its first in-scope day. The opening date is the as_of parameter when given (a period opening passes the prior December 31); otherwise the day before the reconciliation baseline when one has been set, otherwise the day before the configured inventory start date. Reads materialized/cached data only — no live provider call.

Authentication: Requires Bearer token.

Query parameters:

  • connection_id (integer, required): accounting connection id.
  • as_of (date, optional): pin the opening to this day. Format: Y-m-d.

Response fields: as_of_date (the effective opening date, null when no accounts are earmarked or no opening date is configured), from_baseline (whether as_of_date came from a set baseline rather than the as_of parameter or the inventory start date), accounts[] — each with nominal_code_id, code, name, provider_account_name, sku_value (inventory valuation, the sum of its warehouses), sku_quantity, ledger_balance (the internal ledger balance at the same cutoff — every posting regardless of whether it has synced to the provider yet), provider_balance, divergence (provider_balance minus sku_value, null when no provider balance is available), point_as_of_date (the day the provider balance was measured — the earliest captured day on/after the opening), provider_captured_at (when the provider balance was last taken from the provider) and provider_source (xero_trial_balance = captured live from the provider's Trial Balance; xero_journals = rebuilt from the synced journal cache), and warehouses[] (warehouse_id, warehouse_name, is_fba, sku_value, sku_quantity). Each account also carries opening_adjustments[] — the standing reconciling adjustments dated after the opening that cover its gap (reversals already netted out), each with journal_entry_id, effective_date and signed amount — and their sum opening_adjustment_net. Each account also carries pending_ledger (unsynced activity dated on/before the opening that WILL sync — self-resolving lag) and excluded_ledger (activity that will never sync — the pre-baseline mismatch a baseline sets aside).

The three balances split the total opening gap into a posting gap (ledger_balance − sku_value: value the stock carries that was never journaled) and a sync gap (provider_balance − ledger_balance: postings that haven't reached the provider). Posting gap + sync gap = divergence.

Request​

Responses​

OK

Response Headers
    Content-Type