Finanças · ContaReceberBoleto

Boletos de contas a receber

POSThttps://app.omie.com.br/api/v1/financas/contareceberboleto/WSDL

1consulta

3alterações

Claude · MCPpelos assistentes de IA

JSON · XMLformato

CancelarBoleto

altera dadosClaudeMCP

Cancela o Boleto. ATENÇÃO: Os boletos gerados e já enviados ao banco estão sujeitos a tarifação (de emissão, cancelamento ou de alteração da data de vencimento do boleto).

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCodIntTitulo`	texto · até 60	Código de Integração do Título. Utilize a tag "codigo_lancamento_integracao" do método "ListarContasReceber" da API /api/v1/financas/contareceber/ para obter essa informação.
`nCodTitulo`	número inteiro	Código do título Código Interno do título no Omie. Utilize a tag "codigo_lancamento_omie" do método "ListarContasReceber" da API /api/v1/financas/contareceber/ para obter essa informação.

Retorno 2O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodStatus`	texto	Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro durante o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido.
`cDesStatus`	texto	Descrição do status do processamento. Essa tag explica o resultado da tag "cCodStatus".

POST /api/v1/financas/contareceberboleto/

curl -s https://app.omie.com.br/api/v1/financas/contareceberboleto/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarBoleto", "param": [{"nCodTitulo": 0, "cCodIntTitulo": ""}]}'

import os
import requests

