Get journal entries Run in API Explorer

GET /api/v1.0/engagements/{engagementSid}/journal-entries

OData endpoint that gets journal entries

Path parameters

  • engagementSid string Required

    The engagement SID

Query parameters

  • $filter string

    OData $filter parameter

  • $orderby string

    OData $orderby parameter

  • $top integer(int64) Required

    OData $top parameter

    Minimum value is 0, maximum value is 5000.

  • $skip integer(int64)

    OData $skip parameter

    Minimum value is 0, maximum value is 5000.

  • $count boolean

    OData $count parameter

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • value array[object]
      Hide value attributes Show value attributes object
      • engagementGuid string(uuid) Required
      • journalGuid string(uuid) Required
      • legalEntityName string Required
      • legalEntityCode string Required
      • periodEndDate string(date-time) Required
      • periodName string Required
      • periodCode string | null Required
      • description string Required
      • journalDate string(date-time) Required
      • preparedBy string Required
      • preparedDate string(date-time) Required
      • journalStatus string Required

        Values are Draft, ReadyToPost, PendingPost, Posted, or Rejected.

      • currency string Required
      • debitSum number(double) Required
      • creditSum number(double) Required
      • totalLineCount integer(int32) Required
      • lastModifiedDate string(date-time) Required
      • journalLines array[object] Required
        Hide journalLines attributes Show journalLines attributes object
        • lineNumber integer(int32) Required
        • accountNo string Required
        • accountName string | null Required
        • credit number(double) | null Required
        • debit number(double) | null Required
        • lineText string | null Required
        • dimensions object Required
          Hide dimensions attribute Show dimensions attribute object
          • * string Additional properties
      • attachments array[object] Required
        Hide attachments attributes Show attachments attributes object
        • fileName string Required
    • @odata.count string | null
    • @odata.nextPage string | null
  • 400 application/problem+json

    Bad Request

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • default application/problem+json

    Error

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
GET /api/v1.0/engagements/{engagementSid}/journal-entries
curl \
 --request GET 'https://journal.adra.com/api/v1.0/engagements/{engagementSid}/journal-entries?%24top=42' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "value": [
    {
      "engagementGuid": "string",
      "journalGuid": "string",
      "legalEntityName": "string",
      "legalEntityCode": "string",
      "periodEndDate": "2025-05-04T09:42:00Z",
      "periodName": "string",
      "periodCode": "string",
      "description": "string",
      "journalDate": "2025-05-04T09:42:00Z",
      "preparedBy": "string",
      "preparedDate": "2025-05-04T09:42:00Z",
      "journalStatus": "Draft",
      "currency": "string",
      "debitSum": 42.0,
      "creditSum": 42.0,
      "totalLineCount": 42,
      "lastModifiedDate": "2025-05-04T09:42:00Z",
      "journalLines": [
        {
          "lineNumber": 42,
          "accountNo": "string",
          "accountName": "string",
          "credit": 42.0,
          "debit": 42.0,
          "lineText": "string",
          "dimensions": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          }
        }
      ],
      "attachments": [
        {
          "fileName": "string",
          "downloadLink": "string"
        }
      ]
    }
  ],
  "@odata.count": "string",
  "@odata.nextPage": "string"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (default)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}