GET
/
v1
/
invoices
/
{id}
{
  "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

​
X-API-KEY
string
header
required

API Key Authentication.

Path Parameters

​
id
string
required

The invoice id.

Response

200
application/json

The request was successfully processed and the invoice is returned.