Get journal entries Technical Preview

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

OData endpoint that gets journal entries

Path parameters

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

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"
}