Batch APIs

Post /api/v3/batch

Operation: OpenBatchV3 Permissions: BillsAndBatches (Create)

Opens a new batch. If there are other open batches for this user,
and CloseExistingBatch is true, closes those batches before creating the new batch.
Returns the batch response DTO.

---

Get /api/v3/batch

Operation: GetBatchesV3 Permissions: BillsAndBatches (View) Paginated

---

Get /api/v3/batch/{batchId}

Operation: GetBatchV3 Permissions: BillsAndBatches (View)

---

Put /api/v3/batch/{batchId}

Operation: EditBatchV3 Permissions: BillsAndBatches (Create)

---

Delete /api/v3/batch/{batchId}

Operation: DeleteBatchV3 Permissions: BillsAndBatches (Delete)

---

Put /api/v3/batch/close/{batchId}

Operation: CloseBatchV3 Permissions: BillsAndBatches (Create)

---

Get /api/v202509/batch/{batchId}/log

Operation: GetBatchLogsV202509 Permissions: BillsAndBatches (View)

Retrieves all move operation logs for a specific batch

---

Put /api/v202206/batch/{batchId}/status

Operation: UpdateBatchStatusV202206

Update the status of a batch.
Requesting user must have BillAndBatches Create to update their own batch or to open another user’s pending batch.
User must have BillsAndBatches Manage to update another user’s batch to closed or pending.
If opening another user’s batch,
the requesting user’s open batches (if any) will be set to Pending status if LeaveOpenBatchesAsIs is not set or is false.
the requesting user’s open batches (if any) will be left open if LeaveOpenBatchesAsIs is true.
See ‘Batch Statuses’ section below for more information.

---

Put /api/v202104/batch/{batchId}/distributeAccountCharges

Operation: DistributeAccountChargesToMetersForBillsInBatchV202104 Permissions: BillsAndBatches (Edit)

For each bill in the provided batch which has account-level charges, distribute these account charges amongst the meters on the bill.
This is done proportionally by meter use or cost, depending on the split basis.
Maximum of 10000 bills can be processed at one time.

---