OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Finanças · LancamentoContaPagar

Lançamento de Contas a Pagar

POSThttps://app.omie.com.br/api/v1/financas/contapagar/WSDL
2consultas
8alterações
Claude 10 de 10 · ChatGPT 5 de 10 · MCP 10 de 10pelos assistentes de IA
JSON · XMLformato

AlterarContaPagar

altera dadosClaudeChatGPTMCP

Altera uma conta a pagar

Obrigatórios 1

CampoTipoDescrição
pagamentoobjetoDetalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag "baixar_documento" com "S" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba "Pagamentos" no cadastro do lançamento.
pagamento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
pagamento.codigo_pagamento_integracaotexto · até 20
pagamento.datatexto · até 10Data da Baixa
pagamento.descontonúmeroValor do desconto.
pagamento.jurosnúmeroValor do Juros.
pagamento.multanúmeroValor da multa.
pagamento.observacaotextoObservação da Baixa do Contas a Receber.
pagamento.valornúmeroValor a ser baixado.
Opcionais 47Campos e estruturas que você pode enviar
CampoTipoDescrição
aprendizado_rateiotexto · até 1Aprendizado de rateio de departamento. Preencher com "S" ou "N". Default "N" Quando essa tag for preenchida com "S" será assumido o rateio de departamento para a categoria informada na tag "codigo_categoria". Essa tag é utilizada apenas nos métodos de inclusão e alteração.
baixar_documentotexto · até 1Efetua a baixa automática do documento.
bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
categoriaslista de objetos
categorias[].codigo_categoriatexto · até 20
categorias[].percentualnúmeroPercentual da categoria
categorias[].valornúmero
chave_nfetexto · até 44Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar.
cnab_integracao_bancariaobjetoDados do CNAB e Integração Bancária.
cnab_integracao_bancaria.agencia_transferenciatexto · até 10Número da Agência para Transferência Bancária.
cnab_integracao_bancaria.banco_transferenciatexto · até 3Código do Banco para Transferência Bancária.
cnab_integracao_bancaria.codigo_barras_boletotexto · até 70Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)
cnab_integracao_bancaria.codigo_forma_pagamentotexto · até 3Código da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code.
cnab_integracao_bancaria.conta_corrente_transferenciatexto · até 25Número da Conta Corrente para Transferência Bancária.
cnab_integracao_bancaria.cpf_cnpj_transferenciatexto · até 20CNPJ ou CPF do Titular.
cnab_integracao_bancaria.finalidade_transferenciaobrigatóriotexto · até 10Finalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag ["id_conta_corrente"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag "pix_qrcode") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros
cnab_integracao_bancaria.juros_boletonúmeroPercentual de Juros ao Mês do Boleto.
cnab_integracao_bancaria.multa_boletonúmeroPercentual de Multa por Atraso do Boleto.
cnab_integracao_bancaria.nome_transferenciatexto · até 60Nome do Titular da Conta Corrente.
cnab_integracao_bancaria.pix_qrcodetexto · até 300QR Code do PIX.
codigo_barras_ficha_compensacaotexto · até 70Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_categoriatexto · até 20Código da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
codigo_cliente_fornecedornúmero inteiroCódigo do Favorecido / Fornecedor. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação.
codigo_cliente_fornecedor_integracaotexto · até 60Código de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente_omie".
codigo_lancamento_integracaotexto · até 60Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_projetonúmero inteiroCódigo do Projeto. Informação localizada na Aba "Detalhes" do Contas a Pagar. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação.
codigo_tipo_documentotexto · até 5Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_vendedornúmero inteiroCódigo do Vendedor. Informação localizada na Aba "Diversos" do Contas a Pagar. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação.
conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N.
data_emissaotexto · até 10Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_entradatexto · até 10Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_previsaotexto · até 10Data da Previsão de Pagamento. Utilize o formato "dd/mm/aaaa". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente.
data_vencimentotexto · até 10Data de Vencimento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente.
distribuicaolista de objetosDistribuição por Departamentos.
distribuicao[].cCodDeptexto · até 40Código do Departamento
distribuicao[].cDesDeptexto · até 50Descrição do Departamento
distribuicao[].nPerDepnúmeroPercentual do rateio
distribuicao[].nValDepnúmeroValor do rateio
id_conta_correntenúmero inteiroCódigo da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Pagar. Os valores disponíveis são: "APIP" - Integração de Conta a Pagar "BARP" - Conta a Pagar Importada por Código de Barras "COMP" - Parcela a Pagar de Compras "CTEP" - Parcela a Pagar de um CT-e "DEVP" - Conta a Pagar da Devolução de Venda "IMPP" - Parcela a Pagar de uma Nota de Importação "MANP" - Lançamento Manual de Conta a Pagar "NFEP" - Conta a Pagar Importada de uma NF-e "RPTP" - Repetição de Contas a Pagar "XMLP" - Conta a Pagar Importada de um arquivo XML
infoobjetoInformações complemetares do cadastro do produto.
info.cImpAPItexto · até 1Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração.
info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
info.uAlttexto · até 10Usuário da Alteração. Não deve ser informado na Inclusão/Alteração.
info.uInctexto · até 10Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
nsutexto · até 100DEPRECATED.
numero_documentotexto · até 20Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_documento_fiscaltexto · até 20Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar.
numero_parcelatexto · até 7Número da parcela. Utilizar o formato "999/999". Para 1 parcela utilize "001/001" Se não informado assumirá o valor "001/001". Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_pedidotexto · até 15Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar.
observacaotextoObservações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
operacaotexto · até 2Código da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: "01" - Venda de Serviço "11" - Venda de Produto "12" - Venda de Produto pelo PDV "13" - Devolução de Venda "14" - Remessa de Produto "16" - Nota Complementar de Saída
retem_cofinstexto · até 1Reter COFINS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_cslltexto · até 1Reter CSLL. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_insstexto · até 1Reter INSS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_irtexto · até 1Reter IR. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_isstexto · até 1Reter ISS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_pistexto · até 1Reter PIS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
servico_tomadoobjeto
servico_tomado.aliquota_cofinsnúmeroAlíquota do COFINS (%).
servico_tomado.aliquota_pisnúmeroAlíquota do PIS (%).
servico_tomado.base_cofinsnúmeroBase de cálculo do COFINS.
servico_tomado.base_pisnúmeroBase de cálculo do PIS.
servico_tomado.codigo_servicotexto · até 10Código do serviço (LC116).
servico_tomado.cst_cofinstexto · até 2CST do COFINS (Código da Situação Tributária).
servico_tomado.cst_pistexto · até 2CST do PIS (Código da Situação Tributária).
servico_tomado.numero_nftexto · até 20Número da Nota Fiscal.
servico_tomado.serie_nftexto · até 20Série da Nota Fiscal.
servico_tomado.valor_cofinsnúmeroValor do PIS.
servico_tomado.valor_nfnúmeroValor total da Nota Fiscal.
servico_tomado.valor_pisnúmeroValor do PIS.
status_titulotexto · até 3Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar.
valor_cofinsnúmeroValor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_csllnúmeroValor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_documentonúmeroValor da Conta.
valor_inssnúmeroValor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_irnúmeroValor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_issnúmeroValor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_pagnúmeroValor a pagar. Disponível apenas para os métodos de consulta e listagem.
valor_pisnúmeroValor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
Descontinuados 6Ainda aceitos, fora do fluxo principal
CampoTipoDescrição
acaodescontinuadotextoDEPRECATED
baixa_bloqueadadescontinuadotexto · até 1DEPRECATED
bloqueadodescontinuadotexto · até 1DEPRECATED
codigo_cmc7_chequedescontinuadotexto · até 40DEPRECATED
id_conta_corrente_integracaodescontinuadotexto · até 20DEPRECATED
importado_apidescontinuadotexto · até 1DEPRECATED
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_statustextoCódigo do Status de Processamento. Quando retornar 0 (zero) indica que o processamento foi executado com sucesso. Qualquer outro valor maior que 0 (zero) indica que ocorreu uma falha durante o processo de validação dos dados.
descricao_statustextoDescrição do Status de Processamento. Descreve o resultado do processando, de acordo com o código de status retornado.
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarContaPagar", "param": [{"codigo_lancamento_integracao": "1790774898", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "2.04.01", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}'

CancelarPagamento

