OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Painel do Contador · Fechamento

Guias de impostos e bloqueio de período

POSThttps://app.omie.com.br/api/v1/contador/fechamento/WSDL
1consulta
3alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

GuiaImpArmazenar

altera dadosClaudeMCP

Armazena as Guias para Pagamento dos Impostos

Obrigatórios 1

CampoTipoDescrição
layouttextoCódigo do layout contábil (ver ListarLayoutContabil), ex. "SCI1". Aceita também o código sem o número final (SCI vira SCI1). Obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
guiaslista de objetosGuia de Imposto
guias[].chave_nfetexto · até 44Chave de Acesso da Nota Fiscal Eletrônica relacionada
guias[].cnpj_cpf_cliente_fornecedortexto · até 20CNPJ/CPF do fornecedor, usado quando o código não é informado. Precisa já estar cadastrado.
guias[].codigo_cliente_fornecedornúmero inteiroCódigo do fornecedor (cliente/fornecedor) no Omie. Informe este ou o CNPJ/CPF.
guias[].codigo_integracaoobrigatóriotexto · até 60Código de integração da guia (chave da guia no seu sistema). Obrigatório.
guias[].codigo_receitatexto · até 70Código de Receita da Guia de Recolhimento
guias[].data_emissaotexto · até 10Data de emissão da guia, no formato AAAAMMDD. Obrigatória. Um único valor, não uma lista.
guias[].data_entradaobrigatóriotexto · até 10Data de entrada (registro) da guia, no formato AAAAMMDD. Obrigatória. Define o mês do lote contábil em que a guia é anexada.
guias[].data_previsaotexto · até 10Data de previsão de pagamento, no formato AAAAMMDD. Sem preenchimento, é o vencimento levado para o próximo dia útil.
guias[].data_vencimentoobrigatóriotexto · até 10Data de vencimento da guia, no formato AAAAMMDD. Obrigatória.
guias[].file_base64obrigatóriotextoArquivo com a guia codificado em base64 (PDF ou imagem). Obrigatório.
guias[].file_nameobrigatóriotextoNome do arquivo com a guia de pagamento, com extensão (ex. das-202501.pdf). Obrigatório.
guias[].numero_documentotexto · até 20Número do Documento da Conta a Pagar
guias[].numero_documento_fiscaltexto · até 20Número do Documento Fiscal relacionado
guias[].observacaotextoObservações da Conta a Pagar
guias[].tipo_guiaobrigatóriotexto · até 20Tipo da guia. Obrigatório. Ex.: "DAS", "ICMS", "ICMS_ST", "IPI", "PIS", "COFINS", "CSLL", "PCC", "IRPJ", "IRRF", "ISS", "CPRB", "GARE_SP" (e demais guias estaduais), "BOL" (boleto) ou "FAT" (fatura).
guias[].valor_documentoobrigatórionúmeroValor líquido para pagamento da guia. Obrigatório e maior que zero.
modulotextoTexto livre que identifica o módulo do sistema contábil de origem (ex. "Fiscal"). Usado depois como filtro em GuiaImpListar.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
layouttextoCódigo do layout contábil usado.
modulotextoMódulo do sistema informado na requisição.
resultlista de objetosResultado de cada guia recebida, com os dados enviados e o status.
result[].cCodStatustextoCódigo do status. "0" guia criada, "1" guia atualizada; outro valor é o código do erro.
result[].cDesStatustextoDescrição do Status
result[].chave_nfetextoChave de Acesso da Nota Fiscal Eletrônica relacionada
result[].cnpj_cpf_cliente_fornecedortextoCNPJ/CPF do Cliente ou Fornecedor
result[].codigo_cliente_fornecedornúmero inteiroCódigo do Cliente ou Fornecedor no Omie
result[].codigo_integracaotextoCódigo de Integração da Guia
result[].codigo_receitatextoCódigo de Receita da Guia de Recolhimento
result[].data_emissaotextoData de Emissão da Guia (AAAAMMDD)
result[].data_entradatextoData de Entrada da Guia (AAAAMMDD)
result[].data_previsaotextoData de Previsão de Pagamento da Guia (AAAAMMDD)
result[].data_vencimentotextoData de Vencimento da Guia (AAAAMMDD)
result[].file_nametextoNome do arquivo com a guia de pagamento
result[].numero_documentotextoNúmero do Documento da Conta a Pagar
result[].numero_documento_fiscaltextoNúmero do Documento Fiscal relacionado
result[].observacaotextoObservações da Conta a Pagar
result[].statustextoSituação do processamento da guia. "OK" - Guia processada. "ERROR" - Guia recusada; o motivo está em cDesStatus.
result[].tipo_guiatextoTipo da Guia na Tabela de Impostos
result[].valor_documentodecimalValor Líquido para Pagamento da Guia
timeElapsedtextoTempo de processamento da requisição.
POST /api/v1/contador/fechamento/
curl -s https://app.omie.com.br/api/v1/contador/fechamento/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "GuiaImpArmazenar", "param": [{"layout": "SCI1", "modulo": "Fiscal", "guias": [{"tipo_guia": "DAS", "codigo_receita": "", "codigo_integracao": "DAS-202501", "data_emissao": "20250210", "data_entrada": "20250131", "codigo_cliente_fornecedor": 0, "cnpj_cpf_cliente_fornecedor": "00.394.460/0058-87", "data_vencimento": "20250220", "data_previsao": "", "valor_documento": 1532.47, "numero_documento": "DAS 01/2025", "numero_documento_fiscal": "", "chave_nfe": "", "observacao": "Simples Nacional competência 01/2025", "file_name": "das-202501.pdf", "file_base64": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggNiAwIFI+PgpzdHJlYW0K"}]}]}'

