Changelog

Histórico de mudanças da API Conta Simples

Para entender as convenções, versionamento e política de breaking changes, veja Convenções do Changelog.

[2026-10-27]

Changed

Atualizar Transação Bancária: fornecedor. PATCH /statements/v1/banking/{transactionId} aceita o campo supplierId para vincular um fornecedor à transação: use o id retornado em Listar Fornecedores. Envie null para remover o fornecedor; sem o campo, o fornecedor atual é mantido. Um corpo só com supplierId já é válido. Um supplierId que não seja inteiro positivo, ou que não apareça em Listar Fornecedores, retorna 400.
Atualizar Transação de Cartão: fornecedor. PATCH /statements/v1/credit-card/{transactionId} aceita o campo supplierId para vincular um fornecedor à transação: use o id retornado em Listar Fornecedores. Envie null para remover o fornecedor; sem o campo, o fornecedor atual é mantido. Um corpo só com supplierId já é válido. Um supplierId que não seja inteiro positivo, ou que não apareça em Listar Fornecedores, retorna 400.

[2026-10-08]

Fixed

Vincular comprovante ou nota fiscal: rota e regras do arquivo. A rota é POST /attachments/v1/attachments, e não POST /attachments/v1, como indicava a referência. A referência do endpoint agora traz também as regras que o upload já aplica: o file.name termina com uma extensão aceita para o file.contentType, senão a resposta é 400; e o PUT para a uploadUrl leva o header Content-Type do formato, senão o S3 recusa o upload. A resposta 403, de escopo não concedido, passa a constar no endpoint.

[2026-10-01]

Changed

Cartões virtuais (VCN): requestor como texto. Criar VCN, Atualizar VCN e Cancelar VCN exigem requestor no corpo: texto de 1 a 100 caracteres, com o e-mail de um usuário ou um identificador do seu sistema. O objeto { name, email, phone } deixa de ser aceito. Veja Corpo da requisição.

[2026-09-30]

🚧 Precisa fazer algo agora? Não, se a sua credencial não tem chave pública. A assinatura só é exigida de credenciais com chave pública, e a chave é obrigatória para receber escopos sensíveis.

Added

Cartões virtuais (VCN): consulta e cancelamento. Dois endpoints novos para acompanhar e encerrar uma VCN emitida.
- Consultar VCN (GET /credit-cards/v1/vcns/{vcnId}): devolve o status, a janela de uso e o teto de uma VCN, sem os dados do cartão.
- Cancelar VCN (DELETE /credit-cards/v1/vcns/{vcnId}): encerra a VCN de forma definitiva; repetir a chamada é seguro.
Página Assinatura de Requisições em Comece Aqui, para credenciais com chave assimétrica. Ela explica como gerar o par de chaves, como registrar a chave pública, quando a assinatura é exigida e como assinar seguindo a RFC 9421 (HTTP Message Signatures).
- A assinatura cobre o método, o path, a query e o corpo, este por meio do header Content-Digest, e vai nos headers Signature-Input e Signature. Os algoritmos aceitos são rsa-v1_5-sha256, rsa-pss-sha512, ecdsa-p256-sha256 e ed25519, e o created vale por 300 segundos.
- Uma credencial com chave pública assina todas as chamadas, inclusive as de leitura. A chave é obrigatória para receber escopos sensíveis, que são os de escrita e o de Revelar dados do VCN.
- A página traz exemplos em Node.js e openssl e mostra como conferir a assinatura na sua máquina antes de chamar a API.
Campo details.reason na resposta 401 de assinatura, com os valores SIGNATURE_REQUIRED e INVALID_SIGNATURE. Está documentado em Assinatura de Requisições.
Campo details.requiredScope na resposta 403, que informa qual escopo faltou na credencial. Está documentado em Erros Comuns.
Headers Signature-Input, Signature e Content-Digest na referência de todos os endpoints, menos a emissão do token, que usa Basic Auth. Eles também aparecem como campos no playground.
Card de assinatura no playground. No Try it, abaixo de Headers, você cola a chave privada de uma credencial de Sandbox e cada envio sai assinado. A chave fica só na memória da aba e não é gravada nem enviada.

[2026-09-29]

Added

Cartões virtuais (VCN). Emita um cartão virtual de uso restrito para uma reserva de hospedagem (HOTEL), uma reserva aérea (AERIAL) ou um uso definido por você (CUSTOM, ex.: um cartão por fornecedor).
- Criar VCN (POST /credit-cards/v1/vcns): emite a VCN e devolve PAN, CVV e validade.
- Atualizar VCN (PATCH /credit-cards/v1/vcns/{vcnId}): recarrega o teto e ajusta a janela de uso de uma VCN CUSTOM, sem trocar o cartão.
- Revelar dados do VCN (GET /credit-cards/v1/vcns/{vcnId}/reveal): devolve de novo PAN, CVV e validade de uma VCN emitida.
- Guia de VCN: os tipos, o ciclo de vida e as regras de janela de uso, idempotência, teto, repetição de chamadas e erros, comuns a todos os endpoints de VCN.
- Todas as chamadas de VCN exigem o header X-Partner-Id, que identifica a plataforma integradora. Veja Identificação da plataforma.

[2026-09-01]

Added

Adiciona endpoint de atualização de transação bancária (PATCH /statements/v1/banking/{transactionId}): permite atualizar observação, categoria, centro de custo e conciliar uma transação do extrato bancário. Ver referência.

[2026-08-03]

Added

Endpoint de comprovante de transação bancária (GET /statements/v1/banking/{transactionId}/receipt): gera o comprovante em PDF de uma transação bancária (PIX, TED, transferência entre contas Conta Simples ou pagamento de boleto) e retorna uma URL assinada de curta duração (5 minutos) para download. Disponível apenas para transações com status PROCESSADO (status: 2); consulte o campo showReceipt da transação antes de chamar. Ver referência.

[2026-06-30]

Added

Endpoint de vinculação de comprovante ou nota fiscal (POST /attachments/v1): cria um registro de anexo vinculado a uma transação existente e retorna uma URL pré-assinada para upload direto ao S3. Fluxo em 2 etapas: (1) POST para obter {id, uploadUrl}; (2) PUT {uploadUrl} com o binário do arquivo. O id retornado é compatível com GET /attachments/v1/content/{attachmentId}. Ver referência.

[2026-06-29]

Added

Adiciona endpoint de listagem de faturas (GET /credit-cards/v1/bills): lista todas as faturas de cartão de crédito da empresa autenticada, com filtro opcional por status. Os valores são em BRL. Ver referência.
Adiciona endpoint de detalhes da fatura (GET /credit-cards/v1/bills/{dueDate}): retorna os totalizadores (nacional, internacional, IOF, créditos e encargos) e os itens (transações) de uma fatura específica, identificada pela data de vencimento. Ver referência.

[2026-06-26]

Added

Endpoint de consulta de saldo da conta (GET /accounts/v1/balance): retorna o saldo disponível da conta da empresa autenticada em BRL. Ver referência.

[2026-06-23]

Added

Endpoint de criação de centro de custo (POST /cost-centers/v1/cost-centers): cria um novo centro de custo para a empresa; o campo name é obrigatório e deve ser único por empresa. Ver referência.
Endpoint de consulta de centro de custo por ID (GET /cost-centers/v1/cost-centers/{id}): retorna os dados de um centro de custo específico pelo UUID. Ver referência.
Endpoint de atualização de centro de custo (PATCH /cost-centers/v1/cost-centers/{id}): renomeia um centro de custo existente; o novo nome deve ser único na empresa. Ver referência.
Endpoint de exclusão de centro de custo (DELETE /cost-centers/v1/cost-centers/{id}): exclui um centro de custo pelo UUID; retorna 204 em caso de sucesso. Ver referência.

Deprecated

Campo responsible na resposta de GET /cost-centers/v1/cost-centers: será removido em versão futura. Não utilize este campo em novas integrações. Ver referência.

[2026-06-18]

Added

Endpoint de atualização de fornecedor (PUT /suppliers/v1/suppliers/{id}): atualiza o nome de um fornecedor existente da empresa; o campo name é obrigatório e deve ser único por empresa. Ver referência.
Endpoint de exclusão de fornecedor (DELETE /suppliers/v1/suppliers/{id}): exclui um fornecedor existente da empresa pelo ID numérico. Retorna 204 em caso de sucesso. Ver referência.

[2026-06-11]

Added

Endpoint de atualização de nome de categoria (PATCH /categories/v1/categories/{id}): renomeia uma categoria customizada existente; apenas o campo name é atualizado — os estabelecimentos vinculados e o tipo da categoria permanecem inalterados. O novo nome deve ser único na empresa. Ver referência.
Endpoint de exclusão de categorias (DELETE /categories/v1/categories): deleta uma ou mais categorias customizadas em uma única requisição. Se a categoria tiver estabelecimentos vinculados, informe moveTo para reatribuí-los antes da exclusão — omitir retorna 422. Ver referência.