altera dadosClaudeMCP

Cancela um pagamento realizado no Contas a Pagar

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo para identificar a baixa do título no Contas a Pagar.
codigo_baixa_integracaotexto · até 20Código da baixa do integrador para identificar a baixa de um título do contas a pagar.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo para identificar a baixa do título no Contas a Pagar.
codigo_baixa_integracaotextoCódigo da baixa do integrador para identificar a baixa de um título do contas a pagar.
codigo_statustextoCódigo do Status da baixa do contas a pagar.
descricao_statustextoDescrição do Status da baixa do contas a pagar.
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarPagamento", "param": [{"codigo_baixa": 0}]}'

ConsultarContaPagar

consultaClaudeChatGPTMCP

Consulta uma conta a pagar

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_lancamento_integracaotexto · até 60Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
Retorno 54O que volta numa chamada bem-sucedida
CampoTipoDescrição
acaotextoDEPRECATED
aprendizado_rateiotextoAprendizado de rateio de departamento. Preencher com "S" ou "N". Default "N" Quando essa tag for preenchida com "S" será assumido o rateio de departamento para a categoria informada na tag "codigo_categoria". Essa tag é utilizada apenas nos métodos de inclusão e alteração.
baixa_bloqueadatextoDEPRECATED
baixar_documentotextoEfetua a baixa automática do documento.
bloqueadotextoDEPRECATED
bloquear_exclusaotextoBloqueia a exclusão do registro. (S/N)
categoriaslista de objetos
categorias[].codigo_categoriatexto
categorias[].percentualdecimalPercentual da categoria
categorias[].valordecimal
chave_nfetextoChave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar.
cnab_integracao_bancariaobjetoDados do CNAB e Integração Bancária.
cnab_integracao_bancaria.agencia_transferenciatextoNúmero da Agência para Transferência Bancária.
cnab_integracao_bancaria.banco_transferenciatextoCódigo do Banco para Transferência Bancária.
cnab_integracao_bancaria.codigo_barras_boletotextoCódigo de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)
cnab_integracao_bancaria.codigo_forma_pagamentotextoCódigo da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code.
cnab_integracao_bancaria.conta_corrente_transferenciatextoNúmero da Conta Corrente para Transferência Bancária.
cnab_integracao_bancaria.cpf_cnpj_transferenciatextoCNPJ ou CPF do Titular.
cnab_integracao_bancaria.finalidade_transferenciatextoFinalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag ["id_conta_corrente"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag "pix_qrcode") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros
cnab_integracao_bancaria.juros_boletodecimalPercentual de Juros ao Mês do Boleto.
cnab_integracao_bancaria.multa_boletodecimalPercentual de Multa por Atraso do Boleto.
cnab_integracao_bancaria.nome_transferenciatextoNome do Titular da Conta Corrente.
cnab_integracao_bancaria.pix_qrcodetextoQR Code do PIX.
codigo_barras_ficha_compensacaotextoCódigo de Barras Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_categoriatextoCódigo da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
codigo_cliente_fornecedornúmero inteiroCódigo do Favorecido / Fornecedor. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação.
codigo_cliente_fornecedor_integracaotextoCódigo de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente_omie".
codigo_cmc7_chequetextoDEPRECATED
codigo_lancamento_integracaotextoCódigo de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_projetonúmero inteiroCódigo do Projeto. Informação localizada na Aba "Detalhes" do Contas a Pagar. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação.
codigo_tipo_documentotextoCódigo do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_vendedornúmero inteiroCódigo do Vendedor. Informação localizada na Aba "Diversos" do Contas a Pagar. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação.
conciliar_documentotextoEfetua a conciliação do documento automaticamente. Opcional. Preencher com S/N.
data_emissaotextoData de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_entradatextoData de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_previsaotextoData da Previsão de Pagamento. Utilize o formato "dd/mm/aaaa". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente.
data_vencimentotextoData de Vencimento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente.
distribuicaolista de objetosDistribuição por Departamentos.
distribuicao[].cCodDeptextoCódigo do Departamento
distribuicao[].cDesDeptextoDescrição do Departamento
distribuicao[].nPerDepdecimalPercentual do rateio
distribuicao[].nValDepdecimalValor do rateio
id_conta_correntenúmero inteiroCódigo da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
id_conta_corrente_integracaotextoDEPRECATED
id_origemtextoCódigo da Origem. Informação localizada na Aba "Diversos" do Contas a Pagar. Os valores disponíveis são: "APIP" - Integração de Conta a Pagar "BARP" - Conta a Pagar Importada por Código de Barras "COMP" - Parcela a Pagar de Compras "CTEP" - Parcela a Pagar de um CT-e "DEVP" - Conta a Pagar da Devolução de Venda "IMPP" - Parcela a Pagar de uma Nota de Importação "MANP" - Lançamento Manual de Conta a Pagar "NFEP" - Conta a Pagar Importada de uma NF-e "RPTP" - Repetição de Contas a Pagar "XMLP" - Conta a Pagar Importada de um arquivo XML
importado_apitextoDEPRECATED
infoobjetoInformações complemetares do cadastro do produto.
info.cImpAPItextoImportado pela API (S/N). Não deve ser informado na Inclusão/Alteração.
info.dAlttextoData da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
info.dInctextoData da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
info.hAlttextoHora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
info.hInctextoHora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
info.uAlttextoUsuário da Alteração. Não deve ser informado na Inclusão/Alteração.
info.uInctextoUsuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
nsutextoDEPRECATED.
numero_documentotextoNúmero do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_documento_fiscaltextoNúmero da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar.
numero_parcelatextoNúmero da parcela. Utilizar o formato "999/999". Para 1 parcela utilize "001/001" Se não informado assumirá o valor "001/001". Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_pedidotextoNúmero do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar.
observacaotextoObservações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
operacaotextoCódigo da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: "01" - Venda de Serviço "11" - Venda de Produto "12" - Venda de Produto pelo PDV "13" - Devolução de Venda "14" - Remessa de Produto "16" - Nota Complementar de Saída
pagamentoobjetoDetalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag "baixar_documento" com "S" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba "Pagamentos" no cadastro do lançamento.
pagamento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
pagamento.codigo_pagamento_integracaotexto
pagamento.datatextoData da Baixa
pagamento.descontodecimalValor do desconto.
pagamento.jurosdecimalValor do Juros.
pagamento.multadecimalValor da multa.
pagamento.observacaotextoObservação da Baixa do Contas a Receber.
pagamento.valordecimalValor a ser baixado.
retem_cofinstextoReter COFINS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_cslltextoReter CSLL. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_insstextoReter INSS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_irtextoReter IR. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_isstextoReter ISS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_pistextoReter PIS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
servico_tomadoobjeto
servico_tomado.aliquota_cofinsdecimalAlíquota do COFINS (%).
servico_tomado.aliquota_pisdecimalAlíquota do PIS (%).
servico_tomado.base_cofinsdecimalBase de cálculo do COFINS.
servico_tomado.base_pisdecimalBase de cálculo do PIS.
servico_tomado.codigo_servicotextoCódigo do serviço (LC116).
servico_tomado.cst_cofinstextoCST do COFINS (Código da Situação Tributária).
servico_tomado.cst_pistextoCST do PIS (Código da Situação Tributária).
servico_tomado.numero_nftextoNúmero da Nota Fiscal.
servico_tomado.serie_nftextoSérie da Nota Fiscal.
servico_tomado.valor_cofinsdecimalValor do PIS.
servico_tomado.valor_nfdecimalValor total da Nota Fiscal.
servico_tomado.valor_pisdecimalValor do PIS.
status_titulotextoStatus do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar.
valor_cofinsdecimalValor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_cslldecimalValor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_documentodecimalValor da Conta.
valor_inssdecimalValor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_irdecimalValor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_issdecimalValor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_pagdecimalValor a pagar. Disponível apenas para os métodos de consulta e listagem.
valor_pisdecimalValor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarContaPagar", "param": [{"codigo_lancamento_omie": 0, "codigo_lancamento_integracao": ""}]}'

ExcluirContaPagar

altera dadosClaudeChatGPTMCP

