Finanças ·
LancamentoContaPagarLançamento de Contas a Pagar
2consultas
8alterações
Claude 10 de 10 · ChatGPT 5 de 10 · MCP 10 de 10pelos assistentes de IA
JSON · XMLformato
Altera uma conta a pagar
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
pagamento | objeto | Detalhes 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_corrente | número inteiro | Código da Conta Corrente. |
pagamento.codigo_pagamento_integracao | texto · até 20 | |
pagamento.data | texto · até 10 | Data da Baixa |
pagamento.desconto | número | Valor do desconto. |
pagamento.juros | número | Valor do Juros. |
pagamento.multa | número | Valor da multa. |
pagamento.observacao | texto | Observação da Baixa do Contas a Receber. |
pagamento.valor | número | Valor a ser baixado. |
Opcionais 47Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
aprendizado_rateio | texto · até 1 | Aprendizado 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_documento | texto · até 1 | Efetua a baixa automática do documento. |
bloquear_exclusao | texto · até 1 | Bloqueia a exclusão do registro. (S/N) |
categorias | lista de objetos | |
categorias[].codigo_categoria | texto · até 20 | |
categorias[].percentual | número | Percentual da categoria |
categorias[].valor | número | |
chave_nfe | texto · até 44 | Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar. |
cnab_integracao_bancaria | objeto | Dados do CNAB e Integração Bancária. |
cnab_integracao_bancaria.agencia_transferencia | texto · até 10 | Número da Agência para Transferência Bancária. |
cnab_integracao_bancaria.banco_transferencia | texto · até 3 | Código do Banco para Transferência Bancária. |
cnab_integracao_bancaria.codigo_barras_boleto | texto · até 70 | Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos) |
cnab_integracao_bancaria.codigo_forma_pagamento | texto · até 3 | Có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_transferencia | texto · até 25 | Número da Conta Corrente para Transferência Bancária. |
cnab_integracao_bancaria.cpf_cnpj_transferencia | texto · até 20 | CNPJ ou CPF do Titular. |
cnab_integracao_bancaria.finalidade_transferenciaobrigatório | texto · até 10 | Finalidade 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_boleto | número | Percentual de Juros ao Mês do Boleto. |
cnab_integracao_bancaria.multa_boleto | número | Percentual de Multa por Atraso do Boleto. |
cnab_integracao_bancaria.nome_transferencia | texto · até 60 | Nome do Titular da Conta Corrente. |
cnab_integracao_bancaria.pix_qrcode | texto · até 300 | QR Code do PIX. |
codigo_barras_ficha_compensacao | texto · até 70 | Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_categoria | texto · até 20 | Có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_fornecedor | número inteiro | Có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_integracao | texto · até 60 | Có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_integracao | texto · até 60 | Có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_omie | número inteiro | Có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_projeto | número inteiro | Có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_documento | texto · até 5 | Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_vendedor | número inteiro | Có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_documento | texto · até 1 | Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N. |
data_emissao | texto · até 10 | Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_entrada | texto · até 10 | Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_previsao | texto · até 10 | Data 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_vencimento | texto · até 10 | Data 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. |
distribuicao | lista de objetos | Distribuição por Departamentos. |
distribuicao[].cCodDep | texto · até 40 | Código do Departamento |
distribuicao[].cDesDep | texto · até 50 | Descrição do Departamento |
distribuicao[].nPerDep | número | Percentual do rateio |
distribuicao[].nValDep | número | Valor do rateio |
id_conta_corrente | número inteiro | Có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_origem | texto · até 4 | Có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 |
info | objeto | Informações complemetares do cadastro do produto. |
info.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
info.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
info.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
nsu | texto · até 100 | DEPRECATED. |
numero_documento | texto · até 20 | Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
numero_documento_fiscal | texto · até 20 | Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
numero_parcela | texto · até 7 | Nú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_pedido | texto · até 15 | Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar. |
observacao | texto | Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
operacao | texto · até 2 | Có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_cofins | texto · até 1 | Reter 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_csll | texto · até 1 | Reter 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_inss | texto · até 1 | Reter 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_ir | texto · até 1 | Reter 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_iss | texto · até 1 | Reter 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_pis | texto · até 1 | Reter 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_tomado | objeto | |
servico_tomado.aliquota_cofins | número | Alíquota do COFINS (%). |
servico_tomado.aliquota_pis | número | Alíquota do PIS (%). |
servico_tomado.base_cofins | número | Base de cálculo do COFINS. |
servico_tomado.base_pis | número | Base de cálculo do PIS. |
servico_tomado.codigo_servico | texto · até 10 | Código do serviço (LC116). |
servico_tomado.cst_cofins | texto · até 2 | CST do COFINS (Código da Situação Tributária). |
servico_tomado.cst_pis | texto · até 2 | CST do PIS (Código da Situação Tributária). |
servico_tomado.numero_nf | texto · até 20 | Número da Nota Fiscal. |
servico_tomado.serie_nf | texto · até 20 | Série da Nota Fiscal. |
servico_tomado.valor_cofins | número | Valor do PIS. |
servico_tomado.valor_nf | número | Valor total da Nota Fiscal. |
servico_tomado.valor_pis | número | Valor do PIS. |
status_titulo | texto · até 3 | Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar. |
valor_cofins | número | Valor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_csll | número | Valor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_documento | número | Valor da Conta. |
valor_inss | número | Valor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_ir | número | Valor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_iss | número | Valor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_pag | número | Valor a pagar. Disponível apenas para os métodos de consulta e listagem. |
valor_pis | número | Valor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
Descontinuados 6Ainda aceitos, fora do fluxo principal
| Campo | Tipo | Descrição |
|---|---|---|
acaodescontinuado | texto | DEPRECATED |
baixa_bloqueadadescontinuado | texto · até 1 | DEPRECATED |
bloqueadodescontinuado | texto · até 1 | DEPRECATED |
codigo_cmc7_chequedescontinuado | texto · até 40 | DEPRECATED |
id_conta_corrente_integracaodescontinuado | texto · até 20 | DEPRECATED |
importado_apidescontinuado | texto · até 1 | DEPRECATED |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_lancamento_integracao | texto | Có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_omie | número inteiro | Có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_status | texto | Có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_status | texto | Descriçã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}]}'import os
import requests
corpo = {'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}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"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
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"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
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"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
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"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
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""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}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosCancela um pagamento realizado no Contas a Pagar
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_baixa | número inteiro | Código para identificar a baixa do título no Contas a Pagar. |
codigo_baixa_integracao | texto · até 20 | Có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
| Campo | Tipo | Descrição |
|---|---|---|
codigo_baixa | número inteiro | Código para identificar a baixa do título no Contas a Pagar. |
codigo_baixa_integracao | texto | Código da baixa do integrador para identificar a baixa de um título do contas a pagar. |
codigo_status | texto | Código do Status da baixa do contas a pagar. |
descricao_status | texto | Descriçã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}]}'import os
import requests
corpo = {'call': 'CancelarPagamento', 'param': [{'codigo_baixa': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "CancelarPagamento",
"param": [
{
"codigo_baixa": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "CancelarPagamento",
"param": [
{
"codigo_baixa": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"call": "CancelarPagamento",
"param": [
{
"codigo_baixa": 0
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "CancelarPagamento",
"param": [
{
"codigo_baixa": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""CancelarPagamento"", ""param"": [{""codigo_baixa"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosConsulta uma conta a pagar
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_lancamento_integracao | texto · até 60 | Có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_omie | número inteiro | Có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
| Campo | Tipo | Descrição |
|---|---|---|
acao | texto | DEPRECATED |
aprendizado_rateio | texto | Aprendizado 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_bloqueada | texto | DEPRECATED |
baixar_documento | texto | Efetua a baixa automática do documento. |
bloqueado | texto | DEPRECATED |
bloquear_exclusao | texto | Bloqueia a exclusão do registro. (S/N) |
categorias | lista de objetos | |
categorias[].codigo_categoria | texto | |
categorias[].percentual | decimal | Percentual da categoria |
categorias[].valor | decimal | |
chave_nfe | texto | Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar. |
cnab_integracao_bancaria | objeto | Dados do CNAB e Integração Bancária. |
cnab_integracao_bancaria.agencia_transferencia | texto | Número da Agência para Transferência Bancária. |
cnab_integracao_bancaria.banco_transferencia | texto | Código do Banco para Transferência Bancária. |
cnab_integracao_bancaria.codigo_barras_boleto | texto | Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos) |
cnab_integracao_bancaria.codigo_forma_pagamento | texto | Có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_transferencia | texto | Número da Conta Corrente para Transferência Bancária. |
cnab_integracao_bancaria.cpf_cnpj_transferencia | texto | CNPJ ou CPF do Titular. |
cnab_integracao_bancaria.finalidade_transferencia | texto | Finalidade 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_boleto | decimal | Percentual de Juros ao Mês do Boleto. |
cnab_integracao_bancaria.multa_boleto | decimal | Percentual de Multa por Atraso do Boleto. |
cnab_integracao_bancaria.nome_transferencia | texto | Nome do Titular da Conta Corrente. |
cnab_integracao_bancaria.pix_qrcode | texto | QR Code do PIX. |
codigo_barras_ficha_compensacao | texto | Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_categoria | texto | Có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_fornecedor | número inteiro | Có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_integracao | texto | Có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_cheque | texto | DEPRECATED |
codigo_lancamento_integracao | texto | Có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_omie | número inteiro | Có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_projeto | número inteiro | Có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_documento | texto | Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_vendedor | número inteiro | Có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_documento | texto | Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N. |
data_emissao | texto | Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_entrada | texto | Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_previsao | texto | Data 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_vencimento | texto | Data 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. |
distribuicao | lista de objetos | Distribuição por Departamentos. |
distribuicao[].cCodDep | texto | Código do Departamento |
distribuicao[].cDesDep | texto | Descrição do Departamento |
distribuicao[].nPerDep | decimal | Percentual do rateio |
distribuicao[].nValDep | decimal | Valor do rateio |
id_conta_corrente | número inteiro | Có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_integracao | texto | DEPRECATED |
id_origem | texto | Có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_api | texto | DEPRECATED |
info | objeto | Informações complemetares do cadastro do produto. |
info.cImpAPI | texto | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.uAlt | texto | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
info.uInc | texto | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
nsu | texto | DEPRECATED. |
numero_documento | texto | Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
numero_documento_fiscal | texto | Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
numero_parcela | texto | Nú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_pedido | texto | Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar. |
observacao | texto | Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
operacao | texto | Có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 |
pagamento | objeto | Detalhes 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_corrente | número inteiro | Código da Conta Corrente. |
pagamento.codigo_pagamento_integracao | texto | |
pagamento.data | texto | Data da Baixa |
pagamento.desconto | decimal | Valor do desconto. |
pagamento.juros | decimal | Valor do Juros. |
pagamento.multa | decimal | Valor da multa. |
pagamento.observacao | texto | Observação da Baixa do Contas a Receber. |
pagamento.valor | decimal | Valor a ser baixado. |
retem_cofins | texto | Reter 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_csll | texto | Reter 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_inss | texto | Reter 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_ir | texto | Reter 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_iss | texto | Reter 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_pis | texto | Reter 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_tomado | objeto | |
servico_tomado.aliquota_cofins | decimal | Alíquota do COFINS (%). |
servico_tomado.aliquota_pis | decimal | Alíquota do PIS (%). |
servico_tomado.base_cofins | decimal | Base de cálculo do COFINS. |
servico_tomado.base_pis | decimal | Base de cálculo do PIS. |
servico_tomado.codigo_servico | texto | Código do serviço (LC116). |
servico_tomado.cst_cofins | texto | CST do COFINS (Código da Situação Tributária). |
servico_tomado.cst_pis | texto | CST do PIS (Código da Situação Tributária). |
servico_tomado.numero_nf | texto | Número da Nota Fiscal. |
servico_tomado.serie_nf | texto | Série da Nota Fiscal. |
servico_tomado.valor_cofins | decimal | Valor do PIS. |
servico_tomado.valor_nf | decimal | Valor total da Nota Fiscal. |
servico_tomado.valor_pis | decimal | Valor do PIS. |
status_titulo | texto | Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar. |
valor_cofins | decimal | Valor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_csll | decimal | Valor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_documento | decimal | Valor da Conta. |
valor_inss | decimal | Valor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_ir | decimal | Valor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_iss | decimal | Valor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_pag | decimal | Valor a pagar. Disponível apenas para os métodos de consulta e listagem. |
valor_pis | decimal | Valor 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": ""}]}'import os
import requests
corpo = {'call': 'ConsultarContaPagar',
'param': [{'codigo_lancamento_omie': 0, 'codigo_lancamento_integracao': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarContaPagar",
"param": [
{
"codigo_lancamento_omie": 0,
"codigo_lancamento_integracao": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ConsultarContaPagar",
"param": [
{
"codigo_lancamento_omie": 0,
"codigo_lancamento_integracao": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"call": "ConsultarContaPagar",
"param": [
{
"codigo_lancamento_omie": 0,
"codigo_lancamento_integracao": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ConsultarContaPagar",
"param": [
{
"codigo_lancamento_omie": 0,
"codigo_lancamento_integracao": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarContaPagar"", ""param"": [{""codigo_lancamento_omie"": 0, ""codigo_lancamento_integracao"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosExclui uma conta a pagar
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_lancamento_integracao | texto · até 60 | Có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_omie | número inteiro | Có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
| Campo | Tipo | Descrição |
|---|---|---|
codigo_lancamento_integracao | texto | Có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_omie | número inteiro | Có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_status | texto | Có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_status | texto | Descriçã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": ""}]}'import os
import requests
corpo = {'call': 'ExcluirContaPagar',
'param': [{'codigo_lancamento_omie': 0, 'codigo_lancamento_integracao': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirContaPagar",
"param": [
{
"codigo_lancamento_omie": 0,
"codigo_lancamento_integracao": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ExcluirContaPagar",
"param": [
{
"codigo_lancamento_omie": 0,
"codigo_lancamento_integracao": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"call": "ExcluirContaPagar",
"param": [
{
"codigo_lancamento_omie": 0,
"codigo_lancamento_integracao": ""
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ExcluirContaPagar",
"param": [
{
"codigo_lancamento_omie": 0,
"codigo_lancamento_integracao": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirContaPagar"", ""param"": [{""codigo_lancamento_omie"": 0, ""codigo_lancamento_integracao"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclui uma conta a Pagar.
Obrigatórios 4
| Campo | Tipo | Descrição |
|---|---|---|
codigo_lancamento_integracao | texto · até 60 | Có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_vencimento | texto · até 10 | Data 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. |
pagamento | objeto | Detalhes 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_corrente | número inteiro | Código da Conta Corrente. |
pagamento.codigo_pagamento_integracao | texto · até 20 | |
pagamento.data | texto · até 10 | Data da Baixa |
pagamento.desconto | número | Valor do desconto. |
pagamento.juros | número | Valor do Juros. |
pagamento.multa | número | Valor da multa. |
pagamento.observacao | texto | Observação da Baixa do Contas a Receber. |
pagamento.valor | número | Valor a ser baixado. |
valor_documento | número | Valor da Conta. |
Opcionais 44Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
aprendizado_rateio | texto · até 1 | Aprendizado 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_documento | texto · até 1 | Efetua a baixa automática do documento. |
bloquear_exclusao | texto · até 1 | Bloqueia a exclusão do registro. (S/N) |
categorias | lista de objetos | |
categorias[].codigo_categoria | texto · até 20 | |
categorias[].percentual | número | Percentual da categoria |
categorias[].valor | número | |
chave_nfe | texto · até 44 | Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar. |
cnab_integracao_bancaria | objeto | Dados do CNAB e Integração Bancária. |
cnab_integracao_bancaria.agencia_transferencia | texto · até 10 | Número da Agência para Transferência Bancária. |
cnab_integracao_bancaria.banco_transferencia | texto · até 3 | Código do Banco para Transferência Bancária. |
cnab_integracao_bancaria.codigo_barras_boleto | texto · até 70 | Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos) |
cnab_integracao_bancaria.codigo_forma_pagamento | texto · até 3 | Có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_transferencia | texto · até 25 | Número da Conta Corrente para Transferência Bancária. |
cnab_integracao_bancaria.cpf_cnpj_transferencia | texto · até 20 | CNPJ ou CPF do Titular. |
cnab_integracao_bancaria.finalidade_transferenciaobrigatório | texto · até 10 | Finalidade 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_boleto | número | Percentual de Juros ao Mês do Boleto. |
cnab_integracao_bancaria.multa_boleto | número | Percentual de Multa por Atraso do Boleto. |
cnab_integracao_bancaria.nome_transferencia | texto · até 60 | Nome do Titular da Conta Corrente. |
cnab_integracao_bancaria.pix_qrcode | texto · até 300 | QR Code do PIX. |
codigo_barras_ficha_compensacao | texto · até 70 | Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_categoria | texto · até 20 | Có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_fornecedor | número inteiro | Có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_integracao | texto · até 60 | Có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_omie | número inteiro | Có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_projeto | número inteiro | Có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_documento | texto · até 5 | Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_vendedor | número inteiro | Có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_documento | texto · até 1 | Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N. |
data_emissao | texto · até 10 | Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_entrada | texto · até 10 | Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_previsao | texto · até 10 | Data 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. |
distribuicao | lista de objetos | Distribuição por Departamentos. |
distribuicao[].cCodDep | texto · até 40 | Código do Departamento |
distribuicao[].cDesDep | texto · até 50 | Descrição do Departamento |
distribuicao[].nPerDep | número | Percentual do rateio |
distribuicao[].nValDep | número | Valor do rateio |
id_conta_corrente | número inteiro | Có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_origem | texto · até 4 | Có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 |
info | objeto | Informações complemetares do cadastro do produto. |
info.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
info.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
info.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
nsu | texto · até 100 | DEPRECATED. |
numero_documento | texto · até 20 | Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
numero_documento_fiscal | texto · até 20 | Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
numero_parcela | texto · até 7 | Nú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_pedido | texto · até 15 | Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar. |
observacao | texto | Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
operacao | texto · até 2 | Có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_cofins | texto · até 1 | Reter 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_csll | texto · até 1 | Reter 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_inss | texto · até 1 | Reter 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_ir | texto · até 1 | Reter 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_iss | texto · até 1 | Reter 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_pis | texto · até 1 | Reter 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_tomado | objeto | |
servico_tomado.aliquota_cofins | número | Alíquota do COFINS (%). |
servico_tomado.aliquota_pis | número | Alíquota do PIS (%). |
servico_tomado.base_cofins | número | Base de cálculo do COFINS. |
servico_tomado.base_pis | número | Base de cálculo do PIS. |
servico_tomado.codigo_servico | texto · até 10 | Código do serviço (LC116). |
servico_tomado.cst_cofins | texto · até 2 | CST do COFINS (Código da Situação Tributária). |
servico_tomado.cst_pis | texto · até 2 | CST do PIS (Código da Situação Tributária). |
servico_tomado.numero_nf | texto · até 20 | Número da Nota Fiscal. |
servico_tomado.serie_nf | texto · até 20 | Série da Nota Fiscal. |
servico_tomado.valor_cofins | número | Valor do PIS. |
servico_tomado.valor_nf | número | Valor total da Nota Fiscal. |
servico_tomado.valor_pis | número | Valor do PIS. |
status_titulo | texto · até 3 | Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar. |
valor_cofins | número | Valor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_csll | número | Valor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_inss | número | Valor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_ir | número | Valor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_iss | número | Valor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_pag | número | Valor a pagar. Disponível apenas para os métodos de consulta e listagem. |
valor_pis | número | Valor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
Descontinuados 6Ainda aceitos, fora do fluxo principal
| Campo | Tipo | Descrição |
|---|---|---|
acaodescontinuado | texto | DEPRECATED |
baixa_bloqueadadescontinuado | texto · até 1 | DEPRECATED |
bloqueadodescontinuado | texto · até 1 | DEPRECATED |
codigo_cmc7_chequedescontinuado | texto · até 40 | DEPRECATED |
id_conta_corrente_integracaodescontinuado | texto · até 20 | DEPRECATED |
importado_apidescontinuado | texto · até 1 | DEPRECATED |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_lancamento_integracao | texto | Có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_omie | número inteiro | Có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_status | texto | Có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_status | texto | Descriçã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}]}'import os
import requests
corpo = {'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}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"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
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"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
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"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
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"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
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""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}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosInclusão do contas a pagar por lote
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
conta_pagar_cadastro | lista de objetos | |
conta_pagar_cadastro[].acaodescontinuado | texto | DEPRECATED |
conta_pagar_cadastro[].aprendizado_rateio | texto · até 1 | Aprendizado 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_bloqueadadescontinuado | texto · até 1 | DEPRECATED |
conta_pagar_cadastro[].baixar_documento | texto · até 1 | Efetua a baixa automática do documento. |
conta_pagar_cadastro[].bloqueadodescontinuado | texto · até 1 | DEPRECATED |
conta_pagar_cadastro[].bloquear_exclusao | texto · até 1 | Bloqueia a exclusão do registro. (S/N) |
conta_pagar_cadastro[].categorias | lista de objetos | |
conta_pagar_cadastro[].categorias[].codigo_categoria | texto · até 20 | |
conta_pagar_cadastro[].categorias[].percentual | número | Percentual da categoria |
conta_pagar_cadastro[].categorias[].valor | número | |
conta_pagar_cadastro[].chave_nfe | texto · até 44 | Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].cnab_integracao_bancaria | objeto | Dados do CNAB e Integração Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.agencia_transferencia | texto · até 10 | Número da Agência para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.banco_transferencia | texto · até 3 | Código do Banco para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_barras_boleto | texto · até 70 | Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos) |
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_forma_pagamento | texto · até 3 | Có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_transferencia | texto · até 25 | Número da Conta Corrente para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.cpf_cnpj_transferencia | texto · até 20 | CNPJ ou CPF do Titular. |
conta_pagar_cadastro[].cnab_integracao_bancaria.finalidade_transferenciaobrigatório | texto · até 10 | Finalidade 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_boleto | número | Percentual de Juros ao Mês do Boleto. |
conta_pagar_cadastro[].cnab_integracao_bancaria.multa_boleto | número | Percentual de Multa por Atraso do Boleto. |
conta_pagar_cadastro[].cnab_integracao_bancaria.nome_transferencia | texto · até 60 | Nome do Titular da Conta Corrente. |
conta_pagar_cadastro[].cnab_integracao_bancaria.pix_qrcode | texto · até 300 | QR Code do PIX. |
conta_pagar_cadastro[].codigo_barras_ficha_compensacao | texto · até 70 | Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].codigo_categoria | texto · até 20 | Có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_fornecedor | número inteiro | Có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_integracao | texto · até 60 | Có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_chequedescontinuado | texto · até 40 | DEPRECATED |
conta_pagar_cadastro[].codigo_lancamento_integracao | texto · até 60 | Có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_omie | número inteiro | Có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_projeto | número inteiro | Có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_documento | texto · até 5 | Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].codigo_vendedor | número inteiro | Có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_documento | texto · até 1 | Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N. |
conta_pagar_cadastro[].data_emissao | texto · até 10 | Data 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_entrada | texto · até 10 | Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
conta_pagar_cadastro[].data_previsao | texto · até 10 | Data 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_vencimento | texto · até 10 | Data 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[].distribuicao | lista de objetos | Distribuição por Departamentos. |
conta_pagar_cadastro[].distribuicao[].cCodDep | texto · até 40 | Código do Departamento |
conta_pagar_cadastro[].distribuicao[].cDesDep | texto · até 50 | Descrição do Departamento |
conta_pagar_cadastro[].distribuicao[].nPerDep | número | Percentual do rateio |
conta_pagar_cadastro[].distribuicao[].nValDep | número | Valor do rateio |
conta_pagar_cadastro[].id_conta_corrente | número inteiro | Có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_integracaodescontinuado | texto · até 20 | DEPRECATED |
conta_pagar_cadastro[].id_origem | texto · até 4 | Có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_apidescontinuado | texto · até 1 | DEPRECATED |
conta_pagar_cadastro[].info | objeto | Informações complemetares do cadastro do produto. |
conta_pagar_cadastro[].info.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].nsu | texto · até 100 | DEPRECATED. |
conta_pagar_cadastro[].numero_documento | texto · até 20 | Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].numero_documento_fiscal | texto · até 20 | Nú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_parcela | texto · até 7 | Nú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_pedido | texto · até 15 | Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].observacao | texto | Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
conta_pagar_cadastro[].operacao | texto · até 2 | Có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ório | objeto | Detalhes 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_corrente | número inteiro | Código da Conta Corrente. |
conta_pagar_cadastro[].pagamento.codigo_pagamento_integracao | texto · até 20 | |
conta_pagar_cadastro[].pagamento.data | texto · até 10 | Data da Baixa |
conta_pagar_cadastro[].pagamento.desconto | número | Valor do desconto. |
conta_pagar_cadastro[].pagamento.juros | número | Valor do Juros. |
conta_pagar_cadastro[].pagamento.multa | número | Valor da multa. |
conta_pagar_cadastro[].pagamento.observacao | texto | Observação da Baixa do Contas a Receber. |
conta_pagar_cadastro[].pagamento.valor | número | Valor a ser baixado. |
conta_pagar_cadastro[].retem_cofins | texto · até 1 | Reter 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_csll | texto · até 1 | Reter 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_inss | texto · até 1 | Reter 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_ir | texto · até 1 | Reter 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_iss | texto · até 1 | Reter 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_pis | texto · até 1 | Reter 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_tomado | objeto | |
conta_pagar_cadastro[].servico_tomado.aliquota_cofins | número | Alíquota do COFINS (%). |
conta_pagar_cadastro[].servico_tomado.aliquota_pis | número | Alíquota do PIS (%). |
conta_pagar_cadastro[].servico_tomado.base_cofins | número | Base de cálculo do COFINS. |
conta_pagar_cadastro[].servico_tomado.base_pis | número | Base de cálculo do PIS. |
conta_pagar_cadastro[].servico_tomado.codigo_servico | texto · até 10 | Código do serviço (LC116). |
conta_pagar_cadastro[].servico_tomado.cst_cofins | texto · até 2 | CST do COFINS (Código da Situação Tributária). |
conta_pagar_cadastro[].servico_tomado.cst_pis | texto · até 2 | CST do PIS (Código da Situação Tributária). |
conta_pagar_cadastro[].servico_tomado.numero_nf | texto · até 20 | Número da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.serie_nf | texto · até 20 | Série da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.valor_cofins | número | Valor do PIS. |
conta_pagar_cadastro[].servico_tomado.valor_nf | número | Valor total da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.valor_pis | número | Valor do PIS. |
conta_pagar_cadastro[].status_titulo | texto · até 3 | Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar. |
conta_pagar_cadastro[].valor_cofins | número | Valor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_csll | número | Valor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_documento | número | Valor da Conta. |
conta_pagar_cadastro[].valor_inss | número | Valor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_ir | número | Valor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_iss | número | Valor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_pag | número | Valor a pagar. Disponível apenas para os métodos de consulta e listagem. |
conta_pagar_cadastro[].valor_pis | número | Valor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
lote | número inteiro | Número do Lote |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_status | texto | Código do Status do processamento |
descricao_status | texto | Descrição do Status do Lote |
lote | número inteiro | Nú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}]}]}'import os
import requests
corpo = {'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}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"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
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"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
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"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
}
]
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"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
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""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}]}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosEfetua a baixa de um pagamento do contas a pagar.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
codigo_conta_corrente | número inteiro | Código da Conta Corrente. |
data | texto · até 10 | Data da Baixa |
Opcionais 11Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
codigo_baixa | número inteiro | Código para identificar a baixa do título no Contas a Pagar. |
codigo_baixa_integracao | texto · até 20 | Código da baixa do integrador para identificar a baixa de um título do contas a pagar. |
codigo_conta_corrente_integracao | texto · até 20 | Código da Conta Corrente do Integrador. |
codigo_lancamento | número inteiro | codigo do lançamento no Omie |
codigo_lancamento_integracao | texto · até 60 | Código do lançamento do integrador. |
conciliar_documento | texto · até 1 | Efetua a conciliação do documento automaticamente. |
desconto | número | Valor do desconto. |
juros | número | Valor do Juros. |
multa | número | Valor da multa. |
observacao | texto | Observação da Baixa do Contas a Receber. |
valor | número | Valor a ser baixado. |
Retorno 8O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_baixa | número inteiro | Código da baixa do contas a receber no Omie. |
codigo_baixa_integracao | texto | Código da baixa do integrador para identificar a baixa do título do contas a receber. |
codigo_lancamento | número inteiro | Código do lançamento no contas a pagar. |
codigo_lancamento_integracao | texto | Código de integração do parceiro para identificar o lançamento no Contas a Receber. |
codigo_status | texto | Código do Status da baixa. |
descricao_status | texto | Descrição do status da baixa do contas a pagar |
liquidado | texto | Indica que o recebimento liquidado. |
valor_baixado | decimal | Valor 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."}]}'import os
import requests
corpo = {'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.'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"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."
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"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."
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"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."
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"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."
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""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.""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosListar as Contas a Pagar
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 21Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | texto · até 1 | Exibir apenas os registros gerados pela API. Informar "S" ou "N". O valor padrão para esse campo é "N". |
exibir_obs | texto · até 1 | Exibir as observações do lançamento (S/N). Preencher com "S" ou "N". Default "N" |
filtrar_apenas_alteracao | texto · até 1 | Filtra os registros exibindos apenas os alterados. Informar "S" ou "N". O valor padrão para esse campo é "N". |
filtrar_apenas_inclusao | texto · até 1 | Filtra os registros exibindos apenas os incluídos. Informar "S" ou "N". O valor padrão para esse campo é "N". |
filtrar_apenas_titulos_em_aberto | texto · até 1 | DEPRECATED. |
filtrar_cliente | número inteiro | Filtrar 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_corrente | número inteiro | Filtrar 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_cnpj | texto · até 20 | Filtrar os títulos por CPF/CNPJ. Informar apenas números. |
filtrar_por_data_ate | texto · até 10 | Data 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_de | texto · até 10 | Data 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_ate | texto · até 10 | |
filtrar_por_emissao_de | texto · até 10 | |
filtrar_por_projeto | número inteiro | Có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_ate | texto · até 10 | |
filtrar_por_registro_de | texto · até 10 | |
filtrar_por_status | texto · até 100 | Filtrar por status. Valores disponíveis: CANCELADO, PAGO, LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO |
filtrar_por_vendedor | número inteiro | Có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_descrescente | texto · até 1 | Exibir 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_por | texto · até 100 | Ordem de exibição dos dados. O valor padrão para esse campo é "CODIGO". Os valores disponíveis são: "CODIGO" "CODIGO_INTEGRACAO" |
pagina | número inteiro | Nú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_pagina | número inteiro | Nú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
| Campo | Tipo | Descrição |
|---|---|---|
conta_pagar_cadastro | lista de objetos | |
conta_pagar_cadastro[].acao | texto | DEPRECATED |
conta_pagar_cadastro[].aprendizado_rateio | texto | Aprendizado 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_bloqueada | texto | DEPRECATED |
conta_pagar_cadastro[].baixar_documento | texto | Efetua a baixa automática do documento. |
conta_pagar_cadastro[].bloqueado | texto | DEPRECATED |
conta_pagar_cadastro[].bloquear_exclusao | texto | Bloqueia a exclusão do registro. (S/N) |
conta_pagar_cadastro[].categorias | lista de objetos | |
conta_pagar_cadastro[].categorias[].codigo_categoria | texto | |
conta_pagar_cadastro[].categorias[].percentual | decimal | Percentual da categoria |
conta_pagar_cadastro[].categorias[].valor | decimal | |
conta_pagar_cadastro[].chave_nfe | texto | Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].cnab_integracao_bancaria | objeto | Dados do CNAB e Integração Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.agencia_transferencia | texto | Número da Agência para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.banco_transferencia | texto | Código do Banco para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_barras_boleto | texto | Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos) |
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_forma_pagamento | texto | Có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_transferencia | texto | Número da Conta Corrente para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.cpf_cnpj_transferencia | texto | CNPJ ou CPF do Titular. |
conta_pagar_cadastro[].cnab_integracao_bancaria.finalidade_transferencia | texto | Finalidade 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_boleto | decimal | Percentual de Juros ao Mês do Boleto. |
conta_pagar_cadastro[].cnab_integracao_bancaria.multa_boleto | decimal | Percentual de Multa por Atraso do Boleto. |
conta_pagar_cadastro[].cnab_integracao_bancaria.nome_transferencia | texto | Nome do Titular da Conta Corrente. |
conta_pagar_cadastro[].cnab_integracao_bancaria.pix_qrcode | texto | QR Code do PIX. |
conta_pagar_cadastro[].codigo_barras_ficha_compensacao | texto | Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].codigo_categoria | texto | Có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_fornecedor | número inteiro | Có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_integracao | texto | Có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_cheque | texto | DEPRECATED |
conta_pagar_cadastro[].codigo_lancamento_integracao | texto | Có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_omie | número inteiro | Có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_projeto | número inteiro | Có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_documento | texto | Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].codigo_vendedor | número inteiro | Có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_documento | texto | Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N. |
conta_pagar_cadastro[].data_emissao | texto | Data 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_entrada | texto | Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
conta_pagar_cadastro[].data_previsao | texto | Data 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_vencimento | texto | Data 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[].distribuicao | lista de objetos | Distribuição por Departamentos. |
conta_pagar_cadastro[].distribuicao[].cCodDep | texto | Código do Departamento |
conta_pagar_cadastro[].distribuicao[].cDesDep | texto | Descrição do Departamento |
conta_pagar_cadastro[].distribuicao[].nPerDep | decimal | Percentual do rateio |
conta_pagar_cadastro[].distribuicao[].nValDep | decimal | Valor do rateio |
conta_pagar_cadastro[].id_conta_corrente | número inteiro | Có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_integracao | texto | DEPRECATED |
conta_pagar_cadastro[].id_origem | texto | Có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_api | texto | DEPRECATED |
conta_pagar_cadastro[].info | objeto | Informações complemetares do cadastro do produto. |
conta_pagar_cadastro[].info.cImpAPI | texto | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.dAlt | texto | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.dInc | texto | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.hAlt | texto | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.hInc | texto | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.uAlt | texto | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.uInc | texto | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].nsu | texto | DEPRECATED. |
conta_pagar_cadastro[].numero_documento | texto | Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].numero_documento_fiscal | texto | Nú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_parcela | texto | Nú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_pedido | texto | Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].observacao | texto | Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
conta_pagar_cadastro[].operacao | texto | Có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[].pagamento | objeto | Detalhes 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_corrente | número inteiro | Código da Conta Corrente. |
conta_pagar_cadastro[].pagamento.codigo_pagamento_integracao | texto | |
conta_pagar_cadastro[].pagamento.data | texto | Data da Baixa |
conta_pagar_cadastro[].pagamento.desconto | decimal | Valor do desconto. |
conta_pagar_cadastro[].pagamento.juros | decimal | Valor do Juros. |
conta_pagar_cadastro[].pagamento.multa | decimal | Valor da multa. |
conta_pagar_cadastro[].pagamento.observacao | texto | Observação da Baixa do Contas a Receber. |
conta_pagar_cadastro[].pagamento.valor | decimal | Valor a ser baixado. |
conta_pagar_cadastro[].retem_cofins | texto | Reter 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_csll | texto | Reter 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_inss | texto | Reter 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_ir | texto | Reter 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_iss | texto | Reter 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_pis | texto | Reter 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_tomado | objeto | |
conta_pagar_cadastro[].servico_tomado.aliquota_cofins | decimal | Alíquota do COFINS (%). |
conta_pagar_cadastro[].servico_tomado.aliquota_pis | decimal | Alíquota do PIS (%). |
conta_pagar_cadastro[].servico_tomado.base_cofins | decimal | Base de cálculo do COFINS. |
conta_pagar_cadastro[].servico_tomado.base_pis | decimal | Base de cálculo do PIS. |
conta_pagar_cadastro[].servico_tomado.codigo_servico | texto | Código do serviço (LC116). |
conta_pagar_cadastro[].servico_tomado.cst_cofins | texto | CST do COFINS (Código da Situação Tributária). |
conta_pagar_cadastro[].servico_tomado.cst_pis | texto | CST do PIS (Código da Situação Tributária). |
conta_pagar_cadastro[].servico_tomado.numero_nf | texto | Número da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.serie_nf | texto | Série da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.valor_cofins | decimal | Valor do PIS. |
conta_pagar_cadastro[].servico_tomado.valor_nf | decimal | Valor total da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.valor_pis | decimal | Valor do PIS. |
conta_pagar_cadastro[].status_titulo | texto | Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar. |
conta_pagar_cadastro[].valor_cofins | decimal | Valor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_csll | decimal | Valor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_documento | decimal | Valor da Conta. |
conta_pagar_cadastro[].valor_inss | decimal | Valor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_ir | decimal | Valor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_iss | decimal | Valor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_pag | decimal | Valor a pagar. Disponível apenas para os métodos de consulta e listagem. |
conta_pagar_cadastro[].valor_pis | decimal | Valor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
pagina | número inteiro | |
registros | número inteiro | |
total_de_paginas | número inteiro | |
total_de_registros | nú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"}]}'import os
import requests
corpo = {'call': 'ListarContasPagar',
'param': [{'pagina': 1, 'registros_por_pagina': 20, 'apenas_importado_api': 'N'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarContasPagar",
"param": [
{
"pagina": 1,
"registros_por_pagina": 20,
"apenas_importado_api": "N"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ListarContasPagar",
"param": [
{
"pagina": 1,
"registros_por_pagina": 20,
"apenas_importado_api": "N"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"call": "ListarContasPagar",
"param": [
{
"pagina": 1,
"registros_por_pagina": 20,
"apenas_importado_api": "N"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ListarContasPagar",
"param": [
{
"pagina": 1,
"registros_por_pagina": 20,
"apenas_importado_api": "N"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarContasPagar"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 20, ""apenas_importado_api"": ""N""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosUpsert do Contas a Pagar
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
pagamento | objeto | Detalhes 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_corrente | número inteiro | Código da Conta Corrente. |
pagamento.codigo_pagamento_integracao | texto · até 20 | |
pagamento.data | texto · até 10 | Data da Baixa |
pagamento.desconto | número | Valor do desconto. |
pagamento.juros | número | Valor do Juros. |
pagamento.multa | número | Valor da multa. |
pagamento.observacao | texto | Observação da Baixa do Contas a Receber. |
pagamento.valor | número | Valor a ser baixado. |
Opcionais 47Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
aprendizado_rateio | texto · até 1 | Aprendizado 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_documento | texto · até 1 | Efetua a baixa automática do documento. |
bloquear_exclusao | texto · até 1 | Bloqueia a exclusão do registro. (S/N) |
categorias | lista de objetos | |
categorias[].codigo_categoria | texto · até 20 | |
categorias[].percentual | número | Percentual da categoria |
categorias[].valor | número | |
chave_nfe | texto · até 44 | Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar. |
cnab_integracao_bancaria | objeto | Dados do CNAB e Integração Bancária. |
cnab_integracao_bancaria.agencia_transferencia | texto · até 10 | Número da Agência para Transferência Bancária. |
cnab_integracao_bancaria.banco_transferencia | texto · até 3 | Código do Banco para Transferência Bancária. |
cnab_integracao_bancaria.codigo_barras_boleto | texto · até 70 | Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos) |
cnab_integracao_bancaria.codigo_forma_pagamento | texto · até 3 | Có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_transferencia | texto · até 25 | Número da Conta Corrente para Transferência Bancária. |
cnab_integracao_bancaria.cpf_cnpj_transferencia | texto · até 20 | CNPJ ou CPF do Titular. |
cnab_integracao_bancaria.finalidade_transferenciaobrigatório | texto · até 10 | Finalidade 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_boleto | número | Percentual de Juros ao Mês do Boleto. |
cnab_integracao_bancaria.multa_boleto | número | Percentual de Multa por Atraso do Boleto. |
cnab_integracao_bancaria.nome_transferencia | texto · até 60 | Nome do Titular da Conta Corrente. |
cnab_integracao_bancaria.pix_qrcode | texto · até 300 | QR Code do PIX. |
codigo_barras_ficha_compensacao | texto · até 70 | Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_categoria | texto · até 20 | Có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_fornecedor | número inteiro | Có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_integracao | texto · até 60 | Có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_integracao | texto · até 60 | Có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_omie | número inteiro | Có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_projeto | número inteiro | Có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_documento | texto · até 5 | Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_vendedor | número inteiro | Có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_documento | texto · até 1 | Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N. |
data_emissao | texto · até 10 | Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_entrada | texto · até 10 | Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_previsao | texto · até 10 | Data 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_vencimento | texto · até 10 | Data 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. |
distribuicao | lista de objetos | Distribuição por Departamentos. |
distribuicao[].cCodDep | texto · até 40 | Código do Departamento |
distribuicao[].cDesDep | texto · até 50 | Descrição do Departamento |
distribuicao[].nPerDep | número | Percentual do rateio |
distribuicao[].nValDep | número | Valor do rateio |
id_conta_corrente | número inteiro | Có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_origem | texto · até 4 | Có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 |
info | objeto | Informações complemetares do cadastro do produto. |
info.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
info.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
info.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
info.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
info.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
nsu | texto · até 100 | DEPRECATED. |
numero_documento | texto · até 20 | Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
numero_documento_fiscal | texto · até 20 | Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
numero_parcela | texto · até 7 | Nú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_pedido | texto · até 15 | Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar. |
observacao | texto | Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
operacao | texto · até 2 | Có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_cofins | texto · até 1 | Reter 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_csll | texto · até 1 | Reter 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_inss | texto · até 1 | Reter 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_ir | texto · até 1 | Reter 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_iss | texto · até 1 | Reter 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_pis | texto · até 1 | Reter 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_tomado | objeto | |
servico_tomado.aliquota_cofins | número | Alíquota do COFINS (%). |
servico_tomado.aliquota_pis | número | Alíquota do PIS (%). |
servico_tomado.base_cofins | número | Base de cálculo do COFINS. |
servico_tomado.base_pis | número | Base de cálculo do PIS. |
servico_tomado.codigo_servico | texto · até 10 | Código do serviço (LC116). |
servico_tomado.cst_cofins | texto · até 2 | CST do COFINS (Código da Situação Tributária). |
servico_tomado.cst_pis | texto · até 2 | CST do PIS (Código da Situação Tributária). |
servico_tomado.numero_nf | texto · até 20 | Número da Nota Fiscal. |
servico_tomado.serie_nf | texto · até 20 | Série da Nota Fiscal. |
servico_tomado.valor_cofins | número | Valor do PIS. |
servico_tomado.valor_nf | número | Valor total da Nota Fiscal. |
servico_tomado.valor_pis | número | Valor do PIS. |
status_titulo | texto · até 3 | Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar. |
valor_cofins | número | Valor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_csll | número | Valor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_documento | número | Valor da Conta. |
valor_inss | número | Valor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_ir | número | Valor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_iss | número | Valor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_pag | número | Valor a pagar. Disponível apenas para os métodos de consulta e listagem. |
valor_pis | número | Valor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
Descontinuados 6Ainda aceitos, fora do fluxo principal
| Campo | Tipo | Descrição |
|---|---|---|
acaodescontinuado | texto | DEPRECATED |
baixa_bloqueadadescontinuado | texto · até 1 | DEPRECATED |
bloqueadodescontinuado | texto · até 1 | DEPRECATED |
codigo_cmc7_chequedescontinuado | texto · até 40 | DEPRECATED |
id_conta_corrente_integracaodescontinuado | texto · até 20 | DEPRECATED |
importado_apidescontinuado | texto · até 1 | DEPRECATED |
Retorno 4O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_lancamento_integracao | texto | Có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_omie | número inteiro | Có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_status | texto | Có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_status | texto | Descriçã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}]}'import os
import requests
corpo = {'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}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"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
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"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
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"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
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"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
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""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}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosEfetua o UPSERT do Contas a Pagar por Lote
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
conta_pagar_cadastro | lista de objetos | |
conta_pagar_cadastro[].acaodescontinuado | texto | DEPRECATED |
conta_pagar_cadastro[].aprendizado_rateio | texto · até 1 | Aprendizado 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_bloqueadadescontinuado | texto · até 1 | DEPRECATED |
conta_pagar_cadastro[].baixar_documento | texto · até 1 | Efetua a baixa automática do documento. |
conta_pagar_cadastro[].bloqueadodescontinuado | texto · até 1 | DEPRECATED |
conta_pagar_cadastro[].bloquear_exclusao | texto · até 1 | Bloqueia a exclusão do registro. (S/N) |
conta_pagar_cadastro[].categorias | lista de objetos | |
conta_pagar_cadastro[].categorias[].codigo_categoria | texto · até 20 | |
conta_pagar_cadastro[].categorias[].percentual | número | Percentual da categoria |
conta_pagar_cadastro[].categorias[].valor | número | |
conta_pagar_cadastro[].chave_nfe | texto · até 44 | Chave da NF.e. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].cnab_integracao_bancaria | objeto | Dados do CNAB e Integração Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.agencia_transferencia | texto · até 10 | Número da Agência para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.banco_transferencia | texto · até 3 | Código do Banco para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_barras_boleto | texto · até 70 | Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos) |
conta_pagar_cadastro[].cnab_integracao_bancaria.codigo_forma_pagamento | texto · até 3 | Có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_transferencia | texto · até 25 | Número da Conta Corrente para Transferência Bancária. |
conta_pagar_cadastro[].cnab_integracao_bancaria.cpf_cnpj_transferencia | texto · até 20 | CNPJ ou CPF do Titular. |
conta_pagar_cadastro[].cnab_integracao_bancaria.finalidade_transferenciaobrigatório | texto · até 10 | Finalidade 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_boleto | número | Percentual de Juros ao Mês do Boleto. |
conta_pagar_cadastro[].cnab_integracao_bancaria.multa_boleto | número | Percentual de Multa por Atraso do Boleto. |
conta_pagar_cadastro[].cnab_integracao_bancaria.nome_transferencia | texto · até 60 | Nome do Titular da Conta Corrente. |
conta_pagar_cadastro[].cnab_integracao_bancaria.pix_qrcode | texto · até 300 | QR Code do PIX. |
conta_pagar_cadastro[].codigo_barras_ficha_compensacao | texto · até 70 | Código de Barras Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].codigo_categoria | texto · até 20 | Có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_fornecedor | número inteiro | Có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_integracao | texto · até 60 | Có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_chequedescontinuado | texto · até 40 | DEPRECATED |
conta_pagar_cadastro[].codigo_lancamento_integracao | texto · até 60 | Có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_omie | número inteiro | Có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_projeto | número inteiro | Có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_documento | texto · até 5 | Código do Tipo de Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].codigo_vendedor | número inteiro | Có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_documento | texto · até 1 | Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N. |
conta_pagar_cadastro[].data_emissao | texto · até 10 | Data 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_entrada | texto · até 10 | Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
conta_pagar_cadastro[].data_previsao | texto · até 10 | Data 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_vencimento | texto · até 10 | Data 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[].distribuicao | lista de objetos | Distribuição por Departamentos. |
conta_pagar_cadastro[].distribuicao[].cCodDep | texto · até 40 | Código do Departamento |
conta_pagar_cadastro[].distribuicao[].cDesDep | texto · até 50 | Descrição do Departamento |
conta_pagar_cadastro[].distribuicao[].nPerDep | número | Percentual do rateio |
conta_pagar_cadastro[].distribuicao[].nValDep | número | Valor do rateio |
conta_pagar_cadastro[].id_conta_corrente | número inteiro | Có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_integracaodescontinuado | texto · até 20 | DEPRECATED |
conta_pagar_cadastro[].id_origem | texto · até 4 | Có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_apidescontinuado | texto · até 1 | DEPRECATED |
conta_pagar_cadastro[].info | objeto | Informações complemetares do cadastro do produto. |
conta_pagar_cadastro[].info.cImpAPI | texto · até 1 | Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.dAlt | texto · até 10 | Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.dInc | texto · até 10 | Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.hAlt | texto · até 8 | Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.hInc | texto · até 8 | Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.uAlt | texto · até 10 | Usuário da Alteração. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].info.uInc | texto · até 10 | Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração. |
conta_pagar_cadastro[].nsu | texto · até 100 | DEPRECATED. |
conta_pagar_cadastro[].numero_documento | texto · até 20 | Número do Documento. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].numero_documento_fiscal | texto · até 20 | Nú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_parcela | texto · até 7 | Nú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_pedido | texto · até 15 | Número do Pedido. Informação localizada na Aba "Diversos" do Contas a Pagar. |
conta_pagar_cadastro[].observacao | texto | Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar. |
conta_pagar_cadastro[].operacao | texto · até 2 | Có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ório | objeto | Detalhes 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_corrente | número inteiro | Código da Conta Corrente. |
conta_pagar_cadastro[].pagamento.codigo_pagamento_integracao | texto · até 20 | |
conta_pagar_cadastro[].pagamento.data | texto · até 10 | Data da Baixa |
conta_pagar_cadastro[].pagamento.desconto | número | Valor do desconto. |
conta_pagar_cadastro[].pagamento.juros | número | Valor do Juros. |
conta_pagar_cadastro[].pagamento.multa | número | Valor da multa. |
conta_pagar_cadastro[].pagamento.observacao | texto | Observação da Baixa do Contas a Receber. |
conta_pagar_cadastro[].pagamento.valor | número | Valor a ser baixado. |
conta_pagar_cadastro[].retem_cofins | texto · até 1 | Reter 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_csll | texto · até 1 | Reter 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_inss | texto · até 1 | Reter 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_ir | texto · até 1 | Reter 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_iss | texto · até 1 | Reter 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_pis | texto · até 1 | Reter 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_tomado | objeto | |
conta_pagar_cadastro[].servico_tomado.aliquota_cofins | número | Alíquota do COFINS (%). |
conta_pagar_cadastro[].servico_tomado.aliquota_pis | número | Alíquota do PIS (%). |
conta_pagar_cadastro[].servico_tomado.base_cofins | número | Base de cálculo do COFINS. |
conta_pagar_cadastro[].servico_tomado.base_pis | número | Base de cálculo do PIS. |
conta_pagar_cadastro[].servico_tomado.codigo_servico | texto · até 10 | Código do serviço (LC116). |
conta_pagar_cadastro[].servico_tomado.cst_cofins | texto · até 2 | CST do COFINS (Código da Situação Tributária). |
conta_pagar_cadastro[].servico_tomado.cst_pis | texto · até 2 | CST do PIS (Código da Situação Tributária). |
conta_pagar_cadastro[].servico_tomado.numero_nf | texto · até 20 | Número da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.serie_nf | texto · até 20 | Série da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.valor_cofins | número | Valor do PIS. |
conta_pagar_cadastro[].servico_tomado.valor_nf | número | Valor total da Nota Fiscal. |
conta_pagar_cadastro[].servico_tomado.valor_pis | número | Valor do PIS. |
conta_pagar_cadastro[].status_titulo | texto · até 3 | Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar. |
conta_pagar_cadastro[].valor_cofins | número | Valor COFINS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_csll | número | Valor CSLL. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_documento | número | Valor da Conta. |
conta_pagar_cadastro[].valor_inss | número | Valor INSS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_ir | número | Valor IR. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_iss | número | Valor ISS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
conta_pagar_cadastro[].valor_pag | número | Valor a pagar. Disponível apenas para os métodos de consulta e listagem. |
conta_pagar_cadastro[].valor_pis | número | Valor PIS. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
lote | número inteiro | Número do Lote |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
codigo_status | texto | Código do Status do processamento |
descricao_status | texto | Descrição do Status do Lote |
lote | número inteiro | Nú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}]}]}'import os
import requests
corpo = {'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}]}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contapagar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/financas/contapagar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"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
}
]
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"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
}
]
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contapagar/")
corpo = <<~'JSON'
{
"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
}
]
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"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
}
]
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/financas/contapagar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""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}]}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados