Solicitar Relatório de Recebíveis

Para solicitar os relatórios de seus recebíveis, é necessário realizar uma chamada na api Solicitar Relatórios de Recebíveis utilizando o método POST, onde precisa informar o período que deseja para visualizar seus recebíveis. Os dados necessários estão no quadro "Parâmetros do Body"

Este endpoinet nfileira a geração assíncrona do relatório CSV de recebíveis e retorna o requestId que será
utilizado para consultar o status e efetuar o download posterior.

Modelo de Requisição:


Request

curl --location 'https://sandbox-apicorp.celcoin.com.br/baas/v1/cash/companies/2345678/report-receivables' \
--header 'Authorization: Bearer ...' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "dateFrom": "2026-01-01",
    "dateTo": "2026-01-31"
  }'
📘

Atenção!!!

  • O limite máximo do período de busca são 30 dias.
  • O campo account é obrigatório. Informar o número da conta do BaaS que deseja buscar relatório.
  • O arquivo é expirado após 24 horas.

Campos da requisição:

CampoDescriçãoTipo
dateFromData Esperada da LiquidaçãoString ($date)
dateToData Esperada da Liquidação FinalString ($date)
accountNúmero da Conta do BaaSInt

Modelo de retorno:

{
    "version": "1.0.0",
    "status": 201,
    "body": {
        "requestId": "82553943-7cb5-40eb-93c8-6f2c01b5b7da",
        "status": "SUCCESS"
    }
}

Tabela descritiva dos campos retornados

CampoDescriçãoTipo
typeRetorna se a solicitação foi realizada com sucesso. Valores possíveis: True ou FalseBool
requestIdIdentificador da solicitaçãoString
statusStatus da Solicitação. Valores possíveis: SUCESS e ERRORString
📘

Após solicitação do relatório conteúdo se tornará disponível através da notificação de receivable-report.


Did this page help you?