Exclui uma conta a pagar

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_lancamento_integracaotexto · até 60Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_statustextoCódigo do Status de Processamento. Quando retornar 0 (zero) indica que o processamento foi executado com sucesso. Qualquer outro valor maior que 0 (zero) indica que ocorreu uma falha durante o processo de validação dos dados.
descricao_statustextoDescrição do Status de Processamento. Descreve o resultado do processando, de acordo com o código de status retornado.
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirContaPagar", "param": [{"codigo_lancamento_omie": 0, "codigo_lancamento_integracao": ""}]}'

IncluirContaPagar

altera dadosClaudeChatGPTMCP

Inclui uma conta a Pagar.

Obrigatórios 4

CampoTipoDescrição
codigo_lancamento_integracaotexto · até 60Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
data_vencimentotexto · até 10Data de Vencimento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente.
pagamentoobjetoDetalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag "baixar_documento" com "S" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba "Pagamentos" no cadastro do lançamento.
pagamento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
pagamento.codigo_pagamento_integracaotexto · até 20
pagamento.datatexto · até 10Data da Baixa
pagamento.descontonúmeroValor do desconto.
pagamento.jurosnúmeroValor do Juros.
pagamento.multanúmeroValor da multa.
pagamento.observacaotextoObservação da Baixa do Contas a Receber.
pagamento.valornúmeroValor a ser baixado.
valor_documentonúmeroValor da Conta.
Opcionais 44Campos e estruturas que você pode enviar
CampoTipoDescrição
aprendizado_rateiotexto · até 1Aprendizado de rateio de departamento. Preencher com "S" ou "N". Default "N" Quando essa tag for preenchida com "S" será assumido o rateio de departamento para a categoria informada na tag "codigo_categoria". Essa tag é utilizada apenas nos métodos de inclusão e alteração.
baixar_documentotexto · até 1Efetua a baixa automática do documento.
bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
categoriaslista de objetos
categorias[].codigo_categoriatexto · até 20
categorias[].percentualnúmeroPercentual da categoria
categorias[].valornúmero
chave_nfetexto · até 44Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar.
cnab_integracao_bancariaobjetoDados do CNAB e Integração Bancária.
cnab_integracao_bancaria.agencia_transferenciatexto · até 10Número da Agência para Transferência Bancária.
cnab_integracao_bancaria.banco_transferenciatexto · até 3Código do Banco para Transferência Bancária.
cnab_integracao_bancaria.codigo_barras_boletotexto · até 70Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)
cnab_integracao_bancaria.codigo_forma_pagamentotexto · até 3Código da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code.
cnab_integracao_bancaria.conta_corrente_transferenciatexto · até 25Número da Conta Corrente para Transferência Bancária.
cnab_integracao_bancaria.cpf_cnpj_transferenciatexto · até 20CNPJ ou CPF do Titular.
cnab_integracao_bancaria.finalidade_transferenciaobrigatóriotexto · até 10Finalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag ["id_conta_corrente"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag "pix_qrcode") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros
cnab_integracao_bancaria.juros_boletonúmeroPercentual de Juros ao Mês do Boleto.
cnab_integracao_bancaria.multa_boletonúmeroPercentual de Multa por Atraso do Boleto.
cnab_integracao_bancaria.nome_transferenciatexto · até 60Nome do Titular da Conta Corrente.
cnab_integracao_bancaria.pix_qrcodetexto · até 300QR Code do PIX.
codigo_barras_ficha_compensacaotexto · até 70Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_categoriatexto · até 20Código da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
codigo_cliente_fornecedornúmero inteiroCódigo do Favorecido / Fornecedor. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação.
codigo_cliente_fornecedor_integracaotexto · até 60Código de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente_omie".
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_projetonúmero inteiroCódigo do Projeto. Informação localizada na Aba "Detalhes" do Contas a Pagar. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação.
codigo_tipo_documentotexto · até 5Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_vendedornúmero inteiroCódigo do Vendedor. Informação localizada na Aba "Diversos" do Contas a Pagar. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação.
conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N.
data_emissaotexto · até 10Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_entradatexto · até 10Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_previsaotexto · até 10Data da Previsão de Pagamento. Utilize o formato "dd/mm/aaaa". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente.
distribuicaolista de objetosDistribuição por Departamentos.
distribuicao[].cCodDeptexto · até 40Código do Departamento
distribuicao[].cDesDeptexto · até 50Descrição do Departamento
distribuicao[].nPerDepnúmeroPercentual do rateio
distribuicao[].nValDepnúmeroValor do rateio
id_conta_correntenúmero inteiroCódigo da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Pagar. Os valores disponíveis são: "APIP" - Integração de Conta a Pagar "BARP" - Conta a Pagar Importada por Código de Barras "COMP" - Parcela a Pagar de Compras "CTEP" - Parcela a Pagar de um CT-e "DEVP" - Conta a Pagar da Devolução de Venda "IMPP" - Parcela a Pagar de uma Nota de Importação "MANP" - Lançamento Manual de Conta a Pagar "NFEP" - Conta a Pagar Importada de uma NF-e "RPTP" - Repetição de Contas a Pagar "XMLP" - Conta a Pagar Importada de um arquivo XML
infoobjetoInformações complemetares do cadastro do produto.
info.cImpAPItexto · até 1Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração.
info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
info.uAlttexto · até 10Usuário da Alteração. Não deve ser informado na Inclusão/Alteração.
info.uInctexto · até 10Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
nsutexto · até 100DEPRECATED.
numero_documentotexto · até 20Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_documento_fiscaltexto · até 20Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar.
numero_parcelatexto · até 7Número da parcela. Utilizar o formato "999/999". Para 1 parcela utilize "001/001" Se não informado assumirá o valor "001/001". Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_pedidotexto · até 15Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar.
observacaotextoObservações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
operacaotexto · até 2Código da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: "01" - Venda de Serviço "11" - Venda de Produto "12" - Venda de Produto pelo PDV "13" - Devolução de Venda "14" - Remessa de Produto "16" - Nota Complementar de Saída
retem_cofinstexto · até 1Reter COFINS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_cslltexto · até 1Reter CSLL. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_insstexto · até 1Reter INSS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_irtexto · até 1Reter IR. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_isstexto · até 1Reter ISS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_pistexto · até 1Reter PIS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
servico_tomadoobjeto
servico_tomado.aliquota_cofinsnúmeroAlíquota do COFINS (%).
servico_tomado.aliquota_pisnúmeroAlíquota do PIS (%).
servico_tomado.base_cofinsnúmeroBase de cálculo do COFINS.
servico_tomado.base_pisnúmeroBase de cálculo do PIS.
servico_tomado.codigo_servicotexto · até 10Código do serviço (LC116).
servico_tomado.cst_cofinstexto · até 2CST do COFINS (Código da Situação Tributária).
servico_tomado.cst_pistexto · até 2CST do PIS (Código da Situação Tributária).
servico_tomado.numero_nftexto · até 20Número da Nota Fiscal.
servico_tomado.serie_nftexto · até 20Série da Nota Fiscal.
servico_tomado.valor_cofinsnúmeroValor do PIS.
servico_tomado.valor_nfnúmeroValor total da Nota Fiscal.
servico_tomado.valor_pisnúmeroValor do PIS.
status_titulotexto · até 3Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar.
valor_cofinsnúmeroValor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_csllnúmeroValor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_inssnúmeroValor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_irnúmeroValor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_issnúmeroValor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_pagnúmeroValor a pagar. Disponível apenas para os métodos de consulta e listagem.
valor_pisnúmeroValor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
Descontinuados 6Ainda aceitos, fora do fluxo principal
CampoTipoDescrição
acaodescontinuadotextoDEPRECATED
baixa_bloqueadadescontinuadotexto · até 1DEPRECATED
bloqueadodescontinuadotexto · até 1DEPRECATED
codigo_cmc7_chequedescontinuadotexto · até 40DEPRECATED
id_conta_corrente_integracaodescontinuadotexto · até 20DEPRECATED
importado_apidescontinuadotexto · até 1DEPRECATED
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_statustextoCódigo do Status de Processamento. Quando retornar 0 (zero) indica que o processamento foi executado com sucesso. Qualquer outro valor maior que 0 (zero) indica que ocorreu uma falha durante o processo de validação dos dados.
descricao_statustextoDescrição do Status de Processamento. Descreve o resultado do processando, de acordo com o código de status retornado.
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirContaPagar", "param": [{"codigo_lancamento_integracao": "1790774898", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "2.04.01", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}'

