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 --request PUT 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/receivables' \
--header 'accept: application/json' \
--header 'Authorization: Bearer acess_token' \
--header 'Content-Type: application/json' \
--data-raw {
  "startAt": "2024-01-01",
  "endAt": "2024-01-30",
  "settlementStartDate": "2024-01-01",
  "settlementEndDate": "2024-01-30",
  "account": 17128,
  "transactions": [
    1,
    2,
    3
  ],
  "brand": [
    "visa",
    "mastercard"
  ],
  "operation": [
    "captured",
    "reversed",
    "chargeback"
  ],
  "status": [
    "payed",
    "payedPartial",
    "pending"
  ],
  "taxMdr": 1.5
}
'

📘
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.

Os campos settlementStartDate e settlementEndDate, possuem prioridade sobre startAt e endAt, sendo obrigatório passar um dos dois conjuntos sempre

Campos da requisição:

Campo	Descrição	Tipo
startAt	Data Esperada da Liquidação	String ($date)
endAt	Data Esperada da Liquidação Final	String ($date)
settlementStartDate	Data Inicial de Pagamento	String ($date)
settlementEndDate	Data Final de Pagamento	String ($date)
account	Número da Conta do BaaS	Int
transactions	Identificador Único das Transações	Int
brand	Bandeira da Transação. Valores possíveis: visa, mastercard	String
operation	Tipo de Operação da Transação. Valores Possíveis: captured, reversed, chargeback	String
status	Status de Pagamento da Transação. Valores Possíveis: payed, payedPartial, pending	String
taxMdr	Valor da Taxa MDR	number

Modelo de retorno: necessário validar retorno de sucesso

{
  "type": true,
  "requestId": "8c4f5d18-2fa0-4425-abce-161282e22b3e",
  "status": "PROCESSING"
}

Note que essa api é síncrona, sendo assim, a Celcoin irá retornar para você o resultado final da solicitação de cadastro da empresa.

Tabela descritiva dos campos retornados

Campo	Descrição	Tipo
type	Retorna se a solicitação foi realizada com sucesso. Valores possíveis: True ou False	Bool
requestId	Identificador da solicitação	String
status	Status da Solicitação. Valores possíveis: processing	String

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