Keepfy API

Detalhamento das APIs de consumo do Keepfy

Contact

Contato

Terms of Service

https://keepfy.com/politica-de-privacidade/

API Endpoints

# Endpoint:
https://app.keepfy.com/graphql

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.

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.

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": "d917e25fcd1ea997b13a591f5fc7a66af5431d64905cf2f42c96c8329de741f3"
  }

Queries

`area`

Description

Retorna uma área

Response

Returns an Area!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query Area($id: String!) {
  area(id: $id) {
    id
    description
    isActive
    isInMaintenance
    branchId
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "area": {
      "id": "xyz789",
      "description": "abc123",
      "isActive": true,
      "isInMaintenance": true,
      "branchId": "abc123"
    }
  }
}

Queries

`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
      isInMaintenance
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{"data": {"areas": {"items": [Area], "hasMore": false}}}

Queries

`availability`

Description

Retorna indicadores de disponibilidade por criticidade e grupo

Response

Returns [CriticalityAndGroup!]!

Example

Query

query Availability {
  availability {
    criticalities {
      label
      result
    }
    groups {
      label
      result
      id
    }
    branchId
  }
}

Response

{
  "data": {
    "availability": [
      {
        "criticalities": [CriticalityBIData],
        "groups": [GroupBIData],
        "branchId": "xyz789"
      }
    ]
  }
}

Queries

`availabilityByCriticality`

Description

Retorna indicadores de disponibilidade por criticidade

Response

Returns [EquipmentBIData!]!

Arguments

Name	Description
`criticality` - `Scale!`	Filtro de criticidade

Example

Query

query AvailabilityByCriticality($criticality: Scale!) {
  availabilityByCriticality(criticality: $criticality) {
    id
    equipment
    costCenter
    calendar
    result
    criticality
    tag
    description
    branchId
  }
}

Variables

{"criticality": "High"}

Response

{
  "data": {
    "availabilityByCriticality": [
      {
        "id": "abc123",
        "equipment": "abc123",
        "costCenter": "abc123",
        "calendar": "xyz789",
        "result": 987.65,
        "criticality": "High",
        "tag": "abc123",
        "description": "xyz789",
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`availabilityByGroup`

Description

Retorna indicadores de disponibilidade por grupo

Response

Returns [EquipmentBIData!]!

Arguments

Name	Description
`groupId` - `String!`	Código identificador do grupo

Example

Query

query AvailabilityByGroup($groupId: String!) {
  availabilityByGroup(groupId: $groupId) {
    id
    equipment
    costCenter
    calendar
    result
    criticality
    tag
    description
    branchId
  }
}

Variables

{"groupId": "xyz789"}

Response

{
  "data": {
    "availabilityByGroup": [
      {
        "id": "xyz789",
        "equipment": "xyz789",
        "costCenter": "xyz789",
        "calendar": "xyz789",
        "result": 123.45,
        "criticality": "High",
        "tag": "xyz789",
        "description": "abc123",
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`availableBranches`

Description

Retorna filiais disponíveis para o usuário

Response

Returns [Branch!]!

Example

Query

query AvailableBranches {
  availableBranches {
    phoneNumber
    activityType
    zipCode
    street
    number
    neighborhood
    city
    state
    country
    complement
    timeZone
    mfmUser
    mfmPassword
    id
    organizationId
    name
    createdAt
    updatedAt
    documentNumber
    deletedAt
    settings {
      serviceOrder {
        ...ServiceOrderSettingsFragment
      }
      equipment {
        ...EquipmentSettingsFragment
      }
      inventory {
        ...InventorySettingsFragment
      }
      totvsModa {
        ...TotvsModaEndpointSettingsFragment
      }
    }
  }
}

Response

{
  "data": {
    "availableBranches": [
      {
        "phoneNumber": "abc123",
        "activityType": "AgricultureLivestockForestryAndAquaculture",
        "zipCode": "abc123",
        "street": "xyz789",
        "number": "xyz789",
        "neighborhood": "abc123",
        "city": "abc123",
        "state": "xyz789",
        "country": "xyz789",
        "complement": "xyz789",
        "timeZone": "xyz789",
        "mfmUser": "xyz789",
        "mfmPassword": "abc123",
        "id": "abc123",
        "organizationId": "abc123",
        "name": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "updatedAt": "2007-12-03T10:15:30Z",
        "documentNumber": "xyz789",
        "deletedAt": "2007-12-03T10:15:30Z",
        "settings": GlobalSettings
      }
    ]
  }
}

Queries

`back`

Description

Retorna indicadores de backlog da manutenção

Response

Returns [BasicIndicator!]!

Arguments

Name	Description
`filter` - `DateFilterInput`	Filtro de data

Example

Query

query Back($filter: DateFilterInput) {
  back(filter: $filter) {
    label
    result
    branchId
  }
}

Variables

{"filter": DateFilterInput}

Response

{
  "data": {
    "back": [
      {
        "label": "abc123",
        "result": 123.45,
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`calendar`

Description

Retorna um calendário

Response

Returns a Calendar!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query Calendar($id: String!) {
  calendar(id: $id) {
    id
    name
    isActive
    workShifts {
      id
      calendarId
      start {
        ...TimePointFragment
      }
      end {
        ...TimePointFragment
      }
    }
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "calendar": {
      "id": "abc123",
      "name": "xyz789",
      "isActive": false,
      "workShifts": [WorkShift]
    }
  }
}

Queries

`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
      }
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": CalendarQueryInput
}

Response

{
  "data": {
    "calendars": {"items": [Calendar], "hasMore": true}
  }
}

Queries

`cbe`

Description

Retorna indicatores de custo por equipamento

Response

Returns [CBEIndicator!]!

Example

Query

query Cbe {
  cbe {
    label
    total
    accumulatedCostPercentage
    purchase {
      value
      percentage
    }
    maintenance {
      value
      percentage
    }
  }
}

Response

{
  "data": {
    "cbe": [
      {
        "label": "xyz789",
        "total": 987.65,
        "accumulatedCostPercentage": 123.45,
        "purchase": ComparativeResult,
        "maintenance": ComparativeResult
      }
    ]
  }
}

Queries

`confiability`

Description

Retorna indicadores de confiabilidade por criticidade e grupo

Response

Returns [CriticalityAndGroup!]!

Example

Query

query Confiability {
  confiability {
    criticalities {
      label
      result
    }
    groups {
      label
      result
      id
    }
    branchId
  }
}

Response

{
  "data": {
    "confiability": [
      {
        "criticalities": [CriticalityBIData],
        "groups": [GroupBIData],
        "branchId": "xyz789"
      }
    ]
  }
}

Queries

`confiabilityByCriticality`

Description

Retorna indicadores de confiabilidade por criticidade

Response

Returns [EquipmentBIData!]!

Arguments

Name	Description
`criticality` - `Scale!`	Filtro de criticidade

Example

Query

query ConfiabilityByCriticality($criticality: Scale!) {
  confiabilityByCriticality(criticality: $criticality) {
    id
    equipment
    costCenter
    calendar
    result
    criticality
    tag
    description
    branchId
  }
}

Variables

{"criticality": "High"}

Response

{
  "data": {
    "confiabilityByCriticality": [
      {
        "id": "xyz789",
        "equipment": "xyz789",
        "costCenter": "xyz789",
        "calendar": "abc123",
        "result": 123.45,
        "criticality": "High",
        "tag": "abc123",
        "description": "abc123",
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`confiabilityByGroup`

Description

Retorna indicadores de confiabilidade por grupo

Response

Returns [EquipmentBIData!]!

Arguments

Name	Description
`groupId` - `String!`	Código identificador do grupo

Example

Query

query ConfiabilityByGroup($groupId: String!) {
  confiabilityByGroup(groupId: $groupId) {
    id
    equipment
    costCenter
    calendar
    result
    criticality
    tag
    description
    branchId
  }
}

Variables

{"groupId": "abc123"}

Response

{
  "data": {
    "confiabilityByGroup": [
      {
        "id": "abc123",
        "equipment": "abc123",
        "costCenter": "xyz789",
        "calendar": "xyz789",
        "result": 987.65,
        "criticality": "High",
        "tag": "abc123",
        "description": "xyz789",
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`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
    branchId
    erpId
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "costCenter": {
      "id": "abc123",
      "description": "xyz789",
      "isActive": false,
      "branchId": "xyz789",
      "erpId": "xyz789"
    }
  }
}

Queries

`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
      branchId
      erpId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": CostCenterQueryInput
}

Response

{
  "data": {
    "costCenters": {
      "items": [CostCenter],
      "hasMore": false
    }
  }
}

Queries

`counterEntries`

Description

Retorna contadores do equipamento

Response

Returns [Counter!]!

Arguments

Name	Description
`equipment` - `String!`	Código identificador do equipamento

Example

Query

query CounterEntries($equipment: String!) {
  counterEntries(equipment: $equipment) {
    id
    readAt
    position
    accumulatedPosition
    type
    serviceOrder {
      id
      code
      equipment {
        ...EquipmentDefaultsFragment
      }
      user {
        ...UserBasicInfoFragment
      }
      service
      situation
      startDate
      endDate
      attachments {
        ...AttachmentFragment
      }
      maintenance {
        ...MaintenanceOnServiceOrderFragment
      }
      cancellationReasonRef {
        ...ReasonFragment
      }
      costCenterRef {
        ...CostCenterFragment
      }
      observation
      priority
      realStartDate
      realEndDate
      conclusion
      doneCost
      foreseenCost
      createdAt
      areas {
        ...AreaTreeFragment
      }
      resources {
        ...ResourcesOnServiceOrderFragment
      }
      followUp {
        ...ServiceOrderFollowUpFragment
      }
      stoppedAt
      resumedAt
      foreseenStoppedAt
      foreseenResumedAt
      updatedAt
      operationTime
      hasDoneResource
      hasDoneHuman
      hasUnreportedThirdParty
      generatedByServiceRequest
      hasMaintenceByCounter
      serviceRequest {
        ...ServiceRequestRefFragment
      }
      finalizationObservation
      cancellationObservation
      counter {
        ...CounterFragment
      }
      foreseenEmployeeCost
      doneEmployeeCost
      foreseenToolCost
      doneToolCost
      foreseenMaterialCost
      doneMaterialCost
      foreseenThirdPartyCost
      doneThirdPartyCost
      branchId
    }
    dailyVariation
    branchId
  }
}

Variables

{"equipment": "xyz789"}

Response

{
  "data": {
    "counterEntries": [
      {
        "id": "abc123",
        "readAt": "2007-12-03T10:15:30Z",
        "position": 987.65,
        "accumulatedPosition": 987.65,
        "type": "Inform",
        "serviceOrder": ServiceOrder,
        "dailyVariation": 987.65,
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`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
    availability
    realAvailability
    startDate
    endDate
    isActive
    calendar {
      id
      name
      isActive
      workShifts {
        ...WorkShiftFragment
      }
    }
    specialties {
      id
      name
      hourlyWage
      isActive
      isInMaintenance
    }
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "employee": {
      "id": "xyz789",
      "user": User,
      "hourlyWage": 123.45,
      "availability": 123.45,
      "realAvailability": 123.45,
      "startDate": "xyz789",
      "endDate": "xyz789",
      "isActive": false,
      "calendar": Calendar,
      "specialties": [Specialty]
    }
  }
}

Queries

`employees`

Description

Retorna funcionários

Response

Returns a PaginatedEmployees!

Arguments

Name	Description
`endDate` - `String`	Data de fim do serviço de mão de obra
`startDate` - `String`	Data de início do serviço de mão de obra
`pagination` - `Pagination`	Parâmetros da paginação
`query` - `PaginationDefaultQueryInput!`	Parâmetros da pesquisa

Example

Query

query Employees(
  $endDate: String,
  $startDate: String,
  $pagination: Pagination,
  $query: PaginationDefaultQueryInput!
) {
  employees(
    endDate: $endDate,
    startDate: $startDate,
    pagination: $pagination,
    query: $query
  ) {
    items {
      id
      user {
        ...UserFragment
      }
      hourlyWage
      availability
      realAvailability
      startDate
      endDate
      isActive
      calendar {
        ...CalendarFragment
      }
      specialties {
        ...SpecialtyFragment
      }
    }
    hasMore
  }
}

Variables

{
  "endDate": "xyz789",
  "startDate": "xyz789",
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{
  "data": {
    "employees": {
      "items": [FullEmployee],
      "hasMore": false
    }
  }
}

Queries

`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
      }
    }
    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
      manufacturer {
        ...ManufacturerFragment
      }
      branchId
    }
    group {
      id
      name
      isActive
      referenceId
      branchId
    }
    costCenter {
      id
      description
      isActive
      branchId
      erpId
    }
    calendar {
      id
      name
      isActive
      workShifts {
        ...WorkShiftFragment
      }
    }
    releaseReason {
      id
      description
      type
      isActive
      referenceId
      isUsed
      branchId
    }
    customer {
      documentNumber
      daytimePhoneNumber
      phoneNumber
      email
      address
      number
      complement
      zipCode
      neighborhood
      city
      state
      country
      description
      customerPicture
      customerPictureKey
      attachments {
        ...AttachmentFragment
      }
      branch {
        ...BranchFragment
      }
      users {
        ...UserOrganizationListingFragment
      }
      agreements {
        ...CustomerAgreementFragment
      }
      id
      type
      name
      isActive
    }
    criticality
    attachments {
      id
      filename
      contentType
      contentLength
      url
      uploadedBy
      createdAt
      uploadUrl
      isMainPicture
    }
    sensors {
      id
      externalId
      description
      mainPicture
      sensorType
      hasSensorData
      sensorData {
        ...SensorDataEquipmentFragment
      }
    }
    mainAttachmentUrl
    availability
    tagDescription
    equipmentsStructure {
      id
      description
      tag
      treeTag
      tagDescription
      classification
    }
    maintenances {
      equipmentId
      maintenance
      active
      description
      lastMaintenance
      skipWeekend
      stopEquipment
      hoursBeforeStop
      hoursAfterStop
      detail {
        ...DetailMaintenanceFragment
      }
      maintenanceCounter {
        ...MaintenanceCounterActiveFragment
      }
      maintenanceTime {
        ...MaintenanceTimeActiveFragment
      }
      lastServiceOrder {
        ...DetailServiceOrderFragment
      }
      nextMaintenance {
        ...DetailServiceOrderFragment
      }
      realNextMaintenanceDate
      masterPlan {
        ...MasterPlanOnEquipmentFragment
      }
      observation {
        ...ObservationFragment
      }
      areas {
        ...MaintenanceTreeFragment
      }
      hasServiceOrder
      hasActiveServiceOrder
      branchId
    }
    isLastPositionDifferent
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "equipment": {
      "isInTree": true,
      "treeTag": "abc123",
      "serial": "abc123",
      "purchaseDate": "abc123",
      "purchaseValue": 123.45,
      "warranty": 987.65,
      "warrantyDate": "xyz789",
      "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": "abc123",
      "isStarter": false,
      "tag": "xyz789",
      "previousTags": "abc123",
      "classification": "Equipment",
      "isMaintenanceActive": false,
      "owner": "Own",
      "situation": "Active",
      "properties": [EquipmentProperty],
      "counterEntries": [Counter],
      "model": Model,
      "group": Group,
      "costCenter": CostCenter,
      "calendar": Calendar,
      "releaseReason": Reason,
      "customer": CustomerPartner,
      "criticality": "High",
      "attachments": [EquipmentAttachment],
      "sensors": [SensorEquipment],
      "mainAttachmentUrl": "xyz789",
      "availability": 987.65,
      "tagDescription": "abc123",
      "equipmentsStructure": [EquipmentStructure],
      "maintenances": [MaintenanceOnEquipment],
      "isLastPositionDifferent": true
    }
  }
}

Queries

`equipmentByTag`

Description

Retorna um equipamento

Response

Returns an EquipmentWithMaintenance!

Arguments

Name	Description
`tag` - `String!`	TAG do equipamento

Example

Query

query EquipmentByTag($tag: String!) {
  equipmentByTag(tag: $tag) {
    isInTree
    treeTag
    serial
    purchaseDate
    purchaseValue
    warranty
    warrantyDate
    warrantyUnit
    counterType
    counterLimit
    releaseReasonId
    releaseDate
    dailyVariation
    counterAmount
    accumulatedPosition
    canUpdateLimit
    branch {
      phoneNumber
      activityType
      zipCode
      street
      number
      neighborhood
      city
      state
      country
      complement
      timeZone
      mfmUser
      mfmPassword
      id
      organizationId
      name
      createdAt
      updatedAt
      documentNumber
      deletedAt
      settings {
        ...GlobalSettingsFragment
      }
    }
    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
      manufacturer {
        ...ManufacturerFragment
      }
      branchId
    }
    group {
      id
      name
      isActive
      referenceId
      branchId
    }
    costCenter {
      id
      description
      isActive
      branchId
      erpId
    }
    calendar {
      id
      name
      isActive
      workShifts {
        ...WorkShiftFragment
      }
    }
    releaseReason {
      id
      description
      type
      isActive
      referenceId
      isUsed
      branchId
    }
    customer {
      documentNumber
      daytimePhoneNumber
      phoneNumber
      email
      address
      number
      complement
      zipCode
      neighborhood
      city
      state
      country
      description
      customerPicture
      customerPictureKey
      attachments {
        ...AttachmentFragment
      }
      branch {
        ...BranchFragment
      }
      users {
        ...UserOrganizationListingFragment
      }
      agreements {
        ...CustomerAgreementFragment
      }
      id
      type
      name
      isActive
    }
    criticality
    attachments {
      id
      filename
      contentType
      contentLength
      url
      uploadedBy
      createdAt
      uploadUrl
      isMainPicture
    }
    sensors {
      id
      externalId
      description
      mainPicture
      sensorType
      hasSensorData
      sensorData {
        ...SensorDataEquipmentFragment
      }
    }
    mainAttachmentUrl
    availability
    tagDescription
    equipmentsStructure {
      id
      description
      tag
      treeTag
      tagDescription
      classification
    }
    maintenances {
      equipmentId
      maintenance
      active
      description
      lastMaintenance
      skipWeekend
      stopEquipment
      hoursBeforeStop
      hoursAfterStop
      detail {
        ...DetailMaintenanceFragment
      }
      maintenanceCounter {
        ...MaintenanceCounterActiveFragment
      }
      maintenanceTime {
        ...MaintenanceTimeActiveFragment
      }
      lastServiceOrder {
        ...DetailServiceOrderFragment
      }
      nextMaintenance {
        ...DetailServiceOrderFragment
      }
      realNextMaintenanceDate
      masterPlan {
        ...MasterPlanOnEquipmentFragment
      }
      observation {
        ...ObservationFragment
      }
      areas {
        ...MaintenanceTreeFragment
      }
      hasServiceOrder
      hasActiveServiceOrder
      branchId
    }
    isLastPositionDifferent
  }
}

Variables

{"tag": "xyz789"}

Response

{
  "data": {
    "equipmentByTag": {
      "isInTree": false,
      "treeTag": "abc123",
      "serial": "abc123",
      "purchaseDate": "abc123",
      "purchaseValue": 987.65,
      "warranty": 123.45,
      "warrantyDate": "abc123",
      "warrantyUnit": "Day",
      "counterType": "Hours",
      "counterLimit": "SixDigits",
      "releaseReasonId": "xyz789",
      "releaseDate": "abc123",
      "dailyVariation": 123.45,
      "counterAmount": 123.45,
      "accumulatedPosition": 987.65,
      "canUpdateLimit": true,
      "branch": Branch,
      "id": "xyz789",
      "description": "xyz789",
      "isStarter": true,
      "tag": "abc123",
      "previousTags": "xyz789",
      "classification": "Equipment",
      "isMaintenanceActive": true,
      "owner": "Own",
      "situation": "Active",
      "properties": [EquipmentProperty],
      "counterEntries": [Counter],
      "model": Model,
      "group": Group,
      "costCenter": CostCenter,
      "calendar": Calendar,
      "releaseReason": Reason,
      "customer": CustomerPartner,
      "criticality": "High",
      "attachments": [EquipmentAttachment],
      "sensors": [SensorEquipment],
      "mainAttachmentUrl": "abc123",
      "availability": 987.65,
      "tagDescription": "xyz789",
      "equipmentsStructure": [EquipmentStructure],
      "maintenances": [MaintenanceOnEquipment],
      "isLastPositionDifferent": true
    }
  }
}

Queries

`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"
    }
  }
}

Queries

`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
      classification
      isMaintenanceActive
      availability
      group {
        ...BasicInformationNameFragment
      }
      model {
        ...BasicInformationDescriptionFragment
      }
      counterType
      counterLimit
      situation
      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
    }
  }
}

Queries

`feature`

Description

Retorna uma característica

Response

Returns a Feature!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query Feature($id: String!) {
  feature(id: $id) {
    id
    description
    type
    isActive
    isInEquipment
    branchId
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "feature": {
      "id": "abc123",
      "description": "abc123",
      "type": "String",
      "isActive": true,
      "isInEquipment": false,
      "branchId": "xyz789"
    }
  }
}

Queries

`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
      isInEquipment
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": FeatureQueryInput
}

Response

{
  "data": {
    "features": {"items": [Feature], "hasMore": false}
  }
}

Queries

`foreseenServiceOrder`

Description

Retorna uma ordem de serviço com os recursos previstos apenas

Response

Returns a ServiceOrder!

Arguments

Name	Description
`keepMaterial` - `Boolean`	Indica se deve manter materiais na árvore de recursos em vez de produtos
`id` - `String!`	Código identificador

Example

Query

query ForeseenServiceOrder(
  $keepMaterial: Boolean,
  $id: String!
) {
  foreseenServiceOrder(
    keepMaterial: $keepMaterial,
    id: $id
  ) {
    id
    code
    equipment {
      isInTree
      treeTag
      serial
      purchaseDate
      purchaseValue
      warranty
      warrantyDate
      warrantyUnit
      counterType
      counterLimit
      releaseReasonId
      releaseDate
      dailyVariation
      counterAmount
      accumulatedPosition
      canUpdateLimit
      branch {
        ...BranchFragment
      }
      id
      description
      isStarter
      tag
      previousTags
      classification
      isMaintenanceActive
      owner
      situation
      properties {
        ...EquipmentPropertyFragment
      }
      counterEntries {
        ...CounterFragment
      }
      model {
        ...ModelFragment
      }
      group {
        ...GroupFragment
      }
      costCenter {
        ...CostCenterFragment
      }
      calendar {
        ...CalendarFragment
      }
      releaseReason {
        ...ReasonFragment
      }
      customer {
        ...CustomerPartnerFragment
      }
      criticality
      attachments {
        ...EquipmentAttachmentFragment
      }
      sensors {
        ...SensorEquipmentFragment
      }
      mainAttachmentUrl
      availability
      tagDescription
      equipmentsStructure {
        ...EquipmentStructureFragment
      }
    }
    user {
      documentNumber
      birthDate
      address
      educationLevel
      gender
      mobileTourView
      id
      name
      email
      accessBy
      employees {
        ...EmployeeFragment
      }
      verifiedEmail
      profilePicture
      restrictedBy
      preferences {
        ...UserPreferencesFragment
      }
      policiesAgreement {
        ...PolicyAgreementFragment
      }
    }
    service
    situation
    startDate
    endDate
    attachments {
      id
      filename
      contentType
      contentLength
      url
      uploadedBy
      createdAt
      uploadUrl
    }
    maintenance {
      id
      description
      lastMaintenance
      active
      increaseCounter
      timeIncrease
      timeUnit
      equipment {
        ...EquipmentDefaultsFragment
      }
      stopEquipment
      hoursBeforeStop
      hoursAfterStop
    }
    cancellationReasonRef {
      id
      description
      type
      isActive
      referenceId
      isUsed
      branchId
    }
    costCenterRef {
      id
      description
      isActive
      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
    }
    followUp {
      type
      user {
        ...UserFragment
      }
      createdAt
      id
      description
      deletedAt
      branchId
      action
      serviceRequestId
      requesterId
    }
    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
    doneMaterialCost
    foreseenThirdPartyCost
    doneThirdPartyCost
    branchId
  }
}

Variables

{"keepMaterial": true, "id": "abc123"}

Response

{
  "data": {
    "foreseenServiceOrder": {
      "id": "abc123",
      "code": "xyz789",
      "equipment": EquipmentDefaults,
      "user": UserBasicInfo,
      "service": "Corrective",
      "situation": "Opened",
      "startDate": "2007-12-03T10:15:30Z",
      "endDate": "2007-12-03T10:15:30Z",
      "attachments": [Attachment],
      "maintenance": MaintenanceOnServiceOrder,
      "cancellationReasonRef": Reason,
      "costCenterRef": CostCenter,
      "observation": "abc123",
      "priority": 987.65,
      "realStartDate": "2007-12-03T10:15:30Z",
      "realEndDate": "2007-12-03T10:15:30Z",
      "conclusion": 123.45,
      "doneCost": 123.45,
      "foreseenCost": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "areas": [AreaTree],
      "resources": [ResourcesOnServiceOrder],
      "followUp": [ServiceOrderFollowUp],
      "stoppedAt": "2007-12-03T10:15:30Z",
      "resumedAt": "2007-12-03T10:15:30Z",
      "foreseenStoppedAt": "2007-12-03T10:15:30Z",
      "foreseenResumedAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "operationTime": 123.45,
      "hasDoneResource": false,
      "hasDoneHuman": false,
      "hasUnreportedThirdParty": true,
      "generatedByServiceRequest": true,
      "hasMaintenceByCounter": true,
      "serviceRequest": ServiceRequestRef,
      "finalizationObservation": "abc123",
      "cancellationObservation": "abc123",
      "counter": Counter,
      "foreseenEmployeeCost": 123.45,
      "doneEmployeeCost": 123.45,
      "foreseenToolCost": 123.45,
      "doneToolCost": 987.65,
      "foreseenMaterialCost": 987.65,
      "doneMaterialCost": 987.65,
      "foreseenThirdPartyCost": 123.45,
      "doneThirdPartyCost": 123.45,
      "branchId": "xyz789"
    }
  }
}

Queries

`group`

Description

Retorna um grupo

Response

Returns a Group!

Arguments

Name	Description
`id` - `String!`	Código identificador

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": false,
      "referenceId": "xyz789",
      "branchId": "xyz789"
    }
  }
}

Queries

`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}}}

Queries

`indicatorSummary`

Description

Retorna indicadores resumidos por filial

Response

Returns [BasicIndicator!]!

Example

Query

query IndicatorSummary {
  indicatorSummary {
    label
    result
    branchId
  }
}

Response

{
  "data": {
    "indicatorSummary": [
      {
        "label": "xyz789",
        "result": 987.65,
        "branchId": "xyz789"
      }
    ]
  }
}

Queries

`isSupplierResource`

Description

Retorna se um fornecedor é utilizado como recurso com seu serviço de terceiro

Response

Returns a UsingSupplier

Arguments

Name	Description
`thirdPartyId` - `String!`	Código identificador do serviço de terceiro
`id` - `String!`	Código identificador

Example

Query

query IsSupplierResource(
  $thirdPartyId: String!,
  $id: String!
) {
  isSupplierResource(
    thirdPartyId: $thirdPartyId,
    id: $id
  )
}

Variables

{
  "thirdPartyId": "abc123",
  "id": "xyz789"
}

Response

{"data": {"isSupplierResource": "ServiceOrder"}}

Queries

`maintenance`

Description

Retorna um plano de manutenção

Response

Returns a Maintenance!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query Maintenance($id: String!) {
  maintenance(id: $id) {
    id
    description
    lastMaintenance
    active
    maintenanceCounter {
      increaseCounter
      active
    }
    maintenanceTime {
      timeIncrease
      timeUnit
      active
    }
    skipWeekend
    stopEquipment
    hoursBeforeStop
    hoursAfterStop
    equipment {
      isInTree
      treeTag
      serial
      purchaseDate
      purchaseValue
      warranty
      warrantyDate
      warrantyUnit
      counterType
      counterLimit
      releaseReasonId
      releaseDate
      dailyVariation
      counterAmount
      accumulatedPosition
      canUpdateLimit
      branch {
        ...BranchFragment
      }
      id
      description
      isStarter
      tag
      previousTags
      classification
      isMaintenanceActive
      owner
      situation
      properties {
        ...EquipmentPropertyFragment
      }
      counterEntries {
        ...CounterFragment
      }
      model {
        ...ModelFragment
      }
      group {
        ...GroupFragment
      }
      costCenter {
        ...CostCenterFragment
      }
      calendar {
        ...CalendarFragment
      }
      releaseReason {
        ...ReasonFragment
      }
      customer {
        ...CustomerPartnerFragment
      }
      criticality
      attachments {
        ...EquipmentAttachmentFragment
      }
      sensors {
        ...SensorEquipmentFragment
      }
      mainAttachmentUrl
      availability
      tagDescription
      equipmentsStructure {
        ...EquipmentStructureFragment
      }
    }
    areas {
      id
      area {
        ...AreaFragment
      }
      resources {
        ...MaintenanceHumanResourceFragment
      }
    }
    branchId
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "maintenance": {
      "id": "xyz789",
      "description": "abc123",
      "lastMaintenance": "2007-12-03T10:15:30Z",
      "active": true,
      "maintenanceCounter": MaintenanceCounterActive,
      "maintenanceTime": MaintenanceTimeActive,
      "skipWeekend": false,
      "stopEquipment": false,
      "hoursBeforeStop": 123.45,
      "hoursAfterStop": 123.45,
      "equipment": EquipmentDefaults,
      "areas": [MaintenanceTree],
      "branchId": "abc123"
    }
  }
}

Queries

`maintenanceByEquipment`

Description

Retorna manutenções de um equipamento

Response

Returns [MaintenanceOnEquipment!]!

Arguments

Name	Description
`equipment` - `String!`	Código identificador do equipamento

Example

Query

query MaintenanceByEquipment($equipment: String!) {
  maintenanceByEquipment(equipment: $equipment) {
    equipmentId
    maintenance
    active
    description
    lastMaintenance
    skipWeekend
    stopEquipment
    hoursBeforeStop
    hoursAfterStop
    detail {
      increase
      unit
    }
    maintenanceCounter {
      increaseCounter
      active
    }
    maintenanceTime {
      timeIncrease
      timeUnit
      active
    }
    lastServiceOrder {
      serviceOrderId
      serviceOrder
      date
      situation
      counter {
        ...CounterFragment
      }
    }
    nextMaintenance {
      serviceOrderId
      serviceOrder
      date
      situation
      counter {
        ...CounterFragment
      }
    }
    realNextMaintenanceDate
    masterPlan {
      active
      id
    }
    observation {
      situation
      suggestedDate
      minimumDate
      deadline
    }
    areas {
      id
      area {
        ...AreaFragment
      }
      resources {
        ...MaintenanceHumanResourceFragment
      }
    }
    hasServiceOrder
    hasActiveServiceOrder
    branchId
  }
}

Variables

{"equipment": "xyz789"}

Response

{
  "data": {
    "maintenanceByEquipment": [
      {
        "equipmentId": "abc123",
        "maintenance": "abc123",
        "active": true,
        "description": "abc123",
        "lastMaintenance": "2007-12-03T10:15:30Z",
        "skipWeekend": false,
        "stopEquipment": true,
        "hoursBeforeStop": 987.65,
        "hoursAfterStop": 123.45,
        "detail": [DetailMaintenance],
        "maintenanceCounter": MaintenanceCounterActive,
        "maintenanceTime": MaintenanceTimeActive,
        "lastServiceOrder": DetailServiceOrder,
        "nextMaintenance": DetailServiceOrder,
        "realNextMaintenanceDate": "2007-12-03T10:15:30Z",
        "masterPlan": MasterPlanOnEquipment,
        "observation": Observation,
        "areas": [MaintenanceTree],
        "hasServiceOrder": true,
        "hasActiveServiceOrder": true,
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`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
    branchId
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "manufacturer": {
      "id": "abc123",
      "description": "xyz789",
      "isActive": true,
      "branchId": "xyz789"
    }
  }
}

Queries

`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
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": ManufacturerQueryInput
}

Response

{
  "data": {
    "manufacturers": {
      "items": [Manufacturer],
      "hasMore": false
    }
  }
}

Queries

`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
      manufacturer {
        ...ManufacturerFragment
      }
      branchId
    }
    group {
      id
      name
      isActive
      referenceId
      branchId
    }
    branchId
    resources {
      id
      area {
        ...AreaFragment
      }
      resources {
        ...HumanResourceFragment
      }
    }
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "masterPlan": {
      "id": "xyz789",
      "description": "xyz789",
      "maintenanceTime": MasterPlanTime,
      "skipWeekend": true,
      "stopEquipment": true,
      "hoursBeforeStop": 987.65,
      "hoursAfterStop": 987.65,
      "maintenanceCounter": MasterPlanCounter,
      "isImported": false,
      "model": Model,
      "group": Group,
      "branchId": "xyz789",
      "resources": [MasterPlanResource]
    }
  }
}

Queries

`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
    }
  }
}

Queries

`material`

Description

Retorna um material

Response

Returns a Material!

Arguments

Name	Description
`branchId` - `String`	Código da filial para pesquisa
`id` - `String!`	Código identificador

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
    }
    isInMaintenance
    branchId
    erpId
  }
}

Variables

{
  "branchId": "xyz789",
  "id": "xyz789"
}

Response

{
  "data": {
    "material": {
      "id": "abc123",
      "description": "xyz789",
      "standardCost": 123.45,
      "isActive": false,
      "referenceId": "abc123",
      "measurementUnit": NewMeasurementUnit,
      "isInMaintenance": true,
      "branchId": "xyz789",
      "erpId": "xyz789"
    }
  }
}

Queries

`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
      }
      isInMaintenance
      branchId
      erpId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{
  "data": {
    "materials": {"items": [Material], "hasMore": true}
  }
}

Queries

`mct`

Description

Retorna indicatores de custo total de manutenção

Response

Returns [MCTIndicator!]!

Arguments

Name	Description
`filter` - `DateFilterInput`	Filtro de data

Example

Query

query Mct($filter: DateFilterInput) {
  mct(filter: $filter) {
    label
    total
    corrective
    preventive
    improvement
    accumulatedCost
    branchId
  }
}

Variables

{"filter": DateFilterInput}

Response

{
  "data": {
    "mct": [
      {
        "label": "xyz789",
        "total": 123.45,
        "corrective": 987.65,
        "preventive": 987.65,
        "improvement": 987.65,
        "accumulatedCost": 987.65,
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`meanTimeBetweenFailures`

Description

Retorna indicadores de tempo médio entre falhas por criticidade e grupo

Response

Returns [CriticalityAndGroup!]!

Example

Query

query MeanTimeBetweenFailures {
  meanTimeBetweenFailures {
    criticalities {
      label
      result
    }
    groups {
      label
      result
      id
    }
    branchId
  }
}

Response

{
  "data": {
    "meanTimeBetweenFailures": [
      {
        "criticalities": [CriticalityBIData],
        "groups": [GroupBIData],
        "branchId": "xyz789"
      }
    ]
  }
}

Queries

`meanTimeBetweenFailuresByCriticality`

Description

Retorna indicadores de tempo médio entre falhas por criticidade

Response

Returns [EquipmentBIData!]!

Arguments

Name	Description
`criticality` - `Scale!`	Filtro de criticidade

Example

Query

query MeanTimeBetweenFailuresByCriticality($criticality: Scale!) {
  meanTimeBetweenFailuresByCriticality(criticality: $criticality) {
    id
    equipment
    costCenter
    calendar
    result
    criticality
    tag
    description
    branchId
  }
}

Variables

{"criticality": "High"}

Response

{
  "data": {
    "meanTimeBetweenFailuresByCriticality": [
      {
        "id": "abc123",
        "equipment": "abc123",
        "costCenter": "abc123",
        "calendar": "xyz789",
        "result": 987.65,
        "criticality": "High",
        "tag": "xyz789",
        "description": "xyz789",
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`meanTimeBetweenFailuresByGroup`

Description

Retorna indicadores de tempo médio entre falhas por grupo

Response

Returns [EquipmentBIData!]!

Arguments

Name	Description
`groupId` - `String!`	Código identificador do grupo

Example

Query

query MeanTimeBetweenFailuresByGroup($groupId: String!) {
  meanTimeBetweenFailuresByGroup(groupId: $groupId) {
    id
    equipment
    costCenter
    calendar
    result
    criticality
    tag
    description
    branchId
  }
}

Variables

{"groupId": "xyz789"}

Response

{
  "data": {
    "meanTimeBetweenFailuresByGroup": [
      {
        "id": "abc123",
        "equipment": "abc123",
        "costCenter": "abc123",
        "calendar": "abc123",
        "result": 987.65,
        "criticality": "High",
        "tag": "abc123",
        "description": "xyz789",
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`meanTimeToRepair`

Description

Retorna indicadores de tempo médio para reparos por criticidade e grupo

Response

Returns [CriticalityAndGroup!]!

Example

Query

query MeanTimeToRepair {
  meanTimeToRepair {
    criticalities {
      label
      result
    }
    groups {
      label
      result
      id
    }
    branchId
  }
}

Response

{
  "data": {
    "meanTimeToRepair": [
      {
        "criticalities": [CriticalityBIData],
        "groups": [GroupBIData],
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`meanTimeToRepairByCriticality`

Description

Retorna indicadores de tempo médio para reparos por criticidade

Response

Returns [EquipmentBIData!]!

Arguments

Name	Description
`criticality` - `Scale!`	Filtro de criticidade

Example

Query

query MeanTimeToRepairByCriticality($criticality: Scale!) {
  meanTimeToRepairByCriticality(criticality: $criticality) {
    id
    equipment
    costCenter
    calendar
    result
    criticality
    tag
    description
    branchId
  }
}

Variables

{"criticality": "High"}

Response

{
  "data": {
    "meanTimeToRepairByCriticality": [
      {
        "id": "abc123",
        "equipment": "abc123",
        "costCenter": "xyz789",
        "calendar": "abc123",
        "result": 123.45,
        "criticality": "High",
        "tag": "xyz789",
        "description": "abc123",
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`meanTimeToRepairByGroup`

Description

Retorna indicadores de tempo médio para reparos por grupo

Response

Returns [EquipmentBIData!]!

Arguments

Name	Description
`groupId` - `String!`	Código identificador do grupo

Example

Query

query MeanTimeToRepairByGroup($groupId: String!) {
  meanTimeToRepairByGroup(groupId: $groupId) {
    id
    equipment
    costCenter
    calendar
    result
    criticality
    tag
    description
    branchId
  }
}

Variables

{"groupId": "xyz789"}

Response

{
  "data": {
    "meanTimeToRepairByGroup": [
      {
        "id": "xyz789",
        "equipment": "xyz789",
        "costCenter": "xyz789",
        "calendar": "xyz789",
        "result": 123.45,
        "criticality": "High",
        "tag": "xyz789",
        "description": "xyz789",
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`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": "abc123"}

Response

{
  "data": {
    "measurementUnit": {
      "id": "abc123",
      "name": "xyz789",
      "acronym": "abc123",
      "isActive": false,
      "branchId": "xyz789",
      "erpId": "xyz789",
      "description": "xyz789",
      "symbol": "xyz789"
    }
  }
}

Queries

`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
    }
  }
}

Queries

`model`

Description

Retorna um modelo de equipamento

Response

Returns a Model!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query Model($id: String!) {
  model(id: $id) {
    id
    description
    isActive
    manufacturer {
      id
      description
      isActive
      branchId
    }
    branchId
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "model": {
      "id": "xyz789",
      "description": "abc123",
      "isActive": false,
      "manufacturer": Manufacturer,
      "branchId": "xyz789"
    }
  }
}

Queries

`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
      manufacturer {
        ...ManufacturerFragment
      }
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": ModelQueryInput
}

Response

{"data": {"models": {"items": [Model], "hasMore": false}}}

Queries

`nonEmployeeUsers`

Description

Retorna usuários que não estão vinculados ao cadastro geral de funcionários

Response

Returns [UserOrganizationListing!]!

Arguments

Name	Description
`branchId` - `String`	Código identificador da filial para pesquisa
`name` - `String!`	Conteúdo do nome dos usuários a serem pesquisados

Example

Query

query NonEmployeeUsers(
  $branchId: String,
  $name: String!
) {
  nonEmployeeUsers(
    branchId: $branchId,
    name: $name
  ) {
    name
    id
    branches
    email
    accessBy
    roleId
    status
    profilePicture
  }
}

Variables

{
  "branchId": "xyz789",
  "name": "abc123"
}

Response

{
  "data": {
    "nonEmployeeUsers": [
      {
        "name": "xyz789",
        "id": "xyz789",
        "branches": ["xyz789"],
        "email": "abc123",
        "accessBy": "Internal",
        "roleId": "xyz789",
        "status": "xyz789",
        "profilePicture": "abc123"
      }
    ]
  }
}

Queries

`organization`

Description

Retorna a organização

Response

Returns an OrganizationWithBranches!

Example

Query

query Organization {
  organization {
    id
    name
    cognitoMetadataUrl
    cognitoIdentifiers
    socialName
    organizationPicture
    expiresAt
    createdAt
    isPartner
    planStatus
    onboardingTasks {
      id
      value
      completed
    }
    paymentOrigin
    branches {
      phoneNumber
      activityType
      zipCode
      street
      number
      neighborhood
      city
      state
      country
      complement
      timeZone
      mfmUser
      mfmPassword
      id
      organizationId
      name
      createdAt
      updatedAt
      documentNumber
      deletedAt
      settings {
        ...GlobalSettingsFragment
      }
    }
  }
}

Response

{
  "data": {
    "organization": {
      "id": "xyz789",
      "name": "xyz789",
      "cognitoMetadataUrl": "xyz789",
      "cognitoIdentifiers": "abc123",
      "socialName": "abc123",
      "organizationPicture": "xyz789",
      "expiresAt": "2007-12-03T10:15:30Z",
      "createdAt": "2007-12-03T10:15:30Z",
      "isPartner": false,
      "planStatus": "Paid",
      "onboardingTasks": [OnboardingTask],
      "paymentOrigin": "Totvs",
      "branches": [Branch]
    }
  }
}

Queries

`purchaseCategories`

Response

Returns [PurchaseCategory!]!

Arguments

Name	Description
`appSecret` - `String!`
`appKey` - `String!`

Example

Query

query PurchaseCategories(
  $appSecret: String!,
  $appKey: String!
) {
  purchaseCategories(
    appSecret: $appSecret,
    appKey: $appKey
  ) {
    codigo
    descricao
  }
}

Variables

{
  "appSecret": "xyz789",
  "appKey": "abc123"
}

Response

{
  "data": {
    "purchaseCategories": [
      {
        "codigo": "xyz789",
        "descricao": "xyz789"
      }
    ]
  }
}

Queries

`rav`

Description

Retorna indicatores de valor de reposição de ativos

Response

Returns [BasicIndicator!]!

Arguments

Name	Description
`filter` - `DateFilterInput`	Filtro de data

Example

Query

query Rav($filter: DateFilterInput) {
  rav(filter: $filter) {
    label
    result
    branchId
  }
}

Variables

{"filter": DateFilterInput}

Response

{
  "data": {
    "rav": [
      {
        "label": "abc123",
        "result": 123.45,
        "branchId": "abc123"
      }
    ]
  }
}

Queries

`reason`

Description

Retorna um motivo de cancelamento ou inativação

Response

Returns a Reason!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query Reason($id: String!) {
  reason(id: $id) {
    id
    description
    type
    isActive
    referenceId
    isUsed
    branchId
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "reason": {
      "id": "abc123",
      "description": "abc123",
      "type": "Delay",
      "isActive": true,
      "referenceId": "xyz789",
      "isUsed": true,
      "branchId": "xyz789"
    }
  }
}

Queries

`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
      isUsed
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{
  "data": {
    "reasons": {"items": [Reason], "hasMore": true}
  }
}

Queries

`sensorData`

Description

Retorna dados dos últimos 7 dias do sensor

Response

Returns a SensorDataLastWeek!

Arguments

Name	Description
`id` - `String!`

Example

Query

query SensorData($id: String!) {
  sensorData(id: $id) {
    sensorByHour {
      label
      surfaceTemperature
      velZ
      velX
      velY
    }
    sensorByDay {
      label
      result
    }
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "sensorData": {
      "sensorByHour": [SensorDataHour],
      "sensorByDay": [SensorDataDay]
    }
  }
}

Queries

`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
      isUsed
      branchId
    }
    costCenterRef {
      id
      description
      isActive
      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
    }
    followUp {
      type
      user {
        ...UserFragment
      }
      createdAt
      id
      description
      deletedAt
      branchId
      action
      serviceRequestId
      requesterId
    }
    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
    doneMaterialCost
    foreseenThirdPartyCost
    doneThirdPartyCost
    branchId
  }
}

Variables

{
  "enableLink": true,
  "keepMaterial": true,
  "id": "xyz789"
}

Response

{
  "data": {
    "serviceOrder": {
      "id": "abc123",
      "code": "abc123",
      "equipment": EquipmentDefaults,
      "user": UserBasicInfo,
      "service": "Corrective",
      "situation": "Opened",
      "startDate": "2007-12-03T10:15:30Z",
      "endDate": "2007-12-03T10:15:30Z",
      "attachments": [Attachment],
      "maintenance": MaintenanceOnServiceOrder,
      "cancellationReasonRef": Reason,
      "costCenterRef": CostCenter,
      "observation": "xyz789",
      "priority": 123.45,
      "realStartDate": "2007-12-03T10:15:30Z",
      "realEndDate": "2007-12-03T10:15:30Z",
      "conclusion": 123.45,
      "doneCost": 987.65,
      "foreseenCost": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "areas": [AreaTree],
      "resources": [ResourcesOnServiceOrder],
      "followUp": [ServiceOrderFollowUp],
      "stoppedAt": "2007-12-03T10:15:30Z",
      "resumedAt": "2007-12-03T10:15:30Z",
      "foreseenStoppedAt": "2007-12-03T10:15:30Z",
      "foreseenResumedAt": "2007-12-03T10:15:30Z",
      "updatedAt": "2007-12-03T10:15:30Z",
      "operationTime": 123.45,
      "hasDoneResource": false,
      "hasDoneHuman": false,
      "hasUnreportedThirdParty": false,
      "generatedByServiceRequest": true,
      "hasMaintenceByCounter": false,
      "serviceRequest": ServiceRequestRef,
      "finalizationObservation": "xyz789",
      "cancellationObservation": "abc123",
      "counter": Counter,
      "foreseenEmployeeCost": 987.65,
      "doneEmployeeCost": 987.65,
      "foreseenToolCost": 987.65,
      "doneToolCost": 987.65,
      "foreseenMaterialCost": 987.65,
      "doneMaterialCost": 123.45,
      "foreseenThirdPartyCost": 987.65,
      "doneThirdPartyCost": 987.65,
      "branchId": "xyz789"
    }
  }
}

Queries

`serviceOrderFollowUp`

Description

Retorna os acompanhamentos de uma ordem de serviço

Response

Returns [ServiceOrderFollowUp!]!

Arguments

Name	Description
`serviceOrderId` - `String!`	Código identificador

Example

Query

query ServiceOrderFollowUp($serviceOrderId: String!) {
  serviceOrderFollowUp(serviceOrderId: $serviceOrderId) {
    type
    user {
      documentNumber
      birthDate
      address
      educationLevel
      gender
      mobileTourView
      id
      name
      email
      accessBy
      employees {
        ...EmployeeFragment
      }
      verifiedEmail
      profilePicture
      restrictedBy
      preferences {
        ...UserPreferencesFragment
      }
      policiesAgreement {
        ...PolicyAgreementFragment
      }
      roles {
        ...RoleFragment
      }
      customer {
        ...CustomerPartnerFragment
      }
    }
    createdAt
    id
    description
    deletedAt
    branchId
    action
    serviceRequestId
    requesterId
  }
}

Variables

{"serviceOrderId": "abc123"}

Response

{
  "data": {
    "serviceOrderFollowUp": [
      {
        "type": "Event",
        "user": User,
        "createdAt": "2007-12-03T10:15:30Z",
        "id": "abc123",
        "description": "xyz789",
        "deletedAt": "2007-12-03T10:15:30Z",
        "branchId": "xyz789",
        "action": "Open",
        "serviceRequestId": "xyz789",
        "requesterId": "abc123"
      }
    ]
  }
}

Queries

`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. Default = `{field: Priority, type: Descending}`
`omitMultimedia` - `Boolean`	Omitir multimídia

Example

Query

query ServiceOrders(
  $pagination: Pagination,
  $query: ServiceOrderQueryInput!,
  $orderBy: ServiceOrderOrderByInput,
  $omitMultimedia: Boolean
) {
  serviceOrders(
    pagination: $pagination,
    query: $query,
    orderBy: $orderBy,
    omitMultimedia: $omitMultimedia
  ) {
    items {
      id
      code
      equipment {
        ...EquipmentDefaultsFragment
      }
      user {
        ...UserBasicInfoFragment
      }
      service
      situation
      startDate
      endDate
      attachments {
        ...AttachmentFragment
      }
      maintenance {
        ...MaintenanceOnServiceOrderFragment
      }
      cancellationReasonRef {
        ...ReasonFragment
      }
      costCenterRef {
        ...CostCenterFragment
      }
      observation
      priority
      realStartDate
      realEndDate
      conclusion
      doneCost
      foreseenCost
      createdAt
      areas {
        ...AreaTreeFragment
      }
      resources {
        ...ResourcesOnServiceOrderFragment
      }
      followUp {
        ...ServiceOrderFollowUpFragment
      }
      stoppedAt
      resumedAt
      foreseenStoppedAt
      foreseenResumedAt
      updatedAt
      operationTime
      hasDoneResource
      hasDoneHuman
      hasUnreportedThirdParty
      generatedByServiceRequest
      hasMaintenceByCounter
      serviceRequest {
        ...ServiceRequestRefFragment
      }
      finalizationObservation
      cancellationObservation
      counter {
        ...CounterFragment
      }
      foreseenEmployeeCost
      doneEmployeeCost
      foreseenToolCost
      doneToolCost
      foreseenMaterialCost
      doneMaterialCost
      foreseenThirdPartyCost
      doneThirdPartyCost
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": ServiceOrderQueryInput,
  "orderBy": {"field": "Priority", "type": "Descending"},
  "omitMultimedia": false
}

Response

{
  "data": {
    "serviceOrders": {
      "items": [ServiceOrder],
      "hasMore": true
    }
  }
}

Queries

`serviceOrdersByServiceRequests`

Description

Retorna ordens de serviço

Response

Returns a PaginatedServiceOrders!

Arguments

Name	Description
`pagination` - `Pagination`	Parâmetros da paginação
`query` - `ServiceRequestQueryInput!`	Parâmetros da pesquisa
`orderBy` - `ServiceRequestOrderByInput`	Ordenação de solicitações de serviço. Default = `{field: Priority, type: Descending}`
`omitMultimedia` - `Boolean`	Omitir multimídia

Example

Query

query ServiceOrdersByServiceRequests(
  $pagination: Pagination,
  $query: ServiceRequestQueryInput!,
  $orderBy: ServiceRequestOrderByInput,
  $omitMultimedia: Boolean
) {
  serviceOrdersByServiceRequests(
    pagination: $pagination,
    query: $query,
    orderBy: $orderBy,
    omitMultimedia: $omitMultimedia
  ) {
    items {
      id
      code
      equipment {
        ...EquipmentDefaultsFragment
      }
      user {
        ...UserBasicInfoFragment
      }
      service
      situation
      startDate
      endDate
      attachments {
        ...AttachmentFragment
      }
      maintenance {
        ...MaintenanceOnServiceOrderFragment
      }
      cancellationReasonRef {
        ...ReasonFragment
      }
      costCenterRef {
        ...CostCenterFragment
      }
      observation
      priority
      realStartDate
      realEndDate
      conclusion
      doneCost
      foreseenCost
      createdAt
      areas {
        ...AreaTreeFragment
      }
      resources {
        ...ResourcesOnServiceOrderFragment
      }
      followUp {
        ...ServiceOrderFollowUpFragment
      }
      stoppedAt
      resumedAt
      foreseenStoppedAt
      foreseenResumedAt
      updatedAt
      operationTime
      hasDoneResource
      hasDoneHuman
      hasUnreportedThirdParty
      generatedByServiceRequest
      hasMaintenceByCounter
      serviceRequest {
        ...ServiceRequestRefFragment
      }
      finalizationObservation
      cancellationObservation
      counter {
        ...CounterFragment
      }
      foreseenEmployeeCost
      doneEmployeeCost
      foreseenToolCost
      doneToolCost
      foreseenMaterialCost
      doneMaterialCost
      foreseenThirdPartyCost
      doneThirdPartyCost
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": ServiceRequestQueryInput,
  "orderBy": {"field": "Priority", "type": "Descending"},
  "omitMultimedia": false
}

Response

{
  "data": {
    "serviceOrdersByServiceRequests": {
      "items": [ServiceOrder],
      "hasMore": false
    }
  }
}

Queries

`serviceOrdersCosts`

Description

Retorna custos de ordens de serviço

Response

Returns a ServiceOrderCosts!

Arguments

Name	Description
`input` - `ServiceOrderQueryInput!`	Pesquisa de ordem de serviço

Example

Query

query ServiceOrdersCosts($input: ServiceOrderQueryInput!) {
  serviceOrdersCosts(input: $input) {
    foreseenEmployeeCost
    doneEmployeeCost
    foreseenToolCost
    doneToolCost
    foreseenMaterialCost
    doneMaterialCost
    foreseenThirdPartyCost
    doneThirdPartyCost
  }
}

Variables

{"input": ServiceOrderQueryInput}

Response

{
  "data": {
    "serviceOrdersCosts": {
      "foreseenEmployeeCost": 987.65,
      "doneEmployeeCost": 123.45,
      "foreseenToolCost": 123.45,
      "doneToolCost": 123.45,
      "foreseenMaterialCost": 123.45,
      "doneMaterialCost": 987.65,
      "foreseenThirdPartyCost": 987.65,
      "doneThirdPartyCost": 123.45
    }
  }
}

Queries

`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": "abc123",
        "situation": "Opened",
        "startDate": "2007-12-03T10:15:30Z",
        "equipment": EquipmentBasicInfo,
        "conclusion": 987.65,
        "doneCost": 123.45,
        "foreseenCost": 987.65,
        "priority": 123.45,
        "branchId": "xyz789"
      }
    ]
  }
}

Queries

`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
      availability
      realAvailability
      startDate
      endDate
      isActive
    }
    reason {
      id
      description
      type
      isActive
      referenceId
      isUsed
      branchId
    }
    equipment {
      isInTree
      treeTag
      serial
      purchaseDate
      purchaseValue
      warranty
      warrantyDate
      warrantyUnit
      counterType
      counterLimit
      releaseReasonId
      releaseDate
      dailyVariation
      counterAmount
      accumulatedPosition
      canUpdateLimit
      branch {
        ...BranchFragment
      }
      id
      description
      isStarter
      tag
      previousTags
      classification
      isMaintenanceActive
      owner
      situation
      properties {
        ...EquipmentPropertyFragment
      }
      counterEntries {
        ...CounterFragment
      }
      model {
        ...ModelFragment
      }
      group {
        ...GroupFragment
      }
      costCenter {
        ...CostCenterFragment
      }
      calendar {
        ...CalendarFragment
      }
      releaseReason {
        ...ReasonFragment
      }
      customer {
        ...CustomerPartnerFragment
      }
      criticality
      attachments {
        ...EquipmentAttachmentFragment
      }
      sensors {
        ...SensorEquipmentFragment
      }
      mainAttachmentUrl
      availability
      tagDescription
      equipmentsStructure {
        ...EquipmentStructureFragment
      }
    }
    customer {
      documentNumber
      daytimePhoneNumber
      phoneNumber
      email
      address
      number
      complement
      zipCode
      neighborhood
      city
      state
      country
      description
      customerPicture
      customerPictureKey
      attachments {
        ...AttachmentFragment
      }
      branch {
        ...BranchFragment
      }
      users {
        ...UserOrganizationListingFragment
      }
      agreements {
        ...CustomerAgreementFragment
      }
      id
      type
      name
      isActive
    }
    serviceOrder {
      id
      code
      equipment {
        ...EquipmentDefaultsFragment
      }
      user {
        ...UserBasicInfoFragment
      }
      service
      situation
      startDate
      endDate
      attachments {
        ...AttachmentFragment
      }
      maintenance {
        ...MaintenanceOnServiceOrderFragment
      }
      cancellationReasonRef {
        ...ReasonFragment
      }
      costCenterRef {
        ...CostCenterFragment
      }
      observation
      priority
      realStartDate
      realEndDate
      conclusion
      doneCost
      foreseenCost
      createdAt
    }
    satisfactionSurvey {
      id
      deadlineEvaluation
      coveringEvaluation
      observation
    }
    requester {
      documentNumber
      birthDate
      address
      educationLevel
      gender
      mobileTourView
      id
      name
      email
      accessBy
      employees {
        ...EmployeeFragment
      }
      verifiedEmail
      profilePicture
      restrictedBy
      preferences {
        ...UserPreferencesFragment
      }
      policiesAgreement {
        ...PolicyAgreementFragment
      }
      roles {
        ...RoleFragment
      }
      customer {
        ...CustomerPartnerFragment
      }
    }
    createdAt
    stoppedAt
    serviceTime
    runTime
    finishedAt
    distributedAt
    canceledAt
    branchId
    attachments {
      id
      filename
      contentType
      contentLength
      url
      uploadedBy
      createdAt
      uploadUrl
    }
    followUp {
      type
      user {
        ...UserFragment
      }
      createdAt
      id
      description
      deletedAt
      branchId
      action
      serviceOrderId
    }
  }
}

Variables

{"enableLink": true, "id": "abc123"}

Response

{
  "data": {
    "serviceRequest": {
      "id": "xyz789",
      "code": "abc123",
      "description": "abc123",
      "isAuto": true,
      "situation": "AwaitingAnalysis",
      "priority": "Emergency",
      "observation": "abc123",
      "runningTime": "xyz789",
      "employee": Employee,
      "reason": Reason,
      "equipment": EquipmentDefaults,
      "customer": CustomerPartner,
      "serviceOrder": ServiceOrderDefaults,
      "satisfactionSurvey": SatisfactionSurvey,
      "requester": User,
      "createdAt": "2007-12-03T10:15:30Z",
      "stoppedAt": "2007-12-03T10:15:30Z",
      "serviceTime": "abc123",
      "runTime": "xyz789",
      "finishedAt": "2007-12-03T10:15:30Z",
      "distributedAt": "2007-12-03T10:15:30Z",
      "canceledAt": "2007-12-03T10:15:30Z",
      "branchId": "xyz789",
      "attachments": [Attachment],
      "followUp": [ServiceRequestFollowUp]
    }
  }
}

Queries

`serviceRequestFollowUp`

Description

Retorna os acompanhamentos de uma solicitação de serviço

Response

Returns [ServiceRequestFollowUp!]!

Arguments

Name	Description
`serviceRequestId` - `String!`	Código identificador

Example

Query

query ServiceRequestFollowUp($serviceRequestId: String!) {
  serviceRequestFollowUp(serviceRequestId: $serviceRequestId) {
    type
    user {
      documentNumber
      birthDate
      address
      educationLevel
      gender
      mobileTourView
      id
      name
      email
      accessBy
      employees {
        ...EmployeeFragment
      }
      verifiedEmail
      profilePicture
      restrictedBy
      preferences {
        ...UserPreferencesFragment
      }
      policiesAgreement {
        ...PolicyAgreementFragment
      }
      roles {
        ...RoleFragment
      }
      customer {
        ...CustomerPartnerFragment
      }
    }
    createdAt
    id
    description
    deletedAt
    branchId
    action
    serviceOrderId
  }
}

Variables

{"serviceRequestId": "abc123"}

Response

{
  "data": {
    "serviceRequestFollowUp": [
      {
        "type": "Event",
        "user": User,
        "createdAt": "2007-12-03T10:15:30Z",
        "id": "abc123",
        "description": "xyz789",
        "deletedAt": "2007-12-03T10:15:30Z",
        "branchId": "xyz789",
        "action": "Comment",
        "serviceOrderId": "xyz789"
      }
    ]
  }
}

Queries

`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. Default = `{field: Priority, type: Descending}`
`omitMultimedia` - `Boolean`	Omitir multimídia

Example

Query

query ServiceRequests(
  $pagination: Pagination,
  $query: ServiceRequestQueryInput!,
  $orderBy: ServiceRequestOrderByInput,
  $omitMultimedia: Boolean
) {
  serviceRequests(
    pagination: $pagination,
    query: $query,
    orderBy: $orderBy,
    omitMultimedia: $omitMultimedia
  ) {
    items {
      id
      code
      description
      isAuto
      situation
      priority
      observation
      runningTime
      stoppedAt
      reason {
        ...ReasonFragment
      }
      equipment {
        ...EquipmentDefaultsFragment
      }
      serviceOrder {
        ...ServiceOrderDefaultsFragment
      }
      satisfactionSurvey {
        ...SatisfactionSurveyFragment
      }
      requester {
        ...UserFragment
      }
      createdAt
      serviceTime
      runTime
      employee {
        ...EmployeeFragment
      }
      finishedAt
      distributedAt
      canceledAt
      customer {
        ...CustomerPartnerFragment
      }
      branchId
      attachments {
        ...AttachmentFragment
      }
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": ServiceRequestQueryInput,
  "orderBy": {"field": "Priority", "type": "Descending"},
  "omitMultimedia": false
}

Response

{
  "data": {
    "serviceRequests": {
      "items": [ServiceRequestBrowse],
      "hasMore": false
    }
  }
}

Queries

`serviceRequestsHome`

Description

Retorna solicitações de serviço

Response

Returns [ServiceRequestHome!]!

Example

Query

query ServiceRequestsHome {
  serviceRequestsHome {
    id
    code
    createdAt
    serviceOrder {
      id
      code
      createdAt
    }
    equipment {
      id
      description
      tag
      tagDescription
      isStarter
    }
    requester {
      id
      name
      profilePicture
    }
    priority
    situation
    branchId
  }
}

Response

{
  "data": {
    "serviceRequestsHome": [
      {
        "id": "xyz789",
        "code": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "serviceOrder": ServiceOrderBasicInfo,
        "equipment": EquipmentBasicInfo,
        "requester": RequestBasicInfo,
        "priority": "Emergency",
        "situation": "AwaitingAnalysis",
        "branchId": "xyz789"
      }
    ]
  }
}

Queries

`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
      isInMaintenance
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{
  "data": {
    "specialties": {
      "items": [Specialty],
      "hasMore": false
    }
  }
}

Queries

`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
    isInMaintenance
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "specialty": {
      "id": "xyz789",
      "name": "xyz789",
      "hourlyWage": 123.45,
      "isActive": false,
      "isInMaintenance": true
    }
  }
}

Queries

`step`

Description

Retorna uma etapa

Response

Returns a Step!

Arguments

Name	Description
`branchId` - `String`	Código da filial para pesquisa
`id` - `String!`	Código identificador

Example

Query

query Step(
  $branchId: String,
  $id: String!
) {
  step(
    branchId: $branchId,
    id: $id
  ) {
    id
    description
    isReported
    averageTime
    requestResponse
    type
    measurementUnit {
      id
      description
      symbol
    }
    isActive
    isInMaintenance
    branchId
  }
}

Variables

{
  "branchId": "xyz789",
  "id": "xyz789"
}

Response

{
  "data": {
    "step": {
      "id": "xyz789",
      "description": "xyz789",
      "isReported": false,
      "averageTime": "xyz789",
      "requestResponse": false,
      "type": "Number",
      "measurementUnit": MeasurementUnit,
      "isActive": true,
      "isInMaintenance": true,
      "branchId": "abc123"
    }
  }
}

Queries

`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
      isInMaintenance
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{"data": {"steps": {"items": [Step], "hasMore": true}}}

Queries

`supplier`

Description

Retorna um fornecedor

Response

Returns a Supplier!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query Supplier($id: String!) {
  supplier(id: $id) {
    id
    name
    branchId
    erpId
  }
}

Variables

{"id": "abc123"}

Response

{
  "data": {
    "supplier": {
      "id": "abc123",
      "name": "xyz789",
      "branchId": "xyz789",
      "erpId": "xyz789"
    }
  }
}

Queries

`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
      branchId
      erpId
    }
    hasMore
  }
}

Variables

{
  "thirdPartyId": "abc123",
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{
  "data": {
    "suppliers": {"items": [Supplier], "hasMore": true}
  }
}

Queries

`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": false
    }
  }
}

Queries

`thirdParty`

Description

Retorna um serviço de terceiro

Response

Returns a ThirdParty!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query ThirdParty($id: String!) {
  thirdParty(id: $id) {
    id
    description
    standardCost
    isActive
    suppliers {
      id
      name
      branchId
      erpId
      cost
    }
    isInMaintenance
    branchId
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "thirdParty": {
      "id": "xyz789",
      "description": "xyz789",
      "standardCost": 123.45,
      "isActive": false,
      "suppliers": [ThirdPartySupplierCost],
      "isInMaintenance": false,
      "branchId": "abc123"
    }
  }
}

Queries

`tool`

Description

Retorna uma ferramenta

Response

Returns a Tool!

Arguments

Name	Description
`id` - `String!`	Código identificador

Example

Query

query Tool($id: String!) {
  tool(id: $id) {
    id
    description
    hourlyCost
    isActive
    isInMaintenance
    branchId
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "tool": {
      "id": "abc123",
      "description": "abc123",
      "hourlyCost": 987.65,
      "isActive": true,
      "isInMaintenance": true,
      "branchId": "abc123"
    }
  }
}

Queries

`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
      isInMaintenance
      branchId
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{"data": {"tools": {"items": [Tool], "hasMore": false}}}

Queries

`user`

Description

Retorna um usuário

Response

Returns a UserBasicInfo!

Arguments

Name	Description
`id` - `String!`	Código identificador do usuário

Example

Query

query User($id: String!) {
  user(id: $id) {
    documentNumber
    birthDate
    address
    educationLevel
    gender
    mobileTourView
    id
    name
    email
    accessBy
    employees {
      id
      user {
        ...UserFragment
      }
      hourlyWage
      availability
      realAvailability
      startDate
      endDate
      isActive
    }
    verifiedEmail
    profilePicture
    restrictedBy
    preferences {
      expandedSidebar
      expandedWallet
      showTree
      printTotalCost
      printImages
      printFollowUp
    }
    policiesAgreement {
      id
      termId
      userId
      ipAddress
      createdAt
      userAgent
    }
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "user": {
      "documentNumber": "xyz789",
      "birthDate": "abc123",
      "address": "xyz789",
      "educationLevel": "ElementarySchool",
      "gender": "Male",
      "mobileTourView": false,
      "id": 4,
      "name": "xyz789",
      "email": "xyz789",
      "accessBy": "Internal",
      "employees": [Employee],
      "verifiedEmail": "abc123",
      "profilePicture": "abc123",
      "restrictedBy": "abc123",
      "preferences": UserPreferences,
      "policiesAgreement": [PolicyAgreement]
    }
  }
}

Queries

`users`

Description

Retorna usuários

Response

Returns [UserOrganizationListing!]!

Arguments

Name	Description
`name` - `String`	Conteúdo do nome dos usuários a serem pesquisados

Example

Query

query Users($name: String) {
  users(name: $name) {
    name
    id
    branches
    email
    accessBy
    roleId
    status
    profilePicture
  }
}

Variables

{"name": "abc123"}

Response

{
  "data": {
    "users": [
      {
        "name": "xyz789",
        "id": "abc123",
        "branches": ["xyz789"],
        "email": "xyz789",
        "accessBy": "Internal",
        "roleId": "abc123",
        "status": "xyz789",
        "profilePicture": "abc123"
      }
    ]
  }
}

Queries

`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": "abc123"}

Response

{
  "data": {
    "warehouse": {
      "id": "xyz789",
      "description": "abc123",
      "isActive": true,
      "branchId": "xyz789",
      "erpId": "abc123",
      "level": "xyz789"
    }
  }
}

Queries

`warehouses`

Description

Retorna os locais de estoque

Response

Returns a PaginatedWarehouses!

Arguments

Name	Description
`pagination` - `Pagination`	Parâmetros da paginação
`query` - `PaginationDefaultQueryInput!`	Parâmetros da pesquisa

Example

Query

query Warehouses(
  $pagination: Pagination,
  $query: PaginationDefaultQueryInput!
) {
  warehouses(
    pagination: $pagination,
    query: $query
  ) {
    items {
      id
      description
      isActive
      branchId
      erpId
      level
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": PaginationDefaultQueryInput
}

Response

{
  "data": {
    "warehouses": {"items": [Warehouse], "hasMore": false}
  }
}

Queries

`warehousesByMaterial`

Description

Retorna os locais de estoque por material

Response

Returns a PaginatedWarehouses!

Arguments

Name	Description
`pagination` - `Pagination`	Parâmetros da paginação
`query` - `WarehouseQueryInput!`	Parâmetros da pesquisa

Example

Query

query WarehousesByMaterial(
  $pagination: Pagination,
  $query: WarehouseQueryInput!
) {
  warehousesByMaterial(
    pagination: $pagination,
    query: $query
  ) {
    items {
      id
      description
      isActive
      branchId
      erpId
      level
    }
    hasMore
  }
}

Variables

{
  "pagination": Pagination,
  "query": WarehouseQueryInput
}

Response

{
  "data": {
    "warehousesByMaterial": {
      "items": [Warehouse],
      "hasMore": false
    }
  }
}

Mutations

`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": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "deletedAt": "2007-12-03T10:15:30Z"
    }
  }
}

Types

AccessBy

Description

Forma de acesso ao sistema

Values

Enum Value	Description
`Internal`	Autenticação pelo Keepfy
`Microsoft`	Autenticação pela Microsoft

Example

"Internal"

Types

AccessToken

Description

Token de acesso externo

Fields

Field Name	Description
`token` - `String!`	Token de acesso (access-token)
`apiAccessId` - `String!`	Código identificador da integração externa
`createdAt` - `DateTime!`	Data de criação
`deletedAt` - `DateTime`	Data de exclusão

Example

{
  "token": "xyz789",
  "apiAccessId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "deletedAt": "2007-12-03T10:15:30Z"
}

Types

AccessTokenInput

Description

Argumentos de criação de token de acesso externo

Fields

Input Field	Description
`accessKey` - `String!`	Chave de acesso
`accessSecret` - `String!`	Senha de acesso
`timeZone` - `String`	Fuso-horário

Example

{
  "accessKey": "abc123",
  "accessSecret": "abc123",
  "timeZone": "abc123"
}

Types

ActivityType

Description

Tipo de atividade econômica

Values

Enum Value	Description
`AgricultureLivestockForestryAndAquaculture`	Agricultura, pecuária, produção florestal, pesca e aquicultura
`ExtractiveIndustries`	Indústrias extrativas
`ManufacturingIndustries`	Indústrias de transformação
`ElectricityAndGas`	Eletricidade e gás
`WaterSewageWasteManagementAndDecontamination`	Água, esgoto, atividades de gestão de resíduos e descontaminação
`Construction`	Construção
`MotorVehiclesTradeAndRepair`	Comércio, reparação de veículos automotores e motocicletas
`TransportStorageAndMail`	Transporte, armazenagem e correio
`AccommodationAndFood`	Alojamento e alimentação
`InformationAndCommunication`	Informação e comunicação
`FinancialAndInsurance`	Atividades financeiras, de seguros e serviços relacionados
`RealEstate`	Atividades imobiliárias
`ProfessionalScientificAndTechnical`	Atividades profissionais, científicas e técnicas
`AdministrativeAndComplementaryServices`	Atividades administrativas e serviços complementares
`PublicAdministrationDefenseAndSocialSecurity`	Administração pública, defesa e seguridade social
`Education`	Educação
`HumanHealthAndSocialServices`	Saúde humana e serviços sociais
`ArtsCultureSportAndRecreation`	Artes, cultura, esporte e recreação
`OtherServices`	Outras atividades de serviços
`DomesticServices`	Serviços domésticos
`InternationalOrganizations`	Organismos internacionais e outras instituições extraterritoriais

Example

"AgricultureLivestockForestryAndAquaculture"

Types

Area

Description

Área

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`isActive` - `Boolean`	Status
`isInMaintenance` - `Boolean`	Indica se a área é usada em alguma árvore de recursos
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "abc123",
  "description": "abc123",
  "isActive": true,
  "isInMaintenance": false,
  "branchId": "xyz789"
}

Types

AreaTree

Description

Árvore de recursos

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": true,
  "done": true,
  "resources": [HumanResourceTree]
}

Types

Attachment

Description

Anexo

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` - `String!`	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": "abc123",
  "filename": "abc123",
  "contentType": "abc123",
  "contentLength": 987.65,
  "url": "xyz789",
  "uploadedBy": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "uploadUrl": "abc123"
}

Types

BasicIndicator

Description

Indicador

Fields

Field Name	Description
`label` - `String!`	Data
`result` - `Float!`	Resultado
`branchId` - `String!`	Código identificador da filial

Example

{
  "label": "abc123",
  "result": 987.65,
  "branchId": "xyz789"
}

Types

BasicInformationDescription

Description

Identificação básica por descrição

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição

Example

{
  "id": "xyz789",
  "description": "abc123"
}

Types

BasicInformationName

Description

Identificação básica por nome

Fields

Field Name	Description
`id` - `String!`	Código identificador
`name` - `String!`	Nome

Example

{
  "id": "abc123",
  "name": "xyz789"
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Branch

Description

Filial da organização

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

Example

{
  "phoneNumber": "xyz789",
  "activityType": "AgricultureLivestockForestryAndAquaculture",
  "zipCode": "xyz789",
  "street": "abc123",
  "number": "abc123",
  "neighborhood": "xyz789",
  "city": "abc123",
  "state": "xyz789",
  "country": "xyz789",
  "complement": "abc123",
  "timeZone": "abc123",
  "mfmUser": "xyz789",
  "mfmPassword": "abc123",
  "id": "abc123",
  "organizationId": "abc123",
  "name": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "documentNumber": "xyz789",
  "deletedAt": "2007-12-03T10:15:30Z",
  "settings": GlobalSettings
}

Types

CBEIndicator

Description

Indicador de custo por equipamento

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": 123.45,
  "accumulatedCostPercentage": 123.45,
  "purchase": ComparativeResult,
  "maintenance": ComparativeResult
}

Types

Calendar

Description

Calendário

Fields

Field Name	Description
`id` - `String!`	Código identificador
`name` - `String!`	Nome
`isActive` - `Boolean`	Status
`workShifts` - `[WorkShift!]!`	Turnos de trabalho

Example

{
  "id": "abc123",
  "name": "xyz789",
  "isActive": true,
  "workShifts": [WorkShift]
}

Types

CalendarQueryInput

Description

Pesquisa de calendário

Fields

Input Field	Description
`identifier` - `String`	Pesquisa por nome ou descrição
`isActive` - `Boolean`	Pesquisa registros ativos ou inativos

Example

{"identifier": "abc123", "isActive": true}

Types

Checklist

Description

Recurso de 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": "abc123",
  "type": "Area",
  "step": Step,
  "resources": [PhysicalResource]
}

Types

ChecklistTree

Description

Recurso de checklist

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": "abc123",
  "parentId": "xyz789",
  "resources": [PhysicalResourceTree]
}

Types

ComparativeResult

Description

Resultado comparativo

Fields

Field Name	Description
`value` - `Float!`	Valor
`percentage` - `Float!`	Porcentagem

Example

{"value": 987.65, "percentage": 987.65}

Types

CostCenter

Description

Centro de custo

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição do centro de custo
`isActive` - `Boolean`	Status
`branchId` - `String`	Código identificador da filial
`erpId` - `String`	Código identificador na integração

Example

{
  "id": "xyz789",
  "description": "xyz789",
  "isActive": true,
  "branchId": "abc123",
  "erpId": "xyz789"
}

Types

CostCenterQueryInput

Description

Pesquisa de centros de custo

Fields

Input Field	Description
`identifier` - `String`	Pesquisa por nome ou descrição
`isActive` - `Boolean`	Pesquisa registros ativos ou inativos

Example

{"identifier": "xyz789", "isActive": false}

Types

Counter

Description

Contador

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": "2007-12-03T10:15:30Z",
  "position": 987.65,
  "accumulatedPosition": 987.65,
  "type": "Inform",
  "serviceOrder": ServiceOrder,
  "dailyVariation": 987.65,
  "branchId": "abc123"
}

Types

CounterIndicator

Description

Indicador de histórico do contador

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"
}

Types

CounterLimit

Description

Posição limite do contador

Values

Enum Value	Description
`SixDigits`	Máximo de seis dígitos
`NineDigits`	Máximo de nove dígitos

Example

"SixDigits"

Types

CounterType

Description

Tipo de controle do contador

Values

Enum Value	Description
`Hours`	Controle por horas
`KM`	Controle por quilômetros
`NoCounter`	Sem controle de contador

Example

"Hours"

Types

CounterTypeIncrement

Description

Tipo de incremento do contador

Values

Enum Value	Description
`Hours`	Incremento por horas
`KM`	Incremento por quilômetros

Example

"Hours"

Types

CriticalityAndGroup

Description

Indicadores por criticidade e grupo

Fields

Field Name	Description
`criticalities` - `[CriticalityBIData!]!`	Indicadores por criticidade
`groups` - `[GroupBIData!]!`	Indicadores por grupo
`branchId` - `String!`	Código identificador da filial

Example

{
  "criticalities": [CriticalityBIData],
  "groups": [GroupBIData],
  "branchId": "abc123"
}

Types

CriticalityBIData

Description

Indicador por criticidade

Fields

Field Name	Description
`label` - `Scale!`	Criticidade
`result` - `Float!`	Resultado

Example

{"label": "High", "result": 123.45}

Types

CustomerAgreement

Description

Contrato do cliente parceiro

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": "xyz789",
  "isActive": false,
  "description": "xyz789",
  "attachments": [Attachment]
}

Types

CustomerPartner

Description

Cliente Parceiro

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`	E-mail
`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` - `String`	URL da foto de perfil
`customerPictureKey` - `String`	Chave de acesso da foto de perfil
`attachments` - `[Attachment!]!`	Anexos
`branch` - `Branch!`	Filial vinculada
`users` - `[UserOrganizationListing!]`	Usuários vinculados
`agreements` - `[CustomerAgreement!]`	Contratos
`id` - `String!`	Código identificador
`type` - `PersonType!`	Tipo de cadastro fiscal
`name` - `String!`	Nome do cliente
`isActive` - `Boolean!`	Status

