POST
/
v1
/
invoices
curl --request POST \
  --url https://api.base39.io/v1/invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payer": "<string>",
  "beneficiary": "<string>",
  "dueDate": "2023-12-25",
  "type": "pay_off",
  "description": "<string>",
  "items": [
    {
      "installment": "inst_631a1f531a40784a5b1df6ed",
      "amount": 123,
      "discount": 123,
      "fine": 123,
      "interest": 123,
      "description": "<string>",
      "metadata": {}
    }
  ],
  "autoFinalize": true,
  "updateInvoiceItemOnInsert": true,
  "paidAt": "2023-12-25",
  "metadata": {}
}'
{
  "id": "inv_5f92f01728e009f403d8502e",
  "status": "draft",
  "payer": "<string>",
  "beneficiary": "<string>",
  "dueDate": "2023-12-25",
  "amountDue": 200000,
  "amountPaid": 150050,
  "amountRemaining": 95000,
  "type": "pay_off",
  "invoiceItems": {
    "url": "<string>",
    "hasMore": true,
    "data": [
      {
        "id": "item_5f92f01728e009f403d8502e",
        "installment": "inst_631a1f531a40784a5b1df6ed",
        "invoice": "inv_631a1f531a40784a4b0df5ed",
        "amount": 123,
        "discount": 123,
        "fine": 123,
        "interest": 123,
        "description": "<string>",
        "metadata": {},
        "createdAt": "2023-08-25T22:38:41.134Z",
        "updatedAt": "2023-08-25T22:38:41.134Z",
        "deleted": false
      }
    ]
  },
  "paymentIntents": {
    "hasMore": true,
    "data": [
      {
        "id": "pi_5f92f01728e009f403d8502e",
        "invoice": "inv_631a1f531a40784a4b0df5ed",
        "status": "open",
        "amount": 123,
        "paymentDetails": {
          "paidAt": "2023-12-25",
          "amountPaid": 123,
          "metadata": {}
        },
        "expireAt": "2023-12-25",
        "method": "boleto",
        "methodData": {
          "externalId": "<string>",
          "type": "boleto",
          "provider": "kobana",
          "description": "<string>",
          "typeableLine": "<string>",
          "url": "<string>",
          "barcode": "<string>",
          "ourNumber": "<string>",
          "customer": "cust_631a2a321a40784a4b0df641",
          "events": [
            {}
          ]
        },
        "metadata": {},
        "createdAt": "2023-08-25T22:38:41.134Z",
        "updatedAt": "2023-08-25T22:38:41.134Z"
      }
    ]
  },
  "description": "<string>",
  "history": [
    {
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "status": "draft",
      "metadata": {}
    }
  ],
  "paidAt": "2023-12-25",
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "key_643969122d598f5b62d15fbc",
    "externalClientId": "optr_643969122d598f5b62d15fbd"
  },
  "updatedBy": {
    "clientId": "key_643969122d598f5b62d15fbc",
    "externalClientId": "optr_643969122d598f5b62d15fbd"
  }
}

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.

Query Parameters

​
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[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Criar uma fatura

​
payer
string
required

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

​
beneficiary
string
required

Fundo que vai receber o pagamento.

​
type
enum<string>
required

Tipo do item da fatura.

Available options:
pay_off,
customer_recurring,
company_recurring
​
dueDate
string

A data de vencimento da fatura.

​
description
string

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

​
items
object[]

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

​
autoFinalize
boolean

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.

​
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

​
paidAt
string

Data de pagamento 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.

Response

201 - application/json
Retorna o objeto `Invoice` se a criação for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos.

Este objeto representa uma fatura.

​
id
string

Identificador exclusivo para o objeto.

Example:

"inv_5f92f01728e009f403d8502e"

​
status
enum<string>

Status da fatura

Available options:
draft,
open,
paid,
void,
uncollectible
Example:

"draft"

​
payer
string

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

​
beneficiary
string

Fundo que vai receber o pagamento.

​
dueDate
string

A data de vencimento da fatura.

​
amountDue
number

Valor devido.

Example:

200000

​
amountPaid
number

Valor pago.

Example:

150050

​
amountRemaining
number

Valor restante.

Example:

95000

​
type
enum<string>

Tipo do item da fatura.

Available options:
pay_off,
customer_recurring,
company_recurring
​
invoiceItems
object

Contém grupos de parcelas na fatura tanto para o pagamento, como para antecipação.

​
paymentIntents
object

Representa um conjunto de intenções de pagamento.

​
description
string

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

​
history
object[]
​
paidAt
string

Data de pagamento 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

Esta estrutura de dados descreve a auditoria das operações de criação de faturas (invoices).

​
updatedBy
object

Esta estrutura de dados descreve a auditoria das operações de alteração de faturas (invoices).