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.
accounting:writeGrant 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 currencycharged_on(optional, date Y-m-d): the date on the card or bank statementaccount_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
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.