v1

latestOpenAPI 3.1.02026-07-12103760.3 KB

Companies

Journals

Create Journal

post/unified/accounting/companies/{id}/journals

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

referencestring nullable

Reference number for the journal

memostring nullable

Memo or description for the journal

exchange_ratenumber nullable

Exchange rate to company base currency to apply to all lines

transaction_datestring date-time nullable

Date of the journal transaction

Example request

{
  "reference": "JRN-2024-001",
  "memo": "Monthly closing entries",
  "currency_code": {
    "value": "USD"
  },
  "exchange_rate": 1,
  "transaction_date": "2024-03-20T10:00:00Z",
  "lines": [
    {
      "account_id": "acc_123456789",
      "description": "Payment for office supplies",
      "amount": 10010,
      "tax_rate_id": "tax_123456789",
      "tax_amount": 10010
    }
  ]
}

Response

The journal was created successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}