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

ListarContratosconsulta

Lista os contratos cadastrados.

Identificação

Operaçãoservicos/contrato:ListarContratos
ServiçoContrato
MóduloServiços
Endpoint/api/v1/servicos/contrato/

Como as pessoas pedem isso

listar contratos de serviço

Parâmetros

CampoTipoDescrição
apenas_importado_apistringDEPRECATED
cExibeObsstring(S/N) Indica se a "Observação / Dados Adicionais" serão retornados na listagem.
cExibirInfoCadastrostringExibir as informações complementares do contrato (S/N). Preenchimento Opcional. Preencher com "S" ou "N".
cExibirProdutosstringExibir os produtos utilizados (S/N). Preenchimento Opcional. Preencher com "S" ou "N".
filtrar_apenas_alteracaostringFiltrar apenas registros alterados (S/N)
filtrar_apenas_inclusaostringFiltrar apenas registros incluídos (S/N)
filtrar_clienteintegerFiltra os registros exibidos por cliente
filtrar_cnpj_cpfstringFiltrar os contratos por CNPJ/CPF.
filtrar_por_data_atestringFiltrar lançamentos incluídos e/ou alterados até a data
filtrar_por_data_destringFiltrar lançamentos incluídos e/ou alterados até a data
ordem_descrescentestringIndica se a ordem de exibição é decrescente caso seja informado "S".
ordenar_porstringOrdem de exibição dos dados. Padrão: Código.
paginaintegerNúmero da página que será listada.
registros_por_paginaintegerNúmero de registros retornados.

Exemplo de chamada

{
  "pagina": 1,
  "registros_por_pagina": 50,
  "apenas_importado_api": "N"
}
api.omie.com.br/mcp · Documentação · Operações