Example

{
  "documentNumber": "xyz789",
  "daytimePhoneNumber": "abc123",
  "phoneNumber": "abc123",
  "email": "abc123",
  "address": "abc123",
  "number": "abc123",
  "complement": "abc123",
  "zipCode": "abc123",
  "neighborhood": "abc123",
  "city": "abc123",
  "state": "abc123",
  "country": "xyz789",
  "description": "abc123",
  "customerPicture": "abc123",
  "customerPictureKey": "abc123",
  "attachments": [Attachment],
  "branch": Branch,
  "users": [UserOrganizationListing],
  "agreements": [CustomerAgreement],
  "id": "xyz789",
  "type": "IndividualPerson",
  "name": "abc123",
  "isActive": false
}

Types

DateFilterInput

Description

Filtro de data

Fields

Input Field	Description
`startDate` - `String!`	Data de início
`endDate` - `String!`	Data de fim

Example

{
  "startDate": "xyz789",
  "endDate": "xyz789"
}

Types

DateRange

Description

Intervalo de data

Fields

Input Field	Description
`min` - `DateTime`	Mínimo
`max` - `DateTime`	Máximo

Example

{
  "min": "2007-12-03T10:15:30Z",
  "max": "2007-12-03T10:15:30Z"
}

Types

DateTime

Description

The javascript Date as string. Type represents date and time as the ISO Date string.

Example

"2007-12-03T10:15:30Z"

Types

DayOfWeek

Description

Dia da semana

Values

Enum Value	Description
`Sunday`	domingo
`Monday`	segunda-feira
`Tuesday`	terça-feira
`Wednesday`	quarta-feira
`Thursday`	quinta-feira
`Friday`	sexta-feira
`Saturday`	sábado

Example

"Sunday"

Types

DetailMaintenance

Description

Detalhes da manutenção

Fields

Field Name	Description
`increase` - `Float!`	Valor do incremento
`unit` - `IncreaseType!`	Tipo de incremento

Example

{"increase": 123.45, "unit": "Day"}

Types

DetailServiceOrder

Description

Detalhes da ordem de serviço

Fields

Field Name	Description
`serviceOrderId` - `String`	Código identificador da ordem de serviço
`serviceOrder` - `String`	Código da ordem de serviço
`date` - `DateTime`	Data de início previsto da próxima manutenção ou data de fim realizada da última manutenção
`situation` - `ServiceOrderSituation`	Tipo de situação
`counter` - `Counter`	Contador

Example

{
  "serviceOrderId": "xyz789",
  "serviceOrder": "xyz789",
  "date": "2007-12-03T10:15:30Z",
  "situation": "Opened",
  "counter": Counter
}

Types

EducationLevel

Description

Nível de instrução

Values

Enum Value	Description
`ElementarySchool`	Ensino Fundamental
`HighSchool`	Ensino Médio
`UniversityGraduate`	Graduação
`MastersDegree`	Mestrado
`DoctorateDegree`	Doutorado

Example

"ElementarySchool"

Types

Employee

Description

Funcionário

Fields

Field Name	Description
`id` - `String!`	Código identificador
`user` - `User!`	Usuário vinculado
`hourlyWage` - `Float`	Salário por hora
`availability` - `Float`	Indicador de disponibilidade
`realAvailability` - `Float`	Indicador de disponibilidade real
`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

Example

{
  "id": "abc123",
  "user": User,
  "hourlyWage": 123.45,
  "availability": 123.45,
  "realAvailability": 987.65,
  "startDate": "abc123",
  "endDate": "abc123",
  "isActive": true
}

Types

EntryType

Description

Tipo de lançamento do contador

Values

Enum Value	Description
`Inform`	Informe
`Break`	Quebra
`Turn`	Virada

Example

"Inform"

Types

EquipmentAttachment

Description

Anexo de equipamento

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` - `String!`	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": "xyz789",
  "filename": "abc123",
  "contentType": "abc123",
  "contentLength": 987.65,
  "url": "xyz789",
  "uploadedBy": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "uploadUrl": "xyz789",
  "isMainPicture": false
}

Types

EquipmentBIData

Description

Dados do indicador do equipamento

Fields

Field Name	Description
`id` - `String!`	Código identificador
`equipment` - `String!`	Descrição completa
`costCenter` - `String!`	Nome do centro de custo
`calendar` - `String!`	Nome do calendário
`result` - `Float!`	Resultado
`criticality` - `Scale!`	Criticidade
`tag` - `String`	Identificação
`description` - `String`	Descrição
`branchId` - `String!`	Código identificador da filial

Example

{
  "id": "abc123",
  "equipment": "xyz789",
  "costCenter": "xyz789",
  "calendar": "abc123",
  "result": 987.65,
  "criticality": "High",
  "tag": "abc123",
  "description": "abc123",
  "branchId": "abc123"
}

Types

EquipmentBasicInfo

Description

Equipamento

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`tag` - `String!`	Identificação
`tagDescription` - `String!`	Identificação e descrição
`isStarter` - `Boolean!`	Indica se é simplificado

Example

{
  "id": "abc123",
  "description": "xyz789",
  "tag": "xyz789",
  "tagDescription": "abc123",
  "isStarter": true
}

Types

EquipmentClassification

Description

Classificação na árvore de equipamentos

Values

Enum Value	Description
`Equipment`	Equipamento
`Component`	Componente

Example

"Equipment"

Types

EquipmentDefaults

Description

Equipamento

Fields

Field Name	Description
`isInTree` - `Boolean`	Indica se o equipamento está em uma árvore
`treeTag` - `String`	TAG
`serial` - `String`	Série
`purchaseDate` - `String`	Data de compra
`purchaseValue` - `Float`	Valor de compra
`warranty` - `Float`	Garantia
`warrantyDate` - `String`	Data de fim da garantia
`warrantyUnit` - `PeriodUnit`	Tipo de unidade de período da garantia
`counterType` - `CounterType`	Tipo de controle do contador
`counterLimit` - `CounterLimit`	Posição limite do contador
`releaseReasonId` - `String`	Código identificador do motivo de inativação
`releaseDate` - `String`	Data de inativação
`dailyVariation` - `Float`	Variação diária
`counterAmount` - `Float`	Quantidade de registros para cálculo da variação diária
`accumulatedPosition` - `Float`	Posição acumulada
`canUpdateLimit` - `Boolean`	Indica se pode alterar o limite do contador
`branch` - `Branch!`	Filial
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`isStarter` - `Boolean!`	Indica se é simplificado
`tag` - `String!`	Identificação
`previousTags` - `String`	TAGs dos pais na árvore de equipamentos
`classification` - `EquipmentClassification!`	Classificação na árvore de equipamentos
`isMaintenanceActive` - `Boolean!`	Indica se possui manutenções ativas
`owner` - `EquipmentOwnerType!`	Tipo de proprietário
`situation` - `EquipmentSituation!`	Tipo de situação
`properties` - `[EquipmentProperty!]!`	Características
`counterEntries` - `[Counter!]!`	Contadores
`model` - `Model`	Modelo
`group` - `Group`	Grupo
`costCenter` - `CostCenter`	Centro de custo
`calendar` - `Calendar`	Calendário
`releaseReason` - `Reason`	Motivo de inativação
`customer` - `CustomerPartner`	Cliente parceiro
`criticality` - `Scale`	Tipo de criticidade
`attachments` - `[EquipmentAttachment!]!`	Anexos
`sensors` - `[SensorEquipment!]!`	Sensores relacionados
`mainAttachmentUrl` - `String`	URL da imagem principal
`availability` - `Float`	Disponibilidade
`tagDescription` - `String!`	Identificação e descrição
`equipmentsStructure` - `[EquipmentStructure!]`	Estrutura de equipamentos

Example

{
  "isInTree": true,
  "treeTag": "abc123",
  "serial": "xyz789",
  "purchaseDate": "xyz789",
  "purchaseValue": 987.65,
  "warranty": 987.65,
  "warrantyDate": "abc123",
  "warrantyUnit": "Day",
  "counterType": "Hours",
  "counterLimit": "SixDigits",
  "releaseReasonId": "abc123",
  "releaseDate": "abc123",
  "dailyVariation": 987.65,
  "counterAmount": 123.45,
  "accumulatedPosition": 987.65,
  "canUpdateLimit": false,
  "branch": Branch,
  "id": "xyz789",
  "description": "abc123",
  "isStarter": false,
  "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": "abc123",
  "availability": 987.65,
  "tagDescription": "abc123",
  "equipmentsStructure": [EquipmentStructure]
}

Types

EquipmentFilter

Description

