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

Lançamento de Contas a Receber

POSThttps://app.omie.com.br/api/v1/financas/contareceber/WSDL
2consultas
11alterações
Claude 13 de 13 · ChatGPT 5 de 13 · MCP 13 de 13pelos assistentes de IA
JSON · XMLformato

AlterarContaReceber

altera dadosClaudeChatGPTMCP

Altera um conta a receber

Obrigatórios 1

CampoTipoDescrição
recebimentoobjetoDetalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, 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 "Recebimentos" no cadastro do lançamento.
recebimento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
recebimento.codigo_recebimento_integracaotexto · até 20
recebimento.datatexto · até 10Data da Baixa
recebimento.descontonúmeroValor do desconto.
recebimento.jurosnúmeroValor do Juros.
recebimento.multanúmeroValor da multa.
recebimento.observacaotextoObservação da Baixa do Contas a Receber.
recebimento.valornúmeroValor a ser baixado.
Opcionais 57Campos e estruturas que você pode enviar
CampoTipoDescrição
acaotextoA-Adiciona Valor / S-Subtrai valor / L-Lança valor.
aprendizado_rateiotexto · até 1Aprendizado 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_documentotexto · até 1Efetua a baixa automática do documento.
bloqueadotexto · até 1Bloquear lançamento (S/N)
bloquear_baixatexto · até 1bloquear a baixa do lançamento
bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
boletoobjetoInformações do boleto.
boleto.cGeradotexto · até 1Gerou boleto (S/N)?
boleto.cNumBancariotexto · até 30Número bancário do boleto.
boleto.cNumBoletotexto · até 30Número do boleto.
boleto.dDtEmBoltexto · até 10Data de emissão do boleto.
boleto.nPerJurosnúmeroPercentual de juros.
boleto.nPerMultanúmeroPercentual de multa.
cNumeroContratotexto · até 20Número do contrato do cliente.
cPedidoClientetexto · até 30Número do pedido do cliente.
categoriaslista de objetos
categorias[].codigo_categoriatexto · até 20
categorias[].percentualnúmeroPercentual da categoria
categorias[].valornúmero
chave_nfetexto · até 44Chave de Acesso da NFE
codigo_barras_ficha_compensacaotexto · até 70Código de Barras da Ficha de Compensação
codigo_categoriatexto · até 20Código da Categoria
codigo_cliente_fornecedornúmero inteiroCódigo de Cliente / Fornecedor
codigo_cliente_fornecedor_integracaotexto · até 60Código do cliente informado pelo integrador.
codigo_cmc7_chequetexto · até 40Código CMC7 do Cheque
codigo_lancamento_integracaotexto · até 60Código do lançamento gerado pelo integrador.
codigo_lancamento_omienúmero inteiroChave do Lançamento
codigo_projetonúmero inteiroCódigo do Projeto
codigo_tipo_documentotexto · até 5Código para o Tipo de Documento
codigo_vendedornúmero inteiroCódigo do Vendedor
conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente.
data_emissaotexto · até 10Data de Emissão
data_previsaotexto · até 10Data de Previsão de Pagamento/Recebimento
data_registrotexto · até 10Data de Registro
data_vencimentotexto · até 10Data de Vencimento
distribuicaolista de objetosDistribuição por Departamentos
distribuicao[].cCodDeptexto · até 40Código do Departamento
distribuicao[].cDesDeptexto · até 50Descrição do Departamento
distribuicao[].nPerDepnúmeroPercentual do rateio
distribuicao[].nValDepnúmeroValor do rateio
id_conta_correntenúmero inteiroId da Conta Corrente
id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Receber. Os valores disponíveis são: "APIR" - Integração de Conta a Receber "BARR" - Conta a Receber Importada por Código de Barras "CTER" - Parcela a Receber de um CT-e "DEVR" - Conta a Receber da Devolução ao Fornecedor "MANR" - Lançamento Manual de Conta a Receber "NFER" - Conta a Receber Importada de uma NF-e "RPTR" - Repetição de Contas a Receber "VENR" - Parcela a Receber de Vendas "XMLR" - Conta a Receber Importada de um arquivo XML
importado_apitexto · até 1Lançamento gerado pela API
infoobjetoInformações complementares do anexo.
info.cImpAPItexto · até 1Importado pela API (S/N).
info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa.
info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa.
info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss.
info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss.
info.uAlttexto · até 10Usuário da Alteração.
info.uInctexto · até 10Usuário da Inclusão.
lancamento_detalhelista de objetos
lancamento_detalhe[].CCFtexto · até 20
lancamento_detalhe[].COOtexto · até 20
lancamento_detalhe[].nCodInttexto · até 20Código de Integração
nCodOSnúmero inteiroID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente.
nCodPedidonúmero inteiroID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie.
nsutexto · até 100Número Sequencial Único - Comprovante de pagamento.
numero_documentotexto · até 20Número do Documento
numero_documento_fiscaltexto · até 20Número do Documento Fiscal
numero_parcelatexto · até 7Número da parcela "Formatada" como 999/999
numero_pedidotexto · até 15Número do Pedido
observacaotextoObservação
operacaotexto · até 2Operação
repeticaoobjetoRepetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags "mensal", "semanal" ou "especifico" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba "Repetição" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração.
repeticao.antecipartexto · até 1Antecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
repeticao.especificoobrigatórioobjetoRepetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.especifico.repetir_a_cadanúmero inteiroInforme aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias.
repeticao.especifico.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
repeticao.mensalobrigatórioobjetoRepetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.mensal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
repeticao.mensal.repetir_todo_dianúmero inteiroInforme aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês.
repeticao.postergartexto · até 1Postergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
repeticao.semanalobrigatórioobjetoRepetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.semanal.repetir_dia_semanatexto · até 10Informe o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado
repeticao.semanal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
retem_cofinstexto · até 1Indica que o Valor do COFINS informado deve ser retido
retem_cslltexto · até 1Indica que o Valor do CSLL informado deve ser retido
retem_insstexto · até 1Indica que o Valor do INSS informado deve ser retido
retem_irtexto · até 1Indica que o Valor do Imposto de Renda informado deve ser retido
retem_isstexto · até 1Indica que o Valor do ISS informado deve ser retido
retem_pistexto · até 1Indica que o Valor do PIS informado deve ser retido
status_titulotexto · até 100Status do Título
tipo_agrupamentotexto · até 1Tipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV.
valor_cofinsnúmeroValor do COFINS
valor_csllnúmeroValor do CSLL
valor_documentonúmeroValor do Lançamento
valor_inssnúmeroValor do INSS
valor_irnúmeroValor do Imposto de Renda
valor_issnúmeroValor do ISS
valor_pisnúmeroValor do PIS
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
codigo_lancamento_omienúmero inteiro
codigo_statustexto
descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AlterarContaReceber", "param": [{"codigo_lancamento_integracao": "1790774979", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "1.01.02", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}'

CancelarContaReceber

altera dadosClaudeMCP

Cancelamento do boleto gerado de uma conta a receber

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
chave_lancamentonúmero inteiroCódigo do lançamento no Omie. É o codigo_lancamento_omie que IncluirContaReceber e ListarContasReceber devolvem.
codigo_lancamento_integracaotexto · até 60Código do lançamento gerado pelo integrador.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
codigo_lancamento_omienúmero inteiro
codigo_statustexto
descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarContaReceber", "param": [{"chave_lancamento": 0}]}'

CancelarRecebimento

altera dadosClaudeMCP

Efetua o cancelamento de um recebimento de Contas a Receber.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo para identificar a baixa do título no Contas a Receber.
codigo_baixa_integracaotexto · até 20Código da baixa do integrador para identificar a baixa de um título do contas a receber.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo da baixa do contas a receber no Omie.
codigo_baixa_integracaotextoCódigo da baixa do integrador para identificar a baixa do título do contas a receber.
codigo_statustextoCódigo do Status da baixa.
descricao_statustextoDescrição do status da baixa do contas a receber.
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarRecebimento", "param": [{"codigo_baixa": 0}]}'