IncluirContaPagarPorLote

altera dadosClaudeMCP

Inclusão do contas a pagar por lote

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
conta_pagar_cadastrolista de objetos
conta_pagar_cadastro[].acaodescontinuadotextoDEPRECATED
conta_pagar_cadastro[].aprendizado_rateiotexto · até 1Aprendizado de rateio de departamento. Preencher com "S" ou "N". Default "N" Quando essa tag for preenchida com "S" será assumido o rateio de departamento para a categoria informada na tag "codigo_categoria". Essa tag é utilizada apenas nos métodos de inclusão e alteração.
conta_pagar_cadastro[].baixa_bloqueadadescontinuadotexto · até 1DEPRECATED
conta_pagar_cadastro[].baixar_documentotexto · até 1Efetua a baixa automática do documento.
conta_pagar_cadastro[].bloqueadodescontinuadotexto · até 1DEPRECATED
conta_pagar_cadastro[].bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
conta_pagar_cadastro[].categoriaslista de objetos
conta_pagar_cadastro[].categorias[].codigo_categoriatexto · até 20
conta_pagar_cadastro[].categorias[].percentualnúmeroPercentual da categoria
conta_pagar_cadastro[].categorias[].valornúmero
conta_pagar_cadastro[].chave_nfetexto · até 44Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].cnab_integracao_bancariaobjetoDados do CNAB e Integração Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.agencia_transferenciatexto · até 10Número da Agência para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.banco_transferenciatexto · até 3Código do Banco para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_barras_boletotexto · até 70Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_forma_pagamentotexto · até 3Código da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code.
conta_pagar_cadastro[].cnab_integracao_bancaria.conta_corrente_transferenciatexto · até 25Número da Conta Corrente para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.cpf_cnpj_transferenciatexto · até 20CNPJ ou CPF do Titular.
conta_pagar_cadastro[].cnab_integracao_bancaria.finalidade_transferenciaobrigatóriotexto · até 10Finalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag ["id_conta_corrente"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag "pix_qrcode") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros
conta_pagar_cadastro[].cnab_integracao_bancaria.juros_boletonúmeroPercentual de Juros ao Mês do Boleto.
conta_pagar_cadastro[].cnab_integracao_bancaria.multa_boletonúmeroPercentual de Multa por Atraso do Boleto.
conta_pagar_cadastro[].cnab_integracao_bancaria.nome_transferenciatexto · até 60Nome do Titular da Conta Corrente.
conta_pagar_cadastro[].cnab_integracao_bancaria.pix_qrcodetexto · até 300QR Code do PIX.
conta_pagar_cadastro[].codigo_barras_ficha_compensacaotexto · até 70Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].codigo_categoriatexto · até 20Código da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
conta_pagar_cadastro[].codigo_cliente_fornecedornúmero inteiroCódigo do Favorecido / Fornecedor. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação.
conta_pagar_cadastro[].codigo_cliente_fornecedor_integracaotexto · até 60Código de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente_omie".
conta_pagar_cadastro[].codigo_cmc7_chequedescontinuadotexto · até 40DEPRECATED
conta_pagar_cadastro[].codigo_lancamento_integracaotexto · até 60Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
conta_pagar_cadastro[].codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
conta_pagar_cadastro[].codigo_projetonúmero inteiroCódigo do Projeto. Informação localizada na Aba "Detalhes" do Contas a Pagar. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação.
conta_pagar_cadastro[].codigo_tipo_documentotexto · até 5Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].codigo_vendedornúmero inteiroCódigo do Vendedor. Informação localizada na Aba "Diversos" do Contas a Pagar. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação.
conta_pagar_cadastro[].conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N.
conta_pagar_cadastro[].data_emissaotexto · até 10Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].data_entradatexto · até 10Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].data_previsaotexto · até 10Data da Previsão de Pagamento. Utilize o formato "dd/mm/aaaa". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente.
conta_pagar_cadastro[].data_vencimentotexto · até 10Data de Vencimento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente.
conta_pagar_cadastro[].distribuicaolista de objetosDistribuição por Departamentos.
conta_pagar_cadastro[].distribuicao[].cCodDeptexto · até 40Código do Departamento
conta_pagar_cadastro[].distribuicao[].cDesDeptexto · até 50Descrição do Departamento
conta_pagar_cadastro[].distribuicao[].nPerDepnúmeroPercentual do rateio
conta_pagar_cadastro[].distribuicao[].nValDepnúmeroValor do rateio
conta_pagar_cadastro[].id_conta_correntenúmero inteiroCódigo da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
conta_pagar_cadastro[].id_conta_corrente_integracaodescontinuadotexto · até 20DEPRECATED
conta_pagar_cadastro[].id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Pagar. Os valores disponíveis são: "APIP" - Integração de Conta a Pagar "BARP" - Conta a Pagar Importada por Código de Barras "COMP" - Parcela a Pagar de Compras "CTEP" - Parcela a Pagar de um CT-e "DEVP" - Conta a Pagar da Devolução de Venda "IMPP" - Parcela a Pagar de uma Nota de Importação "MANP" - Lançamento Manual de Conta a Pagar "NFEP" - Conta a Pagar Importada de uma NF-e "RPTP" - Repetição de Contas a Pagar "XMLP" - Conta a Pagar Importada de um arquivo XML
conta_pagar_cadastro[].importado_apidescontinuadotexto · até 1DEPRECATED
conta_pagar_cadastro[].infoobjetoInformações complemetares do cadastro do produto.
conta_pagar_cadastro[].info.cImpAPItexto · até 1Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.uAlttexto · até 10Usuário da Alteração. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.uInctexto · até 10Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].nsutexto · até 100DEPRECATED.
conta_pagar_cadastro[].numero_documentotexto · até 20Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].numero_documento_fiscaltexto · até 20Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].numero_parcelatexto · até 7Número da parcela. Utilizar o formato "999/999". Para 1 parcela utilize "001/001" Se não informado assumirá o valor "001/001". Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].numero_pedidotexto · até 15Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].observacaotextoObservações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].operacaotexto · até 2Código da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: "01" - Venda de Serviço "11" - Venda de Produto "12" - Venda de Produto pelo PDV "13" - Devolução de Venda "14" - Remessa de Produto "16" - Nota Complementar de Saída
conta_pagar_cadastro[].pagamentoobrigatórioobjetoDetalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag "baixar_documento" com "S" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba "Pagamentos" no cadastro do lançamento.
conta_pagar_cadastro[].pagamento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
conta_pagar_cadastro[].pagamento.codigo_pagamento_integracaotexto · até 20
conta_pagar_cadastro[].pagamento.datatexto · até 10Data da Baixa
conta_pagar_cadastro[].pagamento.descontonúmeroValor do desconto.
conta_pagar_cadastro[].pagamento.jurosnúmeroValor do Juros.
conta_pagar_cadastro[].pagamento.multanúmeroValor da multa.
conta_pagar_cadastro[].pagamento.observacaotextoObservação da Baixa do Contas a Receber.
conta_pagar_cadastro[].pagamento.valornúmeroValor a ser baixado.
conta_pagar_cadastro[].retem_cofinstexto · até 1Reter COFINS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_cslltexto · até 1Reter CSLL. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_insstexto · até 1Reter INSS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_irtexto · até 1Reter IR. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_isstexto · até 1Reter ISS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_pistexto · até 1Reter PIS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].servico_tomadoobjeto
conta_pagar_cadastro[].servico_tomado.aliquota_cofinsnúmeroAlíquota do COFINS (%).
conta_pagar_cadastro[].servico_tomado.aliquota_pisnúmeroAlíquota do PIS (%).
conta_pagar_cadastro[].servico_tomado.base_cofinsnúmeroBase de cálculo do COFINS.
conta_pagar_cadastro[].servico_tomado.base_pisnúmeroBase de cálculo do PIS.
conta_pagar_cadastro[].servico_tomado.codigo_servicotexto · até 10Código do serviço (LC116).
conta_pagar_cadastro[].servico_tomado.cst_cofinstexto · até 2CST do COFINS (Código da Situação Tributária).
conta_pagar_cadastro[].servico_tomado.cst_pistexto · até 2CST do PIS (Código da Situação Tributária).
conta_pagar_cadastro[].servico_tomado.numero_nftexto · até 20Número da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.serie_nftexto · até 20Série da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.valor_cofinsnúmeroValor do PIS.
conta_pagar_cadastro[].servico_tomado.valor_nfnúmeroValor total da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.valor_pisnúmeroValor do PIS.
conta_pagar_cadastro[].status_titulotexto · até 3Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar.
conta_pagar_cadastro[].valor_cofinsnúmeroValor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_csllnúmeroValor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_documentonúmeroValor da Conta.
conta_pagar_cadastro[].valor_inssnúmeroValor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_irnúmeroValor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_issnúmeroValor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_pagnúmeroValor a pagar. Disponível apenas para os métodos de consulta e listagem.
conta_pagar_cadastro[].valor_pisnúmeroValor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
lotenúmero inteiroNúmero do Lote
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_statustextoCódigo do Status do processamento
descricao_statustextoDescrição do Status do Lote
lotenúmero inteiroNúmero do lote processado
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirContaPagarPorLote", "param": [{"lote": 100, "conta_pagar_cadastro": [{"codigo_lancamento_integracao": "1790774898", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "2.04.01", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}, {"codigo_lancamento_integracao": "1790774898", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 120.0, "codigo_categoria": "2.04.01", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}]}'

LancarPagamento

altera dadosClaudeMCP

Efetua a baixa de um pagamento do contas a pagar.

Obrigatórios 2

CampoTipoDescrição
codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
datatexto · até 10Data da Baixa
Opcionais 11Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo para identificar a baixa do título no Contas a Pagar.
codigo_baixa_integracaotexto · até 20Código da baixa do integrador para identificar a baixa de um título do contas a pagar.
codigo_conta_corrente_integracaotexto · até 20Código da Conta Corrente do Integrador.
codigo_lancamentonúmero inteirocodigo do lançamento no Omie
codigo_lancamento_integracaotexto · até 60Código do lançamento do integrador.
conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente.
descontonúmeroValor do desconto.
jurosnúmeroValor do Juros.
multanúmeroValor da multa.
observacaotextoObservação da Baixa do Contas a Receber.
valornúmeroValor a ser baixado.
Retorno 8O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo da baixa do contas a receber no Omie.
codigo_baixa_integracaotextoCódigo da baixa do integrador para identificar a baixa do título do contas a receber.
codigo_lancamentonúmero inteiroCódigo do lançamento no contas a pagar.
codigo_lancamento_integracaotextoCódigo de integração do parceiro para identificar o lançamento no Contas a Receber.
codigo_statustextoCódigo do Status da baixa.
descricao_statustextoDescrição do status da baixa do contas a pagar
liquidadotextoIndica que o recebimento liquidado.
valor_baixadodecimalValor baixado
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "LancarPagamento", "param": [{"codigo_lancamento": 0, "codigo_lancamento_integracao": "", "codigo_baixa_integracao": "", "codigo_conta_corrente": "", "valor": 100.2, "desconto": 0, "juros": 0, "multa": 0, "data": "30/09/2026", "observacao": "Baixa de documento realizada via API."}]}'

ListarContasPagar

consultaClaudeChatGPTMCP

