Histórico da Página

...

language

js

Eclipse

Raw

Atenção

Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, um bem com contador, necessariamente precisa do campo "counter" preenchido, Exemplo: "counter": 50.

card

Alteração de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: PUT

Altera um Abastecimento.

Ao executar a chamada do webservice o método irá:

Alterar um abastecimento já existente;
Preencher os todos os campos obrigatórios para gerar um abastecimento:

Body

Campos que compõe a alteração de um abastecimento.

Deck of Cards

startHidden	false
id	0
effectType	fade
loopCards	true

label

Card

label	Solcitação de Serviço

Deck of Cards

startHidden	false
id	0
effectType	fade
loopCards	true

Card

id	0
label	Inclusão de Solicitação de Serviço

Método: /mntsrws/api/v1/request

Tipo: POST

Inclui uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

Incluir uma Solicitação de Serviço;
Preencher os todos os campos obrigatórios para gerar uma Solicitação de Serviço:

Body

Campos que compõe a requisição de inclusão da S.S..

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
location	Logic	-	Define se é para bem ou localização	Condicional	TQB_TIPOSS
origin	String	20	Origem de Registro	Sim	TQB_ORIGEM
equipment	String	16	Código do Bem/Localização	Sim	TQB_CODBEM
description	String	999	Descrição da Solicitação	Sim	TQB_DESCSS
costCenter	String	20	Código do Centro de Custo da S.S.	Não	TQB_CCUSTO
counter	Numeric	09	Primeiro Contador do Equipamento	Condicional	TQB_POSCON
secondCounter	Numeric	09	Segundo Contador do Equipamento	Condicional	TQB_POSCO2
telephoneExtension	String	10	Ramal	Condicional	TQB_RAMAL
serviceType	String	06	Código do Serviço da S.S.	Não	TQB_CDSERV
priority	String	01	Prioridade	Não	TQB_PRIORI

Exemplo de uma requisição básica:

Bloco de código

language	js
theme	Eclipse
title	Raw

{
	"equipment":"001",
	"dateTime":"20220419 13:00",
	"description":"Não esta refrigerando",
	"serviceType": "000001",
	"telephoneExtension": "569"
	"counter":2300,
	"secondCounter":550,
	"location":true
}

Nota

title	Atenção

O campo dateTime deverá conter um espaço entre a data e hora("dateTime":"20220430 11:00").
Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, caso a S.S. for inclusa para uma Localização, será necessário adicionar "location":true no body.

Card

id	1
label	Distribuição de Solicitação de Serviço

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Distribui uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

Incluir uma S.S.;
Preencher os campos obrigatórios para distribuir a S.S.;
No value deverá ser informado o número da Solicitação de serviço: /mntsrws/api/v1/request/000298/distribute, que no caso do exemplo foi utilizado como 000298.

Body

Lista dos campos disponíveis no método de inclusão de O.S.:

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
executor	String	25	Define se é para bem ou localização	Condicional	TQB_CDEXEC
serviceType	String	20	Origem de Registro	Sim	TQB_CDSERV

Exemplo de distribuição de uma S.S.:

Bloco de código

language	js
theme	Eclipse
title	Raw

{   
    "executor":"000000",
    "serviceType":"000001"
}

Card

id	1
label	Inclusão de O.S. a partir de uma Solicitação de Serviço

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Inclui uma O.S. a partir de uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

Incluir uma O.S. para a Solicitação de Serviço já existente;
Preencher os campos obrigatórios para gerar a O.S.;
No value deverá ser informado o número da Solicitação de serviço: /mntsrws/api/v1/request/000298/order, que no caso do exemplo foi utilizado como 000298.

Body

Lista dos campos disponíveis no método de inclusão de O.S.:

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
location	Logic	-	Define se é para bem ou localização	Condicional	TJ_TIPOOS
origin	String	20	Origem de Registro	Sim	TQB_ORIGEM
equipment	String	16	Código do Bem/Localização	Sim	TJ_CODBEM
costCenter	String	20	Código do Centro de Custo da O.S.	Sim	TJ_CCUSTO
startDate	String	08(data) + 05(hora)	Data e Hora da abertura da O.S.( 20220419 13:00 )	Sim	TJ_DTORIGI / TJ_HOMPINI / TJ_HORACO1 / TJ_HORACO2
service	String	20	Código do serviço da O.S.	Sim	TJ_SERVICO
situation	Numeric	09	Situação da O.S. ( P = Pendente / L = Liberada )	Sim	TJ_SITUACA
counter	Numeric	09	Primeiro Contador do Equipamento	Condicional	TJ_POSCON
secondCounter	Numeric	09	Segundo Contador do Equipamento	Condicional	TJ_POSCO2
workCenter	Numeric	09	Código do Centro de Trabalho	Não	TJ_CENTRAB
sequence	String	10	Sequência da Manutenção	Não	TJ_SEQRELA
downTime	String	06	Data e Hora de Para inicio do bem da O.S.( 20220430 11:00 )	Não	TJ_DTPRINI / TJ_HOPRINI
inputs	array	999	Array de Insumos previstos da O.S.	Não	-

Inputs

Lista dos campos que estão disponíveis para serem utilizados dentro do inputs:

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
operation	String	01	C = Inclusão do Insumo	Sim	-
task	String	06	Código da Tarefa	Sim	TL_TAREFA
type	String	01	Tipo de Insumo	Sim	TL_TIPOREG
code	String	30	Código do Insumo	Sim	TL_CODIGO
unity	String	02	Unidade do Insumo	Sim	TL_UNIDADE
amount	Numeric	09	Quantidade do Insumo	Sim	TL_QUANTID
isDone	Logic	-	Define se é Insumo previsto ou realizado	Sim	-
date	String	08(data) + 05(hora)	Data e Hora inicio previsto para o insumo	Sim	TL_DTINICI / TL_HOINICI
destiny	String	01	Destino do insumo	Condicional	TL_DESTINO
resourceAmount	Numeric	03	Quantidade do recurso	Condicional	TL_QUANREC
warehouse	String	06	Almoxarifado	Condicional	TL_LOCAL
note	String	10	Observações (MEMO)	Condicional	TL_OBSERVA

Exemplo de inclusão de uma O.S. sem informar insumo:

Bloco de código

language	js
theme	Eclipse
title	Raw

{   
    "equipment":"CLIO",
    "service":"CORGEN",
    "situation": "L",
    "costCenter": "099",
    "startDate":"20200101 14:00"
}

Exemplo de inclusão de uma O.S. informando um insumo do tipo produto:

Bloco de código

language	js
theme	Eclipse
title	Raw

{  
    "equipment":"CLIO",
    "service":"CORGEN",
    "situation": "L",
    "costCenter": "099",
    "startDate":"20200101 14:00",
    "inputs":[  
      {  
         "operation":"C",
         "task":"0",
         "destiny":"A",
         "code":"PRODGEN",
         "type":"P",
         "warehouse":"01",
         "date":"20180701 09:00",
         "amount":3,
         "isDone":false,
         "unity":"UN"
      }
    ]
}

Nota

title	Atenção

O campo date deverá conter um espaço entre a data e hora("date":"20220430 11:00");
Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, caso o insumo da O.S. a ser incluída for do tipo Produto, será necessário adicionar destiny ao body.

Card

Abastecimento

fade

true

0

Inclusão de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: POST

Inclui um Abastecimento.

Ao executar a chamada do webservice o método irá:

Incluir um abastecimento;
Preencher os todos os campos obrigatórios para gerar um abastecimento:

Body

Campos que compõe a requisição de um abastecimento.

Cloak

Deck of Cards
id	0	effectType	loopCards
Card
id	label

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
plate	String	8	Placa do Veículo	Sim	TQN_PLACA
equipment	String	16	Código do Veículo	Sim	TQN_FROTA
fuel	String	03	Código do Combustível	Sim	TQN_CODCOM
gasStation	String	14	Código do posto	Sim	TQN_POSTO
store	String	14	Código do loja	Sim	TQN_LOJA
cnpj	String	14	CNPJ do posto	Não	TQN_CNPJ
date	Date	08	Data do abastecimento	Sim	TQN_DTABAS
hour	String	05	Hora da abastecimento	Sim	TQN_HRABAS
tank	String	02	tanque do posto	Sim	TQN_TANQUE
bomb	String	03	bomba do posto	Sim	TQN_BOMBA
quant	Numeric	09	quantidade abastecida	Sim	TQN_QUANT
unitaryValue	Numeric	09	valor unitário do combustível	Sim	TQN_VALUNI
amount	Numeric	15	valor total do combustível	Sim	TQN_VALTOT
counter	Numeric	09	Contador do equipamento	Condicional	TQN_HODOM
secondCounter	Numeric	09	Segundo Contador do equipamento	Condicional	TQN_POSCO2
driver	String	06	Código do motorista	Condicional	TQN_CODMOT
invoice	String	09	Código da nota fiscal	Condicional	TQN_NOTFIS
trip	String	06	Código da viagem	Condicional	TQN_CODVIA
scale	String	08	Código da escala	Condicional	TQN_ESCALA

Exemplo de um abastecimento padrão:

Bloco de código

theme

title

Nota

title

{
   "plate":"MNT-1234",
   "equipment":"VEI-S10",
   "fuel":"MNT",
   "gasStation":"MNTPOS",
   "store":"01",
   "cnpj":"34236121000159",
   "date":"20230220",
   "hour":"12:10",
   "tank":"01",
   "bomb":"01",
   "quant":5,
   "unitaryValue":4,
   "amount":20
   
}

label

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
equipment	String	16	Código do Veículo	Sim	TQN_CODBEM
date	String	08	Data do abastecimento	Sim	TQN_DTABAS
hour	String	05	Hora da abastecimento	Sim	TQN_HRABAS
quant	Numeric	09	quantidade abastecida	Sim	TQN_QUANT
unitaryValue	Numeric	09	valor unitário do combustivel	Sim	TQN_VALUNI
amount	Numeric	15	valor total do combustível	Sim	TQN_VALTOT

Bloco de códigolanguagetheme

js

title

Eclipse

Cardlabel

Raw

{
   "equipment":"VEI-S10",
   "date":"20230320",
   "hour":"12:10",
   "quant":6,
   "unitaryValue":4,
   "amount":24
   
}

Deleção de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: DELETE

Excluí um Abastecimento.

Ao executar a chamada do webservice o método irá:

Excluir um abastecimento já existente;
Preencher os todos os campos obrigatórios para gerar um abastecimento:

Body

Campos que compõe a alteração de um abastecimento.

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
equipment	String	16	Código do Veículo	Sim	TQN_CODBEM
dateTime	String	08	Data do abastecimento	Sim	TQN_DTABAS
time	String	05	Hora da abastecimento	Sim	TQN_HRABAS

Bloco de códigolanguagetheme

js

title

Eclipse

Raw

{ "equipment":"VEI-S10", "date":"20230320", "hour":"12:10" }

Informações adicionais:

Integração via API; https://www.totvs.com/blog/inovacoes/integracao-via-api/
API reference Totvs; https://api.totvs.com.br/;
Caso esteja ocorrendo algum problema, verificar a seção de dúvidas frequentes, no link http://tdn.totvs.com/x/J4HpDw.

Árvore de páginas

Versões comparadas

Versão antiga 22

Nova versão 23

Chave

Método: mntFuelUp/api/v1/fuelup

Tipo: PUT

Body

Método: /mntsrws/api/v1/request

Tipo: POST

Body

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Inputs

Método: mntFuelUp/api/v1/fuelup

Tipo: POST

Body

Método: mntFuelUp/api/v1/fuelup

Tipo: DELETE

Body