API Reference

Journal Line Items

Endpoints

GET /v1/journal-line-items/
GET /v1/journal-line-items/:id/

Journal Line Item object

AttributesTypeDescription
idstringThe id of the object.
descriptionstringThe description of the journal line item.
contactstringThe id of the contact.
currencystringThe currency of the journal line item.
accountstringThe id of the account.
amountnumberThe amount of the journal. Positive is debit, Negative is credit.

Example

{
    "id": "jli_Dz6coJqPVFRCrqaxUSYfoQ",
    "description": "Example journal line item",
    "contact": "co_ZUipbgE7DSxHPNCitmVfo6",
    "currency": "SAR",
    "account": "acc_dwhdnG9Y2zaWDvEexrCmxW",
    "amount": -15.0
}

Get journal line item

Endpoint

GET /v1/journal-line-items/:id/

Response sample

{
    "id": "jli_Dz6coJqPVFRCrqaxUSYfoQ",
    "description": "Example journal line item",
    "contact": "co_ZUipbgE7DSxHPNCitmVfo6",
    "currency": "SAR",
    "account": "acc_dwhdnG9Y2zaWDvEexrCmxW",
    "amount": -15.0
}

List journal line items

Endpoint

GET /v1/journal-line-items/

Filters

Query paramTypeDescription
accountstringThe id of the account.
account_classificationstringThe classification of an associated account.
currencystringThe currency of the associated journal.
tax_ratestringThe id of the tax rate.
contactstringThe id of the contact.
date_beforestringThe journal line items created on or after the date.
date_beforestringThe journal line items created on or before the date.
journalstringThe id of the journal.