OmieapiDocumentaçãoOperações
← Referência das operações

AlterarContaPagaraltera dados

Altera uma conta a pagar

Identificação

Operaçãofinancas/contapagar:AlterarContaPagar
ServiçoLancamentoContaPagar
MóduloFinanças
Endpoint/api/v1/financas/contapagar/

Como as pessoas pedem isso

alterar conta a pagar

Parâmetros

CampoTipoDescrição
acaostringDEPRECATED
aprendizado_rateiostringAprendizado 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.
baixa_bloqueadastringDEPRECATED
baixar_documentolista de stringEfetua a baixa automática do documento.
bloqueadostringDEPRECATED
bloquear_exclusaostringBloqueia a exclusão do registro. (S/N)
categoriaslista de object
chave_nfestringChave da NF.e. Preenchimento Opcional. Informação localizada na Aba "Diversos" do Contas a Pagar.
cnab_integracao_bancariaobjectDados do CNAB e Integração Bancária.
codigo_barras_ficha_compensacaostringCódigo de Barras Preenchimento Opcional. Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_categoriastringCódigo da Categoria. Preenchimento Opcional. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação.
codigo_cliente_fornecedorintegerCódigo do Favorecido / Fornecedor. Preenchimento Obrigatório. 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.
codigo_cliente_fornecedor_integracaostringCódigo de Integração do Favorecido / Fornecedor. Preenchimento Opcional. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente_omie".
codigo_cmc7_chequestringDEPRECATED
codigo_lancamento_integracaostringCódigo de Integração do Lançamento de Contas a Pagar. Preenchimento Obrigatório na inclusão. Preenchimento Opcional na Alteração/Consulta/Pesquisa. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação.
codigo_lancamento_omieintegerCódigo do Lançamento de Contas a Pagar. Preenchimento automático na inclusão. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs.
codigo_projetointegerCódigo do Projeto. Preenchimento Opcional. 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.
codigo_tipo_documentostringCódigo do Tipo de Documento. Preenchimento Opcional. Informação localizada na Aba "Diversos" do Contas a Pagar.
codigo_vendedorintegerCódigo do Vendedor. Preenchimento Opcional. 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.
conciliar_documentolista de stringEfetua a conciliação do documento automaticamente. Opcional. Preencher com S/N.
data_emissaostringData de Emissão. Preenchimento Opcional. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_entradastringData de Registro. Preenchimento Opcional. Caso não informado, assumirá a data corrente. Informação localizada na Aba "Detalhes" do Contas a Pagar.
data_previsaostringData da Previsão de Pagamento. Preenchimento Obrigatório. Utilize o formato "dd/mm/aaaa". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente.
data_vencimentostringData de Vencimento. Preenchimento Obrigatório. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente.
distribuicaolista de objectDistribuição por Departamentos. Preenchimento Opcional.
id_conta_correnteintegerCódigo da Conta Corrente. Preenchimento Opcional. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação.
id_conta_corrente_integracaostringDEPRECATED
id_origemstringCódigo da Origem. Preenchimento automático - Não informar. Informação localizada na Aba "Diversos" do Contas a Pagar. Os valores disponíveis são: "APIP" - Integração de Conta a Pagar "BARP" - Conta a Pagar Importada por Código de Barras "COMP" - Parcela a Pagar de Compras "CTEP" - Parcela a Pagar de um CT-e "DEVP" - Conta a Pagar da Devolução de Venda "IMPP" - Parcela a Pagar de uma Nota de Importação "MANP" - Lançamento Manual de Conta a Pagar "NFEP" - Conta a Pagar Importada de uma NF-e "RPTP" - Repetição de Contas a Pagar "XMLP" - Conta a Pagar Importada de um arquivo XML
importado_apistringDEPRECATED
infoobjectInformações sobre a criação/alteração do lançamento de Contas a Pagar. Preenchimento automático - Não informar.
nsustringDEPRECATED.
numero_documentostringNúmero do Documento. Preenchimento Opcional. Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_documento_fiscalstringNúmero da Nota Fiscal associada ao lançamento de Contas a Pagar. Preenchimento Opcional. Informação localizada na Aba "Detalhes" do Contas a Pagar.
numero_parcelastringNúmero da parcela. Preenchimento Opcional. Utilizar o formato "999/999". Para 1 parcela utilize "001/001" Se não informado assumirá o valor "001/001". Informação localizada na Aba "Diversos" do Contas a Pagar.
numero_pedidostringNúmero do Pedido. Preenchimento Opcional. Informação localizada na Aba "Diversos" do Contas a Pagar.
observacaostringObservações. Preenchimento Opcional. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba "Detalhes" do Contas a Pagar.
operacaostringCódigo da Operação. . Preenchimento Automático - Não preencher. Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: "01" - Venda de Serviço "11" - Venda de Produto "12" - Venda de Produto pelo PDV "13" - Devolução de Venda "14" - Remessa de Produto "16" - Nota Complementar de Saída
pagamento obrigatóriolista de objectDetalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, 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 "Pagamentos" no cadastro do lançamento. Preenchimento opcional.
retem_cofinsstringReter COFINS. Preenchimento Opcional. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_csllstringReter CSLL. Preenchimento Opcional. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_inssstringReter INSS. Preenchimento Opcional. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_irstringReter IR. Preenchimento Opcional. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_issstringReter ISS. Preenchimento Opcional. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
retem_pisstringReter PIS. Preenchimento Opcional. Informar "S" ou "N". Se não informado, será assumido "N" por padrão. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
servico_tomadoobject
status_titulostringStatus do Título. Preenchimento automático - Não informar. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar.
valor_cofinsnumberValor COFINS. Preenchimento Opcional. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_csllnumberValor CSLL. Preenchimento Opcional. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_documentonumberValor da Conta. Preenchimento Obrigatório.
valor_inssnumberValor INSS. Preenchimento Opcional. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_irnumberValor IR. Preenchimento Opcional. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_issnumberValor ISS. Preenchimento Opcional. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.
valor_pagnumberValor a pagar. Disponível apenas para os métodos de consulta e listagem.
valor_pisnumberValor PIS. Preenchimento Opcional. Informação localizada na Aba "Impostos Retidos" do Contas a Pagar.

Exemplo de chamada

{
  "codigo_lancamento_integracao": "#TS#",
  "codigo_cliente_fornecedor": 4214850,
  "data_vencimento": "#TODAY#",
  "valor_documento": 100,
  "codigo_categoria": "2.04.01",
  "data_previsao": "#TODAY#",
  "id_conta_corrente": 4243124
}
Esta operação altera dados de verdade, na hora. Não existe ambiente de ensaio neste endereço.
api.omie.com.br/mcp · Documentação · Operações