corpo = {'call': 'CancelarBoleto', 'param': [{'nCodTitulo': 0, 'cCodIntTitulo': ''}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/contareceberboleto/",
    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/contareceberboleto/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "CancelarBoleto",
    "param": [
      {
        "nCodTitulo": 0,
        "cCodIntTitulo": ""
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contareceberboleto/");
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": "CancelarBoleto",
    "param": [
        {
            "nCodTitulo": 0,
            "cCodIntTitulo": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/contareceberboleto/")
corpo = <<~'JSON'
{
  "call": "CancelarBoleto",
  "param": [
    {
      "nCodTitulo": 0,
      "cCodIntTitulo": ""
    }
  ]
}
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": "CancelarBoleto",
  "param": [
    {
      "nCodTitulo": 0,
      "cCodIntTitulo": ""
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/contareceberboleto/"))
    .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/contareceberboleto/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""CancelarBoleto"", ""param"": [{""nCodTitulo"": 0, ""cCodIntTitulo"": """"}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

GerarBoleto

altera dadosClaudeMCP

Gera um Boleto referente a um Contas a Receber.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCodIntTitulo`	texto · até 60	Código de Integração do Título. Utilize a tag "codigo_lancamento_integracao" do método "ListarContasReceber" da API /api/v1/financas/contareceber/ para obter essa informação.
`nCodTitulo`	número inteiro	Código do título Código Interno do título no Omie. Utilize a tag "codigo_lancamento_omie" do método "ListarContasReceber" da API /api/v1/financas/contareceber/ para obter essa informação.

Retorno 15O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodBarras`	texto	Código de barras do Boleto.
`cCodStatus`	texto	Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro durante o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido.
`cDesStatus`	texto	Descrição do status do processamento. Essa tag explica o resultado da tag "cCodStatus".
`cLinkBoleto`	texto	Link do Boleto.
`cNumBancario`	texto	Número bancário do boleto.
`cNumBoleto`	texto	Número do boleto.
`dDescontoCond1`	texto	Data de desconto condicional.
`dDescontoCond2`	texto	Data do desconto condicional.
`dDescontoCond3`	texto	Data do desconto condicional.
`dDtEmBol`	texto	Data de emissão do boleto.
`nPerJuros`	decimal	Percentual de juros.
`nPerMulta`	decimal	Percentual de multa.
`vDescontoCond1`	decimal	Valor do desconto condicional.
`vDescontoCond2`	decimal	Valor do desconto condicional.
`vDescontoCond3`	decimal	Valor do desconto condicional.

POST /api/v1/financas/contareceberboleto/

curl -s https://app.omie.com.br/api/v1/financas/contareceberboleto/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "GerarBoleto", "param": [{"nCodTitulo": 0, "cCodIntTitulo": ""}]}'

import os
import requests

corpo = {'call': 'GerarBoleto', 'param': [{'nCodTitulo': 0, 'cCodIntTitulo': ''}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/contareceberboleto/",
    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/contareceberboleto/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "GerarBoleto",
    "param": [
      {
        "nCodTitulo": 0,
        "cCodIntTitulo": ""
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contareceberboleto/");
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": "GerarBoleto",
    "param": [
        {
            "nCodTitulo": 0,
            "cCodIntTitulo": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/contareceberboleto/")
corpo = <<~'JSON'
{
  "call": "GerarBoleto",
  "param": [
    {
      "nCodTitulo": 0,
      "cCodIntTitulo": ""
    }
  ]
}
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": "GerarBoleto",
  "param": [
    {
      "nCodTitulo": 0,
      "cCodIntTitulo": ""
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/contareceberboleto/"))
    .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/contareceberboleto/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""GerarBoleto"", ""param"": [{""nCodTitulo"": 0, ""cCodIntTitulo"": """"}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ObterBoleto

consultaClaudeMCP

Disponibiliza o link de Download do Boleto. ATENÇÃO: Os boletos gerados e já enviados ao banco estão sujeitos a tarifação (de emissão, cancelamento ou de alteração da data de vencimento do boleto).

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCodIntTitulo`	texto · até 60	Código de Integração do Título. Utilize a tag "codigo_lancamento_integracao" do método "ListarContasReceber" da API /api/v1/financas/contareceber/ para obter essa informação.
`nCodTitulo`	número inteiro	Código do título Código Interno do título no Omie. Utilize a tag "codigo_lancamento_omie" do método "ListarContasReceber" da API /api/v1/financas/contareceber/ para obter essa informação.

Retorno 15O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodBarras`	texto	Código de barras do Boleto.
`cCodStatus`	texto	Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro durante o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido.
`cDesStatus`	texto	Descrição do status do processamento. Essa tag explica o resultado da tag "cCodStatus".
`cLinkBoleto`	texto	Link do Boleto.
`cNumBancario`	texto	Número bancário do boleto.
`cNumBoleto`	texto	Número do boleto.
`dDescontoCond1`	texto	Data de desconto condicional.
`dDescontoCond2`	texto	Data do desconto condicional.
`dDescontoCond3`	texto	Data do desconto condicional.
`dDtEmBol`	texto	Data de emissão do boleto.
`nPerJuros`	decimal	Percentual de juros.
`nPerMulta`	decimal	Percentual de multa.
`vDescontoCond1`	decimal	Valor do desconto condicional.
`vDescontoCond2`	decimal	Valor do desconto condicional.
`vDescontoCond3`	decimal	Valor do desconto condicional.

POST /api/v1/financas/contareceberboleto/

curl -s https://app.omie.com.br/api/v1/financas/contareceberboleto/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterBoleto", "param": [{"nCodTitulo": 0, "cCodIntTitulo": ""}]}'

import os
import requests

corpo = {'call': 'ObterBoleto', 'param': [{'nCodTitulo': 0, 'cCodIntTitulo': ''}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/contareceberboleto/",
    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/contareceberboleto/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ObterBoleto",
    "param": [
      {
        "nCodTitulo": 0,
        "cCodIntTitulo": ""
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contareceberboleto/");
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": "ObterBoleto",
    "param": [
        {
            "nCodTitulo": 0,
            "cCodIntTitulo": ""
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/contareceberboleto/")
corpo = <<~'JSON'
{
  "call": "ObterBoleto",
  "param": [
    {
      "nCodTitulo": 0,
      "cCodIntTitulo": ""
    }
  ]
}
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": "ObterBoleto",
  "param": [
    {
      "nCodTitulo": 0,
      "cCodIntTitulo": ""
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/contareceberboleto/"))
    .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/contareceberboleto/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ObterBoleto"", ""param"": [{""nCodTitulo"": 0, ""cCodIntTitulo"": """"}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ProrrogarBoleto

altera dadosClaudeMCP

Prorroga o vencimento do Boleto. ATENÇÃO: Os boletos gerados e já enviados ao banco estão sujeitos a tarifação (de emissão, cancelamento ou de alteração da data de vencimento do boleto).

Obrigatórios 1

Campo	Tipo	Descrição
`dDtVenc`	texto · até 10	Data de vencimento.

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`cCodIntTitulo`	texto · até 60	Código de Integração do Título. Utilize a tag "codigo_lancamento_integracao" do método "ListarContasReceber" da API /api/v1/financas/contareceber/ para obter essa informação.
`nCodTitulo`	número inteiro	Código do título Código Interno do título no Omie. Utilize a tag "codigo_lancamento_omie" do método "ListarContasReceber" da API /api/v1/financas/contareceber/ para obter essa informação.

Retorno 15O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`cCodBarras`	texto	Código de barras do Boleto.
`cCodStatus`	texto	Código do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro durante o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido.
`cDesStatus`	texto	Descrição do status do processamento. Essa tag explica o resultado da tag "cCodStatus".
`cLinkBoleto`	texto	Link do Boleto.
`cNumBancario`	texto	Número bancário do boleto.
`cNumBoleto`	texto	Número do boleto.
`dDescontoCond1`	texto	Data de desconto condicional.
`dDescontoCond2`	texto	Data do desconto condicional.
`dDescontoCond3`	texto	Data do desconto condicional.
`dDtEmBol`	texto	Data de emissão do boleto.
`nPerJuros`	decimal	Percentual de juros.
`nPerMulta`	decimal	Percentual de multa.
`vDescontoCond1`	decimal	Valor do desconto condicional.
`vDescontoCond2`	decimal	Valor do desconto condicional.
`vDescontoCond3`	decimal	Valor do desconto condicional.

POST /api/v1/financas/contareceberboleto/

curl -s https://app.omie.com.br/api/v1/financas/contareceberboleto/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ProrrogarBoleto", "param": [{"nCodTitulo": 0, "cCodIntTitulo": "", "dDtVenc": "30/09/2026"}]}'

import os
import requests

corpo = {'call': 'ProrrogarBoleto',
 'param': [{'nCodTitulo': 0, 'cCodIntTitulo': '', 'dDtVenc': '30/09/2026'}]}

resp = requests.post(
    "https://app.omie.com.br/api/v1/financas/contareceberboleto/",
    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/contareceberboleto/", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "call": "ProrrogarBoleto",
    "param": [
      {
        "nCodTitulo": 0,
        "cCodIntTitulo": "",
        "dDtVenc": "30/09/2026"
      }
    ]
  }),
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/contareceberboleto/");
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": "ProrrogarBoleto",
    "param": [
        {
            "nCodTitulo": 0,
            "cCodIntTitulo": "",
            "dDtVenc": "30/09/2026"
        }
    ]
}
JSON,
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/v1/financas/contareceberboleto/")
corpo = <<~'JSON'
{
  "call": "ProrrogarBoleto",
  "param": [
    {
      "nCodTitulo": 0,
      "cCodIntTitulo": "",
      "dDtVenc": "30/09/2026"
    }
  ]
}
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": "ProrrogarBoleto",
  "param": [
    {
      "nCodTitulo": 0,
      "cCodIntTitulo": "",
      "dDtVenc": "30/09/2026"
    }
  ]
}
""";

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/v1/financas/contareceberboleto/"))
    .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/contareceberboleto/",
        [
            Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""call"": ""ProrrogarBoleto"", ""param"": [{""nCodTitulo"": 0, ""cCodIntTitulo"": """", ""dDtVenc"": ""30/09/2026""}]}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

CancelarBoleto
GerarBoleto
ObterBoleto
ProrrogarBoleto