GET
/
v1
/
invoices
/
{invoice}
/
invoice-items
curl --request GET \
  --url https://api.base39.io/v1/invoices/{invoice}/invoice-items \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "item_5f92f01728e009f403d8502e",
      "installment": "inst_631a1f531a40784a5b1df6ed",
      "invoice": "inv_631a1f531a40784a4b0df5ed",
      "amount": 123,
      "discount": 123,
      "fine": 123,
      "interest": 123,
      "description": "<string>",
      "purposeKey": "<string>",
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
invoice
string
required

ID da fatura

Query Parameters

​
installment
string

ID da parcela

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
limit
integer
default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

Response

200 - application/json
Um objeto com a propriedade `data` contendo um array de itens a partir do `starting_after`. Se não houver mais itens, o array será vazio. A solicitação nunca deve retornar um erro.

Uma lista de itens da fatura.

​
hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

​
data
object[]

Uma lista de itens da fatura.

Representa uma parcela da fatura tanto para o pagamento, como para antecipação.