Sign in

v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
ReconcilingSources

Create reconciling source

Creates a reconciling source identified by customId. Calling this endpoint again with a customId that already exists updates the existing reconciling source instead of creating a duplicate or raising a conflict error; only the fields sent are applied, and any field previously stored is kept unless a new value is sent.

post/reconcilingsources/{companyId}

Path parameters

companyIdstring required

Request body

namestring required

Name of the reconciling source.

additionalInfoobject nullable

Free-form key/value metadata to attach to the reconciling source. Replaces the previously stored value entirely (not merged). Omitted or null values leave the current metadata unchanged.

matchingMetadataKeystring nullable

Key within a reconciling item's metadata used to associate it with a product transaction. Omitted or null values leave the current key unchanged.

customIdstring required

Your own unique ID for the reconciling source. You can use it as your internal reconciling source ID.

Example request

{
  "name": "Stripe orders feed",
  "matchingMetadataKey": "orderId",
  "customId": "stripe-orders"
}

Response

Successful Response

idstring required

Embat resource ID