Sign in

v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
ReconcilingItems

Retrieve reconciling item

Returns a single reconciling item by customId.

get/reconcilingitems/{companyId}/{customId}

Path parameters

customIdstring required
companyIdstring required

Response

Successful Response

amountnumber required

Amount of the reconciling item, in currency.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTC' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNH' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EEK' | 'EGP' | 'ERN' | 'ETB' | 'ETH' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTC' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWG' | 'ZWL' required
datestring date-time required

Date of the reconciling item.

descriptionstring required

Free-text description of the reconciling item.

metadataobject nullable

Free-form key/value data associated with the reconciling item. When its reconciling source defines a matchingMetadataKey, the value stored under that key is used to automatically associate this item with a product transaction — only string, number or boolean values are usable for matching, other value types are ignored. An empty string is also accepted and treated as an empty object. Replaces the previously stored value entirely (not merged). Omitted or null leaves the current metadata unchanged.

additionalInfoobject nullable

Free-form key/value metadata to attach to the reconciling item. An empty string is also accepted and treated as an empty object. Replaces the previously stored value entirely (not merged). Omitted or null leaves the current metadata unchanged.

customIdstring required

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

reconcilingSourceCustomIdstring required

Custom ID of the reconciling source this item belongs to. You can get them from "Reconciling Sources" endpoints. Not validated against existing reconciling sources: if it does not match one, the item is still created, but it is not automatically matched against transactions.

idstring required

Embat ID of the reconciling item.

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.

reconciledboolean

Whether this item has completed the reconciliation process against a transaction. Set by Embat; it cannot be set through this API.

isMatchedboolean

Whether this item has been matched to a transaction. Defaults to false when the item is created and is set by Embat afterwards; it cannot be set through this API.

Example response

{
  "amount": 199.9,
  "date": "2024-01-15T00:00:00Z",
  "description": "Stripe order #4821",
  "metadata": {
    "orderId": "ORD-48213"
  },
  "customId": "stripe-order-4821",
  "reconcilingSourceCustomId": "stripe-orders"
}