GuiaImpListar

consultaClaudeMCP

Listar Guias.

Obrigatórios 1

CampoTipoDescrição
layouttextoCódigo do layout contábil em que as guias foram enviadas (ex. "SCI1"). Obrigatório.
Opcionais 16Campos e estruturas que você pode enviar
CampoTipoDescrição
cOrdemDecrescentetexto · até 1Ordem decrescente - "S" ou "N". Padrão "N".
cOrdenarPortexto · até 100Ordenar por: "CODIGO_INTEGRACAO", "DATA_EMISSAO", "DATA_VENCIMENTO" ou "DATA_PAGAMENTO". Obrigatório na prática: sem ele a chamada é recusada.
cStatustexto · até 100Situação da conta a pagar da guia: "LIQUIDADO", "VENCEHOJE", "AVENCER" ou "ATRASADO". Vence hoje, a vencer e atrasado comparam a data de previsão com hoje.
dDtEmisAtetexto · até 10Data de emissão final (dd/mm/aaaa).
dDtEmisDetexto · até 10Data de emissão inicial (dd/mm/aaaa). Um único valor, não uma lista.
dDtPagtoAtetexto · até 10Data de pagamento final (dd/mm/aaaa).
dDtPagtoDetexto · até 10Data de pagamento inicial (dd/mm/aaaa).
dDtPrevAtetexto · até 10Data de previsão de pagamento final (dd/mm/aaaa).
dDtPrevDetexto · até 10Data de previsão de pagamento inicial (dd/mm/aaaa).
dDtRegAtetexto · até 10Data de registro (entrada) final (dd/mm/aaaa).
dDtRegDetexto · até 10Data de registro (entrada) inicial (dd/mm/aaaa).
dDtVencAtetexto · até 10Data de vencimento final (dd/mm/aaaa).
dDtVencDetexto · até 10Data de vencimento inicial (dd/mm/aaaa).
modulotextoFiltra pelo módulo informado no envio da guia. Sem preenchimento, traz todos.
nPaginanúmero inteiroNúmero da página a retornar. Padrão 1.
nRegPorPaginanúmero inteiroNúmero de registros por página. Padrão 100, máximo 100.
Retorno 6O que volta numa chamada bem-sucedida
CampoTipoDescrição
guiaslista de objetosGuias de impostos encontradas, com a situação da conta a pagar.
guias[].chave_nfetextoChave de acesso da NF-e relacionada.
guias[].cnpj_cpf_cliente_fornecedortextoCNPJ/CPF do fornecedor.
guias[].codigo_cliente_fornecedornúmero inteiroCódigo do fornecedor no Omie.
guias[].codigo_integracaotextoCódigo de integração da guia.
guias[].codigo_receitatextoCódigo de receita da guia de recolhimento.
guias[].conta_contabilobjetoConta do plano contábil configurada para a categoria da conta a pagar. Vem vazia sem configuração.
guias[].conta_contabil.classificacaotextoClassificação da conta contábil.
guias[].conta_contabil.cod_reduzidotextoCódigo reduzido da conta contábil.
guias[].conta_contabil.descricaotextoDescrição da conta contábil.
guias[].data_emissaotextoData de emissão da guia (AAAAMMDD). Um único valor, não uma lista.
guias[].data_entradatextoData de entrada (registro) da guia (AAAAMMDD).
guias[].data_pagamentotextoData do pagamento (AAAAMMDD). Vazio se não foi paga.
guias[].data_previsaotextoData de previsão de pagamento (AAAAMMDD).
guias[].data_vencimentotextoData de vencimento (AAAAMMDD).
guias[].descontodecimalDesconto obtido.
guias[].jurosdecimalJuros pagos.
guias[].liquidadotextoIndica se a conta a pagar da guia está liquidada - "S" ou "N".
guias[].multadecimalMulta paga.
guias[].numero_documentotextoNúmero do documento da conta a pagar.
guias[].numero_documento_fiscaltextoNúmero do documento fiscal relacionado.
guias[].tipo_guiatextoTipo da guia (ex. DAS, ICMS, IRRF).
guias[].valor_documentodecimalValor da guia.
guias[].valor_pagodecimalValor pago.
nPaginanúmero inteiroNúmero da página retornada.
nRegistrosnúmero inteiroNúmero de registros retornados nesta página.
nTotPaginasnúmero inteiroNúmero total de páginas.
nTotRegistrosnúmero inteiroTotal de registros encontrados.
timeElapsedtextoTempo de processamento da requisição.
POST /api/v1/contador/fechamento/
curl -s https://app.omie.com.br/api/v1/contador/fechamento/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "GuiaImpListar", "param": [{"nPagina": 1, "nRegPorPagina": 20, "layout": "SCI1", "cOrdenarPor": "DATA_EMISSAO"}]}'