ConciliarRecebimento

altera dadosClaudeMCP

Efetua a conciliação da baixa

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo da Baixa
codigo_baixa_integracaotexto · até 20Código de Integração da Baixa
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo da Baixa
codigo_baixa_integracaotextoCódigo de Integração da Baixa
codigo_statustexto
descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConciliarRecebimento", "param": [{"codigo_baixa": 0}]}'

ConsultarContaReceber

consultaClaudeChatGPTMCP

Consulta uma Conta a Receber

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_lancamento_integracaotexto · até 60Código de integração do Lançamento.
codigo_lancamento_omienúmero inteiro
Retorno 58O que volta numa chamada bem-sucedida
CampoTipoDescrição
acaotextoA-Adiciona Valor / S-Subtrai valor / L-Lança valor.
aprendizado_rateiotextoAprendizado 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_documentotextoEfetua a baixa automática do documento.
bloqueadotextoBloquear lançamento (S/N)
bloquear_baixatextobloquear a baixa do lançamento
bloquear_exclusaotextoBloqueia a exclusão do registro. (S/N)
boletoobjetoInformações do boleto.
boleto.cGeradotextoGerou boleto (S/N)?
boleto.cNumBancariotextoNúmero bancário do boleto.
boleto.cNumBoletotextoNúmero do boleto.
boleto.dDtEmBoltextoData de emissão do boleto.
boleto.nPerJurosdecimalPercentual de juros.
boleto.nPerMultadecimalPercentual de multa.
cNumeroContratotextoNúmero do contrato do cliente.
cPedidoClientetextoNúmero do pedido do cliente.
categoriaslista de objetos
categorias[].codigo_categoriatexto
categorias[].percentualdecimalPercentual da categoria
categorias[].valordecimal
chave_nfetextoChave de Acesso da NFE
codigo_barras_ficha_compensacaotextoCódigo de Barras da Ficha de Compensação
codigo_categoriatextoCódigo da Categoria
codigo_cliente_fornecedornúmero inteiroCódigo de Cliente / Fornecedor
codigo_cliente_fornecedor_integracaotextoCódigo do cliente informado pelo integrador.
codigo_cmc7_chequetextoCódigo CMC7 do Cheque
codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
codigo_lancamento_omienúmero inteiroChave do Lançamento
codigo_projetonúmero inteiroCódigo do Projeto
codigo_tipo_documentotextoCódigo para o Tipo de Documento
codigo_vendedornúmero inteiroCódigo do Vendedor
conciliar_documentotextoEfetua a conciliação do documento automaticamente.
data_emissaotextoData de Emissão
data_previsaotextoData de Previsão de Pagamento/Recebimento
data_registrotextoData de Registro
data_vencimentotextoData de Vencimento
distribuicaolista de objetosDistribuição por Departamentos
distribuicao[].cCodDeptextoCódigo do Departamento
distribuicao[].cDesDeptextoDescrição do Departamento
distribuicao[].nPerDepdecimalPercentual do rateio
distribuicao[].nValDepdecimalValor do rateio
id_conta_correntenúmero inteiroId da Conta Corrente
id_origemtextoCódigo da Origem. Informação localizada na Aba "Diversos" do Contas a Receber. Os valores disponíveis são: "APIR" - Integração de Conta a Receber "BARR" - Conta a Receber Importada por Código de Barras "CTER" - Parcela a Receber de um CT-e "DEVR" - Conta a Receber da Devolução ao Fornecedor "MANR" - Lançamento Manual de Conta a Receber "NFER" - Conta a Receber Importada de uma NF-e "RPTR" - Repetição de Contas a Receber "VENR" - Parcela a Receber de Vendas "XMLR" - Conta a Receber Importada de um arquivo XML
importado_apitextoLançamento gerado pela API
infoobjetoInformações complementares do anexo.
info.cImpAPItextoImportado pela API (S/N).
info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
info.hAlttextoHora da Alteração. No formato hh:mm:ss.
info.hInctextoHora da Inclusão. No formato hh:mm:ss.
info.uAlttextoUsuário da Alteração.
info.uInctextoUsuário da Inclusão.
lancamento_detalhelista de objetos
lancamento_detalhe[].CCFtexto
lancamento_detalhe[].COOtexto
lancamento_detalhe[].nCodInttextoCódigo de Integração
nCodOSnúmero inteiroID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente.
nCodPedidonúmero inteiroID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie.
nsutextoNúmero Sequencial Único - Comprovante de pagamento.
numero_documentotextoNúmero do Documento
numero_documento_fiscaltextoNúmero do Documento Fiscal
numero_parcelatextoNúmero da parcela "Formatada" como 999/999
numero_pedidotextoNúmero do Pedido
observacaotextoObservação
operacaotextoOperação
recebimentoobjetoDetalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, 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 "Recebimentos" no cadastro do lançamento.
recebimento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
recebimento.codigo_recebimento_integracaotexto
recebimento.datatextoData da Baixa
recebimento.descontodecimalValor do desconto.
recebimento.jurosdecimalValor do Juros.
recebimento.multadecimalValor da multa.
recebimento.observacaotextoObservação da Baixa do Contas a Receber.
recebimento.valordecimalValor a ser baixado.
repeticaoobjetoRepetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags "mensal", "semanal" ou "especifico" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba "Repetição" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração.
repeticao.antecipartextoAntecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
repeticao.especificoobjetoRepetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.especifico.repetir_a_cadanúmero inteiroInforme aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias.
repeticao.especifico.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
repeticao.mensalobjetoRepetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.mensal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
repeticao.mensal.repetir_todo_dianúmero inteiroInforme aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês.
repeticao.postergartextoPostergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
repeticao.semanalobjetoRepetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.semanal.repetir_dia_semanatextoInforme o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado
repeticao.semanal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
retem_cofinstextoIndica que o Valor do COFINS informado deve ser retido
retem_cslltextoIndica que o Valor do CSLL informado deve ser retido
retem_insstextoIndica que o Valor do INSS informado deve ser retido
retem_irtextoIndica que o Valor do Imposto de Renda informado deve ser retido
retem_isstextoIndica que o Valor do ISS informado deve ser retido
retem_pistextoIndica que o Valor do PIS informado deve ser retido
status_titulotextoStatus do Título
tipo_agrupamentotextoTipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV.
valor_cofinsdecimalValor do COFINS
valor_cslldecimalValor do CSLL
valor_documentodecimalValor do Lançamento
valor_inssdecimalValor do INSS
valor_irdecimalValor do Imposto de Renda
valor_issdecimalValor do ISS
valor_pisdecimalValor do PIS
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarContaReceber", "param": [{"codigo_lancamento_omie": 0, "codigo_lancamento_integracao": ""}]}'

DesconciliarRecebimento

altera dadosClaudeMCP

Desconciliar o Recebimento

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo da Baixa
codigo_baixa_integracaotexto · até 20Código de Integração da Baixa
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo da Baixa
codigo_baixa_integracaotextoCódigo de Integração da Baixa
codigo_statustexto
descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "DesconciliarRecebimento", "param": [{"codigo_baixa": 0}]}'

ExcluirContaReceber

altera dadosClaudeMCP

Exclui uma conta a receber

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
chave_lancamentonúmero inteiroCódigo do lançamento no Omie. É o codigo_lancamento_omie que IncluirContaReceber e ListarContasReceber devolvem.
codigo_lancamento_integracaotexto · até 60Código do lançamento gerado pelo integrador.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
codigo_lancamento_omienúmero inteiro
codigo_statustexto
descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ExcluirContaReceber", "param": [{"chave_lancamento": 0}]}'

