POST
/
v1
/
invoice-items
curl --request POST \
  --url https://api.base39.io/v1/invoice-items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "installment": "inst_631a1f531a40784a5b1df6ed",
  "amount": 123,
  "discount": 123,
  "fine": 123,
  "interest": 123,
  "description": "<string>",
  "purposeKey": "<string>",
  "updateInvoiceItemOnInsert": true,
  "deductFineInterestFromAmount": true,
  "metadata": {}
}'
{
  "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.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Query Parameters

​
invoice
string
required

ID da fatura

​
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.

​
fields
string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Body

application/json

Criar um item de fatura

Response

201 - application/json

Retorna o objeto InvoiceItem se a atualização for bem-sucedida; retorna erro se os parâmetros forem inválidos.

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