Finanças ·
ContaReceberBarrasLançamento de contas a receber a partir do código de barras do boleto
0consultas
1alteração
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Inclui uma conta a receber 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 8Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCodCateg | texto · até 20 | Código da categoria de receita. Recomendado informar sempre: se não informado, o padrão é buscado no histórico de contas a pagar do cliente e pode resultar numa categoria de despesa. 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 ou CPF do cliente, usado para localizar o cliente no cadastro. Obrigatório quando nIdCliente não for informado. O cliente precisa estar cadastrado com esse documento. |
cDocumento | texto · até 20 | Número do documento. Se não informado, o número do documento fica com o nosso número lido do código de barras. Informação localizada na aba "Diversos" do Contas a Receber. |
cObservacao | texto | Observações. Utilize o caractere ( | ) pipe como separador de linhas. O Omie acrescenta ao final a data, a hora e o usuário da inclusão via integração. Informação localizada na aba "Detalhes" do Contas a Receber. |
dPrevisao | texto · até 10 | Data da previsão de recebimento, no formato dd/mm/aaaa. Se não informada, assume a data de hoje. |
nIdCliente | número inteiro | ID 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. |
nIdConta | número inteiro | Código da conta corrente. Se não informado, assume a conta padrão do cliente; sem padrão, a chamada é recusada pedindo a conta. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação. |
Retorno 3O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cCodStatus | texto | Código do status do processamento. "0" indica sucesso. |
cDesStatus | texto | Descrição do status do processamento. |
nIdTitulo | número inteiro | Código do lançamento de contas a receber criado (o mesmo usado nas demais APIs de contas a receber). |
POST /api/v1/financas/contareceber-barras/
curl -s https://app.omie.com.br/api/v1/financas/contareceber-barras/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "IncluirContaReceberCodBar", "param": [{"cCodigoBarras": "", "nIdCliente": 0, "cCpfCnpj": "", "dVencimento": "#TODAY#", "dPrevisao": "#TODAY#", "vDocumento": 0, "cCodCateg": "1.01.02", "nIdConta": 0, "cDocumento": "", "cObservacao": ""}]}'import os
import requests
corpo = {'call': 'IncluirContaReceberCodBar',
'param': [{'cCodigoBarras': '',
'nIdCliente': 0,
'cCpfCnpj': '',
'dVencimento': '#TODAY#',
'dPrevisao': '#TODAY#',
'vDocumento': 0,
'cCodCateg': '1.01.02',
'nIdConta': 0,
'cDocumento': '',
'cObservacao': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/contareceber-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/contareceber-barras/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "IncluirContaReceberCodBar",
"param": [
{
"cCodigoBarras": "",
"nIdCliente": 0,
"cCpfCnpj": "",
"dVencimento": "#TODAY#",
"dPrevisao": "#TODAY#",
"vDocumento": 0,
"cCodCateg": "1.01.02",
"nIdConta": 0,
"cDocumento": "",
"cObservacao": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contareceber-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": "IncluirContaReceberCodBar",
"param": [
{
"cCodigoBarras": "",
"nIdCliente": 0,
"cCpfCnpj": "",
"dVencimento": "#TODAY#",
"dPrevisao": "#TODAY#",
"vDocumento": 0,
"cCodCateg": "1.01.02",
"nIdConta": 0,
"cDocumento": "",
"cObservacao": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/contareceber-barras/")
corpo = <<~'JSON'
{
"call": "IncluirContaReceberCodBar",
"param": [
{
"cCodigoBarras": "",
"nIdCliente": 0,
"cCpfCnpj": "",
"dVencimento": "#TODAY#",
"dPrevisao": "#TODAY#",
"vDocumento": 0,
"cCodCateg": "1.01.02",
"nIdConta": 0,
"cDocumento": "",
"cObservacao": ""
}
]
}
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": "IncluirContaReceberCodBar",
"param": [
{
"cCodigoBarras": "",
"nIdCliente": 0,
"cCpfCnpj": "",
"dVencimento": "#TODAY#",
"dPrevisao": "#TODAY#",
"vDocumento": 0,
"cCodCateg": "1.01.02",
"nIdConta": 0,
"cDocumento": "",
"cObservacao": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/contareceber-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/contareceber-barras/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""IncluirContaReceberCodBar"", ""param"": [{""cCodigoBarras"": """", ""nIdCliente"": 0, ""cCpfCnpj"": """", ""dVencimento"": ""#TODAY#"", ""dPrevisao"": ""#TODAY#"", ""vDocumento"": 0, ""cCodCateg"": ""1.01.02"", ""nIdConta"": 0, ""cDocumento"": """", ""cObservacao"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados