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
anonymizedAt
attachments {
...AttachmentFragment
}
branch {
...BranchFragment
}
users {
...UserOrganizationListingFragment
}
agreements {
...CustomerAgreementFragment
}
id
type
name
isActive
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"activeCustomers": {
"items": [CustomerPartner],
"hasMore": true
}
}
}
Q
area
Description
Retorna uma área
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": true,
"referenceId": "xyz789",
"isInMaintenance": true,
"branchId": "abc123"
}
}
}
Q
areas
Description
Retorna áreas
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": false}}}
Q
calendar
Description
Retorna um calendário
Example
Query
query Calendar($id: String!) {
calendar(id: $id) {
id
name
isActive
workShifts {
id
calendarId
start {
...TimePointFragment
}
end {
...TimePointFragment
}
}
referenceId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"calendar": {
"id": "abc123",
"name": "abc123",
"isActive": false,
"workShifts": [WorkShift],
"referenceId": "xyz789"
}
}
}
Q
calendars
Description
Retorna calendários
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": true}
}
}
Q
costCenter
Description
Retorna um centro de custo
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": "xyz789"}
Response
{
"data": {
"costCenter": {
"id": "xyz789",
"description": "xyz789",
"isActive": true,
"referenceId": "xyz789",
"branchId": "xyz789",
"erpId": "abc123"
}
}
}
Q
costCenters
Description
Retorna centros de custo
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
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
anonymizedAt
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
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
attachments {
...AttachmentFragment
}
}
id
type
name
isActive
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"customer": {
"documentNumber": "abc123",
"daytimePhoneNumber": "xyz789",
"phoneNumber": "xyz789",
"email": "abc123",
"address": "abc123",
"number": "abc123",
"complement": "abc123",
"zipCode": "xyz789",
"neighborhood": "xyz789",
"city": "xyz789",
"state": "abc123",
"country": "xyz789",
"description": "xyz789",
"customerPicture": S3UrlCloudFront,
"customerPictureKey": "abc123",
"anonymizedAt": "2026-09-18T17:42:23.846Z",
"attachments": [Attachment],
"branch": Branch,
"users": [UserOrganizationListing],
"agreements": [CustomerAgreement],
"id": "abc123",
"type": "IndividualPerson",
"name": "xyz789",
"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
anonymizedAt
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
Description
Retorna um funcionário
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": "abc123"}
Response
{
"data": {
"employee": {
"id": "abc123",
"user": User,
"hourlyWage": 987.65,
"startDate": "abc123",
"endDate": "abc123",
"isActive": false,
"calendar": Calendar,
"specialties": [Specialty]
}
}
}
Q
employees
Description
Retorna funcionários
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": true
}
}
}
Q
equipment
Description
Retorna um equipamento
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
branchId
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
createdAt
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"equipment": {
"isInTree": true,
"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": "abc123",
"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": S3UrlCloudFront,
"availability": 123.45,
"tagDescription": "abc123",
"equipmentsStructure": [EquipmentStructure],
"maintenances": [MaintenanceOnEquipment],
"isLastPositionDifferent": false,
"createdAt": "2026-03-18T17:42:23.846Z"
}
}
}
Q
equipmentIndicators
Description
Retorna todos os indicadores
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": "abc123"
}
}
}
Q
equipments
Description
Retorna equipamentos
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
previousTags
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": true
}
}
}
Q
feature
Description
Retorna uma característica
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": true,
"branchId": "xyz789"
}
}
}
Q
features
Description
Retorna características
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": 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
group
Description
Retorna um grupo
Example
Query
query Group($id: String!) {
group(id: $id) {
id
name
isActive
referenceId
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"group": {
"id": "xyz789",
"name": "abc123",
"isActive": true,
"referenceId": "xyz789",
"branchId": "xyz789"
}
}
}
Q
groups
Description
Retorna grupos
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
indicatorSummary
Description
Retorna indicadores resumidos por filial
Response
Returns [BasicIndicator!]!
Example
Query
query IndicatorSummary {
indicatorSummary {
label
result
branchId
}
}
Response
{
"data": {
"indicatorSummary": [
{
"label": "abc123",
"result": 123.45,
"branchId": "xyz789"
}
]
}
}
Q
manufacturer
Description
Retorna um fabricante
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": "xyz789"}
Response
{
"data": {
"manufacturer": {
"id": "abc123",
"description": "xyz789",
"isActive": true,
"referenceId": "xyz789",
"branchId": "abc123"
}
}
}
Q
manufacturers
Description
Retorna fabricantes
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
masterPlan
Description
Retorna um plano mestre
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": "xyz789"}
Response
{
"data": {
"masterPlan": {
"id": "xyz789",
"description": "xyz789",
"maintenanceTime": MasterPlanTime,
"skipWeekend": true,
"stopEquipment": false,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 987.65,
"maintenanceCounter": MasterPlanCounter,
"isImported": true,
"model": Model,
"group": Group,
"branchId": "abc123",
"resources": [MasterPlanResource]
}
}
}
Q
masterPlans
Description
Retorna planos mestre
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": false
}
}
}
Q
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
minimumBalance
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": "abc123",
"measurementUnit": NewMeasurementUnit,
"warehouse": Warehouse,
"isInMaintenance": true,
"branchId": "abc123",
"erpId": "xyz789",
"stockLevels": [StockLevelOnMaterial],
"stockMovements": [StockMovementOnMaterial],
"isIntegrated": true
}
}
}
Q
materials
Description
Retorna materiais
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
measurementUnit
Description
Retorna uma unidade de medida
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": "xyz789",
"acronym": "xyz789",
"isActive": false,
"branchId": "abc123",
"erpId": "abc123",
"description": "xyz789",
"symbol": "abc123"
}
}
}
Q
measurementUnits
Description
Retorna as unidades de medida
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": true
}
}
}
Q
model
Description
Retorna um modelo de equipamento
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": "abc123",
"description": "abc123",
"isActive": true,
"referenceId": "abc123",
"manufacturer": Manufacturer,
"branchId": "abc123"
}
}
}
Q
models
Description
Retorna modelos de equipamentos
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
reason
Description
Retorna um motivo de cancelamento ou inativação
Example
Query
query Reason($id: String!) {
reason(id: $id) {
id
description
type
isActive
referenceId
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"reason": {
"id": "abc123",
"description": "abc123",
"type": "Delay",
"isActive": true,
"referenceId": "xyz789",
"branchId": "abc123"
}
}
}
Q
reasons
Description
Retorna motivos de cancelamento ou inativação
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
branchId
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"reasons": {"items": [Reason], "hasMore": true}
}
}
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
}
}
serviceOrdersToSchedule {
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
{"schedule": QuerySchedule}
Response
{
"data": {
"scheduleByPeriod": {
"scheduledResources": [ShallowResourceItem],
"resourcesToSchedule": [ShallowResourceItem],
"scheduledMaintenances": [
ShallowMaintenanceSchedule
],
"maintenancesToSchedule": [
ShallowMaintenanceSchedule
],
"serviceOrdersToSchedule": [ServiceOrder]
}
}
}
Q
serviceOrder
Description
Retorna uma ordem de serviço
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
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": true,
"keepMaterial": false,
"id": "abc123"
}
Response
{
"data": {
"serviceOrder": {
"id": "xyz789",
"code": "abc123",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2026-03-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "abc123",
"priority": 987.65,
"realStartDate": "2026-03-18T17:42:23.846Z",
"realEndDate": "2026-09-18T17:42:23.846Z",
"conclusion": 123.45,
"doneCost": 987.65,
"foreseenCost": 123.45,
"createdAt": "2026-09-18T17:42:23.846Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2026-03-18T17:42:23.846Z",
"resumedAt": "2026-03-18T17:42:23.846Z",
"foreseenStoppedAt": "2026-09-18T17:42:23.846Z",
"foreseenResumedAt": "2026-03-18T17:42:23.846Z",
"updatedAt": "2026-03-18T17:42:23.846Z",
"operationTime": 123.45,
"hasDoneResource": true,
"hasDoneHuman": false,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": false,
"hasMaintenceByCounter": true,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "xyz789",
"cancellationObservation": "xyz789",
"counter": Counter,
"foreseenEmployeeCost": 123.45,
"doneEmployeeCost": 123.45,
"foreseenToolCost": 123.45,
"doneToolCost": 123.45,
"foreseenMaterialCost": 987.65,
"foreseenProductCost": 123.45,
"doneMaterialCost": 123.45,
"doneProductCost": 987.65,
"foreseenThirdPartyCost": 123.45,
"doneThirdPartyCost": 123.45,
"branchId": "abc123"
}
}
}
Q
serviceOrders
Description
Retorna ordens de serviço
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 |
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": ServiceOrderOrderByInput,
"omitMultimedia": true
}
Response
{
"data": {
"serviceOrders": {
"items": [ServiceOrder],
"hasMore": true
}
}
}
Q
serviceOrdersHome
Description
Retorna ordens de serviço
Response
Returns [ServiceOrderHome!]!
Example
Query
query ServiceOrdersHome {
serviceOrdersHome {
id
code
situation
startDate
equipment {
id
description
tag
tagDescription
isStarter
}
conclusion
doneCost
foreseenCost
priority
branchId
}
}
Response
{
"data": {
"serviceOrdersHome": [
{
"id": "abc123",
"code": "xyz789",
"situation": "Opened",
"startDate": "2026-03-18T17:42:23.846Z",
"equipment": EquipmentBasicInfo,
"conclusion": 123.45,
"doneCost": 123.45,
"foreseenCost": 987.65,
"priority": 987.65,
"branchId": "abc123"
}
]
}
}
Q
serviceRequest
Description
Retorna uma solicitação de serviço
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
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
anonymizedAt
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
}
generatedServiceOrder
linkedServiceOrder
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": false, "id": "abc123"}
Response
{
"data": {
"serviceRequest": {
"id": "xyz789",
"code": "xyz789",
"description": "xyz789",
"isAuto": false,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "abc123",
"runningTime": "abc123",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"generatedServiceOrder": true,
"linkedServiceOrder": false,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-09-18T17:42:23.846Z",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"serviceTime": "abc123",
"runTime": "abc123",
"finishedAt": "2026-09-18T17:42:23.846Z",
"distributedAt": "2026-09-18T17:42:23.846Z",
"canceledAt": "2026-09-18T17:42:23.846Z",
"branchId": "abc123",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
}
}
Q
serviceRequests
Description
Retorna solicitações de serviço
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 |
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
}
generatedServiceOrder
linkedServiceOrder
satisfactionSurvey {
...SatisfactionSurveyFragment
}
requester {
...UserFragment
}
createdAt
serviceTime
runTime
employee {
...EmployeeFragment
}
finishedAt
distributedAt
canceledAt
customer {
...CustomerPartnerFragment
}
branchId
attachments {
...AttachmentFragment
}
}
hasMore
}
}
Variables
{
"pagination": Pagination,
"query": ServiceRequestQueryInput,
"orderBy": ServiceRequestOrderByInput,
"omitMultimedia": true
}
Response
{
"data": {
"serviceRequests": {
"items": [ServiceRequestBrowse],
"hasMore": true
}
}
}
Q
specialties
Description
Retorna especialidades
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": true}
}
}
Q
specialty
Description
Retorna uma especialidade
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": "abc123",
"hourlyWage": 987.65,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": true
}
}
}
Q
step
Description
Retorna uma etapa
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": "xyz789",
"id": "xyz789"
}
Response
{
"data": {
"step": {
"id": "xyz789",
"description": "xyz789",
"isReported": true,
"averageTime": "xyz789",
"requestResponse": true,
"type": "Number",
"measurementUnit": MeasurementUnit,
"isActive": true,
"referenceId": "xyz789",
"isInMaintenance": true,
"branchId": "xyz789"
}
}
}
Q
steps
Description
Retorna etapas
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": true}}}
Q
supplier
Description
Retorna um fornecedor
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": "xyz789",
"isResource": "ServiceOrder",
"branchId": "xyz789",
"erpId": "xyz789"
}
}
}
Q
suppliers
Description
Retorna fornecedores de serviços de terceiros
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": "xyz789",
"pagination": Pagination,
"query": PaginationDefaultQueryInput
}
Response
{
"data": {
"suppliers": {"items": [Supplier], "hasMore": true}
}
}
Q
thirdParties
Description
Retorna serviços de terceiros
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
Description
Retorna um serviço de terceiro
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": "xyz789",
"description": "abc123",
"standardCost": 987.65,
"isActive": false,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": true,
"branchId": "xyz789"
}
}
}
Q
tool
Description
Retorna uma ferramenta
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": "xyz789",
"id": "abc123"
}
Response
{
"data": {
"tool": {
"id": "abc123",
"description": "xyz789",
"hourlyCost": 987.65,
"isActive": true,
"referenceId": "abc123",
"isInMaintenance": true,
"branchId": "abc123"
}
}
}
Q
tools
Description
Retorna ferramentas
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
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
}
}
serviceOrdersToSchedule {
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
{
"endDate": "2026-09-18T17:42:23.846Z",
"startDate": "2026-09-18T17:42:23.846Z",
"identifier": "xyz789",
"filter": ScheduleFilter
}
Response
{
"data": {
"wallet": {
"resourceItems": [ShallowResourceItem],
"maintenanceResourceItems": [
ShallowMaintenanceWallet
],
"serviceOrdersToSchedule": [ServiceOrder],
"hasMore": false
}
}
}
Q
warehouse
Description
Retorna um local de estoque
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": "xyz789",
"isActive": true,
"branchId": "xyz789",
"erpId": "abc123",
"level": "abc123"
}
}
}
Q
warehouses
Description
Retorna os locais de estoque
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": false}
}
}
Operations
Mutations
M
cancelServiceOrder
Response
Returns a ServiceOrder!
Arguments
| Name | Description |
|---|---|
serviceOrder - CancelServiceOrder!
|
Example
Query
mutation CancelServiceOrder($serviceOrder: CancelServiceOrder!) {
cancelServiceOrder(serviceOrder: $serviceOrder) {
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
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
{"serviceOrder": CancelServiceOrder}
Response
{
"data": {
"cancelServiceOrder": {
"id": "abc123",
"code": "abc123",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2026-03-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "abc123",
"priority": 123.45,
"realStartDate": "2026-03-18T17:42:23.846Z",
"realEndDate": "2026-03-18T17:42:23.846Z",
"conclusion": 123.45,
"doneCost": 123.45,
"foreseenCost": 123.45,
"createdAt": "2026-03-18T17:42:23.846Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2026-09-18T17:42:23.846Z",
"resumedAt": "2026-09-18T17:42:23.846Z",
"foreseenStoppedAt": "2026-03-18T17:42:23.846Z",
"foreseenResumedAt": "2026-03-18T17:42:23.846Z",
"updatedAt": "2026-09-18T17:42:23.846Z",
"operationTime": 987.65,
"hasDoneResource": false,
"hasDoneHuman": true,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": true,
"hasMaintenceByCounter": false,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "abc123",
"cancellationObservation": "xyz789",
"counter": Counter,
"foreseenEmployeeCost": 987.65,
"doneEmployeeCost": 987.65,
"foreseenToolCost": 123.45,
"doneToolCost": 987.65,
"foreseenMaterialCost": 987.65,
"foreseenProductCost": 987.65,
"doneMaterialCost": 123.45,
"doneProductCost": 987.65,
"foreseenThirdPartyCost": 987.65,
"doneThirdPartyCost": 123.45,
"branchId": "xyz789"
}
}
}
Example
mutation cancelServiceOrderExample {
cancelServiceOrder(serviceOrder: { cancellationReason: "example", cancellationObservation: "example", id: "example" }) {
id
code
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
service
situation
startDate
endDate
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
maintenance {
id
description
lastMaintenance
active
increaseCounter
timeIncrease
timeUnit
stopEquipment
hoursBeforeStop
hoursAfterStop
}
cancellationReasonRef {
id
description
type
isActive
referenceId
branchId
}
costCenterRef {
id
description
isActive
referenceId
branchId
erpId
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
id
foreseen
done
}
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
mentioned
lastEditedAt
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
dailyVariation
branchId
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
}
M
cancelServiceRequest
Response
Returns a ServiceRequest!
Arguments
| Name | Description |
|---|---|
serviceRequest - ServiceRequestCancellation!
|
Example
Query
mutation CancelServiceRequest($serviceRequest: ServiceRequestCancellation!) {
cancelServiceRequest(serviceRequest: $serviceRequest) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
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
anonymizedAt
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
}
generatedServiceOrder
linkedServiceOrder
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
{"serviceRequest": ServiceRequestCancellation}
Response
{
"data": {
"cancelServiceRequest": {
"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,
"generatedServiceOrder": true,
"linkedServiceOrder": true,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-09-18T17:42:23.846Z",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"serviceTime": "abc123",
"runTime": "xyz789",
"finishedAt": "2026-03-18T17:42:23.846Z",
"distributedAt": "2026-09-18T17:42:23.846Z",
"canceledAt": "2026-09-18T17:42:23.846Z",
"branchId": "xyz789",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
}
}
Example
mutation cancelServiceRequestExample {
cancelServiceRequest(serviceRequest: { cancellationReason: "example", id: "example" }) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
branchId
}
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
id
type
name
isActive
}
serviceOrder {
id
code
service
situation
startDate
endDate
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
}
generatedServiceOrder
linkedServiceOrder
satisfactionSurvey {
id
deadlineEvaluation
coveringEvaluation
observation
}
requester {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
createdAt
stoppedAt
serviceTime
runTime
finishedAt
distributedAt
canceledAt
branchId
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
followUp {
type
mentioned
lastEditedAt
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
}
M
commentServiceOrder
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ServiceOrderCommentInput!
|
Example
Query
mutation CommentServiceOrder($input: ServiceOrderCommentInput!) {
commentServiceOrder(input: $input)
}
Variables
{"input": ServiceOrderCommentInput}
Response
{"data": {"commentServiceOrder": "abc123"}}
Example
mutation commentServiceOrderExample {
commentServiceOrder(input: { comment: "example", serviceOrderId: "example" })
}
M
commentServiceRequest
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ServiceRequestCommentInput!
|
Example
Query
mutation CommentServiceRequest($input: ServiceRequestCommentInput!) {
commentServiceRequest(input: $input)
}
Variables
{"input": ServiceRequestCommentInput}
Response
{
"data": {
"commentServiceRequest": "abc123"
}
}
Example
mutation commentServiceRequestExample {
commentServiceRequest(input: { comment: "example", serviceRequestId: "example" })
}
M
createAccessToken
Description
Criação de token de acesso externo
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": "2026-09-18T17:42:23.846Z",
"deletedAt": "2026-03-18T17:42:23.846Z"
}
}
}
Example
mutation createAccessTokenExample {
createAccessToken {
token
apiAccessId
createdAt
deletedAt
}
}
M
createArea
Response
Returns an Area!
Arguments
| Name | Description |
|---|---|
area - AreaInput!
|
Example
Query
mutation CreateArea($area: AreaInput!) {
createArea(area: $area) {
id
description
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"area": AreaInput}
Response
{
"data": {
"createArea": {
"id": "abc123",
"description": "abc123",
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": true,
"branchId": "abc123"
}
}
}
Example
mutation createAreaExample {
createArea(area: { description: "example" }) {
id
description
isActive
referenceId
isInMaintenance
branchId
}
}
M
createCalendar
Response
Returns a Calendar!
Arguments
| Name | Description |
|---|---|
workShifts - [WorkShiftInput!]!
|
|
name - String!
|
Example
Query
mutation CreateCalendar(
$workShifts: [WorkShiftInput!]!,
$name: String!
) {
createCalendar(
workShifts: $workShifts,
name: $name
) {
id
name
isActive
workShifts {
id
calendarId
start {
...TimePointFragment
}
end {
...TimePointFragment
}
}
referenceId
}
}
Variables
{
"workShifts": [WorkShiftInput],
"name": "abc123"
}
Response
{
"data": {
"createCalendar": {
"id": "xyz789",
"name": "xyz789",
"isActive": false,
"workShifts": [WorkShift],
"referenceId": "xyz789"
}
}
}
Example
mutation createCalendarExample {
createCalendar(workShifts: [{ start: { day: Sunday, hour: "example" }, end: { day: Sunday, hour: "example" } }], name: "example") {
id
name
isActive
workShifts {
id
calendarId
}
referenceId
}
}
M
createCostCenter
Response
Returns a CostCenter!
Arguments
| Name | Description |
|---|---|
costCenter - CostCenterInput!
|
Example
Query
mutation CreateCostCenter($costCenter: CostCenterInput!) {
createCostCenter(costCenter: $costCenter) {
id
description
isActive
referenceId
branchId
erpId
}
}
Variables
{"costCenter": CostCenterInput}
Response
{
"data": {
"createCostCenter": {
"id": "xyz789",
"description": "abc123",
"isActive": false,
"referenceId": "xyz789",
"branchId": "abc123",
"erpId": "xyz789"
}
}
}
Example
mutation createCostCenterExample {
createCostCenter(costCenter: { description: "example" }) {
id
description
isActive
referenceId
branchId
erpId
}
}
M
createCustomerPartner
Response
Returns a CustomerPartner!
Arguments
| Name | Description |
|---|---|
customer - CustomerCreationInput!
|
Example
Query
mutation CreateCustomerPartner($customer: CustomerCreationInput!) {
createCustomerPartner(customer: $customer) {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
attachments {
...AttachmentFragment
}
}
id
type
name
isActive
}
}
Variables
{"customer": CustomerCreationInput}
Response
{
"data": {
"createCustomerPartner": {
"documentNumber": "abc123",
"daytimePhoneNumber": "xyz789",
"phoneNumber": "xyz789",
"email": "abc123",
"address": "xyz789",
"number": "xyz789",
"complement": "xyz789",
"zipCode": "abc123",
"neighborhood": "abc123",
"city": "abc123",
"state": "xyz789",
"country": "abc123",
"description": "abc123",
"customerPicture": S3UrlCloudFront,
"customerPictureKey": "abc123",
"anonymizedAt": "2026-09-18T17:42:23.846Z",
"attachments": [Attachment],
"branch": Branch,
"users": [UserOrganizationListing],
"agreements": [CustomerAgreement],
"id": "xyz789",
"type": "IndividualPerson",
"name": "abc123",
"isActive": false
}
}
}
Example
mutation createCustomerPartnerExample {
createCustomerPartner(customer: { type: IndividualPerson, name: "example" }) {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
}
users {
name
id
branches
email
accessBy
roleId
status
profilePicture
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
}
id
type
name
isActive
}
}
M
createEmployee
Response
Returns a FullEmployee!
Arguments
| Name | Description |
|---|---|
employee - EmployeeCreationInput!
|
Example
Query
mutation CreateEmployee($employee: EmployeeCreationInput!) {
createEmployee(employee: $employee) {
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
{"employee": EmployeeCreationInput}
Response
{
"data": {
"createEmployee": {
"id": "abc123",
"user": User,
"hourlyWage": 123.45,
"startDate": "xyz789",
"endDate": "xyz789",
"isActive": false,
"calendar": Calendar,
"specialties": [Specialty]
}
}
}
Example
mutation createEmployeeExample {
createEmployee(employee: { specialties: ["example"], userId: "example", calendarId: "example" }) {
id
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
hourlyWage
startDate
endDate
isActive
calendar {
id
name
isActive
referenceId
}
specialties {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
}
M
createEquipment
Response
Returns an EquipmentCreateOutput!
Arguments
| Name | Description |
|---|---|
attachments - [AttachmentUpload!]
|
|
equipment - EquipmentCreateInput!
|
Example
Query
mutation CreateEquipment(
$attachments: [AttachmentUpload!],
$equipment: EquipmentCreateInput!
) {
createEquipment(
attachments: $attachments,
equipment: $equipment
) {
id
description
tag
treeTag
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
}
model {
id
description
}
group {
id
name
}
customer {
id
name
}
}
}
Variables
{
"attachments": [AttachmentUpload],
"equipment": EquipmentCreateInput
}
Response
{
"data": {
"createEquipment": {
"id": "xyz789",
"description": "xyz789",
"tag": "abc123",
"treeTag": "abc123",
"maintenances": [MaintenanceOnEquipment],
"model": BasicInformationDescription,
"group": BasicInformationName,
"customer": BasicInformationName
}
}
}
Example
mutation createEquipmentExample {
createEquipment(attachments: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], equipment: { groupId: "example", costCenterId: "example", modelId: "example", calendarId: "example", description: "example", tag: "example", classification: Equipment, owner: Own, criticality: High }) {
id
description
tag
treeTag
maintenances {
equipmentId
maintenance
active
description
lastMaintenance
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
realNextMaintenanceDate
hasServiceOrder
hasActiveServiceOrder
hasOpenServiceOrder
branchId
}
model {
id
description
}
group {
id
name
}
customer {
id
name
}
}
}
M
createFeature
Response
Returns a Feature!
Arguments
| Name | Description |
|---|---|
feature - FeatureInput!
|
Example
Query
mutation CreateFeature($feature: FeatureInput!) {
createFeature(feature: $feature) {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
}
Variables
{"feature": FeatureInput}
Response
{
"data": {
"createFeature": {
"id": "abc123",
"description": "xyz789",
"type": "String",
"isActive": true,
"referenceId": "abc123",
"isInEquipment": false,
"branchId": "xyz789"
}
}
}
Example
mutation createFeatureExample {
createFeature(feature: { description: "example", type: String }) {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
}
M
createGroup
Response
Returns a Group!
Arguments
| Name | Description |
|---|---|
group - GroupInput!
|
Example
Query
mutation CreateGroup($group: GroupInput!) {
createGroup(group: $group) {
id
name
isActive
referenceId
branchId
}
}
Variables
{"group": GroupInput}
Response
{
"data": {
"createGroup": {
"id": "xyz789",
"name": "abc123",
"isActive": false,
"referenceId": "abc123",
"branchId": "xyz789"
}
}
}
Example
mutation createGroupExample {
createGroup(group: { name: "example" }) {
id
name
isActive
referenceId
branchId
}
}
M
createManufacturer
Response
Returns a Manufacturer!
Arguments
| Name | Description |
|---|---|
manufacturer - ManufacturerInput!
|
Example
Query
mutation CreateManufacturer($manufacturer: ManufacturerInput!) {
createManufacturer(manufacturer: $manufacturer) {
id
description
isActive
referenceId
branchId
}
}
Variables
{"manufacturer": ManufacturerInput}
Response
{
"data": {
"createManufacturer": {
"id": "xyz789",
"description": "xyz789",
"isActive": false,
"referenceId": "xyz789",
"branchId": "abc123"
}
}
}
Example
mutation createManufacturerExample {
createManufacturer(manufacturer: { description: "example" }) {
id
description
isActive
referenceId
branchId
}
}
M
createMasterPlan
Response
Returns a MasterPlan!
Arguments
| Name | Description |
|---|---|
masterPlan - CreateMasterPlan!
|
Example
Query
mutation CreateMasterPlan($masterPlan: CreateMasterPlan!) {
createMasterPlan(masterPlan: $masterPlan) {
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
{"masterPlan": CreateMasterPlan}
Response
{
"data": {
"createMasterPlan": {
"id": "xyz789",
"description": "abc123",
"maintenanceTime": MasterPlanTime,
"skipWeekend": true,
"stopEquipment": false,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"maintenanceCounter": MasterPlanCounter,
"isImported": true,
"model": Model,
"group": Group,
"branchId": "xyz789",
"resources": [MasterPlanResource]
}
}
}
Example
mutation createMasterPlanExample {
createMasterPlan(masterPlan: { description: "example", maintenanceTime: { timeIncrement: 1.0, timeUnit: Day, active: true }, maintenanceCounter: { counterIncrement: 1.0, counterUnit: Hours, active: true }, stopEquipment: true, skipWeekend: true, resources: [{ resourceId: "example", type: Area }] }) {
id
description
maintenanceTime {
timeIncrement
timeUnit
active
}
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
maintenanceCounter {
counterIncrement
counterUnit
active
}
isImported
model {
id
description
isActive
referenceId
branchId
}
group {
id
name
isActive
referenceId
branchId
}
branchId
resources {
id
}
}
}
M
createMaterial
Response
Returns a Material!
Arguments
| Name | Description |
|---|---|
material - MaterialInput!
|
Example
Query
mutation CreateMaterial($material: MaterialInput!) {
createMaterial(material: $material) {
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
minimumBalance
warehouse {
...WarehouseFragment
}
}
stockMovements {
id
type
amount
observation
status
amountConfirmed
origin
createdAt
movementDate
warehouse {
...WarehouseFragment
}
}
isIntegrated
}
}
Variables
{"material": MaterialInput}
Response
{
"data": {
"createMaterial": {
"id": "xyz789",
"description": "abc123",
"standardCost": 987.65,
"isActive": false,
"referenceId": "abc123",
"measurementUnit": NewMeasurementUnit,
"warehouse": Warehouse,
"isInMaintenance": true,
"branchId": "abc123",
"erpId": "abc123",
"stockLevels": [StockLevelOnMaterial],
"stockMovements": [StockMovementOnMaterial],
"isIntegrated": false
}
}
}
Example
mutation createMaterialExample {
createMaterial(material: { description: "example", measurementUnitId: "example", standardCost: 1.0 }) {
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
minimumBalance
}
stockMovements {
id
type
amount
observation
status
amountConfirmed
origin
createdAt
movementDate
}
isIntegrated
}
}
M
createMeasurementUnit
Response
Returns a NewMeasurementUnit!
Arguments
| Name | Description |
|---|---|
measurementUnit - MeasurementUnitInput!
|
Example
Query
mutation CreateMeasurementUnit($measurementUnit: MeasurementUnitInput!) {
createMeasurementUnit(measurementUnit: $measurementUnit) {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
}
Variables
{"measurementUnit": MeasurementUnitInput}
Response
{
"data": {
"createMeasurementUnit": {
"id": "abc123",
"name": "xyz789",
"acronym": "xyz789",
"isActive": true,
"branchId": "abc123",
"erpId": "abc123",
"description": "abc123",
"symbol": "abc123"
}
}
}
Example
mutation createMeasurementUnitExample {
createMeasurementUnit(measurementUnit: { name: "example", acronym: "example" }) {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
}
M
createModel
Response
Returns a Model!
Arguments
| Name | Description |
|---|---|
model - ModelInput!
|
Example
Query
mutation CreateModel($model: ModelInput!) {
createModel(model: $model) {
id
description
isActive
referenceId
manufacturer {
id
description
isActive
referenceId
branchId
}
branchId
}
}
Variables
{"model": ModelInput}
Response
{
"data": {
"createModel": {
"id": "xyz789",
"description": "xyz789",
"isActive": true,
"referenceId": "abc123",
"manufacturer": Manufacturer,
"branchId": "abc123"
}
}
}
Example
mutation createModelExample {
createModel(model: { description: "example" }) {
id
description
isActive
referenceId
manufacturer {
id
description
isActive
referenceId
branchId
}
branchId
}
}
M
createReason
Response
Returns a Reason!
Arguments
| Name | Description |
|---|---|
reason - ReasonInput!
|
Example
Query
mutation CreateReason($reason: ReasonInput!) {
createReason(reason: $reason) {
id
description
type
isActive
referenceId
branchId
}
}
Variables
{"reason": ReasonInput}
Response
{
"data": {
"createReason": {
"id": "abc123",
"description": "xyz789",
"type": "Delay",
"isActive": false,
"referenceId": "abc123",
"branchId": "xyz789"
}
}
}
Example
mutation createReasonExample {
createReason(reason: { description: "example", type: Delay }) {
id
description
type
isActive
referenceId
branchId
}
}
M
createServiceOrder
Response
Returns a ServiceOrder!
Arguments
| Name | Description |
|---|---|
attachments - NewBaseAttachmentArgs
|
|
serviceOrder - ServiceOrderInput!
|
Example
Query
mutation CreateServiceOrder(
$attachments: NewBaseAttachmentArgs,
$serviceOrder: ServiceOrderInput!
) {
createServiceOrder(
attachments: $attachments,
serviceOrder: $serviceOrder
) {
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
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
{
"attachments": NewBaseAttachmentArgs,
"serviceOrder": ServiceOrderInput
}
Response
{
"data": {
"createServiceOrder": {
"id": "xyz789",
"code": "abc123",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2026-09-18T17:42:23.846Z",
"endDate": "2026-03-18T17:42:23.846Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "abc123",
"priority": 123.45,
"realStartDate": "2026-09-18T17:42:23.846Z",
"realEndDate": "2026-09-18T17:42:23.846Z",
"conclusion": 123.45,
"doneCost": 987.65,
"foreseenCost": 123.45,
"createdAt": "2026-09-18T17:42:23.846Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2026-03-18T17:42:23.846Z",
"resumedAt": "2026-03-18T17:42:23.846Z",
"foreseenStoppedAt": "2026-03-18T17:42:23.846Z",
"foreseenResumedAt": "2026-03-18T17:42:23.846Z",
"updatedAt": "2026-03-18T17:42:23.846Z",
"operationTime": 987.65,
"hasDoneResource": true,
"hasDoneHuman": false,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": false,
"hasMaintenceByCounter": true,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "abc123",
"cancellationObservation": "xyz789",
"counter": Counter,
"foreseenEmployeeCost": 987.65,
"doneEmployeeCost": 987.65,
"foreseenToolCost": 987.65,
"doneToolCost": 123.45,
"foreseenMaterialCost": 987.65,
"foreseenProductCost": 123.45,
"doneMaterialCost": 123.45,
"doneProductCost": 987.65,
"foreseenThirdPartyCost": 987.65,
"doneThirdPartyCost": 123.45,
"branchId": "abc123"
}
}
}
Example
mutation createServiceOrderExample {
createServiceOrder(attachments: { newAttachments: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], existentAttachments: [{ filename: "example", contentType: "example", contentLength: 1.0, url: "example" }] }, serviceOrder: { equipment: "example", service: Corrective, priority: 1.0, startDate: "example", endDate: "example" }) {
id
code
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
service
situation
startDate
endDate
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
maintenance {
id
description
lastMaintenance
active
increaseCounter
timeIncrease
timeUnit
stopEquipment
hoursBeforeStop
hoursAfterStop
}
cancellationReasonRef {
id
description
type
isActive
referenceId
branchId
}
costCenterRef {
id
description
isActive
referenceId
branchId
erpId
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
id
foreseen
done
}
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
mentioned
lastEditedAt
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
dailyVariation
branchId
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
}
M
createServiceRequest
Response
Returns a ServiceRequest!
Arguments
| Name | Description |
|---|---|
attachments - [AttachmentUpload!]
|
|
serviceRequest - ServiceRequestCreation!
|
Example
Query
mutation CreateServiceRequest(
$attachments: [AttachmentUpload!],
$serviceRequest: ServiceRequestCreation!
) {
createServiceRequest(
attachments: $attachments,
serviceRequest: $serviceRequest
) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
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
anonymizedAt
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
}
generatedServiceOrder
linkedServiceOrder
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
{
"attachments": [AttachmentUpload],
"serviceRequest": ServiceRequestCreation
}
Response
{
"data": {
"createServiceRequest": {
"id": "abc123",
"code": "abc123",
"description": "abc123",
"isAuto": true,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "abc123",
"runningTime": "abc123",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"generatedServiceOrder": true,
"linkedServiceOrder": false,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-03-18T17:42:23.846Z",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"serviceTime": "xyz789",
"runTime": "abc123",
"finishedAt": "2026-09-18T17:42:23.846Z",
"distributedAt": "2026-03-18T17:42:23.846Z",
"canceledAt": "2026-03-18T17:42:23.846Z",
"branchId": "abc123",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
}
}
Example
mutation createServiceRequestExample {
createServiceRequest(attachments: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], serviceRequest: { description: "example" }) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
branchId
}
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
id
type
name
isActive
}
serviceOrder {
id
code
service
situation
startDate
endDate
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
}
generatedServiceOrder
linkedServiceOrder
satisfactionSurvey {
id
deadlineEvaluation
coveringEvaluation
observation
}
requester {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
createdAt
stoppedAt
serviceTime
runTime
finishedAt
distributedAt
canceledAt
branchId
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
followUp {
type
mentioned
lastEditedAt
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
}
M
createSpecialty
Response
Returns a Specialty!
Arguments
| Name | Description |
|---|---|
specialty - SpecialtyInput!
|
Example
Query
mutation CreateSpecialty($specialty: SpecialtyInput!) {
createSpecialty(specialty: $specialty) {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
Variables
{"specialty": SpecialtyInput}
Response
{
"data": {
"createSpecialty": {
"id": "abc123",
"name": "abc123",
"hourlyWage": 987.65,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": true
}
}
}
Example
mutation createSpecialtyExample {
createSpecialty(specialty: { name: "example" }) {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
M
createStarterEquipment
Response
Returns a StarterEquipmentCreateOutput!
Arguments
| Name | Description |
|---|---|
attachments - [AttachmentUpload!]
|
|
equipment - StarterEquipmentCreateInput!
|
Example
Query
mutation CreateStarterEquipment(
$attachments: [AttachmentUpload!],
$equipment: StarterEquipmentCreateInput!
) {
createStarterEquipment(
attachments: $attachments,
equipment: $equipment
) {
id
description
tag
treeTag
customer {
id
name
}
isStarter
}
}
Variables
{
"attachments": [AttachmentUpload],
"equipment": StarterEquipmentCreateInput
}
Response
{
"data": {
"createStarterEquipment": {
"id": "abc123",
"description": "abc123",
"tag": "abc123",
"treeTag": "abc123",
"customer": BasicInformationName,
"isStarter": true
}
}
}
Example
mutation createStarterEquipmentExample {
createStarterEquipment(attachments: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], equipment: { description: "example", owner: Own }) {
id
description
tag
treeTag
customer {
id
name
}
isStarter
}
}
M
createStep
Response
Returns a Step!
Arguments
| Name | Description |
|---|---|
step - StepInput!
|
Example
Query
mutation CreateStep($step: StepInput!) {
createStep(step: $step) {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
id
description
symbol
}
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"step": StepInput}
Response
{
"data": {
"createStep": {
"id": "abc123",
"description": "xyz789",
"isReported": true,
"averageTime": "abc123",
"requestResponse": true,
"type": "Number",
"measurementUnit": MeasurementUnit,
"isActive": false,
"referenceId": "abc123",
"isInMaintenance": false,
"branchId": "abc123"
}
}
}
Example
mutation createStepExample {
createStep(step: { description: "example", requestResponse: true }) {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
id
description
symbol
}
isActive
referenceId
isInMaintenance
branchId
}
}
M
createSupplier
Response
Returns a Supplier!
Arguments
| Name | Description |
|---|---|
supplier - SupplierInput!
|
Example
Query
mutation CreateSupplier($supplier: SupplierInput!) {
createSupplier(supplier: $supplier) {
id
name
isResource
branchId
erpId
}
}
Variables
{"supplier": SupplierInput}
Response
{
"data": {
"createSupplier": {
"id": "xyz789",
"name": "abc123",
"isResource": "ServiceOrder",
"branchId": "xyz789",
"erpId": "xyz789"
}
}
}
Example
mutation createSupplierExample {
createSupplier(supplier: { name: "example" }) {
id
name
isResource
branchId
erpId
}
}
M
createThirdParty
Response
Returns a ThirdParty!
Arguments
| Name | Description |
|---|---|
thirdParty - ThirdPartyInput!
|
Example
Query
mutation CreateThirdParty($thirdParty: ThirdPartyInput!) {
createThirdParty(thirdParty: $thirdParty) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
Variables
{"thirdParty": ThirdPartyInput}
Response
{
"data": {
"createThirdParty": {
"id": "xyz789",
"description": "xyz789",
"standardCost": 987.65,
"isActive": true,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": false,
"branchId": "xyz789"
}
}
}
Example
mutation createThirdPartyExample {
createThirdParty(thirdParty: { description: "example" }) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
M
createTool
Response
Returns a Tool!
Arguments
| Name | Description |
|---|---|
tool - ToolInput!
|
Example
Query
mutation CreateTool($tool: ToolInput!) {
createTool(tool: $tool) {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"tool": ToolInput}
Response
{
"data": {
"createTool": {
"id": "abc123",
"description": "xyz789",
"hourlyCost": 987.65,
"isActive": true,
"referenceId": "xyz789",
"isInMaintenance": false,
"branchId": "xyz789"
}
}
}
Example
mutation createToolExample {
createTool(tool: { description: "example" }) {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
}
M
createWarehouse
Response
Returns a Warehouse!
Arguments
| Name | Description |
|---|---|
warehouse - WarehouseInput!
|
Example
Query
mutation CreateWarehouse($warehouse: WarehouseInput!) {
createWarehouse(warehouse: $warehouse) {
id
description
isActive
branchId
erpId
level
}
}
Variables
{"warehouse": WarehouseInput}
Response
{
"data": {
"createWarehouse": {
"id": "abc123",
"description": "abc123",
"isActive": false,
"branchId": "xyz789",
"erpId": "abc123",
"level": "abc123"
}
}
}
Example
mutation createWarehouseExample {
createWarehouse(warehouse: { description: "example" }) {
id
description
isActive
branchId
erpId
level
}
}
M
distributeServiceRequest
Response
Returns a ServiceRequest!
Arguments
| Name | Description |
|---|---|
serviceRequest - ServiceRequestDistribution!
|
Example
Query
mutation DistributeServiceRequest($serviceRequest: ServiceRequestDistribution!) {
distributeServiceRequest(serviceRequest: $serviceRequest) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
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
anonymizedAt
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
}
generatedServiceOrder
linkedServiceOrder
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
{"serviceRequest": ServiceRequestDistribution}
Response
{
"data": {
"distributeServiceRequest": {
"id": "xyz789",
"code": "abc123",
"description": "abc123",
"isAuto": false,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "xyz789",
"runningTime": "abc123",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"generatedServiceOrder": true,
"linkedServiceOrder": false,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-09-18T17:42:23.846Z",
"stoppedAt": "2026-09-18T17:42:23.846Z",
"serviceTime": "abc123",
"runTime": "abc123",
"finishedAt": "2026-09-18T17:42:23.846Z",
"distributedAt": "2026-09-18T17:42:23.846Z",
"canceledAt": "2026-09-18T17:42:23.846Z",
"branchId": "xyz789",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
}
}
Example
mutation distributeServiceRequestExample {
distributeServiceRequest(serviceRequest: { id: "example" }) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
branchId
}
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
id
type
name
isActive
}
serviceOrder {
id
code
service
situation
startDate
endDate
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
}
generatedServiceOrder
linkedServiceOrder
satisfactionSurvey {
id
deadlineEvaluation
coveringEvaluation
observation
}
requester {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
createdAt
stoppedAt
serviceTime
runTime
finishedAt
distributedAt
canceledAt
branchId
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
followUp {
type
mentioned
lastEditedAt
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
}
M
finalizeServiceRequest
Response
Returns a ServiceRequest!
Arguments
| Name | Description |
|---|---|
serviceRequest - ServiceRequestFinalization!
|
Example
Query
mutation FinalizeServiceRequest($serviceRequest: ServiceRequestFinalization!) {
finalizeServiceRequest(serviceRequest: $serviceRequest) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
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
anonymizedAt
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
}
generatedServiceOrder
linkedServiceOrder
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
{"serviceRequest": ServiceRequestFinalization}
Response
{
"data": {
"finalizeServiceRequest": {
"id": "xyz789",
"code": "abc123",
"description": "xyz789",
"isAuto": false,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "xyz789",
"runningTime": "xyz789",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"generatedServiceOrder": true,
"linkedServiceOrder": true,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-03-18T17:42:23.846Z",
"stoppedAt": "2026-09-18T17:42:23.846Z",
"serviceTime": "xyz789",
"runTime": "xyz789",
"finishedAt": "2026-03-18T17:42:23.846Z",
"distributedAt": "2026-09-18T17:42:23.846Z",
"canceledAt": "2026-03-18T17:42:23.846Z",
"branchId": "abc123",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
}
}
Example
mutation finalizeServiceRequestExample {
finalizeServiceRequest(serviceRequest: { id: "example" }) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
branchId
}
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
id
type
name
isActive
}
serviceOrder {
id
code
service
situation
startDate
endDate
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
}
generatedServiceOrder
linkedServiceOrder
satisfactionSurvey {
id
deadlineEvaluation
coveringEvaluation
observation
}
requester {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
createdAt
stoppedAt
serviceTime
runTime
finishedAt
distributedAt
canceledAt
branchId
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
followUp {
type
mentioned
lastEditedAt
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
}
M
finishServiceOrder
Response
Returns a ServiceOrder!
Arguments
| Name | Description |
|---|---|
serviceOrder - FinishServiceOrder!
|
Example
Query
mutation FinishServiceOrder($serviceOrder: FinishServiceOrder!) {
finishServiceOrder(serviceOrder: $serviceOrder) {
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
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
{"serviceOrder": FinishServiceOrder}
Response
{
"data": {
"finishServiceOrder": {
"id": "xyz789",
"code": "abc123",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2026-09-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "xyz789",
"priority": 123.45,
"realStartDate": "2026-03-18T17:42:23.846Z",
"realEndDate": "2026-03-18T17:42:23.846Z",
"conclusion": 987.65,
"doneCost": 123.45,
"foreseenCost": 987.65,
"createdAt": "2026-03-18T17:42:23.846Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2026-09-18T17:42:23.846Z",
"resumedAt": "2026-09-18T17:42:23.846Z",
"foreseenStoppedAt": "2026-03-18T17:42:23.846Z",
"foreseenResumedAt": "2026-09-18T17:42:23.846Z",
"updatedAt": "2026-09-18T17:42:23.846Z",
"operationTime": 123.45,
"hasDoneResource": false,
"hasDoneHuman": true,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": false,
"hasMaintenceByCounter": true,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "abc123",
"cancellationObservation": "abc123",
"counter": Counter,
"foreseenEmployeeCost": 123.45,
"doneEmployeeCost": 987.65,
"foreseenToolCost": 987.65,
"doneToolCost": 123.45,
"foreseenMaterialCost": 987.65,
"foreseenProductCost": 123.45,
"doneMaterialCost": 987.65,
"doneProductCost": 987.65,
"foreseenThirdPartyCost": 123.45,
"doneThirdPartyCost": 987.65,
"branchId": "xyz789"
}
}
}
Example
mutation finishServiceOrderExample {
finishServiceOrder(serviceOrder: { id: "example" }) {
id
code
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
service
situation
startDate
endDate
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
maintenance {
id
description
lastMaintenance
active
increaseCounter
timeIncrease
timeUnit
stopEquipment
hoursBeforeStop
hoursAfterStop
}
cancellationReasonRef {
id
description
type
isActive
referenceId
branchId
}
costCenterRef {
id
description
isActive
referenceId
branchId
erpId
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
id
foreseen
done
}
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
mentioned
lastEditedAt
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
dailyVariation
branchId
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
}
M
relateSupplier
Response
Returns a ThirdParty!
Arguments
| Name | Description |
|---|---|
thirdParty - ThirdPartySupplierRelationUpdate!
|
Example
Query
mutation RelateSupplier($thirdParty: ThirdPartySupplierRelationUpdate!) {
relateSupplier(thirdParty: $thirdParty) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
Variables
{"thirdParty": ThirdPartySupplierRelationUpdate}
Response
{
"data": {
"relateSupplier": {
"id": "abc123",
"description": "xyz789",
"standardCost": 123.45,
"isActive": true,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": true,
"branchId": "xyz789"
}
}
}
Example
mutation relateSupplierExample {
relateSupplier(thirdParty: { id: "example" }) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
M
removeArea
Example
Query
mutation RemoveArea($id: String!) {
removeArea(id: $id) {
id
description
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"removeArea": {
"id": "xyz789",
"description": "abc123",
"isActive": true,
"referenceId": "abc123",
"isInMaintenance": false,
"branchId": "abc123"
}
}
}
Example
mutation removeAreaExample {
removeArea(id: "example") {
id
description
isActive
referenceId
isInMaintenance
branchId
}
}
M
removeCalendar
Example
Query
mutation RemoveCalendar($id: String!) {
removeCalendar(id: $id) {
id
name
isActive
workShifts {
id
calendarId
start {
...TimePointFragment
}
end {
...TimePointFragment
}
}
referenceId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"removeCalendar": {
"id": "abc123",
"name": "xyz789",
"isActive": false,
"workShifts": [WorkShift],
"referenceId": "xyz789"
}
}
}
Example
mutation removeCalendarExample {
removeCalendar(id: "example") {
id
name
isActive
workShifts {
id
calendarId
}
referenceId
}
}
M
removeCommentServiceOrder
Response
Returns a ServiceOrderFollowUp!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveCommentServiceOrder($id: String!) {
removeCommentServiceOrder(id: $id) {
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
{"id": "abc123"}
Response
{
"data": {
"removeCommentServiceOrder": {
"type": "Event",
"user": User,
"mentioned": "xyz789",
"mentions": [Mentions],
"lastEditedAt": "xyz789",
"historyComment": [HistoryComment],
"createdAt": "2026-09-18T17:42:23.846Z",
"id": "xyz789",
"description": "xyz789",
"deletedAt": "2026-03-18T17:42:23.846Z",
"branchId": "abc123",
"action": "Open",
"serviceRequestId": "abc123",
"requesterId": "abc123",
"url": "xyz789"
}
}
}
Example
mutation removeCommentServiceOrderExample {
removeCommentServiceOrder(id: "example") {
type
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
mentioned
mentions {
id
}
lastEditedAt
historyComment {
comment
mentions
date
}
createdAt
id
description
deletedAt
branchId
action
serviceRequestId
requesterId
url
}
}
M
removeCommentServiceRequest
Response
Returns a ServiceRequestFollowUp!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveCommentServiceRequest($id: String!) {
removeCommentServiceRequest(id: $id) {
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
{"id": "abc123"}
Response
{
"data": {
"removeCommentServiceRequest": {
"type": "Event",
"user": User,
"mentioned": "xyz789",
"mentions": [Mentions],
"lastEditedAt": "xyz789",
"historyComment": [HistoryComment],
"createdAt": "2026-03-18T17:42:23.846Z",
"id": "abc123",
"description": "xyz789",
"deletedAt": "2026-03-18T17:42:23.846Z",
"branchId": "xyz789",
"action": "Comment",
"serviceOrderId": "xyz789",
"url": "xyz789"
}
}
}
Example
mutation removeCommentServiceRequestExample {
removeCommentServiceRequest(id: "example") {
type
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
mentioned
mentions {
id
}
lastEditedAt
historyComment {
comment
mentions
date
}
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
M
removeCostCenter
Response
Returns a CostCenter!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveCostCenter($id: String!) {
removeCostCenter(id: $id) {
id
description
isActive
referenceId
branchId
erpId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeCostCenter": {
"id": "abc123",
"description": "abc123",
"isActive": true,
"referenceId": "xyz789",
"branchId": "xyz789",
"erpId": "xyz789"
}
}
}
Example
mutation removeCostCenterExample {
removeCostCenter(id: "example") {
id
description
isActive
referenceId
branchId
erpId
}
}
M
removeCustomerPartner
Response
Returns a CustomerPartner!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveCustomerPartner($id: String!) {
removeCustomerPartner(id: $id) {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
attachments {
...AttachmentFragment
}
}
id
type
name
isActive
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeCustomerPartner": {
"documentNumber": "abc123",
"daytimePhoneNumber": "xyz789",
"phoneNumber": "xyz789",
"email": "xyz789",
"address": "abc123",
"number": "abc123",
"complement": "xyz789",
"zipCode": "xyz789",
"neighborhood": "abc123",
"city": "xyz789",
"state": "xyz789",
"country": "xyz789",
"description": "xyz789",
"customerPicture": S3UrlCloudFront,
"customerPictureKey": "abc123",
"anonymizedAt": "2026-09-18T17:42:23.846Z",
"attachments": [Attachment],
"branch": Branch,
"users": [UserOrganizationListing],
"agreements": [CustomerAgreement],
"id": "xyz789",
"type": "IndividualPerson",
"name": "abc123",
"isActive": true
}
}
}
Example
mutation removeCustomerPartnerExample {
removeCustomerPartner(id: "example") {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
}
users {
name
id
branches
email
accessBy
roleId
status
profilePicture
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
}
id
type
name
isActive
}
}
M
removeEmployee
Example
Query
mutation RemoveEmployee($id: String!) {
removeEmployee(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
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeEmployee": {
"id": "abc123",
"user": User,
"hourlyWage": 987.65,
"startDate": "xyz789",
"endDate": "xyz789",
"isActive": false
}
}
}
Example
mutation removeEmployeeExample {
removeEmployee(id: "example") {
id
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
hourlyWage
startDate
endDate
isActive
}
}
M
removeEquipment
Response
Returns an EquipmentRemoveOutput!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveEquipment($id: String!) {
removeEquipment(id: $id) {
id
description
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeEquipment": {
"id": "abc123",
"description": "xyz789"
}
}
}
Example
mutation removeEquipmentExample {
removeEquipment(id: "example") {
id
description
}
}
M
removeFeature
Example
Query
mutation RemoveFeature($id: String!) {
removeFeature(id: $id) {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"removeFeature": {
"id": "xyz789",
"description": "abc123",
"type": "String",
"isActive": false,
"referenceId": "abc123",
"isInEquipment": false,
"branchId": "abc123"
}
}
}
Example
mutation removeFeatureExample {
removeFeature(id: "example") {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
}
M
removeGroup
Example
Query
mutation RemoveGroup($id: String!) {
removeGroup(id: $id) {
id
name
isActive
referenceId
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeGroup": {
"id": "xyz789",
"name": "xyz789",
"isActive": false,
"referenceId": "abc123",
"branchId": "abc123"
}
}
}
Example
mutation removeGroupExample {
removeGroup(id: "example") {
id
name
isActive
referenceId
branchId
}
}
M
removeManufacturer
Response
Returns a Manufacturer!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveManufacturer($id: String!) {
removeManufacturer(id: $id) {
id
description
isActive
referenceId
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeManufacturer": {
"id": "xyz789",
"description": "xyz789",
"isActive": false,
"referenceId": "xyz789",
"branchId": "xyz789"
}
}
}
Example
mutation removeManufacturerExample {
removeManufacturer(id: "example") {
id
description
isActive
referenceId
branchId
}
}
M
removeMasterPlan
Response
Returns a MasterPlan!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveMasterPlan($id: String!) {
removeMasterPlan(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": "xyz789"}
Response
{
"data": {
"removeMasterPlan": {
"id": "xyz789",
"description": "abc123",
"maintenanceTime": MasterPlanTime,
"skipWeekend": false,
"stopEquipment": false,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"maintenanceCounter": MasterPlanCounter,
"isImported": true,
"model": Model,
"group": Group,
"branchId": "xyz789",
"resources": [MasterPlanResource]
}
}
}
Example
mutation removeMasterPlanExample {
removeMasterPlan(id: "example") {
id
description
maintenanceTime {
timeIncrement
timeUnit
active
}
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
maintenanceCounter {
counterIncrement
counterUnit
active
}
isImported
model {
id
description
isActive
referenceId
branchId
}
group {
id
name
isActive
referenceId
branchId
}
branchId
resources {
id
}
}
}
M
removeMaterial
Example
Query
mutation RemoveMaterial($id: String!) {
removeMaterial(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
minimumBalance
warehouse {
...WarehouseFragment
}
}
stockMovements {
id
type
amount
observation
status
amountConfirmed
origin
createdAt
movementDate
warehouse {
...WarehouseFragment
}
}
isIntegrated
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeMaterial": {
"id": "abc123",
"description": "xyz789",
"standardCost": 123.45,
"isActive": false,
"referenceId": "xyz789",
"measurementUnit": NewMeasurementUnit,
"warehouse": Warehouse,
"isInMaintenance": false,
"branchId": "xyz789",
"erpId": "abc123",
"stockLevels": [StockLevelOnMaterial],
"stockMovements": [StockMovementOnMaterial],
"isIntegrated": true
}
}
}
Example
mutation removeMaterialExample {
removeMaterial(id: "example") {
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
minimumBalance
}
stockMovements {
id
type
amount
observation
status
amountConfirmed
origin
createdAt
movementDate
}
isIntegrated
}
}
M
removeMeasurementUnit
Response
Returns a NewMeasurementUnit!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveMeasurementUnit($id: String!) {
removeMeasurementUnit(id: $id) {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeMeasurementUnit": {
"id": "abc123",
"name": "xyz789",
"acronym": "xyz789",
"isActive": true,
"branchId": "abc123",
"erpId": "abc123",
"description": "abc123",
"symbol": "xyz789"
}
}
}
Example
mutation removeMeasurementUnitExample {
removeMeasurementUnit(id: "example") {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
}
M
removeModel
Example
Query
mutation RemoveModel($id: String!) {
removeModel(id: $id) {
id
description
isActive
referenceId
manufacturer {
id
description
isActive
referenceId
branchId
}
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"removeModel": {
"id": "xyz789",
"description": "xyz789",
"isActive": false,
"referenceId": "abc123",
"manufacturer": Manufacturer,
"branchId": "xyz789"
}
}
}
Example
mutation removeModelExample {
removeModel(id: "example") {
id
description
isActive
referenceId
manufacturer {
id
description
isActive
referenceId
branchId
}
branchId
}
}
M
removeReason
Example
Query
mutation RemoveReason($id: String!) {
removeReason(id: $id) {
id
description
type
isActive
referenceId
branchId
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"removeReason": {
"id": "xyz789",
"description": "xyz789",
"type": "Delay",
"isActive": true,
"referenceId": "abc123",
"branchId": "abc123"
}
}
}
Example
mutation removeReasonExample {
removeReason(id: "example") {
id
description
type
isActive
referenceId
branchId
}
}
M
removeSpecialty
Response
Returns a Specialty!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveSpecialty($id: String!) {
removeSpecialty(id: $id) {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeSpecialty": {
"id": "abc123",
"name": "abc123",
"hourlyWage": 987.65,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": false
}
}
}
Example
mutation removeSpecialtyExample {
removeSpecialty(id: "example") {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
M
removeStep
Example
Query
mutation RemoveStep($id: String!) {
removeStep(id: $id) {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
id
description
symbol
}
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeStep": {
"id": "xyz789",
"description": "xyz789",
"isReported": false,
"averageTime": "abc123",
"requestResponse": false,
"type": "Number",
"measurementUnit": MeasurementUnit,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": true,
"branchId": "abc123"
}
}
}
Example
mutation removeStepExample {
removeStep(id: "example") {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
id
description
symbol
}
isActive
referenceId
isInMaintenance
branchId
}
}
M
removeSupplier
Example
Query
mutation RemoveSupplier($id: String!) {
removeSupplier(id: $id) {
id
name
isResource
branchId
erpId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeSupplier": {
"id": "abc123",
"name": "abc123",
"isResource": "ServiceOrder",
"branchId": "abc123",
"erpId": "abc123"
}
}
}
Example
mutation removeSupplierExample {
removeSupplier(id: "example") {
id
name
isResource
branchId
erpId
}
}
M
removeThirdParty
Response
Returns a ThirdParty!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveThirdParty($id: String!) {
removeThirdParty(id: $id) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeThirdParty": {
"id": "xyz789",
"description": "abc123",
"standardCost": 987.65,
"isActive": true,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": false,
"branchId": "xyz789"
}
}
}
Example
mutation removeThirdPartyExample {
removeThirdParty(id: "example") {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
M
removeTool
Example
Query
mutation RemoveTool($id: String!) {
removeTool(id: $id) {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"removeTool": {
"id": "xyz789",
"description": "xyz789",
"hourlyCost": 987.65,
"isActive": true,
"referenceId": "xyz789",
"isInMaintenance": true,
"branchId": "xyz789"
}
}
}
Example
mutation removeToolExample {
removeTool(id: "example") {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
}
M
removeWarehouse
Response
Returns a Warehouse!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation RemoveWarehouse($id: String!) {
removeWarehouse(id: $id) {
id
description
isActive
branchId
erpId
level
}
}
Variables
{"id": "abc123"}
Response
{
"data": {
"removeWarehouse": {
"id": "abc123",
"description": "abc123",
"isActive": false,
"branchId": "xyz789",
"erpId": "xyz789",
"level": "xyz789"
}
}
}
Example
mutation removeWarehouseExample {
removeWarehouse(id: "example") {
id
description
isActive
branchId
erpId
level
}
}
M
reportServiceOrder
Response
Returns a ServiceOrder!
Arguments
| Name | Description |
|---|---|
serviceOrder - ServiceOrderReport!
|
Example
Query
mutation ReportServiceOrder($serviceOrder: ServiceOrderReport!) {
reportServiceOrder(serviceOrder: $serviceOrder) {
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
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
{"serviceOrder": ServiceOrderReport}
Response
{
"data": {
"reportServiceOrder": {
"id": "xyz789",
"code": "abc123",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2026-09-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "xyz789",
"priority": 123.45,
"realStartDate": "2026-03-18T17:42:23.846Z",
"realEndDate": "2026-09-18T17:42:23.846Z",
"conclusion": 123.45,
"doneCost": 987.65,
"foreseenCost": 987.65,
"createdAt": "2026-09-18T17:42:23.846Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2026-03-18T17:42:23.846Z",
"resumedAt": "2026-03-18T17:42:23.846Z",
"foreseenStoppedAt": "2026-09-18T17:42:23.846Z",
"foreseenResumedAt": "2026-03-18T17:42:23.846Z",
"updatedAt": "2026-09-18T17:42:23.846Z",
"operationTime": 987.65,
"hasDoneResource": true,
"hasDoneHuman": true,
"hasUnreportedThirdParty": true,
"generatedByServiceRequest": false,
"hasMaintenceByCounter": true,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "abc123",
"cancellationObservation": "abc123",
"counter": Counter,
"foreseenEmployeeCost": 123.45,
"doneEmployeeCost": 987.65,
"foreseenToolCost": 987.65,
"doneToolCost": 987.65,
"foreseenMaterialCost": 987.65,
"foreseenProductCost": 987.65,
"doneMaterialCost": 987.65,
"doneProductCost": 123.45,
"foreseenThirdPartyCost": 987.65,
"doneThirdPartyCost": 987.65,
"branchId": "xyz789"
}
}
}
Example
mutation reportServiceOrderExample {
reportServiceOrder(serviceOrder: { id: "example" }) {
id
code
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
service
situation
startDate
endDate
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
maintenance {
id
description
lastMaintenance
active
increaseCounter
timeIncrease
timeUnit
stopEquipment
hoursBeforeStop
hoursAfterStop
}
cancellationReasonRef {
id
description
type
isActive
referenceId
branchId
}
costCenterRef {
id
description
isActive
referenceId
branchId
erpId
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
id
foreseen
done
}
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
mentioned
lastEditedAt
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
dailyVariation
branchId
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
}
M
satisfactionSurveyServiceRequest
Response
Returns a ServiceRequest!
Arguments
| Name | Description |
|---|---|
attachments - [AttachmentUpload!]
|
|
attachmentIds - [String!]
|
|
serviceRequest - SatisfactionSurveyInput!
|
Example
Query
mutation SatisfactionSurveyServiceRequest(
$attachments: [AttachmentUpload!],
$attachmentIds: [String!],
$serviceRequest: SatisfactionSurveyInput!
) {
satisfactionSurveyServiceRequest(
attachments: $attachments,
attachmentIds: $attachmentIds,
serviceRequest: $serviceRequest
) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
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
anonymizedAt
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
}
generatedServiceOrder
linkedServiceOrder
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
{
"attachments": [AttachmentUpload],
"attachmentIds": ["xyz789"],
"serviceRequest": SatisfactionSurveyInput
}
Response
{
"data": {
"satisfactionSurveyServiceRequest": {
"id": "abc123",
"code": "abc123",
"description": "xyz789",
"isAuto": true,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "abc123",
"runningTime": "abc123",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"generatedServiceOrder": false,
"linkedServiceOrder": false,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-09-18T17:42:23.846Z",
"stoppedAt": "2026-09-18T17:42:23.846Z",
"serviceTime": "xyz789",
"runTime": "abc123",
"finishedAt": "2026-03-18T17:42:23.846Z",
"distributedAt": "2026-03-18T17:42:23.846Z",
"canceledAt": "2026-09-18T17:42:23.846Z",
"branchId": "abc123",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
}
}
Example
mutation satisfactionSurveyServiceRequestExample {
satisfactionSurveyServiceRequest(attachments: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], attachmentIds: ["example"], serviceRequest: { deadlineEvaluation: Great, coveringEvaluation: Great, serviceRequestId: "example" }) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
branchId
}
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
id
type
name
isActive
}
serviceOrder {
id
code
service
situation
startDate
endDate
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
}
generatedServiceOrder
linkedServiceOrder
satisfactionSurvey {
id
deadlineEvaluation
coveringEvaluation
observation
}
requester {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
createdAt
stoppedAt
serviceTime
runTime
finishedAt
distributedAt
canceledAt
branchId
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
followUp {
type
mentioned
lastEditedAt
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
}
M
saveIndicators
M
setCustomerPicture
Response
Returns a CustomerPartner!
Arguments
| Name | Description |
|---|---|
attachment - [AttachmentUpload!]!
|
|
customerId - String!
|
Example
Query
mutation SetCustomerPicture(
$attachment: [AttachmentUpload!]!,
$customerId: String!
) {
setCustomerPicture(
attachment: $attachment,
customerId: $customerId
) {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
attachments {
...AttachmentFragment
}
}
id
type
name
isActive
}
}
Variables
{
"attachment": [AttachmentUpload],
"customerId": "abc123"
}
Response
{
"data": {
"setCustomerPicture": {
"documentNumber": "xyz789",
"daytimePhoneNumber": "xyz789",
"phoneNumber": "xyz789",
"email": "abc123",
"address": "xyz789",
"number": "xyz789",
"complement": "xyz789",
"zipCode": "abc123",
"neighborhood": "abc123",
"city": "xyz789",
"state": "xyz789",
"country": "xyz789",
"description": "abc123",
"customerPicture": S3UrlCloudFront,
"customerPictureKey": "xyz789",
"anonymizedAt": "2026-03-18T17:42:23.846Z",
"attachments": [Attachment],
"branch": Branch,
"users": [UserOrganizationListing],
"agreements": [CustomerAgreement],
"id": "xyz789",
"type": "IndividualPerson",
"name": "xyz789",
"isActive": false
}
}
}
Example
mutation setCustomerPictureExample {
setCustomerPicture(attachment: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], customerId: "example") {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
}
users {
name
id
branches
email
accessBy
roleId
status
profilePicture
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
}
id
type
name
isActive
}
}
M
updateArea
Response
Returns an Area!
Arguments
| Name | Description |
|---|---|
input - AreaUpdate!
|
Example
Query
mutation UpdateArea($input: AreaUpdate!) {
updateArea(input: $input) {
id
description
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"input": AreaUpdate}
Response
{
"data": {
"updateArea": {
"id": "abc123",
"description": "abc123",
"isActive": true,
"referenceId": "abc123",
"isInMaintenance": true,
"branchId": "xyz789"
}
}
}
Example
mutation updateAreaExample {
updateArea(input: { id: "example" }) {
id
description
isActive
referenceId
isInMaintenance
branchId
}
}
M
updateCalendar
Response
Returns a Calendar!
Arguments
| Name | Description |
|---|---|
fields - CalendarUpdate!
|
Example
Query
mutation UpdateCalendar($fields: CalendarUpdate!) {
updateCalendar(fields: $fields) {
id
name
isActive
workShifts {
id
calendarId
start {
...TimePointFragment
}
end {
...TimePointFragment
}
}
referenceId
}
}
Variables
{"fields": CalendarUpdate}
Response
{
"data": {
"updateCalendar": {
"id": "abc123",
"name": "xyz789",
"isActive": true,
"workShifts": [WorkShift],
"referenceId": "xyz789"
}
}
}
Example
mutation updateCalendarExample {
updateCalendar(fields: { id: "example" }) {
id
name
isActive
workShifts {
id
calendarId
}
referenceId
}
}
M
updateCommentServiceOrder
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ServiceOrderCommentUpdate!
|
Example
Query
mutation UpdateCommentServiceOrder($input: ServiceOrderCommentUpdate!) {
updateCommentServiceOrder(input: $input)
}
Variables
{"input": ServiceOrderCommentUpdate}
Response
{
"data": {
"updateCommentServiceOrder": "abc123"
}
}
Example
mutation updateCommentServiceOrderExample {
updateCommentServiceOrder(input: { comment: "example", id: "example" })
}
M
updateCommentServiceRequest
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ServiceRequestCommentUpdate!
|
Example
Query
mutation UpdateCommentServiceRequest($input: ServiceRequestCommentUpdate!) {
updateCommentServiceRequest(input: $input)
}
Variables
{"input": ServiceRequestCommentUpdate}
Response
{
"data": {
"updateCommentServiceRequest": "xyz789"
}
}
Example
mutation updateCommentServiceRequestExample {
updateCommentServiceRequest(input: { comment: "example", id: "example" })
}
M
updateCostCenter
Response
Returns a CostCenter!
Arguments
| Name | Description |
|---|---|
costCenter - CostCenterUpdate!
|
Example
Query
mutation UpdateCostCenter($costCenter: CostCenterUpdate!) {
updateCostCenter(costCenter: $costCenter) {
id
description
isActive
referenceId
branchId
erpId
}
}
Variables
{"costCenter": CostCenterUpdate}
Response
{
"data": {
"updateCostCenter": {
"id": "abc123",
"description": "abc123",
"isActive": true,
"referenceId": "abc123",
"branchId": "xyz789",
"erpId": "xyz789"
}
}
}
Example
mutation updateCostCenterExample {
updateCostCenter(costCenter: { id: "example" }) {
id
description
isActive
referenceId
branchId
erpId
}
}
M
updateCustomerPartner
Response
Returns a CustomerPartner!
Arguments
| Name | Description |
|---|---|
customer - CustomerPartnerUpdateInput!
|
Example
Query
mutation UpdateCustomerPartner($customer: CustomerPartnerUpdateInput!) {
updateCustomerPartner(customer: $customer) {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
attachments {
...AttachmentFragment
}
}
id
type
name
isActive
}
}
Variables
{"customer": CustomerPartnerUpdateInput}
Response
{
"data": {
"updateCustomerPartner": {
"documentNumber": "xyz789",
"daytimePhoneNumber": "xyz789",
"phoneNumber": "xyz789",
"email": "abc123",
"address": "abc123",
"number": "abc123",
"complement": "abc123",
"zipCode": "abc123",
"neighborhood": "xyz789",
"city": "abc123",
"state": "xyz789",
"country": "abc123",
"description": "xyz789",
"customerPicture": S3UrlCloudFront,
"customerPictureKey": "xyz789",
"anonymizedAt": "2026-03-18T17:42:23.846Z",
"attachments": [Attachment],
"branch": Branch,
"users": [UserOrganizationListing],
"agreements": [CustomerAgreement],
"id": "abc123",
"type": "IndividualPerson",
"name": "xyz789",
"isActive": true
}
}
}
Example
mutation updateCustomerPartnerExample {
updateCustomerPartner(customer: { id: "example" }) {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
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
}
users {
name
id
branches
email
accessBy
roleId
status
profilePicture
anonymizedAt
}
agreements {
branchId
id
code
effectiveStartDate
effectiveEndDate
isActive
description
}
id
type
name
isActive
}
}
M
updateEmployee
Response
Returns a FullEmployee!
Arguments
| Name | Description |
|---|---|
employee - EmployeeUpdateInput!
|
Example
Query
mutation UpdateEmployee($employee: EmployeeUpdateInput!) {
updateEmployee(employee: $employee) {
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
{"employee": EmployeeUpdateInput}
Response
{
"data": {
"updateEmployee": {
"id": "abc123",
"user": User,
"hourlyWage": 987.65,
"startDate": "xyz789",
"endDate": "abc123",
"isActive": false,
"calendar": Calendar,
"specialties": [Specialty]
}
}
}
Example
mutation updateEmployeeExample {
updateEmployee(employee: { specialties: ["example"], id: "example" }) {
id
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
hourlyWage
startDate
endDate
isActive
calendar {
id
name
isActive
referenceId
}
specialties {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
}
M
updateEquipment
Response
Returns an EquipmentUpdateOutput!
Arguments
| Name | Description |
|---|---|
attachments - [AttachmentUpload!]
|
|
attachmentIds - [String!]
|
|
equipment - EquipmentUpdateInput!
|
Example
Query
mutation UpdateEquipment(
$attachments: [AttachmentUpload!],
$attachmentIds: [String!],
$equipment: EquipmentUpdateInput!
) {
updateEquipment(
attachments: $attachments,
attachmentIds: $attachmentIds,
equipment: $equipment
) {
id
description
}
}
Variables
{
"attachments": [AttachmentUpload],
"attachmentIds": ["xyz789"],
"equipment": EquipmentUpdateInput
}
Response
{
"data": {
"updateEquipment": {
"id": "abc123",
"description": "abc123"
}
}
}
Example
mutation updateEquipmentExample {
updateEquipment(attachments: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], attachmentIds: ["example"], equipment: { id: "example" }) {
id
description
}
}
M
updateFeature
Response
Returns a Feature!
Arguments
| Name | Description |
|---|---|
feature - FeatureUpdate!
|
Example
Query
mutation UpdateFeature($feature: FeatureUpdate!) {
updateFeature(feature: $feature) {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
}
Variables
{"feature": FeatureUpdate}
Response
{
"data": {
"updateFeature": {
"id": "abc123",
"description": "abc123",
"type": "String",
"isActive": false,
"referenceId": "abc123",
"isInEquipment": false,
"branchId": "xyz789"
}
}
}
Example
mutation updateFeatureExample {
updateFeature(feature: { id: "example" }) {
id
description
type
isActive
referenceId
isInEquipment
branchId
}
}
M
updateGroup
Response
Returns a Group!
Arguments
| Name | Description |
|---|---|
group - GroupUpdate!
|
Example
Query
mutation UpdateGroup($group: GroupUpdate!) {
updateGroup(group: $group) {
id
name
isActive
referenceId
branchId
}
}
Variables
{"group": GroupUpdate}
Response
{
"data": {
"updateGroup": {
"id": "abc123",
"name": "xyz789",
"isActive": false,
"referenceId": "abc123",
"branchId": "xyz789"
}
}
}
Example
mutation updateGroupExample {
updateGroup(group: { id: "example" }) {
id
name
isActive
referenceId
branchId
}
}
M
updateManufacturer
Response
Returns a Manufacturer!
Arguments
| Name | Description |
|---|---|
manufacturer - ManufacturerUpdate!
|
Example
Query
mutation UpdateManufacturer($manufacturer: ManufacturerUpdate!) {
updateManufacturer(manufacturer: $manufacturer) {
id
description
isActive
referenceId
branchId
}
}
Variables
{"manufacturer": ManufacturerUpdate}
Response
{
"data": {
"updateManufacturer": {
"id": "xyz789",
"description": "xyz789",
"isActive": true,
"referenceId": "xyz789",
"branchId": "xyz789"
}
}
}
Example
mutation updateManufacturerExample {
updateManufacturer(manufacturer: { id: "example" }) {
id
description
isActive
referenceId
branchId
}
}
M
updateMasterPlan
Response
Returns a MasterPlan!
Arguments
| Name | Description |
|---|---|
masterPlan - UpdateMasterPlan!
|
Example
Query
mutation UpdateMasterPlan($masterPlan: UpdateMasterPlan!) {
updateMasterPlan(masterPlan: $masterPlan) {
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
{"masterPlan": UpdateMasterPlan}
Response
{
"data": {
"updateMasterPlan": {
"id": "abc123",
"description": "xyz789",
"maintenanceTime": MasterPlanTime,
"skipWeekend": false,
"stopEquipment": true,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 123.45,
"maintenanceCounter": MasterPlanCounter,
"isImported": true,
"model": Model,
"group": Group,
"branchId": "abc123",
"resources": [MasterPlanResource]
}
}
}
Example
mutation updateMasterPlanExample {
updateMasterPlan(masterPlan: { id: "example", maintenanceTime: { timeIncrement: 1.0, timeUnit: Day, active: true }, maintenanceCounter: { counterIncrement: 1.0, counterUnit: Hours, active: true }, resources: [{ resourceId: "example", type: Area }] }) {
id
description
maintenanceTime {
timeIncrement
timeUnit
active
}
skipWeekend
stopEquipment
hoursBeforeStop
hoursAfterStop
maintenanceCounter {
counterIncrement
counterUnit
active
}
isImported
model {
id
description
isActive
referenceId
branchId
}
group {
id
name
isActive
referenceId
branchId
}
branchId
resources {
id
}
}
}
M
updateMaterial
Response
Returns a Material!
Arguments
| Name | Description |
|---|---|
material - MaterialUpdate!
|
Example
Query
mutation UpdateMaterial($material: MaterialUpdate!) {
updateMaterial(material: $material) {
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
minimumBalance
warehouse {
...WarehouseFragment
}
}
stockMovements {
id
type
amount
observation
status
amountConfirmed
origin
createdAt
movementDate
warehouse {
...WarehouseFragment
}
}
isIntegrated
}
}
Variables
{"material": MaterialUpdate}
Response
{
"data": {
"updateMaterial": {
"id": "xyz789",
"description": "xyz789",
"standardCost": 987.65,
"isActive": true,
"referenceId": "abc123",
"measurementUnit": NewMeasurementUnit,
"warehouse": Warehouse,
"isInMaintenance": true,
"branchId": "xyz789",
"erpId": "xyz789",
"stockLevels": [StockLevelOnMaterial],
"stockMovements": [StockMovementOnMaterial],
"isIntegrated": true
}
}
}
Example
mutation updateMaterialExample {
updateMaterial(material: { id: "example" }) {
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
minimumBalance
}
stockMovements {
id
type
amount
observation
status
amountConfirmed
origin
createdAt
movementDate
}
isIntegrated
}
}
M
updateMeasurementUnit
Response
Returns a NewMeasurementUnit!
Arguments
| Name | Description |
|---|---|
measurementUnit - MeasurementUnitUpdate!
|
Example
Query
mutation UpdateMeasurementUnit($measurementUnit: MeasurementUnitUpdate!) {
updateMeasurementUnit(measurementUnit: $measurementUnit) {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
}
Variables
{"measurementUnit": MeasurementUnitUpdate}
Response
{
"data": {
"updateMeasurementUnit": {
"id": "xyz789",
"name": "xyz789",
"acronym": "abc123",
"isActive": false,
"branchId": "xyz789",
"erpId": "xyz789",
"description": "abc123",
"symbol": "abc123"
}
}
}
Example
mutation updateMeasurementUnitExample {
updateMeasurementUnit(measurementUnit: { id: "example" }) {
id
name
acronym
isActive
branchId
erpId
description
symbol
}
}
M
updateModel
Response
Returns a Model!
Arguments
| Name | Description |
|---|---|
model - ModelUpdate!
|
Example
Query
mutation UpdateModel($model: ModelUpdate!) {
updateModel(model: $model) {
id
description
isActive
referenceId
manufacturer {
id
description
isActive
referenceId
branchId
}
branchId
}
}
Variables
{"model": ModelUpdate}
Response
{
"data": {
"updateModel": {
"id": "abc123",
"description": "xyz789",
"isActive": true,
"referenceId": "xyz789",
"manufacturer": Manufacturer,
"branchId": "abc123"
}
}
}
Example
mutation updateModelExample {
updateModel(model: { id: "example" }) {
id
description
isActive
referenceId
manufacturer {
id
description
isActive
referenceId
branchId
}
branchId
}
}
M
updateReason
Response
Returns a Reason!
Arguments
| Name | Description |
|---|---|
reason - ReasonUpdate!
|
Example
Query
mutation UpdateReason($reason: ReasonUpdate!) {
updateReason(reason: $reason) {
id
description
type
isActive
referenceId
branchId
}
}
Variables
{"reason": ReasonUpdate}
Response
{
"data": {
"updateReason": {
"id": "xyz789",
"description": "abc123",
"type": "Delay",
"isActive": false,
"referenceId": "xyz789",
"branchId": "abc123"
}
}
}
Example
mutation updateReasonExample {
updateReason(reason: { id: "example" }) {
id
description
type
isActive
referenceId
branchId
}
}
M
updateServiceOrder
Response
Returns a ServiceOrder!
Arguments
| Name | Description |
|---|---|
attachments - NewBaseAttachmentArgs
|
|
attachmentIds - [String!]
|
|
serviceOrder - ServiceOrderUpdateInput!
|
Example
Query
mutation UpdateServiceOrder(
$attachments: NewBaseAttachmentArgs,
$attachmentIds: [String!],
$serviceOrder: ServiceOrderUpdateInput!
) {
updateServiceOrder(
attachments: $attachments,
attachmentIds: $attachmentIds,
serviceOrder: $serviceOrder
) {
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
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
{
"attachments": NewBaseAttachmentArgs,
"attachmentIds": ["abc123"],
"serviceOrder": ServiceOrderUpdateInput
}
Response
{
"data": {
"updateServiceOrder": {
"id": "abc123",
"code": "xyz789",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2026-09-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "xyz789",
"priority": 987.65,
"realStartDate": "2026-09-18T17:42:23.846Z",
"realEndDate": "2026-03-18T17:42:23.846Z",
"conclusion": 123.45,
"doneCost": 987.65,
"foreseenCost": 987.65,
"createdAt": "2026-09-18T17:42:23.846Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2026-03-18T17:42:23.846Z",
"resumedAt": "2026-09-18T17:42:23.846Z",
"foreseenStoppedAt": "2026-09-18T17:42:23.846Z",
"foreseenResumedAt": "2026-09-18T17:42:23.846Z",
"updatedAt": "2026-09-18T17:42:23.846Z",
"operationTime": 987.65,
"hasDoneResource": true,
"hasDoneHuman": false,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": false,
"hasMaintenceByCounter": true,
"serviceRequest": ServiceRequestRef,
"finalizationObservation": "abc123",
"cancellationObservation": "abc123",
"counter": Counter,
"foreseenEmployeeCost": 123.45,
"doneEmployeeCost": 123.45,
"foreseenToolCost": 123.45,
"doneToolCost": 123.45,
"foreseenMaterialCost": 123.45,
"foreseenProductCost": 987.65,
"doneMaterialCost": 123.45,
"doneProductCost": 987.65,
"foreseenThirdPartyCost": 123.45,
"doneThirdPartyCost": 123.45,
"branchId": "xyz789"
}
}
}
Example
mutation updateServiceOrderExample {
updateServiceOrder(attachments: { newAttachments: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], existentAttachments: [{ filename: "example", contentType: "example", contentLength: 1.0, url: "example" }] }, attachmentIds: ["example"], serviceOrder: { id: "example" }) {
id
code
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
user {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
service
situation
startDate
endDate
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
maintenance {
id
description
lastMaintenance
active
increaseCounter
timeIncrease
timeUnit
stopEquipment
hoursBeforeStop
hoursAfterStop
}
cancellationReasonRef {
id
description
type
isActive
referenceId
branchId
}
costCenterRef {
id
description
isActive
referenceId
branchId
erpId
}
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
areas {
id
foreseen
done
}
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
mentioned
lastEditedAt
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
dailyVariation
branchId
}
foreseenEmployeeCost
doneEmployeeCost
foreseenToolCost
doneToolCost
foreseenMaterialCost
foreseenProductCost
doneMaterialCost
doneProductCost
foreseenThirdPartyCost
doneThirdPartyCost
branchId
}
}
M
updateServiceRequest
Response
Returns a ServiceRequest!
Arguments
| Name | Description |
|---|---|
attachments - [AttachmentUpload!]
|
|
attachmentIds - [String!]
|
|
serviceRequest - ServiceRequestUpdate!
|
Example
Query
mutation UpdateServiceRequest(
$attachments: [AttachmentUpload!],
$attachmentIds: [String!],
$serviceRequest: ServiceRequestUpdate!
) {
updateServiceRequest(
attachments: $attachments,
attachmentIds: $attachmentIds,
serviceRequest: $serviceRequest
) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
user {
...UserFragment
}
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
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
anonymizedAt
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
}
generatedServiceOrder
linkedServiceOrder
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
{
"attachments": [AttachmentUpload],
"attachmentIds": ["abc123"],
"serviceRequest": ServiceRequestUpdate
}
Response
{
"data": {
"updateServiceRequest": {
"id": "abc123",
"code": "xyz789",
"description": "abc123",
"isAuto": false,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "abc123",
"runningTime": "xyz789",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"generatedServiceOrder": false,
"linkedServiceOrder": false,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-03-18T17:42:23.846Z",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"serviceTime": "xyz789",
"runTime": "xyz789",
"finishedAt": "2026-03-18T17:42:23.846Z",
"distributedAt": "2026-09-18T17:42:23.846Z",
"canceledAt": "2026-03-18T17:42:23.846Z",
"branchId": "xyz789",
"attachments": [Attachment],
"followUp": [ServiceRequestFollowUp]
}
}
}
Example
mutation updateServiceRequestExample {
updateServiceRequest(attachments: [{ filename: "example", contentType: "example", contentLength: 1.0, upload: "example" }], attachmentIds: ["example"], serviceRequest: { id: "example" }) {
id
code
description
isAuto
situation
priority
observation
runningTime
employee {
id
hourlyWage
startDate
endDate
isActive
}
reason {
id
description
type
isActive
referenceId
branchId
}
equipment {
isInTree
treeTag
serial
purchaseDate
purchaseValue
warranty
warrantyDate
warrantyUnit
counterType
counterLimit
releaseReasonId
releaseDate
dailyVariation
counterAmount
accumulatedPosition
canUpdateLimit
id
description
isStarter
tag
previousTags
classification
isMaintenanceActive
owner
situation
criticality
mainAttachmentUrl
availability
tagDescription
}
customer {
documentNumber
daytimePhoneNumber
phoneNumber
email
address
number
complement
zipCode
neighborhood
city
state
country
description
customerPicture
customerPictureKey
anonymizedAt
id
type
name
isActive
}
serviceOrder {
id
code
service
situation
startDate
endDate
observation
priority
realStartDate
realEndDate
conclusion
doneCost
foreseenCost
createdAt
}
generatedServiceOrder
linkedServiceOrder
satisfactionSurvey {
id
deadlineEvaluation
coveringEvaluation
observation
}
requester {
documentNumber
birthDate
address
educationLevel
gender
mobileTourView
id
name
email
accessBy
verifiedEmail
profilePicture
restrictedBy
}
createdAt
stoppedAt
serviceTime
runTime
finishedAt
distributedAt
canceledAt
branchId
attachments {
id
filename
contentType
contentLength
url
uploadedBy
createdAt
uploadUrl
}
followUp {
type
mentioned
lastEditedAt
createdAt
id
description
deletedAt
branchId
action
serviceOrderId
url
}
}
}
M
updateSpecialty
Response
Returns a Specialty!
Arguments
| Name | Description |
|---|---|
specialty - SpecialtyUpdate!
|
Example
Query
mutation UpdateSpecialty($specialty: SpecialtyUpdate!) {
updateSpecialty(specialty: $specialty) {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
Variables
{"specialty": SpecialtyUpdate}
Response
{
"data": {
"updateSpecialty": {
"id": "xyz789",
"name": "xyz789",
"hourlyWage": 123.45,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": false
}
}
}
Example
mutation updateSpecialtyExample {
updateSpecialty(specialty: { id: "example" }) {
id
name
hourlyWage
isActive
referenceId
isInMaintenance
}
}
M
updateStep
Response
Returns a Step!
Arguments
| Name | Description |
|---|---|
step - StepUpdate!
|
Example
Query
mutation UpdateStep($step: StepUpdate!) {
updateStep(step: $step) {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
id
description
symbol
}
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"step": StepUpdate}
Response
{
"data": {
"updateStep": {
"id": "xyz789",
"description": "abc123",
"isReported": true,
"averageTime": "xyz789",
"requestResponse": false,
"type": "Number",
"measurementUnit": MeasurementUnit,
"isActive": true,
"referenceId": "abc123",
"isInMaintenance": false,
"branchId": "abc123"
}
}
}
Example
mutation updateStepExample {
updateStep(step: { id: "example" }) {
id
description
isReported
averageTime
requestResponse
type
measurementUnit {
id
description
symbol
}
isActive
referenceId
isInMaintenance
branchId
}
}
M
updateSupplier
Response
Returns a Supplier!
Arguments
| Name | Description |
|---|---|
supplier - SupplierUpdate!
|
Example
Query
mutation UpdateSupplier($supplier: SupplierUpdate!) {
updateSupplier(supplier: $supplier) {
id
name
isResource
branchId
erpId
}
}
Variables
{"supplier": SupplierUpdate}
Response
{
"data": {
"updateSupplier": {
"id": "xyz789",
"name": "xyz789",
"isResource": "ServiceOrder",
"branchId": "abc123",
"erpId": "abc123"
}
}
}
Example
mutation updateSupplierExample {
updateSupplier(supplier: { id: "example" }) {
id
name
isResource
branchId
erpId
}
}
M
updateThirdParty
Response
Returns a ThirdParty!
Arguments
| Name | Description |
|---|---|
thirdParty - ThirdPartyUpdate!
|
Example
Query
mutation UpdateThirdParty($thirdParty: ThirdPartyUpdate!) {
updateThirdParty(thirdParty: $thirdParty) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
Variables
{"thirdParty": ThirdPartyUpdate}
Response
{
"data": {
"updateThirdParty": {
"id": "abc123",
"description": "abc123",
"standardCost": 987.65,
"isActive": true,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": true,
"branchId": "abc123"
}
}
}
Example
mutation updateThirdPartyExample {
updateThirdParty(thirdParty: { id: "example" }) {
id
description
standardCost
isActive
suppliers {
id
name
isResource
branchId
erpId
cost
}
isInMaintenance
branchId
}
}
M
updateTool
Response
Returns a Tool!
Arguments
| Name | Description |
|---|---|
tool - ToolUpdate!
|
Example
Query
mutation UpdateTool($tool: ToolUpdate!) {
updateTool(tool: $tool) {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
}
Variables
{"tool": ToolUpdate}
Response
{
"data": {
"updateTool": {
"id": "xyz789",
"description": "abc123",
"hourlyCost": 123.45,
"isActive": true,
"referenceId": "xyz789",
"isInMaintenance": false,
"branchId": "xyz789"
}
}
}
Example
mutation updateToolExample {
updateTool(tool: { id: "example" }) {
id
description
hourlyCost
isActive
referenceId
isInMaintenance
branchId
}
}
M
updateWarehouse
Response
Returns a Warehouse!
Arguments
| Name | Description |
|---|---|
warehouse - WarehouseUpdate!
|
Example
Query
mutation UpdateWarehouse($warehouse: WarehouseUpdate!) {
updateWarehouse(warehouse: $warehouse) {
id
description
isActive
branchId
erpId
level
}
}
Variables
{"warehouse": WarehouseUpdate}
Response
{
"data": {
"updateWarehouse": {
"id": "abc123",
"description": "abc123",
"isActive": false,
"branchId": "xyz789",
"erpId": "xyz789",
"level": "xyz789"
}
}
}
Example
mutation updateWarehouseExample {
updateWarehouse(warehouse: { id: "example" }) {
id
description
isActive
branchId
erpId
level
}
}Types
Types
T
AccessBy
Values
| Enum Value | Description |
|---|---|
|
|
Autenticação pelo Keepfy |
|
|
Autenticação pela Microsoft |
Example
"Internal"
T
AccessToken
Example
{
"token": "abc123",
"apiAccessId": "xyz789",
"createdAt": "2026-09-18T17:42:23.846Z",
"deletedAt": "2026-03-18T17:42:23.846Z"
}
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
AgreementCreationInput
Fields
| Input Field | Description |
|---|---|
effectiveStartDate - String!
|
|
effectiveEndDate - String!
|
|
description - String
|
|
attachments - [AttachmentCreationInput!]
|
Example
{
"effectiveStartDate": "xyz789",
"effectiveEndDate": "xyz789",
"description": "xyz789",
"attachments": [AttachmentCreationInput]
}
T
AgreementOnUpdate
Fields
| Input Field | Description |
|---|---|
toCreate - [AgreementCreationInput!]!
|
|
toUpdate - [AgreementUpdateInput!]!
|
|
toRemove - [String!]!
|
Example
{
"toCreate": [AgreementCreationInput],
"toUpdate": [AgreementUpdateInput],
"toRemove": ["abc123"]
}
T
AgreementUpdateInput
T
Area
Example
{
"id": "xyz789",
"description": "xyz789",
"isActive": false,
"referenceId": "abc123",
"isInMaintenance": false,
"branchId": "xyz789"
}
T
AreaInput
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": "xyz789",
"area": Area,
"foreseen": false,
"done": true,
"resources": [HumanResourceTree]
}
T
AreaTreeInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
resources - [HumanResourceTreeInput!]
|
Example
{
"resourceId": "xyz789",
"type": "Area",
"resources": [HumanResourceTreeInput]
}
T
AreaTreeUpdate
Fields
| Input Field | Description |
|---|---|
id - String
|
|
resourceId - String!
|
|
type - ResourceType!
|
|
foreseen - Boolean!
|
|
done - Boolean!
|
|
parentId - String
|
|
resources - [HumanResourceTreeUpdate!]
|
Example
{
"id": "abc123",
"resourceId": "xyz789",
"type": "Area",
"foreseen": true,
"done": false,
"parentId": "abc123",
"resources": [HumanResourceTreeUpdate]
}
T
AreaUpdate
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": "abc123",
"createdAt": "2026-09-18T17:42:23.846Z",
"uploadUrl": "abc123"
}
T
AttachmentCreationInput
T
AttachmentDownload
Example
{
"filename": "abc123",
"contentType": "xyz789",
"contentLength": 987.65,
"contentThumbLength": 123.45,
"url": S3UrlCloudFront,
"thumbUrl": "abc123",
"thumbFilename": "abc123"
}
T
AttachmentUpload
Example
{
"filename": "abc123",
"contentType": "abc123",
"contentLength": 123.45,
"contentThumbLength": 987.65,
"upload": Upload,
"thumbUpload": Upload
}
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.
Example
true
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": "abc123",
"activityType": "AgricultureLivestockForestryAndAquaculture",
"zipCode": "xyz789",
"street": "xyz789",
"number": "abc123",
"neighborhood": "xyz789",
"city": "abc123",
"state": "xyz789",
"country": "abc123",
"complement": "abc123",
"timeZone": "abc123",
"mfmUser": "abc123",
"mfmPassword": "abc123",
"id": "abc123",
"organizationId": "xyz789",
"name": "abc123",
"createdAt": "2026-03-18T17:42:23.846Z",
"updatedAt": "2026-03-18T17:42:23.846Z",
"documentNumber": "abc123",
"deletedAt": "2026-03-18T17:42:23.846Z",
"settings": GlobalSettings,
"endpoints": [Endpoint]
}
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": 987.65,
"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": "abc123",
"isActive": false,
"workShifts": [WorkShift],
"referenceId": "abc123"
}
T
CalendarQueryInput
T
CalendarUpdate
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
name - String
|
|
isActive - Boolean
|
|
workShifts - [WorkShiftUpdate!]
|
Example
{
"id": "abc123",
"name": "abc123",
"isActive": true,
"workShifts": [WorkShiftUpdate]
}
T
CancelServiceOrder
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
ChecklistInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
resources - [PhysicalResourceInput!]
|
|
id - String
|
Example
{
"resourceId": "xyz789",
"type": "Area",
"resources": [PhysicalResourceInput],
"id": "abc123"
}
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": true,
"done": false,
"response": "xyz789",
"parentId": "xyz789",
"resources": [PhysicalResourceTree]
}
T
ChecklistTreeInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
resources - [PhysicalResourceTreeInput!]
|
Example
{
"resourceId": "xyz789",
"type": "Area",
"resources": [PhysicalResourceTreeInput]
}
T
ChecklistTreeUpdate
Fields
| Input Field | Description |
|---|---|
id - String
|
|
resourceId - String!
|
|
type - ResourceType!
|
|
foreseen - Boolean!
|
|
done - Boolean!
|
|
response - String
|
|
parentId - String
|
|
resources - [PhysicalResourceTreeUpdate!]
|
Example
{
"id": "xyz789",
"resourceId": "xyz789",
"type": "Area",
"foreseen": false,
"done": false,
"response": "xyz789",
"parentId": "abc123",
"resources": [PhysicalResourceTreeUpdate]
}
T
ComparativeResult
T
CostCenter
Example
{
"id": "abc123",
"description": "abc123",
"isActive": true,
"referenceId": "xyz789",
"branchId": "xyz789",
"erpId": "abc123"
}
T
CostCenterInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
Example
{"description": "abc123"}
T
CostCenterQueryInput
T
CostCenterUpdate
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": "2026-03-18T17:42:23.846Z",
"position": 123.45,
"accumulatedPosition": 987.65,
"type": "Inform",
"serviceOrder": ServiceOrder,
"dailyVariation": 987.65,
"branchId": "xyz789"
}
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": 123.45,
"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
CreateMasterPlan
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
maintenanceTime - MasterPlanTimeInput!
|
|
maintenanceCounter - MasterPlanCounterInput!
|
|
stopEquipment - Boolean!
|
|
hoursBeforeStop - Float
|
|
hoursAfterStop - Float
|
|
skipWeekend - Boolean!
|
|
resources - [MasterPlanResourceInput!]!
|
|
modelId - String
|
|
groupId - String
|
Example
{
"description": "xyz789",
"maintenanceTime": MasterPlanTimeInput,
"maintenanceCounter": MasterPlanCounterInput,
"stopEquipment": true,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"skipWeekend": true,
"resources": [MasterPlanResourceInput],
"modelId": "xyz789",
"groupId": "xyz789"
}
T
CustomInventoryEndpointSettings
Fields
| Field Name | Description |
|---|---|
integrationCustomInventory - Boolean!
|
Habilitar integração com Keepfy Estoque |
enablesRegistration - CustomInventoryRegistrationsSettings!
|
Configurações de cadastro |
Example
{
"integrationCustomInventory": true,
"enablesRegistration": CustomInventoryRegistrationsSettings
}
T
CustomInventoryRegistrationsSettings
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": "abc123",
"effectiveStartDate": "xyz789",
"effectiveEndDate": "abc123",
"isActive": true,
"description": "xyz789",
"attachments": [Attachment]
}
T
CustomerCreationInput
Fields
| Input Field | Description |
|---|---|
documentNumber - String
|
|
daytimePhoneNumber - String
|
|
phoneNumber - String
|
|
email - String
|
|
address - String
|
|
number - String
|
|
complement - String
|
|
zipCode - String
|
|
neighborhood - String
|
|
city - String
|
|
state - String
|
|
country - String
|
|
description - String
|
|
type - PersonType!
|
|
name - String!
|
|
users - [UsersToInviteInput!]
|
|
agreements - [AgreementCreationInput!]
|
Example
{
"documentNumber": "xyz789",
"daytimePhoneNumber": "abc123",
"phoneNumber": "xyz789",
"email": "abc123",
"address": "xyz789",
"number": "abc123",
"complement": "abc123",
"zipCode": "abc123",
"neighborhood": "abc123",
"city": "abc123",
"state": "xyz789",
"country": "xyz789",
"description": "xyz789",
"type": "IndividualPerson",
"name": "abc123",
"users": [UsersToInviteInput],
"agreements": [AgreementCreationInput]
}
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 |
anonymizedAt - DateTime
|
Indica a data da anonimização do usuário |
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": "xyz789",
"phoneNumber": "abc123",
"email": "abc123",
"address": "abc123",
"number": "xyz789",
"complement": "abc123",
"zipCode": "abc123",
"neighborhood": "xyz789",
"city": "abc123",
"state": "abc123",
"country": "xyz789",
"description": "xyz789",
"customerPicture": S3UrlCloudFront,
"customerPictureKey": "xyz789",
"anonymizedAt": "2026-03-18T17:42:23.846Z",
"attachments": [Attachment],
"branch": Branch,
"users": [UserOrganizationListing],
"agreements": [CustomerAgreement],
"id": "xyz789",
"type": "IndividualPerson",
"name": "abc123",
"isActive": true
}
T
CustomerPartnerUpdateInput
Fields
| Input Field | Description |
|---|---|
documentNumber - String
|
|
daytimePhoneNumber - String
|
|
phoneNumber - String
|
|
email - String
|
|
address - String
|
|
number - String
|
|
complement - String
|
|
zipCode - String
|
|
neighborhood - String
|
|
city - String
|
|
state - String
|
|
country - String
|
|
description - String
|
|
id - String!
|
|
type - PersonType
|
|
name - String
|
|
isActive - Boolean
|
|
users - UsersOnUpdate
|
|
agreements - AgreementOnUpdate
|
Example
{
"documentNumber": "xyz789",
"daytimePhoneNumber": "xyz789",
"phoneNumber": "xyz789",
"email": "abc123",
"address": "abc123",
"number": "xyz789",
"complement": "abc123",
"zipCode": "abc123",
"neighborhood": "xyz789",
"city": "abc123",
"state": "xyz789",
"country": "abc123",
"description": "abc123",
"id": "xyz789",
"type": "IndividualPerson",
"name": "xyz789",
"isActive": false,
"users": UsersOnUpdate,
"agreements": AgreementOnUpdate
}
T
DateFilterInput
T
DateRange
T
DateTime
Example
"2026-03-18T17:42:23.846Z"
T
DayOfWeek
Values
| Enum Value | Description |
|---|---|
|
|
domingo |
|
|
segunda-feira |
|
|
terça-feira |
|
|
quarta-feira |
|
|
quinta-feira |
|
|
sexta-feira |
|
|
sábado |
Example
"Sunday"
T
DefaultFinishServiceOrder
Example
{
"finalizationObservation": "xyz789",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"resumedAt": "2026-03-18T17:42:23.846Z",
"counter": InformCounterInput,
"addAttachment": false,
"removeAttachment": true
}
T
DesignVersion
Values
| Enum Value | Description |
|---|---|
|
|
Layout v1 (legado) |
|
|
Layout v2 (novo) |
Example
"v1"
T
DetailMaintenance
Fields
| Field Name | Description |
|---|---|
increase - Float!
|
Valor do incremento |
unit - IncreaseType!
|
Tipo de incremento |
Example
{"increase": 987.65, "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": "abc123",
"serviceOrder": "xyz789",
"date": "2026-03-18T17:42:23.846Z",
"situation": "Opened",
"counter": Counter
}
T
EducationLevel
Values
| Enum Value | Description |
|---|---|
|
|
Ensino Fundamental |
|
|
Ensino Médio |
|
|
Graduação |
|
|
Mestrado |
|
|
Doutorado |
Example
"ElementarySchool"
T
Employee
Example
{
"id": "xyz789",
"user": User,
"hourlyWage": 123.45,
"startDate": "abc123",
"endDate": "abc123",
"isActive": true
}
T
EmployeeCreationInput
Fields
| Input Field | Description |
|---|---|
hourlyWage - Float
|
|
specialties - [String!]!
|
|
userId - String!
|
|
calendarId - String!
|
|
branchId - String
|
Example
{
"hourlyWage": 123.45,
"specialties": ["xyz789"],
"userId": "xyz789",
"calendarId": "xyz789",
"branchId": "abc123"
}
T
EmployeeUpdateInput
Fields
| Input Field | Description |
|---|---|
hourlyWage - Float
|
|
specialties - [String!]!
|
|
id - String!
|
|
calendarId - String
|
Example
{
"hourlyWage": 987.65,
"specialties": ["abc123"],
"id": "abc123",
"calendarId": "xyz789"
}
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": "xyz789",
"branchId": "abc123",
"erpType": "FakeERP",
"erpLine": "Omie",
"erpCompany": "abc123",
"erpBranch": "abc123",
"url": "xyz789",
"port": 123.45,
"authType": "Basic",
"user": "abc123",
"password": "abc123",
"apiClient": "abc123",
"apiSecret": "xyz789",
"urlTSS": "xyz789",
"group": "abc123",
"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": "xyz789",
"contentLength": 123.45,
"url": S3UrlCloudFront,
"uploadedBy": "abc123",
"createdAt": "2026-03-18T17:42:23.846Z",
"uploadUrl": "abc123",
"isMainPicture": false
}
T
EquipmentAttachmentInput
T
EquipmentBasicInfo
Example
{
"id": "xyz789",
"description": "xyz789",
"tag": "abc123",
"tagDescription": "abc123",
"isStarter": false
}
T
EquipmentClassification
Values
| Enum Value | Description |
|---|---|
|
|
Equipamento |
|
|
Componente |
Example
"Equipment"
T
EquipmentCounter
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
position - Float!
|
|
readAt - DateTime!
|
|
type - EntryType!
|
Example
{
"id": "abc123",
"position": 123.45,
"readAt": "2026-09-18T17:42:23.846Z",
"type": "Inform"
}
T
EquipmentCreateInput
Fields
| Input Field | 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 |
groupId - String!
|
|
costCenterId - String!
|
|
modelId - String!
|
|
calendarId - String!
|
|
description - String!
|
|
tag - String!
|
|
classification - EquipmentClassification!
|
|
owner - EquipmentOwnerType!
|
|
customerId - String
|
|
mainPicture - String
|
|
criticality - Scale!
|
|
attachments - [EquipmentAttachmentInput!]
|
|
properties - [EquipmentPropertyInput!]
|
|
maintenances - [EquipmentMaintenanceInput!]
|
|
counters - [EquipmentCounter!]
|
|
sensors - [SensorInput!]
|
Example
{
"isInTree": false,
"treeTag": "abc123",
"serial": "xyz789",
"purchaseDate": "abc123",
"purchaseValue": 987.65,
"warranty": 123.45,
"warrantyDate": "xyz789",
"warrantyUnit": "Day",
"counterType": "Hours",
"counterLimit": "SixDigits",
"releaseReasonId": "xyz789",
"releaseDate": "xyz789",
"dailyVariation": 123.45,
"counterAmount": 123.45,
"accumulatedPosition": 987.65,
"canUpdateLimit": true,
"groupId": "xyz789",
"costCenterId": "abc123",
"modelId": "xyz789",
"calendarId": "abc123",
"description": "abc123",
"tag": "abc123",
"classification": "Equipment",
"owner": "Own",
"customerId": "abc123",
"mainPicture": "abc123",
"criticality": "High",
"attachments": [EquipmentAttachmentInput],
"properties": [EquipmentPropertyInput],
"maintenances": [EquipmentMaintenanceInput],
"counters": [EquipmentCounter],
"sensors": [SensorInput]
}
T
EquipmentCreateOutput
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
description - String!
|
Descrição |
tag - String!
|
|
treeTag - String
|
|
maintenances - [MaintenanceOnEquipment!]
|
|
model - BasicInformationDescription
|
|
group - BasicInformationName
|
|
customer - BasicInformationName
|
Example
{
"id": "xyz789",
"description": "xyz789",
"tag": "abc123",
"treeTag": "abc123",
"maintenances": [MaintenanceOnEquipment],
"model": BasicInformationDescription,
"group": BasicInformationName,
"customer": BasicInformationName
}
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 - S3UrlCloudFront
|
URL da imagem principal |
availability - Float
|
Disponibilidade |
tagDescription - String!
|
Identificação e descrição |
equipmentsStructure - [EquipmentStructure!]
|
Estrutura de equipamentos |
Example
{
"isInTree": false,
"treeTag": "abc123",
"serial": "abc123",
"purchaseDate": "abc123",
"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": false,
"branch": Branch,
"id": "xyz789",
"description": "xyz789",
"isStarter": true,
"tag": "xyz789",
"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": S3UrlCloudFront,
"availability": 123.45,
"tagDescription": "abc123",
"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": ["xyz789"],
"groups": ["xyz789"],
"models": ["xyz789"],
"costCenters": ["abc123"],
"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": "xyz789"
}
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 |
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 |
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 - S3UrlCloudFront
|
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": "xyz789",
"description": "abc123",
"isStarter": false,
"tag": "xyz789",
"treeTag": "xyz789",
"previousTags": "xyz789",
"classification": "Equipment",
"isMaintenanceActive": true,
"availability": 123.45,
"group": BasicInformationName,
"model": BasicInformationDescription,
"counterType": "Hours",
"counterLimit": "SixDigits",
"dailyVariation": 123.45,
"counterAmount": 987.65,
"accumulatedPosition": 123.45,
"lastPosition": 987.65,
"situation": "Active",
"isStopped": true,
"criticality": "High",
"mainAttachmentUrl": S3UrlCloudFront,
"costCenter": BasicInformationDescription,
"purchaseDate": "xyz789",
"warranty": 123.45,
"warrantyDate": "abc123",
"warrantyUnit": "Day",
"owner": "Own",
"customer": CustomerPartner,
"releaseDate": "xyz789",
"tagDescription": "abc123",
"branchId": "abc123",
"sensorsQuantity": 987.65,
"sensorsHealth": 987.65
}
T
EquipmentMaintenanceInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
lastMaintenance - DateTime!
|
|
maintenanceTime - MaintenanceTime!
|
|
increaseCounter - Float!
|
|
skipWeekend - Boolean!
|
|
stopEquipment - Boolean!
|
|
hoursBeforeStop - Float
|
|
hoursAfterStop - Float
|
|
masterPlan - EquipmentMasterPlan!
|
|
areas - [MaintenanceAreaInput!]!
|
Example
{
"description": "xyz789",
"lastMaintenance": "2026-03-18T17:42:23.846Z",
"maintenanceTime": MaintenanceTime,
"increaseCounter": 123.45,
"skipWeekend": false,
"stopEquipment": true,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 123.45,
"masterPlan": EquipmentMasterPlan,
"areas": [MaintenanceAreaInput]
}
T
EquipmentMaintenanceType
Values
| Enum Value | Description |
|---|---|
|
|
Com manutenção |
|
|
Sem manutenção |
Example
"WithMaintenance"
T
EquipmentMasterPlan
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": "abc123",
"measurementUnit": MeasurementUnit,
"feature": Feature
}
T
EquipmentPropertyInput
T
EquipmentPropertyUpdate
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": "xyz789",
"filter": EquipmentFilter,
"summaryOrderBy": "Alphabetic",
"isMonitoring": false,
"isEquipmentTree": true,
"ignoreIds": ["abc123"]
}
T
EquipmentRemoveOutput
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": "xyz789",
"description": "xyz789",
"tag": "xyz789",
"treeTag": "abc123",
"tagDescription": "abc123",
"classification": "Equipment"
}
T
EquipmentType
Values
| Enum Value | Description |
|---|---|
|
|
Simplificado |
|
|
Completo |
Example
"Starter"
T
EquipmentUpdateInput
Fields
| Input Field | 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 |
id - String!
|
|
isStarter - Boolean
|
|
tag - String
|
|
classification - EquipmentClassification
|
|
criticality - Scale
|
|
groupId - String
|
|
costCenterId - String
|
|
modelId - String
|
|
calendarId - String
|
|
description - String
|
|
isMaintenanceActive - Boolean
|
|
owner - EquipmentOwnerType
|
|
mainPicture - String
|
|
customerId - String
|
|
situation - EquipmentSituation
|
|
properties - [EquipmentPropertyUpdate!]
|
|
maintenances - MaintenanceOnUpdate
|
|
counters - [EquipmentCounter!]
|
|
sensors - [SensorInput!]
|
Example
{
"isInTree": true,
"treeTag": "xyz789",
"serial": "abc123",
"purchaseDate": "abc123",
"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,
"id": "abc123",
"isStarter": false,
"tag": "abc123",
"classification": "Equipment",
"criticality": "High",
"groupId": "xyz789",
"costCenterId": "abc123",
"modelId": "abc123",
"calendarId": "abc123",
"description": "xyz789",
"isMaintenanceActive": true,
"owner": "Own",
"mainPicture": "xyz789",
"customerId": "abc123",
"situation": "Active",
"properties": [EquipmentPropertyUpdate],
"maintenances": MaintenanceOnUpdate,
"counters": [EquipmentCounter],
"sensors": [SensorInput]
}
T
EquipmentUpdateOutput
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 - S3UrlCloudFront
|
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 |
createdAt - DateTime!
|
Data de criação do equipamento |
Example
{
"isInTree": false,
"treeTag": "abc123",
"serial": "abc123",
"purchaseDate": "xyz789",
"purchaseValue": 123.45,
"warranty": 987.65,
"warrantyDate": "xyz789",
"warrantyUnit": "Day",
"counterType": "Hours",
"counterLimit": "SixDigits",
"releaseReasonId": "abc123",
"releaseDate": "xyz789",
"dailyVariation": 123.45,
"counterAmount": 987.65,
"accumulatedPosition": 123.45,
"canUpdateLimit": false,
"branch": Branch,
"id": "abc123",
"description": "abc123",
"isStarter": true,
"tag": "xyz789",
"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": S3UrlCloudFront,
"availability": 123.45,
"tagDescription": "xyz789",
"equipmentsStructure": [EquipmentStructure],
"maintenances": [MaintenanceOnEquipment],
"isLastPositionDifferent": false,
"createdAt": "2026-09-18T17:42:23.846Z"
}
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
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": "abc123",
"description": "abc123",
"type": "String",
"isActive": true,
"referenceId": "xyz789",
"isInEquipment": false,
"branchId": "abc123"
}
T
FeatureInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
type - FeatureType!
|
Example
{"description": "xyz789", "type": "String"}
T
FeatureQueryInput
T
FeatureType
Values
| Enum Value | Description |
|---|---|
|
|
Texto |
|
|
Inteiro |
|
|
Data |
|
|
Decimal |
Example
"String"
T
FeatureUpdate
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
description - String
|
|
type - FeatureType
|
|
isActive - Boolean
|
Example
{
"id": "abc123",
"description": "abc123",
"type": "String",
"isActive": true
}
T
FinishServiceOrder
Example
{
"finalizationObservation": "xyz789",
"stoppedAt": "2026-09-18T17:42:23.846Z",
"resumedAt": "2026-09-18T17:42:23.846Z",
"counter": InformCounterInput,
"addAttachment": true,
"removeAttachment": true,
"id": "xyz789"
}
T
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
T
FloatRange
T
FollowUpManualInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
Example
{"description": "xyz789"}
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": "abc123",
"user": User,
"hourlyWage": 987.65,
"startDate": "abc123",
"endDate": "xyz789",
"isActive": true,
"calendar": Calendar,
"specialties": [Specialty]
}
T
GenericSpecialty
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 |
customInventory - CustomInventoryEndpointSettings!
|
Configurações de integração com Estoque customizado |
Example
{
"serviceOrder": ServiceOrderSettings,
"equipment": EquipmentSettings,
"inventory": InventorySettings,
"totvsModa": TotvsModaEndpointSettings,
"keepfyInventory": KeepfyInventoryEndpointSettings,
"customInventory": CustomInventoryEndpointSettings
}
T
Group
T
GroupInput
T
GroupQueryInput
T
GroupUpdate
T
HistoryComment
Fields
| Field Name | Description |
|---|---|
comment - String!
|
|
mentions - [String!]!
|
|
date - DateTime!
|
Example
{
"comment": "abc123",
"mentions": ["abc123"],
"date": "2026-03-18T17:42:23.846Z"
}
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
HumanResourceInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
amount - Float!
|
|
resources - [PhysicalResourceInput!]
|
|
checklists - [ChecklistInput!]
|
|
thirdParties - [MasterPlanThirdPartyInput!]
|
|
id - String
|
Example
{
"resourceId": "abc123",
"type": "Area",
"amount": 987.65,
"resources": [PhysicalResourceInput],
"checklists": [ChecklistInput],
"thirdParties": [MasterPlanThirdPartyInput],
"id": "abc123"
}
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": "2026-09-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"amount": 987.65,
"cost": 123.45,
"startDateDone": "2026-09-18T17:42:23.846Z",
"endDateDone": "2026-03-18T17:42:23.846Z",
"amountDone": 987.65,
"costDone": 123.45,
"foreseen": false,
"done": true,
"parentId": "abc123",
"purchaseRequestId": "abc123",
"resources": [PhysicalResourceTree],
"checklists": [ChecklistTree],
"thirdParties": [ThirdPartyTree]
}
T
HumanResourceTreeInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
startDate - DateTime!
|
|
endDate - DateTime!
|
|
resources - [PhysicalResourceTreeInput!]
|
|
checklists - [ChecklistTreeInput!]
|
|
thirdParties - [ThirdPartyTreeInput!]
|
Example
{
"resourceId": "xyz789",
"type": "Area",
"startDate": "2026-03-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"resources": [PhysicalResourceTreeInput],
"checklists": [ChecklistTreeInput],
"thirdParties": [ThirdPartyTreeInput]
}
T
HumanResourceTreeUpdate
Fields
| Input Field | Description |
|---|---|
id - String
|
|
resourceId - String!
|
|
type - ResourceType!
|
|
foreseen - Boolean!
|
|
done - Boolean!
|
|
startDate - DateTime
|
|
endDate - DateTime
|
|
startDateDone - DateTime
|
|
endDateDone - DateTime
|
|
parentId - String
|
|
resources - [PhysicalResourceTreeUpdate!]
|
|
checklists - [ChecklistTreeUpdate!]
|
|
thirdParties - [ThirdPartyTreeUpdate!]
|
Example
{
"id": "xyz789",
"resourceId": "abc123",
"type": "Area",
"foreseen": true,
"done": true,
"startDate": "2026-09-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"startDateDone": "2026-03-18T17:42:23.846Z",
"endDateDone": "2026-03-18T17:42:23.846Z",
"parentId": "abc123",
"resources": [PhysicalResourceTreeUpdate],
"checklists": [ChecklistTreeUpdate],
"thirdParties": [ThirdPartyTreeUpdate]
}
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": "abc123"
}
T
InformCounterInput
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
IntegrationContext
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Inventory"
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": true,
"categoryPurchase": "xyz789",
"materialsFamilies": ["abc123"]
}
T
KeepfyInventoryEndpointSettings
Fields
| Field Name | Description |
|---|---|
integrationKeepfyInventory - Boolean!
|
Habilitar integração com Keepfy Estoque |
plannersToNotification - [String!]!
|
Planejadores a notificar quando material abaixo do mínimo |
Example
{
"integrationKeepfyInventory": true,
"plannersToNotification": ["abc123"]
}
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": "abc123",
"total": 987.65,
"corrective": 123.45,
"preventive": 987.65,
"improvement": 123.45,
"accumulatedCost": 123.45,
"branchId": "xyz789"
}
T
MaintenanceAreaInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
resources - [MaintenanceHumanResourceInput!]
|
|
id - String
|
Example
{
"resourceId": "abc123",
"type": "Area",
"resources": [MaintenanceHumanResourceInput],
"id": "xyz789"
}
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
MaintenanceChecklistInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
resources - [MaintenancePhysicalResourceInput!]
|
|
id - String
|
Example
{
"resourceId": "xyz789",
"type": "Area",
"resources": [MaintenancePhysicalResourceInput],
"id": "xyz789"
}
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": 987.65,
"resources": [MaintenancePhysicalResource],
"checklists": [MaintenanceChecklist],
"thirdParties": [MaintenanceThirdParty]
}
T
MaintenanceHumanResourceInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
amount - Float!
|
|
resources - [MaintenancePhysicalResourceInput!]
|
|
checklists - [MaintenanceChecklistInput!]
|
|
thirdParties - [MaintenanceThirdPartyInput!]
|
|
id - String
|
Example
{
"resourceId": "abc123",
"type": "Area",
"amount": 123.45,
"resources": [MaintenancePhysicalResourceInput],
"checklists": [MaintenanceChecklistInput],
"thirdParties": [MaintenanceThirdPartyInput],
"id": "abc123"
}
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": "abc123",
"maintenance": "abc123",
"active": true,
"description": "xyz789",
"lastMaintenance": "2026-03-18T17:42:23.846Z",
"skipWeekend": true,
"stopEquipment": true,
"hoursBeforeStop": 123.45,
"hoursAfterStop": 123.45,
"detail": [DetailMaintenance],
"maintenanceCounter": MaintenanceCounterActive,
"maintenanceTime": MaintenanceTimeActive,
"lastServiceOrder": DetailServiceOrder,
"nextMaintenance": DetailServiceOrder,
"realNextMaintenanceDate": "2026-03-18T17:42:23.846Z",
"masterPlan": MasterPlanOnEquipment,
"observation": Observation,
"areas": [MaintenanceTree],
"hasServiceOrder": true,
"hasActiveServiceOrder": false,
"hasOpenServiceOrder": false,
"branchId": "xyz789"
}
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": "2026-09-18T17:42:23.846Z",
"active": false,
"increaseCounter": 123.45,
"timeIncrease": 987.65,
"timeUnit": "Day",
"equipment": EquipmentDefaults,
"stopEquipment": true,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65
}
T
MaintenanceOnUpdate
Fields
| Input Field | Description |
|---|---|
toCreate - [EquipmentMaintenanceInput!]!
|
|
toUpdate - [UpdateMaintenance!]!
|
|
toRemove - [String!]!
|
Example
{
"toCreate": [EquipmentMaintenanceInput],
"toUpdate": [UpdateMaintenance],
"toRemove": ["xyz789"]
}
T
MaintenancePhysicalResource
Example
{
"id": "xyz789",
"type": "Area",
"material": Material,
"product": Material,
"tool": Tool,
"warehouse": Warehouse,
"amount": 123.45
}
T
MaintenancePhysicalResourceInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
warehouseId - String
|
|
type - ResourceType!
|
|
amount - Float!
|
|
id - String
|
Example
{
"resourceId": "abc123",
"warehouseId": "xyz789",
"type": "Area",
"amount": 987.65,
"id": "abc123"
}
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": "abc123",
"thirdParty": ThirdParty,
"supplier": Supplier,
"type": "Area"
}
T
MaintenanceThirdPartyInput
Fields
| Input Field | Description |
|---|---|
thirdPartyResourceId - String!
|
|
supplierResourceId - String
|
|
type - ResourceType!
|
|
id - String
|
Example
{
"thirdPartyResourceId": "abc123",
"supplierResourceId": "xyz789",
"type": "Area",
"id": "abc123"
}
T
MaintenanceTime
Fields
| Input Field | Description |
|---|---|
timeIncrease - Float!
|
|
timeUnit - TimeUnitType!
|
Example
{"timeIncrease": 123.45, "timeUnit": "Day"}
T
MaintenanceTimeActive
Fields
| Field Name | Description |
|---|---|
timeIncrease - Float!
|
Valor do incremento |
timeUnit - TimeUnitType!
|
Unidade de tempo |
active - Boolean!
|
Indica se está ativo |
Example
{"timeIncrease": 123.45, "timeUnit": "Day", "active": true}
T
MaintenanceTree
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador do recurso |
area - Area
|
Área |
resources - [MaintenanceHumanResource!]
|
Recursos humanos |
Example
{
"id": "xyz789",
"area": Area,
"resources": [MaintenanceHumanResource]
}
T
Manufacturer
Example
{
"id": "xyz789",
"description": "abc123",
"isActive": false,
"referenceId": "xyz789",
"branchId": "abc123"
}
T
ManufacturerInput
T
ManufacturerQueryInput
T
ManufacturerUpdate
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": true,
"model": Model,
"group": Group,
"branchId": "abc123",
"resources": [MasterPlanResource]
}
T
MasterPlanCounter
Fields
| Field Name | Description |
|---|---|
counterIncrement - Float!
|
Valor |
counterUnit - CounterTypeIncrement!
|
Tipo de incremento |
active - Boolean!
|
Indica se está ativo |
Example
{"counterIncrement": 123.45, "counterUnit": "Hours", "active": true}
T
MasterPlanCounterInput
Fields
| Input Field | Description |
|---|---|
counterIncrement - Float!
|
|
counterUnit - CounterTypeIncrement!
|
|
active - Boolean!
|
Example
{"counterIncrement": 123.45, "counterUnit": "Hours", "active": false}
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": "abc123",
"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": "abc123",
"area": Area,
"resources": [HumanResource]
}
T
MasterPlanResourceInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
type - ResourceType!
|
|
resources - [HumanResourceInput!]
|
|
id - String
|
Example
{
"resourceId": "xyz789",
"type": "Area",
"resources": [HumanResourceInput],
"id": "abc123"
}
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": true,
"stopEquipment": true,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"maintenanceCounter": MasterPlanCounter,
"isImported": true,
"model": Model,
"group": Group,
"branchId": "abc123",
"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": 987.65,
"type": "Area"
}
T
MasterPlanThirdPartyInput
Fields
| Input Field | Description |
|---|---|
thirdPartyResourceId - String!
|
|
supplierResourceId - String
|
|
type - ResourceType!
|
|
id - String
|
Example
{
"thirdPartyResourceId": "xyz789",
"supplierResourceId": "abc123",
"type": "Area",
"id": "xyz789"
}
T
MasterPlanTime
Fields
| Field Name | Description |
|---|---|
timeIncrement - Float!
|
Valor |
timeUnit - TimeUnitType!
|
Unidade de tempo |
active - Boolean!
|
Indica se está ativo |
Example
{"timeIncrement": 123.45, "timeUnit": "Day", "active": true}
T
MasterPlanTimeInput
Fields
| Input Field | Description |
|---|---|
timeIncrement - Float!
|
|
timeUnit - TimeUnitType!
|
|
active - Boolean!
|
Example
{"timeIncrement": 123.45, "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": "xyz789",
"standardCost": 987.65,
"isActive": true,
"referenceId": "abc123",
"measurementUnit": NewMeasurementUnit,
"warehouse": Warehouse,
"isInMaintenance": false,
"branchId": "abc123",
"erpId": "abc123",
"stockLevels": [StockLevelOnMaterial],
"stockMovements": [StockMovementOnMaterial],
"isIntegrated": true
}
T
MaterialInput
Example
{
"description": "xyz789",
"measurementUnitId": "abc123",
"standardCost": 123.45,
"warehouseId": "abc123",
"levels": [StockLevelMaterialInput],
"branch": "abc123",
"isIntegrated": false,
"erpId": "abc123"
}
T
MaterialUpdate
Example
{
"id": "xyz789",
"description": "xyz789",
"measurementUnitId": "xyz789",
"warehouseId": "xyz789",
"standardCost": 123.45,
"isActive": true,
"levels": StockLevelMaterialUpdate
}
T
MeasurementUnit
T
MeasurementUnitInput
T
MeasurementUnitUpdate
T
MentionUser
T
Mentions
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
user - MentionUser!
|
Example
{
"id": "xyz789",
"user": MentionUser
}
T
Model
Example
{
"id": "xyz789",
"description": "xyz789",
"isActive": true,
"referenceId": "abc123",
"manufacturer": Manufacturer,
"branchId": "xyz789"
}
T
ModelInput
T
ModelQueryInput
T
ModelUpdate
T
NamedAttachment
T
NewBaseAttachmentArgs
Fields
| Input Field | Description |
|---|---|
newAttachments - [AttachmentUpload!]!
|
|
existentAttachments - [AttachmentDownload!]!
|
Example
{
"newAttachments": [AttachmentUpload],
"existentAttachments": [AttachmentDownload]
}
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": "abc123",
"name": "xyz789",
"acronym": "xyz789",
"isActive": true,
"branchId": "xyz789",
"erpId": "xyz789",
"description": "abc123",
"symbol": "abc123"
}
T
NewPaginatedMeasurementUnits
Fields
| Field Name | Description |
|---|---|
items - [NewMeasurementUnit!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [NewMeasurementUnit], "hasMore": false}
T
Observation
Example
{
"situation": "abc123",
"suggestedDate": "2026-09-18T17:42:23.846Z",
"minimumDate": "2026-09-18T17:42:23.846Z",
"deadline": "2026-03-18T17:42:23.846Z"
}
T
OrderBy
Values
| Enum Value | Description |
|---|---|
|
|
Crescente |
|
|
Decrescente |
Example
"Ascending"
T
PagedWallet
Fields
| Field Name | Description |
|---|---|
resourceItems - [ShallowResourceItem!]!
|
|
maintenanceResourceItems - [ShallowMaintenanceWallet!]!
|
|
serviceOrdersToSchedule - [ServiceOrder!]!
|
|
hasMore - Boolean!
|
Example
{
"resourceItems": [ShallowResourceItem],
"maintenanceResourceItems": [ShallowMaintenanceWallet],
"serviceOrdersToSchedule": [ServiceOrder],
"hasMore": true
}
T
PaginatedAreas
T
PaginatedCalendars
Fields
| Field Name | Description |
|---|---|
items - [Calendar!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Calendar], "hasMore": false}
T
PaginatedCostCenters
Fields
| Field Name | Description |
|---|---|
items - [CostCenter!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [CostCenter], "hasMore": true}
T
PaginatedCustomers
Fields
| Field Name | Description |
|---|---|
items - [CustomerPartner!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [CustomerPartner], "hasMore": false}
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": true}
T
PaginatedFeatures
Fields
| Field Name | Description |
|---|---|
items - [Feature!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Feature], "hasMore": true}
T
PaginatedGenericSpecialties
Fields
| Field Name | Description |
|---|---|
items - [GenericSpecialty!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [GenericSpecialty], "hasMore": false}
T
PaginatedGroups
T
PaginatedManufacturer
Fields
| Field Name | Description |
|---|---|
items - [Manufacturer!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Manufacturer], "hasMore": true}
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": true}
T
PaginatedModels
T
PaginatedReasons
Fields
| Field Name | Description |
|---|---|
items - [Reason!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Reason], "hasMore": false}
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": false}
T
PaginatedSpecialties
Fields
| Field Name | Description |
|---|---|
items - [Specialty!]!
|
Lista de registros |
hasMore - Boolean!
|
Indica se existem mais registros |
Example
{"items": [Specialty], "hasMore": true}
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": true,
"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": "abc123",
"type": "Area",
"amount": 987.65,
"material": Material,
"product": Material,
"tool": Tool,
"warehouse": Warehouse
}
T
PhysicalResourceInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
warehouseId - String
|
|
type - ResourceType!
|
|
amount - Float!
|
|
id - String
|
Example
{
"resourceId": "abc123",
"warehouseId": "xyz789",
"type": "Area",
"amount": 123.45,
"id": "xyz789"
}
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": "abc123",
"type": "Area",
"material": Material,
"product": Material,
"tool": Tool,
"warehouse": Warehouse,
"amount": 123.45,
"cost": 987.65,
"amountDone": 987.65,
"costDone": 987.65,
"foreseen": true,
"done": true,
"parentId": "abc123"
}
T
PhysicalResourceTreeInput
Fields
| Input Field | Description |
|---|---|
resourceId - String!
|
|
warehouseId - String
|
|
type - ResourceType!
|
|
amount - Float!
|
Example
{
"resourceId": "xyz789",
"warehouseId": "abc123",
"type": "Area",
"amount": 123.45
}
T
PhysicalResourceTreeUpdate
Example
{
"id": "xyz789",
"resourceId": "xyz789",
"warehouseId": "abc123",
"type": "Area",
"amount": 123.45,
"amountDone": 987.65,
"foreseen": true,
"done": false,
"parentId": "abc123"
}
T
PolicyAgreement
Example
{
"id": "xyz789",
"termId": "xyz789",
"userId": "abc123",
"ipAddress": "abc123",
"createdAt": "2026-09-18T17:42:23.846Z",
"userAgent": "xyz789"
}
T
PostingType
Values
| Enum Value | Description |
|---|---|
|
|
Gerado automaticamente pelo sistema |
|
|
Comentário de usuário |
Example
"Event"
T
QuerySchedule
Fields
| Input Field | Description |
|---|---|
startDate - DateTime!
|
|
endDate - DateTime!
|
|
identifier - String
|
|
filter - ScheduleFilter
|
Filtro |
Example
{
"startDate": "2026-03-18T17:42:23.846Z",
"endDate": "2026-03-18T17:42:23.846Z",
"identifier": "xyz789",
"filter": ScheduleFilter
}
T
Reason
Example
{
"id": "xyz789",
"description": "abc123",
"type": "Delay",
"isActive": true,
"referenceId": "abc123",
"branchId": "xyz789"
}
T
ReasonInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
type - ReasonType!
|
Example
{"description": "abc123", "type": "Delay"}
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
ReasonUpdate
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
description - String
|
|
type - ReasonType
|
|
isActive - Boolean
|
Example
{
"id": "xyz789",
"description": "xyz789",
"type": "Delay",
"isActive": false
}
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": "abc123",
"branchId": "xyz789",
"serviceOrderId": "abc123",
"type": "Area",
"areaId": "xyz789",
"employeeId": "xyz789",
"specialtyId": "abc123",
"thirdPartyId": "abc123",
"supplierId": "abc123",
"stepId": "xyz789",
"materialId": "xyz789",
"toolId": "abc123",
"warehouseId": "abc123",
"sequence": 987.65,
"areaDoneId": "abc123",
"employeeDoneId": "xyz789",
"thirdPartyDoneId": "abc123",
"supplierDoneId": "xyz789",
"stepDoneId": "xyz789",
"materialDoneId": "abc123",
"toolDoneId": "xyz789",
"warehouseDoneId": "xyz789",
"sequenceDone": 987.65,
"foreseen": false,
"done": false,
"startDate": "2026-09-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"amount": 123.45,
"response": "abc123",
"cost": 987.65,
"startDateDone": "2026-03-18T17:42:23.846Z",
"endDateDone": "2026-09-18T17:42:23.846Z",
"amountDone": 123.45,
"costDone": 123.45,
"parentId": "abc123",
"parentDoneId": "abc123",
"purchaseRequestId": "xyz789",
"createdAt": "2026-03-18T17:42:23.846Z",
"updatedAt": "2026-03-18T17:42:23.846Z"
}
T
Role
Example
{
"userId": "xyz789",
"branchId": "xyz789",
"roleId": "abc123",
"createdAt": "2026-03-18T17:42:23.846Z",
"branch": Branch
}
T
RolesWallet
T
S3UrlCloudFront
Example
S3UrlCloudFront
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": "xyz789",
"deadlineEvaluation": "Great",
"coveringEvaluation": "Great",
"observation": "abc123"
}
T
SatisfactionSurveyInput
Fields
| Input Field | Description |
|---|---|
deadlineEvaluation - EvaluationType!
|
|
coveringEvaluation - EvaluationType!
|
|
observation - String
|
|
serviceRequestId - String!
|
Example
{
"deadlineEvaluation": "Great",
"coveringEvaluation": "Great",
"observation": "xyz789",
"serviceRequestId": "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 |
code - StringRange
|
Intervalo de códigos de OS |
Example
{
"cardTypes": ["Maintenance"],
"customers": ["xyz789"],
"employees": ["abc123"],
"specialties": ["abc123"],
"groups": ["abc123"],
"tags": ["abc123"],
"criticalities": ["High"],
"costCenters": ["abc123"],
"priorities": ["Emergency"],
"serviceTypes": ["Corrective"],
"code": StringRange
}
T
SchedulesItems
Fields
| Field Name | Description |
|---|---|
scheduledResources - [ShallowResourceItem!]!
|
|
resourcesToSchedule - [ShallowResourceItem!]!
|
|
scheduledMaintenances - [ShallowMaintenanceSchedule!]!
|
|
maintenancesToSchedule - [ShallowMaintenanceSchedule!]!
|
|
serviceOrdersToSchedule - [ServiceOrder!]!
|
Example
{
"scheduledResources": [ShallowResourceItem],
"resourcesToSchedule": [ShallowResourceItem],
"scheduledMaintenances": [ShallowMaintenanceSchedule],
"maintenancesToSchedule": [ShallowMaintenanceSchedule],
"serviceOrdersToSchedule": [ServiceOrder]
}
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": "abc123",
"sensorId": "abc123",
"surfaceTemperature": 987.65,
"surfaceTemperatureThresholdWarning": 987.65,
"surfaceTemperatureThresholdCritical": 987.65,
"velX": 987.65,
"velXThresholdWarning": 123.45,
"velXThresholdCritical": 987.65,
"velY": 987.65,
"velYThresholdWarning": 123.45,
"velYThresholdCritical": 987.65,
"velZ": 123.45,
"velZThresholdWarning": 987.65,
"velZThresholdCritical": 987.65,
"lastTimestamp": "2026-03-18T17:42:23.846Z",
"health": 123.45,
"enabled": true,
"createdAt": "2026-09-18T17:42:23.846Z"
}
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": "xyz789",
"externalId": "xyz789",
"description": "abc123",
"mainPicture": S3UrlCloudFront,
"sensorType": "xyz789",
"hasSensorData": true,
"sensorData": [SensorDataEquipment]
}
T
SensorInput
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": "2026-03-18T17:42:23.846Z",
"endDate": "2026-03-18T17:42:23.846Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "xyz789",
"priority": 123.45,
"realStartDate": "2026-03-18T17:42:23.846Z",
"realEndDate": "2026-03-18T17:42:23.846Z",
"conclusion": 987.65,
"doneCost": 987.65,
"foreseenCost": 987.65,
"createdAt": "2026-09-18T17:42:23.846Z",
"areas": [AreaTree],
"resources": [ResourcesOnServiceOrder],
"followUp": [ServiceOrderFollowUp],
"stoppedAt": "2026-03-18T17:42:23.846Z",
"resumedAt": "2026-03-18T17:42:23.846Z",
"foreseenStoppedAt": "2026-09-18T17:42:23.846Z",
"foreseenResumedAt": "2026-09-18T17:42:23.846Z",
"updatedAt": "2026-09-18T17:42:23.846Z",
"operationTime": 123.45,
"hasDoneResource": true,
"hasDoneHuman": false,
"hasUnreportedThirdParty": false,
"generatedByServiceRequest": true,
"hasMaintenceByCounter": true,
"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": 987.65,
"doneProductCost": 123.45,
"foreseenThirdPartyCost": 987.65,
"doneThirdPartyCost": 123.45,
"branchId": "xyz789"
}
T
ServiceOrderAction
Values
| Enum Value | Description |
|---|---|
|
|
Abertura |
|
|
Abertura por SS |
|
|
Vinculação com SS |
|
|
Desvinculação com SS |
|
|
Reporte |
|
|
Reporte automático |
|
|
Reporte de finalizada |
|
|
Finalização |
|
|
Cancelamento |
|
|
Cancelamento em lote |
|
|
Edição |
|
|
Comentário de usuário |
Example
"Open"
T
ServiceOrderCommentInput
T
ServiceOrderCommentUpdate
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": "abc123",
"equipment": EquipmentDefaults,
"user": UserBasicInfo,
"service": "Corrective",
"situation": "Opened",
"startDate": "2026-03-18T17:42:23.846Z",
"endDate": "2026-03-18T17:42:23.846Z",
"attachments": [Attachment],
"maintenance": MaintenanceOnServiceOrder,
"cancellationReasonRef": Reason,
"costCenterRef": CostCenter,
"observation": "abc123",
"priority": 987.65,
"realStartDate": "2026-03-18T17:42:23.846Z",
"realEndDate": "2026-09-18T17:42:23.846Z",
"conclusion": 123.45,
"doneCost": 123.45,
"foreseenCost": 987.65,
"createdAt": "2026-03-18T17:42:23.846Z"
}
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 |
inServiceRequest - [ServiceOrderInRequest!]
|
Relação com solicitações de serviço |
tags - [String!]
|
TAGs de equipamentos |
conclusion - FloatRange
|
Intervalo de percentual de conclusão |
finishedAt - DateRange
|
Intervalo de tempo da finalização |
foreseenStoppedAt - DateRange
|
Intervalo de data de parada prevista início do equipamento |
stoppedAt - DateRange
|
Intervalo de data de parada real início do equipamento |
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": ["abc123"],
"customers": ["abc123"],
"equipmentOwnersType": ["Own"],
"groups": ["xyz789"],
"equipments": ["abc123"],
"inServiceRequest": ["With"],
"tags": ["xyz789"],
"conclusion": FloatRange,
"finishedAt": DateRange,
"foreseenStoppedAt": DateRange,
"stoppedAt": DateRange,
"foreseenCost": FloatRange,
"doneCost": FloatRange,
"foreseenEmployees": ["xyz789"],
"doneEmployees": ["abc123"],
"foreseenThirdParties": ["xyz789"],
"doneThirdParties": ["xyz789"],
"areas": ["xyz789"],
"specialties": ["xyz789"],
"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": "2026-03-18T17:42:23.846Z",
"id": "xyz789",
"description": "abc123",
"deletedAt": "2026-03-18T17:42:23.846Z",
"branchId": "xyz789",
"action": "Open",
"serviceRequestId": "abc123",
"requesterId": "xyz789",
"url": "xyz789"
}
T
ServiceOrderHome
Fields
| Field Name | Description |
|---|---|
id - String!
|
Código identificador |
code - String!
|
Código do serviço na filial |
situation - ServiceOrderSituation!
|
Tipo de situação |
startDate - DateTime!
|
Data de início |
equipment - EquipmentBasicInfo!
|
Equipamento |
conclusion - Float
|
Tempo de conclusão em horas |
doneCost - Float
|
Custo realizado |
foreseenCost - Float
|
Custo previsto |
priority - Float
|
Prioridade |
branchId - String
|
Código identificador da filial |
Example
{
"id": "xyz789",
"code": "xyz789",
"situation": "Opened",
"startDate": "2026-03-18T17:42:23.846Z",
"equipment": EquipmentBasicInfo,
"conclusion": 123.45,
"doneCost": 987.65,
"foreseenCost": 987.65,
"priority": 987.65,
"branchId": "xyz789"
}
T
ServiceOrderInRequest
Values
| Enum Value | Description |
|---|---|
|
|
Com ordem de serviço |
|
|
Sem ordem de serviço |
Example
"With"
T
ServiceOrderInput
Fields
| Input Field | Description |
|---|---|
equipment - String!
|
|
service - ServiceType!
|
|
priority - Float!
|
|
startDate - DateTime!
|
|
endDate - DateTime!
|
|
stoppedAt - DateTime
|
|
observation - String
|
|
maintenance - String
|
|
attachments - [NamedAttachment!]
|
|
areas - [AreaTreeInput!]
|
Example
{
"equipment": "abc123",
"service": "Corrective",
"priority": 987.65,
"startDate": "2026-03-18T17:42:23.846Z",
"endDate": "2026-03-18T17:42:23.846Z",
"stoppedAt": "2026-09-18T17:42:23.846Z",
"observation": "xyz789",
"maintenance": "abc123",
"attachments": [NamedAttachment],
"areas": [AreaTreeInput]
}
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
ServiceOrderReport
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
equipmentId - String
|
|
componentId - String
|
|
priority - Float
|
|
observation - String
|
|
startDate - DateTime
|
|
endDate - DateTime
|
|
areas - [AreaTreeUpdate!]
|
|
finishFields - DefaultFinishServiceOrder
|
Example
{
"id": "xyz789",
"equipmentId": "abc123",
"componentId": "xyz789",
"priority": 987.65,
"observation": "xyz789",
"startDate": "2026-09-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"areas": [AreaTreeUpdate],
"finishFields": DefaultFinishServiceOrder
}
T
ServiceOrderSettings
Fields
| Field Name | Description |
|---|---|
requesterSeeOwnServiceOrder - Boolean!
|
Solicitante pode visualizar a ordem de serviço de sua solicitação de serviço |
requiredEquipmentDowntime - Boolean!
|
Registro obrigatório do período de parada de equipamento ao finalizar OSs |
executorOpenCorrective - Boolean!
|
Executor pode abrir ordem de serviço corretiva |
executorOnlyPlayStop - Boolean!
|
Executor pode reportar apenas por play/stop (mobile) |
plannersNotifyOverdue - [String!]!
|
Planejadores a receber workflow de manutenções em atraso |
Example
{
"requesterSeeOwnServiceOrder": true,
"requiredEquipmentDowntime": false,
"executorOpenCorrective": false,
"executorOnlyPlayStop": false,
"plannersNotifyOverdue": ["abc123"]
}
T
ServiceOrderSituation
Values
| Enum Value | Description |
|---|---|
|
|
Aberta |
|
|
Cancelada |
|
|
Finalizada |
Example
"Opened"
T
ServiceOrderUpdateInput
Example
{
"id": "abc123",
"equipmentId": "xyz789",
"priority": 123.45,
"observation": "xyz789",
"startDate": "2026-03-18T17:42:23.846Z",
"endDate": "2026-03-18T17:42:23.846Z",
"stoppedAt": "2026-09-18T17:42:23.846Z",
"resumedAt": "2026-03-18T17:42:23.846Z",
"areas": [AreaTreeUpdate]
}
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 |
generatedServiceOrder - Boolean
|
Indica se a ordem de serviço foi gerada |
linkedServiceOrder - Boolean
|
Indica se a ordem de serviço foi vinculada |
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": "abc123",
"code": "xyz789",
"description": "xyz789",
"isAuto": false,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "abc123",
"runningTime": "xyz789",
"employee": Employee,
"reason": Reason,
"equipment": EquipmentDefaults,
"customer": CustomerPartner,
"serviceOrder": ServiceOrderDefaults,
"generatedServiceOrder": true,
"linkedServiceOrder": true,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-09-18T17:42:23.846Z",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"serviceTime": "xyz789",
"runTime": "xyz789",
"finishedAt": "2026-03-18T17:42:23.846Z",
"distributedAt": "2026-03-18T17:42:23.846Z",
"canceledAt": "2026-09-18T17:42:23.846Z",
"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 |
|
|
Vinculação com OS |
|
|
Desvinculação com 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
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 |
generatedServiceOrder - Boolean
|
Indica se a ordem de serviço foi gerada |
linkedServiceOrder - Boolean
|
Indica se a ordem de serviço foi vinculada |
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": "abc123",
"code": "abc123",
"description": "xyz789",
"isAuto": true,
"situation": "AwaitingAnalysis",
"priority": "Emergency",
"observation": "xyz789",
"runningTime": "abc123",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"reason": Reason,
"equipment": EquipmentDefaults,
"serviceOrder": ServiceOrderDefaults,
"generatedServiceOrder": true,
"linkedServiceOrder": true,
"satisfactionSurvey": SatisfactionSurvey,
"requester": User,
"createdAt": "2026-09-18T17:42:23.846Z",
"serviceTime": "xyz789",
"runTime": "xyz789",
"employee": Employee,
"finishedAt": "2026-09-18T17:42:23.846Z",
"distributedAt": "2026-03-18T17:42:23.846Z",
"canceledAt": "2026-03-18T17:42:23.846Z",
"customer": CustomerPartner,
"branchId": "xyz789",
"attachments": [Attachment]
}
T
ServiceRequestCancellation
T
ServiceRequestCommentInput
T
ServiceRequestCommentUpdate
T
ServiceRequestCreation
Example
{
"description": "xyz789",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"resumedAt": "2026-03-18T17:42:23.846Z",
"equipmentId": "xyz789",
"customerId": "abc123",
"attachments": [NamedAttachment]
}
T
ServiceRequestDistribution
Fields
| Input Field | Description |
|---|---|
priority - ServiceRequestPriority
|
|
employeeId - String
|
|
id - String!
|
Example
{
"priority": "Emergency",
"employeeId": "xyz789",
"id": "abc123"
}
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 |
stoppedAt - DateRange
|
Intervalo de data de parada real início do equipamento |
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": ["xyz789"],
"criticalities": ["High"],
"costCenters": ["xyz789"],
"situations": ["AwaitingAnalysis"],
"origin": ["ByUser"],
"customers": ["xyz789"],
"equipmentOwnersType": ["Own"],
"priorities": ["Emergency"],
"createdAt": DateRange,
"updatedAt": DateRange,
"stoppedAt": DateRange,
"openedBy": ["abc123"],
"distributedTo": ["abc123"]
}
T
ServiceRequestFinalization
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": "xyz789",
"mentions": [Mentions],
"lastEditedAt": "xyz789",
"historyComment": [HistoryComment],
"createdAt": "2026-09-18T17:42:23.846Z",
"id": "abc123",
"description": "xyz789",
"deletedAt": "2026-09-18T17:42:23.846Z",
"branchId": "abc123",
"action": "Comment",
"serviceOrderId": "xyz789",
"url": "abc123"
}
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": "abc123",
"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": "xyz789",
"code": "abc123",
"situation": "AwaitingAnalysis",
"requesterId": "abc123"
}
T
ServiceRequestSituation
Values
| Enum Value | Description |
|---|---|
|
|
Aguardando análise |
|
|
Distribuída |
|
|
Aguardando OS |
|
|
Aguardando resposta à pesquisa de satisfação |
|
|
Finalizada |
|
|
Cancelada |
Example
"AwaitingAnalysis"
T
ServiceRequestUpdate
Example
{
"id": "abc123",
"description": "xyz789",
"equipmentId": "abc123",
"customerId": "xyz789",
"stoppedAt": "2026-03-18T17:42:23.846Z",
"resumedAt": "2026-09-18T17:42:23.846Z",
"followUp": [FollowUpManualInput],
"serviceOrderId": "abc123"
}
T
ServiceType
Values
| Enum Value | Description |
|---|---|
|
|
Corretivo |
|
|
Melhoria |
|
|
Preventivo |
Example
"Corrective"
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": "abc123",
"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": 123.45,
"resourceId": "abc123",
"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": "xyz789",
"type": "Area",
"employee": Employee,
"specialty": Specialty,
"startDate": "2026-03-18T17:42:23.846Z",
"endDate": "2026-09-18T17:42:23.846Z",
"amount": 123.45,
"cost": 123.45,
"startDateDone": "2026-03-18T17:42:23.846Z",
"endDateDone": "2026-03-18T17:42:23.846Z",
"amountDone": 123.45,
"costDone": 987.65,
"foreseen": true,
"done": true,
"parentId": "xyz789",
"purchaseRequestId": "xyz789",
"serviceOrder": ServiceOrder
}
T
Specialty
Example
{
"id": "abc123",
"name": "xyz789",
"hourlyWage": 987.65,
"isActive": true,
"referenceId": "abc123",
"isInMaintenance": false
}
T
SpecialtyInput
T
SpecialtyUpdate
T
StarterEquipmentCreateInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
owner - EquipmentOwnerType!
|
|
mainPicture - String
|
|
customerId - String
|
|
attachments - [EquipmentAttachmentInput!]
|
Example
{
"description": "abc123",
"owner": "Own",
"mainPicture": "xyz789",
"customerId": "abc123",
"attachments": [EquipmentAttachmentInput]
}
T
StarterEquipmentCreateOutput
Example
{
"id": "xyz789",
"description": "xyz789",
"tag": "abc123",
"treeTag": "abc123",
"customer": BasicInformationName,
"isStarter": 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": "abc123",
"description": "abc123",
"isReported": true,
"averageTime": "abc123",
"requestResponse": true,
"type": "Number",
"measurementUnit": MeasurementUnit,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": true,
"branchId": "abc123"
}
T
StepInput
Example
{
"description": "xyz789",
"averageTime": "xyz789",
"requestResponse": false,
"type": "Number",
"measurementUnitId": "abc123",
"branch": "xyz789"
}
T
StepType
Values
| Enum Value | Description |
|---|---|
|
|
Numérico |
|
|
Data |
Example
"Number"
T
StepUpdate
Example
{
"id": "xyz789",
"description": "xyz789",
"averageTime": "xyz789",
"requestResponse": true,
"type": "Number",
"measurementUnitId": "xyz789",
"isActive": true
}
T
StockLevelMaterialInput
T
StockLevelMaterialUpdate
Fields
| Input Field | Description |
|---|---|
toCreate - [StockLevelMaterialInput!]!
|
|
toUpdate - [StockLevelUpdateInput!]!
|
|
toRemove - [String!]!
|
Example
{
"toCreate": [StockLevelMaterialInput],
"toUpdate": [StockLevelUpdateInput],
"toRemove": ["abc123"]
}
T
StockLevelOnMaterial
Example
{
"id": "abc123",
"physicalBalance": 123.45,
"amountBooked": 987.65,
"averageCost": 123.45,
"unitCost": 123.45,
"level": 123.45,
"minimumBalance": 123.45,
"warehouse": Warehouse
}
T
StockLevelUpdateInput
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": "abc123",
"type": "in",
"amount": 987.65,
"observation": "abc123",
"status": "done",
"amountConfirmed": 123.45,
"origin": "Manual",
"createdAt": "2026-09-18T17:42:23.846Z",
"movementDate": "2026-09-18T17:42:23.846Z",
"warehouse": Warehouse
}
T
StockMovementOrigin
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Manual"
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
"abc123"
T
StringRange
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": "abc123",
"isResource": "ServiceOrder",
"branchId": "abc123",
"erpId": "abc123"
}
T
SupplierInput
T
SupplierUpdate
T
TableFields
T
TablePreferences
Fields
| Field Name | Description |
|---|---|
listServiceOrders - TableFields
|
|
listServiceRequests - TableFields
|
|
listEquipments - TableFields
|
Example
{
"listServiceOrders": TableFields,
"listServiceRequests": TableFields,
"listEquipments": TableFields
}
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": 123.45,
"isActive": true,
"suppliers": [ThirdPartySupplierCost],
"isInMaintenance": true,
"branchId": "abc123"
}
T
ThirdPartyInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
|
standardCost - Float
|
|
suppliers - [ThirdPartySupplierRelation!]
|
|
branch - String
|
Example
{
"description": "abc123",
"standardCost": 987.65,
"suppliers": [ThirdPartySupplierRelation],
"branch": "abc123"
}
T
ThirdPartySupplierCost
Example
{
"id": "abc123",
"name": "abc123",
"isResource": "ServiceOrder",
"branchId": "xyz789",
"erpId": "abc123",
"cost": 123.45
}
T
ThirdPartySupplierRelation
T
ThirdPartySupplierRelationUpdate
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
suppliers - [ThirdPartySupplierRelation!]
|
Example
{
"id": "abc123",
"suppliers": [ThirdPartySupplierRelation]
}
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": "xyz789",
"thirdParty": ThirdParty,
"supplier": Supplier,
"type": "Area",
"foreseen": true,
"done": true,
"cost": 123.45,
"costDone": 987.65,
"parentId": "xyz789"
}
T
ThirdPartyTreeInput
Fields
| Input Field | Description |
|---|---|
thirdPartyResourceId - String!
|
|
supplierResourceId - String
|
|
cost - Float
|
|
type - ResourceType!
|
Example
{
"thirdPartyResourceId": "abc123",
"supplierResourceId": "xyz789",
"cost": 987.65,
"type": "Area"
}
T
ThirdPartyTreeUpdate
Example
{
"id": "xyz789",
"thirdPartyResourceId": "xyz789",
"supplierResourceId": "abc123",
"type": "Area",
"foreseen": false,
"done": false,
"cost": 123.45,
"costDone": 123.45,
"parentId": "abc123"
}
T
ThirdPartyUpdate
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
description - String
|
|
standardCost - Float
|
|
isActive - Boolean
|
|
suppliers - [ThirdPartySupplierRelation!]
|
Example
{
"id": "abc123",
"description": "xyz789",
"standardCost": 987.65,
"isActive": false,
"suppliers": [ThirdPartySupplierRelation]
}
T
TimePoint
Fields
| Field Name | Description |
|---|---|
day - DayOfWeek!
|
Dia da semana |
hour - String!
|
Hora do dia |
Example
{"day": "Sunday", "hour": "abc123"}
T
TimePointInput
Fields
| Input Field | Description |
|---|---|
day - DayOfWeek!
|
Dia da semana |
hour - String!
|
Hora do dia |
Example
{"day": "Sunday", "hour": "xyz789"}
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": "abc123",
"hourlyCost": 987.65,
"isActive": false,
"referenceId": "xyz789",
"isInMaintenance": true,
"branchId": "xyz789"
}
T
ToolInput
T
ToolUpdate
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": true,
"supplierType": "abc123",
"supplierClassifications": ["abc123"],
"productType": "xyz789",
"productClassifications": ["xyz789"],
"cost": 123.45,
"purposeCode": 987.65,
"expenseCode": 987.65,
"requester": 987.65
}
T
UpdateCounter
T
UpdateMaintenance
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
description - String
|
|
lastMaintenance - DateTime
|
|
counter - UpdateCounter!
|
|
time - UpdateTime!
|
|
skipWeekend - Boolean
|
|
stopEquipment - Boolean
|
|
hoursBeforeStop - Float
|
|
hoursAfterStop - Float
|
|
masterPlan - EquipmentMasterPlan!
|
|
active - Boolean
|
|
areas - [MaintenanceAreaInput!]
|
Example
{
"id": "abc123",
"description": "abc123",
"lastMaintenance": "2026-03-18T17:42:23.846Z",
"counter": UpdateCounter,
"time": UpdateTime,
"skipWeekend": false,
"stopEquipment": true,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 987.65,
"masterPlan": EquipmentMasterPlan,
"active": false,
"areas": [MaintenanceAreaInput]
}
T
UpdateMasterPlan
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
description - String
|
|
modelId - String
|
|
groupId - String
|
|
maintenanceTime - MasterPlanTimeInput!
|
|
maintenanceCounter - MasterPlanCounterInput!
|
|
skipWeekend - Boolean
|
|
stopEquipment - Boolean
|
|
hoursBeforeStop - Float
|
|
hoursAfterStop - Float
|
|
resources - [MasterPlanResourceInput!]!
|
Example
{
"id": "abc123",
"description": "xyz789",
"modelId": "abc123",
"groupId": "xyz789",
"maintenanceTime": MasterPlanTimeInput,
"maintenanceCounter": MasterPlanCounterInput,
"skipWeekend": true,
"stopEquipment": false,
"hoursBeforeStop": 987.65,
"hoursAfterStop": 123.45,
"resources": [MasterPlanResourceInput]
}
T
UpdateTime
Fields
| Input Field | Description |
|---|---|
timeIncrease - Float!
|
|
timeUnit - TimeUnitType!
|
|
active - Boolean!
|
Example
{"timeIncrease": 987.65, "timeUnit": "Day", "active": false}
T
Upload
Example
Upload
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": true,
"id": "4",
"name": "abc123",
"email": "abc123",
"accessBy": "Internal",
"employees": [Employee],
"verifiedEmail": "xyz789",
"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": "abc123",
"birthDate": "abc123",
"address": "abc123",
"educationLevel": "ElementarySchool",
"gender": "Male",
"mobileTourView": false,
"id": 4,
"name": "abc123",
"email": "abc123",
"accessBy": "Internal",
"employees": [Employee],
"verifiedEmail": "abc123",
"profilePicture": S3UrlCloudFront,
"restrictedBy": "abc123",
"preferences": UserPreferences,
"policiesAgreement": [PolicyAgreement]
}
T
UserGender
Values
| Enum Value | Description |
|---|---|
|
|
Masculino |
|
|
Feminino |
Example
"Male"
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 |
anonymizedAt - DateTime
|
Indica a data da anonimização do usuário |
Example
{
"name": "xyz789",
"id": "abc123",
"branches": ["abc123"],
"email": "xyz789",
"accessBy": "Internal",
"roleId": "abc123",
"status": "xyz789",
"profilePicture": S3UrlCloudFront,
"anonymizedAt": "2026-09-18T17:42:23.846Z"
}
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 |
tables - TablePreferences
|
Preferências para tabelas de visualização em lista |
designVersion - DesignVersion
|
Versão do design (layout) escolhida pelo usuário |
Example
{
"expandedSidebar": true,
"expandedWallet": true,
"showTree": true,
"printTotalCost": true,
"printImages": true,
"printFollowUp": true,
"exportTables": "xyz789",
"tables": TablePreferences,
"designVersion": "v1"
}
T
UserWallet
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String!
|
|
profilePicture - S3UrlCloudFront
|
|
roles - [RolesWallet!]!
|
Example
{
"id": "abc123",
"name": "xyz789",
"profilePicture": S3UrlCloudFront,
"roles": [RolesWallet]
}
T
UsersOnUpdate
Fields
| Input Field | Description |
|---|---|
toCreate - [UsersToInviteInput!]!
|
|
toActivate - [String!]!
|
|
toInactivate - [String!]!
|
|
toBlock - [String!]!
|
|
toUnblock - [String!]!
|
|
toCancel - [String!]!
|
|
toAnonymization - [String!]
|
Example
{
"toCreate": [UsersToInviteInput],
"toActivate": ["abc123"],
"toInactivate": ["abc123"],
"toBlock": ["abc123"],
"toUnblock": ["xyz789"],
"toCancel": ["xyz789"],
"toAnonymization": ["xyz789"]
}
T
UsersToInviteInput
T
UsingSupplier
Values
| Enum Value | Description |
|---|---|
|
|
Ordem de serviço |
|
|
Manutenção |
|
|
Plano mestre |
Example
"ServiceOrder"
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": "abc123",
"treeTag": "abc123",
"classification": "Equipment",
"description": "xyz789",
"criticality": "High",
"counterType": "Hours",
"dailyVariation": 123.45,
"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": "xyz789",
"description": "abc123",
"lastMaintenance": "2026-09-18T17:42:23.846Z",
"lastServiceOrder": DetailServiceOrder,
"active": true,
"increaseCounter": 987.65,
"timeIncrease": 987.65,
"timeUnit": "Day",
"skipWeekend": true,
"stopEquipment": true,
"hoursBeforeStop": 987.65,
"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": "abc123",
"description": "abc123",
"isActive": true,
"branchId": "abc123",
"erpId": "abc123",
"level": "xyz789"
}
T
WarehouseInput
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": "xyz789",
"identifier": "abc123",
"isActive": false,
"branchId": "abc123",
"isStockLevel": false,
"ignoreIds": ["abc123"]
}
T
WarehouseUpdate
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
}
T
WorkShiftInput
Fields
| Input Field | Description |
|---|---|
start - TimePointInput!
|
|
end - TimePointInput!
|
Example
{
"start": TimePointInput,
"end": TimePointInput
}
T
WorkShiftUpdate
Fields
| Input Field | Description |
|---|---|
id - String!
|
|
start - TimePointInput
|
|
end - TimePointInput
|
Example
{
"id": "xyz789",
"start": TimePointInput,
"end": TimePointInput
}