Get Invoice
This endpoint allows for the retrieval of an invoice by id. It also returns, if available, a pix and bank_slip URL for each invoice, which expires after 15 minutes.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayId": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"name": "<string>"
},
"paymentAccount": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"businessName": "<string>",
"tradeName": "<string>",
"taxId": "<string>",
"email": "jsmith@example.com",
"address": {
"zipCode": "<string>",
"number": "<string>",
"street": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "AC",
"country": "Brasil",
"complement": "<string>"
}
},
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"totalAmount": 1,
"closedReason": "end_of_cycle",
"payments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"dueDate": "2023-12-25",
"createdAt": "2023-11-07T05:31:56Z",
"processedAt": "2023-11-07T05:31:56Z",
"paymentMethod": "bolepix",
"status": "created",
"pixLink": "<string>",
"bankSlipLink": "<string>"
}
],
"status": "open",
"plans": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"metrics": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"billingModel": "in_full",
"priceTierDivision": "unique_tier",
"fixedAmount": 1,
"minimumAmount": 1,
"resourceName": "<string>",
"resourceType": "unit",
"priceTiers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"billingType": "unit",
"from": 2,
"to": 2,
"packageSize": 2,
"price": "<string>",
"fixedPrice": "<string>",
"basisPoints": 2,
"totalAmount": 1,
"usage": 1
}
],
"totalAmount": 1
}
],
"planSettings": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fixedAmount": 1,
"minimumAmount": 1
},
"totalAmount": 1
}
],
"additionalItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"amount": 2,
"type": "discount"
}
]
}Authorizations
API Key Authentication.
Path Parameters
The invoice id.
Response
The request was successfully processed and the invoice is returned.
The unique identifier of the invoice.
The human-readable identifier of the invoice.
The payment account used for this invoice.
The unique identifier of the payment account.
The legal business name of the payment account holder.
1The trade or "doing business as" name of the payment account holder.
1The tax identification number (CNPJ) of the payment account holder.
The contact email address for the payment account.
The physical address associated with the payment account.
The postal code (CEP) of the address.
8The street number of the address.
1The street name of the address.
1The neighborhood or district of the address.
1The city name of the address.
1The state abbreviation of the address.
AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO The country code of the address.
Brasil Additional address information like apartment number, floor, etc.
The start date of the billing period.
The end date of the billing period.
The total amount to be paid for this invoice.
x >= 0List of payments associated with this invoice.
bolepix, bank_slip, pix created, pending, paid, failed, canceled, expired The current status of the invoice.
open, closed, paid, canceled List of plans associated with this invoice.
Extended plan schema with product, metrics and settings.
The unique identifier for this plan.
The name of the plan.
1Optional description of the plan.
List of metrics associated with this plan.
Invoice in full metric schema.
The unique identifier for this metric.
The ID of the resource this metric is associated with.
The name of the metric.
1The billing model type, set to InFull.
in_full The price tier division method for this metric.
unique_tier, progressive The fixed cost amount for this metric.
x >= 0The minimum cost amount for this metric.
x >= 0The name of the resource.
1The resource type.
unit, currency List of price tiers for this metric.
Price tier configuration for a metric.
The unique identifier for this price tier.
The billing type for this price tier.
unit, package, flat, basis_points The starting value for this price tier.
x >= 1The ending value for this price tier. Null indicates no upper bound.
x >= 1The package size for package-based billing. Null if not package-based.
x >= 1The price for this tier in decimal format.
The fixed price for this tier in decimal format.
The basis points associated with this price tier in decimal format
x >= 1The total amount for this price tier.
x >= 0The usage amount for this price tier.
x >= 0The total amount for this metric.
x >= 0Settings configuration for this plan.
The total amount for this plan.
x >= 0List of additional items charged in this invoice.
Additional item object.
The additional item id.
Name of the additional item.
1Optional description of the additional item.
1Cost amount of the additional item.
x >= 1Type of the additional billing item.
discount, additional_charge The reason why the billing cycle was closed.
end_of_cycle, billing_end_day_updated {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayId": "<string>",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"name": "<string>"
},
"paymentAccount": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"businessName": "<string>",
"tradeName": "<string>",
"taxId": "<string>",
"email": "jsmith@example.com",
"address": {
"zipCode": "<string>",
"number": "<string>",
"street": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "AC",
"country": "Brasil",
"complement": "<string>"
}
},
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"totalAmount": 1,
"closedReason": "end_of_cycle",
"payments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123,
"dueDate": "2023-12-25",
"createdAt": "2023-11-07T05:31:56Z",
"processedAt": "2023-11-07T05:31:56Z",
"paymentMethod": "bolepix",
"status": "created",
"pixLink": "<string>",
"bankSlipLink": "<string>"
}
],
"status": "open",
"plans": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"product": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"metrics": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"billingModel": "in_full",
"priceTierDivision": "unique_tier",
"fixedAmount": 1,
"minimumAmount": 1,
"resourceName": "<string>",
"resourceType": "unit",
"priceTiers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"billingType": "unit",
"from": 2,
"to": 2,
"packageSize": 2,
"price": "<string>",
"fixedPrice": "<string>",
"basisPoints": 2,
"totalAmount": 1,
"usage": 1
}
],
"totalAmount": 1
}
],
"planSettings": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fixedAmount": 1,
"minimumAmount": 1
},
"totalAmount": 1
}
],
"additionalItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"amount": 2,
"type": "discount"
}
]
}