Skip to main content
POST
/
records
Create a record
curl --request POST \
  --url https://api.endclose.com/v1/records \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "amount": 123,
  "direction": "credit",
  "date": "2023-12-25",
  "data_stream_key": "<string>",
  "id": 123,
  "decimal_places": 2,
  "description": "<string>",
  "metadata": {},
  "status": "reconciled",
  "external_id": "<string>",
  "matched_records": [
    {
      "id": 123,
      "amount": 123,
      "decimal_places": 2,
      "direction": "credit",
      "data_stream_key": "<string>"
    }
  ]
}
'
{
  "amount": 123,
  "direction": "credit",
  "date": "2023-12-25",
  "data_stream_key": "<string>",
  "id": 123,
  "decimal_places": 2,
  "description": "<string>",
  "metadata": {},
  "status": "reconciled",
  "external_id": "<string>",
  "matched_records": [
    {
      "id": 123,
      "amount": 123,
      "decimal_places": 2,
      "direction": "credit",
      "data_stream_key": "<string>"
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
amount
integer
required

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

direction
enum<string>
required
Available options:
credit,
debit
date
string<date>
required
data_stream_key
string
required
id
integer
decimal_places
integer
default:2

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

description
string
metadata
object
status
enum<string>

Derived from reconciliation matches. Read-only.

Available options:
reconciled,
unreconciled
external_id
string
matched_records
object[]

Records matched with this record via reconciliation

Response

201 - application/json

Record created

amount
integer
required

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

direction
enum<string>
required
Available options:
credit,
debit
date
string<date>
required
data_stream_key
string
required
id
integer
decimal_places
integer
default:2

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

description
string
metadata
object
status
enum<string>

Derived from reconciliation matches. Read-only.

Available options:
reconciled,
unreconciled
external_id
string
matched_records
object[]

Records matched with this record via reconciliation