Recursos
Cada recurso da API, com os filtros e os campos principais. A especificação OpenAPI tem todos os tipos.
Em resumo
- Toda listagem aceita
limite,cursoreatualizadoDesde(Sincronização incremental), mais os filtros do recurso. - Todo recurso tem o detalhe por id; id de outra organização responde
404. - Campos em português, sem acento, em camelCase. Datas
AAAA-MM-DD; instantes ISO 8601 com fuso; valores em reais com 2 casas. - A lista completa de campos e tipos está na especificação OpenAPI.
Fornecedores
GET /fornecedores · GET /fornecedores/{id} — permissão fornecedor.ler
| Filtro | Valores |
|---|---|
status | rascunho, ativo, inativo, bloqueado |
| Campo | O que é |
|---|---|
id | Identificador do Afflux. Não muda. |
codigo | Código de negócio do fornecedor, único na organização — o campo para casar com o ERP. |
tipoPessoa | pf ou pj |
documento | CPF (11 dígitos) ou CNPJ (14 dígitos), só números |
razaoSocial, nomeFantasia | Nome e nome fantasia |
inscricaoEstadual, inscricaoMunicipal, simplesNacional, mei | Dados fiscais |
email, telefone, endereco | Contato e endereço (cep, logradouro, numero, complemento, bairro, cidade, uf) |
status | Situação no Afflux |
categoria | Categoria de conformidade (id, nome), quando houver |
Contratos
GET /contratos · GET /contratos/{id} — permissão contrato.ler
| Filtro | Valores |
|---|---|
status | rascunho, emaprovacao (em formalização), ativo, suspenso, encerrado, cancelado |
fornecedorId | id do fornecedor |
Campos principais: numero, objeto, tipo, status, fornecedor (id, codigo, documento, razaoSocial), inicio, fim, valor, moeda, regimeValor, periodicidadeFaturamento, tipoFaturamento, diaVencimento, diaLimiteFaturamento, reajuste (data, indice), classificacao (centroCusto, projeto, departamento, cada um com id, codigo e nome) e encerradoEm.
Documentos de faturamento
GET /documentos-faturamento · GET /documentos-faturamento/{id} · GET /documentos-faturamento/{id}/arquivo — permissão faturamento.ler
| Filtro | Valores |
|---|---|
status | rascunho, registrada, emanalise, aprovada, rejeitada, cancelada |
fornecedorId | id do fornecedor |
Campos principais: tipo (codigo, sigla, rotulo — NF, RPA, recibo…), numero, serie, competencia, emissao, valorBruto, valorLiquido, retencoes (iss, irrf, inss, pis, cofins, csll, em reais ou null), status, origem, linkValidacao, fornecedor, contrato, contaPagarId (a conta gerada na aprovação) e arquivo (nome, tipo, sha256).
Arquivo. GET /documentos-faturamento/{id}/arquivo devolve uma URL assinada válida por 5 minutos para baixar o PDF ou o XML:
{ "url": "https://…", "expiraEm": "2026-10-09T15:35:12.000Z", "nome": "nf-123.pdf", "tipo": "application/pdf" }Baixe logo; se expirar, peça outra. Documento sem arquivo responde 404.
Contas a pagar
GET /contas-pagar · GET /contas-pagar/{id} — permissão financeiro.ler. A situação de pagamento tem página própria: Contas a pagar.
Pagamentos
GET /pagamentos · GET /pagamentos/{id} — permissão financeiro.ler
| Filtro | Valores |
|---|---|
status | pendente, processando, liquidado, falhou, estornado |
contaPagarId | id da conta a pagar |
Campos principais: contaPagarId, fornecedorId, status, meio (pix, ted, boleto, asaassplit, outro), valor, pagoEm, loteId, provedor (asaas ou null para baixa manual), referenciaProvedor, destino (tipo conta ou carteira, contaBancariaId, banco, titularNome) e temComprovante.
O destino é o retrato gravado no pagamento — a prova de para onde o dinheiro foi —, e não a conta bancária vigente hoje.
Dados bancários
GET /fornecedores/{id}/contas-bancarias · GET /contas-bancarias/{id} — permissão contabancaria.ler. Página própria: Dados bancários.
Campos comuns
Todo recurso traz id, criadoEm e atualizadoEm. Referências a outros recursos vêm como objeto pequeno (fornecedor: { id, codigo, documento, razaoSocial }) ou como …Id, para buscar o detalhe quando precisar.