IncluirContaReceber

altera dadosClaudeChatGPTMCP

Inclui uma conta a Receber

Obrigatórios 4

CampoTipoDescrição
codigo_lancamento_integracaotexto · até 60Código do lançamento gerado pelo integrador.
data_vencimentotexto · até 10Data de Vencimento
recebimentoobjetoDetalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, 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 "Recebimentos" no cadastro do lançamento.
recebimento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
recebimento.codigo_recebimento_integracaotexto · até 20
recebimento.datatexto · até 10Data da Baixa
recebimento.descontonúmeroValor do desconto.
recebimento.jurosnúmeroValor do Juros.
recebimento.multanúmeroValor da multa.
recebimento.observacaotextoObservação da Baixa do Contas a Receber.
recebimento.valornúmeroValor a ser baixado.
valor_documentonúmeroValor do Lançamento
Opcionais 54Campos e estruturas que você pode enviar
CampoTipoDescrição
acaotextoA-Adiciona Valor / S-Subtrai valor / L-Lança valor.
aprendizado_rateiotexto · até 1Aprendizado 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_documentotexto · até 1Efetua a baixa automática do documento.
bloqueadotexto · até 1Bloquear lançamento (S/N)
bloquear_baixatexto · até 1bloquear a baixa do lançamento
bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
boletoobjetoInformações do boleto.
boleto.cGeradotexto · até 1Gerou boleto (S/N)?
boleto.cNumBancariotexto · até 30Número bancário do boleto.
boleto.cNumBoletotexto · até 30Número do boleto.
boleto.dDtEmBoltexto · até 10Data de emissão do boleto.
boleto.nPerJurosnúmeroPercentual de juros.
boleto.nPerMultanúmeroPercentual de multa.
cNumeroContratotexto · até 20Número do contrato do cliente.
cPedidoClientetexto · até 30Número do pedido do cliente.
categoriaslista de objetos
categorias[].codigo_categoriatexto · até 20
categorias[].percentualnúmeroPercentual da categoria
categorias[].valornúmero
chave_nfetexto · até 44Chave de Acesso da NFE
codigo_barras_ficha_compensacaotexto · até 70Código de Barras da Ficha de Compensação
codigo_categoriatexto · até 20Código da Categoria
codigo_cliente_fornecedornúmero inteiroCódigo de Cliente / Fornecedor
codigo_cliente_fornecedor_integracaotexto · até 60Código do cliente informado pelo integrador.
codigo_cmc7_chequetexto · até 40Código CMC7 do Cheque
codigo_lancamento_omienúmero inteiroChave do Lançamento
codigo_projetonúmero inteiroCódigo do Projeto
codigo_tipo_documentotexto · até 5Código para o Tipo de Documento
codigo_vendedornúmero inteiroCódigo do Vendedor
conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente.
data_emissaotexto · até 10Data de Emissão
data_previsaotexto · até 10Data de Previsão de Pagamento/Recebimento
data_registrotexto · até 10Data de Registro
distribuicaolista de objetosDistribuição por Departamentos
distribuicao[].cCodDeptexto · até 40Código do Departamento
distribuicao[].cDesDeptexto · até 50Descrição do Departamento
distribuicao[].nPerDepnúmeroPercentual do rateio
distribuicao[].nValDepnúmeroValor do rateio
id_conta_correntenúmero inteiroId da Conta Corrente
id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Receber. Os valores disponíveis são: "APIR" - Integração de Conta a Receber "BARR" - Conta a Receber Importada por Código de Barras "CTER" - Parcela a Receber de um CT-e "DEVR" - Conta a Receber da Devolução ao Fornecedor "MANR" - Lançamento Manual de Conta a Receber "NFER" - Conta a Receber Importada de uma NF-e "RPTR" - Repetição de Contas a Receber "VENR" - Parcela a Receber de Vendas "XMLR" - Conta a Receber Importada de um arquivo XML
importado_apitexto · até 1Lançamento gerado pela API
infoobjetoInformações complementares do anexo.
info.cImpAPItexto · até 1Importado pela API (S/N).
info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa.
info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa.
info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss.
info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss.
info.uAlttexto · até 10Usuário da Alteração.
info.uInctexto · até 10Usuário da Inclusão.
lancamento_detalhelista de objetos
lancamento_detalhe[].CCFtexto · até 20
lancamento_detalhe[].COOtexto · até 20
lancamento_detalhe[].nCodInttexto · até 20Código de Integração
nCodOSnúmero inteiroID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente.
nCodPedidonúmero inteiroID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie.
nsutexto · até 100Número Sequencial Único - Comprovante de pagamento.
numero_documentotexto · até 20Número do Documento
numero_documento_fiscaltexto · até 20Número do Documento Fiscal
numero_parcelatexto · até 7Número da parcela "Formatada" como 999/999
numero_pedidotexto · até 15Número do Pedido
observacaotextoObservação
operacaotexto · até 2Operação
repeticaoobjetoRepetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags "mensal", "semanal" ou "especifico" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba "Repetição" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração.
repeticao.antecipartexto · até 1Antecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
repeticao.especificoobrigatórioobjetoRepetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.especifico.repetir_a_cadanúmero inteiroInforme aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias.
repeticao.especifico.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
repeticao.mensalobrigatórioobjetoRepetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.mensal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
repeticao.mensal.repetir_todo_dianúmero inteiroInforme aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês.
repeticao.postergartexto · até 1Postergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
repeticao.semanalobrigatórioobjetoRepetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.semanal.repetir_dia_semanatexto · até 10Informe o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado
repeticao.semanal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
retem_cofinstexto · até 1Indica que o Valor do COFINS informado deve ser retido
retem_cslltexto · até 1Indica que o Valor do CSLL informado deve ser retido
retem_insstexto · até 1Indica que o Valor do INSS informado deve ser retido
retem_irtexto · até 1Indica que o Valor do Imposto de Renda informado deve ser retido
retem_isstexto · até 1Indica que o Valor do ISS informado deve ser retido
retem_pistexto · até 1Indica que o Valor do PIS informado deve ser retido
status_titulotexto · até 100Status do Título
tipo_agrupamentotexto · até 1Tipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV.
valor_cofinsnúmeroValor do COFINS
valor_csllnúmeroValor do CSLL
valor_inssnúmeroValor do INSS
valor_irnúmeroValor do Imposto de Renda
valor_issnúmeroValor do ISS
valor_pisnúmeroValor do PIS
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
codigo_lancamento_omienúmero inteiro
codigo_statustexto
descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirContaReceber", "param": [{"codigo_lancamento_integracao": "1790774979", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "1.01.02", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}'

IncluirContaReceberPorLote

altera dadosClaudeMCP

