Update a payer

Update mutable fields on a Payer. Omitted fields are left unchanged; send null to clear a nullable field.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[A-Za-z0-9_.]{22,80}$
Body Params
boolean

Payee-controlled automatic collection for this payer. Linking an Account preserves this owned setting. Applies to all payer engagements, each of which needs its own installed funding configuration and active recurring authorization. Omitted on update leaves the preference unchanged.

string | null

Customer reconciliation id. Null or empty clears; duplicates return 409.

string
enum
Defaults to Automatic

Stores the payee's compliance-entity source preference. Omit to leave the stored value unchanged. PayerProvided requires the linked payer Account to have a ComplianceEntity and PayeeProvided requires payeeSuppliedComplianceEntityId; otherwise 422 payments.PinnedComplianceEntityMissing.

Allowed:
string
enum
Defaults to PreferPayerAccountSupplied

Client-administered policy naming which side's collection funding configuration is authoritative after the Payer links. While unlinked, the Client-supplied configuration is authoritative. AlwaysPayeeAccountSupplied and AlwaysPayerAccountSupplied consult only the named side; PreferPayerAccountSupplied consults the Payer-supplied configuration first and falls back to the Client-supplied configuration when absent. The fallback unit is the indivisible funding-authorization pair, never a per-field merge, and revoked authorization is invalid under every value. This selector does not enable invoice auto-pay. While unlinked, collection uses Payer.isAutomaticInvoiceCollectionEnabled; linked-payer auto-pay uses Payee defaults or PayeeEngagement overrides. Changes apply to new collections only; in-flight reservations keep their snapshotted pair.

Allowed:
profile
object

Local display profile for a payer or payee record. Each field is stored and returned exactly as sent; omit a field to leave it unchanged. The contact email changes only through the record's update-email action. Legal, tax, and verification details belong on the related ComplianceEntity.

metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

string

Bind a payee-owned ComplianceEntity whose subject is exactly {type: Payer, id: <this Payer id>}.

string

The AccountingCustomer.id from listAccountingCustomers to map this Payer to. Empty string clears; omitted leaves unchanged. This is a Wingspan normalized reference id, not the QuickBooks-native id.

string

The AccountingItem.id from listAccountingItems to use as the default line-item mapping for invoices to this Payer. Empty string clears; omitted leaves unchanged. This is a Wingspan normalized reference id, not the QuickBooks-native id.

notificationCcEmails
array of strings
length ≤ 10

Replacement list of invoice-notification CC recipients. An empty array clears it.

notificationCcEmails
shareInsurancePolicyTypes
array of objects

Replacement insurance-policy sharing list. An empty array clears it.

shareInsurancePolicyTypes
Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json