Sign in

v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
ReconcilingSources

Retrieve reconciling source

Returns a single reconciling source by customId.

get/reconcilingsources/{companyId}/{customId}

Path parameters

customIdstring required
companyIdstring required

Response

Successful Response

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.

idstring required

Embat ID of the reconciling source.

companyIdstring required

Embat company ID. You can get them from "companies" endpoints

updatedAtstring date-time required

Last updated date of the entity in the database

createdAtstring date-time required

Created date of the entity in the database

Example response

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