API Reference

Update an accounting connection

patch
https://api.wingspan.app/v3/platform/accounting-connections/

Field updates only — mappingDefaults, externalId, metadata. Never status (use the action endpoints) and never syncState (derived). Patch mapping defaults only after refreshing reference data and listing the normalized items/classes/ledger accounts/vendors for this connection. Any mapping id that is absent, stale, or belongs to another connection returns 422.

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

Unique identifier of an AccountingConnection. A 22-character id.

Body Params

Field updates only — never status, never syncState. PATCH semantics: omitted fields are left unchanged; explicit null clears nullable fields. Before setting mappingDefaults, refresh reference data and list the normalized items/classes/ledger accounts/vendors for this connection. Any mappingDefaults.*Id that does not reference normalized reference data for this same connection returns 422.

string | null
mappingDefaults
object

Normalized mapping config. All *Id fields reference normalized reference-resource ids (ledger accounts / items / classes) for the same AccountingConnection. Invalid ids, stale ids from another connection, or ids that have not been refreshed into normalized reference data return 422.

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?