Consultar Faturas

GET {{url}}/api/v1/integracao/cliente/financeiro

GET

No método GET, será possível consultar as faturas em aberto/liquidadas dos clientes e obter o retorno no formato JSON como resposta. Os seguintes parâmetros podem/devem ser utilizados:

AtributoDescriçãoObrigatório
buscaTipo de busca que deseja fazer no clienteSim
termo_buscaTermo utilizado para fazer a buscaSim
limitLimite de resultadosNão
apenas_pendenteInforma de deseja trazer apenas as faturas pendentesNão
order_byCampo que será utilizado para ordenaçãoNão
order_typeTipo da OrdenaçãoNão
data_inicioData de Início (Utiliza a data de vencimento como base)Não
data_fimData de Fim (Utiliza a data de vencimento como base)Não

Os atributos podem conter os seguintes valores:

AtributoDescriçãoValor Default
buscacpfcnpj, codigocliente, idclienteservicoNenhum
termo_buscaCampo livreSim
limitValor mínimo 1, Valor máximo 50.20
apenas_pendentesim,nao.sim
order_bydatavencimento,datapagamento,data_cadastro,valor.data_vencimento
order_typeasc,desc.asc
data_inicioCampo no formato DateTime (YYYY-MM-DD)Nenhum
data_fimCampo no formato DateTime (YYYY-MM-DD)Nenhum
tipo_datadatavencimento, datapagamento, data_cadastrodata_vencimento

Nota

INFORMAÇÃO: O atributo «tipo_data» somente será validado, caso seja informado o atributo data_inicio e/ou data_fim, pois o filtro o tipo de data selecionado, será aplicado em cima da data inicial e/ou data final.

HEADERS

KeyDatatypeRequiredDescription
AuthorizationstringBearer Token obtido na autenticação