PeriodoBloquear

altera dadosClaudeMCP

Bloqueia um período do fechamento contábil.

Obrigatórios 2

CampoTipoDescrição
nAnonúmero inteiroAno do período (4 dígitos). Obrigatório.
nMesnúmero inteiroMês do período (1 a 12). Obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
nQuinzenanúmero inteiroQuinzena do mês (1 ou 2). Obrigatória quando o período contábil do aplicativo é quinzenal; ignorada nos demais.
nSemananúmero inteiroSemana do mês (1 a 5). Obrigatória quando o período contábil do aplicativo é semanal; ignorada nos demais.
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do status. "0" indica sucesso.
cDescStatustextoDescrição do status.
POST /api/v1/contador/fechamento/
curl -s https://app.omie.com.br/api/v1/contador/fechamento/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "PeriodoBloquear", "param": [{"nAno": 2025, "nMes": 1, "nSemana": 0, "nQuinzena": 0}]}'

PeriodoDesbloquear

altera dadosClaudeMCP

Desbloqueia um período do fechamento contábil.

Obrigatórios 2

CampoTipoDescrição
nAnonúmero inteiroAno do período (4 dígitos). Obrigatório.
nMesnúmero inteiroMês do período (1 a 12). Obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
nQuinzenanúmero inteiroQuinzena do mês (1 ou 2). Obrigatória quando o período contábil do aplicativo é quinzenal; ignorada nos demais.
nSemananúmero inteiroSemana do mês (1 a 5). Obrigatória quando o período contábil do aplicativo é semanal; ignorada nos demais.
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do status. "0" indica sucesso.
cDescStatustextoDescrição do status.
POST /api/v1/contador/fechamento/
curl -s https://app.omie.com.br/api/v1/contador/fechamento/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "PeriodoDesbloquear", "param": [{"nAno": 2025, "nMes": 1, "nSemana": 0, "nQuinzena": 0}]}'