eSub Cloud Graph

Platform API Docs

API Endpoints
https://migration.esubcloud.com/graphql
Version

1.0.0

Queries

getAdminCompany

Response

Returns an AdminCompany

Arguments
Name Description
id - ID!
orgId - ID!

Example

Query
query getAdminCompany(
  $id: ID!,
  $orgId: ID!
) {
  getAdminCompany(
    id: $id,
    orgId: $orgId
  ) {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    orgId
    hierarchy
  }
}
Variables
{"id": 4, "orgId": "4"}
Response
{
  "data": {
    "getAdminCompany": {
      "id": 4,
      "name": "abc123",
      "address": Address,
      "country": "xyz789",
      "phone": "abc123",
      "fax": "xyz789",
      "orgId": 4,
      "hierarchy": "xyz789"
    }
  }
}

getChangeOrderRequest

Response

Returns a ChangeOrderRequest

Arguments
Name Description
input - GetChangeOrderRequestInput!

Example

Query
query getChangeOrderRequest($input: GetChangeOrderRequestInput!) {
  getChangeOrderRequest(input: $input) {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Variables
{"input": GetChangeOrderRequestInput}
Response
{
  "data": {
    "getChangeOrderRequest": {
      "approvalNumber": "abc123",
      "approvedAmountInPennies": 123,
      "created": "abc123",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 123,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "xyz789",
      "images": [ResizedAttachment],
      "internalNotes": "xyz789",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "abc123",
      "name": "xyz789",
      "number": "abc123",
      "project": Project,
      "referenceNumberAsi": "xyz789",
      "referenceNumberGcCor": "abc123",
      "referenceNumberOther": "abc123",
      "referenceNumberOwnerCor": "xyz789",
      "referenceNumberPco": "xyz789",
      "referenceNumberRfi": "xyz789",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 987,
      "scheduleImpactComments": "abc123",
      "scheduleImpactDays": 123,
      "scopeOfWork": "xyz789",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

getCleanupTask

Response

Returns a CleanupTask

Arguments
Name Description
id - ID!

Example

Query
query getCleanupTask($id: ID!) {
  getCleanupTask(id: $id) {
    id
    orgId
    status
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getCleanupTask": {
      "id": 4,
      "orgId": "xyz789",
      "status": "CREATED"
    }
  }
}

getCompany

Response

Returns a Company

Arguments
Name Description
id - ID!

Example

Query
query getCompany($id: ID!) {
  getCompany(id: $id) {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    orgId
    hierarchy
    keywords {
      ...KeywordFragment
    }
    logo {
      ...AttachmentFragment
    }
    timeCardSettings {
      ...TimeCardSettingsFragment
    }
    dailyReportSettings {
      ...DailyReportSettingsFragment
    }
    rfiSettings {
      ...RFISettingsFragment
    }
    changeOrderRequestSettings {
      ...ChangeOrderRequestSettingsFragment
    }
    purchaseOrderSettings {
      ...PurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getCompany": {
      "id": "4",
      "name": "abc123",
      "address": Address,
      "country": "xyz789",
      "phone": "xyz789",
      "fax": "abc123",
      "orgId": "4",
      "hierarchy": "abc123",
      "keywords": [Keyword],
      "logo": Attachment,
      "timeCardSettings": TimeCardSettings,
      "dailyReportSettings": DailyReportSettings,
      "rfiSettings": RFISettings,
      "changeOrderRequestSettings": ChangeOrderRequestSettings,
      "purchaseOrderSettings": PurchaseOrderSettings,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getCompanyCostCode

Response

Returns a CompanyCostCode

Arguments
Name Description
input - GetCompanyCostCodeInput!

Example

Query
query getCompanyCostCode($input: GetCompanyCostCodeInput!) {
  getCompanyCostCode(input: $input) {
    id
    companyId
    number
    name
    status
    categories
    addToNewProjects
    projectCostCodes {
      ...ProjectCostCodesFragment
    }
  }
}
Variables
{"input": GetCompanyCostCodeInput}
Response
{
  "data": {
    "getCompanyCostCode": {
      "id": "4",
      "companyId": "abc123",
      "number": "abc123",
      "name": "xyz789",
      "status": "ACTIVE",
      "categories": ["LABOR"],
      "addToNewProjects": false,
      "projectCostCodes": ProjectCostCodes
    }
  }
}

getCompanyFile

Response

Returns a File

Arguments
Name Description
input - GetCompanyFileInput!

Example

Query
query getCompanyFile($input: GetCompanyFileInput!) {
  getCompanyFile(input: $input) {
    id
    link {
      ...AttachmentDownloadLinkFragment
    }
    name
    parentId
    parentPath
    path
    sizeInBytes
    tags {
      ...DriveTagFragment
    }
  }
}
Variables
{"input": GetCompanyFileInput}
Response
{
  "data": {
    "getCompanyFile": {
      "id": "xyz789",
      "link": AttachmentDownloadLink,
      "name": "xyz789",
      "parentId": "abc123",
      "parentPath": "abc123",
      "path": "xyz789",
      "sizeInBytes": 987,
      "tags": [DriveTag]
    }
  }
}

getCompanyFiles

Response

Returns a Files

Arguments
Name Description
input - GetCompanyFilesInput!

Example

Query
query getCompanyFiles($input: GetCompanyFilesInput!) {
  getCompanyFiles(input: $input) {
    cursor
    items {
      ...FileFragment
    }
  }
}
Variables
{"input": GetCompanyFilesInput}
Response
{
  "data": {
    "getCompanyFiles": {
      "cursor": "xyz789",
      "items": [File]
    }
  }
}

getCompanyFolder

Response

Returns a Folder

Arguments
Name Description
input - GetCompanyFolderInput!

Example

Query
query getCompanyFolder($input: GetCompanyFolderInput!) {
  getCompanyFolder(input: $input) {
    id
    name
    parentId
    parentPath
    path
  }
}
Variables
{"input": GetCompanyFolderInput}
Response
{
  "data": {
    "getCompanyFolder": {
      "id": "abc123",
      "name": "xyz789",
      "parentId": "abc123",
      "parentPath": "abc123",
      "path": "abc123"
    }
  }
}

getCompanyFolders

Response

Returns a Folders

Arguments
Name Description
input - GetCompanyFoldersInput!

Example

Query
query getCompanyFolders($input: GetCompanyFoldersInput!) {
  getCompanyFolders(input: $input) {
    cursor
    items {
      ...FolderFragment
    }
  }
}
Variables
{"input": GetCompanyFoldersInput}
Response
{
  "data": {
    "getCompanyFolders": {
      "cursor": "xyz789",
      "items": [Folder]
    }
  }
}

getContact

Response

Returns a Contact

Arguments
Name Description
id - ID!

Example

Query
query getContact($id: ID!) {
  getContact(id: $id) {
    id
    firstName
    middleName
    lastName
    jobTitle
    email
    address {
      ...AddressAllOptionalFragment
    }
    country
    office
    mobile
    fax
    notes
    businessName
    businessType
    status
    apVendor
    vendorId
    website
    cannotDelete
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getContact": {
      "id": "4",
      "firstName": "xyz789",
      "middleName": "xyz789",
      "lastName": "abc123",
      "jobTitle": "xyz789",
      "email": "xyz789",
      "address": AddressAllOptional,
      "country": "abc123",
      "office": "xyz789",
      "mobile": "abc123",
      "fax": "xyz789",
      "notes": "xyz789",
      "businessName": "xyz789",
      "businessType": "xyz789",
      "status": "AVAILABLE",
      "apVendor": false,
      "vendorId": "abc123",
      "website": "abc123",
      "cannotDelete": true,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getDailyReport

Response

Returns a DailyReport

Arguments
Name Description
id - ID!

Example

Query
query getDailyReport($id: ID!) {
  getDailyReport(id: $id) {
    id
    projectId
    customNo
    date
    timeOnSite
    timeOffSite
    totalWorkers
    author
    authorId
    weatherConditions {
      ...WeatherFragment
    }
    weather
    wind
    temperature
    workPerformed
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    issues
    favors
    accidents
    subcontractorsWorked
    visitors
    comments
    notes
    internalComments
    weatherComments
    lastEditedBy
    attachments {
      ...AttachmentsFragment
    }
    docs {
      ...DocsFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getDailyReport": {
      "id": 4,
      "projectId": "xyz789",
      "customNo": "xyz789",
      "date": AWSDateTime,
      "timeOnSite": AWSDateTime,
      "timeOffSite": AWSDateTime,
      "totalWorkers": 987,
      "author": "abc123",
      "authorId": "abc123",
      "weatherConditions": Weather,
      "weather": "abc123",
      "wind": "abc123",
      "temperature": 123,
      "workPerformed": "abc123",
      "keywords": ["xyz789"],
      "listOfKeywords": [NestedKeywords],
      "issues": "xyz789",
      "favors": "xyz789",
      "accidents": "abc123",
      "subcontractorsWorked": "abc123",
      "visitors": "abc123",
      "comments": "abc123",
      "notes": "xyz789",
      "internalComments": "xyz789",
      "weatherComments": "abc123",
      "lastEditedBy": "xyz789",
      "attachments": Attachments,
      "docs": Docs,
      "emails": [Email],
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getEmail

Response

Returns an Email

Arguments
Name Description
id - ID!

Example

Query
query getEmail($id: ID!) {
  getEmail(id: $id) {
    id
    author {
      ...AuthorFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    boxType
    dateSent
    dateReceived
    isUrgent
    hasBeenRead
    subject
    from {
      ...EmailAddressFragment
    }
    to {
      ...EmailAddressFragment
    }
    cc {
      ...EmailAddressFragment
    }
    bcc {
      ...EmailAddressFragment
    }
    text
    html
    emailLink
    documents {
      ...DocumentAttachmentFragment
    }
    images {
      ...ImageAttachmentFragment
    }
    linkedDocument {
      ...LinkedDocumentFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getEmail": {
      "id": 4,
      "author": Author,
      "lastEditedBy": Author,
      "boxType": "INBOX",
      "dateSent": AWSDateTime,
      "dateReceived": AWSDateTime,
      "isUrgent": true,
      "hasBeenRead": true,
      "subject": "abc123",
      "from": EmailAddress,
      "to": [EmailAddress],
      "cc": [EmailAddress],
      "bcc": [EmailAddress],
      "text": "xyz789",
      "html": "xyz789",
      "emailLink": "abc123",
      "documents": [DocumentAttachment],
      "images": [ImageAttachment],
      "linkedDocument": LinkedDocument
    }
  }
}

getEntityAssignment

Response

Returns an EntityAssignment

Arguments
Name Description
id - ID!

Example

Query
query getEntityAssignment($id: ID!) {
  getEntityAssignment(id: $id) {
    id
    entityId
    userId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getEntityAssignment": {
      "id": 4,
      "entityId": 4,
      "userId": "4",
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getFieldNote

Response

Returns a FieldNote

Arguments
Name Description
id - ID!

Example

Query
query getFieldNote($id: ID!) {
  getFieldNote(id: $id) {
    id
    note
    createdOnDeviceAt
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    locationTags {
      ...NestedLocationTagFragment
    }
    address {
      ...AddressFragment
    }
    phase
    system
    attachments {
      ...AttachmentsFragment
    }
    createdByUsername
    createdByUserId
    projectId
    docs {
      ...DocsFragment
    }
    lastUpdatedByUsername
    lastUpdatedByUserId
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getFieldNote": {
      "id": 4,
      "note": "abc123",
      "createdOnDeviceAt": AWSDateTime,
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "locationTags": [NestedLocationTag],
      "address": Address,
      "phase": "xyz789",
      "system": "abc123",
      "attachments": Attachments,
      "createdByUsername": "xyz789",
      "createdByUserId": "abc123",
      "projectId": "abc123",
      "docs": Docs,
      "lastUpdatedByUsername": "abc123",
      "lastUpdatedByUserId": "xyz789",
      "emails": [Email],
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getJobExecutionStatus

Response

Returns a JobStatus

Arguments
Name Description
input - GetJobExecutionStatusInput!

Example

Query
query getJobExecutionStatus($input: GetJobExecutionStatusInput!) {
  getJobExecutionStatus(input: $input) {
    id
    type
    documentId
    status
  }
}
Variables
{"input": GetJobExecutionStatusInput}
Response
{
  "data": {
    "getJobExecutionStatus": {
      "id": "xyz789",
      "type": "COPY_ATTACHMENTS",
      "documentId": "xyz789",
      "status": "RUNNING"
    }
  }
}

getKeyword

Response

Returns a Keyword

Arguments
Name Description
id - ID!

Example

Query
query getKeyword($id: ID!) {
  getKeyword(id: $id) {
    id
    name
    companyId
    status
    usageCount
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getKeyword": {
      "id": "4",
      "name": "xyz789",
      "companyId": "xyz789",
      "status": "AVAILABLE",
      "usageCount": 123,
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getLocationTag

Response

Returns a LocationTag

Arguments
Name Description
id - ID!

Example

Query
query getLocationTag($id: ID!) {
  getLocationTag(id: $id) {
    id
    name
    projectId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getLocationTag": {
      "id": "4",
      "name": "xyz789",
      "projectId": "abc123",
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getMyOrganization

Response

Returns an Organization

Example

Query
query getMyOrganization {
  getMyOrganization {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    accountStatus
    subscriptionStart
    subscriptionEnd
    userCount
    enabledModules
    modules
    _version
    _lastChangedAt
  }
}
Response
{
  "data": {
    "getMyOrganization": {
      "id": 4,
      "name": "abc123",
      "address": Address,
      "country": "xyz789",
      "phone": "abc123",
      "fax": "abc123",
      "accountStatus": "xyz789",
      "subscriptionStart": AWSDateTime,
      "subscriptionEnd": AWSDateTime,
      "userCount": 123,
      "enabledModules": "xyz789",
      "modules": ["CHANGE_ORDER_REQUEST"],
      "_version": 123,
      "_lastChangedAt": AWSTimestamp
    }
  }
}

getOccupancySubType

Response

Returns an OccupancySubType

Arguments
Name Description
id - ID!

Example

Query
query getOccupancySubType($id: ID!) {
  getOccupancySubType(id: $id) {
    id
    name
    companyId
    occupancyTypeId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getOccupancySubType": {
      "id": "4",
      "name": "xyz789",
      "companyId": "abc123",
      "occupancyTypeId": "abc123",
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getOccupancyType

Response

Returns an OccupancyType

Arguments
Name Description
id - ID!

Example

Query
query getOccupancyType($id: ID!) {
  getOccupancyType(id: $id) {
    id
    name
    companyId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getOccupancyType": {
      "id": "4",
      "name": "abc123",
      "companyId": "abc123",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getOrganization

Response

Returns an Organization

Arguments
Name Description
id - ID!

Example

Query
query getOrganization($id: ID!) {
  getOrganization(id: $id) {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    accountStatus
    subscriptionStart
    subscriptionEnd
    userCount
    enabledModules
    modules
    _version
    _lastChangedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getOrganization": {
      "id": 4,
      "name": "xyz789",
      "address": Address,
      "country": "xyz789",
      "phone": "xyz789",
      "fax": "abc123",
      "accountStatus": "xyz789",
      "subscriptionStart": AWSDateTime,
      "subscriptionEnd": AWSDateTime,
      "userCount": 987,
      "enabledModules": "xyz789",
      "modules": ["CHANGE_ORDER_REQUEST"],
      "_version": 987,
      "_lastChangedAt": AWSTimestamp
    }
  }
}

getPdfJob

Response

Returns a PdfJob

Arguments
Name Description
input - GetPdfJobInput

Example

Query
query getPdfJob($input: GetPdfJobInput) {
  getPdfJob(input: $input) {
    id
    status
    type
    created
    modified
    result {
      ...PreSignedLinkFragment
    }
  }
}
Variables
{"input": GetPdfJobInput}
Response
{
  "data": {
    "getPdfJob": {
      "id": "abc123",
      "status": "CREATED",
      "type": "FIELD_NOTE",
      "created": "abc123",
      "modified": "xyz789",
      "result": PreSignedLink
    }
  }
}

getPermissionGroup

Response

Returns a PermissionGroup

Arguments
Name Description
id - ID!

Example

Query
query getPermissionGroup($id: ID!) {
  getPermissionGroup(id: $id) {
    id
    name
    permissions {
      ...PermissionFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getPermissionGroup": {
      "id": "4",
      "name": "xyz789",
      "permissions": [Permission]
    }
  }
}

getProject

Response

Returns a Project

Arguments
Name Description
id - ID!

Example

Query
query getProject($id: ID!) {
  getProject(id: $id) {
    address {
      ...AddressAllOptionalFragment
    }
    changeOrderRequestSettings {
      ...ProjectChangeOrderRequestSettingsFragment
    }
    comments
    company {
      ...CompanyFragment
    }
    companyId
    companyName
    contractCostInPennies
    contractNumber
    contractSoldBy
    contractType
    dailyReportSettings {
      ...ProjectDailyReportSettingsFragment
    }
    divisionId
    endDate
    id
    isPrimeContractor
    mailboxEmail
    marketAreaId
    name
    number
    occupancySubTypeId
    occupancyTypeId
    officeFaxNumber
    officePhoneNumber
    projectRateTemplateId
    rfiSettings {
      ...ProjectRFISettingsFragment
    }
    submittalSettings {
      ...SubmittalSettingsFragment
    }
    startDate
    status
    teams {
      ...ProjectTeamsFragment
    }
    timeSettings {
      ...ProjectTimeSettingsFragment
    }
    purchaseOrderSettings {
      ...ProjectPurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getProject": {
      "address": AddressAllOptional,
      "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
      "comments": "xyz789",
      "company": Company,
      "companyId": "xyz789",
      "companyName": "abc123",
      "contractCostInPennies": 123,
      "contractNumber": "abc123",
      "contractSoldBy": "xyz789",
      "contractType": "abc123",
      "dailyReportSettings": ProjectDailyReportSettings,
      "divisionId": "xyz789",
      "endDate": AWSDateTime,
      "id": "4",
      "isPrimeContractor": false,
      "mailboxEmail": "xyz789",
      "marketAreaId": "xyz789",
      "name": "xyz789",
      "number": "abc123",
      "occupancySubTypeId": "abc123",
      "occupancyTypeId": "xyz789",
      "officeFaxNumber": "abc123",
      "officePhoneNumber": "xyz789",
      "projectRateTemplateId": "xyz789",
      "rfiSettings": ProjectRFISettings,
      "submittalSettings": SubmittalSettings,
      "startDate": AWSDateTime,
      "status": "xyz789",
      "teams": ProjectTeams,
      "timeSettings": ProjectTimeSettings,
      "purchaseOrderSettings": ProjectPurchaseOrderSettings,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getProjectBudget

Response

Returns a ProjectBudget

Arguments
Name Description
input - GetProjectBudgetInput!

Example

Query
query getProjectBudget($input: GetProjectBudgetInput!) {
  getProjectBudget(input: $input) {
    id
    projectCostCodeNumber
    projectId
    units
    laborHoursInMinutes
    laborCostInPennies
    materialCostInPennies
    subcontractorCostInPennies
    equipmentCostInPennies
    overheadCostInPennies
    otherCostInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{"input": GetProjectBudgetInput}
Response
{
  "data": {
    "getProjectBudget": {
      "id": "abc123",
      "projectCostCodeNumber": "abc123",
      "projectId": "xyz789",
      "units": 987,
      "laborHoursInMinutes": 987,
      "laborCostInPennies": 987,
      "materialCostInPennies": 123,
      "subcontractorCostInPennies": 123,
      "equipmentCostInPennies": 987,
      "overheadCostInPennies": 123,
      "otherCostInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

getProjectCostCode

Response

Returns a ProjectCostCode

Arguments
Name Description
input - GetProjectCostCodeInput!

Example

Query
query getProjectCostCode($input: GetProjectCostCodeInput!) {
  getProjectCostCode(input: $input) {
    id
    projectId
    number
    name
    status
    categories
  }
}
Variables
{"input": GetProjectCostCodeInput}
Response
{
  "data": {
    "getProjectCostCode": {
      "id": "4",
      "projectId": "abc123",
      "number": "xyz789",
      "name": "abc123",
      "status": "ACTIVE",
      "categories": ["LABOR"]
    }
  }
}

getProjectFile

Response

Returns a File

Arguments
Name Description
input - GetProjectFileInput!

Example

Query
query getProjectFile($input: GetProjectFileInput!) {
  getProjectFile(input: $input) {
    id
    link {
      ...AttachmentDownloadLinkFragment
    }
    name
    parentId
    parentPath
    path
    sizeInBytes
    tags {
      ...DriveTagFragment
    }
  }
}
Variables
{"input": GetProjectFileInput}
Response
{
  "data": {
    "getProjectFile": {
      "id": "xyz789",
      "link": AttachmentDownloadLink,
      "name": "abc123",
      "parentId": "xyz789",
      "parentPath": "xyz789",
      "path": "abc123",
      "sizeInBytes": 987,
      "tags": [DriveTag]
    }
  }
}

getProjectFiles

Response

Returns a Files

Arguments
Name Description
input - GetProjectFilesInput!

Example

Query
query getProjectFiles($input: GetProjectFilesInput!) {
  getProjectFiles(input: $input) {
    cursor
    items {
      ...FileFragment
    }
  }
}
Variables
{"input": GetProjectFilesInput}
Response
{
  "data": {
    "getProjectFiles": {
      "cursor": "xyz789",
      "items": [File]
    }
  }
}

getProjectFolder

Response

Returns a Folder

Arguments
Name Description
input - GetProjectFolderInput!

Example

Query
query getProjectFolder($input: GetProjectFolderInput!) {
  getProjectFolder(input: $input) {
    id
    name
    parentId
    parentPath
    path
  }
}
Variables
{"input": GetProjectFolderInput}
Response
{
  "data": {
    "getProjectFolder": {
      "id": "xyz789",
      "name": "abc123",
      "parentId": "xyz789",
      "parentPath": "abc123",
      "path": "abc123"
    }
  }
}

getProjectFolders

Response

Returns a Folders

Arguments
Name Description
input - GetProjectFoldersInput!

Example

Query
query getProjectFolders($input: GetProjectFoldersInput!) {
  getProjectFolders(input: $input) {
    cursor
    items {
      ...FolderFragment
    }
  }
}
Variables
{"input": GetProjectFoldersInput}
Response
{
  "data": {
    "getProjectFolders": {
      "cursor": "xyz789",
      "items": [Folder]
    }
  }
}

getPurchaseOrder

Response

Returns a PurchaseOrder

Arguments
Name Description
input - GetPurchaseOrderInput!

Example

Query
query getPurchaseOrder($input: GetPurchaseOrderInput!) {
  getPurchaseOrder(input: $input) {
    id
    project {
      ...ProjectFragment
    }
    number
    date
    type
    description
    status
    vendor {
      ...ContactFragment
    }
    salesTaxRatePercent
    salesTaxAmountInPennies
    depositInPennies
    depositDate
    releaseDate
    billing {
      ...PurchaseOrderBillingFragment
    }
    shipping {
      ...PurchaseOrderShippingFragment
    }
    buyerNotes
    vendorNotes
    internalNotes
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
    lines {
      ...PurchaseOrderLinesFragment
    }
    receivings {
      ...PurchaseOrderReceivingsFragment
    }
    invoicedInPennies
    totalInPennies
    revision
  }
}
Variables
{"input": GetPurchaseOrderInput}
Response
{
  "data": {
    "getPurchaseOrder": {
      "id": "abc123",
      "project": Project,
      "number": "abc123",
      "date": AWSDateTime,
      "type": "PURCHASE_ORDER",
      "description": "xyz789",
      "status": "DRAFT",
      "vendor": Contact,
      "salesTaxRatePercent": 123.45,
      "salesTaxAmountInPennies": 123,
      "depositInPennies": 987,
      "depositDate": AWSDateTime,
      "releaseDate": AWSDateTime,
      "billing": PurchaseOrderBilling,
      "shipping": PurchaseOrderShipping,
      "buyerNotes": "abc123",
      "vendorNotes": "xyz789",
      "internalNotes": "xyz789",
      "docs": [AttachmentV2],
      "images": [ResizedAttachment],
      "lines": PurchaseOrderLines,
      "receivings": PurchaseOrderReceivings,
      "invoicedInPennies": 123,
      "totalInPennies": 123,
      "revision": 123
    }
  }
}

getRateTemplate

Response

Returns a RateTemplate

Arguments
Name Description
input - GetRateTemplateInput

Example

Query
query getRateTemplate($input: GetRateTemplateInput) {
  getRateTemplate(input: $input) {
    id
    name
    companyId
    shift2 {
      ...ShiftDifferentialFragment
    }
    shift3 {
      ...ShiftDifferentialFragment
    }
    laborClasses {
      ...RateLaborClassesFragment
    }
    status
  }
}
Variables
{"input": GetRateTemplateInput}
Response
{
  "data": {
    "getRateTemplate": {
      "id": "abc123",
      "name": "xyz789",
      "companyId": "xyz789",
      "shift2": ShiftDifferential,
      "shift3": ShiftDifferential,
      "laborClasses": RateLaborClasses,
      "status": "ACTIVE"
    }
  }
}

getRfi

Response

Returns a Rfi

Arguments
Name Description
id - ID!

Example

Query
query getRfi($id: ID!) {
  getRfi(id: $id) {
    gcFileNumber
    gcNumber
    attachments {
      ...AttachmentsFragment
    }
    author {
      ...AuthorFragment
    }
    respondByDate
    date
    id
    projectId
    dateV2
    authorV2 {
      ...UserFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    revision
    customNo
    to {
      ...NestedContactFragment
    }
    subject
    respondByDateV2
    questionForClarification
    recommendedSolution
    isScheduleImpacted
    isCostImpacted
    isUrgent
    reference {
      ...RfiReferenceFragment
    }
    projectCostCodeAffected {
      ...ProjectCostCodeFragment
    }
    projectCostCodeAffectedNumber
    dateAnswered
    status
    statusComment
    answerToClarification
    driveAttachments {
      ...RfiAttachmentFragment
    }
    images {
      ...RfiImageFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getRfi": {
      "gcFileNumber": "abc123",
      "gcNumber": "xyz789",
      "attachments": Attachments,
      "author": Author,
      "respondByDate": AWSDate,
      "date": AWSDate,
      "id": 4,
      "projectId": "xyz789",
      "dateV2": AWSDateTime,
      "authorV2": User,
      "lastEditedBy": Author,
      "revision": 123,
      "customNo": "abc123",
      "to": [NestedContact],
      "subject": "abc123",
      "respondByDateV2": AWSDateTime,
      "questionForClarification": "abc123",
      "recommendedSolution": "abc123",
      "isScheduleImpacted": false,
      "isCostImpacted": true,
      "isUrgent": true,
      "reference": RfiReference,
      "projectCostCodeAffected": ProjectCostCode,
      "projectCostCodeAffectedNumber": "abc123",
      "dateAnswered": AWSDateTime,
      "status": "PENDING",
      "statusComment": "abc123",
      "answerToClarification": "xyz789",
      "driveAttachments": [RfiAttachment],
      "images": [RfiImage],
      "emails": [Email],
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getSubmittalItem

Response

Returns a SubmittalItem

Arguments
Name Description
input - GetSubmittalItemInput

Example

Query
query getSubmittalItem($input: GetSubmittalItemInput) {
  getSubmittalItem(input: $input) {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Variables
{"input": GetSubmittalItemInput}
Response
{
  "data": {
    "getSubmittalItem": {
      "created": "xyz789",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "xyz789",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "abc123",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "xyz789",
      "name": "xyz789",
      "notes": "abc123",
      "number": "abc123",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 123,
      "specSection": "xyz789",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

getSubmittalPackage

Response

Returns a SubmittalPackage

Arguments
Name Description
input - GetSubmittalPackageInput

Example

Query
query getSubmittalPackage($input: GetSubmittalPackageInput) {
  getSubmittalPackage(input: $input) {
    created
    dateSent
    description
    from {
      ...ContactFragment
    }
    id
    modified
    number
    name
    project {
      ...ProjectFragment
    }
    respondBy
    returnedOn
    status
    to {
      ...ContactFragment
    }
    submittalItems {
      ...SubmittalItemFragment
    }
    emails {
      ...EmailFragment
    }
  }
}
Variables
{"input": GetSubmittalPackageInput}
Response
{
  "data": {
    "getSubmittalPackage": {
      "created": "abc123",
      "dateSent": AWSDateTime,
      "description": "xyz789",
      "from": Contact,
      "id": "xyz789",
      "modified": "abc123",
      "number": "abc123",
      "name": "xyz789",
      "project": Project,
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "status": "DRAFT",
      "to": Contact,
      "submittalItems": [SubmittalItem],
      "emails": [Email]
    }
  }
}

getTimeCard

Response

Returns a TimeCard

Arguments
Name Description
id - ID!

Example

Query
query getTimeCard($id: ID!) {
  getTimeCard(id: $id) {
    comments
    date
    doubleTimeInMinutes
    hoursLost
    id
    laborClass
    overTimeInMinutes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    project {
      ...ProjectFragment
    }
    regularTimeInMinutes
    shift
    status
    timeCardProjectCostCodeNumber
    timeCardDailyReportId
    units
    user {
      ...UserFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getTimeCard": {
      "comments": "abc123",
      "date": AWSDateTime,
      "doubleTimeInMinutes": 123,
      "hoursLost": 987,
      "id": "4",
      "laborClass": "abc123",
      "overTimeInMinutes": 123,
      "projectCostCode": ProjectCostCode,
      "project": Project,
      "regularTimeInMinutes": 123,
      "shift": "SHIFT1",
      "status": "PENDING",
      "timeCardProjectCostCodeNumber": "abc123",
      "timeCardDailyReportId": "xyz789",
      "units": 987,
      "user": User,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getUnitOfMeasure

Response

Returns a UnitOfMeasure

Arguments
Name Description
input - GetUnitOfMeasureInput!

Example

Query
query getUnitOfMeasure($input: GetUnitOfMeasureInput!) {
  getUnitOfMeasure(input: $input) {
    id
    companyId
    name
    abbreviation
  }
}
Variables
{"input": GetUnitOfMeasureInput}
Response
{
  "data": {
    "getUnitOfMeasure": {
      "id": 4,
      "companyId": "abc123",
      "name": "xyz789",
      "abbreviation": "abc123"
    }
  }
}

getUser

Response

Returns a User

Arguments
Name Description
id - ID!

Example

Query
query getUser($id: ID!) {
  getUser(id: $id) {
    id
    orgId
    companyAssociations
    defaultCompany
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AddressAllOptionalFragment
    }
    country
    useCompanyAddress
    emailSignature
    crew
    primaryLaborClass
    languagePreference
    dateDisplayPreference
    permissionGroup
    permissionGroupName
    accessLevel
    crewStatus
    type
    loginStatus
    addToNewProjects
    contact {
      ...ContactFragment
    }
    laborClassId
    laborClass {
      ...LaborClassFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getUser": {
      "id": "4",
      "orgId": "xyz789",
      "companyAssociations": ["abc123"],
      "defaultCompany": "xyz789",
      "givenName": "xyz789",
      "middleName": "xyz789",
      "familyName": "xyz789",
      "email": "abc123",
      "employeeNo": "abc123",
      "role": "xyz789",
      "jobTitle": "xyz789",
      "officeNo": "xyz789",
      "mobileNo": "xyz789",
      "faxNo": "abc123",
      "address": AddressAllOptional,
      "country": "abc123",
      "useCompanyAddress": true,
      "emailSignature": "abc123",
      "crew": true,
      "primaryLaborClass": "abc123",
      "languagePreference": "xyz789",
      "dateDisplayPreference": "xyz789",
      "permissionGroup": "xyz789",
      "permissionGroupName": "abc123",
      "accessLevel": "abc123",
      "crewStatus": "AVAILABLE",
      "type": "STANDARD",
      "loginStatus": "ACTIVE",
      "addToNewProjects": true,
      "contact": Contact,
      "laborClassId": "abc123",
      "laborClass": LaborClass,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getVersionSet

Response

Returns a VersionSet

Arguments
Name Description
input - GetVersionSetInput!

Example

Query
query getVersionSet($input: GetVersionSetInput!) {
  getVersionSet(input: $input) {
    id
    createdBy {
      ...UserFragment
    }
    dateIssued
    project {
      ...ProjectFragment
    }
    name
  }
}
Variables
{"input": GetVersionSetInput}
Response
{
  "data": {
    "getVersionSet": {
      "id": "abc123",
      "createdBy": User,
      "dateIssued": AWSDateTime,
      "project": Project,
      "name": "abc123"
    }
  }
}

getWeather

Response

Returns a WeatherReport

Arguments
Name Description
input - GetWeatherInput!

Example

Query
query getWeather($input: GetWeatherInput!) {
  getWeather(input: $input) {
    byTheHour {
      ...WeatherFragment
    }
  }
}
Variables
{"input": GetWeatherInput}
Response
{"data": {"getWeather": {"byTheHour": [Weather]}}}

getWeatherType

Response

Returns a WeatherType

Arguments
Name Description
id - ID!

Example

Query
query getWeatherType($id: ID!) {
  getWeatherType(id: $id) {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getWeatherType": {
      "id": "4",
      "name": "xyz789",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

getWindType

Response

Returns a WindType

Arguments
Name Description
id - ID!

Example

Query
query getWindType($id: ID!) {
  getWindType(id: $id) {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getWindType": {
      "id": "4",
      "name": "xyz789",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

listAdminCompanies

Response

Returns a ModelAdminCompanyConnection

Arguments
Name Description
limit - Int
nextToken - String
orgId - ID!

Example

Query
query listAdminCompanies(
  $limit: Int,
  $nextToken: String,
  $orgId: ID!
) {
  listAdminCompanies(
    limit: $limit,
    nextToken: $nextToken,
    orgId: $orgId
  ) {
    items {
      ...AdminCompanyFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "limit": 987,
  "nextToken": "abc123",
  "orgId": "4"
}
Response
{
  "data": {
    "listAdminCompanies": {
      "items": [AdminCompany],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listAdminPermissionGroups

Response

Returns a ModelPermissionGroupConnection

Arguments
Name Description
limit - Int
nextToken - String
orgId - ID!

Example

Query
query listAdminPermissionGroups(
  $limit: Int,
  $nextToken: String,
  $orgId: ID!
) {
  listAdminPermissionGroups(
    limit: $limit,
    nextToken: $nextToken,
    orgId: $orgId
  ) {
    items {
      ...PermissionGroupFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "limit": 123,
  "nextToken": "abc123",
  "orgId": 4
}
Response
{
  "data": {
    "listAdminPermissionGroups": {
      "items": [PermissionGroup],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listChangeOrderRequestEquipmentLineItems

Arguments
Name Description
input - ListChangeOrderRequestEquipmentLineItemsInput!

Example

Query
query listChangeOrderRequestEquipmentLineItems($input: ListChangeOrderRequestEquipmentLineItemsInput!) {
  listChangeOrderRequestEquipmentLineItems(input: $input) {
    items {
      ...ChangeOrderRequestEquipmentLineItemFragment
    }
    cursor
    count
  }
}
Variables
{"input": ListChangeOrderRequestEquipmentLineItemsInput}
Response
{
  "data": {
    "listChangeOrderRequestEquipmentLineItems": {
      "items": [ChangeOrderRequestEquipmentLineItem],
      "cursor": "abc123",
      "count": 123
    }
  }
}

listChangeOrderRequestLaborLineItems

Arguments
Name Description
input - ListChangeOrderRequestLaborLineItemsInput!

Example

Query
query listChangeOrderRequestLaborLineItems($input: ListChangeOrderRequestLaborLineItemsInput!) {
  listChangeOrderRequestLaborLineItems(input: $input) {
    items {
      ...ChangeOrderRequestLaborLineItemFragment
    }
    cursor
    count
  }
}
Variables
{"input": ListChangeOrderRequestLaborLineItemsInput}
Response
{
  "data": {
    "listChangeOrderRequestLaborLineItems": {
      "items": [ChangeOrderRequestLaborLineItem],
      "cursor": "abc123",
      "count": 987
    }
  }
}

listChangeOrderRequestMaterialLineItems

Arguments
Name Description
input - ListChangeOrderRequestMaterialLineItemsInput!

Example

Query
query listChangeOrderRequestMaterialLineItems($input: ListChangeOrderRequestMaterialLineItemsInput!) {
  listChangeOrderRequestMaterialLineItems(input: $input) {
    items {
      ...ChangeOrderRequestMaterialLineItemFragment
    }
    cursor
    count
  }
}
Variables
{"input": ListChangeOrderRequestMaterialLineItemsInput}
Response
{
  "data": {
    "listChangeOrderRequestMaterialLineItems": {
      "items": [ChangeOrderRequestMaterialLineItem],
      "cursor": "xyz789",
      "count": 123
    }
  }
}

listChangeOrderRequestOtherLineItems

Arguments
Name Description
input - ListChangeOrderRequestOtherLineItemsInput!

Example

Query
query listChangeOrderRequestOtherLineItems($input: ListChangeOrderRequestOtherLineItemsInput!) {
  listChangeOrderRequestOtherLineItems(input: $input) {
    items {
      ...ChangeOrderRequestOtherLineItemFragment
    }
    cursor
    count
  }
}
Variables
{"input": ListChangeOrderRequestOtherLineItemsInput}
Response
{
  "data": {
    "listChangeOrderRequestOtherLineItems": {
      "items": [ChangeOrderRequestOtherLineItem],
      "cursor": "abc123",
      "count": 123
    }
  }
}

listChangeOrderRequestOverheadLineItems

Arguments
Name Description
input - ListChangeOrderRequestOverheadLineItemsInput!

Example

Query
query listChangeOrderRequestOverheadLineItems($input: ListChangeOrderRequestOverheadLineItemsInput!) {
  listChangeOrderRequestOverheadLineItems(input: $input) {
    items {
      ...ChangeOrderRequestOverheadLineItemFragment
    }
    cursor
    count
  }
}
Variables
{"input": ListChangeOrderRequestOverheadLineItemsInput}
Response
{
  "data": {
    "listChangeOrderRequestOverheadLineItems": {
      "items": [ChangeOrderRequestOverheadLineItem],
      "cursor": "xyz789",
      "count": 123
    }
  }
}

listChangeOrderRequestSearchFacets

Response

Returns a ChangeOrderRequestSearchFacets

Example

Query
query listChangeOrderRequestSearchFacets {
  listChangeOrderRequestSearchFacets {
    status {
      ...ChangeOrderRequestStatusSearchFacetFragment
    }
    workType {
      ...ChangeOrderRequestWorkTypeSearchFacetFragment
    }
    showAllRevisions {
      ...SearchFacetBooleanFragment
    }
  }
}
Response
{
  "data": {
    "listChangeOrderRequestSearchFacets": {
      "status": [ChangeOrderRequestStatusSearchFacet],
      "workType": [ChangeOrderRequestWorkTypeSearchFacet],
      "showAllRevisions": [SearchFacetBoolean]
    }
  }
}

listChangeOrderRequestSubcontractorLineItems

Example

Query
query listChangeOrderRequestSubcontractorLineItems($input: ListChangeOrderRequestSubcontractorLineItemsInput!) {
  listChangeOrderRequestSubcontractorLineItems(input: $input) {
    items {
      ...ChangeOrderRequestSubcontractorLineItemFragment
    }
    cursor
    count
  }
}
Variables
{
  "input": ListChangeOrderRequestSubcontractorLineItemsInput
}
Response
{
  "data": {
    "listChangeOrderRequestSubcontractorLineItems": {
      "items": [ChangeOrderRequestSubcontractorLineItem],
      "cursor": "xyz789",
      "count": 987
    }
  }
}

listCompanies

Response

Returns a ModelCompanyConnection

Arguments
Name Description
filter - ModelCompanyFilterInput
limit - Int
nextToken - String

Example

Query
query listCompanies(
  $filter: ModelCompanyFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listCompanies(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...CompanyFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelCompanyFilterInput,
  "limit": 123,
  "nextToken": "xyz789"
}
Response
{
  "data": {
    "listCompanies": {
      "items": [Company],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listContacts

Response

Returns a ModelContactConnection

Arguments
Name Description
filter - ModelContactFilterInput
limit - Int
nextToken - String

Example

Query
query listContacts(
  $filter: ModelContactFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listContacts(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...ContactFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelContactFilterInput,
  "limit": 123,
  "nextToken": "abc123"
}
Response
{
  "data": {
    "listContacts": {
      "items": [Contact],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listDailyReports

Response

Returns a ModelDailyReportConnection

Arguments
Name Description
filter - ModelDailyReportFilterInput
limit - Int
nextToken - String

Example

Query
query listDailyReports(
  $filter: ModelDailyReportFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listDailyReports(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...DailyReportFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelDailyReportFilterInput,
  "limit": 987,
  "nextToken": "abc123"
}
Response
{
  "data": {
    "listDailyReports": {
      "items": [DailyReport],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listEmailSearchFacets

Response

Returns a MailboxSearchFacets

Example

Query
query listEmailSearchFacets {
  listEmailSearchFacets {
    boxType {
      ...MailboxBoxTypeSearchFacetFragment
    }
    documentType {
      ...MailboxDocumentTypeSearchFacetFragment
    }
    hasBeenRead {
      ...SearchFacetBooleanFragment
    }
    isUrgent {
      ...SearchFacetBooleanFragment
    }
  }
}
Response
{
  "data": {
    "listEmailSearchFacets": {
      "boxType": [MailboxBoxTypeSearchFacet],
      "documentType": [MailboxDocumentTypeSearchFacet],
      "hasBeenRead": [SearchFacetBoolean],
      "isUrgent": [SearchFacetBoolean]
    }
  }
}

listEntityAssignments

Response

Returns a ModelEntityAssignmentConnection

Arguments
Name Description
filter - ModelEntityAssignmentFilterInput
limit - Int
nextToken - String

Example

Query
query listEntityAssignments(
  $filter: ModelEntityAssignmentFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listEntityAssignments(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...EntityAssignmentFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelEntityAssignmentFilterInput,
  "limit": 987,
  "nextToken": "xyz789"
}
Response
{
  "data": {
    "listEntityAssignments": {
      "items": [EntityAssignment],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listFieldNotes

Response

Returns a ModelFieldNoteConnection

Arguments
Name Description
filter - ModelFieldNoteFilterInput
limit - Int
nextToken - String

Example

Query
query listFieldNotes(
  $filter: ModelFieldNoteFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listFieldNotes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...FieldNoteFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelFieldNoteFilterInput,
  "limit": 123,
  "nextToken": "abc123"
}
Response
{
  "data": {
    "listFieldNotes": {
      "items": [FieldNote],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listJobExecutions

Response

Returns a JobStatuses

Arguments
Name Description
input - ListJobExecutionsInput!

Example

Query
query listJobExecutions($input: ListJobExecutionsInput!) {
  listJobExecutions(input: $input) {
    items {
      ...JobStatusFragment
    }
    nextToken
  }
}
Variables
{"input": ListJobExecutionsInput}
Response
{
  "data": {
    "listJobExecutions": {
      "items": [JobStatus],
      "nextToken": "abc123"
    }
  }
}

listKeywords

Response

Returns a ModelKeywordConnection

Arguments
Name Description
filter - ModelKeywordFilterInput
limit - Int
nextToken - String

Example

Query
query listKeywords(
  $filter: ModelKeywordFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listKeywords(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...KeywordFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelKeywordFilterInput,
  "limit": 987,
  "nextToken": "xyz789"
}
Response
{
  "data": {
    "listKeywords": {
      "items": [Keyword],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listLaborClasses

Response

Returns a LaborClasses

Arguments
Name Description
input - ListLaborClassesInput

Example

Query
query listLaborClasses($input: ListLaborClassesInput) {
  listLaborClasses(input: $input) {
    items {
      ...LaborClassFragment
    }
    nextToken
  }
}
Variables
{"input": ListLaborClassesInput}
Response
{
  "data": {
    "listLaborClasses": {
      "items": [LaborClass],
      "nextToken": "xyz789"
    }
  }
}

listLocationTags

Response

Returns a ModelLocationTagConnection

Arguments
Name Description
filter - ModelLocationTagFilterInput
limit - Int
nextToken - String

Example

Query
query listLocationTags(
  $filter: ModelLocationTagFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listLocationTags(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...LocationTagFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelLocationTagFilterInput,
  "limit": 123,
  "nextToken": "xyz789"
}
Response
{
  "data": {
    "listLocationTags": {
      "items": [LocationTag],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listOccupancySubTypes

Response

Returns a ModelOccupancySubTypeConnection

Arguments
Name Description
filter - ModelOccupancySubTypeFilterInput
limit - Int
nextToken - String

Example

Query
query listOccupancySubTypes(
  $filter: ModelOccupancySubTypeFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listOccupancySubTypes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...OccupancySubTypeFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelOccupancySubTypeFilterInput,
  "limit": 987,
  "nextToken": "abc123"
}
Response
{
  "data": {
    "listOccupancySubTypes": {
      "items": [OccupancySubType],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listOccupancyTypes

Response

Returns a ModelOccupancyTypeConnection

Arguments
Name Description
filter - ModelOccupancyTypeFilterInput
limit - Int
nextToken - String

Example

Query
query listOccupancyTypes(
  $filter: ModelOccupancyTypeFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listOccupancyTypes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...OccupancyTypeFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelOccupancyTypeFilterInput,
  "limit": 987,
  "nextToken": "abc123"
}
Response
{
  "data": {
    "listOccupancyTypes": {
      "items": [OccupancyType],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listOrganizations

Response

Returns a ModelOrganizationConnection

Arguments
Name Description
limit - Int
nextToken - String
filter - String

Example

Query
query listOrganizations(
  $limit: Int,
  $nextToken: String,
  $filter: String
) {
  listOrganizations(
    limit: $limit,
    nextToken: $nextToken,
    filter: $filter
  ) {
    items {
      ...OrganizationFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "limit": 987,
  "nextToken": "xyz789",
  "filter": "abc123"
}
Response
{
  "data": {
    "listOrganizations": {
      "items": [Organization],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listPermissionGroups

Response

Returns a ModelPermissionGroupConnection

Arguments
Name Description
limit - Int
nextToken - String

Example

Query
query listPermissionGroups(
  $limit: Int,
  $nextToken: String
) {
  listPermissionGroups(
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...PermissionGroupFragment
    }
    nextToken
    startedAt
  }
}
Variables
{"limit": 987, "nextToken": "abc123"}
Response
{
  "data": {
    "listPermissionGroups": {
      "items": [PermissionGroup],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listProjectCostCodes

Response

Returns a ProjectCostCodes

Arguments
Name Description
input - ListProjectCostCodeInput

Example

Query
query listProjectCostCodes($input: ListProjectCostCodeInput) {
  listProjectCostCodes(input: $input) {
    items {
      ...ProjectCostCodeFragment
    }
    cursor
  }
}
Variables
{"input": ListProjectCostCodeInput}
Response
{
  "data": {
    "listProjectCostCodes": {
      "items": [ProjectCostCode],
      "cursor": "xyz789"
    }
  }
}

listProjects

Response

Returns a ModelProjectConnection

Arguments
Name Description
filter - ModelProjectFilterInput
limit - Int
nextToken - String

Example

Query
query listProjects(
  $filter: ModelProjectFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listProjects(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...ProjectFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelProjectFilterInput,
  "limit": 123,
  "nextToken": "xyz789"
}
Response
{
  "data": {
    "listProjects": {
      "items": [Project],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listPurchaseOrderLines

Response

Returns a PurchaseOrderLines

Arguments
Name Description
input - ListPurchaseOrderLinesInput!

Example

Query
query listPurchaseOrderLines($input: ListPurchaseOrderLinesInput!) {
  listPurchaseOrderLines(input: $input) {
    items {
      ...PurchaseOrderLineFragment
    }
    cursor
  }
}
Variables
{"input": ListPurchaseOrderLinesInput}
Response
{
  "data": {
    "listPurchaseOrderLines": {
      "items": [PurchaseOrderLine],
      "cursor": "abc123"
    }
  }
}

listPurchaseOrderReceivingLines

Response

Returns a PurchaseOrderReceivingLines

Arguments
Name Description
input - ListPurchaseOrderReceivingLinesInput!

Example

Query
query listPurchaseOrderReceivingLines($input: ListPurchaseOrderReceivingLinesInput!) {
  listPurchaseOrderReceivingLines(input: $input) {
    items {
      ...PurchaseOrderReceivingLineFragment
    }
    cursor
  }
}
Variables
{"input": ListPurchaseOrderReceivingLinesInput}
Response
{
  "data": {
    "listPurchaseOrderReceivingLines": {
      "items": [PurchaseOrderReceivingLine],
      "cursor": "xyz789"
    }
  }
}

listPurchaseOrderReceivings

Response

Returns a PurchaseOrderReceivings

Arguments
Name Description
input - ListPurchaseOrderReceivingsInput!

Example

Query
query listPurchaseOrderReceivings($input: ListPurchaseOrderReceivingsInput!) {
  listPurchaseOrderReceivings(input: $input) {
    items {
      ...PurchaseOrderReceivingFragment
    }
    cursor
  }
}
Variables
{"input": ListPurchaseOrderReceivingsInput}
Response
{
  "data": {
    "listPurchaseOrderReceivings": {
      "items": [PurchaseOrderReceiving],
      "cursor": "xyz789"
    }
  }
}

listPurchaseOrderSearchFacets

Response

Returns a PurchaseOrderSearchFacets

Example

Query
query listPurchaseOrderSearchFacets {
  listPurchaseOrderSearchFacets {
    status {
      ...PurchaseOrderStatusSearchFacetFragment
    }
    showAllRevisions {
      ...SearchFacetBooleanFragment
    }
  }
}
Response
{
  "data": {
    "listPurchaseOrderSearchFacets": {
      "status": [PurchaseOrderStatusSearchFacet],
      "showAllRevisions": [SearchFacetBoolean]
    }
  }
}

listRateTemplates

Response

Returns a RateTemplates

Arguments
Name Description
input - ListRateTemplatesInput

Example

Query
query listRateTemplates($input: ListRateTemplatesInput) {
  listRateTemplates(input: $input) {
    items {
      ...RateTemplateFragment
    }
    nextToken
  }
}
Variables
{"input": ListRateTemplatesInput}
Response
{
  "data": {
    "listRateTemplates": {
      "items": [RateTemplate],
      "nextToken": "abc123"
    }
  }
}

listRfiSearchFacets

Response

Returns a RfiSearchFacets

Example

Query
query listRfiSearchFacets {
  listRfiSearchFacets {
    status {
      ...RfiStatusSearchFacetFragment
    }
    isScheduleImpacted {
      ...SearchFacetBooleanFragment
    }
    isCostImpacted {
      ...SearchFacetBooleanFragment
    }
    showAllRevisions {
      ...SearchFacetBooleanFragment
    }
  }
}
Response
{
  "data": {
    "listRfiSearchFacets": {
      "status": [RfiStatusSearchFacet],
      "isScheduleImpacted": [SearchFacetBoolean],
      "isCostImpacted": [SearchFacetBoolean],
      "showAllRevisions": [SearchFacetBoolean]
    }
  }
}

listRfis

Response

Returns a ModelRfiConnection

Arguments
Name Description
filter - ModelRfiFilterInput
limit - Int
nextToken - String

Example

Query
query listRfis(
  $filter: ModelRfiFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listRfis(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...RfiFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelRfiFilterInput,
  "limit": 123,
  "nextToken": "abc123"
}
Response
{
  "data": {
    "listRfis": {
      "items": [Rfi],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listSubmittalPackageSearchFacets

Response

Returns a SubmittalPackageSearchFacets

Example

Query
query listSubmittalPackageSearchFacets {
  listSubmittalPackageSearchFacets {
    status {
      ...SubmittalPackageStatusSearchFacetFragment
    }
  }
}
Response
{
  "data": {
    "listSubmittalPackageSearchFacets": {
      "status": [SubmittalPackageStatusSearchFacet]
    }
  }
}

listSubmittalSearchFacets

Response

Returns a SubmittalSearchFacets

Example

Query
query listSubmittalSearchFacets {
  listSubmittalSearchFacets {
    documentType {
      ...SubmittalDocumentTypeSearchFacetFragment
    }
    status {
      ...SubmittalStatusSearchFacetFragment
    }
    type {
      ...SubmittalTypeSearchFacetFragment
    }
    showAllRevisions {
      ...SearchFacetBooleanFragment
    }
  }
}
Response
{
  "data": {
    "listSubmittalSearchFacets": {
      "documentType": [SubmittalDocumentTypeSearchFacet],
      "status": [SubmittalStatusSearchFacet],
      "type": [SubmittalTypeSearchFacet],
      "showAllRevisions": [SearchFacetBoolean]
    }
  }
}

listTimeCards

Response

Returns a ModelTimeCardConnection

Arguments
Name Description
filter - ModelTimeCardFilterInput
limit - Int
nextToken - String

Example

Query
query listTimeCards(
  $filter: ModelTimeCardFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listTimeCards(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...TimeCardFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelTimeCardFilterInput,
  "limit": 987,
  "nextToken": "abc123"
}
Response
{
  "data": {
    "listTimeCards": {
      "items": [TimeCard],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listTimeCardsBy

Response

Returns a TimeCards

Arguments
Name Description
input - ListTimeCardsByInput

Example

Query
query listTimeCardsBy($input: ListTimeCardsByInput) {
  listTimeCardsBy(input: $input) {
    items {
      ...TimeCardFragment
    }
    nextToken
  }
}
Variables
{"input": ListTimeCardsByInput}
Response
{
  "data": {
    "listTimeCardsBy": {
      "items": [TimeCard],
      "nextToken": "xyz789"
    }
  }
}

listUnitOfMeasures

Response

Returns a UnitOfMeasures

Arguments
Name Description
input - ListUnitOfMeasuresInput!

Example

Query
query listUnitOfMeasures($input: ListUnitOfMeasuresInput!) {
  listUnitOfMeasures(input: $input) {
    items {
      ...UnitOfMeasureFragment
    }
    cursor
  }
}
Variables
{"input": ListUnitOfMeasuresInput}
Response
{
  "data": {
    "listUnitOfMeasures": {
      "items": [UnitOfMeasure],
      "cursor": "abc123"
    }
  }
}

listUsers

Response

Returns a ModelUserConnection

Arguments
Name Description
filter - ModelUserFilterInput
limit - Int
nextToken - String

Example

Query
query listUsers(
  $filter: ModelUserFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listUsers(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...UserFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelUserFilterInput,
  "limit": 123,
  "nextToken": "xyz789"
}
Response
{
  "data": {
    "listUsers": {
      "items": [User],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listUsersSorted

Response

Returns a ModelUserConnection

Arguments
Name Description
sortBy - UserSortByColumn!
limit - Int
nextToken - String
direction - ModelSortDirection!

Example

Query
query listUsersSorted(
  $sortBy: UserSortByColumn!,
  $limit: Int,
  $nextToken: String,
  $direction: ModelSortDirection!
) {
  listUsersSorted(
    sortBy: $sortBy,
    limit: $limit,
    nextToken: $nextToken,
    direction: $direction
  ) {
    items {
      ...UserFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "sortBy": "EMAIL",
  "limit": 987,
  "nextToken": "abc123",
  "direction": "ASC"
}
Response
{
  "data": {
    "listUsersSorted": {
      "items": [User],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listUsersWithMembership

Arguments
Name Description
input - ListUsersWithMembershipInput

Example

Query
query listUsersWithMembership($input: ListUsersWithMembershipInput) {
  listUsersWithMembership(input: $input) {
    items {
      ...UserWithMembershipFragment
    }
    nextToken
    startedAt
  }
}
Variables
{"input": ListUsersWithMembershipInput}
Response
{
  "data": {
    "listUsersWithMembership": {
      "items": [UserWithMembership],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

listWeatherTypes

Response

Returns a ModelWeatherTypeConnection

Arguments
Name Description
filter - ModelWeatherTypeFilterInput
limit - Int
nextToken - String

Example

Query
query listWeatherTypes(
  $filter: ModelWeatherTypeFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listWeatherTypes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...WeatherTypeFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelWeatherTypeFilterInput,
  "limit": 123,
  "nextToken": "xyz789"
}
Response
{
  "data": {
    "listWeatherTypes": {
      "items": [WeatherType],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

listWindTypes

Response

Returns a ModelWindTypeConnection

Arguments
Name Description
filter - ModelWindTypeFilterInput
limit - Int
nextToken - String

Example

Query
query listWindTypes(
  $filter: ModelWindTypeFilterInput,
  $limit: Int,
  $nextToken: String
) {
  listWindTypes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken
  ) {
    items {
      ...WindTypeFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelWindTypeFilterInput,
  "limit": 123,
  "nextToken": "xyz789"
}
Response
{
  "data": {
    "listWindTypes": {
      "items": [WindType],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

searchChangeOrderRequests

Response

Returns a ChangeOrderRequestSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - ChangeOrderRequestSearchFilterInput
sortBy - ChangeOrderRequestSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchChangeOrderRequests(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: ChangeOrderRequestSearchFilterInput,
  $sortBy: ChangeOrderRequestSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchChangeOrderRequests(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...ChangeOrderRequestSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "xyz789",
  "limit": 123,
  "page": 123,
  "filter": ChangeOrderRequestSearchFilterInput,
  "sortBy": "DATE_SENT",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchChangeOrderRequests": {
      "items": [ChangeOrderRequestSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchContacts

Response

Returns a ContactSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - ContactSearchFilterInput
sortBy - ContactSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchContacts(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: ContactSearchFilterInput,
  $sortBy: ContactSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchContacts(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...ContactSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "xyz789",
  "limit": 987,
  "page": 123,
  "filter": ContactSearchFilterInput,
  "sortBy": "NAME",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchContacts": {
      "items": [ContactSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchCostCodes

Response

Returns a CostCodeSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - CostCodeSearchFilterInput
context - CostCodeSearchContextInput
sortBy - CostCodeSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchCostCodes(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: CostCodeSearchFilterInput,
  $context: CostCodeSearchContextInput,
  $sortBy: CostCodeSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchCostCodes(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    context: $context,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...CostCodeSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "xyz789",
  "limit": 123,
  "page": 987,
  "filter": CostCodeSearchFilterInput,
  "context": CostCodeSearchContextInput,
  "sortBy": "NAME",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchCostCodes": {
      "items": [CostCodeSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchDailyReports

Response

Returns a DailyReportSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - DailyReportSearchFilterInput
sortBy - DailyReportSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchDailyReports(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: DailyReportSearchFilterInput,
  $sortBy: DailyReportSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchDailyReports(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...DailyReportSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "xyz789",
  "limit": 123,
  "page": 123,
  "filter": DailyReportSearchFilterInput,
  "sortBy": "DATE",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchDailyReports": {
      "items": [DailyReportSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchEmails

Response

Returns a MailboxSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - MailboxSearchFilterInput
sortBy - MailboxSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchEmails(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: MailboxSearchFilterInput,
  $sortBy: MailboxSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchEmails(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...MailboxSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "abc123",
  "limit": 123,
  "page": 123,
  "filter": MailboxSearchFilterInput,
  "sortBy": "DATE",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchEmails": {
      "items": [MailboxSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchFieldNotes

Response

Returns a FieldNoteSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - FieldNoteSearchFilterInput
sortBy - FieldNoteSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchFieldNotes(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: FieldNoteSearchFilterInput,
  $sortBy: FieldNoteSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchFieldNotes(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...FieldNoteSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "abc123",
  "limit": 123,
  "page": 123,
  "filter": FieldNoteSearchFilterInput,
  "sortBy": "DATE",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchFieldNotes": {
      "items": [FieldNoteSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchProjects

Response

Returns a ProjectSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - ProjectSearchFilterInput
context - ProjectSearchContextInput
sortBy - ProjectSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchProjects(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: ProjectSearchFilterInput,
  $context: ProjectSearchContextInput,
  $sortBy: ProjectSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchProjects(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    context: $context,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...ProjectSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "abc123",
  "limit": 123,
  "page": 987,
  "filter": ProjectSearchFilterInput,
  "context": ProjectSearchContextInput,
  "sortBy": "NUMBER",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchProjects": {
      "items": [ProjectSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchPurchaseOrders

Response

Returns a PurchaseOrderSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - PurchaseOrderSearchFilterInput
sortBy - PurchaseOrderSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchPurchaseOrders(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: PurchaseOrderSearchFilterInput,
  $sortBy: PurchaseOrderSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchPurchaseOrders(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...PurchaseOrderSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "xyz789",
  "limit": 987,
  "page": 987,
  "filter": PurchaseOrderSearchFilterInput,
  "sortBy": "DATE",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchPurchaseOrders": {
      "items": [PurchaseOrderSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchRfis

Response

Returns a RfiSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - RfiSearchFilterInput
sortBy - RfiSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchRfis(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: RfiSearchFilterInput,
  $sortBy: RfiSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchRfis(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...RfiSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "xyz789",
  "limit": 987,
  "page": 123,
  "filter": RfiSearchFilterInput,
  "sortBy": "DATE",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchRfis": {
      "items": [RfiSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchSubmittalPackages

Response

Returns a SubmittalPackageSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - SubmittalPackageSearchFilterInput
sortBy - SubmittalPackageSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchSubmittalPackages(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: SubmittalPackageSearchFilterInput,
  $sortBy: SubmittalPackageSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchSubmittalPackages(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...SubmittalPackageSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "abc123",
  "limit": 123,
  "page": 123,
  "filter": SubmittalPackageSearchFilterInput,
  "sortBy": "NUMBER",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchSubmittalPackages": {
      "items": [SubmittalPackageSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchSubmittals

Response

Returns a SubmittalSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - SubmittalSearchFilterInput
sortBy - SubmittalSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchSubmittals(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: SubmittalSearchFilterInput,
  $sortBy: SubmittalSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchSubmittals(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...SubmittalSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "abc123",
  "limit": 987,
  "page": 123,
  "filter": SubmittalSearchFilterInput,
  "sortBy": "NUMBER",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchSubmittals": {
      "items": [SubmittalSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

searchUsers

Response

Returns a UserSearchResults

Arguments
Name Description
term - String
limit - Int
page - Int
filter - UserSearchFilterInput
context - UserSearchContextInput
sortBy - UserSearchSortByColumn
direction - ModelSortDirection

Example

Query
query searchUsers(
  $term: String,
  $limit: Int,
  $page: Int,
  $filter: UserSearchFilterInput,
  $context: UserSearchContextInput,
  $sortBy: UserSearchSortByColumn,
  $direction: ModelSortDirection
) {
  searchUsers(
    term: $term,
    limit: $limit,
    page: $page,
    filter: $filter,
    context: $context,
    sortBy: $sortBy,
    direction: $direction
  ) {
    items {
      ...UserSearchResultFragment
    }
    pagination {
      ...SearchResultsPaginationFragment
    }
  }
}
Variables
{
  "term": "abc123",
  "limit": 987,
  "page": 987,
  "filter": UserSearchFilterInput,
  "context": UserSearchContextInput,
  "sortBy": "NAME",
  "direction": "ASC"
}
Response
{
  "data": {
    "searchUsers": {
      "items": [UserSearchResult],
      "pagination": SearchResultsPagination
    }
  }
}

syncCompanies

Response

Returns a ModelCompanyConnection

Arguments
Name Description
filter - ModelCompanyFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncCompanies(
  $filter: ModelCompanyFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncCompanies(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...CompanyFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelCompanyFilterInput,
  "limit": 123,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncCompanies": {
      "items": [Company],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

syncContacts

Response

Returns a ModelContactConnection

Arguments
Name Description
filter - ModelContactFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncContacts(
  $filter: ModelContactFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncContacts(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...ContactFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelContactFilterInput,
  "limit": 987,
  "nextToken": "xyz789",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncContacts": {
      "items": [Contact],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncDailyReports

Response

Returns a ModelDailyReportConnection

Arguments
Name Description
filter - ModelDailyReportFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncDailyReports(
  $filter: ModelDailyReportFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncDailyReports(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...DailyReportFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelDailyReportFilterInput,
  "limit": 123,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncDailyReports": {
      "items": [DailyReport],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncEntityAssignments

Response

Returns a ModelEntityAssignmentConnection

Arguments
Name Description
filter - ModelEntityAssignmentFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncEntityAssignments(
  $filter: ModelEntityAssignmentFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncEntityAssignments(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...EntityAssignmentFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelEntityAssignmentFilterInput,
  "limit": 123,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncEntityAssignments": {
      "items": [EntityAssignment],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

syncFieldNotes

Response

Returns a ModelFieldNoteConnection

Arguments
Name Description
filter - ModelFieldNoteFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncFieldNotes(
  $filter: ModelFieldNoteFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncFieldNotes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...FieldNoteFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelFieldNoteFilterInput,
  "limit": 123,
  "nextToken": "xyz789",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncFieldNotes": {
      "items": [FieldNote],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncKeywords

Response

Returns a ModelKeywordConnection

Arguments
Name Description
filter - ModelKeywordFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncKeywords(
  $filter: ModelKeywordFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncKeywords(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...KeywordFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelKeywordFilterInput,
  "limit": 987,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncKeywords": {
      "items": [Keyword],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncLocationTags

Response

Returns a ModelLocationTagConnection

Arguments
Name Description
filter - ModelLocationTagFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncLocationTags(
  $filter: ModelLocationTagFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncLocationTags(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...LocationTagFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelLocationTagFilterInput,
  "limit": 123,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncLocationTags": {
      "items": [LocationTag],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncOccupancySubTypes

Response

Returns a ModelOccupancySubTypeConnection

Arguments
Name Description
filter - ModelOccupancySubTypeFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncOccupancySubTypes(
  $filter: ModelOccupancySubTypeFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncOccupancySubTypes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...OccupancySubTypeFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelOccupancySubTypeFilterInput,
  "limit": 987,
  "nextToken": "xyz789",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncOccupancySubTypes": {
      "items": [OccupancySubType],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

syncOccupancyTypes

Response

Returns a ModelOccupancyTypeConnection

Arguments
Name Description
filter - ModelOccupancyTypeFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncOccupancyTypes(
  $filter: ModelOccupancyTypeFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncOccupancyTypes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...OccupancyTypeFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelOccupancyTypeFilterInput,
  "limit": 123,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncOccupancyTypes": {
      "items": [OccupancyType],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncProjects

Response

Returns a ModelProjectConnection

Arguments
Name Description
filter - ModelProjectFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncProjects(
  $filter: ModelProjectFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncProjects(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...ProjectFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelProjectFilterInput,
  "limit": 123,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncProjects": {
      "items": [Project],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncRfis

Response

Returns a ModelRfiConnection

Arguments
Name Description
filter - ModelRfiFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncRfis(
  $filter: ModelRfiFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncRfis(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...RfiFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelRfiFilterInput,
  "limit": 987,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncRfis": {
      "items": [Rfi],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncTimeCards

Response

Returns a ModelTimeCardConnection

Arguments
Name Description
filter - ModelTimeCardFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncTimeCards(
  $filter: ModelTimeCardFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncTimeCards(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...TimeCardFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelTimeCardFilterInput,
  "limit": 987,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncTimeCards": {
      "items": [TimeCard],
      "nextToken": "abc123",
      "startedAt": AWSTimestamp
    }
  }
}

syncUsers

Response

Returns a ModelUserConnection

Arguments
Name Description
filter - ModelUserFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncUsers(
  $filter: ModelUserFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncUsers(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...UserFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelUserFilterInput,
  "limit": 987,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncUsers": {
      "items": [User],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncWeatherTypes

Response

Returns a ModelWeatherTypeConnection

Arguments
Name Description
filter - ModelWeatherTypeFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncWeatherTypes(
  $filter: ModelWeatherTypeFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncWeatherTypes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...WeatherTypeFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelWeatherTypeFilterInput,
  "limit": 987,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncWeatherTypes": {
      "items": [WeatherType],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

syncWindTypes

Response

Returns a ModelWindTypeConnection

Arguments
Name Description
filter - ModelWindTypeFilterInput
limit - Int
nextToken - String
lastSync - AWSTimestamp

Example

Query
query syncWindTypes(
  $filter: ModelWindTypeFilterInput,
  $limit: Int,
  $nextToken: String,
  $lastSync: AWSTimestamp
) {
  syncWindTypes(
    filter: $filter,
    limit: $limit,
    nextToken: $nextToken,
    lastSync: $lastSync
  ) {
    items {
      ...WindTypeFragment
    }
    nextToken
    startedAt
  }
}
Variables
{
  "filter": ModelWindTypeFilterInput,
  "limit": 987,
  "nextToken": "abc123",
  "lastSync": AWSTimestamp
}
Response
{
  "data": {
    "syncWindTypes": {
      "items": [WindType],
      "nextToken": "xyz789",
      "startedAt": AWSTimestamp
    }
  }
}

validateUniqueUserEmail

Response

Returns a Boolean

Arguments
Name Description
email - String!

Example

Query
query validateUniqueUserEmail($email: String!) {
  validateUniqueUserEmail(email: $email)
}
Variables
{"email": "xyz789"}
Response
{"data": {"validateUniqueUserEmail": true}}

validateUniqueUserEmployeeNo

Response

Returns a Boolean

Arguments
Name Description
employeeNo - String!

Example

Query
query validateUniqueUserEmployeeNo($employeeNo: String!) {
  validateUniqueUserEmployeeNo(employeeNo: $employeeNo)
}
Variables
{"employeeNo": "abc123"}
Response
{"data": {"validateUniqueUserEmployeeNo": false}}

Mutations

confirmForgotPassword

Response

Returns a Boolean

Arguments
Name Description
input - ConfirmForgotPasswordInput!

Example

Query
mutation confirmForgotPassword($input: ConfirmForgotPasswordInput!) {
  confirmForgotPassword(input: $input)
}
Variables
{"input": ConfirmForgotPasswordInput}
Response
{"data": {"confirmForgotPassword": true}}

copyChangeOrderRequest

Response

Returns a ChangeOrderRequest

Arguments
Name Description
input - CopyChangeOrderRequestInput!

Example

Query
mutation copyChangeOrderRequest($input: CopyChangeOrderRequestInput!) {
  copyChangeOrderRequest(input: $input) {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Variables
{"input": CopyChangeOrderRequestInput}
Response
{
  "data": {
    "copyChangeOrderRequest": {
      "approvalNumber": "abc123",
      "approvedAmountInPennies": 987,
      "created": "xyz789",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 987,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "xyz789",
      "images": [ResizedAttachment],
      "internalNotes": "abc123",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "abc123",
      "name": "abc123",
      "number": "xyz789",
      "project": Project,
      "referenceNumberAsi": "xyz789",
      "referenceNumberGcCor": "abc123",
      "referenceNumberOther": "abc123",
      "referenceNumberOwnerCor": "xyz789",
      "referenceNumberPco": "abc123",
      "referenceNumberRfi": "xyz789",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 123,
      "scheduleImpactComments": "abc123",
      "scheduleImpactDays": 987,
      "scopeOfWork": "abc123",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

copyPurchaseOrder

Response

Returns a PurchaseOrder

Arguments
Name Description
input - CopyPurchaseOrderInput!

Example

Query
mutation copyPurchaseOrder($input: CopyPurchaseOrderInput!) {
  copyPurchaseOrder(input: $input) {
    id
    project {
      ...ProjectFragment
    }
    number
    date
    type
    description
    status
    vendor {
      ...ContactFragment
    }
    salesTaxRatePercent
    salesTaxAmountInPennies
    depositInPennies
    depositDate
    releaseDate
    billing {
      ...PurchaseOrderBillingFragment
    }
    shipping {
      ...PurchaseOrderShippingFragment
    }
    buyerNotes
    vendorNotes
    internalNotes
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
    lines {
      ...PurchaseOrderLinesFragment
    }
    receivings {
      ...PurchaseOrderReceivingsFragment
    }
    invoicedInPennies
    totalInPennies
    revision
  }
}
Variables
{"input": CopyPurchaseOrderInput}
Response
{
  "data": {
    "copyPurchaseOrder": {
      "id": "abc123",
      "project": Project,
      "number": "abc123",
      "date": AWSDateTime,
      "type": "PURCHASE_ORDER",
      "description": "abc123",
      "status": "DRAFT",
      "vendor": Contact,
      "salesTaxRatePercent": 123.45,
      "salesTaxAmountInPennies": 987,
      "depositInPennies": 987,
      "depositDate": AWSDateTime,
      "releaseDate": AWSDateTime,
      "billing": PurchaseOrderBilling,
      "shipping": PurchaseOrderShipping,
      "buyerNotes": "abc123",
      "vendorNotes": "xyz789",
      "internalNotes": "xyz789",
      "docs": [AttachmentV2],
      "images": [ResizedAttachment],
      "lines": PurchaseOrderLines,
      "receivings": PurchaseOrderReceivings,
      "invoicedInPennies": 123,
      "totalInPennies": 987,
      "revision": 987
    }
  }
}

copySubmittalItem

Response

Returns a SubmittalItem

Arguments
Name Description
input - CreateCopySubmittalItemInput!

Example

Query
mutation copySubmittalItem($input: CreateCopySubmittalItemInput!) {
  copySubmittalItem(input: $input) {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Variables
{"input": CreateCopySubmittalItemInput}
Response
{
  "data": {
    "copySubmittalItem": {
      "created": "abc123",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "abc123",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "xyz789",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "abc123",
      "name": "abc123",
      "notes": "abc123",
      "number": "xyz789",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 123,
      "specSection": "abc123",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

createAdminCompany

Response

Returns an AdminCompany

Arguments
Name Description
input - CreateAdminCompanyInput!

Example

Query
mutation createAdminCompany($input: CreateAdminCompanyInput!) {
  createAdminCompany(input: $input) {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    orgId
    hierarchy
  }
}
Variables
{"input": CreateAdminCompanyInput}
Response
{
  "data": {
    "createAdminCompany": {
      "id": "4",
      "name": "abc123",
      "address": Address,
      "country": "abc123",
      "phone": "xyz789",
      "fax": "xyz789",
      "orgId": 4,
      "hierarchy": "abc123"
    }
  }
}

createAdminUser

Response

Returns an AdminUser

Arguments
Name Description
input - CreateAdminUserInput!

Example

Query
mutation createAdminUser($input: CreateAdminUserInput!) {
  createAdminUser(input: $input) {
    id
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AdminAddressAllOptionalFragment
    }
    useCompanyAddress
    emailSignature
    languagePreference
    dateDisplayPreference
    _version
  }
}
Variables
{"input": CreateAdminUserInput}
Response
{
  "data": {
    "createAdminUser": {
      "id": "4",
      "givenName": "xyz789",
      "middleName": "xyz789",
      "familyName": "xyz789",
      "email": "xyz789",
      "employeeNo": "xyz789",
      "role": "xyz789",
      "jobTitle": "abc123",
      "officeNo": "xyz789",
      "mobileNo": "xyz789",
      "faxNo": "abc123",
      "address": AdminAddressAllOptional,
      "useCompanyAddress": true,
      "emailSignature": "abc123",
      "languagePreference": "abc123",
      "dateDisplayPreference": "xyz789",
      "_version": 987
    }
  }
}

createAttachmentLinkForCompany

Response

Returns an Attachment

Arguments
Name Description
input - CreateAttachmentLinkForCompanyInput!

Example

Query
mutation createAttachmentLinkForCompany($input: CreateAttachmentLinkForCompanyInput!) {
  createAttachmentLinkForCompany(input: $input) {
    id
    key
    link
    algorithm
    credential
    date
    token
    policy
    signature
  }
}
Variables
{"input": CreateAttachmentLinkForCompanyInput}
Response
{
  "data": {
    "createAttachmentLinkForCompany": {
      "id": "xyz789",
      "key": "abc123",
      "link": "xyz789",
      "algorithm": "abc123",
      "credential": "xyz789",
      "date": "abc123",
      "token": "xyz789",
      "policy": "xyz789",
      "signature": "xyz789"
    }
  }
}

createAttachmentLinkForNote

Response

Returns an Attachment

Arguments
Name Description
input - CreateAttachmentLinkForNoteInput!

Example

Query
mutation createAttachmentLinkForNote($input: CreateAttachmentLinkForNoteInput!) {
  createAttachmentLinkForNote(input: $input) {
    id
    key
    link
    algorithm
    credential
    date
    token
    policy
    signature
  }
}
Variables
{"input": CreateAttachmentLinkForNoteInput}
Response
{
  "data": {
    "createAttachmentLinkForNote": {
      "id": "xyz789",
      "key": "xyz789",
      "link": "xyz789",
      "algorithm": "xyz789",
      "credential": "abc123",
      "date": "xyz789",
      "token": "abc123",
      "policy": "xyz789",
      "signature": "xyz789"
    }
  }
}

createAttachmentLinkForReport

Response

Returns an Attachment

Arguments
Name Description
input - CreateAttachmentLinkForReportInput!

Example

Query
mutation createAttachmentLinkForReport($input: CreateAttachmentLinkForReportInput!) {
  createAttachmentLinkForReport(input: $input) {
    id
    key
    link
    algorithm
    credential
    date
    token
    policy
    signature
  }
}
Variables
{"input": CreateAttachmentLinkForReportInput}
Response
{
  "data": {
    "createAttachmentLinkForReport": {
      "id": "abc123",
      "key": "xyz789",
      "link": "xyz789",
      "algorithm": "abc123",
      "credential": "xyz789",
      "date": "xyz789",
      "token": "xyz789",
      "policy": "xyz789",
      "signature": "abc123"
    }
  }
}

createChangeOrderRequest

Response

Returns a ChangeOrderRequest

Arguments
Name Description
input - CreateChangeOrderRequestInput!

Example

Query
mutation createChangeOrderRequest($input: CreateChangeOrderRequestInput!) {
  createChangeOrderRequest(input: $input) {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Variables
{"input": CreateChangeOrderRequestInput}
Response
{
  "data": {
    "createChangeOrderRequest": {
      "approvalNumber": "abc123",
      "approvedAmountInPennies": 123,
      "created": "abc123",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 987,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "xyz789",
      "images": [ResizedAttachment],
      "internalNotes": "abc123",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "abc123",
      "name": "xyz789",
      "number": "abc123",
      "project": Project,
      "referenceNumberAsi": "xyz789",
      "referenceNumberGcCor": "abc123",
      "referenceNumberOther": "xyz789",
      "referenceNumberOwnerCor": "abc123",
      "referenceNumberPco": "abc123",
      "referenceNumberRfi": "xyz789",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 123,
      "scheduleImpactComments": "xyz789",
      "scheduleImpactDays": 123,
      "scopeOfWork": "xyz789",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

createChangeOrderRequestEquipmentLineItem

Arguments
Name Description
input - CreateChangeOrderRequestEquipmentLineItemInput!

Example

Query
mutation createChangeOrderRequestEquipmentLineItem($input: CreateChangeOrderRequestEquipmentLineItemInput!) {
  createChangeOrderRequestEquipmentLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customEquipment
  }
}
Variables
{"input": CreateChangeOrderRequestEquipmentLineItemInput}
Response
{
  "data": {
    "createChangeOrderRequestEquipmentLineItem": {
      "costInPennies": 987,
      "id": "xyz789",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "xyz789",
      "rateInPennies": 987,
      "sellPriceInPennies": 123,
      "quantity": 123.45,
      "customEquipment": "xyz789"
    }
  }
}

createChangeOrderRequestLaborLineItem

Response

Returns a ChangeOrderRequestLaborLineItem

Arguments
Name Description
input - CreateChangeOrderRequestLaborLineItemInput!

Example

Query
mutation createChangeOrderRequestLaborLineItem($input: CreateChangeOrderRequestLaborLineItemInput!) {
  createChangeOrderRequestLaborLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customLaborClass
    hoursInMinutes
    laborClass {
      ...LaborClassFragment
    }
    rateInPennies
    sellRateInPennies
    workers
  }
}
Variables
{"input": CreateChangeOrderRequestLaborLineItemInput}
Response
{
  "data": {
    "createChangeOrderRequestLaborLineItem": {
      "costInPennies": 987,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customLaborClass": "abc123",
      "hoursInMinutes": 987,
      "laborClass": LaborClass,
      "rateInPennies": 123,
      "sellRateInPennies": 123,
      "workers": 123.45
    }
  }
}

createChangeOrderRequestMaterialLineItem

Arguments
Name Description
input - CreateChangeOrderRequestMaterialLineItemInput!

Example

Query
mutation createChangeOrderRequestMaterialLineItem($input: CreateChangeOrderRequestMaterialLineItemInput!) {
  createChangeOrderRequestMaterialLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customMaterial
  }
}
Variables
{"input": CreateChangeOrderRequestMaterialLineItemInput}
Response
{
  "data": {
    "createChangeOrderRequestMaterialLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "abc123",
      "rateInPennies": 123,
      "sellPriceInPennies": 987,
      "quantity": 987.65,
      "customMaterial": "abc123"
    }
  }
}

createChangeOrderRequestOtherLineItem

Response

Returns a ChangeOrderRequestOtherLineItem

Arguments
Name Description
input - CreateChangeOrderRequestOtherLineItemInput!

Example

Query
mutation createChangeOrderRequestOtherLineItem($input: CreateChangeOrderRequestOtherLineItemInput!) {
  createChangeOrderRequestOtherLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{"input": CreateChangeOrderRequestOtherLineItemInput}
Response
{
  "data": {
    "createChangeOrderRequestOtherLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 987.65,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "abc123",
      "description": "abc123",
      "priceInPennies": 123,
      "quantity": 123.45,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

createChangeOrderRequestOverheadLineItem

Arguments
Name Description
input - CreateChangeOrderRequestOverheadLineItemInput!

Example

Query
mutation createChangeOrderRequestOverheadLineItem($input: CreateChangeOrderRequestOverheadLineItemInput!) {
  createChangeOrderRequestOverheadLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{"input": CreateChangeOrderRequestOverheadLineItemInput}
Response
{
  "data": {
    "createChangeOrderRequestOverheadLineItem": {
      "costInPennies": 987,
      "id": "abc123",
      "markup": 123.45,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "abc123",
      "priceInPennies": 123,
      "quantity": 123.45,
      "sellPriceInPennies": 987,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

createChangeOrderRequestPdfJob

Response

Returns a PdfJob

Arguments
Name Description
input - CreateChangeOrderRequestPdfJobInput!

Example

Query
mutation createChangeOrderRequestPdfJob($input: CreateChangeOrderRequestPdfJobInput!) {
  createChangeOrderRequestPdfJob(input: $input) {
    id
    status
    type
    created
    modified
    result {
      ...PreSignedLinkFragment
    }
  }
}
Variables
{"input": CreateChangeOrderRequestPdfJobInput}
Response
{
  "data": {
    "createChangeOrderRequestPdfJob": {
      "id": "abc123",
      "status": "CREATED",
      "type": "FIELD_NOTE",
      "created": "xyz789",
      "modified": "xyz789",
      "result": PreSignedLink
    }
  }
}

createChangeOrderRequestRevision

Response

Returns a ChangeOrderRequest

Arguments
Name Description
input - CreateChangeOrderRequestRevisionInput!

Example

Query
mutation createChangeOrderRequestRevision($input: CreateChangeOrderRequestRevisionInput!) {
  createChangeOrderRequestRevision(input: $input) {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Variables
{"input": CreateChangeOrderRequestRevisionInput}
Response
{
  "data": {
    "createChangeOrderRequestRevision": {
      "approvalNumber": "abc123",
      "approvedAmountInPennies": 987,
      "created": "xyz789",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 987,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "abc123",
      "images": [ResizedAttachment],
      "internalNotes": "abc123",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "abc123",
      "name": "abc123",
      "number": "abc123",
      "project": Project,
      "referenceNumberAsi": "xyz789",
      "referenceNumberGcCor": "xyz789",
      "referenceNumberOther": "xyz789",
      "referenceNumberOwnerCor": "abc123",
      "referenceNumberPco": "abc123",
      "referenceNumberRfi": "abc123",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 123,
      "scheduleImpactComments": "abc123",
      "scheduleImpactDays": 123,
      "scopeOfWork": "xyz789",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

createChangeOrderRequestSubcontractorLineItem

Example

Query
mutation createChangeOrderRequestSubcontractorLineItem($input: CreateChangeOrderRequestSubcontractorLineItemInput!) {
  createChangeOrderRequestSubcontractorLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{
  "input": CreateChangeOrderRequestSubcontractorLineItemInput
}
Response
{
  "data": {
    "createChangeOrderRequestSubcontractorLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "abc123",
      "description": "abc123",
      "priceInPennies": 987,
      "quantity": 123.45,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

createCleanupTask

Response

Returns a CleanupTask

Arguments
Name Description
orgId - String!

Example

Query
mutation createCleanupTask($orgId: String!) {
  createCleanupTask(orgId: $orgId) {
    id
    orgId
    status
  }
}
Variables
{"orgId": "xyz789"}
Response
{
  "data": {
    "createCleanupTask": {
      "id": 4,
      "orgId": "abc123",
      "status": "CREATED"
    }
  }
}

createCompanyCostCode

Response

Returns a CompanyCostCode

Arguments
Name Description
input - CreateCompanyCostCodeInput!

Example

Query
mutation createCompanyCostCode($input: CreateCompanyCostCodeInput!) {
  createCompanyCostCode(input: $input) {
    id
    companyId
    number
    name
    status
    categories
    addToNewProjects
    projectCostCodes {
      ...ProjectCostCodesFragment
    }
  }
}
Variables
{"input": CreateCompanyCostCodeInput}
Response
{
  "data": {
    "createCompanyCostCode": {
      "id": 4,
      "companyId": "xyz789",
      "number": "xyz789",
      "name": "xyz789",
      "status": "ACTIVE",
      "categories": ["LABOR"],
      "addToNewProjects": false,
      "projectCostCodes": ProjectCostCodes
    }
  }
}

createCompanyFolder

Response

Returns a Folder

Arguments
Name Description
input - CreateCompanyFolderInput!

Example

Query
mutation createCompanyFolder($input: CreateCompanyFolderInput!) {
  createCompanyFolder(input: $input) {
    id
    name
    parentId
    parentPath
    path
  }
}
Variables
{"input": CreateCompanyFolderInput}
Response
{
  "data": {
    "createCompanyFolder": {
      "id": "xyz789",
      "name": "abc123",
      "parentId": "abc123",
      "parentPath": "xyz789",
      "path": "xyz789"
    }
  }
}

createContact

Response

Returns a Contact

Arguments
Name Description
input - CreateContactInput!
condition - ModelContactConditionInput

Example

Query
mutation createContact(
  $input: CreateContactInput!,
  $condition: ModelContactConditionInput
) {
  createContact(
    input: $input,
    condition: $condition
  ) {
    id
    firstName
    middleName
    lastName
    jobTitle
    email
    address {
      ...AddressAllOptionalFragment
    }
    country
    office
    mobile
    fax
    notes
    businessName
    businessType
    status
    apVendor
    vendorId
    website
    cannotDelete
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateContactInput,
  "condition": ModelContactConditionInput
}
Response
{
  "data": {
    "createContact": {
      "id": "4",
      "firstName": "xyz789",
      "middleName": "xyz789",
      "lastName": "xyz789",
      "jobTitle": "abc123",
      "email": "abc123",
      "address": AddressAllOptional,
      "country": "xyz789",
      "office": "xyz789",
      "mobile": "xyz789",
      "fax": "abc123",
      "notes": "xyz789",
      "businessName": "abc123",
      "businessType": "xyz789",
      "status": "AVAILABLE",
      "apVendor": true,
      "vendorId": "xyz789",
      "website": "abc123",
      "cannotDelete": true,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createDailyReport

Response

Returns a DailyReport

Arguments
Name Description
input - CreateDailyReportInput!
condition - ModelDailyReportConditionInput

Example

Query
mutation createDailyReport(
  $input: CreateDailyReportInput!,
  $condition: ModelDailyReportConditionInput
) {
  createDailyReport(
    input: $input,
    condition: $condition
  ) {
    id
    projectId
    customNo
    date
    timeOnSite
    timeOffSite
    totalWorkers
    author
    authorId
    weatherConditions {
      ...WeatherFragment
    }
    weather
    wind
    temperature
    workPerformed
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    issues
    favors
    accidents
    subcontractorsWorked
    visitors
    comments
    notes
    internalComments
    weatherComments
    lastEditedBy
    attachments {
      ...AttachmentsFragment
    }
    docs {
      ...DocsFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateDailyReportInput,
  "condition": ModelDailyReportConditionInput
}
Response
{
  "data": {
    "createDailyReport": {
      "id": 4,
      "projectId": "xyz789",
      "customNo": "xyz789",
      "date": AWSDateTime,
      "timeOnSite": AWSDateTime,
      "timeOffSite": AWSDateTime,
      "totalWorkers": 987,
      "author": "abc123",
      "authorId": "abc123",
      "weatherConditions": Weather,
      "weather": "abc123",
      "wind": "abc123",
      "temperature": 987,
      "workPerformed": "abc123",
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "issues": "abc123",
      "favors": "xyz789",
      "accidents": "xyz789",
      "subcontractorsWorked": "abc123",
      "visitors": "abc123",
      "comments": "xyz789",
      "notes": "abc123",
      "internalComments": "abc123",
      "weatherComments": "xyz789",
      "lastEditedBy": "xyz789",
      "attachments": Attachments,
      "docs": Docs,
      "emails": [Email],
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createDocumentLinkForNote

Response

Returns an Attachment

Arguments
Name Description
input - CreateDocumentLinkForNoteInput!

Example

Query
mutation createDocumentLinkForNote($input: CreateDocumentLinkForNoteInput!) {
  createDocumentLinkForNote(input: $input) {
    id
    key
    link
    algorithm
    credential
    date
    token
    policy
    signature
  }
}
Variables
{"input": CreateDocumentLinkForNoteInput}
Response
{
  "data": {
    "createDocumentLinkForNote": {
      "id": "xyz789",
      "key": "xyz789",
      "link": "xyz789",
      "algorithm": "xyz789",
      "credential": "xyz789",
      "date": "abc123",
      "token": "xyz789",
      "policy": "xyz789",
      "signature": "abc123"
    }
  }
}

createDocumentLinkForReport

Response

Returns an Attachment

Arguments
Name Description
input - CreateDocumentLinkForReportInput!

Example

Query
mutation createDocumentLinkForReport($input: CreateDocumentLinkForReportInput!) {
  createDocumentLinkForReport(input: $input) {
    id
    key
    link
    algorithm
    credential
    date
    token
    policy
    signature
  }
}
Variables
{"input": CreateDocumentLinkForReportInput}
Response
{
  "data": {
    "createDocumentLinkForReport": {
      "id": "abc123",
      "key": "xyz789",
      "link": "xyz789",
      "algorithm": "abc123",
      "credential": "xyz789",
      "date": "xyz789",
      "token": "abc123",
      "policy": "abc123",
      "signature": "abc123"
    }
  }
}

createDownloadLinkForChangeOrderRequest

Arguments
Name Description
input - CreateDownloadLinkForChangeOrderRequestInput!

Example

Query
mutation createDownloadLinkForChangeOrderRequest($input: CreateDownloadLinkForChangeOrderRequestInput!) {
  createDownloadLinkForChangeOrderRequest(input: $input) {
    url
    createdAt
    expiresAt
  }
}
Variables
{"input": CreateDownloadLinkForChangeOrderRequestInput}
Response
{
  "data": {
    "createDownloadLinkForChangeOrderRequest": {
      "url": "xyz789",
      "createdAt": "xyz789",
      "expiresAt": "abc123"
    }
  }
}

createDownloadLinkForCompanyDrive

Response

Returns a PreSignedLink

Arguments
Name Description
input - CreateDownloadLinkForCompanyDriveInput!

Example

Query
mutation createDownloadLinkForCompanyDrive($input: CreateDownloadLinkForCompanyDriveInput!) {
  createDownloadLinkForCompanyDrive(input: $input) {
    link
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
  }
}
Variables
{"input": CreateDownloadLinkForCompanyDriveInput}
Response
{
  "data": {
    "createDownloadLinkForCompanyDrive": {
      "link": "abc123",
      "createdAt": "xyz789",
      "expiresAt": "abc123",
      "headers": [Header]
    }
  }
}

createDownloadLinkForProjectDrive

Response

Returns a PreSignedLink

Arguments
Name Description
input - CreateDownloadLinkForProjectDriveInput!

Example

Query
mutation createDownloadLinkForProjectDrive($input: CreateDownloadLinkForProjectDriveInput!) {
  createDownloadLinkForProjectDrive(input: $input) {
    link
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
  }
}
Variables
{"input": CreateDownloadLinkForProjectDriveInput}
Response
{
  "data": {
    "createDownloadLinkForProjectDrive": {
      "link": "abc123",
      "createdAt": "abc123",
      "expiresAt": "xyz789",
      "headers": [Header]
    }
  }
}

createDownloadLinkForRfi

Response

Returns a RfiAttachmentDownloadLink

Arguments
Name Description
input - CreateDownloadLinkForRfiInput!

Example

Query
mutation createDownloadLinkForRfi($input: CreateDownloadLinkForRfiInput!) {
  createDownloadLinkForRfi(input: $input) {
    url
    createdAt
    expiresAt
  }
}
Variables
{"input": CreateDownloadLinkForRfiInput}
Response
{
  "data": {
    "createDownloadLinkForRfi": {
      "url": "xyz789",
      "createdAt": "abc123",
      "expiresAt": "xyz789"
    }
  }
}

createDownloadLinkForSubmittal

Response

Returns a SubmittalAttachmentDownloadLink

Arguments
Name Description
input - CreateDownloadLinkForSubmittalInput!

Example

Query
mutation createDownloadLinkForSubmittal($input: CreateDownloadLinkForSubmittalInput!) {
  createDownloadLinkForSubmittal(input: $input) {
    url
    createdAt
    expiresAt
  }
}
Variables
{"input": CreateDownloadLinkForSubmittalInput}
Response
{
  "data": {
    "createDownloadLinkForSubmittal": {
      "url": "xyz789",
      "createdAt": "abc123",
      "expiresAt": "abc123"
    }
  }
}

createEntityAssignment

Response

Returns an EntityAssignment

Arguments
Name Description
input - CreateEntityAssignmentInput!
condition - ModelEntityAssignmentConditionInput

Example

Query
mutation createEntityAssignment(
  $input: CreateEntityAssignmentInput!,
  $condition: ModelEntityAssignmentConditionInput
) {
  createEntityAssignment(
    input: $input,
    condition: $condition
  ) {
    id
    entityId
    userId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateEntityAssignmentInput,
  "condition": ModelEntityAssignmentConditionInput
}
Response
{
  "data": {
    "createEntityAssignment": {
      "id": 4,
      "entityId": "4",
      "userId": 4,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createFieldNote

Response

Returns a FieldNote

Arguments
Name Description
input - CreateFieldNoteInput!
condition - ModelFieldNoteConditionInput

Example

Query
mutation createFieldNote(
  $input: CreateFieldNoteInput!,
  $condition: ModelFieldNoteConditionInput
) {
  createFieldNote(
    input: $input,
    condition: $condition
  ) {
    id
    note
    createdOnDeviceAt
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    locationTags {
      ...NestedLocationTagFragment
    }
    address {
      ...AddressFragment
    }
    phase
    system
    attachments {
      ...AttachmentsFragment
    }
    createdByUsername
    createdByUserId
    projectId
    docs {
      ...DocsFragment
    }
    lastUpdatedByUsername
    lastUpdatedByUserId
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateFieldNoteInput,
  "condition": ModelFieldNoteConditionInput
}
Response
{
  "data": {
    "createFieldNote": {
      "id": 4,
      "note": "abc123",
      "createdOnDeviceAt": AWSDateTime,
      "keywords": ["xyz789"],
      "listOfKeywords": [NestedKeywords],
      "locationTags": [NestedLocationTag],
      "address": Address,
      "phase": "xyz789",
      "system": "abc123",
      "attachments": Attachments,
      "createdByUsername": "abc123",
      "createdByUserId": "abc123",
      "projectId": "abc123",
      "docs": Docs,
      "lastUpdatedByUsername": "xyz789",
      "lastUpdatedByUserId": "xyz789",
      "emails": [Email],
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createKeyword

Response

Returns a Keyword

Arguments
Name Description
input - CreateKeywordInput!
condition - ModelKeywordConditionInput

Example

Query
mutation createKeyword(
  $input: CreateKeywordInput!,
  $condition: ModelKeywordConditionInput
) {
  createKeyword(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    status
    usageCount
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateKeywordInput,
  "condition": ModelKeywordConditionInput
}
Response
{
  "data": {
    "createKeyword": {
      "id": 4,
      "name": "abc123",
      "companyId": "abc123",
      "status": "AVAILABLE",
      "usageCount": 987,
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createLaborClass

Response

Returns a LaborClass

Arguments
Name Description
input - CreateLaborClassInput!

Example

Query
mutation createLaborClass($input: CreateLaborClassInput!) {
  createLaborClass(input: $input) {
    id
    companyId
    name
    status
  }
}
Variables
{"input": CreateLaborClassInput}
Response
{
  "data": {
    "createLaborClass": {
      "id": "xyz789",
      "companyId": "xyz789",
      "name": "abc123",
      "status": "ACTIVE"
    }
  }
}

createLocationTag

Response

Returns a LocationTag

Arguments
Name Description
input - CreateLocationTagInput!
condition - ModelLocationTagConditionInput

Example

Query
mutation createLocationTag(
  $input: CreateLocationTagInput!,
  $condition: ModelLocationTagConditionInput
) {
  createLocationTag(
    input: $input,
    condition: $condition
  ) {
    id
    name
    projectId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateLocationTagInput,
  "condition": ModelLocationTagConditionInput
}
Response
{
  "data": {
    "createLocationTag": {
      "id": "4",
      "name": "xyz789",
      "projectId": "abc123",
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createOccupancySubType

Response

Returns an OccupancySubType

Arguments
Name Description
input - CreateOccupancySubTypeInput!
condition - ModelOccupancySubTypeConditionInput

Example

Query
mutation createOccupancySubType(
  $input: CreateOccupancySubTypeInput!,
  $condition: ModelOccupancySubTypeConditionInput
) {
  createOccupancySubType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    occupancyTypeId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateOccupancySubTypeInput,
  "condition": ModelOccupancySubTypeConditionInput
}
Response
{
  "data": {
    "createOccupancySubType": {
      "id": 4,
      "name": "abc123",
      "companyId": "abc123",
      "occupancyTypeId": "abc123",
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createOccupancyType

Response

Returns an OccupancyType

Arguments
Name Description
input - CreateOccupancyTypeInput!
condition - ModelOccupancyTypeConditionInput

Example

Query
mutation createOccupancyType(
  $input: CreateOccupancyTypeInput!,
  $condition: ModelOccupancyTypeConditionInput
) {
  createOccupancyType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateOccupancyTypeInput,
  "condition": ModelOccupancyTypeConditionInput
}
Response
{
  "data": {
    "createOccupancyType": {
      "id": 4,
      "name": "xyz789",
      "companyId": "xyz789",
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createOrganization

Response

Returns an Organization

Arguments
Name Description
input - CreateOrganizationInput!

Example

Query
mutation createOrganization($input: CreateOrganizationInput!) {
  createOrganization(input: $input) {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    accountStatus
    subscriptionStart
    subscriptionEnd
    userCount
    enabledModules
    modules
    _version
    _lastChangedAt
  }
}
Variables
{"input": CreateOrganizationInput}
Response
{
  "data": {
    "createOrganization": {
      "id": 4,
      "name": "abc123",
      "address": Address,
      "country": "xyz789",
      "phone": "xyz789",
      "fax": "xyz789",
      "accountStatus": "xyz789",
      "subscriptionStart": AWSDateTime,
      "subscriptionEnd": AWSDateTime,
      "userCount": 123,
      "enabledModules": "abc123",
      "modules": ["CHANGE_ORDER_REQUEST"],
      "_version": 987,
      "_lastChangedAt": AWSTimestamp
    }
  }
}

createPdfForDailyReport

Response

Returns a PreSignedLink

Arguments
Name Description
input - CreatePdfForDailyReportInput!

Example

Query
mutation createPdfForDailyReport($input: CreatePdfForDailyReportInput!) {
  createPdfForDailyReport(input: $input) {
    link
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
  }
}
Variables
{"input": CreatePdfForDailyReportInput}
Response
{
  "data": {
    "createPdfForDailyReport": {
      "link": "abc123",
      "createdAt": "abc123",
      "expiresAt": "abc123",
      "headers": [Header]
    }
  }
}

createPdfForFieldNote

Response

Returns a String

Arguments
Name Description
input - CreatePdfForFieldNoteInput!

Example

Query
mutation createPdfForFieldNote($input: CreatePdfForFieldNoteInput!) {
  createPdfForFieldNote(input: $input)
}
Variables
{"input": CreatePdfForFieldNoteInput}
Response
{
  "data": {
    "createPdfForFieldNote": "xyz789"
  }
}

createPdfForRfi

Response

Returns a PreSignedLink

Arguments
Name Description
input - CreatePdfForRfiInput!

Example

Query
mutation createPdfForRfi($input: CreatePdfForRfiInput!) {
  createPdfForRfi(input: $input) {
    link
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
  }
}
Variables
{"input": CreatePdfForRfiInput}
Response
{
  "data": {
    "createPdfForRfi": {
      "link": "xyz789",
      "createdAt": "abc123",
      "expiresAt": "xyz789",
      "headers": [Header]
    }
  }
}

createPermissionGroup

Response

Returns [PermissionGroup]

Arguments
Name Description
input - CreatePermissionGroupInput!

Example

Query
mutation createPermissionGroup($input: CreatePermissionGroupInput!) {
  createPermissionGroup(input: $input) {
    id
    name
    permissions {
      ...PermissionFragment
    }
  }
}
Variables
{"input": CreatePermissionGroupInput}
Response
{
  "data": {
    "createPermissionGroup": [
      {
        "id": "4",
        "name": "xyz789",
        "permissions": [Permission]
      }
    ]
  }
}

createProject

Response

Returns a Project

Arguments
Name Description
input - CreateProjectInput!
condition - ModelProjectConditionInput

Example

Query
mutation createProject(
  $input: CreateProjectInput!,
  $condition: ModelProjectConditionInput
) {
  createProject(
    input: $input,
    condition: $condition
  ) {
    address {
      ...AddressAllOptionalFragment
    }
    changeOrderRequestSettings {
      ...ProjectChangeOrderRequestSettingsFragment
    }
    comments
    company {
      ...CompanyFragment
    }
    companyId
    companyName
    contractCostInPennies
    contractNumber
    contractSoldBy
    contractType
    dailyReportSettings {
      ...ProjectDailyReportSettingsFragment
    }
    divisionId
    endDate
    id
    isPrimeContractor
    mailboxEmail
    marketAreaId
    name
    number
    occupancySubTypeId
    occupancyTypeId
    officeFaxNumber
    officePhoneNumber
    projectRateTemplateId
    rfiSettings {
      ...ProjectRFISettingsFragment
    }
    submittalSettings {
      ...SubmittalSettingsFragment
    }
    startDate
    status
    teams {
      ...ProjectTeamsFragment
    }
    timeSettings {
      ...ProjectTimeSettingsFragment
    }
    purchaseOrderSettings {
      ...ProjectPurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateProjectInput,
  "condition": ModelProjectConditionInput
}
Response
{
  "data": {
    "createProject": {
      "address": AddressAllOptional,
      "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
      "comments": "abc123",
      "company": Company,
      "companyId": "xyz789",
      "companyName": "xyz789",
      "contractCostInPennies": 987,
      "contractNumber": "abc123",
      "contractSoldBy": "xyz789",
      "contractType": "xyz789",
      "dailyReportSettings": ProjectDailyReportSettings,
      "divisionId": "abc123",
      "endDate": AWSDateTime,
      "id": 4,
      "isPrimeContractor": false,
      "mailboxEmail": "xyz789",
      "marketAreaId": "xyz789",
      "name": "xyz789",
      "number": "abc123",
      "occupancySubTypeId": "xyz789",
      "occupancyTypeId": "abc123",
      "officeFaxNumber": "abc123",
      "officePhoneNumber": "abc123",
      "projectRateTemplateId": "abc123",
      "rfiSettings": ProjectRFISettings,
      "submittalSettings": SubmittalSettings,
      "startDate": AWSDateTime,
      "status": "abc123",
      "teams": ProjectTeams,
      "timeSettings": ProjectTimeSettings,
      "purchaseOrderSettings": ProjectPurchaseOrderSettings,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createProjectCostCode

Response

Returns a ProjectCostCode

Arguments
Name Description
input - CreateProjectCostCodeInput!

Example

Query
mutation createProjectCostCode($input: CreateProjectCostCodeInput!) {
  createProjectCostCode(input: $input) {
    id
    projectId
    number
    name
    status
    categories
  }
}
Variables
{"input": CreateProjectCostCodeInput}
Response
{
  "data": {
    "createProjectCostCode": {
      "id": "4",
      "projectId": "xyz789",
      "number": "abc123",
      "name": "abc123",
      "status": "ACTIVE",
      "categories": ["LABOR"]
    }
  }
}

createProjectFile

Response

Returns an Attachment

Arguments
Name Description
input - CreateProjectFileInput!

Example

Query
mutation createProjectFile($input: CreateProjectFileInput!) {
  createProjectFile(input: $input) {
    id
    key
    link
    algorithm
    credential
    date
    token
    policy
    signature
  }
}
Variables
{"input": CreateProjectFileInput}
Response
{
  "data": {
    "createProjectFile": {
      "id": "abc123",
      "key": "abc123",
      "link": "abc123",
      "algorithm": "abc123",
      "credential": "abc123",
      "date": "xyz789",
      "token": "xyz789",
      "policy": "xyz789",
      "signature": "xyz789"
    }
  }
}

createProjectFolder

Response

Returns a Folder

Arguments
Name Description
input - CreateProjectFolderInput!

Example

Query
mutation createProjectFolder($input: CreateProjectFolderInput!) {
  createProjectFolder(input: $input) {
    id
    name
    parentId
    parentPath
    path
  }
}
Variables
{"input": CreateProjectFolderInput}
Response
{
  "data": {
    "createProjectFolder": {
      "id": "abc123",
      "name": "abc123",
      "parentId": "xyz789",
      "parentPath": "abc123",
      "path": "abc123"
    }
  }
}

createPurchaseOrder

Response

Returns a PurchaseOrder

Arguments
Name Description
input - CreatePurchaseOrderInput!

Example

Query
mutation createPurchaseOrder($input: CreatePurchaseOrderInput!) {
  createPurchaseOrder(input: $input) {
    id
    project {
      ...ProjectFragment
    }
    number
    date
    type
    description
    status
    vendor {
      ...ContactFragment
    }
    salesTaxRatePercent
    salesTaxAmountInPennies
    depositInPennies
    depositDate
    releaseDate
    billing {
      ...PurchaseOrderBillingFragment
    }
    shipping {
      ...PurchaseOrderShippingFragment
    }
    buyerNotes
    vendorNotes
    internalNotes
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
    lines {
      ...PurchaseOrderLinesFragment
    }
    receivings {
      ...PurchaseOrderReceivingsFragment
    }
    invoicedInPennies
    totalInPennies
    revision
  }
}
Variables
{"input": CreatePurchaseOrderInput}
Response
{
  "data": {
    "createPurchaseOrder": {
      "id": "abc123",
      "project": Project,
      "number": "xyz789",
      "date": AWSDateTime,
      "type": "PURCHASE_ORDER",
      "description": "abc123",
      "status": "DRAFT",
      "vendor": Contact,
      "salesTaxRatePercent": 123.45,
      "salesTaxAmountInPennies": 987,
      "depositInPennies": 123,
      "depositDate": AWSDateTime,
      "releaseDate": AWSDateTime,
      "billing": PurchaseOrderBilling,
      "shipping": PurchaseOrderShipping,
      "buyerNotes": "abc123",
      "vendorNotes": "xyz789",
      "internalNotes": "xyz789",
      "docs": [AttachmentV2],
      "images": [ResizedAttachment],
      "lines": PurchaseOrderLines,
      "receivings": PurchaseOrderReceivings,
      "invoicedInPennies": 123,
      "totalInPennies": 987,
      "revision": 987
    }
  }
}

createPurchaseOrderLine

Response

Returns a PurchaseOrderLine

Arguments
Name Description
input - CreatePurchaseOrderLineInput!

Example

Query
mutation createPurchaseOrderLine($input: CreatePurchaseOrderLineInput!) {
  createPurchaseOrderLine(input: $input) {
    id
    taxExempt
    number
    description
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    notes
    priceInPennies
    per
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    quantityOrdered
    totalInPennies
    releaseDate
    created
  }
}
Variables
{"input": CreatePurchaseOrderLineInput}
Response
{
  "data": {
    "createPurchaseOrderLine": {
      "id": "xyz789",
      "taxExempt": false,
      "number": "abc123",
      "description": "xyz789",
      "projectCostCode": ProjectCostCode,
      "notes": "abc123",
      "priceInPennies": 987,
      "per": "abc123",
      "unitOfMeasure": UnitOfMeasure,
      "quantityOrdered": 123,
      "totalInPennies": 987,
      "releaseDate": AWSDateTime,
      "created": AWSDateTime
    }
  }
}

createPurchaseOrderReceiving

Response

Returns a PurchaseOrderReceiving

Arguments
Name Description
input - CreatePurchaseOrderReceivingInput!

Example

Query
mutation createPurchaseOrderReceiving($input: CreatePurchaseOrderReceivingInput!) {
  createPurchaseOrderReceiving(input: $input) {
    id
    purchaseOrderId
    date
    packingSlipNumber
    invoiceNumber
    invoiceAmountInPennies
    comments
    lines {
      ...PurchaseOrderReceivingLinesFragment
    }
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
  }
}
Variables
{"input": CreatePurchaseOrderReceivingInput}
Response
{
  "data": {
    "createPurchaseOrderReceiving": {
      "id": "abc123",
      "purchaseOrderId": "xyz789",
      "date": AWSDateTime,
      "packingSlipNumber": "xyz789",
      "invoiceNumber": "abc123",
      "invoiceAmountInPennies": 123,
      "comments": "xyz789",
      "lines": PurchaseOrderReceivingLines,
      "docs": [AttachmentV2],
      "images": [ResizedAttachment]
    }
  }
}

createPurchaseOrderReceivingLine

Response

Returns a PurchaseOrderReceivingLine

Arguments
Name Description
input - CreatePurchaseOrderReceivingLineInput!

Example

Query
mutation createPurchaseOrderReceivingLine($input: CreatePurchaseOrderReceivingLineInput!) {
  createPurchaseOrderReceivingLine(input: $input) {
    id
    receivingId
    purchaseOrderId
    lineNumber
    itemNumber
    itemDescription
    unitOfMeasureName
    totalOrdered
    previouslyReceived
    receivedToday
    total
    receivedInFull
    backOrdered
  }
}
Variables
{"input": CreatePurchaseOrderReceivingLineInput}
Response
{
  "data": {
    "createPurchaseOrderReceivingLine": {
      "id": "xyz789",
      "receivingId": "xyz789",
      "purchaseOrderId": "xyz789",
      "lineNumber": "xyz789",
      "itemNumber": "abc123",
      "itemDescription": "abc123",
      "unitOfMeasureName": "abc123",
      "totalOrdered": 987,
      "previouslyReceived": 123,
      "receivedToday": 987,
      "total": 123,
      "receivedInFull": false,
      "backOrdered": 987
    }
  }
}

createPurchaseOrderRevision

Response

Returns a PurchaseOrder

Arguments
Name Description
input - CreatePurchaseOrderRevisionInput!

Example

Query
mutation createPurchaseOrderRevision($input: CreatePurchaseOrderRevisionInput!) {
  createPurchaseOrderRevision(input: $input) {
    id
    project {
      ...ProjectFragment
    }
    number
    date
    type
    description
    status
    vendor {
      ...ContactFragment
    }
    salesTaxRatePercent
    salesTaxAmountInPennies
    depositInPennies
    depositDate
    releaseDate
    billing {
      ...PurchaseOrderBillingFragment
    }
    shipping {
      ...PurchaseOrderShippingFragment
    }
    buyerNotes
    vendorNotes
    internalNotes
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
    lines {
      ...PurchaseOrderLinesFragment
    }
    receivings {
      ...PurchaseOrderReceivingsFragment
    }
    invoicedInPennies
    totalInPennies
    revision
  }
}
Variables
{"input": CreatePurchaseOrderRevisionInput}
Response
{
  "data": {
    "createPurchaseOrderRevision": {
      "id": "abc123",
      "project": Project,
      "number": "xyz789",
      "date": AWSDateTime,
      "type": "PURCHASE_ORDER",
      "description": "abc123",
      "status": "DRAFT",
      "vendor": Contact,
      "salesTaxRatePercent": 123.45,
      "salesTaxAmountInPennies": 987,
      "depositInPennies": 123,
      "depositDate": AWSDateTime,
      "releaseDate": AWSDateTime,
      "billing": PurchaseOrderBilling,
      "shipping": PurchaseOrderShipping,
      "buyerNotes": "xyz789",
      "vendorNotes": "abc123",
      "internalNotes": "abc123",
      "docs": [AttachmentV2],
      "images": [ResizedAttachment],
      "lines": PurchaseOrderLines,
      "receivings": PurchaseOrderReceivings,
      "invoicedInPennies": 123,
      "totalInPennies": 987,
      "revision": 987
    }
  }
}

createRateTemplate

Response

Returns a RateTemplate

Arguments
Name Description
input - CreateRateTemplateInput!

Example

Query
mutation createRateTemplate($input: CreateRateTemplateInput!) {
  createRateTemplate(input: $input) {
    id
    name
    companyId
    shift2 {
      ...ShiftDifferentialFragment
    }
    shift3 {
      ...ShiftDifferentialFragment
    }
    laborClasses {
      ...RateLaborClassesFragment
    }
    status
  }
}
Variables
{"input": CreateRateTemplateInput}
Response
{
  "data": {
    "createRateTemplate": {
      "id": "xyz789",
      "name": "abc123",
      "companyId": "xyz789",
      "shift2": ShiftDifferential,
      "shift3": ShiftDifferential,
      "laborClasses": RateLaborClasses,
      "status": "ACTIVE"
    }
  }
}

createRfi

Response

Returns a Rfi

Arguments
Name Description
input - CreateRfiInput!
condition - ModelRfiConditionInput

Example

Query
mutation createRfi(
  $input: CreateRfiInput!,
  $condition: ModelRfiConditionInput
) {
  createRfi(
    input: $input,
    condition: $condition
  ) {
    gcFileNumber
    gcNumber
    attachments {
      ...AttachmentsFragment
    }
    author {
      ...AuthorFragment
    }
    respondByDate
    date
    id
    projectId
    dateV2
    authorV2 {
      ...UserFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    revision
    customNo
    to {
      ...NestedContactFragment
    }
    subject
    respondByDateV2
    questionForClarification
    recommendedSolution
    isScheduleImpacted
    isCostImpacted
    isUrgent
    reference {
      ...RfiReferenceFragment
    }
    projectCostCodeAffected {
      ...ProjectCostCodeFragment
    }
    projectCostCodeAffectedNumber
    dateAnswered
    status
    statusComment
    answerToClarification
    driveAttachments {
      ...RfiAttachmentFragment
    }
    images {
      ...RfiImageFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateRfiInput,
  "condition": ModelRfiConditionInput
}
Response
{
  "data": {
    "createRfi": {
      "gcFileNumber": "xyz789",
      "gcNumber": "xyz789",
      "attachments": Attachments,
      "author": Author,
      "respondByDate": AWSDate,
      "date": AWSDate,
      "id": "4",
      "projectId": "abc123",
      "dateV2": AWSDateTime,
      "authorV2": User,
      "lastEditedBy": Author,
      "revision": 987,
      "customNo": "xyz789",
      "to": [NestedContact],
      "subject": "abc123",
      "respondByDateV2": AWSDateTime,
      "questionForClarification": "abc123",
      "recommendedSolution": "xyz789",
      "isScheduleImpacted": false,
      "isCostImpacted": false,
      "isUrgent": false,
      "reference": RfiReference,
      "projectCostCodeAffected": ProjectCostCode,
      "projectCostCodeAffectedNumber": "abc123",
      "dateAnswered": AWSDateTime,
      "status": "PENDING",
      "statusComment": "xyz789",
      "answerToClarification": "abc123",
      "driveAttachments": [RfiAttachment],
      "images": [RfiImage],
      "emails": [Email],
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createRfiRevision

Response

Returns a RfiRevisionOutput

Arguments
Name Description
input - CreateRfiRevisionInput!

Example

Query
mutation createRfiRevision($input: CreateRfiRevisionInput!) {
  createRfiRevision(input: $input) {
    revision {
      ...RfiFragment
    }
    copyAttachmentsJobId
  }
}
Variables
{"input": CreateRfiRevisionInput}
Response
{
  "data": {
    "createRfiRevision": {
      "revision": Rfi,
      "copyAttachmentsJobId": "xyz789"
    }
  }
}

createRfiRevision2

Response

Returns a Rfi

Arguments
Name Description
input - CreateRfiRevisionInput!

Example

Query
mutation createRfiRevision2($input: CreateRfiRevisionInput!) {
  createRfiRevision2(input: $input) {
    gcFileNumber
    gcNumber
    attachments {
      ...AttachmentsFragment
    }
    author {
      ...AuthorFragment
    }
    respondByDate
    date
    id
    projectId
    dateV2
    authorV2 {
      ...UserFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    revision
    customNo
    to {
      ...NestedContactFragment
    }
    subject
    respondByDateV2
    questionForClarification
    recommendedSolution
    isScheduleImpacted
    isCostImpacted
    isUrgent
    reference {
      ...RfiReferenceFragment
    }
    projectCostCodeAffected {
      ...ProjectCostCodeFragment
    }
    projectCostCodeAffectedNumber
    dateAnswered
    status
    statusComment
    answerToClarification
    driveAttachments {
      ...RfiAttachmentFragment
    }
    images {
      ...RfiImageFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"input": CreateRfiRevisionInput}
Response
{
  "data": {
    "createRfiRevision2": {
      "gcFileNumber": "xyz789",
      "gcNumber": "abc123",
      "attachments": Attachments,
      "author": Author,
      "respondByDate": AWSDate,
      "date": AWSDate,
      "id": "4",
      "projectId": "xyz789",
      "dateV2": AWSDateTime,
      "authorV2": User,
      "lastEditedBy": Author,
      "revision": 987,
      "customNo": "xyz789",
      "to": [NestedContact],
      "subject": "xyz789",
      "respondByDateV2": AWSDateTime,
      "questionForClarification": "abc123",
      "recommendedSolution": "abc123",
      "isScheduleImpacted": false,
      "isCostImpacted": true,
      "isUrgent": false,
      "reference": RfiReference,
      "projectCostCodeAffected": ProjectCostCode,
      "projectCostCodeAffectedNumber": "xyz789",
      "dateAnswered": AWSDateTime,
      "status": "PENDING",
      "statusComment": "xyz789",
      "answerToClarification": "xyz789",
      "driveAttachments": [RfiAttachment],
      "images": [RfiImage],
      "emails": [Email],
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createSubmittalItem

Response

Returns a SubmittalItem

Arguments
Name Description
input - CreateSubmittalItemInput!

Example

Query
mutation createSubmittalItem($input: CreateSubmittalItemInput!) {
  createSubmittalItem(input: $input) {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Variables
{"input": CreateSubmittalItemInput}
Response
{
  "data": {
    "createSubmittalItem": {
      "created": "abc123",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "abc123",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "xyz789",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "abc123",
      "name": "xyz789",
      "notes": "abc123",
      "number": "xyz789",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 987,
      "specSection": "xyz789",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

createSubmittalItemPdfJob

Response

Returns a PdfJob

Arguments
Name Description
input - CreateSubmittalItemPdfJobInput!

Example

Query
mutation createSubmittalItemPdfJob($input: CreateSubmittalItemPdfJobInput!) {
  createSubmittalItemPdfJob(input: $input) {
    id
    status
    type
    created
    modified
    result {
      ...PreSignedLinkFragment
    }
  }
}
Variables
{"input": CreateSubmittalItemPdfJobInput}
Response
{
  "data": {
    "createSubmittalItemPdfJob": {
      "id": "abc123",
      "status": "CREATED",
      "type": "FIELD_NOTE",
      "created": "xyz789",
      "modified": "abc123",
      "result": PreSignedLink
    }
  }
}

createSubmittalItemRevision

Response

Returns a SubmittalItem

Arguments
Name Description
input - CreateSubmittalItemRevisionInput!

Example

Query
mutation createSubmittalItemRevision($input: CreateSubmittalItemRevisionInput!) {
  createSubmittalItemRevision(input: $input) {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Variables
{"input": CreateSubmittalItemRevisionInput}
Response
{
  "data": {
    "createSubmittalItemRevision": {
      "created": "abc123",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "abc123",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "xyz789",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "abc123",
      "name": "abc123",
      "notes": "xyz789",
      "number": "xyz789",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 123,
      "specSection": "xyz789",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

createSubmittalPackage

Response

Returns a SubmittalPackage

Arguments
Name Description
input - CreateSubmittalPackageInput!

Example

Query
mutation createSubmittalPackage($input: CreateSubmittalPackageInput!) {
  createSubmittalPackage(input: $input) {
    created
    dateSent
    description
    from {
      ...ContactFragment
    }
    id
    modified
    number
    name
    project {
      ...ProjectFragment
    }
    respondBy
    returnedOn
    status
    to {
      ...ContactFragment
    }
    submittalItems {
      ...SubmittalItemFragment
    }
    emails {
      ...EmailFragment
    }
  }
}
Variables
{"input": CreateSubmittalPackageInput}
Response
{
  "data": {
    "createSubmittalPackage": {
      "created": "xyz789",
      "dateSent": AWSDateTime,
      "description": "xyz789",
      "from": Contact,
      "id": "xyz789",
      "modified": "xyz789",
      "number": "abc123",
      "name": "abc123",
      "project": Project,
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "status": "DRAFT",
      "to": Contact,
      "submittalItems": [SubmittalItem],
      "emails": [Email]
    }
  }
}

createSubmittalPackagePdfJob

Response

Returns a PdfJob

Arguments
Name Description
input - CreateSubmittalPackagePdfJobInput!

Example

Query
mutation createSubmittalPackagePdfJob($input: CreateSubmittalPackagePdfJobInput!) {
  createSubmittalPackagePdfJob(input: $input) {
    id
    status
    type
    created
    modified
    result {
      ...PreSignedLinkFragment
    }
  }
}
Variables
{"input": CreateSubmittalPackagePdfJobInput}
Response
{
  "data": {
    "createSubmittalPackagePdfJob": {
      "id": "xyz789",
      "status": "CREATED",
      "type": "FIELD_NOTE",
      "created": "xyz789",
      "modified": "abc123",
      "result": PreSignedLink
    }
  }
}

createTimeCard

Response

Returns a TimeCard

Arguments
Name Description
input - CreateTimeCardInput!
condition - ModelTimeCardConditionInput

Example

Query
mutation createTimeCard(
  $input: CreateTimeCardInput!,
  $condition: ModelTimeCardConditionInput
) {
  createTimeCard(
    input: $input,
    condition: $condition
  ) {
    comments
    date
    doubleTimeInMinutes
    hoursLost
    id
    laborClass
    overTimeInMinutes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    project {
      ...ProjectFragment
    }
    regularTimeInMinutes
    shift
    status
    timeCardProjectCostCodeNumber
    timeCardDailyReportId
    units
    user {
      ...UserFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateTimeCardInput,
  "condition": ModelTimeCardConditionInput
}
Response
{
  "data": {
    "createTimeCard": {
      "comments": "xyz789",
      "date": AWSDateTime,
      "doubleTimeInMinutes": 123,
      "hoursLost": 123,
      "id": "4",
      "laborClass": "xyz789",
      "overTimeInMinutes": 987,
      "projectCostCode": ProjectCostCode,
      "project": Project,
      "regularTimeInMinutes": 123,
      "shift": "SHIFT1",
      "status": "PENDING",
      "timeCardProjectCostCodeNumber": "abc123",
      "timeCardDailyReportId": "abc123",
      "units": 123,
      "user": User,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createTimeCardMigration

Response

Returns a TimeCardMigration

Arguments
Name Description
input - CreateTimeCardMigrationInput!

Example

Query
mutation createTimeCardMigration($input: CreateTimeCardMigrationInput!) {
  createTimeCardMigration(input: $input) {
    id
    timeCardProjectCostCodeNumber
    timeCardDailyReportId
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    user {
      ...UserFragment
    }
    project {
      ...ProjectFragment
    }
    date
    regularTimeInMinutes
    overTimeInMinutes
    doubleTimeInMinutes
    shift
    hoursLost
    units
    comments
    status
    laborClass
  }
}
Variables
{"input": CreateTimeCardMigrationInput}
Response
{
  "data": {
    "createTimeCardMigration": {
      "id": "4",
      "timeCardProjectCostCodeNumber": "xyz789",
      "timeCardDailyReportId": "abc123",
      "projectCostCode": ProjectCostCode,
      "user": User,
      "project": Project,
      "date": AWSDateTime,
      "regularTimeInMinutes": 987,
      "overTimeInMinutes": 123,
      "doubleTimeInMinutes": 987,
      "shift": "SHIFT1",
      "hoursLost": 123,
      "units": 987,
      "comments": "xyz789",
      "status": "PENDING",
      "laborClass": "abc123"
    }
  }
}

createUnitOfMeasure

Response

Returns a UnitOfMeasure

Arguments
Name Description
input - CreateUnitOfMeasureInput!

Example

Query
mutation createUnitOfMeasure($input: CreateUnitOfMeasureInput!) {
  createUnitOfMeasure(input: $input) {
    id
    companyId
    name
    abbreviation
  }
}
Variables
{"input": CreateUnitOfMeasureInput}
Response
{
  "data": {
    "createUnitOfMeasure": {
      "id": 4,
      "companyId": "abc123",
      "name": "xyz789",
      "abbreviation": "xyz789"
    }
  }
}

createUploadLinkForChangeOrderRequest

Arguments
Name Description
input - CreateUploadLinkForChangeOrderRequestInput!

Example

Query
mutation createUploadLinkForChangeOrderRequest($input: CreateUploadLinkForChangeOrderRequestInput!) {
  createUploadLinkForChangeOrderRequest(input: $input) {
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
    id
    link
  }
}
Variables
{"input": CreateUploadLinkForChangeOrderRequestInput}
Response
{
  "data": {
    "createUploadLinkForChangeOrderRequest": {
      "createdAt": "xyz789",
      "expiresAt": "abc123",
      "headers": [Header],
      "id": "xyz789",
      "link": "xyz789"
    }
  }
}

createUploadLinkForCompanyDrive

Response

Returns a DriveUploadLink

Arguments
Name Description
input - CreateUploadLinkForCompanyDriveInput!

Example

Query
mutation createUploadLinkForCompanyDrive($input: CreateUploadLinkForCompanyDriveInput!) {
  createUploadLinkForCompanyDrive(input: $input) {
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
    id
    link
  }
}
Variables
{"input": CreateUploadLinkForCompanyDriveInput}
Response
{
  "data": {
    "createUploadLinkForCompanyDrive": {
      "createdAt": "xyz789",
      "expiresAt": "xyz789",
      "headers": [Header],
      "id": "abc123",
      "link": "xyz789"
    }
  }
}

createUploadLinkForPOReceiving

Arguments
Name Description
input - CreateUploadLinkForPOReceivingInput!

Example

Query
mutation createUploadLinkForPOReceiving($input: CreateUploadLinkForPOReceivingInput!) {
  createUploadLinkForPOReceiving(input: $input) {
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
    id
    link
  }
}
Variables
{"input": CreateUploadLinkForPOReceivingInput}
Response
{
  "data": {
    "createUploadLinkForPOReceiving": {
      "createdAt": "abc123",
      "expiresAt": "abc123",
      "headers": [Header],
      "id": "xyz789",
      "link": "abc123"
    }
  }
}

createUploadLinkForProjectDrive

Response

Returns a DriveUploadLink

Arguments
Name Description
input - CreateUploadLinkForProjectDriveInput!

Example

Query
mutation createUploadLinkForProjectDrive($input: CreateUploadLinkForProjectDriveInput!) {
  createUploadLinkForProjectDrive(input: $input) {
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
    id
    link
  }
}
Variables
{"input": CreateUploadLinkForProjectDriveInput}
Response
{
  "data": {
    "createUploadLinkForProjectDrive": {
      "createdAt": "xyz789",
      "expiresAt": "xyz789",
      "headers": [Header],
      "id": "xyz789",
      "link": "xyz789"
    }
  }
}

createUploadLinkForPurchaseOrder

Arguments
Name Description
input - CreateUploadLinkForPurchaseOrderInput!

Example

Query
mutation createUploadLinkForPurchaseOrder($input: CreateUploadLinkForPurchaseOrderInput!) {
  createUploadLinkForPurchaseOrder(input: $input) {
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
    id
    link
  }
}
Variables
{"input": CreateUploadLinkForPurchaseOrderInput}
Response
{
  "data": {
    "createUploadLinkForPurchaseOrder": {
      "createdAt": "xyz789",
      "expiresAt": "xyz789",
      "headers": [Header],
      "id": "abc123",
      "link": "abc123"
    }
  }
}

createUploadLinkForRfi

Response

Returns a RfiAttachmentUploadLink

Arguments
Name Description
input - CreateUploadLinkForRfiInput!

Example

Query
mutation createUploadLinkForRfi($input: CreateUploadLinkForRfiInput!) {
  createUploadLinkForRfi(input: $input) {
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
    id
    link
  }
}
Variables
{"input": CreateUploadLinkForRfiInput}
Response
{
  "data": {
    "createUploadLinkForRfi": {
      "createdAt": "xyz789",
      "expiresAt": "xyz789",
      "headers": [Header],
      "id": "xyz789",
      "link": "xyz789"
    }
  }
}

createUploadLinkForSubmittal

Response

Returns a SubmittalAttachmentUploadLink

Arguments
Name Description
input - CreateUploadLinkForSubmittalInput!

Example

Query
mutation createUploadLinkForSubmittal($input: CreateUploadLinkForSubmittalInput!) {
  createUploadLinkForSubmittal(input: $input) {
    createdAt
    expiresAt
    headers {
      ...HeaderFragment
    }
    id
    link
  }
}
Variables
{"input": CreateUploadLinkForSubmittalInput}
Response
{
  "data": {
    "createUploadLinkForSubmittal": {
      "createdAt": "abc123",
      "expiresAt": "abc123",
      "headers": [Header],
      "id": "xyz789",
      "link": "xyz789"
    }
  }
}

createUser

Response

Returns a User

Arguments
Name Description
input - CreateUserInput!
condition - ModelUserConditionInput

Example

Query
mutation createUser(
  $input: CreateUserInput!,
  $condition: ModelUserConditionInput
) {
  createUser(
    input: $input,
    condition: $condition
  ) {
    id
    orgId
    companyAssociations
    defaultCompany
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AddressAllOptionalFragment
    }
    country
    useCompanyAddress
    emailSignature
    crew
    primaryLaborClass
    languagePreference
    dateDisplayPreference
    permissionGroup
    permissionGroupName
    accessLevel
    crewStatus
    type
    loginStatus
    addToNewProjects
    contact {
      ...ContactFragment
    }
    laborClassId
    laborClass {
      ...LaborClassFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateUserInput,
  "condition": ModelUserConditionInput
}
Response
{
  "data": {
    "createUser": {
      "id": "4",
      "orgId": "abc123",
      "companyAssociations": ["abc123"],
      "defaultCompany": "abc123",
      "givenName": "abc123",
      "middleName": "abc123",
      "familyName": "abc123",
      "email": "xyz789",
      "employeeNo": "abc123",
      "role": "abc123",
      "jobTitle": "abc123",
      "officeNo": "xyz789",
      "mobileNo": "abc123",
      "faxNo": "abc123",
      "address": AddressAllOptional,
      "country": "abc123",
      "useCompanyAddress": false,
      "emailSignature": "abc123",
      "crew": false,
      "primaryLaborClass": "abc123",
      "languagePreference": "xyz789",
      "dateDisplayPreference": "xyz789",
      "permissionGroup": "abc123",
      "permissionGroupName": "xyz789",
      "accessLevel": "xyz789",
      "crewStatus": "AVAILABLE",
      "type": "STANDARD",
      "loginStatus": "ACTIVE",
      "addToNewProjects": false,
      "contact": Contact,
      "laborClassId": "xyz789",
      "laborClass": LaborClass,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createVersionSet

Response

Returns a VersionSet

Arguments
Name Description
input - CreateVersionSetInput!

Example

Query
mutation createVersionSet($input: CreateVersionSetInput!) {
  createVersionSet(input: $input) {
    id
    createdBy {
      ...UserFragment
    }
    dateIssued
    project {
      ...ProjectFragment
    }
    name
  }
}
Variables
{"input": CreateVersionSetInput}
Response
{
  "data": {
    "createVersionSet": {
      "id": "xyz789",
      "createdBy": User,
      "dateIssued": AWSDateTime,
      "project": Project,
      "name": "xyz789"
    }
  }
}

createWeatherType

Response

Returns a WeatherType

Arguments
Name Description
input - CreateWeatherTypeInput!
condition - ModelWeatherTypeConditionInput

Example

Query
mutation createWeatherType(
  $input: CreateWeatherTypeInput!,
  $condition: ModelWeatherTypeConditionInput
) {
  createWeatherType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateWeatherTypeInput,
  "condition": ModelWeatherTypeConditionInput
}
Response
{
  "data": {
    "createWeatherType": {
      "id": 4,
      "name": "xyz789",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

createWindType

Response

Returns a WindType

Arguments
Name Description
input - CreateWindTypeInput!
condition - ModelWindTypeConditionInput

Example

Query
mutation createWindType(
  $input: CreateWindTypeInput!,
  $condition: ModelWindTypeConditionInput
) {
  createWindType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": CreateWindTypeInput,
  "condition": ModelWindTypeConditionInput
}
Response
{
  "data": {
    "createWindType": {
      "id": "4",
      "name": "xyz789",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteAdminCompany

Response

Returns a Boolean

Arguments
Name Description
input - DeleteAdminCompanyInput!

Example

Query
mutation deleteAdminCompany($input: DeleteAdminCompanyInput!) {
  deleteAdminCompany(input: $input)
}
Variables
{"input": DeleteAdminCompanyInput}
Response
{"data": {"deleteAdminCompany": false}}

deleteChangeOrderRequest

Response

Returns a ChangeOrderRequest

Arguments
Name Description
input - DeleteChangeOrderRequestInput!

Example

Query
mutation deleteChangeOrderRequest($input: DeleteChangeOrderRequestInput!) {
  deleteChangeOrderRequest(input: $input) {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Variables
{"input": DeleteChangeOrderRequestInput}
Response
{
  "data": {
    "deleteChangeOrderRequest": {
      "approvalNumber": "xyz789",
      "approvedAmountInPennies": 123,
      "created": "abc123",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 123,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "xyz789",
      "images": [ResizedAttachment],
      "internalNotes": "xyz789",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "abc123",
      "name": "abc123",
      "number": "abc123",
      "project": Project,
      "referenceNumberAsi": "xyz789",
      "referenceNumberGcCor": "xyz789",
      "referenceNumberOther": "xyz789",
      "referenceNumberOwnerCor": "xyz789",
      "referenceNumberPco": "xyz789",
      "referenceNumberRfi": "abc123",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 987,
      "scheduleImpactComments": "xyz789",
      "scheduleImpactDays": 987,
      "scopeOfWork": "xyz789",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

deleteChangeOrderRequestAttachment

Response

Returns a Boolean

Arguments
Name Description
input - DeleteChangeOrderRequestAttachmentInput!

Example

Query
mutation deleteChangeOrderRequestAttachment($input: DeleteChangeOrderRequestAttachmentInput!) {
  deleteChangeOrderRequestAttachment(input: $input)
}
Variables
{"input": DeleteChangeOrderRequestAttachmentInput}
Response
{"data": {"deleteChangeOrderRequestAttachment": false}}

deleteChangeOrderRequestEquipmentLineItem

Arguments
Name Description
input - DeleteChangeOrderRequestEquipmentLineItemInput!

Example

Query
mutation deleteChangeOrderRequestEquipmentLineItem($input: DeleteChangeOrderRequestEquipmentLineItemInput!) {
  deleteChangeOrderRequestEquipmentLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customEquipment
  }
}
Variables
{"input": DeleteChangeOrderRequestEquipmentLineItemInput}
Response
{
  "data": {
    "deleteChangeOrderRequestEquipmentLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "abc123",
      "rateInPennies": 123,
      "sellPriceInPennies": 987,
      "quantity": 123.45,
      "customEquipment": "xyz789"
    }
  }
}

deleteChangeOrderRequestLaborLineItem

Response

Returns a ChangeOrderRequestLaborLineItem

Arguments
Name Description
input - DeleteChangeOrderRequestLaborLineItemInput!

Example

Query
mutation deleteChangeOrderRequestLaborLineItem($input: DeleteChangeOrderRequestLaborLineItemInput!) {
  deleteChangeOrderRequestLaborLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customLaborClass
    hoursInMinutes
    laborClass {
      ...LaborClassFragment
    }
    rateInPennies
    sellRateInPennies
    workers
  }
}
Variables
{"input": DeleteChangeOrderRequestLaborLineItemInput}
Response
{
  "data": {
    "deleteChangeOrderRequestLaborLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customLaborClass": "xyz789",
      "hoursInMinutes": 123,
      "laborClass": LaborClass,
      "rateInPennies": 987,
      "sellRateInPennies": 123,
      "workers": 987.65
    }
  }
}

deleteChangeOrderRequestMaterialLineItem

Arguments
Name Description
input - DeleteChangeOrderRequestMaterialLineItemInput!

Example

Query
mutation deleteChangeOrderRequestMaterialLineItem($input: DeleteChangeOrderRequestMaterialLineItemInput!) {
  deleteChangeOrderRequestMaterialLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customMaterial
  }
}
Variables
{"input": DeleteChangeOrderRequestMaterialLineItemInput}
Response
{
  "data": {
    "deleteChangeOrderRequestMaterialLineItem": {
      "costInPennies": 987,
      "id": "abc123",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "xyz789",
      "rateInPennies": 123,
      "sellPriceInPennies": 987,
      "quantity": 987.65,
      "customMaterial": "abc123"
    }
  }
}

deleteChangeOrderRequestOtherLineItem

Response

Returns a ChangeOrderRequestOtherLineItem

Arguments
Name Description
input - DeleteChangeOrderRequestOtherLineItemInput!

Example

Query
mutation deleteChangeOrderRequestOtherLineItem($input: DeleteChangeOrderRequestOtherLineItemInput!) {
  deleteChangeOrderRequestOtherLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{"input": DeleteChangeOrderRequestOtherLineItemInput}
Response
{
  "data": {
    "deleteChangeOrderRequestOtherLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 987.65,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "abc123",
      "priceInPennies": 123,
      "quantity": 987.65,
      "sellPriceInPennies": 987,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

deleteChangeOrderRequestOverheadLineItem

Arguments
Name Description
input - DeleteChangeOrderRequestOverheadLineItemInput!

Example

Query
mutation deleteChangeOrderRequestOverheadLineItem($input: DeleteChangeOrderRequestOverheadLineItemInput!) {
  deleteChangeOrderRequestOverheadLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{"input": DeleteChangeOrderRequestOverheadLineItemInput}
Response
{
  "data": {
    "deleteChangeOrderRequestOverheadLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "abc123",
      "description": "abc123",
      "priceInPennies": 123,
      "quantity": 123.45,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

deleteChangeOrderRequestSubcontractorLineItem

Example

Query
mutation deleteChangeOrderRequestSubcontractorLineItem($input: DeleteChangeOrderRequestSubcontractorLineItemInput!) {
  deleteChangeOrderRequestSubcontractorLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{
  "input": DeleteChangeOrderRequestSubcontractorLineItemInput
}
Response
{
  "data": {
    "deleteChangeOrderRequestSubcontractorLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "abc123",
      "description": "xyz789",
      "priceInPennies": 987,
      "quantity": 123.45,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

deleteCompanyCostCode

Response

Returns a CompanyCostCode

Arguments
Name Description
input - DeleteCompanyCostCodeInput!

Example

Query
mutation deleteCompanyCostCode($input: DeleteCompanyCostCodeInput!) {
  deleteCompanyCostCode(input: $input) {
    id
    companyId
    number
    name
    status
    categories
    addToNewProjects
    projectCostCodes {
      ...ProjectCostCodesFragment
    }
  }
}
Variables
{"input": DeleteCompanyCostCodeInput}
Response
{
  "data": {
    "deleteCompanyCostCode": {
      "id": "4",
      "companyId": "abc123",
      "number": "xyz789",
      "name": "abc123",
      "status": "ACTIVE",
      "categories": ["LABOR"],
      "addToNewProjects": false,
      "projectCostCodes": ProjectCostCodes
    }
  }
}

deleteCompanyFile

Response

Returns a File

Arguments
Name Description
input - DeleteCompanyFileInput!

Example

Query
mutation deleteCompanyFile($input: DeleteCompanyFileInput!) {
  deleteCompanyFile(input: $input) {
    id
    link {
      ...AttachmentDownloadLinkFragment
    }
    name
    parentId
    parentPath
    path
    sizeInBytes
    tags {
      ...DriveTagFragment
    }
  }
}
Variables
{"input": DeleteCompanyFileInput}
Response
{
  "data": {
    "deleteCompanyFile": {
      "id": "abc123",
      "link": AttachmentDownloadLink,
      "name": "abc123",
      "parentId": "xyz789",
      "parentPath": "xyz789",
      "path": "abc123",
      "sizeInBytes": 987,
      "tags": [DriveTag]
    }
  }
}

deleteCompanyFolder

Response

Returns a Folder

Arguments
Name Description
input - DeleteCompanyFolderInput!

Example

Query
mutation deleteCompanyFolder($input: DeleteCompanyFolderInput!) {
  deleteCompanyFolder(input: $input) {
    id
    name
    parentId
    parentPath
    path
  }
}
Variables
{"input": DeleteCompanyFolderInput}
Response
{
  "data": {
    "deleteCompanyFolder": {
      "id": "abc123",
      "name": "xyz789",
      "parentId": "abc123",
      "parentPath": "xyz789",
      "path": "xyz789"
    }
  }
}

deleteContact

Response

Returns a Contact

Arguments
Name Description
input - DeleteContactInput!
condition - ModelContactConditionInput

Example

Query
mutation deleteContact(
  $input: DeleteContactInput!,
  $condition: ModelContactConditionInput
) {
  deleteContact(
    input: $input,
    condition: $condition
  ) {
    id
    firstName
    middleName
    lastName
    jobTitle
    email
    address {
      ...AddressAllOptionalFragment
    }
    country
    office
    mobile
    fax
    notes
    businessName
    businessType
    status
    apVendor
    vendorId
    website
    cannotDelete
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteContactInput,
  "condition": ModelContactConditionInput
}
Response
{
  "data": {
    "deleteContact": {
      "id": 4,
      "firstName": "xyz789",
      "middleName": "xyz789",
      "lastName": "abc123",
      "jobTitle": "xyz789",
      "email": "xyz789",
      "address": AddressAllOptional,
      "country": "xyz789",
      "office": "xyz789",
      "mobile": "abc123",
      "fax": "xyz789",
      "notes": "abc123",
      "businessName": "xyz789",
      "businessType": "abc123",
      "status": "AVAILABLE",
      "apVendor": true,
      "vendorId": "xyz789",
      "website": "abc123",
      "cannotDelete": false,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteDailyReport

Response

Returns a DailyReport

Arguments
Name Description
input - DeleteDailyReportInput!
condition - ModelDailyReportConditionInput

Example

Query
mutation deleteDailyReport(
  $input: DeleteDailyReportInput!,
  $condition: ModelDailyReportConditionInput
) {
  deleteDailyReport(
    input: $input,
    condition: $condition
  ) {
    id
    projectId
    customNo
    date
    timeOnSite
    timeOffSite
    totalWorkers
    author
    authorId
    weatherConditions {
      ...WeatherFragment
    }
    weather
    wind
    temperature
    workPerformed
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    issues
    favors
    accidents
    subcontractorsWorked
    visitors
    comments
    notes
    internalComments
    weatherComments
    lastEditedBy
    attachments {
      ...AttachmentsFragment
    }
    docs {
      ...DocsFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteDailyReportInput,
  "condition": ModelDailyReportConditionInput
}
Response
{
  "data": {
    "deleteDailyReport": {
      "id": "4",
      "projectId": "xyz789",
      "customNo": "xyz789",
      "date": AWSDateTime,
      "timeOnSite": AWSDateTime,
      "timeOffSite": AWSDateTime,
      "totalWorkers": 987,
      "author": "abc123",
      "authorId": "xyz789",
      "weatherConditions": Weather,
      "weather": "abc123",
      "wind": "abc123",
      "temperature": 987,
      "workPerformed": "abc123",
      "keywords": ["xyz789"],
      "listOfKeywords": [NestedKeywords],
      "issues": "xyz789",
      "favors": "xyz789",
      "accidents": "xyz789",
      "subcontractorsWorked": "abc123",
      "visitors": "abc123",
      "comments": "abc123",
      "notes": "xyz789",
      "internalComments": "abc123",
      "weatherComments": "abc123",
      "lastEditedBy": "abc123",
      "attachments": Attachments,
      "docs": Docs,
      "emails": [Email],
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteEmail

Response

Returns an Email

Arguments
Name Description
input - DeleteEmailInput!

Example

Query
mutation deleteEmail($input: DeleteEmailInput!) {
  deleteEmail(input: $input) {
    id
    author {
      ...AuthorFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    boxType
    dateSent
    dateReceived
    isUrgent
    hasBeenRead
    subject
    from {
      ...EmailAddressFragment
    }
    to {
      ...EmailAddressFragment
    }
    cc {
      ...EmailAddressFragment
    }
    bcc {
      ...EmailAddressFragment
    }
    text
    html
    emailLink
    documents {
      ...DocumentAttachmentFragment
    }
    images {
      ...ImageAttachmentFragment
    }
    linkedDocument {
      ...LinkedDocumentFragment
    }
  }
}
Variables
{"input": DeleteEmailInput}
Response
{
  "data": {
    "deleteEmail": {
      "id": 4,
      "author": Author,
      "lastEditedBy": Author,
      "boxType": "INBOX",
      "dateSent": AWSDateTime,
      "dateReceived": AWSDateTime,
      "isUrgent": true,
      "hasBeenRead": true,
      "subject": "xyz789",
      "from": EmailAddress,
      "to": [EmailAddress],
      "cc": [EmailAddress],
      "bcc": [EmailAddress],
      "text": "abc123",
      "html": "abc123",
      "emailLink": "abc123",
      "documents": [DocumentAttachment],
      "images": [ImageAttachment],
      "linkedDocument": LinkedDocument
    }
  }
}

deleteEntityAssignment

Response

Returns an EntityAssignment

Arguments
Name Description
input - DeleteEntityAssignmentInput!
condition - ModelEntityAssignmentConditionInput

Example

Query
mutation deleteEntityAssignment(
  $input: DeleteEntityAssignmentInput!,
  $condition: ModelEntityAssignmentConditionInput
) {
  deleteEntityAssignment(
    input: $input,
    condition: $condition
  ) {
    id
    entityId
    userId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteEntityAssignmentInput,
  "condition": ModelEntityAssignmentConditionInput
}
Response
{
  "data": {
    "deleteEntityAssignment": {
      "id": "4",
      "entityId": "4",
      "userId": "4",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteFieldNote

Response

Returns a FieldNote

Arguments
Name Description
input - DeleteFieldNoteInput!
condition - ModelFieldNoteConditionInput

Example

Query
mutation deleteFieldNote(
  $input: DeleteFieldNoteInput!,
  $condition: ModelFieldNoteConditionInput
) {
  deleteFieldNote(
    input: $input,
    condition: $condition
  ) {
    id
    note
    createdOnDeviceAt
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    locationTags {
      ...NestedLocationTagFragment
    }
    address {
      ...AddressFragment
    }
    phase
    system
    attachments {
      ...AttachmentsFragment
    }
    createdByUsername
    createdByUserId
    projectId
    docs {
      ...DocsFragment
    }
    lastUpdatedByUsername
    lastUpdatedByUserId
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteFieldNoteInput,
  "condition": ModelFieldNoteConditionInput
}
Response
{
  "data": {
    "deleteFieldNote": {
      "id": 4,
      "note": "xyz789",
      "createdOnDeviceAt": AWSDateTime,
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "locationTags": [NestedLocationTag],
      "address": Address,
      "phase": "xyz789",
      "system": "abc123",
      "attachments": Attachments,
      "createdByUsername": "xyz789",
      "createdByUserId": "xyz789",
      "projectId": "abc123",
      "docs": Docs,
      "lastUpdatedByUsername": "xyz789",
      "lastUpdatedByUserId": "abc123",
      "emails": [Email],
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteKeyword

Response

Returns a Keyword

Arguments
Name Description
input - DeleteKeywordInput!
condition - ModelKeywordConditionInput

Example

Query
mutation deleteKeyword(
  $input: DeleteKeywordInput!,
  $condition: ModelKeywordConditionInput
) {
  deleteKeyword(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    status
    usageCount
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteKeywordInput,
  "condition": ModelKeywordConditionInput
}
Response
{
  "data": {
    "deleteKeyword": {
      "id": "4",
      "name": "xyz789",
      "companyId": "xyz789",
      "status": "AVAILABLE",
      "usageCount": 123,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteLaborClass

Response

Returns a LaborClass

Arguments
Name Description
input - DeleteLaborClassInput!

Example

Query
mutation deleteLaborClass($input: DeleteLaborClassInput!) {
  deleteLaborClass(input: $input) {
    id
    companyId
    name
    status
  }
}
Variables
{"input": DeleteLaborClassInput}
Response
{
  "data": {
    "deleteLaborClass": {
      "id": "xyz789",
      "companyId": "abc123",
      "name": "xyz789",
      "status": "ACTIVE"
    }
  }
}

deleteLocationTag

Response

Returns a LocationTag

Arguments
Name Description
input - DeleteLocationTagInput!
condition - ModelLocationTagConditionInput

Example

Query
mutation deleteLocationTag(
  $input: DeleteLocationTagInput!,
  $condition: ModelLocationTagConditionInput
) {
  deleteLocationTag(
    input: $input,
    condition: $condition
  ) {
    id
    name
    projectId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteLocationTagInput,
  "condition": ModelLocationTagConditionInput
}
Response
{
  "data": {
    "deleteLocationTag": {
      "id": 4,
      "name": "abc123",
      "projectId": "abc123",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteOccupancySubType

Response

Returns an OccupancySubType

Arguments
Name Description
input - DeleteOccupancySubTypeInput!
condition - ModelOccupancySubTypeConditionInput

Example

Query
mutation deleteOccupancySubType(
  $input: DeleteOccupancySubTypeInput!,
  $condition: ModelOccupancySubTypeConditionInput
) {
  deleteOccupancySubType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    occupancyTypeId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteOccupancySubTypeInput,
  "condition": ModelOccupancySubTypeConditionInput
}
Response
{
  "data": {
    "deleteOccupancySubType": {
      "id": 4,
      "name": "xyz789",
      "companyId": "abc123",
      "occupancyTypeId": "abc123",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteOccupancyType

Response

Returns an OccupancyType

Arguments
Name Description
input - DeleteOccupancyTypeInput!
condition - ModelOccupancyTypeConditionInput

Example

Query
mutation deleteOccupancyType(
  $input: DeleteOccupancyTypeInput!,
  $condition: ModelOccupancyTypeConditionInput
) {
  deleteOccupancyType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteOccupancyTypeInput,
  "condition": ModelOccupancyTypeConditionInput
}
Response
{
  "data": {
    "deleteOccupancyType": {
      "id": 4,
      "name": "abc123",
      "companyId": "abc123",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteOrganization

Response

Returns a Boolean

Arguments
Name Description
input - DeleteOrganizationInput!

Example

Query
mutation deleteOrganization($input: DeleteOrganizationInput!) {
  deleteOrganization(input: $input)
}
Variables
{"input": DeleteOrganizationInput}
Response
{"data": {"deleteOrganization": true}}

deletePOReceivingAttachment

Response

Returns a Boolean

Arguments
Name Description
input - DeletePOReceivingAttachmentInput!

Example

Query
mutation deletePOReceivingAttachment($input: DeletePOReceivingAttachmentInput!) {
  deletePOReceivingAttachment(input: $input)
}
Variables
{"input": DeletePOReceivingAttachmentInput}
Response
{"data": {"deletePOReceivingAttachment": true}}

deletePermissionGroup

Response

Returns a Boolean

Arguments
Name Description
input - DeletePermissionGroupInput!

Example

Query
mutation deletePermissionGroup($input: DeletePermissionGroupInput!) {
  deletePermissionGroup(input: $input)
}
Variables
{"input": DeletePermissionGroupInput}
Response
{"data": {"deletePermissionGroup": false}}

deleteProject

Response

Returns a Project

Arguments
Name Description
input - DeleteProjectInput!
condition - ModelProjectConditionInput

Example

Query
mutation deleteProject(
  $input: DeleteProjectInput!,
  $condition: ModelProjectConditionInput
) {
  deleteProject(
    input: $input,
    condition: $condition
  ) {
    address {
      ...AddressAllOptionalFragment
    }
    changeOrderRequestSettings {
      ...ProjectChangeOrderRequestSettingsFragment
    }
    comments
    company {
      ...CompanyFragment
    }
    companyId
    companyName
    contractCostInPennies
    contractNumber
    contractSoldBy
    contractType
    dailyReportSettings {
      ...ProjectDailyReportSettingsFragment
    }
    divisionId
    endDate
    id
    isPrimeContractor
    mailboxEmail
    marketAreaId
    name
    number
    occupancySubTypeId
    occupancyTypeId
    officeFaxNumber
    officePhoneNumber
    projectRateTemplateId
    rfiSettings {
      ...ProjectRFISettingsFragment
    }
    submittalSettings {
      ...SubmittalSettingsFragment
    }
    startDate
    status
    teams {
      ...ProjectTeamsFragment
    }
    timeSettings {
      ...ProjectTimeSettingsFragment
    }
    purchaseOrderSettings {
      ...ProjectPurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteProjectInput,
  "condition": ModelProjectConditionInput
}
Response
{
  "data": {
    "deleteProject": {
      "address": AddressAllOptional,
      "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
      "comments": "xyz789",
      "company": Company,
      "companyId": "xyz789",
      "companyName": "xyz789",
      "contractCostInPennies": 123,
      "contractNumber": "abc123",
      "contractSoldBy": "abc123",
      "contractType": "xyz789",
      "dailyReportSettings": ProjectDailyReportSettings,
      "divisionId": "xyz789",
      "endDate": AWSDateTime,
      "id": "4",
      "isPrimeContractor": false,
      "mailboxEmail": "xyz789",
      "marketAreaId": "xyz789",
      "name": "abc123",
      "number": "xyz789",
      "occupancySubTypeId": "abc123",
      "occupancyTypeId": "abc123",
      "officeFaxNumber": "xyz789",
      "officePhoneNumber": "xyz789",
      "projectRateTemplateId": "abc123",
      "rfiSettings": ProjectRFISettings,
      "submittalSettings": SubmittalSettings,
      "startDate": AWSDateTime,
      "status": "abc123",
      "teams": ProjectTeams,
      "timeSettings": ProjectTimeSettings,
      "purchaseOrderSettings": ProjectPurchaseOrderSettings,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteProjectCostCode

Response

Returns a ProjectCostCode

Arguments
Name Description
input - DeleteProjectCostCodeInput!

Example

Query
mutation deleteProjectCostCode($input: DeleteProjectCostCodeInput!) {
  deleteProjectCostCode(input: $input) {
    id
    projectId
    number
    name
    status
    categories
  }
}
Variables
{"input": DeleteProjectCostCodeInput}
Response
{
  "data": {
    "deleteProjectCostCode": {
      "id": 4,
      "projectId": "abc123",
      "number": "abc123",
      "name": "abc123",
      "status": "ACTIVE",
      "categories": ["LABOR"]
    }
  }
}

deleteProjectFile

Response

Returns a File

Arguments
Name Description
input - DeleteProjectFileInput!

Example

Query
mutation deleteProjectFile($input: DeleteProjectFileInput!) {
  deleteProjectFile(input: $input) {
    id
    link {
      ...AttachmentDownloadLinkFragment
    }
    name
    parentId
    parentPath
    path
    sizeInBytes
    tags {
      ...DriveTagFragment
    }
  }
}
Variables
{"input": DeleteProjectFileInput}
Response
{
  "data": {
    "deleteProjectFile": {
      "id": "abc123",
      "link": AttachmentDownloadLink,
      "name": "abc123",
      "parentId": "xyz789",
      "parentPath": "abc123",
      "path": "xyz789",
      "sizeInBytes": 987,
      "tags": [DriveTag]
    }
  }
}

deleteProjectFolder

Response

Returns a Folder

Arguments
Name Description
input - DeleteProjectFolderInput!

Example

Query
mutation deleteProjectFolder($input: DeleteProjectFolderInput!) {
  deleteProjectFolder(input: $input) {
    id
    name
    parentId
    parentPath
    path
  }
}
Variables
{"input": DeleteProjectFolderInput}
Response
{
  "data": {
    "deleteProjectFolder": {
      "id": "abc123",
      "name": "abc123",
      "parentId": "xyz789",
      "parentPath": "xyz789",
      "path": "xyz789"
    }
  }
}

deletePurchaseOrder

Response

Returns a PurchaseOrder

Arguments
Name Description
input - DeletePurchaseOrderInput!

Example

Query
mutation deletePurchaseOrder($input: DeletePurchaseOrderInput!) {
  deletePurchaseOrder(input: $input) {
    id
    project {
      ...ProjectFragment
    }
    number
    date
    type
    description
    status
    vendor {
      ...ContactFragment
    }
    salesTaxRatePercent
    salesTaxAmountInPennies
    depositInPennies
    depositDate
    releaseDate
    billing {
      ...PurchaseOrderBillingFragment
    }
    shipping {
      ...PurchaseOrderShippingFragment
    }
    buyerNotes
    vendorNotes
    internalNotes
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
    lines {
      ...PurchaseOrderLinesFragment
    }
    receivings {
      ...PurchaseOrderReceivingsFragment
    }
    invoicedInPennies
    totalInPennies
    revision
  }
}
Variables
{"input": DeletePurchaseOrderInput}
Response
{
  "data": {
    "deletePurchaseOrder": {
      "id": "abc123",
      "project": Project,
      "number": "xyz789",
      "date": AWSDateTime,
      "type": "PURCHASE_ORDER",
      "description": "abc123",
      "status": "DRAFT",
      "vendor": Contact,
      "salesTaxRatePercent": 987.65,
      "salesTaxAmountInPennies": 123,
      "depositInPennies": 123,
      "depositDate": AWSDateTime,
      "releaseDate": AWSDateTime,
      "billing": PurchaseOrderBilling,
      "shipping": PurchaseOrderShipping,
      "buyerNotes": "abc123",
      "vendorNotes": "abc123",
      "internalNotes": "abc123",
      "docs": [AttachmentV2],
      "images": [ResizedAttachment],
      "lines": PurchaseOrderLines,
      "receivings": PurchaseOrderReceivings,
      "invoicedInPennies": 987,
      "totalInPennies": 987,
      "revision": 123
    }
  }
}

deletePurchaseOrderAttachment

Response

Returns a Boolean

Arguments
Name Description
input - DeletePurchaseOrderAttachmentInput!

Example

Query
mutation deletePurchaseOrderAttachment($input: DeletePurchaseOrderAttachmentInput!) {
  deletePurchaseOrderAttachment(input: $input)
}
Variables
{"input": DeletePurchaseOrderAttachmentInput}
Response
{"data": {"deletePurchaseOrderAttachment": true}}

deletePurchaseOrderLine

Response

Returns a PurchaseOrderLine

Arguments
Name Description
input - DeletePurchaseOrderLineInput!

Example

Query
mutation deletePurchaseOrderLine($input: DeletePurchaseOrderLineInput!) {
  deletePurchaseOrderLine(input: $input) {
    id
    taxExempt
    number
    description
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    notes
    priceInPennies
    per
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    quantityOrdered
    totalInPennies
    releaseDate
    created
  }
}
Variables
{"input": DeletePurchaseOrderLineInput}
Response
{
  "data": {
    "deletePurchaseOrderLine": {
      "id": "xyz789",
      "taxExempt": false,
      "number": "abc123",
      "description": "abc123",
      "projectCostCode": ProjectCostCode,
      "notes": "abc123",
      "priceInPennies": 987,
      "per": "abc123",
      "unitOfMeasure": UnitOfMeasure,
      "quantityOrdered": 987,
      "totalInPennies": 123,
      "releaseDate": AWSDateTime,
      "created": AWSDateTime
    }
  }
}

deletePurchaseOrderReceiving

Response

Returns a PurchaseOrderReceiving

Arguments
Name Description
input - DeletePurchaseOrderReceivingInput!

Example

Query
mutation deletePurchaseOrderReceiving($input: DeletePurchaseOrderReceivingInput!) {
  deletePurchaseOrderReceiving(input: $input) {
    id
    purchaseOrderId
    date
    packingSlipNumber
    invoiceNumber
    invoiceAmountInPennies
    comments
    lines {
      ...PurchaseOrderReceivingLinesFragment
    }
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
  }
}
Variables
{"input": DeletePurchaseOrderReceivingInput}
Response
{
  "data": {
    "deletePurchaseOrderReceiving": {
      "id": "xyz789",
      "purchaseOrderId": "xyz789",
      "date": AWSDateTime,
      "packingSlipNumber": "xyz789",
      "invoiceNumber": "xyz789",
      "invoiceAmountInPennies": 987,
      "comments": "abc123",
      "lines": PurchaseOrderReceivingLines,
      "docs": [AttachmentV2],
      "images": [ResizedAttachment]
    }
  }
}

deleteRateTemplate

Response

Returns a RateTemplate

Arguments
Name Description
input - DeleteRateTemplateInput!

Example

Query
mutation deleteRateTemplate($input: DeleteRateTemplateInput!) {
  deleteRateTemplate(input: $input) {
    id
    name
    companyId
    shift2 {
      ...ShiftDifferentialFragment
    }
    shift3 {
      ...ShiftDifferentialFragment
    }
    laborClasses {
      ...RateLaborClassesFragment
    }
    status
  }
}
Variables
{"input": DeleteRateTemplateInput}
Response
{
  "data": {
    "deleteRateTemplate": {
      "id": "xyz789",
      "name": "abc123",
      "companyId": "abc123",
      "shift2": ShiftDifferential,
      "shift3": ShiftDifferential,
      "laborClasses": RateLaborClasses,
      "status": "ACTIVE"
    }
  }
}

deleteRfi

Response

Returns a Rfi

Arguments
Name Description
input - DeleteRfiInput!
condition - ModelRfiConditionInput

Example

Query
mutation deleteRfi(
  $input: DeleteRfiInput!,
  $condition: ModelRfiConditionInput
) {
  deleteRfi(
    input: $input,
    condition: $condition
  ) {
    gcFileNumber
    gcNumber
    attachments {
      ...AttachmentsFragment
    }
    author {
      ...AuthorFragment
    }
    respondByDate
    date
    id
    projectId
    dateV2
    authorV2 {
      ...UserFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    revision
    customNo
    to {
      ...NestedContactFragment
    }
    subject
    respondByDateV2
    questionForClarification
    recommendedSolution
    isScheduleImpacted
    isCostImpacted
    isUrgent
    reference {
      ...RfiReferenceFragment
    }
    projectCostCodeAffected {
      ...ProjectCostCodeFragment
    }
    projectCostCodeAffectedNumber
    dateAnswered
    status
    statusComment
    answerToClarification
    driveAttachments {
      ...RfiAttachmentFragment
    }
    images {
      ...RfiImageFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteRfiInput,
  "condition": ModelRfiConditionInput
}
Response
{
  "data": {
    "deleteRfi": {
      "gcFileNumber": "abc123",
      "gcNumber": "xyz789",
      "attachments": Attachments,
      "author": Author,
      "respondByDate": AWSDate,
      "date": AWSDate,
      "id": 4,
      "projectId": "xyz789",
      "dateV2": AWSDateTime,
      "authorV2": User,
      "lastEditedBy": Author,
      "revision": 123,
      "customNo": "xyz789",
      "to": [NestedContact],
      "subject": "xyz789",
      "respondByDateV2": AWSDateTime,
      "questionForClarification": "xyz789",
      "recommendedSolution": "xyz789",
      "isScheduleImpacted": true,
      "isCostImpacted": false,
      "isUrgent": true,
      "reference": RfiReference,
      "projectCostCodeAffected": ProjectCostCode,
      "projectCostCodeAffectedNumber": "abc123",
      "dateAnswered": AWSDateTime,
      "status": "PENDING",
      "statusComment": "xyz789",
      "answerToClarification": "xyz789",
      "driveAttachments": [RfiAttachment],
      "images": [RfiImage],
      "emails": [Email],
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteRfiAttachment

Response

Returns a Boolean

Arguments
Name Description
input - DeleteRfiAttachmentInput!

Example

Query
mutation deleteRfiAttachment($input: DeleteRfiAttachmentInput!) {
  deleteRfiAttachment(input: $input)
}
Variables
{"input": DeleteRfiAttachmentInput}
Response
{"data": {"deleteRfiAttachment": false}}

deleteSubmittalAttachment

Response

Returns a Boolean

Arguments
Name Description
input - DeleteSubmittalAttachmentInput!

Example

Query
mutation deleteSubmittalAttachment($input: DeleteSubmittalAttachmentInput!) {
  deleteSubmittalAttachment(input: $input)
}
Variables
{"input": DeleteSubmittalAttachmentInput}
Response
{"data": {"deleteSubmittalAttachment": false}}

deleteSubmittalItem

Response

Returns a SubmittalItem

Arguments
Name Description
input - DeleteSubmittalItemInput!

Example

Query
mutation deleteSubmittalItem($input: DeleteSubmittalItemInput!) {
  deleteSubmittalItem(input: $input) {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Variables
{"input": DeleteSubmittalItemInput}
Response
{
  "data": {
    "deleteSubmittalItem": {
      "created": "abc123",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "xyz789",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "abc123",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "xyz789",
      "name": "xyz789",
      "notes": "xyz789",
      "number": "abc123",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 123,
      "specSection": "xyz789",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

deleteSubmittalPackage

Response

Returns a SubmittalPackage

Arguments
Name Description
input - DeleteSubmittalPackageInput!

Example

Query
mutation deleteSubmittalPackage($input: DeleteSubmittalPackageInput!) {
  deleteSubmittalPackage(input: $input) {
    created
    dateSent
    description
    from {
      ...ContactFragment
    }
    id
    modified
    number
    name
    project {
      ...ProjectFragment
    }
    respondBy
    returnedOn
    status
    to {
      ...ContactFragment
    }
    submittalItems {
      ...SubmittalItemFragment
    }
    emails {
      ...EmailFragment
    }
  }
}
Variables
{"input": DeleteSubmittalPackageInput}
Response
{
  "data": {
    "deleteSubmittalPackage": {
      "created": "abc123",
      "dateSent": AWSDateTime,
      "description": "xyz789",
      "from": Contact,
      "id": "xyz789",
      "modified": "abc123",
      "number": "abc123",
      "name": "xyz789",
      "project": Project,
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "status": "DRAFT",
      "to": Contact,
      "submittalItems": [SubmittalItem],
      "emails": [Email]
    }
  }
}

deleteTimeCard

Response

Returns a TimeCard

Arguments
Name Description
input - DeleteTimeCardInput!
condition - ModelTimeCardConditionInput

Example

Query
mutation deleteTimeCard(
  $input: DeleteTimeCardInput!,
  $condition: ModelTimeCardConditionInput
) {
  deleteTimeCard(
    input: $input,
    condition: $condition
  ) {
    comments
    date
    doubleTimeInMinutes
    hoursLost
    id
    laborClass
    overTimeInMinutes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    project {
      ...ProjectFragment
    }
    regularTimeInMinutes
    shift
    status
    timeCardProjectCostCodeNumber
    timeCardDailyReportId
    units
    user {
      ...UserFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteTimeCardInput,
  "condition": ModelTimeCardConditionInput
}
Response
{
  "data": {
    "deleteTimeCard": {
      "comments": "xyz789",
      "date": AWSDateTime,
      "doubleTimeInMinutes": 987,
      "hoursLost": 123,
      "id": 4,
      "laborClass": "xyz789",
      "overTimeInMinutes": 123,
      "projectCostCode": ProjectCostCode,
      "project": Project,
      "regularTimeInMinutes": 987,
      "shift": "SHIFT1",
      "status": "PENDING",
      "timeCardProjectCostCodeNumber": "abc123",
      "timeCardDailyReportId": "xyz789",
      "units": 987,
      "user": User,
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteUnitOfMeasure

Response

Returns a UnitOfMeasure

Arguments
Name Description
input - DeleteUnitOfMeasureInput!

Example

Query
mutation deleteUnitOfMeasure($input: DeleteUnitOfMeasureInput!) {
  deleteUnitOfMeasure(input: $input) {
    id
    companyId
    name
    abbreviation
  }
}
Variables
{"input": DeleteUnitOfMeasureInput}
Response
{
  "data": {
    "deleteUnitOfMeasure": {
      "id": 4,
      "companyId": "abc123",
      "name": "abc123",
      "abbreviation": "xyz789"
    }
  }
}

deleteUser

Response

Returns a User

Arguments
Name Description
input - DeleteUserInput!
condition - ModelUserConditionInput

Example

Query
mutation deleteUser(
  $input: DeleteUserInput!,
  $condition: ModelUserConditionInput
) {
  deleteUser(
    input: $input,
    condition: $condition
  ) {
    id
    orgId
    companyAssociations
    defaultCompany
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AddressAllOptionalFragment
    }
    country
    useCompanyAddress
    emailSignature
    crew
    primaryLaborClass
    languagePreference
    dateDisplayPreference
    permissionGroup
    permissionGroupName
    accessLevel
    crewStatus
    type
    loginStatus
    addToNewProjects
    contact {
      ...ContactFragment
    }
    laborClassId
    laborClass {
      ...LaborClassFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteUserInput,
  "condition": ModelUserConditionInput
}
Response
{
  "data": {
    "deleteUser": {
      "id": 4,
      "orgId": "xyz789",
      "companyAssociations": ["xyz789"],
      "defaultCompany": "abc123",
      "givenName": "xyz789",
      "middleName": "abc123",
      "familyName": "xyz789",
      "email": "xyz789",
      "employeeNo": "xyz789",
      "role": "xyz789",
      "jobTitle": "xyz789",
      "officeNo": "abc123",
      "mobileNo": "abc123",
      "faxNo": "xyz789",
      "address": AddressAllOptional,
      "country": "abc123",
      "useCompanyAddress": true,
      "emailSignature": "xyz789",
      "crew": false,
      "primaryLaborClass": "xyz789",
      "languagePreference": "abc123",
      "dateDisplayPreference": "abc123",
      "permissionGroup": "abc123",
      "permissionGroupName": "abc123",
      "accessLevel": "abc123",
      "crewStatus": "AVAILABLE",
      "type": "STANDARD",
      "loginStatus": "ACTIVE",
      "addToNewProjects": false,
      "contact": Contact,
      "laborClassId": "abc123",
      "laborClass": LaborClass,
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteVersionSet

Response

Returns a DeleteVersionSetResponse

Arguments
Name Description
input - DeleteVersionSetInput!

Example

Query
mutation deleteVersionSet($input: DeleteVersionSetInput!) {
  deleteVersionSet(input: $input) {
    deleted
  }
}
Variables
{"input": DeleteVersionSetInput}
Response
{"data": {"deleteVersionSet": {"deleted": false}}}

deleteWeatherType

Response

Returns a WeatherType

Arguments
Name Description
input - DeleteWeatherTypeInput!
condition - ModelWeatherTypeConditionInput

Example

Query
mutation deleteWeatherType(
  $input: DeleteWeatherTypeInput!,
  $condition: ModelWeatherTypeConditionInput
) {
  deleteWeatherType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteWeatherTypeInput,
  "condition": ModelWeatherTypeConditionInput
}
Response
{
  "data": {
    "deleteWeatherType": {
      "id": 4,
      "name": "xyz789",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

deleteWindType

Response

Returns a WindType

Arguments
Name Description
input - DeleteWindTypeInput!
condition - ModelWindTypeConditionInput

Example

Query
mutation deleteWindType(
  $input: DeleteWindTypeInput!,
  $condition: ModelWindTypeConditionInput
) {
  deleteWindType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": DeleteWindTypeInput,
  "condition": ModelWindTypeConditionInput
}
Response
{
  "data": {
    "deleteWindType": {
      "id": 4,
      "name": "abc123",
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

requestAuthToken

Response

Returns an AuthToken

Arguments
Name Description
input - RequestAuthTokenInput!

Example

Query
mutation requestAuthToken($input: RequestAuthTokenInput!) {
  requestAuthToken(input: $input) {
    accessToken
    idToken
    refreshToken
    permissions {
      ...PermissionFragment
    }
  }
}
Variables
{"input": RequestAuthTokenInput}
Response
{
  "data": {
    "requestAuthToken": {
      "accessToken": "xyz789",
      "idToken": "abc123",
      "refreshToken": "xyz789",
      "permissions": [Permission]
    }
  }
}

requestCumulioToken

Response

Returns a CumulioToken

Arguments
Name Description
input - RequestCumulioTokenInput!

Example

Query
mutation requestCumulioToken($input: RequestCumulioTokenInput!) {
  requestCumulioToken(input: $input) {
    token
    key
  }
}
Variables
{"input": RequestCumulioTokenInput}
Response
{
  "data": {
    "requestCumulioToken": {
      "token": "abc123",
      "key": "xyz789"
    }
  }
}

requestPasswordResetCode

Response

Returns a Boolean

Arguments
Name Description
input - RequestPasswordResetCodeInput!

Example

Query
mutation requestPasswordResetCode($input: RequestPasswordResetCodeInput!) {
  requestPasswordResetCode(input: $input)
}
Variables
{"input": RequestPasswordResetCodeInput}
Response
{"data": {"requestPasswordResetCode": false}}

sendEmailForChangeOrderRequest

Response

Returns an ID

Arguments
Name Description
email - ChangeOrderRequestEmailInput!

Example

Query
mutation sendEmailForChangeOrderRequest($email: ChangeOrderRequestEmailInput!) {
  sendEmailForChangeOrderRequest(email: $email)
}
Variables
{"email": ChangeOrderRequestEmailInput}
Response
{
  "data": {
    "sendEmailForChangeOrderRequest": "4"
  }
}

sendEmailForDailyReport

Response

Returns an ID

Arguments
Name Description
email - DailyReportEmailInput!
dailyReportId - ID!

Example

Query
mutation sendEmailForDailyReport(
  $email: DailyReportEmailInput!,
  $dailyReportId: ID!
) {
  sendEmailForDailyReport(
    email: $email,
    dailyReportId: $dailyReportId
  )
}
Variables
{"email": DailyReportEmailInput, "dailyReportId": 4}
Response
{"data": {"sendEmailForDailyReport": "4"}}

sendEmailForFieldNote

Response

Returns an ID

Arguments
Name Description
email - EmailInput!
fieldNoteId - ID!

Example

Query
mutation sendEmailForFieldNote(
  $email: EmailInput!,
  $fieldNoteId: ID!
) {
  sendEmailForFieldNote(
    email: $email,
    fieldNoteId: $fieldNoteId
  )
}
Variables
{
  "email": EmailInput,
  "fieldNoteId": "4"
}
Response
{"data": {"sendEmailForFieldNote": "4"}}

sendEmailForRfi

Response

Returns an ID

Arguments
Name Description
email - RfiEmailInput!
rfiId - ID!

Example

Query
mutation sendEmailForRfi(
  $email: RfiEmailInput!,
  $rfiId: ID!
) {
  sendEmailForRfi(
    email: $email,
    rfiId: $rfiId
  )
}
Variables
{
  "email": RfiEmailInput,
  "rfiId": "4"
}
Response
{"data": {"sendEmailForRfi": 4}}

sendEmailForSubmittalItem

Response

Returns an ID

Arguments
Name Description
email - SubmittalItemEmailInput!

Example

Query
mutation sendEmailForSubmittalItem($email: SubmittalItemEmailInput!) {
  sendEmailForSubmittalItem(email: $email)
}
Variables
{"email": SubmittalItemEmailInput}
Response
{"data": {"sendEmailForSubmittalItem": 4}}

sendEmailForSubmittalPackage

Response

Returns an ID

Arguments
Name Description
email - SubmittalPackageEmailInput!

Example

Query
mutation sendEmailForSubmittalPackage($email: SubmittalPackageEmailInput!) {
  sendEmailForSubmittalPackage(email: $email)
}
Variables
{"email": SubmittalPackageEmailInput}
Response
{
  "data": {
    "sendEmailForSubmittalPackage": "4"
  }
}

setBatchEntityAssignment

Response

Returns [EntityAssignment]

Arguments
Name Description
input - SetBatchEntityAssignmentInput!

Example

Query
mutation setBatchEntityAssignment($input: SetBatchEntityAssignmentInput!) {
  setBatchEntityAssignment(input: $input) {
    id
    entityId
    userId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"input": SetBatchEntityAssignmentInput}
Response
{
  "data": {
    "setBatchEntityAssignment": [
      {
        "id": "4",
        "entityId": "4",
        "userId": 4,
        "_version": 123,
        "_deleted": true,
        "_lastChangedAt": AWSTimestamp,
        "createdAt": AWSDateTime,
        "updatedAt": AWSDateTime
      }
    ]
  }
}

updateAdminCompany

Response

Returns an AdminCompany

Arguments
Name Description
input - UpdateAdminCompanyInput!

Example

Query
mutation updateAdminCompany($input: UpdateAdminCompanyInput!) {
  updateAdminCompany(input: $input) {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    orgId
    hierarchy
  }
}
Variables
{"input": UpdateAdminCompanyInput}
Response
{
  "data": {
    "updateAdminCompany": {
      "id": 4,
      "name": "abc123",
      "address": Address,
      "country": "xyz789",
      "phone": "abc123",
      "fax": "abc123",
      "orgId": "4",
      "hierarchy": "xyz789"
    }
  }
}

updateChangeOrderRequest

Response

Returns a ChangeOrderRequest

Arguments
Name Description
input - UpdateChangeOrderRequestInput!

Example

Query
mutation updateChangeOrderRequest($input: UpdateChangeOrderRequestInput!) {
  updateChangeOrderRequest(input: $input) {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Variables
{"input": UpdateChangeOrderRequestInput}
Response
{
  "data": {
    "updateChangeOrderRequest": {
      "approvalNumber": "xyz789",
      "approvedAmountInPennies": 123,
      "created": "abc123",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 987,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "xyz789",
      "images": [ResizedAttachment],
      "internalNotes": "abc123",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "abc123",
      "name": "xyz789",
      "number": "abc123",
      "project": Project,
      "referenceNumberAsi": "abc123",
      "referenceNumberGcCor": "xyz789",
      "referenceNumberOther": "abc123",
      "referenceNumberOwnerCor": "xyz789",
      "referenceNumberPco": "xyz789",
      "referenceNumberRfi": "abc123",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 123,
      "scheduleImpactComments": "xyz789",
      "scheduleImpactDays": 987,
      "scopeOfWork": "xyz789",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

updateChangeOrderRequestAttachment

Response

Returns an AttachmentV2

Arguments
Name Description
input - UpdateChangeOrderRequestAttachmentInput!

Example

Query
mutation updateChangeOrderRequestAttachment($input: UpdateChangeOrderRequestAttachmentInput!) {
  updateChangeOrderRequestAttachment(input: $input) {
    id
    name
    tags {
      ...DriveTagFragment
    }
    link {
      ...AttachmentDownloadLinkFragment
    }
  }
}
Variables
{"input": UpdateChangeOrderRequestAttachmentInput}
Response
{
  "data": {
    "updateChangeOrderRequestAttachment": {
      "id": "4",
      "name": "xyz789",
      "tags": [DriveTag],
      "link": AttachmentDownloadLink
    }
  }
}

updateChangeOrderRequestEquipmentLineItem

Arguments
Name Description
input - UpdateChangeOrderRequestEquipmentLineItemInput!

Example

Query
mutation updateChangeOrderRequestEquipmentLineItem($input: UpdateChangeOrderRequestEquipmentLineItemInput!) {
  updateChangeOrderRequestEquipmentLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customEquipment
  }
}
Variables
{"input": UpdateChangeOrderRequestEquipmentLineItemInput}
Response
{
  "data": {
    "updateChangeOrderRequestEquipmentLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "abc123",
      "rateInPennies": 987,
      "sellPriceInPennies": 123,
      "quantity": 123.45,
      "customEquipment": "xyz789"
    }
  }
}

updateChangeOrderRequestLaborLineItem

Response

Returns a ChangeOrderRequestLaborLineItem

Arguments
Name Description
input - UpdateChangeOrderRequestLaborLineItemInput!

Example

Query
mutation updateChangeOrderRequestLaborLineItem($input: UpdateChangeOrderRequestLaborLineItemInput!) {
  updateChangeOrderRequestLaborLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customLaborClass
    hoursInMinutes
    laborClass {
      ...LaborClassFragment
    }
    rateInPennies
    sellRateInPennies
    workers
  }
}
Variables
{"input": UpdateChangeOrderRequestLaborLineItemInput}
Response
{
  "data": {
    "updateChangeOrderRequestLaborLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customLaborClass": "xyz789",
      "hoursInMinutes": 987,
      "laborClass": LaborClass,
      "rateInPennies": 987,
      "sellRateInPennies": 123,
      "workers": 123.45
    }
  }
}

updateChangeOrderRequestMaterialLineItem

Arguments
Name Description
input - UpdateChangeOrderRequestMaterialLineItemInput!

Example

Query
mutation updateChangeOrderRequestMaterialLineItem($input: UpdateChangeOrderRequestMaterialLineItemInput!) {
  updateChangeOrderRequestMaterialLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customMaterial
  }
}
Variables
{"input": UpdateChangeOrderRequestMaterialLineItemInput}
Response
{
  "data": {
    "updateChangeOrderRequestMaterialLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "xyz789",
      "rateInPennies": 123,
      "sellPriceInPennies": 123,
      "quantity": 987.65,
      "customMaterial": "abc123"
    }
  }
}

updateChangeOrderRequestOtherLineItem

Response

Returns a ChangeOrderRequestOtherLineItem

Arguments
Name Description
input - UpdateChangeOrderRequestOtherLineItemInput!

Example

Query
mutation updateChangeOrderRequestOtherLineItem($input: UpdateChangeOrderRequestOtherLineItemInput!) {
  updateChangeOrderRequestOtherLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{"input": UpdateChangeOrderRequestOtherLineItemInput}
Response
{
  "data": {
    "updateChangeOrderRequestOtherLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "xyz789",
      "priceInPennies": 123,
      "quantity": 123.45,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

updateChangeOrderRequestOverheadLineItem

Arguments
Name Description
input - UpdateChangeOrderRequestOverheadLineItemInput!

Example

Query
mutation updateChangeOrderRequestOverheadLineItem($input: UpdateChangeOrderRequestOverheadLineItemInput!) {
  updateChangeOrderRequestOverheadLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{"input": UpdateChangeOrderRequestOverheadLineItemInput}
Response
{
  "data": {
    "updateChangeOrderRequestOverheadLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "abc123",
      "priceInPennies": 987,
      "quantity": 987.65,
      "sellPriceInPennies": 987,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

updateChangeOrderRequestSubcontractorLineItem

Example

Query
mutation updateChangeOrderRequestSubcontractorLineItem($input: UpdateChangeOrderRequestSubcontractorLineItemInput!) {
  updateChangeOrderRequestSubcontractorLineItem(input: $input) {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{
  "input": UpdateChangeOrderRequestSubcontractorLineItemInput
}
Response
{
  "data": {
    "updateChangeOrderRequestSubcontractorLineItem": {
      "costInPennies": 987,
      "id": "abc123",
      "markup": 123.45,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "abc123",
      "priceInPennies": 123,
      "quantity": 987.65,
      "sellPriceInPennies": 987,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

updateCompanyCostCode

Response

Returns a CompanyCostCode

Arguments
Name Description
input - UpdateCompanyCostCodeInput!

Example

Query
mutation updateCompanyCostCode($input: UpdateCompanyCostCodeInput!) {
  updateCompanyCostCode(input: $input) {
    id
    companyId
    number
    name
    status
    categories
    addToNewProjects
    projectCostCodes {
      ...ProjectCostCodesFragment
    }
  }
}
Variables
{"input": UpdateCompanyCostCodeInput}
Response
{
  "data": {
    "updateCompanyCostCode": {
      "id": 4,
      "companyId": "abc123",
      "number": "abc123",
      "name": "xyz789",
      "status": "ACTIVE",
      "categories": ["LABOR"],
      "addToNewProjects": true,
      "projectCostCodes": ProjectCostCodes
    }
  }
}

updateCompanyFile

Response

Returns a File

Arguments
Name Description
input - UpdateCompanyFileInput!

Example

Query
mutation updateCompanyFile($input: UpdateCompanyFileInput!) {
  updateCompanyFile(input: $input) {
    id
    link {
      ...AttachmentDownloadLinkFragment
    }
    name
    parentId
    parentPath
    path
    sizeInBytes
    tags {
      ...DriveTagFragment
    }
  }
}
Variables
{"input": UpdateCompanyFileInput}
Response
{
  "data": {
    "updateCompanyFile": {
      "id": "abc123",
      "link": AttachmentDownloadLink,
      "name": "abc123",
      "parentId": "xyz789",
      "parentPath": "abc123",
      "path": "abc123",
      "sizeInBytes": 987,
      "tags": [DriveTag]
    }
  }
}

updateCompanyFolder

Response

Returns a Folder

Arguments
Name Description
input - UpdateCompanyFolderInput!

Example

Query
mutation updateCompanyFolder($input: UpdateCompanyFolderInput!) {
  updateCompanyFolder(input: $input) {
    id
    name
    parentId
    parentPath
    path
  }
}
Variables
{"input": UpdateCompanyFolderInput}
Response
{
  "data": {
    "updateCompanyFolder": {
      "id": "xyz789",
      "name": "xyz789",
      "parentId": "xyz789",
      "parentPath": "abc123",
      "path": "xyz789"
    }
  }
}

updateCompanySettings

Response

Returns a Company

Arguments
Name Description
input - UpdateCompanySettingsInput!

Example

Query
mutation updateCompanySettings($input: UpdateCompanySettingsInput!) {
  updateCompanySettings(input: $input) {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    orgId
    hierarchy
    keywords {
      ...KeywordFragment
    }
    logo {
      ...AttachmentFragment
    }
    timeCardSettings {
      ...TimeCardSettingsFragment
    }
    dailyReportSettings {
      ...DailyReportSettingsFragment
    }
    rfiSettings {
      ...RFISettingsFragment
    }
    changeOrderRequestSettings {
      ...ChangeOrderRequestSettingsFragment
    }
    purchaseOrderSettings {
      ...PurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"input": UpdateCompanySettingsInput}
Response
{
  "data": {
    "updateCompanySettings": {
      "id": 4,
      "name": "xyz789",
      "address": Address,
      "country": "abc123",
      "phone": "xyz789",
      "fax": "abc123",
      "orgId": 4,
      "hierarchy": "abc123",
      "keywords": [Keyword],
      "logo": Attachment,
      "timeCardSettings": TimeCardSettings,
      "dailyReportSettings": DailyReportSettings,
      "rfiSettings": RFISettings,
      "changeOrderRequestSettings": ChangeOrderRequestSettings,
      "purchaseOrderSettings": PurchaseOrderSettings,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateContact

Response

Returns a Contact

Arguments
Name Description
input - UpdateContactInput!
condition - ModelContactConditionInput

Example

Query
mutation updateContact(
  $input: UpdateContactInput!,
  $condition: ModelContactConditionInput
) {
  updateContact(
    input: $input,
    condition: $condition
  ) {
    id
    firstName
    middleName
    lastName
    jobTitle
    email
    address {
      ...AddressAllOptionalFragment
    }
    country
    office
    mobile
    fax
    notes
    businessName
    businessType
    status
    apVendor
    vendorId
    website
    cannotDelete
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateContactInput,
  "condition": ModelContactConditionInput
}
Response
{
  "data": {
    "updateContact": {
      "id": "4",
      "firstName": "abc123",
      "middleName": "abc123",
      "lastName": "xyz789",
      "jobTitle": "xyz789",
      "email": "xyz789",
      "address": AddressAllOptional,
      "country": "abc123",
      "office": "abc123",
      "mobile": "xyz789",
      "fax": "xyz789",
      "notes": "xyz789",
      "businessName": "xyz789",
      "businessType": "xyz789",
      "status": "AVAILABLE",
      "apVendor": false,
      "vendorId": "abc123",
      "website": "abc123",
      "cannotDelete": true,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateDailyReport

Response

Returns a DailyReport

Arguments
Name Description
input - UpdateDailyReportInput!
condition - ModelDailyReportConditionInput

Example

Query
mutation updateDailyReport(
  $input: UpdateDailyReportInput!,
  $condition: ModelDailyReportConditionInput
) {
  updateDailyReport(
    input: $input,
    condition: $condition
  ) {
    id
    projectId
    customNo
    date
    timeOnSite
    timeOffSite
    totalWorkers
    author
    authorId
    weatherConditions {
      ...WeatherFragment
    }
    weather
    wind
    temperature
    workPerformed
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    issues
    favors
    accidents
    subcontractorsWorked
    visitors
    comments
    notes
    internalComments
    weatherComments
    lastEditedBy
    attachments {
      ...AttachmentsFragment
    }
    docs {
      ...DocsFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateDailyReportInput,
  "condition": ModelDailyReportConditionInput
}
Response
{
  "data": {
    "updateDailyReport": {
      "id": "4",
      "projectId": "abc123",
      "customNo": "abc123",
      "date": AWSDateTime,
      "timeOnSite": AWSDateTime,
      "timeOffSite": AWSDateTime,
      "totalWorkers": 987,
      "author": "xyz789",
      "authorId": "abc123",
      "weatherConditions": Weather,
      "weather": "abc123",
      "wind": "xyz789",
      "temperature": 987,
      "workPerformed": "xyz789",
      "keywords": ["xyz789"],
      "listOfKeywords": [NestedKeywords],
      "issues": "xyz789",
      "favors": "abc123",
      "accidents": "xyz789",
      "subcontractorsWorked": "abc123",
      "visitors": "abc123",
      "comments": "abc123",
      "notes": "xyz789",
      "internalComments": "xyz789",
      "weatherComments": "xyz789",
      "lastEditedBy": "xyz789",
      "attachments": Attachments,
      "docs": Docs,
      "emails": [Email],
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateEmail

Response

Returns an Email

Arguments
Name Description
input - UpdateEmailInput!

Example

Query
mutation updateEmail($input: UpdateEmailInput!) {
  updateEmail(input: $input) {
    id
    author {
      ...AuthorFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    boxType
    dateSent
    dateReceived
    isUrgent
    hasBeenRead
    subject
    from {
      ...EmailAddressFragment
    }
    to {
      ...EmailAddressFragment
    }
    cc {
      ...EmailAddressFragment
    }
    bcc {
      ...EmailAddressFragment
    }
    text
    html
    emailLink
    documents {
      ...DocumentAttachmentFragment
    }
    images {
      ...ImageAttachmentFragment
    }
    linkedDocument {
      ...LinkedDocumentFragment
    }
  }
}
Variables
{"input": UpdateEmailInput}
Response
{
  "data": {
    "updateEmail": {
      "id": "4",
      "author": Author,
      "lastEditedBy": Author,
      "boxType": "INBOX",
      "dateSent": AWSDateTime,
      "dateReceived": AWSDateTime,
      "isUrgent": true,
      "hasBeenRead": false,
      "subject": "abc123",
      "from": EmailAddress,
      "to": [EmailAddress],
      "cc": [EmailAddress],
      "bcc": [EmailAddress],
      "text": "abc123",
      "html": "xyz789",
      "emailLink": "xyz789",
      "documents": [DocumentAttachment],
      "images": [ImageAttachment],
      "linkedDocument": LinkedDocument
    }
  }
}

updateEntityAssignment

Response

Returns an EntityAssignment

Arguments
Name Description
input - UpdateEntityAssignmentInput!
condition - ModelEntityAssignmentConditionInput

Example

Query
mutation updateEntityAssignment(
  $input: UpdateEntityAssignmentInput!,
  $condition: ModelEntityAssignmentConditionInput
) {
  updateEntityAssignment(
    input: $input,
    condition: $condition
  ) {
    id
    entityId
    userId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateEntityAssignmentInput,
  "condition": ModelEntityAssignmentConditionInput
}
Response
{
  "data": {
    "updateEntityAssignment": {
      "id": 4,
      "entityId": "4",
      "userId": 4,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateFieldNote

Response

Returns a FieldNote

Arguments
Name Description
input - UpdateFieldNoteInput!
condition - ModelFieldNoteConditionInput

Example

Query
mutation updateFieldNote(
  $input: UpdateFieldNoteInput!,
  $condition: ModelFieldNoteConditionInput
) {
  updateFieldNote(
    input: $input,
    condition: $condition
  ) {
    id
    note
    createdOnDeviceAt
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    locationTags {
      ...NestedLocationTagFragment
    }
    address {
      ...AddressFragment
    }
    phase
    system
    attachments {
      ...AttachmentsFragment
    }
    createdByUsername
    createdByUserId
    projectId
    docs {
      ...DocsFragment
    }
    lastUpdatedByUsername
    lastUpdatedByUserId
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateFieldNoteInput,
  "condition": ModelFieldNoteConditionInput
}
Response
{
  "data": {
    "updateFieldNote": {
      "id": 4,
      "note": "xyz789",
      "createdOnDeviceAt": AWSDateTime,
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "locationTags": [NestedLocationTag],
      "address": Address,
      "phase": "abc123",
      "system": "xyz789",
      "attachments": Attachments,
      "createdByUsername": "xyz789",
      "createdByUserId": "xyz789",
      "projectId": "abc123",
      "docs": Docs,
      "lastUpdatedByUsername": "abc123",
      "lastUpdatedByUserId": "xyz789",
      "emails": [Email],
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateKeyword

Response

Returns a Keyword

Arguments
Name Description
input - UpdateKeywordInput!
condition - ModelKeywordConditionInput

Example

Query
mutation updateKeyword(
  $input: UpdateKeywordInput!,
  $condition: ModelKeywordConditionInput
) {
  updateKeyword(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    status
    usageCount
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateKeywordInput,
  "condition": ModelKeywordConditionInput
}
Response
{
  "data": {
    "updateKeyword": {
      "id": "4",
      "name": "xyz789",
      "companyId": "abc123",
      "status": "AVAILABLE",
      "usageCount": 987,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateLaborClass

Response

Returns a LaborClass

Arguments
Name Description
input - UpdateLaborClassInput!

Example

Query
mutation updateLaborClass($input: UpdateLaborClassInput!) {
  updateLaborClass(input: $input) {
    id
    companyId
    name
    status
  }
}
Variables
{"input": UpdateLaborClassInput}
Response
{
  "data": {
    "updateLaborClass": {
      "id": "abc123",
      "companyId": "abc123",
      "name": "xyz789",
      "status": "ACTIVE"
    }
  }
}

updateLocationTag

Response

Returns a LocationTag

Arguments
Name Description
input - UpdateLocationTagInput!
condition - ModelLocationTagConditionInput

Example

Query
mutation updateLocationTag(
  $input: UpdateLocationTagInput!,
  $condition: ModelLocationTagConditionInput
) {
  updateLocationTag(
    input: $input,
    condition: $condition
  ) {
    id
    name
    projectId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateLocationTagInput,
  "condition": ModelLocationTagConditionInput
}
Response
{
  "data": {
    "updateLocationTag": {
      "id": 4,
      "name": "abc123",
      "projectId": "abc123",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateOccupancySubType

Response

Returns an OccupancySubType

Arguments
Name Description
input - UpdateOccupancySubTypeInput!
condition - ModelOccupancySubTypeConditionInput

Example

Query
mutation updateOccupancySubType(
  $input: UpdateOccupancySubTypeInput!,
  $condition: ModelOccupancySubTypeConditionInput
) {
  updateOccupancySubType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    occupancyTypeId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateOccupancySubTypeInput,
  "condition": ModelOccupancySubTypeConditionInput
}
Response
{
  "data": {
    "updateOccupancySubType": {
      "id": "4",
      "name": "abc123",
      "companyId": "abc123",
      "occupancyTypeId": "abc123",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateOccupancyType

Response

Returns an OccupancyType

Arguments
Name Description
input - UpdateOccupancyTypeInput!
condition - ModelOccupancyTypeConditionInput

Example

Query
mutation updateOccupancyType(
  $input: UpdateOccupancyTypeInput!,
  $condition: ModelOccupancyTypeConditionInput
) {
  updateOccupancyType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    companyId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateOccupancyTypeInput,
  "condition": ModelOccupancyTypeConditionInput
}
Response
{
  "data": {
    "updateOccupancyType": {
      "id": "4",
      "name": "abc123",
      "companyId": "abc123",
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateOrganization

Response

Returns an Organization

Arguments
Name Description
input - UpdateOrganizationInput!

Example

Query
mutation updateOrganization($input: UpdateOrganizationInput!) {
  updateOrganization(input: $input) {
    id
    name
    address {
      ...AddressFragment
    }
    country
    phone
    fax
    accountStatus
    subscriptionStart
    subscriptionEnd
    userCount
    enabledModules
    modules
    _version
    _lastChangedAt
  }
}
Variables
{"input": UpdateOrganizationInput}
Response
{
  "data": {
    "updateOrganization": {
      "id": "4",
      "name": "xyz789",
      "address": Address,
      "country": "abc123",
      "phone": "xyz789",
      "fax": "abc123",
      "accountStatus": "abc123",
      "subscriptionStart": AWSDateTime,
      "subscriptionEnd": AWSDateTime,
      "userCount": 987,
      "enabledModules": "xyz789",
      "modules": ["CHANGE_ORDER_REQUEST"],
      "_version": 987,
      "_lastChangedAt": AWSTimestamp
    }
  }
}

updatePOReceivingAttachment

Response

Returns an AttachmentV2

Arguments
Name Description
input - UpdatePOReceivingAttachmentInput!

Example

Query
mutation updatePOReceivingAttachment($input: UpdatePOReceivingAttachmentInput!) {
  updatePOReceivingAttachment(input: $input) {
    id
    name
    tags {
      ...DriveTagFragment
    }
    link {
      ...AttachmentDownloadLinkFragment
    }
  }
}
Variables
{"input": UpdatePOReceivingAttachmentInput}
Response
{
  "data": {
    "updatePOReceivingAttachment": {
      "id": 4,
      "name": "abc123",
      "tags": [DriveTag],
      "link": AttachmentDownloadLink
    }
  }
}

updatePermissionGroup

Response

Returns [PermissionGroup]

Arguments
Name Description
input - UpdatePermissionGroupInput!

Example

Query
mutation updatePermissionGroup($input: UpdatePermissionGroupInput!) {
  updatePermissionGroup(input: $input) {
    id
    name
    permissions {
      ...PermissionFragment
    }
  }
}
Variables
{"input": UpdatePermissionGroupInput}
Response
{
  "data": {
    "updatePermissionGroup": [
      {
        "id": "4",
        "name": "abc123",
        "permissions": [Permission]
      }
    ]
  }
}

updateProject

Response

Returns a Project

Arguments
Name Description
input - UpdateProjectInput!
condition - ModelProjectConditionInput

Example

Query
mutation updateProject(
  $input: UpdateProjectInput!,
  $condition: ModelProjectConditionInput
) {
  updateProject(
    input: $input,
    condition: $condition
  ) {
    address {
      ...AddressAllOptionalFragment
    }
    changeOrderRequestSettings {
      ...ProjectChangeOrderRequestSettingsFragment
    }
    comments
    company {
      ...CompanyFragment
    }
    companyId
    companyName
    contractCostInPennies
    contractNumber
    contractSoldBy
    contractType
    dailyReportSettings {
      ...ProjectDailyReportSettingsFragment
    }
    divisionId
    endDate
    id
    isPrimeContractor
    mailboxEmail
    marketAreaId
    name
    number
    occupancySubTypeId
    occupancyTypeId
    officeFaxNumber
    officePhoneNumber
    projectRateTemplateId
    rfiSettings {
      ...ProjectRFISettingsFragment
    }
    submittalSettings {
      ...SubmittalSettingsFragment
    }
    startDate
    status
    teams {
      ...ProjectTeamsFragment
    }
    timeSettings {
      ...ProjectTimeSettingsFragment
    }
    purchaseOrderSettings {
      ...ProjectPurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateProjectInput,
  "condition": ModelProjectConditionInput
}
Response
{
  "data": {
    "updateProject": {
      "address": AddressAllOptional,
      "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
      "comments": "xyz789",
      "company": Company,
      "companyId": "xyz789",
      "companyName": "xyz789",
      "contractCostInPennies": 123,
      "contractNumber": "abc123",
      "contractSoldBy": "xyz789",
      "contractType": "abc123",
      "dailyReportSettings": ProjectDailyReportSettings,
      "divisionId": "xyz789",
      "endDate": AWSDateTime,
      "id": 4,
      "isPrimeContractor": false,
      "mailboxEmail": "abc123",
      "marketAreaId": "abc123",
      "name": "abc123",
      "number": "abc123",
      "occupancySubTypeId": "xyz789",
      "occupancyTypeId": "xyz789",
      "officeFaxNumber": "abc123",
      "officePhoneNumber": "abc123",
      "projectRateTemplateId": "abc123",
      "rfiSettings": ProjectRFISettings,
      "submittalSettings": SubmittalSettings,
      "startDate": AWSDateTime,
      "status": "abc123",
      "teams": ProjectTeams,
      "timeSettings": ProjectTimeSettings,
      "purchaseOrderSettings": ProjectPurchaseOrderSettings,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateProjectBudget

Response

Returns a ProjectBudget

Arguments
Name Description
input - UpdateProjectBudgetInput!

Example

Query
mutation updateProjectBudget($input: UpdateProjectBudgetInput!) {
  updateProjectBudget(input: $input) {
    id
    projectCostCodeNumber
    projectId
    units
    laborHoursInMinutes
    laborCostInPennies
    materialCostInPennies
    subcontractorCostInPennies
    equipmentCostInPennies
    overheadCostInPennies
    otherCostInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Variables
{"input": UpdateProjectBudgetInput}
Response
{
  "data": {
    "updateProjectBudget": {
      "id": "abc123",
      "projectCostCodeNumber": "abc123",
      "projectId": "abc123",
      "units": 123,
      "laborHoursInMinutes": 123,
      "laborCostInPennies": 123,
      "materialCostInPennies": 987,
      "subcontractorCostInPennies": 987,
      "equipmentCostInPennies": 123,
      "overheadCostInPennies": 123,
      "otherCostInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

updateProjectCostCode

Response

Returns a ProjectCostCode

Arguments
Name Description
input - UpdateProjectCostCodeInput!

Example

Query
mutation updateProjectCostCode($input: UpdateProjectCostCodeInput!) {
  updateProjectCostCode(input: $input) {
    id
    projectId
    number
    name
    status
    categories
  }
}
Variables
{"input": UpdateProjectCostCodeInput}
Response
{
  "data": {
    "updateProjectCostCode": {
      "id": 4,
      "projectId": "abc123",
      "number": "xyz789",
      "name": "abc123",
      "status": "ACTIVE",
      "categories": ["LABOR"]
    }
  }
}

updateProjectFile

Response

Returns a File

Arguments
Name Description
input - UpdateProjectFileInput!

Example

Query
mutation updateProjectFile($input: UpdateProjectFileInput!) {
  updateProjectFile(input: $input) {
    id
    link {
      ...AttachmentDownloadLinkFragment
    }
    name
    parentId
    parentPath
    path
    sizeInBytes
    tags {
      ...DriveTagFragment
    }
  }
}
Variables
{"input": UpdateProjectFileInput}
Response
{
  "data": {
    "updateProjectFile": {
      "id": "abc123",
      "link": AttachmentDownloadLink,
      "name": "xyz789",
      "parentId": "abc123",
      "parentPath": "abc123",
      "path": "abc123",
      "sizeInBytes": 123,
      "tags": [DriveTag]
    }
  }
}

updateProjectFolder

Response

Returns a Folder

Arguments
Name Description
input - UpdateProjectFolderInput!

Example

Query
mutation updateProjectFolder($input: UpdateProjectFolderInput!) {
  updateProjectFolder(input: $input) {
    id
    name
    parentId
    parentPath
    path
  }
}
Variables
{"input": UpdateProjectFolderInput}
Response
{
  "data": {
    "updateProjectFolder": {
      "id": "xyz789",
      "name": "xyz789",
      "parentId": "xyz789",
      "parentPath": "abc123",
      "path": "abc123"
    }
  }
}

updateProjectSettings

Response

Returns a Project

Arguments
Name Description
input - UpdateProjectSettingsInput!

Example

Query
mutation updateProjectSettings($input: UpdateProjectSettingsInput!) {
  updateProjectSettings(input: $input) {
    address {
      ...AddressAllOptionalFragment
    }
    changeOrderRequestSettings {
      ...ProjectChangeOrderRequestSettingsFragment
    }
    comments
    company {
      ...CompanyFragment
    }
    companyId
    companyName
    contractCostInPennies
    contractNumber
    contractSoldBy
    contractType
    dailyReportSettings {
      ...ProjectDailyReportSettingsFragment
    }
    divisionId
    endDate
    id
    isPrimeContractor
    mailboxEmail
    marketAreaId
    name
    number
    occupancySubTypeId
    occupancyTypeId
    officeFaxNumber
    officePhoneNumber
    projectRateTemplateId
    rfiSettings {
      ...ProjectRFISettingsFragment
    }
    submittalSettings {
      ...SubmittalSettingsFragment
    }
    startDate
    status
    teams {
      ...ProjectTeamsFragment
    }
    timeSettings {
      ...ProjectTimeSettingsFragment
    }
    purchaseOrderSettings {
      ...ProjectPurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"input": UpdateProjectSettingsInput}
Response
{
  "data": {
    "updateProjectSettings": {
      "address": AddressAllOptional,
      "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
      "comments": "xyz789",
      "company": Company,
      "companyId": "abc123",
      "companyName": "xyz789",
      "contractCostInPennies": 987,
      "contractNumber": "xyz789",
      "contractSoldBy": "xyz789",
      "contractType": "xyz789",
      "dailyReportSettings": ProjectDailyReportSettings,
      "divisionId": "abc123",
      "endDate": AWSDateTime,
      "id": "4",
      "isPrimeContractor": true,
      "mailboxEmail": "xyz789",
      "marketAreaId": "abc123",
      "name": "abc123",
      "number": "xyz789",
      "occupancySubTypeId": "xyz789",
      "occupancyTypeId": "xyz789",
      "officeFaxNumber": "xyz789",
      "officePhoneNumber": "abc123",
      "projectRateTemplateId": "xyz789",
      "rfiSettings": ProjectRFISettings,
      "submittalSettings": SubmittalSettings,
      "startDate": AWSDateTime,
      "status": "abc123",
      "teams": ProjectTeams,
      "timeSettings": ProjectTimeSettings,
      "purchaseOrderSettings": ProjectPurchaseOrderSettings,
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updatePurchaseOrder

Response

Returns a PurchaseOrder

Arguments
Name Description
input - UpdatePurchaseOrderInput!

Example

Query
mutation updatePurchaseOrder($input: UpdatePurchaseOrderInput!) {
  updatePurchaseOrder(input: $input) {
    id
    project {
      ...ProjectFragment
    }
    number
    date
    type
    description
    status
    vendor {
      ...ContactFragment
    }
    salesTaxRatePercent
    salesTaxAmountInPennies
    depositInPennies
    depositDate
    releaseDate
    billing {
      ...PurchaseOrderBillingFragment
    }
    shipping {
      ...PurchaseOrderShippingFragment
    }
    buyerNotes
    vendorNotes
    internalNotes
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
    lines {
      ...PurchaseOrderLinesFragment
    }
    receivings {
      ...PurchaseOrderReceivingsFragment
    }
    invoicedInPennies
    totalInPennies
    revision
  }
}
Variables
{"input": UpdatePurchaseOrderInput}
Response
{
  "data": {
    "updatePurchaseOrder": {
      "id": "abc123",
      "project": Project,
      "number": "xyz789",
      "date": AWSDateTime,
      "type": "PURCHASE_ORDER",
      "description": "xyz789",
      "status": "DRAFT",
      "vendor": Contact,
      "salesTaxRatePercent": 123.45,
      "salesTaxAmountInPennies": 123,
      "depositInPennies": 123,
      "depositDate": AWSDateTime,
      "releaseDate": AWSDateTime,
      "billing": PurchaseOrderBilling,
      "shipping": PurchaseOrderShipping,
      "buyerNotes": "abc123",
      "vendorNotes": "xyz789",
      "internalNotes": "abc123",
      "docs": [AttachmentV2],
      "images": [ResizedAttachment],
      "lines": PurchaseOrderLines,
      "receivings": PurchaseOrderReceivings,
      "invoicedInPennies": 123,
      "totalInPennies": 123,
      "revision": 987
    }
  }
}

updatePurchaseOrderAttachment

Response

Returns an AttachmentV2

Arguments
Name Description
input - UpdatePurchaseOrderAttachmentInput!

Example

Query
mutation updatePurchaseOrderAttachment($input: UpdatePurchaseOrderAttachmentInput!) {
  updatePurchaseOrderAttachment(input: $input) {
    id
    name
    tags {
      ...DriveTagFragment
    }
    link {
      ...AttachmentDownloadLinkFragment
    }
  }
}
Variables
{"input": UpdatePurchaseOrderAttachmentInput}
Response
{
  "data": {
    "updatePurchaseOrderAttachment": {
      "id": 4,
      "name": "xyz789",
      "tags": [DriveTag],
      "link": AttachmentDownloadLink
    }
  }
}

updatePurchaseOrderLine

Response

Returns a PurchaseOrderLine

Arguments
Name Description
input - UpdatePurchaseOrderLineInput!

Example

Query
mutation updatePurchaseOrderLine($input: UpdatePurchaseOrderLineInput!) {
  updatePurchaseOrderLine(input: $input) {
    id
    taxExempt
    number
    description
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    notes
    priceInPennies
    per
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    quantityOrdered
    totalInPennies
    releaseDate
    created
  }
}
Variables
{"input": UpdatePurchaseOrderLineInput}
Response
{
  "data": {
    "updatePurchaseOrderLine": {
      "id": "abc123",
      "taxExempt": true,
      "number": "abc123",
      "description": "abc123",
      "projectCostCode": ProjectCostCode,
      "notes": "abc123",
      "priceInPennies": 987,
      "per": "abc123",
      "unitOfMeasure": UnitOfMeasure,
      "quantityOrdered": 987,
      "totalInPennies": 123,
      "releaseDate": AWSDateTime,
      "created": AWSDateTime
    }
  }
}

updatePurchaseOrderReceiving

Response

Returns a PurchaseOrderReceiving

Arguments
Name Description
input - UpdatePurchaseOrderReceivingInput!

Example

Query
mutation updatePurchaseOrderReceiving($input: UpdatePurchaseOrderReceivingInput!) {
  updatePurchaseOrderReceiving(input: $input) {
    id
    purchaseOrderId
    date
    packingSlipNumber
    invoiceNumber
    invoiceAmountInPennies
    comments
    lines {
      ...PurchaseOrderReceivingLinesFragment
    }
    docs {
      ...AttachmentV2Fragment
    }
    images {
      ...ResizedAttachmentFragment
    }
  }
}
Variables
{"input": UpdatePurchaseOrderReceivingInput}
Response
{
  "data": {
    "updatePurchaseOrderReceiving": {
      "id": "xyz789",
      "purchaseOrderId": "xyz789",
      "date": AWSDateTime,
      "packingSlipNumber": "abc123",
      "invoiceNumber": "xyz789",
      "invoiceAmountInPennies": 987,
      "comments": "xyz789",
      "lines": PurchaseOrderReceivingLines,
      "docs": [AttachmentV2],
      "images": [ResizedAttachment]
    }
  }
}

updatePurchaseOrderReceivingLine

Response

Returns a PurchaseOrderReceivingLine

Arguments
Name Description
input - UpdatePurchaseOrderReceivingLineInput!

Example

Query
mutation updatePurchaseOrderReceivingLine($input: UpdatePurchaseOrderReceivingLineInput!) {
  updatePurchaseOrderReceivingLine(input: $input) {
    id
    receivingId
    purchaseOrderId
    lineNumber
    itemNumber
    itemDescription
    unitOfMeasureName
    totalOrdered
    previouslyReceived
    receivedToday
    total
    receivedInFull
    backOrdered
  }
}
Variables
{"input": UpdatePurchaseOrderReceivingLineInput}
Response
{
  "data": {
    "updatePurchaseOrderReceivingLine": {
      "id": "xyz789",
      "receivingId": "xyz789",
      "purchaseOrderId": "abc123",
      "lineNumber": "abc123",
      "itemNumber": "abc123",
      "itemDescription": "xyz789",
      "unitOfMeasureName": "abc123",
      "totalOrdered": 123,
      "previouslyReceived": 987,
      "receivedToday": 123,
      "total": 987,
      "receivedInFull": true,
      "backOrdered": 987
    }
  }
}

updateRateTemplate

Response

Returns a RateTemplate

Arguments
Name Description
input - UpdateRateTemplateInput!

Example

Query
mutation updateRateTemplate($input: UpdateRateTemplateInput!) {
  updateRateTemplate(input: $input) {
    id
    name
    companyId
    shift2 {
      ...ShiftDifferentialFragment
    }
    shift3 {
      ...ShiftDifferentialFragment
    }
    laborClasses {
      ...RateLaborClassesFragment
    }
    status
  }
}
Variables
{"input": UpdateRateTemplateInput}
Response
{
  "data": {
    "updateRateTemplate": {
      "id": "xyz789",
      "name": "xyz789",
      "companyId": "xyz789",
      "shift2": ShiftDifferential,
      "shift3": ShiftDifferential,
      "laborClasses": RateLaborClasses,
      "status": "ACTIVE"
    }
  }
}

updateRfi

Response

Returns a Rfi

Arguments
Name Description
input - UpdateRfiInput!
condition - ModelRfiConditionInput

Example

Query
mutation updateRfi(
  $input: UpdateRfiInput!,
  $condition: ModelRfiConditionInput
) {
  updateRfi(
    input: $input,
    condition: $condition
  ) {
    gcFileNumber
    gcNumber
    attachments {
      ...AttachmentsFragment
    }
    author {
      ...AuthorFragment
    }
    respondByDate
    date
    id
    projectId
    dateV2
    authorV2 {
      ...UserFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    revision
    customNo
    to {
      ...NestedContactFragment
    }
    subject
    respondByDateV2
    questionForClarification
    recommendedSolution
    isScheduleImpacted
    isCostImpacted
    isUrgent
    reference {
      ...RfiReferenceFragment
    }
    projectCostCodeAffected {
      ...ProjectCostCodeFragment
    }
    projectCostCodeAffectedNumber
    dateAnswered
    status
    statusComment
    answerToClarification
    driveAttachments {
      ...RfiAttachmentFragment
    }
    images {
      ...RfiImageFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateRfiInput,
  "condition": ModelRfiConditionInput
}
Response
{
  "data": {
    "updateRfi": {
      "gcFileNumber": "abc123",
      "gcNumber": "abc123",
      "attachments": Attachments,
      "author": Author,
      "respondByDate": AWSDate,
      "date": AWSDate,
      "id": 4,
      "projectId": "xyz789",
      "dateV2": AWSDateTime,
      "authorV2": User,
      "lastEditedBy": Author,
      "revision": 987,
      "customNo": "xyz789",
      "to": [NestedContact],
      "subject": "abc123",
      "respondByDateV2": AWSDateTime,
      "questionForClarification": "abc123",
      "recommendedSolution": "xyz789",
      "isScheduleImpacted": true,
      "isCostImpacted": false,
      "isUrgent": false,
      "reference": RfiReference,
      "projectCostCodeAffected": ProjectCostCode,
      "projectCostCodeAffectedNumber": "xyz789",
      "dateAnswered": AWSDateTime,
      "status": "PENDING",
      "statusComment": "abc123",
      "answerToClarification": "xyz789",
      "driveAttachments": [RfiAttachment],
      "images": [RfiImage],
      "emails": [Email],
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateRfiAttachment

Response

Returns a RfiAttachment

Arguments
Name Description
input - UpdateRfiAttachmentInput!

Example

Query
mutation updateRfiAttachment($input: UpdateRfiAttachmentInput!) {
  updateRfiAttachment(input: $input) {
    id
    name
    sortOrder
    tags {
      ...DriveTagFragment
    }
    link {
      ...RfiAttachmentDownloadLinkFragment
    }
  }
}
Variables
{"input": UpdateRfiAttachmentInput}
Response
{
  "data": {
    "updateRfiAttachment": {
      "id": "4",
      "name": "abc123",
      "sortOrder": "abc123",
      "tags": [DriveTag],
      "link": RfiAttachmentDownloadLink
    }
  }
}

updateSubmittalAttachment

Response

Returns an AttachmentV2

Arguments
Name Description
input - UpdateSubmittalAttachmentInput!

Example

Query
mutation updateSubmittalAttachment($input: UpdateSubmittalAttachmentInput!) {
  updateSubmittalAttachment(input: $input) {
    id
    name
    tags {
      ...DriveTagFragment
    }
    link {
      ...AttachmentDownloadLinkFragment
    }
  }
}
Variables
{"input": UpdateSubmittalAttachmentInput}
Response
{
  "data": {
    "updateSubmittalAttachment": {
      "id": 4,
      "name": "xyz789",
      "tags": [DriveTag],
      "link": AttachmentDownloadLink
    }
  }
}

updateSubmittalItem

Response

Returns a SubmittalItem

Arguments
Name Description
input - UpdateSubmittalItemInput!

Example

Query
mutation updateSubmittalItem($input: UpdateSubmittalItemInput!) {
  updateSubmittalItem(input: $input) {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Variables
{"input": UpdateSubmittalItemInput}
Response
{
  "data": {
    "updateSubmittalItem": {
      "created": "abc123",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "xyz789",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "xyz789",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "abc123",
      "name": "abc123",
      "notes": "xyz789",
      "number": "xyz789",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 987,
      "specSection": "abc123",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

updateSubmittalPackage

Response

Returns a SubmittalPackage

Arguments
Name Description
input - UpdateSubmittalPackageInput!

Example

Query
mutation updateSubmittalPackage($input: UpdateSubmittalPackageInput!) {
  updateSubmittalPackage(input: $input) {
    created
    dateSent
    description
    from {
      ...ContactFragment
    }
    id
    modified
    number
    name
    project {
      ...ProjectFragment
    }
    respondBy
    returnedOn
    status
    to {
      ...ContactFragment
    }
    submittalItems {
      ...SubmittalItemFragment
    }
    emails {
      ...EmailFragment
    }
  }
}
Variables
{"input": UpdateSubmittalPackageInput}
Response
{
  "data": {
    "updateSubmittalPackage": {
      "created": "xyz789",
      "dateSent": AWSDateTime,
      "description": "xyz789",
      "from": Contact,
      "id": "abc123",
      "modified": "abc123",
      "number": "xyz789",
      "name": "xyz789",
      "project": Project,
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "status": "DRAFT",
      "to": Contact,
      "submittalItems": [SubmittalItem],
      "emails": [Email]
    }
  }
}

updateTimeCard

Response

Returns a TimeCard

Arguments
Name Description
input - UpdateTimeCardInput!
condition - ModelTimeCardConditionInput

Example

Query
mutation updateTimeCard(
  $input: UpdateTimeCardInput!,
  $condition: ModelTimeCardConditionInput
) {
  updateTimeCard(
    input: $input,
    condition: $condition
  ) {
    comments
    date
    doubleTimeInMinutes
    hoursLost
    id
    laborClass
    overTimeInMinutes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    project {
      ...ProjectFragment
    }
    regularTimeInMinutes
    shift
    status
    timeCardProjectCostCodeNumber
    timeCardDailyReportId
    units
    user {
      ...UserFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateTimeCardInput,
  "condition": ModelTimeCardConditionInput
}
Response
{
  "data": {
    "updateTimeCard": {
      "comments": "abc123",
      "date": AWSDateTime,
      "doubleTimeInMinutes": 123,
      "hoursLost": 123,
      "id": "4",
      "laborClass": "xyz789",
      "overTimeInMinutes": 987,
      "projectCostCode": ProjectCostCode,
      "project": Project,
      "regularTimeInMinutes": 987,
      "shift": "SHIFT1",
      "status": "PENDING",
      "timeCardProjectCostCodeNumber": "abc123",
      "timeCardDailyReportId": "xyz789",
      "units": 987,
      "user": User,
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateUnitOfMeasure

Response

Returns a UnitOfMeasure

Arguments
Name Description
input - UpdateUnitOfMeasureInput!

Example

Query
mutation updateUnitOfMeasure($input: UpdateUnitOfMeasureInput!) {
  updateUnitOfMeasure(input: $input) {
    id
    companyId
    name
    abbreviation
  }
}
Variables
{"input": UpdateUnitOfMeasureInput}
Response
{
  "data": {
    "updateUnitOfMeasure": {
      "id": "4",
      "companyId": "xyz789",
      "name": "abc123",
      "abbreviation": "xyz789"
    }
  }
}

updateUser

Response

Returns a User

Arguments
Name Description
input - UpdateUserInput!
condition - ModelUserConditionInput

Example

Query
mutation updateUser(
  $input: UpdateUserInput!,
  $condition: ModelUserConditionInput
) {
  updateUser(
    input: $input,
    condition: $condition
  ) {
    id
    orgId
    companyAssociations
    defaultCompany
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AddressAllOptionalFragment
    }
    country
    useCompanyAddress
    emailSignature
    crew
    primaryLaborClass
    languagePreference
    dateDisplayPreference
    permissionGroup
    permissionGroupName
    accessLevel
    crewStatus
    type
    loginStatus
    addToNewProjects
    contact {
      ...ContactFragment
    }
    laborClassId
    laborClass {
      ...LaborClassFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateUserInput,
  "condition": ModelUserConditionInput
}
Response
{
  "data": {
    "updateUser": {
      "id": 4,
      "orgId": "xyz789",
      "companyAssociations": ["abc123"],
      "defaultCompany": "abc123",
      "givenName": "xyz789",
      "middleName": "abc123",
      "familyName": "abc123",
      "email": "xyz789",
      "employeeNo": "abc123",
      "role": "abc123",
      "jobTitle": "abc123",
      "officeNo": "xyz789",
      "mobileNo": "xyz789",
      "faxNo": "abc123",
      "address": AddressAllOptional,
      "country": "xyz789",
      "useCompanyAddress": true,
      "emailSignature": "xyz789",
      "crew": false,
      "primaryLaborClass": "xyz789",
      "languagePreference": "xyz789",
      "dateDisplayPreference": "xyz789",
      "permissionGroup": "xyz789",
      "permissionGroupName": "abc123",
      "accessLevel": "xyz789",
      "crewStatus": "AVAILABLE",
      "type": "STANDARD",
      "loginStatus": "ACTIVE",
      "addToNewProjects": true,
      "contact": Contact,
      "laborClassId": "xyz789",
      "laborClass": LaborClass,
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateUserLoginStatus

Response

Returns a User

Arguments
Name Description
input - UpdateUserLoginStatusInput!

Example

Query
mutation updateUserLoginStatus($input: UpdateUserLoginStatusInput!) {
  updateUserLoginStatus(input: $input) {
    id
    orgId
    companyAssociations
    defaultCompany
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AddressAllOptionalFragment
    }
    country
    useCompanyAddress
    emailSignature
    crew
    primaryLaborClass
    languagePreference
    dateDisplayPreference
    permissionGroup
    permissionGroupName
    accessLevel
    crewStatus
    type
    loginStatus
    addToNewProjects
    contact {
      ...ContactFragment
    }
    laborClassId
    laborClass {
      ...LaborClassFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{"input": UpdateUserLoginStatusInput}
Response
{
  "data": {
    "updateUserLoginStatus": {
      "id": 4,
      "orgId": "abc123",
      "companyAssociations": ["abc123"],
      "defaultCompany": "abc123",
      "givenName": "abc123",
      "middleName": "xyz789",
      "familyName": "xyz789",
      "email": "xyz789",
      "employeeNo": "abc123",
      "role": "xyz789",
      "jobTitle": "xyz789",
      "officeNo": "abc123",
      "mobileNo": "xyz789",
      "faxNo": "abc123",
      "address": AddressAllOptional,
      "country": "xyz789",
      "useCompanyAddress": false,
      "emailSignature": "xyz789",
      "crew": true,
      "primaryLaborClass": "xyz789",
      "languagePreference": "abc123",
      "dateDisplayPreference": "abc123",
      "permissionGroup": "xyz789",
      "permissionGroupName": "xyz789",
      "accessLevel": "abc123",
      "crewStatus": "AVAILABLE",
      "type": "STANDARD",
      "loginStatus": "ACTIVE",
      "addToNewProjects": true,
      "contact": Contact,
      "laborClassId": "xyz789",
      "laborClass": LaborClass,
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateVersionSet

Response

Returns a VersionSet

Arguments
Name Description
input - UpdateVersionSetInput!

Example

Query
mutation updateVersionSet($input: UpdateVersionSetInput!) {
  updateVersionSet(input: $input) {
    id
    createdBy {
      ...UserFragment
    }
    dateIssued
    project {
      ...ProjectFragment
    }
    name
  }
}
Variables
{"input": UpdateVersionSetInput}
Response
{
  "data": {
    "updateVersionSet": {
      "id": "xyz789",
      "createdBy": User,
      "dateIssued": AWSDateTime,
      "project": Project,
      "name": "abc123"
    }
  }
}

updateWeatherType

Response

Returns a WeatherType

Arguments
Name Description
input - UpdateWeatherTypeInput!
condition - ModelWeatherTypeConditionInput

Example

Query
mutation updateWeatherType(
  $input: UpdateWeatherTypeInput!,
  $condition: ModelWeatherTypeConditionInput
) {
  updateWeatherType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateWeatherTypeInput,
  "condition": ModelWeatherTypeConditionInput
}
Response
{
  "data": {
    "updateWeatherType": {
      "id": 4,
      "name": "xyz789",
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

updateWindType

Response

Returns a WindType

Arguments
Name Description
input - UpdateWindTypeInput!
condition - ModelWindTypeConditionInput

Example

Query
mutation updateWindType(
  $input: UpdateWindTypeInput!,
  $condition: ModelWindTypeConditionInput
) {
  updateWindType(
    input: $input,
    condition: $condition
  ) {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Variables
{
  "input": UpdateWindTypeInput,
  "condition": ModelWindTypeConditionInput
}
Response
{
  "data": {
    "updateWindType": {
      "id": 4,
      "name": "xyz789",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

Types

AWSDate

Description

The AWSDate scalar type provided by AWS AppSync, represents a valid extended ISO 8601 Date string. In other words, this scalar type accepts date strings of the form YYYY-MM-DD. The scalar can also accept "negative years" of the form -YYYY which correspond to years before 0000. For example, " -2017-05-01" and " -9999-01-01" are both valid dates. This scalar type can also accept an optional time zone offset. For example, " 1970-01-01", " 1970-01-01Z", " 1970-01-01-07:00" and " 1970-01-01+05:30" are all valid dates. The time zone offset must either be Z (representing the UTC time zone) or be in the format ±hh:mm:ss. The seconds field in the timezone offset will be considered valid even though it is not part of the ISO 8601 standard.

Example
AWSDate

AWSDateTime

Description

The AWSDateTime scalar type provided by AWS AppSync, represents a valid extended ISO 8601 DateTime string. In other words, this scalar type accepts datetime strings of the form YYYY-MM-DDThh:mm:ss.SSSZ. The scalar can also accept "negative years" of the form -YYYY which correspond to years before 0000. For example, " -2017-01-01T00:00Z" and " -9999-01-01T00:00Z" are both valid datetime strings. The field after the two digit seconds field is a nanoseconds field. It can accept between 1 and 9 digits. So, for example, " 1970-01-01T12:00:00.2Z", " 1970-01-01T12:00:00.277Z" and " 1970-01-01T12:00:00.123456789Z" are all valid datetime strings. The seconds and nanoseconds fields are optional (the seconds field must be specified if the nanoseconds field is to be used). The time zone offset is compulsory for this scalar. The time zone offset must either be Z (representing the UTC time zone) or be in the format ±hh:mm:ss. The seconds field in the timezone offset will be considered valid even though it is not part of the ISO 8601 standard.

Example
AWSDateTime

AWSTimestamp

Description

The AWSTimestamp scalar type provided by AWS AppSync, represents the number of seconds that have elapsed since 1970-01-01T00:00Z. Negative values are also accepted and these represent the number of seconds till 1970-01-01T00:00Z. Timestamps are serialized and deserialized as integers. The minimum supported timestamp value is -31557014167219200 which corresponds to -1000000000-01-01T00:00Z. The maximum supported timestamp value is 31556889864403199 which corresponds to 1000000000-12-31T23:59:59.999999999Z.

Example
AWSTimestamp

Address

Fields
Field Name Description
street1 - String!
street2 - String
city - String!
state - String!
zipCode - String!
county - String
Example
{
  "street1": "xyz789",
  "street2": "abc123",
  "city": "abc123",
  "state": "xyz789",
  "zipCode": "abc123",
  "county": "abc123"
}

AddressAllOptional

Fields
Field Name Description
street1 - String
street2 - String
city - String
state - String
zipCode - String
county - String
country - String
Example
{
  "street1": "xyz789",
  "street2": "xyz789",
  "city": "xyz789",
  "state": "xyz789",
  "zipCode": "abc123",
  "county": "xyz789",
  "country": "abc123"
}

AddressAllOptionalInput

Fields
Input Field Description
street1 - String
street2 - String
city - String
state - String
zipCode - String
county - String
country - String
Example
{
  "street1": "abc123",
  "street2": "xyz789",
  "city": "xyz789",
  "state": "xyz789",
  "zipCode": "xyz789",
  "county": "abc123",
  "country": "xyz789"
}

AddressInput

Fields
Input Field Description
street1 - String!
street2 - String
city - String!
state - String!
zipCode - String!
county - String
Example
{
  "street1": "xyz789",
  "street2": "abc123",
  "city": "abc123",
  "state": "abc123",
  "zipCode": "xyz789",
  "county": "xyz789"
}

AddressInputAllOptional

Fields
Input Field Description
street1 - String
street2 - String
city - String
state - String
zipCode - String
Example
{
  "street1": "abc123",
  "street2": "abc123",
  "city": "xyz789",
  "state": "xyz789",
  "zipCode": "abc123"
}

AdminAddressAllOptional

Fields
Field Name Description
street1 - String
street2 - String
city - String
state - String
zipCode - String
county - String
Example
{
  "street1": "xyz789",
  "street2": "xyz789",
  "city": "abc123",
  "state": "xyz789",
  "zipCode": "abc123",
  "county": "abc123"
}

AdminCompany

Fields
Field Name Description
id - ID!
name - String!
address - Address!
country - String!
phone - String!
fax - String
orgId - ID!
hierarchy - String
Example
{
  "id": 4,
  "name": "abc123",
  "address": Address,
  "country": "abc123",
  "phone": "xyz789",
  "fax": "xyz789",
  "orgId": 4,
  "hierarchy": "xyz789"
}

AdminUser

Fields
Field Name Description
id - ID
givenName - String!
middleName - String
familyName - String!
email - String!
employeeNo - String
role - String
jobTitle - String
officeNo - String
mobileNo - String
faxNo - String
address - AdminAddressAllOptional
useCompanyAddress - Boolean
emailSignature - String
languagePreference - String
dateDisplayPreference - String
_version - Int!
Example
{
  "id": 4,
  "givenName": "abc123",
  "middleName": "abc123",
  "familyName": "xyz789",
  "email": "xyz789",
  "employeeNo": "abc123",
  "role": "abc123",
  "jobTitle": "abc123",
  "officeNo": "abc123",
  "mobileNo": "xyz789",
  "faxNo": "xyz789",
  "address": AdminAddressAllOptional,
  "useCompanyAddress": true,
  "emailSignature": "abc123",
  "languagePreference": "abc123",
  "dateDisplayPreference": "xyz789",
  "_version": 987
}

Attachment

Fields
Field Name Description
id - String
key - String
link - String
algorithm - String
credential - String
date - String
token - String
policy - String
signature - String
Example
{
  "id": "abc123",
  "key": "abc123",
  "link": "abc123",
  "algorithm": "xyz789",
  "credential": "abc123",
  "date": "xyz789",
  "token": "abc123",
  "policy": "xyz789",
  "signature": "abc123"
}

AttachmentGroup

Fields
Field Name Description
original - Attachment
thumbnail - Attachment
web - Attachment
type - String
Example
{
  "original": Attachment,
  "thumbnail": Attachment,
  "web": Attachment,
  "type": "abc123"
}

AttachmentGroupInput

Fields
Input Field Description
original - AttachmentInput
thumbnail - AttachmentInput
web - AttachmentInput
type - String
Example
{
  "original": AttachmentInput,
  "thumbnail": AttachmentInput,
  "web": AttachmentInput,
  "type": "xyz789"
}

AttachmentInput

Fields
Input Field Description
id - String
key - String
link - String
algorithm - String
credential - String
date - String
token - String
policy - String
signature - String
Example
{
  "id": "xyz789",
  "key": "xyz789",
  "link": "xyz789",
  "algorithm": "abc123",
  "credential": "abc123",
  "date": "xyz789",
  "token": "xyz789",
  "policy": "xyz789",
  "signature": "abc123"
}

AttachmentV2

Fields
Field Name Description
id - ID!
name - String!
tags - [DriveTag!]
link - AttachmentDownloadLink
Example
{
  "id": 4,
  "name": "xyz789",
  "tags": [DriveTag],
  "link": AttachmentDownloadLink
}

Attachments

Fields
Field Name Description
count - Int
items - [AttachmentGroup!]
Example
{"count": 987, "items": [AttachmentGroup]}

AttachmentsInput

Fields
Input Field Description
count - Int
items - [AttachmentGroupInput!]
Example
{"count": 123, "items": [AttachmentGroupInput]}

AuthToken

Fields
Field Name Description
accessToken - String!
idToken - String!
refreshToken - String!
permissions - [Permission!]
Example
{
  "accessToken": "xyz789",
  "idToken": "xyz789",
  "refreshToken": "abc123",
  "permissions": [Permission]
}

Author

Fields
Field Name Description
userId - String
name - String
Example
{
  "userId": "abc123",
  "name": "xyz789"
}

AuthorInput

Fields
Input Field Description
userId - String
name - String
Example
{
  "userId": "abc123",
  "name": "xyz789"
}

AvailabilityStatus

Values
Enum Value Description

AVAILABLE

UNAVAILABLE

Example
"AVAILABLE"

Boolean

Description

Built-in Boolean

Example
true

ChangeOrderRequest

Fields
Field Name Description
approvalNumber - String
approvedAmountInPennies - Int
created - String
date - AWSDateTime
dateApproved - AWSDateTime
dateSent - AWSDateTime
daysValid - Int
docs - [AttachmentV2!]!
emails - [Email!]!
id - String!
images - [ResizedAttachment!]!
internalNotes - String
itemSummary - ChangeOrderRequestItemSummary
modified - String
name - String!
number - String!
project - Project!
referenceNumberAsi - String
referenceNumberGcCor - String
referenceNumberOther - String
referenceNumberOwnerCor - String
referenceNumberPco - String
referenceNumberRfi - String
respondBy - AWSDateTime
returnedOn - AWSDateTime
returnToContact - Contact
revision - Int
scheduleImpactComments - String
scheduleImpactDays - Int
scopeOfWork - String
sendByDate - AWSDateTime
smallTools - ChangeOrderRequestSmallTools
status - ChangeOrderRequestStatus
toContact - Contact
worksheet - ChangeOrderRequestWorksheet
workType - ChangeOrderRequestWorkType
laborLineItems - ChangeOrderRequestLaborLineItems
materialLineItems - ChangeOrderRequestMaterialLineItems
equipmentLineItems - ChangeOrderRequestEquipmentLineItems
subcontractorLineItems - ChangeOrderRequestSubcontractorLineItems
overheadLineItems - ChangeOrderRequestOverheadLineItems
otherLineItems - ChangeOrderRequestOtherLineItems
Example
{
  "approvalNumber": "xyz789",
  "approvedAmountInPennies": 123,
  "created": "abc123",
  "date": AWSDateTime,
  "dateApproved": AWSDateTime,
  "dateSent": AWSDateTime,
  "daysValid": 123,
  "docs": [AttachmentV2],
  "emails": [Email],
  "id": "abc123",
  "images": [ResizedAttachment],
  "internalNotes": "xyz789",
  "itemSummary": ChangeOrderRequestItemSummary,
  "modified": "xyz789",
  "name": "xyz789",
  "number": "xyz789",
  "project": Project,
  "referenceNumberAsi": "abc123",
  "referenceNumberGcCor": "abc123",
  "referenceNumberOther": "xyz789",
  "referenceNumberOwnerCor": "abc123",
  "referenceNumberPco": "xyz789",
  "referenceNumberRfi": "xyz789",
  "respondBy": AWSDateTime,
  "returnedOn": AWSDateTime,
  "returnToContact": Contact,
  "revision": 123,
  "scheduleImpactComments": "xyz789",
  "scheduleImpactDays": 987,
  "scopeOfWork": "xyz789",
  "sendByDate": AWSDateTime,
  "smallTools": ChangeOrderRequestSmallTools,
  "status": "DRAFT",
  "toContact": Contact,
  "worksheet": ChangeOrderRequestWorksheet,
  "workType": "ALLOWANCE",
  "laborLineItems": ChangeOrderRequestLaborLineItems,
  "materialLineItems": ChangeOrderRequestMaterialLineItems,
  "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
  "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
  "overheadLineItems": ChangeOrderRequestOverheadLineItems,
  "otherLineItems": ChangeOrderRequestOtherLineItems
}

ChangeOrderRequestEmailInput

Fields
Input Field Description
to - [String!]!
cc - [String!]!
bcc - [String!]!
subject - String
comments - String
entityString - String!
type - PdfChangeOrderType!
Example
{
  "to": ["abc123"],
  "cc": ["abc123"],
  "bcc": ["abc123"],
  "subject": "xyz789",
  "comments": "xyz789",
  "entityString": "xyz789",
  "type": "CHANGE_ORDER_LUMP_SUM"
}

ChangeOrderRequestEquipmentLineItem

Fields
Field Name Description
costInPennies - Int!
id - String!
markup - Float
notes - String
projectCostCode - ProjectCostCode
totalInPennies - Int!
tags - [WorksheetTag!]!
unitOfMeasure - UnitOfMeasure
customUnitOfMeasure - String
rateInPennies - Int
sellPriceInPennies - Int
quantity - Float
customEquipment - String
Example
{
  "costInPennies": 987,
  "id": "abc123",
  "markup": 123.45,
  "notes": "xyz789",
  "projectCostCode": ProjectCostCode,
  "totalInPennies": 987,
  "tags": [WorksheetTag],
  "unitOfMeasure": UnitOfMeasure,
  "customUnitOfMeasure": "xyz789",
  "rateInPennies": 987,
  "sellPriceInPennies": 987,
  "quantity": 123.45,
  "customEquipment": "abc123"
}

ChangeOrderRequestEquipmentLineItems

Fields
Field Name Description
items - [ChangeOrderRequestEquipmentLineItem!]!
cursor - String
count - Int
Example
{
  "items": [ChangeOrderRequestEquipmentLineItem],
  "cursor": "abc123",
  "count": 987
}

ChangeOrderRequestItemCategorySummary

Fields
Field Name Description
bond - Float
custom - Float
overhead - Float
overrideInPennies - Int
profit - Float
tax - Float
totalInPennies - Int!
totalWithMarkupInPennies - Int!
Example
{
  "bond": 987.65,
  "custom": 987.65,
  "overhead": 123.45,
  "overrideInPennies": 987,
  "profit": 987.65,
  "tax": 987.65,
  "totalInPennies": 987,
  "totalWithMarkupInPennies": 123
}

ChangeOrderRequestItemCategorySummaryInput

Fields
Input Field Description
bond - Float
custom - Float
overhead - Float
overrideInPennies - Int
profit - Float
tax - Float
totalInPennies - Int!
totalWithMarkupInPennies - Int!
Example
{
  "bond": 987.65,
  "custom": 987.65,
  "overhead": 123.45,
  "overrideInPennies": 987,
  "profit": 987.65,
  "tax": 123.45,
  "totalInPennies": 123,
  "totalWithMarkupInPennies": 123
}

ChangeOrderRequestItemSummary

Example
{
  "equipment": ChangeOrderRequestItemCategorySummary,
  "labor": ChangeOrderRequestItemCategorySummary,
  "material": ChangeOrderRequestItemCategorySummary,
  "other": ChangeOrderRequestItemCategorySummary,
  "overhead": ChangeOrderRequestItemCategorySummary,
  "subcontractor": ChangeOrderRequestItemCategorySummary,
  "smallTools": ChangeOrderRequestItemCategorySummary,
  "totals": ChangeOrderRequestItemSummaryTotals,
  "useCompoundMarkups": false,
  "grandTotalInPennies": 987,
  "lumpSumOverrideInPennies": 987
}

ChangeOrderRequestItemSummaryInput

Example
{
  "equipment": ChangeOrderRequestItemCategorySummaryInput,
  "labor": ChangeOrderRequestItemCategorySummaryInput,
  "material": ChangeOrderRequestItemCategorySummaryInput,
  "other": ChangeOrderRequestItemCategorySummaryInput,
  "overhead": ChangeOrderRequestItemCategorySummaryInput,
  "subcontractor": ChangeOrderRequestItemCategorySummaryInput,
  "smallTools": ChangeOrderRequestItemCategorySummaryInput,
  "totals": ChangeOrderRequestItemSummaryTotalsInput,
  "useCompoundMarkups": true,
  "grandTotalInPennies": 987,
  "lumpSumOverrideInPennies": 123
}

ChangeOrderRequestItemSummaryTotals

Fields
Field Name Description
bondInPennies - Int!
customInPennies - Int!
overheadInPennies - Int!
override - Float!
profitInPennies - Int!
taxInPennies - Int!
totalInPennies - Int!
totalWithMarkupInPennies - Int!
Example
{
  "bondInPennies": 987,
  "customInPennies": 987,
  "overheadInPennies": 987,
  "override": 123.45,
  "profitInPennies": 987,
  "taxInPennies": 123,
  "totalInPennies": 123,
  "totalWithMarkupInPennies": 987
}

ChangeOrderRequestItemSummaryTotalsInput

Fields
Input Field Description
bondInPennies - Int!
customInPennies - Int!
overheadInPennies - Int!
override - Float!
profitInPennies - Int!
taxInPennies - Int!
totalInPennies - Int!
totalWithMarkupInPennies - Int!
Example
{
  "bondInPennies": 987,
  "customInPennies": 987,
  "overheadInPennies": 987,
  "override": 123.45,
  "profitInPennies": 123,
  "taxInPennies": 987,
  "totalInPennies": 987,
  "totalWithMarkupInPennies": 987
}

ChangeOrderRequestLaborLineItem

Fields
Field Name Description
costInPennies - Int!
id - String!
markup - Float
notes - String
projectCostCode - ProjectCostCode
totalInPennies - Int!
tags - [WorksheetTag!]!
customLaborClass - String
hoursInMinutes - Int
laborClass - LaborClass
rateInPennies - Int
sellRateInPennies - Int
workers - Float
Example
{
  "costInPennies": 987,
  "id": "abc123",
  "markup": 123.45,
  "notes": "abc123",
  "projectCostCode": ProjectCostCode,
  "totalInPennies": 123,
  "tags": [WorksheetTag],
  "customLaborClass": "xyz789",
  "hoursInMinutes": 987,
  "laborClass": LaborClass,
  "rateInPennies": 123,
  "sellRateInPennies": 123,
  "workers": 123.45
}

ChangeOrderRequestLaborLineItems

Fields
Field Name Description
items - [ChangeOrderRequestLaborLineItem!]!
cursor - String
count - Int
Example
{
  "items": [ChangeOrderRequestLaborLineItem],
  "cursor": "abc123",
  "count": 987
}

ChangeOrderRequestMaterialLineItem

Fields
Field Name Description
costInPennies - Int!
id - String!
markup - Float
notes - String
projectCostCode - ProjectCostCode
totalInPennies - Int!
tags - [WorksheetTag!]!
unitOfMeasure - UnitOfMeasure
customUnitOfMeasure - String
rateInPennies - Int
sellPriceInPennies - Int
quantity - Float
customMaterial - String
Example
{
  "costInPennies": 987,
  "id": "xyz789",
  "markup": 123.45,
  "notes": "abc123",
  "projectCostCode": ProjectCostCode,
  "totalInPennies": 987,
  "tags": [WorksheetTag],
  "unitOfMeasure": UnitOfMeasure,
  "customUnitOfMeasure": "xyz789",
  "rateInPennies": 123,
  "sellPriceInPennies": 987,
  "quantity": 987.65,
  "customMaterial": "xyz789"
}

ChangeOrderRequestMaterialLineItems

Fields
Field Name Description
items - [ChangeOrderRequestMaterialLineItem!]!
cursor - String
count - Int
Example
{
  "items": [ChangeOrderRequestMaterialLineItem],
  "cursor": "xyz789",
  "count": 123
}

ChangeOrderRequestOtherLineItem

Fields
Field Name Description
costInPennies - Int!
id - String!
markup - Float
notes - String
projectCostCode - ProjectCostCode
totalInPennies - Int!
tags - [WorksheetTag!]!
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasure - UnitOfMeasure
Example
{
  "costInPennies": 987,
  "id": "xyz789",
  "markup": 123.45,
  "notes": "xyz789",
  "projectCostCode": ProjectCostCode,
  "totalInPennies": 123,
  "tags": [WorksheetTag],
  "customUnitOfMeasure": "abc123",
  "description": "xyz789",
  "priceInPennies": 123,
  "quantity": 123.45,
  "sellPriceInPennies": 123,
  "unitOfMeasure": UnitOfMeasure
}

ChangeOrderRequestOtherLineItems

Fields
Field Name Description
items - [ChangeOrderRequestOtherLineItem!]!
cursor - String
count - Int
Example
{
  "items": [ChangeOrderRequestOtherLineItem],
  "cursor": "abc123",
  "count": 987
}

ChangeOrderRequestOverheadLineItem

Fields
Field Name Description
costInPennies - Int!
id - String!
markup - Float
notes - String
projectCostCode - ProjectCostCode
totalInPennies - Int!
tags - [WorksheetTag!]!
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasure - UnitOfMeasure
Example
{
  "costInPennies": 987,
  "id": "xyz789",
  "markup": 987.65,
  "notes": "xyz789",
  "projectCostCode": ProjectCostCode,
  "totalInPennies": 123,
  "tags": [WorksheetTag],
  "customUnitOfMeasure": "abc123",
  "description": "abc123",
  "priceInPennies": 987,
  "quantity": 987.65,
  "sellPriceInPennies": 987,
  "unitOfMeasure": UnitOfMeasure
}

ChangeOrderRequestOverheadLineItems

Fields
Field Name Description
items - [ChangeOrderRequestOverheadLineItem!]!
cursor - String
count - Int
Example
{
  "items": [ChangeOrderRequestOverheadLineItem],
  "cursor": "abc123",
  "count": 987
}

ChangeOrderRequestSearchFacets

Fields
Field Name Description
status - [ChangeOrderRequestStatusSearchFacet!]!
workType - [ChangeOrderRequestWorkTypeSearchFacet!]!
showAllRevisions - [SearchFacetBoolean!]!
Example
{
  "status": [ChangeOrderRequestStatusSearchFacet],
  "workType": [ChangeOrderRequestWorkTypeSearchFacet],
  "showAllRevisions": [SearchFacetBoolean]
}

ChangeOrderRequestSearchFilterInput

Example
{
  "status": SearchFilterByChangeOrderRequestStatusInput,
  "workType": SearchFilterByChangeOrderRequestWorkTypeInput,
  "showAllRevisions": SearchFilterByBooleanInput,
  "projects": SearchFilterByProjectInput
}

ChangeOrderRequestSearchHighlight

Fields
Field Name Description
name - String
Example
{"name": "xyz789"}

ChangeOrderRequestSearchResult

Fields
Field Name Description
document - ChangeOrderRequestSearchResultDocument!
highlight - ChangeOrderRequestSearchHighlight
Example
{
  "document": ChangeOrderRequestSearchResultDocument,
  "highlight": ChangeOrderRequestSearchHighlight
}

ChangeOrderRequestSearchResultDocument

Fields
Field Name Description
entity - ChangeOrderRequest!
Example
{"entity": ChangeOrderRequest}

ChangeOrderRequestSearchResults

Fields
Field Name Description
items - [ChangeOrderRequestSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [ChangeOrderRequestSearchResult],
  "pagination": SearchResultsPagination
}

ChangeOrderRequestSearchSortByColumn

Values
Enum Value Description

DATE_SENT

NAME

NUMBER

RETURNED_ON

STATUS

WORK_TYPE

AMOUNT_QUOTED

Example
"DATE_SENT"

ChangeOrderRequestSettings

Fields
Field Name Description
defaultReservationOfRightsVerbiage - String
Example
{
  "defaultReservationOfRightsVerbiage": "xyz789"
}

ChangeOrderRequestSettingsInput

Fields
Input Field Description
defaultReservationOfRightsVerbiage - String
Example
{
  "defaultReservationOfRightsVerbiage": "abc123"
}

ChangeOrderRequestSmallTools

Fields
Field Name Description
description - String
notes - String
percentLabor - Float
sellPriceInPennies - Int
totalInPennies - Int!
totalLaborInPennies - Int!
Example
{
  "description": "abc123",
  "notes": "xyz789",
  "percentLabor": 123.45,
  "sellPriceInPennies": 987,
  "totalInPennies": 123,
  "totalLaborInPennies": 123
}

ChangeOrderRequestSmallToolsInput

Fields
Input Field Description
description - String
notes - String
percentLabor - Float
sellPriceInPennies - Int
totalInPennies - Int!
totalLaborInPennies - Int!
Example
{
  "description": "xyz789",
  "notes": "xyz789",
  "percentLabor": 987.65,
  "sellPriceInPennies": 987,
  "totalInPennies": 987,
  "totalLaborInPennies": 123
}

ChangeOrderRequestStatus

Values
Enum Value Description

DRAFT

SENT

PRICING

RETURNED

REVISEANDRESUBMIT

APPROVED

REJECTED

CANCELED

VOID

REVISED

Example
"DRAFT"

ChangeOrderRequestStatusSearchFacet

Fields
Field Name Description
name - String!
key - ChangeOrderRequestStatus!
count - Int
Example
{
  "name": "abc123",
  "key": "DRAFT",
  "count": 123
}

ChangeOrderRequestSubcontractorLineItem

Fields
Field Name Description
costInPennies - Int!
id - String!
markup - Float
notes - String
projectCostCode - ProjectCostCode
totalInPennies - Int!
tags - [WorksheetTag!]!
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasure - UnitOfMeasure
Example
{
  "costInPennies": 987,
  "id": "abc123",
  "markup": 987.65,
  "notes": "xyz789",
  "projectCostCode": ProjectCostCode,
  "totalInPennies": 987,
  "tags": [WorksheetTag],
  "customUnitOfMeasure": "abc123",
  "description": "xyz789",
  "priceInPennies": 123,
  "quantity": 987.65,
  "sellPriceInPennies": 987,
  "unitOfMeasure": UnitOfMeasure
}

ChangeOrderRequestSubcontractorLineItems

Fields
Field Name Description
items - [ChangeOrderRequestSubcontractorLineItem!]!
cursor - String
count - Int
Example
{
  "items": [ChangeOrderRequestSubcontractorLineItem],
  "cursor": "xyz789",
  "count": 987
}

ChangeOrderRequestWorkType

Values
Enum Value Description

ALLOWANCE

BUDGETADJUSTMENT

DIRECTEDCHANGE

FIELDWORK

OWNERREQUESTED

PRICEDONOTPROCEED

PRICENOTTOEXCEED

PRICEPROCEED

SUBCONTRACTORREQUESTED

TANDM

WORKUNDERPROTEST

Example
"ALLOWANCE"

ChangeOrderRequestWorkTypeSearchFacet

Fields
Field Name Description
name - String!
key - ChangeOrderRequestWorkType!
count - Int
Example
{
  "name": "xyz789",
  "key": "ALLOWANCE",
  "count": 123
}

ChangeOrderRequestWorksheet

Fields
Field Name Description
equipmentCategoryNotes - String
equipmentTotalInPennies - Int!
equipmentTotalCostInPennies - Int!
laborCategoryNotes - String
laborTotalInPennies - Int!
laborTotalCostInPennies - Int!
laborTotalHoursInMinutes - Int!
materialsCategoryNotes - String
materialsTotalInPennies - Int!
materialsTotalCostInPennies - Int!
otherCategoryNotes - String
otherTotalInPennies - Int!
otherTotalCostInPennies - Int!
overheadCategoryNotes - String
overheadTotalInPennies - Int!
overheadTotalCostInPennies - Int!
subcontractorCategoryNotes - String
subcontractorTotalInPennies - Int!
subcontractorTotalCostInPennies - Int!
Example
{
  "equipmentCategoryNotes": "abc123",
  "equipmentTotalInPennies": 987,
  "equipmentTotalCostInPennies": 123,
  "laborCategoryNotes": "abc123",
  "laborTotalInPennies": 987,
  "laborTotalCostInPennies": 123,
  "laborTotalHoursInMinutes": 987,
  "materialsCategoryNotes": "abc123",
  "materialsTotalInPennies": 123,
  "materialsTotalCostInPennies": 123,
  "otherCategoryNotes": "abc123",
  "otherTotalInPennies": 123,
  "otherTotalCostInPennies": 987,
  "overheadCategoryNotes": "xyz789",
  "overheadTotalInPennies": 987,
  "overheadTotalCostInPennies": 123,
  "subcontractorCategoryNotes": "xyz789",
  "subcontractorTotalInPennies": 123,
  "subcontractorTotalCostInPennies": 123
}

ChangeOrderRequestWorksheetInput

Fields
Input Field Description
equipmentCategoryNotes - String
equipmentTotalInPennies - Int!
equipmentTotalCostInPennies - Int!
laborCategoryNotes - String
laborTotalInPennies - Int!
laborTotalCostInPennies - Int!
laborTotalHoursInMinutes - Int!
materialsCategoryNotes - String
materialsTotalInPennies - Int!
materialsTotalCostInPennies - Int!
otherCategoryNotes - String
otherTotalInPennies - Int!
otherTotalCostInPennies - Int!
overheadCategoryNotes - String
overheadTotalInPennies - Int!
overheadTotalCostInPennies - Int!
subcontractorCategoryNotes - String
subcontractorTotalInPennies - Int!
subcontractorTotalCostInPennies - Int!
Example
{
  "equipmentCategoryNotes": "abc123",
  "equipmentTotalInPennies": 987,
  "equipmentTotalCostInPennies": 987,
  "laborCategoryNotes": "xyz789",
  "laborTotalInPennies": 123,
  "laborTotalCostInPennies": 123,
  "laborTotalHoursInMinutes": 123,
  "materialsCategoryNotes": "xyz789",
  "materialsTotalInPennies": 123,
  "materialsTotalCostInPennies": 123,
  "otherCategoryNotes": "abc123",
  "otherTotalInPennies": 987,
  "otherTotalCostInPennies": 987,
  "overheadCategoryNotes": "xyz789",
  "overheadTotalInPennies": 123,
  "overheadTotalCostInPennies": 123,
  "subcontractorCategoryNotes": "xyz789",
  "subcontractorTotalInPennies": 987,
  "subcontractorTotalCostInPennies": 987
}

CleanupTask

Fields
Field Name Description
id - ID!
orgId - String!
status - CleanupTaskStatusType
Example
{
  "id": "4",
  "orgId": "xyz789",
  "status": "CREATED"
}

CleanupTaskStatusType

Values
Enum Value Description

CREATED

FAILED

IN_PROGRESS

SUCCEEDED

Example
"CREATED"

Company

Fields
Field Name Description
id - ID!
name - String!
address - Address!
country - String!
phone - String!
fax - String
orgId - ID!
hierarchy - String
keywords - [Keyword!]
logo - Attachment
timeCardSettings - TimeCardSettings
dailyReportSettings - DailyReportSettings
rfiSettings - RFISettings
changeOrderRequestSettings - ChangeOrderRequestSettings
purchaseOrderSettings - PurchaseOrderSettings
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": "4",
  "name": "xyz789",
  "address": Address,
  "country": "abc123",
  "phone": "abc123",
  "fax": "abc123",
  "orgId": 4,
  "hierarchy": "xyz789",
  "keywords": [Keyword],
  "logo": Attachment,
  "timeCardSettings": TimeCardSettings,
  "dailyReportSettings": DailyReportSettings,
  "rfiSettings": RFISettings,
  "changeOrderRequestSettings": ChangeOrderRequestSettings,
  "purchaseOrderSettings": PurchaseOrderSettings,
  "_version": 123,
  "_deleted": true,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

CompanyCostCode

Fields
Field Name Description
id - ID
companyId - String!
number - String!
name - String!
status - CostCodeStatus!
categories - [CostCodeCategory!]
addToNewProjects - Boolean!
projectCostCodes - ProjectCostCodes
Example
{
  "id": 4,
  "companyId": "abc123",
  "number": "xyz789",
  "name": "xyz789",
  "status": "ACTIVE",
  "categories": ["LABOR"],
  "addToNewProjects": false,
  "projectCostCodes": ProjectCostCodes
}

ConfirmForgotPasswordInput

Fields
Input Field Description
username - String!
confirmationCode - String!
newPassword - String!
Example
{
  "username": "abc123",
  "confirmationCode": "xyz789",
  "newPassword": "xyz789"
}

ConstructionDocumentType

Values
Enum Value Description

FIELD_NOTE

DAILY_REPORT

RFI

SUBMITTAL

SUBMITTAL_PACKAGE

CHANGE_ORDER

PURCHASE_ORDER

Example
"FIELD_NOTE"

Contact

Fields
Field Name Description
id - ID!
firstName - String
middleName - String
lastName - String
jobTitle - String
email - String
address - AddressAllOptional
country - String
office - String
mobile - String
fax - String
notes - String
businessName - String!
businessType - String!
status - AvailabilityStatus
apVendor - Boolean
vendorId - String
website - String
cannotDelete - Boolean
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": "4",
  "firstName": "xyz789",
  "middleName": "xyz789",
  "lastName": "abc123",
  "jobTitle": "abc123",
  "email": "abc123",
  "address": AddressAllOptional,
  "country": "abc123",
  "office": "abc123",
  "mobile": "xyz789",
  "fax": "abc123",
  "notes": "xyz789",
  "businessName": "xyz789",
  "businessType": "xyz789",
  "status": "AVAILABLE",
  "apVendor": false,
  "vendorId": "xyz789",
  "website": "xyz789",
  "cannotDelete": false,
  "_version": 987,
  "_deleted": false,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

ContactSearchFilterInput

Fields
Input Field Description
businessType - SearchFilterByStringInput
isApVendor - SearchFilterByBooleanInput
status - SearchFilterByAvailabilityStatusInput
Example
{
  "businessType": SearchFilterByStringInput,
  "isApVendor": SearchFilterByBooleanInput,
  "status": SearchFilterByAvailabilityStatusInput
}

ContactSearchHighlight

Fields
Field Name Description
name - String
jobTitle - String
businessName - String
businessType - String
notes - String
Example
{
  "name": "xyz789",
  "jobTitle": "xyz789",
  "businessName": "xyz789",
  "businessType": "xyz789",
  "notes": "abc123"
}

ContactSearchResult

Fields
Field Name Description
document - ContactSearchResultDocument!
highlight - ContactSearchHighlight
Example
{
  "document": ContactSearchResultDocument,
  "highlight": ContactSearchHighlight
}

ContactSearchResultDocument

Fields
Field Name Description
id - ID!
name - String
jobTitle - String
businessName - String!
businessType - String!
apVendor - Boolean
notes - String
status - AvailabilityStatus
email - String
Example
{
  "id": "4",
  "name": "xyz789",
  "jobTitle": "abc123",
  "businessName": "xyz789",
  "businessType": "abc123",
  "apVendor": true,
  "notes": "abc123",
  "status": "AVAILABLE",
  "email": "abc123"
}

ContactSearchResults

Fields
Field Name Description
items - [ContactSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [ContactSearchResult],
  "pagination": SearchResultsPagination
}

ContactSearchSortByColumn

Values
Enum Value Description

NAME

JOB_TITLE

BUSINESS_NAME

BUSINESS_TYPE

AP_VENDOR

NOTES

STATUS

Example
"NAME"

CopyChangeOrderRequestInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

CopyPurchaseOrderInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

CostCodeCategory

Values
Enum Value Description

LABOR

OVERHEAD_LABOR

MATERIALS

EQUIPMENT

SUBCONTRACTORS

OVERHEAD

OTHER

Example
"LABOR"

CostCodeSearchContextInput

Fields
Input Field Description
projects - SearchFilterByProjectInput
Example
{"projects": SearchFilterByProjectInput}

CostCodeSearchFilterInput

Example
{
  "categories": SearchFilterByCostCodeCategoryInput,
  "status": SearchFilterByCostCodeStatusInput,
  "companies": SearchFilterByCompanyInput,
  "projects": SearchFilterByProjectInput,
  "type": SearchFilterByCostCodeTypeInput
}

CostCodeSearchHighlight

Fields
Field Name Description
number - String
name - String
Example
{
  "number": "abc123",
  "name": "abc123"
}

CostCodeSearchResult

Fields
Field Name Description
document - CostCodeSearchResultDocument!
highlight - CostCodeSearchHighlight
Example
{
  "document": CostCodeSearchResultDocument,
  "highlight": CostCodeSearchHighlight
}

CostCodeSearchResultDocument

Fields
Field Name Description
entity - CostCodeUnifiedForSearch!
type - CostCodeSearchType!
Example
{"entity": CostCodeUnifiedForSearch, "type": "COMPANY"}

CostCodeSearchResults

Fields
Field Name Description
items - [CostCodeSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [CostCodeSearchResult],
  "pagination": SearchResultsPagination
}

CostCodeSearchSortByColumn

Values
Enum Value Description

NAME

NUMBER

Example
"NAME"

CostCodeSearchType

Values
Enum Value Description

COMPANY

PROJECT

Example
"COMPANY"

CostCodeStatus

Values
Enum Value Description

ACTIVE

DEACTIVATED

Example
"ACTIVE"

CostCodeUnifiedForSearch

Fields
Field Name Description
id - ID
companyId - String
projectId - String
number - String!
name - String!
status - CostCodeStatus!
categories - [CostCodeCategory!]
addToNewProjects - Boolean
projectBudget - ProjectBudget
Example
{
  "id": "4",
  "companyId": "xyz789",
  "projectId": "abc123",
  "number": "abc123",
  "name": "xyz789",
  "status": "ACTIVE",
  "categories": ["LABOR"],
  "addToNewProjects": true,
  "projectBudget": ProjectBudget
}

CreateAdminCompanyInput

Fields
Input Field Description
id - ID
orgId - ID!
name - String!
address - AddressInput!
country - String!
phone - String!
fax - String
hierarchy - String
Example
{
  "id": 4,
  "orgId": "4",
  "name": "abc123",
  "address": AddressInput,
  "country": "xyz789",
  "phone": "abc123",
  "fax": "xyz789",
  "hierarchy": "xyz789"
}

CreateAdminUserInput

Fields
Input Field Description
id - ID
givenName - String!
middleName - String
familyName - String!
email - String!
employeeNo - String
role - String
jobTitle - String
officeNo - String
mobileNo - String
faxNo - String
address - AddressInput
useCompanyAddress - Boolean
emailSignature - String
languagePreference - String
dateDisplayPreference - String
Example
{
  "id": "4",
  "givenName": "abc123",
  "middleName": "xyz789",
  "familyName": "abc123",
  "email": "abc123",
  "employeeNo": "abc123",
  "role": "xyz789",
  "jobTitle": "abc123",
  "officeNo": "xyz789",
  "mobileNo": "abc123",
  "faxNo": "abc123",
  "address": AddressInput,
  "useCompanyAddress": false,
  "emailSignature": "xyz789",
  "languagePreference": "abc123",
  "dateDisplayPreference": "abc123"
}

CreateAttachmentLinkForCompanyInput

Fields
Input Field Description
companyId - ID!
fileName - String!
fileId - String
Example
{
  "companyId": 4,
  "fileName": "xyz789",
  "fileId": "abc123"
}

CreateAttachmentLinkForNoteInput

Fields
Input Field Description
fieldNoteId - ID!
fileName - String!
fileId - String
Example
{
  "fieldNoteId": 4,
  "fileName": "abc123",
  "fileId": "abc123"
}

CreateAttachmentLinkForReportInput

Fields
Input Field Description
dailyReportId - ID!
fileName - String!
fileId - String
Example
{
  "dailyReportId": 4,
  "fileName": "xyz789",
  "fileId": "xyz789"
}

CreateChangeOrderRequestEquipmentLineItemInput

Fields
Input Field Description
changeOrderRequestId - String!
projectCostCodeNumber - String
projectId - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
unitOfMeasureId - String
customUnitOfMeasure - String
rateInPennies - Int
sellPriceInPennies - Int
quantity - Float
customEquipment - String
Example
{
  "changeOrderRequestId": "abc123",
  "projectCostCodeNumber": "xyz789",
  "projectId": "xyz789",
  "notes": "abc123",
  "costInPennies": 987,
  "markup": 123.45,
  "totalInPennies": 123,
  "tags": [WorksheetTagInput],
  "unitOfMeasureId": "abc123",
  "customUnitOfMeasure": "xyz789",
  "rateInPennies": 987,
  "sellPriceInPennies": 123,
  "quantity": 987.65,
  "customEquipment": "abc123"
}

CreateChangeOrderRequestInput

Fields
Input Field Description
approvalNumber - String
approvedAmountInPennies - Int
date - AWSDateTime
dateApproved - AWSDateTime
dateSent - AWSDateTime
daysValid - Int
internalNotes - String
itemSummary - ChangeOrderRequestItemSummaryInput
name - String!
number - String
projectId - String!
referenceNumberAsi - String
referenceNumberGcCor - String
referenceNumberOther - String
referenceNumberOwnerCor - String
referenceNumberPco - String
referenceNumberRfi - String
respondBy - AWSDateTime
returnedOn - AWSDateTime
returnToContactId - String
scheduleImpactComments - String
scheduleImpactDays - Int
scopeOfWork - String
sendByDate - AWSDateTime
smallTools - ChangeOrderRequestSmallToolsInput
status - ChangeOrderRequestStatus
toContactId - String
worksheet - ChangeOrderRequestWorksheetInput
workType - ChangeOrderRequestWorkType
Example
{
  "approvalNumber": "xyz789",
  "approvedAmountInPennies": 123,
  "date": AWSDateTime,
  "dateApproved": AWSDateTime,
  "dateSent": AWSDateTime,
  "daysValid": 987,
  "internalNotes": "abc123",
  "itemSummary": ChangeOrderRequestItemSummaryInput,
  "name": "abc123",
  "number": "abc123",
  "projectId": "xyz789",
  "referenceNumberAsi": "abc123",
  "referenceNumberGcCor": "abc123",
  "referenceNumberOther": "abc123",
  "referenceNumberOwnerCor": "abc123",
  "referenceNumberPco": "abc123",
  "referenceNumberRfi": "abc123",
  "respondBy": AWSDateTime,
  "returnedOn": AWSDateTime,
  "returnToContactId": "abc123",
  "scheduleImpactComments": "xyz789",
  "scheduleImpactDays": 987,
  "scopeOfWork": "abc123",
  "sendByDate": AWSDateTime,
  "smallTools": ChangeOrderRequestSmallToolsInput,
  "status": "DRAFT",
  "toContactId": "abc123",
  "worksheet": ChangeOrderRequestWorksheetInput,
  "workType": "ALLOWANCE"
}

CreateChangeOrderRequestLaborLineItemInput

Fields
Input Field Description
changeOrderRequestId - String!
costInPennies - Int!
markup - Float
notes - String
projectCostCodeNumber - String
projectId - String
totalInPennies - Int!
tags - [WorksheetTagInput!]
customLaborClass - String
hoursInMinutes - Int
laborClassId - String
rateInPennies - Int
sellRateInPennies - Int
workers - Float
Example
{
  "changeOrderRequestId": "abc123",
  "costInPennies": 123,
  "markup": 987.65,
  "notes": "abc123",
  "projectCostCodeNumber": "abc123",
  "projectId": "xyz789",
  "totalInPennies": 123,
  "tags": [WorksheetTagInput],
  "customLaborClass": "xyz789",
  "hoursInMinutes": 123,
  "laborClassId": "abc123",
  "rateInPennies": 123,
  "sellRateInPennies": 123,
  "workers": 987.65
}

CreateChangeOrderRequestMaterialLineItemInput

Fields
Input Field Description
changeOrderRequestId - String!
projectCostCodeNumber - String
projectId - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
unitOfMeasureId - String
customUnitOfMeasure - String
rateInPennies - Int
sellPriceInPennies - Int
quantity - Float
customMaterial - String
Example
{
  "changeOrderRequestId": "abc123",
  "projectCostCodeNumber": "xyz789",
  "projectId": "xyz789",
  "notes": "abc123",
  "costInPennies": 987,
  "markup": 123.45,
  "totalInPennies": 987,
  "tags": [WorksheetTagInput],
  "unitOfMeasureId": "xyz789",
  "customUnitOfMeasure": "xyz789",
  "rateInPennies": 987,
  "sellPriceInPennies": 123,
  "quantity": 123.45,
  "customMaterial": "abc123"
}

CreateChangeOrderRequestOtherLineItemInput

Fields
Input Field Description
changeOrderRequestId - String!
projectCostCodeNumber - String
projectId - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasureId - String
Example
{
  "changeOrderRequestId": "xyz789",
  "projectCostCodeNumber": "abc123",
  "projectId": "abc123",
  "notes": "xyz789",
  "costInPennies": 123,
  "markup": 123.45,
  "totalInPennies": 987,
  "tags": [WorksheetTagInput],
  "customUnitOfMeasure": "xyz789",
  "description": "xyz789",
  "priceInPennies": 123,
  "quantity": 987.65,
  "sellPriceInPennies": 123,
  "unitOfMeasureId": "xyz789"
}

CreateChangeOrderRequestOverheadLineItemInput

Fields
Input Field Description
changeOrderRequestId - String!
projectCostCodeNumber - String
projectId - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasureId - String
Example
{
  "changeOrderRequestId": "abc123",
  "projectCostCodeNumber": "abc123",
  "projectId": "xyz789",
  "notes": "xyz789",
  "costInPennies": 123,
  "markup": 987.65,
  "totalInPennies": 987,
  "tags": [WorksheetTagInput],
  "customUnitOfMeasure": "abc123",
  "description": "abc123",
  "priceInPennies": 123,
  "quantity": 123.45,
  "sellPriceInPennies": 123,
  "unitOfMeasureId": "xyz789"
}

CreateChangeOrderRequestPdfJobInput

Fields
Input Field Description
entityString - String!
type - PdfChangeOrderType!
Example
{
  "entityString": "abc123",
  "type": "CHANGE_ORDER_LUMP_SUM"
}

CreateChangeOrderRequestRevisionInput

Fields
Input Field Description
originatingChangeOrderRequestId - String!
Example
{
  "originatingChangeOrderRequestId": "xyz789"
}

CreateChangeOrderRequestSubcontractorLineItemInput

Fields
Input Field Description
changeOrderRequestId - String!
projectCostCodeNumber - String
projectId - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasureId - String
Example
{
  "changeOrderRequestId": "xyz789",
  "projectCostCodeNumber": "abc123",
  "projectId": "xyz789",
  "notes": "abc123",
  "costInPennies": 987,
  "markup": 987.65,
  "totalInPennies": 987,
  "tags": [WorksheetTagInput],
  "customUnitOfMeasure": "xyz789",
  "description": "xyz789",
  "priceInPennies": 123,
  "quantity": 123.45,
  "sellPriceInPennies": 987,
  "unitOfMeasureId": "xyz789"
}

CreateCompanyCostCodeInput

Fields
Input Field Description
companyId - String!
number - String!
name - String!
status - CostCodeStatus!
categories - [CostCodeCategory!]
addToNewProjects - Boolean!
Example
{
  "companyId": "xyz789",
  "number": "xyz789",
  "name": "xyz789",
  "status": "ACTIVE",
  "categories": ["LABOR"],
  "addToNewProjects": false
}

CreateCompanyFolderInput

Fields
Input Field Description
companyId - String!
name - String!
parentId - String!
Example
{
  "companyId": "abc123",
  "name": "abc123",
  "parentId": "abc123"
}

CreateContactInput

Fields
Input Field Description
id - ID
firstName - String
middleName - String
lastName - String
jobTitle - String
email - String
address - AddressAllOptionalInput
country - String
office - String
mobile - String
fax - String
notes - String
businessName - String!
businessType - String!
status - AvailabilityStatus
apVendor - Boolean
vendorId - String
website - String
cannotDelete - Boolean
_version - Int
Example
{
  "id": 4,
  "firstName": "xyz789",
  "middleName": "xyz789",
  "lastName": "xyz789",
  "jobTitle": "abc123",
  "email": "abc123",
  "address": AddressAllOptionalInput,
  "country": "abc123",
  "office": "abc123",
  "mobile": "xyz789",
  "fax": "xyz789",
  "notes": "abc123",
  "businessName": "abc123",
  "businessType": "xyz789",
  "status": "AVAILABLE",
  "apVendor": false,
  "vendorId": "abc123",
  "website": "abc123",
  "cannotDelete": true,
  "_version": 987
}

CreateCopySubmittalItemInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

CreateDailyReportInput

Fields
Input Field Description
id - ID
projectId - String!
customNo - String
date - AWSDateTime!
timeOnSite - AWSDateTime
timeOffSite - AWSDateTime
totalWorkers - Int
author - String
authorId - String
weatherConditions - WeatherInput
weather - String
wind - String
temperature - Int
workPerformed - String
keywords - [String!]
listOfKeywords - [NestedKeywordsInput!]
issues - String
favors - String
accidents - String
subcontractorsWorked - String
visitors - String
comments - String
notes - String
internalComments - String
weatherComments - String
lastEditedBy - String
attachments - AttachmentsInput
docs - DocsInput
emails - [EmailInput!]
_version - Int
Example
{
  "id": 4,
  "projectId": "abc123",
  "customNo": "xyz789",
  "date": AWSDateTime,
  "timeOnSite": AWSDateTime,
  "timeOffSite": AWSDateTime,
  "totalWorkers": 987,
  "author": "abc123",
  "authorId": "abc123",
  "weatherConditions": WeatherInput,
  "weather": "xyz789",
  "wind": "abc123",
  "temperature": 987,
  "workPerformed": "abc123",
  "keywords": ["abc123"],
  "listOfKeywords": [NestedKeywordsInput],
  "issues": "xyz789",
  "favors": "xyz789",
  "accidents": "xyz789",
  "subcontractorsWorked": "xyz789",
  "visitors": "abc123",
  "comments": "abc123",
  "notes": "abc123",
  "internalComments": "abc123",
  "weatherComments": "xyz789",
  "lastEditedBy": "abc123",
  "attachments": AttachmentsInput,
  "docs": DocsInput,
  "emails": [EmailInput],
  "_version": 987
}

CreateDocumentLinkForNoteInput

Fields
Input Field Description
fieldNoteId - ID!
fileName - String!
fileId - String
Example
{
  "fieldNoteId": "4",
  "fileName": "abc123",
  "fileId": "abc123"
}

CreateDocumentLinkForReportInput

Fields
Input Field Description
dailyReportId - ID!
fileName - String!
Example
{
  "dailyReportId": "4",
  "fileName": "xyz789"
}

CreateDownloadLinkForChangeOrderRequestInput

Fields
Input Field Description
changeOrderRequestId - String!
attachmentId - String!
Example
{
  "changeOrderRequestId": "abc123",
  "attachmentId": "xyz789"
}

CreateDownloadLinkForCompanyDriveInput

Fields
Input Field Description
companyId - String!
id - String!
Example
{
  "companyId": "abc123",
  "id": "abc123"
}

CreateDownloadLinkForProjectDriveInput

Fields
Input Field Description
id - String!
projectId - String!
Example
{
  "id": "abc123",
  "projectId": "xyz789"
}

CreateDownloadLinkForRfiInput

Fields
Input Field Description
rfiId - String!
attachmentId - String!
Example
{
  "rfiId": "xyz789",
  "attachmentId": "xyz789"
}

CreateDownloadLinkForSubmittalInput

Fields
Input Field Description
submittalId - String!
attachmentId - String!
Example
{
  "submittalId": "xyz789",
  "attachmentId": "xyz789"
}

CreateEntityAssignmentInput

Fields
Input Field Description
id - ID
entityId - ID!
userId - ID!
_version - Int
Example
{"id": 4, "entityId": 4, "userId": 4, "_version": 123}

CreateFieldNoteInput

Fields
Input Field Description
id - ID
note - String!
createdOnDeviceAt - AWSDateTime!
keywords - [String!]
listOfKeywords - [NestedKeywordsInput!]!
locationTags - [NestedLocationTagInput!]
address - AddressInput
phase - String
system - String
attachments - AttachmentsInput
createdByUsername - String
createdByUserId - String
projectId - String!
docs - DocsInput
lastUpdatedByUsername - String
lastUpdatedByUserId - String
emails - [EmailInput!]
_version - Int
Example
{
  "id": "4",
  "note": "abc123",
  "createdOnDeviceAt": AWSDateTime,
  "keywords": ["abc123"],
  "listOfKeywords": [NestedKeywordsInput],
  "locationTags": [NestedLocationTagInput],
  "address": AddressInput,
  "phase": "abc123",
  "system": "abc123",
  "attachments": AttachmentsInput,
  "createdByUsername": "abc123",
  "createdByUserId": "xyz789",
  "projectId": "xyz789",
  "docs": DocsInput,
  "lastUpdatedByUsername": "xyz789",
  "lastUpdatedByUserId": "xyz789",
  "emails": [EmailInput],
  "_version": 123
}

CreateKeywordInput

Fields
Input Field Description
id - ID
name - String!
companyId - String!
status - AvailabilityStatus!
usageCount - Int
_version - Int
Example
{
  "id": "4",
  "name": "abc123",
  "companyId": "xyz789",
  "status": "AVAILABLE",
  "usageCount": 123,
  "_version": 987
}

CreateLaborClassInput

Fields
Input Field Description
name - String!
companyId - String!
Example
{
  "name": "xyz789",
  "companyId": "abc123"
}

CreateLocationTagInput

Fields
Input Field Description
id - ID
name - String!
projectId - String!
_version - Int
Example
{
  "id": 4,
  "name": "xyz789",
  "projectId": "abc123",
  "_version": 987
}

CreateOccupancySubTypeInput

Fields
Input Field Description
id - ID
name - String!
companyId - String!
occupancyTypeId - String!
_version - Int
Example
{
  "id": 4,
  "name": "xyz789",
  "companyId": "abc123",
  "occupancyTypeId": "xyz789",
  "_version": 123
}

CreateOccupancyTypeInput

Fields
Input Field Description
id - ID
name - String!
companyId - String!
_version - Int
Example
{
  "id": 4,
  "name": "abc123",
  "companyId": "xyz789",
  "_version": 987
}

CreateOrganizationInput

Fields
Input Field Description
id - ID
name - String!
address - AddressInput!
country - String!
phone - String!
fax - String
accountStatus - String!
subscriptionStart - AWSDateTime!
subscriptionEnd - AWSDateTime!
userCount - Int!
enabledModules - String
modules - [Modules!]
Example
{
  "id": 4,
  "name": "abc123",
  "address": AddressInput,
  "country": "xyz789",
  "phone": "xyz789",
  "fax": "xyz789",
  "accountStatus": "xyz789",
  "subscriptionStart": AWSDateTime,
  "subscriptionEnd": AWSDateTime,
  "userCount": 123,
  "enabledModules": "abc123",
  "modules": ["CHANGE_ORDER_REQUEST"]
}

CreatePdfForDailyReportInput

Fields
Input Field Description
dailyReportId - String!
displayDate - String
createdAt - String
includeCrew - Boolean
includeCrewComments - Boolean
includeKeywords - Boolean
includeInternalComments - Boolean
includeMedia - Boolean
filesToInclude - [String!]
Example
{
  "dailyReportId": "xyz789",
  "displayDate": "abc123",
  "createdAt": "abc123",
  "includeCrew": false,
  "includeCrewComments": true,
  "includeKeywords": true,
  "includeInternalComments": true,
  "includeMedia": true,
  "filesToInclude": ["xyz789"]
}

CreatePdfForFieldNoteInput

Fields
Input Field Description
createdAt - String!
displayDate - String
fieldNoteId - String!
Example
{
  "createdAt": "abc123",
  "displayDate": "abc123",
  "fieldNoteId": "xyz789"
}

CreatePdfForRfiInput

Fields
Input Field Description
rfiId - String!
displayDate - String
createdAt - String
filesToInclude - [String!]
Example
{
  "rfiId": "xyz789",
  "displayDate": "abc123",
  "createdAt": "abc123",
  "filesToInclude": ["xyz789"]
}

CreatePermissionGroupInput

Fields
Input Field Description
groups - [PermissionGroupInput!]!
Example
{"groups": [PermissionGroupInput]}

CreateProjectCostCodeInput

Fields
Input Field Description
projectId - String!
number - String!
name - String!
status - CostCodeStatus!
categories - [CostCodeCategory!]
Example
{
  "projectId": "xyz789",
  "number": "abc123",
  "name": "xyz789",
  "status": "ACTIVE",
  "categories": ["LABOR"]
}

CreateProjectFileInput

Fields
Input Field Description
name - String!
parentId - String!
projectId - String!
Example
{
  "name": "xyz789",
  "parentId": "xyz789",
  "projectId": "abc123"
}

CreateProjectFolderInput

Fields
Input Field Description
name - String!
parentId - String!
projectId - String!
Example
{
  "name": "abc123",
  "parentId": "xyz789",
  "projectId": "abc123"
}

CreateProjectInput

Fields
Input Field Description
address - AddressAllOptionalInput
changeOrderRequestSettings - ProjectChangeOrderRequestSettingsInput
comments - String
companyId - String!
companyName - String
contractCostInPennies - Int
contractNumber - String
contractSoldBy - String
contractType - String
dailyReportSettings - ProjectDailyReportSettingsInput
divisionId - String
endDate - AWSDateTime
id - ID
isPrimeContractor - Boolean
mailboxEmail - String
marketAreaId - String
name - String
number - String
occupancySubTypeId - String
occupancyTypeId - String
officeFaxNumber - String
officePhoneNumber - String
projectRateTemplateId - String
rfiSettings - ProjectRFISettingsInput
submittalSettings - SubmittalSettingsInput
startDate - AWSDateTime
status - String!
teams - ProjectTeamsInput
timeSettings - ProjectTimeSettingsInput
purchaseOrderSettings - ProjectPurchaseOrderSettingsInput
_version - Int
projectCompanyId - ID
Example
{
  "address": AddressAllOptionalInput,
  "changeOrderRequestSettings": ProjectChangeOrderRequestSettingsInput,
  "comments": "abc123",
  "companyId": "abc123",
  "companyName": "abc123",
  "contractCostInPennies": 123,
  "contractNumber": "xyz789",
  "contractSoldBy": "abc123",
  "contractType": "abc123",
  "dailyReportSettings": ProjectDailyReportSettingsInput,
  "divisionId": "abc123",
  "endDate": AWSDateTime,
  "id": 4,
  "isPrimeContractor": true,
  "mailboxEmail": "abc123",
  "marketAreaId": "xyz789",
  "name": "xyz789",
  "number": "xyz789",
  "occupancySubTypeId": "xyz789",
  "occupancyTypeId": "abc123",
  "officeFaxNumber": "abc123",
  "officePhoneNumber": "abc123",
  "projectRateTemplateId": "xyz789",
  "rfiSettings": ProjectRFISettingsInput,
  "submittalSettings": SubmittalSettingsInput,
  "startDate": AWSDateTime,
  "status": "abc123",
  "teams": ProjectTeamsInput,
  "timeSettings": ProjectTimeSettingsInput,
  "purchaseOrderSettings": ProjectPurchaseOrderSettingsInput,
  "_version": 123,
  "projectCompanyId": 4
}

CreatePurchaseOrderInput

Fields
Input Field Description
projectId - String!
number - String
date - AWSDateTime
type - PurchaseOrderType!
status - PurchaseOrderStatus!
description - String
vendorId - String
salesTaxRatePercent - Float
salesTaxAmountInPennies - Int
depositInPennies - Int
depositDate - AWSDateTime
releaseDate - AWSDateTime
billing - PurchaseOrderBillingInput
shipping - PurchaseOrderShippingInput
buyerNotes - String
vendorNotes - String
internalNotes - String
totalInPennies - Int
invoicedInPennies - Int
Example
{
  "projectId": "xyz789",
  "number": "xyz789",
  "date": AWSDateTime,
  "type": "PURCHASE_ORDER",
  "status": "DRAFT",
  "description": "xyz789",
  "vendorId": "abc123",
  "salesTaxRatePercent": 123.45,
  "salesTaxAmountInPennies": 987,
  "depositInPennies": 987,
  "depositDate": AWSDateTime,
  "releaseDate": AWSDateTime,
  "billing": PurchaseOrderBillingInput,
  "shipping": PurchaseOrderShippingInput,
  "buyerNotes": "abc123",
  "vendorNotes": "xyz789",
  "internalNotes": "xyz789",
  "totalInPennies": 123,
  "invoicedInPennies": 987
}

CreatePurchaseOrderLineInput

Fields
Input Field Description
purchaseOrderId - String!
taxExempt - Boolean!
number - String
description - String!
projectCostCodeNumber - String
projectId - String
notes - String
priceInPennies - Int
per - String
unitOfMeasureId - String
quantityOrdered - Int
totalInPennies - Int
releaseDate - AWSDateTime
Example
{
  "purchaseOrderId": "abc123",
  "taxExempt": false,
  "number": "abc123",
  "description": "abc123",
  "projectCostCodeNumber": "abc123",
  "projectId": "abc123",
  "notes": "abc123",
  "priceInPennies": 123,
  "per": "abc123",
  "unitOfMeasureId": "abc123",
  "quantityOrdered": 123,
  "totalInPennies": 987,
  "releaseDate": AWSDateTime
}

CreatePurchaseOrderReceivingInput

Fields
Input Field Description
purchaseOrderId - String!
date - AWSDateTime
packingSlipNumber - String
invoiceNumber - String
invoiceAmountInPennies - Int
comments - String
Example
{
  "purchaseOrderId": "xyz789",
  "date": AWSDateTime,
  "packingSlipNumber": "xyz789",
  "invoiceNumber": "abc123",
  "invoiceAmountInPennies": 123,
  "comments": "xyz789"
}

CreatePurchaseOrderReceivingLineInput

Fields
Input Field Description
receivingId - String!
purchaseOrderId - String!
lineNumber - String
itemNumber - String
itemDescription - String
unitOfMeasureName - String
totalOrdered - Int
previouslyReceived - Int
total - Int
receivedToday - Int
receivedInFull - Boolean
backOrdered - Int
Example
{
  "receivingId": "abc123",
  "purchaseOrderId": "abc123",
  "lineNumber": "xyz789",
  "itemNumber": "abc123",
  "itemDescription": "abc123",
  "unitOfMeasureName": "abc123",
  "totalOrdered": 123,
  "previouslyReceived": 987,
  "total": 987,
  "receivedToday": 123,
  "receivedInFull": true,
  "backOrdered": 987
}

CreatePurchaseOrderRevisionInput

Fields
Input Field Description
originatingPurchaseOrderId - String!
Example
{"originatingPurchaseOrderId": "abc123"}

CreateRateTemplateInput

Fields
Input Field Description
companyId - String!
name - String!
shift2 - ShiftDifferentialInput
shift3 - ShiftDifferentialInput
laborClasses - [RateLaborClassInput!]
Example
{
  "companyId": "xyz789",
  "name": "xyz789",
  "shift2": ShiftDifferentialInput,
  "shift3": ShiftDifferentialInput,
  "laborClasses": [RateLaborClassInput]
}

CreateRfiInput

Fields
Input Field Description
gcFileNumber - String
gcNumber - String
attachments - AttachmentsInput
author - AuthorInput
respondByDate - AWSDate
date - AWSDate
id - ID
projectId - String
dateV2 - AWSDateTime
lastEditedBy - AuthorInput
revision - Int
customNo - String
to - [NestedContactInput!]
subject - String
respondByDateV2 - AWSDateTime
questionForClarification - String
recommendedSolution - String
isScheduleImpacted - Boolean
isCostImpacted - Boolean
isUrgent - Boolean
reference - RfiReferenceInput
projectCostCodeAffected - ProjectCostCodeInput
projectCostCodeAffectedNumber - String
dateAnswered - AWSDateTime
status - RfiStatus
statusComment - String
answerToClarification - String
driveAttachments - [RfiAttachmentInput!]
images - [RfiImageInput!]
emails - [EmailInput!]
_version - Int
rfiAuthorV2Id - ID
Example
{
  "gcFileNumber": "xyz789",
  "gcNumber": "xyz789",
  "attachments": AttachmentsInput,
  "author": AuthorInput,
  "respondByDate": AWSDate,
  "date": AWSDate,
  "id": "4",
  "projectId": "abc123",
  "dateV2": AWSDateTime,
  "lastEditedBy": AuthorInput,
  "revision": 123,
  "customNo": "abc123",
  "to": [NestedContactInput],
  "subject": "abc123",
  "respondByDateV2": AWSDateTime,
  "questionForClarification": "xyz789",
  "recommendedSolution": "xyz789",
  "isScheduleImpacted": true,
  "isCostImpacted": false,
  "isUrgent": false,
  "reference": RfiReferenceInput,
  "projectCostCodeAffected": ProjectCostCodeInput,
  "projectCostCodeAffectedNumber": "abc123",
  "dateAnswered": AWSDateTime,
  "status": "PENDING",
  "statusComment": "abc123",
  "answerToClarification": "xyz789",
  "driveAttachments": [RfiAttachmentInput],
  "images": [RfiImageInput],
  "emails": [EmailInput],
  "_version": 987,
  "rfiAuthorV2Id": "4"
}

CreateRfiRevisionInput

Fields
Input Field Description
originatingRfiId - String!
Example
{"originatingRfiId": "xyz789"}

CreateSubmittalItemInput

Fields
Input Field Description
dateReceived - AWSDateTime
dateSent - AWSDateTime
deliveryDate - AWSDateTime
description - String
documentType - SubmittalDocType
fromContactId - String
installationDate - AWSDateTime
leadTime - AWSDateTime
methodSent - SubmittalMethodSent
name - String!
notes - String
number - String
package - String
poIssueDate - AWSDateTime
poReleaseDate - AWSDateTime
priority - SubmittalPriority
projectId - String!
reasonForSending - SubmittalReasonForSending
respondedOn - AWSDateTime
returnBy - AWSDateTime
specSection - String
status - SubmittalStatus!
submitBy - AWSDateTime
toContactId - String
type - SubmittalType
warrantyDate - AWSDateTime
Example
{
  "dateReceived": AWSDateTime,
  "dateSent": AWSDateTime,
  "deliveryDate": AWSDateTime,
  "description": "xyz789",
  "documentType": "SUBMITTAL",
  "fromContactId": "xyz789",
  "installationDate": AWSDateTime,
  "leadTime": AWSDateTime,
  "methodSent": "CERTIFIEDMAIL",
  "name": "abc123",
  "notes": "abc123",
  "number": "xyz789",
  "package": "xyz789",
  "poIssueDate": AWSDateTime,
  "poReleaseDate": AWSDateTime,
  "priority": "LOW",
  "projectId": "abc123",
  "reasonForSending": "ASREQUESTED",
  "respondedOn": AWSDateTime,
  "returnBy": AWSDateTime,
  "specSection": "xyz789",
  "status": "DRAFT",
  "submitBy": AWSDateTime,
  "toContactId": "abc123",
  "type": "PRODUCTDATA",
  "warrantyDate": AWSDateTime
}

CreateSubmittalItemPdfJobInput

Fields
Input Field Description
entityString - String!
type - PdfSourceType
Example
{
  "entityString": "abc123",
  "type": "FIELD_NOTE"
}

CreateSubmittalItemRevisionInput

Fields
Input Field Description
originatingSubmittalItemId - String!
Example
{"originatingSubmittalItemId": "abc123"}

CreateSubmittalPackageInput

Fields
Input Field Description
dateSent - AWSDateTime
description - String
fromContactId - String
name - String
number - String
projectId - String!
respondBy - AWSDateTime
returnedOn - AWSDateTime
status - PackageStatus!
toContactId - String
Example
{
  "dateSent": AWSDateTime,
  "description": "abc123",
  "fromContactId": "abc123",
  "name": "xyz789",
  "number": "xyz789",
  "projectId": "abc123",
  "respondBy": AWSDateTime,
  "returnedOn": AWSDateTime,
  "status": "DRAFT",
  "toContactId": "xyz789"
}

CreateSubmittalPackagePdfJobInput

Fields
Input Field Description
entityString - String!
Example
{"entityString": "abc123"}

CreateTimeCardInput

Fields
Input Field Description
comments - String
date - AWSDateTime!
doubleTimeInMinutes - Int
hoursLost - Int
id - ID
laborClass - String
overTimeInMinutes - Int
projectCostCode - ProjectCostCodeInput
regularTimeInMinutes - Int
shift - Shift
status - TimeCardStatus
timeCardProjectCostCodeNumber - String
timeCardDailyReportId - String
units - Int
_version - Int
timeCardProjectId - ID
timeCardUserId - ID
Example
{
  "comments": "xyz789",
  "date": AWSDateTime,
  "doubleTimeInMinutes": 123,
  "hoursLost": 987,
  "id": 4,
  "laborClass": "xyz789",
  "overTimeInMinutes": 987,
  "projectCostCode": ProjectCostCodeInput,
  "regularTimeInMinutes": 987,
  "shift": "SHIFT1",
  "status": "PENDING",
  "timeCardProjectCostCodeNumber": "xyz789",
  "timeCardDailyReportId": "abc123",
  "units": 987,
  "_version": 987,
  "timeCardProjectId": "4",
  "timeCardUserId": 4
}

CreateTimeCardMigrationInput

Fields
Input Field Description
comments - String
date - AWSDateTime!
doubleTimeInMinutes - Int
hoursLost - Int
id - ID
laborClass - String
orgId - ID!
overTimeInMinutes - Int
regularTimeInMinutes - Int
shift - Shift
status - TimeCardStatus
timeCardDailyReportId - String
timeCardProjectCostCodeNumber - String
timeCardProjectId - ID
timeCardUserId - ID
units - Int
Example
{
  "comments": "abc123",
  "date": AWSDateTime,
  "doubleTimeInMinutes": 987,
  "hoursLost": 123,
  "id": "4",
  "laborClass": "xyz789",
  "orgId": 4,
  "overTimeInMinutes": 123,
  "regularTimeInMinutes": 987,
  "shift": "SHIFT1",
  "status": "PENDING",
  "timeCardDailyReportId": "abc123",
  "timeCardProjectCostCodeNumber": "abc123",
  "timeCardProjectId": "4",
  "timeCardUserId": "4",
  "units": 987
}

CreateUnitOfMeasureInput

Fields
Input Field Description
companyId - String!
name - String!
abbreviation - String!
Example
{
  "companyId": "abc123",
  "name": "abc123",
  "abbreviation": "xyz789"
}

CreateUploadLinkForChangeOrderRequestInput

Fields
Input Field Description
changeOrderRequestId - String!
fileName - String!
Example
{
  "changeOrderRequestId": "abc123",
  "fileName": "xyz789"
}

CreateUploadLinkForCompanyDriveInput

Fields
Input Field Description
companyId - String!
fileName - String!
parentId - String!
Example
{
  "companyId": "abc123",
  "fileName": "xyz789",
  "parentId": "xyz789"
}

CreateUploadLinkForPOReceivingInput

Fields
Input Field Description
purchaseOrderId - String!
receivingId - String!
fileName - String!
Example
{
  "purchaseOrderId": "abc123",
  "receivingId": "abc123",
  "fileName": "xyz789"
}

CreateUploadLinkForProjectDriveInput

Fields
Input Field Description
fileName - String!
parentId - String!
projectId - String!
Example
{
  "fileName": "xyz789",
  "parentId": "xyz789",
  "projectId": "abc123"
}

CreateUploadLinkForPurchaseOrderInput

Fields
Input Field Description
purchaseOrderId - String!
fileName - String!
Example
{
  "purchaseOrderId": "abc123",
  "fileName": "xyz789"
}

CreateUploadLinkForRfiInput

Fields
Input Field Description
rfiId - String!
fileName - String!
Example
{
  "rfiId": "abc123",
  "fileName": "abc123"
}

CreateUploadLinkForSubmittalInput

Fields
Input Field Description
submittalId - String!
fileName - String!
Example
{
  "submittalId": "abc123",
  "fileName": "xyz789"
}

CreateUserInput

Fields
Input Field Description
id - ID
orgId - String
companyAssociations - [String!]
defaultCompany - String
givenName - String!
middleName - String
familyName - String!
email - String
employeeNo - String
role - String
jobTitle - String
officeNo - String
mobileNo - String
faxNo - String
address - AddressAllOptionalInput
country - String
useCompanyAddress - Boolean
emailSignature - String
crew - Boolean
primaryLaborClass - String
languagePreference - String
dateDisplayPreference - String
permissionGroup - String
permissionGroupName - String
accessLevel - String
crewStatus - AvailabilityStatus
type - UserType
loginStatus - LoginStatus
addToNewProjects - Boolean
laborClassId - String
laborClass - LaborClassInput
_version - Int
Example
{
  "id": "4",
  "orgId": "xyz789",
  "companyAssociations": ["xyz789"],
  "defaultCompany": "abc123",
  "givenName": "xyz789",
  "middleName": "xyz789",
  "familyName": "abc123",
  "email": "xyz789",
  "employeeNo": "abc123",
  "role": "xyz789",
  "jobTitle": "xyz789",
  "officeNo": "xyz789",
  "mobileNo": "abc123",
  "faxNo": "abc123",
  "address": AddressAllOptionalInput,
  "country": "abc123",
  "useCompanyAddress": false,
  "emailSignature": "abc123",
  "crew": false,
  "primaryLaborClass": "abc123",
  "languagePreference": "xyz789",
  "dateDisplayPreference": "abc123",
  "permissionGroup": "xyz789",
  "permissionGroupName": "xyz789",
  "accessLevel": "xyz789",
  "crewStatus": "AVAILABLE",
  "type": "STANDARD",
  "loginStatus": "ACTIVE",
  "addToNewProjects": true,
  "laborClassId": "abc123",
  "laborClass": LaborClassInput,
  "_version": 987
}

CreateVersionSetInput

Fields
Input Field Description
dateIssued - AWSDateTime!
projectId - String!
name - String
Example
{
  "dateIssued": AWSDateTime,
  "projectId": "xyz789",
  "name": "xyz789"
}

CreateWeatherTypeInput

Fields
Input Field Description
id - ID
name - String
_version - Int
Example
{"id": 4, "name": "xyz789", "_version": 987}

CreateWindTypeInput

Fields
Input Field Description
id - ID
name - String
_version - Int
Example
{
  "id": "4",
  "name": "xyz789",
  "_version": 987
}

CumulioToken

Fields
Field Name Description
token - String
key - String
Example
{
  "token": "abc123",
  "key": "xyz789"
}

DailyReport

Fields
Field Name Description
id - ID!
projectId - String!
customNo - String
date - AWSDateTime!
timeOnSite - AWSDateTime
timeOffSite - AWSDateTime
totalWorkers - Int
author - String
authorId - String
weatherConditions - Weather
weather - String
wind - String
temperature - Int
workPerformed - String
keywords - [String!]
listOfKeywords - [NestedKeywords!]
issues - String
favors - String
accidents - String
subcontractorsWorked - String
visitors - String
comments - String
notes - String
internalComments - String
weatherComments - String
lastEditedBy - String
attachments - Attachments
docs - Docs
emails - [Email!]
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": "4",
  "projectId": "xyz789",
  "customNo": "abc123",
  "date": AWSDateTime,
  "timeOnSite": AWSDateTime,
  "timeOffSite": AWSDateTime,
  "totalWorkers": 123,
  "author": "abc123",
  "authorId": "xyz789",
  "weatherConditions": Weather,
  "weather": "xyz789",
  "wind": "abc123",
  "temperature": 123,
  "workPerformed": "abc123",
  "keywords": ["xyz789"],
  "listOfKeywords": [NestedKeywords],
  "issues": "xyz789",
  "favors": "xyz789",
  "accidents": "abc123",
  "subcontractorsWorked": "xyz789",
  "visitors": "abc123",
  "comments": "xyz789",
  "notes": "abc123",
  "internalComments": "xyz789",
  "weatherComments": "abc123",
  "lastEditedBy": "xyz789",
  "attachments": Attachments,
  "docs": Docs,
  "emails": [Email],
  "_version": 987,
  "_deleted": false,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

DailyReportEmailInput

Fields
Input Field Description
to - [String!]!
urgent - Boolean
cc - [String!]
bcc - [String!]
subject - String
comments - String
includeCrew - Boolean
includeCrewComments - Boolean
includeKeywords - Boolean
includeInternalComments - Boolean
includeMedia - Boolean
filesToInclude - [String!]
Example
{
  "to": ["abc123"],
  "urgent": true,
  "cc": ["xyz789"],
  "bcc": ["xyz789"],
  "subject": "xyz789",
  "comments": "xyz789",
  "includeCrew": true,
  "includeCrewComments": true,
  "includeKeywords": false,
  "includeInternalComments": true,
  "includeMedia": true,
  "filesToInclude": ["abc123"]
}

DailyReportSearchFilterInput

Fields
Input Field Description
date - SearchFilterByDateInput
keywords - SearchFilterByStringInput
authors - SearchFilterByIdNameInput
projects - SearchFilterByProjectInput
Example
{
  "date": SearchFilterByDateInput,
  "keywords": SearchFilterByStringInput,
  "authors": SearchFilterByIdNameInput,
  "projects": SearchFilterByProjectInput
}

DailyReportSearchHighlight

Fields
Field Name Description
customNo - String
comments - [String]
keywords - [String]
author - String
Example
{
  "customNo": "abc123",
  "comments": ["abc123"],
  "keywords": ["abc123"],
  "author": "xyz789"
}

DailyReportSearchResult

Fields
Field Name Description
document - DailyReportSearchResultDocument!
highlight - DailyReportSearchHighlight
Example
{
  "document": DailyReportSearchResultDocument,
  "highlight": DailyReportSearchHighlight
}

DailyReportSearchResultDocument

Fields
Field Name Description
entity - DailyReport!
hours - DailyReportSearchResultHours
Example
{
  "entity": DailyReport,
  "hours": DailyReportSearchResultHours
}

DailyReportSearchResultHours

Fields
Field Name Description
lostHours - Float
totalHours - Float
overtimeAndDoubleTimeHours - Float
Example
{
  "lostHours": 123.45,
  "totalHours": 987.65,
  "overtimeAndDoubleTimeHours": 987.65
}

DailyReportSearchResults

Fields
Field Name Description
items - [DailyReportSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [DailyReportSearchResult],
  "pagination": SearchResultsPagination
}

DailyReportSearchSortByColumn

Values
Enum Value Description

DATE

NUMBER

Example
"DATE"

DailyReportSettings

Fields
Field Name Description
dailyReportEditWindow - Int
dailyReportEditWindowUnlimited - Boolean
viewDailyReportCommentWorkPerformed - Boolean
viewDailyReportCommentWorkPerformedLabel - String
viewDailyReportCommentExtraWork - Boolean
viewDailyReportCommentExtraWorkLabel - String
viewDailyReportCommentSchedule - Boolean
viewDailyReportCommentScheduleLabel - String
viewDailyReportCommentSubcontractorsWorked - Boolean
viewDailyReportCommentSubcontractorsWorkedLabel - String
viewDailyReportCommentOtherVisitors - Boolean
viewDailyReportCommentOtherVisitorsLabel - String
viewDailyReportCommentWeather - Boolean
viewDailyReportCommentWeatherLabel - String
viewDailyReportCommentAccidents - Boolean
viewDailyReportCommentAccidentsLabel - String
viewDailyReportCommentProblems - Boolean
viewDailyReportCommentProblemsLabel - String
viewDailyReportCommentInternal - Boolean
viewDailyReportCommentInternalLabel - String
displayDailyReportComments - Boolean
displayDailyReportCrew - Boolean
Example
{
  "dailyReportEditWindow": 123,
  "dailyReportEditWindowUnlimited": true,
  "viewDailyReportCommentWorkPerformed": true,
  "viewDailyReportCommentWorkPerformedLabel": "xyz789",
  "viewDailyReportCommentExtraWork": true,
  "viewDailyReportCommentExtraWorkLabel": "xyz789",
  "viewDailyReportCommentSchedule": false,
  "viewDailyReportCommentScheduleLabel": "xyz789",
  "viewDailyReportCommentSubcontractorsWorked": true,
  "viewDailyReportCommentSubcontractorsWorkedLabel": "xyz789",
  "viewDailyReportCommentOtherVisitors": true,
  "viewDailyReportCommentOtherVisitorsLabel": "abc123",
  "viewDailyReportCommentWeather": false,
  "viewDailyReportCommentWeatherLabel": "xyz789",
  "viewDailyReportCommentAccidents": true,
  "viewDailyReportCommentAccidentsLabel": "xyz789",
  "viewDailyReportCommentProblems": true,
  "viewDailyReportCommentProblemsLabel": "abc123",
  "viewDailyReportCommentInternal": true,
  "viewDailyReportCommentInternalLabel": "xyz789",
  "displayDailyReportComments": false,
  "displayDailyReportCrew": false
}

DaysOfTheWeek

Values
Enum Value Description

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Example
"MONDAY"

DeleteAdminCompanyInput

Fields
Input Field Description
id - ID!
orgId - ID!
Example
{"id": 4, "orgId": 4}

DeleteChangeOrderRequestAttachmentInput

Fields
Input Field Description
changeOrderRequestId - String!
attachmentId - String!
Example
{
  "changeOrderRequestId": "xyz789",
  "attachmentId": "xyz789"
}

DeleteChangeOrderRequestEquipmentLineItemInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeleteChangeOrderRequestInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeleteChangeOrderRequestLaborLineItemInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeleteChangeOrderRequestMaterialLineItemInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

DeleteChangeOrderRequestOtherLineItemInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeleteChangeOrderRequestOverheadLineItemInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeleteChangeOrderRequestSubcontractorLineItemInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

DeleteCompanyCostCodeInput

Fields
Input Field Description
companyId - String!
number - String!
Example
{
  "companyId": "xyz789",
  "number": "xyz789"
}

DeleteCompanyFileInput

Fields
Input Field Description
companyId - String!
id - String!
Example
{
  "companyId": "abc123",
  "id": "abc123"
}

DeleteCompanyFolderInput

Fields
Input Field Description
companyId - String!
id - String!
Example
{
  "companyId": "abc123",
  "id": "abc123"
}

DeleteContactInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": "4", "_version": 987}

DeleteDailyReportInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": 4, "_version": 987}

DeleteEmailInput

Fields
Input Field Description
id - String!
isPermanent - Boolean
Example
{"id": "xyz789", "isPermanent": true}

DeleteEntityAssignmentInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": 4, "_version": 123}

DeleteFieldNoteInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": "4", "_version": 123}

DeleteKeywordInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": 4, "_version": 987}

DeleteLaborClassInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeleteLocationTagInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": 4, "_version": 987}

DeleteOccupancySubTypeInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": 4, "_version": 987}

DeleteOccupancyTypeInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": "4", "_version": 123}

DeleteOrganizationInput

Fields
Input Field Description
id - ID!
Example
{"id": "4"}

DeletePOReceivingAttachmentInput

Fields
Input Field Description
purchaseOrderId - String!
receivingId - String!
attachmentId - String!
Example
{
  "purchaseOrderId": "xyz789",
  "receivingId": "abc123",
  "attachmentId": "xyz789"
}

DeletePermissionGroupInput

Fields
Input Field Description
id - ID!
Example
{"id": "4"}

DeleteProjectCostCodeInput

Fields
Input Field Description
projectId - String!
number - String!
Example
{
  "projectId": "abc123",
  "number": "xyz789"
}

DeleteProjectFileInput

Fields
Input Field Description
id - String!
projectId - String!
Example
{
  "id": "xyz789",
  "projectId": "xyz789"
}

DeleteProjectFolderInput

Fields
Input Field Description
id - String!
projectId - String!
Example
{
  "id": "xyz789",
  "projectId": "xyz789"
}

DeleteProjectInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": 4, "_version": 987}

DeletePurchaseOrderAttachmentInput

Fields
Input Field Description
purchaseOrderId - String!
attachmentId - String!
Example
{
  "purchaseOrderId": "abc123",
  "attachmentId": "abc123"
}

DeletePurchaseOrderInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeletePurchaseOrderLineInput

Fields
Input Field Description
id - String!
purchaseOrderId - String!
Example
{
  "id": "abc123",
  "purchaseOrderId": "abc123"
}

DeletePurchaseOrderReceivingInput

Fields
Input Field Description
id - String!
purchaseOrderId - String!
Example
{
  "id": "xyz789",
  "purchaseOrderId": "abc123"
}

DeleteRateTemplateInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

DeleteRfiAttachmentInput

Fields
Input Field Description
rfiId - String!
attachmentId - String!
Example
{
  "rfiId": "abc123",
  "attachmentId": "abc123"
}

DeleteRfiInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": 4, "_version": 123}

DeleteSubmittalAttachmentInput

Fields
Input Field Description
submittalId - String!
attachmentId - String!
Example
{
  "submittalId": "xyz789",
  "attachmentId": "xyz789"
}

DeleteSubmittalItemInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeleteSubmittalPackageInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

DeleteTimeCardInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": "4", "_version": 987}

DeleteUnitOfMeasureInput

Fields
Input Field Description
id - ID!
Example
{"id": 4}

DeleteUserInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": 4, "_version": 123}

DeleteVersionSetInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

DeleteVersionSetResponse

Fields
Field Name Description
deleted - Boolean
Example
{"deleted": false}

DeleteWeatherTypeInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": "4", "_version": 987}

DeleteWindTypeInput

Fields
Input Field Description
id - ID!
_version - Int
Example
{"id": "4", "_version": 123}

DocGroup

Fields
Field Name Description
id - String
link - String
type - String
name - String
Example
{
  "id": "abc123",
  "link": "xyz789",
  "type": "abc123",
  "name": "xyz789"
}

DocGroupInput

Fields
Input Field Description
id - String
link - String
type - String
name - String
Example
{
  "id": "xyz789",
  "link": "xyz789",
  "type": "abc123",
  "name": "xyz789"
}

Docs

Fields
Field Name Description
count - Int
items - [DocGroup!]
Example
{"count": 123, "items": [DocGroup]}

DocsInput

Fields
Input Field Description
count - Int
items - [DocGroupInput!]
Example
{"count": 987, "items": [DocGroupInput]}

DocumentAttachment

Fields
Field Name Description
id - ID!
name - String!
tags - [DriveTag!]
link - AttachmentDownloadLink
Example
{
  "id": 4,
  "name": "xyz789",
  "tags": [DriveTag],
  "link": AttachmentDownloadLink
}

DriveTag

Fields
Field Name Description
key - String!
value - String!
Example
{
  "key": "abc123",
  "value": "abc123"
}

DriveTagInput

Fields
Input Field Description
key - String!
value - String!
Example
{
  "key": "xyz789",
  "value": "abc123"
}

Email

Fields
Field Name Description
id - ID!
author - Author
lastEditedBy - Author
boxType - EmailBox!
dateSent - AWSDateTime
dateReceived - AWSDateTime
isUrgent - Boolean
hasBeenRead - Boolean
subject - String!
from - EmailAddress!
to - [EmailAddress!]!
cc - [EmailAddress!]!
bcc - [EmailAddress!]!
text - String
html - String
emailLink - String
documents - [DocumentAttachment!]
images - [ImageAttachment!]
linkedDocument - LinkedDocument
Example
{
  "id": "4",
  "author": Author,
  "lastEditedBy": Author,
  "boxType": "INBOX",
  "dateSent": AWSDateTime,
  "dateReceived": AWSDateTime,
  "isUrgent": true,
  "hasBeenRead": false,
  "subject": "abc123",
  "from": EmailAddress,
  "to": [EmailAddress],
  "cc": [EmailAddress],
  "bcc": [EmailAddress],
  "text": "xyz789",
  "html": "xyz789",
  "emailLink": "xyz789",
  "documents": [DocumentAttachment],
  "images": [ImageAttachment],
  "linkedDocument": LinkedDocument
}

EmailAddress

Fields
Field Name Description
name - String
email - String!
Example
{
  "name": "xyz789",
  "email": "abc123"
}

EmailBox

Values
Enum Value Description

INBOX

OUTBOX

DELETED

SPAM

Example
"INBOX"

EmailInput

Fields
Input Field Description
to - [String!]!
urgent - Boolean
cc - [String!]
bcc - [String!]
subject - String
comments - String
sendAttachments - Boolean
metadata - EmailMetadata
Example
{
  "to": ["xyz789"],
  "urgent": true,
  "cc": ["xyz789"],
  "bcc": ["abc123"],
  "subject": "xyz789",
  "comments": "abc123",
  "sendAttachments": false,
  "metadata": EmailMetadata
}

EmailMetadata

Fields
Input Field Description
orgId - String!
emailId - String!
Example
{
  "orgId": "xyz789",
  "emailId": "abc123"
}

EntityAssignment

Fields
Field Name Description
id - ID!
entityId - ID!
userId - ID!
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": 4,
  "entityId": 4,
  "userId": 4,
  "_version": 987,
  "_deleted": true,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

FieldNote

Fields
Field Name Description
id - ID!
note - String!
createdOnDeviceAt - AWSDateTime!
keywords - [String!]
listOfKeywords - [NestedKeywords!]!
locationTags - [NestedLocationTag!]
address - Address
phase - String
system - String
attachments - Attachments
createdByUsername - String
createdByUserId - String
projectId - String!
docs - Docs
lastUpdatedByUsername - String
lastUpdatedByUserId - String
emails - [Email!]
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": 4,
  "note": "abc123",
  "createdOnDeviceAt": AWSDateTime,
  "keywords": ["xyz789"],
  "listOfKeywords": [NestedKeywords],
  "locationTags": [NestedLocationTag],
  "address": Address,
  "phase": "abc123",
  "system": "xyz789",
  "attachments": Attachments,
  "createdByUsername": "abc123",
  "createdByUserId": "abc123",
  "projectId": "xyz789",
  "docs": Docs,
  "lastUpdatedByUsername": "abc123",
  "lastUpdatedByUserId": "abc123",
  "emails": [Email],
  "_version": 123,
  "_deleted": true,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

FieldNoteSearchFilterInput

Fields
Input Field Description
date - SearchFilterByDateInput
keywords - SearchFilterByStringInput
authors - SearchFilterByIdNameInput
projects - SearchFilterByProjectInput
Example
{
  "date": SearchFilterByDateInput,
  "keywords": SearchFilterByStringInput,
  "authors": SearchFilterByIdNameInput,
  "projects": SearchFilterByProjectInput
}

FieldNoteSearchHighlight

Fields
Field Name Description
notes - String
keywords - [String]
author - String
Example
{
  "notes": "abc123",
  "keywords": ["xyz789"],
  "author": "abc123"
}

FieldNoteSearchResult

Fields
Field Name Description
document - FieldNoteSearchResultDocument!
highlight - FieldNoteSearchHighlight
Example
{
  "document": FieldNoteSearchResultDocument,
  "highlight": FieldNoteSearchHighlight
}

FieldNoteSearchResultDocument

Fields
Field Name Description
id - ID!
date - AWSDateTime!
notes - String!
keywords - [String]
author - String!
projectId - ID!
attachments - Attachments
docs - Docs
Example
{
  "id": 4,
  "date": AWSDateTime,
  "notes": "abc123",
  "keywords": ["abc123"],
  "author": "xyz789",
  "projectId": "4",
  "attachments": Attachments,
  "docs": Docs
}

FieldNoteSearchResults

Fields
Field Name Description
items - [FieldNoteSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [FieldNoteSearchResult],
  "pagination": SearchResultsPagination
}

FieldNoteSearchSortByColumn

Values
Enum Value Description

DATE

AUTHOR

Example
"DATE"

File

Fields
Field Name Description
id - String!
link - AttachmentDownloadLink!
name - String!
parentId - String!
parentPath - String!
path - String!
sizeInBytes - Int!
tags - [DriveTag!]!
Example
{
  "id": "xyz789",
  "link": AttachmentDownloadLink,
  "name": "xyz789",
  "parentId": "xyz789",
  "parentPath": "abc123",
  "path": "xyz789",
  "sizeInBytes": 987,
  "tags": [DriveTag]
}

Files

Fields
Field Name Description
cursor - String
items - [File!]!
Example
{
  "cursor": "abc123",
  "items": [File]
}

FilterByIdInput

Fields
Input Field Description
eq - ID
contains - [ID]
Example
{"eq": 4, "contains": [4]}

FilterByJobExecutionStatusInput

Fields
Input Field Description
eq - JobExecutionStatus
contains - [JobExecutionStatus]
Example
{"eq": "RUNNING", "contains": ["RUNNING"]}

FilterByJobTypeInput

Fields
Input Field Description
eq - JobType
contains - [JobType]
Example
{"eq": "COPY_ATTACHMENTS", "contains": ["COPY_ATTACHMENTS"]}

Float

Description

Built-in Float

Example
123.45

Folder

Fields
Field Name Description
id - String!
name - String!
parentId - String!
parentPath - String!
path - String!
Example
{
  "id": "abc123",
  "name": "xyz789",
  "parentId": "abc123",
  "parentPath": "xyz789",
  "path": "abc123"
}

Folders

Fields
Field Name Description
cursor - String
items - [Folder!]!
Example
{
  "cursor": "abc123",
  "items": [Folder]
}

GetChangeOrderRequestInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

GetCompanyCostCodeInput

Fields
Input Field Description
companyId - String!
number - String!
Example
{
  "companyId": "abc123",
  "number": "abc123"
}

GetCompanyFileInput

Fields
Input Field Description
companyId - String!
id - String!
Example
{
  "companyId": "xyz789",
  "id": "abc123"
}

GetCompanyFilesInput

Fields
Input Field Description
companyId - String!
cursor - String
limit - Int
parentId - String!
Example
{
  "companyId": "abc123",
  "cursor": "xyz789",
  "limit": 987,
  "parentId": "abc123"
}

GetCompanyFolderInput

Fields
Input Field Description
companyId - String!
id - String!
Example
{
  "companyId": "abc123",
  "id": "xyz789"
}

GetCompanyFoldersInput

Fields
Input Field Description
companyId - String!
cursor - String
limit - Int
parentId - String!
Example
{
  "companyId": "abc123",
  "cursor": "abc123",
  "limit": 123,
  "parentId": "xyz789"
}

GetJobExecutionStatusInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

GetPdfJobInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

GetProjectBudgetInput

Fields
Input Field Description
projectId - String!
projectCostCodeNumber - String!
Example
{
  "projectId": "abc123",
  "projectCostCodeNumber": "xyz789"
}

GetProjectCostCodeInput

Fields
Input Field Description
projectId - String!
number - String!
Example
{
  "projectId": "abc123",
  "number": "abc123"
}

GetProjectFileInput

Fields
Input Field Description
id - String!
projectId - String!
Example
{
  "id": "abc123",
  "projectId": "xyz789"
}

GetProjectFilesInput

Fields
Input Field Description
cursor - String
limit - Int
parentId - String!
projectId - String!
Example
{
  "cursor": "abc123",
  "limit": 123,
  "parentId": "abc123",
  "projectId": "xyz789"
}

GetProjectFolderInput

Fields
Input Field Description
id - String!
projectId - String!
Example
{
  "id": "abc123",
  "projectId": "abc123"
}

GetProjectFoldersInput

Fields
Input Field Description
cursor - String
limit - Int
parentId - String!
projectId - String!
Example
{
  "cursor": "abc123",
  "limit": 987,
  "parentId": "xyz789",
  "projectId": "xyz789"
}

GetPurchaseOrderInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

GetRateTemplateInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

GetSubmittalItemInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

GetSubmittalPackageInput

Fields
Input Field Description
id - String!
Example
{"id": "abc123"}

GetUnitOfMeasureInput

Fields
Input Field Description
id - ID!
Example
{"id": "4"}

GetVersionSetInput

Fields
Input Field Description
id - String!
Example
{"id": "xyz789"}

GetWeatherInput

Fields
Input Field Description
projectId - String!
date - AWSDateTime
Example
{
  "projectId": "abc123",
  "date": AWSDateTime
}

Header

Fields
Field Name Description
name - String!
value - String!
Example
{
  "name": "abc123",
  "value": "abc123"
}

Hierarchy

Values
Enum Value Description

ORGANIZATION

COMPANY

PROJECT

Example
"ORGANIZATION"

ID

Description

Built-in ID

Example
"4"

ImageAttachment

Fields
Field Name Description
original - DocumentAttachment
thumbnail - DocumentAttachment
webOptimized - DocumentAttachment
Example
{
  "original": DocumentAttachment,
  "thumbnail": DocumentAttachment,
  "webOptimized": DocumentAttachment
}

Int

Description

Built-in Int

Example
123

JobExecutionStatus

Values
Enum Value Description

RUNNING

SUCCEEDED

FAILED

TIMED_OUT

ABORTED

Example
"RUNNING"

JobExecutionStatusFilterInput

Fields
Input Field Description
status - FilterByJobExecutionStatusInput
type - FilterByJobTypeInput
documentId - FilterByIdInput
Example
{
  "status": FilterByJobExecutionStatusInput,
  "type": FilterByJobTypeInput,
  "documentId": FilterByIdInput
}

JobStatus

Fields
Field Name Description
id - String!
type - JobType!
documentId - String
status - JobExecutionStatus!
Example
{
  "id": "xyz789",
  "type": "COPY_ATTACHMENTS",
  "documentId": "xyz789",
  "status": "RUNNING"
}

JobStatuses

Fields
Field Name Description
items - [JobStatus!]!
nextToken - String
Example
{
  "items": [JobStatus],
  "nextToken": "abc123"
}

JobType

Values
Enum Value Description

COPY_ATTACHMENTS

OTHER

Example
"COPY_ATTACHMENTS"

Keyword

Fields
Field Name Description
id - ID!
name - String!
companyId - String!
status - AvailabilityStatus!
usageCount - Int
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": "4",
  "name": "abc123",
  "companyId": "abc123",
  "status": "AVAILABLE",
  "usageCount": 987,
  "_version": 987,
  "_deleted": false,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

LaborClass

Fields
Field Name Description
id - String!
companyId - String!
name - String!
status - LaborClassStatus!
Example
{
  "id": "abc123",
  "companyId": "xyz789",
  "name": "abc123",
  "status": "ACTIVE"
}

LaborClassInput

Fields
Input Field Description
id - String!
companyId - String!
name - String!
status - LaborClassStatus!
Example
{
  "id": "xyz789",
  "companyId": "xyz789",
  "name": "xyz789",
  "status": "ACTIVE"
}

LaborClassStatus

Values
Enum Value Description

ACTIVE

DEACTIVATED

Example
"ACTIVE"

LaborClasses

Fields
Field Name Description
items - [LaborClass!]!
nextToken - String
Example
{
  "items": [LaborClass],
  "nextToken": "xyz789"
}

LinkedDocument

Fields
Field Name Description
documentId - String!
documentType - ConstructionDocumentType!
documentName - String
Example
{
  "documentId": "xyz789",
  "documentType": "FIELD_NOTE",
  "documentName": "xyz789"
}

LinkedDocumentInput

Fields
Input Field Description
documentId - String!
documentType - ConstructionDocumentType!
Example
{
  "documentId": "xyz789",
  "documentType": "FIELD_NOTE"
}

ListChangeOrderRequestEquipmentLineItemsInput

Fields
Input Field Description
changeOrderRequestId - String
cursor - String
Example
{
  "changeOrderRequestId": "abc123",
  "cursor": "abc123"
}

ListChangeOrderRequestLaborLineItemsInput

Fields
Input Field Description
changeOrderRequestId - String
cursor - String
Example
{
  "changeOrderRequestId": "abc123",
  "cursor": "xyz789"
}

ListChangeOrderRequestMaterialLineItemsInput

Fields
Input Field Description
changeOrderRequestId - String
cursor - String
Example
{
  "changeOrderRequestId": "xyz789",
  "cursor": "xyz789"
}

ListChangeOrderRequestOtherLineItemsInput

Fields
Input Field Description
changeOrderRequestId - String
cursor - String
Example
{
  "changeOrderRequestId": "xyz789",
  "cursor": "abc123"
}

ListChangeOrderRequestOverheadLineItemsInput

Fields
Input Field Description
changeOrderRequestId - String
cursor - String
Example
{
  "changeOrderRequestId": "abc123",
  "cursor": "abc123"
}

ListChangeOrderRequestSubcontractorLineItemsInput

Fields
Input Field Description
changeOrderRequestId - String
cursor - String
Example
{
  "changeOrderRequestId": "xyz789",
  "cursor": "abc123"
}

ListJobExecutionsInput

Fields
Input Field Description
filter - JobExecutionStatusFilterInput
limit - Int
nextToken - String
Example
{
  "filter": JobExecutionStatusFilterInput,
  "limit": 123,
  "nextToken": "xyz789"
}

ListLaborClassesInput

Fields
Input Field Description
companyId - String
status - LaborClassStatus
nextToken - String
Example
{
  "companyId": "abc123",
  "status": "ACTIVE",
  "nextToken": "abc123"
}

ListProjectCostCodeInput

Fields
Input Field Description
companyId - String
number - String
Example
{
  "companyId": "xyz789",
  "number": "abc123"
}

ListPurchaseOrderLinesInput

Fields
Input Field Description
purchaseOrderId - String!
cursor - String
Example
{
  "purchaseOrderId": "abc123",
  "cursor": "xyz789"
}

ListPurchaseOrderReceivingLinesInput

Fields
Input Field Description
purchaseOrderId - String!
receivingId - String!
cursor - String
Example
{
  "purchaseOrderId": "abc123",
  "receivingId": "xyz789",
  "cursor": "xyz789"
}

ListPurchaseOrderReceivingsInput

Fields
Input Field Description
purchaseOrderId - String!
cursor - String
Example
{
  "purchaseOrderId": "xyz789",
  "cursor": "abc123"
}

ListRateTemplatesInput

Fields
Input Field Description
status - String
companyId - String
nextToken - String
Example
{
  "status": "xyz789",
  "companyId": "xyz789",
  "nextToken": "xyz789"
}

ListTimeCardsByInput

Fields
Input Field Description
companyId - String
startDate - AWSDateTime
endDate - AWSDateTime
dailyReportId - String
nextToken - String
Example
{
  "companyId": "abc123",
  "startDate": AWSDateTime,
  "endDate": AWSDateTime,
  "dailyReportId": "xyz789",
  "nextToken": "abc123"
}

ListUnitOfMeasuresInput

Fields
Input Field Description
companyId - String!
Example
{"companyId": "xyz789"}

ListUsersWithMembershipInput

Fields
Input Field Description
projectId - String
companyId - String
sortBy - UserSortByColumn
limit - Int
nextToken - String
direction - ModelSortDirection
Example
{
  "projectId": "xyz789",
  "companyId": "xyz789",
  "sortBy": "EMAIL",
  "limit": 987,
  "nextToken": "abc123",
  "direction": "ASC"
}

LocationTag

Fields
Field Name Description
id - ID!
name - String!
projectId - String!
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": "4",
  "name": "xyz789",
  "projectId": "xyz789",
  "_version": 123,
  "_deleted": false,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

LoginStatus

Values
Enum Value Description

ACTIVE

DEACTIVATED

Example
"ACTIVE"

MailboxBoxTypeSearchFacet

Fields
Field Name Description
name - String!
key - EmailBox!
count - Int
Example
{
  "name": "xyz789",
  "key": "INBOX",
  "count": 987
}

MailboxDocumentTypeSearchFacet

Fields
Field Name Description
name - String!
key - ConstructionDocumentType!
count - Int
Example
{
  "name": "abc123",
  "key": "FIELD_NOTE",
  "count": 987
}

MailboxSearchFacets

Fields
Field Name Description
boxType - [MailboxBoxTypeSearchFacet!]!
documentType - [MailboxDocumentTypeSearchFacet!]!
hasBeenRead - [SearchFacetBoolean!]!
isUrgent - [SearchFacetBoolean!]!
Example
{
  "boxType": [MailboxBoxTypeSearchFacet],
  "documentType": [MailboxDocumentTypeSearchFacet],
  "hasBeenRead": [SearchFacetBoolean],
  "isUrgent": [SearchFacetBoolean]
}

MailboxSearchFilterInput

Example
{
  "hasBeenRead": SearchFilterByBooleanInput,
  "isUrgent": SearchFilterByBooleanInput,
  "documentType": SearchFilterByMailboxDocumentTypeInput,
  "documentId": SearchFilterByIdInput,
  "boxType": SearchFilterByMailboxBoxTypeInput,
  "projects": SearchFilterByProjectInput
}

MailboxSearchHighlight

Fields
Field Name Description
subject - String
text - String
from - String
to - [String!]
Example
{
  "subject": "abc123",
  "text": "xyz789",
  "from": "abc123",
  "to": ["abc123"]
}

MailboxSearchResult

Fields
Field Name Description
document - MailboxSearchResultDocument!
highlight - MailboxSearchHighlight
Example
{
  "document": MailboxSearchResultDocument,
  "highlight": MailboxSearchHighlight
}

MailboxSearchResultDocument

Fields
Field Name Description
entity - Email!
date - AWSDateTime!
hasAttachments - Boolean!
Example
{
  "entity": Email,
  "date": AWSDateTime,
  "hasAttachments": false
}

MailboxSearchResults

Fields
Field Name Description
items - [MailboxSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [MailboxSearchResult],
  "pagination": SearchResultsPagination
}

MailboxSearchSortByColumn

Values
Enum Value Description

DATE

FROM

TO

Example
"DATE"

ModelAdminCompanyConnection

Fields
Field Name Description
items - [AdminCompany]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [AdminCompany],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelAttributeTypes

Values
Enum Value Description

binary

binarySet

bool

list

map

number

numberSet

string

stringSet

_null

Example
"binary"

ModelAvailabilityStatusInput

Fields
Input Field Description
eq - AvailabilityStatus
ne - AvailabilityStatus
Example
{"eq": "AVAILABLE", "ne": "AVAILABLE"}

ModelBooleanInput

Fields
Input Field Description
ne - Boolean
eq - Boolean
attributeExists - Boolean
attributeType - ModelAttributeTypes
Example
{"ne": false, "eq": false, "attributeExists": true, "attributeType": "binary"}

ModelCompanyConnection

Fields
Field Name Description
items - [Company]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [Company],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelCompanyFilterInput

Example
{
  "id": ModelIDInput,
  "name": ModelStringInput,
  "country": ModelStringInput,
  "phone": ModelStringInput,
  "fax": ModelStringInput,
  "orgId": ModelIDInput,
  "hierarchy": ModelStringInput,
  "and": [ModelCompanyFilterInput],
  "or": [ModelCompanyFilterInput],
  "not": ModelCompanyFilterInput
}

ModelContactConditionInput

Fields
Input Field Description
firstName - ModelStringInput
middleName - ModelStringInput
lastName - ModelStringInput
jobTitle - ModelStringInput
email - ModelStringInput
country - ModelStringInput
office - ModelStringInput
mobile - ModelStringInput
fax - ModelStringInput
notes - ModelStringInput
businessName - ModelStringInput
businessType - ModelStringInput
status - ModelAvailabilityStatusInput
apVendor - ModelBooleanInput
vendorId - ModelStringInput
website - ModelStringInput
cannotDelete - ModelBooleanInput
and - [ModelContactConditionInput]
or - [ModelContactConditionInput]
not - ModelContactConditionInput
Example
{
  "firstName": ModelStringInput,
  "middleName": ModelStringInput,
  "lastName": ModelStringInput,
  "jobTitle": ModelStringInput,
  "email": ModelStringInput,
  "country": ModelStringInput,
  "office": ModelStringInput,
  "mobile": ModelStringInput,
  "fax": ModelStringInput,
  "notes": ModelStringInput,
  "businessName": ModelStringInput,
  "businessType": ModelStringInput,
  "status": ModelAvailabilityStatusInput,
  "apVendor": ModelBooleanInput,
  "vendorId": ModelStringInput,
  "website": ModelStringInput,
  "cannotDelete": ModelBooleanInput,
  "and": [ModelContactConditionInput],
  "or": [ModelContactConditionInput],
  "not": ModelContactConditionInput
}

ModelContactConnection

Fields
Field Name Description
items - [Contact]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [Contact],
  "nextToken": "xyz789",
  "startedAt": AWSTimestamp
}

ModelContactFilterInput

Fields
Input Field Description
id - ModelIDInput
firstName - ModelStringInput
middleName - ModelStringInput
lastName - ModelStringInput
jobTitle - ModelStringInput
email - ModelStringInput
country - ModelStringInput
office - ModelStringInput
mobile - ModelStringInput
fax - ModelStringInput
notes - ModelStringInput
businessName - ModelStringInput
businessType - ModelStringInput
status - ModelAvailabilityStatusInput
apVendor - ModelBooleanInput
vendorId - ModelStringInput
website - ModelStringInput
cannotDelete - ModelBooleanInput
and - [ModelContactFilterInput]
or - [ModelContactFilterInput]
not - ModelContactFilterInput
Example
{
  "id": ModelIDInput,
  "firstName": ModelStringInput,
  "middleName": ModelStringInput,
  "lastName": ModelStringInput,
  "jobTitle": ModelStringInput,
  "email": ModelStringInput,
  "country": ModelStringInput,
  "office": ModelStringInput,
  "mobile": ModelStringInput,
  "fax": ModelStringInput,
  "notes": ModelStringInput,
  "businessName": ModelStringInput,
  "businessType": ModelStringInput,
  "status": ModelAvailabilityStatusInput,
  "apVendor": ModelBooleanInput,
  "vendorId": ModelStringInput,
  "website": ModelStringInput,
  "cannotDelete": ModelBooleanInput,
  "and": [ModelContactFilterInput],
  "or": [ModelContactFilterInput],
  "not": ModelContactFilterInput
}

ModelDailyReportConditionInput

Fields
Input Field Description
projectId - ModelStringInput
customNo - ModelStringInput
date - ModelStringInput
timeOnSite - ModelStringInput
timeOffSite - ModelStringInput
totalWorkers - ModelIntInput
author - ModelStringInput
authorId - ModelStringInput
weather - ModelStringInput
wind - ModelStringInput
temperature - ModelIntInput
workPerformed - ModelStringInput
keywords - ModelStringInput
issues - ModelStringInput
favors - ModelStringInput
accidents - ModelStringInput
subcontractorsWorked - ModelStringInput
visitors - ModelStringInput
comments - ModelStringInput
notes - ModelStringInput
internalComments - ModelStringInput
weatherComments - ModelStringInput
lastEditedBy - ModelStringInput
and - [ModelDailyReportConditionInput]
or - [ModelDailyReportConditionInput]
not - ModelDailyReportConditionInput
Example
{
  "projectId": ModelStringInput,
  "customNo": ModelStringInput,
  "date": ModelStringInput,
  "timeOnSite": ModelStringInput,
  "timeOffSite": ModelStringInput,
  "totalWorkers": ModelIntInput,
  "author": ModelStringInput,
  "authorId": ModelStringInput,
  "weather": ModelStringInput,
  "wind": ModelStringInput,
  "temperature": ModelIntInput,
  "workPerformed": ModelStringInput,
  "keywords": ModelStringInput,
  "issues": ModelStringInput,
  "favors": ModelStringInput,
  "accidents": ModelStringInput,
  "subcontractorsWorked": ModelStringInput,
  "visitors": ModelStringInput,
  "comments": ModelStringInput,
  "notes": ModelStringInput,
  "internalComments": ModelStringInput,
  "weatherComments": ModelStringInput,
  "lastEditedBy": ModelStringInput,
  "and": [ModelDailyReportConditionInput],
  "or": [ModelDailyReportConditionInput],
  "not": ModelDailyReportConditionInput
}

ModelDailyReportConnection

Fields
Field Name Description
items - [DailyReport]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [DailyReport],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelDailyReportFilterInput

Fields
Input Field Description
id - ModelIDInput
projectId - ModelStringInput
customNo - ModelStringInput
date - ModelStringInput
timeOnSite - ModelStringInput
timeOffSite - ModelStringInput
totalWorkers - ModelIntInput
author - ModelStringInput
authorId - ModelStringInput
weather - ModelStringInput
wind - ModelStringInput
temperature - ModelIntInput
workPerformed - ModelStringInput
keywords - ModelStringInput
issues - ModelStringInput
favors - ModelStringInput
accidents - ModelStringInput
subcontractorsWorked - ModelStringInput
visitors - ModelStringInput
comments - ModelStringInput
notes - ModelStringInput
internalComments - ModelStringInput
weatherComments - ModelStringInput
lastEditedBy - ModelStringInput
and - [ModelDailyReportFilterInput]
or - [ModelDailyReportFilterInput]
not - ModelDailyReportFilterInput
Example
{
  "id": ModelIDInput,
  "projectId": ModelStringInput,
  "customNo": ModelStringInput,
  "date": ModelStringInput,
  "timeOnSite": ModelStringInput,
  "timeOffSite": ModelStringInput,
  "totalWorkers": ModelIntInput,
  "author": ModelStringInput,
  "authorId": ModelStringInput,
  "weather": ModelStringInput,
  "wind": ModelStringInput,
  "temperature": ModelIntInput,
  "workPerformed": ModelStringInput,
  "keywords": ModelStringInput,
  "issues": ModelStringInput,
  "favors": ModelStringInput,
  "accidents": ModelStringInput,
  "subcontractorsWorked": ModelStringInput,
  "visitors": ModelStringInput,
  "comments": ModelStringInput,
  "notes": ModelStringInput,
  "internalComments": ModelStringInput,
  "weatherComments": ModelStringInput,
  "lastEditedBy": ModelStringInput,
  "and": [ModelDailyReportFilterInput],
  "or": [ModelDailyReportFilterInput],
  "not": ModelDailyReportFilterInput
}

ModelEntityAssignmentConditionInput

Example
{
  "entityId": ModelIDInput,
  "userId": ModelIDInput,
  "and": [ModelEntityAssignmentConditionInput],
  "or": [ModelEntityAssignmentConditionInput],
  "not": ModelEntityAssignmentConditionInput
}

ModelEntityAssignmentConnection

Fields
Field Name Description
items - [EntityAssignment]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [EntityAssignment],
  "nextToken": "xyz789",
  "startedAt": AWSTimestamp
}

ModelEntityAssignmentFilterInput

Example
{
  "id": ModelIDInput,
  "entityId": ModelIDInput,
  "userId": ModelIDInput,
  "and": [ModelEntityAssignmentFilterInput],
  "or": [ModelEntityAssignmentFilterInput],
  "not": ModelEntityAssignmentFilterInput
}

ModelFieldNoteConditionInput

Fields
Input Field Description
note - ModelStringInput
createdOnDeviceAt - ModelStringInput
keywords - ModelStringInput
phase - ModelStringInput
system - ModelStringInput
createdByUsername - ModelStringInput
createdByUserId - ModelStringInput
projectId - ModelStringInput
lastUpdatedByUsername - ModelStringInput
lastUpdatedByUserId - ModelStringInput
and - [ModelFieldNoteConditionInput]
or - [ModelFieldNoteConditionInput]
not - ModelFieldNoteConditionInput
Example
{
  "note": ModelStringInput,
  "createdOnDeviceAt": ModelStringInput,
  "keywords": ModelStringInput,
  "phase": ModelStringInput,
  "system": ModelStringInput,
  "createdByUsername": ModelStringInput,
  "createdByUserId": ModelStringInput,
  "projectId": ModelStringInput,
  "lastUpdatedByUsername": ModelStringInput,
  "lastUpdatedByUserId": ModelStringInput,
  "and": [ModelFieldNoteConditionInput],
  "or": [ModelFieldNoteConditionInput],
  "not": ModelFieldNoteConditionInput
}

ModelFieldNoteConnection

Fields
Field Name Description
items - [FieldNote]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [FieldNote],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelFieldNoteFilterInput

Fields
Input Field Description
id - ModelIDInput
note - ModelStringInput
createdOnDeviceAt - ModelStringInput
keywords - ModelStringInput
phase - ModelStringInput
system - ModelStringInput
createdByUsername - ModelStringInput
createdByUserId - ModelStringInput
projectId - ModelStringInput
lastUpdatedByUsername - ModelStringInput
lastUpdatedByUserId - ModelStringInput
and - [ModelFieldNoteFilterInput]
or - [ModelFieldNoteFilterInput]
not - ModelFieldNoteFilterInput
Example
{
  "id": ModelIDInput,
  "note": ModelStringInput,
  "createdOnDeviceAt": ModelStringInput,
  "keywords": ModelStringInput,
  "phase": ModelStringInput,
  "system": ModelStringInput,
  "createdByUsername": ModelStringInput,
  "createdByUserId": ModelStringInput,
  "projectId": ModelStringInput,
  "lastUpdatedByUsername": ModelStringInput,
  "lastUpdatedByUserId": ModelStringInput,
  "and": [ModelFieldNoteFilterInput],
  "or": [ModelFieldNoteFilterInput],
  "not": ModelFieldNoteFilterInput
}

ModelIDInput

Fields
Input Field Description
ne - ID
eq - ID
le - ID
lt - ID
ge - ID
gt - ID
contains - ID
notContains - ID
between - [ID]
beginsWith - ID
attributeExists - Boolean
attributeType - ModelAttributeTypes
size - ModelSizeInput
Example
{
  "ne": "4",
  "eq": 4,
  "le": "4",
  "lt": 4,
  "ge": 4,
  "gt": 4,
  "contains": "4",
  "notContains": 4,
  "between": ["4"],
  "beginsWith": "4",
  "attributeExists": true,
  "attributeType": "binary",
  "size": ModelSizeInput
}

ModelIntInput

Fields
Input Field Description
ne - Int
eq - Int
le - Int
lt - Int
ge - Int
gt - Int
between - [Int]
attributeExists - Boolean
attributeType - ModelAttributeTypes
Example
{
  "ne": 123,
  "eq": 987,
  "le": 123,
  "lt": 123,
  "ge": 987,
  "gt": 123,
  "between": [123],
  "attributeExists": false,
  "attributeType": "binary"
}

ModelKeywordConditionInput

Example
{
  "name": ModelStringInput,
  "companyId": ModelStringInput,
  "status": ModelAvailabilityStatusInput,
  "usageCount": ModelIntInput,
  "and": [ModelKeywordConditionInput],
  "or": [ModelKeywordConditionInput],
  "not": ModelKeywordConditionInput
}

ModelKeywordConnection

Fields
Field Name Description
items - [Keyword]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [Keyword],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelKeywordFilterInput

Example
{
  "id": ModelIDInput,
  "name": ModelStringInput,
  "companyId": ModelStringInput,
  "status": ModelAvailabilityStatusInput,
  "usageCount": ModelIntInput,
  "and": [ModelKeywordFilterInput],
  "or": [ModelKeywordFilterInput],
  "not": ModelKeywordFilterInput
}

ModelLocationTagConditionInput

Example
{
  "name": ModelStringInput,
  "projectId": ModelStringInput,
  "and": [ModelLocationTagConditionInput],
  "or": [ModelLocationTagConditionInput],
  "not": ModelLocationTagConditionInput
}

ModelLocationTagConnection

Fields
Field Name Description
items - [LocationTag]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [LocationTag],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelLocationTagFilterInput

Example
{
  "id": ModelIDInput,
  "name": ModelStringInput,
  "projectId": ModelStringInput,
  "and": [ModelLocationTagFilterInput],
  "or": [ModelLocationTagFilterInput],
  "not": ModelLocationTagFilterInput
}

ModelLoginStatusInput

Fields
Input Field Description
eq - LoginStatus
ne - LoginStatus
Example
{"eq": "ACTIVE", "ne": "ACTIVE"}

ModelOccupancySubTypeConditionInput

Example
{
  "name": ModelStringInput,
  "companyId": ModelStringInput,
  "occupancyTypeId": ModelStringInput,
  "and": [ModelOccupancySubTypeConditionInput],
  "or": [ModelOccupancySubTypeConditionInput],
  "not": ModelOccupancySubTypeConditionInput
}

ModelOccupancySubTypeConnection

Fields
Field Name Description
items - [OccupancySubType]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [OccupancySubType],
  "nextToken": "xyz789",
  "startedAt": AWSTimestamp
}

ModelOccupancySubTypeFilterInput

Example
{
  "id": ModelIDInput,
  "name": ModelStringInput,
  "companyId": ModelStringInput,
  "occupancyTypeId": ModelStringInput,
  "and": [ModelOccupancySubTypeFilterInput],
  "or": [ModelOccupancySubTypeFilterInput],
  "not": ModelOccupancySubTypeFilterInput
}

ModelOccupancyTypeConditionInput

Example
{
  "name": ModelStringInput,
  "companyId": ModelStringInput,
  "and": [ModelOccupancyTypeConditionInput],
  "or": [ModelOccupancyTypeConditionInput],
  "not": ModelOccupancyTypeConditionInput
}

ModelOccupancyTypeConnection

Fields
Field Name Description
items - [OccupancyType]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [OccupancyType],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelOccupancyTypeFilterInput

Example
{
  "id": ModelIDInput,
  "name": ModelStringInput,
  "companyId": ModelStringInput,
  "and": [ModelOccupancyTypeFilterInput],
  "or": [ModelOccupancyTypeFilterInput],
  "not": ModelOccupancyTypeFilterInput
}

ModelOrganizationConnection

Fields
Field Name Description
items - [Organization]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [Organization],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelPermissionGroupConnection

Fields
Field Name Description
items - [PermissionGroup]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [PermissionGroup],
  "nextToken": "xyz789",
  "startedAt": AWSTimestamp
}

ModelProjectConditionInput

Fields
Input Field Description
comments - ModelStringInput
companyId - ModelStringInput
companyName - ModelStringInput
contractCostInPennies - ModelIntInput
contractNumber - ModelStringInput
contractSoldBy - ModelStringInput
contractType - ModelStringInput
divisionId - ModelStringInput
endDate - ModelStringInput
isPrimeContractor - ModelBooleanInput
mailboxEmail - ModelStringInput
marketAreaId - ModelStringInput
name - ModelStringInput
number - ModelStringInput
occupancySubTypeId - ModelStringInput
occupancyTypeId - ModelStringInput
officeFaxNumber - ModelStringInput
officePhoneNumber - ModelStringInput
projectRateTemplateId - ModelStringInput
startDate - ModelStringInput
status - ModelStringInput
and - [ModelProjectConditionInput]
or - [ModelProjectConditionInput]
not - ModelProjectConditionInput
Example
{
  "comments": ModelStringInput,
  "companyId": ModelStringInput,
  "companyName": ModelStringInput,
  "contractCostInPennies": ModelIntInput,
  "contractNumber": ModelStringInput,
  "contractSoldBy": ModelStringInput,
  "contractType": ModelStringInput,
  "divisionId": ModelStringInput,
  "endDate": ModelStringInput,
  "isPrimeContractor": ModelBooleanInput,
  "mailboxEmail": ModelStringInput,
  "marketAreaId": ModelStringInput,
  "name": ModelStringInput,
  "number": ModelStringInput,
  "occupancySubTypeId": ModelStringInput,
  "occupancyTypeId": ModelStringInput,
  "officeFaxNumber": ModelStringInput,
  "officePhoneNumber": ModelStringInput,
  "projectRateTemplateId": ModelStringInput,
  "startDate": ModelStringInput,
  "status": ModelStringInput,
  "and": [ModelProjectConditionInput],
  "or": [ModelProjectConditionInput],
  "not": ModelProjectConditionInput
}

ModelProjectConnection

Fields
Field Name Description
items - [Project]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [Project],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelProjectFilterInput

Fields
Input Field Description
comments - ModelStringInput
companyId - ModelStringInput
companyName - ModelStringInput
contractCostInPennies - ModelIntInput
contractNumber - ModelStringInput
contractSoldBy - ModelStringInput
contractType - ModelStringInput
divisionId - ModelStringInput
endDate - ModelStringInput
id - ModelIDInput
isPrimeContractor - ModelBooleanInput
mailboxEmail - ModelStringInput
marketAreaId - ModelStringInput
name - ModelStringInput
number - ModelStringInput
occupancySubTypeId - ModelStringInput
occupancyTypeId - ModelStringInput
officeFaxNumber - ModelStringInput
officePhoneNumber - ModelStringInput
projectRateTemplateId - ModelStringInput
startDate - ModelStringInput
status - ModelStringInput
and - [ModelProjectFilterInput]
or - [ModelProjectFilterInput]
not - ModelProjectFilterInput
Example
{
  "comments": ModelStringInput,
  "companyId": ModelStringInput,
  "companyName": ModelStringInput,
  "contractCostInPennies": ModelIntInput,
  "contractNumber": ModelStringInput,
  "contractSoldBy": ModelStringInput,
  "contractType": ModelStringInput,
  "divisionId": ModelStringInput,
  "endDate": ModelStringInput,
  "id": ModelIDInput,
  "isPrimeContractor": ModelBooleanInput,
  "mailboxEmail": ModelStringInput,
  "marketAreaId": ModelStringInput,
  "name": ModelStringInput,
  "number": ModelStringInput,
  "occupancySubTypeId": ModelStringInput,
  "occupancyTypeId": ModelStringInput,
  "officeFaxNumber": ModelStringInput,
  "officePhoneNumber": ModelStringInput,
  "projectRateTemplateId": ModelStringInput,
  "startDate": ModelStringInput,
  "status": ModelStringInput,
  "and": [ModelProjectFilterInput],
  "or": [ModelProjectFilterInput],
  "not": ModelProjectFilterInput
}

ModelRfiConditionInput

Fields
Input Field Description
gcFileNumber - ModelStringInput
gcNumber - ModelStringInput
respondByDate - ModelStringInput
date - ModelStringInput
projectId - ModelStringInput
dateV2 - ModelStringInput
revision - ModelIntInput
customNo - ModelStringInput
subject - ModelStringInput
respondByDateV2 - ModelStringInput
questionForClarification - ModelStringInput
recommendedSolution - ModelStringInput
isScheduleImpacted - ModelBooleanInput
isCostImpacted - ModelBooleanInput
isUrgent - ModelBooleanInput
projectCostCodeAffectedNumber - ModelStringInput
dateAnswered - ModelStringInput
status - ModelRfiStatusInput
statusComment - ModelStringInput
answerToClarification - ModelStringInput
and - [ModelRfiConditionInput]
or - [ModelRfiConditionInput]
not - ModelRfiConditionInput
Example
{
  "gcFileNumber": ModelStringInput,
  "gcNumber": ModelStringInput,
  "respondByDate": ModelStringInput,
  "date": ModelStringInput,
  "projectId": ModelStringInput,
  "dateV2": ModelStringInput,
  "revision": ModelIntInput,
  "customNo": ModelStringInput,
  "subject": ModelStringInput,
  "respondByDateV2": ModelStringInput,
  "questionForClarification": ModelStringInput,
  "recommendedSolution": ModelStringInput,
  "isScheduleImpacted": ModelBooleanInput,
  "isCostImpacted": ModelBooleanInput,
  "isUrgent": ModelBooleanInput,
  "projectCostCodeAffectedNumber": ModelStringInput,
  "dateAnswered": ModelStringInput,
  "status": ModelRfiStatusInput,
  "statusComment": ModelStringInput,
  "answerToClarification": ModelStringInput,
  "and": [ModelRfiConditionInput],
  "or": [ModelRfiConditionInput],
  "not": ModelRfiConditionInput
}

ModelRfiConnection

Fields
Field Name Description
items - [Rfi]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [Rfi],
  "nextToken": "xyz789",
  "startedAt": AWSTimestamp
}

ModelRfiFilterInput

Fields
Input Field Description
gcFileNumber - ModelStringInput
gcNumber - ModelStringInput
respondByDate - ModelStringInput
date - ModelStringInput
id - ModelIDInput
projectId - ModelStringInput
dateV2 - ModelStringInput
revision - ModelIntInput
customNo - ModelStringInput
subject - ModelStringInput
respondByDateV2 - ModelStringInput
questionForClarification - ModelStringInput
recommendedSolution - ModelStringInput
isScheduleImpacted - ModelBooleanInput
isCostImpacted - ModelBooleanInput
isUrgent - ModelBooleanInput
projectCostCodeAffectedNumber - ModelStringInput
dateAnswered - ModelStringInput
status - ModelRfiStatusInput
statusComment - ModelStringInput
answerToClarification - ModelStringInput
and - [ModelRfiFilterInput]
or - [ModelRfiFilterInput]
not - ModelRfiFilterInput
Example
{
  "gcFileNumber": ModelStringInput,
  "gcNumber": ModelStringInput,
  "respondByDate": ModelStringInput,
  "date": ModelStringInput,
  "id": ModelIDInput,
  "projectId": ModelStringInput,
  "dateV2": ModelStringInput,
  "revision": ModelIntInput,
  "customNo": ModelStringInput,
  "subject": ModelStringInput,
  "respondByDateV2": ModelStringInput,
  "questionForClarification": ModelStringInput,
  "recommendedSolution": ModelStringInput,
  "isScheduleImpacted": ModelBooleanInput,
  "isCostImpacted": ModelBooleanInput,
  "isUrgent": ModelBooleanInput,
  "projectCostCodeAffectedNumber": ModelStringInput,
  "dateAnswered": ModelStringInput,
  "status": ModelRfiStatusInput,
  "statusComment": ModelStringInput,
  "answerToClarification": ModelStringInput,
  "and": [ModelRfiFilterInput],
  "or": [ModelRfiFilterInput],
  "not": ModelRfiFilterInput
}

ModelRfiStatusInput

Fields
Input Field Description
eq - RfiStatus
ne - RfiStatus
Example
{"eq": "PENDING", "ne": "PENDING"}

ModelShiftInput

Fields
Input Field Description
eq - Shift
ne - Shift
Example
{"eq": "SHIFT1", "ne": "SHIFT1"}

ModelSizeInput

Fields
Input Field Description
ne - Int
eq - Int
le - Int
lt - Int
ge - Int
gt - Int
between - [Int]
Example
{
  "ne": 123,
  "eq": 123,
  "le": 123,
  "lt": 123,
  "ge": 987,
  "gt": 123,
  "between": [987]
}

ModelSortDirection

Values
Enum Value Description

ASC

DESC

Example
"ASC"

ModelStringInput

Fields
Input Field Description
ne - String
eq - String
le - String
lt - String
ge - String
gt - String
contains - String
notContains - String
between - [String]
beginsWith - String
attributeExists - Boolean
attributeType - ModelAttributeTypes
size - ModelSizeInput
Example
{
  "ne": "abc123",
  "eq": "xyz789",
  "le": "xyz789",
  "lt": "abc123",
  "ge": "abc123",
  "gt": "xyz789",
  "contains": "xyz789",
  "notContains": "abc123",
  "between": ["xyz789"],
  "beginsWith": "xyz789",
  "attributeExists": false,
  "attributeType": "binary",
  "size": ModelSizeInput
}

ModelTimeCardConditionInput

Fields
Input Field Description
comments - ModelStringInput
date - ModelStringInput
doubleTimeInMinutes - ModelIntInput
hoursLost - ModelIntInput
laborClass - ModelStringInput
overTimeInMinutes - ModelIntInput
regularTimeInMinutes - ModelIntInput
shift - ModelShiftInput
status - ModelTimeCardStatusInput
timeCardProjectCostCodeNumber - ModelStringInput
timeCardDailyReportId - ModelStringInput
units - ModelIntInput
and - [ModelTimeCardConditionInput]
or - [ModelTimeCardConditionInput]
not - ModelTimeCardConditionInput
Example
{
  "comments": ModelStringInput,
  "date": ModelStringInput,
  "doubleTimeInMinutes": ModelIntInput,
  "hoursLost": ModelIntInput,
  "laborClass": ModelStringInput,
  "overTimeInMinutes": ModelIntInput,
  "regularTimeInMinutes": ModelIntInput,
  "shift": ModelShiftInput,
  "status": ModelTimeCardStatusInput,
  "timeCardProjectCostCodeNumber": ModelStringInput,
  "timeCardDailyReportId": ModelStringInput,
  "units": ModelIntInput,
  "and": [ModelTimeCardConditionInput],
  "or": [ModelTimeCardConditionInput],
  "not": ModelTimeCardConditionInput
}

ModelTimeCardConnection

Fields
Field Name Description
items - [TimeCard]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [TimeCard],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelTimeCardFilterInput

Fields
Input Field Description
comments - ModelStringInput
date - ModelStringInput
doubleTimeInMinutes - ModelIntInput
hoursLost - ModelIntInput
id - ModelIDInput
laborClass - ModelStringInput
overTimeInMinutes - ModelIntInput
regularTimeInMinutes - ModelIntInput
shift - ModelShiftInput
status - ModelTimeCardStatusInput
timeCardProjectCostCodeNumber - ModelStringInput
timeCardDailyReportId - ModelStringInput
units - ModelIntInput
and - [ModelTimeCardFilterInput]
or - [ModelTimeCardFilterInput]
not - ModelTimeCardFilterInput
Example
{
  "comments": ModelStringInput,
  "date": ModelStringInput,
  "doubleTimeInMinutes": ModelIntInput,
  "hoursLost": ModelIntInput,
  "id": ModelIDInput,
  "laborClass": ModelStringInput,
  "overTimeInMinutes": ModelIntInput,
  "regularTimeInMinutes": ModelIntInput,
  "shift": ModelShiftInput,
  "status": ModelTimeCardStatusInput,
  "timeCardProjectCostCodeNumber": ModelStringInput,
  "timeCardDailyReportId": ModelStringInput,
  "units": ModelIntInput,
  "and": [ModelTimeCardFilterInput],
  "or": [ModelTimeCardFilterInput],
  "not": ModelTimeCardFilterInput
}

ModelTimeCardStatusInput

Fields
Input Field Description
eq - TimeCardStatus
ne - TimeCardStatus
Example
{"eq": "PENDING", "ne": "PENDING"}

ModelUserConditionInput

Fields
Input Field Description
orgId - ModelStringInput
companyAssociations - ModelStringInput
defaultCompany - ModelStringInput
givenName - ModelStringInput
middleName - ModelStringInput
familyName - ModelStringInput
email - ModelStringInput
employeeNo - ModelStringInput
role - ModelStringInput
jobTitle - ModelStringInput
officeNo - ModelStringInput
mobileNo - ModelStringInput
faxNo - ModelStringInput
country - ModelStringInput
useCompanyAddress - ModelBooleanInput
emailSignature - ModelStringInput
crew - ModelBooleanInput
primaryLaborClass - ModelStringInput
languagePreference - ModelStringInput
dateDisplayPreference - ModelStringInput
permissionGroup - ModelStringInput
permissionGroupName - ModelStringInput
accessLevel - ModelStringInput
crewStatus - ModelAvailabilityStatusInput
type - ModelUserTypeInput
loginStatus - ModelLoginStatusInput
addToNewProjects - ModelBooleanInput
laborClassId - ModelStringInput
and - [ModelUserConditionInput]
or - [ModelUserConditionInput]
not - ModelUserConditionInput
Example
{
  "orgId": ModelStringInput,
  "companyAssociations": ModelStringInput,
  "defaultCompany": ModelStringInput,
  "givenName": ModelStringInput,
  "middleName": ModelStringInput,
  "familyName": ModelStringInput,
  "email": ModelStringInput,
  "employeeNo": ModelStringInput,
  "role": ModelStringInput,
  "jobTitle": ModelStringInput,
  "officeNo": ModelStringInput,
  "mobileNo": ModelStringInput,
  "faxNo": ModelStringInput,
  "country": ModelStringInput,
  "useCompanyAddress": ModelBooleanInput,
  "emailSignature": ModelStringInput,
  "crew": ModelBooleanInput,
  "primaryLaborClass": ModelStringInput,
  "languagePreference": ModelStringInput,
  "dateDisplayPreference": ModelStringInput,
  "permissionGroup": ModelStringInput,
  "permissionGroupName": ModelStringInput,
  "accessLevel": ModelStringInput,
  "crewStatus": ModelAvailabilityStatusInput,
  "type": ModelUserTypeInput,
  "loginStatus": ModelLoginStatusInput,
  "addToNewProjects": ModelBooleanInput,
  "laborClassId": ModelStringInput,
  "and": [ModelUserConditionInput],
  "or": [ModelUserConditionInput],
  "not": ModelUserConditionInput
}

ModelUserConnection

Fields
Field Name Description
items - [User]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [User],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelUserFilterInput

Fields
Input Field Description
id - ModelIDInput
orgId - ModelStringInput
companyAssociations - ModelStringInput
defaultCompany - ModelStringInput
givenName - ModelStringInput
middleName - ModelStringInput
familyName - ModelStringInput
email - ModelStringInput
employeeNo - ModelStringInput
role - ModelStringInput
jobTitle - ModelStringInput
officeNo - ModelStringInput
mobileNo - ModelStringInput
faxNo - ModelStringInput
country - ModelStringInput
useCompanyAddress - ModelBooleanInput
emailSignature - ModelStringInput
crew - ModelBooleanInput
primaryLaborClass - ModelStringInput
languagePreference - ModelStringInput
dateDisplayPreference - ModelStringInput
permissionGroup - ModelStringInput
permissionGroupName - ModelStringInput
accessLevel - ModelStringInput
crewStatus - ModelAvailabilityStatusInput
type - ModelUserTypeInput
loginStatus - ModelLoginStatusInput
addToNewProjects - ModelBooleanInput
laborClassId - ModelStringInput
and - [ModelUserFilterInput]
or - [ModelUserFilterInput]
not - ModelUserFilterInput
Example
{
  "id": ModelIDInput,
  "orgId": ModelStringInput,
  "companyAssociations": ModelStringInput,
  "defaultCompany": ModelStringInput,
  "givenName": ModelStringInput,
  "middleName": ModelStringInput,
  "familyName": ModelStringInput,
  "email": ModelStringInput,
  "employeeNo": ModelStringInput,
  "role": ModelStringInput,
  "jobTitle": ModelStringInput,
  "officeNo": ModelStringInput,
  "mobileNo": ModelStringInput,
  "faxNo": ModelStringInput,
  "country": ModelStringInput,
  "useCompanyAddress": ModelBooleanInput,
  "emailSignature": ModelStringInput,
  "crew": ModelBooleanInput,
  "primaryLaborClass": ModelStringInput,
  "languagePreference": ModelStringInput,
  "dateDisplayPreference": ModelStringInput,
  "permissionGroup": ModelStringInput,
  "permissionGroupName": ModelStringInput,
  "accessLevel": ModelStringInput,
  "crewStatus": ModelAvailabilityStatusInput,
  "type": ModelUserTypeInput,
  "loginStatus": ModelLoginStatusInput,
  "addToNewProjects": ModelBooleanInput,
  "laborClassId": ModelStringInput,
  "and": [ModelUserFilterInput],
  "or": [ModelUserFilterInput],
  "not": ModelUserFilterInput
}

ModelUserTypeInput

Fields
Input Field Description
eq - UserType
ne - UserType
Example
{"eq": "STANDARD", "ne": "STANDARD"}

ModelUserWithMembershipConnection

Fields
Field Name Description
items - [UserWithMembership]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [UserWithMembership],
  "nextToken": "xyz789",
  "startedAt": AWSTimestamp
}

ModelWeatherTypeConditionInput

Example
{
  "name": ModelStringInput,
  "and": [ModelWeatherTypeConditionInput],
  "or": [ModelWeatherTypeConditionInput],
  "not": ModelWeatherTypeConditionInput
}

ModelWeatherTypeConnection

Fields
Field Name Description
items - [WeatherType]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [WeatherType],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelWeatherTypeFilterInput

Example
{
  "id": ModelIDInput,
  "name": ModelStringInput,
  "and": [ModelWeatherTypeFilterInput],
  "or": [ModelWeatherTypeFilterInput],
  "not": ModelWeatherTypeFilterInput
}

ModelWindTypeConditionInput

Example
{
  "name": ModelStringInput,
  "and": [ModelWindTypeConditionInput],
  "or": [ModelWindTypeConditionInput],
  "not": ModelWindTypeConditionInput
}

ModelWindTypeConnection

Fields
Field Name Description
items - [WindType]
nextToken - String
startedAt - AWSTimestamp
Example
{
  "items": [WindType],
  "nextToken": "abc123",
  "startedAt": AWSTimestamp
}

ModelWindTypeFilterInput

Example
{
  "id": ModelIDInput,
  "name": ModelStringInput,
  "and": [ModelWindTypeFilterInput],
  "or": [ModelWindTypeFilterInput],
  "not": ModelWindTypeFilterInput
}

Modules

Values
Enum Value Description

CHANGE_ORDER_REQUEST

DAILY_REPORTS

DRAWINGS

ESUB_DRIVE

FIELD_NOTES

MAILBOX

PURCHASE_ORDER

RFI

SUBMITTALS

TIME_CARD_MANAGEMENT

Example
"CHANGE_ORDER_REQUEST"

NestedContact

Fields
Field Name Description
id - String
email - String
name - String
Example
{
  "id": "abc123",
  "email": "xyz789",
  "name": "xyz789"
}

NestedContactInput

Fields
Input Field Description
id - String!
email - String
Example
{
  "id": "xyz789",
  "email": "abc123"
}

NestedKeywords

Fields
Field Name Description
id - String!
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}

NestedKeywordsInput

Fields
Input Field Description
id - String!
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}

NestedLocationTag

Fields
Field Name Description
id - String
name - String!
Example
{
  "id": "abc123",
  "name": "xyz789"
}

NestedLocationTagInput

Fields
Input Field Description
id - String
name - String!
Example
{
  "id": "xyz789",
  "name": "abc123"
}

OccupancySubType

Fields
Field Name Description
id - ID
name - String!
companyId - String!
occupancyTypeId - String!
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": 4,
  "name": "abc123",
  "companyId": "abc123",
  "occupancyTypeId": "xyz789",
  "_version": 123,
  "_deleted": false,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

OccupancyType

Fields
Field Name Description
id - ID
name - String!
companyId - String!
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": 4,
  "name": "abc123",
  "companyId": "xyz789",
  "_version": 987,
  "_deleted": true,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

Organization

Fields
Field Name Description
id - ID!
name - String!
address - Address!
country - String!
phone - String!
fax - String
accountStatus - String!
subscriptionStart - AWSDateTime!
subscriptionEnd - AWSDateTime!
userCount - Int!
enabledModules - String Use Modules instead of this
modules - [Modules!]
_version - Int!
_lastChangedAt - AWSTimestamp!
Example
{
  "id": "4",
  "name": "xyz789",
  "address": Address,
  "country": "abc123",
  "phone": "xyz789",
  "fax": "abc123",
  "accountStatus": "abc123",
  "subscriptionStart": AWSDateTime,
  "subscriptionEnd": AWSDateTime,
  "userCount": 987,
  "enabledModules": "abc123",
  "modules": ["CHANGE_ORDER_REQUEST"],
  "_version": 987,
  "_lastChangedAt": AWSTimestamp
}

PackageStatus

Values
Enum Value Description

DRAFT

PACKAGED

SENT

RETURNED

APPROVED

APPROVEDASNOTED

NOEXCEPTIONSTAKEN

REVISEANDRESUBMIT

REJECTED

VOID

OTHER

Example
"DRAFT"

PdfChangeOrderType

Values
Enum Value Description

CHANGE_ORDER_LUMP_SUM

CHANGE_ORDER_ITEM_DETAIL

CHANGE_ORDER_ITEM_DETAIL_NO_PRICING

CHANGE_ORDER_CATEGORY_SUMMARY

Example
"CHANGE_ORDER_LUMP_SUM"

PdfJob

Fields
Field Name Description
id - String!
status - PdfJobStatus
type - PdfSourceType
created - String!
modified - String!
result - PreSignedLink
Example
{
  "id": "abc123",
  "status": "CREATED",
  "type": "FIELD_NOTE",
  "created": "abc123",
  "modified": "abc123",
  "result": PreSignedLink
}

PdfJobStatus

Values
Enum Value Description

CREATED

FAILED

IN_PROGRESS

SUCCEEDED

Example
"CREATED"

PdfSourceType

Values
Enum Value Description

FIELD_NOTE

DAILY_REPORT

RFI

SUBMITTAL_ITEM

SUBMITTAL_PACKAGE

CHANGE_ORDER_LUMP_SUM

CHANGE_ORDER_ITEM_DETAIL

CHANGE_ORDER_ITEM_DETAIL_NO_PRICING

CHANGE_ORDER_CATEGORY_SUMMARY

Example
"FIELD_NOTE"

Permission

Fields
Field Name Description
id - ID!
groupId - ID!
tag - String!
permission - String!
Example
{
  "id": 4,
  "groupId": 4,
  "tag": "abc123",
  "permission": "abc123"
}

PermissionGroup

Fields
Field Name Description
id - ID!
name - String!
permissions - [Permission!]!
Example
{
  "id": "4",
  "name": "xyz789",
  "permissions": [Permission]
}

PermissionGroupInput

Fields
Input Field Description
id - ID
name - String!
permissions - [PermissionInput!]!
Example
{
  "id": 4,
  "name": "xyz789",
  "permissions": [PermissionInput]
}

PermissionInput

Fields
Input Field Description
id - ID
tag - String!
permission - String!
Example
{
  "id": 4,
  "tag": "xyz789",
  "permission": "abc123"
}

Project

Fields
Field Name Description
address - AddressAllOptional
changeOrderRequestSettings - ProjectChangeOrderRequestSettings
comments - String
company - Company
companyId - String! Use company
companyName - String Use company
contractCostInPennies - Int
contractNumber - String
contractSoldBy - String
contractType - String
dailyReportSettings - ProjectDailyReportSettings
divisionId - String
endDate - AWSDateTime
id - ID!
isPrimeContractor - Boolean
mailboxEmail - String
marketAreaId - String
name - String
number - String
occupancySubTypeId - String
occupancyTypeId - String
officeFaxNumber - String
officePhoneNumber - String
projectRateTemplateId - String
rfiSettings - ProjectRFISettings
submittalSettings - SubmittalSettings
startDate - AWSDateTime
status - String!
teams - ProjectTeams
timeSettings - ProjectTimeSettings
purchaseOrderSettings - ProjectPurchaseOrderSettings
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "address": AddressAllOptional,
  "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
  "comments": "abc123",
  "company": Company,
  "companyId": "xyz789",
  "companyName": "abc123",
  "contractCostInPennies": 987,
  "contractNumber": "abc123",
  "contractSoldBy": "abc123",
  "contractType": "xyz789",
  "dailyReportSettings": ProjectDailyReportSettings,
  "divisionId": "xyz789",
  "endDate": AWSDateTime,
  "id": "4",
  "isPrimeContractor": false,
  "mailboxEmail": "abc123",
  "marketAreaId": "abc123",
  "name": "xyz789",
  "number": "xyz789",
  "occupancySubTypeId": "xyz789",
  "occupancyTypeId": "xyz789",
  "officeFaxNumber": "xyz789",
  "officePhoneNumber": "xyz789",
  "projectRateTemplateId": "abc123",
  "rfiSettings": ProjectRFISettings,
  "submittalSettings": SubmittalSettings,
  "startDate": AWSDateTime,
  "status": "abc123",
  "teams": ProjectTeams,
  "timeSettings": ProjectTimeSettings,
  "purchaseOrderSettings": ProjectPurchaseOrderSettings,
  "_version": 987,
  "_deleted": false,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

ProjectBudget

Fields
Field Name Description
id - String
projectCostCodeNumber - String!
projectId - String!
units - Int
laborHoursInMinutes - Int
laborCostInPennies - Int
materialCostInPennies - Int
subcontractorCostInPennies - Int
equipmentCostInPennies - Int
overheadCostInPennies - Int
otherCostInPennies - Int
unitOfMeasure - UnitOfMeasure
Example
{
  "id": "abc123",
  "projectCostCodeNumber": "abc123",
  "projectId": "abc123",
  "units": 123,
  "laborHoursInMinutes": 987,
  "laborCostInPennies": 987,
  "materialCostInPennies": 987,
  "subcontractorCostInPennies": 123,
  "equipmentCostInPennies": 987,
  "overheadCostInPennies": 987,
  "otherCostInPennies": 987,
  "unitOfMeasure": UnitOfMeasure
}

ProjectChangeOrderRequestSettings

Fields
Field Name Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["abc123"],
  "distributionListCc": ["xyz789"],
  "distributionListBcc": ["abc123"]
}

ProjectChangeOrderRequestSettingsInput

Fields
Input Field Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["xyz789"],
  "distributionListCc": ["abc123"],
  "distributionListBcc": ["xyz789"]
}

ProjectCostCode

Fields
Field Name Description
id - ID
projectId - String!
number - String!
name - String!
status - CostCodeStatus!
categories - [CostCodeCategory!]
Example
{
  "id": "4",
  "projectId": "xyz789",
  "number": "xyz789",
  "name": "abc123",
  "status": "ACTIVE",
  "categories": ["LABOR"]
}

ProjectCostCodeInput

Fields
Input Field Description
id - ID
projectId - String!
number - String!
name - String!
status - CostCodeStatus!
categories - [CostCodeCategory!]
Example
{
  "id": "4",
  "projectId": "xyz789",
  "number": "abc123",
  "name": "abc123",
  "status": "ACTIVE",
  "categories": ["LABOR"]
}

ProjectCostCodes

Fields
Field Name Description
items - [ProjectCostCode!]
cursor - String
Example
{
  "items": [ProjectCostCode],
  "cursor": "abc123"
}

ProjectDailyReportSettings

Fields
Field Name Description
dailyReportEditWindow - Int
dailyReportEditWindowUnlimited - Boolean
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "dailyReportEditWindow": 123,
  "dailyReportEditWindowUnlimited": true,
  "distributionListTo": ["abc123"],
  "distributionListCc": ["abc123"],
  "distributionListBcc": ["abc123"]
}

ProjectDailyReportSettingsInput

Fields
Input Field Description
dailyReportEditWindow - Int
dailyReportEditWindowUnlimited - Boolean
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "dailyReportEditWindow": 123,
  "dailyReportEditWindowUnlimited": true,
  "distributionListTo": ["xyz789"],
  "distributionListCc": ["xyz789"],
  "distributionListBcc": ["abc123"]
}

ProjectFilterByInternalTeamInput

Fields
Input Field Description
superintendents - SearchFilterByIdNameInput
projectManagers - SearchFilterByIdNameInput
Example
{
  "superintendents": SearchFilterByIdNameInput,
  "projectManagers": SearchFilterByIdNameInput
}

ProjectFilterByTeamInput

Fields
Input Field Description
internalTeam - ProjectFilterByInternalTeamInput
Example
{"internalTeam": ProjectFilterByInternalTeamInput}

ProjectPurchaseOrderSettings

Fields
Field Name Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["abc123"],
  "distributionListCc": ["xyz789"],
  "distributionListBcc": ["xyz789"]
}

ProjectPurchaseOrderSettingsInput

Fields
Input Field Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["abc123"],
  "distributionListCc": ["abc123"],
  "distributionListBcc": ["abc123"]
}

ProjectRFISettings

Fields
Field Name Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["abc123"],
  "distributionListCc": ["abc123"],
  "distributionListBcc": ["abc123"]
}

ProjectRFISettingsInput

Fields
Input Field Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["xyz789"],
  "distributionListCc": ["abc123"],
  "distributionListBcc": ["xyz789"]
}

ProjectSearchContextInput

Fields
Input Field Description
costCode - SearchContextUsingNumberValueInput
Example
{"costCode": SearchContextUsingNumberValueInput}

ProjectSearchFilterInput

Fields
Input Field Description
number - SearchFilterByStringInput
status - SearchFilterByStringInput
isAssigned - SearchFilterByBooleanInput
companies - SearchFilterByCompanyInput
teams - ProjectFilterByTeamInput
Example
{
  "number": SearchFilterByStringInput,
  "status": SearchFilterByStringInput,
  "isAssigned": SearchFilterByBooleanInput,
  "companies": SearchFilterByCompanyInput,
  "teams": ProjectFilterByTeamInput
}

ProjectSearchHighlight

Fields
Field Name Description
number - String
name - String
superintendent - String Use teams.internalTeam.superintendent
projectManager - String Use teams.internalTeam.projectManager
teams - ProjectTeamsForSearch
Example
{
  "number": "abc123",
  "name": "xyz789",
  "superintendent": "xyz789",
  "projectManager": "xyz789",
  "teams": ProjectTeamsForSearch
}

ProjectSearchResult

Fields
Field Name Description
document - ProjectSearchResultDocument!
highlight - ProjectSearchHighlight
Example
{
  "document": ProjectSearchResultDocument,
  "highlight": ProjectSearchHighlight
}

ProjectSearchResultDocument

Fields
Field Name Description
id - String
status - String
number - String
name - String
superintendent - String Use teams.internalTeam.superintendent
projectManager - String Use teams.internalTeam.projectManager
isAssigned - Boolean
teams - ProjectTeamsForSearch
Example
{
  "id": "xyz789",
  "status": "xyz789",
  "number": "xyz789",
  "name": "abc123",
  "superintendent": "abc123",
  "projectManager": "abc123",
  "isAssigned": true,
  "teams": ProjectTeamsForSearch
}

ProjectSearchResults

Fields
Field Name Description
items - [ProjectSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [ProjectSearchResult],
  "pagination": SearchResultsPagination
}

ProjectSearchSortByColumn

Values
Enum Value Description

NUMBER

NAME

STATUS

PROJECT_MANAGER

SUPERINTENDENT

Example
"NUMBER"

ProjectTeamContactForSearch

Fields
Field Name Description
id - ID!
firstName - String
middleName - String
lastName - String
fullName - String
Example
{
  "id": "4",
  "firstName": "xyz789",
  "middleName": "abc123",
  "lastName": "xyz789",
  "fullName": "xyz789"
}

ProjectTeamExternal

Fields
Field Name Description
owner - [Contact]
designer - [Contact]
contractor - [Contact]
engineer - [Contact]
Example
{
  "owner": [Contact],
  "designer": [Contact],
  "contractor": [Contact],
  "engineer": [Contact]
}

ProjectTeamExternalInput

Fields
Input Field Description
owner - [ProjectTeamsContactInput]
designer - [ProjectTeamsContactInput]
contractor - [ProjectTeamsContactInput]
engineer - [ProjectTeamsContactInput]
Example
{
  "owner": [ProjectTeamsContactInput],
  "designer": [ProjectTeamsContactInput],
  "contractor": [ProjectTeamsContactInput],
  "engineer": [ProjectTeamsContactInput]
}

ProjectTeamInternal

Fields
Field Name Description
estimator - [Contact]
superintendent - [Contact]
foreman - [Contact]
projectManager - [Contact]
projectEngineer - [Contact]
Example
{
  "estimator": [Contact],
  "superintendent": [Contact],
  "foreman": [Contact],
  "projectManager": [Contact],
  "projectEngineer": [Contact]
}

ProjectTeamInternalForSearch

Fields
Field Name Description
superintendent - [ProjectTeamContactForSearch]
projectManager - [ProjectTeamContactForSearch]
Example
{
  "superintendent": [ProjectTeamContactForSearch],
  "projectManager": [ProjectTeamContactForSearch]
}

ProjectTeamInternalInput

Fields
Input Field Description
estimator - [ProjectTeamsContactInput]
superintendent - [ProjectTeamsContactInput]
foreman - [ProjectTeamsContactInput]
projectManager - [ProjectTeamsContactInput]
projectEngineer - [ProjectTeamsContactInput]
Example
{
  "estimator": [ProjectTeamsContactInput],
  "superintendent": [ProjectTeamsContactInput],
  "foreman": [ProjectTeamsContactInput],
  "projectManager": [ProjectTeamsContactInput],
  "projectEngineer": [ProjectTeamsContactInput]
}

ProjectTeams

Fields
Field Name Description
internalTeam - ProjectTeamInternal
externalTeam - ProjectTeamExternal
Example
{
  "internalTeam": ProjectTeamInternal,
  "externalTeam": ProjectTeamExternal
}

ProjectTeamsContactInput

Fields
Input Field Description
id - String
Example
{"id": "abc123"}

ProjectTeamsForSearch

Fields
Field Name Description
internalTeam - ProjectTeamInternalForSearch
Example
{"internalTeam": ProjectTeamInternalForSearch}

ProjectTeamsInput

Fields
Input Field Description
internalTeam - ProjectTeamInternalInput
externalTeam - ProjectTeamExternalInput
Example
{
  "internalTeam": ProjectTeamInternalInput,
  "externalTeam": ProjectTeamExternalInput
}

ProjectTimeSettings

Fields
Field Name Description
defaultOnTime - String
defaultOffTime - String
Example
{
  "defaultOnTime": "abc123",
  "defaultOffTime": "xyz789"
}

ProjectTimeSettingsInput

Fields
Input Field Description
defaultOnTime - String
defaultOffTime - String
Example
{
  "defaultOnTime": "abc123",
  "defaultOffTime": "xyz789"
}

PurchaseOrder

Fields
Field Name Description
id - String!
project - Project!
number - String!
date - AWSDateTime
type - PurchaseOrderType!
description - String
status - PurchaseOrderStatus!
vendor - Contact
salesTaxRatePercent - Float
salesTaxAmountInPennies - Int
depositInPennies - Int
depositDate - AWSDateTime
releaseDate - AWSDateTime
billing - PurchaseOrderBilling
shipping - PurchaseOrderShipping
buyerNotes - String
vendorNotes - String
internalNotes - String
docs - [AttachmentV2!]!
images - [ResizedAttachment!]!
lines - PurchaseOrderLines!
receivings - PurchaseOrderReceivings!
invoicedInPennies - Int
totalInPennies - Int
revision - Int
Example
{
  "id": "xyz789",
  "project": Project,
  "number": "xyz789",
  "date": AWSDateTime,
  "type": "PURCHASE_ORDER",
  "description": "abc123",
  "status": "DRAFT",
  "vendor": Contact,
  "salesTaxRatePercent": 987.65,
  "salesTaxAmountInPennies": 987,
  "depositInPennies": 123,
  "depositDate": AWSDateTime,
  "releaseDate": AWSDateTime,
  "billing": PurchaseOrderBilling,
  "shipping": PurchaseOrderShipping,
  "buyerNotes": "xyz789",
  "vendorNotes": "xyz789",
  "internalNotes": "abc123",
  "docs": [AttachmentV2],
  "images": [ResizedAttachment],
  "lines": PurchaseOrderLines,
  "receivings": PurchaseOrderReceivings,
  "invoicedInPennies": 987,
  "totalInPennies": 987,
  "revision": 987
}

PurchaseOrderBilling

Fields
Field Name Description
contact - Contact
replyTo - Contact
address - AddressAllOptional
Example
{
  "contact": Contact,
  "replyTo": Contact,
  "address": AddressAllOptional
}

PurchaseOrderBillingInput

Fields
Input Field Description
contactId - String
replyToContactId - String
address - AddressInputAllOptional
Example
{
  "contactId": "abc123",
  "replyToContactId": "xyz789",
  "address": AddressInputAllOptional
}

PurchaseOrderCustomNumberSetting

Fields
Field Name Description
startsAt - Int
hierarchy - Hierarchy!
Example
{"startsAt": 123, "hierarchy": "ORGANIZATION"}

PurchaseOrderCustomNumberSettingsInput

Fields
Input Field Description
startsAt - Int
hierarchy - Hierarchy
Example
{"startsAt": 123, "hierarchy": "ORGANIZATION"}

PurchaseOrderLine

Fields
Field Name Description
id - String!
taxExempt - Boolean!
number - String
description - String!
projectCostCode - ProjectCostCode
notes - String
priceInPennies - Int
per - String
unitOfMeasure - UnitOfMeasure
quantityOrdered - Int
totalInPennies - Int
releaseDate - AWSDateTime
created - AWSDateTime
Example
{
  "id": "xyz789",
  "taxExempt": true,
  "number": "abc123",
  "description": "abc123",
  "projectCostCode": ProjectCostCode,
  "notes": "xyz789",
  "priceInPennies": 123,
  "per": "abc123",
  "unitOfMeasure": UnitOfMeasure,
  "quantityOrdered": 987,
  "totalInPennies": 987,
  "releaseDate": AWSDateTime,
  "created": AWSDateTime
}

PurchaseOrderLines

Fields
Field Name Description
items - [PurchaseOrderLine!]!
cursor - String
Example
{
  "items": [PurchaseOrderLine],
  "cursor": "xyz789"
}

PurchaseOrderProjectSettingsInput

Fields
Input Field Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["abc123"],
  "distributionListCc": ["abc123"],
  "distributionListBcc": ["abc123"]
}

PurchaseOrderReceiving

Fields
Field Name Description
id - String!
purchaseOrderId - String!
date - AWSDateTime
packingSlipNumber - String
invoiceNumber - String
invoiceAmountInPennies - Int
comments - String
lines - PurchaseOrderReceivingLines
docs - [AttachmentV2!]!
images - [ResizedAttachment!]!
Example
{
  "id": "xyz789",
  "purchaseOrderId": "xyz789",
  "date": AWSDateTime,
  "packingSlipNumber": "xyz789",
  "invoiceNumber": "abc123",
  "invoiceAmountInPennies": 123,
  "comments": "xyz789",
  "lines": PurchaseOrderReceivingLines,
  "docs": [AttachmentV2],
  "images": [ResizedAttachment]
}

PurchaseOrderReceivingLine

Fields
Field Name Description
id - String!
receivingId - String!
purchaseOrderId - String!
lineNumber - String
itemNumber - String
itemDescription - String
unitOfMeasureName - String
totalOrdered - Int
previouslyReceived - Int
receivedToday - Int
total - Int
receivedInFull - Boolean
backOrdered - Int
Example
{
  "id": "abc123",
  "receivingId": "abc123",
  "purchaseOrderId": "abc123",
  "lineNumber": "xyz789",
  "itemNumber": "abc123",
  "itemDescription": "xyz789",
  "unitOfMeasureName": "xyz789",
  "totalOrdered": 123,
  "previouslyReceived": 987,
  "receivedToday": 123,
  "total": 987,
  "receivedInFull": false,
  "backOrdered": 987
}

PurchaseOrderReceivingLines

Fields
Field Name Description
items - [PurchaseOrderReceivingLine!]!
cursor - String
Example
{
  "items": [PurchaseOrderReceivingLine],
  "cursor": "xyz789"
}

PurchaseOrderReceivings

Fields
Field Name Description
items - [PurchaseOrderReceiving!]!
cursor - String
Example
{
  "items": [PurchaseOrderReceiving],
  "cursor": "xyz789"
}

PurchaseOrderSearchFacets

Fields
Field Name Description
status - [PurchaseOrderStatusSearchFacet!]!
showAllRevisions - [SearchFacetBoolean!]!
Example
{
  "status": [PurchaseOrderStatusSearchFacet],
  "showAllRevisions": [SearchFacetBoolean]
}

PurchaseOrderSearchFilterInput

Fields
Input Field Description
projects - SearchFilterByProjectInput
showAllRevisions - SearchFilterByBooleanInput
status - SearchFilterByPurchaseOrderStatusInput
Example
{
  "projects": SearchFilterByProjectInput,
  "showAllRevisions": SearchFilterByBooleanInput,
  "status": SearchFilterByPurchaseOrderStatusInput
}

PurchaseOrderSearchHighlight

Fields
Field Name Description
name - String
Example
{"name": "abc123"}

PurchaseOrderSearchResult

Fields
Field Name Description
document - PurchaseOrderSearchResultDocument!
highlight - PurchaseOrderSearchHighlight
Example
{
  "document": PurchaseOrderSearchResultDocument,
  "highlight": PurchaseOrderSearchHighlight
}

PurchaseOrderSearchResultDocument

Fields
Field Name Description
entity - PurchaseOrder!
Example
{"entity": PurchaseOrder}

PurchaseOrderSearchResults

Fields
Field Name Description
items - [PurchaseOrderSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [PurchaseOrderSearchResult],
  "pagination": SearchResultsPagination
}

PurchaseOrderSearchSortByColumn

Values
Enum Value Description

DATE

NUMBER

STATUS

TOTAL

Example
"DATE"

PurchaseOrderSettings

Fields
Field Name Description
customNumber - PurchaseOrderCustomNumberSetting!
disclaimer - String
Example
{
  "customNumber": PurchaseOrderCustomNumberSetting,
  "disclaimer": "xyz789"
}

PurchaseOrderSettingsInput

Fields
Input Field Description
customNumber - PurchaseOrderCustomNumberSettingsInput
disclaimer - String
Example
{
  "customNumber": PurchaseOrderCustomNumberSettingsInput,
  "disclaimer": "xyz789"
}

PurchaseOrderShipping

Fields
Field Name Description
amountInPennies - Int
contact - Contact
address - AddressAllOptional
deliveryDate - AWSDateTime
freightMethod - String
method - String
instructions - String
paymentTerms - String
Example
{
  "amountInPennies": 123,
  "contact": Contact,
  "address": AddressAllOptional,
  "deliveryDate": AWSDateTime,
  "freightMethod": "xyz789",
  "method": "xyz789",
  "instructions": "abc123",
  "paymentTerms": "xyz789"
}

PurchaseOrderShippingInput

Fields
Input Field Description
amountInPennies - Int
contactId - String
address - AddressInputAllOptional
deliveryDate - AWSDateTime
freightMethod - String
method - String
instructions - String
paymentTerms - String
Example
{
  "amountInPennies": 123,
  "contactId": "abc123",
  "address": AddressInputAllOptional,
  "deliveryDate": AWSDateTime,
  "freightMethod": "xyz789",
  "method": "xyz789",
  "instructions": "xyz789",
  "paymentTerms": "abc123"
}

PurchaseOrderStatus

Values
Enum Value Description

DRAFT

PENDING

OPEN

PARTIAL_SHIPMENT

RECEIVED_IN_FULL

COMPLETE

VOID

REVISED

Example
"DRAFT"

PurchaseOrderStatusSearchFacet

Fields
Field Name Description
name - String!
key - PurchaseOrderStatus!
count - Int
Example
{
  "name": "xyz789",
  "key": "DRAFT",
  "count": 987
}

PurchaseOrderType

Values
Enum Value Description

PURCHASE_ORDER

REQUEST_FOR_PRICING

Example
"PURCHASE_ORDER"

RFISettings

Fields
Field Name Description
prefixRfiProjectNo - Boolean
addCoverSheets - Boolean
customText - String
clickHereToReply - Boolean
dueInDays - Int
Example
{
  "prefixRfiProjectNo": false,
  "addCoverSheets": true,
  "customText": "xyz789",
  "clickHereToReply": true,
  "dueInDays": 987
}

RFISettingsInput

Fields
Input Field Description
prefixRfiProjectNo - Boolean
addCoverSheets - Boolean
customText - String
clickHereToReply - Boolean
Example
{
  "prefixRfiProjectNo": false,
  "addCoverSheets": false,
  "customText": "xyz789",
  "clickHereToReply": false
}

RateLaborClass

Fields
Field Name Description
id - String
laborClassId - String!
rateInPennies - Int
overTimeInPennies - Int
doubleTimeInPennies - Int
status - LaborClassStatus
laborClass - LaborClass
Example
{
  "id": "xyz789",
  "laborClassId": "xyz789",
  "rateInPennies": 123,
  "overTimeInPennies": 123,
  "doubleTimeInPennies": 123,
  "status": "ACTIVE",
  "laborClass": LaborClass
}

RateLaborClassInput

Fields
Input Field Description
laborClassId - String!
rateInPennies - Int
overTimeInPennies - Int
doubleTimeInPennies - Int
status - LaborClassStatus
Example
{
  "laborClassId": "xyz789",
  "rateInPennies": 123,
  "overTimeInPennies": 987,
  "doubleTimeInPennies": 987,
  "status": "ACTIVE"
}

RateLaborClasses

Fields
Field Name Description
items - [RateLaborClass!]!
nextToken - String
Example
{
  "items": [RateLaborClass],
  "nextToken": "xyz789"
}

RateTemplate

Fields
Field Name Description
id - String!
name - String!
companyId - String!
shift2 - ShiftDifferential
shift3 - ShiftDifferential
laborClasses - RateLaborClasses
status - RateTemplateStatus
Example
{
  "id": "xyz789",
  "name": "abc123",
  "companyId": "abc123",
  "shift2": ShiftDifferential,
  "shift3": ShiftDifferential,
  "laborClasses": RateLaborClasses,
  "status": "ACTIVE"
}

RateTemplateStatus

Values
Enum Value Description

ACTIVE

DEACTIVATED

Example
"ACTIVE"

RateTemplates

Fields
Field Name Description
items - [RateTemplate!]!
nextToken - String
Example
{
  "items": [RateTemplate],
  "nextToken": "abc123"
}

RequestAuthTokenInput

Fields
Input Field Description
username - String!
password - String!
Example
{
  "username": "abc123",
  "password": "xyz789"
}

RequestCumulioTokenInput

Fields
Input Field Description
projectId - String
companyId - String
Example
{
  "projectId": "abc123",
  "companyId": "abc123"
}

RequestPasswordResetCodeInput

Fields
Input Field Description
username - String!
Example
{"username": "xyz789"}

ResizedAttachment

Fields
Field Name Description
original - AttachmentV2
thumbnail - AttachmentV2
webOptimized - AttachmentV2
Example
{
  "original": AttachmentV2,
  "thumbnail": AttachmentV2,
  "webOptimized": AttachmentV2
}

Rfi

Fields
Field Name Description
gcFileNumber - String Use reference.gcFileNumber instead
gcNumber - String Use reference.gccmNumber instead
attachments - Attachments Use driveAttachments instead
author - Author
respondByDate - AWSDate Use respondByDateV2 instead
date - AWSDate Use dateV2 instead
id - ID!
projectId - String
dateV2 - AWSDateTime
authorV2 - User
lastEditedBy - Author
revision - Int
customNo - String
to - [NestedContact!]
subject - String
respondByDateV2 - AWSDateTime
questionForClarification - String
recommendedSolution - String
isScheduleImpacted - Boolean
isCostImpacted - Boolean
isUrgent - Boolean
reference - RfiReference
projectCostCodeAffected - ProjectCostCode
projectCostCodeAffectedNumber - String
dateAnswered - AWSDateTime
status - RfiStatus
statusComment - String
answerToClarification - String
driveAttachments - [RfiAttachment!]
images - [RfiImage!]
emails - [Email!]
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "gcFileNumber": "abc123",
  "gcNumber": "xyz789",
  "attachments": Attachments,
  "author": Author,
  "respondByDate": AWSDate,
  "date": AWSDate,
  "id": 4,
  "projectId": "abc123",
  "dateV2": AWSDateTime,
  "authorV2": User,
  "lastEditedBy": Author,
  "revision": 987,
  "customNo": "xyz789",
  "to": [NestedContact],
  "subject": "abc123",
  "respondByDateV2": AWSDateTime,
  "questionForClarification": "abc123",
  "recommendedSolution": "abc123",
  "isScheduleImpacted": true,
  "isCostImpacted": false,
  "isUrgent": false,
  "reference": RfiReference,
  "projectCostCodeAffected": ProjectCostCode,
  "projectCostCodeAffectedNumber": "abc123",
  "dateAnswered": AWSDateTime,
  "status": "PENDING",
  "statusComment": "xyz789",
  "answerToClarification": "xyz789",
  "driveAttachments": [RfiAttachment],
  "images": [RfiImage],
  "emails": [Email],
  "_version": 123,
  "_deleted": false,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

RfiAttachment

Fields
Field Name Description
id - ID!
name - String!
sortOrder - String Use tags
tags - [DriveTag!]
link - RfiAttachmentDownloadLink
Example
{
  "id": "4",
  "name": "abc123",
  "sortOrder": "abc123",
  "tags": [DriveTag],
  "link": RfiAttachmentDownloadLink
}

RfiAttachmentDownloadLinkInput

Fields
Input Field Description
url - String
createdAt - String
expiresAt - String
Example
{
  "url": "xyz789",
  "createdAt": "abc123",
  "expiresAt": "xyz789"
}

RfiAttachmentInput

Fields
Input Field Description
id - ID!
name - String!
sortOrder - String
tags - [DriveTagInput!]
link - RfiAttachmentDownloadLinkInput
Example
{
  "id": 4,
  "name": "abc123",
  "sortOrder": "abc123",
  "tags": [DriveTagInput],
  "link": RfiAttachmentDownloadLinkInput
}

RfiEmailInput

Fields
Input Field Description
to - [String!]!
urgent - Boolean
cc - [String!]
bcc - [String!]
subject - String
comments - String
filesToInclude - [String!]
metadata - EmailMetadata
Example
{
  "to": ["abc123"],
  "urgent": false,
  "cc": ["abc123"],
  "bcc": ["abc123"],
  "subject": "abc123",
  "comments": "abc123",
  "filesToInclude": ["abc123"],
  "metadata": EmailMetadata
}

RfiImage

Fields
Field Name Description
original - RfiAttachment
thumbnail - RfiAttachment
webOptimized - RfiAttachment
Example
{
  "original": RfiAttachment,
  "thumbnail": RfiAttachment,
  "webOptimized": RfiAttachment
}

RfiImageInput

Fields
Input Field Description
original - RfiAttachmentInput
thumbnail - RfiAttachmentInput
webOptimized - RfiAttachmentInput
Example
{
  "original": RfiAttachmentInput,
  "thumbnail": RfiAttachmentInput,
  "webOptimized": RfiAttachmentInput
}

RfiReference

Fields
Field Name Description
gccmNumber - String
gcFileNumber - String
ownerNumber - String
otherNumber - String
specNumber - String
drawingNumber - String
drawingDetail - String
Example
{
  "gccmNumber": "xyz789",
  "gcFileNumber": "xyz789",
  "ownerNumber": "xyz789",
  "otherNumber": "xyz789",
  "specNumber": "xyz789",
  "drawingNumber": "abc123",
  "drawingDetail": "abc123"
}

RfiReferenceInput

Fields
Input Field Description
gccmNumber - String
gcFileNumber - String
ownerNumber - String
otherNumber - String
specNumber - String
drawingNumber - String
drawingDetail - String
Example
{
  "gccmNumber": "abc123",
  "gcFileNumber": "abc123",
  "ownerNumber": "abc123",
  "otherNumber": "xyz789",
  "specNumber": "abc123",
  "drawingNumber": "abc123",
  "drawingDetail": "xyz789"
}

RfiRevisionOutput

Fields
Field Name Description
revision - Rfi!
copyAttachmentsJobId - String
Example
{
  "revision": Rfi,
  "copyAttachmentsJobId": "xyz789"
}

RfiSearchFacets

Fields
Field Name Description
status - [RfiStatusSearchFacet!]!
isScheduleImpacted - [SearchFacetBoolean!]!
isCostImpacted - [SearchFacetBoolean!]!
showAllRevisions - [SearchFacetBoolean!]!
Example
{
  "status": [RfiStatusSearchFacet],
  "isScheduleImpacted": [SearchFacetBoolean],
  "isCostImpacted": [SearchFacetBoolean],
  "showAllRevisions": [SearchFacetBoolean]
}

RfiSearchFilterInput

Fields
Input Field Description
status - SearchFilterByRfiStatusInput
isScheduleImpacted - SearchFilterByBooleanInput
isCostImpacted - SearchFilterByBooleanInput
showAllRevisions - SearchFilterByBooleanInput
projects - SearchFilterByProjectInput
Example
{
  "status": SearchFilterByRfiStatusInput,
  "isScheduleImpacted": SearchFilterByBooleanInput,
  "isCostImpacted": SearchFilterByBooleanInput,
  "showAllRevisions": SearchFilterByBooleanInput,
  "projects": SearchFilterByProjectInput
}

RfiSearchHighlight

Fields
Field Name Description
customNo - String
to - [String!]
subject - String
questionForClarification - String
recommendedSolution - String
projectCostCodeAffected - String
statusComment - String
answerToClarification - String
reference - RfiSearchHighlightReference
Example
{
  "customNo": "xyz789",
  "to": ["abc123"],
  "subject": "abc123",
  "questionForClarification": "xyz789",
  "recommendedSolution": "abc123",
  "projectCostCodeAffected": "xyz789",
  "statusComment": "abc123",
  "answerToClarification": "xyz789",
  "reference": RfiSearchHighlightReference
}

RfiSearchHighlightReference

Fields
Field Name Description
gccmNumber - String
gcFileNumber - String
ownerNumber - String
otherNumber - String
specNumber - String
drawingNumber - String
drawingDetail - String
Example
{
  "gccmNumber": "xyz789",
  "gcFileNumber": "xyz789",
  "ownerNumber": "abc123",
  "otherNumber": "abc123",
  "specNumber": "xyz789",
  "drawingNumber": "abc123",
  "drawingDetail": "abc123"
}

RfiSearchResult

Fields
Field Name Description
document - RfiSearchResultDocument!
highlight - RfiSearchHighlight
Example
{
  "document": RfiSearchResultDocument,
  "highlight": RfiSearchHighlight
}

RfiSearchResultDocument

Fields
Field Name Description
entity - Rfi!
daysRemaining - Int!
Example
{"entity": Rfi, "daysRemaining": 987}

RfiSearchResults

Fields
Field Name Description
items - [RfiSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [RfiSearchResult],
  "pagination": SearchResultsPagination
}

RfiSearchSortByColumn

Values
Enum Value Description

DATE

DUE_DATE

NUMBER

Example
"DATE"

RfiStatus

Values
Enum Value Description

PENDING

ANSWERED

VOID

Example
"PENDING"

RfiStatusSearchFacet

Fields
Field Name Description
name - String!
key - RfiStatus!
count - Int
Example
{
  "name": "abc123",
  "key": "PENDING",
  "count": 987
}

SearchContextUsingNumberValueInput

Fields
Input Field Description
number - String
Example
{"number": "abc123"}

SearchFacetBoolean

Fields
Field Name Description
name - String!
key - Boolean!
count - Int
Example
{
  "name": "xyz789",
  "key": false,
  "count": 987
}

SearchFilterByAvailabilityStatusInput

Fields
Input Field Description
eq - AvailabilityStatus
contains - [AvailabilityStatus]
Example
{"eq": "AVAILABLE", "contains": ["AVAILABLE"]}

SearchFilterByBooleanInput

Fields
Input Field Description
eq - Boolean
contains - [Boolean]
Example
{"eq": true, "contains": [true]}

SearchFilterByChangeOrderRequestStatusInput

Fields
Input Field Description
eq - ChangeOrderRequestStatus
contains - [ChangeOrderRequestStatus!]
Example
{"eq": "DRAFT", "contains": ["DRAFT"]}

SearchFilterByChangeOrderRequestWorkTypeInput

Fields
Input Field Description
eq - ChangeOrderRequestWorkType
contains - [ChangeOrderRequestWorkType!]
Example
{"eq": "ALLOWANCE", "contains": ["ALLOWANCE"]}

SearchFilterByCompanyInput

Fields
Input Field Description
id - SearchFilterByIdInput
Example
{"id": SearchFilterByIdInput}

SearchFilterByCostCodeCategoryInput

Fields
Input Field Description
eq - CostCodeCategory
contains - [CostCodeCategory]
Example
{"eq": "LABOR", "contains": ["LABOR"]}

SearchFilterByCostCodeStatusInput

Fields
Input Field Description
eq - CostCodeStatus
contains - [CostCodeStatus]
Example
{"eq": "ACTIVE", "contains": ["ACTIVE"]}

SearchFilterByCostCodeTypeInput

Fields
Input Field Description
eq - CostCodeSearchType
contains - [CostCodeSearchType]
Example
{"eq": "COMPANY", "contains": ["COMPANY"]}

SearchFilterByDateInput

Fields
Input Field Description
eq - AWSDateTime
ge - AWSDateTime
le - AWSDateTime
between - [AWSDateTime]
Example
{
  "eq": AWSDateTime,
  "ge": AWSDateTime,
  "le": AWSDateTime,
  "between": [AWSDateTime]
}

SearchFilterByIdInput

Fields
Input Field Description
eq - ID
contains - [ID]
Example
{"eq": 4, "contains": ["4"]}

SearchFilterByIdNameInput

Fields
Input Field Description
id - SearchFilterByIdInput
name - SearchFilterByStringInput
Example
{
  "id": SearchFilterByIdInput,
  "name": SearchFilterByStringInput
}

SearchFilterByIdWithNegationInput

Fields
Input Field Description
eq - ID
ne - ID
contains - [ID]
notContains - [ID]
Example
{
  "eq": 4,
  "ne": "4",
  "contains": [4],
  "notContains": [4]
}

SearchFilterByLoginStatusInput

Fields
Input Field Description
eq - LoginStatus
contains - [LoginStatus]
Example
{"eq": "ACTIVE", "contains": ["ACTIVE"]}

SearchFilterByMailboxBoxTypeInput

Fields
Input Field Description
eq - EmailBox
Example
{"eq": "INBOX"}

SearchFilterByMailboxDocumentTypeInput

Fields
Input Field Description
eq - ConstructionDocumentType
contains - [ConstructionDocumentType!]
Example
{"eq": "FIELD_NOTE", "contains": ["FIELD_NOTE"]}

SearchFilterByProjectInput

Fields
Input Field Description
id - SearchFilterByIdInput
Example
{"id": SearchFilterByIdInput}

SearchFilterByPurchaseOrderStatusInput

Fields
Input Field Description
eq - PurchaseOrderStatus
contains - [PurchaseOrderStatus!]
Example
{"eq": "DRAFT", "contains": ["DRAFT"]}

SearchFilterByRfiStatusInput

Fields
Input Field Description
eq - RfiStatus
contains - [RfiStatus!]
Example
{"eq": "PENDING", "contains": ["PENDING"]}

SearchFilterByStringInput

Fields
Input Field Description
eq - String
contains - [String]
Example
{
  "eq": "xyz789",
  "contains": ["xyz789"]
}

SearchFilterBySubmittalDocumentTypeInput

Fields
Input Field Description
eq - SubmittalDocType
contains - [SubmittalDocType!]
Example
{"eq": "SUBMITTAL", "contains": ["SUBMITTAL"]}

SearchFilterBySubmittalPackageInput

Fields
Input Field Description
id - SearchFilterByIdWithNegationInput
Example
{"id": SearchFilterByIdWithNegationInput}

SearchFilterBySubmittalPackageStatusInput

Fields
Input Field Description
eq - PackageStatus
contains - [PackageStatus!]
Example
{"eq": "DRAFT", "contains": ["DRAFT"]}

SearchFilterBySubmittalStatusInput

Fields
Input Field Description
eq - SubmittalStatus
contains - [SubmittalStatus!]
Example
{"eq": "DRAFT", "contains": ["DRAFT"]}

SearchFilterBySubmittalTypeInput

Fields
Input Field Description
eq - SubmittalType
contains - [SubmittalType!]
Example
{"eq": "PRODUCTDATA", "contains": ["PRODUCTDATA"]}

SearchFilterByUserTypeInput

Fields
Input Field Description
eq - UserType
contains - [UserType]
Example
{"eq": "STANDARD", "contains": ["STANDARD"]}

SearchResult

Fields
Field Name Description
items - [SearchResultDocument!]
pagination - SearchResultsPagination!
Example
{
  "items": [SearchResultDocument],
  "pagination": SearchResultsPagination
}

SearchResultDocument

Fields
Field Name Description
title - String
id - String
type - String
documentType - String
Example
{
  "title": "xyz789",
  "id": "xyz789",
  "type": "abc123",
  "documentType": "xyz789"
}

SearchResultsPagination

Fields
Field Name Description
hits - Int
currentPage - Int
pages - Int
pageSize - Int
Example
{"hits": 987, "currentPage": 123, "pages": 123, "pageSize": 123}

SetBatchEntityAssignmentInput

Fields
Input Field Description
listOfEntityIds - [String!]!
userId - ID!
Example
{
  "listOfEntityIds": ["abc123"],
  "userId": "4"
}

Shift

Values
Enum Value Description

SHIFT1

SHIFT2

SHIFT3

Example
"SHIFT1"

ShiftDifferential

Fields
Field Name Description
amount - Int
type - ShiftDifferentialType
Example
{"amount": 123, "type": "PERCENTAGE"}

ShiftDifferentialInput

Fields
Input Field Description
amount - Int
type - ShiftDifferentialType
Example
{"amount": 123, "type": "PERCENTAGE"}

ShiftDifferentialType

Values
Enum Value Description

PERCENTAGE

DOLLAR

Example
"PERCENTAGE"

String

Description

Built-in String

Example
"abc123"

SubmittalDocType

Values
Enum Value Description

SUBMITTAL

TRANSMITTAL

Example
"SUBMITTAL"

SubmittalDocumentTypeSearchFacet

Fields
Field Name Description
name - String!
key - SubmittalDocType!
count - Int
Example
{
  "name": "xyz789",
  "key": "SUBMITTAL",
  "count": 987
}

SubmittalItem

Fields
Field Name Description
created - String
dateReceived - AWSDateTime
dateSent - AWSDateTime
deliveryDate - AWSDateTime
description - String
docs - [AttachmentV2!]!
documentType - SubmittalDocType
emails - [Email!]!
from - Contact
id - String!
images - [ResizedAttachment!]!
installationDate - AWSDateTime
leadTime - AWSDateTime
methodSent - SubmittalMethodSent
modified - String
name - String!
notes - String
number - String!
package - SubmittalPackage
poIssueDate - AWSDateTime
poReleaseDate - AWSDateTime
priority - SubmittalPriority
project - Project!
reasonForSending - SubmittalReasonForSending
respondedOn - AWSDateTime
returnBy - AWSDateTime
revision - Int
specSection - String
status - SubmittalStatus!
submitBy - AWSDateTime
to - Contact
type - SubmittalType
warrantyDate - AWSDateTime
Example
{
  "created": "abc123",
  "dateReceived": AWSDateTime,
  "dateSent": AWSDateTime,
  "deliveryDate": AWSDateTime,
  "description": "xyz789",
  "docs": [AttachmentV2],
  "documentType": "SUBMITTAL",
  "emails": [Email],
  "from": Contact,
  "id": "abc123",
  "images": [ResizedAttachment],
  "installationDate": AWSDateTime,
  "leadTime": AWSDateTime,
  "methodSent": "CERTIFIEDMAIL",
  "modified": "abc123",
  "name": "xyz789",
  "notes": "xyz789",
  "number": "xyz789",
  "package": SubmittalPackage,
  "poIssueDate": AWSDateTime,
  "poReleaseDate": AWSDateTime,
  "priority": "LOW",
  "project": Project,
  "reasonForSending": "ASREQUESTED",
  "respondedOn": AWSDateTime,
  "returnBy": AWSDateTime,
  "revision": 123,
  "specSection": "xyz789",
  "status": "DRAFT",
  "submitBy": AWSDateTime,
  "to": Contact,
  "type": "PRODUCTDATA",
  "warrantyDate": AWSDateTime
}

SubmittalItemEmailInput

Fields
Input Field Description
to - [String!]!
cc - [String!]!
bcc - [String!]!
subject - String
comments - String
entityString - String!
Example
{
  "to": ["abc123"],
  "cc": ["xyz789"],
  "bcc": ["abc123"],
  "subject": "abc123",
  "comments": "abc123",
  "entityString": "xyz789"
}

SubmittalMethodSent

Values
Enum Value Description

CERTIFIEDMAIL

EMAIL

FAX

FEDEX

HANDDELIVERY

MAIL

OTHER

OVERNIGHTDELIVERY

UPS

Example
"CERTIFIEDMAIL"

SubmittalPackage

Fields
Field Name Description
created - String
dateSent - AWSDateTime
description - String
from - Contact
id - String!
modified - String
number - String
name - String
project - Project!
respondBy - AWSDateTime
returnedOn - AWSDateTime
status - PackageStatus!
to - Contact
submittalItems - [SubmittalItem!]!
emails - [Email!]!
Example
{
  "created": "xyz789",
  "dateSent": AWSDateTime,
  "description": "xyz789",
  "from": Contact,
  "id": "xyz789",
  "modified": "abc123",
  "number": "abc123",
  "name": "abc123",
  "project": Project,
  "respondBy": AWSDateTime,
  "returnedOn": AWSDateTime,
  "status": "DRAFT",
  "to": Contact,
  "submittalItems": [SubmittalItem],
  "emails": [Email]
}

SubmittalPackageEmailInput

Fields
Input Field Description
to - [String!]!
cc - [String!]!
bcc - [String!]!
subject - String
comments - String
entityString - String!
Example
{
  "to": ["xyz789"],
  "cc": ["abc123"],
  "bcc": ["abc123"],
  "subject": "abc123",
  "comments": "abc123",
  "entityString": "abc123"
}

SubmittalPackageSearchFacets

Fields
Field Name Description
status - [SubmittalPackageStatusSearchFacet!]!
Example
{"status": [SubmittalPackageStatusSearchFacet]}

SubmittalPackageSearchFilterInput

Fields
Input Field Description
status - SearchFilterBySubmittalPackageStatusInput
projects - SearchFilterByProjectInput
Example
{
  "status": SearchFilterBySubmittalPackageStatusInput,
  "projects": SearchFilterByProjectInput
}

SubmittalPackageSearchHighlight

Fields
Field Name Description
number - String
name - String
Example
{
  "number": "abc123",
  "name": "xyz789"
}

SubmittalPackageSearchResult

Fields
Field Name Description
document - SubmittalPackageSearchResultDocument!
highlight - SubmittalPackageSearchHighlight
Example
{
  "document": SubmittalPackageSearchResultDocument,
  "highlight": SubmittalPackageSearchHighlight
}

SubmittalPackageSearchResultDocument

Fields
Field Name Description
entity - SubmittalPackage!
Example
{"entity": SubmittalPackage}

SubmittalPackageSearchResults

Fields
Field Name Description
items - [SubmittalPackageSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [SubmittalPackageSearchResult],
  "pagination": SearchResultsPagination
}

SubmittalPackageSearchSortByColumn

Values
Enum Value Description

NUMBER

NAME

DATE_SENT

RESPOND_BY

RETURNED_ON

Example
"NUMBER"

SubmittalPackageStatusSearchFacet

Fields
Field Name Description
name - String!
key - PackageStatus!
count - Int
Example
{
  "name": "abc123",
  "key": "DRAFT",
  "count": 987
}

SubmittalPriority

Values
Enum Value Description

LOW

MEDIUM

HIGH

Example
"LOW"

SubmittalReasonForSending

Values
Enum Value Description

ASREQUESTED

ASBUILT

FORAPPROVAL

FORDRAFTINGONLY

FORRELEASE

FORREVIEWANDCOMMENT

FORSIGNATURE

FORYOURUSE

OTHER

RETURNEDFORCORRECTIONS

Example
"ASREQUESTED"

SubmittalSearchFacets

Fields
Field Name Description
documentType - [SubmittalDocumentTypeSearchFacet!]!
status - [SubmittalStatusSearchFacet!]!
type - [SubmittalTypeSearchFacet!]!
showAllRevisions - [SearchFacetBoolean!]!
Example
{
  "documentType": [SubmittalDocumentTypeSearchFacet],
  "status": [SubmittalStatusSearchFacet],
  "type": [SubmittalTypeSearchFacet],
  "showAllRevisions": [SearchFacetBoolean]
}

SubmittalSearchFilterInput

Example
{
  "documentType": SearchFilterBySubmittalDocumentTypeInput,
  "type": SearchFilterBySubmittalTypeInput,
  "status": SearchFilterBySubmittalStatusInput,
  "package": SearchFilterBySubmittalPackageInput,
  "showAllRevisions": SearchFilterByBooleanInput,
  "projects": SearchFilterByProjectInput
}

SubmittalSearchHighlight

Fields
Field Name Description
number - String
name - String
description - String
specSection - String
package - String
Example
{
  "number": "abc123",
  "name": "abc123",
  "description": "abc123",
  "specSection": "xyz789",
  "package": "xyz789"
}

SubmittalSearchResult

Fields
Field Name Description
document - SubmittalSearchResultDocument!
highlight - SubmittalSearchHighlight
Example
{
  "document": SubmittalSearchResultDocument,
  "highlight": SubmittalSearchHighlight
}

SubmittalSearchResultDocument

Fields
Field Name Description
entity - SubmittalItem!
Example
{"entity": SubmittalItem}

SubmittalSearchResults

Fields
Field Name Description
items - [SubmittalSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [SubmittalSearchResult],
  "pagination": SearchResultsPagination
}

SubmittalSearchSortByColumn

Values
Enum Value Description

NUMBER

PACKAGE_NO

SUBMIT_BY

RETURN_BY

DATE_SENT

RETURNED_ON

SPEC_SECTION

Example
"NUMBER"

SubmittalSettings

Fields
Field Name Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["abc123"],
  "distributionListCc": ["abc123"],
  "distributionListBcc": ["xyz789"]
}

SubmittalSettingsInput

Fields
Input Field Description
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
Example
{
  "distributionListTo": ["xyz789"],
  "distributionListCc": ["abc123"],
  "distributionListBcc": ["xyz789"]
}

SubmittalStatus

Values
Enum Value Description

DRAFT

PACKAGED

SENT

RETURNED

APPROVED

APPROVEDASNOTED

NOEXCEPTIONSTAKEN

REVISEANDRESUBMIT

REJECTED

VOID

OTHER

REVISED

Example
"DRAFT"

SubmittalStatusSearchFacet

Fields
Field Name Description
name - String!
key - SubmittalStatus!
count - Int
Example
{
  "name": "abc123",
  "key": "DRAFT",
  "count": 987
}

SubmittalType

Values
Enum Value Description

PRODUCTDATA

CERTIFICATES

SHOPDRAWINGS

SAMPLES

ATTICSTOCK

OMMANUALS

WARRANTY

SCHEDULE

REPORTS

DOCUMENTATION

LEED

MOCKUP

PROJECTDOCUMENTS

OTHER

Example
"PRODUCTDATA"

SubmittalTypeSearchFacet

Fields
Field Name Description
name - String!
key - SubmittalType!
count - Int
Example
{
  "name": "xyz789",
  "key": "PRODUCTDATA",
  "count": 987
}

Temperature

Fields
Field Name Description
fahrenheit - Int
celsius - Int
Example
{"fahrenheit": 987, "celsius": 123}

TemperatureInput

Fields
Input Field Description
fahrenheit - Int
celsius - Int
Example
{"fahrenheit": 987, "celsius": 987}

TimeCard

Fields
Field Name Description
comments - String
date - AWSDateTime!
doubleTimeInMinutes - Int
hoursLost - Int
id - ID!
laborClass - String
overTimeInMinutes - Int
projectCostCode - ProjectCostCode
project - Project
regularTimeInMinutes - Int
shift - Shift
status - TimeCardStatus
timeCardProjectCostCodeNumber - String
timeCardDailyReportId - String
units - Int
user - User
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "comments": "xyz789",
  "date": AWSDateTime,
  "doubleTimeInMinutes": 987,
  "hoursLost": 987,
  "id": 4,
  "laborClass": "abc123",
  "overTimeInMinutes": 123,
  "projectCostCode": ProjectCostCode,
  "project": Project,
  "regularTimeInMinutes": 987,
  "shift": "SHIFT1",
  "status": "PENDING",
  "timeCardProjectCostCodeNumber": "abc123",
  "timeCardDailyReportId": "xyz789",
  "units": 987,
  "user": User,
  "_version": 987,
  "_deleted": true,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

TimeCardMigration

Fields
Field Name Description
id - ID!
timeCardProjectCostCodeNumber - String
timeCardDailyReportId - String
projectCostCode - ProjectCostCode
user - User
project - Project
date - AWSDateTime!
regularTimeInMinutes - Int
overTimeInMinutes - Int
doubleTimeInMinutes - Int
shift - Shift
hoursLost - Int
units - Int
comments - String
status - TimeCardStatus
laborClass - String
Example
{
  "id": "4",
  "timeCardProjectCostCodeNumber": "abc123",
  "timeCardDailyReportId": "abc123",
  "projectCostCode": ProjectCostCode,
  "user": User,
  "project": Project,
  "date": AWSDateTime,
  "regularTimeInMinutes": 987,
  "overTimeInMinutes": 987,
  "doubleTimeInMinutes": 987,
  "shift": "SHIFT1",
  "hoursLost": 123,
  "units": 987,
  "comments": "abc123",
  "status": "PENDING",
  "laborClass": "xyz789"
}

TimeCardSettings

Fields
Field Name Description
weekEndingDay - DaysOfTheWeek!
applyOTPerDayInXHours - Int!
applyOTPerWeekInXHours - Int!
otEnabled - Boolean!
dtEnabled - Boolean!
shiftEnabled - Boolean!
laborClassEnabled - Boolean!
Example
{
  "weekEndingDay": "MONDAY",
  "applyOTPerDayInXHours": 123,
  "applyOTPerWeekInXHours": 987,
  "otEnabled": false,
  "dtEnabled": false,
  "shiftEnabled": false,
  "laborClassEnabled": false
}

TimeCardSettingsInput

Fields
Input Field Description
weekEndingDay - DaysOfTheWeek!
applyOTPerDayInXHours - Int!
applyOTPerWeekInXHours - Int!
otEnabled - Boolean!
dtEnabled - Boolean!
shiftEnabled - Boolean!
laborClassEnabled - Boolean!
Example
{
  "weekEndingDay": "MONDAY",
  "applyOTPerDayInXHours": 987,
  "applyOTPerWeekInXHours": 123,
  "otEnabled": false,
  "dtEnabled": true,
  "shiftEnabled": false,
  "laborClassEnabled": false
}

TimeCardStatus

Values
Enum Value Description

PENDING

EXPORTED

APPROVED

REJECTED

Example
"PENDING"

TimeCards

Fields
Field Name Description
items - [TimeCard!]!
nextToken - String
Example
{
  "items": [TimeCard],
  "nextToken": "abc123"
}

UnitOfMeasure

Fields
Field Name Description
id - ID
companyId - String
name - String
abbreviation - String
Example
{
  "id": "4",
  "companyId": "xyz789",
  "name": "abc123",
  "abbreviation": "abc123"
}

UnitOfMeasures

Fields
Field Name Description
items - [UnitOfMeasure!]!
cursor - String
Example
{
  "items": [UnitOfMeasure],
  "cursor": "abc123"
}

UpdateAdminCompanyInput

Fields
Input Field Description
id - ID!
orgId - ID!
name - String
address - AddressInput
country - String
phone - String
fax - String
hierarchy - String
Example
{
  "id": 4,
  "orgId": "4",
  "name": "abc123",
  "address": AddressInput,
  "country": "xyz789",
  "phone": "abc123",
  "fax": "abc123",
  "hierarchy": "xyz789"
}

UpdateChangeOrderRequestAttachmentInput

Fields
Input Field Description
changeOrderRequestId - String!
attachmentId - String!
name - String
tags - [DriveTagInput!]
Example
{
  "changeOrderRequestId": "xyz789",
  "attachmentId": "abc123",
  "name": "abc123",
  "tags": [DriveTagInput]
}

UpdateChangeOrderRequestEquipmentLineItemInput

Fields
Input Field Description
id - String!
projectCostCodeNumber - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
unitOfMeasureId - String
customUnitOfMeasure - String
rateInPennies - Int
sellPriceInPennies - Int
quantity - Float
customEquipment - String
Example
{
  "id": "abc123",
  "projectCostCodeNumber": "xyz789",
  "notes": "abc123",
  "costInPennies": 123,
  "markup": 123.45,
  "totalInPennies": 123,
  "tags": [WorksheetTagInput],
  "unitOfMeasureId": "abc123",
  "customUnitOfMeasure": "abc123",
  "rateInPennies": 987,
  "sellPriceInPennies": 987,
  "quantity": 987.65,
  "customEquipment": "xyz789"
}

UpdateChangeOrderRequestInput

Fields
Input Field Description
approvalNumber - String
approvedAmountInPennies - Int
date - AWSDateTime
dateApproved - AWSDateTime
dateSent - AWSDateTime
daysValid - Int
id - String!
internalNotes - String
itemSummary - ChangeOrderRequestItemSummaryInput
name - String
number - String
referenceNumberAsi - String
referenceNumberGcCor - String
referenceNumberOther - String
referenceNumberOwnerCor - String
referenceNumberPco - String
referenceNumberRfi - String
respondBy - AWSDateTime
returnedOn - AWSDateTime
returnToContactId - String
scheduleImpactComments - String
scheduleImpactDays - Int
scopeOfWork - String
sendByDate - AWSDateTime
smallTools - ChangeOrderRequestSmallToolsInput
status - ChangeOrderRequestStatus
toContactId - String
worksheet - ChangeOrderRequestWorksheetInput
workType - ChangeOrderRequestWorkType
Example
{
  "approvalNumber": "abc123",
  "approvedAmountInPennies": 987,
  "date": AWSDateTime,
  "dateApproved": AWSDateTime,
  "dateSent": AWSDateTime,
  "daysValid": 987,
  "id": "abc123",
  "internalNotes": "abc123",
  "itemSummary": ChangeOrderRequestItemSummaryInput,
  "name": "xyz789",
  "number": "xyz789",
  "referenceNumberAsi": "xyz789",
  "referenceNumberGcCor": "xyz789",
  "referenceNumberOther": "abc123",
  "referenceNumberOwnerCor": "xyz789",
  "referenceNumberPco": "xyz789",
  "referenceNumberRfi": "abc123",
  "respondBy": AWSDateTime,
  "returnedOn": AWSDateTime,
  "returnToContactId": "xyz789",
  "scheduleImpactComments": "xyz789",
  "scheduleImpactDays": 123,
  "scopeOfWork": "abc123",
  "sendByDate": AWSDateTime,
  "smallTools": ChangeOrderRequestSmallToolsInput,
  "status": "DRAFT",
  "toContactId": "abc123",
  "worksheet": ChangeOrderRequestWorksheetInput,
  "workType": "ALLOWANCE"
}

UpdateChangeOrderRequestLaborLineItemInput

Fields
Input Field Description
id - String!
costInPennies - Int!
markup - Float
notes - String
projectCostCodeNumber - String
totalInPennies - Int!
tags - [WorksheetTagInput!]
customLaborClass - String
hoursInMinutes - Int
laborClassId - String
rateInPennies - Int
sellRateInPennies - Int
workers - Float
Example
{
  "id": "abc123",
  "costInPennies": 123,
  "markup": 987.65,
  "notes": "abc123",
  "projectCostCodeNumber": "abc123",
  "totalInPennies": 123,
  "tags": [WorksheetTagInput],
  "customLaborClass": "xyz789",
  "hoursInMinutes": 123,
  "laborClassId": "abc123",
  "rateInPennies": 987,
  "sellRateInPennies": 123,
  "workers": 123.45
}

UpdateChangeOrderRequestMaterialLineItemInput

Fields
Input Field Description
id - String!
projectCostCodeNumber - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
unitOfMeasureId - String
customUnitOfMeasure - String
rateInPennies - Int
sellPriceInPennies - Int
quantity - Float
customMaterial - String
Example
{
  "id": "abc123",
  "projectCostCodeNumber": "abc123",
  "notes": "abc123",
  "costInPennies": 987,
  "markup": 987.65,
  "totalInPennies": 123,
  "tags": [WorksheetTagInput],
  "unitOfMeasureId": "xyz789",
  "customUnitOfMeasure": "xyz789",
  "rateInPennies": 987,
  "sellPriceInPennies": 123,
  "quantity": 987.65,
  "customMaterial": "xyz789"
}

UpdateChangeOrderRequestOtherLineItemInput

Fields
Input Field Description
id - String!
projectCostCodeNumber - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasureId - String
Example
{
  "id": "xyz789",
  "projectCostCodeNumber": "abc123",
  "notes": "xyz789",
  "costInPennies": 123,
  "markup": 987.65,
  "totalInPennies": 987,
  "tags": [WorksheetTagInput],
  "customUnitOfMeasure": "abc123",
  "description": "xyz789",
  "priceInPennies": 123,
  "quantity": 123.45,
  "sellPriceInPennies": 123,
  "unitOfMeasureId": "xyz789"
}

UpdateChangeOrderRequestOverheadLineItemInput

Fields
Input Field Description
id - String!
projectCostCodeNumber - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasureId - String
Example
{
  "id": "abc123",
  "projectCostCodeNumber": "abc123",
  "notes": "xyz789",
  "costInPennies": 987,
  "markup": 987.65,
  "totalInPennies": 987,
  "tags": [WorksheetTagInput],
  "customUnitOfMeasure": "abc123",
  "description": "abc123",
  "priceInPennies": 123,
  "quantity": 123.45,
  "sellPriceInPennies": 987,
  "unitOfMeasureId": "xyz789"
}

UpdateChangeOrderRequestSubcontractorLineItemInput

Fields
Input Field Description
id - String!
projectCostCodeNumber - String
notes - String
costInPennies - Int!
markup - Float
totalInPennies - Int!
tags - [WorksheetTagInput!]
customUnitOfMeasure - String
description - String
priceInPennies - Int
quantity - Float
sellPriceInPennies - Int
unitOfMeasureId - String
Example
{
  "id": "abc123",
  "projectCostCodeNumber": "xyz789",
  "notes": "xyz789",
  "costInPennies": 123,
  "markup": 123.45,
  "totalInPennies": 987,
  "tags": [WorksheetTagInput],
  "customUnitOfMeasure": "abc123",
  "description": "xyz789",
  "priceInPennies": 123,
  "quantity": 123.45,
  "sellPriceInPennies": 123,
  "unitOfMeasureId": "abc123"
}

UpdateCompanyCostCodeInput

Fields
Input Field Description
companyId - String!
number - String!
name - String
status - CostCodeStatus
categories - [CostCodeCategory!]
addToNewProjects - Boolean
Example
{
  "companyId": "abc123",
  "number": "xyz789",
  "name": "xyz789",
  "status": "ACTIVE",
  "categories": ["LABOR"],
  "addToNewProjects": false
}

UpdateCompanyFileInput

Fields
Input Field Description
companyId - String!
id - String!
name - String
tags - [DriveTagInput!]
Example
{
  "companyId": "xyz789",
  "id": "abc123",
  "name": "abc123",
  "tags": [DriveTagInput]
}

UpdateCompanyFolderInput

Fields
Input Field Description
companyId - String!
id - String!
name - String
Example
{
  "companyId": "abc123",
  "id": "xyz789",
  "name": "xyz789"
}

UpdateCompanySettingsInput

Fields
Input Field Description
id - ID!
hierarchy - String
dailyReportEditWindow - Int
dailyReportEditWindowUnlimited - Boolean
viewDailyReportCommentWorkPerformed - Boolean
viewDailyReportCommentWorkPerformedLabel - String
viewDailyReportCommentExtraWork - Boolean
viewDailyReportCommentExtraWorkLabel - String
viewDailyReportCommentSchedule - Boolean
viewDailyReportCommentScheduleLabel - String
viewDailyReportCommentSubcontractorsWorked - Boolean
viewDailyReportCommentSubcontractorsWorkedLabel - String
viewDailyReportCommentOtherVisitors - Boolean
viewDailyReportCommentOtherVisitorsLabel - String
viewDailyReportCommentWeather - Boolean
viewDailyReportCommentWeatherLabel - String
viewDailyReportCommentAccidents - Boolean
viewDailyReportCommentAccidentsLabel - String
viewDailyReportCommentProblems - Boolean
viewDailyReportCommentProblemsLabel - String
viewDailyReportCommentInternal - Boolean
viewDailyReportCommentInternalLabel - String
displayDailyReportComments - Boolean
displayDailyReportCrew - Boolean
timeCardSettings - TimeCardSettingsInput
rfiSettings - RFISettingsInput
changeOrderRequestSettings - ChangeOrderRequestSettingsInput
purchaseOrderSettings - PurchaseOrderSettingsInput
Example
{
  "id": 4,
  "hierarchy": "abc123",
  "dailyReportEditWindow": 987,
  "dailyReportEditWindowUnlimited": false,
  "viewDailyReportCommentWorkPerformed": false,
  "viewDailyReportCommentWorkPerformedLabel": "xyz789",
  "viewDailyReportCommentExtraWork": false,
  "viewDailyReportCommentExtraWorkLabel": "xyz789",
  "viewDailyReportCommentSchedule": true,
  "viewDailyReportCommentScheduleLabel": "xyz789",
  "viewDailyReportCommentSubcontractorsWorked": true,
  "viewDailyReportCommentSubcontractorsWorkedLabel": "xyz789",
  "viewDailyReportCommentOtherVisitors": true,
  "viewDailyReportCommentOtherVisitorsLabel": "abc123",
  "viewDailyReportCommentWeather": true,
  "viewDailyReportCommentWeatherLabel": "abc123",
  "viewDailyReportCommentAccidents": false,
  "viewDailyReportCommentAccidentsLabel": "abc123",
  "viewDailyReportCommentProblems": true,
  "viewDailyReportCommentProblemsLabel": "abc123",
  "viewDailyReportCommentInternal": true,
  "viewDailyReportCommentInternalLabel": "abc123",
  "displayDailyReportComments": false,
  "displayDailyReportCrew": false,
  "timeCardSettings": TimeCardSettingsInput,
  "rfiSettings": RFISettingsInput,
  "changeOrderRequestSettings": ChangeOrderRequestSettingsInput,
  "purchaseOrderSettings": PurchaseOrderSettingsInput
}

UpdateContactInput

Fields
Input Field Description
id - ID!
firstName - String
middleName - String
lastName - String
jobTitle - String
email - String
address - AddressAllOptionalInput
country - String
office - String
mobile - String
fax - String
notes - String
businessName - String
businessType - String
status - AvailabilityStatus
apVendor - Boolean
vendorId - String
website - String
cannotDelete - Boolean
_version - Int
Example
{
  "id": 4,
  "firstName": "xyz789",
  "middleName": "xyz789",
  "lastName": "xyz789",
  "jobTitle": "abc123",
  "email": "xyz789",
  "address": AddressAllOptionalInput,
  "country": "xyz789",
  "office": "abc123",
  "mobile": "xyz789",
  "fax": "xyz789",
  "notes": "abc123",
  "businessName": "abc123",
  "businessType": "xyz789",
  "status": "AVAILABLE",
  "apVendor": true,
  "vendorId": "abc123",
  "website": "abc123",
  "cannotDelete": true,
  "_version": 987
}

UpdateDailyReportInput

Fields
Input Field Description
id - ID!
projectId - String
customNo - String
date - AWSDateTime
timeOnSite - AWSDateTime
timeOffSite - AWSDateTime
totalWorkers - Int
author - String
authorId - String
weatherConditions - WeatherInput
weather - String
wind - String
temperature - Int
workPerformed - String
keywords - [String!]
listOfKeywords - [NestedKeywordsInput!]
issues - String
favors - String
accidents - String
subcontractorsWorked - String
visitors - String
comments - String
notes - String
internalComments - String
weatherComments - String
lastEditedBy - String
attachments - AttachmentsInput
docs - DocsInput
emails - [EmailInput!]
_version - Int
Example
{
  "id": "4",
  "projectId": "abc123",
  "customNo": "xyz789",
  "date": AWSDateTime,
  "timeOnSite": AWSDateTime,
  "timeOffSite": AWSDateTime,
  "totalWorkers": 987,
  "author": "xyz789",
  "authorId": "xyz789",
  "weatherConditions": WeatherInput,
  "weather": "abc123",
  "wind": "xyz789",
  "temperature": 123,
  "workPerformed": "xyz789",
  "keywords": ["abc123"],
  "listOfKeywords": [NestedKeywordsInput],
  "issues": "abc123",
  "favors": "abc123",
  "accidents": "xyz789",
  "subcontractorsWorked": "abc123",
  "visitors": "abc123",
  "comments": "xyz789",
  "notes": "abc123",
  "internalComments": "abc123",
  "weatherComments": "abc123",
  "lastEditedBy": "xyz789",
  "attachments": AttachmentsInput,
  "docs": DocsInput,
  "emails": [EmailInput],
  "_version": 123
}

UpdateEmailInput

Fields
Input Field Description
id - String!
boxType - EmailBox
isUrgent - Boolean
hasBeenRead - Boolean
linkedDocument - LinkedDocumentInput
Example
{
  "id": "xyz789",
  "boxType": "INBOX",
  "isUrgent": true,
  "hasBeenRead": true,
  "linkedDocument": LinkedDocumentInput
}

UpdateEntityAssignmentInput

Fields
Input Field Description
id - ID!
entityId - ID
userId - ID
_version - Int
Example
{
  "id": "4",
  "entityId": "4",
  "userId": 4,
  "_version": 987
}

UpdateFieldNoteInput

Fields
Input Field Description
id - ID!
note - String
createdOnDeviceAt - AWSDateTime
keywords - [String!]
listOfKeywords - [NestedKeywordsInput!]
locationTags - [NestedLocationTagInput!]
address - AddressInput
phase - String
system - String
attachments - AttachmentsInput
createdByUsername - String
createdByUserId - String
projectId - String
docs - DocsInput
lastUpdatedByUsername - String
lastUpdatedByUserId - String
emails - [EmailInput!]
_version - Int
Example
{
  "id": 4,
  "note": "abc123",
  "createdOnDeviceAt": AWSDateTime,
  "keywords": ["abc123"],
  "listOfKeywords": [NestedKeywordsInput],
  "locationTags": [NestedLocationTagInput],
  "address": AddressInput,
  "phase": "xyz789",
  "system": "xyz789",
  "attachments": AttachmentsInput,
  "createdByUsername": "abc123",
  "createdByUserId": "xyz789",
  "projectId": "abc123",
  "docs": DocsInput,
  "lastUpdatedByUsername": "xyz789",
  "lastUpdatedByUserId": "abc123",
  "emails": [EmailInput],
  "_version": 123
}

UpdateKeywordInput

Fields
Input Field Description
id - ID!
name - String
companyId - String
status - AvailabilityStatus
usageCount - Int
_version - Int
Example
{
  "id": 4,
  "name": "xyz789",
  "companyId": "abc123",
  "status": "AVAILABLE",
  "usageCount": 123,
  "_version": 123
}

UpdateLaborClassInput

Fields
Input Field Description
id - ID!
name - String
status - LaborClassStatus
Example
{
  "id": "4",
  "name": "abc123",
  "status": "ACTIVE"
}

UpdateLocationTagInput

Fields
Input Field Description
id - ID!
name - String
projectId - String
_version - Int
Example
{
  "id": 4,
  "name": "xyz789",
  "projectId": "abc123",
  "_version": 987
}

UpdateOccupancySubTypeInput

Fields
Input Field Description
id - ID!
name - String
companyId - String
occupancyTypeId - String
_version - Int
Example
{
  "id": "4",
  "name": "xyz789",
  "companyId": "xyz789",
  "occupancyTypeId": "xyz789",
  "_version": 123
}

UpdateOccupancyTypeInput

Fields
Input Field Description
id - ID!
name - String
companyId - String
_version - Int
Example
{
  "id": "4",
  "name": "abc123",
  "companyId": "abc123",
  "_version": 123
}

UpdateOrganizationInput

Fields
Input Field Description
id - ID!
name - String
address - AddressInput
country - String
phone - String
fax - String
accountStatus - String
subscriptionStart - AWSDateTime
subscriptionEnd - AWSDateTime
userCount - Int
enabledModules - String
modules - [Modules!]
Example
{
  "id": "4",
  "name": "abc123",
  "address": AddressInput,
  "country": "abc123",
  "phone": "xyz789",
  "fax": "xyz789",
  "accountStatus": "xyz789",
  "subscriptionStart": AWSDateTime,
  "subscriptionEnd": AWSDateTime,
  "userCount": 123,
  "enabledModules": "abc123",
  "modules": ["CHANGE_ORDER_REQUEST"]
}

UpdatePOReceivingAttachmentInput

Fields
Input Field Description
purchaseOrderId - String!
receivingId - String!
attachmentId - String!
name - String
tags - [DriveTagInput!]
Example
{
  "purchaseOrderId": "xyz789",
  "receivingId": "abc123",
  "attachmentId": "xyz789",
  "name": "abc123",
  "tags": [DriveTagInput]
}

UpdatePermissionGroupInput

Fields
Input Field Description
groups - [PermissionGroupInput!]!
Example
{"groups": [PermissionGroupInput]}

UpdateProjectBudgetInput

Fields
Input Field Description
id - String
projectCostCodeNumber - String!
projectId - String!
units - Int
laborHoursInMinutes - Int
laborCostInPennies - Int
materialCostInPennies - Int
subcontractorCostInPennies - Int
equipmentCostInPennies - Int
overheadCostInPennies - Int
otherCostInPennies - Int
unitOfMeasureId - String
Example
{
  "id": "abc123",
  "projectCostCodeNumber": "abc123",
  "projectId": "xyz789",
  "units": 987,
  "laborHoursInMinutes": 987,
  "laborCostInPennies": 123,
  "materialCostInPennies": 987,
  "subcontractorCostInPennies": 987,
  "equipmentCostInPennies": 123,
  "overheadCostInPennies": 123,
  "otherCostInPennies": 123,
  "unitOfMeasureId": "abc123"
}

UpdateProjectCostCodeInput

Fields
Input Field Description
projectId - String!
number - String!
name - String
status - CostCodeStatus
categories - [CostCodeCategory!]
Example
{
  "projectId": "xyz789",
  "number": "abc123",
  "name": "abc123",
  "status": "ACTIVE",
  "categories": ["LABOR"]
}

UpdateProjectFileInput

Fields
Input Field Description
id - String!
name - String
projectId - String!
tags - [DriveTagInput!]
Example
{
  "id": "abc123",
  "name": "abc123",
  "projectId": "xyz789",
  "tags": [DriveTagInput]
}

UpdateProjectFolderInput

Fields
Input Field Description
id - String!
name - String
projectId - String!
Example
{
  "id": "xyz789",
  "name": "abc123",
  "projectId": "abc123"
}

UpdateProjectInput

Fields
Input Field Description
address - AddressAllOptionalInput
changeOrderRequestSettings - ProjectChangeOrderRequestSettingsInput
comments - String
companyId - String
companyName - String
contractCostInPennies - Int
contractNumber - String
contractSoldBy - String
contractType - String
dailyReportSettings - ProjectDailyReportSettingsInput
divisionId - String
endDate - AWSDateTime
id - ID!
isPrimeContractor - Boolean
mailboxEmail - String
marketAreaId - String
name - String
number - String
occupancySubTypeId - String
occupancyTypeId - String
officeFaxNumber - String
officePhoneNumber - String
projectRateTemplateId - String
rfiSettings - ProjectRFISettingsInput
submittalSettings - SubmittalSettingsInput
startDate - AWSDateTime
status - String
teams - ProjectTeamsInput
timeSettings - ProjectTimeSettingsInput
purchaseOrderSettings - ProjectPurchaseOrderSettingsInput
_version - Int
projectCompanyId - ID
Example
{
  "address": AddressAllOptionalInput,
  "changeOrderRequestSettings": ProjectChangeOrderRequestSettingsInput,
  "comments": "xyz789",
  "companyId": "abc123",
  "companyName": "abc123",
  "contractCostInPennies": 987,
  "contractNumber": "xyz789",
  "contractSoldBy": "xyz789",
  "contractType": "abc123",
  "dailyReportSettings": ProjectDailyReportSettingsInput,
  "divisionId": "xyz789",
  "endDate": AWSDateTime,
  "id": "4",
  "isPrimeContractor": false,
  "mailboxEmail": "xyz789",
  "marketAreaId": "xyz789",
  "name": "abc123",
  "number": "abc123",
  "occupancySubTypeId": "xyz789",
  "occupancyTypeId": "abc123",
  "officeFaxNumber": "abc123",
  "officePhoneNumber": "abc123",
  "projectRateTemplateId": "xyz789",
  "rfiSettings": ProjectRFISettingsInput,
  "submittalSettings": SubmittalSettingsInput,
  "startDate": AWSDateTime,
  "status": "xyz789",
  "teams": ProjectTeamsInput,
  "timeSettings": ProjectTimeSettingsInput,
  "purchaseOrderSettings": ProjectPurchaseOrderSettingsInput,
  "_version": 987,
  "projectCompanyId": 4
}

UpdateProjectSettingsInput

Fields
Input Field Description
id - ID!
changeOrderRequestSettings - ProjectChangeOrderRequestSettingsInput
dailyReportEditWindow - Int
dailyReportEditWindowUnlimited - Boolean
defaultOnTime - String
defaultOffTime - String
distributionListTo - [String]
distributionListCc - [String]
distributionListBcc - [String]
rfiDistributionListTo - [String]
rfiDistributionListCc - [String]
rfiDistributionListBcc - [String]
submittalSettings - SubmittalSettingsInput
purchaseOrderSettings - PurchaseOrderProjectSettingsInput
teams - ProjectTeamsInput
_version - Int
Example
{
  "id": "4",
  "changeOrderRequestSettings": ProjectChangeOrderRequestSettingsInput,
  "dailyReportEditWindow": 123,
  "dailyReportEditWindowUnlimited": true,
  "defaultOnTime": "xyz789",
  "defaultOffTime": "abc123",
  "distributionListTo": ["abc123"],
  "distributionListCc": ["xyz789"],
  "distributionListBcc": ["abc123"],
  "rfiDistributionListTo": ["xyz789"],
  "rfiDistributionListCc": ["abc123"],
  "rfiDistributionListBcc": ["abc123"],
  "submittalSettings": SubmittalSettingsInput,
  "purchaseOrderSettings": PurchaseOrderProjectSettingsInput,
  "teams": ProjectTeamsInput,
  "_version": 123
}

UpdatePurchaseOrderAttachmentInput

Fields
Input Field Description
purchaseOrderId - String!
attachmentId - String!
name - String
tags - [DriveTagInput!]
Example
{
  "purchaseOrderId": "abc123",
  "attachmentId": "xyz789",
  "name": "abc123",
  "tags": [DriveTagInput]
}

UpdatePurchaseOrderInput

Fields
Input Field Description
id - String!
number - String
date - AWSDateTime
type - PurchaseOrderType
status - PurchaseOrderStatus
description - String
vendorId - String
salesTaxRatePercent - Float
salesTaxAmountInPennies - Int
depositInPennies - Int
depositDate - AWSDateTime
releaseDate - AWSDateTime
billing - PurchaseOrderBillingInput
shipping - PurchaseOrderShippingInput
buyerNotes - String
vendorNotes - String
internalNotes - String
totalInPennies - Int
invoicedInPennies - Int
Example
{
  "id": "abc123",
  "number": "abc123",
  "date": AWSDateTime,
  "type": "PURCHASE_ORDER",
  "status": "DRAFT",
  "description": "xyz789",
  "vendorId": "abc123",
  "salesTaxRatePercent": 123.45,
  "salesTaxAmountInPennies": 123,
  "depositInPennies": 123,
  "depositDate": AWSDateTime,
  "releaseDate": AWSDateTime,
  "billing": PurchaseOrderBillingInput,
  "shipping": PurchaseOrderShippingInput,
  "buyerNotes": "abc123",
  "vendorNotes": "xyz789",
  "internalNotes": "abc123",
  "totalInPennies": 987,
  "invoicedInPennies": 123
}

UpdatePurchaseOrderLineInput

Fields
Input Field Description
id - String!
purchaseOrderId - String!
taxExempt - Boolean
number - String
description - String
projectCostCodeNumber - String
projectId - String
notes - String
priceInPennies - Int
per - String
unitOfMeasureId - String
quantityOrdered - Int
totalInPennies - Int
releaseDate - AWSDateTime
Example
{
  "id": "abc123",
  "purchaseOrderId": "xyz789",
  "taxExempt": true,
  "number": "xyz789",
  "description": "xyz789",
  "projectCostCodeNumber": "xyz789",
  "projectId": "xyz789",
  "notes": "abc123",
  "priceInPennies": 987,
  "per": "xyz789",
  "unitOfMeasureId": "xyz789",
  "quantityOrdered": 987,
  "totalInPennies": 123,
  "releaseDate": AWSDateTime
}

UpdatePurchaseOrderReceivingInput

Fields
Input Field Description
id - String!
purchaseOrderId - String!
date - AWSDateTime
packingSlipNumber - String
invoiceNumber - String
invoiceAmountInPennies - Int
comments - String
Example
{
  "id": "xyz789",
  "purchaseOrderId": "xyz789",
  "date": AWSDateTime,
  "packingSlipNumber": "abc123",
  "invoiceNumber": "xyz789",
  "invoiceAmountInPennies": 987,
  "comments": "abc123"
}

UpdatePurchaseOrderReceivingLineInput

Fields
Input Field Description
id - String!
purchaseOrderId - String!
receivingId - String!
lineNumber - String
itemNumber - String
itemDescription - String
unitOfMeasureName - String
totalOrdered - Int
previouslyReceived - Int
total - Int
receivedToday - Int
receivedInFull - Boolean
backOrdered - Int
Example
{
  "id": "xyz789",
  "purchaseOrderId": "xyz789",
  "receivingId": "abc123",
  "lineNumber": "abc123",
  "itemNumber": "abc123",
  "itemDescription": "abc123",
  "unitOfMeasureName": "abc123",
  "totalOrdered": 987,
  "previouslyReceived": 123,
  "total": 123,
  "receivedToday": 987,
  "receivedInFull": true,
  "backOrdered": 123
}

UpdateRateLaborClassInput

Fields
Input Field Description
id - String!
laborClassId - String!
rateInPennies - Int
overTimeInPennies - Int
doubleTimeInPennies - Int
status - LaborClassStatus
Example
{
  "id": "abc123",
  "laborClassId": "xyz789",
  "rateInPennies": 987,
  "overTimeInPennies": 123,
  "doubleTimeInPennies": 987,
  "status": "ACTIVE"
}

UpdateRateTemplateInput

Fields
Input Field Description
id - String!
name - String
shift2 - ShiftDifferentialInput
shift3 - ShiftDifferentialInput
laborClasses - [UpdateRateLaborClassInput!]
Example
{
  "id": "xyz789",
  "name": "abc123",
  "shift2": ShiftDifferentialInput,
  "shift3": ShiftDifferentialInput,
  "laborClasses": [UpdateRateLaborClassInput]
}

UpdateRfiAttachmentInput

Fields
Input Field Description
rfiId - String!
attachmentId - String!
name - String
tags - [DriveTagInput!]
Example
{
  "rfiId": "abc123",
  "attachmentId": "abc123",
  "name": "abc123",
  "tags": [DriveTagInput]
}

UpdateRfiInput

Fields
Input Field Description
gcFileNumber - String
gcNumber - String
attachments - AttachmentsInput
author - AuthorInput
respondByDate - AWSDate
date - AWSDate
id - ID!
projectId - String
dateV2 - AWSDateTime
lastEditedBy - AuthorInput
revision - Int
customNo - String
to - [NestedContactInput!]
subject - String
respondByDateV2 - AWSDateTime
questionForClarification - String
recommendedSolution - String
isScheduleImpacted - Boolean
isCostImpacted - Boolean
isUrgent - Boolean
reference - RfiReferenceInput
projectCostCodeAffected - ProjectCostCodeInput
projectCostCodeAffectedNumber - String
dateAnswered - AWSDateTime
status - RfiStatus
statusComment - String
answerToClarification - String
driveAttachments - [RfiAttachmentInput!]
images - [RfiImageInput!]
emails - [EmailInput!]
_version - Int
rfiAuthorV2Id - ID
Example
{
  "gcFileNumber": "xyz789",
  "gcNumber": "abc123",
  "attachments": AttachmentsInput,
  "author": AuthorInput,
  "respondByDate": AWSDate,
  "date": AWSDate,
  "id": 4,
  "projectId": "xyz789",
  "dateV2": AWSDateTime,
  "lastEditedBy": AuthorInput,
  "revision": 123,
  "customNo": "xyz789",
  "to": [NestedContactInput],
  "subject": "xyz789",
  "respondByDateV2": AWSDateTime,
  "questionForClarification": "xyz789",
  "recommendedSolution": "xyz789",
  "isScheduleImpacted": true,
  "isCostImpacted": true,
  "isUrgent": false,
  "reference": RfiReferenceInput,
  "projectCostCodeAffected": ProjectCostCodeInput,
  "projectCostCodeAffectedNumber": "abc123",
  "dateAnswered": AWSDateTime,
  "status": "PENDING",
  "statusComment": "xyz789",
  "answerToClarification": "abc123",
  "driveAttachments": [RfiAttachmentInput],
  "images": [RfiImageInput],
  "emails": [EmailInput],
  "_version": 123,
  "rfiAuthorV2Id": 4
}

UpdateSubmittalAttachmentInput

Fields
Input Field Description
submittalId - String!
attachmentId - String!
name - String
tags - [DriveTagInput!]
Example
{
  "submittalId": "xyz789",
  "attachmentId": "abc123",
  "name": "xyz789",
  "tags": [DriveTagInput]
}

UpdateSubmittalItemInput

Fields
Input Field Description
dateReceived - AWSDateTime
dateSent - AWSDateTime
deliveryDate - AWSDateTime
description - String
documentType - SubmittalDocType
fromContactId - String
id - String!
installationDate - AWSDateTime
leadTime - AWSDateTime
methodSent - SubmittalMethodSent
name - String
notes - String
number - String
package - String
poIssueDate - AWSDateTime
poReleaseDate - AWSDateTime
priority - SubmittalPriority
projectId - String
reasonForSending - SubmittalReasonForSending
respondedOn - AWSDateTime
returnBy - AWSDateTime
specSection - String
status - SubmittalStatus
submitBy - AWSDateTime
type - SubmittalType
toContactId - String
warrantyDate - AWSDateTime
Example
{
  "dateReceived": AWSDateTime,
  "dateSent": AWSDateTime,
  "deliveryDate": AWSDateTime,
  "description": "xyz789",
  "documentType": "SUBMITTAL",
  "fromContactId": "abc123",
  "id": "xyz789",
  "installationDate": AWSDateTime,
  "leadTime": AWSDateTime,
  "methodSent": "CERTIFIEDMAIL",
  "name": "abc123",
  "notes": "abc123",
  "number": "abc123",
  "package": "xyz789",
  "poIssueDate": AWSDateTime,
  "poReleaseDate": AWSDateTime,
  "priority": "LOW",
  "projectId": "xyz789",
  "reasonForSending": "ASREQUESTED",
  "respondedOn": AWSDateTime,
  "returnBy": AWSDateTime,
  "specSection": "abc123",
  "status": "DRAFT",
  "submitBy": AWSDateTime,
  "type": "PRODUCTDATA",
  "toContactId": "abc123",
  "warrantyDate": AWSDateTime
}

UpdateSubmittalPackageInput

Fields
Input Field Description
dateSent - AWSDateTime
description - String
fromContactId - String
id - String!
name - String
number - String
projectId - String
respondBy - AWSDateTime
returnedOn - AWSDateTime
status - PackageStatus
toContactId - String
Example
{
  "dateSent": AWSDateTime,
  "description": "xyz789",
  "fromContactId": "abc123",
  "id": "abc123",
  "name": "xyz789",
  "number": "xyz789",
  "projectId": "abc123",
  "respondBy": AWSDateTime,
  "returnedOn": AWSDateTime,
  "status": "DRAFT",
  "toContactId": "xyz789"
}

UpdateTimeCardInput

Fields
Input Field Description
comments - String
date - AWSDateTime
doubleTimeInMinutes - Int
hoursLost - Int
id - ID!
laborClass - String
overTimeInMinutes - Int
projectCostCode - ProjectCostCodeInput
regularTimeInMinutes - Int
shift - Shift
status - TimeCardStatus
timeCardProjectCostCodeNumber - String
timeCardDailyReportId - String
units - Int
_version - Int
timeCardProjectId - ID
timeCardUserId - ID
Example
{
  "comments": "xyz789",
  "date": AWSDateTime,
  "doubleTimeInMinutes": 123,
  "hoursLost": 123,
  "id": "4",
  "laborClass": "xyz789",
  "overTimeInMinutes": 123,
  "projectCostCode": ProjectCostCodeInput,
  "regularTimeInMinutes": 123,
  "shift": "SHIFT1",
  "status": "PENDING",
  "timeCardProjectCostCodeNumber": "abc123",
  "timeCardDailyReportId": "abc123",
  "units": 123,
  "_version": 123,
  "timeCardProjectId": 4,
  "timeCardUserId": 4
}

UpdateUnitOfMeasureInput

Fields
Input Field Description
id - String!
name - String
abbreviation - String
Example
{
  "id": "abc123",
  "name": "abc123",
  "abbreviation": "abc123"
}

UpdateUserInput

Fields
Input Field Description
id - ID!
orgId - String
companyAssociations - [String!]
defaultCompany - String
givenName - String
middleName - String
familyName - String
email - String
employeeNo - String
role - String
jobTitle - String
officeNo - String
mobileNo - String
faxNo - String
address - AddressAllOptionalInput
country - String
useCompanyAddress - Boolean
emailSignature - String
crew - Boolean
primaryLaborClass - String
languagePreference - String
dateDisplayPreference - String
permissionGroup - String
permissionGroupName - String
accessLevel - String
crewStatus - AvailabilityStatus
type - UserType
loginStatus - LoginStatus
addToNewProjects - Boolean
laborClassId - String
laborClass - LaborClassInput
_version - Int
Example
{
  "id": 4,
  "orgId": "xyz789",
  "companyAssociations": ["xyz789"],
  "defaultCompany": "xyz789",
  "givenName": "abc123",
  "middleName": "xyz789",
  "familyName": "xyz789",
  "email": "xyz789",
  "employeeNo": "abc123",
  "role": "xyz789",
  "jobTitle": "abc123",
  "officeNo": "xyz789",
  "mobileNo": "xyz789",
  "faxNo": "abc123",
  "address": AddressAllOptionalInput,
  "country": "xyz789",
  "useCompanyAddress": true,
  "emailSignature": "xyz789",
  "crew": false,
  "primaryLaborClass": "abc123",
  "languagePreference": "abc123",
  "dateDisplayPreference": "abc123",
  "permissionGroup": "abc123",
  "permissionGroupName": "abc123",
  "accessLevel": "abc123",
  "crewStatus": "AVAILABLE",
  "type": "STANDARD",
  "loginStatus": "ACTIVE",
  "addToNewProjects": true,
  "laborClassId": "xyz789",
  "laborClass": LaborClassInput,
  "_version": 987
}

UpdateUserLoginStatusInput

Fields
Input Field Description
id - ID!
loginStatus - LoginStatus!
Example
{"id": 4, "loginStatus": "ACTIVE"}

UpdateVersionSetInput

Fields
Input Field Description
id - String!
name - String
dateIssued - String
Example
{
  "id": "abc123",
  "name": "xyz789",
  "dateIssued": "xyz789"
}

UpdateWeatherTypeInput

Fields
Input Field Description
id - ID!
name - String
_version - Int
Example
{
  "id": "4",
  "name": "xyz789",
  "_version": 123
}

UpdateWindTypeInput

Fields
Input Field Description
id - ID!
name - String
_version - Int
Example
{
  "id": "4",
  "name": "xyz789",
  "_version": 123
}

User

Fields
Field Name Description
id - ID
orgId - String
companyAssociations - [String!]
defaultCompany - String
givenName - String!
middleName - String
familyName - String!
email - String
employeeNo - String
role - String
jobTitle - String
officeNo - String
mobileNo - String
faxNo - String
address - AddressAllOptional
country - String
useCompanyAddress - Boolean
emailSignature - String
crew - Boolean
primaryLaborClass - String User LaborClassId
languagePreference - String
dateDisplayPreference - String
permissionGroup - String
permissionGroupName - String
accessLevel - String
crewStatus - AvailabilityStatus
type - UserType
loginStatus - LoginStatus
addToNewProjects - Boolean
contact - Contact
laborClassId - String
laborClass - LaborClass
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": "4",
  "orgId": "abc123",
  "companyAssociations": ["abc123"],
  "defaultCompany": "abc123",
  "givenName": "abc123",
  "middleName": "abc123",
  "familyName": "abc123",
  "email": "abc123",
  "employeeNo": "xyz789",
  "role": "xyz789",
  "jobTitle": "xyz789",
  "officeNo": "xyz789",
  "mobileNo": "xyz789",
  "faxNo": "xyz789",
  "address": AddressAllOptional,
  "country": "xyz789",
  "useCompanyAddress": true,
  "emailSignature": "abc123",
  "crew": true,
  "primaryLaborClass": "abc123",
  "languagePreference": "abc123",
  "dateDisplayPreference": "abc123",
  "permissionGroup": "abc123",
  "permissionGroupName": "abc123",
  "accessLevel": "abc123",
  "crewStatus": "AVAILABLE",
  "type": "STANDARD",
  "loginStatus": "ACTIVE",
  "addToNewProjects": true,
  "contact": Contact,
  "laborClassId": "abc123",
  "laborClass": LaborClass,
  "_version": 987,
  "_deleted": false,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

UserSearchContextInput

Fields
Input Field Description
projects - SearchFilterByProjectInput
Example
{"projects": SearchFilterByProjectInput}

UserSearchFilterInput

Example
{
  "permissionGroup": SearchFilterByIdNameInput,
  "status": SearchFilterByLoginStatusInput,
  "crewStatus": SearchFilterByAvailabilityStatusInput,
  "type": SearchFilterByUserTypeInput,
  "companies": SearchFilterByCompanyInput
}

UserSearchHighlight

Fields
Field Name Description
name - String
email - String
permissionGroup - String
Example
{
  "name": "abc123",
  "email": "abc123",
  "permissionGroup": "abc123"
}

UserSearchResult

Fields
Field Name Description
document - UserSearchResultDocument!
highlight - UserSearchHighlight
Example
{
  "document": UserSearchResultDocument,
  "highlight": UserSearchHighlight
}

UserSearchResultDocument

Fields
Field Name Description
entity - User!
isProjectMember - Boolean
id - ID! Use entity property instead
name - String! Use entity property instead
email - String Use entity property instead
permissionGroup - String Use entity property instead
crewStatus - AvailabilityStatus Use entity property instead
crew - Boolean Use entity property instead
status - LoginStatus Use entity property instead
type - UserType Use entity property instead
employeeNo - String Use entity property instead
laborClass - LaborClass Use entity property instead
Example
{
  "entity": User,
  "isProjectMember": false,
  "id": 4,
  "name": "abc123",
  "email": "abc123",
  "permissionGroup": "xyz789",
  "crewStatus": "AVAILABLE",
  "crew": true,
  "status": "ACTIVE",
  "type": "STANDARD",
  "employeeNo": "xyz789",
  "laborClass": LaborClass
}

UserSearchResults

Fields
Field Name Description
items - [UserSearchResult!]!
pagination - SearchResultsPagination!
Example
{
  "items": [UserSearchResult],
  "pagination": SearchResultsPagination
}

UserSearchSortByColumn

Values
Enum Value Description

NAME

EMAIL

PERMISSION_GROUP

STATUS

CREW_STATUS

Example
"NAME"

UserSortByColumn

Values
Enum Value Description

EMAIL

FULLNAME

PERMISSION_GROUP

Example
"EMAIL"

UserType

Values
Enum Value Description

STANDARD

ONLY_CREW

Example
"STANDARD"

UserWithMembership

Fields
Field Name Description
user - User!
isProjectMember - Boolean
Example
{"user": User, "isProjectMember": false}

VersionSet

Fields
Field Name Description
id - String!
createdBy - User!
dateIssued - AWSDateTime!
project - Project!
name - String
Example
{
  "id": "abc123",
  "createdBy": User,
  "dateIssued": AWSDateTime,
  "project": Project,
  "name": "xyz789"
}

Weather

Fields
Field Name Description
projectId - String
icon - String
temperature - Temperature
windSpeed - Int
humidityPercent - Int
weather - String
source - WeatherSource
hour - Int
Example
{
  "projectId": "abc123",
  "icon": "xyz789",
  "temperature": Temperature,
  "windSpeed": 987,
  "humidityPercent": 987,
  "weather": "xyz789",
  "source": "WORLDWIDEWEATHER",
  "hour": 123
}

WeatherInput

Fields
Input Field Description
projectId - String
icon - String
temperature - TemperatureInput
windSpeed - Int
humidityPercent - Int
weather - String
source - WeatherSource
hour - Int
Example
{
  "projectId": "abc123",
  "icon": "xyz789",
  "temperature": TemperatureInput,
  "windSpeed": 987,
  "humidityPercent": 123,
  "weather": "abc123",
  "source": "WORLDWIDEWEATHER",
  "hour": 123
}

WeatherReport

Fields
Field Name Description
byTheHour - [Weather!]!
Example
{"byTheHour": [Weather]}

WeatherSource

Values
Enum Value Description

WORLDWIDEWEATHER

ESUB

Example
"WORLDWIDEWEATHER"

WeatherType

Fields
Field Name Description
id - ID!
name - String
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": 4,
  "name": "abc123",
  "_version": 123,
  "_deleted": true,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

WindType

Fields
Field Name Description
id - ID!
name - String
_version - Int!
_deleted - Boolean
_lastChangedAt - AWSTimestamp!
createdAt - AWSDateTime!
updatedAt - AWSDateTime!
Example
{
  "id": 4,
  "name": "abc123",
  "_version": 987,
  "_deleted": true,
  "_lastChangedAt": AWSTimestamp,
  "createdAt": AWSDateTime,
  "updatedAt": AWSDateTime
}

WorksheetTag

Fields
Field Name Description
key - String!
value - String!
Example
{
  "key": "abc123",
  "value": "xyz789"
}

WorksheetTagInput

Fields
Input Field Description
key - String!
value - String!
Example
{
  "key": "xyz789",
  "value": "xyz789"
}

Subscriptions

onCreateChangeOrderRequest

Response

Returns a ChangeOrderRequest

Example

Query
subscription onCreateChangeOrderRequest {
  onCreateChangeOrderRequest {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Response
{
  "data": {
    "onCreateChangeOrderRequest": {
      "approvalNumber": "xyz789",
      "approvedAmountInPennies": 123,
      "created": "xyz789",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 987,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "abc123",
      "images": [ResizedAttachment],
      "internalNotes": "abc123",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "xyz789",
      "name": "abc123",
      "number": "xyz789",
      "project": Project,
      "referenceNumberAsi": "xyz789",
      "referenceNumberGcCor": "abc123",
      "referenceNumberOther": "xyz789",
      "referenceNumberOwnerCor": "abc123",
      "referenceNumberPco": "xyz789",
      "referenceNumberRfi": "xyz789",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 987,
      "scheduleImpactComments": "abc123",
      "scheduleImpactDays": 987,
      "scopeOfWork": "xyz789",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

onCreateChangeOrderRequestEquipmentLineItem

Example

Query
subscription onCreateChangeOrderRequestEquipmentLineItem {
  onCreateChangeOrderRequestEquipmentLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customEquipment
  }
}
Response
{
  "data": {
    "onCreateChangeOrderRequestEquipmentLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "xyz789",
      "rateInPennies": 987,
      "sellPriceInPennies": 987,
      "quantity": 123.45,
      "customEquipment": "abc123"
    }
  }
}

onCreateChangeOrderRequestLaborLineItem

Response

Returns a ChangeOrderRequestLaborLineItem

Example

Query
subscription onCreateChangeOrderRequestLaborLineItem {
  onCreateChangeOrderRequestLaborLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customLaborClass
    hoursInMinutes
    laborClass {
      ...LaborClassFragment
    }
    rateInPennies
    sellRateInPennies
    workers
  }
}
Response
{
  "data": {
    "onCreateChangeOrderRequestLaborLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customLaborClass": "xyz789",
      "hoursInMinutes": 123,
      "laborClass": LaborClass,
      "rateInPennies": 987,
      "sellRateInPennies": 123,
      "workers": 123.45
    }
  }
}

onCreateChangeOrderRequestMaterialLineItem

Example

Query
subscription onCreateChangeOrderRequestMaterialLineItem {
  onCreateChangeOrderRequestMaterialLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customMaterial
  }
}
Response
{
  "data": {
    "onCreateChangeOrderRequestMaterialLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "abc123",
      "rateInPennies": 123,
      "sellPriceInPennies": 987,
      "quantity": 987.65,
      "customMaterial": "abc123"
    }
  }
}

onCreateChangeOrderRequestOtherLineItem

Response

Returns a ChangeOrderRequestOtherLineItem

Example

Query
subscription onCreateChangeOrderRequestOtherLineItem {
  onCreateChangeOrderRequestOtherLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onCreateChangeOrderRequestOtherLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "abc123",
      "description": "abc123",
      "priceInPennies": 123,
      "quantity": 987.65,
      "sellPriceInPennies": 987,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onCreateChangeOrderRequestOverheadLineItem

Example

Query
subscription onCreateChangeOrderRequestOverheadLineItem {
  onCreateChangeOrderRequestOverheadLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onCreateChangeOrderRequestOverheadLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 123.45,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "abc123",
      "description": "xyz789",
      "priceInPennies": 987,
      "quantity": 123.45,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onCreateChangeOrderRequestSubcontractorLineItem

Example

Query
subscription onCreateChangeOrderRequestSubcontractorLineItem {
  onCreateChangeOrderRequestSubcontractorLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onCreateChangeOrderRequestSubcontractorLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "abc123",
      "priceInPennies": 987,
      "quantity": 123.45,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onCreateContact

Response

Returns a Contact

Example

Query
subscription onCreateContact {
  onCreateContact {
    id
    firstName
    middleName
    lastName
    jobTitle
    email
    address {
      ...AddressAllOptionalFragment
    }
    country
    office
    mobile
    fax
    notes
    businessName
    businessType
    status
    apVendor
    vendorId
    website
    cannotDelete
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateContact": {
      "id": 4,
      "firstName": "abc123",
      "middleName": "xyz789",
      "lastName": "abc123",
      "jobTitle": "abc123",
      "email": "xyz789",
      "address": AddressAllOptional,
      "country": "abc123",
      "office": "xyz789",
      "mobile": "abc123",
      "fax": "abc123",
      "notes": "abc123",
      "businessName": "abc123",
      "businessType": "xyz789",
      "status": "AVAILABLE",
      "apVendor": true,
      "vendorId": "xyz789",
      "website": "abc123",
      "cannotDelete": false,
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateDailyReport

Response

Returns a DailyReport

Example

Query
subscription onCreateDailyReport {
  onCreateDailyReport {
    id
    projectId
    customNo
    date
    timeOnSite
    timeOffSite
    totalWorkers
    author
    authorId
    weatherConditions {
      ...WeatherFragment
    }
    weather
    wind
    temperature
    workPerformed
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    issues
    favors
    accidents
    subcontractorsWorked
    visitors
    comments
    notes
    internalComments
    weatherComments
    lastEditedBy
    attachments {
      ...AttachmentsFragment
    }
    docs {
      ...DocsFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateDailyReport": {
      "id": 4,
      "projectId": "xyz789",
      "customNo": "abc123",
      "date": AWSDateTime,
      "timeOnSite": AWSDateTime,
      "timeOffSite": AWSDateTime,
      "totalWorkers": 123,
      "author": "abc123",
      "authorId": "abc123",
      "weatherConditions": Weather,
      "weather": "abc123",
      "wind": "xyz789",
      "temperature": 987,
      "workPerformed": "abc123",
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "issues": "abc123",
      "favors": "xyz789",
      "accidents": "xyz789",
      "subcontractorsWorked": "abc123",
      "visitors": "abc123",
      "comments": "abc123",
      "notes": "abc123",
      "internalComments": "abc123",
      "weatherComments": "abc123",
      "lastEditedBy": "abc123",
      "attachments": Attachments,
      "docs": Docs,
      "emails": [Email],
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateEntityAssignment

Response

Returns an EntityAssignment

Example

Query
subscription onCreateEntityAssignment {
  onCreateEntityAssignment {
    id
    entityId
    userId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateEntityAssignment": {
      "id": 4,
      "entityId": "4",
      "userId": 4,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateFieldNote

Response

Returns a FieldNote

Example

Query
subscription onCreateFieldNote {
  onCreateFieldNote {
    id
    note
    createdOnDeviceAt
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    locationTags {
      ...NestedLocationTagFragment
    }
    address {
      ...AddressFragment
    }
    phase
    system
    attachments {
      ...AttachmentsFragment
    }
    createdByUsername
    createdByUserId
    projectId
    docs {
      ...DocsFragment
    }
    lastUpdatedByUsername
    lastUpdatedByUserId
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateFieldNote": {
      "id": 4,
      "note": "abc123",
      "createdOnDeviceAt": AWSDateTime,
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "locationTags": [NestedLocationTag],
      "address": Address,
      "phase": "abc123",
      "system": "xyz789",
      "attachments": Attachments,
      "createdByUsername": "abc123",
      "createdByUserId": "abc123",
      "projectId": "xyz789",
      "docs": Docs,
      "lastUpdatedByUsername": "xyz789",
      "lastUpdatedByUserId": "xyz789",
      "emails": [Email],
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateKeyword

Response

Returns a Keyword

Example

Query
subscription onCreateKeyword {
  onCreateKeyword {
    id
    name
    companyId
    status
    usageCount
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateKeyword": {
      "id": "4",
      "name": "abc123",
      "companyId": "xyz789",
      "status": "AVAILABLE",
      "usageCount": 123,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateLocationTag

Response

Returns a LocationTag

Example

Query
subscription onCreateLocationTag {
  onCreateLocationTag {
    id
    name
    projectId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateLocationTag": {
      "id": 4,
      "name": "xyz789",
      "projectId": "abc123",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateOccupancySubType

Response

Returns an OccupancySubType

Example

Query
subscription onCreateOccupancySubType {
  onCreateOccupancySubType {
    id
    name
    companyId
    occupancyTypeId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateOccupancySubType": {
      "id": "4",
      "name": "xyz789",
      "companyId": "xyz789",
      "occupancyTypeId": "abc123",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateOccupancyType

Response

Returns an OccupancyType

Example

Query
subscription onCreateOccupancyType {
  onCreateOccupancyType {
    id
    name
    companyId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateOccupancyType": {
      "id": "4",
      "name": "abc123",
      "companyId": "abc123",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateProject

Response

Returns a Project

Example

Query
subscription onCreateProject {
  onCreateProject {
    address {
      ...AddressAllOptionalFragment
    }
    changeOrderRequestSettings {
      ...ProjectChangeOrderRequestSettingsFragment
    }
    comments
    company {
      ...CompanyFragment
    }
    companyId
    companyName
    contractCostInPennies
    contractNumber
    contractSoldBy
    contractType
    dailyReportSettings {
      ...ProjectDailyReportSettingsFragment
    }
    divisionId
    endDate
    id
    isPrimeContractor
    mailboxEmail
    marketAreaId
    name
    number
    occupancySubTypeId
    occupancyTypeId
    officeFaxNumber
    officePhoneNumber
    projectRateTemplateId
    rfiSettings {
      ...ProjectRFISettingsFragment
    }
    submittalSettings {
      ...SubmittalSettingsFragment
    }
    startDate
    status
    teams {
      ...ProjectTeamsFragment
    }
    timeSettings {
      ...ProjectTimeSettingsFragment
    }
    purchaseOrderSettings {
      ...ProjectPurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateProject": {
      "address": AddressAllOptional,
      "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
      "comments": "abc123",
      "company": Company,
      "companyId": "xyz789",
      "companyName": "xyz789",
      "contractCostInPennies": 987,
      "contractNumber": "xyz789",
      "contractSoldBy": "xyz789",
      "contractType": "xyz789",
      "dailyReportSettings": ProjectDailyReportSettings,
      "divisionId": "xyz789",
      "endDate": AWSDateTime,
      "id": 4,
      "isPrimeContractor": false,
      "mailboxEmail": "xyz789",
      "marketAreaId": "xyz789",
      "name": "xyz789",
      "number": "abc123",
      "occupancySubTypeId": "xyz789",
      "occupancyTypeId": "abc123",
      "officeFaxNumber": "abc123",
      "officePhoneNumber": "abc123",
      "projectRateTemplateId": "abc123",
      "rfiSettings": ProjectRFISettings,
      "submittalSettings": SubmittalSettings,
      "startDate": AWSDateTime,
      "status": "xyz789",
      "teams": ProjectTeams,
      "timeSettings": ProjectTimeSettings,
      "purchaseOrderSettings": ProjectPurchaseOrderSettings,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateRfi

Response

Returns a Rfi

Example

Query
subscription onCreateRfi {
  onCreateRfi {
    gcFileNumber
    gcNumber
    attachments {
      ...AttachmentsFragment
    }
    author {
      ...AuthorFragment
    }
    respondByDate
    date
    id
    projectId
    dateV2
    authorV2 {
      ...UserFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    revision
    customNo
    to {
      ...NestedContactFragment
    }
    subject
    respondByDateV2
    questionForClarification
    recommendedSolution
    isScheduleImpacted
    isCostImpacted
    isUrgent
    reference {
      ...RfiReferenceFragment
    }
    projectCostCodeAffected {
      ...ProjectCostCodeFragment
    }
    projectCostCodeAffectedNumber
    dateAnswered
    status
    statusComment
    answerToClarification
    driveAttachments {
      ...RfiAttachmentFragment
    }
    images {
      ...RfiImageFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateRfi": {
      "gcFileNumber": "xyz789",
      "gcNumber": "abc123",
      "attachments": Attachments,
      "author": Author,
      "respondByDate": AWSDate,
      "date": AWSDate,
      "id": "4",
      "projectId": "abc123",
      "dateV2": AWSDateTime,
      "authorV2": User,
      "lastEditedBy": Author,
      "revision": 123,
      "customNo": "xyz789",
      "to": [NestedContact],
      "subject": "abc123",
      "respondByDateV2": AWSDateTime,
      "questionForClarification": "abc123",
      "recommendedSolution": "abc123",
      "isScheduleImpacted": false,
      "isCostImpacted": true,
      "isUrgent": true,
      "reference": RfiReference,
      "projectCostCodeAffected": ProjectCostCode,
      "projectCostCodeAffectedNumber": "abc123",
      "dateAnswered": AWSDateTime,
      "status": "PENDING",
      "statusComment": "xyz789",
      "answerToClarification": "xyz789",
      "driveAttachments": [RfiAttachment],
      "images": [RfiImage],
      "emails": [Email],
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateSubmittalItem

Response

Returns a SubmittalItem

Example

Query
subscription onCreateSubmittalItem {
  onCreateSubmittalItem {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Response
{
  "data": {
    "onCreateSubmittalItem": {
      "created": "xyz789",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "abc123",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "xyz789",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "xyz789",
      "name": "abc123",
      "notes": "abc123",
      "number": "xyz789",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 987,
      "specSection": "xyz789",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

onCreateSubmittalPackage

Response

Returns a SubmittalPackage

Example

Query
subscription onCreateSubmittalPackage {
  onCreateSubmittalPackage {
    created
    dateSent
    description
    from {
      ...ContactFragment
    }
    id
    modified
    number
    name
    project {
      ...ProjectFragment
    }
    respondBy
    returnedOn
    status
    to {
      ...ContactFragment
    }
    submittalItems {
      ...SubmittalItemFragment
    }
    emails {
      ...EmailFragment
    }
  }
}
Response
{
  "data": {
    "onCreateSubmittalPackage": {
      "created": "xyz789",
      "dateSent": AWSDateTime,
      "description": "xyz789",
      "from": Contact,
      "id": "abc123",
      "modified": "abc123",
      "number": "abc123",
      "name": "xyz789",
      "project": Project,
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "status": "DRAFT",
      "to": Contact,
      "submittalItems": [SubmittalItem],
      "emails": [Email]
    }
  }
}

onCreateTimeCard

Response

Returns a TimeCard

Example

Query
subscription onCreateTimeCard {
  onCreateTimeCard {
    comments
    date
    doubleTimeInMinutes
    hoursLost
    id
    laborClass
    overTimeInMinutes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    project {
      ...ProjectFragment
    }
    regularTimeInMinutes
    shift
    status
    timeCardProjectCostCodeNumber
    timeCardDailyReportId
    units
    user {
      ...UserFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateTimeCard": {
      "comments": "abc123",
      "date": AWSDateTime,
      "doubleTimeInMinutes": 123,
      "hoursLost": 987,
      "id": 4,
      "laborClass": "abc123",
      "overTimeInMinutes": 123,
      "projectCostCode": ProjectCostCode,
      "project": Project,
      "regularTimeInMinutes": 123,
      "shift": "SHIFT1",
      "status": "PENDING",
      "timeCardProjectCostCodeNumber": "abc123",
      "timeCardDailyReportId": "xyz789",
      "units": 123,
      "user": User,
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateUser

Response

Returns a User

Example

Query
subscription onCreateUser {
  onCreateUser {
    id
    orgId
    companyAssociations
    defaultCompany
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AddressAllOptionalFragment
    }
    country
    useCompanyAddress
    emailSignature
    crew
    primaryLaborClass
    languagePreference
    dateDisplayPreference
    permissionGroup
    permissionGroupName
    accessLevel
    crewStatus
    type
    loginStatus
    addToNewProjects
    contact {
      ...ContactFragment
    }
    laborClassId
    laborClass {
      ...LaborClassFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateUser": {
      "id": 4,
      "orgId": "xyz789",
      "companyAssociations": ["xyz789"],
      "defaultCompany": "abc123",
      "givenName": "abc123",
      "middleName": "abc123",
      "familyName": "xyz789",
      "email": "xyz789",
      "employeeNo": "xyz789",
      "role": "xyz789",
      "jobTitle": "abc123",
      "officeNo": "abc123",
      "mobileNo": "abc123",
      "faxNo": "xyz789",
      "address": AddressAllOptional,
      "country": "abc123",
      "useCompanyAddress": false,
      "emailSignature": "xyz789",
      "crew": false,
      "primaryLaborClass": "abc123",
      "languagePreference": "abc123",
      "dateDisplayPreference": "abc123",
      "permissionGroup": "abc123",
      "permissionGroupName": "xyz789",
      "accessLevel": "xyz789",
      "crewStatus": "AVAILABLE",
      "type": "STANDARD",
      "loginStatus": "ACTIVE",
      "addToNewProjects": false,
      "contact": Contact,
      "laborClassId": "xyz789",
      "laborClass": LaborClass,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateWeatherType

Response

Returns a WeatherType

Example

Query
subscription onCreateWeatherType {
  onCreateWeatherType {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateWeatherType": {
      "id": 4,
      "name": "xyz789",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onCreateWindType

Response

Returns a WindType

Example

Query
subscription onCreateWindType {
  onCreateWindType {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onCreateWindType": {
      "id": 4,
      "name": "xyz789",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteChangeOrderRequest

Response

Returns a ChangeOrderRequest

Example

Query
subscription onDeleteChangeOrderRequest {
  onDeleteChangeOrderRequest {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Response
{
  "data": {
    "onDeleteChangeOrderRequest": {
      "approvalNumber": "abc123",
      "approvedAmountInPennies": 987,
      "created": "abc123",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 987,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "xyz789",
      "images": [ResizedAttachment],
      "internalNotes": "abc123",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "abc123",
      "name": "abc123",
      "number": "xyz789",
      "project": Project,
      "referenceNumberAsi": "abc123",
      "referenceNumberGcCor": "xyz789",
      "referenceNumberOther": "abc123",
      "referenceNumberOwnerCor": "xyz789",
      "referenceNumberPco": "xyz789",
      "referenceNumberRfi": "xyz789",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 123,
      "scheduleImpactComments": "abc123",
      "scheduleImpactDays": 123,
      "scopeOfWork": "xyz789",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

onDeleteChangeOrderRequestEquipmentLineItem

Example

Query
subscription onDeleteChangeOrderRequestEquipmentLineItem {
  onDeleteChangeOrderRequestEquipmentLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customEquipment
  }
}
Response
{
  "data": {
    "onDeleteChangeOrderRequestEquipmentLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "xyz789",
      "rateInPennies": 987,
      "sellPriceInPennies": 987,
      "quantity": 987.65,
      "customEquipment": "xyz789"
    }
  }
}

onDeleteChangeOrderRequestLaborLineItem

Response

Returns a ChangeOrderRequestLaborLineItem

Example

Query
subscription onDeleteChangeOrderRequestLaborLineItem {
  onDeleteChangeOrderRequestLaborLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customLaborClass
    hoursInMinutes
    laborClass {
      ...LaborClassFragment
    }
    rateInPennies
    sellRateInPennies
    workers
  }
}
Response
{
  "data": {
    "onDeleteChangeOrderRequestLaborLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customLaborClass": "xyz789",
      "hoursInMinutes": 987,
      "laborClass": LaborClass,
      "rateInPennies": 987,
      "sellRateInPennies": 987,
      "workers": 987.65
    }
  }
}

onDeleteChangeOrderRequestMaterialLineItem

Example

Query
subscription onDeleteChangeOrderRequestMaterialLineItem {
  onDeleteChangeOrderRequestMaterialLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customMaterial
  }
}
Response
{
  "data": {
    "onDeleteChangeOrderRequestMaterialLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "xyz789",
      "rateInPennies": 123,
      "sellPriceInPennies": 123,
      "quantity": 987.65,
      "customMaterial": "abc123"
    }
  }
}

onDeleteChangeOrderRequestOtherLineItem

Response

Returns a ChangeOrderRequestOtherLineItem

Example

Query
subscription onDeleteChangeOrderRequestOtherLineItem {
  onDeleteChangeOrderRequestOtherLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onDeleteChangeOrderRequestOtherLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "abc123",
      "priceInPennies": 987,
      "quantity": 123.45,
      "sellPriceInPennies": 987,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onDeleteChangeOrderRequestOverheadLineItem

Example

Query
subscription onDeleteChangeOrderRequestOverheadLineItem {
  onDeleteChangeOrderRequestOverheadLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onDeleteChangeOrderRequestOverheadLineItem": {
      "costInPennies": 987,
      "id": "abc123",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "abc123",
      "priceInPennies": 123,
      "quantity": 123.45,
      "sellPriceInPennies": 987,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onDeleteChangeOrderRequestSubcontractorLineItem

Example

Query
subscription onDeleteChangeOrderRequestSubcontractorLineItem {
  onDeleteChangeOrderRequestSubcontractorLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onDeleteChangeOrderRequestSubcontractorLineItem": {
      "costInPennies": 123,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "xyz789",
      "priceInPennies": 987,
      "quantity": 987.65,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onDeleteContact

Response

Returns a Contact

Example

Query
subscription onDeleteContact {
  onDeleteContact {
    id
    firstName
    middleName
    lastName
    jobTitle
    email
    address {
      ...AddressAllOptionalFragment
    }
    country
    office
    mobile
    fax
    notes
    businessName
    businessType
    status
    apVendor
    vendorId
    website
    cannotDelete
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteContact": {
      "id": 4,
      "firstName": "xyz789",
      "middleName": "xyz789",
      "lastName": "abc123",
      "jobTitle": "xyz789",
      "email": "abc123",
      "address": AddressAllOptional,
      "country": "abc123",
      "office": "xyz789",
      "mobile": "abc123",
      "fax": "xyz789",
      "notes": "abc123",
      "businessName": "abc123",
      "businessType": "xyz789",
      "status": "AVAILABLE",
      "apVendor": false,
      "vendorId": "xyz789",
      "website": "xyz789",
      "cannotDelete": false,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteDailyReport

Response

Returns a DailyReport

Example

Query
subscription onDeleteDailyReport {
  onDeleteDailyReport {
    id
    projectId
    customNo
    date
    timeOnSite
    timeOffSite
    totalWorkers
    author
    authorId
    weatherConditions {
      ...WeatherFragment
    }
    weather
    wind
    temperature
    workPerformed
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    issues
    favors
    accidents
    subcontractorsWorked
    visitors
    comments
    notes
    internalComments
    weatherComments
    lastEditedBy
    attachments {
      ...AttachmentsFragment
    }
    docs {
      ...DocsFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteDailyReport": {
      "id": 4,
      "projectId": "xyz789",
      "customNo": "xyz789",
      "date": AWSDateTime,
      "timeOnSite": AWSDateTime,
      "timeOffSite": AWSDateTime,
      "totalWorkers": 987,
      "author": "abc123",
      "authorId": "abc123",
      "weatherConditions": Weather,
      "weather": "abc123",
      "wind": "xyz789",
      "temperature": 123,
      "workPerformed": "xyz789",
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "issues": "abc123",
      "favors": "abc123",
      "accidents": "xyz789",
      "subcontractorsWorked": "abc123",
      "visitors": "xyz789",
      "comments": "xyz789",
      "notes": "xyz789",
      "internalComments": "abc123",
      "weatherComments": "abc123",
      "lastEditedBy": "xyz789",
      "attachments": Attachments,
      "docs": Docs,
      "emails": [Email],
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteEntityAssignment

Response

Returns an EntityAssignment

Example

Query
subscription onDeleteEntityAssignment {
  onDeleteEntityAssignment {
    id
    entityId
    userId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteEntityAssignment": {
      "id": "4",
      "entityId": "4",
      "userId": "4",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteFieldNote

Response

Returns a FieldNote

Example

Query
subscription onDeleteFieldNote {
  onDeleteFieldNote {
    id
    note
    createdOnDeviceAt
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    locationTags {
      ...NestedLocationTagFragment
    }
    address {
      ...AddressFragment
    }
    phase
    system
    attachments {
      ...AttachmentsFragment
    }
    createdByUsername
    createdByUserId
    projectId
    docs {
      ...DocsFragment
    }
    lastUpdatedByUsername
    lastUpdatedByUserId
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteFieldNote": {
      "id": 4,
      "note": "abc123",
      "createdOnDeviceAt": AWSDateTime,
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "locationTags": [NestedLocationTag],
      "address": Address,
      "phase": "abc123",
      "system": "xyz789",
      "attachments": Attachments,
      "createdByUsername": "xyz789",
      "createdByUserId": "xyz789",
      "projectId": "abc123",
      "docs": Docs,
      "lastUpdatedByUsername": "abc123",
      "lastUpdatedByUserId": "abc123",
      "emails": [Email],
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteKeyword

Response

Returns a Keyword

Example

Query
subscription onDeleteKeyword {
  onDeleteKeyword {
    id
    name
    companyId
    status
    usageCount
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteKeyword": {
      "id": "4",
      "name": "xyz789",
      "companyId": "xyz789",
      "status": "AVAILABLE",
      "usageCount": 987,
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteLocationTag

Response

Returns a LocationTag

Example

Query
subscription onDeleteLocationTag {
  onDeleteLocationTag {
    id
    name
    projectId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteLocationTag": {
      "id": 4,
      "name": "xyz789",
      "projectId": "abc123",
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteOccupancySubType

Response

Returns an OccupancySubType

Example

Query
subscription onDeleteOccupancySubType {
  onDeleteOccupancySubType {
    id
    name
    companyId
    occupancyTypeId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteOccupancySubType": {
      "id": "4",
      "name": "xyz789",
      "companyId": "abc123",
      "occupancyTypeId": "abc123",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteOccupancyType

Response

Returns an OccupancyType

Example

Query
subscription onDeleteOccupancyType {
  onDeleteOccupancyType {
    id
    name
    companyId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteOccupancyType": {
      "id": "4",
      "name": "xyz789",
      "companyId": "abc123",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteProject

Response

Returns a Project

Example

Query
subscription onDeleteProject {
  onDeleteProject {
    address {
      ...AddressAllOptionalFragment
    }
    changeOrderRequestSettings {
      ...ProjectChangeOrderRequestSettingsFragment
    }
    comments
    company {
      ...CompanyFragment
    }
    companyId
    companyName
    contractCostInPennies
    contractNumber
    contractSoldBy
    contractType
    dailyReportSettings {
      ...ProjectDailyReportSettingsFragment
    }
    divisionId
    endDate
    id
    isPrimeContractor
    mailboxEmail
    marketAreaId
    name
    number
    occupancySubTypeId
    occupancyTypeId
    officeFaxNumber
    officePhoneNumber
    projectRateTemplateId
    rfiSettings {
      ...ProjectRFISettingsFragment
    }
    submittalSettings {
      ...SubmittalSettingsFragment
    }
    startDate
    status
    teams {
      ...ProjectTeamsFragment
    }
    timeSettings {
      ...ProjectTimeSettingsFragment
    }
    purchaseOrderSettings {
      ...ProjectPurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteProject": {
      "address": AddressAllOptional,
      "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
      "comments": "xyz789",
      "company": Company,
      "companyId": "xyz789",
      "companyName": "abc123",
      "contractCostInPennies": 123,
      "contractNumber": "abc123",
      "contractSoldBy": "abc123",
      "contractType": "xyz789",
      "dailyReportSettings": ProjectDailyReportSettings,
      "divisionId": "xyz789",
      "endDate": AWSDateTime,
      "id": 4,
      "isPrimeContractor": true,
      "mailboxEmail": "xyz789",
      "marketAreaId": "abc123",
      "name": "xyz789",
      "number": "abc123",
      "occupancySubTypeId": "abc123",
      "occupancyTypeId": "abc123",
      "officeFaxNumber": "xyz789",
      "officePhoneNumber": "xyz789",
      "projectRateTemplateId": "abc123",
      "rfiSettings": ProjectRFISettings,
      "submittalSettings": SubmittalSettings,
      "startDate": AWSDateTime,
      "status": "abc123",
      "teams": ProjectTeams,
      "timeSettings": ProjectTimeSettings,
      "purchaseOrderSettings": ProjectPurchaseOrderSettings,
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteRfi

Response

Returns a Rfi

Example

Query
subscription onDeleteRfi {
  onDeleteRfi {
    gcFileNumber
    gcNumber
    attachments {
      ...AttachmentsFragment
    }
    author {
      ...AuthorFragment
    }
    respondByDate
    date
    id
    projectId
    dateV2
    authorV2 {
      ...UserFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    revision
    customNo
    to {
      ...NestedContactFragment
    }
    subject
    respondByDateV2
    questionForClarification
    recommendedSolution
    isScheduleImpacted
    isCostImpacted
    isUrgent
    reference {
      ...RfiReferenceFragment
    }
    projectCostCodeAffected {
      ...ProjectCostCodeFragment
    }
    projectCostCodeAffectedNumber
    dateAnswered
    status
    statusComment
    answerToClarification
    driveAttachments {
      ...RfiAttachmentFragment
    }
    images {
      ...RfiImageFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteRfi": {
      "gcFileNumber": "abc123",
      "gcNumber": "xyz789",
      "attachments": Attachments,
      "author": Author,
      "respondByDate": AWSDate,
      "date": AWSDate,
      "id": 4,
      "projectId": "abc123",
      "dateV2": AWSDateTime,
      "authorV2": User,
      "lastEditedBy": Author,
      "revision": 987,
      "customNo": "xyz789",
      "to": [NestedContact],
      "subject": "xyz789",
      "respondByDateV2": AWSDateTime,
      "questionForClarification": "abc123",
      "recommendedSolution": "xyz789",
      "isScheduleImpacted": true,
      "isCostImpacted": false,
      "isUrgent": true,
      "reference": RfiReference,
      "projectCostCodeAffected": ProjectCostCode,
      "projectCostCodeAffectedNumber": "abc123",
      "dateAnswered": AWSDateTime,
      "status": "PENDING",
      "statusComment": "abc123",
      "answerToClarification": "abc123",
      "driveAttachments": [RfiAttachment],
      "images": [RfiImage],
      "emails": [Email],
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteSubmittalItem

Response

Returns a SubmittalItem

Example

Query
subscription onDeleteSubmittalItem {
  onDeleteSubmittalItem {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Response
{
  "data": {
    "onDeleteSubmittalItem": {
      "created": "abc123",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "xyz789",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "xyz789",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "xyz789",
      "name": "xyz789",
      "notes": "xyz789",
      "number": "abc123",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 987,
      "specSection": "xyz789",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

onDeleteSubmittalPackage

Response

Returns a SubmittalPackage

Example

Query
subscription onDeleteSubmittalPackage {
  onDeleteSubmittalPackage {
    created
    dateSent
    description
    from {
      ...ContactFragment
    }
    id
    modified
    number
    name
    project {
      ...ProjectFragment
    }
    respondBy
    returnedOn
    status
    to {
      ...ContactFragment
    }
    submittalItems {
      ...SubmittalItemFragment
    }
    emails {
      ...EmailFragment
    }
  }
}
Response
{
  "data": {
    "onDeleteSubmittalPackage": {
      "created": "xyz789",
      "dateSent": AWSDateTime,
      "description": "abc123",
      "from": Contact,
      "id": "xyz789",
      "modified": "abc123",
      "number": "abc123",
      "name": "xyz789",
      "project": Project,
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "status": "DRAFT",
      "to": Contact,
      "submittalItems": [SubmittalItem],
      "emails": [Email]
    }
  }
}

onDeleteTimeCard

Response

Returns a TimeCard

Example

Query
subscription onDeleteTimeCard {
  onDeleteTimeCard {
    comments
    date
    doubleTimeInMinutes
    hoursLost
    id
    laborClass
    overTimeInMinutes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    project {
      ...ProjectFragment
    }
    regularTimeInMinutes
    shift
    status
    timeCardProjectCostCodeNumber
    timeCardDailyReportId
    units
    user {
      ...UserFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteTimeCard": {
      "comments": "xyz789",
      "date": AWSDateTime,
      "doubleTimeInMinutes": 987,
      "hoursLost": 987,
      "id": "4",
      "laborClass": "xyz789",
      "overTimeInMinutes": 987,
      "projectCostCode": ProjectCostCode,
      "project": Project,
      "regularTimeInMinutes": 987,
      "shift": "SHIFT1",
      "status": "PENDING",
      "timeCardProjectCostCodeNumber": "abc123",
      "timeCardDailyReportId": "xyz789",
      "units": 987,
      "user": User,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteUser

Response

Returns a User

Example

Query
subscription onDeleteUser {
  onDeleteUser {
    id
    orgId
    companyAssociations
    defaultCompany
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AddressAllOptionalFragment
    }
    country
    useCompanyAddress
    emailSignature
    crew
    primaryLaborClass
    languagePreference
    dateDisplayPreference
    permissionGroup
    permissionGroupName
    accessLevel
    crewStatus
    type
    loginStatus
    addToNewProjects
    contact {
      ...ContactFragment
    }
    laborClassId
    laborClass {
      ...LaborClassFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteUser": {
      "id": "4",
      "orgId": "abc123",
      "companyAssociations": ["xyz789"],
      "defaultCompany": "abc123",
      "givenName": "abc123",
      "middleName": "xyz789",
      "familyName": "xyz789",
      "email": "abc123",
      "employeeNo": "xyz789",
      "role": "xyz789",
      "jobTitle": "xyz789",
      "officeNo": "abc123",
      "mobileNo": "xyz789",
      "faxNo": "abc123",
      "address": AddressAllOptional,
      "country": "abc123",
      "useCompanyAddress": false,
      "emailSignature": "abc123",
      "crew": false,
      "primaryLaborClass": "xyz789",
      "languagePreference": "xyz789",
      "dateDisplayPreference": "xyz789",
      "permissionGroup": "xyz789",
      "permissionGroupName": "xyz789",
      "accessLevel": "abc123",
      "crewStatus": "AVAILABLE",
      "type": "STANDARD",
      "loginStatus": "ACTIVE",
      "addToNewProjects": true,
      "contact": Contact,
      "laborClassId": "xyz789",
      "laborClass": LaborClass,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteWeatherType

Response

Returns a WeatherType

Example

Query
subscription onDeleteWeatherType {
  onDeleteWeatherType {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteWeatherType": {
      "id": "4",
      "name": "xyz789",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onDeleteWindType

Response

Returns a WindType

Example

Query
subscription onDeleteWindType {
  onDeleteWindType {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onDeleteWindType": {
      "id": "4",
      "name": "xyz789",
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateChangeOrderRequest

Response

Returns a ChangeOrderRequest

Example

Query
subscription onUpdateChangeOrderRequest {
  onUpdateChangeOrderRequest {
    approvalNumber
    approvedAmountInPennies
    created
    date
    dateApproved
    dateSent
    daysValid
    docs {
      ...AttachmentV2Fragment
    }
    emails {
      ...EmailFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    internalNotes
    itemSummary {
      ...ChangeOrderRequestItemSummaryFragment
    }
    modified
    name
    number
    project {
      ...ProjectFragment
    }
    referenceNumberAsi
    referenceNumberGcCor
    referenceNumberOther
    referenceNumberOwnerCor
    referenceNumberPco
    referenceNumberRfi
    respondBy
    returnedOn
    returnToContact {
      ...ContactFragment
    }
    revision
    scheduleImpactComments
    scheduleImpactDays
    scopeOfWork
    sendByDate
    smallTools {
      ...ChangeOrderRequestSmallToolsFragment
    }
    status
    toContact {
      ...ContactFragment
    }
    worksheet {
      ...ChangeOrderRequestWorksheetFragment
    }
    workType
    laborLineItems {
      ...ChangeOrderRequestLaborLineItemsFragment
    }
    materialLineItems {
      ...ChangeOrderRequestMaterialLineItemsFragment
    }
    equipmentLineItems {
      ...ChangeOrderRequestEquipmentLineItemsFragment
    }
    subcontractorLineItems {
      ...ChangeOrderRequestSubcontractorLineItemsFragment
    }
    overheadLineItems {
      ...ChangeOrderRequestOverheadLineItemsFragment
    }
    otherLineItems {
      ...ChangeOrderRequestOtherLineItemsFragment
    }
  }
}
Response
{
  "data": {
    "onUpdateChangeOrderRequest": {
      "approvalNumber": "abc123",
      "approvedAmountInPennies": 987,
      "created": "xyz789",
      "date": AWSDateTime,
      "dateApproved": AWSDateTime,
      "dateSent": AWSDateTime,
      "daysValid": 123,
      "docs": [AttachmentV2],
      "emails": [Email],
      "id": "abc123",
      "images": [ResizedAttachment],
      "internalNotes": "xyz789",
      "itemSummary": ChangeOrderRequestItemSummary,
      "modified": "abc123",
      "name": "xyz789",
      "number": "abc123",
      "project": Project,
      "referenceNumberAsi": "abc123",
      "referenceNumberGcCor": "abc123",
      "referenceNumberOther": "xyz789",
      "referenceNumberOwnerCor": "abc123",
      "referenceNumberPco": "abc123",
      "referenceNumberRfi": "xyz789",
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "returnToContact": Contact,
      "revision": 987,
      "scheduleImpactComments": "abc123",
      "scheduleImpactDays": 987,
      "scopeOfWork": "abc123",
      "sendByDate": AWSDateTime,
      "smallTools": ChangeOrderRequestSmallTools,
      "status": "DRAFT",
      "toContact": Contact,
      "worksheet": ChangeOrderRequestWorksheet,
      "workType": "ALLOWANCE",
      "laborLineItems": ChangeOrderRequestLaborLineItems,
      "materialLineItems": ChangeOrderRequestMaterialLineItems,
      "equipmentLineItems": ChangeOrderRequestEquipmentLineItems,
      "subcontractorLineItems": ChangeOrderRequestSubcontractorLineItems,
      "overheadLineItems": ChangeOrderRequestOverheadLineItems,
      "otherLineItems": ChangeOrderRequestOtherLineItems
    }
  }
}

onUpdateChangeOrderRequestEquipmentLineItem

Example

Query
subscription onUpdateChangeOrderRequestEquipmentLineItem {
  onUpdateChangeOrderRequestEquipmentLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customEquipment
  }
}
Response
{
  "data": {
    "onUpdateChangeOrderRequestEquipmentLineItem": {
      "costInPennies": 987,
      "id": "xyz789",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "abc123",
      "rateInPennies": 987,
      "sellPriceInPennies": 987,
      "quantity": 987.65,
      "customEquipment": "xyz789"
    }
  }
}

onUpdateChangeOrderRequestLaborLineItem

Response

Returns a ChangeOrderRequestLaborLineItem

Example

Query
subscription onUpdateChangeOrderRequestLaborLineItem {
  onUpdateChangeOrderRequestLaborLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customLaborClass
    hoursInMinutes
    laborClass {
      ...LaborClassFragment
    }
    rateInPennies
    sellRateInPennies
    workers
  }
}
Response
{
  "data": {
    "onUpdateChangeOrderRequestLaborLineItem": {
      "costInPennies": 987,
      "id": "abc123",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customLaborClass": "abc123",
      "hoursInMinutes": 987,
      "laborClass": LaborClass,
      "rateInPennies": 987,
      "sellRateInPennies": 987,
      "workers": 123.45
    }
  }
}

onUpdateChangeOrderRequestMaterialLineItem

Example

Query
subscription onUpdateChangeOrderRequestMaterialLineItem {
  onUpdateChangeOrderRequestMaterialLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
    customUnitOfMeasure
    rateInPennies
    sellPriceInPennies
    quantity
    customMaterial
  }
}
Response
{
  "data": {
    "onUpdateChangeOrderRequestMaterialLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "unitOfMeasure": UnitOfMeasure,
      "customUnitOfMeasure": "xyz789",
      "rateInPennies": 123,
      "sellPriceInPennies": 123,
      "quantity": 123.45,
      "customMaterial": "xyz789"
    }
  }
}

onUpdateChangeOrderRequestOtherLineItem

Response

Returns a ChangeOrderRequestOtherLineItem

Example

Query
subscription onUpdateChangeOrderRequestOtherLineItem {
  onUpdateChangeOrderRequestOtherLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onUpdateChangeOrderRequestOtherLineItem": {
      "costInPennies": 987,
      "id": "abc123",
      "markup": 987.65,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 987,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "xyz789",
      "description": "xyz789",
      "priceInPennies": 987,
      "quantity": 987.65,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onUpdateChangeOrderRequestOverheadLineItem

Example

Query
subscription onUpdateChangeOrderRequestOverheadLineItem {
  onUpdateChangeOrderRequestOverheadLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onUpdateChangeOrderRequestOverheadLineItem": {
      "costInPennies": 987,
      "id": "xyz789",
      "markup": 123.45,
      "notes": "xyz789",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "abc123",
      "description": "abc123",
      "priceInPennies": 987,
      "quantity": 987.65,
      "sellPriceInPennies": 123,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onUpdateChangeOrderRequestSubcontractorLineItem

Example

Query
subscription onUpdateChangeOrderRequestSubcontractorLineItem {
  onUpdateChangeOrderRequestSubcontractorLineItem {
    costInPennies
    id
    markup
    notes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    totalInPennies
    tags {
      ...WorksheetTagFragment
    }
    customUnitOfMeasure
    description
    priceInPennies
    quantity
    sellPriceInPennies
    unitOfMeasure {
      ...UnitOfMeasureFragment
    }
  }
}
Response
{
  "data": {
    "onUpdateChangeOrderRequestSubcontractorLineItem": {
      "costInPennies": 123,
      "id": "abc123",
      "markup": 987.65,
      "notes": "abc123",
      "projectCostCode": ProjectCostCode,
      "totalInPennies": 123,
      "tags": [WorksheetTag],
      "customUnitOfMeasure": "abc123",
      "description": "abc123",
      "priceInPennies": 987,
      "quantity": 123.45,
      "sellPriceInPennies": 987,
      "unitOfMeasure": UnitOfMeasure
    }
  }
}

onUpdateContact

Response

Returns a Contact

Example

Query
subscription onUpdateContact {
  onUpdateContact {
    id
    firstName
    middleName
    lastName
    jobTitle
    email
    address {
      ...AddressAllOptionalFragment
    }
    country
    office
    mobile
    fax
    notes
    businessName
    businessType
    status
    apVendor
    vendorId
    website
    cannotDelete
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateContact": {
      "id": 4,
      "firstName": "abc123",
      "middleName": "abc123",
      "lastName": "abc123",
      "jobTitle": "abc123",
      "email": "abc123",
      "address": AddressAllOptional,
      "country": "abc123",
      "office": "abc123",
      "mobile": "xyz789",
      "fax": "abc123",
      "notes": "abc123",
      "businessName": "abc123",
      "businessType": "xyz789",
      "status": "AVAILABLE",
      "apVendor": false,
      "vendorId": "abc123",
      "website": "xyz789",
      "cannotDelete": false,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateDailyReport

Response

Returns a DailyReport

Example

Query
subscription onUpdateDailyReport {
  onUpdateDailyReport {
    id
    projectId
    customNo
    date
    timeOnSite
    timeOffSite
    totalWorkers
    author
    authorId
    weatherConditions {
      ...WeatherFragment
    }
    weather
    wind
    temperature
    workPerformed
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    issues
    favors
    accidents
    subcontractorsWorked
    visitors
    comments
    notes
    internalComments
    weatherComments
    lastEditedBy
    attachments {
      ...AttachmentsFragment
    }
    docs {
      ...DocsFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateDailyReport": {
      "id": 4,
      "projectId": "xyz789",
      "customNo": "abc123",
      "date": AWSDateTime,
      "timeOnSite": AWSDateTime,
      "timeOffSite": AWSDateTime,
      "totalWorkers": 123,
      "author": "xyz789",
      "authorId": "abc123",
      "weatherConditions": Weather,
      "weather": "abc123",
      "wind": "abc123",
      "temperature": 987,
      "workPerformed": "xyz789",
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "issues": "abc123",
      "favors": "xyz789",
      "accidents": "abc123",
      "subcontractorsWorked": "abc123",
      "visitors": "xyz789",
      "comments": "abc123",
      "notes": "abc123",
      "internalComments": "xyz789",
      "weatherComments": "xyz789",
      "lastEditedBy": "xyz789",
      "attachments": Attachments,
      "docs": Docs,
      "emails": [Email],
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateEntityAssignment

Response

Returns an EntityAssignment

Example

Query
subscription onUpdateEntityAssignment {
  onUpdateEntityAssignment {
    id
    entityId
    userId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateEntityAssignment": {
      "id": 4,
      "entityId": 4,
      "userId": 4,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateFieldNote

Response

Returns a FieldNote

Example

Query
subscription onUpdateFieldNote {
  onUpdateFieldNote {
    id
    note
    createdOnDeviceAt
    keywords
    listOfKeywords {
      ...NestedKeywordsFragment
    }
    locationTags {
      ...NestedLocationTagFragment
    }
    address {
      ...AddressFragment
    }
    phase
    system
    attachments {
      ...AttachmentsFragment
    }
    createdByUsername
    createdByUserId
    projectId
    docs {
      ...DocsFragment
    }
    lastUpdatedByUsername
    lastUpdatedByUserId
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateFieldNote": {
      "id": "4",
      "note": "abc123",
      "createdOnDeviceAt": AWSDateTime,
      "keywords": ["abc123"],
      "listOfKeywords": [NestedKeywords],
      "locationTags": [NestedLocationTag],
      "address": Address,
      "phase": "abc123",
      "system": "abc123",
      "attachments": Attachments,
      "createdByUsername": "xyz789",
      "createdByUserId": "xyz789",
      "projectId": "abc123",
      "docs": Docs,
      "lastUpdatedByUsername": "abc123",
      "lastUpdatedByUserId": "abc123",
      "emails": [Email],
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateKeyword

Response

Returns a Keyword

Example

Query
subscription onUpdateKeyword {
  onUpdateKeyword {
    id
    name
    companyId
    status
    usageCount
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateKeyword": {
      "id": "4",
      "name": "abc123",
      "companyId": "xyz789",
      "status": "AVAILABLE",
      "usageCount": 123,
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateLocationTag

Response

Returns a LocationTag

Example

Query
subscription onUpdateLocationTag {
  onUpdateLocationTag {
    id
    name
    projectId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateLocationTag": {
      "id": 4,
      "name": "xyz789",
      "projectId": "abc123",
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateOccupancySubType

Response

Returns an OccupancySubType

Example

Query
subscription onUpdateOccupancySubType {
  onUpdateOccupancySubType {
    id
    name
    companyId
    occupancyTypeId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateOccupancySubType": {
      "id": "4",
      "name": "xyz789",
      "companyId": "abc123",
      "occupancyTypeId": "abc123",
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateOccupancyType

Response

Returns an OccupancyType

Example

Query
subscription onUpdateOccupancyType {
  onUpdateOccupancyType {
    id
    name
    companyId
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateOccupancyType": {
      "id": 4,
      "name": "abc123",
      "companyId": "abc123",
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateProject

Response

Returns a Project

Example

Query
subscription onUpdateProject {
  onUpdateProject {
    address {
      ...AddressAllOptionalFragment
    }
    changeOrderRequestSettings {
      ...ProjectChangeOrderRequestSettingsFragment
    }
    comments
    company {
      ...CompanyFragment
    }
    companyId
    companyName
    contractCostInPennies
    contractNumber
    contractSoldBy
    contractType
    dailyReportSettings {
      ...ProjectDailyReportSettingsFragment
    }
    divisionId
    endDate
    id
    isPrimeContractor
    mailboxEmail
    marketAreaId
    name
    number
    occupancySubTypeId
    occupancyTypeId
    officeFaxNumber
    officePhoneNumber
    projectRateTemplateId
    rfiSettings {
      ...ProjectRFISettingsFragment
    }
    submittalSettings {
      ...SubmittalSettingsFragment
    }
    startDate
    status
    teams {
      ...ProjectTeamsFragment
    }
    timeSettings {
      ...ProjectTimeSettingsFragment
    }
    purchaseOrderSettings {
      ...ProjectPurchaseOrderSettingsFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateProject": {
      "address": AddressAllOptional,
      "changeOrderRequestSettings": ProjectChangeOrderRequestSettings,
      "comments": "xyz789",
      "company": Company,
      "companyId": "xyz789",
      "companyName": "xyz789",
      "contractCostInPennies": 123,
      "contractNumber": "xyz789",
      "contractSoldBy": "xyz789",
      "contractType": "xyz789",
      "dailyReportSettings": ProjectDailyReportSettings,
      "divisionId": "xyz789",
      "endDate": AWSDateTime,
      "id": "4",
      "isPrimeContractor": true,
      "mailboxEmail": "xyz789",
      "marketAreaId": "abc123",
      "name": "xyz789",
      "number": "xyz789",
      "occupancySubTypeId": "xyz789",
      "occupancyTypeId": "xyz789",
      "officeFaxNumber": "abc123",
      "officePhoneNumber": "xyz789",
      "projectRateTemplateId": "xyz789",
      "rfiSettings": ProjectRFISettings,
      "submittalSettings": SubmittalSettings,
      "startDate": AWSDateTime,
      "status": "xyz789",
      "teams": ProjectTeams,
      "timeSettings": ProjectTimeSettings,
      "purchaseOrderSettings": ProjectPurchaseOrderSettings,
      "_version": 987,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateRfi

Response

Returns a Rfi

Example

Query
subscription onUpdateRfi {
  onUpdateRfi {
    gcFileNumber
    gcNumber
    attachments {
      ...AttachmentsFragment
    }
    author {
      ...AuthorFragment
    }
    respondByDate
    date
    id
    projectId
    dateV2
    authorV2 {
      ...UserFragment
    }
    lastEditedBy {
      ...AuthorFragment
    }
    revision
    customNo
    to {
      ...NestedContactFragment
    }
    subject
    respondByDateV2
    questionForClarification
    recommendedSolution
    isScheduleImpacted
    isCostImpacted
    isUrgent
    reference {
      ...RfiReferenceFragment
    }
    projectCostCodeAffected {
      ...ProjectCostCodeFragment
    }
    projectCostCodeAffectedNumber
    dateAnswered
    status
    statusComment
    answerToClarification
    driveAttachments {
      ...RfiAttachmentFragment
    }
    images {
      ...RfiImageFragment
    }
    emails {
      ...EmailFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateRfi": {
      "gcFileNumber": "abc123",
      "gcNumber": "abc123",
      "attachments": Attachments,
      "author": Author,
      "respondByDate": AWSDate,
      "date": AWSDate,
      "id": "4",
      "projectId": "abc123",
      "dateV2": AWSDateTime,
      "authorV2": User,
      "lastEditedBy": Author,
      "revision": 987,
      "customNo": "xyz789",
      "to": [NestedContact],
      "subject": "xyz789",
      "respondByDateV2": AWSDateTime,
      "questionForClarification": "xyz789",
      "recommendedSolution": "abc123",
      "isScheduleImpacted": true,
      "isCostImpacted": true,
      "isUrgent": true,
      "reference": RfiReference,
      "projectCostCodeAffected": ProjectCostCode,
      "projectCostCodeAffectedNumber": "abc123",
      "dateAnswered": AWSDateTime,
      "status": "PENDING",
      "statusComment": "abc123",
      "answerToClarification": "xyz789",
      "driveAttachments": [RfiAttachment],
      "images": [RfiImage],
      "emails": [Email],
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateSubmittalItem

Response

Returns a SubmittalItem

Example

Query
subscription onUpdateSubmittalItem {
  onUpdateSubmittalItem {
    created
    dateReceived
    dateSent
    deliveryDate
    description
    docs {
      ...AttachmentV2Fragment
    }
    documentType
    emails {
      ...EmailFragment
    }
    from {
      ...ContactFragment
    }
    id
    images {
      ...ResizedAttachmentFragment
    }
    installationDate
    leadTime
    methodSent
    modified
    name
    notes
    number
    package {
      ...SubmittalPackageFragment
    }
    poIssueDate
    poReleaseDate
    priority
    project {
      ...ProjectFragment
    }
    reasonForSending
    respondedOn
    returnBy
    revision
    specSection
    status
    submitBy
    to {
      ...ContactFragment
    }
    type
    warrantyDate
  }
}
Response
{
  "data": {
    "onUpdateSubmittalItem": {
      "created": "xyz789",
      "dateReceived": AWSDateTime,
      "dateSent": AWSDateTime,
      "deliveryDate": AWSDateTime,
      "description": "xyz789",
      "docs": [AttachmentV2],
      "documentType": "SUBMITTAL",
      "emails": [Email],
      "from": Contact,
      "id": "xyz789",
      "images": [ResizedAttachment],
      "installationDate": AWSDateTime,
      "leadTime": AWSDateTime,
      "methodSent": "CERTIFIEDMAIL",
      "modified": "xyz789",
      "name": "xyz789",
      "notes": "abc123",
      "number": "abc123",
      "package": SubmittalPackage,
      "poIssueDate": AWSDateTime,
      "poReleaseDate": AWSDateTime,
      "priority": "LOW",
      "project": Project,
      "reasonForSending": "ASREQUESTED",
      "respondedOn": AWSDateTime,
      "returnBy": AWSDateTime,
      "revision": 123,
      "specSection": "xyz789",
      "status": "DRAFT",
      "submitBy": AWSDateTime,
      "to": Contact,
      "type": "PRODUCTDATA",
      "warrantyDate": AWSDateTime
    }
  }
}

onUpdateSubmittalPackage

Response

Returns a SubmittalPackage

Example

Query
subscription onUpdateSubmittalPackage {
  onUpdateSubmittalPackage {
    created
    dateSent
    description
    from {
      ...ContactFragment
    }
    id
    modified
    number
    name
    project {
      ...ProjectFragment
    }
    respondBy
    returnedOn
    status
    to {
      ...ContactFragment
    }
    submittalItems {
      ...SubmittalItemFragment
    }
    emails {
      ...EmailFragment
    }
  }
}
Response
{
  "data": {
    "onUpdateSubmittalPackage": {
      "created": "abc123",
      "dateSent": AWSDateTime,
      "description": "abc123",
      "from": Contact,
      "id": "xyz789",
      "modified": "xyz789",
      "number": "abc123",
      "name": "xyz789",
      "project": Project,
      "respondBy": AWSDateTime,
      "returnedOn": AWSDateTime,
      "status": "DRAFT",
      "to": Contact,
      "submittalItems": [SubmittalItem],
      "emails": [Email]
    }
  }
}

onUpdateTimeCard

Response

Returns a TimeCard

Example

Query
subscription onUpdateTimeCard {
  onUpdateTimeCard {
    comments
    date
    doubleTimeInMinutes
    hoursLost
    id
    laborClass
    overTimeInMinutes
    projectCostCode {
      ...ProjectCostCodeFragment
    }
    project {
      ...ProjectFragment
    }
    regularTimeInMinutes
    shift
    status
    timeCardProjectCostCodeNumber
    timeCardDailyReportId
    units
    user {
      ...UserFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateTimeCard": {
      "comments": "abc123",
      "date": AWSDateTime,
      "doubleTimeInMinutes": 987,
      "hoursLost": 987,
      "id": "4",
      "laborClass": "xyz789",
      "overTimeInMinutes": 123,
      "projectCostCode": ProjectCostCode,
      "project": Project,
      "regularTimeInMinutes": 123,
      "shift": "SHIFT1",
      "status": "PENDING",
      "timeCardProjectCostCodeNumber": "abc123",
      "timeCardDailyReportId": "xyz789",
      "units": 987,
      "user": User,
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateUser

Response

Returns a User

Example

Query
subscription onUpdateUser {
  onUpdateUser {
    id
    orgId
    companyAssociations
    defaultCompany
    givenName
    middleName
    familyName
    email
    employeeNo
    role
    jobTitle
    officeNo
    mobileNo
    faxNo
    address {
      ...AddressAllOptionalFragment
    }
    country
    useCompanyAddress
    emailSignature
    crew
    primaryLaborClass
    languagePreference
    dateDisplayPreference
    permissionGroup
    permissionGroupName
    accessLevel
    crewStatus
    type
    loginStatus
    addToNewProjects
    contact {
      ...ContactFragment
    }
    laborClassId
    laborClass {
      ...LaborClassFragment
    }
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateUser": {
      "id": 4,
      "orgId": "xyz789",
      "companyAssociations": ["xyz789"],
      "defaultCompany": "abc123",
      "givenName": "abc123",
      "middleName": "abc123",
      "familyName": "xyz789",
      "email": "xyz789",
      "employeeNo": "xyz789",
      "role": "xyz789",
      "jobTitle": "xyz789",
      "officeNo": "abc123",
      "mobileNo": "xyz789",
      "faxNo": "xyz789",
      "address": AddressAllOptional,
      "country": "xyz789",
      "useCompanyAddress": false,
      "emailSignature": "xyz789",
      "crew": true,
      "primaryLaborClass": "xyz789",
      "languagePreference": "abc123",
      "dateDisplayPreference": "abc123",
      "permissionGroup": "xyz789",
      "permissionGroupName": "xyz789",
      "accessLevel": "xyz789",
      "crewStatus": "AVAILABLE",
      "type": "STANDARD",
      "loginStatus": "ACTIVE",
      "addToNewProjects": true,
      "contact": Contact,
      "laborClassId": "xyz789",
      "laborClass": LaborClass,
      "_version": 123,
      "_deleted": false,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateWeatherType

Response

Returns a WeatherType

Example

Query
subscription onUpdateWeatherType {
  onUpdateWeatherType {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateWeatherType": {
      "id": "4",
      "name": "xyz789",
      "_version": 987,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}

onUpdateWindType

Response

Returns a WindType

Example

Query
subscription onUpdateWindType {
  onUpdateWindType {
    id
    name
    _version
    _deleted
    _lastChangedAt
    createdAt
    updatedAt
  }
}
Response
{
  "data": {
    "onUpdateWindType": {
      "id": 4,
      "name": "xyz789",
      "_version": 123,
      "_deleted": true,
      "_lastChangedAt": AWSTimestamp,
      "createdAt": AWSDateTime,
      "updatedAt": AWSDateTime
    }
  }
}