InvoiceCreate

Criar uma fatura

payerstringrequired

Responsável pelo pagamento. Pode ser um customer ou company.

beneficiarystringrequired

Fundo que vai receber o pagamento.

dueDatedate

A data de vencimento da fatura.

typestringrequired

Tipo da fatura

Possible values: [pay_off, customer_recurring, company_recurring]

Example: pay_off

purposestring

Propósito da fatura

Possible values: [cancellation, customer_refinance, employment_terminated, external_collector, no_funds, regular, requested_by_company, requested_by_customer, requested_by_insurance, internal_collector]

Example: regular

descriptionstring

Uma string anexada ao objeto. Muitas vezes útil para exibição aos usuários.

items object[]

Array [

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

]

autoFinalizeboolean

Quando definido como true, executa o processo para finalizar a fatura no ato de criação, alterando o status para open ao final do processo. Se não informado ou definido como false, a fatura permanecerá com o status draft.

updateInvoiceItemOnInsertboolean

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

deductFineInterestFromAmountboolean

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

paidAtdate

Data de pagamento da fatura.

paymentSourcestring

Identificador da origem do pagamento.

Example: inv_5f92f01728e009f403d8502e

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.

InvoiceCreate

{
  "payer": "string",
  "beneficiary": "string",
  "dueDate": "2024-07-29",
  "type": "pay_off",
  "purpose": "regular",
  "description": "string",
  "items": [
    {
      "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"
      }
    }
  ],
  "autoFinalize": true,
  "updateInvoiceItemOnInsert": true,
  "deductFineInterestFromAmount": true,
  "paidAt": "2024-07-29",
  "paymentSource": "inv_5f92f01728e009f403d8502e",
  "metadata": {}
}