Get Boleto Charge monthly quota

GET

https://tenant.api.corpx.com/v1/accounts/:accountId/boleto/charge/quota

Returns the two issuance quotas enforced together for the current BRT calendar month. The tenant policy is boletoCharge.maxIssuesPerMonth (default 100); the account policy defaults to 5 for a PF holder and 10 for a PJ holder. There is no unlimited mode. effectiveRemaining is the smaller remaining balance.

A slot is consumed when an issuance is admitted/reserved. It is not refunded if issuance later fails at the settlement bank. Beneficiary validation failures, idempotent repeats, quota denials, and batch dispatches that cannot fit all items consume nothing.

Returns the two issuance quotas enforced together for the current BRT calendar month. The tenant policy is `boletoCharge.maxIssuesPerMonth` (default 100); the account policy defaults to 5 for a PF holder and 10 for a PJ holder. There is no unlimited mode. `effectiveRemaining` is the smaller remaining balance. A slot is consumed when an issuance is admitted/reserved. It is not refunded if issuance later fails at the settlement bank. Beneficiary validation failures, idempotent repeats, quota denials, and batch dispatches that cannot fit all items consume nothing.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired

Account identifier.

Response

Tenant and account quota for the current BRT month

periodStartdate

First day of the current BRT calendar month.

resetsAtdatetime

UTC instant at which the next BRT calendar month starts.

tenantobject

One enforced monthly issuance counter.

accountobject

One enforced monthly issuance counter.

effectiveRemaininginteger>=0

Minimum of tenant.remaining and account.remaining.

Errors

403

Forbidden Error

404

Not Found Error

503

Service Unavailable Error

Authentication

Path parameters

Headers

Response

Errors