POST
/
v1
/
invoices
/
{invoice}
/
finalize
curl --request POST \
  --url https://api.base39.io/v1/invoices/{invoice}/finalize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "metadata": {}
}'
{
  "id": "inv_5f92f01728e009f403d8502e",
  "status": "draft",
  "payer": "<string>",
  "beneficiary": "<string>",
  "dueDate": "2023-12-25",
  "amountDue": 200000,
  "amountPaid": 150050,
  "amountRemaining": 95000,
  "type": "pay_off",
  "purpose": "regular",
  "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>",
        "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"
        }
      }
    ]
  },
  "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>",
          "ourNumberRaw": "<string>",
          "customer": "cust_631a2a321a40784a4b0df641",
          "events": [
            {}
          ]
        },
        "metadata": {},
        "createdAt": "2023-08-25T22:38:41.134Z",
        "updatedAt": "2023-08-25T22:38:41.134Z",
        "createdBy": {
          "clientId": "client_identifier",
          "externalClientId": "<string>",
          "app": "backoffice"
        },
        "updatedBy": {
          "clientId": "client_identifier",
          "externalClientId": "<string>",
          "app": "backoffice"
        }
      }
    ]
  },
  "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": "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.

Path Parameters

​
invoice
string
required

ID da fatura

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

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

Descrição do motivo da atualização do estado.

​
description
string

Erro ao salvar no parceiro

​
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

200 - application/json
Retorna o objeto `Invoice` se bem-sucedido; caso contrário, um erro.

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,
refunded
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 da fatura

Available options:
pay_off,
customer_recurring,
company_recurring
Example:

"pay_off"

​
purpose
enum<string>

Propósito da fatura

Available options:
cancellation,
customer_refinance,
employment_terminated,
external_collector,
no_funds,
regular,
requested_by_company,
requested_by_customer,
requested_by_insurance
Example:

"regular"

​
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
​
updatedBy
object