Webservicesqmb: Difference between revisions

From QuatenusWiki
Created page with "<nowiki>{{QuatenusHeader}}</nowiki> <nowiki>= Web Services Quatenus® Core – Licenciamento =</nowiki> <nowiki>== 📌 Introdução ==</nowiki> Este documento descreve os '''Web Services do Quatenus® Core''' para obtenção de dados de licenciamento. * Versão: 12.00 * Data: Outubro 2025 * Fonte: ----== 🌐 Endereços e Autenticação == <nowiki>=== QDats ===</nowiki> * Licenciamento (Gamas) <nowiki><code>http://services.quatenus-system.com.br/quatenus10/QDats/..."
 
No edit summary
Line 1: Line 1:
<nowiki>{{QuatenusHeader}}</nowiki>
{{QuatenusHeader}}


<nowiki>= Web Services Quatenus® Core – Licenciamento =</nowiki>
= Web Services Quatenus® Core – Licenciamento =


<nowiki>== 📌 Introdução ==</nowiki>
== 📌 Introdução ==


Este documento descreve os '''Web Services do Quatenus® Core''' para obtenção de dados de licenciamento.
Este documento descreve os Web Services do Quatenus® Core para obtenção de dados de licenciamento.


* Versão: 12.00
Versão: 12.00
* Data: Outubro 2025
Data: Outubro 2025
* Fonte:
Fonte:


----== 🌐 Endereços e Autenticação ==
== 🌐 Endereços e Autenticação ==


<nowiki>=== QDats ===</nowiki>
=== QDats ===


* Licenciamento (Gamas) <nowiki><code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl</nowiki><nowiki></code></nowiki>
Licenciamento (Gamas)
* Ativos <nowiki><code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl</nowiki><nowiki></code></nowiki>
<code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl
* Viaturas <nowiki><code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl</nowiki><nowiki></code></nowiki>
</code>
Ativos
<code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl
</code>
Viaturas
<code>http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl
</code>


----=== QBMDats ===
=== QBMDats ===


* Items / Extras <nowiki><code>.../QBMDats/Business/QbmItems/QbmItemsServices.svc?wsdl</code></nowiki>
Items / Extras
* Entidades <nowiki><code>.../QBMDats/Administration/Entities/Entity.svc?wsdl</code></nowiki>
<code>.../QBMDats/Business/QbmItems/QbmItemsServices.svc?wsdl</code>
* Documentos <nowiki><code>.../QBMDats/Documents/Document.svc?wsdl</code></nowiki>
Entidades
* Payment Terms <nowiki><code>.../QbmDats/Business/PaymentTerms/PaymentTermsServices.svc?wsdl</code></nowiki>
<code>.../QBMDats/Administration/Entities/Entity.svc?wsdl</code>
Documentos
<code>.../QBMDats/Documents/Document.svc?wsdl</code>
Payment Terms
<code>.../QbmDats/Business/PaymentTerms/PaymentTermsServices.svc?wsdl</code>


----=== 🔐 Autenticação ===
=== 🔐 Autenticação ===


Parâmetros comuns:
Parâmetros comuns:


<nowiki>{| class="wikitable"</nowiki>
{| class="wikitable"
{| class="wikitable"
!<nowiki>! Parâmetro !! Descrição</nowiki>
|-
|companyId
|-
| -
|-
|deviceIds
|-
| -
|-
|userName
|-
| -
|-
|password
|-
| -
|-
|token
|-
| }
|}
----== 🧪 Serviços Disponíveis ==


<nowiki>=== 📦 Gamas ===</nowiki>
! Parâmetro !! Descrição
companyId
-
deviceIds
-
userName
-
password
-
token
}


* <nowiki><code>SrvGovernmentGet.GetPartnerCodesFamilies()</code></nowiki>
== 🧪 Serviços Disponíveis ==


<nowiki>=== 📱 Dispositivos ===</nowiki>
=== 📦 Gamas ===


* <nowiki><code>ISrvGtiAssetGet.GetAssetBrands()</code></nowiki>
<code>SrvGovernmentGet.GetPartnerCodesFamilies()</code>
* <nowiki><code>ISrvGtiAssetGet.GetAssetModels()</code></nowiki>


<nowiki>=== 🚗 Viaturas ===</nowiki>
=== 📱 Dispositivos ===


