Pular para o conteúdo principal

Vencidas

1. Consultar parcelas vencidas​

Para consultar as parcelas vencidas em um intervalo específico, você pode utilizar o endpoint de listar parcelas:

curl --request GET \
    --url 'https://api.base39.io/v1/installments?due_date_start=2023-10-01&due_date_end=2023-10-31&status=unpaid' \
    --header 'content-type: application/json' \
    --header 'authorization: Basic <api-key>'
  • Parâmetros:
    • due_date_start: Data de início do período de vencimento.
    • due_date_end: Data final do período de vencimento.
    • status: Status da parcela (neste caso, estamos buscando por parcelas não pagas, ou seja, unpaid).

Esta requisição retornará as parcelas que não foram pagas entre 01 e 31 de outubro de 2023.

2. Gerar uma fatura​

Depois de consultar as parcelas vencidas, você pode gerar uma fatura para cobrá-las. Para isso, utilize o seguinte comando:

curl --request POST \
    --url https://api.base39.io/v1/invoices \
    --header 'content-type: application/json' \
    --header 'authorization: Basic <api-key>'
    --data '
        {
            "type": "pay_off",
            "items": [
                {
                    "installment": "inst_...",
                    "amount": 500,
                    "discount": 200,
                    "fine": 50,
                    "interest": 12
                }
            ],
            "autoFinalize": true,
            "dueDate": "2023-11-15",
            "payer": "cust_123",
            "beneficiary": "fund_...",
            "description": "Negociação de parcelas vencidas"
        }
    '
  • Corpo da requisição:
    • type: Tipo da fatura (neste exemplo, pay_off).
    • items: Array com informações sobre cada parcela a ser cobrada.
    • autoFinalize: Indica se a fatura deve ser fechada automaticamente após sua criação.
    • dueDate: Data de vencimento da fatura.
    • payer: Identificador do pagador.
    • beneficiary: Identificador do beneficiário.
    • description: Descrição da fatura.

Neste exemplo, a fatura está sendo gerada para cobrar uma parcela vencida de identificador inst_..., com valor total de R$ 500, desconto de R$ 200, multa de R$ 50 e juros de R$ 12.

Depois de executar a requisição, a API retornará um identificador único para a fatura gerada, que você pode usar para acompanhar seu status ou realizar outras operações.