Finanças · ContaPagarBarras

Lançamento de Contas a Pagar a partir do código de barras do boleto

POSThttps://app.omie.com.br/api/v1/financas/contapagar-barras/WSDL

0consultas

1alteração

Claude · MCPpelos assistentes de IA

JSON · XMLformato

IncluirContaPagarCodBar

altera dadosClaudeMCP

Inclui uma conta a Pagar a partir de um Código de Barras.

Obrigatórios 2

Campo	Tipo	Descrição
`dVencimento`	texto · até 10	Data de vencimento, no formato dd/mm/aaaa. Se não informada, assume o vencimento lido do código de barras; sem código de barras, é obrigatória.
`vDocumento`	número	Valor da conta. Se não informado, assume o valor lido do código de barras; sem código de barras, é obrigatório.

Opcionais 9Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCodCateg`	texto · até 20	Código da categoria (despesa). Se não informado, assume a categoria padrão do fornecedor; sem padrão, a chamada é recusada pedindo a categoria. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
`cCodigoBarras`	texto · até 70	Código de barras ou linha digitável do boleto.
`cCpfCnpj`	texto · até 60	CNPJ / CPF do Fornecedor / Favorecido. Utilizado como identificação do Fornecedor. Preechimento Obrigatório caso a tag "nIdFornecedor" não seja informada.
`cDocumento`	texto · até 20	Número do documento. Atenção: hoje este campo não é gravado (a função lê outra tag). O número do documento do lançamento fica com o nosso número lido do código de barras.
`cObservacao`	texto	Observações. Utilize o carater ( \| ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
`dPrevisao`	texto · até 10	Data da previsão de pagamento, no formato dd/mm/aaaa. Se não informada, assume a data de hoje.
`lBaixarDocumento`	sim/não	true registra o pagamento logo após lançar a conta, com a data de hoje, o valor total e a conta corrente do lançamento. Padrão false. Use só quando o boleto já tiver sido pago.
`nIdConta`	número inteiro	Código da conta corrente. Se não informado, assume a conta padrão do fornecedor; sem padrão, a chamada é recusada pedindo a conta. Com lBaixarDocumento true, é também a conta em que o pagamento é registrado (conta do Omie.CASH é recusada). Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
`nIdFornecedor`	número inteiro	ID do Fornecedor / Favorecido. 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.

Retorno 3O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`codigo_status`	texto	Código do status do processamento. "0" indica sucesso.
`descricao_status`	texto	Descrição do status do processamento.
`nIdTitulo`	número inteiro	ID do lançamento de Contas a Pagar. O conteúdo desse campo é o código interno gerado pelo Omie ao cadastrar o lançamento. 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.

POST /api/v1/financas/contapagar-barras/

curl -s https://app.omie.com.br/api/v1/financas/contapagar-barras/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirContaPagarCodBar", "param": [{"cCodigoBarras": "", "nIdFornecedor": 0, "cCpfCnpj": "", "dVencimento": "#TODAY#", "dPrevisao": "#TODAY#", "vDocumento": 0, "cCodCateg": "2.04.01", "nIdConta": 0, "cDocumento": "", "cObservacao": "", "lBaixarDocumento": false}]}'

import os
import requests

corpo = {'call': 'IncluirContaPagarCodBar',
 'param': [{'cCodigoBarras': '',
            'nIdFornecedor': 0,
            'cCpfCnpj': '',
            'dVencimento': '#TODAY#',
            'dPrevisao': '#TODAY#',
            'vDocumento': 0,
            'cCodCateg': '2.04.01',
            'nIdConta': 0,
            'cDocumento': '',
            'cObservacao': '',
            'lBaixarDocumento': False}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/contapagar-barras/",
    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-barras/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "IncluirContaPagarCodBar",
    "param": [
      {
        "cCodigoBarras": "",
        "nIdFornecedor": 0,
        "cCpfCnpj": "",
        "dVencimento": "#TODAY#",
        "dPrevisao": "#TODAY#",
        "vDocumento": 0,
        "cCodCateg": "2.04.01",
        "nIdConta": 0,
        "cDocumento": "",
        "cObservacao": "",
        "lBaixarDocumento": false
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contapagar-barras/");
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": "IncluirContaPagarCodBar",
    "param": [
        {
            "cCodigoBarras": "",
            "nIdFornecedor": 0,
            "cCpfCnpj": "",
            "dVencimento": "#TODAY#",
            "dPrevisao": "#TODAY#",
            "vDocumento": 0,
            "cCodCateg": "2.04.01",
            "nIdConta": 0,
            "cDocumento": "",
            "cObservacao": "",
            "lBaixarDocumento": false
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/contapagar-barras/")
corpo = <<~'JSON'
{
  "call": "IncluirContaPagarCodBar",
  "param": [
    {
      "cCodigoBarras": "",
      "nIdFornecedor": 0,
      "cCpfCnpj": "",
      "dVencimento": "#TODAY#",
      "dPrevisao": "#TODAY#",
      "vDocumento": 0,
      "cCodCateg": "2.04.01",
      "nIdConta": 0,
      "cDocumento": "",
      "cObservacao": "",
      "lBaixarDocumento": false
    }
  ]
}
JSON

resp = Net::HTTP.post(uri, corpo,
  "Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
  "Content-Type" => "application/json")
puts resp.body

import java.net.URI;
import java.net.http.*;

var corpo = """
{
  "call": "IncluirContaPagarCodBar",
  "param": [
    {
      "cCodigoBarras": "",
      "nIdFornecedor": 0,
      "cCpfCnpj": "",
      "dVencimento": "#TODAY#",
      "dPrevisao": "#TODAY#",
      "vDocumento": 0,
      "cCodCateg": "2.04.01",
      "nIdConta": 0,
      "cDocumento": "",
      "cObservacao": "",
      "lBaixarDocumento": false
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/contapagar-barras/"))
    .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-barras/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""IncluirContaPagarCodBar"", ""param"": [{""cCodigoBarras"": """", ""nIdFornecedor"": 0, ""cCpfCnpj"": """", ""dVencimento"": ""#TODAY#"", ""dPrevisao"": ""#TODAY#"", ""vDocumento"": 0, ""cCodCateg"": ""2.04.01"", ""nIdConta"": 0, ""cDocumento"": """", ""cObservacao"": """", ""lBaixarDocumento"": false}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

IncluirContaPagarCodBar