Bulk Journal Action API Comparison
Financial Consolidation and Close provides two bulk journal action APIs. Both APIs submit one asynchronous job to perform the same workflow action across multiple journals for the same POV. The main difference is how much journal-specific detail can be supplied in the request body.
The following table compares the two bulk journal action APIs and identifies the request, validation, and customization options supported by each API.
Table 6-19 Side by Side Comparison
| Area | Perform Bulk Journal Actions (/journals/bulk-actions) | Perform Detailed Bulk Journal Actions (/journals/bulk-actions/detailed) |
|---|---|---|
| Primary purpose | Bulk action with a simple list of journal labels. | Bulk action with journal-specific comments and attachments. |
| Request shape | Top-level labels array
|
Top-level items array
|
| Shared POV fields | scenario, year, period,
consolidation, action,
cubeName |
scenario, year, period,
consolidation, action,
cubeName |
| Defaulted fields | cubeName defaults to Consol. Send
consolidation explicitly.
|
cubeName defaults to Consol. Send
consolidation explicitly.
|
| Comment support | One common top-level comment applied to every selected
journal.
|
Each items[] entry can provide its own
comment.
|
| Attachment support | Not supported. | Supported through items[].attachments[].fileName for files
already uploaded to Planning Inbox.
|
| Per-journal customization | Low. Journals differ only by label. | High. Each journal can have its own label, comment, and attachment list. |
| Best use case | Fast bulk processing when all journals should use the same comment and no attachments are needed. | Bulk processing when comments vary by journal or supporting files must be attached per journal. |
| Top-level validation | Request body must exist and labels must not be empty.
|
Request body must exist and items must not be empty.
|
| Per-item validation | Each label must resolve to a valid journal in the requested POV. | Each item must contain a valid label. If attachments are
supplied, each attachment must contain a non-blank
fileName.
|
| Auto-reversal support | Supported through top-level autoReversalPeriod and
autoReversalYear.
|
Supported through per-item autoReversalPeriod and
autoReversalYear.
|
| Response | Standard asynchronous job payload. | Standard asynchronous job payload. |
| Legacy alias | /journals/actions/bulk |
/journals/actions/bulk/detailed |
Note:
- Use
/journals/bulk-actionswhen you only need a list of labels and an optional common comment. - Use
/journals/bulk-actions/detailedwhen each journal may need its own comment or Planning Inbox attachments.