Histórico da Página
| Índice | ||
|---|---|---|
|
Objetivos
Determinar os serviços que estarão disponíveis no Protheus para que haja compatibilidade entre o módulo de Ativo Fixo e o aplicativo ATF Mobile.
GET /atf/entities
Retorna a lista de notas e ativos disponíveis.
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 |
|---|---|---|---|
| searchKey | string | Filtra em diversos campos das notas e ativos | - |
| barcode | string | Filtra uma nota ou ativo pelo código de barras | - |
| type | number | Filtra entre ativos (0) ou notas(1) | - |
| page | number | Página inicial 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á uma próxima página a ser retornada ou se atingiu a última página disponível | true = Há uma próxima página false = É a última página disponível |
| entities | Array | Lista com os objetos de notas e ativos retornados. | - |
| entities[].type | number | Indica se o objeto é uma nota ou um ativo | 0 - ativo 1 - nota |
| entities[].asset | string | Código do ativo | Deve ser null se o objeto representa uma nota |
| entities[].item | string | Código do item do ativo | Deve ser null se o objeto representa uma nota |
| entities[].description | string | Descrição do item | Deve ser null se o objeto representa uma nota |
| entities[].invoice | string | Número da nota | Deve ser null se o objeto representa um ativo |
| entities[].series | string | Série da nota | Deve ser null se o objeto representa um ativo |
| entities[].supplier | string | Código do fornecedor | Deve ser null se o objeto representa um ativo |
| entities[].unit | string | Código da loja | Deve ser null se o objeto representa um ativo |
Exemplo de retorno da requisição:
GET /atf/entities?page=1&pageSize=2&searchKey="Gr"
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"hasNext": true,
"entities" : [
{
"type": 0,
"asset": "00001",
"item": "00001",
"description": "Grua",
"invoice": null,
"series": null,
"supplier": null,
"unit": null
},
{
"type": 1,
"asset": null,
"item": null,
"description": null,
"invoice": "000001",
"series": "01",
"supplier": "Grupo JLima",
"unit": "0001"
},
]
} |
GET /atf/assets/{asset}/{item}
Retorna os detalhes de um ativo identificado pelos parâmetros asset e item na url.
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 |
|---|---|---|---|
| fields | string | Lista de campos (separados por vírgula) que devem ser retornados. | - |
| language | string | Indica o formato que os labels dos campos solicitados devem ser retornados. Só são aceitos os valores: 'pt' para português, 'en' para inglês e 'es' para espanhol | 'pt' |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
| Propriedade | Tipo | Descrição | Adicional |
|---|---|---|---|
| location | Object | Objeto indicando a localização do ativo | Caso o ativo esteja sem localização cadastrada, retornar null. |
| location.lat | number | Latitude da localização do ativo | |
| latitude.lng | number | Longitude da localização do ativo |
|
| location.addess | string | Localização do ativo no sistema | |
| image | booleano | indicador se o ativo possui ou não uma imagem cadastrada no sistema | |
| fields | Array | Lista com os campos disponíveis para este ativo | |
| fields[].identifier | string | Identificador do campo no Protheus | |
| fields[].type | string | Tipo (simplificado) do campo no Protheus | Só serão aceitos 5 tipos de campos: 'text', 'number', 'date', 'lookup', 'other' |
| fields[].value | string | Valor a ser exibido no campo | |
| fields[].label | string | Label a ser exibido para o campo, traduzido conforme parâmetro enviado na requisição. | |
| invoices | Array | Lista de notas vinculada à aquele ativo | Serão exibidas pelo mobile de acordo com a ordem enviada pelo serviço. |
| invoices[].supplier | string | Fornecedor da nota | |
| invoices[].unit | string | Loja | |
| invoices[].invoice | string | Número da nota | |
| invoices[].series | string | Série da nota | |
| balances | Array | Saldos disponível para o item | Serão exibidos no mobile de acordo com a ordem enviada pelo serviço. |
| asset_type | string | Tipo do ativo | Ref: N3_TIPO |
| balance_type | string | Tipo do saldo | Ref: N3_TPSALDO |
| history | string | Histórico do saldo | Ref: N3_HISTOR |
| write_off | booleano | Indicador se o saldo está baixado ou não | Ref: N3_BAIXA |
| sequence | string | Sequência de aquisição | Ref: N3_SEQ |
Exemplo de retorno da requisição:
GET /atf/assets/00001/00001?language=pt&fields=name,description,quantity
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas