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

​
installment
string
required

Identificador que faz referência a uma parcela.

Example:

"inst_631a1f531a40784a5b1df6ed"

​
amount
number
required

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

​
discount
number

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

​
fine
number

Valor da multa

​
interest
number

Valor do juros

​
description
string

Descrição do item.

​
purposeKey
string

Chave de propósito do item da fatura.

​
updateInvoiceItemOnInsert
boolean

Sobrescrever configuração de desconto e multa no momento da criação dos itens da fatura. Este campo determina se, no momento da criação dos itens da fatura, descontos ou multas serão aplicados automaticamente aos itens de fatura enviados na requisição. Quando este campo é informado, o valor nele especificado substituirá o valor contido em settings.invoices[type].updateInvoiceItemOnInsert. É importante destacar que essa configuração apenas se aplica à requisição atual e não afetará as configurações existentes. Esse recurso foi desenvolvido com o propósito de substituir o parâmetro settings.invoices[type].updateInvoiceItemOnInsert pelo valor enviado na requisição.

Example:

true

​
deductFineInterestFromAmount
boolean

Quando definido como verdadeiro (true), caso a parcela esteja atrasada e o valor (amount) fornecido seja menor do que o valor restante (amountRemaining), os valores de multa (fine) e juros (interest) do item serão recalculados proporcionalmente ao valor pago (amount) e, então, deduzidos do valor do item, substituindo os três respectivos campos fornecidos na requisição pelos valores proporcionais calculados.

Example:

true

​
metadata
object

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.

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.

​
id
string

Identificador exclusivo para o objeto.

Example:

"item_5f92f01728e009f403d8502e"

​
installment
string

Identificador que faz referência a uma parcela.

Example:

"inst_631a1f531a40784a5b1df6ed"

​
invoice
string

Identificador que faz referência a uma fatura.

Example:

"inv_631a1f531a40784a4b0df5ed"

​
amount
number

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

​
discount
number

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

​
fine
number

Valor da multa

​
interest
number

Valor do juros

​
description
string

Descrição do item.

​
purposeKey
string

Chave de propósito do item da fatura.

​
metadata
object

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.

​
createdAt
string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

​
createdBy
object
​
updatedBy
object