{ "info": { "name": "Mais Gestão · API Pública (v1)", "description": "API Pública do **Mais Gestão / SGE** para integrações externas.\n\nDocumentação dos recursos públicos de autenticação, cadastros, contas, cobranças,\ndocumentos e relatórios.\n\n## URL base e tenant\n\nCada empresa (tenant) tem seu próprio subdomínio. Todas as chamadas usam o padrão:\n\n```\nhttps://{tenant}.{host}/public-api/v1/...\n```\n\n- `{tenant}` — o subdomínio da sua empresa (ex.: `minha-empresa`).\n- `{host}` — o domínio do ambiente (ex.: `api.maisgestao.com.br`).\n\n## Autenticação e permissões\n\nA chave de acesso é obrigatória. Quando o vínculo da permissão exige login, envie também X-Public-API-Key. O login é `POST /auth/sessions`,\nque exige apenas `X-Public-Access-Key`:\n\n| Cabeçalho | Origem |\n|-----------------------|------------------------------------------------------------------------|\n| `X-Public-Access-Key` | Chave de acesso criada por um administrador no painel. |\n| `X-Public-API-Key` | Chave temporária (24h) obtida em `POST /auth/sessions` (campo `api_key`). |\n\n### Fluxo\n\n1. Chame `POST /auth/sessions` com `{ \"email\", \"password\" }` e o cabeçalho `X-Public-Access-Key`.\n A resposta (**HTTP 201**) traz o campo `api_key`.\n2. Nas chamadas cujo vínculo exige login, envie os dois cabeçalhos: `X-Public-Access-Key`\n e `X-Public-API-Key` (com o valor de `api_key`).\n3. Ao terminar, chame `DELETE /auth/session` com os dois cabeçalhos para encerrar a\n chave de API. Um novo login não encerra as chaves anteriores: cada processo do\n integrador pode ter a sua, e todas valem até expirar (24h) ou serem encerradas.\n\n### Chave de acesso sem login\n\nUma chave de acesso criada com `require_login: false` autentica sem `POST /auth/sessions`:\nbasta o cabeçalho `X-Public-Access-Key`, e as operações seguem registradas em nome\nde um usuário interno de integração. Esse modo é uma escolha do administrador ao\ncriar a chave, por permissão. Só funcionam as permissões concedidas à chave sem\nexigir login, e o administrador deve conceder somente as necessárias. Permissões\nque exigem login respondem **403** sem `X-Public-API-Key`.\n\n## Códigos de resposta\n\n| Situação | Status |\n|-------------------------------------------|--------|\n| Credencial ausente, inválida ou expirada | **401**|\n| Credencial válida, sem permissão | **403**|\n| Erro de validação | 422 |\n| Recurso não encontrado | 404 |\n\n> A criação de cliente (`POST /clients`) retorna **HTTP 201**.\n\n## Paginação e ordenação\n\nO formato da paginação depende da operação: pode haver `data`, `links` e `meta`, um paginador com metadados na raiz ou `data` e `meta` sem links. Consulte o schema da resposta. Use `page` para\nselecionar a página e `per_page` para definir a quantidade de itens.\n`per_page` deve ser um inteiro positivo; valores inválidos retornam **422**.\n\nNas operações que permitem ordenação, `sort_column` deve ser uma das colunas\nindicadas na descrição. Colunas não aceitas retornam **422**, com erro no campo\n`sort_column`. Use `sort_direction=asc` ou `desc`; a aceitação e o tratamento de valores inválidos dependem da operação.\n\n## Valores monetários\n\nNas contas a pagar e a receber, `unit_price`, `balance` e `balance_paid` são\nstrings decimais com duas casas, como `\"1500.00\"`. O mesmo formato se aplica a\n`amount` e `start_amount` dos caixas. Consulte o schema de cada recurso para\nos demais valores e preserve a precisão decimal nos cálculos da integração.\n\n## Catálogo de enums\n\nOs valores abaixo são enviados e recebidos no JSON. Os rótulos ajudam na\nexibição dos dados na integração.\n\n### `status` — contas a pagar e a receber (`AccountStatus`)\n\n| Valor | Rótulo |\n|-------|--------|\n| `pending` | Pendente |\n| `partial` | Parcialmente pago |\n| `paid` | Pago |\n| `overdue` | Atrasado |\n| `canceled` | Cancelado |\n| `partial_overdue` | Atrasado com pagamento parcial |\n\n### `payment_method` — contas e pagamentos (`PaymentMethod`)\n\n| Valor | Rótulo |\n|-------|--------|\n| `pix` | Pix |\n| `bank_slip` | Boleto bancário |\n| `transfer` | Transferência bancária |\n| `check` | Cheque |\n| `credit` | Cartão de crédito |\n| `debit` | Cartão de débito |\n| `debit_account` | Débito em conta |\n| `money` | Dinheiro |\n| `none` | Nenhum |\n\n> `debit` representa cartão de débito; `debit_account`, débito em conta.\n\n### `type` — conta a pagar (`PayableType`)\n\n| Valor | Descrição |\n|-------|--------------|\n| `normal` | Normal |\n| `internal_transfer` | Transferência interna |\n| `credit_bill` | Fatura de cartão |\n| `card_invoice_advance` | Antecipação de fatura |\n\n### `type` na resposta — conta a receber (`ReceivableType`)\n\n| Valor | Rótulo |\n|-------|--------|\n| `normal` | Normal |\n| `internal_transfer` | Transferência Interna |\n\n### `generated_for_entity_type` — conta a pagar (`AccountPayableFor`)\n\n| Valor | Rótulo |\n|-------|--------|\n| `employee` | Funcionário |\n| `intern` | Estagiário |\n| `provider` | Fornecedor |\n| `cashbox` | Caixa |\n| `partner` | Sócio |\n\n### `generated_for_entity_type` — conta a receber (`AccountReceivableFor`)\n\n| Valor | Rótulo |\n|-------|--------|\n| `client` | Cliente |\n| `provider` | Fornecedor |\n| `employee` | Funcionário |\n| `intern` | Estagiário |\n| `cashbox` | Caixa |\n| `partner` | Sócio |\n\n> `generated_for_entity_name` contém o nome da entidade vinculada.\n> O envio de cobranças e as notificações de cobrança exigem uma conta vinculada\n> a `client`. Variáveis de template `{{cliente-*}}` não são preenchidas para\n> outros tipos de entidade.\n\n### `recurrence_type` / `recurrence.type` (`RecurrenceType`)\n\n| Valor | Rótulo |\n|-------|--------|\n| `unique` | Única |\n| `installments` | Parcelada |\n| `monthly` | Mensal |\n| `fortnightly` | Quinzenal |\n| `quarterly` | Trimestral |\n| `semiannually` | Semestral |\n| `annually` | Anual |\n\n> Nas **listagens** de contas o campo se chama `recurrence_type` e é **nulável**\n> (`null` quando a conta não tem recorrência); no **detalhe** o mesmo dado vem no\n> objeto aninhado `recurrence.type`. São dois nomes para o mesmo conceito.\n\n### `standard_launch.type` (`StdLaunchType`)\n\n| Valor | Rótulo |\n|-------|--------|\n| `payable` | Conta a pagar |\n| `receivable` | Conta a receber |\n\n### `addresses[].type` na resposta (`TypeOfPersonalData`)\n\n| Valor | Descrição |\n|-------|--------------|\n| `none` | Padrão |\n| `fiscal` | Fiscal |\n| `contact` | Contato |\n| `charge` | Cobrança |\n\n## Primeiros passos com curl\n\nObtenha no painel a chave de acesso e confirme com o administrador as permissões\nnecessárias. Use o endereço HTTPS da sua empresa. As variáveis abaixo são locais;\nos nomes e segredos de exemplo não são credenciais utilizáveis.\n\n```sh\nexport BASE_URL='https://SUA_EMPRESA.SEUDOMINIO/public-api/v1'\nread -r ACCESS_KEY # informe sua chave sem incluí-la no comando\n\ncurl --fail-with-body --request POST \"$BASE_URL/auth/sessions\" \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --header \"X-Public-Access-Key: $ACCESS_KEY\" \\\n --data '{\"email\":\"integracao@example.com\",\"password\":\"SUBSTITUA_LOCALMENTE\"}'\n```\n\nApós o HTTP 201, copie `api_key` para `API_KEY`. Se houver HTTP 202, conclua o\nsegundo fator conforme o schema de autenticação antes de consultar recursos.\nNão grave senhas, chaves ou respostas de autenticação em logs compartilhados.\n\n```sh\nread -r API_KEY\ncurl --fail-with-body \"$BASE_URL/clients?page=1\" \\\n --header 'Accept: application/json' \\\n --header \"X-Public-Access-Key: $ACCESS_KEY\" \\\n --header \"X-Public-API-Key: $API_KEY\"\n\ncurl --fail-with-body --request DELETE \"$BASE_URL/auth/session\" \\\n --header 'Accept: application/json' \\\n --header \"X-Public-Access-Key: $ACCESS_KEY\" \\\n --header \"X-Public-API-Key: $API_KEY\"\nunset ACCESS_KEY API_KEY\n```\n\nA consulta requer `clients.view`. Para chaves autorizadas pelo administrador a\noperar sem login, siga as condições da seção de autenticação; não envie uma chave\nAPI fictícia. Os exemplos de cadastros e operações usam dados ilustrativos e UUIDs\nsintaticamente válidos: substitua-os por registros da própria empresa. Revisões, versões e hashes devem ser\nobtidos nas consultas atuais antes de confirmar alterações. Eles não\nrepresentam emissão, autorização fiscal ou liquidação financeira reais.\n\n## Precisão dos valores\n\nNão converta strings monetárias de resposta em ponto flutuante binário para fazer\ncálculos. Use um tipo decimal ou centavos inteiros, com arredondamento explícito.\n`\"150.00\"` é uma string decimal em reais; `amount_cents: 15000` é um inteiro em\ncentavos. Campos de entrada declarados como `number` continuam sendo números JSON:\n`150.00`, sem `R$`, vírgula decimal ou separador de milhar. Não troque o tipo indicado\nno schema. Alíquotas, percentuais, tarifas e valores fixos têm unidades próprias;\nconsulte a descrição da operação em vez de interpretar todo número como dinheiro.\n\n## Limites, erros e repetição de pedidos\n\nO login público tem limite configurável, com padrão de 5 tentativas em 1 minuto,\nconsiderando empresa, IP, chave de acesso e e-mail. Os atalhos `/charges` e\n`/service-invoices` compartilham orçamento de consulta e criação por empresa e chave,\ncom padrão de 180 chamadas por minuto. Operações que passam pela API interna estão\nsujeitas também ao limite dessa camada (180 chamadas por minuto). Estes valores\nsão padrões da configuração, não uma franquia garantida. Ao receber 429, respeite\n`Retry-After`; não aumente a concorrência enquanto aguarda.\n\n401 indica credencial ausente, inválida ou expirada; 403 indica recusa de permissão\nou módulo; 402 pode bloquear o acesso por situação da assinatura da empresa. 422\ninforma os campos recusados. Outros erros estão descritos na operação. Um 404 pode\nsignificar que o registro não pertence ao escopo da credencial. Preserve as\ninformações de erro e o identificador da requisição, quando disponível, ao acionar\n[o suporte](https://maisgestaoerp.atlassian.net/servicedesk/), sem incluir segredos.\n\n### Erros em Problem Details (RFC 9457)\n\nTodos os erros HTTP 400–599 da API pública retornam `application/problem+json`\ncom o schema `ProblemDetails`. Esse formato é obrigatório e independe do cabeçalho\n`Accept`; nenhuma negociação de formato é necessária. As respostas de sucesso\nseguem o formato documentado em cada operação.\n\nO problema contém `type` (`about:blank`), `title`, `status`, `detail`, `instance`\n(caminho da requisição pública, sem query string) e `code` textual. O código de\ndomínio é preservado quando disponível; caso contrário, aplica-se o código estável\nassociado ao status. Em 422, `errors` pode conter listas de mensagens por campo em\nPT-BR. `request_id` aparece somente quando disponível no cabeçalho de correlação.\nNos erros fiscais 4xx, `fiscal_codes`, `cause` e `retryable` podem trazer códigos,\ncausa e possibilidade de repetição informados pelo emissor. Em 402, `collection`\npode trazer somente o resumo público da assinatura descrito no schema. Erros 5xx\nsão mascarados e não expõem essas extensões de domínio. Em recusas 422 de PIX\nAutomático, `eligibility` preserva a disponibilidade, o código do motivo e sua\nexplicação pública, sem dados privados do provedor.\nOs cabeçalhos do erro, como `Retry-After`, são preservados. Não interprete o texto de\n`detail` como código de máquina. Confira o schema e os exemplos em cada resposta.\n\n### Acompanhamento de cobranças e emissões\n\nA API pública não oferece cadastro de webhooks externos para o integrador.\nAcompanhe a operação por polling com GET em `/charges/{operation}` ou\n`/service-invoices/{operation}`, ou no `status_url` retornado. Essas consultas são\nsomente leitura. Aguarde entre consultas e respeite os limites e `Retry-After`.\nNão reenvie uma emissão para consultar seu estado, especialmente após timeout ou\nresposta `uncertain`: uma resposta inconclusiva não significa que o provedor não\nrecebeu o pedido. Preserve a identificação e a chave de idempotência da intenção\noriginal. Uma nova intenção de cobrança deve ter sua própria chave.\n\n## Versões e compatibilidade\n\nO prefixo `/v1` identifica a versão das rotas; `info.version` identifica a revisão\ndeste contrato documental. Na revisão 1.1.0, antes do primeiro consumidor,\nas URLs públicas foram substituídas pelas rotas canônicas definidas em\n`routes/public-api-canonical.json`. As URLs antigas foram removidas, sem aliases,\nredirecionamentos ou janela de compatibilidade. Os `operationId` foram preservados.\nAdições opcionais compatíveis podem ser documentadas na mesma versão. Remoção de\ncampo, mudança de tipo, enum ou obrigatoriedade, alteração de significado e mudança\nde envelope exigem avaliação explícita de compatibilidade e nova versão ou\nmigração explícita documentada. A migração de erros desta entrega adota\nProblem Details obrigatório para HTTP 400–599. Não há prazo de descontinuação ou SLA de integração definido por este\ncontrato. Nenhuma operação é marcada como descontinuada sem plano correspondente.\nConsulte os [Termos de Uso](https://maisgestao.com.br/termos-de-uso) para as condições\ndo serviço; esta seção não cria garantias comerciais adicionais.\n\n### Changelog — 01/11/2026 — tributação do ISSQN e comércio exterior (NFS-e nacional)\n\n- **Mudança de significado, com migração:** em `POST /accounts-receivable/{account_receivable}/fiscal-invoice-batches`,\n no `invoice` do facilitador e no `tributacao_issqn` da tool MCP `emitir_nfse`, `issqn_tributation` diferente de\n `none` passa a valer para a nota e sobrepõe a categoria e a empresa. Antes, o valor do pedido não mudava a nota.\n Para seguir a configuração, envie `none` (os exemplos passaram a usar `none`). O campo novo\n `fiscal_config.trib_issqn` (1 a 4) declara a tributação; os dois com valores diferentes retornam 422. A escolha é\n fiscal: confirme com o contador.\n- Em `GET /accounts-receivable/{account_receivable}/fiscal-invoice-eligibility`, `issqn_tributation` devolve `none`\n enquanto a empresa não confirmar a Tributação ISSQN, e o valor da empresa depois de confirmada. Não copie esse valor\n para a nota: ele sobreporia a categoria e a recorrência. Envie `none` para seguir a configuração.\n- Campos novos opcionais em `fiscal_config` (nota, categoria, recorrência e facilitador): `trib_issqn`,\n `tp_imunidade` e os padrões de comércio exterior `comex_md_prestacao`, `comex_mec_af_prestador`,\n `comex_mec_af_tomador`, `comex_mov_temp_bens` e `comex_mdic`.\n- `comercio_exterior` na nota e no facilitador (país do resultado, país da prestação, moeda, valor na moeda\n estrangeira, vínculo e números de declaração) e na recorrência (sem números de declaração, com o valor de\n referência em reais), para a emissão automática.\n- Cliente: `comex_vinculo` e `comex_moeda`. País do endereço: código ISO de duas letras da lista de `/countries`,\n conferido em cliente do exterior (o já gravado é aceito).\n- Configuração fiscal: `issqn_immunity_type`, `confirmar_issqn_tributation` e o marcador\n `issqn_tributation_confirmada_em` (Tributação ISSQN gravada antes de 31/10/2026 só vale depois de confirmada).\n- Verificação de pré-requisitos fiscais: bloco `tributacao_issqn`.\n- **Mudança de significado do `cause` (Problem Details):** toda recusa da verificação do Mais Gestão antes do\n envio ao governo passa a vir com `cause` `recusa_antes_do_envio`, e não mais `regra_de_negocio`. Vale para as\n recusas novas desta entrega e para as que já existiam: competência posterior à emissão (E0015), IBS/CBS,\n retenção maior que o valor do serviço (E0700/E0701) e as demais da retenção, a conferência da DPS antes do envio,\n o código de tributação municipal (desdobramento ambíguo ou sem correlação) e o total aproximado dos tributos.\n `regra_de_negocio` fica só para a rejeição do sistema do governo. As duas continuam com `retryable` `false`:\n para decidir se repete, use `retryable`, não `cause`, e trate valor de `cause` desconhecido como definitivo\n quando `retryable` for `false`.\n- `cause` documenta também `classificacao_categoria` (a classificação de IBS e CBS da categoria falta ou não\n vale; corrigir na categoria), que a API já devolvia.\n- **Códigos internos em `fiscal_codes`:** as recusas da verificação do Mais Gestão que reusavam códigos do\n governo passam a vir com códigos próprios `MG-NFSE-*`, que não existem no manual do governo: E0001 vira\n `MG-NFSE-TELEFONE-TOMADOR` (telefone do cliente) ou `MG-NFSE-RETENCAO-ISSQN` (retenção do ISSQN); E0130 vira\n `MG-NFSE-REGIME-SIMPLES`; E0702 vira `MG-NFSE-TOTTRIB-VALOR`; E0709 vira `MG-NFSE-TOTTRIB-SN-PERCENTUAL`; E1577\n vira `MG-NFSE-IBSCBS-CLASSIFICACAO` (com `cause` `classificacao_categoria`); E0223 vira\n `MG-NFSE-ENDERECO-EXTERIOR` ou `MG-NFSE-PAIS-TOMADOR`. Códigos novos: `MG-NFSE-IBSCBS-CREDITO-PRESUMIDO`,\n `MG-NFSE-PAIS-RESULTADO` e `MG-NFSE-VALOR-MOEDA-RECORRENCIA`. Trate código desconhecido pelo `cause` e pelo\n `retryable`.\n\n### Changelog — 29/10/2026 — contrato 1.1.0\n\n- Rotas públicas canônicas: 144 pares método/path migrados; 539 operationIds, tags,\n segurança, obrigatoriedade e campos de corpo preservados. URLs anteriores removidas\n antes do primeiro consumidor; rotas internas da interface e app permanecem internas.\n\n- Descrições de campos e parâmetros enriquecidas por semântica de domínio.\n- Respostas documentadas por finalidade e exemplos verificados contra schemas.\n- Corrigidos relacionamentos nulos de contas a pagar, envelope da prévia de\n conciliação e mapas de regras de governança conforme o comportamento do runtime.\n- Agrupamento de tags e nomes de exibição, preservando identidades de operação.\n- Primeiros passos de autenticação e consulta por curl, precisão de dinheiro,\n limites de chamadas e acompanhamento por polling GET.\n- Erros HTTP 400–599 obrigatórios em `application/problem+json` (RFC 9457).\n- Verificação local reproduzível de exemplos e qualidade da documentação.\n\n\n### Contexto dos campos de entrada e saída\n\nNa entrada pública de conta a receber, `type` usa RecurrenceType (`unique`, `installments`, `monthly`, `fortnightly`, `quarterly`, `semiannually`, `annually`) e é convertido para `recurrence_type`. O `type` da conta retornada usa ReceivableType (`normal`, `internal_transfer`).\n\nNa saída, `emails[].type` e `phones[].type` são objetos de catálogo com `id`, `name` e `description`. Apenas `addresses[].type` usa TypeOfPersonalData. Na entrada, use as chaves exigidas pelo request da operação, sem copiar o objeto da resposta.\n\nO catálogo administrativo de chaves públicas inclui `api_logs.view`; GET `/permissions` representa a sessão interna e não enumera todas as permissões da chave pública.\n\nNão há rota pública de refresh de autenticação: obtenha outra chave com POST /auth/sessions. Documentos fiscais compostos apenas por zeros e a chave CHAVE_FICTICIA_SEM_VALIDADE_NAO_UTILIZAR são marcadores fictícios, sem validade.\n", "_postman_id": "5b7e2a10-0000-4000-8000-14b562f55114", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "version": "1.1.0" }, "variable": [ { "key": "tenant_subdomain", "value": "minha-empresa" }, { "key": "host", "value": "api.maisgestao.com.br" }, { "key": "base_url", "value": "https://{{tenant_subdomain}}.{{host}}/public-api/v1" }, { "key": "access_key", "value": "" }, { "key": "api_key", "value": "" }, { "key": "login_email", "value": "" }, { "key": "login_password", "value": "" } ], "item": [ { "name": "AccountsPayable", "item": [ { "name": "Listar contas a pagar", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable", "host": [ "{{base_url}}" ], "path": [ "accounts-payable" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Sem sort_column: due_date crescente. Com status=paid: last_payment_date decrescente. A listagem geral não promete partição de contas pagas." } }, { "name": "Criar conta a pagar", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable", "host": [ "{{base_url}}" ], "path": [ "accounts-payable" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"generated_for_entity\": \"provider\",\n \"generated_for_entity_id\": \"00000000-0000-4000-8000-000000000001\",\n \"recurrence_type\": \"unique\",\n \"unit_price\": 100,\n \"payment_method\": \"pix\",\n \"description\": \"Aluguel escritório agosto\",\n \"due_date\": \"2026-11-03\",\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\",\n \"category_id\": \"00000000-0000-4000-8000-000000000001\",\n \"account_standard_launch_id\": \"00000000-0000-4000-8000-000000000001\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria uma conta a pagar e retorna HTTP 201.\n\nPermissões exigidas: `accounts.view` + `accounts.create`.\n\n`account_standard_launch_id` é obrigatório e aceita somente conta contábil do tipo `payable`.\n`generated_for_entity` e `generated_for_entity_id` são obrigatórios: toda conta a pagar tem uma pessoa vinculada (`provider`, `employee`, `intern` ou `partner`), ativa e não excluída; sem ela a resposta é **422**.\n`recurrence_type` é obrigatório: `unique` exige `due_date`; `installments` exige `due_date`, `due_day` e `installments` (1–300), exceto com `payment_method: credit` (cartão de crédito), que dispensa `due_day`: cada parcela cai no mesmo dia da primeira data; os demais tipos recorrentes exigem `due_date` e `due_day` (1–31). Recorrência só com `due_day` retorna **422** e não grava nada. Em `installments`, `unit_price` é o valor TOTAL da compra, não o de cada parcela: R$ 100,00 em 3x gera 33,33 + 33,33 + 33,34 (a diferença de centavos fica na última parcela, e a soma sempre fecha). Compra no cartão de crédito (`payment_method: credit`), única ou parcelada, nasce SEMPRE em aberto, porque pode ser só um provisionamento (despesa futura ou recorrente); sem caixa (`cashbox_id` nulo). Para baixá-la no cartão use o cadastro assistido (`POST /accounts-payable/assisted`) com o bloco `payment` (\"Já paga\"): na única ele baixa a conta e na parcelada baixa todas as parcelas, cada uma na data do seu vencimento e na fatura do seu ciclo. Cartão inativo é recusado com **422** (\"Não é possível cadastrar compra em um cartão inativo.\").\n`limit_date` pode ser enviado no topo ou em `recurrence.limit_date`; o valor do topo tem precedência. O objeto `recurrence` é opcional.\n\nCampos condicionados a permissões do usuário:\n- `cashbox_id`: obrigatório com `cashboxes.view` quando o método não é `credit`.\n- `category_id`: obrigatório com `categories.view`.\n- `card_id`: obrigatório com `cards.view` quando `payment_method = credit`.\n\nA resposta usa o mesmo recurso de detalhe e atualização, incluindo `generated_for_entity_type` e `generated_for_entity_name`. Valores monetários são strings decimais.\n\nRetorna **HTTP 201** em caso de sucesso.\n" } }, { "name": "Obter conta a pagar", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable" ], "variable": [ { "key": "account_payable", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de uma conta a pagar.\n\n**Permissão exigida:** `accounts.view`\n" } }, { "name": "Editar conta a pagar", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable" ], "variable": [ { "key": "account_payable", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"due_date\": \"2026-11-03\",\n \"payment_method\": \"pix\",\n \"unit_price\": 100,\n \"description\": \"Aluguel escritório setembro\",\n \"recurrence\": {\n \"due_day\": 1\n },\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\",\n \"category_id\": \"00000000-0000-4000-8000-000000000001\",\n \"account_standard_launch_id\": \"00000000-0000-4000-8000-000000000001\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza os dados de uma conta a pagar.\n\n**Permissões exigidas:** `accounts.view` + `accounts.update`.\n\n`account_standard_launch_id` é obrigatório e aceita somente conta contábil do tipo `payable`.\nNa edição, omitir generated_for_entity e generated_for_entity_id preserva a pessoa atual. Se a conta não tiver pessoa, informe o par. Uma pessoa diferente precisa estar ativa e não excluída, entre os tipos permitidos. Reenviar exatamente o vínculo atual preserva inclusive vínculos legados ou pessoas posteriormente inativadas; ausência de um par válido quando exigido retorna 422.\nO dia da recorrência pode ser enviado em `recurrence.due_day` ou em `due_day` no primeiro nível. O valor do primeiro nível tem precedência. Se ambos forem omitidos, o dia atual é preservado.\n" } }, { "name": "Excluir conta a pagar", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable" ], "variable": [ { "key": "account_payable", "value": "" } ], "query": [] }, "description": "Exclui uma conta a pagar e retorna **204**, sem corpo.\n\n**Permissões exigidas:** `accounts.view` + `accounts.delete`.\nFaturas de cartão não podem ser excluídas; a resposta é **400**. Uma conta paga (ou parcialmente paga) **pode** ser excluída: as baixas dela são estornadas e o saldo de cada caixa volta ao que era antes do pagamento. Não há conta paga que fique fora do caixa.\n" } }, { "name": "Cancelar conta a pagar", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable/cancellations", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable", "cancellations" ], "variable": [ { "key": "account_payable", "value": "" } ], "query": [ { "key": "cancel_recurrent", "value": "", "disabled": true, "description": "Se `true`, cancela também as ocorrências futuras da recorrência.\nAceita `true`/`false`/`1`/`0`.\n" } ] }, "description": "Cancela uma conta a pagar com status `pending` ou `overdue`.\n\n**Permissões exigidas:** `accounts.view` + `accounts.update`.\n\nEnvie `cancel_recurrent=true` para cancelar também as ocorrências futuras da recorrência, ou `false` para cancelar somente esta conta. Um valor não booleano retorna **422** no campo `cancel_recurrent`.\nContas em outros estados retornam **403**.\n\nEsta operação muda estado e por isso usa **POST** (como o cancelamento de conta a receber). Um `GET` neste caminho não existe mais.\n" } }, { "name": "Download da nota fiscal", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable/invoice", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable", "invoice" ], "variable": [ { "key": "account_payable", "value": "" } ], "query": [] }, "description": "Faz o download da nota fiscal de uma conta a pagar, em PDF ou imagem.\n\n**Permissão exigida:** `accounts.view`.\nA resposta contém o arquivo binário. Se o arquivo estiver indisponível, pode retornar **404**.\n" } }, { "name": "Listar pagamentos da conta", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable/payments", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable", "payments" ], "variable": [ { "key": "account_payable", "value": "" } ], "query": [] }, "description": "Retorna os pagamentos registrados para uma conta a pagar.\n\n**Permissões exigidas:** `accounts.view` + `payments.view`\n" } }, { "name": "Registrar pagamento", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable/payments", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable", "payments" ], "variable": [ { "key": "account_payable", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-10-01\",\n \"payment_method\": \"pix\",\n \"value_paid\": 50,\n \"description\": \"Pagamento parcial julho\",\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\",\n \"category_id\": \"00000000-0000-4000-8000-000000000001\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Registra um pagamento total ou parcial em uma conta a pagar.\n\n**Permissões exigidas:** `accounts.view` + `payments.create`.\n\n`value_paid` é o total desembolsado e **já inclui** os acréscimos: para quitar uma conta de 100,00 com juros de 5,00 e multa de 2,50, envie `value_paid: 107.50`, `interest: 5.00` e `penalty: 2.50`. O valor efetivo abatido da conta é `value_paid` menos os acréscimos (`penalty`, `interest`, `charges`, `expedient`, `iof`, `insurance`, `agreement`) e mais `discount_obtained` (o desconto concedido, `discount_granted`, só existe em conta a receber: enviar um valor maior que zero é recusado com **422**). A soma do efetivo com o já pago não pode exceder `unit_price`; caso contrário, a resposta é **400**.\n\nConta cancelada não recebe baixa (**400**), assim como conta já paga. Conta **arquivada** também não recebe baixa manual (**400**, \"Esta conta está arquivada. Desarquive a conta antes de registrar a baixa.\"). A despesa gerada pela tarifa de um recebimento não recebe baixa (**400**). `date` não pode ser futura e todos os campos de dinheiro aceitam no máximo 2 casas decimais (**422**).\n\nEnvie o cabeçalho `Idempotency-Key` (até 200 caracteres) para repetir a chamada com segurança: duas chamadas com a mesma chave geram uma única baixa e a segunda devolve a conta no estado atual. A mesma chave com outro conteúdo retorna **409** (`code: idempotency_key_reused`); gere uma chave nova para uma operação nova. Sem o cabeçalho, cada chamada é uma baixa nova.\n\nA resposta traz a conta já com `status`, `balance` e `balance_paid` depois da baixa.\n\nCampos condicionados a permissões do usuário:\n- `cashbox_id`: obrigatório com `cashboxes.view` quando o método não é cartão.\n- `card_id`: obrigatório com `cards.view` quando `payment_method=credit`.\n- `account_standard_launch_id`: opcional, aceita somente conta contábil do tipo `payable`. Quando omitido, preserva a conta contábil atual.\n- `category_id`: obrigatório com `categories.view` quando a conta não é uma fatura de cartão.\n\nCampos auxiliares, como `penalty`, `interest` e `charges`, aceitam valores numéricos maiores ou iguais a zero, ou `null`.\n" } }, { "name": "Excluir pagamento", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable/payments/:payment", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable", "payments", ":payment" ], "variable": [ { "key": "account_payable", "value": "" }, { "key": "payment", "value": "" } ], "query": [] }, "description": "Exclui um pagamento da conta a pagar e retorna **204**, sem corpo.\n\n**Permissões exigidas:** `accounts.view` + `payments.delete`.\nO pagamento deve pertencer à conta indicada na URL. Um identificador inexistente ou vinculado a outra conta retorna **404**.\n\nA baixa de uma transferência entre caixas e a baixa da despesa gerada pela tarifa de um recebimento não podem ser estornadas por aqui (**400**): exclua a transferência, ou altere a tarifa no recebimento.\n" } }, { "name": "Download do comprovante", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/:account_payable/receipt", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", ":account_payable", "receipt" ], "variable": [ { "key": "account_payable", "value": "" } ], "query": [] }, "description": "Faz o download do comprovante de pagamento em PDF.\n\n**Permissão exigida:** `accounts.view`.\nA resposta contém o arquivo binário. Se o arquivo estiver indisponível, a operação pode retornar **404**.\n" } } ] }, { "name": "AccountsReceivable", "item": [ { "name": "Listar contas a receber", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Retorna uma lista paginada de contas a receber do tenant.\n\nPermissão exigida: `accounts.view`.\n\n**Ordenação:** `sort_column` aceita `client`, `due_date`, `original_due_date`, `balance`, `balance_paid`, `unit_price`, `description`, `document_number`, `installment`, `installments`, `status`, `type`, `payment_method`, `reconciled`, `created_at`, `updated_at`. Colunas fora da lista retornam **422** no campo `sort_column`. Use `sort_direction=asc` ou `desc`; quando omitido ou inválido, o sentido é `asc`.\n" } }, { "name": "Criar conta a receber", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"monthly\",\n \"unit_price\": 150.0,\n \"payment_method\": \"pix\",\n \"due_date\": \"2026-11-10\",\n \"due_day\": 10,\n \"generated_for_entity\": \"client\",\n \"generated_for_entity_id\": \"00000000-0000-4000-8000-000000000001\",\n \"description\": \"Serviço de consultoria\",\n \"observation\": \"Observação interna\",\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\",\n \"category_id\": \"00000000-0000-4000-8000-000000000001\",\n \"account_standard_launch_id\": \"9c541dc4-2222-4eaf-a643-aadd48c0a2fb\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria uma conta a receber e retorna HTTP 201.\n\nPermissões exigidas: `accounts.view` + `accounts.create`.\n\n`cashbox_id` é sempre obrigatório. `account_standard_launch_id` é obrigatório e aceita somente conta contábil do tipo `receivable`.\n`category_id` é obrigatório quando o usuário tem `categories.view`.\n\nCampos condicionais por `type`:\n- `unique`: `due_date` obrigatório, uma data válida em dia útil.\n- `monthly`, `fortnightly`, `quarterly`, `semiannually`, `annually`: `due_day` obrigatório (1–31).\n- `installments`: `due_date`, `due_day` (1–31) e `installments` (1–300) obrigatórios. Em `installments`, `unit_price` é o valor TOTAL da compra, não o de cada parcela: R$ 100,00 em 3x gera 33,33 + 33,33 + 33,34 (a diferença de centavos fica na última parcela, e a soma sempre fecha). Contas já criadas não mudam.\n\n`generated_for_entity` aceita `client`, `provider`, `employee`, `intern` e `partner`. O identificador `generated_for_entity_id` deve pertencer a uma entidade ativa e não excluída do tipo informado.\n\nRetorna **HTTP 201** em caso de sucesso.\n" } }, { "name": "Obter conta a receber", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de uma conta a receber, incluindo pagamentos, caixa,\ncategoria, recorrência e lotes de RPS.\n\nPermissão exigida: `accounts.view`.\n" } }, { "name": "Editar conta a receber", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"monthly\",\n \"unit_price\": 250.0,\n \"payment_method\": \"pix\",\n \"due_date\": \"2027-04-07\",\n \"due_day\": 10,\n \"description\": \"Serviço de consultoria — revisado\",\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\",\n \"category_id\": \"00000000-0000-4000-8000-000000000001\",\n \"account_standard_launch_id\": \"9c541dc4-2222-4eaf-a643-aadd48c0a2fb\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza os dados de uma conta a receber.\n\n**Permissões exigidas:** `accounts.view` + `accounts.update`.\n\n`account_standard_launch_id` é obrigatório e aceita somente conta contábil do tipo `receivable`.\nNa edição, omitir generated_for_entity e generated_for_entity_id preserva a pessoa atual. Se a conta não tiver pessoa, informe o par. Uma pessoa diferente precisa estar ativa e não excluída, entre os tipos permitidos. Reenviar exatamente o vínculo atual preserva inclusive vínculos legados ou pessoas posteriormente inativadas; ausência de um par válido quando exigido retorna 422.\n`type=unique` exige `due_date`; tipos recorrentes exigem `due_day`; `type=installments` exige também `installments` (1–300).\nQuando `due_day` não é enviado, o valor atual é preservado. Datas de pagamento devem ser datas válidas; expressões relativas, como `tomorrow`, retornam **422**.\n\nQuando existe boleto ativo, a edição também pode solicitar sua alteração ao provedor. A conta e a intenção de atualização são gravadas antes dessa solicitação. Se a comunicação falhar ou a resposta não confirmar o mesmo boleto e pedido, retorna **409** com a intenção local preservada; a resposta não significa que a alteração foi desfeita.\nConsulte a conta e `GET /accounts-receivable/{account_receivable}/bank-slip` antes de solicitar outra alteração. `update_sync_status` é somente leitura: `pending` indica alteração em andamento, `uncertain` indica resultado externo inconclusivo e `synced` indica sincronização confirmada; `null` indica ausência desse acompanhamento. Esse campo não substitui a situação financeira em `status`.\nUma tentativa posterior não reenvia a alteração anterior automaticamente. Quando houve mudança de valor ou vencimento, o servidor pode conferir o resultado por consulta autenticada ao provedor, exigindo coincidência de identificador, pedido, valor e vencimento. Uma edição apenas textual ou de pagador com resultado incerto exige conferência pelo suporte, pois essa consulta não comprova todos os campos alterados.\nReserva de emissão ainda sem confirmação, outra atualização em andamento ou mudança do boleto vinculado durante a edição retornam **409** antes de alterar a conta. Provedor que não permite editar o boleto por esta operação retorna **422**. Não crie outra cobrança para contornar um resultado incerto.\n" } }, { "name": "Excluir conta a receber", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "description": "Exclui uma conta a receber e retorna **204**, sem corpo.\n\n**Permissões exigidas:** `accounts.view` + `accounts.delete`.\nUma conta paga pode ser excluída: as baixas dela são estornadas e o saldo do caixa volta ao que era antes do recebimento. Conta com boleto ou nota fiscal ativos não pode ser excluída (**400**).\n" } }, { "name": "Contas com mesmo vencimento", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/accounts-with-same-due-date", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "accounts-with-same-due-date" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "description": "Retorna um array de contas a receber com a mesma data de vencimento\nda conta informada.\n\nPermissão exigida: `accounts.view`.\n" } }, { "name": "Cancelar conta a receber", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/cancellations", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "cancellations" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"pending\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cancela uma conta a receber, alterando seu status para `canceled`.\n\n**Permissões exigidas:** `accounts.view` + `accounts.update`.\n\nSem `status` no corpo, cancelar uma conta `pending` retorna **200**. Repetir a chamada em uma conta já cancelada também retorna **200**.\nCom `status` no corpo, somente contas `pending` e `overdue` podem ser canceladas; contas pagas, parciais ou já canceladas retornam **400**.\n" } }, { "name": "Listar pagamentos da conta", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/payments", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "payments" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "description": "description na baixa altera o histórico da conta a receber. Ausência preserva a descrição da conta; null explícito limpa a descrição. O pagamento não possui descrição própria prometida por esta operação." } }, { "name": "Registrar pagamento", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/payments", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "payments" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-08-01\",\n \"payment_method\": \"pix\",\n \"value_paid\": 50.0,\n \"penalty\": null,\n \"interest\": null,\n \"charges\": null,\n \"description\": \"Histórico atualizado da conta\",\n \"cashbox_id\": null,\n \"category_id\": null\n}", "options": { "raw": { "language": "json" } } }, "description": "Registra um pagamento para a conta a receber.\n\n**Permissões exigidas:** `accounts.view` + `payments.create`.\n\n`value_paid` é o total recebido e **já inclui** os acréscimos: para quitar uma conta de 100,00 com juros de 5,00 e multa de 2,50, envie `value_paid: 107.50`, `interest: 5.00` e `penalty: 2.50`. O efetivo abatido da conta é `value_paid` menos os acréscimos, mais `discount_granted` (o desconto concedido quita junto: conta de 100,00 com juros de 5,00, multa de 2,00 e desconto concedido de 3,00 fica quitada com `value_paid: 104.00`), mais `fed_retention`, `iss_retention` e `gateway_fee`. O desconto obtido (`discount_obtained`) só existe em conta a pagar: enviar um valor maior que zero é recusado com **422**.\n\nContas totalmente pagas, contas canceladas e pagamentos cuja soma exceda `unit_price` retornam **400**.\n`category_id` é obrigatório quando o usuário tem `categories.view`.\n`date` não pode ser futura e os campos de dinheiro aceitam no máximo 2 casas decimais (**422**). Cada retenção (`fed_retention`, `iss_retention`) e a soma delas não podem passar de `value_paid` (**422**). Os campos de acréscimo e desconto não aceitam valores negativos.\n\nEnvie o cabeçalho `Idempotency-Key` (até 200 caracteres) para repetir a chamada com segurança: duas chamadas com a mesma chave geram uma única baixa e a segunda devolve a conta no estado atual. A mesma chave com outro conteúdo retorna **409** (`code: idempotency_key_reused`); gere uma chave nova para uma operação nova. Sem o cabeçalho, cada chamada é uma baixa nova.\n\nA resposta traz a conta já com `status`, `balance` e `balance_paid` depois da baixa.\n" } }, { "name": "Editar pagamento", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/payments/:payment", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "payments", ":payment" ], "variable": [ { "key": "account_receivable", "value": "" }, { "key": "payment", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"pix\",\n \"date\": \"2026-10-01\",\n \"value_paid\": 50\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza um pagamento da conta a receber.\n\n**Permissões exigidas:** `accounts.view` + `payments.update`.\nO pagamento deve pertencer à conta indicada na URL. Dados inválidos retornam **422**, com os erros de validação no corpo.\n\nA baixa de uma transferência entre caixas não pode ser editada (**400**: \"A baixa de uma transferência entre caixas não pode ser editada. Exclua a transferência e registre de novo.\"). Enviar `cashbox_id` nulo é recusado (**422**: \"Para tirar a baixa do caixa, estorne a baixa.\"); omitir o campo preserva o caixa atual. Informar `gateway_fee` maior que zero gera, e este endpoint ajusta, a despesa paga \"Tarifas financeiras\" sem movimentar caixa.\nOmitir `gateway_fee` preserva a tarifa atual; enviar `null` ou `0` limpa a tarifa e remove a despesa derivada. A tarifa efetiva, inclusive a preservada por omissão, deve ser menor ou igual ao novo `value_paid` (valor líquido recebido). Se exceder, retorna **422** em `errors.gateway_fee`, sem alterar conta, baixa, caixa ou despesa derivada.\n" } }, { "name": "Excluir pagamento", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/payments/:payment", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "payments", ":payment" ], "variable": [ { "key": "account_receivable", "value": "" }, { "key": "payment", "value": "" } ], "query": [] }, "description": "Exclui um pagamento da conta a receber, revertendo o saldo, e retorna **204**, sem corpo. Estorna junto a despesa de tarifa gerada pelo recebimento. A baixa de uma transferência entre caixas não pode ser estornada por aqui (**400**): exclua a transferência.\n\n**Permissões exigidas:** `accounts.view` + `payments.delete`.\n" } } ] }, { "name": "AdministrativeDocuments", "item": [ { "name": "Listar documentos administrativos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents", "host": [ "{{base_url}}" ], "path": [ "administrative-documents" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "active", "value": "", "disabled": true, "description": "Filtra por documento ativo (`1`) ou inativo (`0`). Ausente = todos." }, { "key": "search", "value": "", "disabled": true, "description": "Busca por trecho do nome do documento OU do nome do dono (cliente, fornecedor, funcionário, estagiário)." }, { "key": "documentable_type", "value": "", "disabled": true, "description": "Tipo do dono. Aceita uma chave, lista separada por vírgula (`client,provider`) ou array (`documentable_type[]=client`)." }, { "key": "documentable_id", "value": "", "disabled": true, "description": "UUID do dono: devolve só os documentos vinculados a ele." }, { "key": "created_from", "value": "", "disabled": true, "description": "Data inicial (inclusiva) de criação do documento, sobre `created_at`." }, { "key": "created_to", "value": "", "disabled": true, "description": "Data final (inclusiva) de criação do documento, sobre `created_at`." }, { "key": "vigencia", "value": "", "disabled": true, "description": "Recorte por vigência, sobre `expires_at`:\n`vigentes` (com validade e `expires_at >= hoje`), `expirados` (`expires_at < hoje`),\n`sem_validade` (`expires_at` nulo — documento que não expira) e `todos` (padrão, sem filtro).\nOs três primeiros particionam a tabela.\n" }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página; ausente ou vazio usa o padrão da listagem." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Retorna uma lista paginada de documentos administrativos do tenant.\n\nFiltros de vínculo e vigência: `documentable_type`, `documentable_id`, `created_from`,\n`created_to` e `vigencia`. Valor inválido em qualquer um deles responde **422** nomeando o campo.\n`search` também alcança o nome do dono do documento.\n\n**Ordenação:** `sort_column` aceita `name`, `description`, `active`, `created_at`, `updated_at`. Colunas fora da lista retornam **422** no campo `sort_column`. Use `sort_direction=asc` ou `desc`; quando omitido ou inválido, o sentido é `asc`.\n\nPermissões exigidas na chave de acesso: `admin_documents.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Criar documento administrativo", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents", "host": [ "{{base_url}}" ], "path": [ "administrative-documents" ], "query": [] }, "description": "Cria um novo documento administrativo com um ou mais arquivos anexados.\nUse `multipart/form-data` pois o campo `attachments` aceita arquivos binários.\n\n**Permissões necessárias:** `admin_documents.view` + `admin_documents.create`\n\n\nRetorna **HTTP 201** em caso de sucesso.\n", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Contrato Social", "type": "text", "disabled": false, "description": "Nome do documento. Obrigatório." }, { "key": "description", "value": "Documento de constituição da empresa.", "type": "text", "disabled": false, "description": "Descrição do documento. Obrigatória." }, { "key": "documentable_type", "value": "client", "type": "text", "disabled": false, "description": "Tipo do dono do documento. Obrigatório." }, { "key": "documentable_id", "value": "9c541dc4-cb1f-4eaf-a643-aadd48c0a2fb", "type": "text", "disabled": false, "description": "UUID do dono. Obrigatório e tem de existir na tabela do tipo informado (id de fornecedor com `documentable_type=client` é 422)." }, { "key": "expires_at", "value": "2027-12-31", "type": "text", "disabled": false, "description": "Validade do documento (`Y-m-d`). Nulo ou ausente = não expira." }, { "key": "attachments", "type": "file", "src": [], "disabled": false, "description": "De 1 a 10 PDFs, até 100 MB por arquivo. Os PDFs são mesclados em um único anexo; não aceita DOCX/XLSX/PNG/TXT." } ] } } }, { "name": "Obter documento administrativo", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents/:administrative_document", "host": [ "{{base_url}}" ], "path": [ "administrative-documents", ":administrative_document" ], "variable": [ { "key": "administrative_document", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de um documento administrativo, incluindo a lista de anexos.\n\n**Permissões necessárias:** `admin_documents.view`\n" } }, { "name": "Editar documento administrativo", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents/:administrative_document", "host": [ "{{base_url}}" ], "path": [ "administrative-documents", ":administrative_document" ], "variable": [ { "key": "administrative_document", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Contrato Social Atualizado\",\n \"description\": \"Descrição atualizada do documento.\",\n \"documentable_type\": \"client\",\n \"documentable_id\": \"9c541dc4-cb1f-4eaf-a643-aadd48c0a2fb\",\n \"expires_at\": \"2027-12-31\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza o nome e a descrição de um documento administrativo existente.\n\nA regra `unique` no campo `name` ignora o próprio registro (ignore self),\nmas rejeita com 422 se o nome já pertencer a outro documento.\n\n**Permissões necessárias:** `admin_documents.view` + `admin_documents.update`\n" } }, { "name": "Excluir documento administrativo", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents/:administrative_document", "host": [ "{{base_url}}" ], "path": [ "administrative-documents", ":administrative_document" ], "variable": [ { "key": "administrative_document", "value": "" } ], "query": [] }, "description": "Exclui um documento administrativo. Retorna **204**, sem corpo, quando encontrado.\n\n**Permissões exigidas:** `admin_documents.view` + `admin_documents.delete`.\n" } }, { "name": "Adicionar anexo(s) a um documento", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents/:administrative_document/attachment", "host": [ "{{base_url}}" ], "path": [ "administrative-documents", ":administrative_document", "attachment" ], "variable": [ { "key": "administrative_document", "value": "" } ], "query": [] }, "description": "Envia PDF somente quando o documento ainda não possui anexo. Documento com anexo é recusado com 409 conflict, preservando o anexo anterior; esta operação não faz append ilimitado.", "body": { "mode": "formdata", "formdata": [ { "key": "attachments", "type": "file", "src": [], "disabled": false, "description": "Um ou mais arquivos. Obrigatório no POST (required|array|min:1). Formatos aceitos: .ppt, .pptx, .doc, .docx, .pdf, .xls, .xlsx." } ] } } }, { "name": "Excluir anexo de documento administrativo", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents/:administrative_document/attachment/:administrative_attachment", "host": [ "{{base_url}}" ], "path": [ "administrative-documents", ":administrative_document", "attachment", ":administrative_attachment" ], "variable": [ { "key": "administrative_document", "value": "" }, { "key": "administrative_attachment", "value": "" } ], "query": [] }, "description": "Exclui um anexo de um documento administrativo.\n\n**Permissão exigida:** `admin_documents.view`.\n" } }, { "name": "Baixar anexo de documento administrativo", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents/:administrative_document/attachments/:administrative_attachment/file", "host": [ "{{base_url}}" ], "path": [ "administrative-documents", ":administrative_document", "attachments", ":administrative_attachment", "file" ], "variable": [ { "key": "administrative_document", "value": "" }, { "key": "administrative_attachment", "value": "" } ], "query": [] }, "description": "Faz o download do arquivo de um anexo de documento administrativo.\n\n**Permissão exigida:** `admin_documents.view`.\nO documento e o anexo devem existir, e o arquivo deve estar disponível. Identificadores inexistentes retornam **404**.\n" } }, { "name": "Alternar status do documento (ativo/inativo)", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/administrative-documents/:administrative_document/status-transitions", "host": [ "{{base_url}}" ], "path": [ "administrative-documents", ":administrative_document", "status-transitions" ], "variable": [ { "key": "administrative_document", "value": "" } ], "query": [] }, "description": "Inverte o campo `active` do documento (ativa se inativo, inativa se ativo).\n\n**Permissões necessárias:** `admin_documents.view` + `admin_documents.update`\n" } } ] }, { "name": "Autenticação", "item": [ { "name": "Gerar chave de API (X-Public-API-Key)", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/auth/sessions", "host": [ "{{base_url}}" ], "path": [ "auth", "sessions" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"usuario@empresa.com\",\n \"password\": \"sua-senha\",\n \"code\": \"012345\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Autentica um usuário ativo vinculado à chave de acesso. Envie X-Public-Access-Key; a chave X-Public-API-Key ainda não é necessária.\n\nSem segundo fator, retorna 201 com api_key e validade. Com segundo fator configurado, retorna 202 com challenge_id, method e expires_at, sem api_key. Para concluir, repita este POST com email, password, challenge_id e o código de seis caracteres. O desafio pertence ao mesmo usuário, empresa e chave de acesso.\n\nO método otp usa o aplicativo autenticador. email_sms usa o envio já configurado para o usuário. Desafios expirados exigem novo login. Apenas a resposta 201 libera X-Public-API-Key para chamadas autenticadas. Senha, e-mail e códigos não são devolvidos na resposta. Respeite Retry-After em respostas 429." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var json = pm.response.json();", "if (json && json.api_key) { pm.collectionVariables.set('api_key', json.api_key); }", "pm.test('login 201', function () { pm.expect(pm.response.code).to.eql(201); });" ] } } ] }, { "name": "Encerrar chave de API", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/auth/session", "host": [ "{{base_url}}" ], "path": [ "auth", "session" ], "query": [] }, "description": "Encerra a chave de API enviada em X-Public-API-Key. A chave deixa de valer imediatamente; as demais chaves do mesmo usuário continuam válidas até expirar. Envie X-Public-Access-Key e X-Public-API-Key.\n\nSem X-Public-API-Key (chave de acesso sem login), não há o que encerrar e a resposta é 422." } } ] }, { "name": "BankSlip", "item": [ { "name": "Listar boletos da conta a receber", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/bank-slip", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "bank-slip" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "description": "Retorna os boletos vinculados à conta a receber como um array JSON, sem paginação. O array é vazio quando não há boletos.\n\n**Permissão exigida:** `accounts.view`.\n\nCada boleto inclui seus dados de identificação, valores, vencimento, status e datas, além de:\n- `accounts`: contas a receber vinculadas.\n- `downloadUrl`: URL temporária para download do PDF, válida por uma hora; `null` em reserva de emissão, sem documento disponível ou em PIX puro.\n\nUse `number` como identificador do boleto na conciliação da integração.\n\n`number`, `digitable` e `link` podem ser `null` enquanto a reserva de emissão aguarda confirmação ou o artefato ainda não está disponível. A presença do registro não comprova emissão concluída.\n`update_sync_status`, somente leitura, acompanha alterações de um boleto existente: `pending`, `uncertain`, `synced` ou `null` quando não há acompanhamento. Não indica pagamento nem substitui a situação financeira em `status`. Consulte a conta e o boleto após um conflito de edição; uma consulta desta lista não reenvia a alteração ao provedor.\n" } }, { "name": "Emitir boleto para a conta a receber", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/bank-slip", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "bank-slip" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n \"00000000-0000-4000-8000-000000000001\"\n ],\n \"penalty\": 2,\n \"tax\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Emite um boleto para a conta a receber e retorna **201**.\n\n**Permissões exigidas:** `accounts.view` + `bank_slip.emit`.\n\nCada conta pode ter somente um boleto ativo. Uma nova emissão enquanto houver boleto não cancelado retorna **400**. O vencimento da conta não pode ser anterior a hoje (data de São Paulo): nesse caso a resposta é **422**. A emissão exige configuração de cobrança e endereço válido do cliente.\n\nParâmetros opcionais de juros e multa (valores padrão: zero):\n\n| Campo | Descrição |\n|-------|-----------|\n| `type_penalty` | Use `fix` para multa fixa; caso contrário, percentual. |\n| `penalty` | Valor (R$, com `type_penalty` `fix`) ou percentual de multa, de 0 a 100%. |\n| `type_tax` | Use `fix` para juros fixos; caso contrário, percentual. |\n| `tax` | Valor (R$, com `type_tax` `fix`) ou percentual de juros **ao mês**, de 0 a 30% ao mês. |\n" } }, { "name": "Dados da conta para emissão de boleto", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/bank-slip/data", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "bank-slip", "data" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "description": "Retorna os dados da conta a receber para pré-visualização da emissão de boleto.\n\n**Permissão exigida:** `accounts.view`.\n\nAlém dos dados da conta, a resposta inclui:\n- `client`: dados fiscais e de contato do cliente; `null` quando não há entidade geradora.\n- `taxes`: tributos da categoria; `null` quando não há categoria ou entidade.\n- `active_rps_amount`: valor líquido da NFS-e ativa vinculada; zero quando ausente.\n\nNão é necessário ter um boleto emitido para consultar estes dados.\n" } } ] }, { "name": "CardBills", "item": [ { "name": "Listar faturas do cartão", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card/bills", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "bills" ], "variable": [ { "key": "card", "value": "" } ], "query": [] }, "description": "Retorna as faturas do cartão como um array JSON, sem paginação.\nCada item contém `id`, `due`, `close`, `card_recon`, `account_bill`, `accounts_advance` e `payments`.\n\nCada fatura inclui também card_id, summary, revision, origin, capabilities e sync. As capacidades dependem das permissões da credencial e do estado financeiro atual.\n\nPermissões exigidas na chave de acesso: `cards.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Estatísticas de faturas por ano", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card/bills/stats", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "bills", "stats" ], "variable": [ { "key": "card", "value": "" } ], "query": [ { "key": "year", "value": "", "disabled": true, "description": "Ano utilizado na consulta das faturas; ausente usa o ano atual. A implementação converte o valor informado para inteiro." } ] }, "description": "Retorna as estatísticas anuais das faturas do cartão.\n\n- `bills`: array de faturas com `id`, `close_date`, `due_date`, `total` (string numérica), `paid` e `conciliated` (booleanos).\n- `currentYear`, `maxYear` e `minYear`: anos representados como inteiros.\n\nUm valor não numérico em `year` retorna **200** com `bills: []`.\n\nPermissões exigidas na chave de acesso: `cards.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Obter fatura do cartão", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card/bills/:bill", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "bills", ":bill" ], "variable": [ { "key": "card", "value": "" }, { "key": "bill", "value": "" } ], "query": [] }, "description": "Retorna os detalhes da fatura. accounts_advance representa contas a pagar vinculadas pelo mecanismo legado de adiantamento. payments representa os pagamentos da fatura, incluindo adiantamentos atuais kind=advance. Essas coleções têm identidades e projeções distintas: accounts_advance não é uma lista de pagamentos atuais. A API pública atual não expõe rota de estorno dos pagamentos atuais kind=advance. DELETE /cards/{card}/bills/{cardBill}/accounts/{account} é somente para vínculo legado de accounts_advance: account identifica uma conta a pagar, não um pagamento. Sem vínculo legado dessa conta com a fatura, a recusa é 422 errors.account, sem estorno. Não envie o ID de um pagamento atual nessa rota esperando estorná-lo.\n\nPermissões exigidas na chave de acesso: `cards.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Mover pagamento entre faturas", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card/bills/:bill", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "bills", ":bill" ], "variable": [ { "key": "card", "value": "" }, { "key": "bill", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"payment_id\": \"9c59f4d3-ff83-4e00-9f5b-d73e9f6771b6\",\n \"to_card_bill_id\": \"9c59f98a-0602-4f15-b482-002e60c3bbb1\",\n \"expected_revision\": 1,\n \"target_expected_revision\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Move um pagamento da fatura indicada em `{bill}` para outra fatura.\nRetorna **200** com os dados da fatura de origem após a movimentação.\nO pagamento deve ter valor positivo, e sua retirada não pode tornar o total da fatura de origem negativo.\n\nExige cards.view e cards.update. Informe expected_revision e target_expected_revision com as versões atuais das faturas de origem e destino; divergência de versão retorna 409 sem efetuar a movimentação.\n" } } ] }, { "name": "Cards", "item": [ { "name": "Listar cartões de crédito", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards", "host": [ "{{base_url}}" ], "path": [ "cards" ], "query": [ { "key": "search", "value": "", "disabled": true, "description": "Filtro por nome do cartão." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Retorna uma lista paginada de cartões de crédito do tenant.\n\nPermissão exigida: `cards.view`.\n\n### Filtros disponíveis (query string)\n\n| Parâmetro | Tipo | Comportamento |\n|-----------|--------|-----------------------------------------------------------|\n| `search` | string | Busca por nome do cartão (busca parcial, case-insensitive). |\n| `page` | integer| Número da página (padrão: 1). |\n\n**Ordenação:** `sort_column` aceita `name`, `due_day`, `closing_day`, `active`, `provider_id`, `created_at`, `updated_at`. Colunas fora da lista retornam **422** no campo `sort_column`. Use `sort_direction=asc` ou `desc`; quando omitido ou inválido, o sentido é `asc`.\n" } }, { "name": "Criar cartão de crédito", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards", "host": [ "{{base_url}}" ], "path": [ "cards" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Cartão Corporativo\",\n \"due_day\": 15,\n \"closing_day\": 10,\n \"provider_id\": \"9c551086-44fc-4a50-8b60-a5bdf0d30176\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um cartão de crédito e retorna **201**.\n\n**Permissões exigidas:** `cards.view` + `cards.create`.\n" } }, { "name": "Obter cartão de crédito", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card", "host": [ "{{base_url}}" ], "path": [ "cards", ":card" ], "variable": [ { "key": "card", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de um cartão de crédito.\n\nPermissão exigida: `cards.view`.\n" } }, { "name": "Atualizar cartão de crédito", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card", "host": [ "{{base_url}}" ], "path": [ "cards", ":card" ], "variable": [ { "key": "card", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Cartão Atualizado\",\n \"due_day\": 10,\n \"closing_day\": 5,\n \"provider_id\": \"9c551086-44fc-4a50-8b60-a5bdf0d30176\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza os dados de um cartão de crédito. Envie somente os campos que deseja alterar.\n\n**Permissões exigidas:** `cards.view` + `cards.update`.\n" } }, { "name": "Excluir cartão de crédito", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card", "host": [ "{{base_url}}" ], "path": [ "cards", ":card" ], "variable": [ { "key": "card", "value": "" } ], "query": [] }, "description": "Exclui um cartão de crédito.\n\n**Permissões exigidas:** `cards.view` + `cards.delete`.\nRepetir a chamada após a exclusão retorna **404**.\n\nUm cartão com fatura em aberto não pode ser excluído: a resposta é **422** com a mensagem\n\"Não é possível excluir um cartão com faturas em aberto. Quite ou cancele as faturas antes.\"\n" } }, { "name": "Ativar cartão de crédito", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card/activation", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "activation" ], "variable": [ { "key": "card", "value": "" } ], "query": [] }, "description": "Marca o cartão como ativo (`active = true`).\n\nPermissões exigidas: `cards.view` + `cards.update`.\n\nA operação é **idempotente**: chamar em um cartão já ativo retorna 200 e\nmantém `active = true`.\n" } }, { "name": "Histórico do cartão", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card/history", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "history" ], "variable": [ { "key": "card", "value": "" } ], "query": [] }, "description": "Retorna o histórico de compras do cartão, por meio das contas a pagar associadas. Permissão exigida: cards.view. Um adiantamento atual é registrado como pagamento kind=advance da fatura; ele não cria nova conta card_invoice_advance nem é prometido como compra neste histórico. A API pública atual não expõe rota de estorno dos pagamentos atuais kind=advance. DELETE /cards/{card}/bills/{cardBill}/accounts/{account} é somente para vínculo legado de accounts_advance: account identifica uma conta a pagar, não um pagamento. Sem vínculo legado dessa conta com a fatura, a recusa é 422 errors.account, sem estorno. Não envie o ID de um pagamento atual nessa rota esperando estorná-lo." } }, { "name": "Inativar cartão de crédito", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card/inactive", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "inactive" ], "variable": [ { "key": "card", "value": "" } ], "query": [] }, "description": "Marca o cartão como inativo (`active = false`).\n\nPermissões exigidas: `cards.view` + `cards.update`.\n\nA operação é **idempotente**: chamar em um cartão já inativo retorna 200 e\nmantém `active = false`.\n" } }, { "name": "Antecipar pagamento de fatura (invoice advance)", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "advance-fatura-2026-10-04-001", "disabled": false, "description": "Chave não vazia, estável por tentativa. O reenvio deve preservar os mesmos dados e comprovante." } ], "url": { "raw": "{{base_url}}/cards/:card/invoice", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "invoice" ], "variable": [ { "key": "card", "value": "" } ], "query": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "date", "value": "2024-06-22", "type": "text", "disabled": false, "description": "Data do pagamento antecipado." }, { "key": "payment_method", "value": "pix", "type": "text", "disabled": false, "description": "Meio usado para o pagamento. credit e none são rejeitados para a própria fatura." }, { "key": "cashbox_id", "value": "ae0f8e19-5ca3-4055-ba94-47cd24229086", "type": "text", "disabled": false, "description": "UUID de um caixa ativo na empresa autenticada." }, { "key": "card_bill_id", "value": "9c59f98a-159e-4ca5-94f3-950da8d595cc", "type": "text", "disabled": false, "description": "UUID da fatura pertencente ao cartão informado na URL." }, { "key": "value", "value": "500.0", "type": "text", "disabled": false, "description": "Valor do adiantamento (mínimo R$ 0,01)." }, { "key": "receipt", "type": "file", "src": [], "disabled": false, "description": "Comprovante obrigatório (PDF, JPG, JPEG ou PNG), enviado como arquivo multipart." }, { "key": "expected_revision", "value": "1", "type": "text", "disabled": false, "description": "Revisão atual da fatura, obtida na consulta. Obrigatória para executar a antecipação." }, { "key": "confirm_credit", "value": "", "type": "text", "disabled": true, "description": "Confirma o crédito quando value ultrapassa o saldo conhecido da fatura. Sem confirmação, o serviço retorna 422." } ] }, "description": "Registra um adiantamento de pagamento de fatura por `multipart/form-data`.\n\n**Permissões exigidas:** `cards.view` + `cards.update`.\nEnvie o arquivo `receipt` (PDF, JPG, JPEG ou PNG), `expected_revision` da fatura consultada e o cabeçalho `Idempotency-Key` estável para esta tentativa. Comprovante e revisão são obrigatórios para concluir a operação, inclusive neste alias legado.\n\nO adiantamento pode ser registrado mesmo quando o total da fatura ainda é desconhecido. Quando o saldo é conhecido e o valor excede esse saldo, envie `confirm_credit=true` somente após confirmar o crédito excedente. Sem essa confirmação, a operação retorna **422**.\n\nO cartão, a fatura vinculada e o caixa ativo devem pertencer à empresa. `value` deve ser no mínimo `0.01`; os meios `credit` e `none` não são aceitos para pagar a própria fatura. Dados inválidos, comprovante/revisão ausentes ou chave de idempotência inválida retornam **422**.\n\nUma repetição com a mesma chave e os mesmos dados (incluindo arquivo, revisão e confirmação de crédito) não duplica o pagamento. Chave reutilizada com dados diferentes ou revisão desatualizada retorna **409**. O sucesso retorna **204**, sem corpo." } }, { "name": "Estornar adiantamento de fatura", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cards/:card/bills/:cardBill/accounts/:account", "host": [ "{{base_url}}" ], "path": [ "cards", ":card", "bills", ":cardBill", "accounts", ":account" ], "variable": [ { "key": "card", "value": "" }, { "key": "cardBill", "value": "" }, { "key": "account", "value": "" } ], "query": [] }, "description": "Exclui somente adiantamento legado vinculado à fatura por uma conta a pagar. Exige cards.view e cards.delete. O parâmetro account é ID de conta a pagar, não PaymentID. Uma conta existente sem o vínculo legado accounts_advance retorna 422 errors.account, sem estorno; identificadores de recurso inexistentes seguem 404. A API pública atual não expõe rota de estorno dos pagamentos atuais kind=advance. DELETE /cards/{card}/bills/{cardBill}/accounts/{account} é somente para vínculo legado de accounts_advance: account identifica uma conta a pagar, não um pagamento. Sem vínculo legado dessa conta com a fatura, a recusa é 422 errors.account, sem estorno. Não envie o ID de um pagamento atual nessa rota esperando estorná-lo." } } ] }, { "name": "Cashboxes", "item": [ { "name": "Listar caixas", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes", "host": [ "{{base_url}}" ], "path": [ "cashboxes" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Retorna os caixas com paginação (`data`, `links`, `meta`). \n\n**Ordenação:** `sort_column` aceita `name`, `amount`, `start_amount`, `default`, `active`, `editable`, `created_at`, `updated_at`. Colunas fora da lista retornam **422** no campo `sort_column`. Use `sort_direction=asc` ou `desc`; quando omitido ou inválido, o sentido é `asc`.\n\n\nNo extrato (`/cashboxes/{cashbox}/history`), as colunas aceitas são `action`, `description`, `transfer_date`, `created_at` e `updated_at`; a ordem padrão é `transfer_date desc`. O filtro `type` aceita `in`, `out` ou `transfer`; outros valores retornam **422**.\n\nPermissões exigidas na chave de acesso: `cashboxes.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Criar caixa", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes", "host": [ "{{base_url}}" ], "path": [ "cashboxes" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Caixa Operacional\",\n \"amount\": 10000.0,\n \"default\": false,\n \"active\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um novo caixa para o tenant.\n\nRequer permissão: **cashboxes.create**.\n\n\nRetorna **HTTP 201** em caso de sucesso.\n" } }, { "name": "Obter caixa", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes/:cashbox", "host": [ "{{base_url}}" ], "path": [ "cashboxes", ":cashbox" ], "variable": [ { "key": "cashbox", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de um caixa específico.\n\nPermissões exigidas na chave de acesso: `cashboxes.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Ativar caixa", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes/:cashbox/activation", "host": [ "{{base_url}}" ], "path": [ "cashboxes", ":cashbox", "activation" ], "variable": [ { "key": "cashbox", "value": "" } ], "query": [] }, "description": "Marca o caixa como ativo (`active = true`).\n\nA operação é idempotente: chamar em um caixa já ativo retorna 200 sem erro.\nNenhum corpo de requisição é necessário.\nRequer permissão: **cashboxes.update**.\n" } }, { "name": "Definir caixa como padrão", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes/:cashbox/default", "host": [ "{{base_url}}" ], "path": [ "cashboxes", ":cashbox", "default" ], "variable": [ { "key": "cashbox", "value": "" } ], "query": [] }, "description": "Marca o caixa como caixa padrão do tenant. Um caixa inativo não pode ser o padrão (**400**: \"Um caixa inativo não pode ser o padrão. Ative o caixa antes.\").\n\nNenhum corpo de requisição é necessário.\nRequer permissão: **cashboxes.update**.\n" } }, { "name": "Histórico do caixa", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes/:cashbox/history", "host": [ "{{base_url}}" ], "path": [ "cashboxes", ":cashbox", "history" ], "variable": [ { "key": "cashbox", "value": "" } ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." }, { "key": "type", "value": "", "disabled": true, "description": "Tipo de movimentação." }, { "key": "description", "value": "", "disabled": true, "description": "Trecho da descrição da movimentação." }, { "key": "date_from", "value": "", "disabled": true, "description": "Data inicial do período." }, { "key": "date_to", "value": "", "disabled": true, "description": "Data final do período." } ] }, "description": "Retorna o histórico de movimentações do caixa (paginado).\n\nCada item em `data` representa um evento registrado na tabela `cashbox_logs`.\nOs campos de `meta` serializam como strings (e.g. `\"current_page\": \"1\"`).\n\nPermissões exigidas na chave de acesso: `cashboxes.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Reverter transferência (excluir histórico)", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes/:cashbox/history/:history", "host": [ "{{base_url}}" ], "path": [ "cashboxes", ":cashbox", "history", ":history" ], "variable": [ { "key": "cashbox", "value": "" }, { "key": "history", "value": "" } ], "query": [] }, "description": "Reverte uma transferência entre caixas e retorna **204**, sem corpo.\n\n**Permissão exigida:** `cashboxes.update`.\nA movimentação deve pertencer ao caixa indicado na URL; caso contrário, retorna **404**. Transferências que não permitem reversão retornam **400**.\n" } }, { "name": "Desativar caixa", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes/:cashbox/inactive", "host": [ "{{base_url}}" ], "path": [ "cashboxes", ":cashbox", "inactive" ], "variable": [ { "key": "cashbox", "value": "" } ], "query": [] }, "description": "Marca o caixa como inativo (`active = false`).\n\nNenhum corpo de requisição é necessário.\nRequer permissão: **cashboxes.update**.\n" } }, { "name": "Renomear caixa", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes/:cashbox/name", "host": [ "{{base_url}}" ], "path": [ "cashboxes", ":cashbox", "name" ], "variable": [ { "key": "cashbox", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Caixa Principal Renomeado\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza o nome de um caixa.\n\n**Permissão exigida:** `cashboxes.update`.\nO nome deve ser único. Um nome já cadastrado retorna **422**.\n" } }, { "name": "Transferir saldo entre caixas", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cashboxes/:cashbox/transfer", "host": [ "{{base_url}}" ], "path": [ "cashboxes", ":cashbox", "transfer" ], "variable": [ { "key": "cashbox", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"cashbox_id\": \"9c3ff8ac-e390-4558-aa7c-e202028f6e79\",\n \"amount\": 500.0,\n \"date\": \"2024-06-23\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Transfere um valor do caixa indicado na URL para `cashbox_id` informado no corpo.\n\n**Permissão exigida:** `cashboxes.update`.\n\nEnvie `Idempotency-Key` com um valor único por transferência. Repetir a chamada com a mesma chave retorna o mesmo resultado sem movimentar o saldo novamente.\nSem esse cabeçalho, uma transferência idêntica (origem, destino, valor e data), dentro da janela de deduplicação, retorna **409**. Para realizar outra transferência com os mesmos dados, use uma chave nova.\n\n`amount` aceita no máximo 2 casas decimais (**422**: \"O valor deve ter no máximo 2 casas decimais.\").\n\nNão há verificação de saldo: a transferência é aceita mesmo acima do saldo, e o caixa de origem pode ficar negativo.\n" } } ] }, { "name": "Clientes", "item": [ { "name": "Listar clientes", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients", "host": [ "{{base_url}}" ], "path": [ "clients" ], "query": [ { "key": "search", "value": "", "disabled": true, "description": "Busca parcial por código do cliente, nome, nome fantasia ou documento." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página; ausente ou vazio usa o padrão da listagem." } ] }, "description": "Retorna uma lista paginada de clientes do tenant. A busca por search inclui o código do cliente, nome, nome fantasia e documento, combinada com os demais filtros.\n\nPermissões exigidas na chave de acesso: `clients.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Criar cliente", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients", "host": [ "{{base_url}}" ], "path": [ "clients" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"PF\",\n \"name\": \"John Doe\",\n \"fantasy_name\": null,\n \"billing_day\": 10,\n \"code\": \"0010\",\n \"active\": true,\n \"international\": false,\n \"description\": \"Cliente exemplo\",\n \"cpf\": \"00000000000\",\n \"emails\": [\n {\n \"email\": \"john@doe.com\",\n \"description\": \"E-mail principal\",\n \"email_type_id\": \"a5d65bcd-b4f7-4e8c-a156-f31644748343\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"11999999999\",\n \"description\": \"Telefone principal\",\n \"phone_type_id\": \"684b638a-ab19-4864-8a61-8533c98480ea\"\n }\n ],\n \"addresses\": [\n {\n \"state_id\": \"10000000-0000-4000-8000-000000000016\",\n \"city_id\": \"10000000-0000-4000-8000-000000000030\",\n \"address\": \"Rua Exemplo\",\n \"number\": \"100\",\n \"complement\": \"Casa\",\n \"neighborhood\": \"Centro\",\n \"zipcode\": \"30110000\",\n \"description\": \"Endereço principal\"\n }\n ],\n \"contacts\": []\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um novo cliente (PF ou PJ).\n\nAceita `application/json` ou `multipart/form-data` (quando há anexos de documento;\nos campos aninhados — `emails`, `phones`, `addresses`, `contacts`,\n`documentFilesMap` — são enviados como strings JSON no multipart).\n\n\nRetorna **HTTP 201** em caso de sucesso.\n\nPermissões exigidas na chave de acesso: `clients.view` e `clients.create`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Obter cliente", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients/:client", "host": [ "{{base_url}}" ], "path": [ "clients", ":client" ], "variable": [ { "key": "client", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de um cliente, incluindo e-mails, telefones, endereços, contatos e documentos.\n\nPermissões exigidas na chave de acesso: `clients.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Editar cliente", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients/:client", "host": [ "{{base_url}}" ], "path": [ "clients", ":client" ], "variable": [ { "key": "client", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"PF\",\n \"name\": \"John Doe (atualizado)\",\n \"billing_day\": 15,\n \"code\": \"0010\",\n \"description\": \"Descrição atualizada\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza os dados de um cliente existente. Os campos seguem as mesmas regras de criação, mas nenhum é obrigatório por padrão (exceto `type`).\n\nPermissões exigidas na chave de acesso: `clients.view` e `clients.update`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Excluir cliente", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients/:client", "host": [ "{{base_url}}" ], "path": [ "clients", ":client" ], "variable": [ { "key": "client", "value": "" } ], "query": [] }, "description": "Exclui cadastro inativo e elegível, sem contas abertas. Cadastro ativo é recusado com 422 em active; inative antes de excluir. Sucesso público: 204 sem corpo.\n\nPermissões exigidas na chave de acesso: `clients.view` e `clients.delete`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Anexar documento ao cliente", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients/:client/documents/attachment", "host": [ "{{base_url}}" ], "path": [ "clients", ":client", "documents", "attachment" ], "variable": [ { "key": "client", "value": "" } ], "query": [] }, "description": "Envia um arquivo **PDF** para um perfil de documento do cliente.\nUse `multipart/form-data`.\n\nPermissões exigidas na chave de acesso: `clients.view` e `documents.update`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão.", "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file", "src": [], "disabled": false, "description": "Arquivo a ser enviado (apenas PDF)." }, { "key": "document_id", "value": "b560292c-1908-4500-ba80-ec7798f11d5a", "type": "text", "disabled": false, "description": "ID do vínculo cliente-documento (client_has_documents) pertencente ao cliente da rota; não é o ID do perfil documental." } ] } } }, { "name": "Documentos obrigatórios do cliente", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients/:client/documents/required", "host": [ "{{base_url}}" ], "path": [ "clients", ":client", "documents", "required" ], "variable": [ { "key": "client", "value": "" } ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "Filtro opcional de DocumentProfileType: PF, PJ, Any ou I. Ausência mantém a seleção de perfis Any; valor inválido é 422 errors.type antes da consulta. Um resultado vazio não valida tipo fora do enum." } ] }, "description": "Lista os perfis de documento exigidos para este cliente.\n\nPermissões exigidas na chave de acesso: `clients.view` e `documents.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Excluir documento do cliente", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients/:client/documents/:document", "host": [ "{{base_url}}" ], "path": [ "clients", ":client", "documents", ":document" ], "variable": [ { "key": "client", "value": "" }, { "key": "document", "value": "" } ], "query": [] }, "description": "Exclui um documento anexado ao cliente.\n\nPermissões exigidas na chave de acesso: `clients.view` e `documents.delete`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Baixar documento do cliente", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients/:client/documents/:document/file", "host": [ "{{base_url}}" ], "path": [ "clients", ":client", "documents", ":document", "file" ], "variable": [ { "key": "client", "value": "" }, { "key": "document", "value": "" } ], "query": [] }, "description": "Faz o download do arquivo de um documento anexado ao cliente.\n\nPermissões exigidas na chave de acesso: `clients.view` e `documents.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Alternar status do cliente (ativo/inativo)", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/clients/:client/status", "host": [ "{{base_url}}" ], "path": [ "clients", ":client", "status" ], "variable": [ { "key": "client", "value": "" } ], "query": [] }, "description": "Inverte o status `active` do cliente (ativa se inativo, inativa se ativo).\n\nPermissões exigidas na chave de acesso: `clients.view` e `clients.update`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } } ] }, { "name": "DataMigration", "item": [ { "name": "Listar importações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/data-migration/imports", "host": [ "{{base_url}}" ], "path": [ "data-migration", "imports" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Lista as importações de dados com paginação.\n\n**Permissão exigida:** `data_migration.view`.\n\n**Ordenação:** `sort_column` aceita `type`, `action`, `status`, `original_file_name`, `created_at`, `updated_at`. Colunas fora da lista retornam **422** no campo `sort_column`. Use `sort_direction=asc` ou `desc`; quando omitido ou inválido, o sentido é `asc`.\n\n\nA ordenação principal é `created_at desc`; `sort_column` define o critério secundário. Para ordenar pelo nome do arquivo, use `original_file_name`.\n" } }, { "name": "Criar importação (upload de arquivo)", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/data-migration/imports", "host": [ "{{base_url}}" ], "path": [ "data-migration", "imports" ], "query": [] }, "description": "Faz o upload de uma planilha (xlsx, xls ou csv) para iniciar uma importação\nde dados no tenant. Após o upload, um job de processamento (`DataImportFileHandler`)\né despachado para verificar o arquivo (fase `verify`).\n\nUse `multipart/form-data` para enviar o arquivo.\n\n\nRetorna **HTTP 201** em caso de sucesso.\n\nPermissões exigidas na chave de acesso: `data_migration.create`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão.", "body": { "mode": "formdata", "formdata": [ { "key": "type", "value": "clients", "type": "text", "disabled": false, "description": "Tipo da importação. Valores aceitos (enum `ImportType`):\n`account_payables`, `account_receivables`, `cashboxes`, `categories`,\n`clients`, `cost_centers`, `employees`, `interns`, `partners`, `providers`,\n`standard_launches`.\n" }, { "key": "file", "type": "file", "src": [], "disabled": false, "description": "Planilha a importar (xlsx, xls ou csv)." } ] } } }, { "name": "Obter importação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/data-migration/imports/:dataImport", "host": [ "{{base_url}}" ], "path": [ "data-migration", "imports", ":dataImport" ], "variable": [ { "key": "dataImport", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de uma importação específica do tenant, incluindo campos de\nprogresso derivados do campo `data` (headings, has_errors, has_nulls, invalid_file, progress).\n\nQuando `data` é `null` (importação recém-criada ou ainda em fila), os campos de\nprogresso retornam com valores padrão (`[]`, `false`, `100`).\n\nPermissões exigidas na chave de acesso: `data_migration.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Excluir importação", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/data-migration/imports/:dataImport", "host": [ "{{base_url}}" ], "path": [ "data-migration", "imports", ":dataImport" ], "variable": [ { "key": "dataImport", "value": "" } ], "query": [] }, "description": "Exclui uma importação e retorna **200** com uma mensagem de confirmação (esta rota não devolve 204).\n\nSe o identificador não existir ou a exclusão não for concluída, a resposta é **404**. Nesse último caso o corpo pode ser uma lista de textos (`[\"Not Found\"]`) em vez do objeto com `message`.\n\n**Permissão exigida:** `data_migration.delete`.\n" } }, { "name": "Linhas de dados da importação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/data-migration/imports/:dataImport/data", "host": [ "{{base_url}}" ], "path": [ "data-migration", "imports", ":dataImport", "data" ], "variable": [ { "key": "dataImport", "value": "" } ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "search", "value": "", "disabled": true, "description": "Busca no conteúdo das linhas ou mensagens de erro da importação." } ] }, "description": "Retorna as linhas verificadas da planilha em uma coleção paginada. Enquanto os dados não estiverem disponíveis, retorna uma coleção vazia.\nIdentificadores inexistentes ou de outra empresa retornam **404**.\n\nPermissões exigidas na chave de acesso: `data_migration.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Erros da importação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/data-migration/imports/:dataImport/errors", "host": [ "{{base_url}}" ], "path": [ "data-migration", "imports", ":dataImport", "errors" ], "variable": [ { "key": "dataImport", "value": "" } ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "search", "value": "", "disabled": true, "description": "Busca no conteúdo das linhas ou mensagens de erro da importação." } ] }, "description": "Retorna os erros encontrados na verificação da planilha em uma coleção paginada. Quando não há erros disponíveis, retorna uma coleção vazia.\n\nPermissões exigidas na chave de acesso: `data_migration.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Executar importação (import run)", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/data-migration/imports/:dataImport/executions", "host": [ "{{base_url}}" ], "path": [ "data-migration", "imports", ":dataImport", "executions" ], "variable": [ { "key": "dataImport", "value": "" } ], "query": [] }, "description": "Inicia a importação de dados de forma assíncrona, alterando `action` para `import` e `status` para `queued`.\n\n**Permissão exigida:** `data_migration.create`.\nA verificação deve estar concluída: `action=verify` e `status=completed` ou `error`. Caso contrário, retorna **422**.\nNão é necessário enviar corpo na requisição.\n" } } ] }, { "name": "DocumentLote", "item": [ { "name": "Listar lotes de documentos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/document-batches", "host": [ "{{base_url}}" ], "path": [ "document-batches" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página; ausente ou vazio usa o padrão da listagem." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Lista os lotes de documentos com paginação. A geração dos documentos ocorre de forma assíncrona. \n\n**Ordenação:** `sort_column` aceita `from`, `to`, `started_at`, `finished_at`, `progress`, `type`, `status`, `created_at`, `updated_at`. Colunas fora da lista retornam **422** no campo `sort_column`. Use `sort_direction=asc` ou `desc`; quando omitido ou inválido, o sentido é `asc`.\n\n\nSem `sort_column`, a ordem é `created_at desc`.\n\nPermissões exigidas na chave de acesso: `accounting_documents.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Solicitar geração de lote de documentos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/document-batches", "host": [ "{{base_url}}" ], "path": [ "document-batches" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"from\": \"2026-10-01\",\n \"to\": \"2026-10-31\",\n \"type\": \"account_payable\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um lote de documentos e retorna **201**. A geração ocorre de forma assíncrona, com status inicial `pending` e progresso zero.\nConsulte `GET /document-batches/{id}` para acompanhar a geração.\nUm intervalo `from`/`to` sem contas a pagar com pagamentos registrados retorna **400**.\n\nPermissões exigidas na chave de acesso: `accounting_documents.create`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Obter lote de documentos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/document-batches/:document_lote", "host": [ "{{base_url}}" ], "path": [ "document-batches", ":document_lote" ], "variable": [ { "key": "document_lote", "value": "" } ], "query": [] }, "description": "Retorna os dados, o status e o progresso do lote.\n\nPermissões exigidas na chave de acesso: `accounting_documents.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Excluir lote de documentos", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/document-batches/:document_lote", "host": [ "{{base_url}}" ], "path": [ "document-batches", ":document_lote" ], "variable": [ { "key": "document_lote", "value": "" } ], "query": [] }, "description": "Exclui um lote de documentos. Lotes com status `pending` ou `cancelled` podem ser excluídos; lotes em processamento (`processing` ou `merging`) retornam **400**.\n\nPermissões exigidas na chave de acesso: `accounting_documents.delete`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Cancelar lote de documentos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/document-batches/:document_lote/cancellations", "host": [ "{{base_url}}" ], "path": [ "document-batches", ":document_lote", "cancellations" ], "variable": [ { "key": "document_lote", "value": "" } ], "query": [] }, "description": "Cancela um lote pendente, alterando seu status para `cancelled`. Lotes com status `completed` ou `failed` retornam **400**.\nNão é necessário enviar corpo na requisição.\n\nPermissões exigidas na chave de acesso: `accounting_documents.update`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Baixar PDF do lote de documentos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/document-batches/:document_lote/file", "host": [ "{{base_url}}" ], "path": [ "document-batches", ":document_lote", "file" ], "variable": [ { "key": "document_lote", "value": "" } ], "query": [] }, "description": "Faz o download do PDF do lote. Aguarde o status `completed` e a disponibilização do arquivo antes de solicitar o download.\n\nPermissões exigidas na chave de acesso: `accounting_documents.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } } ] }, { "name": "Employees", "item": [ { "name": "Listar funcionários", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees", "host": [ "{{base_url}}" ], "path": [ "employees" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Filtra funcionários ativos (`true`) ou inativos (`false`)." }, { "key": "search", "value": "", "disabled": true, "description": "Busca por nome ou CPF (LIKE parcial)." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página." } ] }, "description": "Retorna uma lista paginada de funcionários. Use `status=true` para listar ativos e `status=false` para inativos. Se `status` for omitido, são listados ativos e inativos.\n\nPermissões exigidas na chave de acesso: `employees.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Criar funcionário", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees", "host": [ "{{base_url}}" ], "path": [ "employees" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"gender\": \"male\",\n \"payment_type\": \"monthly\",\n \"marital_status\": \"single\",\n \"hours\": [],\n \"active\": 1,\n \"employee_workspace_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"employee_graduation_level_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"João Silva\",\n \"occupation\": \"Analista de Sistemas\",\n \"cpf\": \"12345678901\",\n \"salary\": 5000.0,\n \"hire_date\": \"2024-01-15\",\n \"payment_day\": 5,\n \"emails\": [\n {\n \"email\": \"joao@empresa.com\",\n \"email_type_id\": \"a5d65bcd-b4f7-4e8c-a156-f31644748343\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"11999999999\",\n \"phone_type_id\": \"684b638a-ab19-4864-8a61-8533c98480ea\"\n }\n ],\n \"addresses\": [\n {\n \"state_id\": \"10000000-0000-4000-8000-000000000016\",\n \"city_id\": \"10000000-0000-4000-8000-000000000030\",\n \"address\": \"Rua das Flores\",\n \"number\": \"100\",\n \"neighborhood\": \"Centro\",\n \"zipcode\": \"30110000\"\n }\n ],\n \"bankAccounts\": [],\n \"benefits\": []\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um funcionário e retorna **201**.\nAceita `application/json` ou `multipart/form-data`. No multipart, envie os campos aninhados (`emails`, `phones`, `addresses`, `benefits`, `bankAccounts`, `hours`, `documentFilesMap`) como strings JSON.\n\n`payment_day`, `marital_status` e `gender` são obrigatórios. `salary` deve ser no mínimo `0.01`. Cada `emails.*.email` aceita até 60 caracteres e `bankAccounts.*.bank_name`, até 50. Valores inválidos retornam **422**.\n\nPermissões exigidas na chave de acesso: `employees.view` e `employees.create`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Listar níveis de formação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/graduation-levels", "host": [ "{{base_url}}" ], "path": [ "employees", "graduation-levels" ], "query": [] }, "description": "Retorna os níveis de formação disponíveis para funcionários.\n\n**Permissão exigida:** `employees.view`.\n" } }, { "name": "Listar locais de trabalho (workspaces)", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/workspaces", "host": [ "{{base_url}}" ], "path": [ "employees", "workspaces" ], "query": [] }, "description": "Retorna os locais de trabalho disponíveis para funcionários.\n\n**Permissão exigida:** `employees.view`.\n" } }, { "name": "Obter funcionário", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee" ], "variable": [ { "key": "employee", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de um funcionário, incluindo e-mails, telefones,\nendereços, contas bancárias, benefícios e documentos.\n\nO campo `graduation` é o nome do nível de formação (string nullable).\nO campo `workspace` é o nome do local de trabalho (string nullable).\n`salary` é serializado como float (pode aparecer como número sem casas decimais).\n\nPermissões exigidas na chave de acesso: `employees.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Editar funcionário", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee" ], "variable": [ { "key": "employee", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"employee_workspace_id\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"employee_graduation_level_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"name\": \"João Silva Atualizado\",\n \"occupation\": \"Sênior Analista\",\n \"cpf\": \"12345678901\",\n \"salary\": 6500.0,\n \"payment_type\": \"monthly\",\n \"hire_date\": \"2023-01-01\",\n \"payment_day\": 10,\n \"marital_status\": \"married\",\n \"gender\": \"male\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza os dados de um funcionário. Aceita `application/json` ou `multipart/form-data`.\nO CPF deve ser único, desconsiderando o próprio funcionário.\n`payment_day`, `marital_status` e `gender` são obrigatórios. `salary` deve ser no mínimo `0.01`. Cada `emails.*.email` aceita até 60 caracteres e `bankAccounts.*.bank_name`, até 50. Valores inválidos retornam **422**.\n\nPermissões exigidas na chave de acesso: `employees.view` e `employees.update`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Excluir funcionário", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee" ], "variable": [ { "key": "employee", "value": "" } ], "query": [] }, "description": "Exclui um funcionário. Retorna **HTTP 204** sem conteúdo.\n\nPermissões exigidas na chave de acesso: `employees.view` e `employees.delete`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Ativar / inativar funcionário", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee/activation", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee", "activation" ], "variable": [ { "key": "employee", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"active\": true\n}", "options": { "raw": { "language": "json" } } }, "description": "Define o status `active` do funcionário.\n\n**Permissão exigida:** `employees.update`.\n" } }, { "name": "Listar documentos do funcionário", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee/documents", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee", "documents" ], "variable": [ { "key": "employee", "value": "" } ], "query": [] }, "description": "Retorna os documentos vinculados ao funcionário.\nRequer `documents.view` (além de `employees.view` base).\n" } }, { "name": "Adicionar novo documento ao funcionário", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee/documents", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee", "documents" ], "variable": [ { "key": "employee", "value": "" } ], "query": [] }, "description": "Vincula um documento ao funcionário.\n\n**Permissões exigidas:** `employees.view` + `documents.create`.\n", "body": { "mode": "raw", "raw": "{\n \"document_profile_id\": \"10000000-0000-4000-8000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Anexar arquivo a documento do funcionário", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee/documents/attachment", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee", "documents", "attachment" ], "variable": [ { "key": "employee", "value": "" } ], "query": [] }, "description": "Envia um arquivo PDF para um documento do funcionário. Use `multipart/form-data`.\n\n**Permissões exigidas:** `employees.view` + `documents.update`.\nO documento deve existir e pertencer ao funcionário.\n", "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file", "src": [], "disabled": false, "description": "Arquivo PDF a ser enviado." }, { "key": "document_id", "value": "b560292c-1908-4500-ba80-ec7798f11d5a", "type": "text", "disabled": false, "description": "ID do documento (registro em `employee_has_documents`)\nao qual o anexo pertence.\n" } ] } } }, { "name": "Documentos obrigatórios do funcionário", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee/documents/required", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee", "documents", "required" ], "variable": [ { "key": "employee", "value": "" } ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "Filtro opcional de DocumentProfileType: PF, PJ, Any ou I. Ausência mantém a seleção de perfis Any; valor inválido é 422 errors.type antes da consulta. Um resultado vazio não valida tipo fora do enum." } ] }, "description": "Retorna os perfis de documentos obrigatórios para o funcionário.\n\n**Permissões exigidas:** `employees.view` + `documents.view`.\n" } }, { "name": "Excluir documento do funcionário", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee/documents/:document", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee", "documents", ":document" ], "variable": [ { "key": "employee", "value": "" }, { "key": "document", "value": "" } ], "query": [] }, "description": "Exclui um documento do funcionário. Retorna **HTTP 204** sem conteúdo.\nRequer `documents.delete` (além de `employees.view` base).\n" } }, { "name": "Baixar documento do funcionário", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/employees/:employee/documents/:document/file", "host": [ "{{base_url}}" ], "path": [ "employees", ":employee", "documents", ":document", "file" ], "variable": [ { "key": "employee", "value": "" }, { "key": "document", "value": "" } ], "query": [] }, "description": "Faz o download do arquivo de um documento anexado ao funcionário.\nSem permissão extra declarada além de `employees.view`.\n" } } ] }, { "name": "FiscalRps", "item": [ { "name": "Cancelar RPS / NFS-e", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/fiscal-invoices/:fiscal_rps/cancellations", "host": [ "{{base_url}}" ], "path": [ "fiscal-invoices", ":fiscal_rps", "cancellations" ], "variable": [ { "key": "fiscal_rps", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"1\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Solicita o cancelamento de um RPS com status `Attached`. O status passa a `Canceling` enquanto o cancelamento é processado de forma assíncrona.\n\n**Permissões exigidas:** `accounts.view` + `fiscal_rps.cancel`.\nO campo `code` é obrigatório e aceita `\"1\"` ou `\"2\"`. Um RPS já cancelado retorna **400**.\n" } }, { "name": "Verificar pré-requisitos fiscais da conta a receber", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/fiscal-invoice-eligibility", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "fiscal-invoice-eligibility" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "description": "Retorna a configuração fiscal da conta a receber: tipo de operação, tributação ISSQN, sistema NFS-e, localização da empresa e dados do tomador.\n\n`tributacao_issqn` traz o que a emissão usa da tributação do ISSQN e do comércio exterior: os valores resolvidos pela cadeia (nota > recorrência > categoria > empresa) e o nível de origem de cada um em `origem`; `incidencia`, o local de incidência do ISSQN pelo código nacional do serviço (`EP`, `LP`, `ET`, `sem_incidencia` ou `incerta`); `local_do_tomador` (`brasil`, `exterior` ou `nao_informado`); do cadastro do cliente, o país do endereço, o vínculo e a moeda usual; e os dados de comércio exterior da recorrência, quando a conta tem uma.\n\n**Permissões exigidas:** `accounts.view` + `fiscal_rps.view`.\nMantenha o endereço e a configuração fiscal da empresa preenchidos para utilizar os recursos de NFS-e.\n" } }, { "name": "Listar lotes de RPS da conta a receber", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/fiscal-invoice-batches", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "fiscal-invoice-batches" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "description": "Retorna um array com todos os lotes de NFS-e (fiscal_rps_lotes) vinculados à conta\na receber informada. Array vazio quando nenhum lote existe.\n\n**Permissões exigidas:** `accounts.view` + `fiscal_rps.view`\n" } }, { "name": "Emitir NFS-e para a conta a receber", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/fiscal-invoice-batches", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "fiscal-invoice-batches" ], "variable": [ { "key": "account_receivable", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"tax\": \"9c5d1016-cddb-428a-83c5-2278b93e1674\",\n \"city_iso\": \"1100015\",\n \"issqn\": 0,\n \"cst\": 7,\n \"use_issqn\": false,\n \"issqn_tributation\": \"none\",\n \"value\": 100.0,\n \"with_merge\": false,\n \"retentions\": 0,\n \"competence\": \"2024-06-24\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Solicita a emissão de Nota Fiscal de Serviço Eletrônica (NFS-e) do padrão nacional e retorna **200** com o lote de RPS criado. O envio ao sistema nacional da NFS-e ocorre de forma assíncrona.\n\n**Permissões exigidas:** `accounts.view` + `fiscal_rps.emit`.\nA empresa deve ter endereço e configuração fiscal completos e **certificado digital configurado** no emissor (a filial informada ou a matriz). O `value` deve ser maior que zero e **não pode superar o valor da conta** (emissão parcial, menor que a conta, é permitida). Dados inválidos, valor fora dessa faixa ou emissor sem certificado retornam **422**. Se já existir um lote com status `Attached`, uma nova emissão retorna **400**.\n" } }, { "name": "Download da NF-e em PDF", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/fiscal-invoice-batches/:fiscal_rps_lote_id/:rps_id/pdf", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "fiscal-invoice-batches", ":fiscal_rps_lote_id", ":rps_id", "pdf" ], "variable": [ { "key": "account_receivable", "value": "" }, { "key": "fiscal_rps_lote_id", "value": "" }, { "key": "rps_id", "value": "" } ], "query": [] }, "description": "Faz o download do PDF da NFS-e.\n\n**Permissões exigidas:** `accounts.view` + `fiscal_rps.print`.\nA nota deve ter os dados fiscais disponíveis para geração do documento.\n" } }, { "name": "Download do XML da NFS-e", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/fiscal-invoice-batches/:fiscal_rps_lote_id/:rps_id/xml", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "fiscal-invoice-batches", ":fiscal_rps_lote_id", ":rps_id", "xml" ], "variable": [ { "key": "account_receivable", "value": "" }, { "key": "fiscal_rps_lote_id", "value": "" }, { "key": "rps_id", "value": "" } ], "query": [] }, "description": "Faz o download do XML do lote de NFS-e, com tipo de conteúdo `application/xml`.\n\n**Permissões exigidas:** `accounts.view` + `fiscal_rps.print`.\nO lote e o RPS informados devem existir e pertencer à conta indicada.\n" } } ] }, { "name": "Interns", "item": [ { "name": "Listar estagiários", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns", "host": [ "{{base_url}}" ], "path": [ "interns" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." } ] }, "description": "Lista os estagiários com paginação, incluindo `graduation` (nome da formação) e `workspace` (nome do local de trabalho).\n\n**Permissão exigida:** `interns.view`.\nConsulte os tipos dos campos de paginação nos exemplos de resposta.\n" } }, { "name": "Criar estagiário", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns", "host": [ "{{base_url}}" ], "path": [ "interns" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Estagiário Exemplo\",\n \"department\": \"TI\",\n \"birth_date\": \"2000-01-15\",\n \"hire_date\": \"2023-06-01\",\n \"gender\": \"male\",\n \"marital_status\": \"single\",\n \"intern_workspace_id\": \"87c5838d-9b08-414b-9043-9631833118f0\",\n \"intern_graduation_level_id\": \"009a032b-d181-42f4-bc72-29d4de9e3777\",\n \"educational_institution\": \"Universidade Federal\",\n \"payment_type\": \"monthly\",\n \"current_situation_course\": \"concluded\",\n \"payment_day\": 10,\n \"salary\": 1500.0,\n \"cpf\": \"00000000000\",\n \"description\": \"Estagiário de TI\",\n \"active\": false,\n \"emails\": [\n {\n \"email\": \"estagiario@empresa.com\",\n \"email_type_id\": \"a5d65bcd-b4f7-4e8c-a156-f31644748343\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"11999999999\",\n \"phone_type_id\": \"684b638a-ab19-4864-8a61-8533c98480ea\"\n }\n ],\n \"addresses\": [],\n \"bankAccounts\": [],\n \"benefits\": []\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um novo estagiário.\n\nPermissões exigidas: `interns.create` + `interns.view`.\n\nAceita `application/json` ou `multipart/form-data` (quando há anexos de documento;\ncampos aninhados como `emails`, `phones`, `addresses`, `bankAccounts`, `benefits`,\n`documentFilesMap` são enviados como strings JSON no multipart).\n\n### Campos required no POST\n\n`name`, `department`, `birth_date`, `hire_date`, `gender`, `marital_status`,\n`intern_workspace_id`, `intern_graduation_level_id`, `educational_institution`,\n`payment_type`, `current_situation_course`, `payment_day`, `salary`.\n\n`period_of_course` é required quando `current_situation_course != concluded`.\n\n`active` não é um campo de criação. O estagiário é criado ativo; para alternar o status, use `PUT /interns/{intern}/activation`.\n\nRetorna **HTTP 201** em caso de sucesso.\n" } }, { "name": "Listar situações de curso disponíveis", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/current-situations-course", "host": [ "{{base_url}}" ], "path": [ "interns", "current-situations-course" ], "query": [] }, "description": "Retorna os valores aceitos em `current_situation_course`: `concluded`, `studying` e `locked`.\n\n**Permissão exigida:** `interns.view`.\n" } }, { "name": "Obter estagiário", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/:intern", "host": [ "{{base_url}}" ], "path": [ "interns", ":intern" ], "variable": [ { "key": "intern", "value": "" } ], "query": [] }, "description": "Retorna os dados do estagiário, incluindo `emails`, `phones`, `bankAccounts`, `benefits`, `addresses` e `documents`, além de `graduation` e `workspace` (nomes da formação e do local de trabalho).\n\n**Permissão exigida:** `interns.view`.\n`salary` é numérico e `payment_day` é uma string.\n" } }, { "name": "Editar estagiário", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/:intern", "host": [ "{{base_url}}" ], "path": [ "interns", ":intern" ], "variable": [ { "key": "intern", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Marina Exemplo\",\n \"department\": \"Financeiro\",\n \"birth_date\": \"1999-05-20\",\n \"hire_date\": \"2022-03-01\",\n \"gender\": \"female\",\n \"marital_status\": \"single\",\n \"intern_workspace_id\": \"10000000-0000-4000-8000-000000000401\",\n \"intern_graduation_level_id\": \"10000000-0000-4000-8000-000000000402\",\n \"educational_institution\": \"Instituição de Ensino Exemplo\",\n \"payment_type\": \"monthly\",\n \"current_situation_course\": \"concluded\",\n \"payment_day\": 10,\n \"salary\": 1700\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza os dados de um estagiário existente.\n\nPermissões exigidas: `interns.update` + `interns.view`.\n\n### Campos required no PUT\n\n`department`, `birth_date`, `hire_date`, `gender`, `marital_status`,\n`current_situation_course`, `salary`.\n\n`name` é opcional no PUT (mas validado `max:80` quando presente).\n`intern_workspace_id` e `intern_graduation_level_id` são opcionais no PUT.\n`period_of_course` é required quando `current_situation_course != concluded`.\n`cpf` aceita o próprio CPF do intern (unique ignora self).\n" } }, { "name": "Excluir estagiário", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/:intern", "host": [ "{{base_url}}" ], "path": [ "interns", ":intern" ], "variable": [ { "key": "intern", "value": "" } ], "query": [] }, "description": "Exclui um estagiário e retorna **204**, sem corpo.\n\n**Permissões exigidas:** `interns.view` + `interns.delete`.\n" } }, { "name": "Alternar status ativo/inativo do estagiário", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/:intern/activation", "host": [ "{{base_url}}" ], "path": [ "interns", ":intern", "activation" ], "variable": [ { "key": "intern", "value": "" } ], "query": [] }, "description": "Alterna o status `active` do estagiário.\n\n**Permissões exigidas:** `interns.view` + `interns.update`.\nA resposta contém a mensagem de sucesso `{ \"message\": \"Operação realizada com sucesso.\" }`.\n" } }, { "name": "Listar documentos do estagiário", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/:intern/documents", "host": [ "{{base_url}}" ], "path": [ "interns", ":intern", "documents" ], "variable": [ { "key": "intern", "value": "" } ], "query": [] }, "description": "Lista os perfis de documento vinculados ao estagiário.\n\nPermissões exigidas: `documents.view` + `interns.view`.\n" } }, { "name": "Anexar documento ao estagiário", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/:intern/documents/attachment", "host": [ "{{base_url}}" ], "path": [ "interns", ":intern", "documents", "attachment" ], "variable": [ { "key": "intern", "value": "" } ], "query": [] }, "description": "Envia um arquivo PDF para um documento já vinculado ao estagiário. Use multipart/form-data e informe attachment com o arquivo e document_id com a identificação documental obtida no cadastro do estagiário. O tamanho permitido depende do limite de upload do ambiente. Requer documents.update e interns.view.", "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file", "src": [], "disabled": false, "description": "Arquivo a ser enviado (apenas PDF)." }, { "key": "document_id", "value": "28d2fa20-8417-4a29-836f-5609104eb31d", "type": "text", "disabled": false, "description": "ID do perfil de documento em `intern_has_documents`." } ] } } }, { "name": "Excluir documento do estagiário", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/:intern/documents/:document", "host": [ "{{base_url}}" ], "path": [ "interns", ":intern", "documents", ":document" ], "variable": [ { "key": "intern", "value": "" }, { "key": "document", "value": "" } ], "query": [] }, "description": "Exclui um documento do estagiário e retorna **204**, sem corpo.\n\n**Permissões exigidas:** `interns.view` + `documents.delete`.\n" } }, { "name": "Baixar documento do estagiário", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/interns/:intern/documents/:document/file", "host": [ "{{base_url}}" ], "path": [ "interns", ":intern", "documents", ":document", "file" ], "variable": [ { "key": "intern", "value": "" }, { "key": "document", "value": "" } ], "query": [] }, "description": "Faz o download de um documento do estagiário. A resposta contém o arquivo PDF.\n\n**Permissão exigida:** `interns.view`.\n" } } ] }, { "name": "Logs", "item": [ { "name": "Listar logs de auditoria", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/logs", "host": [ "{{base_url}}" ], "path": [ "logs" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página." }, { "key": "search", "value": "", "disabled": true, "description": "Busca por LIKE em `description` e `action` (OR)." }, { "key": "action", "value": "client_created", "disabled": true, "description": "Filtra pelo valor exato do campo `action`." }, { "key": "start_date", "value": "", "disabled": true, "description": "Data de início do filtro de criação (>=). Formato: YYYY-MM-DD." }, { "key": "end_date", "value": "", "disabled": true, "description": "Data de fim do filtro de criação (<=). Formato: YYYY-MM-DD." }, { "key": "user", "value": "", "disabled": true, "description": "UUID do usuário para filtrar logs por `user_id`." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação (ex. `created_at`)." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Direção da ordenação. Usado junto com `sort_column`." } ] }, "description": "Exige api_logs.view na chave de acesso pública, além da autenticação. Sem a permissão: 403. O catálogo administrativo de chaves públicas inclui api_logs.view; GET /permissions reflete o catálogo da sessão interna e não enumera todas as permissões de chave pública. A consulta continua no escopo autorizado da empresa." } }, { "name": "Obter log de auditoria", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/logs/:log", "host": [ "{{base_url}}" ], "path": [ "logs", ":log" ], "variable": [ { "key": "log", "value": "" } ], "query": [] }, "description": "Exige api_logs.view na chave de acesso pública, além da autenticação. Sem a permissão: 403. O catálogo administrativo de chaves públicas inclui api_logs.view; GET /permissions reflete o catálogo da sessão interna e não enumera todas as permissões de chave pública. A consulta continua no escopo autorizado da empresa." } } ] }, { "name": "Providers", "item": [ { "name": "Listar fornecedores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers", "host": [ "{{base_url}}" ], "path": [ "providers" ], "query": [ { "key": "active", "value": "", "disabled": true, "description": "Filtra fornecedores ativos ou inativos quando informado. Ausente, não aplica filtro de estado." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." } ] }, "description": "Sem active, inclui ativos e inativos; active=true filtra ativos e active=false filtra inativos. Use page/per_page." } }, { "name": "Criar fornecedor", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers", "host": [ "{{base_url}}" ], "path": [ "providers" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"PJ\",\n \"name\": \"Fornecedor Exemplo Ltda\",\n \"fantasy_name\": \"Exemplo\",\n \"active\": true,\n \"international\": false,\n \"description\": null,\n \"cnpj\": \"12345678000195\",\n \"ie\": null,\n \"im\": null,\n \"emails\": [\n {\n \"email\": \"contato@exemplo.com\",\n \"description\": \"E-mail principal\",\n \"email_type_id\": \"a5d65bcd-b4f7-4e8c-a156-f31644748343\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"11999999999\",\n \"description\": \"Telefone principal\",\n \"phone_type_id\": \"684b638a-ab19-4864-8a61-8533c98480ea\"\n }\n ],\n \"addresses\": [\n {\n \"state_id\": \"10000000-0000-4000-8000-000000000016\",\n \"city_id\": \"10000000-0000-4000-8000-000000000030\",\n \"address\": \"Rua Exemplo\",\n \"number\": \"100\",\n \"complement\": null,\n \"neighborhood\": \"Centro\",\n \"zipcode\": \"30110000\",\n \"description\": \"Endereço principal\"\n }\n ],\n \"contacts\": [],\n \"bankAccounts\": []\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um fornecedor (PF ou PJ) e retorna **201**.\n\n**Permissões exigidas:** `providers.view` + `providers.create`.\nAceita `application/json` ou `multipart/form-data`. No multipart, envie os campos aninhados (`emails`, `phones`, `addresses`, `contacts`, `bankAccounts`, `documentFilesMap`) como strings JSON.\nUse `GET /providers/{id}` para consultar os dados completos após a criação.\n" } }, { "name": "Alternar status do fornecedor (ativo/inativo)", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers/:provider/status-transitions", "host": [ "{{base_url}}" ], "path": [ "providers", ":provider", "status-transitions" ], "variable": [ { "key": "provider", "value": "" } ], "query": [] }, "description": "Alterna o status `active` do fornecedor e retorna **204**, sem corpo.\n\n**Permissões exigidas:** `providers.view` + `providers.update`.\n" } }, { "name": "Obter fornecedor", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers/:provider", "host": [ "{{base_url}}" ], "path": [ "providers", ":provider" ], "variable": [ { "key": "provider", "value": "" } ], "query": [] }, "description": "Retorna os dados completos do fornecedor, incluindo campos que aceitam `null` e coleções relacionadas.\n\n**Permissão exigida:** `providers.view`.\n" } }, { "name": "Editar fornecedor", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers/:provider", "host": [ "{{base_url}}" ], "path": [ "providers", ":provider" ], "variable": [ { "key": "provider", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"PJ\",\n \"name\": \"Fornecedor Atualizado Ltda\",\n \"active\": true,\n \"cnpj\": \"12345678000195\",\n \"emails\": [],\n \"phones\": [],\n \"addresses\": [],\n \"contacts\": [],\n \"bankAccounts\": []\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza um fornecedor. Aceita `application/json` ou `multipart/form-data`.\nEnvie somente os campos que deseja alterar. `name`, `type` e `active` são opcionais.\nArrays de contatos omitidos ou vazios preservam os vínculos existentes.\n\n**Permissões exigidas:** `providers.view` + `providers.update`.\n" } }, { "name": "Excluir fornecedor", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers/:provider", "host": [ "{{base_url}}" ], "path": [ "providers", ":provider" ], "variable": [ { "key": "provider", "value": "" } ], "query": [] }, "description": "Exclui cadastro inativo e elegível, sem contas abertas. Cadastro ativo é recusado com 422 em active; inative antes de excluir. Sucesso público: 204 sem corpo." } }, { "name": "Listar documentos do fornecedor", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers/:provider/documents", "host": [ "{{base_url}}" ], "path": [ "providers", ":provider", "documents" ], "variable": [ { "key": "provider", "value": "" } ], "query": [] }, "description": "Retorna os perfis de documento associados ao fornecedor.\n\nPermissões exigidas: `providers.view` + `documents.view`.\n" } }, { "name": "Anexar documento ao fornecedor", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers/:provider/documents/attachment", "host": [ "{{base_url}}" ], "path": [ "providers", ":provider", "documents", "attachment" ], "variable": [ { "key": "provider", "value": "" } ], "query": [] }, "description": "Envia um arquivo PDF para um perfil de documento do fornecedor. Use `multipart/form-data`.\n\n**Permissões exigidas:** `providers.view` + `documents.update`.\n", "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file", "src": [], "disabled": false, "description": "Arquivo a ser enviado (apenas PDF)." }, { "key": "document_id", "value": "b560292c-1908-4500-ba80-ec7798f11d5a", "type": "text", "disabled": false, "description": "ID do perfil de documento ao qual o anexo pertence (deve existir em `provider_has_documents`)." } ] } } }, { "name": "Excluir documento do fornecedor", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers/:provider/documents/:document", "host": [ "{{base_url}}" ], "path": [ "providers", ":provider", "documents", ":document" ], "variable": [ { "key": "provider", "value": "" }, { "key": "document", "value": "" } ], "query": [] }, "description": "Exclui um documento do fornecedor e retorna **204**, sem corpo.\n\n**Permissões exigidas:** `providers.view` + `documents.delete`.\n" } }, { "name": "Baixar documento do fornecedor", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/providers/:provider/documents/:document/file", "host": [ "{{base_url}}" ], "path": [ "providers", ":provider", "documents", ":document", "file" ], "variable": [ { "key": "provider", "value": "" }, { "key": "document", "value": "" } ], "query": [] }, "description": "Faz o download do arquivo de um documento anexado ao fornecedor.\n\nPermissão exigida: `providers.view` (sem permissão específica adicional —\n`downloadDocument` não aparece em `withPermissions()` além da base).\n" } } ] }, { "name": "Reports", "item": [ { "name": "Listar relatórios (PDF)", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports", "host": [ "{{base_url}}" ], "path": [ "reports" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Lista os relatórios PDF com paginação e status de geração: `pending`, `processing`, `completed`, `failed` ou `cancelled`.\n`sort_column` aceita `from`, `to`, `started_at`, `finished_at`, `type`, `status`, `orientation`, `created_at` e `updated_at`. Colunas inválidas retornam **422**.\nSem coluna de ordenação, os relatórios são listados por `created_at desc`. `per_page` deve ser um inteiro positivo.\n\nPermissões exigidas na chave de acesso: `accounting_reports.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Solicitar geração de relatório (PDF)", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports", "host": [ "{{base_url}}" ], "path": [ "reports" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"from\": \"2024-06-01\",\n \"to\": \"2024-06-30\",\n \"type\": \"balance_sheet\",\n \"orientation\": \"portrait\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Solicita a geração assíncrona de um relatório e retorna **201**.\nO campo `type` deve conter um dos valores do schema; valores inválidos retornam **422**.\nPara `type=cash_flow`, `from` deve ser uma data futura.\nO campo `status` pode ser `null` imediatamente após a criação, enquanto o processamento não é iniciado.\n\nPermissões exigidas na chave de acesso: `accounting_reports.create`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Obter relatório (PDF)", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/:report", "host": [ "{{base_url}}" ], "path": [ "reports", ":report" ], "variable": [ { "key": "report", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de um relatório, incluindo seu status de geração assíncrona.\n\nPermissões exigidas na chave de acesso: `accounting_reports.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Excluir relatório (PDF)", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/:report", "host": [ "{{base_url}}" ], "path": [ "reports", ":report" ], "variable": [ { "key": "report", "value": "" } ], "query": [] }, "description": "Exclui um relatório e retorna **204**, sem corpo.\n\nPermissões exigidas na chave de acesso: `accounting_reports.delete`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Cancelar relatório (PDF)", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/:report/cancellations", "host": [ "{{base_url}}" ], "path": [ "reports", ":report", "cancellations" ], "variable": [ { "key": "report", "value": "" } ], "query": [] }, "description": "Cancela um relatório pendente ou em processamento, alterando o status para `cancelled`.\nUm relatório já cancelado retorna **400**. Não é necessário enviar corpo na requisição.\n\nPermissões exigidas na chave de acesso: `accounting_reports.update`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Baixar arquivo PDF do relatório", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/:report/file", "host": [ "{{base_url}}" ], "path": [ "reports", ":report", "file" ], "variable": [ { "key": "report", "value": "" } ], "query": [] }, "description": "Faz o download do PDF de um relatório concluído.\nO relatório deve ter status `completed` e arquivo disponível. Caso contrário, retorna **400**.\n\nPermissões exigidas na chave de acesso: `accounting_reports.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Baixar relatório no formato escolhido", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{base_url}}/reports/:report/files/:format", "host": [ "{{base_url}}" ], "path": [ "reports", ":report", "files", ":format" ], "variable": [ { "key": "report", "value": "" }, { "key": "format", "value": "" } ], "query": [] }, "description": "Faz o download de um relatório concluído em `pdf` ou `xlsx`.\nO formato precisa ter sido solicitado na criação e estar concluído. Caso contrário, retorna **400**.\n\nPermissões exigidas na chave de acesso: `accounting_reports.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } } ] }, { "name": "Spreadsheets", "item": [ { "name": "Listar planilhas", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/spreadsheets", "host": [ "{{base_url}}" ], "path": [ "reports", "spreadsheets" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação aceita pela implementação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Sentido da ordenação; o serviço normaliza para asc quando não usa desc." } ] }, "description": "Lista as planilhas de contas a pagar com paginação.\n`sort_column` aceita `from`, `to`, `started_at`, `finished_at`, `progress`, `type`, `status`, `created_at` e `updated_at`. Colunas inválidas retornam **422**. `per_page` deve ser um inteiro positivo.\n\nPermissões exigidas na chave de acesso: `accounting_sheets.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Solicitar geração de planilha", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/spreadsheets", "host": [ "{{base_url}}" ], "path": [ "reports", "spreadsheets" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"from\": \"2026-05-21\",\n \"to\": \"2026-06-21\",\n \"type\": \"account_payable\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Solicita a geração assíncrona de uma planilha de contas a pagar no intervalo\nde datas informado. A geração ocorre em background via queue.\n\n**400 — PaymentsNotFoundException:** Se não houver contas a pagar no intervalo\n`[from, to]`, o serviço lança `PaymentsNotFoundException` e devolve HTTP 400.\nEsta não é uma falha de validação (422) — é uma regra de negócio verificada\napós a validação da entrada.\n\n\nRetorna **HTTP 201** em caso de sucesso.\n\nPermissões exigidas na chave de acesso: `accounting_sheets.create`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Obter planilha", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/spreadsheets/:spreadsheet", "host": [ "{{base_url}}" ], "path": [ "reports", "spreadsheets", ":spreadsheet" ], "variable": [ { "key": "spreadsheet", "value": "" } ], "query": [] }, "description": "Retorna os detalhes de uma planilha específica do tenant.\n\nPermissões exigidas na chave de acesso: `accounting_sheets.view`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Excluir planilha", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/spreadsheets/:spreadsheet", "host": [ "{{base_url}}" ], "path": [ "reports", "spreadsheets", ":spreadsheet" ], "variable": [ { "key": "spreadsheet", "value": "" } ], "query": [] }, "description": "Exclui uma planilha. Apenas planilhas com status\n`pending`, `completed`, `cancelled` ou `failed` podem ser excluídas.\nPlanilhas com status `processing` ou `processing_documents` retornam **400**.\n\nPermissões exigidas na chave de acesso: `accounting_sheets.delete`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Cancelar planilha", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/spreadsheets/:spreadsheet/cancellations", "host": [ "{{base_url}}" ], "path": [ "reports", "spreadsheets", ":spreadsheet", "cancellations" ], "variable": [ { "key": "spreadsheet", "value": "" } ], "query": [] }, "description": "Cancela uma planilha com status `processing` ou `processing_documents` e retorna **204**, sem corpo.\nPlanilhas com status `pending`, `completed`, `cancelled` ou `failed` retornam **400**.\n\nPermissões exigidas na chave de acesso: `accounting_sheets.update`. Quando o vínculo de uma permissão exige login, envie também X-Public-API-Key; a exigência pertence ao vínculo da chave, não é uma propriedade fixa da permissão." } }, { "name": "Baixar planilha (.xlsx)", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reports/spreadsheets/:spreadsheet/file", "host": [ "{{base_url}}" ], "path": [ "reports", "spreadsheets", ":spreadsheet", "file" ], "variable": [ { "key": "spreadsheet", "value": "" } ], "query": [] }, "description": "Faz o download do arquivo `.xlsx` de uma planilha concluída.\n\n**Permissão exigida:** `accounting_sheets.view`.\nAguarde o status `completed` e a disponibilização do arquivo. Uma planilha não concluída retorna **400**.\n" } } ] }, { "name": "Users", "item": [ { "name": "Listar usuários", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/users", "host": [ "{{base_url}}" ], "path": [ "users" ], "query": [ { "key": "active", "value": "", "disabled": true, "description": "Filtro opcional por Request::boolean: 1/true/on/yes viram true; 0/false e valores não reconhecidos, inclusive 2, viram false. Ausência não filtra. Não promete 422 sob enum [0,1]." }, { "key": "search", "value": "", "disabled": true, "description": "Busca por LIKE em `name` e `email` (OR)." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página." } ] }, "description": "Lista os usuários da empresa com paginação.\n\n**Permissão exigida:** `users.view`.\n\n| Parâmetro | Descrição |\n|-----------|-----------|\n| `active` | `1` para ativos, `0` para inativos; omitido, não filtra o status. |\n| `search` | Busca parcial por nome ou e-mail, combinada com `active` quando informado. |\n| `per_page` | Itens por página; padrão: 10. |\n| `page` | Número da página; padrão: 1. |\n\nCada item contém `id`, `name`, `email` e `active`. Consulte o detalhe do usuário para os demais campos.\n" } }, { "name": "Criar usuário", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/users", "host": [ "{{base_url}}" ], "path": [ "users" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"João Silva\",\n \"email\": \"joao.silva@empresa.com\",\n \"associate_type\": \"Employee\",\n \"associate_id\": \"9c541dc4-cb1f-4eaf-a643-aadd48c0a2fb\",\n \"phone\": \"11987654321\",\n \"role\": \"Administrador\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cria um usuário vinculado a um colaborador existente e retorna **201**.\n\n**Permissões exigidas:** `users.view` + `users.create`.\n`associate_type` deve ser `Employee`, `Intern` ou `Partner`, e `associate_id`, o UUID do colaborador correspondente. Cada colaborador pode ter somente um usuário associado.\n" } }, { "name": "Obter usuário", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/users/:user", "host": [ "{{base_url}}" ], "path": [ "users", ":user" ], "variable": [ { "key": "user", "value": "" } ], "query": [] }, "description": "Detalhe e lista são projeções distintas; detalhe não é superconjunto garantido da lista. associate_type_name descreve o vínculo sem expor o cadastro completo associado." } }, { "name": "Editar usuário", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/users/:user", "host": [ "{{base_url}}" ], "path": [ "users", ":user" ], "variable": [ { "key": "user", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"João Silva Atualizado\",\n \"email\": \"joao.novo@empresa.com\",\n \"role\": \"Financeiro\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Atualiza os dados de um usuário e retorna o cadastro atualizado. Envie somente os campos que deseja alterar.\n\n**Permissões exigidas:** `users.view` + `users.update`.\nO e-mail deve ser único entre usuários não excluídos, desconsiderando o próprio usuário. Identificadores inexistentes ou de outra empresa retornam **404**. Inativar ou trocar o cargo do **único administrador ativo** retorna **422** (a empresa não pode ficar sem administrador).\n" } }, { "name": "Excluir usuário", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/users/:user", "host": [ "{{base_url}}" ], "path": [ "users", ":user" ], "variable": [ { "key": "user", "value": "" } ], "query": [] }, "description": "Exclui um usuário e retorna **204**, sem corpo.\n\n**Permissões exigidas:** `users.view` + `users.delete`.\nIdentificadores inexistentes ou de outra empresa retornam **404**. Excluir o **único administrador ativo** da empresa retorna **422** (a empresa não pode ficar sem administrador).\n" } } ] }, { "name": "PIX Automático e boletos", "item": [ { "name": "Consultar PIX Automático", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/pix-mandate", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "pix-mandate" ], "variable": [ { "key": "account_receivable", "value": "{{account_receivable}}" } ], "query": [] }, "description": "Consulta a elegibilidade da recorrência e seu mandato. Permissão exigida: `accounts.view`. Conta avulsa retorna `eligibility.available=false`, motivo `not_recurring` e `mandate=null`." } }, { "name": "Solicitar PIX Automático", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/pix-mandate", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "pix-mandate" ], "variable": [ { "key": "account_receivable", "value": "{{account_receivable}}" } ], "query": [] }, "description": "Solicita autorização do pagador. Permissões exigidas: `accounts.view` + `bank_slip.emit`. O corpo é vazio: valor, datas e periodicidade são derivados da recorrência. São elegíveis periodicidades mensal, trimestral, semestral e anual; a elegibilidade também depende da configuração e do destinatário. Mandato já pendente ou ativo retorna 409." } }, { "name": "Cancelar PIX Automático", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/pix-mandate/cancellations", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "pix-mandate", "cancellations" ], "variable": [ { "key": "account_receivable", "value": "{{account_receivable}}" } ], "query": [] }, "description": "Solicita cancelamento do mandato da recorrência. Permissões exigidas: `accounts.view` + `bank_slip.emit`. O corpo é vazio. Consulte `cancellation_pending` para acompanhar a confirmação do cancelamento." } }, { "name": "Listar instruções PIX", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/pix-instructions", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "pix-instructions" ], "variable": [ { "key": "account_receivable", "value": "{{account_receivable}}" } ], "query": [] }, "description": "Lista instruções de débito desta conta em ordem decrescente de vencimento, sem paginação. Permissão exigida: `accounts.view`." } }, { "name": "Cancelar boleto", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/bank-slip/:bank_slip/cancellations", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "bank-slip", ":bank_slip", "cancellations" ], "variable": [ { "key": "account_receivable", "value": "{{account_receivable}}" }, { "key": "bank_slip", "value": "{{bank_slip}}" } ], "query": [] }, "description": "Permissões exigidas: `accounts.view` + `bank_slip.emit`. O boleto deve pertencer à conta a receber informada. A operação bem-sucedida retorna 204, sem corpo." } }, { "name": "Excluir boleto", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/bank-slip/:bank_slip", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "bank-slip", ":bank_slip" ], "variable": [ { "key": "account_receivable", "value": "{{account_receivable}}" }, { "key": "bank_slip", "value": "{{bank_slip}}" } ], "query": [] }, "description": "Permissões exigidas: `accounts.view` + `bank_slip.emit`. O boleto deve pertencer à conta a receber informada. A operação bem-sucedida retorna 204, sem corpo." } } ] }, { "name": "Sócios", "item": [ { "name": "Listar sócios", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners", "host": [ "{{base_url}}" ], "path": [ "partners" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Filtra por situação." }, { "key": "search", "value": "", "disabled": true, "description": "Nome ou CPF." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página." }, { "key": "sort_column", "value": "", "disabled": true, "description": "Coluna de ordenação." }, { "key": "sort_direction", "value": "", "disabled": true, "description": "Direção da ordenação." } ] }, "description": "Requer partners.view. Sem status, retorna ativos e inativos. Busca parcial por nome ou CPF." } }, { "name": "Criar sócio", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners", "host": [ "{{base_url}}" ], "path": [ "partners" ], "query": [] }, "description": "Requer partners.view. Requer partners.create. O CPF deve ser único entre sócios não excluídos; não pode haver outro cadastro de pessoa ativo com o mesmo CPF. A participação deve ser maior que zero e até 100; a soma das participações não é limitada. Nome e CPF são obrigatórios.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\",\n \"cpf\": \"52998224725\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Atualizar sócio", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner" ], "variable": [ { "key": "partner", "value": "{{partner}}" } ], "query": [] }, "description": "Requer partners.view. Requer partners.update. O CPF deve ser único entre sócios não excluídos; não pode haver outro cadastro de pessoa ativo com o mesmo CPF. A participação deve ser maior que zero e até 100; a soma das participações não é limitada. Relações omitidas são preservadas; [] limpa e uma lista nova substitui.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\",\n \"description\": \"Consultoria de outubro\",\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar sócio", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner" ], "variable": [ { "key": "partner", "value": "{{partner}}" } ], "query": [] }, "description": "Requer partners.view." } }, { "name": "Excluir sócio", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner" ], "variable": [ { "key": "partner", "value": "{{partner}}" } ], "query": [] }, "description": "Requer partners.view. Requer partners.delete. Somente sócios inativos podem ser excluídos." } }, { "name": "Alterar situação do sócio", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner/activation", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner", "activation" ], "variable": [ { "key": "partner", "value": "{{partner}}" } ], "query": [] }, "description": "Requer partners.view. Requer partners.update. Com active, define a situação; sem o campo, alterna. Inativar também inativa o usuário vinculado; reativar o sócio não reativa esse usuário. Conflito de CPF retorna 422.", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar documentos do sócio", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner/documents", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner", "documents" ], "variable": [ { "key": "partner", "value": "{{partner}}" } ], "query": [] }, "description": "Requer partners.view. Requer documents.view." } }, { "name": "Adicionar documentos ao sócio", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner/documents", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner", "documents" ], "variable": [ { "key": "partner", "value": "{{partner}}" } ], "query": [] }, "description": "Requer partners.view. Requer documents.create. Envie um objeto ou uma lista de perfis. Um perfil já associado retorna o documento existente. A resposta contém o registro do documento, sem a apresentação usada na listagem. A criação aceita apenas o perfil do documento. Envie o arquivo pela operação de upload; attachment_id e original_name não podem ser informados na criação.", "body": { "mode": "raw", "raw": "{\n \"document_profile_id\": \"10000000-0000-4000-8000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar documentos obrigatórios", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner/documents/required", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner", "documents", "required" ], "variable": [ { "key": "partner", "value": "{{partner}}" } ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "Filtro opcional de DocumentProfileType: PF, PJ, Any ou I. Ausência mantém a seleção de perfis Any; valor inválido é 422 errors.type antes da consulta. Um resultado vazio não valida tipo fora do enum." } ] }, "description": "Requer partners.view. Requer documents.view. Retorna os perfis obrigatórios da categoria Sócio que correspondem a type ou Any. Sem type, retorna os perfis Any." } }, { "name": "Enviar anexo de documento", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner/documents/attachment", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner", "documents", "attachment" ], "variable": [ { "key": "partner", "value": "{{partner}}" } ], "query": [] }, "description": "Requer partners.view. Requer documents.update. O documento deve pertencer ao sócio. Envie um PDF dentro do limite de upload configurado para a empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "document_id", "value": "{{document}}", "type": "text", "disabled": false, "description": "Identificador único do registro no recurso consultado. Identificação no formato UUID." }, { "key": "attachment", "type": "file", "src": [], "disabled": false, "description": "Arquivo anexado ao registro, conforme o tipo e formato declarados no schema." } ] } } }, { "name": "Baixar documento do sócio", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner/documents/:document/file", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner", "documents", ":document", "file" ], "variable": [ { "key": "partner", "value": "{{partner}}" }, { "key": "document", "value": "{{document}}" } ], "query": [] }, "description": "Requer partners.view. Requer documents.view. O documento deve pertencer ao sócio e ter anexo." } }, { "name": "Excluir documento do sócio", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/partners/:partner/documents/:document", "host": [ "{{base_url}}" ], "path": [ "partners", ":partner", "documents", ":document" ], "variable": [ { "key": "partner", "value": "{{partner}}" }, { "key": "document", "value": "{{document}}" } ], "query": [] }, "description": "Requer partners.view. Requer documents.delete. O documento deve pertencer ao sócio." } }, { "name": "Listar sócios para usuários", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/users/partners", "host": [ "{{base_url}}" ], "path": [ "users", "partners" ], "query": [] }, "description": "Requer users.view. Retorna uma lista sem paginação dos sócios ativos disponíveis no contexto de usuários." } }, { "name": "Listar sócios para contas a pagar", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-payable/partners", "host": [ "{{base_url}}" ], "path": [ "accounts-payable", "partners" ], "query": [] }, "description": "Requer accounts.view. Retorna uma lista sem paginação dos sócios ativos disponíveis no contexto de contas a pagar." } }, { "name": "Listar sócios para contas a receber", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/partners", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", "partners" ], "query": [] }, "description": "Requer accounts.view. Retorna uma lista sem paginação dos sócios ativos disponíveis no contexto de contas a receber." } } ] }, { "name": "Links de pagamento", "item": [ { "name": "Consultar ativação de recebimentos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/payment-activation", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-activation" ], "query": [] }, "description": "Requer bank_slip.configure ou card_receiving.configure. Retorna o estado de boleto, PIX e cartão, além da conta de repasse." } }, { "name": "Ativar recebimento por boleto e PIX", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/payment-activation/bank-slip", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-activation", "bank-slip" ], "query": [] }, "description": "Requer bank_slip.configure. A ativação depende do plano contratado e da disponibilidade de autoatendimento. Envie a conta de repasse completa quando a empresa ainda não a tiver cadastrada. Conta já cadastrada é preservada.", "body": { "mode": "raw", "raw": "{\n \"bank\": \"001\",\n \"agency\": \"0001-9\",\n \"number\": \"00012345-5\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ativar recebimento por cartão", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/payment-activation/card", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-activation", "card" ], "query": [] }, "description": "Requer card_receiving.configure. A ativação depende do plano contratado e da disponibilidade de autoatendimento. Envie a conta de repasse completa quando a empresa ainda não a tiver cadastrada. Conta já cadastrada é preservada.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar configuração dos links", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/payment-link", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-link" ], "query": [] }, "description": "Requer payment_links.view ou payment_links.configure. available_methods reflete os meios de recebimento ativados; preselected_method pode ser null quando nenhum meio está disponível." } }, { "name": "Configurar métodos dos links", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/payment-link", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-link" ], "query": [] }, "description": "Requer payment_links.configure. Escolha ao menos um método disponível e um método pré-selecionado entre os escolhidos. Retorna 201 com a configuração atualizada.", "body": { "mode": "raw", "raw": "{\n \"default_methods\": [\n \"pix\"\n ],\n \"preselected_method\": \"pix\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar link aberto da conta", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/payment-link", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "payment-link" ], "variable": [ { "key": "account_receivable", "value": "{{account_receivable}}" } ], "query": [] }, "description": "Requer accounts.view e ao menos uma das permissões payment_links.view ou payment_links.create. Retorna somente o link aberto. Quando a conta existe e não há link aberto, retorna 200 com data: null." } }, { "name": "Criar link de pagamento", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/accounts-receivable/:account_receivable/payment-link", "host": [ "{{base_url}}" ], "path": [ "accounts-receivable", ":account_receivable", "payment-link" ], "variable": [ { "key": "account_receivable", "value": "{{account_receivable}}" } ], "query": [] }, "description": "Requer accounts.view e payment_links.create. A conta da URL sempre participa do link. As contas adicionais devem pertencer ao mesmo cliente, estar em aberto e não possuir outro link aberto. Retorna a URL do checkout para compartilhar com o pagador. A criação do link não realiza uma cobrança de cartão.", "body": { "mode": "raw", "raw": "{\n \"methods\": [\n \"pix\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Catálogos de integração", "item": [ { "name": "Listar categorias financeiras", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/categories", "host": [ "{{base_url}}" ], "path": [ "categories" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "search", "value": "", "disabled": true, "description": "Busca textual da listagem." }, { "key": "type", "value": "", "disabled": true, "description": "Tipo usado para filtrar os registros; consulte o enum do recurso." }, { "key": "active", "value": "", "disabled": true, "description": "Filtra o estado ativo quando informado." } ] }, "description": "Lista categorias e sua configuração fiscal, incluindo habilitação para NFS-e. Filtros: search, active e type; aceita page e per_page. Permissão na chave: categories.view." }, "response": [] }, { "name": "Listar contas contábeis", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/account-standard-launches", "host": [ "{{base_url}}" ], "path": [ "account-standard-launches" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "search", "value": "", "disabled": true, "description": "Busca textual da listagem." }, { "key": "type", "value": "", "disabled": true, "description": "Tipo usado para filtrar os registros; consulte o enum do recurso." } ] }, "description": "Consulta os identificadores de conta contábil usados na criação de contas. Filtros: search e type; aceita page e per_page. Permissão na chave: std_launch.view." }, "response": [] }, { "name": "Listar centros de custo", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cost-centers", "host": [ "{{base_url}}" ], "path": [ "cost-centers" ], "query": [] }, "description": "Consulta centros ativos e inativos desta empresa. Permissão na chave: accounts.view ou categories.view/create/update." }, "response": [] }, { "name": "Criar centro de custo", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cost-centers", "host": [ "{{base_url}}" ], "path": [ "cost-centers" ], "query": [] }, "description": "Cadastra um centro de custo; name deve ser único na empresa. Permissão na chave: categories.create.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Administrativo\",\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Consultar configuração de centros de custo", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/cost-centers", "host": [ "{{base_url}}" ], "path": [ "configuration", "cost-centers" ], "query": [] }, "description": "Retorna enabled, mode e default_cost_center_id para preencher contas corretamente. Permissão na chave: accounts.view ou categories.view/create/update." }, "response": [] }, { "name": "Listar códigos tributários", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tax-code", "host": [ "{{base_url}}" ], "path": [ "tax-code" ], "query": [] }, "description": "Retorna códigos tributários do padrão de emissão configurado na empresa. Use o id retornado no campo tax da emissão. Permissão na chave: fiscal_rps.view/emit ou categories.view/create/update." }, "response": [] }, { "name": "Listar NBS", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/nbs", "host": [ "{{base_url}}" ], "path": [ "nbs" ], "query": [] }, "description": "Consulta a classificação de serviços disponível para a emissão. Use o id retornado no campo nbs. Permissão na chave: fiscal_rps.view/emit ou categories.view/create/update." }, "response": [] }, { "name": "Listar municípios", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cities", "host": [ "{{base_url}}" ], "path": [ "cities" ], "query": [] }, "description": "Catálogo de localidades com id interno, state_id e title. id não é código IBGE. Use os identificadores devolvidos pelo catálogo." }, "response": [] }, { "name": "Listar estados", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/states", "host": [ "{{base_url}}" ], "path": [ "states" ], "query": [] }, "description": "Consulta os estados disponíveis para cadastro de endereço. Permissão na chave: clients.view/create/update, providers.view/create/update, subsidiaries.view/create/update ou fiscal_rps.emit." }, "response": [] }, { "name": "Listar países", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/countries", "host": [ "{{base_url}}" ], "path": [ "countries" ], "query": [] }, "description": "Consulta os países disponíveis no padrão nacional de NFS-e. Permissão na chave: clients.view/create/update, providers.view/create/update, subsidiaries.view/create/update ou fiscal_rps.emit." }, "response": [] }, { "name": "Listar filiais", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/subsidiaries", "host": [ "{{base_url}}" ], "path": [ "subsidiaries" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." } ] }, "description": "Consulta filiais emissoras da empresa. Aceita page e per_page. Permissão na chave: subsidiaries.view." }, "response": [] } ] }, { "name": "Operações de gestão", "item": [ { "name": "Balanços", "item": [ { "name": "Listar — balanços", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/balances", "host": [ "{{base_url}}" ], "path": [ "balances" ], "query": [ { "key": "start_date", "value": "", "disabled": true, "description": "Data inicial inclusiva, AAAA-MM-DD. Obrigatória com expectation=1. Sem previsão e sem início, inclui o histórico realizado." }, { "key": "end_date", "value": "", "disabled": true, "description": "Data final inclusiva, AAAA-MM-DD, igual ou posterior ao início. Obrigatória com expectation=1; sem previsão, omitida considera hoje." }, { "key": "expectation", "value": "0", "disabled": true, "description": "Inclui os saldos restantes na previsão. Envie 1 para incluir e 0 para somente realizado; texto true/false retorna 422. Quando 1, informe ambas as datas." } ] }, "description": "Permissões exigidas na chave: (accounting_reports.view). O realizado segue o regime de caixa dos relatórios: conta o pagamento da fatura e não soma novamente as compras do cartão. Com expectation=1, acrescenta somente saldos restantes atuais de contas já geradas com vencimento na janela, incluindo contas parcialmente pagas. Não reconstrói o saldo em aberto de uma data histórica nem estima recorrências ainda não geradas. Totais realizados, previstos e projetados são separados, em strings decimais com duas casas; saídas são negativas. O resultado projetado é o realizado mais o restante, sem saldo de abertura. O limite é 50.000 movimentos; reduza o período se receber 422." } }, { "name": "Exportar — balanços", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/balances/export?type=csv&start_date=2026-10-01&end_date=2026-10-31", "host": [ "{{base_url}}" ], "path": [ "balances", "export" ], "query": [ { "key": "type", "value": "csv", "disabled": false, "description": "Formato do arquivo: csv para CSV, pdf para PDF, xml (opção legada) para planilha Excel (.xlsx). O valor xml não produz XML textual." }, { "key": "start_date", "value": "2026-10-01", "disabled": false, "description": "Data inicial inclusiva, AAAA-MM-DD. Obrigatória para exportação." }, { "key": "end_date", "value": "2026-10-31", "disabled": false, "description": "Data final inclusiva, AAAA-MM-DD, igual ou posterior ao início. Obrigatória para exportação." }, { "key": "expectation", "value": "0", "disabled": true, "description": "Inclui os saldos restantes na previsão. Envie 1 para incluir e 0 para somente realizado; texto true/false retorna 422. Quando 1, informe ambas as datas." } ] }, "description": "Permissões exigidas na chave: (accounting_reports.view). O realizado segue o regime de caixa dos relatórios: conta o pagamento da fatura e não soma novamente as compras do cartão. Com expectation=1, acrescenta somente saldos restantes atuais de contas já geradas com vencimento na janela, incluindo contas parcialmente pagas. Não reconstrói o saldo em aberto de uma data histórica nem estima recorrências ainda não geradas. Totais realizados, previstos e projetados são separados, em strings decimais com duas casas; saídas são negativas. O resultado projetado é o realizado mais o restante, sem saldo de abertura. O limite é 50.000 movimentos; reduza o período se receber 422. Retorna diretamente arquivo CSV, Excel (.xlsx pela opção legada type=xml) ou PDF, sem envelope JSON. Semanas têm sete dias e a última é limitada ao fim solicitado. O saldo inicial é o resultado realizado da janela equivalente no mês anterior; não representa o saldo bancário acumulado." } } ] }, { "name": "Bancos", "item": [ { "name": "Listar — bancos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/banks", "host": [ "{{base_url}}" ], "path": [ "banks" ], "query": [] }, "description": "Permissões exigidas na chave: (cashboxes.view ou cashboxes.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Benefícios", "item": [ { "name": "Listar — benefícios", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/benefits", "host": [ "{{base_url}}" ], "path": [ "benefits" ], "query": [] }, "description": "Permissões exigidas na chave: (employees.view ou interns.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Cargos", "item": [ { "name": "Listar — cargos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/roles", "host": [ "{{base_url}}" ], "path": [ "roles" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." } ] }, "description": "Permissões exigidas na chave: (roles.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — cargos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/roles", "host": [ "{{base_url}}" ], "path": [ "roles" ], "query": [] }, "description": "Permissões exigidas na chave: (roles.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"title\": \"Contrato de consultoria\",\n \"name\": \"Consultoria Exemplo\",\n \"permissions\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar — cargos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/roles/:role", "host": [ "{{base_url}}" ], "path": [ "roles", ":role" ], "variable": [ { "key": "role", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (roles.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar — cargos", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/roles/:role", "host": [ "{{base_url}}" ], "path": [ "roles", ":role" ], "variable": [ { "key": "role", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (roles.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"title\": \"Contrato de consultoria\",\n \"name\": \"Consultoria Exemplo\",\n \"permissions\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Atualizar — cargos", "request": { "method": "PATCH", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/roles/:role", "host": [ "{{base_url}}" ], "path": [ "roles", ":role" ], "variable": [ { "key": "role", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (roles.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"title\": \"Contrato de consultoria\",\n \"name\": \"Consultoria Exemplo\",\n \"permissions\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Excluir — cargos", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/roles/:role", "host": [ "{{base_url}}" ], "path": [ "roles", ":role" ], "variable": [ { "key": "role", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (roles.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Categorias", "item": [ { "name": "Criar — categorias", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/categories", "host": [ "{{base_url}}" ], "path": [ "categories" ], "query": [] }, "description": "Permissões exigidas na chave: (categories.view) e (categories.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\",\n \"type\": \"account_payable\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar correlação de tributação — categorias", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/categories/nfse-correlations?tax_code_id=10000000-0000-4000-8000-000000000301", "host": [ "{{base_url}}" ], "path": [ "categories", "nfse-correlations" ], "query": [ { "key": "tax_code_id", "value": "10000000-0000-4000-8000-000000000301", "disabled": false, "description": "UUID do código de tributação utilizado para consultar a correlação fiscal." }, { "key": "ctrib_nac", "value": "", "disabled": true, "description": "Código de tributação nacional usado para localizar a correlação fiscal." }, { "key": "ctrib_mun", "value": "", "disabled": true, "description": "Código de tributação municipal usado para localizar a correlação fiscal." } ] }, "description": "Permissões exigidas na chave: (categories.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar — categorias", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/categories/:category", "host": [ "{{base_url}}" ], "path": [ "categories", ":category" ], "variable": [ { "key": "category", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (categories.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar — categorias", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/categories/:category", "host": [ "{{base_url}}" ], "path": [ "categories", ":category" ], "variable": [ { "key": "category", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (categories.view) e (categories.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\",\n \"type\": \"account_payable\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alternar situação — categorias", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/categories/:category/status-transitions", "host": [ "{{base_url}}" ], "path": [ "categories", ":category", "status-transitions" ], "variable": [ { "key": "category", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (categories.view) e (categories.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Catálogos fiscais", "item": [ { "name": "Consultar — catálogos fiscais", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/tax-code/:tax_code", "host": [ "{{base_url}}" ], "path": [ "tax-code", ":tax_code" ], "variable": [ { "key": "tax_code", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.view ou fiscal_rps.emit ou categories.view ou categories.create ou categories.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Centros de custo", "item": [ { "name": "Atualizar — centros de custo", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cost-centers/:cost_center", "host": [ "{{base_url}}" ], "path": [ "cost-centers", ":cost_center" ], "variable": [ { "key": "cost_center", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (categories.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Conciliação", "item": [ { "name": "Listar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon" ], "variable": [ { "key": "recon", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Listar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx" ], "variable": [ { "key": "recon", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx" ], "variable": [ { "key": "recon", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "ofx", "type": "file", "src": [], "disabled": false, "description": "Arquivo OFX contendo as movimentações bancárias para importação." } ] } } }, { "name": "Consultar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Excluir — conciliação", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Listar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/groups", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "groups" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/groups", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "groups" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"type\": \"payment\",\n \"dir\": \"in\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/groups/:group", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "groups", ":group" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" }, { "key": "group", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Excluir — conciliação", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/groups/:group", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "groups", ":group" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" }, { "key": "group", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/groups/:group/items", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "groups", ":group", "items" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" }, { "key": "group", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nOs identificadores de grupo e entidade devem vir da consulta da conciliação vigente. O exemplo seleciona uma única entidade existente.", "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"00000000-0000-4000-8000-000000000001\",\n \"multiple\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Excluir — conciliação", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/groups/:group/items/:item", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "groups", ":group", "items", ":item" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" }, { "key": "group", "value": "" }, { "key": "item", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/links", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "links" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nOs dois vínculos do exemplo referenciam registros já existentes: uma transação OFX e um pagamento. Não use identificadores de outra empresa.", "body": { "mode": "raw", "raw": "{\n \"ofx_link\": {\n \"type\": \"single\",\n \"id\": \"00000000-0000-4000-8000-000000000001\"\n },\n \"payment_link\": {\n \"type\": \"single\",\n \"id\": \"00000000-0000-4000-8000-000000000002\"\n },\n \"justification\": \"Vínculo conferido no extrato.\",\n \"multiple\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Excluir — conciliação", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/links/:link", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "links", ":link" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" }, { "key": "link", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar sugestão de correspondência — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/ofx/:ofx/match-suggestion", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "ofx", ":ofx", "match-suggestion" ], "variable": [ { "key": "recon", "value": "" }, { "key": "ofx", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Listar transações — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/bank/:recon/transactions", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "bank", ":recon", "transactions" ], "variable": [ { "key": "recon", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Listar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/card", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "card" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." } ] }, "description": "Permissões exigidas na chave: (card_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/card/:recon", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "card", ":recon" ], "variable": [ { "key": "recon", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (card_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Conciliar — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/card/:recon/reconciliations", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "card", ":recon", "reconciliations" ], "variable": [ { "key": "recon", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (card_recons.view) e (card_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"expected_revision\": 1,\n \"value\": 150\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/movements", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "movements" ], "query": [ { "key": "search", "value": "", "disabled": true, "description": "Texto utilizado para localizar registros nos campos pesquisáveis desta listagem." }, { "key": "date_from", "value": "", "disabled": true, "description": "Data inicial do intervalo de movimentações, em AAAA-MM-DD." }, { "key": "date_to", "value": "", "disabled": true, "description": "Data final do intervalo de movimentações, em AAAA-MM-DD." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página de movimentos; a primeira página é 1." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página; sem enum universal presumido." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Idempotency-Key", "value": "conciliacao-exemplo-001", "disabled": false, "description": "Única fonte da chave idempotente. O campo homônimo no corpo não substitui este cabeçalho." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/movements/batch", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "movements", "batch" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update) e (accounts.create) e (payments.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nUse os movimentos, categorias e lançamentos padrão conferidos na prévia atual. Preserve a chave de idempotência ao repetir a mesma intenção.", "body": { "mode": "raw", "raw": "{\n \"linhas\": [\n {\n \"movement_id\": \"00000000-0000-4000-8000-000000000001\",\n \"category_id\": \"00000000-0000-4000-8000-000000000002\",\n \"account_standard_launch_id\": \"00000000-0000-4000-8000-000000000003\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar prévia — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/movements/preview", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "movements", "preview" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Desfazer vínculo — conciliação", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/movements/:movement/link", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "movements", ":movement", "link" ], "variable": [ { "key": "movement", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Excluir — conciliação", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/movements/:movement/application", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "movements", ":movement", "application" ], "variable": [ { "key": "movement", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update) e (accounts.delete) e (payments.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"application_id\": \"88b0fa61-3730-5aa4-b72e-c8a8ed5be6fc\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alterar destinação do movimento — conciliação", "request": { "method": "PATCH", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/movements/:movement/disposition", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "movements", ":movement", "disposition" ], "variable": [ { "key": "movement", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"disposition\": \"ignored\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Aprender apelido do lançamento — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/movements/:movement/aliases", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "movements", ":movement", "aliases" ], "variable": [ { "key": "movement", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update) e (std_launch.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"account_standard_launch_id\": \"b507e048-af4d-5f69-8a9f-c08503933c2c\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ativar conciliação unificada — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/activations", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "activations" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update) e (cashboxes.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nEnvie cashbox_id e o expected_preview_hash retornado pela prévia vigente. O hash do exemplo é ilustrativo e deve ser substituído; não confirma uma migração real.", "body": { "mode": "raw", "raw": "{\n \"expected_preview_hash\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar lançamentos do banco — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/bank-entries?cashbox_id=10000000-0000-4000-8000-000000000201&date_from=2026-10-01&date_to=2026-10-31", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "bank-entries" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." }, { "key": "date_from", "value": "2026-10-01", "disabled": false, "description": "Data inicial do intervalo de movimentações, em AAAA-MM-DD." }, { "key": "date_to", "value": "2026-10-31", "disabled": false, "description": "Data final do intervalo de movimentações, em AAAA-MM-DD." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "search", "value": "", "disabled": true, "description": "Texto utilizado para localizar registros nos campos pesquisáveis desta listagem." }, { "key": "status", "value": "", "disabled": true, "description": "Estado atual do recurso; os valores permitidos estão indicados no enum quando fechado." }, { "key": "direction", "value": "", "disabled": true, "description": "Sentido financeiro da movimentação; utilize os valores aceitos no enum." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Confirmar conciliação — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Idempotency-Key", "value": "f1000000-0000-4000-8000-000000000002", "disabled": false, "description": "Chave da intenção de conciliação. Reenvie a mesma chave com o mesmo conteúdo ao repetir o pedido. O valor no corpo não substitui este cabeçalho." }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/confirmations", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "confirmations" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nEnvie o cabeçalho Idempotency-Key: conciliacao-exemplo-001. Reutilize a mesma chave com o mesmo conteúdo ao repetir a intenção. O campo no corpo não substitui esse cabeçalho. Obtenha expected_version dos itens nas consultas atuais; os valores conciliados devem coincidir.", "body": { "mode": "raw", "raw": "{\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\",\n \"bank_items\": [\n {\n \"movement_id\": \"00000000-0000-4000-8000-000000000002\",\n \"amount\": \"100.00\",\n \"expected_version\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n }\n ],\n \"system_items\": [\n {\n \"entry_key\": \"payment:00000000-0000-4000-8000-000000000002:00000000-0000-4000-8000-000000000001\",\n \"amount\": \"100.00\",\n \"expected_version\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar prévia de migração — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/migration-preview?cashbox_id=10000000-0000-4000-8000-000000000201", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "migration-preview" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." } ] }, "description": "Permissões exigidas na chave: (bank_recons.update) e (cashboxes.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Revisar — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/reviews", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "reviews" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Cria ou confirma revisão somente com versão atual e evidência documental própria que cubra o período. evidence_document_id pode ser herdado de revisão anterior da mesma versão; sem evidência elegível retorna 422. opening_balance deve corresponder ao histórico verificável. Pendências dos dois lados devem estar resolvidas; um erro não cria revisão.", "body": { "mode": "raw", "raw": "{\n \"expected_version\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\",\n \"opening_balance\": \"0.00\",\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\",\n \"date_from\": \"2026-10-01\",\n \"date_to\": \"2026-10-29\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar candidatos à liquidação — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/settlement-candidates?cashbox_id=10000000-0000-4000-8000-000000000201&movement_id=10000000-0000-4000-8000-000000000202", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "settlement-candidates" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." }, { "key": "movement_id", "value": "10000000-0000-4000-8000-000000000202", "disabled": false, "description": "Movimento existente do caixa selecionado. Sem seletor a busca resulta em 404; não promete 200 vazio." }, { "key": "entry_key", "value": "", "disabled": true, "description": "Chave do lançamento financeiro selecionado na conciliação." }, { "key": "as_of", "value": "", "disabled": true, "description": "Data de referência da consulta dos candidatos à liquidação." }, { "key": "receiving_account_key", "value": "", "disabled": true, "description": "Chave da conta de recebimento utilizada para localizar os candidatos à liquidação." }, { "key": "paid_from", "value": "", "disabled": true, "description": "Início do período de pagamento utilizado para selecionar candidatos à liquidação." }, { "key": "paid_to", "value": "", "disabled": true, "description": "Fim do período de pagamento utilizado para selecionar candidatos à liquidação." }, { "key": "credit_from", "value": "", "disabled": true, "description": "Início do período de crédito bancário utilizado para selecionar candidatos à liquidação." }, { "key": "credit_to", "value": "", "disabled": true, "description": "Fim do período de crédito bancário utilizado para selecionar candidatos à liquidação." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar regra de liquidação — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/settlement-rule?cashbox_id=10000000-0000-4000-8000-000000000201", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "settlement-rule" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." }, { "key": "movement_id", "value": "", "disabled": true, "description": "UUID da movimentação bancária usada na análise de conciliação." }, { "key": "entry_key", "value": "", "disabled": true, "description": "Chave do lançamento financeiro selecionado na conciliação." }, { "key": "as_of", "value": "", "disabled": true, "description": "Data de referência da consulta dos candidatos à liquidação." }, { "key": "receiving_account_key", "value": "eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee", "disabled": true, "description": "Chave da conta de recebimento utilizada para localizar os candidatos à liquidação." }, { "key": "paid_from", "value": "", "disabled": true, "description": "Início do período de pagamento utilizado para selecionar candidatos à liquidação." }, { "key": "paid_to", "value": "", "disabled": true, "description": "Fim do período de pagamento utilizado para selecionar candidatos à liquidação." }, { "key": "credit_from", "value": "", "disabled": true, "description": "Início do período de crédito bancário utilizado para selecionar candidatos à liquidação." }, { "key": "credit_to", "value": "", "disabled": true, "description": "Fim do período de crédito bancário utilizado para selecionar candidatos à liquidação." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar regra de liquidação — conciliação", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/settlement-rule", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "settlement-rule" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_slip.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nUse a receiving_account_key retornada pela consulta atual e um calendário conferido. O exemplo omite cutoff: o runtime exige HH:mm, mas o schema publicado ainda declara date para esse campo opcional; essa divergência permanece identificada para correção.", "body": { "mode": "raw", "raw": "{\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\",\n \"receiving_account_key\": \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n \"business_days\": 1,\n \"timezone\": \"America/Sao_Paulo\",\n \"counting_event\": \"next_business_day\",\n \"calendar_version\": \"calendario-exemplo-2026\",\n \"calendar\": [\n {\n \"date\": \"2026-10-29\",\n \"business_day\": true,\n \"provenance\": \"Calendário informado pela empresa\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar resumo de liquidação — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/settlements/summary?cashbox_id=10000000-0000-4000-8000-000000000201", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "settlements", "summary" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." }, { "key": "movement_id", "value": "", "disabled": true, "description": "UUID da movimentação bancária usada na análise de conciliação." }, { "key": "entry_key", "value": "", "disabled": true, "description": "Chave do lançamento financeiro selecionado na conciliação." }, { "key": "as_of", "value": "", "disabled": true, "description": "Data de referência da consulta dos candidatos à liquidação." }, { "key": "receiving_account_key", "value": "", "disabled": true, "description": "Chave da conta de recebimento utilizada para localizar os candidatos à liquidação." }, { "key": "paid_from", "value": "", "disabled": true, "description": "Início do período de pagamento utilizado para selecionar candidatos à liquidação." }, { "key": "paid_to", "value": "", "disabled": true, "description": "Fim do período de pagamento utilizado para selecionar candidatos à liquidação." }, { "key": "credit_from", "value": "", "disabled": true, "description": "Início do período de crédito bancário utilizado para selecionar candidatos à liquidação." }, { "key": "credit_to", "value": "", "disabled": true, "description": "Fim do período de crédito bancário utilizado para selecionar candidatos à liquidação." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar fonte — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/source?cashbox_id=10000000-0000-4000-8000-000000000201", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "source" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Alterar fonte — conciliação", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/source", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "source" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update) e (cashboxes.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"source\": \"ofx\",\n \"effective_date\": \"2026-10-29\",\n \"cashbox_id\": \"00000000-0000-4000-8000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar sugestões — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/suggestions?cashbox_id=10000000-0000-4000-8000-000000000201", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "suggestions" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." }, { "key": "movement_id", "value": "10000000-0000-4000-8000-000000000202", "disabled": true, "description": "UUID da movimentação bancária usada na análise de conciliação." }, { "key": "entry_key", "value": "", "disabled": true, "description": "Chave do lançamento financeiro selecionado na conciliação." }, { "key": "as_of", "value": "", "disabled": true, "description": "Data de referência da consulta dos candidatos à liquidação." }, { "key": "receiving_account_key", "value": "", "disabled": true, "description": "Chave da conta de recebimento utilizada para localizar os candidatos à liquidação." }, { "key": "paid_from", "value": "", "disabled": true, "description": "Início do período de pagamento utilizado para selecionar candidatos à liquidação." }, { "key": "paid_to", "value": "", "disabled": true, "description": "Fim do período de pagamento utilizado para selecionar candidatos à liquidação." }, { "key": "credit_from", "value": "", "disabled": true, "description": "Início do período de crédito bancário utilizado para selecionar candidatos à liquidação." }, { "key": "credit_to", "value": "", "disabled": true, "description": "Fim do período de crédito bancário utilizado para selecionar candidatos à liquidação." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Informe cashbox_id e exatamente um seletor: movement_id OU entry_key. Nenhum ou ambos os seletores resulta em 422 com detail de seleção; não é garantido errors por campo nesta recusa global." } }, { "name": "Consultar resumo — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/summary?cashbox_id=10000000-0000-4000-8000-000000000201&date_from=2026-10-01&date_to=2026-10-31", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "summary" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." }, { "key": "date_from", "value": "2026-10-01", "disabled": false, "description": "Data inicial do intervalo de movimentações, em AAAA-MM-DD." }, { "key": "date_to", "value": "2026-10-31", "disabled": false, "description": "Data final do intervalo de movimentações, em AAAA-MM-DD." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "search", "value": "", "disabled": true, "description": "Texto utilizado para localizar registros nos campos pesquisáveis desta listagem." }, { "key": "status", "value": "", "disabled": true, "description": "Estado atual do recurso; os valores permitidos estão indicados no enum quando fechado." }, { "key": "direction", "value": "", "disabled": true, "description": "Sentido financeiro da movimentação; utilize os valores aceitos no enum." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Listar lançamentos do sistema — conciliação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/system-entries?cashbox_id=10000000-0000-4000-8000-000000000201&date_from=2026-10-01&date_to=2026-10-31", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", "system-entries" ], "query": [ { "key": "cashbox_id", "value": "10000000-0000-4000-8000-000000000201", "disabled": false, "description": "UUID do caixa financeiro vinculado à operação na empresa autenticada." }, { "key": "date_from", "value": "2026-10-01", "disabled": false, "description": "Data inicial do intervalo de movimentações, em AAAA-MM-DD." }, { "key": "date_to", "value": "2026-10-31", "disabled": false, "description": "Data final do intervalo de movimentações, em AAAA-MM-DD." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "search", "value": "", "disabled": true, "description": "Texto utilizado para localizar registros nos campos pesquisáveis desta listagem." }, { "key": "status", "value": "", "disabled": true, "description": "Estado atual do recurso; os valores permitidos estão indicados no enum quando fechado." }, { "key": "direction", "value": "", "disabled": true, "description": "Sentido financeiro da movimentação; utilize os valores aceitos no enum." } ] }, "description": "Permissões exigidas na chave: (bank_recons.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Reverter — conciliação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reconciliations/unified/:reconciliation/reversals", "host": [ "{{base_url}}" ], "path": [ "reconciliations", "unified", ":reconciliation", "reversals" ], "variable": [ { "key": "reconciliation", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_recons.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"expected_revision\": 1,\n \"reason\": \"Solicitação do responsável\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Configurações", "item": [ { "name": "Atualizar configuração de boleto — configurações", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/bank-slip", "host": [ "{{base_url}}" ], "path": [ "configuration", "bank-slip" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_slip.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "logo", "type": "file", "src": [], "disabled": true, "description": "Limite do arquivo em KiB: max 102400." } ] } } }, { "name": "Consultar configuração de boleto — configurações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/bank-slip", "host": [ "{{base_url}}" ], "path": [ "configuration", "bank-slip" ], "query": [] }, "description": "Permissões exigidas na chave: (bank_slip.view ou bank_slip.emit ou bank_slip.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Excluir logotipo do boleto — configurações", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/bank-slip/:systemConfig", "host": [ "{{base_url}}" ], "path": [ "configuration", "bank-slip", ":systemConfig" ], "variable": [ { "key": "systemConfig", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_slip.emit). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar configuração — configurações", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/cost-centers", "host": [ "{{base_url}}" ], "path": [ "configuration", "cost-centers" ], "query": [] }, "description": "Permissões exigidas na chave: (categories.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"mode\": \"single\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar configuração fiscal — configurações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/fiscal-rps", "host": [ "{{base_url}}" ], "path": [ "configuration", "fiscal-rps" ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.emit). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar configuração fiscal — configurações", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/fiscal-rps", "host": [ "{{base_url}}" ], "path": [ "configuration", "fiscal-rps" ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "issqn_immunity_type", "value": "", "type": "text", "disabled": true, "description": "Tipo de imunidade da empresa (tpImunidade), de 1 a 5, com o texto do Anexo I. Só com Tributação ISSQN imunidade; com outra, retorna 422." }, { "key": "confirmar_issqn_tributation", "value": "", "type": "text", "disabled": true, "description": "Confirma a Tributação ISSQN gravada antes de 31/10/2026. Sem confirmação, esse valor não muda a nota (conta como não definido). Escolher um valor novo também confirma. Use 0 ou 1." }, { "key": "certificate", "type": "file", "src": [], "disabled": true, "description": "Limite do arquivo em KiB: max 102400." }, { "key": "password", "value": "", "type": "text", "disabled": true, "description": "Senha do usuário para autenticação. Trate como segredo e não registre em logs." }, { "key": "issqn", "value": "2", "type": "text", "disabled": false, "description": "Alíquota do Imposto Sobre Serviços de Qualquer Natureza, conforme a configuração da emissão." }, { "key": "use_issqn", "value": "true", "type": "text", "disabled": false, "description": "Indica se o cálculo fiscal deve considerar o ISSQN informado." }, { "key": "send_im", "value": "false", "type": "text", "disabled": false, "description": "Controla o envio da inscrição municipal cadastrada do prestador na NFS-e." }, { "key": "retentions", "value": "false", "type": "text", "disabled": false, "description": "Indica se há retenções tributárias a considerar na emissão ou no lançamento." }, { "key": "simple", "value": "no", "type": "text", "disabled": false, "description": "Código obrigatório do enum NFSeSimplesNacional; não é booleano." } ] } } }, { "name": "Consultar configuração de ISSQN — configurações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/fiscal-rps-issqn", "host": [ "{{base_url}}" ], "path": [ "configuration", "fiscal-rps-issqn" ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.view ou fiscal_rps.emit ou categories.view ou categories.create ou categories.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar certificado A1 — configurações", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/fiscal-rps/certificate", "host": [ "{{base_url}}" ], "path": [ "configuration", "fiscal-rps", "certificate" ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "certificate", "type": "file", "src": [], "disabled": false, "description": "Limite do arquivo em KiB: max 102400." }, { "key": "password", "value": "", "type": "text", "disabled": true, "description": "Senha do usuário para autenticação. Trate como segredo e não registre em logs." } ] } } }, { "name": "Consultar classificação fiscal sugerida — configurações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/fiscal-rps/suggested-classification?nbs=115021000", "host": [ "{{base_url}}" ], "path": [ "configuration", "fiscal-rps", "suggested-classification" ], "query": [ { "key": "nbs", "value": "115021000", "disabled": false, "description": "Identificador da Nomenclatura Brasileira de Serviços no catálogo fiscal; preserve o tipo declarado." }, { "key": "onerosa", "value": "", "disabled": true, "description": "Booleano na query: serialize como 0 ou 1. Texto true/false não passa na validação boolean." }, { "key": "exterior", "value": "", "disabled": true, "description": "Booleano na query: serialize como 0 ou 1. Texto true/false não passa na validação boolean." } ] }, "description": "Permissões exigidas na chave: (fiscal_rps.emit). A sugestão segue o Anexo VIII local. Classificações por local do imóvel, como indop 020201, independem de onerosa/exterior. Não onerosa com adquirente no exterior pode não ter sugestão; não extrapole combinações ausentes." } }, { "name": "Consultar orientação do emissor — configurações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/fiscal-rps/guidance", "host": [ "{{base_url}}" ], "path": [ "configuration", "fiscal-rps", "guidance" ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.emit). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar tabelas de IBS/CBS — configurações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/fiscal-rps/ibs-cbs-tables", "host": [ "{{base_url}}" ], "path": [ "configuration", "fiscal-rps", "ibs-cbs-tables" ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.view ou fiscal_rps.emit ou categories.view ou categories.create ou categories.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Vincular credencial de recebimento — configurações", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/payment-activation/credentials/:method", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-activation", "credentials", ":method" ], "variable": [ { "key": "method", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_slip.configure ou card_receiving.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nSubstitua os textos de exemplo pelas credenciais reais do processador obtidas pelo responsável da empresa. Não são credenciais utilizáveis e não devem ser registradas em logs.", "body": { "mode": "raw", "raw": "{\n \"credencial\": \"SUBSTITUA_CREDENCIAL_PJBANK\",\n \"chave\": \"SUBSTITUA_CHAVE_PJBANK\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ativar link de pagamento — configurações", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/payment-activation/link/activation", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-activation", "link", "activation" ], "query": [] }, "description": "Permissões exigidas na chave: (payment_links.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Desativar link de pagamento — configurações", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/payment-activation/link/activation", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-activation", "link", "activation" ], "query": [] }, "description": "Permissões exigidas na chave: (payment_links.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Alterar meio de recebimento — configurações", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/payment-activation/methods/:method", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-activation", "methods", ":method" ], "variable": [ { "key": "method", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (bank_slip.configure ou card_receiving.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Atualizar identidade do link de pagamento — configurações", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/payment-link/branding", "host": [ "{{base_url}}" ], "path": [ "configuration", "payment-link", "branding" ], "query": [] }, "description": "Permissões exigidas na chave: (payment_links.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "logo", "type": "file", "src": [], "disabled": true, "description": "Limite do arquivo em KiB: max 2048." }, { "key": "remove_logo", "value": "", "type": "text", "disabled": true, "description": "Quando verdadeiro, solicita a remoção da imagem de marca atualmente configurada." }, { "key": "color", "value": "", "type": "text", "disabled": true, "description": "Cor de exibição em hexadecimal com seis dígitos precedidos de #, como #125599." }, { "key": "display_name", "value": "", "type": "text", "disabled": true, "description": "Token de escolha; não é o nome resolvido da empresa." }, { "key": "message", "value": "", "type": "text", "disabled": true, "description": "Mensagem legível que explica o resultado da operação." }, { "key": "support_email", "value": "", "type": "text", "disabled": true, "description": "Endereço de e-mail para atendimento ao pagador no link de pagamento." }, { "key": "support_phone", "value": "", "type": "text", "disabled": true, "description": "Telefone de atendimento apresentado ao pagador no link de pagamento." } ] } } }, { "name": "Consultar regime tributário — configurações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/regime-tributario", "host": [ "{{base_url}}" ], "path": [ "configuration", "regime-tributario" ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.emit). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar regime tributário — configurações", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/configuration/regime-tributario", "host": [ "{{base_url}}" ], "path": [ "configuration", "regime-tributario" ], "query": [] }, "description": "Permissões exigidas na chave: (fiscal_rps.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"regime\": \"tradicional\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar identidade visual — configurações", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/template-layout", "host": [ "{{base_url}}" ], "path": [ "configuration", "template-layout" ], "query": [] }, "description": "Permissões exigidas na chave: (layout.edit). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar identidade visual — configurações", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/configuration/template-layout", "host": [ "{{base_url}}" ], "path": [ "configuration", "template-layout" ], "query": [] }, "description": "Permissões exigidas na chave: (layout.edit). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "logo", "type": "file", "src": [], "disabled": true, "description": "Limite do arquivo em KiB: max 102400." }, { "key": "color", "value": "", "type": "text", "disabled": true, "description": "Cor hexadecimal ou nome simples; até 30 caracteres; formato do request." } ] } } } ] }, { "name": "Consulta de CNPJ", "item": [ { "name": "Consultar capabilities — consulta de cnpj", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/cnpj/capabilities", "host": [ "{{base_url}}" ], "path": [ "cnpj", "capabilities" ], "query": [] }, "description": "Permissões exigidas na chave: (clients.create ou providers.create ou clients.update ou providers.update ou accounts.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar lookup — consulta de cnpj", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/cnpj/lookups", "host": [ "{{base_url}}" ], "path": [ "cnpj", "lookups" ], "query": [] }, "description": "Permissões exigidas na chave: (clients.create ou providers.create ou clients.update ou providers.update ou accounts.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"cnpj\": \"12345678000195\",\n \"entity_type\": \"client\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Contratos", "item": [ { "name": "Listar — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts", "host": [ "{{base_url}}" ], "path": [ "contracts" ], "query": [ { "key": "status", "value": "", "disabled": true, "description": "Estado atual do recurso; os valores permitidos estão indicados no enum quando fechado." }, { "key": "contractable_type", "value": "", "disabled": true, "description": "Tipo de pessoa ou entidade vinculada ao contrato; informe junto com contractable_id." }, { "key": "contractable_id", "value": "", "disabled": true, "description": "UUID da pessoa ou entidade vinculada ao contrato; informe junto com contractable_type." }, { "key": "vigencia", "value": "", "disabled": true, "description": "Situação de vigência utilizada para filtrar os contratos." }, { "key": "search", "value": "", "disabled": true, "description": "Texto utilizado para localizar registros nos campos pesquisáveis desta listagem." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." } ] }, "description": "Permissões exigidas na chave: (contracts.view). vigente/nao_vigente consideram somente ready_for_finalization/completed. Rascunhos, enviados, recusados e cancelados ficam fora de ambos. Os filtros não particionam toda a listagem." } }, { "name": "Criar — contratos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/contracts", "host": [ "{{base_url}}" ], "path": [ "contracts" ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"contractable_type\": \"client\",\n \"contractable_id\": \"c4e59b71-71df-5c1b-829a-65a3a45b9e12\",\n \"vigencia_inicio_modo\": \"data\",\n \"vigencia_inicio_data\": \"2026-11-01\",\n \"vigencia_fim_modo\": \"data\",\n \"vigencia_fim_data\": \"2027-11-01\",\n \"title\": \"Contrato de consultoria\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/settings", "host": [ "{{base_url}}" ], "path": [ "contracts", "settings" ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.settings). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar — contratos", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/contracts/settings", "host": [ "{{base_url}}" ], "path": [ "contracts", "settings" ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.settings). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"pricing_acknowledged\": false,\n \"company_signers\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar — contratos", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.update). Exige estado editável: cancelado é 422 errors.contract; em estado elegível, versão desatualizada é 409. Estado é validado antes da versão.", "body": { "mode": "raw", "raw": "{\n \"version\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancelar — contratos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/contracts/:contract/cancellations", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "cancellations" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.cancel). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"version\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Baixar pacote de evidências — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/evidence-package", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "evidence-package" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.evidence). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Baixar evidências em PDF — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/evidence-pdf", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "evidence-pdf" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.evidence). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Baixar PDF final — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/final-pdf", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "final-pdf" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Finalizar — contratos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/finalizations", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "finalizations" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.send). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Baixar PDF — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/pdf", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "pdf" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Enviar PDF — contratos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/pdf", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "pdf" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.update). PDF só pode ser alterado em estado editável. Cancelado retorna 422 errors.contract sem substituição. Em estado elegível, versão desatualizada gera 409.", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "disabled": false, "description": "Limite do arquivo em KiB: max 20480." }, { "key": "version", "value": "", "type": "text", "disabled": false, "description": "Versão do recurso utilizada para identificar alterações concorrentes." } ] } } }, { "name": "Repetir entrega — contratos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/delivery-retries", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "delivery-retries" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.send). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa. Esta ação pode disparar comunicação aos signatários." } }, { "name": "Enviar para assinatura — contratos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/contracts/:contract/deliveries", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "deliveries" ], "variable": [ { "key": "contract", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.send). Antes do débito/envio: escolher mode, cadastrar signatário externo, confirmar orçamento e preparar PDF. Fora de icp_brasil exige posições de todos os signatários; ausência retorna 422 errors.placements antes de cobrar/enviar.", "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"bad17fda-e555-51d9-bf57-b64c2ee80992\",\n \"version\": 1,\n \"expected_total_credits\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Baixar arquivo de identidade — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/signers/:signer/identity/:file", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "signers", ":signer", "identity", ":file" ], "variable": [ { "key": "contract", "value": "" }, { "key": "signer", "value": "" }, { "key": "file", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.review ou contracts.evidence). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Reiniciar verificação do signatário — contratos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/signers/:signer/verification-resets", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "signers", ":signer", "verification-resets" ], "variable": [ { "key": "contract", "value": "" }, { "key": "signer", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.view) e (contracts.send). Reinicia verificação apenas para signatário próprio elegível, com PDF aceito/accepted_path/accepted_sha256 e expires_at futuro. Rascunho e outros casos inelegíveis podem retornar 404, sem promessa de 409 universal." } }, { "name": "Consultar — contratos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/contracts/:contract/signers/:signer/review", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "signers", ":signer", "review" ], "variable": [ { "key": "contract", "value": "" }, { "key": "signer", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.review ou contracts.evidence). Consulta revisão de signatário próprio somente na modalidade extended. Em simple esta consulta retorna 404." } }, { "name": "Decidir revisão de identidade — contratos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/contracts/:contract/signers/:signer/review", "host": [ "{{base_url}}" ], "path": [ "contracts", ":contract", "signers", ":signer", "review" ], "variable": [ { "key": "contract", "value": "" }, { "key": "signer", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (contracts.review ou contracts.evidence) e (contracts.review). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nLeia a revisão atual antes de enviar review_revision. O hash ilustrativo não confirma a revisão de nenhum contrato real.", "body": { "mode": "raw", "raw": "{\n \"decision\": \"resubmit\",\n \"reason\": \"Documento ilegível\",\n \"review_revision\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Cópias de cobranças", "item": [ { "name": "Listar — cópias de cobranças", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/billing-copy-recipients", "host": [ "{{base_url}}" ], "path": [ "billing-copy-recipients" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." } ] }, "description": "Permissões exigidas na chave: (workflows.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — cópias de cobranças", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/billing-copy-recipients", "host": [ "{{base_url}}" ], "path": [ "billing-copy-recipients" ], "query": [] }, "description": "Permissões exigidas na chave: (workflows.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"email\": \"copia@example.com\",\n \"type\": \"cc\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Atualizar — cópias de cobranças", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/billing-copy-recipients/:billingCopyRecipient", "host": [ "{{base_url}}" ], "path": [ "billing-copy-recipients", ":billingCopyRecipient" ], "variable": [ { "key": "billingCopyRecipient", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (workflows.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"email\": \"copia@example.com\",\n \"type\": \"cc\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Excluir — cópias de cobranças", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/billing-copy-recipients/:billingCopyRecipient", "host": [ "{{base_url}}" ], "path": [ "billing-copy-recipients", ":billingCopyRecipient" ], "variable": [ { "key": "billingCopyRecipient", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (workflows.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Alterar situação — cópias de cobranças", "request": { "method": "PATCH", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/billing-copy-recipients/:billingCopyRecipient/status", "host": [ "{{base_url}}" ], "path": [ "billing-copy-recipients", ":billingCopyRecipient", "status" ], "variable": [ { "key": "billingCopyRecipient", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (workflows.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Documentos", "item": [ { "name": "Excluir — documentos", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/documents/attachment/:document", "host": [ "{{base_url}}" ], "path": [ "documents", "attachment", ":document" ], "variable": [ { "key": "document", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (documents.view) e (documents.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Excluir — documentos", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/documents/:document", "host": [ "{{base_url}}" ], "path": [ "documents", ":document" ], "variable": [ { "key": "document", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (documents.view) e (documents.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Documentos auxiliares", "item": [ { "name": "Listar — documentos auxiliares", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/aux-documents", "host": [ "{{base_url}}" ], "path": [ "aux-documents" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Página da consulta paginada." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página; ausente ou vazio usa o padrão da listagem." } ] }, "description": "Permissões exigidas na chave: (aux_document.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — documentos auxiliares", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/aux-documents", "host": [ "{{base_url}}" ], "path": [ "aux-documents" ], "query": [] }, "description": "Permissões exigidas na chave: (aux_document.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "account_type", "value": "", "type": "text", "disabled": false, "description": "Tipo da conta financeira consultada ou vinculada; use as opções aceitas nesta operação. Opções: `receivable`, `payable`." }, { "key": "account_id", "value": "", "type": "text", "disabled": false, "description": "Identificador da conta financeira no escopo da empresa autenticada." }, { "key": "attachments", "type": "file", "src": [], "disabled": true, "description": "Arquivos anexados ao registro para comprovação ou consulta." } ] } } }, { "name": "Baixar — documentos auxiliares", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/aux-documents/:document", "host": [ "{{base_url}}" ], "path": [ "aux-documents", ":document" ], "variable": [ { "key": "document", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (aux_document.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Excluir — documentos auxiliares", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/aux-documents/:document", "host": [ "{{base_url}}" ], "path": [ "aux-documents", ":document" ], "variable": [ { "key": "document", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (aux_document.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Filiais", "item": [ { "name": "Criar — filiais", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/subsidiaries", "host": [ "{{base_url}}" ], "path": [ "subsidiaries" ], "query": [] }, "description": "Permissões exigidas na chave: (subsidiaries.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Filial Exemplo Fictícia", "type": "text", "disabled": false, "description": "Nome utilizado para identificar e exibir o registro." }, { "key": "fantasy_name", "value": "Filial Exemplo", "type": "text", "disabled": false, "description": "Nome fantasia pelo qual a pessoa jurídica é conhecida comercialmente." }, { "key": "cnpj", "value": "11222333000181", "type": "text", "disabled": false, "description": "CNPJ da pessoa jurídica envolvida na operação, preservando zeros à esquerda." }, { "key": "addresses", "value": "{\"state_id\":\"10000000-0000-4000-8000-000000000901\",\"city_id\":\"10000000-0000-4000-8000-000000000902\",\"address\":\"Rua Exemplo\",\"number\":\"123\",\"neighborhood\":\"Centro\",\"zipcode\":\"30110000\"}", "type": "text", "disabled": false, "description": "Endereços vinculados ao cadastro, com município e estado de referência.", "contentType": "application/json" }, { "key": "emails", "value": "{\"email\":\"filial@example.com\",\"type\":\"10000000-0000-4000-8000-000000000903\"}", "type": "text", "disabled": false, "description": "Endereços de e-mail vinculados ao cadastro e suas classificações.", "contentType": "application/json" }, { "key": "phones", "value": "{\"phone\":\"31999990001\",\"type\":\"10000000-0000-4000-8000-000000000904\"}", "type": "text", "disabled": false, "description": "Números de telefone vinculados ao cadastro e suas classificações.", "contentType": "application/json" }, { "key": "fiscal_rps_config", "value": "{\"issuer\":{\"im\":\"12345\",\"cnpj\":\"11222333000181\",\"razao\":\"Filial Exemplo Fictícia\"},\"nfse_system\":\"national\",\"issqn\":2,\"use_issqn\":true}", "type": "text", "disabled": false, "description": "Configuração fiscal do emissor para o preenchimento de RPS e NFS-e.", "contentType": "application/json" } ] } } }, { "name": "Consultar indicadores — filiais", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/subsidiaries/stats", "host": [ "{{base_url}}" ], "path": [ "subsidiaries", "stats" ], "query": [] }, "description": "Permissões exigidas na chave: (subsidiaries.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar — filiais", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/subsidiaries/:subsidiary", "host": [ "{{base_url}}" ], "path": [ "subsidiaries", ":subsidiary" ], "variable": [ { "key": "subsidiary", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (subsidiaries.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar — filiais", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/subsidiaries/:subsidiary", "host": [ "{{base_url}}" ], "path": [ "subsidiaries", ":subsidiary" ], "variable": [ { "key": "subsidiary", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (subsidiaries.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Filial Exemplo Fictícia", "type": "text", "disabled": false, "description": "Nome utilizado para identificar e exibir o registro." }, { "key": "fantasy_name", "value": "Filial Exemplo", "type": "text", "disabled": false, "description": "Nome fantasia pelo qual a pessoa jurídica é conhecida comercialmente." }, { "key": "cnpj", "value": "11222333000181", "type": "text", "disabled": false, "description": "CNPJ da pessoa jurídica envolvida na operação, preservando zeros à esquerda." }, { "key": "addresses", "value": "{\"state_id\":\"10000000-0000-4000-8000-000000000901\",\"city_id\":\"10000000-0000-4000-8000-000000000902\",\"address\":\"Rua Exemplo\",\"number\":\"123\",\"neighborhood\":\"Centro\",\"zipcode\":\"30110000\"}", "type": "text", "disabled": false, "description": "Endereços vinculados ao cadastro, com município e estado de referência.", "contentType": "application/json" }, { "key": "emails", "value": "{\"email\":\"filial@example.com\",\"type\":\"10000000-0000-4000-8000-000000000903\",\"email_type_id\":\"10000000-0000-4000-8000-000000000903\"}", "type": "text", "disabled": false, "description": "Endereços de e-mail vinculados ao cadastro e suas classificações.", "contentType": "application/json" }, { "key": "phones", "value": "{\"phone\":\"31999990001\",\"type\":\"10000000-0000-4000-8000-000000000904\",\"phone_type_id\":\"10000000-0000-4000-8000-000000000904\"}", "type": "text", "disabled": false, "description": "Números de telefone vinculados ao cadastro e suas classificações.", "contentType": "application/json" }, { "key": "fiscal_rps_config", "value": "{\"issuer\":{\"im\":\"12345\",\"cnpj\":\"11222333000181\",\"razao\":\"Filial Exemplo Fictícia\"},\"nfse_system\":\"national\",\"issqn\":2,\"use_issqn\":true}", "type": "text", "disabled": false, "description": "Configuração fiscal do emissor para o preenchimento de RPS e NFS-e.", "contentType": "application/json" }, { "key": "certificate", "type": "file", "src": [], "disabled": true, "description": "Limite do arquivo em KiB: max 102400." }, { "key": "logo", "type": "file", "src": [], "disabled": true, "description": "Limite do arquivo em KiB: max 102400." } ] } } }, { "name": "Excluir — filiais", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/subsidiaries/:subsidiary", "host": [ "{{base_url}}" ], "path": [ "subsidiaries", ":subsidiary" ], "variable": [ { "key": "subsidiary", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (subsidiaries.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Alterar ativação — filiais", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/subsidiaries/:subsidiary/activation", "host": [ "{{base_url}}" ], "path": [ "subsidiaries", ":subsidiary", "activation" ], "variable": [ { "key": "subsidiary", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (subsidiaries.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"active\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Atualizar certificado A1 da filial — filiais", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/subsidiaries/:subsidiary/certificate", "host": [ "{{base_url}}" ], "path": [ "subsidiaries", ":subsidiary", "certificate" ], "variable": [ { "key": "subsidiary", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (subsidiaries.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "formdata", "formdata": [ { "key": "certificate", "type": "file", "src": [], "disabled": false, "description": "Limite do arquivo em KiB: max 102400." }, { "key": "password", "value": "", "type": "text", "disabled": true, "description": "Obrigatória quando a filial não tem senha real salva. Não publicar senha ou certificado em exemplo." } ] } } } ] }, { "name": "Governança", "item": [ { "name": "Consultar análise da conta — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/accounts/:type/:id", "host": [ "{{base_url}}" ], "path": [ "governance", "accounts", ":type", ":id" ], "variable": [ { "key": "type", "value": "" }, { "key": "id", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Analisar conta — governança", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/governance/accounts/:type/:id/analyses", "host": [ "{{base_url}}" ], "path": [ "governance", "accounts", ":type", ":id", "analyses" ], "variable": [ { "key": "type", "value": "" }, { "key": "id", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view). Análise exige conta quitada elegível. Conta aberta/provisionada/estornada retorna 404, ainda que o detalhe da conta esteja acessível.", "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"integracao-exemplo-2026-001\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar painel — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/dashboard", "host": [ "{{base_url}}" ], "path": [ "governance", "dashboard" ], "query": [ { "key": "from", "value": "", "disabled": true, "description": "Início do intervalo selecionado na consulta; o formato e tipo dependem do recurso." }, { "key": "to", "value": "", "disabled": true, "description": "Fim do intervalo selecionado na consulta; o formato e tipo dependem do recurso." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "search", "value": "", "disabled": true, "description": "Texto utilizado para localizar registros nos campos pesquisáveis desta listagem." }, { "key": "report", "value": "", "disabled": true, "description": "Tipo de relatório de governança a consultar." }, { "key": "status", "value": "", "disabled": true, "description": "Estado atual do recurso; os valores permitidos estão indicados no enum quando fechado." }, { "key": "account_type", "value": "", "disabled": true, "description": "Tipo da conta financeira consultada ou vinculada; use as opções aceitas nesta operação." }, { "key": "rule_code", "value": "", "disabled": true, "description": "Código da regra de governança cujas ocorrências serão consultadas." }, { "key": "priority", "value": "", "disabled": true, "description": "Prioridade das ocorrências a incluir na consulta." }, { "key": "outcome", "value": "", "disabled": true, "description": "Resultado da análise da ocorrência; utilize uma das opções aceitas no enum." }, { "key": "assigned_to", "value": "", "disabled": true, "description": "Identificador do usuário responsável por acompanhar a ocorrência." } ] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa. Por direção, além de reconciliation, documentation, payment_evidence e fiscal, devolve review (count, total_count, percent: contas quitadas do período sem ocorrência aberta; percent nulo sem contas quitadas) e documentation_missing (count, total_count: contas do período sem nenhum anexo, nem na conta nem nas baixas). Também devolve reconciled (count, total_count: contas com baixa elegível cujas baixas estão todas conciliadas, mesmo critério da trava de ocorrência; reconciliation permanece inalterado)." } }, { "name": "Listar ocorrências — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/occurrences", "host": [ "{{base_url}}" ], "path": [ "governance", "occurrences" ], "query": [ { "key": "from", "value": "", "disabled": true, "description": "Início do intervalo selecionado na consulta; o formato e tipo dependem do recurso." }, { "key": "to", "value": "", "disabled": true, "description": "Fim do intervalo selecionado na consulta; o formato e tipo dependem do recurso." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "search", "value": "", "disabled": true, "description": "Texto utilizado para localizar registros nos campos pesquisáveis desta listagem." }, { "key": "report", "value": "", "disabled": true, "description": "Tipo de relatório de governança a consultar." }, { "key": "status", "value": "", "disabled": true, "description": "Estado atual do recurso; os valores permitidos estão indicados no enum quando fechado." }, { "key": "account_type", "value": "", "disabled": true, "description": "Tipo da conta financeira consultada ou vinculada; use as opções aceitas nesta operação." }, { "key": "rule_code", "value": "", "disabled": true, "description": "Código da regra de governança cujas ocorrências serão consultadas." }, { "key": "priority", "value": "", "disabled": true, "description": "Prioridade das ocorrências a incluir na consulta." }, { "key": "outcome", "value": "", "disabled": true, "description": "Resultado da análise da ocorrência; utilize uma das opções aceitas no enum." }, { "key": "assigned_to", "value": "", "disabled": true, "description": "Identificador do usuário responsável por acompanhar a ocorrência." } ] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar ocorrência — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/occurrences/:id", "host": [ "{{base_url}}" ], "path": [ "governance", "occurrences", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Revisar — governança", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/governance/occurrences/:id/status", "host": [ "{{base_url}}" ], "path": [ "governance", "occurrences", ":id", "status" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view) e (governance.review). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"status\": \"seen\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Publicar política — governança", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/governance/policy", "host": [ "{{base_url}}" ], "path": [ "governance", "policy" ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view) e (governance.configure). Publica somente quando o mapa normalizado de regras muda. Com mapa idêntico devolve a política atual, preservando version, created_at e note; alterar apenas note não publica uma revisão. expected_version protege contra concorrência e versão desatualizada gera 409.", "body": { "mode": "raw", "raw": "{\n \"expected_version\": \"default\",\n \"rules\": {\n \"C01\": {\n \"enabled\": true,\n \"weight\": 55,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C02\": {\n \"enabled\": true,\n \"weight\": 80,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C03\": {\n \"enabled\": true,\n \"weight\": 50,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C04\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": [],\n \"overrides\": []\n },\n \"C05\": {\n \"enabled\": true,\n \"weight\": 65,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C06\": {\n \"enabled\": true,\n \"weight\": 60,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C07\": {\n \"enabled\": true,\n \"weight\": 40,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C08\": {\n \"enabled\": true,\n \"weight\": 55,\n \"parameters\": {\n \"window_days\": 30\n },\n \"overrides\": []\n },\n \"C09\": {\n \"enabled\": true,\n \"weight\": 30,\n \"parameters\": {\n \"window_days\": 30\n },\n \"overrides\": []\n },\n \"C10\": {\n \"enabled\": true,\n \"weight\": 25,\n \"parameters\": {\n \"lookback_days\": 180,\n \"min_samples\": 5,\n \"multiplier\": \"3.00\"\n },\n \"overrides\": []\n },\n \"C11\": {\n \"enabled\": true,\n \"weight\": 65,\n \"parameters\": [],\n \"overrides\": []\n },\n \"C12\": {\n \"enabled\": true,\n \"weight\": 30,\n \"parameters\": [],\n \"overrides\": []\n },\n \"C13\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": [],\n \"overrides\": []\n },\n \"P01\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": [],\n \"overrides\": []\n },\n \"P03\": {\n \"enabled\": true,\n \"weight\": 30,\n \"parameters\": [],\n \"overrides\": []\n },\n \"P04\": {\n \"enabled\": false,\n \"weight\": 10,\n \"parameters\": [],\n \"overrides\": []\n },\n \"P05\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"R02\": {\n \"enabled\": true,\n \"weight\": 30,\n \"parameters\": [],\n \"overrides\": []\n },\n \"R03\": {\n \"enabled\": true,\n \"weight\": 35,\n \"parameters\": {\n \"max_discount_percent\": \"20.00\"\n },\n \"overrides\": []\n },\n \"R06\": {\n \"enabled\": true,\n \"weight\": 80,\n \"parameters\": [],\n \"overrides\": []\n },\n \"R07\": {\n \"enabled\": true,\n \"weight\": 75,\n \"parameters\": [],\n \"overrides\": []\n },\n \"R08\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": {\n \"amount_tolerance\": \"1.00\"\n },\n \"overrides\": []\n }\n },\n \"note\": \"Conferência dos parâmetros do catálogo.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar histórico — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/policy/history", "host": [ "{{base_url}}" ], "path": [ "governance", "policy", "history" ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar relatórios — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/reports", "host": [ "{{base_url}}" ], "path": [ "governance", "reports" ], "query": [ { "key": "from", "value": "", "disabled": true, "description": "Início do intervalo selecionado na consulta; o formato e tipo dependem do recurso." }, { "key": "to", "value": "", "disabled": true, "description": "Fim do intervalo selecionado na consulta; o formato e tipo dependem do recurso." }, { "key": "page", "value": "", "disabled": true, "description": "Número da página a consultar ou posicionar no documento, conforme a operação." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página na consulta paginada." }, { "key": "search", "value": "", "disabled": true, "description": "Texto utilizado para localizar registros nos campos pesquisáveis desta listagem." }, { "key": "report", "value": "", "disabled": true, "description": "Tipo de relatório de governança a consultar." }, { "key": "status", "value": "", "disabled": true, "description": "Estado atual do recurso; os valores permitidos estão indicados no enum quando fechado." }, { "key": "account_type", "value": "", "disabled": true, "description": "Tipo da conta financeira consultada ou vinculada; use as opções aceitas nesta operação." }, { "key": "rule_code", "value": "", "disabled": true, "description": "Código da regra de governança cujas ocorrências serão consultadas." }, { "key": "priority", "value": "", "disabled": true, "description": "Prioridade das ocorrências a incluir na consulta." }, { "key": "outcome", "value": "", "disabled": true, "description": "Resultado da análise da ocorrência; utilize uma das opções aceitas no enum." }, { "key": "assigned_to", "value": "", "disabled": true, "description": "Identificador do usuário responsável por acompanhar a ocorrência." } ] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar catálogo de relatórios — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/reports/catalog", "host": [ "{{base_url}}" ], "path": [ "governance", "reports", "catalog" ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar regras — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/rules", "host": [ "{{base_url}}" ], "path": [ "governance", "rules" ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Iniciar execução — governança", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/governance/runs", "host": [ "{{base_url}}" ], "path": [ "governance", "runs" ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view) e (governance.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"bad17fda-e555-51d9-bf57-b64c2ee80992\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar execuções — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/runs", "host": [ "{{base_url}}" ], "path": [ "governance", "runs" ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar execução — governança", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/governance/runs/:id", "host": [ "{{base_url}}" ], "path": [ "governance", "runs", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Simular política — governança", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/governance/simulations", "host": [ "{{base_url}}" ], "path": [ "governance", "simulations" ], "query": [] }, "description": "Permissões exigidas na chave: (governance.view) e (governance.configure). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nEnvie o mapa completo das regras do catálogo atual. A simulação do exemplo considera o período informado e não publica a política.", "body": { "mode": "raw", "raw": "{\n \"rules\": {\n \"C01\": {\n \"enabled\": true,\n \"weight\": 55,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C02\": {\n \"enabled\": true,\n \"weight\": 80,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C03\": {\n \"enabled\": true,\n \"weight\": 50,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C04\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": [],\n \"overrides\": []\n },\n \"C05\": {\n \"enabled\": true,\n \"weight\": 65,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C06\": {\n \"enabled\": true,\n \"weight\": 60,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C07\": {\n \"enabled\": true,\n \"weight\": 40,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"C08\": {\n \"enabled\": true,\n \"weight\": 55,\n \"parameters\": {\n \"window_days\": 30\n },\n \"overrides\": []\n },\n \"C09\": {\n \"enabled\": true,\n \"weight\": 30,\n \"parameters\": {\n \"window_days\": 30\n },\n \"overrides\": []\n },\n \"C10\": {\n \"enabled\": true,\n \"weight\": 25,\n \"parameters\": {\n \"lookback_days\": 180,\n \"min_samples\": 5,\n \"multiplier\": \"3.00\"\n },\n \"overrides\": []\n },\n \"C11\": {\n \"enabled\": true,\n \"weight\": 65,\n \"parameters\": [],\n \"overrides\": []\n },\n \"C12\": {\n \"enabled\": true,\n \"weight\": 30,\n \"parameters\": [],\n \"overrides\": []\n },\n \"C13\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": [],\n \"overrides\": []\n },\n \"P01\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": [],\n \"overrides\": []\n },\n \"P03\": {\n \"enabled\": true,\n \"weight\": 30,\n \"parameters\": [],\n \"overrides\": []\n },\n \"P04\": {\n \"enabled\": false,\n \"weight\": 10,\n \"parameters\": [],\n \"overrides\": []\n },\n \"P05\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": {\n \"amount_tolerance\": \"0.01\"\n },\n \"overrides\": []\n },\n \"R02\": {\n \"enabled\": true,\n \"weight\": 30,\n \"parameters\": [],\n \"overrides\": []\n },\n \"R03\": {\n \"enabled\": true,\n \"weight\": 35,\n \"parameters\": {\n \"max_discount_percent\": \"20.00\"\n },\n \"overrides\": []\n },\n \"R06\": {\n \"enabled\": true,\n \"weight\": 80,\n \"parameters\": [],\n \"overrides\": []\n },\n \"R07\": {\n \"enabled\": true,\n \"weight\": 75,\n \"parameters\": [],\n \"overrides\": []\n },\n \"R08\": {\n \"enabled\": true,\n \"weight\": 70,\n \"parameters\": {\n \"amount_tolerance\": \"1.00\"\n },\n \"overrides\": []\n }\n },\n \"account_type\": \"payable\",\n \"from\": \"2026-10-01\",\n \"to\": \"2026-10-29\",\n \"limit\": 10\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Indicadores", "item": [ { "name": "Consultar agenda — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/agenda", "host": [ "{{base_url}}" ], "path": [ "stats", "agenda" ], "query": [] }, "description": "Permissões exigidas na chave: (accounts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar cards stats — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/cards", "host": [ "{{base_url}}" ], "path": [ "stats", "cards" ], "query": [] }, "description": "Permissões exigidas na chave: (accounts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar month card snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/cards/month-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "cards", "month-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.card). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar monthly card snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/cards/monthly-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "cards", "monthly-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.card). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar cash flow preview — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/cash-flow/daily-preview", "host": [ "{{base_url}}" ], "path": [ "stats", "cash-flow", "daily-preview" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.cashflow). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar cash flow snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/cash-flow/daily-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "cash-flow", "daily-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.cashflow). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar cash flow scenarios — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/cash-flow/scenarios", "host": [ "{{base_url}}" ], "path": [ "stats", "cash-flow", "scenarios" ], "query": [] }, "description": "Permissões exigidas na chave: (accounts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar cashboxes stats — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/cashboxes", "host": [ "{{base_url}}" ], "path": [ "stats", "cashboxes" ], "query": [] }, "description": "Permissões exigidas na chave: (accounts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar delinquency — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/delinquency", "host": [ "{{base_url}}" ], "path": [ "stats", "delinquency" ], "query": [] }, "description": "Permissões exigidas na chave: (accounts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar delinquency top — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/delinquency/top", "host": [ "{{base_url}}" ], "path": [ "stats", "delinquency", "top" ], "query": [] }, "description": "Permissões exigidas na chave: (accounts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar daily expense snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/expenses/daily-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "expenses", "daily-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.in_out). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar month credit expense snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/expenses/month-credit-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "expenses", "month-credit-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.in_out ou dashboard.card). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar month expense preview — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/expenses/month-preview", "host": [ "{{base_url}}" ], "path": [ "stats", "expenses", "month-preview" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.in_out). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar monthly overdue expense snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/expenses/monthly-overdue-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "expenses", "monthly-overdue-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.delinquency). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar monthly expense snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/expenses/monthly-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "expenses", "monthly-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.in_out). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar categories expense preview — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/expenses/preview-by-category", "host": [ "{{base_url}}" ], "path": [ "stats", "expenses", "preview-by-category" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.out_by_category). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar daily profit snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/profits/daily-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "profits", "daily-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.summary ou dashboard.results). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar month profit preview — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/profits/month-preview", "host": [ "{{base_url}}" ], "path": [ "stats", "profits", "month-preview" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.summary ou dashboard.results). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar monthly profit snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/profits/monthly-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "profits", "monthly-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.summary ou dashboard.results). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar categories profit preview percentage — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/profits/percentage-by-category", "host": [ "{{base_url}}" ], "path": [ "stats", "profits", "percentage-by-category" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.summary ou dashboard.results). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar categories profit preview — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/profits/preview-by-category", "host": [ "{{base_url}}" ], "path": [ "stats", "profits", "preview-by-category" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.summary ou dashboard.results). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar daily revenue snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/revenues/daily-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "revenues", "daily-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.in_out). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar month overdue revenue snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/revenues/month-overdue-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "revenues", "month-overdue-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.delinquency). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar month revenue preview — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/revenues/month-preview", "host": [ "{{base_url}}" ], "path": [ "stats", "revenues", "month-preview" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.in_out). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar monthly overdue revenue snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/revenues/monthly-overdue-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "revenues", "monthly-overdue-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.delinquency). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar monthly revenue snapshot — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/revenues/monthly-snapshot", "host": [ "{{base_url}}" ], "path": [ "stats", "revenues", "monthly-snapshot" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.in_out). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar categories revenue preview — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/revenues/preview-by-category", "host": [ "{{base_url}}" ], "path": [ "stats", "revenues", "preview-by-category" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.in_by_category). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar series — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/series", "host": [ "{{base_url}}" ], "path": [ "stats", "series" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.summary ou accounts.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar categories — indicadores", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/settings/categories", "host": [ "{{base_url}}" ], "path": [ "stats", "settings", "categories" ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.summary ou dashboard.cashbox ou dashboard.delinquency ou dashboard.cashflow ou dashboard.card ou dashboard.results ou dashboard.in_out ou dashboard.in_by_category ou dashboard.out_by_category). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Alternar situação — indicadores", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/stats/settings/categories/:stats_category/status-transitions", "host": [ "{{base_url}}" ], "path": [ "stats", "settings", "categories", ":stats_category", "status-transitions" ], "variable": [ { "key": "stats_category", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (dashboard.summary ou dashboard.cashbox ou dashboard.delinquency ou dashboard.cashflow ou dashboard.card ou dashboard.results ou dashboard.in_out ou dashboard.in_by_category ou dashboard.out_by_category). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Contas contábeis", "item": [ { "name": "Criar conta contábil", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/account-standard-launches", "host": [ "{{base_url}}" ], "path": [ "account-standard-launches" ], "query": [] }, "description": "Permissões exigidas na chave: (std_launch.view) e (std_launch.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\",\n \"code\": 1,\n \"type\": \"payable\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar conta contábil", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/account-standard-launches/:stdLaunch", "host": [ "{{base_url}}" ], "path": [ "account-standard-launches", ":stdLaunch" ], "variable": [ { "key": "stdLaunch", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (std_launch.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar conta contábil", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/account-standard-launches/:stdLaunch", "host": [ "{{base_url}}" ], "path": [ "account-standard-launches", ":stdLaunch" ], "variable": [ { "key": "stdLaunch", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (std_launch.view) e (std_launch.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\nNa criação, code é validado como inteiro não negativo. Na atualização, um código textual legado pode ser preservado quando é idêntico ao código atual; códigos novos ou alterados continuam sujeitos à validação numérica.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria\",\n \"code\": 123,\n \"type\": \"receivable\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Excluir conta contábil", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/account-standard-launches/:stdLaunch", "host": [ "{{base_url}}" ], "path": [ "account-standard-launches", ":stdLaunch" ], "variable": [ { "key": "stdLaunch", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (std_launch.view) e (std_launch.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Adicionar apelido à conta contábil", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/account-standard-launches/:stdLaunch/aliases", "host": [ "{{base_url}}" ], "path": [ "account-standard-launches", ":stdLaunch", "aliases" ], "variable": [ { "key": "stdLaunch", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (std_launch.view) e (std_launch.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"alias\": \"CONSULTORIA OUTUBRO\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Localidades e contatos", "item": [ { "name": "Consultar endereço pelo CEP — localidades e contatos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/ceps/:cep", "host": [ "{{base_url}}" ], "path": [ "ceps", ":cep" ], "variable": [ { "key": "cep", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (clients.view ou clients.create ou clients.update ou providers.view ou providers.create ou providers.update ou subsidiaries.view ou subsidiaries.create ou subsidiaries.update ou fiscal_rps.emit). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Listar — localidades e contatos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/email-types", "host": [ "{{base_url}}" ], "path": [ "email-types" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Página da consulta paginada." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página; ausente ou vazio usa o padrão da listagem." } ] }, "description": "Permissões exigidas na chave: (email_types.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — localidades e contatos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/email-types", "host": [ "{{base_url}}" ], "path": [ "email-types" ], "query": [] }, "description": "Permissões exigidas na chave: (email_types.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\",\n \"description\": \"Consultoria de outubro\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar — localidades e contatos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/email-types/:email_type", "host": [ "{{base_url}}" ], "path": [ "email-types", ":email_type" ], "variable": [ { "key": "email_type", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (email_types.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar — localidades e contatos", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/email-types/:email_type", "host": [ "{{base_url}}" ], "path": [ "email-types", ":email_type" ], "variable": [ { "key": "email_type", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (email_types.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\",\n \"description\": \"Consultoria de outubro\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Atualizar — localidades e contatos", "request": { "method": "PATCH", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/email-types/:email_type", "host": [ "{{base_url}}" ], "path": [ "email-types", ":email_type" ], "variable": [ { "key": "email_type", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (email_types.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\",\n \"description\": \"Consultoria de outubro\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Excluir — localidades e contatos", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/email-types/:email_type", "host": [ "{{base_url}}" ], "path": [ "email-types", ":email_type" ], "variable": [ { "key": "email_type", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (email_types.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Listar — localidades e contatos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/phone-types", "host": [ "{{base_url}}" ], "path": [ "phone-types" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Página da consulta paginada." }, { "key": "per_page", "value": "", "disabled": true, "description": "Quantidade de registros por página; ausente ou vazio usa o padrão da listagem." } ] }, "description": "Permissões exigidas na chave: (phone_types.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — localidades e contatos", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/phone-types", "host": [ "{{base_url}}" ], "path": [ "phone-types" ], "query": [] }, "description": "Permissões exigidas na chave: (phone_types.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar — localidades e contatos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/phone-types/:phone_type", "host": [ "{{base_url}}" ], "path": [ "phone-types", ":phone_type" ], "variable": [ { "key": "phone_type", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (phone_types.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Atualizar — localidades e contatos", "request": { "method": "PUT", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/phone-types/:phone_type", "host": [ "{{base_url}}" ], "path": [ "phone-types", ":phone_type" ], "variable": [ { "key": "phone_type", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (phone_types.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Atualizar — localidades e contatos", "request": { "method": "PATCH", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/phone-types/:phone_type", "host": [ "{{base_url}}" ], "path": [ "phone-types", ":phone_type" ], "variable": [ { "key": "phone_type", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (phone_types.update). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consultoria Exemplo\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Excluir — localidades e contatos", "request": { "method": "DELETE", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/phone-types/:phone_type", "host": [ "{{base_url}}" ], "path": [ "phone-types", ":phone_type" ], "variable": [ { "key": "phone_type", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (phone_types.delete). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Consultar cidades do estado — localidades e contatos", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/states/:id", "host": [ "{{base_url}}" ], "path": [ "states", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "Permissões exigidas na chave: (clients.view ou clients.create ou clients.update ou providers.view ou providers.create ou providers.update ou subsidiaries.view ou subsidiaries.create ou subsidiaries.update ou fiscal_rps.emit). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } } ] }, { "name": "Modelos de comunicação", "item": [ { "name": "Listar — modelos de comunicação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/templates", "host": [ "{{base_url}}" ], "path": [ "templates" ], "query": [ { "key": "page", "value": "", "disabled": true, "description": "Número da página." }, { "key": "per_page", "value": "", "disabled": true, "description": "Itens por página. Sem teto universal presumido." } ] }, "description": "Permissões exigidas na chave: (templates.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Criar — modelos de comunicação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/templates", "host": [ "{{base_url}}" ], "path": [ "templates" ], "query": [] }, "description": "Permissões exigidas na chave: (templates.view) e (templates.create). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Aviso de vencimento\",\n \"type\": \"sms\",\n \"content\": \"Conteúdo ilustrativo do modelo.\",\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pré-visualizar e-mail — modelos de comunicação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/templates/mail-preview", "host": [ "{{base_url}}" ], "path": [ "templates", "mail-preview" ], "query": [] }, "description": "Permissões exigidas na chave: (templates.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.\n\n### Exemplo e pré-condições\nRenderiza a prévia sem enviar mensagem. O assunto é opcional, inclusive em e-mail; quando informado, suas variáveis são substituídas. Para type=email, informe layout=charge ou communication; omitir layout retorna 422 com errors.layout. SMS continua aceito nesta rota sem layout nem assunto. Substitua account pelo UUID de uma conta a receber existente da empresa.", "body": { "mode": "raw", "raw": "{\n \"type\": \"email\",\n \"content\": \"Consulte a situação do seu recebível.\",\n \"account\": \"00000000-0000-4000-8000-000000000001\",\n \"layout\": \"charge\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar modelos aprovados de WhatsApp — modelos de comunicação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/templates/whatsapp-catalog", "host": [ "{{base_url}}" ], "path": [ "templates", "whatsapp-catalog" ], "query": [] }, "description": "Permissões exigidas na chave: (templates.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa." } }, { "name": "Pré-visualizar WhatsApp — modelos de comunicação", "request": { "method": "POST", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/templates/wpp-preview", "host": [ "{{base_url}}" ], "path": [ "templates", "wpp-preview" ], "query": [] }, "description": "Permissões exigidas na chave: (templates.view). Aplica as validações e regras de negócio deste recurso, incluindo os módulos contratados e o acesso da empresa.", "body": { "mode": "raw", "raw": "{\n \"type\": \"sms\",\n \"content\": \"Consulte a situação do seu recebível.\",\n \"account\": \"00000000-0000-4000-8000-000000000001\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Consultar — modelos de comunicação", "request": { "method": "GET", "header": [ { "key": "X-Public-Access-Key", "value": "{{access_key}}" }, { "key": "X-Public-API-Key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/templates/:template", "host": [ "{{base_url}}" ], "path": [ "templates", ":template" ], "variable": [ { "key": "template", "value": "