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:
Atributo | Descrição | Obrigatório |
---|---|---|
busca | Tipo de busca que deseja fazer no cliente | Sim |
termo_busca | Termo utilizado para fazer a busca | Sim |
limit | Limite de resultados | Não |
apenas_pendente | Informa de deseja trazer apenas as faturas pendentes | Não |
order_by | Campo que será utilizado para ordenação | Não |
order_type | Tipo da Ordenação | Não |
data_inicio | Data de Início (Utiliza a data de vencimento como base) | Não |
data_fim | Data de Fim (Utiliza a data de vencimento como base) | Não |
Os atributos podem conter os seguintes valores:
Atributo | Descrição | Valor Default |
---|---|---|
busca | cpfcnpj, codigocliente, idclienteservico | Nenhum |
termo_busca | Campo livre | Sim |
limit | Valor mínimo 1, Valor máximo 50. | 20 |
apenas_pendente | sim,nao. | sim |
order_by | datavencimento,datapagamento,data_cadastro,valor. | data_vencimento |
order_type | asc,desc. | asc |
data_inicio | Campo no formato DateTime (YYYY-MM-DD) | Nenhum |
data_fim | Campo no formato DateTime (YYYY-MM-DD) | Nenhum |
tipo_data | datavencimento, datapagamento, data_cadastro | data_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
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | Bearer Token obtido na autenticação |