API Reference

Archive your side of an engagement

post
https://api.wingspan.app/v3/payments/payers//engagements//terminate

Archive the caller's own side of an engagement on this Payer relationship; the other side is unchanged. On an engagement the payee created, this transitions it to Terminated, and may name a future effectiveDate. On an engagement the payer created, it archives only the payee's side, as of an effectiveDate no later than today (UTC); existing invoices stay collectible. It returns 409 payments.EngagementSideAlreadyArchived when that side is already archived, and 422 payments.EngagementArchiveDateInFuture for a later date. Terminating an engagement the payee created that is already Terminated returns it unchanged; open invoices or work logs that block that transition return 409.

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}$
string
required

Payer engagement ID (payer-owned engagement record)

Body Params

Archive the caller's own side of an engagement. The side that created the engagement may name a future effectiveDate; its side is blocked at once either way. The other side's effectiveDate may not be later than today (UTC), and defaults to today.

date
string

Recorded when the side that created the engagement terminates it.

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 7 days 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 7 days ago

Did this page help you?