Catálogo por domínio

Esta página funciona como índice editorial para a Referência da API. A referência completa contém todos os métodos, parâmetros e respostas expostos pelo backend.

Empresas e cadastro

Grupo principal na referência: Company

Endpoints de destaque:

Método	Caminho	Uso
GET	/api/company/v1/get-user-companies	Lista empresas e papéis do usuário autenticado.
GET	/api/company/v1/{company_role_id}	Consulta dados da empresa no contexto selecionado.
GET	/api/company/v1/{company_role_id}/bank-account	Lista contas bancárias.
POST	/api/company/v1/{company_role_id}/bank-account	Cadastra conta bancária.
GET	/api/company/v1/{company_role_id}/documents	Lista documentos da empresa.
POST	/api/company/v1/{company_role_id}/documents	Cria/anexa documento.

Cotações

Grupo principal na referência: Quotation

Endpoints de destaque:

Método	Caminho	Uso
GET	/api/v1/quotation/{company_role_id}/list	Lista cotações do contexto.
POST	/api/v1/quotation/{company_role_id}/new	Cria uma nova cotação.
GET	/api/v1/quotation/{quotation_id}	Consulta uma cotação.
PATCH	/api/v1/quotation/{quotation_id}	Atualiza parcialmente uma cotação.
PUT	/api/v1/quotation/{quotation_id}/add-invoice	Adiciona nota à cotação.
POST	/api/v1/quotation/{quotation_id}/import-pdf	Importa PDF para extração.

Marketplace e títulos

Grupos principais na referência: Marketplace e Titles

Endpoints de destaque:

Método	Caminho	Uso
GET	/api/v1/marketplace/products	Lista produtos disponíveis.
POST	/api/v1/marketplace/{company_role_id}	Lista títulos no marketplace.
GET	/api/v1/marketplace/{company_role_id}/title/{title_id}	Consulta detalhes de título.
POST	/api/v1/marketplace/{company_role_id}/title/{title_id}/bid	Cria lance.
POST	/api/v1/marketplace/{company_role_id}/title/{title_id}/cancel-bid	Cancela lance.
POST	/api/v1/marketplace/{company_role_id}/title/{title_id}/confirm-payment	Confirma pagamento quando aplicável.

Documentos e extração

Grupos principais na referência: documents e Company

Endpoints de destaque:

Método	Caminho	Uso
GET	/api/company/v1/{company_role_id}/documents/check	Verifica pendências documentais.
POST	/api/company/v1/{company_role_id}/documents/ai-upload	Envia documento para fluxo com análise.
POST	/api/company/v1/{company_role_id}/documents/confirm	Confirma extração documental.
GET	/api/company/v1/{company_role_id}/document-extraction/{extraction_id}/diff	Consulta diferenças da extração.
GET	/api/company/v1/{company_role_id}/documents/zip	Baixa documentos em ZIP.

Contas escrow e relatórios

Grupos principais na referência: Escrow Account e Reports

Endpoints de destaque:

Método	Caminho	Uso
GET	/api/escrow-account/v1/{company_role_id}	Lista contas escrow.
GET	/api/escrow-account/v1/{company_role_id}/accounts/{account_id}/extract	Consulta extrato.
GET	/api/escrow-account/v1/{company_role_id}/accounts/{account_id}/statements	Lista statements.
GET	/api/reports/v1/{company_role_id}/seller-summary	Relatório resumido de cedente.
GET	/api/reports/v1/{company_role_id}/customer-summary	Relatório resumido de cliente/sacado.
GET	/api/reports/v1/{company_role_id}/maturities	Relatório de maturidades.

Autenticação

Grupo principal na referência: Auth

Endpoints de destaque:

Método	Caminho	Uso
POST	/api/auth/v1/token	Obtém token com e-mail e senha.
POST	/api/auth/v1/token/refresh	Renova token.
POST	/api/auth/v1/login	Fluxo de login mantido pelo backend do app.
GET	/api/auth/v1/current-user	Consulta usuário atual.
POST	/api/auth/v1/logout	Encerra sessão quando aplicável.