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

Lançamento de contas a receber a partir do código de barras do boleto

POSThttps://app.omie.com.br/api/v1/financas/contareceber-barras/WSDL
0consultas
1alteração
Claude · MCPpelos assistentes de IA
JSON · XMLformato

IncluirContaReceberCodBar

altera dadosClaudeMCP

Inclui uma conta a receber a partir de um código de barras.

Obrigatórios 2

CampoTipoDescrição
dVencimentotexto · até 10Data 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.
vDocumentonúmeroValor 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
CampoTipoDescrição
cCodCategtexto · até 20Có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.
cCodigoBarrastexto · até 70Código de barras ou linha digitável do boleto.
cCpfCnpjtexto · até 60CNPJ 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.
cDocumentotexto · até 20Nú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.
cObservacaotextoObservaçõ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.
dPrevisaotexto · até 10Data da previsão de recebimento, no formato dd/mm/aaaa. Se não informada, assume a data de hoje.
nIdClientenúmero inteiroID 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.
nIdContanúmero inteiroCó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
CampoTipoDescrição
cCodStatustextoCódigo do status do processamento. "0" indica sucesso.
cDesStatustextoDescrição do status do processamento.
nIdTitulonúmero inteiroCó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": ""}]}'