Retrieve a record

Changed on

Retrieve a single record by its unique ID.

get/records/{id}

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

The unique identifier of the record

Response

Record retrieved successfully

idstring uuid
amountinteger required

The monetary amount in cents (e.g., 1234 = $12.34)

currencystring

Three-letter ISO 4217 currency code (e.g. USD, EUR). Optional on create — defaults to USD when omitted. Case-insensitive on input; always returned uppercase.

decimal_placesinteger

Number of decimal places for this currency (2 for USD)

direction'credit' | 'debit' required
descriptionstring
datestring date required
metadataobject
external_idstring
data_stream_keystring required

Changes

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status