Filtro de equipamento

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` - `[EquipmentSituation!]`	Tipos de situações de equipamento
`owners` - `[EquipmentOwnerType!]`	Tipos de proprietário
`maintenanceSituations` - `[MaintenanceSituation!]`	Tipos de situações de manutenção
`types` - `[EquipmentType!]`	Tipos de cadastro
`classifications` - `[EquipmentClassification!]`	Tipos de classificação
`availability` - `FloatRange`	Intervalo de disponibilidade
`updatedAt` - `DateRange`	Intervalo de data da última atualização

Example

{
  "serials": ["abc123"],
  "groups": ["abc123"],
  "models": ["xyz789"],
  "costCenters": ["abc123"],
  "calendars": ["abc123"],
  "criticalities": ["High"],
  "customers": ["abc123"],
  "maintenanceTypes": ["WithMaintenance"],
  "warrantyTypes": ["Active"],
  "situations": ["Active"],
  "owners": ["Own"],
  "maintenanceSituations": ["Active"],
  "types": ["Starter"],
  "classifications": ["Equipment"],
  "availability": FloatRange,
  "updatedAt": DateRange
}

Types

EquipmentIndicatorResults

Description

Indicadores do equipamento

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"
}

Types

EquipmentList

Description

Equipamento

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`isStarter` - `Boolean!`	Indica se é simplificado
`tag` - `String!`	Identificação
`treeTag` - `String`	TAG
`classification` - `EquipmentClassification!`	Classificação na árvore de equipamentos
`isMaintenanceActive` - `Boolean!`	Indica se possui manutenções ativas
`availability` - `Float`	Diponibilidade
`group` - `BasicInformationName`	Grupo
`model` - `BasicInformationDescription`	Modelo
`counterType` - `CounterType`	Tipo de controle do contador
`counterLimit` - `CounterLimit`	Posição limite do contador
`situation` - `EquipmentSituation`	Tipo de situação
`criticality` - `Scale`	Tipo de criticidade
`mainAttachmentUrl` - `String`	URL da imagem principal
`costCenter` - `BasicInformationDescription`	Centro de custo
`purchaseDate` - `String`	Data de compra
`warranty` - `Float`	Garantia
`warrantyDate` - `String`	Data de fim da garantia
`warrantyUnit` - `PeriodUnit`	Tipo de unidade de período da garantia
`owner` - `EquipmentOwnerType!`	Tipo de proprietário
`customer` - `CustomerPartner`	Cliente parceiro
`releaseDate` - `String`	Data de inativação
`tagDescription` - `String!`	Identificação e descrição
`branchId` - `String`	Código identificador da filial
`sensorsQuantity` - `Float`	Quantidade de sensores
`sensorsHealth` - `Float`	Saúde do sensor em situação mais crítica

Example

{
  "id": "xyz789",
  "description": "xyz789",
  "isStarter": true,
  "tag": "abc123",
  "treeTag": "abc123",
  "classification": "Equipment",
  "isMaintenanceActive": true,
  "availability": 987.65,
  "group": BasicInformationName,
  "model": BasicInformationDescription,
  "counterType": "Hours",
  "counterLimit": "SixDigits",
  "situation": "Active",
  "criticality": "High",
  "mainAttachmentUrl": "xyz789",
  "costCenter": BasicInformationDescription,
  "purchaseDate": "abc123",
  "warranty": 987.65,
  "warrantyDate": "abc123",
  "warrantyUnit": "Day",
  "owner": "Own",
  "customer": CustomerPartner,
  "releaseDate": "abc123",
  "tagDescription": "xyz789",
  "branchId": "xyz789",
  "sensorsQuantity": 987.65,
  "sensorsHealth": 987.65
}

Types

EquipmentMaintenanceType

Description

Tipo de vínculo do equipamento com planos de manutenção

Values

Enum Value	Description
`WithMaintenance`	Com manutenção
`WithoutMaintenance`	Sem manutenção

Example

"WithMaintenance"

Types

EquipmentOrderByFields

Description

Tipo de ordenação dos equipamentos

Values

Enum Value	Description
`Tag`	Identificação
`Criticality`	Criticidade
`Availability`	Disponibilidade

Example

"Tag"

Types

EquipmentOrderByInput

Description

Ordenação de equipamentos

Fields

Input Field	Description
`field` - `EquipmentOrderByFields`	Tipo de ordenação
`type` - `OrderBy`	Tipo de ordem

Example

{"field": "Tag", "type": "Ascending"}

Types

EquipmentOwnerType

Description

Tipo de proprietário do equipamento

Values

Enum Value	Description
`Own`	Próprio
`Customer`	Cliente

Example

"Own"

Types

EquipmentProperty

Description

Característica do equipamento

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
}

Types

EquipmentQueryInput

Description

Pesquisa de equipamentos

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
`isEquipmentTree` - `Boolean`	Indica se é a visão de árvore de equipamento
`ignoreIds` - `[String!]`	Códigos identificadores que não devem ser buscados

Example

{
  "identifier": "abc123",
  "filter": EquipmentFilter,
  "summaryOrderBy": "Alphabetic",
  "isMonitoring": false,
  "isEquipmentTree": false,
  "ignoreIds": ["abc123"]
}

Types

EquipmentSettings

Description

Configurações de equipamentos

Fields

Field Name	Description
`integrationMfm` - `Boolean!`	Habilitar monitoramento integrado ao WEG MFM
`openRequestAutomatically` - `Boolean!`	Indica se a integração gera solicitação de serviçoautomaticamente com base no nível de saúde

Example

{"integrationMfm": true, "openRequestAutomatically": false}

Types

EquipmentSituation

Description

Tipo de situação do equipamento

Values

Enum Value	Description
`Active`	Ativo
`Inactive`	Inativo

Example

"Active"

Types

EquipmentStructure

Description

Equipamento

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`tag` - `String!`	Identificação
`treeTag` - `String`	TAG
`tagDescription` - `String!`	Identificação e descrição
`classification` - `EquipmentClassification!`	Classificação na árvore de equipamentos

Example

{
  "id": "abc123",
  "description": "abc123",
  "tag": "abc123",
  "treeTag": "xyz789",
  "tagDescription": "abc123",
  "classification": "Equipment"
}

Types

EquipmentType

Description

Tipo de cadastro do equipamento

Values

Enum Value	Description
`Starter`	Simplificado
`Full`	Completo

Example

"Starter"

Types

EquipmentWarrantyType

Description

Tipo de situação da garantia do equipamento

Values

Enum Value	Description
`Active`	Dentro da garantia
`Expired`	Garantia vencida
`WithoutWarranty`	Sem garantia

Example

"Active"

Types

EquipmentWithMaintenance

Description

Equipamento

Fields

Field Name	Description
`isInTree` - `Boolean`	Indica se o equipamento está em uma árvore
`treeTag` - `String`	TAG
`serial` - `String`	Série
`purchaseDate` - `String`	Data de compra
`purchaseValue` - `Float`	Valor de compra
`warranty` - `Float`	Garantia
`warrantyDate` - `String`	Data de fim da garantia
`warrantyUnit` - `PeriodUnit`	Tipo de unidade de período da garantia
`counterType` - `CounterType`	Tipo de controle do contador
`counterLimit` - `CounterLimit`	Posição limite do contador
`releaseReasonId` - `String`	Código identificador do motivo de inativação
`releaseDate` - `String`	Data de inativação
`dailyVariation` - `Float`	Variação diária
`counterAmount` - `Float`	Quantidade de registros para cálculo da variação diária
`accumulatedPosition` - `Float`	Posição acumulada
`canUpdateLimit` - `Boolean`	Indica se pode alterar o limite do contador
`branch` - `Branch!`	Filial
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`isStarter` - `Boolean!`	Indica se é simplificado
`tag` - `String!`	Identificação
`previousTags` - `String`	TAGs dos pais na árvore de equipamentos
`classification` - `EquipmentClassification!`	Classificação na árvore de equipamentos
`isMaintenanceActive` - `Boolean!`	Indica se possui manutenções ativas
`owner` - `EquipmentOwnerType!`	Tipo de proprietário
`situation` - `EquipmentSituation!`	Tipo de situação
`properties` - `[EquipmentProperty!]!`	Características
`counterEntries` - `[Counter!]!`	Contadores
`model` - `Model`	Modelo
`group` - `Group`	Grupo
`costCenter` - `CostCenter`	Centro de custo
`calendar` - `Calendar`	Calendário
`releaseReason` - `Reason`	Motivo de inativação
`customer` - `CustomerPartner`	Cliente parceiro
`criticality` - `Scale`	Tipo de criticidade
`attachments` - `[EquipmentAttachment!]!`	Anexos
`sensors` - `[SensorEquipment!]!`	Sensores relacionados
`mainAttachmentUrl` - `String`	URL da imagem principal
`availability` - `Float`	Disponibilidade
`tagDescription` - `String!`	Identificação e descrição
`equipmentsStructure` - `[EquipmentStructure!]`	Estrutura de equipamentos
`maintenances` - `[MaintenanceOnEquipment!]`	Planos de manutenção
`isLastPositionDifferent` - `Boolean!`	Indica se a última posição de contador é diferente da posição acumulada

Example

{
  "isInTree": true,
  "treeTag": "abc123",
  "serial": "xyz789",
  "purchaseDate": "xyz789",
  "purchaseValue": 987.65,
  "warranty": 987.65,
  "warrantyDate": "abc123",
  "warrantyUnit": "Day",
  "counterType": "Hours",
  "counterLimit": "SixDigits",
  "releaseReasonId": "abc123",
  "releaseDate": "xyz789",
  "dailyVariation": 987.65,
  "counterAmount": 987.65,
  "accumulatedPosition": 987.65,
  "canUpdateLimit": false,
  "branch": Branch,
  "id": "xyz789",
  "description": "abc123",
  "isStarter": true,
  "tag": "abc123",
  "previousTags": "xyz789",
  "classification": "Equipment",
  "isMaintenanceActive": true,
  "owner": "Own",
  "situation": "Active",
  "properties": [EquipmentProperty],
  "counterEntries": [Counter],
  "model": Model,
  "group": Group,
  "costCenter": CostCenter,
  "calendar": Calendar,
  "releaseReason": Reason,
  "customer": CustomerPartner,
  "criticality": "High",
  "attachments": [EquipmentAttachment],
  "sensors": [SensorEquipment],
  "mainAttachmentUrl": "xyz789",
  "availability": 987.65,
  "tagDescription": "abc123",
  "equipmentsStructure": [EquipmentStructure],
  "maintenances": [MaintenanceOnEquipment],
  "isLastPositionDifferent": false
}

Types

EvaluationType

Description

Tipo de resposta à pesquisa de satisfação

Values

Enum Value	Description
`Great`	Ótimo
`Good`	Bom
`Satisfactory`	Satisfatório
`Bad`	Ruim

Example

"Great"

Types

Feature

Description

Característica

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`type` - `FeatureType!`	Tipo de dado
`isActive` - `Boolean`	Status
`isInEquipment` - `Boolean`	Indica se a característica é usada em algum equipamento
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "xyz789",
  "description": "abc123",
  "type": "String",
  "isActive": false,
  "isInEquipment": false,
  "branchId": "xyz789"
}

Types

FeatureQueryInput

Description

Pesquisa de características

Fields

Input Field	Description
`identifier` - `String`	Pesquisa por nome ou descrição
`isActive` - `Boolean`	Pesquisa registros ativos ou inativos

Example

{"identifier": "xyz789", "isActive": false}

Types

FeatureType

Description

Tipo de dado da característica do equipamento

Values

Enum Value	Description
`String`	Texto
`Integer`	Inteiro
`Date`	Data
`Decimal`	Decimal

Example

"String"

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

FloatRange

Description

Intervalo numérico

Fields

Input Field	Description
`min` - `Float`	Mínimo
`max` - `Float`	Máximo

Example

{"min": 987.65, "max": 987.65}

Types

FullEmployee

Description

Funcionário

Fields

Field Name	Description
`id` - `String!`	Código identificador
`user` - `User!`	Usuário vinculado
`hourlyWage` - `Float`	Salário por hora
`availability` - `Float`	Indicador de disponibilidade
`realAvailability` - `Float`	Indicador de disponibilidade real
`startDate` - `String`	Data e hora de início do serviço de mão de obra
`endDate` - `String`	Data e hora de fim do serviço de mão de obra
`isActive` - `Boolean`	Status
`calendar` - `Calendar!`	Calendário de trabalho
`specialties` - `[Specialty!]!`	Especialidades do funcionário

Example

{
  "id": "xyz789",
  "user": User,
  "hourlyWage": 123.45,
  "availability": 987.65,
  "realAvailability": 123.45,
  "startDate": "xyz789",
  "endDate": "abc123",
  "isActive": false,
  "calendar": Calendar,
  "specialties": [Specialty]
}

Types

GlobalSettings

Description

Configurações globais

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

Example

{
  "serviceOrder": ServiceOrderSettings,
  "equipment": EquipmentSettings,
  "inventory": InventorySettings,
  "totvsModa": TotvsModaEndpointSettings
}

Types

Group

Description

Grupo

Fields

Field Name	Description
`id` - `String!`	Código identificador
`name` - `String!`	Nome
`isActive` - `Boolean`	Status
`referenceId` - `String`
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "xyz789",
  "name": "xyz789",
  "isActive": true,
  "referenceId": "xyz789",
  "branchId": "xyz789"
}

Types

GroupBIData

Description

Indicador por grupo

Fields

Field Name	Description
`label` - `String!`	Nome do grupo
`result` - `Float!`	Resultado
`id` - `String!`	Código identificador do grupo

Example

{
  "label": "xyz789",
  "result": 987.65,
  "id": "xyz789"
}

Types

GroupQueryInput

Description

Pesquisa de grupos

Fields

Input Field	Description
`identifier` - `String`	Pesquisa por nome ou descrição
`isActive` - `Boolean`	Pesquisa registros ativos ou inativos
`branchId` - `String`	Pesquisa por uma filial específica

Example

{
  "identifier": "abc123",
  "isActive": false,
  "branchId": "xyz789"
}

Types

HumanResource

Description

Recurso humano

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]
}

Types

HumanResourceTree

Description

Recurso humano

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": "abc123",
  "type": "Area",
  "employee": Employee,
  "specialty": Specialty,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "amount": 987.65,
  "cost": 987.65,
  "startDateDone": "2007-12-03T10:15:30Z",
  "endDateDone": "2007-12-03T10:15:30Z",
  "amountDone": 987.65,
  "costDone": 123.45,
  "foreseen": false,
  "done": false,
  "parentId": "xyz789",
  "purchaseRequestId": "abc123",
  "resources": [PhysicalResourceTree],
  "checklists": [ChecklistTree],
  "thirdParties": [ThirdPartyTree]
}

Types

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"

Types

IncreaseType

Description

Tipo de incremento da manutenção

Values

Enum Value	Description
`Day`	Dia
`Month`	Mês
`Year`	Ano
`Hours`	Horas
`KM`	Quilômetros

Example

"Day"

Types

IndicatorFilterInput

Description

Filtro de indicadores

Fields

Input Field	Description
`dateFilter` - `DateFilterInput`	Filtro de data
`equipmentId` - `String`	Código identificador do equipamento

Example

{
  "dateFilter": DateFilterInput,
  "equipmentId": "abc123"
}

Types

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

Types

InventorySettings

Description

Configurações de estoque

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"]
}

Types

MCTIndicator

Description

Indicador de custo total de manutenção

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": 987.65,
  "preventive": 123.45,
  "improvement": 123.45,
  "accumulatedCost": 123.45,
  "branchId": "abc123"
}

Types

Maintenance

Description

Plano de manutenção do equipamento

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`lastMaintenance` - `DateTime!`	Data da última manutenção
`active` - `Boolean!`	Indica se está ativa
`maintenanceCounter` - `MaintenanceCounterActive!`	Incremento por contador
`maintenanceTime` - `MaintenanceTimeActive!`	Incremento por tempo
`skipWeekend` - `Boolean!`	Desconsidera finais de semana
`stopEquipment` - `Boolean!`	Indica se há parada de equipamento para execução da manutenção
`hoursBeforeStop` - `Float`	Número de horas paradas antes da manutenção
`hoursAfterStop` - `Float`	Número de horas paradas depois da manutenção
`equipment` - `EquipmentDefaults!`	Equipamento
`areas` - `[MaintenanceTree!]!`	Árvore de recursos
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "abc123",
  "description": "xyz789",
  "lastMaintenance": "2007-12-03T10:15:30Z",
  "active": false,
  "maintenanceCounter": MaintenanceCounterActive,
  "maintenanceTime": MaintenanceTimeActive,
  "skipWeekend": false,
  "stopEquipment": true,
  "hoursBeforeStop": 987.65,
  "hoursAfterStop": 987.65,
  "equipment": EquipmentDefaults,
  "areas": [MaintenanceTree],
  "branchId": "abc123"
}

Types

MaintenanceChecklist

Description

Recurso de checklist

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": "abc123",
  "step": Step,
  "type": "Area",
  "resources": [MaintenancePhysicalResource]
}

Types

MaintenanceCounterActive

Description

Incremento por contador

Fields

Field Name	Description
`increaseCounter` - `Float!`	Valor do incremento
`active` - `Boolean!`	Indica se está ativo

Example

{"increaseCounter": 987.65, "active": true}

Types

MaintenanceHumanResource

Description

Recursos humanos

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": "abc123",
  "type": "Area",
  "employee": Employee,
  "specialty": Specialty,
  "amount": 987.65,
  "resources": [MaintenancePhysicalResource],
  "checklists": [MaintenanceChecklist],
  "thirdParties": [MaintenanceThirdParty]
}

Types

MaintenanceOnEquipment

Description

Plano de manutenção do equipamento

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
`branchId` - `String`	Código identificador da filial

Example

{
  "equipmentId": "xyz789",
  "maintenance": "abc123",
  "active": false,
  "description": "xyz789",
  "lastMaintenance": "2007-12-03T10:15:30Z",
  "skipWeekend": true,
  "stopEquipment": false,
  "hoursBeforeStop": 987.65,
  "hoursAfterStop": 987.65,
  "detail": [DetailMaintenance],
  "maintenanceCounter": MaintenanceCounterActive,
  "maintenanceTime": MaintenanceTimeActive,
  "lastServiceOrder": DetailServiceOrder,
  "nextMaintenance": DetailServiceOrder,
  "realNextMaintenanceDate": "2007-12-03T10:15:30Z",
  "masterPlan": MasterPlanOnEquipment,
  "observation": Observation,
  "areas": [MaintenanceTree],
  "hasServiceOrder": false,
  "hasActiveServiceOrder": false,
  "branchId": "xyz789"
}

Types

MaintenanceOnServiceOrder

Description

Manutenção do equipamento

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": "abc123",
  "description": "abc123",
  "lastMaintenance": "2007-12-03T10:15:30Z",
  "active": false,
  "increaseCounter": 987.65,
  "timeIncrease": 123.45,
  "timeUnit": "Day",
  "equipment": EquipmentDefaults,
  "stopEquipment": false,
  "hoursBeforeStop": 987.65,
  "hoursAfterStop": 987.65
}

Types

MaintenancePhysicalResource

Description

Recurso físico

Fields

Field Name	Description
`id` - `String!`	Código identificador do recurso
`type` - `ResourceType!`	Tipo do recurso
`material` - `Material`	Material
`tool` - `Tool`	Ferramenta
`warehouse` - `Warehouse`	Local de estoque
`amount` - `Float`	Quantidade

Example

{
  "id": "xyz789",
  "type": "Area",
  "material": Material,
  "tool": Tool,
  "warehouse": Warehouse,
  "amount": 987.65
}

Types

MaintenanceSituation

Description

Tipo de situação da manutenção

Values

Enum Value	Description
`Active`	Ativa
`Inactive`	Inativa

Example

"Active"

Types

MaintenanceThirdParty

Description

Recurso de terceiro

Fields

Field Name	Description
`id` - `String!`	Código identificador do recurso
`thirdParty` - `ThirdParty!`	Serviço de terceiro
`supplier` - `Supplier`	Fornecedor do serviço
`type` - `ResourceType!`	Tipo do recurso

Example

{
  "id": "xyz789",
  "thirdParty": ThirdParty,
  "supplier": Supplier,
  "type": "Area"
}

Types

MaintenanceTimeActive

Description

Incremento por tempo

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": false}

Types

MaintenanceTree

Description

Árvore de recursos

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]
}

Types

Manufacturer

Description

Fabricante do modelo

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`isActive` - `Boolean`	Status
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "xyz789",
  "description": "abc123",
  "isActive": false,
  "branchId": "xyz789"
}

Types

ManufacturerQueryInput

Description

Pesquisa de fabricantes

Fields

Input Field	Description
`identifier` - `String`	Pesquisa por nome ou descrição
`isActive` - `Boolean`	Pesquisa registros ativos ou inativos
`branchId` - `String`	Pesquisa por uma filial específica

Example

{
  "identifier": "abc123",
  "isActive": false,
  "branchId": "abc123"
}

Types

MasterPlan

Description

Plano mestre

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": true,
  "hoursBeforeStop": 123.45,
  "hoursAfterStop": 987.65,
  "maintenanceCounter": MasterPlanCounter,
  "isImported": false,
  "model": Model,
  "group": Group,
  "branchId": "xyz789",
  "resources": [MasterPlanResource]
}

Types

MasterPlanCounter

Description

Incremento por contador

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": false}

Types

MasterPlanFilter

Description

Filtro de plano mestre

Fields

Input Field	Description
`counter` - `CounterType!`	Tipo de controle do contador
`equipmentId` - `String`	Código identificador do equipamento
`modelId` - `String`	Código identificador do modelo
`groupId` - `String`	Código identificador do grupo

Example

{
  "counter": "Hours",
  "equipmentId": "xyz789",
  "modelId": "xyz789",
  "groupId": "xyz789"
}

Types

MasterPlanOnEquipment

Description

Plano mestre

Fields

Field Name	Description
`active` - `Boolean!`	Indica se está ativo
`id` - `String`	Código identificador

Example

{"active": false, "id": "xyz789"}

Types

MasterPlanOrderBy

Description

Tipo de ordenação dos planos mestre

Values

Enum Value	Description
`Description`	Descrição
`ModelAndGroup`	Modelo e grupo

Example

"Description"

Types

MasterPlanQueryInput

Description

Pesquisa de planos mestre

Fields

Input Field	Description
`identifier` - `String`	Pesquisa por descrição
`filter` - `MasterPlanFilter`	Filtro

Example

{
  "identifier": "abc123",
  "filter": MasterPlanFilter
}

Types

MasterPlanResource

Description

Árvore de recursos de plano mestre

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]
}

Types

MasterPlanSummary

Description

Plano mestre

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": "xyz789",
  "description": "xyz789",
  "maintenanceTime": MasterPlanTime,
  "skipWeekend": false,
  "stopEquipment": false,
  "hoursBeforeStop": 987.65,
  "hoursAfterStop": 123.45,
  "maintenanceCounter": MasterPlanCounter,
  "isImported": false,
  "model": Model,
  "group": Group,
  "branchId": "abc123",
  "resources": [ResourceSummary],
  "tree": [MasterPlanResource]
}

Types

MasterPlanThirdParty

Description

Recurso de terceiro

Fields

Field Name	Description
`id` - `String!`	Código identificador do recurso
`thirdParty` - `ThirdParty!`	Serviço de terceiro
`supplier` - `Supplier`	Forcecedor do serviço
`cost` - `Float`	Custo do serviço
`type` - `ResourceType!`	Tipo do recurso

Example

{
  "id": "xyz789",
  "thirdParty": ThirdParty,
  "supplier": Supplier,
  "cost": 123.45,
  "type": "Area"
}

Types

MasterPlanTime

Description

Incremento por tempo

Fields

Field Name	Description
`timeIncrement` - `Float!`	Valor
`timeUnit` - `TimeUnitType!`	Unidade de tempo
`active` - `Boolean!`	Indica se está ativo

Example

{"timeIncrement": 987.65, "timeUnit": "Day", "active": false}

Types

Material

Description

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
`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

Example

{
  "id": "abc123",
  "description": "abc123",
  "standardCost": 987.65,
  "isActive": true,
  "referenceId": "abc123",
  "measurementUnit": NewMeasurementUnit,
  "isInMaintenance": true,
  "branchId": "abc123",
  "erpId": "xyz789"
}

Types

MeasurementUnit

Description

Unidade de medida

Fields

Field Name	Description
`id` - `String!`	Código identificador da unidade de medida
`description` - `String!`	Descrição da unidade de medida
`symbol` - `String`	Símbolo da unidade de medida

Example

{
  "id": "abc123",
  "description": "abc123",
  "symbol": "xyz789"
}

Types

Model

Description

Modelo do equipamento

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`isActive` - `Boolean`	Status
`manufacturer` - `Manufacturer`	Fabricante
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "xyz789",
  "description": "abc123",
  "isActive": true,
  "manufacturer": Manufacturer,
  "branchId": "xyz789"
}

Types

ModelQueryInput

Description

Pesquisa de modelos de equipamentos

Fields

Input Field	Description
`identifier` - `String`	Pesquisa por nome ou descrição
`isActive` - `Boolean`	Pesquisa registros ativos ou inativos
`branchId` - `String`	Pesquisa por uma filial específica

Example

{
  "identifier": "abc123",
  "isActive": true,
  "branchId": "abc123"
}

Types

NewMeasurementUnit

Description

Unidade de medida

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": "abc123",
  "acronym": "abc123",
  "isActive": false,
  "branchId": "xyz789",
  "erpId": "abc123",
  "description": "abc123",
  "symbol": "xyz789"
}

Types

NewPaginatedMeasurementUnits

Description

Unidades de medida

Fields

Field Name	Description
`items` - `[NewMeasurementUnit!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [NewMeasurementUnit], "hasMore": true}

Types

Observation

Description

Observação da manutenção

Fields

Field Name	Description
`situation` - `String!`	Situação
`suggestedDate` - `DateTime`	Data sugerida
`minimumDate` - `DateTime`	Data mínima
`deadline` - `DateTime`	Data final

Example

{
  "situation": "xyz789",
  "suggestedDate": "2007-12-03T10:15:30Z",
  "minimumDate": "2007-12-03T10:15:30Z",
  "deadline": "2007-12-03T10:15:30Z"
}

Types

OnboardingTask

Description

Tarefa de primeiros passos

Fields

Field Name	Description
`id` - `Float!`	Número da tarefa
`value` - `Float!`	Valor do bônus
`completed` - `Boolean!`	Indica se a tarefa foi feita

Example

{"id": 123.45, "value": 987.65, "completed": false}

Types

OrderBy

Description

Tipo de ordem

Values

Enum Value	Description
`Ascending`	Crescente
`Descending`	Decrescente

Example

"Ascending"

Types

OrganizationWithBranches

Description

Organização

Fields

Field Name	Description
`id` - `String!`	Código identificador
`name` - `String!`	Nome
`cognitoMetadataUrl` - `String`	Metadados Active Directory
`cognitoIdentifiers` - `String`	Identificadores Active Directory
`socialName` - `String`	Razão social
`organizationPicture` - `String`	URL da imagem
`expiresAt` - `DateTime`	Data de vencimento do plano de assinatura
`createdAt` - `DateTime!`	Data de criação
`isPartner` - `Boolean!`	Indica se possui clientes parceiros
`planStatus` - `PlanStatus`	Status do plano de assinatura
`onboardingTasks` - `[OnboardingTask!]`	Tarefas de primeiros passos
`paymentOrigin` - `PaymentOrigin!`	Tipo de controle de pagamento
`branches` - `[Branch!]!`	Filiais

Example

{
  "id": "xyz789",
  "name": "xyz789",
  "cognitoMetadataUrl": "abc123",
  "cognitoIdentifiers": "abc123",
  "socialName": "xyz789",
  "organizationPicture": "abc123",
  "expiresAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "isPartner": true,
  "planStatus": "Paid",
  "onboardingTasks": [OnboardingTask],
  "paymentOrigin": "Totvs",
  "branches": [Branch]
}

Types

PaginatedAreas

Description

Áreas

Fields

Field Name	Description
`items` - `[Area!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Area], "hasMore": false}

Types

PaginatedCalendars

Description

Calendários

Fields

Field Name	Description
`items` - `[Calendar!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Calendar], "hasMore": true}

Types

PaginatedCostCenters

Description

Centros de custo

Fields

Field Name	Description
`items` - `[CostCenter!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [CostCenter], "hasMore": false}

Types

PaginatedEmployees

Description

Funcionários

Fields

Field Name	Description
`items` - `[FullEmployee!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [FullEmployee], "hasMore": false}

Types

PaginatedEquipments

Description

Equipamentos

Fields

Field Name	Description
`items` - `[EquipmentList!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [EquipmentList], "hasMore": true}

Types

PaginatedFeatures

Description

Características

Fields

Field Name	Description
`items` - `[Feature!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Feature], "hasMore": true}

Types

PaginatedGroups

Description

Grupos

Fields

Field Name	Description
`items` - `[Group!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Group], "hasMore": true}

Types

PaginatedManufacturer

Description

Fabricantes de modelos

Fields

Field Name	Description
`items` - `[Manufacturer!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Manufacturer], "hasMore": false}

Types

PaginatedMasterPlans

Description

Planos mestre

Fields

Field Name	Description
`items` - `[MasterPlanSummary!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [MasterPlanSummary], "hasMore": true}

Types

PaginatedMaterials

Description

Materiais

Fields

Field Name	Description
`items` - `[Material!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Material], "hasMore": false}

Types

PaginatedModels

Description

Modelos de equipamentos

Fields

Field Name	Description
`items` - `[Model!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Model], "hasMore": false}

Types

PaginatedReasons

Description

Motivos de cancelamento ou inativação

Fields

Field Name	Description
`items` - `[Reason!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Reason], "hasMore": false}

Types

PaginatedServiceOrders

Description

Ordens de serviço

Fields

Field Name	Description
`items` - `[ServiceOrder!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [ServiceOrder], "hasMore": true}

Types

PaginatedServiceRequests

Description

Solicitações de serviço

Fields

