Skip to main content
GET
Get consignado gateway usage for a competência

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

competencia
string

Billing competência (yyyyMM). Omit for the current UTC month.

Example:

"202607"

Response

OK

period
string
required

Billing competência (yyyyMM) the figures cover.

Example:

"202607"

scope
enum<string>
required

Aggregation scope: gateway (this service's facts) vs full_stack.

Available options:
gateway,
full_stack
Example:

"gateway"

tenant
string
required

Tenant (organization) id the figures belong to, echoed from the authenticated identity — server-derived, NEVER worker PII and NEVER taken from client input. Lets a client-built B2B export key on the tenant without ever sending or choosing one.

Example:

"org-123"

total
string
required

Sum of all unit totals (decimal string, BRL).

Example:

"36.00"

units
object[] | null
required

Per-unit-type priced breakdown.