Listar as Contas a Pagar

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 21Campos e estruturas que você pode enviar
CampoTipoDescrição
apenas_importado_apitexto · até 1Exibir apenas os registros gerados pela API. Informar "S" ou "N". O valor padrão para esse campo é "N".
exibir_obstexto · até 1Exibir as observações do lançamento (S/N). Preencher com "S" ou "N". Default "N"
filtrar_apenas_alteracaotexto · até 1Filtra os registros exibindos apenas os alterados. Informar "S" ou "N". O valor padrão para esse campo é "N".
filtrar_apenas_inclusaotexto · até 1Filtra os registros exibindos apenas os incluídos. Informar "S" ou "N". O valor padrão para esse campo é "N".
filtrar_apenas_titulos_em_abertotexto · até 1DEPRECATED.
filtrar_clientenúmero inteiroFiltrar os lançamentos de Contas a Pagar por código do cliente. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação.
filtrar_conta_correntenúmero inteiroFiltrar os lançamentos de Contas a Pagar por código da conta corrente. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
filtrar_por_cpf_cnpjtexto · até 20Filtrar os títulos por CPF/CNPJ. Informar apenas números.
filtrar_por_data_atetexto · até 10Data de fim do filtro. Utilize o formato "dd/mm/aaaa". Serão consideradas as datas de inclusão e alteração do lançamento de Contas a Pagar conforme definido nos campos "filtrar_apenas_inclusao" e "filtrar_apenas_alteracao".
filtrar_por_data_detexto · até 10Data de Inicio do filtro. Utilize o formato "dd/mm/aaaa". Serão consideradas as datas de inclusão e alteração do lançamento de Contas a Pagar conforme definido nos campos "filtrar_apenas_inclusao" e "filtrar_apenas_alteracao".
filtrar_por_emissao_atetexto · até 10
filtrar_por_emissao_detexto · até 10
filtrar_por_projetonúmero inteiroCódigo do Projeto. Informação localizada na Aba "Detalhes" do Contas a Pagar. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação.
filtrar_por_registro_atetexto · até 10
filtrar_por_registro_detexto · até 10
filtrar_por_statustexto · até 100Filtrar por status. Valores disponíveis: CANCELADO, PAGO, LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO
filtrar_por_vendedornúmero inteiroCódigo do Vendedor. Informação localizada na Aba "Diversos" do Contas a Pagar. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação.
ordem_descrescentetexto · até 1Exibir em Ordem Crescente ou Decrescente Informar "S" para exibir os dados em Ordem Descrescente ou "N" para exibir os dados em Ordem Crescente. O valor padrão para esse campo é "N".
ordenar_portexto · até 100Ordem de exibição dos dados. O valor padrão para esse campo é "CODIGO". Os valores disponíveis são: "CODIGO" "CODIGO_INTEGRACAO"
paginanúmero inteiroNúmero da página que será retornada. Como a resposta é paginada, é necessário informada qual página será recuperada na pesquisa. O valor padrão para esse campo é sempre 1.
registros_por_paginanúmero inteiroNúmero de registros por página. Indique quando registro você recuperá para cada página solicitada. O límite máximo permitido para essa API é 50 registro por página. Assim, se você tiver 1000 lançamentos registrados, será necessário realizar 20 consultas para obter todos os registros.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
conta_pagar_cadastrolista de objetos
conta_pagar_cadastro[].acaotextoDEPRECATED
conta_pagar_cadastro[].aprendizado_rateiotextoAprendizado de rateio de departamento. Preencher com "S" ou "N". Default "N" Quando essa tag for preenchida com "S" será assumido o rateio de departamento para a categoria informada na tag "codigo_categoria". Essa tag é utilizada apenas nos métodos de inclusão e alteração.
conta_pagar_cadastro[].baixa_bloqueadatextoDEPRECATED
conta_pagar_cadastro[].baixar_documentotextoEfetua a baixa automática do documento.
conta_pagar_cadastro[].bloqueadotextoDEPRECATED
conta_pagar_cadastro[].bloquear_exclusaotextoBloqueia a exclusão do registro. (S/N)
conta_pagar_cadastro[].categoriaslista de objetos
conta_pagar_cadastro[].categorias[].codigo_categoriatexto
conta_pagar_cadastro[].categorias[].percentualdecimalPercentual da categoria
conta_pagar_cadastro[].categorias[].valordecimal
conta_pagar_cadastro[].chave_nfetextoChave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].cnab_integracao_bancariaobjetoDados do CNAB e Integração Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.agencia_transferenciatextoNúmero da Agência para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.banco_transferenciatextoCódigo do Banco para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_barras_boletotextoCódigo de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_forma_pagamentotextoCódigo da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code.
conta_pagar_cadastro[].cnab_integracao_bancaria.conta_corrente_transferenciatextoNúmero da Conta Corrente para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.cpf_cnpj_transferenciatextoCNPJ ou CPF do Titular.
conta_pagar_cadastro[].cnab_integracao_bancaria.finalidade_transferenciatextoFinalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag ["id_conta_corrente"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag "pix_qrcode") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros
conta_pagar_cadastro[].cnab_integracao_bancaria.juros_boletodecimalPercentual de Juros ao Mês do Boleto.
conta_pagar_cadastro[].cnab_integracao_bancaria.multa_boletodecimalPercentual de Multa por Atraso do Boleto.
conta_pagar_cadastro[].cnab_integracao_bancaria.nome_transferenciatextoNome do Titular da Conta Corrente.
conta_pagar_cadastro[].cnab_integracao_bancaria.pix_qrcodetextoQR Code do PIX.
conta_pagar_cadastro[].codigo_barras_ficha_compensacaotextoCódigo de Barras Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].codigo_categoriatextoCódigo da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
conta_pagar_cadastro[].codigo_cliente_fornecedornúmero inteiroCódigo do Favorecido / Fornecedor. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação.
conta_pagar_cadastro[].codigo_cliente_fornecedor_integracaotextoCódigo de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente_omie".
conta_pagar_cadastro[].codigo_cmc7_chequetextoDEPRECATED
conta_pagar_cadastro[].codigo_lancamento_integracaotextoCódigo de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
conta_pagar_cadastro[].codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
conta_pagar_cadastro[].codigo_projetonúmero inteiroCódigo do Projeto. Informação localizada na Aba "Detalhes" do Contas a Pagar. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação.
conta_pagar_cadastro[].codigo_tipo_documentotextoCódigo do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].codigo_vendedornúmero inteiroCódigo do Vendedor. Informação localizada na Aba "Diversos" do Contas a Pagar. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação.
conta_pagar_cadastro[].conciliar_documentotextoEfetua a conciliação do documento automaticamente. Opcional. Preencher com S/N.
conta_pagar_cadastro[].data_emissaotextoData de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].data_entradatextoData de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].data_previsaotextoData da Previsão de Pagamento. Utilize o formato "dd/mm/aaaa". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente.
conta_pagar_cadastro[].data_vencimentotextoData de Vencimento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente.
conta_pagar_cadastro[].distribuicaolista de objetosDistribuição por Departamentos.
conta_pagar_cadastro[].distribuicao[].cCodDeptextoCódigo do Departamento
conta_pagar_cadastro[].distribuicao[].cDesDeptextoDescrição do Departamento
conta_pagar_cadastro[].distribuicao[].nPerDepdecimalPercentual do rateio
conta_pagar_cadastro[].distribuicao[].nValDepdecimalValor do rateio
conta_pagar_cadastro[].id_conta_correntenúmero inteiroCódigo da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
conta_pagar_cadastro[].id_conta_corrente_integracaotextoDEPRECATED
conta_pagar_cadastro[].id_origemtextoCódigo da Origem. Informação localizada na Aba "Diversos" do Contas a Pagar. Os valores disponíveis são: "APIP" - Integração de Conta a Pagar "BARP" - Conta a Pagar Importada por Código de Barras "COMP" - Parcela a Pagar de Compras "CTEP" - Parcela a Pagar de um CT-e "DEVP" - Conta a Pagar da Devolução de Venda "IMPP" - Parcela a Pagar de uma Nota de Importação "MANP" - Lançamento Manual de Conta a Pagar "NFEP" - Conta a Pagar Importada de uma NF-e "RPTP" - Repetição de Contas a Pagar "XMLP" - Conta a Pagar Importada de um arquivo XML
conta_pagar_cadastro[].importado_apitextoDEPRECATED
conta_pagar_cadastro[].infoobjetoInformações complemetares do cadastro do produto.
conta_pagar_cadastro[].info.cImpAPItextoImportado pela API (S/N). Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.dAlttextoData da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.dInctextoData da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.hAlttextoHora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.hInctextoHora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.uAlttextoUsuário da Alteração. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.uInctextoUsuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].nsutextoDEPRECATED.
conta_pagar_cadastro[].numero_documentotextoNúmero do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].numero_documento_fiscaltextoNúmero da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].numero_parcelatextoNúmero da parcela. Utilizar o formato "999/999". Para 1 parcela utilize "001/001" Se não informado assumirá o valor "001/001". Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].numero_pedidotextoNúmero do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].observacaotextoObservações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].operacaotextoCódigo da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: "01" - Venda de Serviço "11" - Venda de Produto "12" - Venda de Produto pelo PDV "13" - Devolução de Venda "14" - Remessa de Produto "16" - Nota Complementar de Saída
conta_pagar_cadastro[].pagamentoobjetoDetalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag "baixar_documento" com "S" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba "Pagamentos" no cadastro do lançamento.
conta_pagar_cadastro[].pagamento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
conta_pagar_cadastro[].pagamento.codigo_pagamento_integracaotexto
conta_pagar_cadastro[].pagamento.datatextoData da Baixa
conta_pagar_cadastro[].pagamento.descontodecimalValor do desconto.
conta_pagar_cadastro[].pagamento.jurosdecimalValor do Juros.
conta_pagar_cadastro[].pagamento.multadecimalValor da multa.
conta_pagar_cadastro[].pagamento.observacaotextoObservação da Baixa do Contas a Receber.
conta_pagar_cadastro[].pagamento.valordecimalValor a ser baixado.
conta_pagar_cadastro[].retem_cofinstextoReter COFINS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_cslltextoReter CSLL. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_insstextoReter INSS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_irtextoReter IR. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_isstextoReter ISS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_pistextoReter PIS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].servico_tomadoobjeto
conta_pagar_cadastro[].servico_tomado.aliquota_cofinsdecimalAlíquota do COFINS (%).
conta_pagar_cadastro[].servico_tomado.aliquota_pisdecimalAlíquota do PIS (%).
conta_pagar_cadastro[].servico_tomado.base_cofinsdecimalBase de cálculo do COFINS.
conta_pagar_cadastro[].servico_tomado.base_pisdecimalBase de cálculo do PIS.
conta_pagar_cadastro[].servico_tomado.codigo_servicotextoCódigo do serviço (LC116).
conta_pagar_cadastro[].servico_tomado.cst_cofinstextoCST do COFINS (Código da Situação Tributária).
conta_pagar_cadastro[].servico_tomado.cst_pistextoCST do PIS (Código da Situação Tributária).
conta_pagar_cadastro[].servico_tomado.numero_nftextoNúmero da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.serie_nftextoSérie da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.valor_cofinsdecimalValor do PIS.
conta_pagar_cadastro[].servico_tomado.valor_nfdecimalValor total da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.valor_pisdecimalValor do PIS.
conta_pagar_cadastro[].status_titulotextoStatus do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar.
conta_pagar_cadastro[].valor_cofinsdecimalValor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_cslldecimalValor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_documentodecimalValor da Conta.
conta_pagar_cadastro[].valor_inssdecimalValor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_irdecimalValor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_issdecimalValor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_pagdecimalValor a pagar. Disponível apenas para os métodos de consulta e listagem.
conta_pagar_cadastro[].valor_pisdecimalValor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
paginanúmero inteiro
registrosnúmero inteiro
total_de_paginasnúmero inteiro
total_de_registrosnúmero inteiro
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarContasPagar", "param": [{"pagina": 1, "registros_por_pagina": 20, "apenas_importado_api": "N"}]}'

UpsertContaPagar

altera dadosClaudeMCP

Upsert do Contas a Pagar

Obrigatórios 1

