Manual Journals

Endpoints

GET /v1/manual-journals/
GET /v1/manual-journals/:id/
POST /v1/manual-journals/
PATCH /v1/manual-journals/:id/
DELETE /v1/manual-journals/:id/

Manual Journal object

Attributes	Type	Description
id	`string`	The id of the object.
currency	`string`	The currency used in the manual journal.
date	`string`	The date of the manual journal.
line_items	`array`	The journal line items of the manual journal.
reference	`string`	The reference of the manual journal.
notes	`string`	The notes of the manual journal.

Journal Line Item object

Attributes	Type	Description
id	`string`	The id of the object.
description	`string`	The description of the journal line item.
contact	`string`	The id of the contact.
currency	`string`	The currency of the journal line item.
account	`string`	The id of the account.
amount	`number`	The amount of the journal. Positive is debit, Negative is credit.

Example

{
    "id": "jou_33dCzmjULSzy3uaFBLfC4w",
    "date": "2021-04-15",
    "reference": "10edfd426868c82c874ea38d2f25b91a",
    "notes": "0e4375a38e2438c54be5a784978340f3",
    "currency": "SAR",
    "line_items": [
        {
            "id": "jli_F9pi7TWN3pMh6v8a6zHan2",
            "description": "description 1",
            "contact": "co_bhpSXLJV8vnDGTQod4v9zf",
            "account": "acc_PaKpYDGtfJzAeC6PQEGnAn",
            "amount": -100.00,
            "currency": "SAR"
        },
        {
            "id": "jli_PoW4MbQKaFq2b66xx3qMqt",
            "description": "description 2",
            "contact": "co_bhpSXLJV8vnDGTQod4v9zf",
            "account": "acc_UDkHkHSV7o2bQt9rRXYX7X",
            "amount": 100.00,
            "currency": "SAR"
        },
    ]
}

Get manual journal

Endpoint

GET /v1/manual-journals/:id/

Response sample

{
    "id": "jou_33dCzmjULSzy3uaFBLfC4w",
    "date": "2021-04-15",
    "reference": "10edfd426868c82c874ea38d2f25b91a",
    "notes": "0e4375a38e2438c54be5a784978340f3",
    "currency": "SAR",
    "line_items": [
        {
            "id": "jli_F9pi7TWN3pMh6v8a6zHan2",
            "description": "description 1",
            "contact": "co_bhpSXLJV8vnDGTQod4v9zf",
            "account": "acc_PaKpYDGtfJzAeC6PQEGnAn",
            "amount": -100.00,
            "currency": "SAR"
        },
        {
            "id": "jli_PoW4MbQKaFq2b66xx3qMqt",
            "description": "description 2",
            "contact": "co_bhpSXLJV8vnDGTQod4v9zf",
            "account": "acc_UDkHkHSV7o2bQt9rRXYX7X",
            "amount": 100.00,
            "currency": "SAR"
        },
    ]
}

List manual journals

Endpoint

GET /v1/manual-journals/

Filters

Query param	Type	Description
reference	`string`	The reference of the manual journal.
date	`string`	The manual journal date in `YYYY-MM-DD` e.g. `2021-01-01`.

Create manual journal

Endpoint

POST /v1/manual-journals/

Request body

Attributes	Type	Description
currency	`string`	The currency used in the manual journal.
date	`string`	The date of the manual journal.
line_items	`array`	The journal line items of the manual journal.
reference	`string`	The reference of the manual journal.
notes	`string`	The notes of the manual journal.

Update manual journal

PATCH /v1/manual-journals/:id/

Request body

Attributes	Type	Description
currency	`string`	The currency used in the manual journal.
date	`string`	The date of the manual journal.
reference	`string`	The reference of the manual journal.
notes	`string`	The notes of the manual journal.

Delete manual journal

DELETE /v1/manual-journals/:id/