Field Name	Description
`items` - `[ServiceRequestBrowse!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [ServiceRequestBrowse], "hasMore": true}

Types

PaginatedSpecialties

Description

Especialidades

Fields

Field Name	Description
`items` - `[Specialty!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Specialty], "hasMore": false}

Types

PaginatedSteps

Description

Etapas

Fields

Field Name	Description
`items` - `[Step!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Step], "hasMore": false}

Types

PaginatedSuppliers

Description

Fornecedores de serviços de terceiros

Fields

Field Name	Description
`items` - `[Supplier!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Supplier], "hasMore": false}

Types

PaginatedThirdParties

Description

Serviços de terceiros

Fields

Field Name	Description
`items` - `[ThirdParty!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [ThirdParty], "hasMore": false}

Types

PaginatedTools

Description

Ferramentas

Fields

Field Name	Description
`items` - `[Tool!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Tool], "hasMore": false}

Types

PaginatedWarehouses

Description

Locais de estoque

Fields

Field Name	Description
`items` - `[Warehouse!]!`	Lista de registros
`hasMore` - `Boolean!`	Indica se existem mais registros

Example

{"items": [Warehouse], "hasMore": false}

Types

Pagination

Description

Parâmetros de paginação

Fields

Input Field	Description
`skip` - `Int`	Número de registros a serem pulados
`limit` - `Int`	Número máximo de registros por lista

Example

{"skip": 123, "limit": 987}

Types

PaginationDefaultQueryInput

Description

Pesquisa de cadastros gerais

Fields

Input Field	Description
`identifier` - `String`	Pesquisa por nome ou descrição
`isActive` - `Boolean`	Pesquisa registros ativos ou inativos
`branchId` - `String`	Pesquisa por uma filial específica

Example

{
  "identifier": "abc123",
  "isActive": false,
  "branchId": "abc123"
}

Types

PaymentOrigin

Description

Tipo de controle de pagamento

Values

Enum Value	Description
`Totvs`	Totvs
`Omie`	Omie
`Internal`	Interno

Example

"Totvs"

Types

PeriodUnit

Description

Tipo de unidade do período

Values

Enum Value	Description
`Day`	Dia
`Month`	Mês
`Year`	Ano

Example

"Day"

Types

PersonType

Description

Tipo de cadastro fiscal

Values

Enum Value	Description
`IndividualPerson`	Pessoa física
`LegalPerson`	Pessoa jurídica

Example

"IndividualPerson"

Types

PhysicalResource

Description

Recurso físico

Fields

Field Name	Description
`id` - `String!`	Código identificador do recurso
`type` - `ResourceType!`	Tipo do recurso
`amount` - `Float!`	Quantidades
`material` - `Material`	Material
`tool` - `Tool`	Ferramenta
`warehouse` - `Warehouse`	Local de estoque

Example

{
  "id": "xyz789",
  "type": "Area",
  "amount": 987.65,
  "material": Material,
  "tool": Tool,
  "warehouse": Warehouse
}

Types

PhysicalResourceTree

Description

Recurso físico

Fields

Field Name	Description
`id` - `String!`	Código identificador do recurso
`type` - `ResourceType!`	Tipo do recurso
`material` - `Material`	Material
`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,
  "tool": Tool,
  "warehouse": Warehouse,
  "amount": 123.45,
  "cost": 987.65,
  "amountDone": 987.65,
  "costDone": 987.65,
  "foreseen": false,
  "done": true,
  "parentId": "abc123"
}

Types

PlanStatus

Description

Status do plano de assinatura

Values

Enum Value	Description
`Paid`	Pago
`Cancelled`	Cancelado
`Trial`	Período de testes

Example

"Paid"

Types

PolicyAgreement

Description

Termo de uso e política de privacidade

Fields

Field Name	Description
`id` - `String!`	Código identificador
`termId` - `String!`	Código identificador do termo
`userId` - `String!`	Código identificador do usuário
`ipAddress` - `String!`	Endereço IP da aceitação
`createdAt` - `DateTime!`	Data de criação
`userAgent` - `String!`	Credencial de requisição HTTP

Example

{
  "id": "xyz789",
  "termId": "abc123",
  "userId": "abc123",
  "ipAddress": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "userAgent": "xyz789"
}

Types

PostingType

Description

Tipo de acompanhamento

Values

Enum Value	Description
`Event`	Gerado automaticamente pelo sistema
`Comment`	Comentário de usuário

Example

"Event"

Types

PurchaseCategory

Description

Categoria da Compra

Fields

Field Name	Description
`codigo` - `String!`	Código identificador da categoria da compra
`descricao` - `String!`	Nome da categoria da compra

Example

{
  "codigo": "xyz789",
  "descricao": "abc123"
}

Types

Reason

Description

Motivo de cancelamento ou inativação

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`type` - `ReasonType!`	Tipo de cancelamento
`isActive` - `Boolean`	Status
`referenceId` - `String`
`isUsed` - `Boolean`	Indica se o motivo foi utilizado
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "xyz789",
  "description": "xyz789",
  "type": "Delay",
  "isActive": true,
  "referenceId": "abc123",
  "isUsed": true,
  "branchId": "xyz789"
}

Types

ReasonType

Description

Tipo de motivo de cancelamento ou inativação

Values

Enum Value	Description
`Delay`	Essa opção não está disponível
`Release`	Inativação de equipameto
`SOCancellation`	Cancelamento de OS
`SRCancellation`	Cancelamento de SS

Example

"Delay"

Types

RequestBasicInfo

Description

Usuário solicitante

Fields

Field Name	Description
`id` - `String!`	Código identificador
`name` - `String!`	Nome
`profilePicture` - `String`	Foto de perfil

Example

{
  "id": "abc123",
  "name": "abc123",
  "profilePicture": "abc123"
}

Types

ResourceSummary

Description

Resumo de recurso de plano mestre

Fields

Field Name	Description
`type` - `ResourceType!`	Tipo do recurso
`quantity` - `Float!`	Quantidade do tipo de recurso

Example

{"type": "Area", "quantity": 987.65}

Types

ResourceType

Description

Tipo de recurso

Values

Enum Value	Description
`Area`	Área
`Employee`	Mão de obra
`SpecialtyEmployee`	Especialidade
`Checklist`	Etapa
`Material`	Material
`Tool`	Ferramenta
`ThirdParty`	Serviço de terceiro

Example

"Area"

Types

ResourcesOnServiceOrder

Description

Recursos de ordem de serviço

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

Example

{
  "id": "abc123",
  "branchId": "abc123",
  "serviceOrderId": "abc123",
  "type": "Area",
  "areaId": "abc123",
  "employeeId": "abc123",
  "specialtyId": "xyz789",
  "thirdPartyId": "xyz789",
  "supplierId": "xyz789",
  "stepId": "abc123",
  "materialId": "abc123",
  "toolId": "abc123",
  "warehouseId": "xyz789",
  "sequence": 987.65,
  "areaDoneId": "xyz789",
  "employeeDoneId": "abc123",
  "thirdPartyDoneId": "abc123",
  "supplierDoneId": "abc123",
  "stepDoneId": "xyz789",
  "materialDoneId": "abc123",
  "toolDoneId": "abc123",
  "warehouseDoneId": "xyz789",
  "sequenceDone": 123.45,
  "foreseen": false,
  "done": false,
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "amount": 123.45,
  "response": "xyz789",
  "cost": 123.45,
  "startDateDone": "2007-12-03T10:15:30Z",
  "endDateDone": "2007-12-03T10:15:30Z",
  "amountDone": 987.65,
  "costDone": 987.65,
  "parentId": "xyz789",
  "parentDoneId": "abc123",
  "purchaseRequestId": "xyz789"
}

Types

Role

Description

Perfil de usuário

Fields

Field Name	Description
`userId` - `String!`	Código identificador do usuário
`branchId` - `String!`	Código identificador da filial que o usuário acessa com o perfil
`roleId` - `String!`	Perfil do usuário
`createdAt` - `DateTime!`	Data de criação
`branch` - `Branch!`	Filial que o usuário acessa com o perfil

Example

{
  "userId": "xyz789",
  "branchId": "xyz789",
  "roleId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "branch": Branch
}

Types

SatisfactionSurvey

Description

Pesquisa de satisfação

Fields

Field Name	Description
`id` - `String!`	Código identificador
`deadlineEvaluation` - `EvaluationType!`	Tipo de resposta - atendimento no prazo
`coveringEvaluation` - `EvaluationType!`	Tipo de resposta - atendimento da necessidade
`observation` - `String`	Observação

Example

{
  "id": "abc123",
  "deadlineEvaluation": "Great",
  "coveringEvaluation": "Great",
  "observation": "xyz789"
}

Types

Scale

Description

Tipo de criticidade do equipamento

Values

Enum Value	Description
`High`	Alta
`Medium`	Baixa
`Low`	Média

Example

"High"

Types

SensorDataDay

Description

Histórico de sensor por dia

Fields

Field Name	Description
`label` - `String!`	Dia do lançamento
`result` - `Float!`	Saúde do sensor

Example

{"label": "xyz789", "result": 987.65}

Types

SensorDataEquipment

Description

Dados de sensor do equipamento

Fields

Field Name	Description
`id` - `String!`	Código identificador
`sensorId` - `String!`	Código identificador do sensor
`surfaceTemperature` - `Float!`	Temperatura
`surfaceTemperatureThresholdWarning` - `Float`	Limite de temperatura para alerta
`surfaceTemperatureThresholdCritical` - `Float`	Limite crítico de temperatura
`velX` - `Float!`	Limite de vibração horizontal para alerta
`velXThresholdWarning` - `Float`	Limite crítico de vibração horizontal
`velXThresholdCritical` - `Float`	Vibração Horizontal
`velY` - `Float!`	Vibração Vertical
`velYThresholdWarning` - `Float`	Limite de vibração vertical para alerta
`velYThresholdCritical` - `Float`	Limite crítico de vibração vertical
`velZ` - `Float!`	Vibração Axial
`velZThresholdWarning` - `Float`	Limite de vibração axial para alerta
`velZThresholdCritical` - `Float`	Limite crítico de vibração axial
`lastTimestamp` - `DateTime!`	Data da última coleta
`health` - `Float!`	Saúde do ativo
`enabled` - `Boolean!`	Status do ativo
`createdAt` - `DateTime!`	Data de criação no sistema

Example

{
  "id": "xyz789",
  "sensorId": "xyz789",
  "surfaceTemperature": 123.45,
  "surfaceTemperatureThresholdWarning": 123.45,
  "surfaceTemperatureThresholdCritical": 123.45,
  "velX": 123.45,
  "velXThresholdWarning": 987.65,
  "velXThresholdCritical": 123.45,
  "velY": 123.45,
  "velYThresholdWarning": 123.45,
  "velYThresholdCritical": 123.45,
  "velZ": 987.65,
  "velZThresholdWarning": 123.45,
  "velZThresholdCritical": 987.65,
  "lastTimestamp": "2007-12-03T10:15:30Z",
  "health": 987.65,
  "enabled": false,
  "createdAt": "2007-12-03T10:15:30Z"
}

Types

SensorDataHour

Description

Histórico do sensor por hora

Fields

Field Name	Description
`label` - `String!`	Data e hora do lançamento
`surfaceTemperature` - `String!`	Temperatura
`velZ` - `String`	Vibração Axial
`velX` - `String`	Vibração Horizontal
`velY` - `String`	Vibração Vertical

Example

{
  "label": "xyz789",
  "surfaceTemperature": "abc123",
  "velZ": "xyz789",
  "velX": "abc123",
  "velY": "abc123"
}

Types

SensorDataLastWeek

Description

Dados dos últimos 7 dias do sensor

Fields

Field Name	Description
`sensorByHour` - `[SensorDataHour!]`	Históricos por hora
`sensorByDay` - `[SensorDataDay!]`	Históricos por dia

Example

{
  "sensorByHour": [SensorDataHour],
  "sensorByDay": [SensorDataDay]
}

Types

SensorEquipment

Description

Sensores do equipamento

Fields

Field Name	Description
`id` - `String!`	Código identificador
`externalId` - `String!`	Código identificador do sensor
`description` - `String!`	Descrição do sensor
`mainPicture` - `String`	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": "abc123",
  "sensorType": "abc123",
  "hasSensorData": true,
  "sensorData": [SensorDataEquipment]
}

Types

ServiceOrder

Description

Ordem de serviço

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
`doneMaterialCost` - `Float`	Custo do material realizado
`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": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "attachments": [Attachment],
  "maintenance": MaintenanceOnServiceOrder,
  "cancellationReasonRef": Reason,
  "costCenterRef": CostCenter,
  "observation": "xyz789",
  "priority": 123.45,
  "realStartDate": "2007-12-03T10:15:30Z",
  "realEndDate": "2007-12-03T10:15:30Z",
  "conclusion": 987.65,
  "doneCost": 987.65,
  "foreseenCost": 123.45,
  "createdAt": "2007-12-03T10:15:30Z",
  "areas": [AreaTree],
  "resources": [ResourcesOnServiceOrder],
  "followUp": [ServiceOrderFollowUp],
  "stoppedAt": "2007-12-03T10:15:30Z",
  "resumedAt": "2007-12-03T10:15:30Z",
  "foreseenStoppedAt": "2007-12-03T10:15:30Z",
  "foreseenResumedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "operationTime": 987.65,
  "hasDoneResource": true,
  "hasDoneHuman": false,
  "hasUnreportedThirdParty": false,
  "generatedByServiceRequest": false,
  "hasMaintenceByCounter": true,
  "serviceRequest": ServiceRequestRef,
  "finalizationObservation": "xyz789",
  "cancellationObservation": "abc123",
  "counter": Counter,
  "foreseenEmployeeCost": 123.45,
  "doneEmployeeCost": 987.65,
  "foreseenToolCost": 987.65,
  "doneToolCost": 987.65,
  "foreseenMaterialCost": 123.45,
  "doneMaterialCost": 123.45,
  "foreseenThirdPartyCost": 987.65,
  "doneThirdPartyCost": 987.65,
  "branchId": "xyz789"
}

Types

ServiceOrderAction

Description

Tipo de classificação do acompanhamento da ordem de serviço

Values

Enum Value	Description
`Open`	Abertura
`OpenWithSR`	Abertura por SS
`Report`	Reporte
`AutoReport`	Reporte automático
`ReportFinished`	Reporte de finalizada
`Finish`	Finalização
`Cancel`	Cancelamento
`Update`	Edição
`Comment`	Comentário de usuário

Example

"Open"

Types

ServiceOrderBasicInfo

Description

Ordem de serviço

Fields

Field Name	Description
`id` - `String!`	Código identificador
`code` - `String!`	Código do serviço na filial
`createdAt` - `DateTime!`	Data de criação

Example

{
  "id": "xyz789",
  "code": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z"
}

Types

ServiceOrderCosts

Description

Custos da ordem de serviço

Fields

Field Name	Description
`foreseenEmployeeCost` - `Float!`	Custo de mãos de obra previstos
`doneEmployeeCost` - `Float!`	Custo de mãos de obra realizados
`foreseenToolCost` - `Float!`	Custo de ferramentas previstas
`doneToolCost` - `Float!`	Custo de ferramentas realizadas
`foreseenMaterialCost` - `Float!`	Custo de materiais previstos
`doneMaterialCost` - `Float!`	Custo de materiais realizados
`foreseenThirdPartyCost` - `Float!`	Custo de serviços de terceiros previstos
`doneThirdPartyCost` - `Float!`	Custo de serviços de terceiros realizados

Example

{
  "foreseenEmployeeCost": 987.65,
  "doneEmployeeCost": 987.65,
  "foreseenToolCost": 987.65,
  "doneToolCost": 123.45,
  "foreseenMaterialCost": 987.65,
  "doneMaterialCost": 987.65,
  "foreseenThirdPartyCost": 987.65,
  "doneThirdPartyCost": 987.65
}

Types

ServiceOrderDefaults

Description

Ordem de serviço

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": "xyz789",
  "code": "xyz789",
  "equipment": EquipmentDefaults,
  "user": UserBasicInfo,
  "service": "Corrective",
  "situation": "Opened",
  "startDate": "2007-12-03T10:15:30Z",
  "endDate": "2007-12-03T10:15:30Z",
  "attachments": [Attachment],
  "maintenance": MaintenanceOnServiceOrder,
  "cancellationReasonRef": Reason,
  "costCenterRef": CostCenter,
  "observation": "xyz789",
  "priority": 987.65,
  "realStartDate": "2007-12-03T10:15:30Z",
  "realEndDate": "2007-12-03T10:15:30Z",
  "conclusion": 123.45,
  "doneCost": 123.45,
  "foreseenCost": 123.45,
  "createdAt": "2007-12-03T10:15:30Z"
}

Types

ServiceOrderFilter

Description

Filtro de ordem de serviço

Fields

Input Field	Description
`serials` - `[String!]`	Séries de equipamento
`priorities` - `[ServiceOrderPriority!]`	Tipos de prioridade
`criticalities` - `[Scale!]`	Criticidades
`situations` - `[ServiceOrderSituation!]`	Tipos de situação
`serviceTypes` - `[ServiceType!]`	Tipos de serviço
`expectedStart` - `DateRange`	Intervalo de tempo da previsão de início
`expectedEnd` - `DateRange`	Intervalo de tempo da previsão de fim
`updatedAt` - `DateRange`	Intervalo de data da última atualização
`costCenters` - `[String!]`	Códigos identificadores de centros de custo
`customers` - `[String!]`	Códigos identificadores de clientes
`equipmentOwnersType` - `[EquipmentOwnerType!]`	Tipos de proprietário
`groups` - `[String!]`	Códigos identificadores de grupos
`equipments` - `[String!]`	Códigos identificadores de equipamentos
`tags` - `[String!]`	TAGs de equipamentos
`conclusion` - `FloatRange`	Intervalo de percentual de conclusão
`finishedAt` - `DateRange`	Intervalo de tempo da finalização
`foreseenCost` - `FloatRange`	Intervalo de custo previsto
`doneCost` - `FloatRange`	Intervalo de custo realizado
`foreseenEmployees` - `[String!]`	Códigos identificadores de mãos de obra previstas
`doneEmployees` - `[String!]`	Códigos identificadores de mãos de obra realizadas
`foreseenThirdParties` - `[String!]`	Códigos identificadores de serviços de terceiros previstos
`doneThirdParties` - `[String!]`	Códigos identificadores de serviços de terceiros realizados
`maintenances` - `[String!]`	Códigos identificadores de manutenções
`code` - `StringRange`	Intervalo de códigos de OS

Example

{
  "serials": ["abc123"],
  "priorities": ["Emergency"],
  "criticalities": ["High"],
  "situations": ["Opened"],
  "serviceTypes": ["Corrective"],
  "expectedStart": DateRange,
  "expectedEnd": DateRange,
  "updatedAt": DateRange,
  "costCenters": ["xyz789"],
  "customers": ["abc123"],
  "equipmentOwnersType": ["Own"],
  "groups": ["xyz789"],
  "equipments": ["abc123"],
  "tags": ["xyz789"],
  "conclusion": FloatRange,
  "finishedAt": DateRange,
  "foreseenCost": FloatRange,
  "doneCost": FloatRange,
  "foreseenEmployees": ["xyz789"],
  "doneEmployees": ["xyz789"],
  "foreseenThirdParties": ["xyz789"],
  "doneThirdParties": ["xyz789"],
  "maintenances": ["abc123"],
  "code": StringRange
}

Types

ServiceOrderFollowUp

Description

Acompanhamento da ordem de serviço

Fields

