Journal Entries API

Journal entries are the fundamental records of financial transactions in Snapbooks. They capture the movement of value between accounts and serve as the foundation for financial reporting, supporting various transaction types including sales, purchases, payments, receipts, and adjustments.

API Endpoints

List Journal Entries

GET /api/v2/journal-entries

Retrieve a paginated list of journal entries with filtering options. The response includes the lines and lines.dimensions relations by default.

Query Parameters

Error Responses

Get Journal Entry

GET /api/v2/journal-entries/{id}

Retrieves a specific journal entry by ID. The response includes the lines, lines.dimensions, lines.account, and lines.account.mandatory_dimensions relations by default.

Path Parameters

Error Responses

Create Journal Entry

POST /api/v2/journal-entries/

Creates a new journal entry. The request body must not include an id. The created entry is returned with all default relations populated.

Note the trailing slash on this endpoint. The other journal entry endpoints (GET, PUT, PATCH, DELETE on a specific entry) do not use a trailing slash.

Request Body

Line fields

Example Request

{
  "client_account_id": 7,
  "description": "Office supplies",
  "is_draft": false,
  "lines": [
    {
      "posting_date": "2026-04-10",
      "account_code": "6800",
      "debit": "1000.00",
      "credit": "0",
      "currency_code": "NOK"
    },
    {
      "posting_date": "2026-04-10",
      "account_code": "2400",
      "debit": "0",
      "credit": "1000.00",
      "currency_code": "NOK"
    }
  ]
}

Response

Returns the created journal entry with status 201 Created.

Error Responses

Update Journal Entry

PUT /api/v2/journal-entries/{id}

Replaces the contents of a draft journal entry. Only entries where is_draft is true may be updated — attempts to update a posted entry return 400. The full set of lines should be sent; existing lines are replaced.

Path Parameters

Request Body

Same shape as Create Journal Entry. The client_account_id cannot be changed.

Response

Returns the updated journal entry with status 200 OK.

Error Responses

Cancel (Reverse) Journal Entry

PATCH /api/v2/journal-entries/{id}

Cancels a posted journal entry by creating a reversal entry. The original entry is marked with cancelled: "Y", and a new entry with opposite debits and credits is posted on the current date. The new entry’s ID is recorded as cancellation_entry_id on the original.

Path Parameters

Request Body

Example Request

{
  "cancelled": "Y",
  "cancellation_reason": "Posted in wrong period"
}

Response

Returns the original journal entry (now marked cancelled) with status 200 OK. To retrieve the reversal entry, look up cancellation_entry_id.

Error Responses

Delete Journal Entry

DELETE /api/v2/journal-entries/{id}

Deletes a draft journal entry. Posted entries cannot be deleted — use the PATCH cancellation flow instead.

Path Parameters

Response

{}

Returns an empty object with status 200 OK.

Error Responses

Journal Entry Properties

Main Attributes

Journal Entry Line Properties

Related Resources

Example Response

{
    "id": 1,
    "created_at": "2023-05-10T12:00:00Z",
    "created_by_id": 1,
    "updated_at": "2023-05-10T12:00:00Z",
    "updated_by_id": 1,
    "client_account_id": 1,
    "sequence_number": 1,
    "description": "Sample journal entry",
    "cancelled": null,
    "cancelled_by_id": null,
    "cancellation_entry_id": null,
    "cancellation_reason": null,
    "is_draft": false,
    "voucher_id": null,
    "relation_type": null,
    "relation_id": null,
    "relation_number": null,
    "lines": [
        {
            "id": 1,
            "journal_entry_id": 1,
            "line_id": 1,
            "posting_date": "2023-05-10",
            "description": "Sample line item",
            "account_code": "1000",
            "account_id": 1,
            "debit": "100.00",
            "debit_fc": "100.00",
            "credit": "0.00",
            "credit_fc": "0.00",
            "currency_code": "USD",
            "currency_id": 1,
            "exchange_rate": "1.0000",
            "tax_code": "VAT",
            "tax_code_id": 1,
            "tax_base_amount": "100.00",
            "tax_base_amount_fc": "100.00",
            "tax_amount": "10.00",
            "tax_amount_fc": "10.00",
            "tax_line": null,
            "tax_for_line": null,
            "reconciled_amount": "0.00",
            "reconciled_amount_fc": "0.00",
            "external_reconciled_amount": "0.00",
            "dimensions": [],
            "account": {
                "id": 1,
                "account_code": "1000",
                "description": "Bank Account",
                "mandatory_dimensions": []
            }
        }
    ]
}

Important Notes

• Updates and deletions are restricted to draft entries (is_draft: true)
• Posted entries can only be cancelled via PATCH with cancelled: "Y", which creates a reversal entry
• Client account ID must be from user’s eligible accounts
• Line items are automatically managed with entry operations
• Currency fields with _fc suffix indicate foreign currency amounts
• Tax fields support VAT and other tax calculations
• The POST endpoint requires a trailing slash (/journal-entries/); other operations do not
• GET endpoints include related resources by default