apiDocumentaçãoOperaçõesapiDocumentaçãoOperaçõesListarContasPagarconsultaListar as Contas a Pagar
| Operação | financas/contapagar:ListarContasPagar |
|---|---|
| Serviço | LancamentoContaPagar |
| Módulo | Finanças |
| Endpoint | /api/v1/financas/contapagar/ |
listar contas a pagar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | string | Exibir apenas os registros gerados pela API. Preenchimento Opcional. Informar "S" ou "N". O valor padrão para esse campo é "N". |
exibir_obs | string | Exibir as observações do lançamento (S/N). Preencher com "S" ou "N". Default "N" Preenchimento Opcional. |
filtrar_apenas_alteracao | string | Filtra os registros exibindos apenas os alterados. Preenchimento Opcional. Informar "S" ou "N". O valor padrão para esse campo é "N". |
filtrar_apenas_inclusao | string | Filtra os registros exibindos apenas os incluídos. Preenchimento Opcional. Informar "S" ou "N". O valor padrão para esse campo é "N". |
filtrar_apenas_titulos_em_aberto | string | DEPRECATED. |
filtrar_cliente | integer | Filtrar os lançamentos de Contas a Pagar por código do cliente. Preenchimento Opcional. 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. |
filtrar_conta_corrente | integer | Filtrar os lançamentos de Contas a Pagar por código da conta corrente. Preenchimento Opcional. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação. |
filtrar_por_cpf_cnpj | string | Filtrar os títulos por CPF/CNPJ. Preenchimento Opcional. Informar apenas números. |
filtrar_por_data_ate | string | Data de fim do filtro. Preenchimento Opcional. Utilize o formato "dd/mm/aaaa". Serão consideradas as datas de inclusão e alteração do lançamento de Contas a Pagar conforme definido nos campos "filtrar_apenas_inclusao" e "filtrar_apenas_alteracao". |
filtrar_por_data_de | string | Data de Inicio do filtro. Preenchimento Opcional. Utilize o formato "dd/mm/aaaa". Serão consideradas as datas de inclusão e alteração do lançamento de Contas a Pagar conforme definido nos campos "filtrar_apenas_inclusao" e "filtrar_apenas_alteracao". |
filtrar_por_emissao_ate | string | Data de alteração final (Filtra os registros até a data especificada). No formato dd/mm/aaaa. |
filtrar_por_emissao_de | string | Data de alteração inicial (Filtrar os registros a partir da data especificada). No formato dd/mm/aaaa. |
filtrar_por_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. |
filtrar_por_registro_ate | string | Filtra os registros até a data especificada |
filtrar_por_registro_de | string | Filtra os registros a partir da data |
filtrar_por_status | string | Filtrar por status. Preenchimento Opcional. Valores disponíveis: CANCELADO, PAGO, LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO |
filtrar_por_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. |
ordem_descrescente | string | Exibir em Ordem Crescente ou Decrescente Preenchimento Opcional. Informar "S" para exibir os dados em Ordem Descrescente ou "N" para exibir os dados em Ordem Crescente. O valor padrão para esse campo é "N". |
ordenar_por | string | Ordem de exibição dos dados. Preenchimento Opcional. O valor padrão para esse campo é "CODIGO". Os valores disponíveis são: "CODIGO" "CODIGO_INTEGRACAO" |
pagina | integer | Número da página que será retornada. Preenchimento Opcional. Como a resposta é paginada, é necessário informada qual página será recuperada na pesquisa. O valor padrão para esse campo é sempre 1. |
registros_por_pagina | integer | Número de registros por página. Preenchimento Opcional. Indique quando registro você recuperá para cada página solicitada. O límite máximo permitido para essa API é 50 registro por página. Assim, se você tiver 1000 lançamentos registrados, será necessário realizar 20 consultas para obter todos os registros. |
{
"pagina": 1,
"registros_por_pagina": 20,
"apenas_importado_api": "N"
}