Offers

Types

type CrmOffer {
    id: ID
    contractRequired: boolean
    downPaymount {
        amountCents: number
        currency: string
    }
    checkIn: Date
    checkOut: Date
    expiresAfter: Date
    contractTemplateId: string # uuidv4
    holdCalendar: boolean
    requiresApplication: boolean
    status: string
    uniqueReference: string
    
    createdBy: PmsUser # See auth and identity
    building: Building # See building page
    
    accommodation: CrmOfferAccommodation[]
    
    lead: CrmLead
}

type CrmOfferAccommodation {
    id: ID
    unitType: UnitType # See unit types page
}

Search / List offers

input CrmOffersSearchQueryInput {
   workspaceIds: ID[]
   leadIds: ID[]
}

query {
    crm {
       offers {
          search(
             q: CrmOffersSearchQueryInput
          ) {
             edges {
                node {
                   # CrmOffer
                }
             }
          }   
       }
    }
}

* For brevity cursor types have been excluded - See Pagination (Cursors)

** For brevity most connection keys have been excluded - See Connections

Get offer

query {
    crm {
       offer(offerId: ID) {
          # CrmOffer
       }
    }
}

Edit offer

mutation {
    crm {
       offers {
          update(
             offerId: ID
             data: CrmOffer
          ) {
             # CrmOffer
          }   
       }
    }
}

Delete offer

mutation {
    crm {
       offers {
          delete(
             offerId: ID
          ) 
       }
    }
}

Last updated