Skip to main content

Update Balance Charge

PUT 

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

Record by hand what a negative settlement's balance actually cost on the card or bank, in the default currency (for example when there is no Xero bank-transaction mirror, or the automatic match found nothing). A manual charge is final: the nightly search never replaces it.

Required scope: accounting:write

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

Body:

  • amount (required, number > 0): the amount that left the account, in the default currency
  • charged_on (optional, date Y-m-d): the date on the card or bank statement
  • account_name (optional, string, max 255): the card or bank account

Requires the integrations.update 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