Criar item da fatura

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

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

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

ID da fatura

Expande as referências.

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

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.

Identificador que faz referência a uma parcela.

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

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

Valor da multa

Valor do juros

Descrição do item.

Chave de propósito do item da fatura.

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.

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.

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.

Identificador exclusivo para o objeto.

Identificador que faz referência a uma parcela.

Identificador que faz referência a uma fatura.

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

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

Valor da multa

Valor do juros

Descrição do item.

Chave de propósito do item da fatura.

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.

Data de criação do objeto

Data de alteração do objeto

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