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 TOTVS Meus Ativos Fixos.
GET /wsatf001/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.
...
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": { "name": "Grupo JLima", "id": "000001" }, "unit": "0001" }, ] } |
GET /wsatf001/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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "location": { "lat": -23.5084952, "lng": -46.6536569, "local": { "code": "0000001". "description": "BRAZ LEME" } }, "image": true, "fields": [ { "identifier": "N1_NOME", "type": "string", "value": "Grua", "label": "Nome" }, { "identifier": "N1_DESC", "type": "string", "value": "Grua 20 metros amarela", "label": "Descrição" }, { "identifier": "N1_QTDE", "type": "number", "value": "2", "label": "Quantidade" }, ], "invoices" : [ { "name": "Grupo JLima", "supplier": "000001", "unit": "000001", "invoice": "0000001", "series": "01" } ], "balances": [ { "asset_type": "0001", "balance_type": "00001", "history": '', "write_off": false, "sequence": "00001" } ] } |
GET /wsatf001/assets/{asset}/{item}/image
Retorna a imagem vinculada ao ativo identificado pelos parâmetros asset e item na url.
Parâmetros aceitos
O parâmetro sera passados por queryParams.
Parâmetro | Tipo | Descrição | Valor Default |
---|---|---|---|
rawimage | string | Retorna a imagem no corpo da resposta com o content type correto | - |
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAagBqAAD/4RDc...........(continuação do conteúdo da imagem)" } |
GET /wsatf001/assets/{asset}/{item}/balances/{asset_type}/{balance_type}/{write_off}/{sequence}
Retorna os detalhes de um saldo do ativo.
O ativo será identificado pelos parâmetros asset e item e o saldo será identificado pelo parâmetros asset_type, balance_type, write_off e sequence.
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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "location": { "lat": -23.5084952, "lng": -46.6536569, "local": "0000001" }, "image": true, "fields": [ { "identifier": "N3_HISTOR", "type": "string", "value": "01", "label": "Histórico" }, { "identifier": "N3_BAIXA", "type": "string", "value": "false", "label": "Baixado" } ] } |
GET /wsatf001/assets/{asset}/{item}/invoice
Retorna a nota vinculada de um ativo identificado pelos parâmetros asset e item.
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 |
---|---|---|---|
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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "fields": [ { "identifier": "NUMNOTA", "type": "string", "value": "000001", "label": "Número da nota" }, { "identifier": "SERIE", "type": "string", "value": "01", "label": "Série da nota" } ], "items" : [ "item": "01", "product" : "Grua", "quantity" : 2 ], "assets": [ "asset" : "000001", "item": "00001", "description" : "Grua" ] } |
GET /wsatf001/invoices/{supplier}/{unit}/{invoice}/{series}
Retorna a nota vinculada identificada pelos parâmetros supplier e unit, invoice e series.
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 |
---|---|---|---|
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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "fields": [ { "identifier": "NUMNOTA", "type": "string", "value": "000001", "label": "Número da nota" }, { "identifier": "SERIE", "type": "string", "value": "01", "label": "Série da nota" } ], "items" : [ "item": "01", "product" : "Grua", "quantity" : 2 ], "assets": [ "asset" : "000001", "item": "00001", "description" : "Grua" ] } |
GET /wsatf001/fields/{fieldType}
Retorna os campos disponíveis para um tipo específico identificado pelo fieldType.
...
- GET /wsatf001/fields/assets
- GET /wsatf001/fields/balances
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 |
---|---|---|---|
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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "fields": [ { "identifier": "NUMNOTA", "type": "string", "label": "Número da nota" }, { "identifier": "SERIE", "type": "string", "label": "Série da nota" } ] } |
GET /wsatf001/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 e 2 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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "hasNext": false, "requests": [ { "operation": "0", "status": "0", "reason": "fazer a baixa de quantidade 10 saldo tipo gerencial balanco gerencial ", "quantity": 10, "balances": [ { "type": "10", "balance_type": "3" } ], "date": "20171010", "value": 0 }, } |
POST /wsatf001/assets/request/
Envia requisição para tranferência / baixa e ampliação do ativo.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Payload
O payload que será enviado na requisição conterá as seguintes propriedades:
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "operation": 1, "asset": "000001", "item": "0001", "type": "0", "status" : 0, "reason" : "teste", "value" : 100, "quantity" : 1, "balance": { "type": "10", "balance_type": "3"} } |
PUT /wsatf001/assets/{asset}/{item}
Grava a localização de um ativo identificado pelos parâmetros asset e item na url. Este serviço pode ser usado de duas formas: enviando lat e lng para atualizar a geolocalização, ou enviando o local para atualizar o N1_LOCAL.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Payload
O payload que será enviado na requisição conterá as seguintes propriedades:
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Exemplo 1: Atualizando a geolocalização { "type": "latlng", "location": { "lat": -93.5084952, "lng": -96.6536569 } } Exemplo 2: Atualizando o N1_LOCAL: { "type": "local", "location": { "local": "0000001000001" } } |
PUT /wsatf001/assets/{asset}/{item}/image
Grava a foto de um ativo identificado pelos parâmetros asset e item na url.
Parâmetros aceitos
Não são aceitos parâmetros de URL para esta requisição.
Payload
O payload que será enviado na requisição conterá as seguintes propriedades:
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
{ "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAagBqAAD/4RDc...........(continuação do conteúdo da imagem)" } |
GET /wsatf001/assets/locations
Serviço para retornar a lista de locais possíveis que podem ser selecionados ao atualizar a localização (N1_LOCAL) de um ativo.
O serviço deve aceitar os parâmetros page, pageSize e searchKey, que fará uma busca na descrição (description) e no código (code) do local. Os dados devem ser retornados em ordem alfabética crescente.
O retorno deve obedecer à estrutura:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
“hasNext”: true,
“locations”: [
{
“code”: “0000001”,
“description”:“BRAZ LEME”
},
{
“code”:“0000002”,
“description”: “CANINDE”
}
]
} |
O retorno da requisição, em caso de sucesso, deve ser um HTTP 200 OK.