[2026-06-03]

Added

Endpoint de atualização parcial de usuário (PATCH /users/v1/users/{userId}): atualiza name e/ou roleId de um usuário ativo da empresa; ao menos um campo obrigatório por requisição. Ver referência.
Adiciona endpoint de listagem de fornecedores (GET /suppliers/v1/suppliers). Ver referência.
Adiciona endpoint de consulta de fornecedor por ID (GET /suppliers/v1/suppliers/{id}). Ver referência.
Adiciona endpoint de criação de fornecedor (POST /suppliers/v1/suppliers). Ver referência.

[2026-05-28]

Added

Endpoint de listagem de centros de custo (GET /cost-centers/v1/cost-centers): lista todos os centros de custo da empresa autenticada. A resposta inclui id, name, companyId e o campo opcional responsible com nome e ID do responsável vinculado. Ver referência.

Changed

Endpoint PATCH /statements/v1/credit-card/{transactionId}: adicionado campo costCenterId (UUID) para classificar a transação por centro de custo. Ver referência.

[2026-05-27]

Added

Endpoint de consulta de usuário por ID (GET /users/v1/users/{userId}): retorna os dados de um usuário específico da empresa pelo identificador (UUID v4); resposta alinhada ao item da listagem (UserDto), com 404 quando o usuário não pertencer à empresa autenticada.

[2026-05-26]

Added

Endpoint de atualização de transação de cartão (PATCH /statements/v1/credit-card/{transactionId}): atualiza notes, isConciled e categoryId de uma transação de cartão de crédito; ao menos um campo obrigatório por requisição.

[2026-05-14]

Changed

Endpoint de extrato de cartão (GET /statements/v1/credit-card): adicionado parâmetro opcional cardIds (string, separado por vírgula) para filtrar transações por um ou mais cartões simultaneamente.

[2026-04-28]

Added

Endpoint de criação de categoria (POST /categories/v1/categories): cria uma categoria personalizada para a empresa; o nome deve ser único entre as categorias da empresa.
Endpoint de consulta de categoria por ID (GET /categories/v1/categories/{id}): retorna uma categoria da empresa pelo identificador numérico; resposta alinhada ao item da listagem (estabelecimentos e tipo).

[2026-04-17]

Added

Endpoint de listagem de categorias (GET /categories/v1/categories): retorna as categorias disponíveis para a empresa.

[2026-04-10]

Added

Endpoint de extrato bancário (GET /statements/v1/banking): consulta paginada de transações bancárias da empresa com suporte a filtros por período, conta, categoria, centro de custo, status, valor e responsável.

[2026-04-02]

Changed

Resposta do extrato de cartão (GET /statements/v1/credit-card): cada anexo em attachments pode incluir o campo opcional type com o MIME (image/jpeg, image/png ou application/pdf) quando a extensão do nome do arquivo for reconhecida.

[2026-03-27]

Added

Endpoint de exclusão de usuários (DELETE /users/v1/users/{userId}): permite remover um usuário da empresa pelo ID.

[2026-03-25]

Added

Endpoint de criação de convites de usuários (POST /users/v1/invites): permite enviar convites para novos usuários se juntarem à empresa, informando e-mail e papel (role).

[2026-03-24]

Added

Endpoint de listagem de papéis (roles) (/users/v1/roles): retorna os papéis da empresa com perfil, permissões (claims) e quantidade de usuários vinculados.

[2026-03-23]

Added

Endpoint de listagem de convites de usuários (/users/v1/invites): consulta paginada de convites com filtros por status e papel (role).

[2026-03-17]

Changed

Endpoint de extrato de cartão (/statements/v1/credit-card): documentação atualizada de POST para GET, com parâmetros de filtro (limit, startDate, endDate, types, nextPageStartKey) enviados via query string.

[2026-03-16]

Added

Endpoints de gestão de cartões corporativos: listagem com filtros, bloqueio e desbloqueio de cartões.
Endpoint de listagem de usuários da empresa, com filtro por e-mail e paginação por cursor.

[2026-02-25]

Added

Endpoint de listagem de cartões de crédito.

[2026-02-09]

Added

Endpoint de login para autenticação na API Conta Simples.

[2026-02-03]

Added

Endpoint para download de anexos de transações.

[2026-01-19]

Added

Incremento no endpoint de extrato de cartão, incluindo novos campos relacionados a anexos.

[2025-10-15]

Added

Endpoint de extrato de cartão.
Definição inicial do schema da API para transações e cartões.

Was this page helpful?