Planilha

A API permite a criação, busca e download de planilhas, garantindo um gerenciamento eficiente de arquivos relacionados a recebíveis e operações financeiras. Esses métodos possibilitam a manipulação e recuperação de planilhas conforme os filtros aplicados.

Create a New Spreadsheet

Permite o upload de uma nova planilha na plataforma, armazenando dados estruturados para futuras consultas e processamento.

📌 Endpoint

Método: POST
Endpoint: /spreadsheets

Após o upload, a planilha será registrada com um ID único, que poderá ser utilizado para buscas e downloads posteriores.

Find Spreadsheet by Query Filter

Realiza a busca de planilhas cadastradas com base em parâmetros específicos, possibilitando a filtragem de registros conforme a necessidade do usuário.

📌 Endpoint

Método: GET
Endpoint: /spreadsheets

Os filtros aplicáveis permitem encontrar planilhas conforme critérios definidos, garantindo uma consulta mais precisa e organizada.

Get Spreadsheet by ID

Retorna as informações detalhadas de uma planilha específica, fornecendo os metadados e status do arquivo armazenado na plataforma.

📌 Endpoint

Método: GET
Endpoint: /spreadsheets/{id}

Para obter os detalhes, é necessário informar o ID da planilha, que pode ser obtido no momento da criação ou por meio da busca de arquivos.

Download a Spreadsheet by ID

Permite o download de uma planilha cadastrada na plataforma, possibilitando o acesso ao arquivo original conforme a necessidade do usuário.

📌 Endpoint

Método: GET
Endpoint: /spreadsheets/download/{id}

O ID da planilha deve ser informado para que o sistema recupere e disponibilize o arquivo correspondente. Esse método garante que os dados sejam acessados com segurança e integridade.

Status

Status	Descrição
Em Processamento	Arquivo enviado aguardando processamento.
Processado	Arquivo processado e transformado em recebíveis.
Falha	Arquivo apresentou falha no processamento.