API Reference

Update a payee engagement as the payer

patch
https://api.wingspan.app/v3/payments/payee-engagements/

Update mutable fields on a PayeeEngagement from the payer-side flat path. Omitted fields are left unchanged. Payer-side mirror of the payee-scoped update.

worksiteId must name a worksite owned by the payer, or the request returns 422 with detailCode payments.WorksiteNotFound. For an Employee engagement, the worksite must also be in a country W-2 payroll supports and a state enabled on the payer's employer payroll profile. Otherwise the request returns 422 with payments.WorksiteCountryUnsupported, payments.WorksiteJurisdictionUnsupported, or payments.WorksiteJurisdictionNotEnabled. Nothing is saved when the request is rejected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Payee engagement ID (concrete assignment)

Body Params

PATCH semantics: omitted fields are left unchanged; explicit null clears nullable fields.

date
date | null
string

For Employee engagements, omit to leave the stored location unchanged.

string
string

Overrides the denormalized engagement name. PATCH semantics; omit to leave unchanged.

overrides
object

Payer-controlled per-engagement overrides. Omit to leave the stored override unchanged.

string

The AccountingVendor.id from listAccountingVendors to map this Payee engagement 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 engagement 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?