Skip to main content

Refresh Balance Charge

POST 

/api/amazon/unified/financial-event-groups/:financialEventGroup/balance-charge/refresh

Look again for the charge that settled a negative settlement. When a settlement closes negative, Amazon charges the seller's card or bank instead of paying out, and the next settlement records it as "Payable to Amazon" and "Successful charge". This links the settlement to that later settlement and searches the Xero bank-transaction mirror for the card/bank line: money spent (SPEND) in the default currency, from 1 day before to 10 days after the charge date, within 6% of the converted balance, on the account set as "negative balances charged to" (or with an Amazon payee on any account when none is set). The closest unique amount wins; a line already claimed by another settlement is skipped. When the settlement has no exchange rate of its own, the rate is taken from the charge.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The settlement's accounting documents then book the difference between the card amount and the settlement's conversion to FX Realized Gain/Loss, so they net to exactly the card line. A charge entered by hand is never replaced (clear it first). Also runs nightly for every negative settlement.

Requires the integrations.sync permission.

The response is the settlement with its balance_charge block: whether Amazon charged the negative balance (is_charged), the later settlement that recorded it (charged_in_financial_event_group_id, charged_amount in the settlement currency, charged_on), the settlement's own conversion (converted_net_amount), what actually left the card or bank in the default currency (base_amount, charge_date, account_name, source = xero_bank_transaction or manual, reference = the Xero BankTransactionID), and the realized FX between the two (fx_difference: positive = loss, negative = gain). needs_fx_mapping is true when there is a difference but no FX Realized Gain/Loss nominal code is mapped, so nothing is booked. balance_charge is null for a settlement that did not close negative.

Request​

Responses​

OK

Response Headers
    Content-Type