API Reference

Create an accounting connection

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

Creates the Created record. Call the connect action to begin OAuth. Account-scoped. One active connection per (accountId, partner) — a second active one returns 409 (detailCode: integrations.PartnerAlreadyConnected).

If externalId is supplied and already used by another resource of this type for the owning Account, the request returns 409 ResourceConflict; create is not an upsert.

Recommended setup order for mapping defaults: create/connect, refresh reference data, list items/classes/ledger accounts/vendors, then patch mappingDefaults. Create does not accept mappingDefaults; any mappingDefaults.*Id patched later must reference normalized reference data for this same connection. Invalid, stale, or cross-connection ids return 422.

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

Create/connect first, then refresh reference data, list items/classes/ ledger accounts/vendors, and patch mappingDefaults. Create does not accept mapping defaults because valid ids are known only after reference data is refreshed; invalid or cross-connection ids on update return 422.

string
enum
required
Allowed:
string
Headers
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
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
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?