Locate archived general ledger journal entry chunks
GET/gljournalentries/archives
Discovers which archived chunks contain general ledger journal entries matching exactly one filter mode. The response shape depends on the mode: the date-range (creation_start_date + creation_end_date) and entryId-range (entry_id_from + entry_id_to) modes return a JSON array of chunk descriptors; the entryId-list (entry_ids, up to 100) mode returns a JSON object mapping each requested entryId to the chunk descriptors that contain it (a requested entryId can match more than one chunk because entry identifiers are not strictly ordered by creation date; unmatched entryIds are omitted). Only entries old enough to have been archived are discoverable; more recent entries remain available through the live Journal Entries endpoints and cannot be located here, and requests reaching into that recent range are rejected. Use the returned chunkId values with the Archive Download API. Requires the VIEW_ARCHIVED_JOURNAL_ENTRIES permission.
Request
Responses
- 200
- 400
- 401
- 403
- 503
Archive chunk descriptors (date/entryId range modes) or an entryId-to-chunkIds map (entryId-list mode) returned.
Response Headers
Fixed page size (1000). Present only when more than one page of chunk descriptors matches (total greater than 1000).
Total number of matching chunk descriptors across all pages. Present only when more than one page matches (total greater than 1000).
A validation error occurred. The errorReason identifies the specific cause and errorCode is its numeric code: INVALID_FILTER_PARAMETERS (31002) - no filter mode, or more than one, was supplied (supply exactly one of the date-range, entryId-range, or entryId-list modes); INVALID_DATE_FORMAT (4905) - a date parameter is not a valid ISO yyyy-MM-dd date; INVALID_DATE_RANGE (31003) - creation_start_date is after creation_end_date; INVALID_ENTRY_ID_RANGE (31004) - entry_id_from is greater than entry_id_to; EMPTY_ENTRY_ID_LIST (31005) - the entry_ids list is empty; ENTRY_ID_LIST_TOO_LARGE (31006) - the entry_ids list exceeds 100 entries; RANGE_IN_LIVE_WINDOW (31007) - the requested range reaches into the recent, not-yet-archived window; RANGE_BEFORE_OLDEST_ARCHIVE (31008) - the requested range falls entirely before the oldest archived entry; INVALID_OFFSET (31009) - the offset query parameter is negative.
Unauthorized
Forbidden
The archived Journal Entries data is unavailable. The errorReason identifies the specific cause and errorCode is its numeric code: ARCHIVAL_JOURNALENTRY_NOT_ENABLED (31001) - the archived Journal Entries feature is not enabled; ARCHIVAL_JOURNALENTRY_DATA_NOT_AVAILABLE (31010) - the feature is enabled but no archived data is available yet.