CampoTipoDescrição
pagamentoobjetoDetalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag "baixar_documento" com "S" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba "Pagamentos" no cadastro do lançamento.
pagamento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
pagamento.codigo_pagamento_integracaotexto · até 20
pagamento.datatexto · até 10Data da Baixa
pagamento.descontonúmeroValor do desconto.
pagamento.jurosnúmeroValor do Juros.
pagamento.multanúmeroValor da multa.
pagamento.observacaotextoObservação da Baixa do Contas a Receber.
pagamento.valornúmeroValor a ser baixado.
Opcionais 47Campos e estruturas que você pode enviar
CampoTipoDescrição
aprendizado_rateiotexto · até 1Aprendizado de rateio de departamento. Preencher com "S" ou "N". Default "N" Quando essa tag for preenchida com "S" será assumido o rateio de departamento para a categoria informada na tag "codigo_categoria". Essa tag é utilizada apenas nos métodos de inclusão e alteração.
baixar_documentotexto · até 1Efetua a baixa automática do documento.
bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
categoriaslista de objetos
categorias[].codigo_categoriatexto · até 20
categorias[].percentualnúmeroPercentual da categoria
categorias[].valornúmero
chave_nfetexto · até 44Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar.
cnab_integracao_bancariaobjetoDados do CNAB e Integração Bancária.
cnab_integracao_bancaria.agencia_transferenciatexto · até 10Número da Agência para Transferência Bancária.
cnab_integracao_bancaria.banco_transferenciatexto · até 3Código do Banco para Transferência Bancária.
cnab_integracao_bancaria.codigo_barras_boletotexto · até 70Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)
cnab_integracao_bancaria.codigo_forma_pagamentotexto · até 3Código da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code.
cnab_integracao_bancaria.conta_corrente_transferenciatexto · até 25Número da Conta Corrente para Transferência Bancária.
cnab_integracao_bancaria.cpf_cnpj_transferenciatexto · até 20CNPJ ou CPF do Titular.
cnab_integracao_bancaria.finalidade_transferenciaobrigatóriotexto · até 10Finalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag ["id_conta_corrente"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag "pix_qrcode") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros
cnab_integracao_bancaria.juros_boletonúmeroPercentual de Juros ao Mês do Boleto.
cnab_integracao_bancaria.multa_boletonúmeroPercentual de Multa por Atraso do Boleto.
cnab_integracao_bancaria.nome_transferenciatexto · até 60Nome do Titular da Conta Corrente.
cnab_integracao_bancaria.pix_qrcodetexto · até 300QR Code do PIX.
codigo_barras_ficha_compensacaotexto · até 70Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_categoriatexto · até 20Código da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
codigo_cliente_fornecedornúmero inteiroCódigo do Favorecido / Fornecedor. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação.
codigo_cliente_fornecedor_integracaotexto · até 60Código de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente_omie".
codigo_lancamento_integracaotexto · até 60Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_projetonúmero inteiroCódigo do Projeto. Informação localizada na Aba "Detalhes" do Contas a Pagar. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação.
codigo_tipo_documentotexto · até 5Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_vendedornúmero inteiroCódigo do Vendedor. Informação localizada na Aba "Diversos" do Contas a Pagar. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação.
conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N.
data_emissaotexto · até 10Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_entradatexto · até 10Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_previsaotexto · até 10Data da Previsão de Pagamento. Utilize o formato "dd/mm/aaaa". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente.
data_vencimentotexto · até 10Data de Vencimento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente.
distribuicaolista de objetosDistribuição por Departamentos.
distribuicao[].cCodDeptexto · até 40Código do Departamento
distribuicao[].cDesDeptexto · até 50Descrição do Departamento
distribuicao[].nPerDepnúmeroPercentual do rateio
distribuicao[].nValDepnúmeroValor do rateio
id_conta_correntenúmero inteiroCódigo da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Pagar. Os valores disponíveis são: "APIP" - Integração de Conta a Pagar "BARP" - Conta a Pagar Importada por Código de Barras "COMP" - Parcela a Pagar de Compras "CTEP" - Parcela a Pagar de um CT-e "DEVP" - Conta a Pagar da Devolução de Venda "IMPP" - Parcela a Pagar de uma Nota de Importação "MANP" - Lançamento Manual de Conta a Pagar "NFEP" - Conta a Pagar Importada de uma NF-e "RPTP" - Repetição de Contas a Pagar "XMLP" - Conta a Pagar Importada de um arquivo XML
infoobjetoInformações complemetares do cadastro do produto.
info.cImpAPItexto · até 1Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração.
info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
info.uAlttexto · até 10Usuário da Alteração. Não deve ser informado na Inclusão/Alteração.
info.uInctexto · até 10Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
nsutexto · até 100DEPRECATED.
numero_documentotexto · até 20Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_documento_fiscaltexto · até 20Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar.
numero_parcelatexto · até 7Número da parcela. Utilizar o formato "999/999". Para 1 parcela utilize "001/001" Se não informado assumirá o valor "001/001". Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_pedidotexto · até 15Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar.
observacaotextoObservações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
operacaotexto · até 2Código da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: "01" - Venda de Serviço "11" - Venda de Produto "12" - Venda de Produto pelo PDV "13" - Devolução de Venda "14" - Remessa de Produto "16" - Nota Complementar de Saída
retem_cofinstexto · até 1Reter COFINS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_cslltexto · até 1Reter CSLL. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_insstexto · até 1Reter INSS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_irtexto · até 1Reter IR. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_isstexto · até 1Reter ISS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_pistexto · até 1Reter PIS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
servico_tomadoobjeto
servico_tomado.aliquota_cofinsnúmeroAlíquota do COFINS (%).
servico_tomado.aliquota_pisnúmeroAlíquota do PIS (%).
servico_tomado.base_cofinsnúmeroBase de cálculo do COFINS.
servico_tomado.base_pisnúmeroBase de cálculo do PIS.
servico_tomado.codigo_servicotexto · até 10Código do serviço (LC116).
servico_tomado.cst_cofinstexto · até 2CST do COFINS (Código da Situação Tributária).
servico_tomado.cst_pistexto · até 2CST do PIS (Código da Situação Tributária).
servico_tomado.numero_nftexto · até 20Número da Nota Fiscal.
servico_tomado.serie_nftexto · até 20Série da Nota Fiscal.
servico_tomado.valor_cofinsnúmeroValor do PIS.
servico_tomado.valor_nfnúmeroValor total da Nota Fiscal.
servico_tomado.valor_pisnúmeroValor do PIS.
status_titulotexto · até 3Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar.
valor_cofinsnúmeroValor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_csllnúmeroValor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_documentonúmeroValor da Conta.
valor_inssnúmeroValor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_irnúmeroValor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_issnúmeroValor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_pagnúmeroValor a pagar. Disponível apenas para os métodos de consulta e listagem.
valor_pisnúmeroValor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
Descontinuados 6Ainda aceitos, fora do fluxo principal
CampoTipoDescrição
acaodescontinuadotextoDEPRECATED
baixa_bloqueadadescontinuadotexto · até 1DEPRECATED
bloqueadodescontinuadotexto · até 1DEPRECATED
codigo_cmc7_chequedescontinuadotexto · até 40DEPRECATED
id_conta_corrente_integracaodescontinuadotexto · até 20DEPRECATED
importado_apidescontinuadotexto · até 1DEPRECATED
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_statustextoCódigo do Status de Processamento. Quando retornar 0 (zero) indica que o processamento foi executado com sucesso. Qualquer outro valor maior que 0 (zero) indica que ocorreu uma falha durante o processo de validação dos dados.
descricao_statustextoDescrição do Status de Processamento. Descreve o resultado do processando, de acordo com o código de status retornado.
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "UpsertContaPagar", "param": [{"codigo_lancamento_integracao": "1790774898", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "2.04.01", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}'

UpsertContaPagarPorLote

altera dadosClaudeMCP

Efetua o UPSERT do Contas a Pagar por Lote

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
conta_pagar_cadastrolista de objetos
conta_pagar_cadastro[].acaodescontinuadotextoDEPRECATED
conta_pagar_cadastro[].aprendizado_rateiotexto · até 1Aprendizado de rateio de departamento. Preencher com "S" ou "N". Default "N" Quando essa tag for preenchida com "S" será assumido o rateio de departamento para a categoria informada na tag "codigo_categoria". Essa tag é utilizada apenas nos métodos de inclusão e alteração.
conta_pagar_cadastro[].baixa_bloqueadadescontinuadotexto · até 1DEPRECATED
conta_pagar_cadastro[].baixar_documentotexto · até 1Efetua a baixa automática do documento.
conta_pagar_cadastro[].bloqueadodescontinuadotexto · até 1DEPRECATED
conta_pagar_cadastro[].bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
conta_pagar_cadastro[].categoriaslista de objetos
conta_pagar_cadastro[].categorias[].codigo_categoriatexto · até 20
conta_pagar_cadastro[].categorias[].percentualnúmeroPercentual da categoria
conta_pagar_cadastro[].categorias[].valornúmero
conta_pagar_cadastro[].chave_nfetexto · até 44Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].cnab_integracao_bancariaobjetoDados do CNAB e Integração Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.agencia_transferenciatexto · até 10Número da Agência para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.banco_transferenciatexto · até 3Código do Banco para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_barras_boletotexto · até 70Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_forma_pagamentotexto · até 3Código da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code.
conta_pagar_cadastro[].cnab_integracao_bancaria.conta_corrente_transferenciatexto · até 25Número da Conta Corrente para Transferência Bancária.
conta_pagar_cadastro[].cnab_integracao_bancaria.cpf_cnpj_transferenciatexto · até 20CNPJ ou CPF do Titular.
conta_pagar_cadastro[].cnab_integracao_bancaria.finalidade_transferenciaobrigatóriotexto · até 10Finalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag ["id_conta_corrente"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag "pix_qrcode") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros
conta_pagar_cadastro[].cnab_integracao_bancaria.juros_boletonúmeroPercentual de Juros ao Mês do Boleto.
conta_pagar_cadastro[].cnab_integracao_bancaria.multa_boletonúmeroPercentual de Multa por Atraso do Boleto.
conta_pagar_cadastro[].cnab_integracao_bancaria.nome_transferenciatexto · até 60Nome do Titular da Conta Corrente.
conta_pagar_cadastro[].cnab_integracao_bancaria.pix_qrcodetexto · até 300QR Code do PIX.
conta_pagar_cadastro[].codigo_barras_ficha_compensacaotexto · até 70Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].codigo_categoriatexto · até 20Código da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
conta_pagar_cadastro[].codigo_cliente_fornecedornúmero inteiroCódigo do Favorecido / Fornecedor. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação.
conta_pagar_cadastro[].codigo_cliente_fornecedor_integracaotexto · até 60Código de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente_omie".
conta_pagar_cadastro[].codigo_cmc7_chequedescontinuadotexto · até 40DEPRECATED
conta_pagar_cadastro[].codigo_lancamento_integracaotexto · até 60Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
conta_pagar_cadastro[].codigo_lancamento_omienúmero inteiroCódigo do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
conta_pagar_cadastro[].codigo_projetonúmero inteiroCódigo do Projeto. Informação localizada na Aba "Detalhes" do Contas a Pagar. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação.
conta_pagar_cadastro[].codigo_tipo_documentotexto · até 5Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].codigo_vendedornúmero inteiroCódigo do Vendedor. Informação localizada na Aba "Diversos" do Contas a Pagar. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação.
conta_pagar_cadastro[].conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N.
conta_pagar_cadastro[].data_emissaotexto · até 10Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].data_entradatexto · até 10Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].data_previsaotexto · até 10Data da Previsão de Pagamento. Utilize o formato "dd/mm/aaaa". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente.
conta_pagar_cadastro[].data_vencimentotexto · até 10Data de Vencimento. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente.
conta_pagar_cadastro[].distribuicaolista de objetosDistribuição por Departamentos.
conta_pagar_cadastro[].distribuicao[].cCodDeptexto · até 40Código do Departamento
conta_pagar_cadastro[].distribuicao[].cDesDeptexto · até 50Descrição do Departamento
conta_pagar_cadastro[].distribuicao[].nPerDepnúmeroPercentual do rateio
conta_pagar_cadastro[].distribuicao[].nValDepnúmeroValor do rateio
conta_pagar_cadastro[].id_conta_correntenúmero inteiroCódigo da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
conta_pagar_cadastro[].id_conta_corrente_integracaodescontinuadotexto · até 20DEPRECATED
conta_pagar_cadastro[].id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Pagar. Os valores disponíveis são: "APIP" - Integração de Conta a Pagar "BARP" - Conta a Pagar Importada por Código de Barras "COMP" - Parcela a Pagar de Compras "CTEP" - Parcela a Pagar de um CT-e "DEVP" - Conta a Pagar da Devolução de Venda "IMPP" - Parcela a Pagar de uma Nota de Importação "MANP" - Lançamento Manual de Conta a Pagar "NFEP" - Conta a Pagar Importada de uma NF-e "RPTP" - Repetição de Contas a Pagar "XMLP" - Conta a Pagar Importada de um arquivo XML
conta_pagar_cadastro[].importado_apidescontinuadotexto · até 1DEPRECATED
conta_pagar_cadastro[].infoobjetoInformações complemetares do cadastro do produto.
conta_pagar_cadastro[].info.cImpAPItexto · até 1Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.uAlttexto · até 10Usuário da Alteração. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].info.uInctexto · até 10Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração.
conta_pagar_cadastro[].nsutexto · até 100DEPRECATED.
conta_pagar_cadastro[].numero_documentotexto · até 20Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].numero_documento_fiscaltexto · até 20Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].numero_parcelatexto · até 7Número da parcela. Utilizar o formato "999/999". Para 1 parcela utilize "001/001" Se não informado assumirá o valor "001/001". Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].numero_pedidotexto · até 15Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar.
conta_pagar_cadastro[].observacaotextoObservações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
conta_pagar_cadastro[].operacaotexto · até 2Código da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: "01" - Venda de Serviço "11" - Venda de Produto "12" - Venda de Produto pelo PDV "13" - Devolução de Venda "14" - Remessa de Produto "16" - Nota Complementar de Saída
conta_pagar_cadastro[].pagamentoobrigatórioobjetoDetalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag "baixar_documento" com "S" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba "Pagamentos" no cadastro do lançamento.
conta_pagar_cadastro[].pagamento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
conta_pagar_cadastro[].pagamento.codigo_pagamento_integracaotexto · até 20
conta_pagar_cadastro[].pagamento.datatexto · até 10Data da Baixa
conta_pagar_cadastro[].pagamento.descontonúmeroValor do desconto.
conta_pagar_cadastro[].pagamento.jurosnúmeroValor do Juros.
conta_pagar_cadastro[].pagamento.multanúmeroValor da multa.
conta_pagar_cadastro[].pagamento.observacaotextoObservação da Baixa do Contas a Receber.
conta_pagar_cadastro[].pagamento.valornúmeroValor a ser baixado.
conta_pagar_cadastro[].retem_cofinstexto · até 1Reter COFINS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_cslltexto · até 1Reter CSLL. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_insstexto · até 1Reter INSS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_irtexto · até 1Reter IR. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_isstexto · até 1Reter ISS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].retem_pistexto · até 1Reter PIS. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].servico_tomadoobjeto
conta_pagar_cadastro[].servico_tomado.aliquota_cofinsnúmeroAlíquota do COFINS (%).
conta_pagar_cadastro[].servico_tomado.aliquota_pisnúmeroAlíquota do PIS (%).
conta_pagar_cadastro[].servico_tomado.base_cofinsnúmeroBase de cálculo do COFINS.
conta_pagar_cadastro[].servico_tomado.base_pisnúmeroBase de cálculo do PIS.
conta_pagar_cadastro[].servico_tomado.codigo_servicotexto · até 10Código do serviço (LC116).
conta_pagar_cadastro[].servico_tomado.cst_cofinstexto · até 2CST do COFINS (Código da Situação Tributária).
conta_pagar_cadastro[].servico_tomado.cst_pistexto · até 2CST do PIS (Código da Situação Tributária).
conta_pagar_cadastro[].servico_tomado.numero_nftexto · até 20Número da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.serie_nftexto · até 20Série da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.valor_cofinsnúmeroValor do PIS.
conta_pagar_cadastro[].servico_tomado.valor_nfnúmeroValor total da Nota Fiscal.
conta_pagar_cadastro[].servico_tomado.valor_pisnúmeroValor do PIS.
conta_pagar_cadastro[].status_titulotexto · até 3Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar.
conta_pagar_cadastro[].valor_cofinsnúmeroValor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_csllnúmeroValor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_documentonúmeroValor da Conta.
conta_pagar_cadastro[].valor_inssnúmeroValor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_irnúmeroValor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_issnúmeroValor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
conta_pagar_cadastro[].valor_pagnúmeroValor a pagar. Disponível apenas para os métodos de consulta e listagem.
conta_pagar_cadastro[].valor_pisnúmeroValor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
lotenúmero inteiroNúmero do Lote
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_statustextoCódigo do Status do processamento
descricao_statustextoDescrição do Status do Lote
lotenúmero inteiroNúmero do lote processado
POST /api/v1/financas/contapagar/
curl -s https://app.omie.com.br/api/v1/financas/contapagar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "UpsertContaPagarPorLote", "param": [{"lote": 100, "conta_pagar_cadastro": [{"codigo_lancamento_integracao": "1790774898", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "2.04.01", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}, {"codigo_lancamento_integracao": "1790774898", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 120.0, "codigo_categoria": "2.04.01", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}]}'