GET
/
api
/
manual-journals
[
  {
    "id": 1,
    "date": "2024-03-20",
    "journalNumber": "MJ-2024-001",
    "journalType": "General",
    "reference": "REF-001",
    "amount": 1000,
    "currencyCode": "USD",
    "exchangeRate": 1,
    "description": "Monthly journal entry",
    "isPublished": false,
    "publishedAt": "2024-03-20T10:00:00Z",
    "createdAt": "2024-03-20T09:00:00Z",
    "updatedAt": "2024-03-20T09:30:00Z",
    "branchId": 1,
    "formattedAmount": "$1,000.00",
    "formattedDate": "Mar 20, 2024",
    "formattedPublishedAt": "Mar 20, 2024",
    "formattedCreatedAt": "Mar 20, 2024",
    "entries": [
      {
        "index": 1,
        "credit": 1000,
        "debit": 0,
        "accountId": 1,
        "note": "Payment for services",
        "contactId": 1,
        "branchId": 1,
        "projectId": 1,
        "account": {},
        "contact": {},
        "branch": {}
      }
    ],
    "attachments": [
      "<string>"
    ]
  }
]

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

The manual journal details have been successfully retrieved.

​
id
number
required

Manual Journal ID

Example:

1

​
date
string<date-time>
required

Journal date

Example:

"2024-03-20"

​
journalNumber
string
required

Journal number

Example:

"MJ-2024-001"

​
amount
number
required

Total amount

Example:

1000

​
isPublished
boolean
required

Published status

Example:

false

​
createdAt
string<date-time>
required

Created date

Example:

"2024-03-20T09:00:00Z"

​
formattedAmount
string
required

Formatted amount

Example:

"$1,000.00"

​
formattedDate
string
required

Formatted date

Example:

"Mar 20, 2024"

​
formattedCreatedAt
string
required

Formatted created date

Example:

"Mar 20, 2024"

​
entries
object[]
required

Journal entries

​
journalType
string

Journal type

Example:

"General"

​
reference
string

Reference number

Example:

"REF-001"

​
currencyCode
string

Currency code

Example:

"USD"

​
exchangeRate
number

Exchange rate

Example:

1

​
description
string

Description

Example:

"Monthly journal entry"

​
publishedAt
string<date-time>

Published date

Example:

"2024-03-20T10:00:00Z"

​
updatedAt
string<date-time>

Updated date

Example:

"2024-03-20T09:30:00Z"

​
branchId
number

Branch ID

Example:

1

​
formattedPublishedAt
string

Formatted published date

Example:

"Mar 20, 2024"

​
attachments
string[]

Attachments