Delete an item from a draft Boleto Charge batch

DELETE

https://tenant.api.corpx.com/v1/accounts/:accountId/boleto/charge/batches/:batchId/items/:itemId

DELETE

/v1/accounts/:accountId/boleto/charge/batches/:batchId/items/:itemId

curl -X DELETE https://tenant.api.corpx.com/v1/accounts/accountId/boleto/charge/batches/batchId/items/itemId \
     -H "X-Tenant-Id: X-Tenant-Id" \
     -H "Authorization: Bearer <token>"

{
  "batchId": "bcb_01J8Y7C8D9E0F1G2H3J4",
  "name": "Cobranças de setembro",
  "status": "DRAFT",
  "totalItems": 99,
  "quotaReserved": 0,
  "statistics": {
    "generation": {
      "total": 99,
      "pending": 99,
      "processing": 0,
      "issued": 0,
      "failed": 0,
      "progressPercentage": 0
    },
    "payment": {
      "issued": 0,
      "paid": 0,
      "unpaid": 0,
      "overdue": 0,
      "paidAmount": 0,
      "conversionRate": 0
    }
  },
  "createdAt": "2026-09-24T14:08:12Z",
  "updatedAt": "2026-09-24T14:09:30Z",
  "items": [],
  "page": 1,
  "pageSize": 50,
  "totalPages": 2,
  "hasNext": true
}

Removes one item while the batch is DRAFT. Once dispatch is accepted, items and their reserved quota are immutable.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired

Account identifier.

batchIdstringRequired

Boleto Charge batch identifier returned by the create endpoint.

itemIdstringRequired

Item identifier returned when a chunk is added to the batch.

Response

Item deleted; current draft and first item page

batchIdstring

Batch identifier.

namestring

Optional operator-facing name; empty when omitted.

statusenum

Batch lifecycle. Only DRAFT is editable. COMPLETED, PARTIAL_FAILED, and FAILED are terminal for issuance attempts; individual boleto registration and payment continue afterwards.

totalItemsinteger0-5000

Number of staged items.

quotaReservedinteger0-5000

Slots permanently reserved when dispatch was admitted.

statisticsobject

Current generation progress and payment conversion.

createdAtdatetime

Draft creation instant, in UTC.

updatedAtdatetime

Last persisted batch/statistics update, in UTC.

itemslist of objects

Current page of staged items and issuance results.

pageinteger

Current item page.

pageSizeinteger

Requested item page size.

totalPagesinteger

Number of item pages.

hasNextboolean

Whether another item page exists.

dispatchedAtdatetime or nullOptional

Instant quota was reserved and the batch was queued.

completedAtdatetime or nullOptional

Instant every issuance attempt reached an outcome.

Errors

403

Forbidden Error

404

Not Found Error

409

Conflict Error

Authentication

Path parameters

Headers

Response

Errors