{"openapi":"3.1.0","info":{"title":"API pública do SSTFLIX","version":"1.0.0","description":"API pública do SSTFLIX, versão 1. Consulte e lance dados da sua conta a partir do seu ERP, de uma planilha ou de um site. Esta versão cobre o setor Financeiro; os demais setores estão em breve.\n\n## Autenticação\n\nToda chamada leva a chave no cabeçalho `Authorization: Bearer <chave>`. Quem administra a conta cria a chave em Configurações, Integrações, API, e ela aparece uma única vez. Use a chave só no servidor: a API não envia cabeçalhos CORS e nunca deve ser chamada do navegador. Cada conta pode ter até 10 chaves não revogadas. Os escopos são `<setor>:ler` e `<setor>:gravar` (gravar inclui ler). Chave na URL é recusada.\n\n## Convenções\n\n- Dinheiro sempre em centavos inteiros (`valor_centavos`). Datas em `YYYY-MM-DD`, instantes em ISO 8601 UTC, nomes em português snake_case, e o identificador de todo recurso é `id`.\n\n- Listas paginam por cursor: `limite` (padrão 50, máximo 200) e a resposta `{ \"dados\": [...], \"proximo_cursor\": \"...\" | null }`. O GET por id devolve o registro direto.\n\n- Todo erro tem o formato `{ erro: { codigo, mensagem, detalhes }, id_requisicao }`, com o mesmo id no cabeçalho `X-Request-Id`. Todas as respostas da API, menos este documento, levam `Cache-Control: no-store`.\n\n- Contas a pagar e a receber não são recursos à parte: são `transacoes` filtradas por `tipo` e `status`. O recurso `transferencias` lista os pares de movimentação entre contas e NÃO deve ser somado com `transacoes`.\n\n## O que a API não faz e o que você precisa saber\n\n- O limite de 120 requisições por minuto por chave é um freio de rajada, e não é uma cota exata: ele é contado em memória, por instância do servidor, então o total aceito num minuto pode passar de 120 quando mais de uma instância atende a mesma chave. Não dimensione a integração contando com esse excedente.\n\n- A v1 não mostra exclusões. Não existe DELETE na API e não há um feed de remoções: o registro que uma pessoa apaga na plataforma simplesmente deixa de aparecer nas listagens. Para descobrir o que sumiu, reconcilie de tempos em tempos: nas transações, por janela de datas (data_inicio e data_fim); nos demais recursos, listando tudo e comparando com o que você já guardou.\n\n- Linhas ancoradas são somente leitura para valor, tipo, datas e conta. Uma linha é ancorada quando está conciliada, tem fechamento de caixa, veio de extrato bancário, está ligada a fatura, cobrança, fatura de cartão, venda do PDV ou repasse, ou é uma das duas pernas de uma transferência. Pedir a mudança de valor_centavos, tipo, data_competencia, data_vencimento ou conta_id, dar baixa em uma linha ancorada que ainda não está paga, ou desfazer a baixa de uma linha ancorada e paga responde 409 lancamento_conciliado, com o motivo nos detalhes (campo motivo_da_trava). Os demais campos (descricao, forma_pagamento, categoria, subcategoria, empresa_id, fornecedor_id, cliente_empresa_id, centro_custo_id, plano_contas_id, documento e observacoes) continuam editáveis, com uma exceção: numa perna de transferência, categoria e subcategoria também não mudam (409 lancamento_conciliado, motivo transferencia), porque transferência não é receita nem despesa e, com outra categoria, as duas pernas passariam a contar no resultado como uma entrada e uma saída. Mandar o valor que a linha já tem não é mudança. Por essa mesma regra, a API não move um lançamento para fora de categoria de transferência: pedir outra categoria ou subcategoria numa linha que já está classificada como transferência responde 422 categoria_reservada, do mesmo modo que lançar em categoria de transferência. Numa conta que importa extrato, concilia ou emite faturas pela plataforma, a maior parte do histórico de lançamentos é ancorada: para a API, é leitura.\n\n- Existe uma janela de milissegundos entre a API conferir se a linha é ancorada e a baixa ser gravada. Ela não depende do que o integrador envia, e o desfecho depende de quando a mudança cai nela. Se a linha já estava paga quando a baixa a leu (por exemplo, por outra baixa feita na tela, na agenda ou em outra chamada), a resposta é 200 com ja_estava_pago verdadeiro. Se foi paga depois dessa leitura e antes da gravação, a resposta é 409 lancamento_alterado (o mesmo vale, na baixa com diferença, se o valor mudou nesse intervalo). E se a linha passou a ser conciliada ou ancorada sem ter sido paga nesse intervalo, a baixa é aplicada, porque a gravação confere só o status e, na baixa com diferença, o valor, e não as âncoras. Em qualquer dos casos, leia o lançamento de novo antes de repetir a chamada.\n\n- O desfazer baixa tem a mesma janela de milissegundos. Se a linha já estava pendente ou agendada quando ele a leu, a resposta é 200 com ja_estava_pendente verdadeiro. Se deixou de estar paga depois dessa leitura e antes da gravação (por exemplo, por outro desfazer), a resposta é 409 lancamento_alterado. E se a linha passou a ser ancorada depois dessa leitura e antes da gravação, o desfazer é aplicado, porque a gravação confere só o status, e não as âncoras. Em qualquer dos casos, leia o lançamento de novo antes de repetir a chamada.\n\n- Os registros de idempotência são guardados por 30 dias, e o corpo só é comparado durante esse prazo. Depois dos 30 dias, se o lançamento ainda existe, a mesma referencia_externa devolve esse lançamento como repetição, sem comparar o corpo; e se uma pessoa o apagou, ela cria um lançamento novo (201). Por isso não repita uma chamada por mais de 30 dias, ou confira antes listando as transações com o filtro referencia_externa.\n\n- O POST de fornecedores não é idempotente e não recusa cpf_cnpj repetido: uma nova tentativa cria outro fornecedor. A listagem não tem filtro por cpf_cnpj. Antes de criar, liste os fornecedores (até 200 por página) e confira se ele já existe; depois de um erro de rede ou de tempo esgotado, releia a lista antes de tentar de novo.\n\n- Envie o CPF (11 dígitos) ou o CNPJ (14 dígitos), com ou sem pontuação: a API grava com a pontuação padrão (000.000.000-00 para o CPF e 00.000.000/0000-00 para o CNPJ), no POST e no PATCH. Por exemplo, 11222333000181 fica 11.222.333/0001-81. Outros formatos de documento não são suportados: texto com outra quantidade de dígitos (um documento estrangeiro, por exemplo) fica como veio, mas texto com exatamente 11 dígitos, ou com 14 ou mais, é reescrito como CPF ou CNPJ, descartando o que não for dígito e cortando o que passar de 14 dígitos.\n\n- Editar valor_centavos de um lançamento pago que teve diferença na baixa (juros, multa, acréscimo ou desconto) deixa valor_previsto_centavos e os componentes da diferença desatualizados, e um desfazer a baixa posterior perde essa edição e restaura o valor previsto original. É o mesmo comportamento da tela.\n\n- O cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nDocumentação completa, com exemplos em curl, Node e Python: https://sstflix.com.br/docs/api"},"servers":[{"url":"https://sstflix.com.br/api/v1"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Contas bancárias","description":"Contas bancárias, caixas e cartões da empresa. O saldo inicial é o ponto de partida do livro-caixa, não o saldo de hoje."},{"name":"Categorias","description":"Catálogo de categorias e subcategorias de lançamento. A categoria de uma transação é o par de texto categoria + subcategoria, sem chave estrangeira."},{"name":"Centros de custo","description":"Centros de custo para apropriar despesas e receitas."},{"name":"Plano de contas","description":"Plano de contas contábil em árvore: cada conta aponta para a conta pai (pai_id)."},{"name":"Fornecedores","description":"Fornecedores cadastrados. A chave Pix do fornecedor não é exposta."},{"name":"Transações","description":"Lançamentos de entrada e saída, inclusive contas a pagar e a receber (filtre por tipo e status). Devolve também as transferências entre contas; use computa_no_resultado para separá-las."},{"name":"Faturas","description":"Faturas de venda emitidas aos clientes, com valor, retenções e situação. O link da nota fiscal não é exposto."},{"name":"Cobranças","description":"Cobranças emitidas por boleto, Pix ou cartão. Não traz e-mail nem telefone do cliente, nem link de boleto ou código de Pix."},{"name":"Transferências entre contas","description":"Os pares de movimentação entre duas contas. Os dois lados já estão em transacoes: não some este recurso com transacoes."}],"paths":{"/financeiro/contas":{"get":{"operationId":"listar_financeiro_contas","tags":["Contas bancárias"],"summary":"Listar contas bancárias","description":"Contas bancárias, caixas e cartões da empresa. O saldo inicial é o ponto de partida do livro-caixa, não o saldo de hoje.\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroContasLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/contas/{id}":{"parameters":[{"$ref":"#/components/parameters/IdInteiro"}],"get":{"operationId":"obter_financeiro_contas","tags":["Contas bancárias"],"summary":"Obter um registro de contas bancárias","description":"Contas bancárias, caixas e cartões da empresa. O saldo inicial é o ponto de partida do livro-caixa, não o saldo de hoje.\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroContas"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/categorias":{"get":{"operationId":"listar_financeiro_categorias","tags":["Categorias"],"summary":"Listar categorias","description":"Catálogo de categorias e subcategorias de lançamento. A categoria de uma transação é o par de texto categoria + subcategoria, sem chave estrangeira.\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroCategoriasLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/categorias/{id}":{"parameters":[{"$ref":"#/components/parameters/IdUuid"}],"get":{"operationId":"obter_financeiro_categorias","tags":["Categorias"],"summary":"Obter um registro de categorias","description":"Catálogo de categorias e subcategorias de lançamento. A categoria de uma transação é o par de texto categoria + subcategoria, sem chave estrangeira.\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroCategorias"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/centros-custo":{"get":{"operationId":"listar_financeiro_centros_custo","tags":["Centros de custo"],"summary":"Listar centros de custo","description":"Centros de custo para apropriar despesas e receitas.\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroCentrosCustoLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/centros-custo/{id}":{"parameters":[{"$ref":"#/components/parameters/IdInteiro"}],"get":{"operationId":"obter_financeiro_centros_custo","tags":["Centros de custo"],"summary":"Obter um registro de centros de custo","description":"Centros de custo para apropriar despesas e receitas.\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroCentrosCusto"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/plano-contas":{"get":{"operationId":"listar_financeiro_plano_contas","tags":["Plano de contas"],"summary":"Listar plano de contas","description":"Plano de contas contábil em árvore: cada conta aponta para a conta pai (pai_id).\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroPlanoContasLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/plano-contas/{id}":{"parameters":[{"$ref":"#/components/parameters/IdInteiro"}],"get":{"operationId":"obter_financeiro_plano_contas","tags":["Plano de contas"],"summary":"Obter um registro de plano de contas","description":"Plano de contas contábil em árvore: cada conta aponta para a conta pai (pai_id).\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroPlanoContas"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/fornecedores":{"get":{"operationId":"listar_financeiro_fornecedores","tags":["Fornecedores"],"summary":"Listar fornecedores","description":"Fornecedores cadastrados. A chave Pix do fornecedor não é exposta.\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroFornecedoresLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"post":{"operationId":"criar_financeiro_fornecedores","tags":["Fornecedores"],"summary":"Criar registro em fornecedores","description":"Cria um fornecedor e devolve o fornecedor criado (201, com o cabeçalho Location).\n\nO POST de fornecedores não é idempotente e não recusa cpf_cnpj repetido: uma nova tentativa cria outro fornecedor. A listagem não tem filtro por cpf_cnpj. Antes de criar, liste os fornecedores (até 200 por página) e confira se ele já existe; depois de um erro de rede ou de tempo esgotado, releia a lista antes de tentar de novo.\n\nEscopo exigido: `financeiro:gravar`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroFornecedoresCriar"},"example":{"razao_social":"Gráfica Rápida Ltda","nome_fantasia":"Gráfica Rápida","tipo":"pj","cpf_cnpj":"11222333000181","email":"financeiro@graficarapida.example","telefone":"(41) 3000-0000"}}}},"responses":{"201":{"description":"Registro criado. O cabeçalho Location traz o caminho do registro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroFornecedores"}}}},"400":{"description":"O corpo não é um JSON válido. Códigos possíveis: `json_invalido`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `validacao`, `campo_desconhecido`, `referencia_invalida`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/fornecedores/{id}":{"parameters":[{"$ref":"#/components/parameters/IdInteiro"}],"get":{"operationId":"obter_financeiro_fornecedores","tags":["Fornecedores"],"summary":"Obter um registro de fornecedores","description":"Fornecedores cadastrados. A chave Pix do fornecedor não é exposta.\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroFornecedores"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"patch":{"operationId":"editar_financeiro_fornecedores","tags":["Fornecedores"],"summary":"Editar um registro de fornecedores","description":"Altera só os campos enviados e devolve o fornecedor atual. Enviar ativo falso desativa o fornecedor: a API não apaga registros.\n\nEscopo exigido: `financeiro:gravar`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroFornecedoresEditar"},"example":{"email":"contas@graficarapida.example","ativo":false}}}},"responses":{"200":{"description":"O registro, já com as alterações.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroFornecedores"}}}},"400":{"description":"O corpo não é um JSON válido. Códigos possíveis: `json_invalido`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `validacao`, `campo_desconhecido`, `referencia_invalida`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/transacoes":{"get":{"operationId":"listar_financeiro_transacoes","tags":["Transações"],"summary":"Listar transações","description":"Lançamentos de entrada e saída, inclusive contas a pagar e a receber (filtre por tipo e status). Devolve também as transferências entre contas; use computa_no_resultado para separá-las.\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO filtro atualizado_desde serve à sincronização incremental. Exclusões não aparecem: veja a descrição geral da API.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"},{"name":"tipo","in":"query","required":false,"description":"Só entradas ou só saídas.","schema":{"type":"string","enum":["entrada","saida"]}},{"name":"status","in":"query","required":false,"description":"Situação do pagamento. Contas a pagar e a receber são pendente e agendado.","schema":{"type":"string","enum":["pago","pendente","agendado"]}},{"name":"conta_id","in":"query","required":false,"description":"Só lançamentos desta conta bancária.","schema":{"type":"integer","minimum":0,"maximum":2147483647}},{"name":"empresa_id","in":"query","required":false,"description":"Só lançamentos desta empresa do grupo.","schema":{"type":"string","format":"uuid"}},{"name":"empresa_beneficiaria_id","in":"query","required":false,"description":"Só lançamentos cuja empresa beneficiária é esta.","schema":{"type":"string","format":"uuid"}},{"name":"data_inicio","in":"query","required":false,"description":"A partir desta data (inclusive), sobre a data do pagamento ou, sem ela, a da competência.","schema":{"type":"string","format":"date"}},{"name":"data_fim","in":"query","required":false,"description":"Até esta data (inclusive), sobre a data do pagamento ou, sem ela, a da competência.","schema":{"type":"string","format":"date"}},{"name":"vencimento_de","in":"query","required":false,"description":"Vencimento a partir desta data (inclusive).","schema":{"type":"string","format":"date"}},{"name":"vencimento_ate","in":"query","required":false,"description":"Vencimento até esta data (inclusive).","schema":{"type":"string","format":"date"}},{"name":"atualizado_desde","in":"query","required":false,"description":"Só o que mudou a partir deste instante (inclusive), ISO 8601 com fuso. Para sincronização incremental.","schema":{"type":"string","format":"date-time"}},{"name":"referencia_externa","in":"query","required":false,"description":"Só o lançamento com esta referência externa.","schema":{"type":"string","maxLength":200}},{"name":"computa_no_resultado","in":"query","required":false,"description":"true tira as transferências entre contas e os pagamentos de fatura de cartão; false devolve só eles.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransacoesLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"post":{"operationId":"criar_financeiro_transacoes","tags":["Transações"],"summary":"Criar registro em transações","description":"Cria um lançamento de entrada ou saída e devolve o lançamento criado (201, com o cabeçalho Location).\n\nA referencia_externa é obrigatória e é a chave de idempotência. Repetir a chamada com a mesma referência e o mesmo corpo responde 200 com o lançamento ATUAL (que pode já ter sido baixado ou editado) e o cabeçalho Idempotent-Replayed: true. Durante os 30 dias de retenção, a mesma referência com outro corpo responde 409 conflito_idempotencia. Se uma pessoa apagou o lançamento, responde 409 lancamento_removido e, durante os 30 dias de retenção, a referência não pode ser reaproveitada: use outra. Os registros de idempotência são guardados por 30 dias, e o corpo só é comparado durante esse prazo. Depois dos 30 dias, se o lançamento ainda existe, a mesma referencia_externa devolve esse lançamento como repetição, sem comparar o corpo; e se uma pessoa o apagou, ela cria um lançamento novo (201). Por isso não repita uma chamada por mais de 30 dias, ou confira antes listando as transações com o filtro referencia_externa.\n\nCom status pago, data_pagamento é obrigatória; com pendente ou agendado, data_pagamento é recusado (422).\n\nEscopo exigido: `financeiro:gravar`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransacoesCriar"},"example":{"tipo":"saida","descricao":"Aluguel do escritório, novembro","valor_centavos":450000,"data_competencia":"2026-11-01","data_vencimento":"2026-11-10","referencia_externa":"erp-2026-000123"}}}},"responses":{"200":{"description":"Repetição: a mesma referencia_externa com o mesmo corpo. Devolve o lançamento ATUAL, com o cabeçalho Idempotent-Replayed: true.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Idempotent-Replayed":{"$ref":"#/components/headers/Idempotent-Replayed"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransacoes"}}}},"201":{"description":"Registro criado. O cabeçalho Location traz o caminho do registro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransacoes"}}}},"400":{"description":"O corpo não é um JSON válido. Códigos possíveis: `json_invalido`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"O estado do lançamento não permite a operação. Códigos possíveis: `conflito_idempotencia`, `lancamento_removido`, `lancamento_alterado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `validacao`, `valor_invalido`, `campo_desconhecido`, `categoria_invalida`, `categoria_reservada`, `referencia_invalida`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/transacoes/{id}":{"parameters":[{"$ref":"#/components/parameters/IdUuid"}],"get":{"operationId":"obter_financeiro_transacoes","tags":["Transações"],"summary":"Obter um registro de transações","description":"Lançamentos de entrada e saída, inclusive contas a pagar e a receber (filtre por tipo e status). Devolve também as transferências entre contas; use computa_no_resultado para separá-las.\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransacoes"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"patch":{"operationId":"editar_financeiro_transacoes","tags":["Transações"],"summary":"Editar um registro de transações","description":"Altera só os campos enviados e devolve o lançamento atual. Não edita status, data_pagamento nem referencia_externa (campo fora do esquema: 422 campo_desconhecido): a situação de pagamento só muda pela baixa e pelo desfazer baixa.\n\nLinhas ancoradas são somente leitura para valor, tipo, datas e conta. Uma linha é ancorada quando está conciliada, tem fechamento de caixa, veio de extrato bancário, está ligada a fatura, cobrança, fatura de cartão, venda do PDV ou repasse, ou é uma das duas pernas de uma transferência. Pedir a mudança de valor_centavos, tipo, data_competencia, data_vencimento ou conta_id, dar baixa em uma linha ancorada que ainda não está paga, ou desfazer a baixa de uma linha ancorada e paga responde 409 lancamento_conciliado, com o motivo nos detalhes (campo motivo_da_trava). Os demais campos (descricao, forma_pagamento, categoria, subcategoria, empresa_id, fornecedor_id, cliente_empresa_id, centro_custo_id, plano_contas_id, documento e observacoes) continuam editáveis, com uma exceção: numa perna de transferência, categoria e subcategoria também não mudam (409 lancamento_conciliado, motivo transferencia), porque transferência não é receita nem despesa e, com outra categoria, as duas pernas passariam a contar no resultado como uma entrada e uma saída. Mandar o valor que a linha já tem não é mudança. Por essa mesma regra, a API não move um lançamento para fora de categoria de transferência: pedir outra categoria ou subcategoria numa linha que já está classificada como transferência responde 422 categoria_reservada, do mesmo modo que lançar em categoria de transferência. Numa conta que importa extrato, concilia ou emite faturas pela plataforma, a maior parte do histórico de lançamentos é ancorada: para a API, é leitura.\n\nEditar valor_centavos de um lançamento pago que teve diferença na baixa (juros, multa, acréscimo ou desconto) deixa valor_previsto_centavos e os componentes da diferença desatualizados, e um desfazer a baixa posterior perde essa edição e restaura o valor previsto original. É o mesmo comportamento da tela.\n\nEscopo exigido: `financeiro:gravar`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransacoesEditar"},"example":{"descricao":"Aluguel do escritório, novembro (reajustado)","valor_centavos":465000,"observacoes":null}}}},"responses":{"200":{"description":"O registro, já com as alterações.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransacoes"}}}},"400":{"description":"O corpo não é um JSON válido. Códigos possíveis: `json_invalido`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"O estado do lançamento não permite a operação. Códigos possíveis: `lancamento_conciliado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `validacao`, `valor_invalido`, `campo_desconhecido`, `categoria_invalida`, `categoria_reservada`, `referencia_invalida`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/transacoes/{id}/baixa":{"parameters":[{"$ref":"#/components/parameters/IdUuid"}],"post":{"operationId":"baixar_financeiro_transacoes","tags":["Transações"],"summary":"Dar baixa em um lançamento","description":"Marca o lançamento como pago, com a mesma regra da tela. Valor efetivo = valor_centavos + juros_centavos + multa_centavos + acrescimo_centavos - desconto_centavos; havendo diferença, a justificativa é obrigatória. O corpo é opcional: sem data_pagamento vale a data de hoje em America/Sao_Paulo. Baixa de lançamento já pago responde 200 com ja_estava_pago verdadeiro e não altera nada.\n\nLinhas ancoradas são somente leitura para valor, tipo, datas e conta. Uma linha é ancorada quando está conciliada, tem fechamento de caixa, veio de extrato bancário, está ligada a fatura, cobrança, fatura de cartão, venda do PDV ou repasse, ou é uma das duas pernas de uma transferência. Pedir a mudança de valor_centavos, tipo, data_competencia, data_vencimento ou conta_id, dar baixa em uma linha ancorada que ainda não está paga, ou desfazer a baixa de uma linha ancorada e paga responde 409 lancamento_conciliado, com o motivo nos detalhes (campo motivo_da_trava). Os demais campos (descricao, forma_pagamento, categoria, subcategoria, empresa_id, fornecedor_id, cliente_empresa_id, centro_custo_id, plano_contas_id, documento e observacoes) continuam editáveis, com uma exceção: numa perna de transferência, categoria e subcategoria também não mudam (409 lancamento_conciliado, motivo transferencia), porque transferência não é receita nem despesa e, com outra categoria, as duas pernas passariam a contar no resultado como uma entrada e uma saída. Mandar o valor que a linha já tem não é mudança. Por essa mesma regra, a API não move um lançamento para fora de categoria de transferência: pedir outra categoria ou subcategoria numa linha que já está classificada como transferência responde 422 categoria_reservada, do mesmo modo que lançar em categoria de transferência. Numa conta que importa extrato, concilia ou emite faturas pela plataforma, a maior parte do histórico de lançamentos é ancorada: para a API, é leitura.\n\nExiste uma janela de milissegundos entre a API conferir se a linha é ancorada e a baixa ser gravada. Ela não depende do que o integrador envia, e o desfecho depende de quando a mudança cai nela. Se a linha já estava paga quando a baixa a leu (por exemplo, por outra baixa feita na tela, na agenda ou em outra chamada), a resposta é 200 com ja_estava_pago verdadeiro. Se foi paga depois dessa leitura e antes da gravação, a resposta é 409 lancamento_alterado (o mesmo vale, na baixa com diferença, se o valor mudou nesse intervalo). E se a linha passou a ser conciliada ou ancorada sem ter sido paga nesse intervalo, a baixa é aplicada, porque a gravação confere só o status e, na baixa com diferença, o valor, e não as âncoras. Em qualquer dos casos, leia o lançamento de novo antes de repetir a chamada.\n\nEscopo exigido: `financeiro:gravar`.","requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransacoesBaixa"},"example":{"data_pagamento":"2026-11-12","juros_centavos":1500,"multa_centavos":900,"justificativa":"Pago com dois dias de atraso"}}}},"responses":{"200":{"description":"O lançamento atual, já pago. Com ja_estava_pago verdadeiro quando ele já estava pago e nada foi alterado.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FinanceiroTransacoes"},{"type":"object","properties":{"ja_estava_pago":{"type":"boolean","description":"Presente e verdadeiro quando o lançamento já estava pago e nada foi alterado."}}}]}}}},"400":{"description":"O corpo não é um JSON válido. Códigos possíveis: `json_invalido`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"O estado do lançamento não permite a operação. Códigos possíveis: `lancamento_conciliado`, `lancamento_alterado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `validacao`, `valor_invalido`, `campo_desconhecido`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/transacoes/{id}/desfazer-baixa":{"parameters":[{"$ref":"#/components/parameters/IdUuid"}],"post":{"operationId":"desfazer_baixa_financeiro_transacoes","tags":["Transações"],"summary":"Desfazer a baixa de um lançamento","description":"Devolve um lançamento pago para pendente, restaurando o valor previsto e zerando juros, multa, acréscimo e desconto se a baixa teve diferença. Sobre um lançamento que já está pendente responde 200 com ja_estava_pendente verdadeiro e não altera nada. Não usa corpo.\n\nLinhas ancoradas são somente leitura para valor, tipo, datas e conta. Uma linha é ancorada quando está conciliada, tem fechamento de caixa, veio de extrato bancário, está ligada a fatura, cobrança, fatura de cartão, venda do PDV ou repasse, ou é uma das duas pernas de uma transferência. Pedir a mudança de valor_centavos, tipo, data_competencia, data_vencimento ou conta_id, dar baixa em uma linha ancorada que ainda não está paga, ou desfazer a baixa de uma linha ancorada e paga responde 409 lancamento_conciliado, com o motivo nos detalhes (campo motivo_da_trava). Os demais campos (descricao, forma_pagamento, categoria, subcategoria, empresa_id, fornecedor_id, cliente_empresa_id, centro_custo_id, plano_contas_id, documento e observacoes) continuam editáveis, com uma exceção: numa perna de transferência, categoria e subcategoria também não mudam (409 lancamento_conciliado, motivo transferencia), porque transferência não é receita nem despesa e, com outra categoria, as duas pernas passariam a contar no resultado como uma entrada e uma saída. Mandar o valor que a linha já tem não é mudança. Por essa mesma regra, a API não move um lançamento para fora de categoria de transferência: pedir outra categoria ou subcategoria numa linha que já está classificada como transferência responde 422 categoria_reservada, do mesmo modo que lançar em categoria de transferência. Numa conta que importa extrato, concilia ou emite faturas pela plataforma, a maior parte do histórico de lançamentos é ancorada: para a API, é leitura.\n\nO desfazer baixa tem a mesma janela de milissegundos. Se a linha já estava pendente ou agendada quando ele a leu, a resposta é 200 com ja_estava_pendente verdadeiro. Se deixou de estar paga depois dessa leitura e antes da gravação (por exemplo, por outro desfazer), a resposta é 409 lancamento_alterado. E se a linha passou a ser ancorada depois dessa leitura e antes da gravação, o desfazer é aplicado, porque a gravação confere só o status, e não as âncoras. Em qualquer dos casos, leia o lançamento de novo antes de repetir a chamada.\n\nEscopo exigido: `financeiro:gravar`.","responses":{"200":{"description":"O lançamento atual, já pendente. Com ja_estava_pendente verdadeiro quando ele já estava pendente e nada foi alterado.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/FinanceiroTransacoes"},{"type":"object","properties":{"ja_estava_pendente":{"type":"boolean","description":"Presente e verdadeiro quando o lançamento já estava pendente e nada foi alterado."}}}]}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"O estado do lançamento não permite a operação. Códigos possíveis: `lancamento_conciliado`, `lancamento_alterado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/faturas":{"get":{"operationId":"listar_financeiro_faturas","tags":["Faturas"],"summary":"Listar faturas","description":"Faturas de venda emitidas aos clientes, com valor, retenções e situação. O link da nota fiscal não é exposto.\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO filtro atualizado_desde serve à sincronização incremental. Exclusões não aparecem: veja a descrição geral da API.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"},{"name":"atualizado_desde","in":"query","required":false,"description":"Só o que mudou a partir deste instante (inclusive), ISO 8601 com fuso. Para sincronização incremental.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroFaturasLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/faturas/{id}":{"parameters":[{"$ref":"#/components/parameters/IdUuid"}],"get":{"operationId":"obter_financeiro_faturas","tags":["Faturas"],"summary":"Obter um registro de faturas","description":"Faturas de venda emitidas aos clientes, com valor, retenções e situação. O link da nota fiscal não é exposto.\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroFaturas"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/cobrancas":{"get":{"operationId":"listar_financeiro_cobrancas","tags":["Cobranças"],"summary":"Listar cobranças","description":"Cobranças emitidas por boleto, Pix ou cartão. Não traz e-mail nem telefone do cliente, nem link de boleto ou código de Pix.\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO filtro atualizado_desde serve à sincronização incremental. Exclusões não aparecem: veja a descrição geral da API.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"},{"name":"atualizado_desde","in":"query","required":false,"description":"Só o que mudou a partir deste instante (inclusive), ISO 8601 com fuso. Para sincronização incremental.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroCobrancasLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/cobrancas/{id}":{"parameters":[{"$ref":"#/components/parameters/IdInteiro"}],"get":{"operationId":"obter_financeiro_cobrancas","tags":["Cobranças"],"summary":"Obter um registro de cobranças","description":"Cobranças emitidas por boleto, Pix ou cartão. Não traz e-mail nem telefone do cliente, nem link de boleto ou código de Pix.\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroCobrancas"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/transferencias":{"get":{"operationId":"listar_financeiro_transferencias","tags":["Transferências entre contas"],"summary":"Listar transferências entre contas","description":"Os pares de movimentação entre duas contas. Os dois lados já estão em transacoes: não some este recurso com transacoes.\n\nLista os registros, com filtros e paginação por cursor. Cada recurso tem uma ordem fixa. Parâmetro de consulta que o recurso não conhece responde 422 campo_desconhecido.\n\nO cursor guarda só a posição na listagem, não os filtros: reutilizá-lo com outros filtros reposiciona a leitura na nova listagem. Mantenha os mesmos filtros de uma página para a seguinte.\n\nEscopo exigido: `financeiro:ler`.","parameters":[{"$ref":"#/components/parameters/Limite"},{"$ref":"#/components/parameters/Cursor"}],"responses":{"200":{"description":"Uma página de registros e o cursor da próxima.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransferenciasLista"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"O corpo ou os parâmetros não passaram na validação. Códigos possíveis: `campo_desconhecido`, `paginacao_invalida`, `validacao`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/financeiro/transferencias/{id}":{"parameters":[{"$ref":"#/components/parameters/IdInteiro"}],"get":{"operationId":"obter_financeiro_transferencias","tags":["Transferências entre contas"],"summary":"Obter um registro de transferências entre contas","description":"Os pares de movimentação entre duas contas. Os dois lados já estão em transacoes: não some este recurso com transacoes.\n\nDevolve um registro pelo id, sem envelope.\n\nEscopo exigido: `financeiro:ler`.","responses":{"200":{"description":"O registro, direto, sem envelope.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinanceiroTransferencias"}}}},"401":{"description":"A chave não foi aceita. Códigos possíveis: `chave_ausente`, `chave_invalida`, `chave_revogada`, `chave_expirada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave é boa, mas não pode fazer isto. Códigos possíveis: `escopo_insuficiente`, `modulo_indisponivel`, `empresa_bloqueada`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"O registro não existe na conta da chave. Códigos possíveis: `nao_encontrado`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de requisições atingido. Códigos possíveis: `limite_de_requisicoes`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro do nosso lado. Códigos possíveis: `erro_interno`. O formato do erro e o significado de cada código estão no esquema Erro.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"sst_live_<prefixo>_<segredo>","description":"Chave criada por um administrador da conta em Configurações, Integrações, API. Formato sst_live_<prefixo>_<segredo>, enviada no cabeçalho Authorization: Bearer. Aparece uma única vez, na criação. Use só no servidor."}},"parameters":{"Limite":{"name":"limite","in":"query","required":false,"description":"Quantos registros por página, de 1 a 200.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},"Cursor":{"name":"cursor","in":"query","required":false,"description":"O proximo_cursor da página anterior, sem alterar, no mesmo recurso. Reutilizá-lo com outros filtros reposiciona a leitura na nova listagem.","schema":{"type":"string"}},"IdUuid":{"name":"id","in":"path","required":true,"description":"Identificador do registro (UUID).","schema":{"type":"string","format":"uuid"}},"IdInteiro":{"name":"id","in":"path","required":true,"description":"Identificador do registro (inteiro).","schema":{"type":"integer","minimum":1,"maximum":2147483647}}},"headers":{"X-Request-Id":{"description":"Identificador desta requisição (req_ e 32 hexadecimais), igual ao id_requisicao do erro. Cite-o ao abrir um chamado.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requisições permitidas por minuto para a chave.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requisições que ainda cabem na janela atual, nesta instância do servidor.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Quando a janela atual termina, como época Unix em segundos.","schema":{"type":"integer"}},"Retry-After":{"description":"Segundos a esperar antes de tentar de novo.","schema":{"type":"integer"}},"Location":{"description":"Caminho do registro criado, a partir da raiz do domínio.","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"Vale true quando a resposta é a repetição de uma chamada já feita com a mesma referencia_externa.","schema":{"type":"string","enum":["true"]}}},"schemas":{"Erro":{"type":"object","description":"O formato de todo erro da API. O mesmo identificador vai no cabeçalho X-Request-Id.","required":["erro","id_requisicao"],"properties":{"erro":{"type":"object","required":["codigo","mensagem","detalhes"],"properties":{"codigo":{"type":"string","enum":["chave_ausente","chave_invalida","chave_revogada","chave_expirada","escopo_insuficiente","modulo_indisponivel","empresa_bloqueada","json_invalido","nao_encontrado","recurso_desconhecido","validacao","valor_invalido","campo_desconhecido","paginacao_invalida","categoria_invalida","categoria_reservada","referencia_invalida","conflito_idempotencia","lancamento_removido","lancamento_conciliado","lancamento_alterado","limite_de_requisicoes","erro_interno"],"description":"Código estável do erro: decida por ele, não pela mensagem.\n\n- `chave_ausente` (401): A requisição não trouxe o cabeçalho Authorization: Bearer com a chave.\n- `chave_invalida` (401): A chave não existe, está mal formada, o cabeçalho não usa o esquema Bearer, ou a chave foi enviada na URL (isso é sempre recusado).\n- `chave_revogada` (401): A chave foi revogada por um administrador da conta. Crie outra.\n- `chave_expirada` (401): A chave passou da data de validade escolhida na criação. Crie outra.\n- `escopo_insuficiente` (403): A chave não tem o escopo que a operação exige, por exemplo financeiro:gravar para criar ou alterar.\n- `modulo_indisponivel` (403): O setor ou a página do recurso não está disponível no plano atual da conta. Vale o plano de agora, não o de quando a chave foi criada.\n- `empresa_bloqueada` (403): A conta da chave está inativa, bloqueada, não foi encontrada ou está com o período de teste vencido.\n- `json_invalido` (400): O corpo da requisição não é um JSON válido. Envie JSON com Content-Type: application/json.\n- `nao_encontrado` (404): O registro não existe na conta da chave. Um id com formato impossível também responde assim.\n- `recurso_desconhecido` (404): O setor ou o recurso não existe na v1, ou o recurso é somente leitura e a operação (POST ou PATCH) não é oferecida. Não é 405.\n- `validacao` (422): Um campo do corpo ou um parâmetro de consulta tem valor inválido. O detalhe traz um item por campo, com o motivo.\n- `valor_invalido` (422): Valor em centavos fora do aceito: precisa ser número inteiro, de 1 a 2.000.000.000 no lançamento e de 0 a 2.000.000.000 nos componentes da baixa. Também quando o valor efetivo da baixa fica zerado ou acima do limite.\n- `campo_desconhecido` (422): Campo do corpo ou parâmetro de consulta que a operação não conhece ou não aceita, como status, data_pagamento e referencia_externa no PATCH de transações.\n- `paginacao_invalida` (422): O limite está fora de 1 a 200, ou o cursor foi alterado, é de outro recurso ou está malformado.\n- `categoria_invalida` (422): A categoria, ou o par categoria e subcategoria, não existe no catálogo de categorias da conta, ou veio subcategoria sem categoria.\n- `categoria_reservada` (422): Categoria de transferência entre contas, que não pode ser usada em lançamento pela API. A mesma regra vale na saída: a API não move para outra categoria um lançamento que já está classificado como transferência.\n- `referencia_invalida` (422): Um identificador de outro recurso (conta_id, empresa_id, fornecedor_id, centro_custo_id, plano_contas_id ou cliente_empresa_id) não existe na conta da chave.\n- `conflito_idempotencia` (409): Durante os 30 dias de retenção, a mesma referencia_externa só aceita o mesmo corpo, e esta chamada trouxe outro. Para repetir a chamada reenvie exatamente o mesmo corpo; para criar outro lançamento use outra referência. Depois dos 30 dias o corpo não é comparado: se o lançamento ainda existe, a mesma referência o devolve como repetição.\n- `lancamento_removido` (409): O lançamento criado com esta referencia_externa foi apagado por uma pessoa. Durante os 30 dias de retenção, a referência fica queimada: use outra. Depois dos 30 dias, a mesma referência cria um lançamento novo.\n- `lancamento_conciliado` (409): O lançamento é ancorado (conciliado, de extrato bancário, ligado a fatura, cobrança, PDV, repasse ou transferência) e a operação mudaria valor, tipo, datas ou conta (numa perna de transferência, também categoria e subcategoria), ou a baixa. O detalhe traz o motivo, em motivo_da_trava.\n- `lancamento_alterado` (409): O lançamento mudou durante a chamada, numa janela de milissegundos. Leia o lançamento de novo e repita a chamada se ainda fizer sentido.\n- `limite_de_requisicoes` (429): Mais de 120 requisições por minuto com a mesma chave. Espere os segundos do cabeçalho Retry-After.\n- `erro_interno` (500): Erro do nosso lado. Informe o id_requisicao ao suporte do SSTFLIX."},"mensagem":{"type":"string","description":"Texto em português para uma pessoa ler. Pode mudar: não decida por ele."},"detalhes":{"type":"array","items":{"$ref":"#/components/schemas/DetalheDeErro"},"description":"Um item por campo com problema. Vazio quando o erro não é de um campo."}}},"id_requisicao":{"type":"string","pattern":"^req_[0-9a-f]{32}$","description":"Identificador da requisição, igual ao cabeçalho X-Request-Id."}},"example":{"erro":{"codigo":"valor_invalido","mensagem":"Corpo inválido: valor_centavos (informe centavos inteiros, de 1 a 2000000000 (número, não texto)).","detalhes":[{"campo":"valor_centavos","motivo":"informe centavos inteiros, de 1 a 2000000000 (número, não texto)"}]},"id_requisicao":"req_0123456789abcdef0123456789abcdef"}},"DetalheDeErro":{"type":"object","required":["campo","motivo"],"properties":{"campo":{"type":"string","description":"O campo do corpo ou o parâmetro de consulta com problema. Alguns erros trazem um rótulo, como motivo_da_trava."},"motivo":{"type":"string","description":"Por que o campo foi recusado, em português."}}},"FinanceiroContas":{"type":"object","description":"Contas bancárias. Contas bancárias, caixas e cartões da empresa. O saldo inicial é o ponto de partida do livro-caixa, não o saldo de hoje. Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","nome","banco","tipo","agencia","numero","saldo_inicial_centavos","cor","ativo","empresa_id","criado_em"],"properties":{"id":{"type":"integer","description":"Identificador do registro (inteiro)."},"nome":{"type":["string","null"],"description":"Nome da conta."},"banco":{"type":["string","null"],"description":"Banco, quando houver. Vazio para caixa."},"tipo":{"type":["string","null"],"enum":["corrente","poupanca","investimento","cartao","dinheiro","outros",null],"description":"Tipo da conta."},"agencia":{"type":["string","null"],"description":"Agência. Vazio quando não se aplica."},"numero":{"type":["string","null"],"description":"Número da conta. Vazio quando não se aplica."},"saldo_inicial_centavos":{"type":["integer","null"],"description":"Saldo inicial em centavos."},"cor":{"type":["string","null"],"description":"Cor de exibição na plataforma, em hexadecimal."},"ativo":{"type":["boolean","null"],"description":"Falso quando o registro foi desativado (nunca é apagado pela API)."},"empresa_id":{"type":["string","null"],"format":"uuid","description":"Empresa do grupo dona da conta, quando a conta é de uma delas."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando a conta foi cadastrada."}}},"FinanceiroContasLista":{"type":"object","description":"Uma página de contas bancárias.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroContas"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}},"FinanceiroCategorias":{"type":"object","description":"Categorias. Catálogo de categorias e subcategorias de lançamento. A categoria de uma transação é o par de texto categoria + subcategoria, sem chave estrangeira. Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","tipo","grupo","categoria","subcategoria","ativo","criado_em"],"properties":{"id":{"type":"string","format":"uuid","description":"Identificador do registro (UUID)."},"tipo":{"type":["string","null"],"description":"Natureza da categoria: entrada, saida ou transferencia. Transferência não entra no resultado."},"grupo":{"type":["string","null"],"description":"Grupo da categoria."},"categoria":{"type":["string","null"],"description":"Categoria."},"subcategoria":{"type":["string","null"],"description":"Subcategoria. Vazio quando a categoria não tem subcategoria."},"ativo":{"type":["boolean","null"],"description":"Falso quando o registro foi desativado (nunca é apagado pela API)."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando a categoria foi cadastrada."}}},"FinanceiroCategoriasLista":{"type":"object","description":"Uma página de categorias.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroCategorias"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}},"FinanceiroCentrosCusto":{"type":"object","description":"Centros de custo. Centros de custo para apropriar despesas e receitas. Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","nome","codigo","descricao","ativo","criado_em"],"properties":{"id":{"type":"integer","description":"Identificador do registro (inteiro)."},"nome":{"type":["string","null"],"description":"Nome do centro de custo."},"codigo":{"type":["string","null"],"description":"Código curto. Vazio quando não há."},"descricao":{"type":["string","null"],"description":"Descrição livre."},"ativo":{"type":["boolean","null"],"description":"Falso quando o registro foi desativado (nunca é apagado pela API)."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando o centro de custo foi cadastrado."}}},"FinanceiroCentrosCustoLista":{"type":"object","description":"Uma página de centros de custo.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroCentrosCusto"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}},"FinanceiroPlanoContas":{"type":"object","description":"Plano de contas. Plano de contas contábil em árvore: cada conta aponta para a conta pai (pai_id). Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","codigo","nome","tipo","natureza","pai_id","nivel","ativo","criado_em"],"properties":{"id":{"type":"integer","description":"Identificador do registro (inteiro)."},"codigo":{"type":["string","null"],"description":"Código contábil, por exemplo 1.1.01."},"nome":{"type":["string","null"],"description":"Nome da conta contábil."},"tipo":{"type":["string","null"],"enum":["sintetica","analitica",null],"description":"Sintética agrupa contas; analítica recebe lançamentos."},"natureza":{"type":["string","null"],"enum":["devedora","credora",null],"description":"Natureza do saldo da conta."},"pai_id":{"type":["integer","null"],"description":"Identificador da conta pai. Nulo na raiz."},"nivel":{"type":["integer","null"],"description":"Nível na árvore, a partir de 1."},"ativo":{"type":["boolean","null"],"description":"Falso quando o registro foi desativado (nunca é apagado pela API)."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando a conta contábil foi cadastrada."}}},"FinanceiroPlanoContasLista":{"type":"object","description":"Uma página de plano de contas.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroPlanoContas"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}},"FinanceiroFornecedores":{"type":"object","description":"Fornecedores. Fornecedores cadastrados. A chave Pix do fornecedor não é exposta. Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","razao_social","nome_fantasia","tipo","cpf_cnpj","email","telefone","categoria","contato_nome","observacoes","ativo","empresa_id","criado_em"],"properties":{"id":{"type":"integer","description":"Identificador do registro (inteiro)."},"razao_social":{"type":["string","null"],"description":"Razão social, ou nome completo quando pessoa física."},"nome_fantasia":{"type":["string","null"],"description":"Nome fantasia. Vazio quando não há."},"tipo":{"type":["string","null"],"enum":["pj","pf",null],"description":"Pessoa jurídica (pj) ou física (pf)."},"cpf_cnpj":{"type":["string","null"],"description":"CPF ou CNPJ, como cadastrado (pode vir com pontuação)."},"email":{"type":["string","null"],"description":"E-mail de contato."},"telefone":{"type":["string","null"],"description":"Telefone de contato."},"categoria":{"type":["string","null"],"description":"Categoria do fornecedor."},"contato_nome":{"type":["string","null"],"description":"Nome da pessoa de contato."},"observacoes":{"type":["string","null"],"description":"Observações livres."},"ativo":{"type":["boolean","null"],"description":"Falso quando o registro foi desativado (nunca é apagado pela API)."},"empresa_id":{"type":["string","null"],"format":"uuid","description":"Empresa do grupo a que o fornecedor está vinculado, quando houver."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando o fornecedor foi cadastrado."}}},"FinanceiroFornecedoresLista":{"type":"object","description":"Uma página de fornecedores.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroFornecedores"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}},"FinanceiroFornecedoresCriar":{"type":"object","properties":{"razao_social":{"type":"string","minLength":1,"maxLength":200,"description":"Razão social, ou nome completo quando pessoa física. Obrigatória no cadastro, de 1 a 200 caracteres."},"nome_fantasia":{"type":"string","maxLength":200,"description":"Nome fantasia, até 200 caracteres."},"tipo":{"type":"string","enum":["pj","pf"],"description":"Pessoa jurídica (pj, o padrão) ou pessoa física (pf)."},"cpf_cnpj":{"type":"string","maxLength":30,"description":"Envie o CPF (11 dígitos) ou o CNPJ (14 dígitos), com ou sem pontuação: a API grava com a pontuação padrão (000.000.000-00 para o CPF e 00.000.000/0000-00 para o CNPJ), no POST e no PATCH. Por exemplo, 11222333000181 fica 11.222.333/0001-81. Outros formatos de documento não são suportados: texto com outra quantidade de dígitos (um documento estrangeiro, por exemplo) fica como veio, mas texto com exatamente 11 dígitos, ou com 14 ou mais, é reescrito como CPF ou CNPJ, descartando o que não for dígito e cortando o que passar de 14 dígitos. Aceita até 30 caracteres."},"email":{"type":"string","maxLength":200,"description":"E-mail de contato, até 200 caracteres."},"telefone":{"type":"string","maxLength":40,"description":"Telefone de contato, até 40 caracteres."},"categoria":{"type":"string","maxLength":100,"description":"Categoria do fornecedor, em texto livre, até 100 caracteres. Sem ela vale outros."},"contato_nome":{"type":"string","maxLength":200,"description":"Nome da pessoa de contato, até 200 caracteres."},"observacoes":{"type":"string","maxLength":5000,"description":"Observações livres, até 5000 caracteres."},"empresa_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Empresa do grupo a que o fornecedor está vinculado. Nulo para nenhuma. Se não existir na conta da chave, a resposta é 422 referencia_invalida."}},"required":["razao_social"],"additionalProperties":false,"description":"Corpo de criação de um fornecedor. Só razao_social é obrigatória."},"FinanceiroFornecedoresEditar":{"type":"object","properties":{"razao_social":{"type":"string","minLength":1,"maxLength":200,"description":"Razão social, ou nome completo quando pessoa física. Obrigatória no cadastro, de 1 a 200 caracteres."},"nome_fantasia":{"type":"string","maxLength":200,"description":"Nome fantasia, até 200 caracteres."},"tipo":{"type":"string","enum":["pj","pf"],"description":"Pessoa jurídica (pj, o padrão) ou pessoa física (pf)."},"cpf_cnpj":{"type":"string","maxLength":30,"description":"Envie o CPF (11 dígitos) ou o CNPJ (14 dígitos), com ou sem pontuação: a API grava com a pontuação padrão (000.000.000-00 para o CPF e 00.000.000/0000-00 para o CNPJ), no POST e no PATCH. Por exemplo, 11222333000181 fica 11.222.333/0001-81. Outros formatos de documento não são suportados: texto com outra quantidade de dígitos (um documento estrangeiro, por exemplo) fica como veio, mas texto com exatamente 11 dígitos, ou com 14 ou mais, é reescrito como CPF ou CNPJ, descartando o que não for dígito e cortando o que passar de 14 dígitos. Aceita até 30 caracteres."},"email":{"type":"string","maxLength":200,"description":"E-mail de contato, até 200 caracteres."},"telefone":{"type":"string","maxLength":40,"description":"Telefone de contato, até 40 caracteres."},"categoria":{"type":"string","maxLength":100,"description":"Categoria do fornecedor, em texto livre, até 100 caracteres. Sem ela vale outros."},"contato_nome":{"type":"string","maxLength":200,"description":"Nome da pessoa de contato, até 200 caracteres."},"observacoes":{"type":"string","maxLength":5000,"description":"Observações livres, até 5000 caracteres."},"empresa_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Empresa do grupo a que o fornecedor está vinculado. Nulo para nenhuma. Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"ativo":{"type":"boolean","description":"Falso desativa o fornecedor. A API nunca apaga registros."}},"additionalProperties":false,"minProperties":1,"description":"Corpo de edição de um fornecedor: só o que vier é alterado, e ao menos um campo é obrigatório. Texto vazio limpa o campo (menos razao_social) e empresa_id nulo desvincula."},"FinanceiroTransacoes":{"type":"object","description":"Transações. Lançamentos de entrada e saída, inclusive contas a pagar e a receber (filtre por tipo e status). Devolve também as transferências entre contas; use computa_no_resultado para separá-las. Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","tipo","descricao","valor_centavos","status","data_competencia","data_pagamento","data_vencimento","mes_competencia","forma_pagamento","categoria","subcategoria","conta_id","empresa_id","empresa_beneficiaria_id","cliente_empresa_id","fornecedor_id","centro_custo_id","plano_contas_id","documento","observacoes","referencia_externa","conciliado","fatura_id","cobranca_id","multa_centavos","juros_centavos","desconto_centavos","acrescimo_centavos","valor_previsto_centavos","computa_no_resultado","atualizado_em","criado_em"],"properties":{"id":{"type":"string","format":"uuid","description":"Identificador do registro (UUID)."},"tipo":{"type":["string","null"],"enum":["entrada","saida",null],"description":"Entrada (receita) ou saída (despesa)."},"descricao":{"type":["string","null"],"description":"Descrição do lançamento."},"valor_centavos":{"type":["integer","null"],"description":"Valor previsto ou efetivo do lançamento, em centavos."},"status":{"type":["string","null"],"enum":["pago","pendente","agendado",null],"description":"Situação do pagamento."},"data_competencia":{"type":["string","null"],"format":"date","description":"Data de competência (YYYY-MM-DD)."},"data_pagamento":{"type":["string","null"],"format":"date","description":"Data em que foi pago (YYYY-MM-DD). Nula enquanto o status não for pago."},"data_vencimento":{"type":["string","null"],"format":"date","description":"Data de vencimento (YYYY-MM-DD)."},"mes_competencia":{"type":["string","null"],"description":"Mês de competência, quando informado."},"forma_pagamento":{"type":["string","null"],"description":"Forma de pagamento, em texto livre."},"categoria":{"type":["string","null"],"description":"Categoria. Junto com subcategoria forma o par do catálogo de categorias."},"subcategoria":{"type":["string","null"],"description":"Subcategoria."},"conta_id":{"type":["integer","null"],"description":"Conta bancária (recurso contas)."},"empresa_id":{"type":["string","null"],"format":"uuid","description":"Empresa do grupo dona do lançamento."},"empresa_beneficiaria_id":{"type":["string","null"],"format":"uuid","description":"Empresa do grupo beneficiada pelo lançamento, quando diferente da dona."},"cliente_empresa_id":{"type":["string","null"],"format":"uuid","description":"Empresa cliente vinculada ao lançamento."},"fornecedor_id":{"type":["integer","null"],"description":"Fornecedor (recurso fornecedores)."},"centro_custo_id":{"type":["integer","null"],"description":"Centro de custo (recurso centros-custo)."},"plano_contas_id":{"type":["integer","null"],"description":"Conta contábil (recurso plano-contas)."},"documento":{"type":["string","null"],"description":"Número do documento, por exemplo da nota fiscal."},"observacoes":{"type":["string","null"],"description":"Observações livres."},"referencia_externa":{"type":["string","null"],"description":"Referência do sistema de origem. É a chave de idempotência dos lançamentos criados pela API."},"conciliado":{"type":["boolean","null"],"description":"Verdadeiro quando o lançamento já foi conferido com o extrato bancário."},"fatura_id":{"type":["string","null"],"format":"uuid","description":"Fatura de venda vinculada (recurso faturas)."},"cobranca_id":{"type":["integer","null"],"description":"Cobrança vinculada (recurso cobrancas)."},"multa_centavos":{"type":["integer","null"],"description":"Multa paga ou recebida, em centavos."},"juros_centavos":{"type":["integer","null"],"description":"Juros pagos ou recebidos, em centavos."},"desconto_centavos":{"type":["integer","null"],"description":"Desconto concedido ou obtido, em centavos."},"acrescimo_centavos":{"type":["integer","null"],"description":"Acréscimo, em centavos."},"valor_previsto_centavos":{"type":["integer","null"],"description":"Valor previsto antes da baixa, em centavos. Nulo quando o lançamento nunca foi baixado."},"computa_no_resultado":{"type":["boolean","null"],"description":"Falso para transferência entre contas e para o pagamento de fatura de cartão, que não são receita nem despesa. Calculado com a mesma regra da tela de transações."},"atualizado_em":{"type":["string","null"],"format":"date-time","description":"Última alteração do lançamento. Base do filtro atualizado_desde."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando o lançamento foi criado."}}},"FinanceiroTransacoesLista":{"type":"object","description":"Uma página de transações.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroTransacoes"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}},"FinanceiroTransacoesCriar":{"type":"object","properties":{"tipo":{"type":"string","enum":["entrada","saida"],"description":"Entrada (receita) ou saída (despesa)."},"descricao":{"type":"string","minLength":1,"maxLength":500,"description":"Descrição do lançamento, de 1 a 500 caracteres."},"valor_centavos":{"type":"integer","minimum":1,"maximum":2000000000,"description":"Valor em centavos, número inteiro de 1 a 2.000.000.000. Texto, decimal, zero, negativo e nulo são recusados com valor_invalido."},"data_competencia":{"type":"string","format":"date","description":"Data de competência, no formato YYYY-MM-DD (anos de 1900 a 2200)."},"referencia_externa":{"type":"string","minLength":1,"maxLength":200,"description":"Obrigatória. Referência do seu sistema, de 1 a 200 caracteres, sem espaço no começo nem no fim. É a chave de idempotência: durante os 30 dias de retenção, a mesma referência com o mesmo corpo devolve o lançamento já criado, e com outro corpo é recusada com conflito_idempotencia. Depois dos 30 dias o corpo não é comparado: se o lançamento ainda existe, a mesma referência o devolve como repetição."},"status":{"default":"pendente","type":"string","enum":["pendente","agendado","pago"],"description":"Situação inicial do lançamento. Padrão pendente. Com pago, data_pagamento é obrigatória."},"data_pagamento":{"type":["string","null"],"format":"date","description":"Só vale com status pago, quando é obrigatória (YYYY-MM-DD). Com pendente ou agendado, enviar data_pagamento é recusado: a data prevista de pagamento vai em data_vencimento."},"data_vencimento":{"type":["string","null"],"format":"date","description":"Data de vencimento, no formato YYYY-MM-DD."},"forma_pagamento":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"description":"Forma de pagamento, em texto livre, até 60 caracteres."},"categoria":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Categoria do catálogo de categorias da conta (recurso categorias), sem diferenciar maiúsculas de minúsculas. Pode ser enviada sozinha se existir no catálogo. É gravada com a grafia do catálogo. Categoria de transferência entre contas é recusada (categoria_reservada). No PATCH, numa perna de transferência a categoria e a subcategoria não mudam (409 lancamento_conciliado), e a API não move para outra categoria um lançamento que já está em categoria de transferência (422 categoria_reservada)."},"subcategoria":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Subcategoria do par categoria e subcategoria do catálogo de categorias. Exige categoria."},"conta_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}],"description":"Conta bancária (recurso contas). Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"empresa_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Empresa do grupo dona do lançamento. Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"fornecedor_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}],"description":"Fornecedor (recurso fornecedores). Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"cliente_empresa_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Empresa cliente vinculada ao lançamento. Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"centro_custo_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}],"description":"Centro de custo (recurso centros-custo). Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"plano_contas_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}],"description":"Conta contábil (recurso plano-contas). Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"documento":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Número do documento, por exemplo da nota fiscal, até 100 caracteres."},"observacoes":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"description":"Observações livres, até 5000 caracteres."}},"required":["tipo","descricao","valor_centavos","data_competencia","referencia_externa"],"additionalProperties":false,"description":"Corpo de criação de um lançamento. A referencia_externa é obrigatória: é a chave de idempotência."},"FinanceiroTransacoesEditar":{"type":"object","properties":{"tipo":{"type":"string","enum":["entrada","saida"],"description":"Entrada (receita) ou saída (despesa)."},"descricao":{"type":"string","minLength":1,"maxLength":500,"description":"Descrição do lançamento, de 1 a 500 caracteres."},"valor_centavos":{"type":"integer","minimum":1,"maximum":2000000000,"description":"Valor em centavos, número inteiro de 1 a 2.000.000.000. Texto, decimal, zero, negativo e nulo são recusados com valor_invalido."},"data_competencia":{"type":"string","format":"date","description":"Data de competência, no formato YYYY-MM-DD (anos de 1900 a 2200)."},"data_vencimento":{"type":["string","null"],"format":"date","description":"Data de vencimento, no formato YYYY-MM-DD."},"forma_pagamento":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"description":"Forma de pagamento, em texto livre, até 60 caracteres."},"categoria":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Categoria do catálogo de categorias da conta (recurso categorias), sem diferenciar maiúsculas de minúsculas. Pode ser enviada sozinha se existir no catálogo. É gravada com a grafia do catálogo. Categoria de transferência entre contas é recusada (categoria_reservada). No PATCH, numa perna de transferência a categoria e a subcategoria não mudam (409 lancamento_conciliado), e a API não move para outra categoria um lançamento que já está em categoria de transferência (422 categoria_reservada)."},"subcategoria":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Subcategoria do par categoria e subcategoria do catálogo de categorias. Exige categoria."},"conta_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}],"description":"Conta bancária (recurso contas). Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"empresa_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Empresa do grupo dona do lançamento. Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"fornecedor_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}],"description":"Fornecedor (recurso fornecedores). Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"cliente_empresa_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Empresa cliente vinculada ao lançamento. Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"centro_custo_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}],"description":"Centro de custo (recurso centros-custo). Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"plano_contas_id":{"anyOf":[{"type":"integer","minimum":1,"maximum":2147483647},{"type":"null"}],"description":"Conta contábil (recurso plano-contas). Se não existir na conta da chave, a resposta é 422 referencia_invalida."},"documento":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Número do documento, por exemplo da nota fiscal, até 100 caracteres."},"observacoes":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}],"description":"Observações livres, até 5000 caracteres."}},"additionalProperties":false,"minProperties":1,"description":"Corpo de edição de um lançamento: só o que vier é alterado, e ao menos um campo é obrigatório. Enviar null limpa um campo de apoio (todos menos tipo, descricao, valor_centavos e data_competencia). status, data_pagamento e referencia_externa não são aceitos."},"FinanceiroTransacoesBaixa":{"type":"object","properties":{"data_pagamento":{"type":["string","null"],"format":"date","description":"Data do pagamento (YYYY-MM-DD). Sem ela vale a data de hoje em America/Sao_Paulo."},"juros_centavos":{"type":["integer","null"],"minimum":0,"maximum":2000000000,"description":"Juros pagos, em centavos inteiros (de 0 a 2.000.000.000). Ausente ou nulo vale zero."},"multa_centavos":{"type":["integer","null"],"minimum":0,"maximum":2000000000,"description":"Multa paga, em centavos inteiros (de 0 a 2.000.000.000). Ausente ou nulo vale zero."},"acrescimo_centavos":{"type":["integer","null"],"minimum":0,"maximum":2000000000,"description":"Acréscimo, em centavos inteiros (de 0 a 2.000.000.000). Ausente ou nulo vale zero."},"desconto_centavos":{"type":["integer","null"],"minimum":0,"maximum":2000000000,"description":"Desconto obtido, em centavos inteiros (de 0 a 2.000.000.000). Ausente ou nulo vale zero. Não pode passar do valor do lançamento somado aos juros, à multa e ao acréscimo."},"justificativa":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"description":"Obrigatória, com no mínimo 5 caracteres, quando há juros, multa, acréscimo ou desconto. Até 500 caracteres."}},"additionalProperties":false,"description":"Corpo opcional da baixa. Todos os campos são opcionais: sem corpo vale a data de hoje, sem diferença."},"FinanceiroFaturas":{"type":"object","description":"Faturas. Faturas de venda emitidas aos clientes, com valor, retenções e situação. O link da nota fiscal não é exposto. Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","empresa_id","contrato_id","contato_id","empresa_contratada_id","competencia","sequencia","ano","numero_ano","status","valor_centavos","valor_liquido_centavos","retencao_iss_centavos","retencao_inss_centavos","retencao_ir_centavos","retencao_pis_centavos","retencao_cofins_centavos","retencao_csll_centavos","iss_retido","vencimento","pago_em","emitida_em","nf_numero","observacoes","atualizado_em","criado_em"],"properties":{"id":{"type":"string","format":"uuid","description":"Identificador do registro (UUID)."},"empresa_id":{"type":["string","null"],"format":"uuid","description":"Empresa cliente da fatura."},"contrato_id":{"type":["string","null"],"format":"uuid","description":"Contrato de origem, quando houver."},"contato_id":{"type":["string","null"],"format":"uuid","description":"Contato cliente, quando a fatura é para pessoa e não para empresa."},"empresa_contratada_id":{"type":["string","null"],"format":"uuid","description":"Empresa do grupo que presta o serviço."},"competencia":{"type":["string","null"],"format":"date","description":"Mês de competência (YYYY-MM-DD, sempre o dia 1)."},"sequencia":{"type":["integer","null"],"description":"Sequência da fatura dentro da competência, a partir de 1."},"ano":{"type":["integer","null"],"description":"Ano da numeração da fatura."},"numero_ano":{"type":["integer","null"],"description":"Número da fatura dentro do ano."},"status":{"type":["string","null"],"description":"Situação da fatura, em texto livre (por exemplo ABERTA, PAGA)."},"valor_centavos":{"type":["integer","null"],"description":"Valor bruto, em centavos."},"valor_liquido_centavos":{"type":["integer","null"],"description":"Valor líquido depois das retenções, em centavos."},"retencao_iss_centavos":{"type":["integer","null"],"description":"ISS retido, em centavos."},"retencao_inss_centavos":{"type":["integer","null"],"description":"INSS retido, em centavos."},"retencao_ir_centavos":{"type":["integer","null"],"description":"IR retido, em centavos."},"retencao_pis_centavos":{"type":["integer","null"],"description":"PIS retido, em centavos."},"retencao_cofins_centavos":{"type":["integer","null"],"description":"COFINS retida, em centavos."},"retencao_csll_centavos":{"type":["integer","null"],"description":"CSLL retida, em centavos."},"iss_retido":{"type":["boolean","null"],"description":"Verdadeiro quando o ISS é retido pelo tomador."},"vencimento":{"type":["string","null"],"format":"date","description":"Data de vencimento (YYYY-MM-DD)."},"pago_em":{"type":["string","null"],"format":"date","description":"Data do pagamento (YYYY-MM-DD). Nula enquanto não paga."},"emitida_em":{"type":["string","null"],"format":"date","description":"Data de emissão da nota fiscal (YYYY-MM-DD)."},"nf_numero":{"type":["string","null"],"description":"Número da nota fiscal."},"observacoes":{"type":["string","null"],"description":"Observações livres."},"atualizado_em":{"type":["string","null"],"format":"date-time","description":"Última alteração da fatura. Base do filtro atualizado_desde."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando a fatura foi criada."}}},"FinanceiroFaturasLista":{"type":"object","description":"Uma página de faturas.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroFaturas"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}},"FinanceiroCobrancas":{"type":"object","description":"Cobranças. Cobranças emitidas por boleto, Pix ou cartão. Não traz e-mail nem telefone do cliente, nem link de boleto ou código de Pix. Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","cliente_nome","cliente_cnpj_cpf","valor_centavos","forma_pagamento","status","data_vencimento","data_pagamento","descricao","parcelas","contrato_id","fatura_id","recorrencia_id","valor_liquido_centavos","taxa_gateway_centavos","atualizado_em","criado_em"],"properties":{"id":{"type":"integer","description":"Identificador do registro (inteiro)."},"cliente_nome":{"type":["string","null"],"description":"Nome do cliente."},"cliente_cnpj_cpf":{"type":["string","null"],"description":"CPF ou CNPJ do cliente, como cadastrado."},"valor_centavos":{"type":["integer","null"],"description":"Valor da cobrança, em centavos."},"forma_pagamento":{"type":["string","null"],"description":"Forma de pagamento (boleto, pix, cartão)."},"status":{"type":["string","null"],"description":"Situação da cobrança, em texto livre (por exemplo pendente, pago, cancelada)."},"data_vencimento":{"type":["string","null"],"format":"date","description":"Data de vencimento (YYYY-MM-DD)."},"data_pagamento":{"type":["string","null"],"format":"date","description":"Data do pagamento (YYYY-MM-DD). Nula enquanto não paga."},"descricao":{"type":["string","null"],"description":"Descrição da cobrança."},"parcelas":{"type":["integer","null"],"description":"Número de parcelas."},"contrato_id":{"type":["string","null"],"format":"uuid","description":"Contrato de origem, quando houver."},"fatura_id":{"type":["string","null"],"format":"uuid","description":"Fatura de origem (recurso faturas), quando houver."},"recorrencia_id":{"type":["integer","null"],"description":"Recorrência que gerou a cobrança, quando houver."},"valor_liquido_centavos":{"type":["integer","null"],"description":"Valor líquido depois da taxa do gateway, em centavos."},"taxa_gateway_centavos":{"type":["integer","null"],"description":"Taxa cobrada pelo gateway de pagamento, em centavos."},"atualizado_em":{"type":["string","null"],"format":"date-time","description":"Última alteração da cobrança. Base do filtro atualizado_desde."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando a cobrança foi criada."}}},"FinanceiroCobrancasLista":{"type":"object","description":"Uma página de cobranças.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroCobrancas"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}},"FinanceiroTransferencias":{"type":"object","description":"Transferências entre contas. Os pares de movimentação entre duas contas. Os dois lados já estão em transacoes: não some este recurso com transacoes. Todo campo vem sempre na resposta; o que não tem valor vem nulo.","required":["id","conta_origem_id","conta_destino_id","valor_centavos","data_transferencia","descricao","transacao_saida_id","transacao_entrada_id","criado_em"],"properties":{"id":{"type":"integer","description":"Identificador do registro (inteiro)."},"conta_origem_id":{"type":["integer","null"],"description":"Conta de onde o dinheiro saiu (recurso contas)."},"conta_destino_id":{"type":["integer","null"],"description":"Conta para onde o dinheiro foi (recurso contas)."},"valor_centavos":{"type":["integer","null"],"description":"Valor transferido, em centavos."},"data_transferencia":{"type":["string","null"],"format":"date","description":"Data da transferência (YYYY-MM-DD)."},"descricao":{"type":["string","null"],"description":"Descrição livre."},"transacao_saida_id":{"type":["string","null"],"format":"uuid","description":"Lançamento de saída na conta de origem (recurso transacoes)."},"transacao_entrada_id":{"type":["string","null"],"format":"uuid","description":"Lançamento de entrada na conta de destino (recurso transacoes)."},"criado_em":{"type":["string","null"],"format":"date-time","description":"Quando a transferência foi registrada."}}},"FinanceiroTransferenciasLista":{"type":"object","description":"Uma página de transferências entre contas.","required":["dados","proximo_cursor"],"properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/FinanceiroTransferencias"}},"proximo_cursor":{"type":["string","null"],"description":"Cursor opaco da próxima página, para enviar sem alterar no parâmetro cursor. Nulo quando esta é a última página."}}}}},"externalDocs":{"description":"Documentação completa da API pública","url":"https://sstflix.com.br/docs/api"}}