GET/bills/{id}

Recuperar

Recupera o recurso de fatura pelo seu id

Parameters

Path Parameters

Name	Type	Description
`id`required	string (uuid)	Identificador primário da fatura

Responses

200Recuperar uma fatura de cartão de crédito.

object

Resposta com informações relacionadas a uma fatura de cartão de crédito

idrequiredstring

Identificador principal

dueDaterequiredstring (date-time)

Data de vencimento da fatura, exibida para pagamento pelo cliente

billClosingDatestring (date-time) | null

Data em que a fatura foi fechada

totalAmountrequirednumber

Valor total da fatura

totalAmountCurrencyCoderequiredstring

Código que referencia a moeda da fatura

minimumPaymentAmountnumber

Valor mínimo de pagamento da fatura

allowsInstallmentsboolean

Indica se a fatura permite pagamentos parcelados (verdadeiro) ou não (falso)

financeChargesrequiredobject[]

Lista de cobranças associadas à fatura

itemsobject

Resposta com informações relacionadas à cobrança de juros de fatura de cartão de crédito

paymentsrequiredobject[]

Lista de pagamentos associados à fatura

itemsobject

Resposta com informações relacionadas ao pagamento de fatura de cartão de crédito

Example response

json

{
  "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
  "dueDate": "2023-07-20T00:00:00",
  "billClosingDate": "2023-07-13T00:00:00",
  "totalAmount": 50000,
  "totalAmountCurrencyCode": "BRL",
  "minimumPaymentAmount": 50000,
  "allowsInstallments": true,
  "financeCharges": [
    {
      "id": "123456bf-c196-47ea-a28c-8251d6bb8777",
      "type": "IOF",
      "amount": 20.51,
      "currencyCode": "BRL",
      "additionalInfo": "NA"
    }
  ],
  "payments": [
    {
      "id": "9f1c7b2e-5d3a-4c8b-a1e2-6f7d8c9b0a1b",
      "valueType": "FULL_PAYMENT",
      "paymentDate": "2023-07-20T00:00:00",
      "paymentMode": "DEBIT_ACCOUNT",
      "amount": 50000,
      "currencyCode": "BRL"
    }
  ]
}

curl -X GET \
  'https://api.pluggy.ai/bills/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Resposta de exemplo

{
  "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
  "dueDate": "2023-07-20T00:00:00",
  "billClosingDate": "2023-07-13T00:00:00",
  "totalAmount": 50000,
  "totalAmountCurrencyCode": "BRL",
  "minimumPaymentAmount": 50000,
  "allowsInstallments": true,
  "financeCharges": [
    {
      "id": "123456bf-c196-47ea-a28c-8251d6bb8777",
      "type": "IOF",
      "amount": 20.51,
      "currencyCode": "BRL",
      "additionalInfo": "NA"
    }
  ],
  "payments": [
    {
      "id": "9f1c7b2e-5d3a-4c8b-a1e2-6f7d8c9b0a1b",
      "valueType": "FULL_PAYMENT",
      "paymentDate": "2023-07-20T00:00:00",
      "paymentMode": "DEBIT_ACCOUNT",
      "amount": 50000,
      "currencyCode": "BRL"
    }
  ]
}