Incluir Lançamentos de contas a receber por lote. (Máximo de 50).

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
conta_receber_cadastrolista de objetos
conta_receber_cadastro[].acaotextoA-Adiciona Valor / S-Subtrai valor / L-Lança valor.
conta_receber_cadastro[].aprendizado_rateiotexto · até 1Aprendizado 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_receber_cadastro[].baixar_documentotexto · até 1Efetua a baixa automática do documento.
conta_receber_cadastro[].bloqueadotexto · até 1Bloquear lançamento (S/N)
conta_receber_cadastro[].bloquear_baixatexto · até 1bloquear a baixa do lançamento
conta_receber_cadastro[].bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
conta_receber_cadastro[].boletoobjetoInformações do boleto.
conta_receber_cadastro[].boleto.cGeradotexto · até 1Gerou boleto (S/N)?
conta_receber_cadastro[].boleto.cNumBancariotexto · até 30Número bancário do boleto.
conta_receber_cadastro[].boleto.cNumBoletotexto · até 30Número do boleto.
conta_receber_cadastro[].boleto.dDtEmBoltexto · até 10Data de emissão do boleto.
conta_receber_cadastro[].boleto.nPerJurosnúmeroPercentual de juros.
conta_receber_cadastro[].boleto.nPerMultanúmeroPercentual de multa.
conta_receber_cadastro[].cNumeroContratotexto · até 20Número do contrato do cliente.
conta_receber_cadastro[].cPedidoClientetexto · até 30Número do pedido do cliente.
conta_receber_cadastro[].categoriaslista de objetos
conta_receber_cadastro[].categorias[].codigo_categoriatexto · até 20
conta_receber_cadastro[].categorias[].percentualnúmeroPercentual da categoria
conta_receber_cadastro[].categorias[].valornúmero
conta_receber_cadastro[].chave_nfetexto · até 44Chave de Acesso da NFE
conta_receber_cadastro[].codigo_barras_ficha_compensacaotexto · até 70Código de Barras da Ficha de Compensação
conta_receber_cadastro[].codigo_categoriatexto · até 20Código da Categoria
conta_receber_cadastro[].codigo_cliente_fornecedornúmero inteiroCódigo de Cliente / Fornecedor
conta_receber_cadastro[].codigo_cliente_fornecedor_integracaotexto · até 60Código do cliente informado pelo integrador.
conta_receber_cadastro[].codigo_cmc7_chequetexto · até 40Código CMC7 do Cheque
conta_receber_cadastro[].codigo_lancamento_integracaotexto · até 60Código do lançamento gerado pelo integrador.
conta_receber_cadastro[].codigo_lancamento_omienúmero inteiroChave do Lançamento
conta_receber_cadastro[].codigo_projetonúmero inteiroCódigo do Projeto
conta_receber_cadastro[].codigo_tipo_documentotexto · até 5Código para o Tipo de Documento
conta_receber_cadastro[].codigo_vendedornúmero inteiroCódigo do Vendedor
conta_receber_cadastro[].conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente.
conta_receber_cadastro[].data_emissaotexto · até 10Data de Emissão
conta_receber_cadastro[].data_previsaotexto · até 10Data de Previsão de Pagamento/Recebimento
conta_receber_cadastro[].data_registrotexto · até 10Data de Registro
conta_receber_cadastro[].data_vencimentotexto · até 10Data de Vencimento
conta_receber_cadastro[].distribuicaolista de objetosDistribuição por Departamentos
conta_receber_cadastro[].distribuicao[].cCodDeptexto · até 40Código do Departamento
conta_receber_cadastro[].distribuicao[].cDesDeptexto · até 50Descrição do Departamento
conta_receber_cadastro[].distribuicao[].nPerDepnúmeroPercentual do rateio
conta_receber_cadastro[].distribuicao[].nValDepnúmeroValor do rateio
conta_receber_cadastro[].id_conta_correntenúmero inteiroId da Conta Corrente
conta_receber_cadastro[].id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Receber. Os valores disponíveis são: "APIR" - Integração de Conta a Receber "BARR" - Conta a Receber Importada por Código de Barras "CTER" - Parcela a Receber de um CT-e "DEVR" - Conta a Receber da Devolução ao Fornecedor "MANR" - Lançamento Manual de Conta a Receber "NFER" - Conta a Receber Importada de uma NF-e "RPTR" - Repetição de Contas a Receber "VENR" - Parcela a Receber de Vendas "XMLR" - Conta a Receber Importada de um arquivo XML
conta_receber_cadastro[].importado_apitexto · até 1Lançamento gerado pela API
conta_receber_cadastro[].infoobjetoInformações complementares do anexo.
conta_receber_cadastro[].info.cImpAPItexto · até 1Importado pela API (S/N).
conta_receber_cadastro[].info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa.
conta_receber_cadastro[].info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa.
conta_receber_cadastro[].info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss.
conta_receber_cadastro[].info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss.
conta_receber_cadastro[].info.uAlttexto · até 10Usuário da Alteração.
conta_receber_cadastro[].info.uInctexto · até 10Usuário da Inclusão.
conta_receber_cadastro[].lancamento_detalhelista de objetos
conta_receber_cadastro[].lancamento_detalhe[].CCFtexto · até 20
conta_receber_cadastro[].lancamento_detalhe[].COOtexto · até 20
conta_receber_cadastro[].lancamento_detalhe[].nCodInttexto · até 20Código de Integração
conta_receber_cadastro[].nCodOSnúmero inteiroID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente.
conta_receber_cadastro[].nCodPedidonúmero inteiroID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie.
conta_receber_cadastro[].nsutexto · até 100Número Sequencial Único - Comprovante de pagamento.
conta_receber_cadastro[].numero_documentotexto · até 20Número do Documento
conta_receber_cadastro[].numero_documento_fiscaltexto · até 20Número do Documento Fiscal
conta_receber_cadastro[].numero_parcelatexto · até 7Número da parcela "Formatada" como 999/999
conta_receber_cadastro[].numero_pedidotexto · até 15Número do Pedido
conta_receber_cadastro[].observacaotextoObservação
conta_receber_cadastro[].operacaotexto · até 2Operação
conta_receber_cadastro[].recebimentoobrigatórioobjetoDetalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, 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 "Recebimentos" no cadastro do lançamento.
conta_receber_cadastro[].recebimento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
conta_receber_cadastro[].recebimento.codigo_recebimento_integracaotexto · até 20
conta_receber_cadastro[].recebimento.datatexto · até 10Data da Baixa
conta_receber_cadastro[].recebimento.descontonúmeroValor do desconto.
conta_receber_cadastro[].recebimento.jurosnúmeroValor do Juros.
conta_receber_cadastro[].recebimento.multanúmeroValor da multa.
conta_receber_cadastro[].recebimento.observacaotextoObservação da Baixa do Contas a Receber.
conta_receber_cadastro[].recebimento.valornúmeroValor a ser baixado.
conta_receber_cadastro[].repeticaoobjetoRepetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags "mensal", "semanal" ou "especifico" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba "Repetição" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração.
conta_receber_cadastro[].repeticao.antecipartexto · até 1Antecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
conta_receber_cadastro[].repeticao.especificoobrigatórioobjetoRepetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.especifico.repetir_a_cadanúmero inteiroInforme aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias.
conta_receber_cadastro[].repeticao.especifico.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].repeticao.mensalobrigatórioobjetoRepetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.mensal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].repeticao.mensal.repetir_todo_dianúmero inteiroInforme aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês.
conta_receber_cadastro[].repeticao.postergartexto · até 1Postergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
conta_receber_cadastro[].repeticao.semanalobrigatórioobjetoRepetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.semanal.repetir_dia_semanatexto · até 10Informe o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado
conta_receber_cadastro[].repeticao.semanal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].retem_cofinstexto · até 1Indica que o Valor do COFINS informado deve ser retido
conta_receber_cadastro[].retem_cslltexto · até 1Indica que o Valor do CSLL informado deve ser retido
conta_receber_cadastro[].retem_insstexto · até 1Indica que o Valor do INSS informado deve ser retido
conta_receber_cadastro[].retem_irtexto · até 1Indica que o Valor do Imposto de Renda informado deve ser retido
conta_receber_cadastro[].retem_isstexto · até 1Indica que o Valor do ISS informado deve ser retido
conta_receber_cadastro[].retem_pistexto · até 1Indica que o Valor do PIS informado deve ser retido
conta_receber_cadastro[].status_titulotexto · até 100Status do Título
conta_receber_cadastro[].tipo_agrupamentotexto · até 1Tipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV.
conta_receber_cadastro[].valor_cofinsnúmeroValor do COFINS
conta_receber_cadastro[].valor_csllnúmeroValor do CSLL
conta_receber_cadastro[].valor_documentonúmeroValor do Lançamento
conta_receber_cadastro[].valor_inssnúmeroValor do INSS
conta_receber_cadastro[].valor_irnúmeroValor do Imposto de Renda
conta_receber_cadastro[].valor_issnúmeroValor do ISS
conta_receber_cadastro[].valor_pisnúmeroValor do PIS
lotenúmero inteiroNúmero do lote de lançamentos de contas a receber.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_statustextoCódigo do Status do processamento
descricao_statustextoDescrição do Status do Lote
lotenúmero inteiroNúmero do lote processado
status_lotelista de objetos
status_lote[].codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
status_lote[].codigo_lancamento_omienúmero inteiro
status_lote[].codigo_statustexto
status_lote[].descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "IncluirContaReceberPorLote", "param": [{"lote": 100, "conta_receber_cadastro": [{"codigo_lancamento_integracao": "1790774979", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "1.01.02", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}, {"codigo_lancamento_integracao": "1790774979", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 120.0, "codigo_categoria": "1.01.02", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}]}'

LancarRecebimento

altera dadosClaudeChatGPTMCP

Realiza a baixa de um título no conta a receber.

Obrigatórios 2

CampoTipoDescrição
codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
datatexto · até 10Data da Baixa
Opcionais 13Campos e estruturas que você pode enviar
CampoTipoDescrição
bloqueadotexto · até 1
codigo_baixanúmero inteiroCódigo para identificar a baixa do título no Contas a Receber.
codigo_baixa_integracaotexto · até 20Código da baixa do integrador para identificar a baixa de um título do contas a receber.
codigo_conta_corrente_integracaotexto · até 20Código da Conta Corrente do Integrador.
codigo_lancamentonúmero inteirocodigo do lançamento no Omie
codigo_lancamento_integracaotexto · até 60Código do lançamento do integrador.
conciliar_documentotexto · até 1
descontonúmeroValor do desconto.
jurosnúmeroValor do Juros.
multanúmeroValor da multa.
nsutexto · até 100Número Sequencial Único - Comprovante de pagamento.
observacaotextoObservação da Baixa do Contas a Receber.
valornúmeroValor a ser baixado.
Retorno 8O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_baixanúmero inteiroCódigo da baixa do contas a receber no Omie.
codigo_baixa_integracaotextoCódigo da baixa do integrador para identificar a baixa do título do contas a receber.
codigo_lancamentonúmero inteiroCódigo do lançamento no contas a receber,
codigo_lancamento_integracaotextoCódigo de integração do parceiro para identificar o lançamento no Contas a Receber.
codigo_statustextoCódigo do Status da baixa.
descricao_statustextoDescrição do status da baixa do contas a receber.
liquidadotextoIndica que o recebimento liquidado.
valor_baixadodecimalValor baixado
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "LancarRecebimento", "param": [{"codigo_lancamento": 0, "codigo_baixa": 0, "codigo_conta_corrente": 0, "valor": 0, "data": "", "observacao": ""}]}'

