Contas a receber

POST /api/v1/accounts-receivable Copied!

Este endpoint permite criar um ou várias contas a receber

header da request:

Authorization: Bearer {access_token}
Accept: application/json 
Idempotency-Key: "asdsad32312dqs"

O payload deve estar no seguinte formato:

[
  {
    "url_callback": "https://callback.com.br/",
    "client_id": "30da23ca-e48c-4f96-b62b-26f6eb613dba", // UUID do clinte no ERP
    "payment_slip_id": "1af90a0f-93b9-42f0-afa9-ff2d6e9fd765", // UUID referente ao carnê no ERP
    "account_receivable_id": "5ea197ea-6426-4f46-9d14-e34e5699dbd9", // UUID do contas a receber no ERP
    "payment_method": 1, // 1 para Boleto Hibrido (boleto + pix) | 3 Para PIX
    "items": [
      // Descrição dos itens para caso tenha descrição no boleto
      {
        "description": "100 MEGAS_FIBRA - UPGRADE = 59.90",
        "quantity": 1,
        "price": 89.93
      }
    ],
    "due_date": "2025-05-10",
    "emission_date": "2025-04-10",
    "value": 89.93, // Valor da cobrança
    "discount_type": "NaoTemDesconto", // ValorFixoAteDataInformada, NaoTemDesconto
    "discount_date": null, // Data limite para desconto (Não obrigatório se for NaoTemDesconto)
    "discount_value": 0, // Valor do desconto (Não obrigatório se for NaoTemDesconto)
    "fine_value": 3, // Multa por atraso percentual do valor total
    "interest_amount": 0.03 // juros por dia
  }
]

Response:

{
  "status": "success",
  "message": "Requisição recebida – as contas a receber estão sendo processadas."
}

Após o envio à API, todas as cobranças são imediatamente registradas em nosso banco de dados e enfileiradas para processamento assíncrono. Assim que o registro junto ao meio de pagamento é concluído, retornamos ao seu sistema as informações de pagamento (PIX, QR Code, linha digitável, código de barras e boleto).

Callback:

{
  "success": true,
  "type": "registered",
  "accounts_receivable_id": "df8a0909-3df3-45ec-94f8-088b4586286a",
  "payment_data": {
    "typeable_line": "21390001171200003300600018637884111690000005900",
    "barcode": "21391116900000059000001112000033000001863788",
    "our_number": "00001863788",
    "pix_copy_and_paste": "00020101021226910014BR.GOV.BCB.PIX2569qrcode-h.bancoarbi.com.br/gi/v2/cobv/4e31686ddbf5453da7959668129c062b5204000053039865802BR5907K8 Bank6008Curitiba61088102067062070503***63041795",
    "qrcode_image": "https://sandbox.meuk8.com.br/pix?data=00020101021226910014BR.GOV.BCB.PIX2569qrcode-h.bancoarbi.com.br/gi/v2/cobv/4e31686ddbf5453da7959668129c062b5204000053039865802BR5907K8 Bank6008Curitiba61088102067062070503***63041795",
    "pdf": "http://painel.localhost/account-receivable/view-pdf/1/df8a01747141482"
  }
}

POST /api/v1/accounts-receivable/{uuid}/cancelCopied!

Este endpoint recebe apenas o identificador da cobrança e enfileira o pedido de cancelamento para processamento em background. A resposta inicial confirma o recebimento (202 Accepted) e, ao concluir o cancelamento junto ao meio de pagamento, a API dispara uma callback para notificar o resultado.

header da request:

Authorization: Bearer {access_token}
Accept: application/json 
Idempotency-Key: "asdsad32312dqs"

Response:

{
  "status": "success",
  "message": "Contas a receber enviada para o cancelamento"
}

Ao término do processamento, a API faz um POST para a url_callback informada, enviando um payload com o status final do cancelamento.

Callback:

{
  "status": "success",
  "accounts_receivable_id": "cd91f563-2f2f-4fa2-be7b-7e5c51669f6f", // UUID do contas a receber no ERP
  "message": "Conta a receber cancelada com sucesso."
}

POST /api/v1/accounts-receivable/searchCopied!

Este endpoint realiza a busca das cobranças registradas no sistema em um intervalo definido pelos parâmetros start_date e end_date, retornando os resultados filtrados conforme os critérios informados.

As datas são referentes as data de emissão de cada conta a receber.

header da request:

Authorization: Bearer {access_token}
Accept: application/json 
Idempotency-Key: "asdsad32312dqs"

Opções de buscas do contas a receber:

{ 
  "all": "Todos", 
  "pending": "Pendente", 
  "approved": "Aprovada", 
  "rejected": "Rejeitada", 
  "cancelled": "Cancelada"
}

O payload deve estar no seguinte formato:

{
  "state": "approved",
  "start_date": "2025-05-09",
  "end_date": "2025-05-09"
}

Response:

[
    {
        "accounts_receivable_id": "d1b60c3a-2f9e-4bd2-80dc-aea8fc0da6e3",
        "client_name": "Mariana Oliveira",
        "status_payment": "Aprovada",
        "paymento_type": "Manual",
        "payment_date": "2025-05-09T20:07:03.15",
        "amount_due": 59,
        "amount_paid": 59,
        "fee_amount": 0
    },
    {
        "accounts_receivable_id": "9c9235f5-b6c5-47d3-b039-363b1534287d",
        "client_name": "Mariana Oliveira",
        "status_payment": "Pendente",
        "paymento_type": "naodefinido",
        "payment_date": null,
        "amount_due": 59,
        "amount_paid": 0,
        "fee_amount": 0
    },
]

POST /api/v1/accounts-receivable/{uuid}/consult-transactionCopied!

Este endepoint permite a busca de uma única conta a receber

header da request:

Authorization: Bearer {access_token}
Accept: application/json 
Idempotency-Key: "asdsad32312dqs"

Response:

{
    "accounts_receivable_id": "8ac8837d-20a2-4d7d-b412-fb28aeb19112",
    "client_name": "Mariana Oliveira",
    "status_payment": "Cancelada",
    "payment_type": "naodefinido",
    "payment_date": null,
    "amount_due": 59,
    "amount_paid": 0,
    "fee_amount": 0
}

POST /api/v1/bank-slip-booklet/{uuid}Copied!

Este endpoint enfileira a criação do carnê em segundo plano. Assim que o processamento for concluído, a API faz um POST para a url_callback informada, enviando o documento do carnê (PDF) com todas as instruções de pagamento.

header da request:

Authorization: Bearer {access_token}
Accept: application/json 
Idempotency-Key: "asdsad32312dqs"

O payload deve estar no seguinte formato:

{
  "url_callback" : "https://webhook.site/39ece621-8750-468b-bcf0-f0ee78a692e7"
}

Response:

{
  "success": true,
  "type": "preparing",
  "message": "Preparando download do carnê.",
  "payment_slip_id": "d9e29314-b37f-4e13-a026-bfaaa44b9b7b"
}

Callback:

API aguarda a conclusão da geração do carnê.
Ao término, dispara um POST para a url_callback com o payload contendo o link para download ou o conteúdo binário do PDF.

{
  "success": true,
  "type": "sent",
  "payment_slip_id": "d9e29314-b37f-4e13-a026-bfaaa44b9b7b",
  "download": "https://painel.homologacao.rami.capital/bank-slip-booklet/13/2453/accountreceivable/booklets/client_marianaoliveiraoi.pdf"
}