* <nowiki><code>ISrvGtiFleetGet.GetVehiclesBrands()</code></nowiki>
<code>ISrvGtiAssetGet.GetAssetBrands()</code>
* <nowiki><code>ISrvGtiFleetGet.GetVehiclesModels()</code></nowiki>
<code>ISrvGtiAssetGet.GetAssetModels()</code>
* <nowiki><code>ISrvGtiFleetGet.GetVehiclesClassType()</code></nowiki>
* <nowiki><code>ISrvGtiFleetGet.GetFuelTypes()</code></nowiki>


<nowiki>=== 📦 Items ===</nowiki>
=== 🚗 Viaturas ===


* <nowiki><code>QbmItemsServices.GetLicensableItems()</code></nowiki>
<code>ISrvGtiFleetGet.GetVehiclesBrands()</code>
* <nowiki><code>QbmItemsServices.GetLicensableItemExtras()</code></nowiki>
<code>ISrvGtiFleetGet.GetVehiclesModels()</code>
* <nowiki><code>QbmItemsServices.GetDeviceClasses()</code></nowiki>
<code>ISrvGtiFleetGet.GetVehiclesClassType()</code>
<code>ISrvGtiFleetGet.GetFuelTypes()</code>


<nowiki>=== 👤 Entidades ===</nowiki>
=== 📦 Items ===


* <nowiki><code>IEntity.GetCustomers()</code></nowiki>
<code>QbmItemsServices.GetLicensableItems()</code>
* <nowiki><code>IEntity.GetPartners()</code></nowiki>
<code>QbmItemsServices.GetLicensableItemExtras()</code>
<code>QbmItemsServices.GetDeviceClasses()</code>


<nowiki>=== 📄 Documentos ===</nowiki>
=== 👤 Entidades ===


* <nowiki><code>IDocument.GetExternalContracts()</code></nowiki>
<code>IEntity.GetCustomers()</code>
* <nowiki><code>IDocument.GetExternalBillingEvents()</code></nowiki>
<code>IEntity.GetPartners()</code>


<nowiki>=== 💰 Pagamentos ===</nowiki>
=== 📄 Documentos ===


* <nowiki><code>IPaymentTermsServices.GetPaymentTermsExternal()</code></nowiki>
<code>IDocument.GetExternalContracts()</code>
<code>IDocument.GetExternalBillingEvents()</code>


----== 🔎 Estrutura Geral dos Serviços ==
=== 💰 Pagamentos ===
 
<code>IPaymentTermsServices.GetPaymentTermsExternal()</code>
 
== 🔎 Estrutura Geral dos Serviços ==


A maioria dos serviços segue o mesmo padrão:
A maioria dos serviços segue o mesmo padrão:


<nowiki>=== Argumentos Comuns ===</nowiki>
=== Argumentos Comuns ===


<nowiki>{| class="wikitable"</nowiki>
{| class="wikitable"
{| class="wikitable"
!<nowiki>! Campo !! Descrição</nowiki>
 
|-
! Campo !! Descrição
|filter
filter
|-
-
| -
companyIds
|-
-
|companyIds
cultureInfo
|-
-
| -
timeZoneOffset / timeZoneId
|-
-
|cultureInfo
currentPage / pageNumber
|-
-
| -
pageSize / rowsPerPage
|-
-
|timeZoneOffset / timeZoneId
sortColumnName
|-
-
| -
sortDirection
|-
-
|currentPage / pageNumber
userName
|-
-
| -
password
|-
-
|pageSize / rowsPerPage
token
|-
}
| -
 
|-
=== Estrutura de Resposta ===
|sortColumnName
|-
| -
|-
|sortDirection
|-
| -
|-
|userName
|-
| -
|-
|password
|-
| -
|-
|token
|-
| }
|}
----=== Estrutura de Resposta ===


Normalmente:
Normalmente:


<nowiki>{| class="wikitable"</nowiki>
{| class="wikitable"
{| class="wikitable"
!<nowiki>! Campo !! Descrição</nowiki>
|-
|Rows
|-
| -
|-
|TotalRows
|-
| }
|}
----== 📦 Exemplos de Serviços ==


<nowiki>=== SrvGovernmentGet.GetPartnerCodesFamilies ===</nowiki>
! Campo !! Descrição
Rows
-
TotalRows
}
 
== 📦 Exemplos de Serviços ==
 
=== SrvGovernmentGet.GetPartnerCodesFamilies ===


Obtém gamas de produtos.
Obtém gamas de produtos.


<nowiki>==== Retorno ====</nowiki>
==== Retorno ====


* PartnerCodeFamilyId
PartnerCodeFamilyId
* Code
Code
* Description
Description
* Type (B2B / B2C)
Type (B2B / B2C)


----=== ISrvGtiAssetGet.GetAssetBrands ===
=== ISrvGtiAssetGet.GetAssetBrands ===


Obtém marcas de dispositivos.
Obtém marcas de dispositivos.


<nowiki>==== Retorno ====</nowiki>
==== Retorno ====


* AssetBrandId
AssetBrandId
* Name
Name
* Origin (Global / Local)
Origin (Global / Local)


----=== ISrvGtiAssetGet.GetAssetModels ===
=== ISrvGtiAssetGet.GetAssetModels ===


Obtém modelos de dispositivos.
Obtém modelos de dispositivos.


<nowiki>==== Notas ===</nowiki>
==== Notas ===


* Pode filtrar por tipo (mobile, computer, machine)
Pode filtrar por tipo (mobile, computer, machine)
* Pode filtrar ativos/inativos
Pode filtrar ativos/inativos


----=== ISrvGtiFleetGet.GetVehiclesBrands ===
=== ISrvGtiFleetGet.GetVehiclesBrands ===


Obtém marcas de viaturas.
Obtém marcas de viaturas.
----=== ISrvGtiFleetGet.GetVehiclesModels ===
 
=== ISrvGtiFleetGet.GetVehiclesModels ===


Obtém modelos de viaturas.
Obtém modelos de viaturas.
Line 203: Line 178:
Inclui:
Inclui:


* Dados técnicos (motor, consumo, dimensões)
Dados técnicos (motor, consumo, dimensões)
* Marca associada
Marca associada
* Categoria e classe
Categoria e classe


----=== QbmItemsServices.GetLicensableItems ===
=== QbmItemsServices.GetLicensableItems ===


Obtém produtos licenciáveis QBM.
Obtém produtos licenciáveis QBM.


<nowiki>==== Filtros avançados ===</nowiki>
==== Filtros avançados ===


Formato JSON:
Formato JSON:


<nowiki><code> { "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } } </code></nowiki>
<code> { "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } } </code>


<nowiki>==== Retorno ===</nowiki>
==== Retorno ===


* Code
Code
* Description
Description
* ItemType (Produto / Serviço)
ItemType (Produto / Serviço)
* UnitPrice
UnitPrice
* TaxRate
TaxRate
* Discount
Discount


----=== QbmItemsServices.GetLicensableItemExtras ===
=== QbmItemsServices.GetLicensableItemExtras ===


Obtém extras associados a um item.
Obtém extras associados a um item.
----=== QbmItemsServices.GetDeviceClasses ===
 
=== QbmItemsServices.GetDeviceClasses ===


Obtém tipos de ativos.
Obtém tipos de ativos.
Line 235: Line 211:
Exemplos:
Exemplos:


* VEHICLE
VEHICLE
* MOTORCYCLE
MOTORCYCLE


----=== IEntity.GetCustomers ===
=== IEntity.GetCustomers ===


Obtém clientes externos.
Obtém clientes externos.


<nowiki>==== Filtros disponíveis ===</nowiki>
==== Filtros disponíveis ===


* Estado (ACTIVE / INACTIVE)
Estado (ACTIVE / INACTIVE)
* VIP
VIP
* País
País
* Data última atualização
Data última atualização


<nowiki>==== Informação retornada ===</nowiki>
==== Informação retornada ===


* Dados de faturação
Dados de faturação
* Métodos de pagamento
Métodos de pagamento
* Contactos
Contactos
* Moeda
Moeda
* Estado (ativo/inativo)
Estado (ativo/inativo)


----== ⚙️ Serviços Auxiliares ==
== ⚙️ Serviços Auxiliares ==


Incluem:
Incluem:


* Países
Países
* Regiões
Regiões
* Moedas
Moedas
* Idiomas
Idiomas
* Fusos horários
Fusos horários


----== 📎 Notas Importantes ==
== 📎 Notas Importantes ==


⚠️ Os endpoints podem variar consoante a infraestrutura
⚠️ Os endpoints podem variar consoante a infraestrutura
Line 274: Line 250:


⚠️ Datas devem respeitar formato e timezone definidos
⚠️ Datas devem respeitar formato e timezone definidos
----== 🧩 Apêndices ==


* Lista de fusos horários suportados
== 🧩 Apêndices ==
* Lista de culturas suportadas
 
Lista de fusos horários suportados
Lista de culturas suportadas


----<nowiki>{{QuatenusFooter}}</nowiki>
{{QuatenusFooter}}

Revision as of 15:19, 28 April 2026

Web Services Quatenus® Core – Licenciamento

📌 Introdução

Este documento descreve os Web Services do Quatenus® Core para obtenção de dados de licenciamento.

Versão: 12.00 Data: Outubro 2025 Fonte:

🌐 Endereços e Autenticação

QDats

Licenciamento (Gamas) http://services.quatenus-system.com.br/quatenus10/QDats/SrvGovernmentGet.svc?wsdl Ativos http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiAssetGet.svc?wsdl Viaturas http://services.quatenus-system.com.br/quatenus10/QDats/SrvGtiFleetGet.svc?wsdl

QBMDats

Items / Extras .../QBMDats/Business/QbmItems/QbmItemsServices.svc?wsdl Entidades .../QBMDats/Administration/Entities/Entity.svc?wsdl Documentos .../QBMDats/Documents/Document.svc?wsdl Payment Terms .../QbmDats/Business/PaymentTerms/PaymentTermsServices.svc?wsdl

🔐 Autenticação

Parâmetros comuns:

Parâmetro Descrição

companyId - deviceIds - userName - password - token }

🧪 Serviços Disponíveis

📦 Gamas

SrvGovernmentGet.GetPartnerCodesFamilies()

📱 Dispositivos

ISrvGtiAssetGet.GetAssetBrands() ISrvGtiAssetGet.GetAssetModels()

🚗 Viaturas

ISrvGtiFleetGet.GetVehiclesBrands() ISrvGtiFleetGet.GetVehiclesModels() ISrvGtiFleetGet.GetVehiclesClassType() ISrvGtiFleetGet.GetFuelTypes()

📦 Items

QbmItemsServices.GetLicensableItems() QbmItemsServices.GetLicensableItemExtras() QbmItemsServices.GetDeviceClasses()

👤 Entidades

IEntity.GetCustomers() IEntity.GetPartners()

📄 Documentos

IDocument.GetExternalContracts() IDocument.GetExternalBillingEvents()

💰 Pagamentos

IPaymentTermsServices.GetPaymentTermsExternal()

🔎 Estrutura Geral dos Serviços

A maioria dos serviços segue o mesmo padrão:

Argumentos Comuns

Campo Descrição

filter - companyIds - cultureInfo - timeZoneOffset / timeZoneId - currentPage / pageNumber - pageSize / rowsPerPage - sortColumnName - sortDirection - userName - password - token }

Estrutura de Resposta

Normalmente:

Campo Descrição

Rows - TotalRows }

📦 Exemplos de Serviços

SrvGovernmentGet.GetPartnerCodesFamilies

Obtém gamas de produtos.

Retorno

PartnerCodeFamilyId Code Description Type (B2B / B2C)

ISrvGtiAssetGet.GetAssetBrands

Obtém marcas de dispositivos.

Retorno

AssetBrandId Name Origin (Global / Local)

ISrvGtiAssetGet.GetAssetModels

Obtém modelos de dispositivos.

= Notas

Pode filtrar por tipo (mobile, computer, machine) Pode filtrar ativos/inativos

ISrvGtiFleetGet.GetVehiclesBrands

Obtém marcas de viaturas.

ISrvGtiFleetGet.GetVehiclesModels

Obtém modelos de viaturas.

Inclui:

Dados técnicos (motor, consumo, dimensões) Marca associada Categoria e classe

QbmItemsServices.GetLicensableItems

Obtém produtos licenciáveis QBM.

= Filtros avançados

Formato JSON:

{ "Data":{ "Global":"", "Extra":"", "Units":"", "ItemTypes":"", "IsEnabledFilter":"ALL" } }

= Retorno

Code Description ItemType (Produto / Serviço) UnitPrice TaxRate Discount

QbmItemsServices.GetLicensableItemExtras

Obtém extras associados a um item.

QbmItemsServices.GetDeviceClasses

Obtém tipos de ativos.

Exemplos:

VEHICLE MOTORCYCLE

IEntity.GetCustomers

Obtém clientes externos.

= Filtros disponíveis

Estado (ACTIVE / INACTIVE) VIP País Data última atualização

= Informação retornada

Dados de faturação Métodos de pagamento Contactos Moeda Estado (ativo/inativo)

⚙️ Serviços Auxiliares

Incluem:

Países Regiões Moedas Idiomas Fusos horários

📎 Notas Importantes

⚠️ Os endpoints podem variar consoante a infraestrutura

⚠️ Alguns serviços exigem parâmetros obrigatórios dependendo da configuração

⚠️ Datas devem respeitar formato e timezone definidos

🧩 Apêndices

Lista de fusos horários suportados Lista de culturas suportadas