ENendclose

Update a record

Changed on

Update a record's fields. The record must have a status of unreconciled. Records that are partially or fully reconciled cannot be modified.

patch/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

Headers

Idempotency-Keystring

Optional. Send the same key when retrying a write you are not sure landed: the first response is returned again (with Idempotent-Replayed: true) instead of writing twice. A key used for a different request is refused with 422; one whose first request is still running gets 409. A refused or failed request does not use up its key. Keys are per environment and kept for 7 days.

Request body

amountinteger

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

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

Response

Record updated

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

  • 159f9ed3dbf4Revision changes
    • breaking

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

    • info

      added the new optional header request parameter Idempotency-Key