Journal Entry API documentation

Mar 13, 2026

Change #145fb2b5

1.0

Breaking

Compare

6 structure changes including:

1 Breaking change

1 Addition

4 Modifications

1 Removal

Modified 4 Breaking

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

Authentication
Adra oauth code pkce & Adra personal access token authentication method Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
Adra oauth code pkce & Adra oauth client cred & Adra personal access token authentication method Added

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/pendingpost/bulk

Authentication
Adra oauth code pkce & Adra personal access token authentication method Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
Adra oauth code pkce & Adra oauth client cred & Adra personal access token authentication method Added

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/post/bulk

Authentication
Adra oauth code pkce & Adra personal access token authentication method Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
Adra oauth code pkce & Adra oauth client cred & Adra personal access token authentication method Added

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/reject/bulk

Authentication
Adra oauth code pkce & Adra personal access token authentication method Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
Adra oauth code pkce & Adra oauth client cred & Adra personal access token authentication method Added

Removed 1 Breaking

Adra oauth code pkce & Adra personal access tokenauthentication method

Removing a resource is always breaking unless it was deprecated before
Breaking

Added 1

Adra oauth code pkce & Adra oauth client cred & Adra personal access tokenauthentication method

Mar 13, 2026

Change #5173bdd2

1.0

Compare

1 structure change including:

1 Modification

Modified 1

POST JournalPublishedwebhook

Webhook is no longer Technical Preview

Mar 13, 2026

Change #53e72611

1.0

Breaking

Compare

5 structure changes including:

5 Modifications

Modified 5 Breaking

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

Response
200 response Modified
- application/json content type Modified
  - value property Modified
    - periodCode property Modified
      - Property is no longer required
      - Type went from string | null to string
        Breaking
    - journalLines property Modified
  - @odata.count, @odata.nextPage properties Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking
default response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/pendingpost/bulk

Response
200 response Modified
- application/json content type Modified
  - statusReason property Modified
    - Property is no longer required
    - Type went from string | null to string
      Breaking
400 response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking
409 response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking
default response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/post/bulk

Body
application/json content type Modified
- journals property Modified
  - postComment property Modified
    - Type went from string | null to string
      Breaking
- bundleGuid property Modified
  - Property is no longer required
  - Type went from string(uuid) | null to string(uuid)
    Breaking
Response
200 response Modified
- application/json content type Modified
  - journalsUpdated property Modified
    - statusReason property Modified
      - Property is no longer required
      - Type went from string | null to string
        Breaking
400 response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking
409 response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking
default response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/reject/bulk

Response
200 response Modified
- application/json content type Modified
  - statusReason property Modified
    - Property is no longer required
    - Type went from string | null to string
      Breaking
400 response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking
409 response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking
default response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking

POST JournalPublishedwebhook

Response
default response Modified
- application/problem+json content type Modified
  - type, title, detail, instance properties Modified
    - Type went from string | null to string
      Breaking
  - status property Modified
    - Type went from integer(int32) | null to integer(int32)
      Breaking

Jun 12, 2025

Change #e0247b50

1.0

Compare

1 structure change including:

1 Addition

Added 1

POST JournalPublishedwebhook

Jun 12, 2025

Change #5a60b372

1.0

Compare

4 structure changes including:

4 Modifications

Modified 4

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

Operation is no longer Technical Preview

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/pendingpost/bulk

Operation is no longer Technical Preview

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/post/bulk

Operation is no longer Technical Preview

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/reject/bulk

Operation is no longer Technical Preview

Mar 23, 2025

Change #00d75aa5

1.0

Compare

3 structure changes including:

3 Modifications

Modified 3

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/pendingpost/bulk

Body
application/json content type Modified
Response
200 response Modified
- application/json content type Modified
  - statusReason property Added

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/post/bulk

Body
application/json content type Modified
- journals property Modified
  - postComment property Added
Response
200 response Modified
- application/json content type Modified
  - journalsUpdated property Modified
    - statusReason property Added

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/reject/bulk

Body
application/json content type Modified
Response
200 response Modified
- application/json content type Modified
  - statusReason property Added

Mar 17, 2025

Change #ab1b67ac

1.0

Breaking

Compare

6 structure changes including:

3 Breaking changes

3 Additions

1 Modification

2 Removals

Modified 1 Breaking

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/reject/bulk

Path went from /journalRejected to /api/v1.0/engagements/{engagementSid}/journal-entries/command/reject/bulk (same operationId)
Breaking
Verb went from POST to PUT (same operationId)
Breaking
Body
application/json content type Modified
- rejectedDate property Removed
- journalGuids property Added
Response
200 response Modified
- application/json content type Added
Path
journalId path parameter Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
Authentication
O auth 2.0 authorization code with pkce & Adra personal access token authentication method Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
Adra oauth code pkce & Adra personal access token authentication method Added

Removed 2 Breaking

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

Removing a resource is always breaking unless it was deprecated before
Breaking

POST journalPostedwebhook

Removing a resource is always breaking unless it was deprecated before
Breaking

Added 3

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

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/pendingpost/bulk

PUT /api/v1.0/engagements/{engagementSid}/journal-entries/command/post/bulk

Feb 10, 2025

Change #cc9333ce

1.0

Compare

Do not miss any Journal Entry API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created