Skip to main content

List Settlement Type Mapping Instances by Financial Code

GET 
/api/amazon/unified/settlement-type-mappings/instances

Returns the resolved settlement type mapping for a single financial code, per Amazon integration instance. Settlement type mappings map Amazon settlement fee/transaction types to nominal codes (and settlement mapping groups) used when generating accounting transactions; overrides are per-instance exceptions to the global mapping.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

One row is returned per instance with the EFFECTIVE values - the per-instance override when one exists, otherwise the global default:

  • integration_instance - {id, name} of the Amazon integration instance.
  • nominalCode - resolved nominal code {id, code, name} or null when unmapped.
  • mappingGroup - resolved settlement mapping group {id, name, document_type} (document_type is invoice or bill) or null.
  • is_override - true when the row comes from a per-instance override rather than the global mapping.
  • override_id - the override record ID (use it with DELETE .../overrides/:id), or null.

Query parameters:

  • financial_code (required, string).
  • integration_instance_ids[] (optional, array of integers) - limit to specific instances.

Request​

Responses​

OK

Response Headers
    Content-Type