Skip to main content

Delete Balance Charge

DELETE 

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

Forget a negative settlement's recorded charge (matched or entered by hand) and immediately look for it again, as Refresh Balance Charge does.

Required scope: accounting:write

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

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