API Reference

Update a payee

patch
https://api.wingspan.app/v3/payments/payees/

Update mutable fields on a Payee. 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

Partial update of payer-controlled Payee record data.

string
enum

W-9 source selection, independent of payout destination and read-only w9Source provenance. The fallback mode uses the payer's complete W-9 when payee data is not shared or incomplete. RPC errors propagate. Omit on update to preserve the policy.

Allowed:
string
enum

Payout destination selection, independent of W-9 selection. The fallback mode uses the payer-managed destination when the payee's destination is absent, invalid, or inaccessible. RPC errors propagate. One complete configuration is selected; sources are never merged. Omit on update to preserve the policy.

Allowed:
string
enum
Defaults to Automatic

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

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.

string

Customer's own ID for reconciliation. Unique within the owning account and the Payee resource type; a collision returns 409. An empty string clears the stored value. Omit to leave unchanged.

defaults
object
string

Payer-private operational notes. Empty string clears the value.

string

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

string

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

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.

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

Updated 4 months ago

Did this page help you?
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

Updated 4 months ago

Did this page help you?