ListarContasReceber

consultaClaudeChatGPTMCP

Lista as contas a receber cadastradas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 21Campos e estruturas que você pode enviar
CampoTipoDescrição
apenas_importado_apitexto · até 1Ex.: S, N
exibir_obstexto · até 1Exibir as observações do lançamento (S/N). Preencher com "S" ou "N". Default "N"Ex.: S, N
filtrar_apenas_alteracaotexto · até 1Ex.: S, N
filtrar_apenas_inclusaotexto · até 1Ex.: S, N
filtrar_apenas_titulos_em_abertotexto · até 1Ex.: S, N
filtrar_clientenúmero inteiro
filtrar_conta_correntenúmero inteiroCódigo da Conta Corrente
filtrar_por_cpf_cnpjtexto · até 20Filtrar os títulos por CPF/CNPJ
filtrar_por_data_atetexto · até 10
filtrar_por_data_detexto · até 10
filtrar_por_emissao_atetexto · até 10
filtrar_por_emissao_detexto · até 10
filtrar_por_projetonúmero inteiroCó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_atetexto · até 10
filtrar_por_registro_detexto · até 10
filtrar_por_statustexto · até 100Filtrar por StatusEx.: CANCELADO, PAGO, LIQUIDADO
filtrar_por_vendedornúmero inteiroCó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_descrescentetexto · até 1Ex.: S, N
ordenar_portexto · até 100Ex.: CODIGO, CODIGO_INTEGRACAO, DATA_EMISSAO
paginanúmero inteiro
registros_por_paginanúmero inteiro
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
conta_receber_cadastrolista de objetos
conta_receber_cadastro[].acaotextoA-Adiciona Valor / S-Subtrai valor / L-Lança valor.
conta_receber_cadastro[].aprendizado_rateiotextoAprendizado 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_receber_cadastro[].baixar_documentotextoEfetua a baixa automática do documento.
conta_receber_cadastro[].bloqueadotextoBloquear lançamento (S/N)
conta_receber_cadastro[].bloquear_baixatextobloquear a baixa do lançamento
conta_receber_cadastro[].bloquear_exclusaotextoBloqueia a exclusão do registro. (S/N)
conta_receber_cadastro[].boletoobjetoInformações do boleto.
conta_receber_cadastro[].boleto.cGeradotextoGerou boleto (S/N)?
conta_receber_cadastro[].boleto.cNumBancariotextoNúmero bancário do boleto.
conta_receber_cadastro[].boleto.cNumBoletotextoNúmero do boleto.
conta_receber_cadastro[].boleto.dDtEmBoltextoData de emissão do boleto.
conta_receber_cadastro[].boleto.nPerJurosdecimalPercentual de juros.
conta_receber_cadastro[].boleto.nPerMultadecimalPercentual de multa.
conta_receber_cadastro[].cNumeroContratotextoNúmero do contrato do cliente.
conta_receber_cadastro[].cPedidoClientetextoNúmero do pedido do cliente.
conta_receber_cadastro[].categoriaslista de objetos
conta_receber_cadastro[].categorias[].codigo_categoriatexto
conta_receber_cadastro[].categorias[].percentualdecimalPercentual da categoria
conta_receber_cadastro[].categorias[].valordecimal
conta_receber_cadastro[].chave_nfetextoChave de Acesso da NFE
conta_receber_cadastro[].codigo_barras_ficha_compensacaotextoCódigo de Barras da Ficha de Compensação
conta_receber_cadastro[].codigo_categoriatextoCódigo da Categoria
conta_receber_cadastro[].codigo_cliente_fornecedornúmero inteiroCódigo de Cliente / Fornecedor
conta_receber_cadastro[].codigo_cliente_fornecedor_integracaotextoCódigo do cliente informado pelo integrador.
conta_receber_cadastro[].codigo_cmc7_chequetextoCódigo CMC7 do Cheque
conta_receber_cadastro[].codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
conta_receber_cadastro[].codigo_lancamento_omienúmero inteiroChave do Lançamento
conta_receber_cadastro[].codigo_projetonúmero inteiroCódigo do Projeto
conta_receber_cadastro[].codigo_tipo_documentotextoCódigo para o Tipo de Documento
conta_receber_cadastro[].codigo_vendedornúmero inteiroCódigo do Vendedor
conta_receber_cadastro[].conciliar_documentotextoEfetua a conciliação do documento automaticamente.
conta_receber_cadastro[].data_emissaotextoData de Emissão
conta_receber_cadastro[].data_previsaotextoData de Previsão de Pagamento/Recebimento
conta_receber_cadastro[].data_registrotextoData de Registro
conta_receber_cadastro[].data_vencimentotextoData de Vencimento
conta_receber_cadastro[].distribuicaolista de objetosDistribuição por Departamentos
conta_receber_cadastro[].distribuicao[].cCodDeptextoCódigo do Departamento
conta_receber_cadastro[].distribuicao[].cDesDeptextoDescrição do Departamento
conta_receber_cadastro[].distribuicao[].nPerDepdecimalPercentual do rateio
conta_receber_cadastro[].distribuicao[].nValDepdecimalValor do rateio
conta_receber_cadastro[].id_conta_correntenúmero inteiroId da Conta Corrente
conta_receber_cadastro[].id_origemtextoCódigo da Origem. Informação localizada na Aba "Diversos" do Contas a Receber. Os valores disponíveis são: "APIR" - Integração de Conta a Receber "BARR" - Conta a Receber Importada por Código de Barras "CTER" - Parcela a Receber de um CT-e "DEVR" - Conta a Receber da Devolução ao Fornecedor "MANR" - Lançamento Manual de Conta a Receber "NFER" - Conta a Receber Importada de uma NF-e "RPTR" - Repetição de Contas a Receber "VENR" - Parcela a Receber de Vendas "XMLR" - Conta a Receber Importada de um arquivo XML
conta_receber_cadastro[].importado_apitextoLançamento gerado pela API
conta_receber_cadastro[].infoobjetoInformações complementares do anexo.
conta_receber_cadastro[].info.cImpAPItextoImportado pela API (S/N).
conta_receber_cadastro[].info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
conta_receber_cadastro[].info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
conta_receber_cadastro[].info.hAlttextoHora da Alteração. No formato hh:mm:ss.
conta_receber_cadastro[].info.hInctextoHora da Inclusão. No formato hh:mm:ss.
conta_receber_cadastro[].info.uAlttextoUsuário da Alteração.
conta_receber_cadastro[].info.uInctextoUsuário da Inclusão.
conta_receber_cadastro[].lancamento_detalhelista de objetos
conta_receber_cadastro[].lancamento_detalhe[].CCFtexto
conta_receber_cadastro[].lancamento_detalhe[].COOtexto
conta_receber_cadastro[].lancamento_detalhe[].nCodInttextoCódigo de Integração
conta_receber_cadastro[].nCodOSnúmero inteiroID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente.
conta_receber_cadastro[].nCodPedidonúmero inteiroID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie.
conta_receber_cadastro[].nsutextoNúmero Sequencial Único - Comprovante de pagamento.
conta_receber_cadastro[].numero_documentotextoNúmero do Documento
conta_receber_cadastro[].numero_documento_fiscaltextoNúmero do Documento Fiscal
conta_receber_cadastro[].numero_parcelatextoNúmero da parcela "Formatada" como 999/999
conta_receber_cadastro[].numero_pedidotextoNúmero do Pedido
conta_receber_cadastro[].observacaotextoObservação
conta_receber_cadastro[].operacaotextoOperação
conta_receber_cadastro[].recebimentoobjetoDetalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, 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 "Recebimentos" no cadastro do lançamento.
conta_receber_cadastro[].recebimento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
conta_receber_cadastro[].recebimento.codigo_recebimento_integracaotexto
conta_receber_cadastro[].recebimento.datatextoData da Baixa
conta_receber_cadastro[].recebimento.descontodecimalValor do desconto.
conta_receber_cadastro[].recebimento.jurosdecimalValor do Juros.
conta_receber_cadastro[].recebimento.multadecimalValor da multa.
conta_receber_cadastro[].recebimento.observacaotextoObservação da Baixa do Contas a Receber.
conta_receber_cadastro[].recebimento.valordecimalValor a ser baixado.
conta_receber_cadastro[].repeticaoobjetoRepetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags "mensal", "semanal" ou "especifico" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba "Repetição" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração.
conta_receber_cadastro[].repeticao.antecipartextoAntecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
conta_receber_cadastro[].repeticao.especificoobjetoRepetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.especifico.repetir_a_cadanúmero inteiroInforme aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias.
conta_receber_cadastro[].repeticao.especifico.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].repeticao.mensalobjetoRepetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.mensal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].repeticao.mensal.repetir_todo_dianúmero inteiroInforme aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês.
conta_receber_cadastro[].repeticao.postergartextoPostergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
conta_receber_cadastro[].repeticao.semanalobjetoRepetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.semanal.repetir_dia_semanatextoInforme o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado
conta_receber_cadastro[].repeticao.semanal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].retem_cofinstextoIndica que o Valor do COFINS informado deve ser retido
conta_receber_cadastro[].retem_cslltextoIndica que o Valor do CSLL informado deve ser retido
conta_receber_cadastro[].retem_insstextoIndica que o Valor do INSS informado deve ser retido
conta_receber_cadastro[].retem_irtextoIndica que o Valor do Imposto de Renda informado deve ser retido
conta_receber_cadastro[].retem_isstextoIndica que o Valor do ISS informado deve ser retido
conta_receber_cadastro[].retem_pistextoIndica que o Valor do PIS informado deve ser retido
conta_receber_cadastro[].status_titulotextoStatus do Título
conta_receber_cadastro[].tipo_agrupamentotextoTipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV.
conta_receber_cadastro[].valor_cofinsdecimalValor do COFINS
conta_receber_cadastro[].valor_cslldecimalValor do CSLL
conta_receber_cadastro[].valor_documentodecimalValor do Lançamento
conta_receber_cadastro[].valor_inssdecimalValor do INSS
conta_receber_cadastro[].valor_irdecimalValor do Imposto de Renda
conta_receber_cadastro[].valor_issdecimalValor do ISS
conta_receber_cadastro[].valor_pisdecimalValor do PIS
paginanúmero inteiro
registrosnúmero inteiro
total_de_paginasnúmero inteiro
total_de_registrosnúmero inteiro
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarContasReceber", "param": [{"pagina": 1, "registros_por_pagina": 20, "apenas_importado_api": "N"}]}'

