Obter item da fatura

GET 
/v1/invoices/:invoice/invoice-items/:invoice_item

Retorna um objeto InvoiceItem

Request

Path Parameters

invoice_item stringrequired
ID do item da fatura
Example: item_5f92f01728e009f403d8502e
invoice stringrequired
ID da fatura
Example: inv_5f92f01728e009f403d8502e

Query Parameters

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.
Example: data.loan

Responses

200

Retorna o objeto InvoiceItem para um ID válido. Se o item estiver excluído, retorna um subconjunto com a propriedade deleted como true.

application/json

Schema

Schema

idstring
Identificador exclusivo para o objeto.
Example: item_5f92f01728e009f403d8502e
installmentstring
Identificador que faz referência a uma parcela.
Example: inst_631a1f531a40784a5b1df6ed
invoicestring
Identificador que faz referência a uma fatura.
Example: inv_631a1f531a40784a4b0df5ed
amountdouble

Valor da parcela que será considerado como pago. Pode ser menor (para realizar pagamento parcial da parcela) ou igual ao valor original da parcela.

discountdouble

Valor do desconto que será dado na fatura referente a parcela informada

finedouble

Valor da multa

interestdouble

Valor do juros

descriptionstring

Descrição do item.

purposeKeystring

Chave de propósito do item da fatura.

metadataobject

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

createdAtdate-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z
updatedAtdate-time
Data de alteração do objeto
Example: 2023-08-25T22:38:41.134Z
deletedboolean
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
Default value: false
Example: false

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

Example (from schema)

{
  "id": "item_5f92f01728e009f403d8502e",
  "installment": "inst_631a1f531a40784a5b1df6ed",
  "invoice": "inv_631a1f531a40784a4b0df5ed",
  "amount": 0,
  "discount": 0,
  "fine": 0,
  "interest": 0,
  "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"
  }
}