Skip to main content

Update Accounting Mapping

POST 

/api/payment-types/accounting-mapping

Map each payment method to the accounting account its payments post through.

Required scope: settings:write

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

Authentication: Requires Bearer token.

Body fields:

  • payment_types (array, required, min 1) - the mappings to save.
  • payment_types[].id (integer, required) - the payment method to map.
  • payment_types[].accounting_integration_id (integer or null, required key) - the id of the connected provider's bank account to post to. Send null to clear the mapping. The key must be present even when null.

The account is resolved against the connected accounting provider, so the record type is never sent by the caller. All or nothing: an id that is not one of that provider's accounts rejects the whole request and nothing is saved. Returns 422 on an unknown payment method or account id.

Requires permission: payment_types.update

Request​

Responses​

OK

Response Headers
    Content-Type