UpsertContaReceber

altera dadosClaudeMCP

Executa o Upsert do Contas a receber

Obrigatórios 1

CampoTipoDescrição
recebimentoobjetoDetalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, 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 "Recebimentos" no cadastro do lançamento.
recebimento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
recebimento.codigo_recebimento_integracaotexto · até 20
recebimento.datatexto · até 10Data da Baixa
recebimento.descontonúmeroValor do desconto.
recebimento.jurosnúmeroValor do Juros.
recebimento.multanúmeroValor da multa.
recebimento.observacaotextoObservação da Baixa do Contas a Receber.
recebimento.valornúmeroValor a ser baixado.
Opcionais 57Campos e estruturas que você pode enviar
CampoTipoDescrição
acaotextoA-Adiciona Valor / S-Subtrai valor / L-Lança valor.
aprendizado_rateiotexto · até 1Aprendizado 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_documentotexto · até 1Efetua a baixa automática do documento.
bloqueadotexto · até 1Bloquear lançamento (S/N)
bloquear_baixatexto · até 1bloquear a baixa do lançamento
bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
boletoobjetoInformações do boleto.
boleto.cGeradotexto · até 1Gerou boleto (S/N)?
boleto.cNumBancariotexto · até 30Número bancário do boleto.
boleto.cNumBoletotexto · até 30Número do boleto.
boleto.dDtEmBoltexto · até 10Data de emissão do boleto.
boleto.nPerJurosnúmeroPercentual de juros.
boleto.nPerMultanúmeroPercentual de multa.
cNumeroContratotexto · até 20Número do contrato do cliente.
cPedidoClientetexto · até 30Número do pedido do cliente.
categoriaslista de objetos
categorias[].codigo_categoriatexto · até 20
categorias[].percentualnúmeroPercentual da categoria
categorias[].valornúmero
chave_nfetexto · até 44Chave de Acesso da NFE
codigo_barras_ficha_compensacaotexto · até 70Código de Barras da Ficha de Compensação
codigo_categoriatexto · até 20Código da Categoria
codigo_cliente_fornecedornúmero inteiroCódigo de Cliente / Fornecedor
codigo_cliente_fornecedor_integracaotexto · até 60Código do cliente informado pelo integrador.
codigo_cmc7_chequetexto · até 40Código CMC7 do Cheque
codigo_lancamento_integracaotexto · até 60Código do lançamento gerado pelo integrador.
codigo_lancamento_omienúmero inteiroChave do Lançamento
codigo_projetonúmero inteiroCódigo do Projeto
codigo_tipo_documentotexto · até 5Código para o Tipo de Documento
codigo_vendedornúmero inteiroCódigo do Vendedor
conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente.
data_emissaotexto · até 10Data de Emissão
data_previsaotexto · até 10Data de Previsão de Pagamento/Recebimento
data_registrotexto · até 10Data de Registro
data_vencimentotexto · até 10Data de Vencimento
distribuicaolista de objetosDistribuição por Departamentos
distribuicao[].cCodDeptexto · até 40Código do Departamento
distribuicao[].cDesDeptexto · até 50Descrição do Departamento
distribuicao[].nPerDepnúmeroPercentual do rateio
distribuicao[].nValDepnúmeroValor do rateio
id_conta_correntenúmero inteiroId da Conta Corrente
id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Receber. Os valores disponíveis são: "APIR" - Integração de Conta a Receber "BARR" - Conta a Receber Importada por Código de Barras "CTER" - Parcela a Receber de um CT-e "DEVR" - Conta a Receber da Devolução ao Fornecedor "MANR" - Lançamento Manual de Conta a Receber "NFER" - Conta a Receber Importada de uma NF-e "RPTR" - Repetição de Contas a Receber "VENR" - Parcela a Receber de Vendas "XMLR" - Conta a Receber Importada de um arquivo XML
importado_apitexto · até 1Lançamento gerado pela API
infoobjetoInformações complementares do anexo.
info.cImpAPItexto · até 1Importado pela API (S/N).
info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa.
info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa.
info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss.
info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss.
info.uAlttexto · até 10Usuário da Alteração.
info.uInctexto · até 10Usuário da Inclusão.
lancamento_detalhelista de objetos
lancamento_detalhe[].CCFtexto · até 20
lancamento_detalhe[].COOtexto · até 20
lancamento_detalhe[].nCodInttexto · até 20Código de Integração
nCodOSnúmero inteiroID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente.
nCodPedidonúmero inteiroID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie.
nsutexto · até 100Número Sequencial Único - Comprovante de pagamento.
numero_documentotexto · até 20Número do Documento
numero_documento_fiscaltexto · até 20Número do Documento Fiscal
numero_parcelatexto · até 7Número da parcela "Formatada" como 999/999
numero_pedidotexto · até 15Número do Pedido
observacaotextoObservação
operacaotexto · até 2Operação
repeticaoobjetoRepetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags "mensal", "semanal" ou "especifico" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba "Repetição" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração.
repeticao.antecipartexto · até 1Antecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
repeticao.especificoobrigatórioobjetoRepetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.especifico.repetir_a_cadanúmero inteiroInforme aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias.
repeticao.especifico.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
repeticao.mensalobrigatórioobjetoRepetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.mensal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
repeticao.mensal.repetir_todo_dianúmero inteiroInforme aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês.
repeticao.postergartexto · até 1Postergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
repeticao.semanalobrigatórioobjetoRepetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
repeticao.semanal.repetir_dia_semanatexto · até 10Informe o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado
repeticao.semanal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
retem_cofinstexto · até 1Indica que o Valor do COFINS informado deve ser retido
retem_cslltexto · até 1Indica que o Valor do CSLL informado deve ser retido
retem_insstexto · até 1Indica que o Valor do INSS informado deve ser retido
retem_irtexto · até 1Indica que o Valor do Imposto de Renda informado deve ser retido
retem_isstexto · até 1Indica que o Valor do ISS informado deve ser retido
retem_pistexto · até 1Indica que o Valor do PIS informado deve ser retido
status_titulotexto · até 100Status do Título
tipo_agrupamentotexto · até 1Tipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV.
valor_cofinsnúmeroValor do COFINS
valor_csllnúmeroValor do CSLL
valor_documentonúmeroValor do Lançamento
valor_inssnúmeroValor do INSS
valor_irnúmeroValor do Imposto de Renda
valor_issnúmeroValor do ISS
valor_pisnúmeroValor do PIS
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
codigo_lancamento_omienúmero inteiro
codigo_statustexto
descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "UpsertContaReceber", "param": [{"codigo_lancamento_integracao": "1790774979", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "1.01.02", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}'

UpsertContaReceberPorLote

altera dadosClaudeMCP

Efetua o UPSERT do Contas a Receber por Lote.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar
CampoTipoDescrição
conta_receber_cadastrolista de objetos
conta_receber_cadastro[].acaotextoA-Adiciona Valor / S-Subtrai valor / L-Lança valor.
conta_receber_cadastro[].aprendizado_rateiotexto · até 1Aprendizado 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_receber_cadastro[].baixar_documentotexto · até 1Efetua a baixa automática do documento.
conta_receber_cadastro[].bloqueadotexto · até 1Bloquear lançamento (S/N)
conta_receber_cadastro[].bloquear_baixatexto · até 1bloquear a baixa do lançamento
conta_receber_cadastro[].bloquear_exclusaotexto · até 1Bloqueia a exclusão do registro. (S/N)
conta_receber_cadastro[].boletoobjetoInformações do boleto.
conta_receber_cadastro[].boleto.cGeradotexto · até 1Gerou boleto (S/N)?
conta_receber_cadastro[].boleto.cNumBancariotexto · até 30Número bancário do boleto.
conta_receber_cadastro[].boleto.cNumBoletotexto · até 30Número do boleto.
conta_receber_cadastro[].boleto.dDtEmBoltexto · até 10Data de emissão do boleto.
conta_receber_cadastro[].boleto.nPerJurosnúmeroPercentual de juros.
conta_receber_cadastro[].boleto.nPerMultanúmeroPercentual de multa.
conta_receber_cadastro[].cNumeroContratotexto · até 20Número do contrato do cliente.
conta_receber_cadastro[].cPedidoClientetexto · até 30Número do pedido do cliente.
conta_receber_cadastro[].categoriaslista de objetos
conta_receber_cadastro[].categorias[].codigo_categoriatexto · até 20
conta_receber_cadastro[].categorias[].percentualnúmeroPercentual da categoria
conta_receber_cadastro[].categorias[].valornúmero
conta_receber_cadastro[].chave_nfetexto · até 44Chave de Acesso da NFE
conta_receber_cadastro[].codigo_barras_ficha_compensacaotexto · até 70Código de Barras da Ficha de Compensação
conta_receber_cadastro[].codigo_categoriatexto · até 20Código da Categoria
conta_receber_cadastro[].codigo_cliente_fornecedornúmero inteiroCódigo de Cliente / Fornecedor
conta_receber_cadastro[].codigo_cliente_fornecedor_integracaotexto · até 60Código do cliente informado pelo integrador.
conta_receber_cadastro[].codigo_cmc7_chequetexto · até 40Código CMC7 do Cheque
conta_receber_cadastro[].codigo_lancamento_integracaotexto · até 60Código do lançamento gerado pelo integrador.
conta_receber_cadastro[].codigo_lancamento_omienúmero inteiroChave do Lançamento
conta_receber_cadastro[].codigo_projetonúmero inteiroCódigo do Projeto
conta_receber_cadastro[].codigo_tipo_documentotexto · até 5Código para o Tipo de Documento
conta_receber_cadastro[].codigo_vendedornúmero inteiroCódigo do Vendedor
conta_receber_cadastro[].conciliar_documentotexto · até 1Efetua a conciliação do documento automaticamente.
conta_receber_cadastro[].data_emissaotexto · até 10Data de Emissão
conta_receber_cadastro[].data_previsaotexto · até 10Data de Previsão de Pagamento/Recebimento
conta_receber_cadastro[].data_registrotexto · até 10Data de Registro
conta_receber_cadastro[].data_vencimentotexto · até 10Data de Vencimento
conta_receber_cadastro[].distribuicaolista de objetosDistribuição por Departamentos
conta_receber_cadastro[].distribuicao[].cCodDeptexto · até 40Código do Departamento
conta_receber_cadastro[].distribuicao[].cDesDeptexto · até 50Descrição do Departamento
conta_receber_cadastro[].distribuicao[].nPerDepnúmeroPercentual do rateio
conta_receber_cadastro[].distribuicao[].nValDepnúmeroValor do rateio
conta_receber_cadastro[].id_conta_correntenúmero inteiroId da Conta Corrente
conta_receber_cadastro[].id_origemtexto · até 4Código da Origem. Informação localizada na Aba "Diversos" do Contas a Receber. Os valores disponíveis são: "APIR" - Integração de Conta a Receber "BARR" - Conta a Receber Importada por Código de Barras "CTER" - Parcela a Receber de um CT-e "DEVR" - Conta a Receber da Devolução ao Fornecedor "MANR" - Lançamento Manual de Conta a Receber "NFER" - Conta a Receber Importada de uma NF-e "RPTR" - Repetição de Contas a Receber "VENR" - Parcela a Receber de Vendas "XMLR" - Conta a Receber Importada de um arquivo XML
conta_receber_cadastro[].importado_apitexto · até 1Lançamento gerado pela API
conta_receber_cadastro[].infoobjetoInformações complementares do anexo.
conta_receber_cadastro[].info.cImpAPItexto · até 1Importado pela API (S/N).
conta_receber_cadastro[].info.dAlttexto · até 10Data da Alteração. No formato dd/mm/aaaa.
conta_receber_cadastro[].info.dInctexto · até 10Data da Inclusão. No formato dd/mm/aaaa.
conta_receber_cadastro[].info.hAlttexto · até 8Hora da Alteração. No formato hh:mm:ss.
conta_receber_cadastro[].info.hInctexto · até 8Hora da Inclusão. No formato hh:mm:ss.
conta_receber_cadastro[].info.uAlttexto · até 10Usuário da Alteração.
conta_receber_cadastro[].info.uInctexto · até 10Usuário da Inclusão.
conta_receber_cadastro[].lancamento_detalhelista de objetos
conta_receber_cadastro[].lancamento_detalhe[].CCFtexto · até 20
conta_receber_cadastro[].lancamento_detalhe[].COOtexto · até 20
conta_receber_cadastro[].lancamento_detalhe[].nCodInttexto · até 20Código de Integração
conta_receber_cadastro[].nCodOSnúmero inteiroID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente.
conta_receber_cadastro[].nCodPedidonúmero inteiroID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie.
conta_receber_cadastro[].nsutexto · até 100Número Sequencial Único - Comprovante de pagamento.
conta_receber_cadastro[].numero_documentotexto · até 20Número do Documento
conta_receber_cadastro[].numero_documento_fiscaltexto · até 20Número do Documento Fiscal
conta_receber_cadastro[].numero_parcelatexto · até 7Número da parcela "Formatada" como 999/999
conta_receber_cadastro[].numero_pedidotexto · até 15Número do Pedido
conta_receber_cadastro[].observacaotextoObservação
conta_receber_cadastro[].operacaotexto · até 2Operação
conta_receber_cadastro[].recebimentoobrigatórioobjetoDetalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, 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 "Recebimentos" no cadastro do lançamento.
conta_receber_cadastro[].recebimento.codigo_conta_correntenúmero inteiroCódigo da Conta Corrente.
conta_receber_cadastro[].recebimento.codigo_recebimento_integracaotexto · até 20
conta_receber_cadastro[].recebimento.datatexto · até 10Data da Baixa
conta_receber_cadastro[].recebimento.descontonúmeroValor do desconto.
conta_receber_cadastro[].recebimento.jurosnúmeroValor do Juros.
conta_receber_cadastro[].recebimento.multanúmeroValor da multa.
conta_receber_cadastro[].recebimento.observacaotextoObservação da Baixa do Contas a Receber.
conta_receber_cadastro[].recebimento.valornúmeroValor a ser baixado.
conta_receber_cadastro[].repeticaoobjetoRepetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags "mensal", "semanal" ou "especifico" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba "Repetição" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração.
conta_receber_cadastro[].repeticao.antecipartexto · até 1Antecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
conta_receber_cadastro[].repeticao.especificoobrigatórioobjetoRepetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.especifico.repetir_a_cadanúmero inteiroInforme aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias.
conta_receber_cadastro[].repeticao.especifico.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].repeticao.mensalobrigatórioobjetoRepetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.mensal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].repeticao.mensal.repetir_todo_dianúmero inteiroInforme aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês.
conta_receber_cadastro[].repeticao.postergartexto · até 1Postergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com "S" ou "N". Preencher com "S" somente umas das tags: antecipar postergar
conta_receber_cadastro[].repeticao.semanalobrigatórioobjetoRepetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico
conta_receber_cadastro[].repeticao.semanal.repetir_dia_semanatexto · até 10Informe o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado
conta_receber_cadastro[].repeticao.semanal.repetir_pornúmero inteiroInforme aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições.
conta_receber_cadastro[].retem_cofinstexto · até 1Indica que o Valor do COFINS informado deve ser retido
conta_receber_cadastro[].retem_cslltexto · até 1Indica que o Valor do CSLL informado deve ser retido
conta_receber_cadastro[].retem_insstexto · até 1Indica que o Valor do INSS informado deve ser retido
conta_receber_cadastro[].retem_irtexto · até 1Indica que o Valor do Imposto de Renda informado deve ser retido
conta_receber_cadastro[].retem_isstexto · até 1Indica que o Valor do ISS informado deve ser retido
conta_receber_cadastro[].retem_pistexto · até 1Indica que o Valor do PIS informado deve ser retido
conta_receber_cadastro[].status_titulotexto · até 100Status do Título
conta_receber_cadastro[].tipo_agrupamentotexto · até 1Tipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV.
conta_receber_cadastro[].valor_cofinsnúmeroValor do COFINS
conta_receber_cadastro[].valor_csllnúmeroValor do CSLL
conta_receber_cadastro[].valor_documentonúmeroValor do Lançamento
conta_receber_cadastro[].valor_inssnúmeroValor do INSS
conta_receber_cadastro[].valor_irnúmeroValor do Imposto de Renda
conta_receber_cadastro[].valor_issnúmeroValor do ISS
conta_receber_cadastro[].valor_pisnúmeroValor do PIS
lotenúmero inteiroNúmero do lote de lançamentos de contas a receber.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
codigo_statustextoCódigo do Status do processamento
descricao_statustextoDescrição do Status do Lote
lotenúmero inteiroNúmero do lote processado
status_lotelista de objetos
status_lote[].codigo_lancamento_integracaotextoCódigo do lançamento gerado pelo integrador.
status_lote[].codigo_lancamento_omienúmero inteiro
status_lote[].codigo_statustexto
status_lote[].descricao_statustexto
POST /api/v1/financas/contareceber/
curl -s https://app.omie.com.br/api/v1/financas/contareceber/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "UpsertContaReceberPorLote", "param": [{"lote": 100, "conta_receber_cadastro": [{"codigo_lancamento_integracao": "1790774979", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 100.0, "codigo_categoria": "1.01.02", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}, {"codigo_lancamento_integracao": "1790774979", "codigo_cliente_fornecedor": 4214850, "data_vencimento": "30/09/2026", "valor_documento": 120.0, "codigo_categoria": "1.01.02", "data_previsao": "30/09/2026", "id_conta_corrente": 4243124}]}]}'