Update Custom Field Mappings
PUT/api/qbo/custom-field-mappings
Updates the QBO invoice custom field mapping config. sales_rep (required) maps the Sales Order's sales rep, and po_number (optional) maps the Sales Order's customer_po_number.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
definition_id must be "1", "2", or "3" (QBO supports three legacy custom fields) and may be null when enabled is false.
custom_field_mappings.po_number.destination (optional) chooses where the PO number is written on the invoice:
custom_field— write it to the QBO legacy custom field named bydefinition_id. This is the default whendestinationis omitted, so mappings saved before the field existed keep their current behaviour.customer_memo— writePO# <customer_po_number>to the invoice's customer-facing memo (QBOCustomerMemo, shown as "Note to customer").definition_idis ignored and may be null, so this works even when all three QBO legacy custom fields are disabled in the company's sales-form preferences.
The memo is only written when the Sales Order actually has a customer_po_number — orders without one leave any existing memo untouched. Credit memos are unaffected; these mappings apply to invoices only.
Requires a Bearer token.
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
Response Headers
Unprocessable Entity
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.