Field Name	Description
`type` - `PostingType!`	Tipo de acompanhamento
`user` - `User!`	Usuário
`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

Example

{
  "type": "Event",
  "user": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "abc123",
  "description": "abc123",
  "deletedAt": "2007-12-03T10:15:30Z",
  "branchId": "xyz789",
  "action": "Open",
  "serviceRequestId": "abc123",
  "requesterId": "xyz789"
}

Types

ServiceOrderHome

Description

Ordem de serviço

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": "abc123",
  "code": "xyz789",
  "situation": "Opened",
  "startDate": "2007-12-03T10:15:30Z",
  "equipment": EquipmentBasicInfo,
  "conclusion": 987.65,
  "doneCost": 123.45,
  "foreseenCost": 123.45,
  "priority": 123.45,
  "branchId": "xyz789"
}

Types

ServiceOrderOrderByFields

Description

Tipo de ordenação das ordens de serviço

Values

Enum Value	Description
`Priority`	Prioridade
`Progress`	Progresso
`ForeseenStart`	Início previsto
`Code`	Código

Example

"Priority"

Types

ServiceOrderOrderByInput

Description

Ordenação de ordens de serviço

Fields

Input Field	Description
`field` - `ServiceOrderOrderByFields`	Tipo de ordenação
`type` - `OrderBy`	Tipo de ordem

Example

{"field": "Priority", "type": "Ascending"}

Types

ServiceOrderPriority

Description

Tipo de prioridade da ordem de serviço

Values

Enum Value	Description
`Emergency`	Emergencial
`High`	Alta
`Medium`	Média
`Low`	Baixa
`Planned`	Planejada

Example

"Emergency"

Types

ServiceOrderQueryInput

Description

Pesquisa de ordem de serviço

Fields

Input Field	Description
`identifier` - `String`	Texto para pesquisa
`filter` - `ServiceOrderFilter`	Filtro
`summaryOrderBy` - `SummaryOrderBy`	Tipo de ordenação do filtro

Example

{
  "identifier": "xyz789",
  "filter": ServiceOrderFilter,
  "summaryOrderBy": "Alphabetic"
}

Types

ServiceOrderSettings

Description

Configurações de ordens de serviço

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

Example

{"requesterSeeOwnServiceOrder": true, "requiredEquipmentDowntime": false}

Types

ServiceOrderSituation

Description

Tipo de situação da ordem de serviço

Values

Enum Value	Description
`Opened`	Aberta
`Canceled`	Cancelada
`Closed`	Finalizada

Example

"Opened"

Types

ServiceRequest

Description

Solicitação de serviço

Fields

Field Name	Description
`id` - `String!`	Código identificador
`code` - `String!`	Código do serviço na filial
`description` - `String!`	Descrição
`isAuto` - `Boolean!`	Indica se é uma solicitação de serviço automática
`situation` - `ServiceRequestSituation!`	Tipo de situação
`priority` - `ServiceRequestPriority`	Tipo de prioridade
`observation` - `String`	Observações
`runningTime` - `String`	Tempo de execução
`employee` - `Employee`	Executor
`reason` - `Reason`	Motivo de cancelamento
`equipment` - `EquipmentDefaults`	Equipamento
`customer` - `CustomerPartner`	Cliente
`serviceOrder` - `ServiceOrderDefaults`	Ordem de serviço
`satisfactionSurvey` - `SatisfactionSurvey`	Pesquisa de satisfação
`requester` - `User!`	Usuário solicitante
`createdAt` - `DateTime!`	Data de criação
`stoppedAt` - `DateTime`	Data de início da parada do equipamento
`serviceTime` - `String`	Tempo de serviço
`runTime` - `String`	Tempo de execução
`finishedAt` - `DateTime`	Data de finalização
`distributedAt` - `DateTime`	Data de distribuição
`canceledAt` - `DateTime`	Data de cancelamento
`branchId` - `String`	Código identificador da filial
`attachments` - `[Attachment!]!`	Anexos
`followUp` - `[ServiceRequestFollowUp!]!`	Acompanhamentos

Example

{
  "id": "xyz789",
  "code": "abc123",
  "description": "xyz789",
  "isAuto": false,
  "situation": "AwaitingAnalysis",
  "priority": "Emergency",
  "observation": "xyz789",
  "runningTime": "abc123",
  "employee": Employee,
  "reason": Reason,
  "equipment": EquipmentDefaults,
  "customer": CustomerPartner,
  "serviceOrder": ServiceOrderDefaults,
  "satisfactionSurvey": SatisfactionSurvey,
  "requester": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "stoppedAt": "2007-12-03T10:15:30Z",
  "serviceTime": "xyz789",
  "runTime": "abc123",
  "finishedAt": "2007-12-03T10:15:30Z",
  "distributedAt": "2007-12-03T10:15:30Z",
  "canceledAt": "2007-12-03T10:15:30Z",
  "branchId": "xyz789",
  "attachments": [Attachment],
  "followUp": [ServiceRequestFollowUp]
}

Types

ServiceRequestAction

Description

Tipo de classificação para acompanhamento da solicitação de serviço

Values

Enum Value	Description
`Comment`	Comentário de usuário
`CreatedByWEG`	Criação automática por sensor WEG
`UpdatedByWEG`	Edição automática por sensor WEG
`WaitAnalysis`	Criação
`WaitSurvey`	Questionário
`Distribute`	Distribuição
`DistributeWithSO`	Geração de OS
`Finish`	Finalização
`FinishByAdmin`	Finalização por administrador do sistema
`FinishRelatedSO`	Finalização automática pela OS gerada
`Cancel`	Cancelamento
`CancelRelatedSO`	Cancelamento automático pela OS gerada
`Update`	Edição

Example

"Comment"

Types

ServiceRequestBrowse

Description

Solicitação de serviço

Fields

Field Name	Description
`id` - `String!`	Código identificador
`code` - `String!`	Código do serviço na filial
`description` - `String!`	Ocorrência
`isAuto` - `Boolean!`	Indica se é uma solicitação de serviço automática
`situation` - `ServiceRequestSituation!`	Tipo de situação
`priority` - `ServiceRequestPriority`	Tipo de prioridade
`observation` - `String`	Observações
`runningTime` - `String`	Tempo de execução
`stoppedAt` - `DateTime`	Data de início da parada do equipamento
`reason` - `Reason`	Motivo de cancelamento
`equipment` - `EquipmentDefaults`	Equipamento
`serviceOrder` - `ServiceOrderDefaults`	Ordem de serviço
`satisfactionSurvey` - `SatisfactionSurvey`	Pesquisa de satisfação
`requester` - `User!`	Usuário solicitante
`createdAt` - `DateTime!`	Data de criação
`serviceTime` - `String`	Tempo em análise
`runTime` - `String`	Tempo em execução
`employee` - `Employee`	Executor
`finishedAt` - `DateTime`	Data de finalização
`distributedAt` - `DateTime`	Data de distribuição
`canceledAt` - `DateTime`	Data de cancelamento
`customer` - `CustomerPartner`	Cliente
`branchId` - `String`	Código identificador da filial
`attachments` - `[Attachment!]`	Anexos

Example

{
  "id": "xyz789",
  "code": "xyz789",
  "description": "abc123",
  "isAuto": false,
  "situation": "AwaitingAnalysis",
  "priority": "Emergency",
  "observation": "abc123",
  "runningTime": "xyz789",
  "stoppedAt": "2007-12-03T10:15:30Z",
  "reason": Reason,
  "equipment": EquipmentDefaults,
  "serviceOrder": ServiceOrderDefaults,
  "satisfactionSurvey": SatisfactionSurvey,
  "requester": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "serviceTime": "abc123",
  "runTime": "xyz789",
  "employee": Employee,
  "finishedAt": "2007-12-03T10:15:30Z",
  "distributedAt": "2007-12-03T10:15:30Z",
  "canceledAt": "2007-12-03T10:15:30Z",
  "customer": CustomerPartner,
  "branchId": "xyz789",
  "attachments": [Attachment]
}

Types

ServiceRequestFilter

Description

Filtro de solicitação de serviço

Fields

Input Field	Description
`serials` - `[String!]`	Séries de equipamento
`equipments` - `[String]`	Códigos identificadores de equipamentos
`tags` - `[String!]`	TAGs de equipamentos
`criticalities` - `[Scale!]`	Criticidades
`costCenters` - `[String!]`	Códigos identificadores de centros de custo
`situations` - `[ServiceRequestSituation!]`	Tipos de situação
`origin` - `[ServiceRequestOrigin!]`	Origem da abertura da Solicitação
`customers` - `[String!]`	Códigos identificadores de clientes
`equipmentOwnersType` - `[EquipmentOwnerType!]`	Tipos de proprietário
`priorities` - `[ServiceRequestPriority!]`	Tipos de prioridade
`createdAt` - `DateRange`	Intervalo de data de criação
`updatedAt` - `DateRange`	Intervalo de data da última atualização
`openedBy` - `[String!]`	Códigos identificadores de usuários responsáveis pela abertura
`distributedTo` - `[String!]`	Códigos identificadores de executores

Example

{
  "serials": ["xyz789"],
  "equipments": ["abc123"],
  "tags": ["abc123"],
  "criticalities": ["High"],
  "costCenters": ["abc123"],
  "situations": ["AwaitingAnalysis"],
  "origin": ["ByUser"],
  "customers": ["abc123"],
  "equipmentOwnersType": ["Own"],
  "priorities": ["Emergency"],
  "createdAt": DateRange,
  "updatedAt": DateRange,
  "openedBy": ["xyz789"],
  "distributedTo": ["abc123"]
}

Types

ServiceRequestFollowUp

Description

Acompanhamento da solicitação de serviço

Fields

Field Name	Description
`type` - `PostingType!`	Tipo de acompanhamento
`user` - `User!`	Usuário
`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`

Example

{
  "type": "Event",
  "user": User,
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "abc123",
  "description": "xyz789",
  "deletedAt": "2007-12-03T10:15:30Z",
  "branchId": "abc123",
  "action": "Comment",
  "serviceOrderId": "abc123"
}

Types

ServiceRequestHome

Description

Solicitação de serviço

Fields

Field Name	Description
`id` - `String!`	Código identificador
`code` - `String!`	Código do serviço na filial
`createdAt` - `DateTime!`	Data de criação
`serviceOrder` - `ServiceOrderBasicInfo`	Ordem de serviço
`equipment` - `EquipmentBasicInfo`	Equipamento
`requester` - `RequestBasicInfo!`	Usuário solicitante
`priority` - `ServiceRequestPriority`	Tipo de prioridade
`situation` - `ServiceRequestSituation!`	Tipo de situação
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "abc123",
  "code": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "serviceOrder": ServiceOrderBasicInfo,
  "equipment": EquipmentBasicInfo,
  "requester": RequestBasicInfo,
  "priority": "Emergency",
  "situation": "AwaitingAnalysis",
  "branchId": "abc123"
}

Types

ServiceRequestOrderByField

Description

Tipo de ordenação das solicitações de serviço

Values

Enum Value	Description
`Priority`	Prioridade
`CreatedAt`	Data de abertura

Example

"Priority"

Types

ServiceRequestOrderByInput

Description

Ordenação de solicitações de serviço

Fields

Input Field	Description
`field` - `ServiceRequestOrderByField`	Tipo de ordenação
`type` - `OrderBy`	Tipo de ordem

Example

{"field": "Priority", "type": "Ascending"}

Types

ServiceRequestOrigin

Description

Origem da abertura da Solicitação

Values

Enum Value	Description
`ByUser`	Criação por usuário
`ByAutomatically`	Criação automática

Example

"ByUser"

Types

ServiceRequestPriority

Description

Tipo de prioridade da solicitação de serviço

Values

Enum Value	Description
`Emergency`	Emergencial
`High`	Alta
`Medium`	Média
`Low`	Baixa

Example

"Emergency"

Types

ServiceRequestQueryInput

Description

Pesquisa de solicitação de serviço

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"
}

Types

ServiceRequestRef

Description

Solicitação de serviço

Fields

Field Name	Description
`id` - `String!`	Código identificador
`code` - `String!`	Código do serviço na filial
`situation` - `ServiceRequestSituation!`	Situação
`requesterId` - `String!`	Código identificador do usuário solicitante

Example

{
  "id": "abc123",
  "code": "xyz789",
  "situation": "AwaitingAnalysis",
  "requesterId": "xyz789"
}

Types

ServiceRequestSituation

Description

Tipo de situação da solicitação de serviço

Values

Enum Value	Description
`AwaitingAnalysis`	Aguardando análise
`Distributed`	Distribuída
`DistributedWithSO`	Aguardando OS
`Satisfaction`	Aguardando resposta à pesquisa de satisfação
`Finished`	Finalizada
`Canceled`	Cancelada

Example

"AwaitingAnalysis"

Types

ServiceType

Description

Tipo de serviço da ordem de serviço

Values

Enum Value	Description
`Corrective`	Corretivo
`Improvement`	Melhoria
`Preventive`	Preventivo

Example

"Corrective"

Types

Specialty

Description

Especialidade

Fields

Field Name	Description
`id` - `String!`	Código identificador
`name` - `String!`	Nome
`hourlyWage` - `Float!`	Salário por hora
`isActive` - `Boolean`	Status
`isInMaintenance` - `Boolean`	Indica se a especialidade é usada em alguma árvore de recursos

Example

{
  "id": "abc123",
  "name": "xyz789",
  "hourlyWage": 123.45,
  "isActive": true,
  "isInMaintenance": true
}

Types

Step

Description

Etapa

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
`isInMaintenance` - `Boolean`	Indica se a etapa é usada em alguma árvore de recursos
`branchId` - `String`	Código identificador da filial

Example

{
  "id": "xyz789",
  "description": "xyz789",
  "isReported": true,
  "averageTime": "xyz789",
  "requestResponse": false,
  "type": "Number",
  "measurementUnit": MeasurementUnit,
  "isActive": true,
  "isInMaintenance": false,
  "branchId": "abc123"
}

Types

StepType

Description

Tipo de dado da resposta da etapa

Values

Enum Value	Description
`Number`	Numérico

Example

"Number"

Types

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"

Types

StringRange

Description

Intervalo textual

Fields

Input Field	Description
`min` - `String`	Mínimo
`max` - `String`	Máximo

Example

{
  "min": "xyz789",
  "max": "abc123"
}

Types

SummaryOrderBy

Description

Tipo de ordenação dos filtros

Values

Enum Value	Description
`Alphabetic`	Ordem alfabética
`Amount`	Ordem numérica

Example

"Alphabetic"

Types

Supplier

Description

Fornecedor do serviço de terceiro

Fields

Field Name	Description
`id` - `String!`	Código identificador
`name` - `String!`	Nome
`branchId` - `String`	Código identificador da filial
`erpId` - `String`	Código identificador na integração

Example

{
  "id": "abc123",
  "name": "xyz789",
  "branchId": "abc123",
  "erpId": "xyz789"
}

Types

ThirdParty

Description

Serviço de terceiro

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": "xyz789",
  "standardCost": 987.65,
  "isActive": false,
  "suppliers": [ThirdPartySupplierCost],
  "isInMaintenance": false,
  "branchId": "abc123"
}

Types

ThirdPartySupplierCost

Description

Fornecedor de serviço de terceiro

Fields

Field Name	Description
`id` - `String!`	Código identificador
`name` - `String!`	Nome
`branchId` - `String`	Código identificador da filial
`erpId` - `String`	Código identificador na integração
`cost` - `Float!`	Custo do fornecedor

Example

{
  "id": "xyz789",
  "name": "xyz789",
  "branchId": "abc123",
  "erpId": "xyz789",
  "cost": 987.65
}

Types

ThirdPartyTree

Description

Recurso de terceiro

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": 123.45,
  "parentId": "abc123"
}

Types

TimePoint

Description

Dia da semana e hora para turnos de trabalho

Fields

Field Name	Description
`day` - `DayOfWeek!`	Dia da semana
`hour` - `String!`	Hora do dia

Example

{"day": "Sunday", "hour": "abc123"}

Types

TimeUnitType

Description

Unidade de tempo

Values

Enum Value	Description
`Day`	Dia
`Month`	Mês
`Year`	Ano

Example

"Day"

Types

Tool

Description

Ferramenta

Fields

Field Name	Description
`id` - `String!`	Código identificador
`description` - `String!`	Descrição
`hourlyCost` - `Float!`	Custo por hora
`isActive` - `Boolean`	Status
`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": 123.45,
  "isActive": true,
  "isInMaintenance": false,
  "branchId": "abc123"
}

Types

TotvsModaEndpointSettings

Description

Configurações de integração com Totvs Moda

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
`requester` - `Float!`	Código do usuário da requisição

Example

{
  "integrationTotvsModa": true,
  "supplierType": "xyz789",
  "supplierClassifications": ["abc123"],
  "productType": "abc123",
  "productClassifications": ["abc123"],
  "cost": 987.65,
  "purposeCode": 987.65,
  "requester": 123.45
}

Types

User

Description

Usuário

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!`	E-mail
`accessBy` - `AccessBy!`	Forma de acesso ao sistema
`employees` - `[Employee!]!`	Funcionários vinculados
`verifiedEmail` - `String`	E-mail verificado
`profilePicture` - `String`	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": "xyz789",
  "address": "abc123",
  "educationLevel": "ElementarySchool",
  "gender": "Male",
  "mobileTourView": true,
  "id": "4",
  "name": "xyz789",
  "email": "abc123",
  "accessBy": "Internal",
  "employees": [Employee],
  "verifiedEmail": "abc123",
  "profilePicture": "abc123",
  "restrictedBy": "abc123",
  "preferences": UserPreferences,
  "policiesAgreement": [PolicyAgreement],
  "roles": [Role],
  "customer": CustomerPartner
}

Types

UserBasicInfo

Description

Informações básicas de usuário

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!`	E-mail
`accessBy` - `AccessBy!`	Forma de acesso ao sistema
`employees` - `[Employee!]!`	Funcionários vinculados
`verifiedEmail` - `String`	E-mail verificado
`profilePicture` - `String`	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": "xyz789",
  "profilePicture": "xyz789",
  "restrictedBy": "abc123",
  "preferences": UserPreferences,
  "policiesAgreement": [PolicyAgreement]
}

Types

UserGender

Description

Gênero

Values

Enum Value	Description
`Male`	Masculino
`Female`	Feminino

Example

"Male"

Types

UserOrganizationListing

Description

Usuário

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!`	E-mail
`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` - `String`	URL da foto de perfil

Example

{
  "name": "xyz789",
  "id": "xyz789",
  "branches": ["xyz789"],
  "email": "xyz789",
  "accessBy": "Internal",
  "roleId": "abc123",
  "status": "xyz789",
  "profilePicture": "xyz789"
}

Types

UserPreferences

Description

Preferências de usuário

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

Example

{
  "expandedSidebar": false,
  "expandedWallet": false,
  "showTree": true,
  "printTotalCost": false,
  "printImages": true,
  "printFollowUp": true
}

Types

UsingSupplier

Description

Tipo de árvore de recursos em que um fornecedor está sendo utilizado

Values

Enum Value	Description
`ServiceOrder`	Ordem de serviço
`Maintenance`	Manutenção
`MasterPlan`	Plano mestre

Example

"ServiceOrder"

Types

Warehouse

Description

Local de estoque

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": "xyz789",
  "isActive": true,
  "branchId": "xyz789",
  "erpId": "abc123",
  "level": "xyz789"
}

Types

WarehouseQueryInput

Description

Pesquisa de locais de estoque

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
`branchId` - `String`	Código identificador da filial

Example

{
  "materialId": "xyz789",
  "warehouseId": "abc123",
  "identifier": "abc123",
  "branchId": "abc123"
}

Types

WorkShift

Description

Turno de trabalho de calendário

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": "xyz789",
  "calendarId": "abc123",
  "start": TimePoint,
  "end": TimePoint
}

Documentation by Anvil SpectaQL