Histórico da Página
...
| 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 |
...
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAagBqAAD/4RDc...........(continuação do conteúdo da imagem)"
} |
...
GET /atf/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 na url.
Parâmetros aceitos
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 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".
...
| Propriedade | Tipo | Descrição | Adicional | location|||
|---|---|---|---|---|---|---|
| fields | 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 | ||||
| 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[].identifier | string | Identificador do campo no Protheus | |
| fields[].typelabel | 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. | |||
| 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
...
| language | js |
|---|---|
| theme | RDark |
| title | response.json |
| collapse | true |
...
| Label a ser exibido para o campo, traduzido conforme parâmetro enviado na requisição. |
Exemplo de retorno da requisição:
GET /atf/assets/00001/00001/balances/000001/000001/001/01?language=pt&fields=history,write_off
| 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 /atf/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 |
|---|---|---|---|
| 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:
GET /atf/assets/00001/00001/invoice?fields=numnota,serie
| 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 /atf/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 |
|---|---|---|---|
| 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:
GET /atf/assets/invoices/00001/00001/000001/01?fields=numnota,serie
| 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 /atf/fields/{fieldType}
Retorna os campos disponíveis para um tipo específico identificado pelo fieldType.
Os fieldTypes aceitos são: 'assets', 'balances', 'invoices', correspondendo assim à 3 endpoints distintos:
- GET /atf/fields/assets
- GET /atf/fields/balances
- GET /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:
GET /atf/fields/invoices?language=pt
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"fields": [
{
"identifier": "NUMNOTA",
"type": "string",
"label": "Número da nota"
},
{
"identifier": "SERIE",
"type": "string",
"label": "Série da nota"
}
]
} |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas