Pular para o conteúdo principal

Criar item da fatura

POST 
/v1/invoice-items

Cria um novo item da fatura.

Request​

Query Parameters

    invoice stringrequired

    ID da fatura

    Example: inv_631a1f531a40784a4b0df5ed
    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
    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.

    Examples:

    Retorna apenas os campos `id` e `createdAt`.

    Example: id,createdAt

Header Parameters

    Idempotency-Key string

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

    Example: 5f92f01728e009f403d8502e
    base39-external-client-id string

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

Body

    installment stringrequired

    Identificador que faz referência a uma parcela.

    Example: inst_631a1f531a40784a5b1df6ed
    amount doublerequired

    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 double

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

    fine double

    Valor da multa

    interest double

    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.

Responses​

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

Schema

    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 double

    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 double

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

    fine double

    Valor da multa

    interest double

    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 date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

    Example: 2023-08-25T22:38:41.134Z
    deleted boolean

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

    Default value: false
    Example: false

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice
Loading...