Get Payment Type Bank Accounts
GET/api/payment-types/accounting-accounts
List the connected accounting system's bank accounts a payment type can be mapped to (Xero BANK accounts, or QuickBooks bank and credit card accounts), and whether supplier payments need that mapping.
settings:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Response fields:
- provider:
xero,qbo, or null when no accounting system is connected - provider_name: display name of the provider, or null
- requires_mapping: true when supplier payments push to the provider, so a payment type without a bank account is refused
- sync_start_date: payments dated before this (Y-m-d) never sync and need no bank account; null when unset
- accounts: id, name and code of each active account; pass an id as accounting_integration_id when creating or updating a payment type
Request
Responses
- 200
- 401
- 403
- 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.
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.