acao | string | DEPRECATED |
aprendizado_rateio | string | Aprendizado 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_bloqueada | string | DEPRECATED |
baixar_documento | lista de string | Efetua a baixa automática do documento. |
bloqueado | string | DEPRECATED |
bloquear_exclusao | string | Bloqueia a exclusão do registro. (S/N) |
categorias | lista de object | |
chave_nfe | string | Chave da NF.e.
Preenchimento Opcional.
Informação localizada na Aba "Diversos" do Contas a Pagar. |
cnab_integracao_bancaria | object | Dados do CNAB e Integração Bancária. |
codigo_barras_ficha_compensacao | string | Código de Barras
Preenchimento Opcional.
Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_categoria | string | Có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_fornecedor | integer | Có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_integracao | string | Có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_cheque | string | DEPRECATED |
codigo_lancamento_integracao | string | Có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_omie | integer | Có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_projeto | integer | Có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_documento | string | Código do Tipo de Documento.
Preenchimento Opcional.
Informação localizada na Aba "Diversos" do Contas a Pagar. |
codigo_vendedor | integer | Có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_documento | lista de string | Efetua a conciliação do documento automaticamente. Opcional.
Preencher com S/N. |
data_emissao | string | Data de Emissão.
Preenchimento Opcional.
Caso não informado, assumirá a data corrente.
Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_entrada | string | Data de Registro.
Preenchimento Opcional.
Caso não informado, assumirá a data corrente.
Informação localizada na Aba "Detalhes" do Contas a Pagar. |
data_previsao | string | Data 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_vencimento | string | Data 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. |
distribuicao | lista de object | Distribuição por Departamentos.
Preenchimento Opcional. |
id_conta_corrente | integer | Có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_integracao | string | DEPRECATED |
id_origem | string | Có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_api | string | DEPRECATED |
info | object | Informações sobre a criação/alteração do lançamento de Contas a Pagar.
Preenchimento automático - Não informar. |
nsu | string | DEPRECATED. |
numero_documento | string | Número do Documento.
Preenchimento Opcional.
Informação localizada na Aba "Diversos" do Contas a Pagar. |
numero_documento_fiscal | string | Nú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_parcela | string | Nú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_pedido | string | Número do Pedido.
Preenchimento Opcional.
Informação localizada na Aba "Diversos" do Contas a Pagar. |
observacao | string | Observações.
Preenchimento Opcional.
Utilize o carater ( | ) pipe como separador de linhas.
Informação localizada na Aba "Detalhes" do Contas a Pagar. |
operacao | string | Có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ório | lista de object | Detalhes 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_cofins | string | Reter 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_csll | string | Reter 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_inss | string | Reter 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_ir | string | Reter 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_iss | string | Reter 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_pis | string | Reter 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_tomado | object | |
status_titulo | string | Status do Título.
Preenchimento automático - Não informar.
Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar. |
valor_cofins | number | Valor COFINS.
Preenchimento Opcional.
Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_csll | number | Valor CSLL.
Preenchimento Opcional.
Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_documento | number | Valor da Conta.
Preenchimento Obrigatório. |
valor_inss | number | Valor INSS.
Preenchimento Opcional.
Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_ir | number | Valor IR.
Preenchimento Opcional.
Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_iss | number | Valor ISS.
Preenchimento Opcional.
Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
valor_pag | number | Valor a pagar.
Disponível apenas para os métodos de consulta e listagem. |
valor_pis | number | Valor PIS.
Preenchimento Opcional.
Informação localizada na Aba "Impostos Retidos" do Contas a Pagar. |
apiDocumentaçãoOperações