Histórico da Página
| Índice | ||
|---|---|---|
|
1 - 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.
2 - GET /atf/entities
Retorna a lista de notas e ativos disponíveis.
...
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 | Object | Objeto do fornecedor da nota | Deve ser null se o objeto representa um ativo |
| entities[].supplier.name | string | Nome do fornecedor | Deve ser null se o objeto representa um ativo |
| entities[].supplier.id | 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:
...
| 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"
},
]
} |
3 - GET /atf/assets/{asset}/{item}
Retorna os detalhes de um ativo identificado pelos parâmetros asset e item na url.
...
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 | Object | Objeto do fornecedor da nota |
| invoices[].supplier.name | string | Nome do fornecedor |
| invoices[].supplier.id | string | Código do fornecedor |
| 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. |
| balances[].asset_type | string | Tipo do ativo | Ref: N3_TIPO |
| balances[].balance_type | string | Tipo do saldo | Ref: N3_TPSALDO |
| balances[].history | string | Histórico do saldo | Ref: N3_HISTOR |
| balances[].write_off | booleano | Indicador se o saldo está baixado ou não | Ref: N3_BAIXA |
| balances[].sequence | string | Sequência de aquisição | Ref: N3_SEQ |
Exemplo de retorno da requisição:
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"location": {
"lat": -23.5084952,
"lng": -46.6536569,
"local": "0000001"
},
"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" : [
{
"supplier": {
"name": "Grupo JLima",
"id": "000001"
},
"unit": "000001",
"invoice": "0000001",
"series": "01"
}
],
"balances": [
{
"asset_type": "0001",
"balance_type": "00001",
"history": '',
"write_off": false,
"sequence": "00001"
}
]
} |
4 - GET /atf/assets/{asset}/{item}/image
Retorna a imagem vinculada ao ativo identificado pelos parâmetros asset e item na url.
Parâmetros aceitos
Nenhum.
Retorno
O serviço deve retornar as propriedades informadas, de acordo com os parâmetros passados na consulta.
O parâmetro sera passados por queryParams.
| ParâmetroPropriedade | Tipo | DescriçãoAdicional | Valor Default |
|---|---|---|---|
| contentrawimage | stringBase64 da | 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.
| Propriedade | Tipo | Descrição | Adicional |
|---|---|---|---|
| content | string | Base64 da imagem cadastrada no sistema para o ativo |
Exemplo de retorno da requisição:
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAagBqAAD/4RDc...........(continuação do conteúdo da imagem)"
} |
5 - GET /atf/assets/{asset}/{item}/balances/{asset_type}/{balance_type}/{write_off}/{sequence}
Retorna os detalhes de um saldo do ativo.
...
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 |
|---|---|---|---|
| fields | Array | Lista com os campos disponíveis para este saldo |
| 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. |
Exemplo de retorno da requisição:
...
| 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"
}
]
} |
6 - GET /atf/assets/{asset}/{item}/invoice
Retorna a nota vinculada de um ativo identificado pelos parâmetros asset e item.
...
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 |
|---|---|---|---|
| fields | Array | Lista com os campos disponíveis para esta nota |
| 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. |
| items | Array | Array com os itens da nota |
| items[].item | string | Item da nota fiscal |
| items[].product | string | Descrição do produto |
| items[].quantity | number | Quantidade comprada do produto |
| assets | Array | Array de ativos vinculados à nota |
| assets[].asset | string | Código do ativo |
| assets[].item | string | Código do item |
| assets[].description | string | Descrição do item |
Exemplo de retorno da requisição:
...
| 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"
]
} |
7 - GET /atf/invoices/{supplier}/{unit}/{invoice}/{series}
Retorna a nota vinculada identificada pelos parâmetros supplier e unit, invoice e series.
...
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' |
| page | number | Página dos ativos que será retornada | 1 |
| pageSize | number | Tamanho da página dos ativos 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 |
|---|---|---|---|
| fields | Array | Lista com os campos disponíveis para esta nota |
| 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. |
| items | Array | Array com os itens da nota |
| items[].item | string | Item da nota fiscal |
| items[].product | string | Descrição do produto |
| items[].quantity | number | Quantidade comprada do produto |
| assets | Array | Array de ativos vinculados à nota |
| assets[].asset | string | Código do ativo |
| assets[].item | string | Código do item |
| assets[].description | string | Descrição do item |
Exemplo de retorno da requisição:
...
| 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"
]
} |
8 - GET /atf/fields/{fieldType}
Retorna os campos disponíveis para um tipo específico identificado pelo fieldType.
...
- GET /atf/fields/assets
- GET /atf/fields/balancesGET /atf/fields/invoices
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.
| Propriedade | Tipo | Descrição | Adicional |
|---|---|---|---|
| fields | Array | Lista com os campos disponíveis para o tipo selecionado |
| 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[].label | string | Label a ser exibido para o campo, traduzido conforme parâmetro enviado na requisição. |
Exemplo de retorno da requisição:
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"fields": [
{
"identifier": "NUMNOTA",
"type": "string",
"label": "Número da nota"
},
{
"identifier": "SERIE",
"type": "string",
"label": "Série da nota"
}
]
} |
9 - GET /atf/requests
Retorna as solicitações do histórico disponíveis para consulta no aplicativo..
...
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:
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"hasNext": true,
"requests" : [
]
} |
10 - POST /atf/assets/{assetID}/requests
Cria uma nova solicitação para o ativo informado pelo parâmetro assetID.
...
O payload que será enviado na requisição conterá as seguintes propriedades:
| Propriedade | Tipo | Descrição | Adicional |
|---|---|---|---|
| operation | number | Indica qual solicitação está sendo requisitada. | 0: Baixa 1: Transferência Física 2: Transferência Contábil 3: Ampliação |
| asset | string | Código do ativo | Se operation != 0, será nulo |
| item | string | Item do ativo | Se operation != 0, será nulo |
| 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:
- item: Código do item (mostrar sempre junto) (null se type != 0)
...
- type: Tipo de transferência (0-física, 1-contábil) (só existe se for operation=1)
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