Keepfy GraqhQL API
Detalhamento das APIs de consumo do Keepfy.
Contato |
suporte@keepfy.com
Política de Privacidade |
https://keepfy.com/politica-de-privacidade/
API Endpoints
# Production:
https://app.keepfy.com/graphql
Headers
# Your token for authentication
Authorization: access-token <YOUR_TOKEN_HERE>Authentication
Para consumir nossas APIs, você precisará de um token de acesso (access-token) como método de autenticação.
Essa chave pode ser gerada a partir das credenciais de integração (Access Key e Access Secret) da sua organização, conforme os passos abaixo.
Essa chave pode ser gerada a partir das credenciais de integração (Access Key e Access Secret) da sua organização, conforme os passos abaixo.
Gerando suas credenciais de integração
Sendo um usuário com perfil de Administrador, acesse Minha Conta > Organização e vá até a seção Integração Externa.
Selecione a opção Gerar Integração, informe um nome de sua preferência e selecione opção Salvar.
Note que as credencias Access Key e Access Secret foram criadas e agora estão disponíveis para seu uso.
Selecione a opção Gerar Integração, informe um nome de sua preferência e selecione opção Salvar.
Note que as credencias Access Key e Access Secret foram criadas e agora estão disponíveis para seu uso.
Importante: o Access Secret será visualizado apenas nesse momento. Dessa forma, armazene essa informação em um local seguro de sua preferência, a fim de evitar que pessoas não autorizadas tenham acesso à ele.
Gerando seu token de acesso
Execute a mutation
createAccessToken, utilizando suas credencias de integração (Access Key e Access Secret).
Pronto! O retorno terá a chave token que deverá ser utilizado nas suas requisições.
Usando seu token de acesso
Ao consumir nossas APIs, basta adicionar no header da requisição a chave "access-token" juntamente do token gerado no passo anterior, seguindo o exemplo a seguir:
Access Token
{
"access-token": "d917e25fcd1ea997b13a591f5fc7a66af5431d64905cf2f42c96c8329de741f3"
}
Operations
Queries
Q
activeCustomers
Response
Returns a PaginatedCustomers!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query ActiveCustomers(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
activeCustomers(
pagination: $pagination,
query: $query
) {
items {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
attachments {
...AttachmentFragment
}
branch {
...BranchFragment
}
users {
...UserOrganizationListingFragment
}
agreements {
...CustomerAgreementFragment
}
id
type
name
isActive
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"activeCustomers": {
"items": [CustomerPartner],
"hasMore": false
}
}
}
Q
area
Response
Returns an Area!
Example
Query
query Area(
$branchId: String,
$id: String!
) {
area(
branchId: $branchId,
id: $id
) {
id
description
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{
"branchId": "xyz789",
"id": "xyz789"
}
Response
{
"data": {
"area": {
"id": "xyz789",
"description": "xyz789",
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": false,
"branchId": "abc123"
}
}
}
Q
areaInUse
Example
Query
query AreaInUse($id: String!) {
areaInUse(id: $id) {
id
description
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"areaInUse": {
"id": "abc123",
"description": "abc123",
"isActive": true,
"referenceId": "abc123",
"isInMaintenance": false,
"branchId": "xyz789"
}
}
}
Q
areas
Response
Returns a PaginatedAreas!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Areas(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
areas(
pagination: $pagination,
query: $query
) {
items {
id
description
isActive
referenceId
isInMaintenance
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{"data": {"areas": {"items": [Area], "hasMore": true}}}
Q
availabilityByCriticality
Response
Returns [EquipmentBIData!]!
Arguments
| Name | Description |
|---|---|
criticality - Scale!
|
Filtro de criticidade |
Example
Query
query AvailabilityByCriticality($criticality: Scale!) {
availabilityByCriticality(criticality: $criticality) {
id
equipment
costCenter
calendar
result
criticality
tag
description
branchId
updatedAt
}
}
Variables
{"criticality": "High"}
Response
{
"data": {
"availabilityByCriticality": [
{
"id": "abc123",
"equipment": "xyz789",
"costCenter": "xyz789",
"calendar": "abc123",
"result": 987.65,
"criticality": "High",
"tag": "xyz789",
"description": "abc123",
"branchId": "xyz789",
"updatedAt": "abc123"
}
]
}
}
Q
availabilityByGroup
Response
Returns [EquipmentBIData!]!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
Código identificador do grupo |
Example
Query
query AvailabilityByGroup($groupId: String!) {
availabilityByGroup(groupId: $groupId) {
id
equipment
costCenter
calendar
result
criticality
tag
description
branchId
updatedAt
}
}
Variables
{"groupId": "xyz789"}
Response
{
"data": {
"availabilityByGroup": [
{
"id": "abc123",
"equipment": "xyz789",
"costCenter": "abc123",
"calendar": "abc123",
"result": 987.65,
"criticality": "High",
"tag": "abc123",
"description": "abc123",
"branchId": "abc123",
"updatedAt": "abc123"
}
]
}
}
Q
availableUsersToMentionServiceOrder
Response
Returns a PaginatedMentionUsers!
Arguments
| Name | Description |
|---|---|
identifier - String
|
|
pagination - Pagination
|
|
serviceOrderId - String!
|
Example
Query
query AvailableUsersToMentionServiceOrder(
$identifier: String,
$pagination: Pagination,
$serviceOrderId: String!
) {
availableUsersToMentionServiceOrder(
identifier: $identifier,
pagination: $pagination,
serviceOrderId: $serviceOrderId
) {
items {
id
name
}
hasMore
}
}
Variables
{
"identifier": "xyz789",
"pagination": Pagination,
"serviceOrderId": "abc123"
}
Response
{
"data": {
"availableUsersToMentionServiceOrder": {
"items": [MentionUser],
"hasMore": true
}
}
}
Q
availableUsersToMentionServiceRequest
Response
Returns a PaginatedMentionUsers!
Arguments
| Name | Description |
|---|---|
identifier - String
|
|
pagination - Pagination
|
|
serviceRequestId - String!
|
Example
Query
query AvailableUsersToMentionServiceRequest(
$identifier: String,
$pagination: Pagination,
$serviceRequestId: String!
) {
availableUsersToMentionServiceRequest(
identifier: $identifier,
pagination: $pagination,
serviceRequestId: $serviceRequestId
) {
items {
id
name
}
hasMore
}
}
Variables
{
"identifier": "xyz789",
"pagination": Pagination,
"serviceRequestId": "abc123"
}
Response
{
"data": {
"availableUsersToMentionServiceRequest": {
"items": [MentionUser],
"hasMore": true
}
}
}
Q
back
Response
Returns [BasicIndicator!]!
Arguments
| Name | Description |
|---|---|
filter - DateFilterInput
|
Filtro de data |
Example
Query
query Back($filter: DateFilterInput) {
back(filter: $filter) {
label
result
branchId
}
}
Variables
{"filter": DateFilterInput}
Response
{
"data": {
"back": [
{
"label": "abc123",
"result": 123.45,
"branchId": "xyz789"
}
]
}
}
Q
branchIsBlockedToIntegration
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
integration - MetadataType!
|
|
branchId - String!
|
Example
Query
query BranchIsBlockedToIntegration(
$integration: MetadataType!,
$branchId: String!
) {
branchIsBlockedToIntegration(
integration: $integration,
branchId: $branchId
)
}
Variables
{
"integration": "CostCenter",
"branchId": "abc123"
}
Response
{"data": {"branchIsBlockedToIntegration": false}}
Q
calendar
Example
Query
query Calendar($id: String!) {
calendar(id: $id) {
id
name
isActive
workShifts {
id
calendarId
start {
...TimePointFragment
}
end {
...TimePointFragment
}
}
referenceId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"calendar": {
"id": "xyz789",
"name": "xyz789",
"isActive": false,
"workShifts": [WorkShift],
"referenceId": "xyz789"
}
}
}
Q
calendars
Response
Returns a PaginatedCalendars!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - CalendarQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Calendars(
$pagination: Pagination,
$query: CalendarQueryInput!
) {
calendars(
pagination: $pagination,
query: $query
) {
items {
id
name
isActive
workShifts {
...WorkShiftFragment
}
referenceId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": CalendarQueryInput
}
Response
{
"data": {
"calendars": {"items": [Calendar], "hasMore": false}
}
}
Q
confiabilityByCriticality
Response
Returns [EquipmentBIData!]!
Arguments
| Name | Description |
|---|---|
criticality - Scale!
|
Filtro de criticidade |
Example
Query
query ConfiabilityByCriticality($criticality: Scale!) {
confiabilityByCriticality(criticality: $criticality) {
id
equipment
costCenter
calendar
result
criticality
tag
description
branchId
updatedAt
}
}
Variables
{"criticality": "High"}
Response
{
"data": {
"confiabilityByCriticality": [
{
"id": "xyz789",
"equipment": "xyz789",
"costCenter": "xyz789",
"calendar": "abc123",
"result": 123.45,
"criticality": "High",
"tag": "abc123",
"description": "abc123",
"branchId": "abc123",
"updatedAt": "xyz789"
}
]
}
}
Q
confiabilityByGroup
Response
Returns [EquipmentBIData!]!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
Código identificador do grupo |
Example
Query
query ConfiabilityByGroup($groupId: String!) {
confiabilityByGroup(groupId: $groupId) {
id
equipment
costCenter
calendar
result
criticality
tag
description
branchId
updatedAt
}
}
Variables
{"groupId": "xyz789"}
Response
{
"data": {
"confiabilityByGroup": [
{
"id": "abc123",
"equipment": "xyz789",
"costCenter": "abc123",
"calendar": "abc123",
"result": 123.45,
"criticality": "High",
"tag": "xyz789",
"description": "abc123",
"branchId": "xyz789",
"updatedAt": "abc123"
}
]
}
}
Q
costCenter
Response
Returns a CostCenter!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query CostCenter($id: String!) {
costCenter(id: $id) {
id
description
isActive
referenceId
branchId
erpId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"costCenter": {
"id": "xyz789",
"description": "xyz789",
"isActive": false,
"referenceId": "xyz789",
"branchId": "abc123",
"erpId": "xyz789"
}
}
}
Q
costCenterInUse
Response
Returns a CostCenter!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query CostCenterInUse($id: String!) {
costCenterInUse(id: $id) {
id
description
isActive
referenceId
branchId
erpId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"costCenterInUse": {
"id": "abc123",
"description": "xyz789",
"isActive": false,
"referenceId": "abc123",
"branchId": "xyz789",
"erpId": "xyz789"
}
}
}
Q
costCenters
Response
Returns a PaginatedCostCenters!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - CostCenterQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query CostCenters(
$pagination: Pagination,
$query: CostCenterQueryInput!
) {
costCenters(
pagination: $pagination,
query: $query
) {
items {
id
description
isActive
referenceId
branchId
erpId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": CostCenterQueryInput
}
Response
{
"data": {
"costCenters": {
"items": [CostCenter],
"hasMore": true
}
}
}
Q
counterEntries
Response
Returns [Counter!]!
Arguments
| Name | Description |
|---|---|
equipment - String!
|
Código identificador do equipamento |
Example
Query
query CounterEntries($equipment: String!) {
counterEntries(equipment: $equipment) {
id
readAt
position
accumulatedPosition
type
serviceOrder {
id
code
equipment {
...EquipmentDefaultsFragment
}
user {
...UserBasicInfoFragment
}
service
situation
startDate
endDate
attachments {
...AttachmentFragment
}
maintenance {
...MaintenanceOnServiceOrderFragment
}
cancellationReasonRef {
...ReasonFragment
}
costCenterRef {
...CostCenterFragment
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
...AreaTreeFragment
}
resources {
...ResourcesOnServiceOrderFragment
}
followUp {
...ServiceOrderFollowUpFragment
}
stoppedAt
resumedAt
foreseenStoppedAt
foreseenResumedAt
updatedAt
operationTime
hasDoneResource
hasDoneHuman
hasUnreportedThirdParty
generatedByServiceRequest
hasMaintenceByCounter
serviceRequest {
...ServiceRequestRefFragment
}
finalizationObservation
cancellationObservation
counter {
...CounterFragment
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
dailyVariation
branchId
}
}
Variables
{"equipment": "xyz789"}
Response
{
"data": {
"counterEntries": [
{
"id": "abc123",
"readAt": "2025-05-01T17:55:38.518Z",
"position": 123.45,
"accumulatedPosition": 987.65,
"type": "Inform",
"serviceOrder": ServiceOrder,
"dailyVariation": 987.65,
"branchId": "xyz789"
}
]
}
}
Q
customer
Response
Returns a CustomerPartner!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query Customer($id: String!) {
customer(id: $id) {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
branch {
phoneNumber
activityType
zipCode
street
number
neighborhood
city
state
country
complement
timeZone
mfmUser
mfmPassword
id
organizationId
name
createdAt
updatedAt
documentNumber
deletedAt
settings {
...GlobalSettingsFragment
}
endpoints {
...EndpointFragment
}
}
users {
name
id
branches
email
accessBy
roleId
status
profilePicture
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
attachments {
...AttachmentFragment
}
}
id
type
name
isActive
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"customer": {
"documentNumber": "abc123",
"daytimePhoneNumber": "abc123",
"phoneNumber": "abc123",
"email": "xyz789",
"address": "abc123",
"number": "abc123",
"complement": "abc123",
"zipCode": "abc123",
"neighborhood": "xyz789",
"city": "abc123",
"state": "xyz789",
"country": "abc123",
"description": "xyz789",
"customerPicture": S3UrlCloudFront,
"customerPictureKey": "xyz789",
"attachments": [Attachment],
"branch": Branch,
"users": [UserOrganizationListing],
"agreements": [CustomerAgreement],
"id": "xyz789",
"type": "IndividualPerson",
"name": "abc123",
"isActive": false
}
}
}
Q
customers
Response
Returns a PaginatedCustomers!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Customers(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
customers(
pagination: $pagination,
query: $query
) {
items {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
attachments {
...AttachmentFragment
}
branch {
...BranchFragment
}
users {
...UserOrganizationListingFragment
}
agreements {
...CustomerAgreementFragment
}
id
type
name
isActive
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"customers": {
"items": [CustomerPartner],
"hasMore": false
}
}
}
Q
employee
Response
Returns a FullEmployee!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query Employee($id: String!) {
employee(id: $id) {
id
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
employees {
...EmployeeFragment
}
verifiedEmail
profilePicture
restrictedBy
preferences {
...UserPreferencesFragment
}
policiesAgreement {
...PolicyAgreementFragment
}
roles {
...RoleFragment
}
customer {
...CustomerPartnerFragment
}
}
hourlyWage
startDate
endDate
isActive
calendar {
id
name
isActive
workShifts {
...WorkShiftFragment
}
referenceId
}
specialties {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"employee": {
"id": "abc123",
"user": User,
"hourlyWage": 123.45,
"startDate": "abc123",
"endDate": "abc123",
"isActive": false,
"calendar": Calendar,
"specialties": [Specialty]
}
}
}
Q
employees
Response
Returns a PaginatedEmployees!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Employees(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
employees(
pagination: $pagination,
query: $query
) {
items {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
calendar {
...CalendarFragment
}
specialties {
...SpecialtyFragment
}
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"employees": {
"items": [FullEmployee],
"hasMore": false
}
}
}
Q
equipment
Response
Returns an EquipmentWithMaintenance!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query Equipment($id: String!) {
equipment(id: $id) {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
branch {
phoneNumber
activityType
zipCode
street
number
neighborhood
city
state
country
complement
timeZone
mfmUser
mfmPassword
id
organizationId
name
createdAt
updatedAt
documentNumber
deletedAt
settings {
...GlobalSettingsFragment
}
endpoints {
...EndpointFragment
}
}
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
properties {
equipmentId
value
measurementUnit {
...MeasurementUnitFragment
}
feature {
...FeatureFragment
}
}
counterEntries {
id
readAt
position
accumulatedPosition
type
serviceOrder {
...ServiceOrderFragment
}
dailyVariation
branchId
}
model {
id
description
isActive
referenceId
manufacturer {
...ManufacturerFragment
}
branchId
}
group {
id
name
isActive
referenceId
branchId
}
costCenter {
id
description
isActive
referenceId
branchId
erpId
}
calendar {
id
name
isActive
workShifts {
...WorkShiftFragment
}
referenceId
}
releaseReason {
id
description
type
isActive
referenceId
isUsed
branchId
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
attachments {
...AttachmentFragment
}
branch {
...BranchFragment
}
users {
...UserOrganizationListingFragment
}
agreements {
...CustomerAgreementFragment
}
id
type
name
isActive
}
criticality
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
isMainPicture
}
sensors {
id
externalId
description
mainPicture
sensorType
hasSensorData
sensorData {
...SensorDataEquipmentFragment
}
}
mainAttachmentUrl
availability
tagDescription
equipmentsStructure {
id
description
tag
treeTag
tagDescription
classification
}
maintenances {
equipmentId
maintenance
active
description
lastMaintenance
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
detail {
...DetailMaintenanceFragment
}
maintenanceCounter {
...MaintenanceCounterActiveFragment
}
maintenanceTime {
...MaintenanceTimeActiveFragment
}
lastServiceOrder {
...DetailServiceOrderFragment
}
nextMaintenance {
...DetailServiceOrderFragment
}
realNextMaintenanceDate
masterPlan {
...MasterPlanOnEquipmentFragment
}
observation {
...ObservationFragment
}
areas {
...MaintenanceTreeFragment
}
hasServiceOrder
hasActiveServiceOrder
hasOpenServiceOrder
branchId
}
isLastPositionDifferent
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"equipment": {
"isInTree": false,
"treeTag": "abc123",
"serial": "xyz789",
"purchaseDate": "abc123",
"purchaseValue": 987.65,
"warranty": 987.65,
"warrantyDate": "xyz789",
"warrantyUnit": "Day",
"counterType": "Hours",
"counterLimit": "SixDigits",
"releaseReasonId": "xyz789",
"releaseDate": "xyz789",
"dailyVariation": 987.65,
"counterAmount": 123.45,
"accumulatedPosition": 123.45,
"canUpdateLimit": true,
"branch": Branch,
"id": "xyz789",
"description": "xyz789",
"isStarter": true,
"tag": "abc123",
"previousTags": "xyz789",
"classification": "Equipment",
"isMaintenanceActive": true,
"owner": "Own",
"situation": "Active",
"properties": [EquipmentProperty],
"counterEntries": [Counter],
"model": Model,
"group": Group,
"costCenter": CostCenter,
"calendar": Calendar,
"releaseReason": Reason,
"customer": CustomerPartner,
"criticality": "High",
"attachments": [EquipmentAttachment],
"sensors": [SensorEquipment],
"mainAttachmentUrl": "abc123",
"availability": 987.65,
"tagDescription": "abc123",
"equipmentsStructure": [EquipmentStructure],
"maintenances": [MaintenanceOnEquipment],
"isLastPositionDifferent": true
}
}
}
Q
equipmentByTag
Response
Returns an EquipmentWithMaintenance!
Arguments
| Name | Description |
|---|---|
tag - String!
|
TAG do equipamento |
Example
Query
query EquipmentByTag($tag: String!) {
equipmentByTag(tag: $tag) {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
branch {
phoneNumber
activityType
zipCode
street
number
neighborhood
city
state
country
complement
timeZone
mfmUser
mfmPassword
id
organizationId
name
createdAt
updatedAt
documentNumber
deletedAt
settings {
...GlobalSettingsFragment
}
endpoints {
...EndpointFragment
}
}
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
properties {
equipmentId
value
measurementUnit {
...MeasurementUnitFragment
}
feature {
...FeatureFragment
}
}
counterEntries {
id
readAt
position
accumulatedPosition
type
serviceOrder {
...ServiceOrderFragment
}
dailyVariation
branchId
}
model {
id
description
isActive
referenceId
manufacturer {
...ManufacturerFragment
}
branchId
}
group {
id
name
isActive
referenceId
branchId
}
costCenter {
id
description
isActive
referenceId
branchId
erpId
}
calendar {
id
name
isActive
workShifts {
...WorkShiftFragment
}
referenceId
}
releaseReason {
id
description
type
isActive
referenceId
isUsed
branchId
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
attachments {
...AttachmentFragment
}
branch {
...BranchFragment
}
users {
...UserOrganizationListingFragment
}
agreements {
...CustomerAgreementFragment
}
id
type
name
isActive
}
criticality
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
isMainPicture
}
sensors {
id
externalId
description
mainPicture
sensorType
hasSensorData
sensorData {
...SensorDataEquipmentFragment
}
}
mainAttachmentUrl
availability
tagDescription
equipmentsStructure {
id
description
tag
treeTag
tagDescription
classification
}
maintenances {
equipmentId
maintenance
active
description
lastMaintenance
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
detail {
...DetailMaintenanceFragment
}
maintenanceCounter {
...MaintenanceCounterActiveFragment
}
maintenanceTime {
...MaintenanceTimeActiveFragment
}
lastServiceOrder {
...DetailServiceOrderFragment
}
nextMaintenance {
...DetailServiceOrderFragment
}
realNextMaintenanceDate
masterPlan {
...MasterPlanOnEquipmentFragment
}
observation {
...ObservationFragment
}
areas {
...MaintenanceTreeFragment
}
hasServiceOrder
hasActiveServiceOrder
hasOpenServiceOrder
branchId
}
isLastPositionDifferent
}
}
Variables
{"tag": "xyz789"}
Response
{
"data": {
"equipmentByTag": {
"isInTree": true,
"treeTag": "xyz789",
"serial": "xyz789",
"purchaseDate": "xyz789",
"purchaseValue": 123.45,
"warranty": 987.65,
"warrantyDate": "abc123",
"warrantyUnit": "Day",
"counterType": "Hours",
"counterLimit": "SixDigits",
"releaseReasonId": "xyz789",
"releaseDate": "abc123",
"dailyVariation": 123.45,
"counterAmount": 123.45,
"accumulatedPosition": 123.45,
"canUpdateLimit": true,
"branch": Branch,
"id": "abc123",
"description": "xyz789",
"isStarter": false,
"tag": "xyz789",
"previousTags": "xyz789",
"classification": "Equipment",
"isMaintenanceActive": true,
"owner": "Own",
"situation": "Active",
"properties": [EquipmentProperty],
"counterEntries": [Counter],
"model": Model,
"group": Group,
"costCenter": CostCenter,
"calendar": Calendar,
"releaseReason": Reason,
"customer": CustomerPartner,
"criticality": "High",
"attachments": [EquipmentAttachment],
"sensors": [SensorEquipment],
"mainAttachmentUrl": "xyz789",
"availability": 987.65,
"tagDescription": "xyz789",
"equipmentsStructure": [EquipmentStructure],
"maintenances": [MaintenanceOnEquipment],
"isLastPositionDifferent": true
}
}
}
Q
equipmentHasServices
Q
equipmentIndicators
Response
Returns an EquipmentIndicatorResults!
Arguments
| Name | Description |
|---|---|
filter - IndicatorFilterInput!
|
Filtro de indicadores |
Example
Query
query EquipmentIndicators($filter: IndicatorFilterInput!) {
equipmentIndicators(filter: $filter) {
summary {
label
result
branchId
}
mtbf {
label
result
branchId
}
mttr {
label
result
branchId
}
conf {
label
result
branchId
}
disp {
label
result
branchId
}
rav {
label
result
branchId
}
cbe {
label
total
accumulatedCostPercentage
purchase {
...ComparativeResultFragment
}
maintenance {
...ComparativeResultFragment
}
}
mct {
label
total
corrective
preventive
improvement
accumulatedCost
branchId
}
counter {
counterEntries {
...BasicIndicatorFragment
}
lastReal
counterType
}
branchId
}
}
Variables
{"filter": IndicatorFilterInput}
Response
{
"data": {
"equipmentIndicators": {
"summary": [BasicIndicator],
"mtbf": [BasicIndicator],
"mttr": [BasicIndicator],
"conf": [BasicIndicator],
"disp": [BasicIndicator],
"rav": [BasicIndicator],
"cbe": [CBEIndicator],
"mct": [MCTIndicator],
"counter": CounterIndicator,
"branchId": "xyz789"
}
}
}
Q
equipmentSummary
Response
Returns a Summary!
Arguments
| Name | Description |
|---|---|
isTree - Boolean
|
Default = false |
getCounter - Boolean
|
Default = false |
query - EquipmentQueryInput!
|
Example
Query
query EquipmentSummary(
$isTree: Boolean,
$getCounter: Boolean,
$query: EquipmentQueryInput!
) {
equipmentSummary(
isTree: $isTree,
getCounter: $getCounter,
query: $query
) {
totalAmount
entries {
name
title
type
options {
...SummaryOptionFragment
}
}
}
}
Variables
{
"isTree": false,
"getCounter": false,
"query": EquipmentQueryInput
}
Response
{
"data": {
"equipmentSummary": {
"totalAmount": 987,
"entries": [SummaryEntry]
}
}
}
Q
equipments
Response
Returns a PaginatedEquipments!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - EquipmentQueryInput!
|
Parâmetros da pesquisa |
orderBy - EquipmentOrderByInput
|
Ordenação de equipamentos. Default = {field: Tag, type: Ascending} |
Example
Query
query Equipments(
$pagination: Pagination,
$query: EquipmentQueryInput!,
$orderBy: EquipmentOrderByInput
) {
equipments(
pagination: $pagination,
query: $query,
orderBy: $orderBy
) {
items {
id
description
isStarter
tag
treeTag
classification
isMaintenanceActive
availability
group {
...BasicInformationNameFragment
}
model {
...BasicInformationDescriptionFragment
}
counterType
counterLimit
dailyVariation
counterAmount
accumulatedPosition
lastPosition
situation
isStopped
criticality
mainAttachmentUrl
costCenter {
...BasicInformationDescriptionFragment
}
purchaseDate
warranty
warrantyDate
warrantyUnit
owner
customer {
...CustomerPartnerFragment
}
releaseDate
tagDescription
branchId
sensorsQuantity
sensorsHealth
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": EquipmentQueryInput,
"orderBy": {"field": "Tag", "type": "Ascending"}
}
Response
{
"data": {
"equipments": {
"items": [EquipmentList],
"hasMore": false
}
}
}
Q
equipmentsTree
Response
Returns a BranchEquipmentTree
Arguments
| Name | Description |
|---|---|
filters - EquipmentFilter
|
|
identifier - String
|
Example
Query
query EquipmentsTree(
$filters: EquipmentFilter,
$identifier: String
) {
equipmentsTree(
filters: $filters,
identifier: $identifier
) {
id
branch {
id
name
}
tag
children {
id
branch {
...BranchOnTreeFragment
}
tag
sequence
parentId
type
equipment {
...EquipmentOnTreeFragment
}
component {
...EquipmentOnTreeFragment
}
location {
...LocationOnTreeFragment
}
children {
...EquipmentChildFragment
}
}
}
}
Variables
{
"filters": EquipmentFilter,
"identifier": "abc123"
}
Response
{
"data": {
"equipmentsTree": {
"id": "abc123",
"branch": BranchOnTree,
"tag": "xyz789",
"children": [EquipmentChild]
}
}
}
Q
feature
Example
Query
query Feature($id: String!) {
feature(id: $id) {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"feature": {
"id": "xyz789",
"description": "abc123",
"type": "String",
"isActive": false,
"referenceId": "xyz789",
"isInEquipment": false,
"branchId": "abc123"
}
}
}
Q
featureAccess
Response
Returns a ValidationReturn!
Arguments
| Name | Description |
|---|---|
feature - FSFeature!
|
Example
Query
query FeatureAccess($feature: FSFeature!) {
featureAccess(feature: $feature) {
available
version
}
}
Variables
{"feature": "ExternalAuthentication"}
Response
{"data": {"featureAccess": {"available": true, "version": "Stable"}}}
Q
featureInUse
Example
Query
query FeatureInUse($id: String!) {
featureInUse(id: $id) {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"featureInUse": {
"id": "xyz789",
"description": "abc123",
"type": "String",
"isActive": false,
"referenceId": "abc123",
"isInEquipment": false,
"branchId": "abc123"
}
}
}
Q
features
Response
Returns a PaginatedFeatures!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - FeatureQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Features(
$pagination: Pagination,
$query: FeatureQueryInput!
) {
features(
pagination: $pagination,
query: $query
) {
items {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": FeatureQueryInput
}
Response
{
"data": {
"features": {"items": [Feature], "hasMore": false}
}
}
Q
findAdUrl
Q
findAllIntegrationConfigurationByBranch
Response
Returns an IntegrationConfiguration!
Arguments
| Name | Description |
|---|---|
branchId - String!
|
Example
Query
query FindAllIntegrationConfigurationByBranch($branchId: String!) {
findAllIntegrationConfigurationByBranch(branchId: $branchId) {
id
branchId
options {
integration
isActive
origin
reason
deactivatedAt
}
}
}
Variables
{"branchId": "abc123"}
Response
{
"data": {
"findAllIntegrationConfigurationByBranch": {
"id": "xyz789",
"branchId": "xyz789",
"options": [IntegrationConfigurationOptionInput]
}
}
}
Q
findBlockedConfigsByIntegration
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
integration - MetadataType!
|
Example
Query
query FindBlockedConfigsByIntegration($integration: MetadataType!) {
findBlockedConfigsByIntegration(integration: $integration)
}
Variables
{"integration": "CostCenter"}
Response
{
"data": {
"findBlockedConfigsByIntegration": [
"abc123"
]
}
}
Q
findByCustomType
Response
Returns a CustomOrganization
Arguments
| Name | Description |
|---|---|
type - CustomType!
|
Example
Query
query FindByCustomType($type: CustomType!) {
findByCustomType(type: $type) {
id
type
value
}
}
Variables
{"type": "DisconnectDays"}
Response
{
"data": {
"findByCustomType": {
"id": "xyz789",
"type": "DisconnectDays",
"value": "xyz789"
}
}
}
Q
findEndpoints
Response
Returns [Endpoint!]!
Arguments
| Name | Description |
|---|---|
input - FindEndpointsInput!
|
Example
Query
query FindEndpoints($input: FindEndpointsInput!) {
findEndpoints(input: $input) {
id
branchId
erpType
erpLine
erpCompany
erpBranch
url
port
authType
user
password
apiClient
apiSecret
urlTSS
group
branch {
phoneNumber
activityType
zipCode
street
number
neighborhood
city
state
country
complement
timeZone
mfmUser
mfmPassword
id
organizationId
name
createdAt
updatedAt
documentNumber
deletedAt
settings {
...GlobalSettingsFragment
}
endpoints {
...EndpointFragment
}
}
integrationCardName
integrationContext
}
}
Variables
{"input": FindEndpointsInput}
Response
{
"data": {
"findEndpoints": [
{
"id": "abc123",
"branchId": "abc123",
"erpType": "FakeERP",
"erpLine": "Omie",
"erpCompany": "abc123",
"erpBranch": "abc123",
"url": "xyz789",
"port": 987.65,
"authType": "Basic",
"user": "xyz789",
"password": "abc123",
"apiClient": "xyz789",
"apiSecret": "xyz789",
"urlTSS": "xyz789",
"group": "abc123",
"branch": Branch,
"integrationCardName": "abc123",
"integrationContext": "Inventory"
}
]
}
}
Q
findFeaturesRelatedToFlag
Response
Returns [FeatureReturn!]!
Arguments
| Name | Description |
|---|---|
flag - Flag!
|
Example
Query
query FindFeaturesRelatedToFlag($flag: Flag!) {
findFeaturesRelatedToFlag(flag: $flag) {
feature
version
}
}
Variables
{"flag": "RELEASE"}
Response
{
"data": {
"findFeaturesRelatedToFlag": [
{"feature": "ExternalAuthentication", "version": "Stable"}
]
}
}
Q
findFlagsRelatedToFeature
Response
Returns [FlagReturn!]!
Arguments
| Name | Description |
|---|---|
feature - FSFeature!
|
Example
Query
query FindFlagsRelatedToFeature($feature: FSFeature!) {
findFlagsRelatedToFeature(feature: $feature) {
flag
version
}
}
Variables
{"feature": "ExternalAuthentication"}
Response
{
"data": {
"findFlagsRelatedToFeature": [{"flag": "RELEASE", "version": "Stable"}]
}
}
Q
findIntegrationCards
Response
Returns [Endpoint!]!
Arguments
| Name | Description |
|---|---|
integrationContext - IntegrationContext!
|
|
type - ErpType!
|
|
organizationId - String!
|
Example
Query
query FindIntegrationCards(
$integrationContext: IntegrationContext!,
$type: ErpType!,
$organizationId: String!
) {
findIntegrationCards(
integrationContext: $integrationContext,
type: $type,
organizationId: $organizationId
) {
id
branchId
erpType
erpLine
erpCompany
erpBranch
url
port
authType
user
password
apiClient
apiSecret
urlTSS
group
branch {
phoneNumber
activityType
zipCode
street
number
neighborhood
city
state
country
complement
timeZone
mfmUser
mfmPassword
id
organizationId
name
createdAt
updatedAt
documentNumber
deletedAt
settings {
...GlobalSettingsFragment
}
endpoints {
...EndpointFragment
}
}
integrationCardName
integrationContext
}
}
Variables
{
"integrationContext": "Inventory",
"type": "FakeERP",
"organizationId": "xyz789"
}
Response
{
"data": {
"findIntegrationCards": [
{
"id": "abc123",
"branchId": "abc123",
"erpType": "FakeERP",
"erpLine": "Omie",
"erpCompany": "xyz789",
"erpBranch": "abc123",
"url": "xyz789",
"port": 123.45,
"authType": "Basic",
"user": "abc123",
"password": "xyz789",
"apiClient": "abc123",
"apiSecret": "abc123",
"urlTSS": "xyz789",
"group": "xyz789",
"branch": Branch,
"integrationCardName": "abc123",
"integrationContext": "Inventory"
}
]
}
}
Q
findUserNeedAgree
Response
Returns [PolicyTerms!]!
Arguments
| Name | Description |
|---|---|
isFuture - Boolean
|
Example
Query
query FindUserNeedAgree($isFuture: Boolean) {
findUserNeedAgree(isFuture: $isFuture) {
id
content
type
version
isFuture
startedAt
createdAt
}
}
Variables
{"isFuture": false}
Response
{
"data": {
"findUserNeedAgree": [
{
"id": "abc123",
"content": "xyz789",
"type": "Use",
"version": "abc123",
"isFuture": true,
"startedAt": "2025-05-01T17:55:38.518Z",
"createdAt": "2025-10-31T17:55:38.518Z"
}
]
}
}
Q
foreseenServiceOrder
Response
Returns a ServiceOrder!
Example
Query
query ForeseenServiceOrder(
$keepMaterial: Boolean,
$id: String!
) {
foreseenServiceOrder(
keepMaterial: $keepMaterial,
id: $id
) {
id
code
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
branch {
...BranchFragment
}
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
properties {
...EquipmentPropertyFragment
}
counterEntries {
...CounterFragment
}
model {
...ModelFragment
}
group {
...GroupFragment
}
costCenter {
...CostCenterFragment
}
calendar {
...CalendarFragment
}
releaseReason {
...ReasonFragment
}
customer {
...CustomerPartnerFragment
}
criticality
attachments {
...EquipmentAttachmentFragment
}
sensors {
...SensorEquipmentFragment
}
mainAttachmentUrl
availability
tagDescription
equipmentsStructure {
...EquipmentStructureFragment
}
}
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
employees {
...EmployeeFragment
}
verifiedEmail
profilePicture
restrictedBy
preferences {
...UserPreferencesFragment
}
policiesAgreement {
...PolicyAgreementFragment
}
}
service
situation
startDate
endDate
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
maintenance {
id
description
lastMaintenance
active
increaseCounter
timeIncrease
timeUnit
equipment {
...EquipmentDefaultsFragment
}
stopEquipment
hoursBeforeStop
hoursAfterStop
}
cancellationReasonRef {
id
description
type
isActive
referenceId
isUsed
branchId
}
costCenterRef {
id
description
isActive
referenceId
branchId
erpId
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
id
area {
...AreaFragment
}
foreseen
done
resources {
...HumanResourceTreeFragment
}
}
resources {
id
branchId
serviceOrderId
type
areaId
employeeId
specialtyId
thirdPartyId
supplierId
stepId
materialId
toolId
warehouseId
sequence
areaDoneId
employeeDoneId
thirdPartyDoneId
supplierDoneId
stepDoneId
materialDoneId
toolDoneId
warehouseDoneId
sequenceDone
foreseen
done
startDate
endDate
amount
response
cost
startDateDone
endDateDone
amountDone
costDone
parentId
parentDoneId
purchaseRequestId
createdAt
updatedAt
}
followUp {
type
user {
...UserFragment
}
mentioned
mentions {
...MentionsFragment
}
lastEditedAt
historyComment {
...HistoryCommentFragment
}
createdAt
id
description
deletedAt
branchId
action
serviceRequestId
requesterId
url
}
stoppedAt
resumedAt
foreseenStoppedAt
foreseenResumedAt
updatedAt
operationTime
hasDoneResource
hasDoneHuman
hasUnreportedThirdParty
generatedByServiceRequest
hasMaintenceByCounter
serviceRequest {
id
code
situation
requesterId
}
finalizationObservation
cancellationObservation
counter {
id
readAt
position
accumulatedPosition
type
serviceOrder {
...ServiceOrderFragment
}
dailyVariation
branchId
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
}
Variables
{"keepMaterial": false, "id": "xyz789"}
Response
{
"data": {
"foreseenServiceOrder": {
"id": "xyz789",
"code": "abc123",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2025-10-31T17:55:38.518Z",
"endDate": "2025-10-31T17:55:38.518Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "abc123",
"priority": 987.65,
"realStartDate": "2025-10-31T17:55:38.518Z",
"realEndDate": "2025-10-31T17:55:38.518Z",
"conclusion": 123.45,
"doneCost": 123.45,
"foreseenCost": 987.65,
"createdAt": "2025-05-01T17:55:38.518Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2025-10-31T17:55:38.518Z",
"resumedAt": "2025-05-01T17:55:38.518Z",
"foreseenStoppedAt": "2025-10-31T17:55:38.518Z",
"foreseenResumedAt": "2025-05-01T17:55:38.518Z",
"updatedAt": "2025-05-01T17:55:38.518Z",
"operationTime": 987.65,
"hasDoneResource": true,
"hasDoneHuman": true,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": false,
"hasMaintenceByCounter": false,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "xyz789",
"cancellationObservation": "xyz789",
"counter": Counter,
"foreseenEmployeeCost": 123.45,
"doneEmployeeCost": 123.45,
"foreseenToolCost": 123.45,
"doneToolCost": 987.65,
"foreseenMaterialCost": 987.65,
"foreseenProductCost": 987.65,
"doneMaterialCost": 123.45,
"doneProductCost": 123.45,
"foreseenThirdPartyCost": 987.65,
"doneThirdPartyCost": 987.65,
"branchId": "xyz789"
}
}
}
Q
gAreas
Response
Returns a PaginatedGenericAreas!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GAreas(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
gAreas(
pagination: $pagination,
query: $query
) {
items {
id
description
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"gAreas": {"items": [GenericArea], "hasMore": true}
}
}
Q
gCalendars
Response
Returns a PaginatedGenericCalendars!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - CalendarQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GCalendars(
$pagination: Pagination,
$query: CalendarQueryInput!
) {
gCalendars(
pagination: $pagination,
query: $query
) {
items {
id
name
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": CalendarQueryInput
}
Response
{
"data": {
"gCalendars": {
"items": [GenericCalendar],
"hasMore": false
}
}
}
Q
gCostCenters
Response
Returns a PaginatedGenericCostCenters!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - CostCenterQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GCostCenters(
$pagination: Pagination,
$query: CostCenterQueryInput!
) {
gCostCenters(
pagination: $pagination,
query: $query
) {
items {
id
description
class
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": CostCenterQueryInput
}
Response
{
"data": {
"gCostCenters": {
"items": [GenericCostCenter],
"hasMore": false
}
}
}
Q
gFeatures
Response
Returns a PaginatedGenericFeatures!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - FeatureQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GFeatures(
$pagination: Pagination,
$query: FeatureQueryInput!
) {
gFeatures(
pagination: $pagination,
query: $query
) {
items {
id
description
type
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": FeatureQueryInput
}
Response
{
"data": {
"gFeatures": {
"items": [GenericFeature],
"hasMore": false
}
}
}
Q
gGroups
Response
Returns a PaginatedGenericGroups!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - GroupQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GGroups(
$pagination: Pagination,
$query: GroupQueryInput!
) {
gGroups(
pagination: $pagination,
query: $query
) {
items {
id
name
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": GroupQueryInput
}
Response
{
"data": {
"gGroups": {"items": [GenericGroup], "hasMore": true}
}
}
Q
gManufacturers
Response
Returns a PaginatedGenericManufacturers!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ManufacturerQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GManufacturers(
$pagination: Pagination,
$query: ManufacturerQueryInput!
) {
gManufacturers(
pagination: $pagination,
query: $query
) {
items {
id
description
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ManufacturerQueryInput
}
Response
{
"data": {
"gManufacturers": {
"items": [GenericManufacturer],
"hasMore": false
}
}
}
Q
gMaterials
Response
Returns a PaginatedGenericMaterials!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GMaterials(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
gMaterials(
pagination: $pagination,
query: $query
) {
items {
id
description
measurementUnit {
...MeasurementUnitFragment
}
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"gMaterials": {
"items": [GenericMaterial],
"hasMore": false
}
}
}
Q
gMeasurementUnits
Response
Returns a PaginatedMeasurementUnits!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - MeasurementQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GMeasurementUnits(
$pagination: Pagination,
$query: MeasurementQueryInput!
) {
gMeasurementUnits(
pagination: $pagination,
query: $query
) {
items {
id
description
symbol
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": MeasurementQueryInput
}
Response
{
"data": {
"gMeasurementUnits": {
"items": [MeasurementUnit],
"hasMore": true
}
}
}
Q
gModels
Response
Returns a PaginatedGenericModels!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ModelQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GModels(
$pagination: Pagination,
$query: ModelQueryInput!
) {
gModels(
pagination: $pagination,
query: $query
) {
items {
id
description
manufacturer {
...GenericManufacturerFragment
}
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ModelQueryInput
}
Response
{
"data": {
"gModels": {"items": [GenericModel], "hasMore": false}
}
}
Q
gProducts
Use
gMaterials method instead Response
Returns a PaginatedGenericMaterials!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GProducts(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
gProducts(
pagination: $pagination,
query: $query
) {
items {
id
description
measurementUnit {
...MeasurementUnitFragment
}
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"gProducts": {
"items": [GenericMaterial],
"hasMore": true
}
}
}
Q
gReasons
Response
Returns a PaginatedGenericReasons!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GReasons(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
gReasons(
pagination: $pagination,
query: $query
) {
items {
id
description
type
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"gReasons": {
"items": [GenericReason],
"hasMore": true
}
}
}
Q
gSpecialties
Response
Returns a PaginatedGenericSpecialties!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GSpecialties(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
gSpecialties(
pagination: $pagination,
query: $query
) {
items {
id
name
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"gSpecialties": {
"items": [GenericSpecialty],
"hasMore": true
}
}
}
Q
gSteps
Response
Returns a PaginatedGenericSteps!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GSteps(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
gSteps(
pagination: $pagination,
query: $query
) {
items {
id
description
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"gSteps": {"items": [GenericStep], "hasMore": true}
}
}
Q
gTools
Response
Returns a PaginatedGenericTools!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query GTools(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
gTools(
pagination: $pagination,
query: $query
) {
items {
id
description
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"gTools": {"items": [GenericTool], "hasMore": false}
}
}
Q
getSignedThumbUrl
Q
group
Example
Query
query Group($id: String!) {
group(id: $id) {
id
name
isActive
referenceId
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"group": {
"id": "abc123",
"name": "abc123",
"isActive": true,
"referenceId": "xyz789",
"branchId": "abc123"
}
}
}
Q
groups
Response
Returns a PaginatedGroups!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - GroupQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Groups(
$pagination: Pagination,
$query: GroupQueryInput!
) {
groups(
pagination: $pagination,
query: $query
) {
items {
id
name
isActive
referenceId
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": GroupQueryInput
}
Response
{"data": {"groups": {"items": [Group], "hasMore": true}}}
Q
hasInvite
Response
Returns an EmailHasInvite!
Arguments
| Name | Description |
|---|---|
email - String!
|
Example
Query
query HasInvite($email: String!) {
hasInvite(email: $email) {
hasInvite
organizationName
}
}
Variables
{"email": "xyz789"}
Response
{
"data": {
"hasInvite": {
"hasInvite": false,
"organizationName": "abc123"
}
}
}
Q
hasOpenServicesByEquipment
Example
Query
query HasOpenServicesByEquipment($equipmentId: String!) {
hasOpenServicesByEquipment(equipmentId: $equipmentId) {
serviceOrder
serviceRequest
}
}
Variables
{"equipmentId": "abc123"}
Response
{
"data": {
"hasOpenServicesByEquipment": {
"serviceOrder": false,
"serviceRequest": true
}
}
}
Q
hermesGetAllFields
Response
Returns [InternalFields!]!
Arguments
| Name | Description |
|---|---|
input - GetFields!
|
Example
Query
query HermesGetAllFields($input: GetFields!) {
hermesGetAllFields(input: $input) {
id
genericMetadataId
name
type
limit
required
externalFields {
id
name
type
internalFieldId
default
integrationType
metadataId
required
}
}
}
Variables
{"input": GetFields}
Response
{
"data": {
"hermesGetAllFields": [
{
"id": "abc123",
"genericMetadataId": "abc123",
"name": "abc123",
"type": "String",
"limit": 987.65,
"required": true,
"externalFields": ExternalFields
}
]
}
}
Q
hermesGetAllGenericMetadata
Response
Returns [GenericMetadata!]!
Arguments
| Name | Description |
|---|---|
integrationContext - IntegrationContext
|
Example
Query
query HermesGetAllGenericMetadata($integrationContext: IntegrationContext) {
hermesGetAllGenericMetadata(integrationContext: $integrationContext) {
id
name
type
}
}
Variables
{"integrationContext": "Inventory"}
Response
{
"data": {
"hermesGetAllGenericMetadata": [
{
"id": "abc123",
"name": "xyz789",
"type": "CostCenter"
}
]
}
}
Q
hermesGetAllSaasMetadata
Response
Returns [SaasFullMetadata!]!
Arguments
| Name | Description |
|---|---|
input - GetAllSaasMetadataInput!
|
Example
Query
query HermesGetAllSaasMetadata($input: GetAllSaasMetadataInput!) {
hermesGetAllSaasMetadata(input: $input) {
id
name
integrationType
genericMetadataId
isCustomizable
version
isActive
genericMetadata {
id
name
type
}
fields {
id
genericMetadataId
name
type
limit
required
externalFields {
...ExternalFieldsFragment
}
}
}
}
Variables
{"input": GetAllSaasMetadataInput}
Response
{
"data": {
"hermesGetAllSaasMetadata": [
{
"id": "abc123",
"name": "abc123",
"integrationType": "FakeERP",
"genericMetadataId": "abc123",
"isCustomizable": true,
"version": 987.65,
"isActive": true,
"genericMetadata": GenericMetadata,
"fields": [InternalFields]
}
]
}
}
Q
hermesGetErpType
Response
Returns [ErpType!]!
Arguments
| Name | Description |
|---|---|
metadata - MetadataType!
|
Example
Query
query HermesGetErpType($metadata: MetadataType!) {
hermesGetErpType(metadata: $metadata)
}
Variables
{"metadata": "CostCenter"}
Response
{"data": {"hermesGetErpType": ["FakeERP"]}}
Q
integrationTokenByGroup
Response
Returns a String!
Example
Query
query IntegrationTokenByGroup(
$group: String!,
$erpType: ErpType!,
$branchId: String!
) {
integrationTokenByGroup(
group: $group,
erpType: $erpType,
branchId: $branchId
)
}
Variables
{
"group": "xyz789",
"erpType": "FakeERP",
"branchId": "xyz789"
}
Response
{
"data": {
"integrationTokenByGroup": "xyz789"
}
}
Q
integrationsUsers
Response
Returns an IntegrationsUsers!
Arguments
| Name | Description |
|---|---|
branchId - String!
|
Example
Query
query IntegrationsUsers($branchId: String!) {
integrationsUsers(branchId: $branchId) {
integrationOmie {
appKey
appSecret
}
}
}
Variables
{"branchId": "abc123"}
Response
{
"data": {
"integrationsUsers": {"integrationOmie": UserOmie}
}
}
Q
invite
Example
Query
query Invite($token: String!) {
invite(token: $token) {
email
roleId
name
token
createdAt
branch {
phoneNumber
activityType
zipCode
street
number
neighborhood
city
state
country
complement
timeZone
mfmUser
mfmPassword
id
organizationId
name
createdAt
updatedAt
documentNumber
deletedAt
settings {
...GlobalSettingsFragment
}
endpoints {
...EndpointFragment
}
}
accessByAd
}
}
Variables
{"token": "xyz789"}
Response
{
"data": {
"invite": {
"email": "abc123",
"roleId": "xyz789",
"name": "xyz789",
"token": "abc123",
"createdAt": "2025-05-01T17:55:38.518Z",
"branch": Branch,
"accessByAd": false
}
}
}
Q
isSupplierResource
Response
Returns a UsingSupplier
Example
Query
query IsSupplierResource(
$thirdPartyId: String!,
$id: String!
) {
isSupplierResource(
thirdPartyId: $thirdPartyId,
id: $id
)
}
Variables
{
"thirdPartyId": "xyz789",
"id": "abc123"
}
Response
{"data": {"isSupplierResource": "ServiceOrder"}}
Q
maintenance
Response
Returns a Maintenance!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query Maintenance($id: String!) {
maintenance(id: $id) {
id
description
lastMaintenance
active
maintenanceCounter {
increaseCounter
active
}
maintenanceTime {
timeIncrease
timeUnit
active
}
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
branch {
...BranchFragment
}
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
properties {
...EquipmentPropertyFragment
}
counterEntries {
...CounterFragment
}
model {
...ModelFragment
}
group {
...GroupFragment
}
costCenter {
...CostCenterFragment
}
calendar {
...CalendarFragment
}
releaseReason {
...ReasonFragment
}
customer {
...CustomerPartnerFragment
}
criticality
attachments {
...EquipmentAttachmentFragment
}
sensors {
...SensorEquipmentFragment
}
mainAttachmentUrl
availability
tagDescription
equipmentsStructure {
...EquipmentStructureFragment
}
}
areas {
id
area {
...AreaFragment
}
resources {
...MaintenanceHumanResourceFragment
}
}
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"maintenance": {
"id": "abc123",
"description": "abc123",
"lastMaintenance": "2025-05-01T17:55:38.518Z",
"active": false,
"maintenanceCounter": MaintenanceCounterActive,
"maintenanceTime": MaintenanceTimeActive,
"skipWeekend": true,
"stopEquipment": true,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 987.65,
"equipment": EquipmentDefaults,
"areas": [MaintenanceTree],
"branchId": "xyz789"
}
}
}
Q
maintenanceByEquipment
Response
Returns [MaintenanceOnEquipment!]!
Arguments
| Name | Description |
|---|---|
equipment - String!
|
Código identificador do equipamento |
Example
Query
query MaintenanceByEquipment($equipment: String!) {
maintenanceByEquipment(equipment: $equipment) {
equipmentId
maintenance
active
description
lastMaintenance
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
detail {
increase
unit
}
maintenanceCounter {
increaseCounter
active
}
maintenanceTime {
timeIncrease
timeUnit
active
}
lastServiceOrder {
serviceOrderId
serviceOrder
date
situation
counter {
...CounterFragment
}
}
nextMaintenance {
serviceOrderId
serviceOrder
date
situation
counter {
...CounterFragment
}
}
realNextMaintenanceDate
masterPlan {
active
id
}
observation {
situation
suggestedDate
minimumDate
deadline
}
areas {
id
area {
...AreaFragment
}
resources {
...MaintenanceHumanResourceFragment
}
}
hasServiceOrder
hasActiveServiceOrder
hasOpenServiceOrder
branchId
}
}
Variables
{"equipment": "abc123"}
Response
{
"data": {
"maintenanceByEquipment": [
{
"equipmentId": "abc123",
"maintenance": "abc123",
"active": true,
"description": "xyz789",
"lastMaintenance": "2025-10-31T17:55:38.518Z",
"skipWeekend": true,
"stopEquipment": true,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 987.65,
"detail": [DetailMaintenance],
"maintenanceCounter": MaintenanceCounterActive,
"maintenanceTime": MaintenanceTimeActive,
"lastServiceOrder": DetailServiceOrder,
"nextMaintenance": DetailServiceOrder,
"realNextMaintenanceDate": "2025-10-31T17:55:38.518Z",
"masterPlan": MasterPlanOnEquipment,
"observation": Observation,
"areas": [MaintenanceTree],
"hasServiceOrder": false,
"hasActiveServiceOrder": true,
"hasOpenServiceOrder": false,
"branchId": "xyz789"
}
]
}
}
Q
manufacturer
Response
Returns a Manufacturer!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query Manufacturer($id: String!) {
manufacturer(id: $id) {
id
description
isActive
referenceId
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"manufacturer": {
"id": "xyz789",
"description": "abc123",
"isActive": true,
"referenceId": "xyz789",
"branchId": "abc123"
}
}
}
Q
manufacturers
Response
Returns a PaginatedManufacturer!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ManufacturerQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Manufacturers(
$pagination: Pagination,
$query: ManufacturerQueryInput!
) {
manufacturers(
pagination: $pagination,
query: $query
) {
items {
id
description
isActive
referenceId
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ManufacturerQueryInput
}
Response
{
"data": {
"manufacturers": {
"items": [Manufacturer],
"hasMore": true
}
}
}
Q
manyMaintenances
Response
Returns [MaintenanceMany!]!
Arguments
| Name | Description |
|---|---|
maintenances - [String!]!
|
Example
Query
query ManyMaintenances($maintenances: [String!]!) {
manyMaintenances(maintenances: $maintenances) {
id
tree {
id
area {
...AreaFragment
}
resources {
...MaintenanceHumanResourceFragment
}
}
resources {
type
quantity
}
employees {
id
name
}
specialties {
id
name
}
thirdParties {
id
name
}
}
}
Variables
{"maintenances": ["abc123"]}
Response
{
"data": {
"manyMaintenances": [
{
"id": "abc123",
"tree": [MaintenanceTree],
"resources": [ResourceSummary],
"employees": [FilterOnSchedule],
"specialties": [FilterOnSchedule],
"thirdParties": [FilterOnSchedule]
}
]
}
}
Q
masterPlan
Response
Returns a MasterPlan!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query MasterPlan($id: String!) {
masterPlan(id: $id) {
id
description
maintenanceTime {
timeIncrement
timeUnit
active
}
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
maintenanceCounter {
counterIncrement
counterUnit
active
}
isImported
model {
id
description
isActive
referenceId
manufacturer {
...ManufacturerFragment
}
branchId
}
group {
id
name
isActive
referenceId
branchId
}
branchId
resources {
id
area {
...AreaFragment
}
resources {
...HumanResourceFragment
}
}
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"masterPlan": {
"id": "xyz789",
"description": "xyz789",
"maintenanceTime": MasterPlanTime,
"skipWeekend": true,
"stopEquipment": true,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 987.65,
"maintenanceCounter": MasterPlanCounter,
"isImported": false,
"model": Model,
"group": Group,
"branchId": "abc123",
"resources": [MasterPlanResource]
}
}
}
Q
masterPlans
Response
Returns a PaginatedMasterPlans!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - MasterPlanQueryInput!
|
Parâmetros da pesquisa |
orderBy - MasterPlanOrderBy
|
Tipo de ordenação |
Example
Query
query MasterPlans(
$pagination: Pagination,
$query: MasterPlanQueryInput!,
$orderBy: MasterPlanOrderBy
) {
masterPlans(
pagination: $pagination,
query: $query,
orderBy: $orderBy
) {
items {
id
description
maintenanceTime {
...MasterPlanTimeFragment
}
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
maintenanceCounter {
...MasterPlanCounterFragment
}
isImported
model {
...ModelFragment
}
group {
...GroupFragment
}
branchId
resources {
...ResourceSummaryFragment
}
tree {
...MasterPlanResourceFragment
}
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": MasterPlanQueryInput,
"orderBy": "Description"
}
Response
{
"data": {
"masterPlans": {
"items": [MasterPlanSummary],
"hasMore": true
}
}
}
Q
material
Description
Retorna um material
Response
Returns a Material!
Example
Query
query Material(
$branchId: String,
$id: String!
) {
material(
branchId: $branchId,
id: $id
) {
id
description
standardCost
isActive
referenceId
measurementUnit {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
warehouse {
id
description
isActive
branchId
erpId
level
}
isInMaintenance
branchId
erpId
stockLevels {
id
physicalBalance
amountBooked
averageCost
unitCost
level
warehouse {
...WarehouseFragment
}
}
stockMovements {
id
type
amount
observation
status
amountConfirmed
origin
createdAt
movementDate
warehouse {
...WarehouseFragment
}
}
isIntegrated
}
}
Variables
{
"branchId": "xyz789",
"id": "abc123"
}
Response
{
"data": {
"material": {
"id": "abc123",
"description": "xyz789",
"standardCost": 123.45,
"isActive": false,
"referenceId": "xyz789",
"measurementUnit": NewMeasurementUnit,
"warehouse": Warehouse,
"isInMaintenance": true,
"branchId": "xyz789",
"erpId": "xyz789",
"stockLevels": [StockLevelOnMaterial],
"stockMovements": [StockMovementOnMaterial],
"isIntegrated": false
}
}
}
Q
materialClassifications
Response
Returns [TotvsModaClassification!]!
Arguments
| Name | Description |
|---|---|
material - MaterialsClassificationInput!
|
Example
Query
query MaterialClassifications($material: MaterialsClassificationInput!) {
materialClassifications(material: $material) {
code
description
}
}
Variables
{"material": MaterialsClassificationInput}
Response
{
"data": {
"materialClassifications": [
{
"code": "xyz789",
"description": "xyz789"
}
]
}
}
Q
materialInUse
Example
Query
query MaterialInUse($id: String!) {
materialInUse(id: $id) {
id
description
standardCost
isActive
referenceId
measurementUnit {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
warehouse {
id
description
isActive
branchId
erpId
level
}
isInMaintenance
branchId
erpId
stockLevels {
id
physicalBalance
amountBooked
averageCost
unitCost
level
warehouse {
...WarehouseFragment
}
}
stockMovements {
id
type
amount
observation
status
amountConfirmed
origin
createdAt
movementDate
warehouse {
...WarehouseFragment
}
}
isIntegrated
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"materialInUse": {
"id": "xyz789",
"description": "abc123",
"standardCost": 123.45,
"isActive": true,
"referenceId": "xyz789",
"measurementUnit": NewMeasurementUnit,
"warehouse": Warehouse,
"isInMaintenance": false,
"branchId": "abc123",
"erpId": "abc123",
"stockLevels": [StockLevelOnMaterial],
"stockMovements": [StockMovementOnMaterial],
"isIntegrated": true
}
}
}
Q
materialTypes
Response
Returns [TotvsModaClassification!]!
Example
Query
query MaterialTypes(
$token: String!,
$port: Float!,
$url: String!
) {
materialTypes(
token: $token,
port: $port,
url: $url
) {
code
description
}
}
Variables
{
"token": "abc123",
"port": 123.45,
"url": "xyz789"
}
Response
{
"data": {
"materialTypes": [
{
"code": "abc123",
"description": "abc123"
}
]
}
}
Q
materials
Response
Returns a PaginatedMaterials!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Materials(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
materials(
pagination: $pagination,
query: $query
) {
items {
id
description
standardCost
isActive
referenceId
measurementUnit {
...NewMeasurementUnitFragment
}
warehouse {
...WarehouseFragment
}
isInMaintenance
branchId
erpId
stockLevels {
...StockLevelOnMaterialFragment
}
stockMovements {
...StockMovementOnMaterialFragment
}
isIntegrated
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"materials": {"items": [Material], "hasMore": true}
}
}
Q
materialsFamilies
Response
Returns [MaterialFamily!]!
Example
Query
query MaterialsFamilies(
$appSecret: String!,
$appKey: String!
) {
materialsFamilies(
appSecret: $appSecret,
appKey: $appKey
) {
codigo
nomeFamilia
}
}
Variables
{
"appSecret": "xyz789",
"appKey": "abc123"
}
Response
{
"data": {
"materialsFamilies": [
{
"codigo": "xyz789",
"nomeFamilia": "xyz789"
}
]
}
}
Q
mct
Response
Returns [MCTIndicator!]!
Arguments
| Name | Description |
|---|---|
filter - DateFilterInput
|
Filtro de data |
Example
Query
query Mct($filter: DateFilterInput) {
mct(filter: $filter) {
label
total
corrective
preventive
improvement
accumulatedCost
branchId
}
}
Variables
{"filter": DateFilterInput}
Response
{
"data": {
"mct": [
{
"label": "abc123",
"total": 987.65,
"corrective": 987.65,
"preventive": 123.45,
"improvement": 123.45,
"accumulatedCost": 123.45,
"branchId": "abc123"
}
]
}
}
Q
meanTimeBetweenFailuresByCriticality
Response
Returns [EquipmentBIData!]!
Arguments
| Name | Description |
|---|---|
criticality - Scale!
|
Filtro de criticidade |
Example
Query
query MeanTimeBetweenFailuresByCriticality($criticality: Scale!) {
meanTimeBetweenFailuresByCriticality(criticality: $criticality) {
id
equipment
costCenter
calendar
result
criticality
tag
description
branchId
updatedAt
}
}
Variables
{"criticality": "High"}
Response
{
"data": {
"meanTimeBetweenFailuresByCriticality": [
{
"id": "abc123",
"equipment": "abc123",
"costCenter": "abc123",
"calendar": "xyz789",
"result": 987.65,
"criticality": "High",
"tag": "abc123",
"description": "xyz789",
"branchId": "xyz789",
"updatedAt": "abc123"
}
]
}
}
Q
meanTimeBetweenFailuresByGroup
Response
Returns [EquipmentBIData!]!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
Código identificador do grupo |
Example
Query
query MeanTimeBetweenFailuresByGroup($groupId: String!) {
meanTimeBetweenFailuresByGroup(groupId: $groupId) {
id
equipment
costCenter
calendar
result
criticality
tag
description
branchId
updatedAt
}
}
Variables
{"groupId": "xyz789"}
Response
{
"data": {
"meanTimeBetweenFailuresByGroup": [
{
"id": "abc123",
"equipment": "abc123",
"costCenter": "xyz789",
"calendar": "abc123",
"result": 123.45,
"criticality": "High",
"tag": "xyz789",
"description": "xyz789",
"branchId": "xyz789",
"updatedAt": "xyz789"
}
]
}
}
Q
meanTimeToRepairByCriticality
Response
Returns [EquipmentBIData!]!
Arguments
| Name | Description |
|---|---|
criticality - Scale!
|
Filtro de criticidade |
Example
Query
query MeanTimeToRepairByCriticality($criticality: Scale!) {
meanTimeToRepairByCriticality(criticality: $criticality) {
id
equipment
costCenter
calendar
result
criticality
tag
description
branchId
updatedAt
}
}
Variables
{"criticality": "High"}
Response
{
"data": {
"meanTimeToRepairByCriticality": [
{
"id": "abc123",
"equipment": "xyz789",
"costCenter": "xyz789",
"calendar": "abc123",
"result": 987.65,
"criticality": "High",
"tag": "xyz789",
"description": "abc123",
"branchId": "abc123",
"updatedAt": "abc123"
}
]
}
}
Q
meanTimeToRepairByGroup
Response
Returns [EquipmentBIData!]!
Arguments
| Name | Description |
|---|---|
groupId - String!
|
Código identificador do grupo |
Example
Query
query MeanTimeToRepairByGroup($groupId: String!) {
meanTimeToRepairByGroup(groupId: $groupId) {
id
equipment
costCenter
calendar
result
criticality
tag
description
branchId
updatedAt
}
}
Variables
{"groupId": "abc123"}
Response
{
"data": {
"meanTimeToRepairByGroup": [
{
"id": "abc123",
"equipment": "xyz789",
"costCenter": "xyz789",
"calendar": "xyz789",
"result": 987.65,
"criticality": "High",
"tag": "abc123",
"description": "xyz789",
"branchId": "xyz789",
"updatedAt": "abc123"
}
]
}
}
Q
measurementUnit
Response
Returns a NewMeasurementUnit!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query MeasurementUnit($id: String!) {
measurementUnit(id: $id) {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"measurementUnit": {
"id": "xyz789",
"name": "abc123",
"acronym": "xyz789",
"isActive": true,
"branchId": "abc123",
"erpId": "abc123",
"description": "xyz789",
"symbol": "xyz789"
}
}
}
Q
measurementUnits
Response
Returns a NewPaginatedMeasurementUnits!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query MeasurementUnits(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
measurementUnits(
pagination: $pagination,
query: $query
) {
items {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"measurementUnits": {
"items": [NewMeasurementUnit],
"hasMore": false
}
}
}
Q
metadata
Example
Query
query Metadata($table: String!) {
metadata(table: $table) {
title
browse
create {
name
label
description
required
default
disabled
virtual
options
autocomplete
order
picture
type
size
decimal
valid
spellcheck
thousandSeparator
decimalSeparator
}
update {
name
label
description
required
default
disabled
virtual
options
autocomplete
order
picture
type
size
decimal
valid
spellcheck
thousandSeparator
decimalSeparator
}
view {
name
label
description
required
default
disabled
virtual
options
autocomplete
order
picture
type
size
decimal
valid
spellcheck
thousandSeparator
decimalSeparator
}
fields {
name
thousandSeparator
decimalSeparator
label
description
required
default
disabled
virtual
options
autocomplete
order
picture
type
size
decimal
valid
spellcheck
}
}
}
Variables
{"table": "xyz789"}
Response
{
"data": {
"metadata": {
"title": "abc123",
"browse": ["abc123"],
"create": [FieldOptionals],
"update": [FieldOptionals],
"view": [FieldOptionals],
"fields": [FieldDTO]
}
}
}
Q
model
Example
Query
query Model($id: String!) {
model(id: $id) {
id
description
isActive
referenceId
manufacturer {
id
description
isActive
referenceId
branchId
}
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"model": {
"id": "xyz789",
"description": "abc123",
"isActive": false,
"referenceId": "xyz789",
"manufacturer": Manufacturer,
"branchId": "abc123"
}
}
}
Q
models
Response
Returns a PaginatedModels!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ModelQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Models(
$pagination: Pagination,
$query: ModelQueryInput!
) {
models(
pagination: $pagination,
query: $query
) {
items {
id
description
isActive
referenceId
manufacturer {
...ManufacturerFragment
}
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ModelQueryInput
}
Response
{"data": {"models": {"items": [Model], "hasMore": true}}}
Q
nonEmployeeUsers
Response
Returns [UserOrganizationListing!]!
Example
Query
query NonEmployeeUsers(
$branchId: String,
$name: String!
) {
nonEmployeeUsers(
branchId: $branchId,
name: $name
) {
name
id
branches
email
accessBy
roleId
status
profilePicture
}
}
Variables
{
"branchId": "xyz789",
"name": "xyz789"
}
Response
{
"data": {
"nonEmployeeUsers": [
{
"name": "xyz789",
"id": "abc123",
"branches": ["abc123"],
"email": "xyz789",
"accessBy": "Internal",
"roleId": "xyz789",
"status": "xyz789",
"profilePicture": S3UrlCloudFront
}
]
}
}
Q
organizationLevelForecast
Response
Returns a LevelsForecast!
Arguments
| Name | Description |
|---|---|
values - [LevelsForecastInput!]
|
Example
Query
query OrganizationLevelForecast($values: [LevelsForecastInput!]) {
organizationLevelForecast(values: $values) {
nextPayment
isNewPlan
total
levels {
level
quantity
value
total
}
oldTotal
oldLevels {
level
quantity
value
total
}
addLevels {
level
quantity
value
total
}
}
}
Variables
{"values": [LevelsForecastInput]}
Response
{
"data": {
"organizationLevelForecast": {
"nextPayment": "2025-05-01T17:55:38.518Z",
"isNewPlan": true,
"total": 987.65,
"levels": [Level],
"oldTotal": 987.65,
"oldLevels": [Level],
"addLevels": [Level]
}
}
}
Q
products
Use
materials method instead Response
Returns a PaginatedMaterials!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Products(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
products(
pagination: $pagination,
query: $query
) {
items {
id
description
standardCost
isActive
referenceId
measurementUnit {
...NewMeasurementUnitFragment
}
warehouse {
...WarehouseFragment
}
isInMaintenance
branchId
erpId
stockLevels {
...StockLevelOnMaterialFragment
}
stockMovements {
...StockMovementOnMaterialFragment
}
isIntegrated
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"products": {"items": [Material], "hasMore": true}
}
}
Q
purchaseCategories
Response
Returns [PurchaseCategory!]!
Example
Query
query PurchaseCategories(
$appSecret: String!,
$appKey: String!
) {
purchaseCategories(
appSecret: $appSecret,
appKey: $appKey
) {
codigo
descricao
}
}
Variables
{
"appSecret": "xyz789",
"appKey": "abc123"
}
Response
{
"data": {
"purchaseCategories": [
{
"codigo": "xyz789",
"descricao": "abc123"
}
]
}
}
Q
rav
Response
Returns [BasicIndicator!]!
Arguments
| Name | Description |
|---|---|
filter - DateFilterInput
|
Filtro de data |
Example
Query
query Rav($filter: DateFilterInput) {
rav(filter: $filter) {
label
result
branchId
}
}
Variables
{"filter": DateFilterInput}
Response
{
"data": {
"rav": [
{
"label": "xyz789",
"result": 123.45,
"branchId": "xyz789"
}
]
}
}
Q
reason
Example
Query
query Reason($id: String!) {
reason(id: $id) {
id
description
type
isActive
referenceId
isUsed
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"reason": {
"id": "xyz789",
"description": "xyz789",
"type": "Delay",
"isActive": true,
"referenceId": "xyz789",
"isUsed": true,
"branchId": "xyz789"
}
}
}
Q
reasons
Response
Returns a PaginatedReasons!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Reasons(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
reasons(
pagination: $pagination,
query: $query
) {
items {
id
description
type
isActive
referenceId
isUsed
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"reasons": {"items": [Reason], "hasMore": false}
}
}
Q
resourceSchedule
Response
Returns a ResourceItem!
Example
Query
query ResourceSchedule(
$resourceId: String!,
$serviceOrderId: String!
) {
resourceSchedule(
resourceId: $resourceId,
serviceOrderId: $serviceOrderId
) {
id
type
employee {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
specialty {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
startDate
endDate
amount
cost
startDateDone
endDateDone
amountDone
costDone
foreseen
done
parentId
purchaseRequestId
resources {
id
type
material {
...MaterialFragment
}
product {
...MaterialFragment
}
tool {
...ToolFragment
}
warehouse {
...WarehouseFragment
}
amount
cost
amountDone
costDone
foreseen
done
parentId
}
checklists {
id
step {
...StepFragment
}
type
foreseen
done
response
parentId
resources {
...PhysicalResourceTreeFragment
}
}
thirdParties {
id
thirdParty {
...ThirdPartyFragment
}
supplier {
...SupplierFragment
}
type
foreseen
done
cost
costDone
parentId
}
area {
id
description
isActive
referenceId
isInMaintenance
branchId
}
serviceOrder {
id
code
equipment {
...EquipmentDefaultsFragment
}
user {
...UserBasicInfoFragment
}
service
situation
startDate
endDate
attachments {
...AttachmentFragment
}
maintenance {
...MaintenanceOnServiceOrderFragment
}
cancellationReasonRef {
...ReasonFragment
}
costCenterRef {
...CostCenterFragment
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
...AreaTreeFragment
}
resources {
...ResourcesOnServiceOrderFragment
}
followUp {
...ServiceOrderFollowUpFragment
}
stoppedAt
resumedAt
foreseenStoppedAt
foreseenResumedAt
updatedAt
operationTime
hasDoneResource
hasDoneHuman
hasUnreportedThirdParty
generatedByServiceRequest
hasMaintenceByCounter
serviceRequest {
...ServiceRequestRefFragment
}
finalizationObservation
cancellationObservation
counter {
...CounterFragment
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
}
}
Variables
{
"resourceId": "abc123",
"serviceOrderId": "xyz789"
}
Response
{
"data": {
"resourceSchedule": {
"id": "abc123",
"type": "Area",
"employee": Employee,
"specialty": Specialty,
"startDate": "2025-05-01T17:55:38.518Z",
"endDate": "2025-05-01T17:55:38.518Z",
"amount": 123.45,
"cost": 123.45,
"startDateDone": "2025-10-31T17:55:38.518Z",
"endDateDone": "2025-10-31T17:55:38.518Z",
"amountDone": 987.65,
"costDone": 987.65,
"foreseen": true,
"done": true,
"parentId": "xyz789",
"purchaseRequestId": "xyz789",
"resources": [PhysicalResourceTree],
"checklists": [ChecklistTree],
"thirdParties": [ThirdPartyTree],
"area": Area,
"serviceOrder": ServiceOrder
}
}
}
Q
scheduleByPeriod
Response
Returns a SchedulesItems!
Arguments
| Name | Description |
|---|---|
schedule - QuerySchedule!
|
Example
Query
query ScheduleByPeriod($schedule: QuerySchedule!) {
scheduleByPeriod(schedule: $schedule) {
scheduledResources {
id
type
employee {
...EmployeeFragment
}
specialty {
...SpecialtyFragment
}
startDate
endDate
amount
cost
startDateDone
endDateDone
amountDone
costDone
foreseen
done
parentId
purchaseRequestId
serviceOrder {
...ServiceOrderFragment
}
}
resourcesToSchedule {
id
type
employee {
...EmployeeFragment
}
specialty {
...SpecialtyFragment
}
startDate
endDate
amount
cost
startDateDone
endDateDone
amountDone
costDone
foreseen
done
parentId
purchaseRequestId
serviceOrder {
...ServiceOrderFragment
}
}
scheduledMaintenances {
id
type
employee {
...WalletEmployeeFragment
}
specialty {
...WalletSpecialtyFragment
}
amount
resourceId
maintenance {
...WalletMaintenanceFragment
}
maintenanceDates {
...ScheduleDateRangeFragment
}
}
maintenancesToSchedule {
id
type
employee {
...WalletEmployeeFragment
}
specialty {
...WalletSpecialtyFragment
}
amount
resourceId
maintenance {
...WalletMaintenanceFragment
}
maintenanceDates {
...ScheduleDateRangeFragment
}
}
}
}
Variables
{"schedule": QuerySchedule}
Response
{
"data": {
"scheduleByPeriod": {
"scheduledResources": [ShallowResourceItem],
"resourcesToSchedule": [ShallowResourceItem],
"scheduledMaintenances": [
ShallowMaintenanceSchedule
],
"maintenancesToSchedule": [
ShallowMaintenanceSchedule
]
}
}
}
Q
scheduleByPeriodMobile
Response
Returns [CardMobile!]!
Arguments
| Name | Description |
|---|---|
schedule - QuerySchedule!
|
Example
Query
query ScheduleByPeriodMobile($schedule: QuerySchedule!) {
scheduleByPeriodMobile(schedule: $schedule) {
id
date
items {
... on MobileEmptyCard {
...MobileEmptyCardFragment
}
... on ResourceItemOnMobile {
...ResourceItemOnMobileFragment
}
... on MaintenanceItemOnMobile {
...MaintenanceItemOnMobileFragment
}
}
}
}
Variables
{"schedule": QuerySchedule}
Response
{
"data": {
"scheduleByPeriodMobile": [
{
"id": "abc123",
"date": "2025-10-31T17:55:38.518Z",
"items": [MobileEmptyCard]
}
]
}
}
Q
sensorData
Response
Returns a SensorDataLastWeek!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query SensorData($id: String!) {
sensorData(id: $id) {
sensorByHour {
label
surfaceTemperature
velZ
velX
velY
}
sensorByDay {
label
result
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"sensorData": {
"sensorByHour": [SensorDataHour],
"sensorByDay": [SensorDataDay]
}
}
}
Q
serviceOrder
Response
Returns a ServiceOrder!
Arguments
| Name | Description |
|---|---|
enableLink - Boolean
|
Indica se deve renderizar a tag html para links |
keepMaterial - Boolean
|
Indica se deve manter materiais na árvore de recursos em vez de produtos |
id - String!
|
Código identificador |
Example
Query
query ServiceOrder(
$enableLink: Boolean,
$keepMaterial: Boolean,
$id: String!
) {
serviceOrder(
enableLink: $enableLink,
keepMaterial: $keepMaterial,
id: $id
) {
id
code
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
branch {
...BranchFragment
}
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
properties {
...EquipmentPropertyFragment
}
counterEntries {
...CounterFragment
}
model {
...ModelFragment
}
group {
...GroupFragment
}
costCenter {
...CostCenterFragment
}
calendar {
...CalendarFragment
}
releaseReason {
...ReasonFragment
}
customer {
...CustomerPartnerFragment
}
criticality
attachments {
...EquipmentAttachmentFragment
}
sensors {
...SensorEquipmentFragment
}
mainAttachmentUrl
availability
tagDescription
equipmentsStructure {
...EquipmentStructureFragment
}
}
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
employees {
...EmployeeFragment
}
verifiedEmail
profilePicture
restrictedBy
preferences {
...UserPreferencesFragment
}
policiesAgreement {
...PolicyAgreementFragment
}
}
service
situation
startDate
endDate
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
maintenance {
id
description
lastMaintenance
active
increaseCounter
timeIncrease
timeUnit
equipment {
...EquipmentDefaultsFragment
}
stopEquipment
hoursBeforeStop
hoursAfterStop
}
cancellationReasonRef {
id
description
type
isActive
referenceId
isUsed
branchId
}
costCenterRef {
id
description
isActive
referenceId
branchId
erpId
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
id
area {
...AreaFragment
}
foreseen
done
resources {
...HumanResourceTreeFragment
}
}
resources {
id
branchId
serviceOrderId
type
areaId
employeeId
specialtyId
thirdPartyId
supplierId
stepId
materialId
toolId
warehouseId
sequence
areaDoneId
employeeDoneId
thirdPartyDoneId
supplierDoneId
stepDoneId
materialDoneId
toolDoneId
warehouseDoneId
sequenceDone
foreseen
done
startDate
endDate
amount
response
cost
startDateDone
endDateDone
amountDone
costDone
parentId
parentDoneId
purchaseRequestId
createdAt
updatedAt
}
followUp {
type
user {
...UserFragment
}
mentioned
mentions {
...MentionsFragment
}
lastEditedAt
historyComment {
...HistoryCommentFragment
}
createdAt
id
description
deletedAt
branchId
action
serviceRequestId
requesterId
url
}
stoppedAt
resumedAt
foreseenStoppedAt
foreseenResumedAt
updatedAt
operationTime
hasDoneResource
hasDoneHuman
hasUnreportedThirdParty
generatedByServiceRequest
hasMaintenceByCounter
serviceRequest {
id
code
situation
requesterId
}
finalizationObservation
cancellationObservation
counter {
id
readAt
position
accumulatedPosition
type
serviceOrder {
...ServiceOrderFragment
}
dailyVariation
branchId
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
}
Variables
{
"enableLink": false,
"keepMaterial": true,
"id": "xyz789"
}
Response
{
"data": {
"serviceOrder": {
"id": "xyz789",
"code": "xyz789",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2025-05-01T17:55:38.518Z",
"endDate": "2025-05-01T17:55:38.518Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "xyz789",
"priority": 987.65,
"realStartDate": "2025-10-31T17:55:38.518Z",
"realEndDate": "2025-05-01T17:55:38.518Z",
"conclusion": 987.65,
"doneCost": 987.65,
"foreseenCost": 987.65,
"createdAt": "2025-10-31T17:55:38.518Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2025-05-01T17:55:38.518Z",
"resumedAt": "2025-05-01T17:55:38.518Z",
"foreseenStoppedAt": "2025-05-01T17:55:38.518Z",
"foreseenResumedAt": "2025-05-01T17:55:38.518Z",
"updatedAt": "2025-05-01T17:55:38.518Z",
"operationTime": 987.65,
"hasDoneResource": false,
"hasDoneHuman": false,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": true,
"hasMaintenceByCounter": false,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "abc123",
"cancellationObservation": "xyz789",
"counter": Counter,
"foreseenEmployeeCost": 987.65,
"doneEmployeeCost": 987.65,
"foreseenToolCost": 123.45,
"doneToolCost": 123.45,
"foreseenMaterialCost": 987.65,
"foreseenProductCost": 123.45,
"doneMaterialCost": 123.45,
"doneProductCost": 987.65,
"foreseenThirdPartyCost": 987.65,
"doneThirdPartyCost": 123.45,
"branchId": "abc123"
}
}
}
Q
serviceOrderFollowUp
Response
Returns [ServiceOrderFollowUp!]!
Arguments
| Name | Description |
|---|---|
serviceOrderId - String!
|
Código identificador |
Example
Query
query ServiceOrderFollowUp($serviceOrderId: String!) {
serviceOrderFollowUp(serviceOrderId: $serviceOrderId) {
type
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
employees {
...EmployeeFragment
}
verifiedEmail
profilePicture
restrictedBy
preferences {
...UserPreferencesFragment
}
policiesAgreement {
...PolicyAgreementFragment
}
roles {
...RoleFragment
}
customer {
...CustomerPartnerFragment
}
}
mentioned
mentions {
id
user {
...MentionUserFragment
}
}
lastEditedAt
historyComment {
comment
mentions
date
}
createdAt
id
description
deletedAt
branchId
action
serviceRequestId
requesterId
url
}
}
Variables
{"serviceOrderId": "xyz789"}
Response
{
"data": {
"serviceOrderFollowUp": [
{
"type": "Event",
"user": User,
"mentioned": "xyz789",
"mentions": [Mentions],
"lastEditedAt": "abc123",
"historyComment": [HistoryComment],
"createdAt": "2025-05-01T17:55:38.518Z",
"id": "xyz789",
"description": "abc123",
"deletedAt": "2025-10-31T17:55:38.518Z",
"branchId": "xyz789",
"action": "Open",
"serviceRequestId": "abc123",
"requesterId": "abc123",
"url": "xyz789"
}
]
}
}
Q
serviceOrderIndicators
Response
Returns a ServiceOrderIndicators!
Arguments
| Name | Description |
|---|---|
args - ServiceOrdersQueryDashboardArgs!
|
Example
Query
query ServiceOrderIndicators($args: ServiceOrdersQueryDashboardArgs!) {
serviceOrderIndicators(args: $args) {
amountBySituation {
opened
canceled
closed
}
amountByPriority {
emergency
high
medium
low
planned
}
amountByServiceType {
corrective
improvement
preventive
}
}
}
Variables
{"args": ServiceOrdersQueryDashboardArgs}
Response
{
"data": {
"serviceOrderIndicators": {
"amountBySituation": ServiceOrderAmountBySituation,
"amountByPriority": ServiceOrderAmountByPriority,
"amountByServiceType": ServiceOrderAmountByServiceType
}
}
}
Q
serviceOrders
Response
Returns a PaginatedServiceOrders!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ServiceOrderQueryInput!
|
Parâmetros da pesquisa |
orderBy - ServiceOrderOrderByInput
|
Ordenação de ordens de serviço. Default = {field: Priority, type: Descending} |
omitMultimedia - Boolean
|
Omitir multimídia |
Example
Query
query ServiceOrders(
$pagination: Pagination,
$query: ServiceOrderQueryInput!,
$orderBy: ServiceOrderOrderByInput,
$omitMultimedia: Boolean
) {
serviceOrders(
pagination: $pagination,
query: $query,
orderBy: $orderBy,
omitMultimedia: $omitMultimedia
) {
items {
id
code
equipment {
...EquipmentDefaultsFragment
}
user {
...UserBasicInfoFragment
}
service
situation
startDate
endDate
attachments {
...AttachmentFragment
}
maintenance {
...MaintenanceOnServiceOrderFragment
}
cancellationReasonRef {
...ReasonFragment
}
costCenterRef {
...CostCenterFragment
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
...AreaTreeFragment
}
resources {
...ResourcesOnServiceOrderFragment
}
followUp {
...ServiceOrderFollowUpFragment
}
stoppedAt
resumedAt
foreseenStoppedAt
foreseenResumedAt
updatedAt
operationTime
hasDoneResource
hasDoneHuman
hasUnreportedThirdParty
generatedByServiceRequest
hasMaintenceByCounter
serviceRequest {
...ServiceRequestRefFragment
}
finalizationObservation
cancellationObservation
counter {
...CounterFragment
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ServiceOrderQueryInput,
"orderBy": {"field": "Priority", "type": "Descending"},
"omitMultimedia": true
}
Response
{
"data": {
"serviceOrders": {
"items": [ServiceOrder],
"hasMore": false
}
}
}
Q
serviceOrdersByServiceRequests
Response
Returns a PaginatedServiceOrders!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ServiceRequestQueryInput!
|
Parâmetros da pesquisa |
orderBy - ServiceRequestOrderByInput
|
Ordenação de solicitações de serviço. Default = {field: Priority, type: Descending} |
omitMultimedia - Boolean
|
Omitir multimídia |
Example
Query
query ServiceOrdersByServiceRequests(
$pagination: Pagination,
$query: ServiceRequestQueryInput!,
$orderBy: ServiceRequestOrderByInput,
$omitMultimedia: Boolean
) {
serviceOrdersByServiceRequests(
pagination: $pagination,
query: $query,
orderBy: $orderBy,
omitMultimedia: $omitMultimedia
) {
items {
id
code
equipment {
...EquipmentDefaultsFragment
}
user {
...UserBasicInfoFragment
}
service
situation
startDate
endDate
attachments {
...AttachmentFragment
}
maintenance {
...MaintenanceOnServiceOrderFragment
}
cancellationReasonRef {
...ReasonFragment
}
costCenterRef {
...CostCenterFragment
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
...AreaTreeFragment
}
resources {
...ResourcesOnServiceOrderFragment
}
followUp {
...ServiceOrderFollowUpFragment
}
stoppedAt
resumedAt
foreseenStoppedAt
foreseenResumedAt
updatedAt
operationTime
hasDoneResource
hasDoneHuman
hasUnreportedThirdParty
generatedByServiceRequest
hasMaintenceByCounter
serviceRequest {
...ServiceRequestRefFragment
}
finalizationObservation
cancellationObservation
counter {
...CounterFragment
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ServiceRequestQueryInput,
"orderBy": {"field": "Priority", "type": "Descending"},
"omitMultimedia": false
}
Response
{
"data": {
"serviceOrdersByServiceRequests": {
"items": [ServiceOrder],
"hasMore": false
}
}
}
Q
serviceOrdersCosts
Response
Returns a ServiceOrderCosts!
Arguments
| Name | Description |
|---|---|
input - ServiceOrderQueryInput!
|
Pesquisa de ordem de serviço |
Example
Query
query ServiceOrdersCosts($input: ServiceOrderQueryInput!) {
serviceOrdersCosts(input: $input) {
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
doneMaterialCost
foreseenThirdPartyCost
doneThirdPartyCost
}
}
Variables
{"input": ServiceOrderQueryInput}
Response
{
"data": {
"serviceOrdersCosts": {
"foreseenEmployeeCost": 123.45,
"doneEmployeeCost": 987.65,
"foreseenToolCost": 123.45,
"doneToolCost": 123.45,
"foreseenMaterialCost": 123.45,
"doneMaterialCost": 987.65,
"foreseenThirdPartyCost": 987.65,
"doneThirdPartyCost": 123.45
}
}
}
Q
serviceOrdersDashboard
Response
Returns a PaginatedServiceOrders!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ServiceOrderQueryInput!
|
Parâmetros da pesquisa |
orderBy - ServiceOrderOrderByInput
|
Default = {field: Priority, type: Descending} |
Example
Query
query ServiceOrdersDashboard(
$pagination: Pagination,
$query: ServiceOrderQueryInput!,
$orderBy: ServiceOrderOrderByInput
) {
serviceOrdersDashboard(
pagination: $pagination,
query: $query,
orderBy: $orderBy
) {
items {
id
code
equipment {
...EquipmentDefaultsFragment
}
user {
...UserBasicInfoFragment
}
service
situation
startDate
endDate
attachments {
...AttachmentFragment
}
maintenance {
...MaintenanceOnServiceOrderFragment
}
cancellationReasonRef {
...ReasonFragment
}
costCenterRef {
...CostCenterFragment
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
...AreaTreeFragment
}
resources {
...ResourcesOnServiceOrderFragment
}
followUp {
...ServiceOrderFollowUpFragment
}
stoppedAt
resumedAt
foreseenStoppedAt
foreseenResumedAt
updatedAt
operationTime
hasDoneResource
hasDoneHuman
hasUnreportedThirdParty
generatedByServiceRequest
hasMaintenceByCounter
serviceRequest {
...ServiceRequestRefFragment
}
finalizationObservation
cancellationObservation
counter {
...CounterFragment
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ServiceOrderQueryInput,
"orderBy": {"field": "Priority", "type": "Descending"}
}
Response
{
"data": {
"serviceOrdersDashboard": {
"items": [ServiceOrder],
"hasMore": true
}
}
}
Q
serviceOrdersSummary
Response
Returns a Summary!
Arguments
| Name | Description |
|---|---|
getCounter - Boolean
|
Default = true |
query - ServiceOrderQueryInput!
|
Example
Query
query ServiceOrdersSummary(
$getCounter: Boolean,
$query: ServiceOrderQueryInput!
) {
serviceOrdersSummary(
getCounter: $getCounter,
query: $query
) {
totalAmount
entries {
name
title
type
options {
...SummaryOptionFragment
}
}
}
}
Variables
{"getCounter": true, "query": ServiceOrderQueryInput}
Response
{
"data": {
"serviceOrdersSummary": {
"totalAmount": 987,
"entries": [SummaryEntry]
}
}
}
Q
serviceRequest
Response
Returns a ServiceRequest!
Arguments
| Name | Description |
|---|---|
enableLink - Boolean
|
Indica se deve renderizar a tag html para links |
id - String!
|
Código identificador |
Example
Query
query ServiceRequest(
$enableLink: Boolean,
$id: String!
) {
serviceRequest(
enableLink: $enableLink,
id: $id
) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
isUsed
branchId
}
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
branch {
...BranchFragment
}
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
properties {
...EquipmentPropertyFragment
}
counterEntries {
...CounterFragment
}
model {
...ModelFragment
}
group {
...GroupFragment
}
costCenter {
...CostCenterFragment
}
calendar {
...CalendarFragment
}
releaseReason {
...ReasonFragment
}
customer {
...CustomerPartnerFragment
}
criticality
attachments {
...EquipmentAttachmentFragment
}
sensors {
...SensorEquipmentFragment
}
mainAttachmentUrl
availability
tagDescription
equipmentsStructure {
...EquipmentStructureFragment
}
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
attachments {
...AttachmentFragment
}
branch {
...BranchFragment
}
users {
...UserOrganizationListingFragment
}
agreements {
...CustomerAgreementFragment
}
id
type
name
isActive
}
serviceOrder {
id
code
equipment {
...EquipmentDefaultsFragment
}
user {
...UserBasicInfoFragment
}
service
situation
startDate
endDate
attachments {
...AttachmentFragment
}
maintenance {
...MaintenanceOnServiceOrderFragment
}
cancellationReasonRef {
...ReasonFragment
}
costCenterRef {
...CostCenterFragment
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
}
satisfactionSurvey {
id
deadlineEvaluation
coveringEvaluation
observation
}
requester {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
employees {
...EmployeeFragment
}
verifiedEmail
profilePicture
restrictedBy
preferences {
...UserPreferencesFragment
}
policiesAgreement {
...PolicyAgreementFragment
}
roles {
...RoleFragment
}
customer {
...CustomerPartnerFragment
}
}
createdAt
stoppedAt
serviceTime
runTime
finishedAt
distributedAt
canceledAt
branchId
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
followUp {
type
user {
...UserFragment
}
mentioned
mentions {
...MentionsFragment
}
lastEditedAt
historyComment {
...HistoryCommentFragment
}
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
}
Variables
{"enableLink": true, "id": "abc123"}
Response
{
"data": {
"serviceRequest": {
"id": "abc123",
"code": "xyz789",
"description": "xyz789",
"isAuto": false,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "xyz789",
"runningTime": "xyz789",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2025-10-31T17:55:38.518Z",
"stoppedAt": "2025-10-31T17:55:38.518Z",
"serviceTime": "abc123",
"runTime": "xyz789",
"finishedAt": "2025-05-01T17:55:38.518Z",
"distributedAt": "2025-10-31T17:55:38.518Z",
"canceledAt": "2025-10-31T17:55:38.518Z",
"branchId": "abc123",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
}
}
Q
serviceRequestFollowUp
Response
Returns [ServiceRequestFollowUp!]!
Arguments
| Name | Description |
|---|---|
serviceRequestId - String!
|
Código identificador |
Example
Query
query ServiceRequestFollowUp($serviceRequestId: String!) {
serviceRequestFollowUp(serviceRequestId: $serviceRequestId) {
type
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
employees {
...EmployeeFragment
}
verifiedEmail
profilePicture
restrictedBy
preferences {
...UserPreferencesFragment
}
policiesAgreement {
...PolicyAgreementFragment
}
roles {
...RoleFragment
}
customer {
...CustomerPartnerFragment
}
}
mentioned
mentions {
id
user {
...MentionUserFragment
}
}
lastEditedAt
historyComment {
comment
mentions
date
}
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
Variables
{"serviceRequestId": "xyz789"}
Response
{
"data": {
"serviceRequestFollowUp": [
{
"type": "Event",
"user": User,
"mentioned": "xyz789",
"mentions": [Mentions],
"lastEditedAt": "xyz789",
"historyComment": [HistoryComment],
"createdAt": "2025-05-01T17:55:38.518Z",
"id": "xyz789",
"description": "abc123",
"deletedAt": "2025-10-31T17:55:38.518Z",
"branchId": "abc123",
"action": "Comment",
"serviceOrderId": "xyz789",
"url": "abc123"
}
]
}
}
Q
serviceRequestIndicators
Response
Returns a ServiceRequestIndicators!
Arguments
| Name | Description |
|---|---|
args - ServiceRequestsQueryDashboardArgs!
|
Example
Query
query ServiceRequestIndicators($args: ServiceRequestsQueryDashboardArgs!) {
serviceRequestIndicators(args: $args) {
meanTimeBySituation {
emergency {
...ServiceRequestBIFragment
}
high {
...ServiceRequestBIFragment
}
medium {
...ServiceRequestBIFragment
}
low {
...ServiceRequestBIFragment
}
}
amountByPriority {
emergency
high
medium
low
}
answeredSurveys {
answered
notAnswered
}
deadLineEvaluations {
great
good
satisfactory
bad
}
coveringEvaluations {
great
good
satisfactory
bad
}
}
}
Variables
{"args": ServiceRequestsQueryDashboardArgs}
Response
{
"data": {
"serviceRequestIndicators": {
"meanTimeBySituation": MeanTimeBySituation,
"amountByPriority": ServiceRequestAmountByPriority,
"answeredSurveys": AnsweredSurveys,
"deadLineEvaluations": AnswerAvaliation,
"coveringEvaluations": AnswerAvaliation
}
}
}
Q
serviceRequestSummary
Response
Returns a Summary!
Arguments
| Name | Description |
|---|---|
getCounter - Boolean
|
Default = true |
query - ServiceRequestQueryInput!
|
Example
Query
query ServiceRequestSummary(
$getCounter: Boolean,
$query: ServiceRequestQueryInput!
) {
serviceRequestSummary(
getCounter: $getCounter,
query: $query
) {
totalAmount
entries {
name
title
type
options {
...SummaryOptionFragment
}
}
}
}
Variables
{"getCounter": true, "query": ServiceRequestQueryInput}
Response
{
"data": {
"serviceRequestSummary": {
"totalAmount": 123,
"entries": [SummaryEntry]
}
}
}
Q
serviceRequests
Response
Returns a PaginatedServiceRequests!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ServiceRequestQueryInput!
|
Parâmetros da pesquisa |
orderBy - ServiceRequestOrderByInput
|
Ordenação de solicitações de serviço. Default = {field: Priority, type: Descending} |
omitMultimedia - Boolean
|
Omitir multimídia |
Example
Query
query ServiceRequests(
$pagination: Pagination,
$query: ServiceRequestQueryInput!,
$orderBy: ServiceRequestOrderByInput,
$omitMultimedia: Boolean
) {
serviceRequests(
pagination: $pagination,
query: $query,
orderBy: $orderBy,
omitMultimedia: $omitMultimedia
) {
items {
id
code
description
isAuto
situation
priority
observation
runningTime
stoppedAt
reason {
...ReasonFragment
}
equipment {
...EquipmentDefaultsFragment
}
serviceOrder {
...ServiceOrderDefaultsFragment
}
satisfactionSurvey {
...SatisfactionSurveyFragment
}
requester {
...UserFragment
}
createdAt
serviceTime
runTime
employee {
...EmployeeFragment
}
finishedAt
distributedAt
canceledAt
customer {
...CustomerPartnerFragment
}
branchId
attachments {
...AttachmentFragment
}
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ServiceRequestQueryInput,
"orderBy": {"field": "Priority", "type": "Descending"},
"omitMultimedia": false
}
Response
{
"data": {
"serviceRequests": {
"items": [ServiceRequestBrowse],
"hasMore": true
}
}
}
Q
serviceRequestsDashboard
Response
Returns a PaginatedServiceRequestsDashboard!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - ServiceRequestQueryInput!
|
Parâmetros da pesquisa |
orderBy - ServiceRequestOrderByInput
|
Ordenação de solicitações de serviço. Default = {field: Priority, type: Descending} |
Example
Query
query ServiceRequestsDashboard(
$pagination: Pagination,
$query: ServiceRequestQueryInput!,
$orderBy: ServiceRequestOrderByInput
) {
serviceRequestsDashboard(
pagination: $pagination,
query: $query,
orderBy: $orderBy
) {
items {
id
code
priority
equipment {
...EquipmentDefaultsFragment
}
satisfactionSurvey {
...SatisfactionSurveyFragment
}
serviceTime
runTime
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ServiceRequestQueryInput,
"orderBy": {"field": "Priority", "type": "Descending"}
}
Response
{
"data": {
"serviceRequestsDashboard": {
"items": [ServiceRequestDashboard],
"hasMore": true
}
}
}
Q
specialties
Response
Returns a PaginatedSpecialties!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Specialties(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
specialties(
pagination: $pagination,
query: $query
) {
items {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"specialties": {
"items": [Specialty],
"hasMore": false
}
}
}
Q
specialty
Response
Returns a Specialty!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query Specialty($id: String!) {
specialty(id: $id) {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"specialty": {
"id": "abc123",
"name": "xyz789",
"hourlyWage": 123.45,
"isActive": true,
"referenceId": "xyz789",
"isInMaintenance": true
}
}
}
Q
specialtyInUse
Response
Returns a Specialty!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query SpecialtyInUse($id: String!) {
specialtyInUse(id: $id) {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"specialtyInUse": {
"id": "abc123",
"name": "xyz789",
"hourlyWage": 123.45,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": false
}
}
}
Q
step
Response
Returns a Step!
Example
Query
query Step(
$branchId: String,
$id: String!
) {
step(
branchId: $branchId,
id: $id
) {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
id
description
symbol
}
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{
"branchId": "abc123",
"id": "abc123"
}
Response
{
"data": {
"step": {
"id": "abc123",
"description": "xyz789",
"isReported": false,
"averageTime": "abc123",
"requestResponse": false,
"type": "Number",
"measurementUnit": MeasurementUnit,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": false,
"branchId": "xyz789"
}
}
}
Q
stepInUse
Example
Query
query StepInUse($id: String!) {
stepInUse(id: $id) {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
id
description
symbol
}
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"stepInUse": {
"id": "abc123",
"description": "xyz789",
"isReported": false,
"averageTime": "abc123",
"requestResponse": true,
"type": "Number",
"measurementUnit": MeasurementUnit,
"isActive": false,
"referenceId": "abc123",
"isInMaintenance": true,
"branchId": "abc123"
}
}
}
Q
steps
Response
Returns a PaginatedSteps!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Steps(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
steps(
pagination: $pagination,
query: $query
) {
items {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
...MeasurementUnitFragment
}
isActive
referenceId
isInMaintenance
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{"data": {"steps": {"items": [Step], "hasMore": false}}}
Q
stockMovement
Response
Returns a StockMovement!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query StockMovement($id: String!) {
stockMovement(id: $id) {
id
materialId
warehouseId
type
amount
observation
status
amountConfirmed
erpId
isActive
ipeDeliveryId
deliverySparePartId
productDeliveryId
historicInfo
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"stockMovement": {
"id": "abc123",
"materialId": "abc123",
"warehouseId": "abc123",
"type": "in",
"amount": 987.65,
"observation": "abc123",
"status": "done",
"amountConfirmed": 123.45,
"erpId": "abc123",
"isActive": true,
"ipeDeliveryId": "abc123",
"deliverySparePartId": "xyz789",
"productDeliveryId": "abc123",
"historicInfo": false,
"branchId": "abc123"
}
}
}
Q
stockMovementsByMaterial
Response
Returns [StockMovementByMaterial!]!
Arguments
| Name | Description |
|---|---|
materialId - String!
|
Example
Query
query StockMovementsByMaterial($materialId: String!) {
stockMovementsByMaterial(materialId: $materialId) {
id
materialId
type
amount
observation
status
amountConfirmed
movementDate
createdAt
origin
warehouse {
id
description
isActive
branchId
erpId
level
}
isInitialEntry
resource {
id
serviceOrder {
...StockMovementServiceOrderFragment
}
}
}
}
Variables
{"materialId": "abc123"}
Response
{
"data": {
"stockMovementsByMaterial": [
{
"id": "xyz789",
"materialId": "abc123",
"type": "in",
"amount": 123.45,
"observation": "xyz789",
"status": "done",
"amountConfirmed": 123.45,
"movementDate": "2025-05-01T17:55:38.518Z",
"createdAt": "2025-10-31T17:55:38.518Z",
"origin": "Manual",
"warehouse": Warehouse,
"isInitialEntry": false,
"resource": StockMovementResource
}
]
}
}
Q
supplier
Response
Returns a Supplier!
Example
Query
query Supplier(
$branchId: String,
$id: String!
) {
supplier(
branchId: $branchId,
id: $id
) {
id
name
isResource
branchId
erpId
}
}
Variables
{
"branchId": "xyz789",
"id": "xyz789"
}
Response
{
"data": {
"supplier": {
"id": "xyz789",
"name": "abc123",
"isResource": "ServiceOrder",
"branchId": "xyz789",
"erpId": "abc123"
}
}
}
Q
supplierClassifications
Response
Returns [TotvsModaClassification!]!
Example
Query
query SupplierClassifications(
$type: Float!,
$token: String!,
$port: Float!,
$url: String!
) {
supplierClassifications(
type: $type,
token: $token,
port: $port,
url: $url
) {
code
description
}
}
Variables
{
"type": 987.65,
"token": "xyz789",
"port": 123.45,
"url": "xyz789"
}
Response
{
"data": {
"supplierClassifications": [
{
"code": "xyz789",
"description": "xyz789"
}
]
}
}
Q
supplierInUse
Example
Query
query SupplierInUse($id: String!) {
supplierInUse(id: $id) {
id
name
isResource
branchId
erpId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"supplierInUse": {
"id": "xyz789",
"name": "abc123",
"isResource": "ServiceOrder",
"branchId": "xyz789",
"erpId": "abc123"
}
}
}
Q
supplierTypes
Response
Returns [TotvsModaClassification!]!
Example
Query
query SupplierTypes(
$token: String!,
$port: Float!,
$url: String!
) {
supplierTypes(
token: $token,
port: $port,
url: $url
) {
code
description
}
}
Variables
{
"token": "xyz789",
"port": 123.45,
"url": "abc123"
}
Response
{
"data": {
"supplierTypes": [
{
"code": "abc123",
"description": "xyz789"
}
]
}
}
Q
suppliers
Response
Returns a PaginatedSuppliers!
Arguments
| Name | Description |
|---|---|
thirdPartyId - String
|
Código identificador do serviço de terceiro |
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Suppliers(
$thirdPartyId: String,
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
suppliers(
thirdPartyId: $thirdPartyId,
pagination: $pagination,
query: $query
) {
items {
id
name
isResource
branchId
erpId
}
hasMore
}
}
Variables
{
"thirdPartyId": "abc123",
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"suppliers": {"items": [Supplier], "hasMore": true}
}
}
Q
thirdParties
Response
Returns a PaginatedThirdParties!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query ThirdParties(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
thirdParties(
pagination: $pagination,
query: $query
) {
items {
id
description
standardCost
isActive
suppliers {
...ThirdPartySupplierCostFragment
}
isInMaintenance
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"thirdParties": {
"items": [ThirdParty],
"hasMore": true
}
}
}
Q
thirdParty
Response
Returns a ThirdParty!
Example
Query
query ThirdParty(
$branchId: String,
$id: String!
) {
thirdParty(
branchId: $branchId,
id: $id
) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
Variables
{
"branchId": "abc123",
"id": "abc123"
}
Response
{
"data": {
"thirdParty": {
"id": "abc123",
"description": "xyz789",
"standardCost": 987.65,
"isActive": true,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": true,
"branchId": "xyz789"
}
}
}
Q
thirdPartyInUse
Response
Returns a ThirdParty!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
query ThirdPartyInUse($id: String!) {
thirdPartyInUse(id: $id) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"thirdPartyInUse": {
"id": "abc123",
"description": "xyz789",
"standardCost": 987.65,
"isActive": true,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": false,
"branchId": "abc123"
}
}
}
Q
tokenByTotvsModaKey
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - InputToken!
|
Example
Query
query TokenByTotvsModaKey($input: InputToken!) {
tokenByTotvsModaKey(input: $input)
}
Variables
{"input": InputToken}
Response
{"data": {"tokenByTotvsModaKey": "abc123"}}
Q
tool
Response
Returns a Tool!
Example
Query
query Tool(
$branchId: String,
$id: String!
) {
tool(
branchId: $branchId,
id: $id
) {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{
"branchId": "abc123",
"id": "xyz789"
}
Response
{
"data": {
"tool": {
"id": "xyz789",
"description": "abc123",
"hourlyCost": 987.65,
"isActive": true,
"referenceId": "xyz789",
"isInMaintenance": false,
"branchId": "xyz789"
}
}
}
Q
toolInUse
Example
Query
query ToolInUse($id: String!) {
toolInUse(id: $id) {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"toolInUse": {
"id": "abc123",
"description": "abc123",
"hourlyCost": 123.45,
"isActive": true,
"referenceId": "xyz789",
"isInMaintenance": false,
"branchId": "abc123"
}
}
}
Q
tools
Response
Returns a PaginatedTools!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - PaginationDefaultQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Tools(
$pagination: Pagination,
$query: PaginationDefaultQueryInput!
) {
tools(
pagination: $pagination,
query: $query
) {
items {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{"data": {"tools": {"items": [Tool], "hasMore": false}}}
Q
user
Response
Returns a UserBasicInfo!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador do usuário |
Example
Query
query User($id: String!) {
user(id: $id) {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
employees {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
verifiedEmail
profilePicture
restrictedBy
preferences {
expandedSidebar
expandedWallet
showTree
printTotalCost
printImages
printFollowUp
exportTables
}
policiesAgreement {
id
termId
userId
ipAddress
createdAt
userAgent
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"user": {
"documentNumber": "xyz789",
"birthDate": "abc123",
"address": "abc123",
"educationLevel": "ElementarySchool",
"gender": "Male",
"mobileTourView": true,
"id": "4",
"name": "xyz789",
"email": "xyz789",
"accessBy": "Internal",
"employees": [Employee],
"verifiedEmail": "abc123",
"profilePicture": S3UrlCloudFront,
"restrictedBy": "xyz789",
"preferences": UserPreferences,
"policiesAgreement": [PolicyAgreement]
}
}
}
Q
users
Response
Returns [UserOrganizationListing!]!
Arguments
| Name | Description |
|---|---|
name - String
|
Conteúdo do nome dos usuários a serem pesquisados |
Example
Query
query Users($name: String) {
users(name: $name) {
name
id
branches
email
accessBy
roleId
status
profilePicture
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"users": [
{
"name": "xyz789",
"id": "xyz789",
"branches": ["xyz789"],
"email": "abc123",
"accessBy": "Internal",
"roleId": "abc123",
"status": "xyz789",
"profilePicture": S3UrlCloudFront
}
]
}
}
Q
wallet
Response
Returns a PagedWallet!
Arguments
| Name | Description |
|---|---|
endDate - DateTime!
|
|
startDate - DateTime
|
|
identifier - String
|
|
filter - ScheduleFilter
|
Example
Query
query Wallet(
$endDate: DateTime!,
$startDate: DateTime,
$identifier: String,
$filter: ScheduleFilter
) {
wallet(
endDate: $endDate,
startDate: $startDate,
identifier: $identifier,
filter: $filter
) {
resourceItems {
id
type
employee {
...EmployeeFragment
}
specialty {
...SpecialtyFragment
}
startDate
endDate
amount
cost
startDateDone
endDateDone
amountDone
costDone
foreseen
done
parentId
purchaseRequestId
serviceOrder {
...ServiceOrderFragment
}
}
maintenanceResourceItems {
id
type
employee {
...WalletEmployeeFragment
}
specialty {
...WalletSpecialtyFragment
}
amount
resourceId
maintenance {
...WalletMaintenanceFragment
}
maintenanceDates {
...MaintenanceDatesWalletFragment
}
}
hasMore
}
}
Variables
{
"endDate": "2025-10-31T17:55:38.518Z",
"startDate": "2025-10-31T17:55:38.518Z",
"identifier": "xyz789",
"filter": ScheduleFilter
}
Response
{
"data": {
"wallet": {
"resourceItems": [ShallowResourceItem],
"maintenanceResourceItems": [
ShallowMaintenanceWallet
],
"hasMore": false
}
}
}
Q
warehouse
Response
Returns a Warehouse!
Arguments
| Name | Description |
|---|---|
id - String!
|
Código identificador |
Example
Query
query Warehouse($id: String!) {
warehouse(id: $id) {
id
description
isActive
branchId
erpId
level
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"warehouse": {
"id": "xyz789",
"description": "abc123",
"isActive": true,
"branchId": "xyz789",
"erpId": "xyz789",
"level": "xyz789"
}
}
}
Q
warehouses
Response
Returns a PaginatedWarehouses!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - WarehouseQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query Warehouses(
$pagination: Pagination,
$query: WarehouseQueryInput!
) {
warehouses(
pagination: $pagination,
query: $query
) {
items {
id
description
isActive
branchId
erpId
level
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": WarehouseQueryInput
}
Response
{
"data": {
"warehouses": {"items": [Warehouse], "hasMore": true}
}
}
Q
warehousesByMaterial
Response
Returns a PaginatedWarehouses!
Arguments
| Name | Description |
|---|---|
pagination - Pagination
|
Parâmetros da paginação |
query - WarehouseQueryInput!
|
Parâmetros da pesquisa |
Example
Query
query WarehousesByMaterial(
$pagination: Pagination,
$query: WarehouseQueryInput!
) {
warehousesByMaterial(
pagination: $pagination,
query: $query
) {
items {
id
description
isActive
branchId
erpId
level
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": WarehouseQueryInput
}
Response
{
"data": {
"warehousesByMaterial": {
"items": [Warehouse],
"hasMore": false
}
}
}
Operations
Mutations
M
createAccessToken
Response
Returns an AccessToken!
Arguments
| Name | Description |
|---|---|
fields - AccessTokenInput!
|
Argumentos de criação de token de acesso externo |
Example
Query
mutation CreateAccessToken($fields: AccessTokenInput!) {
createAccessToken(fields: $fields) {
token
apiAccessId
createdAt
deletedAt
}
}
Variables
{"fields": AccessTokenInput}
Response
{
"data": {
"createAccessToken": {
"token": "xyz789",
"apiAccessId": "xyz789",
"createdAt": "2025-05-01T17:55:38.518Z",
"deletedAt": "2025-10-31T17:55:38.518Z"
}
}
}
Example
mutation createAccessTokenExample {
createAccessToken {
token
apiAccessId
createdAt
deletedAt
}
}Types
Types
T
AccessBy
Values
| Enum Value | Description |
|---|---|
|
|
Autenticação pelo Keepfy |
|
|
Autenticação pela Microsoft |
Example
"Internal"
T
AccessToken
Example
{
"token": "xyz789",
"apiAccessId": "abc123",
"createdAt": "2025-10-31T17:55:38.518Z",
"deletedAt": "2025-10-31T17:55:38.518Z"
}
T
AccessTokenInput
T
ActivityType
Values
| Enum Value | Description |
|---|---|
|
|
Agricultura, pecuária, produção florestal, pesca e aquicultura |
|
|
Indústrias extrativas |
|
|
Indústrias de transformação |
|
|
Eletricidade e gás |
|
|
Água, esgoto, atividades de gestão de resíduos e descontaminação |
|
|
Construção |
|
|
Comércio, reparação de veículos automotores e motocicletas |
|
|
Transporte, armazenagem e correio |
|
|
Alojamento e alimentação |
|
|
Informação e comunicação |
|
|
Atividades financeiras, de seguros e serviços relacionados |
|
|
Atividades imobiliárias |
|
|
Atividades profissionais, científicas e técnicas |
|
|
Atividades administrativas e serviços complementares |
|
|
Administração pública, defesa e seguridade social |
|
|
Educação |
|
|
Saúde humana e serviços sociais |
|
|
Artes, cultura, esporte e recreação |
|
|
Outras atividades de serviços |
|
|
Serviços domésticos |
|
|
Organismos internacionais e outras instituições extraterritoriais |
Example
"AgricultureLivestockForestryAndAquaculture"
T
AnswerAvaliation
T
AnsweredSurveys
T
Area
Example
{
"id": "abc123",
"description": "abc123",
"isActive": false,
"referenceId": "abc123",
"isInMaintenance": false,
"branchId": "abc123"
}
T
AreaTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
area - Area
|
Área |
foreseen - Boolean!
|
Indica se o recurso foi previsto |
done - Boolean!
|
Indica se o recurso foi realizado |
resources - [HumanResourceTree!]
|
Recursos humanos |
Example
{
"id": "abc123",
"area": Area,
"foreseen": false,
"done": true,
"resources": [HumanResourceTree]
}
T
Attachment
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
filename - String!
|
Nome do arquivo |
contentType - String!
|
Tipo de conteúdo |
contentLength - Float!
|
Tamanho do conteúdo |
url - S3UrlCloudFront!
|
URL |
uploadedBy - String!
|
Código identificador do usuário que postou o anexo |
createdAt - DateTime!
|
Data de criação |
uploadUrl - String
|
URL de upload |
Example
{
"id": "xyz789",
"filename": "xyz789",
"contentType": "abc123",
"contentLength": 123.45,
"url": S3UrlCloudFront,
"uploadedBy": "xyz789",
"createdAt": "2025-05-01T17:55:38.518Z",
"uploadUrl": "xyz789"
}
T
AuthType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Basic"
T
BasicIndicator
T
BasicInformationDescription
T
BasicInformationName
T
Boolean
Description
The Boolean scalar type represents true or false.
T
Branch
Fields
| Field Name | Description |
|---|---|
phoneNumber - String
|
Número de telefone |
activityType - ActivityType
|
Tipo de atividade econômica principal |
zipCode - String
|
Código postal (CEP) |
street - String
|
Rua |
number - String
|
Número |
neighborhood - String
|
Bairro |
city - String
|
Cidade |
state - String
|
Estado |
country - String
|
País |
complement - String
|
Complemento |
timeZone - String
|
Fuso-horário |
mfmUser - String
|
Usuário de integração ao MFM WEG |
mfmPassword - String
|
Senha de integração ao MFM WEG |
id - String!
|
Código identificador |
organizationId - String!
|
Código identificador da organização vinculada |
name - String!
|
Nome |
createdAt - DateTime!
|
Data de criação |
updatedAt - DateTime!
|
Data de atualização |
documentNumber - String
|
Número de documento fiscal |
deletedAt - DateTime
|
Data de inativação |
settings - GlobalSettings!
|
Configurações |
endpoints - [Endpoint!]!
|
Example
{
"phoneNumber": "xyz789",
"activityType": "AgricultureLivestockForestryAndAquaculture",
"zipCode": "abc123",
"street": "abc123",
"number": "xyz789",
"neighborhood": "abc123",
"city": "xyz789",
"state": "xyz789",
"country": "abc123",
"complement": "xyz789",
"timeZone": "xyz789",
"mfmUser": "abc123",
"mfmPassword": "xyz789",
"id": "abc123",
"organizationId": "abc123",
"name": "abc123",
"createdAt": "2025-10-31T17:55:38.518Z",
"updatedAt": "2025-10-31T17:55:38.518Z",
"documentNumber": "abc123",
"deletedAt": "2025-10-31T17:55:38.518Z",
"settings": GlobalSettings,
"endpoints": [Endpoint]
}
T
BranchEquipmentTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
branch - BranchOnTree!
|
|
tag - String
|
|
children - [EquipmentChild!]
|
Example
{
"id": "abc123",
"branch": BranchOnTree,
"tag": "abc123",
"children": [EquipmentChild]
}
T
BranchOnTree
T
CBEIndicator
Fields
| Field Name | Description |
|---|---|
label - String!
|
Data |
total - Float!
|
Custo total |
accumulatedCostPercentage - Float!
|
Porcentagem de custo acumulada |
purchase - ComparativeResult!
|
Comparação com valor de compra |
maintenance - ComparativeResult!
|
Comparação com valor de manutenção |
Example
{
"label": "abc123",
"total": 987.65,
"accumulatedCostPercentage": 123.45,
"purchase": ComparativeResult,
"maintenance": ComparativeResult
}
T
Calendar
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
name - String!
|
Nome |
isActive - Boolean
|
Status |
workShifts - [WorkShift!]!
|
Turnos de trabalho |
referenceId - String
|
Example
{
"id": "abc123",
"name": "xyz789",
"isActive": false,
"workShifts": [WorkShift],
"referenceId": "xyz789"
}
T
CalendarQueryInput
T
Card
Types
| Union Types |
|---|
Example
MobileEmptyCard
T
CardMobile
T
Checklist
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
step - Step!
|
Etapa |
resources - [PhysicalResource!]
|
Recursos físicos |
Example
{
"id": "xyz789",
"type": "Area",
"step": Step,
"resources": [PhysicalResource]
}
T
ChecklistTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
step - Step!
|
Etapa |
type - ResourceType!
|
Tipo do recurso |
foreseen - Boolean!
|
Indica se o recurso foi previsto |
done - Boolean!
|
Indica se o recurso foi realizado |
response - String
|
Resposta da etapa |
parentId - String
|
Código identificador do recurso pai |
resources - [PhysicalResourceTree!]
|
Recursos físicos |
Example
{
"id": "xyz789",
"step": Step,
"type": "Area",
"foreseen": false,
"done": false,
"response": "xyz789",
"parentId": "xyz789",
"resources": [PhysicalResourceTree]
}
T
ComparativeResult
T
CostCenter
Example
{
"id": "abc123",
"description": "xyz789",
"isActive": false,
"referenceId": "abc123",
"branchId": "abc123",
"erpId": "xyz789"
}
T
CostCenterQueryInput
T
Counter
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
readAt - DateTime!
|
Data de leitura |
position - Float!
|
Posição |
accumulatedPosition - Float!
|
Posição acumulada |
type - EntryType!
|
Tipo de lançamento |
serviceOrder - ServiceOrder
|
Ordem de serviço em que o contador foi reportado |
dailyVariation - Float
|
Variação dia |
branchId - String
|
Código identificador da filial |
Example
{
"id": "xyz789",
"readAt": "2025-05-01T17:55:38.518Z",
"position": 123.45,
"accumulatedPosition": 123.45,
"type": "Inform",
"serviceOrder": ServiceOrder,
"dailyVariation": 123.45,
"branchId": "abc123"
}
T
CounterIndicator
Fields
| Field Name | Description |
|---|---|
counterEntries - [BasicIndicator!]!
|
Reportes de contadores |
lastReal - Float!
|
Último valor reportado |
counterType - CounterType!
|
Tipo de controle do contador |
Example
{
"counterEntries": [BasicIndicator],
"lastReal": 987.65,
"counterType": "Hours"
}
T
CounterLimit
Values
| Enum Value | Description |
|---|---|
|
|
Máximo de seis dígitos |
|
|
Máximo de nove dígitos |
Example
"SixDigits"
T
CounterType
Values
| Enum Value | Description |
|---|---|
|
|
Controle por horas |
|
|
Controle por quilômetros |
|
|
Sem controle de contador |
Example
"Hours"
T
CounterTypeIncrement
Values
| Enum Value | Description |
|---|---|
|
|
Incremento por horas |
|
|
Incremento por quilômetros |
Example
"Hours"
T
CustomOrganization
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
type - CustomType!
|
|
value - String!
|
Example
{
"id": "xyz789",
"type": "DisconnectDays",
"value": "xyz789"
}
T
CustomType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DisconnectDays"
T
CustomerAgreement
Fields
| Field Name | Description |
|---|---|
branchId - String!
|
Código identificador da filial vinculada |
id - String!
|
Código identificador interno do contrato |
code - String!
|
Código |
effectiveStartDate - String!
|
Data de início da vigência |
effectiveEndDate - String!
|
Data de fim da vigência |
isActive - Boolean!
|
Status |
description - String
|
Descrição |
attachments - [Attachment!]!
|
Anexos |
Example
{
"branchId": "abc123",
"id": "xyz789",
"code": "xyz789",
"effectiveStartDate": "abc123",
"effectiveEndDate": "abc123",
"isActive": false,
"description": "abc123",
"attachments": [Attachment]
}
T
CustomerPartner
Fields
| Field Name | Description |
|---|---|
documentNumber - String
|
Número de documento fiscal |
daytimePhoneNumber - String
|
Número de telefone |
phoneNumber - String
|
Número de telefone |
email - String
|
|
address - String
|
Endereço |
number - String
|
Número |
complement - String
|
Complemento |
zipCode - String
|
Código postal (CEP) |
neighborhood - String
|
Bairro |
city - String
|
Cidade |
state - String
|
Estado |
country - String
|
País |
description - String
|
Descrição |
customerPicture - S3UrlCloudFront
|
URL da foto de perfil |
customerPictureKey - String
|
Chave de acesso da foto de perfil |
attachments - [Attachment!]!
|
Anexos |
branch - Branch!
|
Filial vinculada |
users - [UserOrganizationListing!]
|
Usuários vinculados |
agreements - [CustomerAgreement!]
|
Contratos |
id - String!
|
Código identificador |
type - PersonType!
|
Tipo de cadastro fiscal |
name - String!
|
Nome do cliente |
isActive - Boolean!
|
Status |
Example
{
"documentNumber": "xyz789",
"daytimePhoneNumber": "abc123",
"phoneNumber": "xyz789",
"email": "abc123",
"address": "xyz789",
"number": "abc123",
"complement": "abc123",
"zipCode": "xyz789",
"neighborhood": "abc123",
"city": "abc123",
"state": "abc123",
"country": "abc123",
"description": "xyz789",
"customerPicture": S3UrlCloudFront,
"customerPictureKey": "xyz789",
"attachments": [Attachment],
"branch": Branch,
"users": [UserOrganizationListing],
"agreements": [CustomerAgreement],
"id": "xyz789",
"type": "IndividualPerson",
"name": "abc123",
"isActive": false
}
T
DateFilterInput
T
DateRange
T
DateTime
Example
"2025-10-31T17:55:38.518Z"
T
DayOfWeek
Values
| Enum Value | Description |
|---|---|
|
|
domingo |
|
|
segunda-feira |
|
|
terça-feira |
|
|
quarta-feira |
|
|
quinta-feira |
|
|
sexta-feira |
|
|
sábado |
Example
"Sunday"
T
DetailMaintenance
Fields
| Field Name | Description |
|---|---|
increase - Float!
|
Valor do incremento |
unit - IncreaseType!
|
Tipo de incremento |
Example
{"increase": 123.45, "unit": "Day"}
T
DetailServiceOrder
Fields
| Field Name | Description |
|---|---|
serviceOrderId - String
|
Código identificador da ordem de serviço |
serviceOrder - String
|
Código da ordem de serviço |
date - DateTime
|
Data de início previsto da próxima manutenção ou data de fim realizada da última manutenção |
situation - ServiceOrderSituation
|
Tipo de situação |
counter - Counter
|
Contador |
Example
{
"serviceOrderId": "xyz789",
"serviceOrder": "abc123",
"date": "2025-10-31T17:55:38.518Z",
"situation": "Opened",
"counter": Counter
}
T
EducationLevel
Values
| Enum Value | Description |
|---|---|
|
|
Ensino Fundamental |
|
|
Ensino Médio |
|
|
Graduação |
|
|
Mestrado |
|
|
Doutorado |
Example
"ElementarySchool"
T
EmailHasInvite
T
Employee
Example
{
"id": "xyz789",
"user": User,
"hourlyWage": 987.65,
"startDate": "abc123",
"endDate": "abc123",
"isActive": true
}
T
Endpoint
Fields
| Field Name | Description |
|---|---|
id - String
|
|
branchId - String
|
|
erpType - ErpType!
|
|
erpLine - ErpLine
|
|
erpCompany - String!
|
|
erpBranch - String
|
|
url - String!
|
|
port - Float
|
|
authType - AuthType
|
|
user - String
|
|
password - String
|
|
apiClient - String
|
|
apiSecret - String
|
|
urlTSS - String
|
|
group - String
|
|
branch - Branch!
|
|
integrationCardName - String
|
|
integrationContext - IntegrationContext
|
Example
{
"id": "abc123",
"branchId": "xyz789",
"erpType": "FakeERP",
"erpLine": "Omie",
"erpCompany": "xyz789",
"erpBranch": "xyz789",
"url": "abc123",
"port": 987.65,
"authType": "Basic",
"user": "xyz789",
"password": "abc123",
"apiClient": "xyz789",
"apiSecret": "abc123",
"urlTSS": "xyz789",
"group": "xyz789",
"branch": Branch,
"integrationCardName": "abc123",
"integrationContext": "Inventory"
}
T
EntryType
Values
| Enum Value | Description |
|---|---|
|
|
Informe |
|
|
Quebra |
|
|
Virada |
Example
"Inform"
T
EquipmentAttachment
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
filename - String!
|
Nome do arquivo |
contentType - String!
|
Tipo de conteúdo |
contentLength - Float!
|
Tamanho do conteúdo |
url - S3UrlCloudFront!
|
URL |
uploadedBy - String!
|
Código identificador do usuário que postou o anexo |
createdAt - DateTime!
|
Data de criação |
uploadUrl - String
|
URL de upload |
isMainPicture - Boolean
|
Indica se é a imagem principal |
Example
{
"id": "abc123",
"filename": "xyz789",
"contentType": "abc123",
"contentLength": 987.65,
"url": S3UrlCloudFront,
"uploadedBy": "abc123",
"createdAt": "2025-10-31T17:55:38.518Z",
"uploadUrl": "xyz789",
"isMainPicture": true
}
T
EquipmentBIData
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
equipment - String!
|
Descrição completa |
costCenter - String!
|
Nome do centro de custo |
calendar - String!
|
Nome do calendário |
result - Float!
|
Resultado |
criticality - Scale!
|
Criticidade |
tag - String
|
Identificação |
description - String
|
Descrição |
branchId - String!
|
Código identificador da filial |
updatedAt - String!
|
Data do cálculo do indicador |
Example
{
"id": "abc123",
"equipment": "xyz789",
"costCenter": "xyz789",
"calendar": "xyz789",
"result": 987.65,
"criticality": "High",
"tag": "abc123",
"description": "abc123",
"branchId": "abc123",
"updatedAt": "abc123"
}
T
EquipmentChild
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
branch - BranchOnTree!
|
|
tag - String
|
|
sequence - Float!
|
|
parentId - String!
|
|
type - EquipmentTreeType!
|
|
equipment - EquipmentOnTree
|
|
component - EquipmentOnTree
|
|
location - LocationOnTree
|
|
children - [EquipmentChild!]
|
Example
{
"id": "abc123",
"branch": BranchOnTree,
"tag": "abc123",
"sequence": 987.65,
"parentId": "abc123",
"type": "Branch",
"equipment": EquipmentOnTree,
"component": EquipmentOnTree,
"location": LocationOnTree,
"children": [EquipmentChild]
}
T
EquipmentClassification
Values
| Enum Value | Description |
|---|---|
|
|
Equipamento |
|
|
Componente |
Example
"Equipment"
T
EquipmentDefaults
Fields
| Field Name | Description |
|---|---|
isInTree - Boolean
|
Indica se o equipamento está em uma árvore |
treeTag - String
|
TAG |
serial - String
|
Série |
purchaseDate - String
|
Data de compra |
purchaseValue - Float
|
Valor de compra |
warranty - Float
|
Garantia |
warrantyDate - String
|
Data de fim da garantia |
warrantyUnit - PeriodUnit
|
Tipo de unidade de período da garantia |
counterType - CounterType
|
Tipo de controle do contador |
counterLimit - CounterLimit
|
Posição limite do contador |
releaseReasonId - String
|
Código identificador do motivo de inativação |
releaseDate - String
|
Data de inativação |
dailyVariation - Float
|
Variação diária |
counterAmount - Float
|
Quantidade de registros para cálculo da variação diária |
accumulatedPosition - Float
|
Posição acumulada |
canUpdateLimit - Boolean
|
Indica se pode alterar o limite do contador |
branch - Branch!
|
Filial |
id - String!
|
Código identificador |
description - String!
|
Descrição |
isStarter - Boolean!
|
Indica se é simplificado |
tag - String!
|
Identificação |
previousTags - String
|
TAGs dos pais na árvore de equipamentos |
classification - EquipmentClassification!
|
Classificação na árvore de equipamentos |
isMaintenanceActive - Boolean!
|
Indica se possui manutenções ativas |
owner - EquipmentOwnerType!
|
Tipo de proprietário |
situation - EquipmentSituation!
|
Tipo de situação |
properties - [EquipmentProperty!]!
|
Características |
counterEntries - [Counter!]!
|
Contadores |
model - Model
|
Modelo |
group - Group
|
Grupo |
costCenter - CostCenter
|
Centro de custo |
calendar - Calendar
|
Calendário |
releaseReason - Reason
|
Motivo de inativação |
customer - CustomerPartner
|
Cliente parceiro |
criticality - Scale
|
Tipo de criticidade |
attachments - [EquipmentAttachment!]!
|
Anexos |
sensors - [SensorEquipment!]!
|
Sensores relacionados |
mainAttachmentUrl - String
|
URL da imagem principal |
availability - Float
|
Disponibilidade |
tagDescription - String!
|
Identificação e descrição |
equipmentsStructure - [EquipmentStructure!]
|
Estrutura de equipamentos |
Example
{
"isInTree": true,
"treeTag": "abc123",
"serial": "abc123",
"purchaseDate": "xyz789",
"purchaseValue": 987.65,
"warranty": 123.45,
"warrantyDate": "xyz789",
"warrantyUnit": "Day",
"counterType": "Hours",
"counterLimit": "SixDigits",
"releaseReasonId": "xyz789",
"releaseDate": "abc123",
"dailyVariation": 987.65,
"counterAmount": 987.65,
"accumulatedPosition": 987.65,
"canUpdateLimit": false,
"branch": Branch,
"id": "xyz789",
"description": "xyz789",
"isStarter": false,
"tag": "abc123",
"previousTags": "xyz789",
"classification": "Equipment",
"isMaintenanceActive": false,
"owner": "Own",
"situation": "Active",
"properties": [EquipmentProperty],
"counterEntries": [Counter],
"model": Model,
"group": Group,
"costCenter": CostCenter,
"calendar": Calendar,
"releaseReason": Reason,
"customer": CustomerPartner,
"criticality": "High",
"attachments": [EquipmentAttachment],
"sensors": [SensorEquipment],
"mainAttachmentUrl": "xyz789",
"availability": 987.65,
"tagDescription": "xyz789",
"equipmentsStructure": [EquipmentStructure]
}
T
EquipmentFilter
Fields
| Input Field | Description |
|---|---|
serials - [String!]
|
Séries de equipamento |
groups - [String!]
|
Códigos identificadores de grupos |
models - [String!]
|
Códigos identificadores de modelos |
costCenters - [String!]
|
Códigos identificadores de centros de custo |
calendars - [String!]
|
Códigos identificadores de calendários |
criticalities - [Scale!]
|
Tipos de criticidade |
customers - [String!]
|
Códigos identificadores de clientes parceiros |
maintenanceTypes - [EquipmentMaintenanceType!]
|
Tipos de vínculo do equipamento com planos de manutenção |
warrantyTypes - [EquipmentWarrantyType!]
|
Tipos de situações da garantia |
situations - [EquipmentSituationDowntime!]
|
Tipos de situações de equipamento |
owners - [EquipmentOwnerType!]
|
Tipos de proprietário |
maintenanceSituations - [MaintenanceSituation!]
|
Tipos de situações de manutenção |
types - [EquipmentType!]
|
Tipos de cadastro |
classifications - [EquipmentClassification!]
|
Tipos de classificação |
availability - FloatRange
|
Intervalo de disponibilidade |
updatedAt - DateRange
|
Intervalo de data da última atualização |
Example
{
"serials": ["abc123"],
"groups": ["xyz789"],
"models": ["abc123"],
"costCenters": ["xyz789"],
"calendars": ["xyz789"],
"criticalities": ["High"],
"customers": ["xyz789"],
"maintenanceTypes": ["WithMaintenance"],
"warrantyTypes": ["Active"],
"situations": ["Active"],
"owners": ["Own"],
"maintenanceSituations": ["Active"],
"types": ["Starter"],
"classifications": ["Equipment"],
"availability": FloatRange,
"updatedAt": DateRange
}
T
EquipmentIndicatorResults
Fields
| Field Name | Description |
|---|---|
summary - [BasicIndicator!]!
|
Resumo |
mtbf - [BasicIndicator!]!
|
Histórico de indicadores de tempo médio entre falhas |
mttr - [BasicIndicator!]!
|
Histórico de indicadores de tempo médio para reparos |
conf - [BasicIndicator!]!
|
Histórico de indicadores de confiabilidade |
disp - [BasicIndicator!]!
|
Histórico de indicadores de disponibilidade |
rav - [BasicIndicator!]!
|
Histórico de indicadores de valor de reposição do ativo |
cbe - [CBEIndicator!]!
|
Histórico de indicadores de custo de equipamento |
mct - [MCTIndicator!]!
|
Histórico de indicadores de custo total de manutenção |
counter - CounterIndicator!
|
Indicador de histórico do contador |
branchId - String!
|
Código identifiador da filial |
Example
{
"summary": [BasicIndicator],
"mtbf": [BasicIndicator],
"mttr": [BasicIndicator],
"conf": [BasicIndicator],
"disp": [BasicIndicator],
"rav": [BasicIndicator],
"cbe": [CBEIndicator],
"mct": [MCTIndicator],
"counter": CounterIndicator,
"branchId": "abc123"
}
T
EquipmentList
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
isStarter - Boolean!
|
Indica se é simplificado |
tag - String!
|
Identificação |
treeTag - String
|
TAG |
classification - EquipmentClassification!
|
Classificação na árvore de equipamentos |
isMaintenanceActive - Boolean!
|
Indica se possui manutenções ativas |
availability - Float
|
Diponibilidade |
group - BasicInformationName
|
Grupo |
model - BasicInformationDescription
|
Modelo |
counterType - CounterType
|
Tipo de controle do contador |
counterLimit - CounterLimit
|
Posição limite do contador |
dailyVariation - Float
|
Variação diária do Contador |
counterAmount - Float
|
Quantidade de registros para cálculo da variação diária |
accumulatedPosition - Float
|
Posição acumulado do contador |
lastPosition - Float
|
Posição do último lançamento de contador |
situation - EquipmentSituation
|
Tipo de situação |
isStopped - Boolean
|
Indica se o equipamento está parado em manutenção |
criticality - Scale
|
Tipo de criticidade |
mainAttachmentUrl - String
|
URL da imagem principal |
costCenter - BasicInformationDescription
|
Centro de custo |
purchaseDate - String
|
Data de compra |
warranty - Float
|
Garantia |
warrantyDate - String
|
Data de fim da garantia |
warrantyUnit - PeriodUnit
|
Tipo de unidade de período da garantia |
owner - EquipmentOwnerType!
|
Tipo de proprietário |
customer - CustomerPartner
|
Cliente parceiro |
releaseDate - String
|
Data de inativação |
tagDescription - String!
|
Identificação e descrição |
branchId - String
|
Código identificador da filial |
sensorsQuantity - Float
|
Quantidade de sensores |
sensorsHealth - Float
|
Saúde do sensor em situação mais crítica |
Example
{
"id": "abc123",
"description": "xyz789",
"isStarter": false,
"tag": "abc123",
"treeTag": "xyz789",
"classification": "Equipment",
"isMaintenanceActive": true,
"availability": 987.65,
"group": BasicInformationName,
"model": BasicInformationDescription,
"counterType": "Hours",
"counterLimit": "SixDigits",
"dailyVariation": 987.65,
"counterAmount": 987.65,
"accumulatedPosition": 987.65,
"lastPosition": 987.65,
"situation": "Active",
"isStopped": false,
"criticality": "High",
"mainAttachmentUrl": "abc123",
"costCenter": BasicInformationDescription,
"purchaseDate": "xyz789",
"warranty": 987.65,
"warrantyDate": "abc123",
"warrantyUnit": "Day",
"owner": "Own",
"customer": CustomerPartner,
"releaseDate": "xyz789",
"tagDescription": "abc123",
"branchId": "xyz789",
"sensorsQuantity": 123.45,
"sensorsHealth": 123.45
}
T
EquipmentMaintenanceType
Values
| Enum Value | Description |
|---|---|
|
|
Com manutenção |
|
|
Sem manutenção |
Example
"WithMaintenance"
T
EquipmentOnTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
description - String!
|
|
situation - EquipmentSituation!
|
|
tag - String!
|
|
treeTag - String
|
|
isStopped - Boolean
|
|
counterType - CounterType
|
Example
{
"id": "xyz789",
"description": "xyz789",
"situation": "Active",
"tag": "abc123",
"treeTag": "abc123",
"isStopped": true,
"counterType": "Hours"
}
T
EquipmentOrderByFields
Values
| Enum Value | Description |
|---|---|
|
|
Identificação |
|
|
Criticidade |
|
|
Disponibilidade |
Example
"Tag"
T
EquipmentOrderByInput
Fields
| Input Field | Description |
|---|---|
field - EquipmentOrderByFields
|
Tipo de ordenação. Default = Tag |
type - OrderBy
|
Tipo de ordem. Default = Ascending |
Example
{"field": "Tag", "type": "Ascending"}
T
EquipmentOwnerType
Values
| Enum Value | Description |
|---|---|
|
|
Próprio |
|
|
Cliente |
Example
"Own"
T
EquipmentProperty
Fields
| Field Name | Description |
|---|---|
equipmentId - String!
|
Código identificador do equipamento |
value - String
|
Valor |
measurementUnit - MeasurementUnit
|
Unidade de medida |
feature - Feature!
|
Característica |
Example
{
"equipmentId": "xyz789",
"value": "xyz789",
"measurementUnit": MeasurementUnit,
"feature": Feature
}
T
EquipmentQueryInput
Fields
| Input Field | Description |
|---|---|
identifier - String
|
Pesquisa por identificação ou descrição |
filter - EquipmentFilter
|
Filtro |
summaryOrderBy - SummaryOrderBy
|
Tipo de ordenação do filtro |
isMonitoring - Boolean
|
Indica se é a visão de monitoramento de sensores. Default = false |
isEquipmentTree - Boolean
|
Indica se é a visão de árvore de equipamento. Default = false |
ignoreIds - [String!]
|
Códigos identificadores que não devem ser buscados |
Example
{
"identifier": "abc123",
"filter": EquipmentFilter,
"summaryOrderBy": "Alphabetic",
"isMonitoring": false,
"isEquipmentTree": true,
"ignoreIds": ["xyz789"]
}
T
EquipmentSettings
T
EquipmentSituation
Values
| Enum Value | Description |
|---|---|
|
|
Ativo |
|
|
Inativo |
Example
"Active"
T
EquipmentSituationDowntime
Values
| Enum Value | Description |
|---|---|
|
|
Ativo |
|
|
Inativo |
|
|
Parado |
Example
"Active"
T
EquipmentStructure
Example
{
"id": "abc123",
"description": "xyz789",
"tag": "xyz789",
"treeTag": "abc123",
"tagDescription": "xyz789",
"classification": "Equipment"
}
T
EquipmentTreeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Branch"
T
EquipmentType
Values
| Enum Value | Description |
|---|---|
|
|
Simplificado |
|
|
Completo |
Example
"Starter"
T
EquipmentWarrantyType
Values
| Enum Value | Description |
|---|---|
|
|
Dentro da garantia |
|
|
Garantia vencida |
|
|
Sem garantia |
Example
"Active"
T
EquipmentWithMaintenance
Fields
| Field Name | Description |
|---|---|
isInTree - Boolean
|
Indica se o equipamento está em uma árvore |
treeTag - String
|
TAG |
serial - String
|
Série |
purchaseDate - String
|
Data de compra |
purchaseValue - Float
|
Valor de compra |
warranty - Float
|
Garantia |
warrantyDate - String
|
Data de fim da garantia |
warrantyUnit - PeriodUnit
|
Tipo de unidade de período da garantia |
counterType - CounterType
|
Tipo de controle do contador |
counterLimit - CounterLimit
|
Posição limite do contador |
releaseReasonId - String
|
Código identificador do motivo de inativação |
releaseDate - String
|
Data de inativação |
dailyVariation - Float
|
Variação diária |
counterAmount - Float
|
Quantidade de registros para cálculo da variação diária |
accumulatedPosition - Float
|
Posição acumulada |
canUpdateLimit - Boolean
|
Indica se pode alterar o limite do contador |
branch - Branch!
|
Filial |
id - String!
|
Código identificador |
description - String!
|
Descrição |
isStarter - Boolean!
|
Indica se é simplificado |
tag - String!
|
Identificação |
previousTags - String
|
TAGs dos pais na árvore de equipamentos |
classification - EquipmentClassification!
|
Classificação na árvore de equipamentos |
isMaintenanceActive - Boolean!
|
Indica se possui manutenções ativas |
owner - EquipmentOwnerType!
|
Tipo de proprietário |
situation - EquipmentSituation!
|
Tipo de situação |
properties - [EquipmentProperty!]!
|
Características |
counterEntries - [Counter!]!
|
Contadores |
model - Model
|
Modelo |
group - Group
|
Grupo |
costCenter - CostCenter
|
Centro de custo |
calendar - Calendar
|
Calendário |
releaseReason - Reason
|
Motivo de inativação |
customer - CustomerPartner
|
Cliente parceiro |
criticality - Scale
|
Tipo de criticidade |
attachments - [EquipmentAttachment!]!
|
Anexos |
sensors - [SensorEquipment!]!
|
Sensores relacionados |
mainAttachmentUrl - String
|
URL da imagem principal |
availability - Float
|
Disponibilidade |
tagDescription - String!
|
Identificação e descrição |
equipmentsStructure - [EquipmentStructure!]
|
Estrutura de equipamentos |
maintenances - [MaintenanceOnEquipment!]
|
Planos de manutenção |
isLastPositionDifferent - Boolean!
|
Indica se a última posição de contador é diferente da posição acumulada |
Example
{
"isInTree": false,
"treeTag": "abc123",
"serial": "abc123",
"purchaseDate": "xyz789",
"purchaseValue": 123.45,
"warranty": 123.45,
"warrantyDate": "xyz789",
"warrantyUnit": "Day",
"counterType": "Hours",
"counterLimit": "SixDigits",
"releaseReasonId": "abc123",
"releaseDate": "abc123",
"dailyVariation": 123.45,
"counterAmount": 123.45,
"accumulatedPosition": 123.45,
"canUpdateLimit": true,
"branch": Branch,
"id": "xyz789",
"description": "abc123",
"isStarter": true,
"tag": "abc123",
"previousTags": "xyz789",
"classification": "Equipment",
"isMaintenanceActive": false,
"owner": "Own",
"situation": "Active",
"properties": [EquipmentProperty],
"counterEntries": [Counter],
"model": Model,
"group": Group,
"costCenter": CostCenter,
"calendar": Calendar,
"releaseReason": Reason,
"customer": CustomerPartner,
"criticality": "High",
"attachments": [EquipmentAttachment],
"sensors": [SensorEquipment],
"mainAttachmentUrl": "xyz789",
"availability": 987.65,
"tagDescription": "xyz789",
"equipmentsStructure": [EquipmentStructure],
"maintenances": [MaintenanceOnEquipment],
"isLastPositionDifferent": true
}
T
ErpLine
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Omie"
T
ErpType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FakeERP"
T
EvaluationType
Values
| Enum Value | Description |
|---|---|
|
|
Ótimo |
|
|
Bom |
|
|
Satisfatório |
|
|
Ruim |
Example
"Great"
T
ExternalFields
Example
{
"id": "abc123",
"name": "xyz789",
"type": "String",
"internalFieldId": "abc123",
"default": "xyz789",
"integrationType": "FakeERP",
"metadataId": "xyz789",
"required": true
}
T
FSFeature
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ExternalAuthentication"
T
Feature
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
type - FeatureType!
|
Tipo de dado |
isActive - Boolean
|
Status |
referenceId - String
|
|
isInEquipment - Boolean
|
Indica se a característica é usada em algum equipamento |
branchId - String
|
Código identificador da filial |
Example
{
"id": "xyz789",
"description": "abc123",
"type": "String",
"isActive": true,
"referenceId": "xyz789",
"isInEquipment": true,
"branchId": "xyz789"
}
T
FeatureQueryInput
T
FeatureReturn
Fields
| Field Name | Description |
|---|---|
feature - FSFeature!
|
|
version - FeatureVersion!
|
Example
{"feature": "ExternalAuthentication", "version": "Stable"}
T
FeatureType
Values
| Enum Value | Description |
|---|---|
|
|
Texto |
|
|
Inteiro |
|
|
Data |
|
|
Decimal |
Example
"String"
T
FeatureVersion
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"Stable"
T
FieldDTO
Fields
| Field Name | Description |
|---|---|
name - String
|
|
thousandSeparator - String
|
|
decimalSeparator - String
|
|
label - String!
|
|
description - String!
|
|
required - Boolean!
|
|
default - String!
|
|
disabled - Boolean!
|
|
virtual - Boolean!
|
|
options - String!
|
|
autocomplete - Boolean!
|
|
order - Float!
|
|
picture - S3UrlCloudFront
|
|
type - String!
|
|
size - Float!
|
|
decimal - Float!
|
|
valid - String!
|
|
spellcheck - Boolean!
|
Example
{
"name": "xyz789",
"thousandSeparator": "xyz789",
"decimalSeparator": "xyz789",
"label": "abc123",
"description": "xyz789",
"required": true,
"default": "xyz789",
"disabled": true,
"virtual": true,
"options": "abc123",
"autocomplete": true,
"order": 123.45,
"picture": S3UrlCloudFront,
"type": "xyz789",
"size": 123.45,
"decimal": 123.45,
"valid": "abc123",
"spellcheck": true
}
T
FieldOptionals
Fields
| Field Name | Description |
|---|---|
name - String
|
|
label - String
|
|
description - String
|
|
required - Boolean
|
|
default - String
|
|
disabled - Boolean
|
|
virtual - Boolean
|
|
options - String
|
|
autocomplete - Boolean
|
|
order - Float
|
|
picture - S3UrlCloudFront
|
|
type - String
|
|
size - Float
|
|
decimal - Float
|
|
valid - String
|
|
spellcheck - Boolean
|
|
thousandSeparator - String
|
|
decimalSeparator - String
|
Example
{
"name": "abc123",
"label": "xyz789",
"description": "xyz789",
"required": false,
"default": "xyz789",
"disabled": false,
"virtual": true,
"options": "xyz789",
"autocomplete": false,
"order": 123.45,
"picture": S3UrlCloudFront,
"type": "abc123",
"size": 123.45,
"decimal": 123.45,
"valid": "xyz789",
"spellcheck": false,
"thousandSeparator": "xyz789",
"decimalSeparator": "abc123"
}
T
FieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"String"
T
FilterOnSchedule
T
FilterType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DateRange"
T
FindEndpointsInput
Example
{
"organizationId": "abc123",
"type": "FakeERP",
"line": "Omie",
"integrationContext": "Inventory",
"group": "xyz789",
"integrationCardName": "xyz789"
}
T
Flag
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"RELEASE"
T
FlagReturn
Fields
| Field Name | Description |
|---|---|
flag - Flag!
|
|
version - FeatureVersion!
|
Example
{"flag": "RELEASE", "version": "Stable"}
T
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
T
FloatRange
T
FullEmployee
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
user - User!
|
Usuário vinculado |
hourlyWage - Float
|
Salário por hora |
startDate - String
|
Data e hora de início do serviço de mão de obra |
endDate - String
|
Data e hora de fim do serviço de mão de obra |
isActive - Boolean
|
Status |
calendar - Calendar!
|
Calendário de trabalho |
specialties - [Specialty!]!
|
Especialidades do funcionário |
Example
{
"id": "xyz789",
"user": User,
"hourlyWage": 123.45,
"startDate": "xyz789",
"endDate": "xyz789",
"isActive": true,
"calendar": Calendar,
"specialties": [Specialty]
}
T
GenericArea
T
GenericCalendar
T
GenericCostCenter
T
GenericFeature
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
description - String!
|
|
type - FeatureType!
|
Example
{
"id": "abc123",
"description": "xyz789",
"type": "String"
}
T
GenericGroup
T
GenericManufacturer
T
GenericMaterial
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
description - String!
|
|
measurementUnit - MeasurementUnit!
|
Example
{
"id": "abc123",
"description": "abc123",
"measurementUnit": MeasurementUnit
}
T
GenericMetadata
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
type - MetadataType!
|
Example
{
"id": "xyz789",
"name": "xyz789",
"type": "CostCenter"
}
T
GenericModel
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
description - String!
|
|
manufacturer - GenericManufacturer
|
Example
{
"id": "xyz789",
"description": "xyz789",
"manufacturer": GenericManufacturer
}
T
GenericReason
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
description - String!
|
|
type - ReasonType!
|
Example
{
"id": "abc123",
"description": "xyz789",
"type": "Delay"
}
T
GenericSpecialty
T
GenericStep
T
GenericTool
T
GetAllSaasMetadataInput
Fields
| Input Field | Description |
|---|---|
erpType - ErpType!
|
|
group - String
|
|
integrationCardName - String
|
|
integrationContext - IntegrationContext
|
Example
{
"erpType": "FakeERP",
"group": "abc123",
"integrationCardName": "abc123",
"integrationContext": "Inventory"
}
T
GetFields
T
GlobalSettings
Fields
| Field Name | Description |
|---|---|
serviceOrder - ServiceOrderSettings!
|
Configurações de ordens de serviço |
equipment - EquipmentSettings!
|
Configurações de equipamentos |
inventory - InventorySettings!
|
Configurações de estoque |
totvsModa - TotvsModaEndpointSettings!
|
Configurações de integração com Totvs Moda |
keepfyInventory - KeepfyInventoryEndpointSettings!
|
Configurações de integração com Totvs Moda |
Example
{
"serviceOrder": ServiceOrderSettings,
"equipment": EquipmentSettings,
"inventory": InventorySettings,
"totvsModa": TotvsModaEndpointSettings,
"keepfyInventory": KeepfyInventoryEndpointSettings
}
T
Group
T
GroupQueryInput
T
HistoryComment
Fields
| Field Name | Description |
|---|---|
comment - String!
|
|
mentions - [String!]!
|
|
date - DateTime!
|
Example
{
"comment": "abc123",
"mentions": ["abc123"],
"date": "2025-10-31T17:55:38.518Z"
}
T
HumanResource
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
amount - Float!
|
Quantidade de recursos |
employee - Employee
|
Mão de obra |
specialty - Specialty
|
Especialidade |
resources - [PhysicalResource!]
|
Recursos físicos |
checklists - [Checklist!]
|
Recursos de checklists |
thirdParties - [MasterPlanThirdParty!]
|
Recursos de terceiros |
Example
{
"id": "abc123",
"type": "Area",
"amount": 987.65,
"employee": Employee,
"specialty": Specialty,
"resources": [PhysicalResource],
"checklists": [Checklist],
"thirdParties": [MasterPlanThirdParty]
}
T
HumanResourceTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
employee - Employee
|
Mão de obra |
specialty - Specialty
|
Especialidade |
startDate - DateTime
|
Data de início da mão de obra prevista |
endDate - DateTime
|
Data de fim da mão de obra prevista |
amount - Float
|
Quantidade prevista |
cost - Float
|
Custo previsto |
startDateDone - DateTime
|
Data de início da mão de obra realizada |
endDateDone - DateTime
|
Data de fim da mão de obra realizada |
amountDone - Float
|
Quantidade realizada |
costDone - Float
|
Custo realizado |
foreseen - Boolean!
|
Indica se o recurso foi previsto |
done - Boolean!
|
Indica se o recurso foi realizado |
parentId - String
|
Código identificador do recurso pai |
purchaseRequestId - String
|
Código da requisição |
resources - [PhysicalResourceTree!]
|
Recursos físicos |
checklists - [ChecklistTree!]
|
Recursos de checklists |
thirdParties - [ThirdPartyTree!]
|
Recursos de terceiros |
Example
{
"id": "xyz789",
"type": "Area",
"employee": Employee,
"specialty": Specialty,
"startDate": "2025-10-31T17:55:38.518Z",
"endDate": "2025-10-31T17:55:38.518Z",
"amount": 987.65,
"cost": 123.45,
"startDateDone": "2025-05-01T17:55:38.518Z",
"endDateDone": "2025-05-01T17:55:38.518Z",
"amountDone": 987.65,
"costDone": 987.65,
"foreseen": true,
"done": true,
"parentId": "abc123",
"purchaseRequestId": "abc123",
"resources": [PhysicalResourceTree],
"checklists": [ChecklistTree],
"thirdParties": [ThirdPartyTree]
}
T
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
T
IncreaseType
Values
| Enum Value | Description |
|---|---|
|
|
Dia |
|
|
Mês |
|
|
Ano |
|
|
Horas |
|
|
Quilômetros |
Example
"Day"
T
IndicatorFilterInput
Fields
| Input Field | Description |
|---|---|
dateFilter - DateFilterInput
|
Filtro de data |
equipmentId - String
|
Código identificador do equipamento |
Example
{
"dateFilter": DateFilterInput,
"equipmentId": "xyz789"
}
T
InputToken
T
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
T
IntegrationConfiguration
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
branchId - String!
|
|
options - [IntegrationConfigurationOptionInput!]!
|
Example
{
"id": "xyz789",
"branchId": "xyz789",
"options": [IntegrationConfigurationOptionInput]
}
T
IntegrationConfigurationOptionInput
Fields
| Field Name | Description |
|---|---|
integration - MetadataType
|
|
isActive - Boolean
|
|
origin - String
|
|
reason - String
|
|
deactivatedAt - String
|
Example
{
"integration": "CostCenter",
"isActive": true,
"origin": "abc123",
"reason": "abc123",
"deactivatedAt": "abc123"
}
T
IntegrationContext
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Inventory"
T
IntegrationsUsers
Fields
| Field Name | Description |
|---|---|
integrationOmie - UserOmie!
|
Integração com Omie |
Example
{"integrationOmie": UserOmie}
T
InternalFields
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
genericMetadataId - String!
|
|
name - String!
|
|
type - FieldType!
|
|
limit - Float
|
|
required - Boolean!
|
|
externalFields - ExternalFields!
|
Example
{
"id": "xyz789",
"genericMetadataId": "xyz789",
"name": "abc123",
"type": "String",
"limit": 123.45,
"required": true,
"externalFields": ExternalFields
}
T
InventorySettings
Fields
| Field Name | Description |
|---|---|
integrationOmie - Boolean!
|
Habilitar integração com ERP Omie |
purchaseRequest - Boolean!
|
Indica se a integração usa requisição de compra |
stockMovement - Boolean!
|
Indica se a integração faz movimentação de saída de materiais |
categoryPurchase - String!
|
Indica se a integração faz movimentação de saída de materiais |
materialsFamilies - [String!]!
|
Códigos identificadores das famílias de materiais |
Example
{
"integrationOmie": true,
"purchaseRequest": false,
"stockMovement": false,
"categoryPurchase": "abc123",
"materialsFamilies": ["xyz789"]
}
T
Invite
Example
{
"email": "abc123",
"roleId": "xyz789",
"name": "xyz789",
"token": "abc123",
"createdAt": "2025-10-31T17:55:38.518Z",
"branch": Branch,
"accessByAd": false
}
T
KeepfyInventoryEndpointSettings
Fields
| Field Name | Description |
|---|---|
integrationKeepfyInventory - Boolean!
|
Habilitar integração com Keepfy Estoque |
Example
{"integrationKeepfyInventory": false}
T
Level
Fields
| Field Name | Description |
|---|---|
level - PlanLevelType!
|
|
quantity - Float!
|
|
value - Float!
|
|
total - Float!
|
Example
{"level": "First", "quantity": 123.45, "value": 987.65, "total": 987.65}
T
LevelsForecast
Example
{
"nextPayment": "2025-10-31T17:55:38.518Z",
"isNewPlan": true,
"total": 987.65,
"levels": [Level],
"oldTotal": 987.65,
"oldLevels": [Level],
"addLevels": [Level]
}
T
LevelsForecastInput
Fields
| Input Field | Description |
|---|---|
planLevelType - PlanLevelType!
|
|
quantity - Float!
|
Example
{"planLevelType": "First", "quantity": 987.65}
T
LocationOnTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
description - String!
|
|
costCenter - CostCenter
|
Example
{
"id": "xyz789",
"description": "abc123",
"costCenter": CostCenter
}
T
MCTIndicator
Fields
| Field Name | Description |
|---|---|
label - String!
|
Data |
total - Float!
|
Custo total |
corrective - Float!
|
Custo total de serviços corretivos |
preventive - Float!
|
Custo total de serviços preventivos |
improvement - Float!
|
Custo total de serviços de melhoria |
accumulatedCost - Float!
|
Custo total acumulado |
branchId - String!
|
Código identificador da filial |
Example
{
"label": "xyz789",
"total": 123.45,
"corrective": 987.65,
"preventive": 123.45,
"improvement": 123.45,
"accumulatedCost": 123.45,
"branchId": "xyz789"
}
T
Maintenance
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
lastMaintenance - DateTime!
|
Data da última manutenção |
active - Boolean!
|
Indica se está ativa |
maintenanceCounter - MaintenanceCounterActive!
|
Incremento por contador |
maintenanceTime - MaintenanceTimeActive!
|
Incremento por tempo |
skipWeekend - Boolean!
|
Desconsidera finais de semana |
stopEquipment - Boolean!
|
Indica se há parada de equipamento para execução da manutenção |
hoursBeforeStop - Float
|
Número de horas paradas antes da manutenção |
hoursAfterStop - Float
|
Número de horas paradas depois da manutenção |
equipment - EquipmentDefaults!
|
Equipamento |
areas - [MaintenanceTree!]!
|
Árvore de recursos |
branchId - String
|
Código identificador da filial |
Example
{
"id": "abc123",
"description": "abc123",
"lastMaintenance": "2025-10-31T17:55:38.518Z",
"active": false,
"maintenanceCounter": MaintenanceCounterActive,
"maintenanceTime": MaintenanceTimeActive,
"skipWeekend": false,
"stopEquipment": false,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"equipment": EquipmentDefaults,
"areas": [MaintenanceTree],
"branchId": "abc123"
}
T
MaintenanceChecklist
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
step - Step!
|
Etapa |
type - ResourceType!
|
Tipo do recurso |
resources - [MaintenancePhysicalResource!]
|
Recursos físicos |
Example
{
"id": "xyz789",
"step": Step,
"type": "Area",
"resources": [MaintenancePhysicalResource]
}
T
MaintenanceCounterActive
T
MaintenanceDatesWallet
Fields
| Field Name | Description |
|---|---|
overdue - ScheduleDateRange
|
|
onTime - [ScheduleDateRange!]!
|
Example
{
"overdue": ScheduleDateRange,
"onTime": [ScheduleDateRange]
}
T
MaintenanceHumanResource
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
employee - Employee
|
Mão de obra |
specialty - Specialty
|
Especialidade |
amount - Float
|
Quantidade |
resources - [MaintenancePhysicalResource!]
|
Recursos físicos |
checklists - [MaintenanceChecklist!]
|
Recursos de checklists |
thirdParties - [MaintenanceThirdParty!]
|
Recursos de terceiros |
Example
{
"id": "xyz789",
"type": "Area",
"employee": Employee,
"specialty": Specialty,
"amount": 123.45,
"resources": [MaintenancePhysicalResource],
"checklists": [MaintenanceChecklist],
"thirdParties": [MaintenanceThirdParty]
}
T
MaintenanceItemOnMobile
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
employee - Employee
|
Mão de obra |
specialty - Specialty
|
Especialidade |
amount - Float
|
Quantidade |
resourceId - String!
|
|
maintenance - MaintenanceOnSchedule!
|
|
startDate - DateTime!
|
|
endDate - DateTime!
|
Example
{
"id": "abc123",
"type": "Area",
"employee": Employee,
"specialty": Specialty,
"amount": 123.45,
"resourceId": "xyz789",
"maintenance": MaintenanceOnSchedule,
"startDate": "2025-10-31T17:55:38.518Z",
"endDate": "2025-05-01T17:55:38.518Z"
}
T
MaintenanceMany
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
tree - [MaintenanceTree!]
|
|
resources - [ResourceSummary!]!
|
|
employees - [FilterOnSchedule!]!
|
|
specialties - [FilterOnSchedule!]!
|
|
thirdParties - [FilterOnSchedule!]!
|
Example
{
"id": "xyz789",
"tree": [MaintenanceTree],
"resources": [ResourceSummary],
"employees": [FilterOnSchedule],
"specialties": [FilterOnSchedule],
"thirdParties": [FilterOnSchedule]
}
T
MaintenanceOnEquipment
Fields
| Field Name | Description |
|---|---|
equipmentId - String!
|
Código identificador do equipamento |
maintenance - String!
|
Código identificador |
active - Boolean!
|
Indica se está ativa |
description - String!
|
Descrição |
lastMaintenance - DateTime!
|
Data da última manutenção |
skipWeekend - Boolean!
|
Desconsidera finais de semana |
stopEquipment - Boolean!
|
Indica se há parada de equipamento para execução da manutenção |
hoursBeforeStop - Float
|
Número de horas paradas antes da manutenção |
hoursAfterStop - Float
|
Número de horas paradas depois da manutenção |
detail - [DetailMaintenance!]!
|
Detalhes da manutenção |
maintenanceCounter - MaintenanceCounterActive!
|
Incremento por contador |
maintenanceTime - MaintenanceTimeActive!
|
Incremento por tempo |
lastServiceOrder - DetailServiceOrder!
|
Última ordem de serviço |
nextMaintenance - DetailServiceOrder!
|
Próxima ordem de serviço |
realNextMaintenanceDate - DateTime!
|
Data real da próxima manutenção |
masterPlan - MasterPlanOnEquipment!
|
Plano mestre |
observation - Observation!
|
Observação |
areas - [MaintenanceTree!]!
|
Árvore de recursos |
hasServiceOrder - Boolean!
|
Indica se a manutenção gerou ordem de serviço |
hasActiveServiceOrder - Boolean!
|
Indica se a manutenção gerou ordem de serviço aberta ou finalizada |
hasOpenServiceOrder - Boolean!
|
Indica se a manutenção tem ordem de serviço aberta |
branchId - String
|
Código identificador da filial |
Example
{
"equipmentId": "xyz789",
"maintenance": "xyz789",
"active": false,
"description": "abc123",
"lastMaintenance": "2025-10-31T17:55:38.518Z",
"skipWeekend": false,
"stopEquipment": false,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"detail": [DetailMaintenance],
"maintenanceCounter": MaintenanceCounterActive,
"maintenanceTime": MaintenanceTimeActive,
"lastServiceOrder": DetailServiceOrder,
"nextMaintenance": DetailServiceOrder,
"realNextMaintenanceDate": "2025-05-01T17:55:38.518Z",
"masterPlan": MasterPlanOnEquipment,
"observation": Observation,
"areas": [MaintenanceTree],
"hasServiceOrder": false,
"hasActiveServiceOrder": false,
"hasOpenServiceOrder": false,
"branchId": "abc123"
}
T
MaintenanceOnSchedule
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
description - String!
|
|
lastMaintenance - DateTime!
|
|
active - Boolean!
|
|
increaseCounter - Float!
|
|
timeIncrease - Float!
|
|
timeUnit - TimeUnitType!
|
|
skipWeekend - Boolean!
|
|
stopEquipment - Boolean!
|
|
hoursBeforeStop - Float
|
|
hoursAfterStop - Float
|
|
equipment - EquipmentDefaults!
|
|
areas - [MaintenanceTree!]!
|
Example
{
"id": "abc123",
"description": "xyz789",
"lastMaintenance": "2025-05-01T17:55:38.518Z",
"active": true,
"increaseCounter": 987.65,
"timeIncrease": 123.45,
"timeUnit": "Day",
"skipWeekend": false,
"stopEquipment": false,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 123.45,
"equipment": EquipmentDefaults,
"areas": [MaintenanceTree]
}
T
MaintenanceOnServiceOrder
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
lastMaintenance - DateTime!
|
Data da última manutenção |
active - Boolean!
|
Indica se a manutenção está ativa |
increaseCounter - Float!
|
Incremento por contador |
timeIncrease - Float!
|
Incremento por tempo |
timeUnit - TimeUnitType!
|
Unidade de tempo |
equipment - EquipmentDefaults!
|
Equipamento |
stopEquipment - Boolean!
|
Indica se há parada de equipamento para execução da manutenção |
hoursBeforeStop - Float
|
Número de horas paradas antes da manutenção |
hoursAfterStop - Float
|
Número de horas paradas depois da manutenção |
Example
{
"id": "xyz789",
"description": "abc123",
"lastMaintenance": "2025-10-31T17:55:38.518Z",
"active": false,
"increaseCounter": 123.45,
"timeIncrease": 987.65,
"timeUnit": "Day",
"equipment": EquipmentDefaults,
"stopEquipment": true,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 987.65
}
T
MaintenancePhysicalResource
Example
{
"id": "abc123",
"type": "Area",
"material": Material,
"product": Material,
"tool": Tool,
"warehouse": Warehouse,
"amount": 987.65
}
T
MaintenanceSituation
Values
| Enum Value | Description |
|---|---|
|
|
Ativa |
|
|
Inativa |
Example
"Active"
T
MaintenanceThirdParty
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
thirdParty - ThirdParty!
|
Serviço de terceiro |
supplier - Supplier
|
Fornecedor do serviço |
type - ResourceType!
|
Tipo do recurso |
Example
{
"id": "xyz789",
"thirdParty": ThirdParty,
"supplier": Supplier,
"type": "Area"
}
T
MaintenanceTimeActive
Fields
| Field Name | Description |
|---|---|
timeIncrease - Float!
|
Valor do incremento |
timeUnit - TimeUnitType!
|
Unidade de tempo |
active - Boolean!
|
Indica se está ativo |
Example
{"timeIncrease": 987.65, "timeUnit": "Day", "active": false}
T
MaintenanceTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
area - Area
|
Área |
resources - [MaintenanceHumanResource!]
|
Recursos humanos |
Example
{
"id": "abc123",
"area": Area,
"resources": [MaintenanceHumanResource]
}
T
Manufacturer
Example
{
"id": "abc123",
"description": "abc123",
"isActive": true,
"referenceId": "xyz789",
"branchId": "xyz789"
}
T
ManufacturerQueryInput
T
MasterPlan
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
maintenanceTime - MasterPlanTime!
|
Incremento por tempo |
skipWeekend - Boolean!
|
Desconsidera finais de semana |
stopEquipment - Boolean!
|
Indica se há parada de equipamento para execução da manutenção |
hoursBeforeStop - Float
|
Número de horas paradas antes da manutenção |
hoursAfterStop - Float
|
Número de horas paradas depois da manutenção |
maintenanceCounter - MasterPlanCounter!
|
Incremento por contador |
isImported - Boolean
|
Indica se foi importado em uma manutação |
model - Model
|
Modelo do equipamento |
group - Group
|
Grupo do equipamento |
branchId - String
|
Código identificador da filial |
resources - [MasterPlanResource!]!
|
Árvore de recursos |
Example
{
"id": "abc123",
"description": "abc123",
"maintenanceTime": MasterPlanTime,
"skipWeekend": true,
"stopEquipment": false,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"maintenanceCounter": MasterPlanCounter,
"isImported": false,
"model": Model,
"group": Group,
"branchId": "xyz789",
"resources": [MasterPlanResource]
}
T
MasterPlanCounter
Fields
| Field Name | Description |
|---|---|
counterIncrement - Float!
|
Valor |
counterUnit - CounterTypeIncrement!
|
Tipo de incremento |
active - Boolean!
|
Indica se está ativo |
Example
{"counterIncrement": 987.65, "counterUnit": "Hours", "active": true}
T
MasterPlanFilter
Fields
| Input Field | Description |
|---|---|
counter - CounterType!
|
Tipo de controle do contador |
equipmentId - String
|
Código identificador do equipamento |
modelId - String
|
Código identificador do modelo |
groupId - String
|
Código identificador do grupo |
Example
{
"counter": "Hours",
"equipmentId": "xyz789",
"modelId": "abc123",
"groupId": "abc123"
}
T
MasterPlanOnEquipment
T
MasterPlanOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
Descrição |
|
|
Modelo e grupo |
Example
"Description"
T
MasterPlanQueryInput
Fields
| Input Field | Description |
|---|---|
identifier - String
|
Pesquisa por descrição |
filter - MasterPlanFilter
|
Filtro |
Example
{
"identifier": "xyz789",
"filter": MasterPlanFilter
}
T
MasterPlanResource
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
area - Area
|
Área |
resources - [HumanResource!]
|
Recursos humanos |
Example
{
"id": "xyz789",
"area": Area,
"resources": [HumanResource]
}
T
MasterPlanSummary
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
maintenanceTime - MasterPlanTime!
|
Incremento por tempo |
skipWeekend - Boolean!
|
Desconsidera finais de semana |
stopEquipment - Boolean!
|
Indica se há parada de equipamento para execução da manutenção |
hoursBeforeStop - Float
|
Número de horas paradas antes da manutenção |
hoursAfterStop - Float
|
Número de horas paradas depois da manutenção |
maintenanceCounter - MasterPlanCounter!
|
Incremento por contador |
isImported - Boolean
|
Indica se foi importado em uma manutação |
model - Model
|
Modelo do equipamento |
group - Group
|
Grupo do equipamento |
branchId - String
|
Código identificador da filial |
resources - [ResourceSummary!]!
|
Resumo dos recursos |
tree - [MasterPlanResource!]!
|
Árvore de recursos |
Example
{
"id": "abc123",
"description": "xyz789",
"maintenanceTime": MasterPlanTime,
"skipWeekend": false,
"stopEquipment": true,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"maintenanceCounter": MasterPlanCounter,
"isImported": true,
"model": Model,
"group": Group,
"branchId": "xyz789",
"resources": [ResourceSummary],
"tree": [MasterPlanResource]
}
T
MasterPlanThirdParty
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
thirdParty - ThirdParty!
|
Serviço de terceiro |
supplier - Supplier
|
Forcecedor do serviço |
cost - Float
|
Custo do serviço |
type - ResourceType!
|
Tipo do recurso |
Example
{
"id": "xyz789",
"thirdParty": ThirdParty,
"supplier": Supplier,
"cost": 123.45,
"type": "Area"
}
T
MasterPlanTime
Fields
| Field Name | Description |
|---|---|
timeIncrement - Float!
|
Valor |
timeUnit - TimeUnitType!
|
Unidade de tempo |
active - Boolean!
|
Indica se está ativo |
Example
{"timeIncrement": 987.65, "timeUnit": "Day", "active": true}
T
Material
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
standardCost - Float!
|
Custo padrão |
isActive - Boolean
|
Status |
referenceId - String
|
|
measurementUnit - NewMeasurementUnit!
|
Unidade de medida |
warehouse - Warehouse
|
Local de estoque padrão |
isInMaintenance - Boolean
|
Indica se o material é usado em alguma árvore de recursos |
branchId - String
|
Código identificador da filial |
erpId - String
|
Código identificador na integração |
stockLevels - [StockLevelOnMaterial!]
|
Nível de estoque |
stockMovements - [StockMovementOnMaterial!]
|
Movimentações |
isIntegrated - Boolean!
|
Example
{
"id": "xyz789",
"description": "abc123",
"standardCost": 987.65,
"isActive": true,
"referenceId": "xyz789",
"measurementUnit": NewMeasurementUnit,
"warehouse": Warehouse,
"isInMaintenance": false,
"branchId": "abc123",
"erpId": "xyz789",
"stockLevels": [StockLevelOnMaterial],
"stockMovements": [StockMovementOnMaterial],
"isIntegrated": true
}
T
MaterialFamily
T
MaterialsClassificationInput
T
MeanTimeBySituation
Fields
| Field Name | Description |
|---|---|
emergency - ServiceRequestBI!
|
|
high - ServiceRequestBI!
|
|
medium - ServiceRequestBI!
|
|
low - ServiceRequestBI!
|
Example
{
"emergency": ServiceRequestBI,
"high": ServiceRequestBI,
"medium": ServiceRequestBI,
"low": ServiceRequestBI
}
T
MeasurementQueryInput
Fields
| Input Field | Description |
|---|---|
identifier - String
|
|
filter - MeasurementUnitFilter!
|
|
branchId - String
|
Example
{
"identifier": "abc123",
"filter": MeasurementUnitFilter,
"branchId": "xyz789"
}
T
MeasurementUnit
T
MeasurementUnitFilter
Fields
| Input Field | Description |
|---|---|
type - MeasurementUnitType!
|
Example
{"type": "EquipmentFeature"}
T
MeasurementUnitType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EquipmentFeature"
T
MentionUser
T
Mentions
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
user - MentionUser!
|
Example
{
"id": "abc123",
"user": MentionUser
}
T
MetadataType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CostCenter"
T
MobileEmptyCard
Fields
| Field Name | Description |
|---|---|
date - DateTime!
|
Example
{"date": "2025-05-01T17:55:38.518Z"}
T
Model
Example
{
"id": "xyz789",
"description": "abc123",
"isActive": true,
"referenceId": "abc123",
"manufacturer": Manufacturer,
"branchId": "abc123"
}
T
ModelQueryInput
T
NewMeasurementUnit
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador da unidade de medida |
name - String!
|
Descrição da unidade de medida |
acronym - String!
|
Acrônimo da unidade de medida |
isActive - Boolean
|
Status |
branchId - String
|
Código identificador da filial |
erpId - String
|
Código identificador no erp |
description - String!
|
Descrição da unidade de medida |
symbol - String!
|
Acrônimo da unidade de medida |
Example
{
"id": "xyz789",
"name": "abc123",
"acronym": "abc123",
"isActive": false,
"branchId": "abc123",
"erpId": "xyz789",
"description": "xyz789",
"symbol": "abc123"
}
T
NewPaginatedMeasurementUnits
Fields
| Field Name | Description |
|---|---|
items - [NewMeasurementUnit!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [NewMeasurementUnit], "hasMore": true}
T
Observation
Example
{
"situation": "xyz789",
"suggestedDate": "2025-05-01T17:55:38.518Z",
"minimumDate": "2025-05-01T17:55:38.518Z",
"deadline": "2025-10-31T17:55:38.518Z"
}
T
OrderBy
Values
| Enum Value | Description |
|---|---|
|
|
Crescente |
|
|
Decrescente |
Example
"Ascending"
T
PagedWallet
Fields
| Field Name | Description |
|---|---|
resourceItems - [ShallowResourceItem!]!
|
|
maintenanceResourceItems - [ShallowMaintenanceWallet!]!
|
|
hasMore - Boolean!
|
Example
{
"resourceItems": [ShallowResourceItem],
"maintenanceResourceItems": [ShallowMaintenanceWallet],
"hasMore": false
}
T
PaginatedAreas
T
PaginatedCalendars
Fields
| Field Name | Description |
|---|---|
items - [Calendar!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Calendar], "hasMore": true}
T
PaginatedCostCenters
Fields
| Field Name | Description |
|---|---|
items - [CostCenter!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [CostCenter], "hasMore": false}
T
PaginatedCustomers
Fields
| Field Name | Description |
|---|---|
items - [CustomerPartner!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [CustomerPartner], "hasMore": true}
T
PaginatedEmployees
Fields
| Field Name | Description |
|---|---|
items - [FullEmployee!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [FullEmployee], "hasMore": true}
T
PaginatedEquipments
Fields
| Field Name | Description |
|---|---|
items - [EquipmentList!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [EquipmentList], "hasMore": false}
T
PaginatedFeatures
Fields
| Field Name | Description |
|---|---|
items - [Feature!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Feature], "hasMore": false}
T
PaginatedGenericAreas
Fields
| Field Name | Description |
|---|---|
items - [GenericArea!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericArea], "hasMore": false}
T
PaginatedGenericCalendars
Fields
| Field Name | Description |
|---|---|
items - [GenericCalendar!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericCalendar], "hasMore": true}
T
PaginatedGenericCostCenters
Fields
| Field Name | Description |
|---|---|
items - [GenericCostCenter!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericCostCenter], "hasMore": true}
T
PaginatedGenericFeatures
Fields
| Field Name | Description |
|---|---|
items - [GenericFeature!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericFeature], "hasMore": true}
T
PaginatedGenericGroups
Fields
| Field Name | Description |
|---|---|
items - [GenericGroup!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericGroup], "hasMore": true}
T
PaginatedGenericManufacturers
Fields
| Field Name | Description |
|---|---|
items - [GenericManufacturer!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericManufacturer], "hasMore": false}
T
PaginatedGenericMaterials
Fields
| Field Name | Description |
|---|---|
items - [GenericMaterial!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericMaterial], "hasMore": true}
T
PaginatedGenericModels
Fields
| Field Name | Description |
|---|---|
items - [GenericModel!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericModel], "hasMore": true}
T
PaginatedGenericReasons
Fields
| Field Name | Description |
|---|---|
items - [GenericReason!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericReason], "hasMore": false}
T
PaginatedGenericSpecialties
Fields
| Field Name | Description |
|---|---|
items - [GenericSpecialty!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericSpecialty], "hasMore": true}
T
PaginatedGenericSteps
Fields
| Field Name | Description |
|---|---|
items - [GenericStep!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericStep], "hasMore": false}
T
PaginatedGenericTools
Fields
| Field Name | Description |
|---|---|
items - [GenericTool!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericTool], "hasMore": true}
T
PaginatedGroups
T
PaginatedManufacturer
Fields
| Field Name | Description |
|---|---|
items - [Manufacturer!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Manufacturer], "hasMore": false}
T
PaginatedMasterPlans
Fields
| Field Name | Description |
|---|---|
items - [MasterPlanSummary!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [MasterPlanSummary], "hasMore": true}
T
PaginatedMaterials
Fields
| Field Name | Description |
|---|---|
items - [Material!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Material], "hasMore": false}
T
PaginatedMeasurementUnits
Fields
| Field Name | Description |
|---|---|
items - [MeasurementUnit!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [MeasurementUnit], "hasMore": true}
T
PaginatedMentionUsers
Fields
| Field Name | Description |
|---|---|
items - [MentionUser!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [MentionUser], "hasMore": false}
T
PaginatedModels
T
PaginatedReasons
Fields
| Field Name | Description |
|---|---|
items - [Reason!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Reason], "hasMore": true}
T
PaginatedServiceOrders
Fields
| Field Name | Description |
|---|---|
items - [ServiceOrder!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [ServiceOrder], "hasMore": false}
T
PaginatedServiceRequests
Fields
| Field Name | Description |
|---|---|
items - [ServiceRequestBrowse!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [ServiceRequestBrowse], "hasMore": true}
T
PaginatedServiceRequestsDashboard
Fields
| Field Name | Description |
|---|---|
items - [ServiceRequestDashboard!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [ServiceRequestDashboard], "hasMore": false}
T
PaginatedSpecialties
Fields
| Field Name | Description |
|---|---|
items - [Specialty!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Specialty], "hasMore": false}
T
PaginatedSteps
T
PaginatedSuppliers
Fields
| Field Name | Description |
|---|---|
items - [Supplier!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Supplier], "hasMore": true}
T
PaginatedThirdParties
Fields
| Field Name | Description |
|---|---|
items - [ThirdParty!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [ThirdParty], "hasMore": false}
T
PaginatedTools
T
PaginatedWarehouses
Fields
| Field Name | Description |
|---|---|
items - [Warehouse!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Warehouse], "hasMore": false}
T
Pagination
T
PaginationDefaultQueryInput
Example
{
"identifier": "abc123",
"isActive": false,
"branchId": "abc123",
"isAutocomplete": true
}
T
PeriodUnit
Values
| Enum Value | Description |
|---|---|
|
|
Dia |
|
|
Mês |
|
|
Ano |
Example
"Day"
T
PersonType
Values
| Enum Value | Description |
|---|---|
|
|
Pessoa física |
|
|
Pessoa jurídica |
Example
"IndividualPerson"
T
PhysicalResource
Example
{
"id": "xyz789",
"type": "Area",
"amount": 123.45,
"material": Material,
"product": Material,
"tool": Tool,
"warehouse": Warehouse
}
T
PhysicalResourceTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
material - Material
|
Material |
product - Material
|
Produto Use material field instead
|
tool - Tool
|
Ferramenta |
warehouse - Warehouse
|
Local de estoque |
amount - Float
|
Quantidade prevista |
cost - Float
|
Custo previsto |
amountDone - Float
|
Quantidade realizada |
costDone - Float
|
Custo realizado |
foreseen - Boolean!
|
Indica se o recurso foi previsto |
done - Boolean!
|
Indica se o recurso foi realizado |
parentId - String
|
Código identificador do recurso pai |
Example
{
"id": "xyz789",
"type": "Area",
"material": Material,
"product": Material,
"tool": Tool,
"warehouse": Warehouse,
"amount": 123.45,
"cost": 123.45,
"amountDone": 987.65,
"costDone": 987.65,
"foreseen": true,
"done": true,
"parentId": "abc123"
}
T
PlanLevelType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"First"
T
PolicyAgreement
Example
{
"id": "xyz789",
"termId": "xyz789",
"userId": "xyz789",
"ipAddress": "xyz789",
"createdAt": "2025-10-31T17:55:38.518Z",
"userAgent": "abc123"
}
T
PolicyTerms
Example
{
"id": "xyz789",
"content": "xyz789",
"type": "Use",
"version": "xyz789",
"isFuture": false,
"startedAt": "2025-05-01T17:55:38.518Z",
"createdAt": "2025-05-01T17:55:38.518Z"
}
T
PostingType
Values
| Enum Value | Description |
|---|---|
|
|
Gerado automaticamente pelo sistema |
|
|
Comentário de usuário |
Example
"Event"
T
PrivacyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Use"
T
PurchaseCategory
T
QuerySchedule
Fields
| Input Field | Description |
|---|---|
startDate - DateTime!
|
|
endDate - DateTime!
|
|
identifier - String
|
|
filter - ScheduleFilter
|
Filtro |
Example
{
"startDate": "2025-05-01T17:55:38.518Z",
"endDate": "2025-05-01T17:55:38.518Z",
"identifier": "abc123",
"filter": ScheduleFilter
}
T
Reason
Example
{
"id": "xyz789",
"description": "xyz789",
"type": "Delay",
"isActive": false,
"referenceId": "abc123",
"isUsed": true,
"branchId": "abc123"
}
T
ReasonType
Values
| Enum Value | Description |
|---|---|
|
|
Essa opção não está disponível |
|
|
Inativação de equipameto |
|
|
Cancelamento de OS |
|
|
Cancelamento de SS |
Example
"Delay"
T
ResourceItem
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
employee - Employee
|
Mão de obra |
specialty - Specialty
|
Especialidade |
startDate - DateTime
|
Data de início da mão de obra prevista |
endDate - DateTime
|
Data de fim da mão de obra prevista |
amount - Float
|
Quantidade prevista |
cost - Float
|
Custo previsto |
startDateDone - DateTime
|
Data de início da mão de obra realizada |
endDateDone - DateTime
|
Data de fim da mão de obra realizada |
amountDone - Float
|
Quantidade realizada |
costDone - Float
|
Custo realizado |
foreseen - Boolean!
|
Indica se o recurso foi previsto |
done - Boolean!
|
Indica se o recurso foi realizado |
parentId - String
|
Código identificador do recurso pai |
purchaseRequestId - String
|
Código da requisição |
resources - [PhysicalResourceTree!]
|
Recursos físicos |
checklists - [ChecklistTree!]
|
Recursos de checklists |
thirdParties - [ThirdPartyTree!]
|
Recursos de terceiros |
area - Area
|
|
serviceOrder - ServiceOrder!
|
Example
{
"id": "xyz789",
"type": "Area",
"employee": Employee,
"specialty": Specialty,
"startDate": "2025-05-01T17:55:38.518Z",
"endDate": "2025-05-01T17:55:38.518Z",
"amount": 123.45,
"cost": 987.65,
"startDateDone": "2025-05-01T17:55:38.518Z",
"endDateDone": "2025-10-31T17:55:38.518Z",
"amountDone": 987.65,
"costDone": 123.45,
"foreseen": false,
"done": false,
"parentId": "abc123",
"purchaseRequestId": "xyz789",
"resources": [PhysicalResourceTree],
"checklists": [ChecklistTree],
"thirdParties": [ThirdPartyTree],
"area": Area,
"serviceOrder": ServiceOrder
}
T
ResourceItemOnMobile
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
employee - Employee
|
Mão de obra |
specialty - Specialty
|
Especialidade |
startDate - DateTime!
|
|
endDate - DateTime!
|
|
amount - Float
|
Quantidade prevista |
cost - Float
|
Custo previsto |
startDateDone - DateTime
|
Data de início da mão de obra realizada |
endDateDone - DateTime
|
Data de fim da mão de obra realizada |
amountDone - Float
|
Quantidade realizada |
costDone - Float
|
Custo realizado |
foreseen - Boolean!
|
Indica se o recurso foi previsto |
done - Boolean!
|
Indica se o recurso foi realizado |
parentId - String
|
Código identificador do recurso pai |
purchaseRequestId - String
|
Código da requisição |
serviceOrder - ServiceOrder!
|
Example
{
"id": "xyz789",
"type": "Area",
"employee": Employee,
"specialty": Specialty,
"startDate": "2025-05-01T17:55:38.518Z",
"endDate": "2025-10-31T17:55:38.518Z",
"amount": 123.45,
"cost": 123.45,
"startDateDone": "2025-10-31T17:55:38.518Z",
"endDateDone": "2025-10-31T17:55:38.518Z",
"amountDone": 123.45,
"costDone": 123.45,
"foreseen": true,
"done": false,
"parentId": "xyz789",
"purchaseRequestId": "xyz789",
"serviceOrder": ServiceOrder
}
T
ResourceSummary
Fields
| Field Name | Description |
|---|---|
type - ResourceType!
|
Tipo do recurso |
quantity - Float!
|
Quantidade do tipo de recurso |
Example
{"type": "Area", "quantity": 987.65}
T
ResourceType
Values
| Enum Value | Description |
|---|---|
|
|
Área |
|
|
Mão de obra |
|
|
Especialidade |
|
|
Etapa |
|
|
Material |
|
|
Ferramenta |
|
|
Serviço de terceiro |
|
|
Utilize a opção "Material" |
Example
"Area"
T
ResourcesOnServiceOrder
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
branchId - String!
|
Código identificador da filial |
serviceOrderId - String!
|
Código identificador da ordem de serviço |
type - ResourceType!
|
Tipo de recurso |
areaId - String
|
Código identificador da área prevista |
employeeId - String
|
Código identificador da mão de obra prevista |
specialtyId - String
|
Código identificador da especialidade prevista |
thirdPartyId - String
|
Código identificador do serviço de terceiro previsto |
supplierId - String
|
Código identificador do fornecedor previsto |
stepId - String
|
Código identificador da etapa prevista |
materialId - String
|
Código identificador do material previsto |
toolId - String
|
Código identificador da ferramenta prevista |
warehouseId - String
|
Código identificador do local de estoque previsto |
sequence - Float!
|
Sequência prevista |
areaDoneId - String
|
Código identificador da área realizada |
employeeDoneId - String
|
Código identificador da mão de obra realizada |
thirdPartyDoneId - String
|
Código identificador do serviço de terceiro realizado |
supplierDoneId - String
|
Código identificador do fornecedor realizado |
stepDoneId - String
|
Código identificador da etapa realizada |
materialDoneId - String
|
Código identificador do material realizado |
toolDoneId - String
|
Código identificador da ferramenta realizada |
warehouseDoneId - String
|
Código identificador do local de estoque realizado |
sequenceDone - Float!
|
Sequência realizada |
foreseen - Boolean!
|
Indica se o recurso está previsto |
done - Boolean!
|
Indica se o recurso está realizado |
startDate - DateTime
|
Data de início prevista |
endDate - DateTime
|
Data de fim prevista |
amount - Float!
|
Quantia prevista |
response - String
|
Resposta da etapa |
cost - Float!
|
Custo previsto |
startDateDone - DateTime
|
Data de início realizada |
endDateDone - DateTime
|
Data de fim realizada |
amountDone - Float!
|
Quantia realizada |
costDone - Float!
|
Custo realizado |
parentId - String
|
Código identificador do recurso pai previsto |
parentDoneId - String
|
Código identificador do recurso pai realizado |
purchaseRequestId - String
|
Código identificador da requisição de compra |
createdAt - DateTime
|
Data de criação do insumo |
updatedAt - DateTime
|
Data de alteração do insumo |
Example
{
"id": "xyz789",
"branchId": "abc123",
"serviceOrderId": "abc123",
"type": "Area",
"areaId": "xyz789",
"employeeId": "abc123",
"specialtyId": "xyz789",
"thirdPartyId": "abc123",
"supplierId": "xyz789",
"stepId": "abc123",
"materialId": "xyz789",
"toolId": "xyz789",
"warehouseId": "abc123",
"sequence": 123.45,
"areaDoneId": "abc123",
"employeeDoneId": "xyz789",
"thirdPartyDoneId": "abc123",
"supplierDoneId": "xyz789",
"stepDoneId": "abc123",
"materialDoneId": "abc123",
"toolDoneId": "abc123",
"warehouseDoneId": "xyz789",
"sequenceDone": 123.45,
"foreseen": true,
"done": false,
"startDate": "2025-10-31T17:55:38.518Z",
"endDate": "2025-10-31T17:55:38.518Z",
"amount": 123.45,
"response": "abc123",
"cost": 987.65,
"startDateDone": "2025-05-01T17:55:38.518Z",
"endDateDone": "2025-10-31T17:55:38.518Z",
"amountDone": 123.45,
"costDone": 987.65,
"parentId": "xyz789",
"parentDoneId": "xyz789",
"purchaseRequestId": "xyz789",
"createdAt": "2025-05-01T17:55:38.518Z",
"updatedAt": "2025-10-31T17:55:38.518Z"
}
T
Role
Example
{
"userId": "abc123",
"branchId": "xyz789",
"roleId": "abc123",
"createdAt": "2025-05-01T17:55:38.518Z",
"branch": Branch
}
T
RolesWallet
T
S3UrlCloudFront
Example
S3UrlCloudFront
T
SaasFullMetadata
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
integrationType - ErpType!
|
|
genericMetadataId - String!
|
|
isCustomizable - Boolean!
|
|
version - Float!
|
|
isActive - Boolean!
|
|
genericMetadata - GenericMetadata
|
|
fields - [InternalFields!]!
|
Example
{
"id": "abc123",
"name": "abc123",
"integrationType": "FakeERP",
"genericMetadataId": "xyz789",
"isCustomizable": false,
"version": 123.45,
"isActive": true,
"genericMetadata": GenericMetadata,
"fields": [InternalFields]
}
T
SatisfactionSurvey
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
deadlineEvaluation - EvaluationType!
|
Tipo de resposta - atendimento no prazo |
coveringEvaluation - EvaluationType!
|
Tipo de resposta - atendimento da necessidade |
observation - String
|
Observação |
Example
{
"id": "abc123",
"deadlineEvaluation": "Great",
"coveringEvaluation": "Great",
"observation": "xyz789"
}
T
Scale
Values
| Enum Value | Description |
|---|---|
|
|
Alta |
|
|
Baixa |
|
|
Média |
Example
"High"
T
ScheduleCardType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Maintenance"
T
ScheduleDateRange
T
ScheduleFilter
Fields
| Input Field | Description |
|---|---|
cardTypes - [ScheduleCardType!]
|
Tipo card a ser apresentado na agenda |
customers - [String!]
|
Códigos identificadores de clientes |
employees - [String!]
|
Códigos identificadores de mãos de obra |
specialties - [String!]
|
Códigos identificadores de especialidade |
groups - [String!]
|
Códigos identificadores de grupos |
tags - [String!]
|
Códigos identificadores de equipamentos |
criticalities - [Scale!]
|
Tipos de criticidade |
costCenters - [String!]
|
Códigos identificadores de centros de custo |
priorities - [ServiceOrderPriority!]
|
Tipos de prioridade |
serviceTypes - [ServiceType!]
|
Tipos de serviço |
Example
{
"cardTypes": ["Maintenance"],
"customers": ["abc123"],
"employees": ["abc123"],
"specialties": ["xyz789"],
"groups": ["xyz789"],
"tags": ["xyz789"],
"criticalities": ["High"],
"costCenters": ["xyz789"],
"priorities": ["Emergency"],
"serviceTypes": ["Corrective"]
}
T
SchedulesItems
Fields
| Field Name | Description |
|---|---|
scheduledResources - [ShallowResourceItem!]!
|
|
resourcesToSchedule - [ShallowResourceItem!]!
|
|
scheduledMaintenances - [ShallowMaintenanceSchedule!]!
|
|
maintenancesToSchedule - [ShallowMaintenanceSchedule!]!
|
Example
{
"scheduledResources": [ShallowResourceItem],
"resourcesToSchedule": [ShallowResourceItem],
"scheduledMaintenances": [ShallowMaintenanceSchedule],
"maintenancesToSchedule": [ShallowMaintenanceSchedule]
}
T
SensorDataDay
T
SensorDataEquipment
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
sensorId - String!
|
Código identificador do sensor |
surfaceTemperature - Float!
|
Temperatura |
surfaceTemperatureThresholdWarning - Float
|
Limite de temperatura para alerta |
surfaceTemperatureThresholdCritical - Float
|
Limite crítico de temperatura |
velX - Float!
|
Limite de vibração horizontal para alerta |
velXThresholdWarning - Float
|
Limite crítico de vibração horizontal |
velXThresholdCritical - Float
|
Vibração Horizontal |
velY - Float!
|
Vibração Vertical |
velYThresholdWarning - Float
|
Limite de vibração vertical para alerta |
velYThresholdCritical - Float
|
Limite crítico de vibração vertical |
velZ - Float!
|
Vibração Axial |
velZThresholdWarning - Float
|
Limite de vibração axial para alerta |
velZThresholdCritical - Float
|
Limite crítico de vibração axial |
lastTimestamp - DateTime!
|
Data da última coleta |
health - Float!
|
Saúde do ativo |
enabled - Boolean!
|
Status do ativo |
createdAt - DateTime!
|
Data de criação no sistema |
Example
{
"id": "xyz789",
"sensorId": "xyz789",
"surfaceTemperature": 123.45,
"surfaceTemperatureThresholdWarning": 123.45,
"surfaceTemperatureThresholdCritical": 123.45,
"velX": 987.65,
"velXThresholdWarning": 123.45,
"velXThresholdCritical": 123.45,
"velY": 987.65,
"velYThresholdWarning": 123.45,
"velYThresholdCritical": 987.65,
"velZ": 987.65,
"velZThresholdWarning": 123.45,
"velZThresholdCritical": 123.45,
"lastTimestamp": "2025-10-31T17:55:38.518Z",
"health": 123.45,
"enabled": true,
"createdAt": "2025-05-01T17:55:38.518Z"
}
T
SensorDataHour
Example
{
"label": "xyz789",
"surfaceTemperature": "xyz789",
"velZ": "abc123",
"velX": "xyz789",
"velY": "xyz789"
}
T
SensorDataLastWeek
Fields
| Field Name | Description |
|---|---|
sensorByHour - [SensorDataHour!]
|
Históricos por hora |
sensorByDay - [SensorDataDay!]
|
Históricos por dia |
Example
{
"sensorByHour": [SensorDataHour],
"sensorByDay": [SensorDataDay]
}
T
SensorEquipment
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
externalId - String!
|
Código identificador do sensor |
description - String!
|
Descrição do sensor |
mainPicture - S3UrlCloudFront
|
Imagem do sensor |
sensorType - String
|
Tipo do sensor |
hasSensorData - Boolean
|
Indica se há dados para o sensor |
sensorData - [SensorDataEquipment!]
|
Dados de sensor do equipamento |
Example
{
"id": "abc123",
"externalId": "abc123",
"description": "abc123",
"mainPicture": S3UrlCloudFront,
"sensorType": "xyz789",
"hasSensorData": true,
"sensorData": [SensorDataEquipment]
}
T
ServiceOrder
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
code - String!
|
Código do serviço na filial |
equipment - EquipmentDefaults!
|
Equipamento |
user - UserBasicInfo
|
Usuário |
service - ServiceType!
|
Tipo de serviço |
situation - ServiceOrderSituation!
|
Tipo de situação |
startDate - DateTime!
|
Data de início prevista |
endDate - DateTime!
|
Data de fim prevista |
attachments - [Attachment!]!
|
Anexos |
maintenance - MaintenanceOnServiceOrder
|
Manutenção |
cancellationReasonRef - Reason
|
Motivo de cancelamento |
costCenterRef - CostCenter
|
Centro de custo |
observation - String
|
Motivo |
priority - Float
|
Prioridade |
realStartDate - DateTime
|
Data de início realizada |
realEndDate - DateTime
|
Data de fim realizada |
conclusion - Float
|
Tempo de conclusão |
doneCost - Float
|
Custo realizado |
foreseenCost - Float
|
Custo previsto |
createdAt - DateTime
|
Data de criação |
areas - [AreaTree!]
|
Árvore de recursos |
resources - [ResourcesOnServiceOrder!]
|
Recursos |
followUp - [ServiceOrderFollowUp!]!
|
Acompanhamentos |
stoppedAt - DateTime
|
Data de início da parada |
resumedAt - DateTime
|
Data de fim da parada |
foreseenStoppedAt - DateTime
|
Data de início previsto da parada |
foreseenResumedAt - DateTime
|
Data de fim previsto da parada |
updatedAt - DateTime
|
Data da última atualização |
operationTime - Float
|
Tempo de manutenção |
hasDoneResource - Boolean
|
Indica se possui recursos realizados |
hasDoneHuman - Boolean
|
Indica se possui recursos humanos realizados |
hasUnreportedThirdParty - Boolean
|
Indica se possui recursos de terceiros previstos não realizados |
generatedByServiceRequest - Boolean
|
Indica se foi gerada por solicitação de serviço |
hasMaintenceByCounter - Boolean
|
Indica se está vinculada à uma manutenção controlada por contador |
serviceRequest - ServiceRequestRef
|
Solicitação de serviço |
finalizationObservation - String
|
Observação de finalização |
cancellationObservation - String
|
Observação de cancelamento |
counter - Counter
|
Contador |
foreseenEmployeeCost - Float
|
Custo da mão de obra prevista |
doneEmployeeCost - Float
|
Custo da mão de obra realizada |
foreseenToolCost - Float
|
Custo da ferramenta prevista |
doneToolCost - Float
|
Custo da ferramenta realizada |
foreseenMaterialCost - Float
|
Custo do material previsto |
foreseenProductCost - Float
|
Custo do produto previsto Use foreseenMaterialCost field instead
|
doneMaterialCost - Float
|
Custo do material realizado |
doneProductCost - Float
|
Custo do produto realizado Use doneMaterialCost field instead
|
foreseenThirdPartyCost - Float
|
Custo do serviço de terceiro previsto |
doneThirdPartyCost - Float
|
Custo do serviço de terceiro realizado |
branchId - String
|
Código identificador da filial |
Example
{
"id": "xyz789",
"code": "xyz789",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2025-10-31T17:55:38.518Z",
"endDate": "2025-05-01T17:55:38.518Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "xyz789",
"priority": 123.45,
"realStartDate": "2025-10-31T17:55:38.518Z",
"realEndDate": "2025-05-01T17:55:38.518Z",
"conclusion": 123.45,
"doneCost": 987.65,
"foreseenCost": 987.65,
"createdAt": "2025-10-31T17:55:38.518Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2025-05-01T17:55:38.518Z",
"resumedAt": "2025-10-31T17:55:38.518Z",
"foreseenStoppedAt": "2025-10-31T17:55:38.518Z",
"foreseenResumedAt": "2025-10-31T17:55:38.518Z",
"updatedAt": "2025-10-31T17:55:38.518Z",
"operationTime": 987.65,
"hasDoneResource": false,
"hasDoneHuman": false,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": true,
"hasMaintenceByCounter": true,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "abc123",
"cancellationObservation": "abc123",
"counter": Counter,
"foreseenEmployeeCost": 123.45,
"doneEmployeeCost": 123.45,
"foreseenToolCost": 123.45,
"doneToolCost": 987.65,
"foreseenMaterialCost": 123.45,
"foreseenProductCost": 123.45,
"doneMaterialCost": 987.65,
"doneProductCost": 123.45,
"foreseenThirdPartyCost": 123.45,
"doneThirdPartyCost": 987.65,
"branchId": "xyz789"
}
T
ServiceOrderAction
Values
| Enum Value | Description |
|---|---|
|
|
Abertura |
|
|
Abertura por SS |
|
|
Reporte |
|
|
Reporte automático |
|
|
Reporte de finalizada |
|
|
Finalização |
|
|
Cancelamento |
|
|
Cancelamento em lote |
|
|
Edição |
|
|
Comentário de usuário |
Example
"Open"
T
ServiceOrderAmountByPriority
T
ServiceOrderAmountByServiceType
T
ServiceOrderAmountBySituation
T
ServiceOrderCosts
Fields
| Field Name | Description |
|---|---|
foreseenEmployeeCost - Float!
|
Custo de mãos de obra previstos |
doneEmployeeCost - Float!
|
Custo de mãos de obra realizados |
foreseenToolCost - Float!
|
Custo de ferramentas previstas |
doneToolCost - Float!
|
Custo de ferramentas realizadas |
foreseenMaterialCost - Float!
|
Custo de materiais previstos |
doneMaterialCost - Float!
|
Custo de materiais realizados |
foreseenThirdPartyCost - Float!
|
Custo de serviços de terceiros previstos |
doneThirdPartyCost - Float!
|
Custo de serviços de terceiros realizados |
Example
{
"foreseenEmployeeCost": 987.65,
"doneEmployeeCost": 987.65,
"foreseenToolCost": 987.65,
"doneToolCost": 123.45,
"foreseenMaterialCost": 123.45,
"doneMaterialCost": 987.65,
"foreseenThirdPartyCost": 123.45,
"doneThirdPartyCost": 987.65
}
T
ServiceOrderDefaults
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
code - String!
|
Código do serviço na filial |
equipment - EquipmentDefaults!
|
Equipamento |
user - UserBasicInfo
|
Usuário |
service - ServiceType!
|
Tipo de serviço |
situation - ServiceOrderSituation!
|
Tipo de situação |
startDate - DateTime!
|
Data de início prevista |
endDate - DateTime!
|
Data de fim prevista |
attachments - [Attachment!]!
|
Anexos |
maintenance - MaintenanceOnServiceOrder
|
Manutenção |
cancellationReasonRef - Reason
|
Motivo de cancelamento |
costCenterRef - CostCenter
|
Centro de custo |
observation - String
|
Motivo |
priority - Float
|
Prioridade |
realStartDate - DateTime
|
Data de início realizada |
realEndDate - DateTime
|
Data de fim realizada |
conclusion - Float
|
Tempo de conclusão |
doneCost - Float
|
Custo realizado |
foreseenCost - Float
|
Custo previsto |
createdAt - DateTime
|
Data de criação |
Example
{
"id": "abc123",
"code": "xyz789",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2025-10-31T17:55:38.518Z",
"endDate": "2025-05-01T17:55:38.518Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "xyz789",
"priority": 987.65,
"realStartDate": "2025-05-01T17:55:38.518Z",
"realEndDate": "2025-05-01T17:55:38.518Z",
"conclusion": 123.45,
"doneCost": 987.65,
"foreseenCost": 987.65,
"createdAt": "2025-10-31T17:55:38.518Z"
}
T
ServiceOrderFilter
Fields
| Input Field | Description |
|---|---|
serials - [String!]
|
Séries de equipamento |
priorities - [ServiceOrderPriority!]
|
Tipos de prioridade |
criticalities - [Scale!]
|
Criticidades |
situations - [ServiceOrderSituation!]
|
Tipos de situação |
serviceTypes - [ServiceType!]
|
Tipos de serviço |
expectedStart - DateRange
|
Intervalo de tempo da previsão de início |
expectedEnd - DateRange
|
Intervalo de tempo da previsão de fim |
updatedAt - DateRange
|
Intervalo de data da última atualização |
costCenters - [String!]
|
Códigos identificadores de centros de custo |
customers - [String!]
|
Códigos identificadores de clientes |
equipmentOwnersType - [EquipmentOwnerType!]
|
Tipos de proprietário |
groups - [String!]
|
Códigos identificadores de grupos |
equipments - [String!]
|
Códigos identificadores de equipamentos |
tags - [String!]
|
TAGs de equipamentos |
conclusion - FloatRange
|
Intervalo de percentual de conclusão |
finishedAt - DateRange
|
Intervalo de tempo da finalização |
foreseenCost - FloatRange
|
Intervalo de custo previsto |
doneCost - FloatRange
|
Intervalo de custo realizado |
foreseenEmployees - [String!]
|
Códigos identificadores de mãos de obra previstas |
doneEmployees - [String!]
|
Códigos identificadores de mãos de obra realizadas |
foreseenThirdParties - [String!]
|
Códigos identificadores de serviços de terceiros previstos |
doneThirdParties - [String!]
|
Códigos identificadores de serviços de terceiros realizados |
areas - [String!]
|
Códigos identificadores de áreas |
specialties - [String!]
|
Códigos identificadores de especialidade |
maintenances - [String!]
|
Códigos identificadores de manutenções |
code - StringRange
|
Intervalo de códigos de OS |
Example
{
"serials": ["abc123"],
"priorities": ["Emergency"],
"criticalities": ["High"],
"situations": ["Opened"],
"serviceTypes": ["Corrective"],
"expectedStart": DateRange,
"expectedEnd": DateRange,
"updatedAt": DateRange,
"costCenters": ["xyz789"],
"customers": ["xyz789"],
"equipmentOwnersType": ["Own"],
"groups": ["xyz789"],
"equipments": ["xyz789"],
"tags": ["abc123"],
"conclusion": FloatRange,
"finishedAt": DateRange,
"foreseenCost": FloatRange,
"doneCost": FloatRange,
"foreseenEmployees": ["abc123"],
"doneEmployees": ["abc123"],
"foreseenThirdParties": ["abc123"],
"doneThirdParties": ["abc123"],
"areas": ["xyz789"],
"specialties": ["abc123"],
"maintenances": ["xyz789"],
"code": StringRange
}
T
ServiceOrderFollowUp
Fields
| Field Name | Description |
|---|---|
type - PostingType!
|
Tipo de acompanhamento |
user - User!
|
Usuário |
mentioned - String
|
Usuários mencionados |
mentions - [Mentions!]
|
Usuários mencionados |
lastEditedAt - String
|
Data da última edição |
historyComment - [HistoryComment!]
|
Histórico de edição de comentários |
createdAt - DateTime!
|
Data de criação |
id - String!
|
Código identificador |
description - String
|
Descrição |
deletedAt - DateTime
|
Data de exclusão |
branchId - String
|
Código identificador da filial |
action - ServiceOrderAction!
|
Tipo de classificação |
serviceRequestId - String
|
Código identificador da solicitação de serviço |
requesterId - String
|
Código identificador do solicitante da solicitação de serviço |
url - String
|
Url da solicitação de serviço |
Example
{
"type": "Event",
"user": User,
"mentioned": "xyz789",
"mentions": [Mentions],
"lastEditedAt": "abc123",
"historyComment": [HistoryComment],
"createdAt": "2025-10-31T17:55:38.518Z",
"id": "xyz789",
"description": "abc123",
"deletedAt": "2025-05-01T17:55:38.518Z",
"branchId": "abc123",
"action": "Open",
"serviceRequestId": "xyz789",
"requesterId": "xyz789",
"url": "xyz789"
}
T
ServiceOrderIndicators
Fields
| Field Name | Description |
|---|---|
amountBySituation - ServiceOrderAmountBySituation!
|
|
amountByPriority - ServiceOrderAmountByPriority!
|
|
amountByServiceType - ServiceOrderAmountByServiceType!
|
Example
{
"amountBySituation": ServiceOrderAmountBySituation,
"amountByPriority": ServiceOrderAmountByPriority,
"amountByServiceType": ServiceOrderAmountByServiceType
}
T
ServiceOrderOrderByFields
Values
| Enum Value | Description |
|---|---|
|
|
Prioridade |
|
|
Progresso |
|
|
Início previsto |
|
|
Código |
Example
"Priority"
T
ServiceOrderOrderByInput
Fields
| Input Field | Description |
|---|---|
field - ServiceOrderOrderByFields
|
Tipo de ordenação. Default = Priority |
type - OrderBy
|
Tipo de ordem. Default = Descending |
Example
{"field": "Priority", "type": "Ascending"}
T
ServiceOrderPriority
Values
| Enum Value | Description |
|---|---|
|
|
Emergencial |
|
|
Alta |
|
|
Média |
|
|
Baixa |
|
|
Planejada |
Example
"Emergency"
T
ServiceOrderQueryInput
Fields
| Input Field | Description |
|---|---|
identifier - String
|
Texto para pesquisa |
filter - ServiceOrderFilter
|
Filtro |
summaryOrderBy - SummaryOrderBy
|
Tipo de ordenação do filtro |
Example
{
"identifier": "abc123",
"filter": ServiceOrderFilter,
"summaryOrderBy": "Alphabetic"
}
T
ServiceOrderSettings
Example
{"requesterSeeOwnServiceOrder": true, "requiredEquipmentDowntime": true}
T
ServiceOrderSituation
Values
| Enum Value | Description |
|---|---|
|
|
Aberta |
|
|
Cancelada |
|
|
Finalizada |
Example
"Opened"
T
ServiceOrdersQueryDashboardArgs
Fields
| Input Field | Description |
|---|---|
query - ServiceOrderQueryInput!
|
|
orderBy - ServiceOrderOrderByInput
|
Example
{
"query": ServiceOrderQueryInput,
"orderBy": ServiceOrderOrderByInput
}
T
ServiceRequest
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
code - String!
|
Código do serviço na filial |
description - String!
|
Descrição |
isAuto - Boolean!
|
Indica se é uma solicitação de serviço automática |
situation - ServiceRequestSituation!
|
Tipo de situação |
priority - ServiceRequestPriority
|
Tipo de prioridade |
observation - String
|
Observações |
runningTime - String
|
Tempo de execução |
employee - Employee
|
Executor |
reason - Reason
|
Motivo de cancelamento |
equipment - EquipmentDefaults
|
Equipamento |
customer - CustomerPartner
|
Cliente |
serviceOrder - ServiceOrderDefaults
|
Ordem de serviço |
satisfactionSurvey - SatisfactionSurvey
|
Pesquisa de satisfação |
requester - User!
|
Usuário solicitante |
createdAt - DateTime!
|
Data de criação |
stoppedAt - DateTime
|
Data de início da parada do equipamento |
serviceTime - String
|
Tempo de serviço |
runTime - String
|
Tempo de execução |
finishedAt - DateTime
|
Data de finalização |
distributedAt - DateTime
|
Data de distribuição |
canceledAt - DateTime
|
Data de cancelamento |
branchId - String
|
Código identificador da filial |
attachments - [Attachment!]!
|
Anexos |
followUp - [ServiceRequestFollowUp!]!
|
Acompanhamentos |
Example
{
"id": "xyz789",
"code": "xyz789",
"description": "abc123",
"isAuto": false,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "xyz789",
"runningTime": "xyz789",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2025-10-31T17:55:38.518Z",
"stoppedAt": "2025-10-31T17:55:38.518Z",
"serviceTime": "abc123",
"runTime": "abc123",
"finishedAt": "2025-05-01T17:55:38.518Z",
"distributedAt": "2025-05-01T17:55:38.518Z",
"canceledAt": "2025-10-31T17:55:38.518Z",
"branchId": "abc123",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
T
ServiceRequestAction
Values
| Enum Value | Description |
|---|---|
|
|
Comentário de usuário |
|
|
Criação automática por sensor WEG |
|
|
Edição automática por sensor WEG |
|
|
Criação |
|
|
Questionário |
|
|
Distribuição |
|
|
Geração de OS |
|
|
Finalização |
|
|
Finalização por administrador do sistema |
|
|
Finalização automática pela OS gerada |
|
|
Cancelamento |
|
|
Cancelamento automático pela OS gerada |
|
|
Edição |
Example
"Comment"
T
ServiceRequestAmountByPriority
T
ServiceRequestBI
T
ServiceRequestBrowse
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
code - String!
|
Código do serviço na filial |
description - String!
|
Ocorrência |
isAuto - Boolean!
|
Indica se é uma solicitação de serviço automática |
situation - ServiceRequestSituation!
|
Tipo de situação |
priority - ServiceRequestPriority
|
Tipo de prioridade |
observation - String
|
Observações |
runningTime - String
|
Tempo de execução |
stoppedAt - DateTime
|
Data de início da parada do equipamento |
reason - Reason
|
Motivo de cancelamento |
equipment - EquipmentDefaults
|
Equipamento |
serviceOrder - ServiceOrderDefaults
|
Ordem de serviço |
satisfactionSurvey - SatisfactionSurvey
|
Pesquisa de satisfação |
requester - User!
|
Usuário solicitante |
createdAt - DateTime!
|
Data de criação |
serviceTime - String
|
Tempo em análise |
runTime - String
|
Tempo em execução |
employee - Employee
|
Executor |
finishedAt - DateTime
|
Data de finalização |
distributedAt - DateTime
|
Data de distribuição |
canceledAt - DateTime
|
Data de cancelamento |
customer - CustomerPartner
|
Cliente |
branchId - String
|
Código identificador da filial |
attachments - [Attachment!]
|
Anexos |
Example
{
"id": "xyz789",
"code": "xyz789",
"description": "xyz789",
"isAuto": true,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "xyz789",
"runningTime": "abc123",
"stoppedAt": "2025-05-01T17:55:38.518Z",
"reason": Reason,
"equipment": EquipmentDefaults,
"serviceOrder": ServiceOrderDefaults,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2025-05-01T17:55:38.518Z",
"serviceTime": "xyz789",
"runTime": "xyz789",
"employee": Employee,
"finishedAt": "2025-10-31T17:55:38.518Z",
"distributedAt": "2025-10-31T17:55:38.518Z",
"canceledAt": "2025-05-01T17:55:38.518Z",
"customer": CustomerPartner,
"branchId": "abc123",
"attachments": [Attachment]
}
T
ServiceRequestDashboard
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
code - String!
|
|
priority - ServiceRequestPriority
|
|
equipment - EquipmentDefaults
|
|
satisfactionSurvey - SatisfactionSurvey
|
|
serviceTime - String
|
|
runTime - String
|
Example
{
"id": "xyz789",
"code": "xyz789",
"priority": "Emergency",
"equipment": EquipmentDefaults,
"satisfactionSurvey": SatisfactionSurvey,
"serviceTime": "xyz789",
"runTime": "xyz789"
}
T
ServiceRequestFilter
Fields
| Input Field | Description |
|---|---|
serials - [String!]
|
Séries de equipamento |
equipments - [String]
|
Códigos identificadores de equipamentos |
tags - [String!]
|
TAGs de equipamentos |
criticalities - [Scale!]
|
Criticidades |
costCenters - [String!]
|
Códigos identificadores de centros de custo |
situations - [ServiceRequestSituation!]
|
Tipos de situação |
origin - [ServiceRequestOrigin!]
|
Origem da abertura da Solicitação |
customers - [String!]
|
Códigos identificadores de clientes |
equipmentOwnersType - [EquipmentOwnerType!]
|
Tipos de proprietário |
priorities - [ServiceRequestPriority!]
|
Tipos de prioridade |
createdAt - DateRange
|
Intervalo de data de criação |
updatedAt - DateRange
|
Intervalo de data da última atualização |
openedBy - [String!]
|
Códigos identificadores de usuários responsáveis pela abertura |
distributedTo - [String!]
|
Códigos identificadores de executores |
Example
{
"serials": ["xyz789"],
"equipments": ["xyz789"],
"tags": ["abc123"],
"criticalities": ["High"],
"costCenters": ["abc123"],
"situations": ["AwaitingAnalysis"],
"origin": ["ByUser"],
"customers": ["abc123"],
"equipmentOwnersType": ["Own"],
"priorities": ["Emergency"],
"createdAt": DateRange,
"updatedAt": DateRange,
"openedBy": ["xyz789"],
"distributedTo": ["abc123"]
}
T
ServiceRequestFollowUp
Fields
| Field Name | Description |
|---|---|
type - PostingType!
|
Tipo de acompanhamento |
user - User!
|
Usuário |
mentioned - String
|
Usuários mencionados |
mentions - [Mentions!]
|
Usuários mencionados |
lastEditedAt - String
|
Data da última edição |
historyComment - [HistoryComment!]
|
Histórico de edição de comentários |
createdAt - DateTime!
|
Data de criação |
id - String!
|
Código identificador |
description - String
|
Descrição |
deletedAt - DateTime
|
Data de exclusão |
branchId - String
|
Código identificador da filial |
action - ServiceRequestAction!
|
Tipo de classificação |
serviceOrderId - String
|
|
url - String
|
Url da ordem de serviço |
Example
{
"type": "Event",
"user": User,
"mentioned": "abc123",
"mentions": [Mentions],
"lastEditedAt": "xyz789",
"historyComment": [HistoryComment],
"createdAt": "2025-10-31T17:55:38.518Z",
"id": "abc123",
"description": "xyz789",
"deletedAt": "2025-10-31T17:55:38.518Z",
"branchId": "abc123",
"action": "Comment",
"serviceOrderId": "abc123",
"url": "abc123"
}
T
ServiceRequestIndicators
Fields
| Field Name | Description |
|---|---|
meanTimeBySituation - MeanTimeBySituation
|
|
amountByPriority - ServiceRequestAmountByPriority
|
|
answeredSurveys - AnsweredSurveys
|
|
deadLineEvaluations - AnswerAvaliation
|
|
coveringEvaluations - AnswerAvaliation
|
Example
{
"meanTimeBySituation": MeanTimeBySituation,
"amountByPriority": ServiceRequestAmountByPriority,
"answeredSurveys": AnsweredSurveys,
"deadLineEvaluations": AnswerAvaliation,
"coveringEvaluations": AnswerAvaliation
}
T
ServiceRequestOrderByField
Values
| Enum Value | Description |
|---|---|
|
|
Prioridade |
|
|
Data de abertura |
Example
"Priority"
T
ServiceRequestOrderByInput
Fields
| Input Field | Description |
|---|---|
field - ServiceRequestOrderByField
|
Tipo de ordenação. Default = Priority |
type - OrderBy
|
Tipo de ordem. Default = Descending |
Example
{"field": "Priority", "type": "Ascending"}
T
ServiceRequestOrigin
Values
| Enum Value | Description |
|---|---|
|
|
Criação por usuário |
|
|
Criação automática |
Example
"ByUser"
T
ServiceRequestPriority
Values
| Enum Value | Description |
|---|---|
|
|
Emergencial |
|
|
Alta |
|
|
Média |
|
|
Baixa |
Example
"Emergency"
T
ServiceRequestQueryInput
Fields
| Input Field | Description |
|---|---|
identifier - String
|
Texto para pesquisa |
filter - ServiceRequestFilter
|
Filtro |
summaryOrderBy - SummaryOrderBy
|
Tipo de ordenação do filtro |
Example
{
"identifier": "xyz789",
"filter": ServiceRequestFilter,
"summaryOrderBy": "Alphabetic"
}
T
ServiceRequestRef
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
code - String!
|
Código do serviço na filial |
situation - ServiceRequestSituation!
|
Situação |
requesterId - String!
|
Código identificador do usuário solicitante |
Example
{
"id": "abc123",
"code": "xyz789",
"situation": "AwaitingAnalysis",
"requesterId": "xyz789"
}
T
ServiceRequestSituation
Values
| Enum Value | Description |
|---|---|
|
|
Aguardando análise |
|
|
Distribuída |
|
|
Aguardando OS |
|
|
Aguardando resposta à pesquisa de satisfação |
|
|
Finalizada |
|
|
Cancelada |
Example
"AwaitingAnalysis"
T
ServiceRequestsQueryDashboardArgs
Fields
| Input Field | Description |
|---|---|
query - ServiceRequestQueryInput!
|
|
orderBy - ServiceRequestOrderByInput
|
Example
{
"query": ServiceRequestQueryInput,
"orderBy": ServiceRequestOrderByInput
}
T
ServiceType
Values
| Enum Value | Description |
|---|---|
|
|
Corretivo |
|
|
Melhoria |
|
|
Preventivo |
Example
"Corrective"
T
Services
T
ShallowMaintenanceSchedule
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
type - ResourceType!
|
|
employee - WalletEmployee
|
|
specialty - WalletSpecialty
|
|
amount - Float
|
|
resourceId - String!
|
|
maintenance - WalletMaintenance!
|
|
maintenanceDates - [ScheduleDateRange!]!
|
Example
{
"id": "xyz789",
"type": "Area",
"employee": WalletEmployee,
"specialty": WalletSpecialty,
"amount": 123.45,
"resourceId": "xyz789",
"maintenance": WalletMaintenance,
"maintenanceDates": [ScheduleDateRange]
}
T
ShallowMaintenanceWallet
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
type - ResourceType!
|
|
employee - WalletEmployee
|
|
specialty - WalletSpecialty
|
|
amount - Float
|
|
resourceId - String!
|
|
maintenance - WalletMaintenance!
|
|
maintenanceDates - MaintenanceDatesWallet!
|
Example
{
"id": "xyz789",
"type": "Area",
"employee": WalletEmployee,
"specialty": WalletSpecialty,
"amount": 987.65,
"resourceId": "xyz789",
"maintenance": WalletMaintenance,
"maintenanceDates": MaintenanceDatesWallet
}
T
ShallowResourceItem
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
type - ResourceType!
|
Tipo do recurso |
employee - Employee
|
Mão de obra |
specialty - Specialty
|
Especialidade |
startDate - DateTime
|
Data de início da mão de obra prevista |
endDate - DateTime
|
Data de fim da mão de obra prevista |
amount - Float
|
Quantidade prevista |
cost - Float
|
Custo previsto |
startDateDone - DateTime
|
Data de início da mão de obra realizada |
endDateDone - DateTime
|
Data de fim da mão de obra realizada |
amountDone - Float
|
Quantidade realizada |
costDone - Float
|
Custo realizado |
foreseen - Boolean!
|
Indica se o recurso foi previsto |
done - Boolean!
|
Indica se o recurso foi realizado |
parentId - String
|
Código identificador do recurso pai |
purchaseRequestId - String
|
Código da requisição |
serviceOrder - ServiceOrder!
|
Example
{
"id": "abc123",
"type": "Area",
"employee": Employee,
"specialty": Specialty,
"startDate": "2025-05-01T17:55:38.518Z",
"endDate": "2025-10-31T17:55:38.518Z",
"amount": 123.45,
"cost": 123.45,
"startDateDone": "2025-05-01T17:55:38.518Z",
"endDateDone": "2025-10-31T17:55:38.518Z",
"amountDone": 123.45,
"costDone": 987.65,
"foreseen": false,
"done": true,
"parentId": "xyz789",
"purchaseRequestId": "xyz789",
"serviceOrder": ServiceOrder
}
T
Specialty
Example
{
"id": "abc123",
"name": "abc123",
"hourlyWage": 123.45,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": true
}
T
Step
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
isReported - Boolean
|
Indica se a etapa foi reportada em uma ordem de serviço |
averageTime - String
|
Tempo médio de execução |
requestResponse - Boolean!
|
Indica se a etapa requer resposta no reporte de ordem de serviço |
type - StepType
|
Tipo de dado da resposta da etapa |
measurementUnit - MeasurementUnit
|
Unidade de medida da resposta |
isActive - Boolean
|
Status |
referenceId - String
|
|
isInMaintenance - Boolean
|
Indica se a etapa é usada em alguma árvore de recursos |
branchId - String
|
Código identificador da filial |
Example
{
"id": "xyz789",
"description": "xyz789",
"isReported": false,
"averageTime": "abc123",
"requestResponse": true,
"type": "Number",
"measurementUnit": MeasurementUnit,
"isActive": true,
"referenceId": "abc123",
"isInMaintenance": false,
"branchId": "xyz789"
}
T
StepType
Values
| Enum Value | Description |
|---|---|
|
|
Numérico |
Example
"Number"
T
StockLevelOnMaterial
Example
{
"id": "abc123",
"physicalBalance": 123.45,
"amountBooked": 123.45,
"averageCost": 987.65,
"unitCost": 987.65,
"level": 123.45,
"warehouse": Warehouse
}
T
StockMovement
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
materialId - String!
|
|
warehouseId - String!
|
|
type - StockMovementType!
|
|
amount - Float!
|
|
observation - String!
|
|
status - StockMovementStatus!
|
|
amountConfirmed - Float!
|
|
erpId - String
|
|
isActive - Boolean
|
|
ipeDeliveryId - String
|
|
deliverySparePartId - String
|
|
productDeliveryId - String
|
|
historicInfo - Boolean
|
|
branchId - String
|
Example
{
"id": "xyz789",
"materialId": "xyz789",
"warehouseId": "xyz789",
"type": "in",
"amount": 123.45,
"observation": "xyz789",
"status": "done",
"amountConfirmed": 123.45,
"erpId": "abc123",
"isActive": false,
"ipeDeliveryId": "xyz789",
"deliverySparePartId": "abc123",
"productDeliveryId": "xyz789",
"historicInfo": false,
"branchId": "xyz789"
}
T
StockMovementByMaterial
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
materialId - String!
|
|
type - StockMovementType!
|
|
amount - Float!
|
|
observation - String!
|
|
status - StockMovementStatus!
|
|
amountConfirmed - Float!
|
|
movementDate - DateTime
|
|
createdAt - DateTime!
|
|
origin - StockMovementOrigin
|
|
warehouse - Warehouse!
|
|
isInitialEntry - Boolean
|
|
resource - StockMovementResource
|
Example
{
"id": "abc123",
"materialId": "abc123",
"type": "in",
"amount": 123.45,
"observation": "xyz789",
"status": "done",
"amountConfirmed": 987.65,
"movementDate": "2025-05-01T17:55:38.518Z",
"createdAt": "2025-05-01T17:55:38.518Z",
"origin": "Manual",
"warehouse": Warehouse,
"isInitialEntry": true,
"resource": StockMovementResource
}
T
StockMovementOnMaterial
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
type - StockMovementType!
|
|
amount - Float!
|
|
observation - String!
|
|
status - StockMovementStatus!
|
|
amountConfirmed - Float!
|
|
origin - StockMovementOrigin
|
|
createdAt - DateTime!
|
|
movementDate - DateTime
|
|
warehouse - Warehouse!
|
Example
{
"id": "xyz789",
"type": "in",
"amount": 987.65,
"observation": "xyz789",
"status": "done",
"amountConfirmed": 987.65,
"origin": "Manual",
"createdAt": "2025-05-01T17:55:38.518Z",
"movementDate": "2025-05-01T17:55:38.518Z",
"warehouse": Warehouse
}
T
StockMovementOrigin
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Manual"
T
StockMovementResource
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
serviceOrder - StockMovementServiceOrder!
|
Example
{
"id": "xyz789",
"serviceOrder": StockMovementServiceOrder
}
T
StockMovementServiceOrder
Fields
| Field Name | Description |
|---|---|
id - String!
|
Example
{"id": "xyz789"}
T
StockMovementStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"done"
T
StockMovementType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"in"
T
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
T
StringRange
T
Summary
Fields
| Field Name | Description |
|---|---|
totalAmount - Int!
|
|
entries - [SummaryEntry!]!
|
Example
{"totalAmount": 987, "entries": [SummaryEntry]}
T
SummaryEntry
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
title - String!
|
|
type - FilterType!
|
|
options - [SummaryOption!]!
|
Example
{
"name": "xyz789",
"title": "xyz789",
"type": "DateRange",
"options": [SummaryOption]
}
T
SummaryOption
T
SummaryOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
Ordem alfabética |
|
|
Ordem numérica |
Example
"Alphabetic"
T
Supplier
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
name - String!
|
Nome |
isResource - UsingSupplier
|
Used only in mobile, will always return null |
branchId - String
|
Código identificador da filial |
erpId - String
|
Código identificador na integração |
Example
{
"id": "xyz789",
"name": "xyz789",
"isResource": "ServiceOrder",
"branchId": "xyz789",
"erpId": "abc123"
}
T
Table
Fields
| Field Name | Description |
|---|---|
title - String!
|
|
browse - [String!]!
|
|
create - [FieldOptionals!]!
|
|
update - [FieldOptionals!]!
|
|
view - [FieldOptionals!]
|
|
fields - [FieldDTO!]!
|
Example
{
"title": "abc123",
"browse": ["xyz789"],
"create": [FieldOptionals],
"update": [FieldOptionals],
"view": [FieldOptionals],
"fields": [FieldDTO]
}
T
ThirdParty
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
standardCost - Float
|
Custo padrão |
isActive - Boolean
|
Status |
suppliers - [ThirdPartySupplierCost!]
|
Fornecedores do serviço |
isInMaintenance - Boolean
|
Indica se o serviço de terceiro é usado em alguma árvore de recursos |
branchId - String
|
Código identificador da filial |
Example
{
"id": "xyz789",
"description": "abc123",
"standardCost": 987.65,
"isActive": true,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": true,
"branchId": "xyz789"
}
T
ThirdPartySupplierCost
Example
{
"id": "abc123",
"name": "abc123",
"isResource": "ServiceOrder",
"branchId": "abc123",
"erpId": "abc123",
"cost": 123.45
}
T
ThirdPartyTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
thirdParty - ThirdParty!
|
Serviço de terceiro |
supplier - Supplier
|
Fornecedor do serviço |
type - ResourceType!
|
Tipo do recurso |
foreseen - Boolean!
|
Indica se o recurso foi previsto |
done - Boolean!
|
Indica se o recurso foi realizado |
cost - Float
|
Custo previsto |
costDone - Float
|
Custo realizado |
parentId - String
|
Código identificador do recurso pai |
Example
{
"id": "abc123",
"thirdParty": ThirdParty,
"supplier": Supplier,
"type": "Area",
"foreseen": true,
"done": false,
"cost": 123.45,
"costDone": 123.45,
"parentId": "xyz789"
}
T
TimePoint
Fields
| Field Name | Description |
|---|---|
day - DayOfWeek!
|
Dia da semana |
hour - String!
|
Hora do dia |
Example
{"day": "Sunday", "hour": "abc123"}
T
TimeUnitType
Values
| Enum Value | Description |
|---|---|
|
|
Dia |
|
|
Mês |
|
|
Ano |
Example
"Day"
T
Tool
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
hourlyCost - Float!
|
Custo por hora |
isActive - Boolean
|
Status |
referenceId - String
|
|
isInMaintenance - Boolean
|
Indica se a ferramenta é usada em alguma árvore de recursos |
branchId - String
|
Código identificador da filial |
Example
{
"id": "abc123",
"description": "xyz789",
"hourlyCost": 123.45,
"isActive": false,
"referenceId": "abc123",
"isInMaintenance": false,
"branchId": "abc123"
}
T
TotvsModaClassification
T
TotvsModaEndpointSettings
Fields
| Field Name | Description |
|---|---|
integrationTotvsModa - Boolean!
|
Habilitar integração com Totvs Moda |
supplierType - String!
|
Tipo de fornecedor |
supplierClassifications - [String!]!
|
Classificações do tipo de fornecedor |
productType - String!
|
Tipo de material |
productClassifications - [String!]!
|
Classificações do tipo de material |
cost - Float!
|
Código de custo do material |
purposeCode - Float!
|
Código da finalidade |
expenseCode - Float
|
Código de despesa |
requester - Float!
|
Código do usuário da requisição |
Example
{
"integrationTotvsModa": false,
"supplierType": "abc123",
"supplierClassifications": ["abc123"],
"productType": "abc123",
"productClassifications": ["abc123"],
"cost": 123.45,
"purposeCode": 987.65,
"expenseCode": 987.65,
"requester": 123.45
}
T
User
Fields
| Field Name | Description |
|---|---|
documentNumber - String
|
Número de documento fiscal |
birthDate - String
|
Data de nascimento |
address - String
|
Endereço |
educationLevel - EducationLevel
|
Nível de instrução |
gender - UserGender
|
Gênero |
mobileTourView - Boolean
|
Indica se o usuário já visualizou o tour pelo aplicativo móvel |
id - ID!
|
Código identificador |
name - String!
|
Nome |
email - String!
|
|
accessBy - AccessBy!
|
Forma de acesso ao sistema |
employees - [Employee!]!
|
Funcionários vinculados |
verifiedEmail - String
|
E-mail verificado |
profilePicture - S3UrlCloudFront
|
URL da foto de perfil |
restrictedBy - String
|
Código identificador da organização vinculada |
preferences - UserPreferences
|
Preferências |
policiesAgreement - [PolicyAgreement!]
|
Termos de uso e política de privacidade |
roles - [Role!]!
|
Perfil |
customer - CustomerPartner
|
Cliente parceiro vinculado |
Example
{
"documentNumber": "xyz789",
"birthDate": "abc123",
"address": "xyz789",
"educationLevel": "ElementarySchool",
"gender": "Male",
"mobileTourView": false,
"id": 4,
"name": "xyz789",
"email": "xyz789",
"accessBy": "Internal",
"employees": [Employee],
"verifiedEmail": "abc123",
"profilePicture": S3UrlCloudFront,
"restrictedBy": "abc123",
"preferences": UserPreferences,
"policiesAgreement": [PolicyAgreement],
"roles": [Role],
"customer": CustomerPartner
}
T
UserBasicInfo
Fields
| Field Name | Description |
|---|---|
documentNumber - String
|
Número de documento fiscal |
birthDate - String
|
Data de nascimento |
address - String
|
Endereço |
educationLevel - EducationLevel
|
Nível de instrução |
gender - UserGender
|
Gênero |
mobileTourView - Boolean
|
Indica se o usuário já visualizou o tour pelo aplicativo móvel |
id - ID!
|
Código identificador |
name - String!
|
Nome |
email - String!
|
|
accessBy - AccessBy!
|
Forma de acesso ao sistema |
employees - [Employee!]!
|
Funcionários vinculados |
verifiedEmail - String
|
E-mail verificado |
profilePicture - S3UrlCloudFront
|
URL da foto de perfil |
restrictedBy - String
|
Código identificador da organização vinculada |
preferences - UserPreferences
|
Preferências |
policiesAgreement - [PolicyAgreement!]
|
Termos de uso e política de privacidade |
Example
{
"documentNumber": "xyz789",
"birthDate": "xyz789",
"address": "abc123",
"educationLevel": "ElementarySchool",
"gender": "Male",
"mobileTourView": true,
"id": 4,
"name": "xyz789",
"email": "xyz789",
"accessBy": "Internal",
"employees": [Employee],
"verifiedEmail": "xyz789",
"profilePicture": S3UrlCloudFront,
"restrictedBy": "xyz789",
"preferences": UserPreferences,
"policiesAgreement": [PolicyAgreement]
}
T
UserGender
Values
| Enum Value | Description |
|---|---|
|
|
Masculino |
|
|
Feminino |
Example
"Male"
T
UserOmie
T
UserOrganizationListing
Fields
| Field Name | Description |
|---|---|
name - String
|
Nome |
id - String
|
Código identificador |
branches - [String!]!
|
Lista dos códigos identificadores das filiais acessíveis |
email - String!
|
|
accessBy - AccessBy
|
Forma de acesso ao sistema |
roleId - String!
|
Perfil na filial da sessão |
status - String!
|
Status do perfil na filial da sessão |
profilePicture - S3UrlCloudFront
|
URL da foto de perfil |
Example
{
"name": "xyz789",
"id": "xyz789",
"branches": ["xyz789"],
"email": "xyz789",
"accessBy": "Internal",
"roleId": "abc123",
"status": "xyz789",
"profilePicture": S3UrlCloudFront
}
T
UserPreferences
Fields
| Field Name | Description |
|---|---|
expandedSidebar - Boolean
|
Indica se o menu lateral deve ser expandido por padrão |
expandedWallet - Boolean
|
Indica se a carteira deve ser expandida por padrão |
showTree - Boolean
|
Indica se visualiza a árvore de equipamentos ou a visão geral |
printTotalCost - Boolean
|
Indica se os custos totais previstos e realizados serão impressos no relatório de OS |
printImages - Boolean
|
Indica se as imagens serão impressas no relatório de OS |
printFollowUp - Boolean
|
Indica se os acompanhamentos serão impressos no relatório de OS |
exportTables - String
|
Tabelas selecionadas para exportação de dados |
Example
{
"expandedSidebar": true,
"expandedWallet": true,
"showTree": true,
"printTotalCost": false,
"printImages": true,
"printFollowUp": false,
"exportTables": "abc123"
}
T
UserWallet
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
profilePicture - S3UrlCloudFront
|
|
roles - [RolesWallet!]!
|
Example
{
"id": "abc123",
"name": "abc123",
"profilePicture": S3UrlCloudFront,
"roles": [RolesWallet]
}
T
UsingSupplier
Values
| Enum Value | Description |
|---|---|
|
|
Ordem de serviço |
|
|
Manutenção |
|
|
Plano mestre |
Example
"ServiceOrder"
T
ValidationReturn
Fields
| Field Name | Description |
|---|---|
available - Boolean!
|
|
version - FeatureVersion!
|
Example
{"available": false, "version": "Stable"}
T
WalletCostCenter
T
WalletCustomer
T
WalletEmployee
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
user - UserWallet!
|
Example
{
"id": "xyz789",
"user": UserWallet
}
T
WalletEquipment
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
tag - String!
|
|
treeTag - String
|
|
classification - EquipmentClassification!
|
|
description - String!
|
|
criticality - Scale
|
|
counterType - CounterType
|
|
dailyVariation - Float
|
|
group - WalletGroup!
|
|
model - WalletModel!
|
|
costCenter - WalletCostCenter!
|
|
customer - WalletCustomer
|
Example
{
"id": "abc123",
"tag": "xyz789",
"treeTag": "abc123",
"classification": "Equipment",
"description": "abc123",
"criticality": "High",
"counterType": "Hours",
"dailyVariation": 987.65,
"group": WalletGroup,
"model": WalletModel,
"costCenter": WalletCostCenter,
"customer": WalletCustomer
}
T
WalletGroup
T
WalletMaintenance
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
description - String!
|
|
lastMaintenance - DateTime!
|
|
lastServiceOrder - DetailServiceOrder
|
|
active - Boolean!
|
|
increaseCounter - Float!
|
|
timeIncrease - Float!
|
|
timeUnit - TimeUnitType!
|
|
skipWeekend - Boolean!
|
|
stopEquipment - Boolean!
|
|
hoursBeforeStop - Float
|
|
hoursAfterStop - Float
|
|
equipment - WalletEquipment!
|
Example
{
"id": "abc123",
"description": "abc123",
"lastMaintenance": "2025-05-01T17:55:38.518Z",
"lastServiceOrder": DetailServiceOrder,
"active": false,
"increaseCounter": 987.65,
"timeIncrease": 987.65,
"timeUnit": "Day",
"skipWeekend": false,
"stopEquipment": true,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 987.65,
"equipment": WalletEquipment
}
T
WalletModel
T
WalletSpecialty
T
Warehouse
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do local de estoque |
description - String!
|
Descrição do local de estoque |
isActive - Boolean!
|
Status |
branchId - String
|
Código identificador da filial |
erpId - String
|
Código identificador na integração |
level - String
|
Saldo do material no local de estoque |
Example
{
"id": "xyz789",
"description": "abc123",
"isActive": true,
"branchId": "xyz789",
"erpId": "xyz789",
"level": "xyz789"
}
T
WarehouseQueryInput
Fields
| Input Field | Description |
|---|---|
materialId - String
|
Código identificador do material |
warehouseId - String
|
Código identificador do material |
identifier - String
|
Pesquisa por nome ou descrição |
isActive - Boolean
|
Pesquisa registros ativos ou inativos |
branchId - String
|
Código identificador da filial |
isStockLevel - Boolean
|
Indica se é a visão de nível de estoque. Default = false |
ignoreIds - [String!]
|
Códigos identificadores que não devem ser buscados |
Example
{
"materialId": "xyz789",
"warehouseId": "abc123",
"identifier": "abc123",
"isActive": false,
"branchId": "xyz789",
"isStockLevel": true,
"ignoreIds": ["abc123"]
}
T
WorkShift
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
calendarId - String!
|
Código identificador do calendário vinculado |
start - TimePoint!
|
Início |
end - TimePoint!
|
Fim |
Example
{
"id": "abc123",
"calendarId": "abc123",
"start": TimePoint,
"end": TimePoint
}