Histórico da Página
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"fields": [
{
"identifier": "NUMNOTA",
"type": "string",
"label": "Número da nota"
},
{
"identifier": "SERIE",
"type": "string",
"label": "Série da nota"
}
]
} |
GET /atf/requests
Retorna as solicitações do histórico disponíveis para consulta no aplicativo..
Parâmetros aceitos
Os parâmetros serão passados por queryParams e poderão ser utilizados em conjunto. Caso haja mais de um parâmetro enviado, a lógica utilizada dever ser "E".
| Parâmetro | Tipo | Descrição | Valor Default |
|---|---|---|---|
| operation | number | Indica o filtro do tipo de solicitação. Só são aceitos os valores: 0 para baixa, 1 para transferência física, 2 para transferência contábil e 3 para ampliação | Retornar todas |
| status | number | Indica o filtro do status da solicitação. O valor 0 indicará pendente, o valor 1 indicará finalizada, e o valor 2 indicará cancelada | Retornar todas |
| date | string | Filtra o retorno por mês e ano (YYYYMM) | - |
| page | number | Página que será retornada | 1 |
| pageSize | number | Tamanho da página que será retornada | 10 |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
| Propriedade | Tipo | Descrição | Adicional |
|---|---|---|---|
| hasNext | booleano | Indica se há ou não uma próxima página a ser retornada | |
| requests | Array | Array de requests disponíveis | |
| requests[].operation | number | Tipo de solicitação | 0: Baixa 1: Transferência Física 2: Transferência Contábil 3: Ampliação |
| requests[].status | number | Status da solicitação | 0: Pendente 1: Finalizada 2: Cancelada |
| requests[].date | string | Data da solicitação, no formato YYYYMMDD | |
| requests[].reason | string | Este campo muda seu conteúdo de acordo com o tipo de solicitação. | Se operation=0, será retornado o motivo. Se operation=1, serão retornados os detalhes Se operation=2, será retornada a observação |
| requests[].value | string | Valor | Só existe se operation for != 1 |
| requests[].quantity | number | Quantidade que for baixada | Só existe se operation for 0 |
| requests[].balance | string | Saldo que foi baixado | Só existe se operation for 0 |
Exemplo de retorno da requisição:
GET /atf/requests?page=1&pageSize=1
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"hasNext": true,
"requests" : [
]
} |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas