Jump to

• Request
• Response
• Examples

Get guest checks

post

/bi/v1/{orgIdentifier}/getGuestChecks

Gets all guest checks for a specified location that were opened on a specified business date or for a specified business date and also after a specified calendar date and time. If the guest check is reopened, it will be included if the reopen closed check business date falls into the specified business or if it was closed after the specified calendar date and time. In order to get the closed guest checks, use the search criteria on the clsdGuestChecksOnly attribute. At least one of the opnbusDt or cldBusDt need to be provided in the guest checks API request.

Request

Path Parameters

• orgIdentifier(required): string
  Unique identifier of the organization name

Body ()

The request body defines the details of the API request.

Root Schema : gstChkRequestPayload

Type: object

Request payload for guest checks

Show Source

• applicationName: string
  Title: Application Name

  Maximum Length: 128

  The name of the application which is accessing the API.

  First Available Version: 20.1.10

• busDt(required): string(date)
  Title: Business Date

  If present, the API will return the superset of all guest checks where Open Business Date or Closed Business Date match to the supplied date. This parameter cannot be present if clsdBusDt or opnbusDt are present.

  First Available Version: 20.1.10

• changedSinceUTC: string(date-time)
  Title: Changed Since Data Time UTC

  Report all guest check activity that has occurred since this UTC date and time for the specified business date.If this object is not included, return all guest check activity for the specified business date.
• clsdBusDt(required): string(date)
  Title: Closed Business Date

  If present, the API will return all guest checks which were closed or reopen closed on the supplied business date. This parameter cannot be present if opnBusDt or busDt are present
• clsdGuestChecksOnly: boolean
  Title: Closed Guest Checks Only

  Indicator whether the response includes only closed guest checks
• include: string
  Title: Include

  Maximum Length: 2000

  List of objects to include in response
• locRef(required): string
  Title: Location Reference

  Maximum Length: 99

  The location reference, this may be a store number or name depending on the organization
• opnBusDt(required): string(date)
  Title: Open Business Date

  If present, the API will return the guest checks which were opened or reopened on the supplied business date. This parameter cannot be present if clsdBusDt or busDt are present
• rvcNum: integer
  Title: Revenue center number

  Maximum Length: 10

  Revenue center number for which the checks are to be fetched.

  First Available Version: 20.1.9.7

• searchCriteria: string
  Title: Search Criteria

  Maximum Length: 2000

  Search criteria to filter results based on field value

{
    "description":"Request payload for guest checks",
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "title":"Location Reference",
            "maxLength":99
        },
        "clsdBusDt":{
            "type":"string",
            "description":"If present, the API will return all guest checks which were closed or reopen closed on the supplied business date. This parameter cannot be present if opnBusDt or busDt are present",
            "title":"Closed Business Date",
            "format":"date"
        },
        "opnBusDt":{
            "type":"string",
            "description":"If present, the API will return the guest checks which were opened or reopened on the supplied business date. This parameter cannot be present if clsdBusDt or busDt are present",
            "title":"Open Business Date",
            "format":"date"
        },
        "busDt":{
            "type":"string",
            "description":"If present, the API will return the superset of all guest checks where Open Business Date or Closed Business Date match to the supplied date. This parameter cannot be present if clsdBusDt or opnbusDt are present. <p>First Available Version: 20.1.10</p>",
            "title":"Business Date",
            "format":"date"
        },
        "clsdGuestChecksOnly":{
            "type":"boolean",
            "description":"Indicator whether the response includes only closed guest checks",
            "title":"Closed Guest Checks Only"
        },
        "changedSinceUTC":{
            "type":"string",
            "description":"Report all guest check activity that has occurred since this UTC date and time for the specified business date.If this object is not included, return all guest check activity for the specified business date.",
            "title":"Changed Since Data Time UTC",
            "format":"date-time"
        },
        "rvcNum":{
            "type":"integer",
            "description":"Revenue center number for which the checks are to be fetched. <p>First Available Version: 20.1.9.7</p>",
            "title":"Revenue center number",
            "maxLength":10
        },
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value",
            "title":"Search Criteria",
            "maxLength":2000
        },
        "include":{
            "type":"string",
            "description":"List of objects to include in response",
            "title":"Include",
            "maxLength":2000
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application which is accessing the API. <p>First Available Version: 20.1.10</p>",
            "title":"Application Name",
            "maxLength":128
        }
    },
    "required":[
        "locRef",
        "opnBusDt",
        "clsdBusDt",
        "busDt"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : guestChecksResponse

Type: object

The response body contains information about the guest checks for the specified location and business date.

Show Source

• curUTC(required): string(date-time)
  Title: Current Date Time in UTC

  The current UTC date and time when the request is made
• guestChecks: array guestChecks
  An array of guest checks
• locRef(required): string
  Title: Location Reference

  Maximum Length: 99

  The location reference, this may be a store number or name depending on the organization

{
    "description":"The response body contains information about the guest checks for the specified location and business date.",
    "properties":{
        "curUTC":{
            "type":"string",
            "description":"The current UTC date and time when the request is made",
            "title":"Current Date Time in UTC",
            "format":"date-time"
        },
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "title":"Location Reference",
            "maxLength":99
        },
        "guestChecks":{
            "type":"array",
            "description":"An array of guest checks",
            "items":{
                "$ref":"#/definitions/guestCheck"
            }
        }
    },
    "required":[
        "curUTC",
        "locRef",
        "guestCheck"
    ]
}

Nested Schema : guestChecks

Type: array

An array of guest checks

Show Source

• Array of: object guestCheck
  The response body contains information about the guest check for the specified location and business date.

{
    "type":"array",
    "description":"An array of guest checks",
    "items":{
        "$ref":"#/definitions/guestCheck"
    }
}

Nested Schema : guestCheck

Type: object

The response body contains information about the guest check for the specified location and business date.

Show Source

• autoFireLcl: string(date-time)
  Title: Auto fire date time of the check

  The date and time the guest check was or is going to be auto fired in the location's timezone. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.12

• autoFireUTC: string(date-time)
  Title: Auto fire date time of the check

  The date and time the guest check was or is going to be auto fired as a UTC time. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.12

• autoSvcTtl(required): number
  Title: Auto Service Charge Total

  The autogratuity or auto service charge total associated with the check. This is optional. The detail also appears in as a service charge line item. This attribute will not be returned in the response if value is 0 or null
• balDueTtl(required): number
  Title: Balance Due Total

  The balance due associated with this guest check, chkTtl ??? payTtl. If the check is closed, this will be 0.00.
• cancelFlag(required): boolean
  Title: Cancel Flag

  A flag indicating if the guest check is cancelled. If the check is not cancelled, this object is not present. This attribute will not be returned in the response if value is false or null.

  First Available Version: 20.1.8.2

• chkInfo(required): string
  Title: Check Information

  Maximum Length: 99

  Information associated with the guest check. This attribute will not be returned in the response if value is null
• chkName(required): string
  Title: Check Name

  Maximum Length: 99

  Unique identifier of the guest check associated with this transaction. This attribute will not be returned in the response if value is null
• chkNum(required): integer
  Title: Check Number

  Maximum Length: 8

  Unique identifier of the guest check associated with this transaction
• chkRef(required): string
  Title: Check Reference

  Maximum Length: 99

  Reference information of the guest check. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.10

• chkTtl(required): number
  Title: Check Total

  The total value of this guest check without payments.
• clsdBusDt(required): string(date)
  Title: Closed Business Date

  The business date the guest check was closed. If the check is open, this object is not present. This attribute will not be returned in the response if value is null
• clsdFlag(required): boolean
  Title: Closed Flag

  A flag indicating if the guest check is closed. If the check is open, this object is not present. This attribute will not be returned in the response if value is false or null.
• clsdLcl(required): string(date-time)
  Title: Closed Business Date Time Local

  The date and time the guest check was closed in the location's timezone. If the check is open, this object is not present. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.9.6

• clsdUTC(required): string(date-time)
  Title: Closed Business Date Time UTC

  The date and time the guest check was closed as a UTC time. If the check is open, this object is not present. This attribute will not be returned in the response if value is null.
• detailLines(required): array detailLines
  Array of guest check detail line JSON objects. Each detail line contains information about a specific menu item, discount, service charge or tender/media. Detail lines are presented in sequence.
• dscTtl(required): number
  Title: Discount Total

  The total value of discounts on this guest check.
• empNum(required): integer
  Title: Employee Number

  Maximum Length: 16

  The number of the employee responsible for this guest check
• gstCnt(required): integer
  Title: Guest Count

  The guest count associated with thus guest check. This is optional. This attribute will not be returned in the response if value is 0 or null.
• guestCheckId(required): integer
  Title: Guest Check ID

  Maximum Length: 16

  Unique Identifier of the guest check
• lastTransLcl(required): string(date-time)
  Title: Last Updated Date Time Local

  The date and time of the last transaction update to the guest check in the location's timezone.

  First Available Version: 20.1.12

• lastTransUTC(required): string(date-time)
  Title: Last Updated Date Time UTC

  The date and time of the last transaction update to the guest check as a UTC time.

  First Available Version: 20.1.12

• lastUpdatedLcl(required): string(date-time)
  Title: Last Updated Date Time Local

  The date and time the guest check was last updated in the cloud in the location's timezone.

  First Available Version: 20.1.12

• lastUpdatedUTC(required): string(date-time)
  Title: Last Updated Date Time UTC

  The date and time the guest check was last updated in the cloud as a UTC time.

  First Available Version: 20.1.12

• ocNum: integer
  Title: Order Channel number

  Maximum Length: 16

  Unique identifier of the order channel. This attribute will not be returned in the response if value is 0 or null.

  First available version 20.1.15

• opnBusDt(required): string(date)
  Title: Open Business Date

  The business date the guest check was opened.
• opnLcl(required): string(date-time)
  Title: Open Business Date Time Local

  The date and time the guest check was opened in the location's timezone.

  First Available Version: 20.1.9.6

• opnUTC(required): string(date-time)
  Title: Open Business Date Time UTC

  The date and time the guest check was opened as a UTC time
• otNum(required): integer
  Title: Order Type Number

  Maximum Length: 16

  The number of the order type associated with this guest check.
• payTtl(required): number
  Title: Pay Total

  The total value of payments on this guest check.
• reopnClsdChkClsdBusDt(required): string(date)
  Title: Reopen Closed Check Closed Business Date

  The business date a reopened closed guest check was closed. If the check was not reopened, the object is not present. This attribute will not be returned in the response if value is null.
• reopnClsdChkClsdLcl(required): string(date-time)
  Title: Reopen Closed Check Closed Business Date Time Local

  The date and time a reopened guest check was closed in the location's timezone. If the check was not reopened, this object is not present. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.9.6

• reopnClsdChkClsdUTC(required): string(date-time)
  Title: Reopen Closed Check Closed Business Date Time UTC

  The date and time a reopened guest check was closed as a UTC time. If the check was not reopened, this object is not present. This attribute will not be returned in the response if value is null.
• reopnFrmChk(required): integer
  Title: Reopen from Check Number

  Maximum Length: 16

  The unique identifier of the check from which the current check was reopened. This attribute will not be returned in the response if value is null
• reopnToChk(required): integer
  Title: Reopen to Check Number

  Maximum Length: 16

  The unique identifier of the check to which the current check was reopened. This attribute will not be returned in the response if value is null
• rndTtl(required): number
  Title: Rounding Total

  Currency rounding total. This attribute will not be returned in the response if value is 0 or null.
• rvcNum(required): integer
  Title: Revenue Center Number

  Maximum Length: 10

  The number of the revenue center associated with this guest check
• spltFrmChk(required): integer
  Title: Reopen to Check Numner

  Maximum Length: 16

  The unique identifier of the check from which the current check was split. This attribute will not be returned in the response if value is null
• subTtl(required): number
  Title: Sub Total

  The subtotal value associated with the guest check.
• svcChgTtl(required): number
  Title: Service Charge Total

  The service charge (executing auto services charge) associated with this guest check. This attribute will not be returned in the response if value is 0 or null
• taxCollTtl: number
  Title: Tax Collected Total

  The total tax collected for the guest check
• taxes(required): array taxes
  An array of taxes that are associated with the guest check
• taxExmpSlsTtl: number
  Title: Tax Exempt Sales Total

  The total of the sales that is exempted from tax. Applicable for add-on taxes only
• tblName(required): string
  Title: Table Name

  Maximum Length: 99

  The table associated with this guest check. This attribute will not be returned in the response if value is null
• tblNum(required): integer
  Title: Table Number

  Maximum Length: 8

  The table number associated with the check. This attribute will not be returned in the response if value is null
• tipTotal(required): number
  Title: Tip Total

  The tip total. This attribute will not be returned in the response if value is 0 or null
• xferStatus(required): string
  Title: Transfer Status

  Maximum Length: 1

  Transfer status of the guest check
  X - Transfer
  A - Add. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.10

• xferToChkNum(required): integer
  Title: Transfer to Check Number

  Maximum Length: 8

  Number of the check to which the check is transferred. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.10

{
    "description":"The response body contains information about the guest check for the specified location and business date.",
    "properties":{
        "guestCheckId":{
            "type":"integer",
            "description":"Unique Identifier of the guest check",
            "title":"Guest Check ID",
            "maxLength":16
        },
        "chkNum":{
            "type":"integer",
            "description":"Unique identifier of the guest check associated with this transaction",
            "title":"Check Number",
            "maxLength":8
        },
        "chkName":{
            "type":"string",
            "description":"Unique identifier of the guest check associated with this transaction. This attribute will not be returned in the response if value is null",
            "title":"Check Name",
            "maxLength":99
        },
        "opnBusDt":{
            "type":"string",
            "description":"The business date the guest check was opened.",
            "title":"Open Business Date",
            "format":"date"
        },
        "clsdBusDt":{
            "type":"string",
            "description":"The business date the guest check was closed. If the check is open, this object is not present. This attribute will not be returned in the response if value is null",
            "title":"Closed Business Date",
            "format":"date"
        },
        "opnUTC":{
            "type":"string",
            "description":"The date and time the guest check was opened as a UTC time",
            "title":"Open Business Date Time UTC",
            "format":"date-time"
        },
        "opnLcl":{
            "type":"string",
            "description":"The date and time the guest check was opened in the location's timezone. <p>First Available Version: 20.1.9.6</p>",
            "title":"Open Business Date Time Local",
            "format":"date-time"
        },
        "clsdUTC":{
            "type":"string",
            "description":"The date and time the guest check was closed as a UTC time. If the check is open, this object is not present. This attribute will not be returned in the response if value is null.",
            "title":"Closed Business Date Time UTC",
            "format":"date-time"
        },
        "clsdLcl":{
            "type":"string",
            "description":"The date and time the guest check was closed in the location's timezone. If the check is open, this object is not present. This attribute will not be returned in the response if value is null.<p>First Available Version: 20.1.9.6</p>",
            "title":"Closed Business Date Time Local",
            "format":"date-time"
        },
        "reopnClsdChkClsdBusDt":{
            "type":"string",
            "description":"The business date a reopened closed guest check was closed. If the check was not reopened, the object is not present. This attribute will not be returned in the response if value is null.",
            "title":"Reopen Closed Check Closed Business Date",
            "format":"date"
        },
        "reopnClsdChkClsdUTC":{
            "type":"string",
            "description":"The date and time a reopened guest check was closed as a UTC time. If the check was not reopened, this object is not present. This attribute will not be returned in the response if value is null.",
            "title":"Reopen Closed Check Closed Business Date Time UTC",
            "format":"date-time"
        },
        "reopnClsdChkClsdLcl":{
            "type":"string",
            "description":"The date and time a reopened guest check was closed in the location's timezone. If the check was not reopened, this object is not present. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.9.6</p>",
            "title":"Reopen Closed Check Closed Business Date Time Local",
            "format":"date-time"
        },
        "lastUpdatedUTC":{
            "type":"string",
            "description":"The date and time the guest check was last updated in the cloud as a UTC time.<p>First Available Version: 20.1.12</p>",
            "title":"Last Updated Date Time UTC",
            "format":"date-time"
        },
        "lastUpdatedLcl":{
            "type":"string",
            "description":"The date and time the guest check was last updated in the cloud  in the location's timezone.<p>First Available Version: 20.1.12</p>",
            "title":"Last Updated Date Time Local",
            "format":"date-time"
        },
        "lastTransUTC":{
            "type":"string",
            "description":"The date and time of the last transaction update to the guest check as a UTC time.<p>First Available Version: 20.1.12</p>",
            "title":"Last Updated Date Time UTC",
            "format":"date-time"
        },
        "lastTransLcl":{
            "type":"string",
            "description":"The date and time of the last transaction update to the guest check in the location's timezone.<p>First Available Version: 20.1.12</p>",
            "title":"Last Updated Date Time Local",
            "format":"date-time"
        },
        "clsdFlag":{
            "type":"boolean",
            "description":"A flag indicating if the guest check is closed. If the check is open, this object is not present. This attribute will not be returned in the response if value is false or null.",
            "title":"Closed Flag"
        },
        "cancelFlag":{
            "type":"boolean",
            "description":"A flag indicating if the guest check is cancelled. If the check is not cancelled, this object is not present. This attribute will not be returned in the response if value is false or null. <p>First Available Version: 20.1.8.2</p>",
            "title":"Cancel Flag"
        },
        "gstCnt":{
            "type":"integer",
            "description":"The guest count associated with thus guest check. This is optional. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Guest Count"
        },
        "subTtl":{
            "type":"number",
            "description":"The subtotal value associated with the guest check.",
            "title":"Sub Total"
        },
        "rndTtl":{
            "type":"number",
            "description":"Currency rounding total. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Rounding Total"
        },
        "autoSvcTtl":{
            "type":"number",
            "description":"The autogratuity or auto service charge total associated with the check. This is optional. The detail also appears in as a service charge line item. This attribute will not be returned in the response if value is 0 or null",
            "title":"Auto Service Charge Total"
        },
        "svcChgTtl":{
            "type":"number",
            "description":"The service charge (executing auto services charge) associated with this guest check. This attribute will not be returned in the response if value is 0 or null",
            "title":"Service Charge Total"
        },
        "taxExmpSlsTtl":{
            "type":"number",
            "description":"The total of the sales that is exempted from tax. Applicable for add-on taxes only",
            "title":"Tax Exempt Sales Total"
        },
        "taxCollTtl":{
            "type":"number",
            "description":"The total tax collected for the guest check",
            "title":"Tax Collected Total"
        },
        "chkTtl":{
            "type":"number",
            "description":"The total value of this guest check without payments.",
            "title":"Check Total"
        },
        "dscTtl":{
            "type":"number",
            "description":"The total value of discounts on this guest check.",
            "title":"Discount Total"
        },
        "payTtl":{
            "type":"number",
            "description":"The total value of payments on this guest check.",
            "title":"Pay Total"
        },
        "tipTotal":{
            "type":"number",
            "description":"The tip total. This attribute will not be returned in the response if value is 0 or null",
            "title":"Tip Total"
        },
        "balDueTtl":{
            "type":"number",
            "description":"The balance due associated with this guest check, chkTtl ??? payTtl. If the check is closed, this will be 0.00.",
            "title":"Balance Due Total"
        },
        "reopnFrmChk":{
            "type":"integer",
            "description":"The unique identifier of the check from which the current check was reopened. This attribute will not be returned in the response if value is null",
            "title":"Reopen from Check Number",
            "maxLength":16
        },
        "reopnToChk":{
            "type":"integer",
            "description":"The unique identifier of the check to which the current check was reopened. This attribute will not be returned in the response if value is null",
            "title":"Reopen to Check Number",
            "maxLength":16
        },
        "spltFrmChk":{
            "type":"integer",
            "description":"The unique identifier of the check from which the current check was split. This attribute will not be returned in the response if value is null",
            "title":"Reopen to Check Numner",
            "maxLength":16
        },
        "rvcNum":{
            "type":"integer",
            "description":"The number of the revenue center associated with this guest check",
            "title":"Revenue Center Number",
            "maxLength":10
        },
        "ocNum":{
            "type":"integer",
            "description":"Unique identifier of the order channel. This attribute will not be returned in the response if value is 0 or null.<p> First available version 20.1.15</p>",
            "title":"Order Channel number",
            "maxLength":16
        },
        "otNum":{
            "type":"integer",
            "description":"The number of the order type associated with this guest check.",
            "title":"Order Type Number",
            "maxLength":16
        },
        "tblNum":{
            "type":"integer",
            "description":"The table number associated with the check. This attribute will not be returned in the response if value is null",
            "title":"Table Number",
            "maxLength":8
        },
        "tblName":{
            "type":"string",
            "description":"The table associated with this guest check. This attribute will not be returned in the response if value is null",
            "title":"Table Name",
            "maxLength":99
        },
        "empNum":{
            "type":"integer",
            "description":"The number of the employee responsible for this guest check ",
            "title":"Employee Number",
            "maxLength":16
        },
        "chkInfo":{
            "type":"string",
            "description":"Information associated with the guest check. This attribute will not be returned in the response if value is null",
            "title":"Check Information",
            "maxLength":99
        },
        "chkRef":{
            "type":"string",
            "description":"Reference information of the guest check. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.10</p>",
            "title":"Check Reference",
            "maxLength":99
        },
        "xferStatus":{
            "type":"string",
            "description":"Transfer status of the guest check <br> X - Transfer <br> A - Add. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.10</p>",
            "title":"Transfer Status",
            "maxLength":1
        },
        "xferToChkNum":{
            "type":"integer",
            "description":"Number of the check to which the check is transferred. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.10</p>",
            "title":"Transfer to Check Number",
            "maxLength":8
        },
        "autoFireUTC":{
            "type":"string",
            "description":"The date and time the guest check was or is going to be auto fired as a UTC time. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.12</p>",
            "title":"Auto fire date time of the check",
            "format":"date-time"
        },
        "autoFireLcl":{
            "type":"string",
            "description":"The date and time the guest check was or is going to be auto fired in the location's timezone. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.12</p>",
            "title":"Auto fire date time of the check",
            "format":"date-time"
        },
        "taxes":{
            "type":"array",
            "description":"An array of taxes that are associated with the guest check",
            "items":{
                "$ref":"#/definitions/guestCheckTax"
            }
        },
        "detailLines":{
            "type":"array",
            "description":"Array of guest check detail line JSON objects. Each detail line contains information about a specific menu item, discount, service charge or tender/media. Detail lines are presented in sequence.",
            "items":{
                "$ref":"#/definitions/guestCheckDetailLine"
            }
        }
    },
    "required":[
        "guestCheckId",
        "chkNum",
        "opnBusDt",
        "opnUTC",
        "opnLcl",
        "lastUpdatedUTC",
        "lastUpdatedLcl",
        "lastTransUTC",
        "lastTransLcl",
        "subTtl",
        "chkTtl",
        "dscTtl",
        "payTtl",
        "balDueTtl",
        "rvcNum",
        "otNum",
        "empNum",
        "detailLines",
        "chkName",
        "clsdBusDt",
        "clsdUTC",
        "clsdLcl",
        "reopnClsdChkClsdBusDt",
        "reopnClsdChkClsdUTC",
        "reopnClsdChkClsdLcl",
        "clsdFlag",
        "cancelFlag",
        "gstCnt",
        "rndTtl",
        "autoSvcTtl",
        "svcChgTtl",
        "tipTotal",
        "reopnFrmChk",
        "reopnToChk",
        "spltFrmChk",
        "tblNum",
        "tblName",
        "chkInfo",
        "chkRef",
        "xferStatus",
        "taxes",
        "xferToChkNum"
    ]
}

Nested Schema : detailLines

Type: array

Array of guest check detail line JSON objects. Each detail line contains information about a specific menu item, discount, service charge or tender/media. Detail lines are presented in sequence.

Show Source

• Array of: object guestCheckDetailLine
  The response body contains information about the guest check detail line for the specified guest check

{
    "type":"array",
    "description":"Array of guest check detail line JSON objects. Each detail line contains information about a specific menu item, discount, service charge or tender/media. Detail lines are presented in sequence.",
    "items":{
        "$ref":"#/definitions/guestCheckDetailLine"
    }
}

Nested Schema : taxes

Type: array

An array of taxes that are associated with the guest check

Show Source

• Array of: object guestCheckTax
  The aggregated tax totals for a given tax associated with the guest check

{
    "type":"array",
    "description":"An array of taxes that are associated with the guest check",
    "items":{
        "$ref":"#/definitions/guestCheckTax"
    }
}

Nested Schema : guestCheckDetailLine

Type: object

The response body contains information about the guest check detail line for the specified guest check

Show Source

• aggQty(required): integer
  Title: Aggregate Quantity

  Maximum Length: 16

  The number of the workstation where the line item was modified
• aggTtl(required): number
  Title: Aggregate Total

  Aggregate total of the line item
• busDt(required): string(date)
  Title: Detail Business Date

  Business Date when the line item was entered
• cashierNum(required): integer
  Title: Cashier Number

  Maximum Length: 16

  Unique identifier of the cashier of the line item. This attribute will not be returned in the response if value is null
• chkEmpNum(required): integer
  Title: Check Employee Number

  Maximum Length: 16

  Unique identifier of the employee who has entered the check
• detailLcl(required): string(date-time)
  Title: Detail Date Time Local

  The date and time this detail line was entered in the location's timezone.

  First Available Version: 20.1.9.6

• detailUTC(required): string(date-time)
  Title: Detail Date Time UTC

  The UTC date and time this detail line was entered.
• discount(required): object guestCheckDiscount
  If this detail line is a discount, a discount JSON object will be present. This attribute will not be returned in the response if detail type is not a discount
• doNotShowFlag(required): boolean
  Title: DoNot Show Flag

  A flag indicating if the line item is not shown on the check. This attribute will not be returned in the response if value is false or null
• dspQty(required): integer
  Title: Display Quantiy

  Maximum Length: 16

  Displayed quantity of the line item
• dspTtl(required): number
  Title: Display Total

  Display total of the line item
• dtlId(required): integer
  Title: Detail ID

  Maximum Length: 16

  Unique identifier of the line item
• dtlOcNum: integer
  Title: Order channel identifier

  Maximum Length: 16

  Unique identifier of the order channel associated with this guest check detail. This attribute will not be returned in the response if value is 0 or null.

  First available version 20.1.15

• dtlOtNum(required): integer
  Title: Detail Order Type Number

  Maximum Length: 16

  The number of the order type associated with this guest check detail. This attribute will not be returned in the response if value is null
• errCorFlag(required): boolean
  Title: Error Correct Flag

  A flag indicating if this detail item is an error correct. This attribute will not be returned in the response if value is false or null
• errorCorrect(required): object guestCheckErrorCorrect
  If this detail line is a error correct, a errorCorrect JSON object will be present. This attribute will not be returned in the response if detail type is not a error correct.

  First Available Version: 20.1.10

• guestCheckLineItemId(required): integer
  Title: Guest Check Line Item ID

  Maximum Length: 16

  Unique identifier of the guest check line item
• lastUpdatedLcl(required): string(date-time)
  Title: Last Updated Date Time Local

  The date and time the transaction was updated or inserted in the cloud in the location's timezone.

  First Available Version: 20.1.12

• lastUpdatedUTC(required): string(date-time)
  Title: Last Updated Date Time UTC

  The date and time the transaction was updated or inserted in the cloud as a UTC time.

  First Available Version: 20.1.12

• lineNum(required): integer
  Title: Line Number

  Maximum Length: 5

  The line number of this detail line.
• menuItem(required): object guestCheckMenuItem
  If this detail line is a menu item, a menu item JSON object will be present. This attribute will not be returned in the response if detail type is not a menu item
• mgrEmpNum(required): integer
  Title: Manager Employee Number

  Maximum Length: 16

  Unique identifier of the manager of the employee who has entered the transaction. This attribute will not be returned in the response if value is null
• other(required): object guestCheckOtherDetails
  If this detail line is any other type like reference, transfer, error correct, a other JSON object will be present. This attribute will not be returned in the response if detail type is a menu item, discount, service charge or tender media
• parDtlId(required): integer
  Title: Parent Detail ID

  Maximum Length: 16

  Unique identifier of the parent line item. This attribute will not be returned in the response if value is 0 or null
• prepCost(required): number
  Title: Preparation Cost

  Preparation Cost of the line item. This attribute will not be returned in the response if value is 0 or null
• refInfo1(required): string
  Title: Check Information

  Maximum Length: 99

  Any manually entered text associated with this detail item. This attribute will not be returned in the response if value is null
• refInfo2(required): string
  Title: Check Information

  Maximum Length: 99

  Any manually entered text associated with this detail item. This attribute will not be returned in the response if value is null
• rsnCodeNum(required): integer
  Title: Reason Code Number

  Maximum Length: 16

  Reason code number. This attribute will not be returned in the response if value is 0 or null
• rvcNum: integer
  Title: Revenue Center Number

  Maximum Length: 10

  The number of the revenue center associated with this line item.

  First Available Version: 20.1.16

• serviceCharge(required): object guestCheckServiceCharge
  If this detail line is a service charge, a service charge JSON object will be present.Note autogratuity also appears here. This attribute will not be returned in the response if detail type is not a service charge
• svcRndNum(required): integer
  Title: Service Round Number

  Maximum Length: 16

  Service Round Number
• tenderMedia(required): object guestCheckTenderMedia
  If this detail line is a tender/media, a tender/media JSON object will be present. This attribute will not be returned in the response if detail type is not a tender media
• transEmpNum(required): integer
  Title: Transaction Employee Number

  Maximum Length: 16

  Unique identifier of the employee who has entered the transaction. This attribute will not be returned in the response if value is same as check employee
• vdFlag(required): boolean
  Title: Void Flag

  A flag indicating if this detail item is a voided item. This attribute will not be returned in the response if value is false or null
• weight(required): number
  Title: Weight

  Weight or Volume of the line item. This attribute will not be returned in the response if value is 0 or null
• wsNum(required): integer
  Title: Workstation Number

  Maximum Length: 16

  The number of the workstation where the line item was modified

{
    "description":"The response body contains information about the guest check detail line for the specified guest check",
    "properties":{
        "guestCheckLineItemId":{
            "type":"integer",
            "description":"Unique identifier of the guest check line item",
            "title":"Guest Check Line Item ID",
            "maxLength":16
        },
        "lineNum":{
            "type":"integer",
            "description":"The line number of this detail line.",
            "title":"Line Number",
            "maxLength":5
        },
        "dtlId":{
            "type":"integer",
            "description":"Unique identifier of the line item",
            "title":"Detail ID",
            "maxLength":16
        },
        "parDtlId":{
            "type":"integer",
            "description":"Unique identifier of the parent line item. This attribute will not be returned in the response if value is 0 or null",
            "title":"Parent Detail ID",
            "maxLength":16
        },
        "detailUTC":{
            "type":"string",
            "description":"The UTC date and time this detail line was entered. ",
            "title":"Detail Date Time UTC",
            "format":"date-time"
        },
        "detailLcl":{
            "type":"string",
            "description":"The date and time this detail line was entered in the location's timezone. <p>First Available Version: 20.1.9.6</p>",
            "title":"Detail Date Time Local",
            "format":"date-time"
        },
        "busDt":{
            "type":"string",
            "description":"Business Date when the line item was entered",
            "title":"Detail Business Date",
            "format":"date"
        },
        "lastUpdatedUTC":{
            "type":"string",
            "description":"The date and time the transaction was updated or inserted in the cloud as a UTC time.<p>First Available Version: 20.1.12</p>",
            "title":"Last Updated Date Time UTC",
            "format":"date-time"
        },
        "lastUpdatedLcl":{
            "type":"string",
            "description":"The date and time the transaction was updated or inserted in the cloud in the location's timezone.<p>First Available Version: 20.1.12</p>",
            "title":"Last Updated Date Time Local",
            "format":"date-time"
        },
        "rvcNum":{
            "type":"integer",
            "description":"The number of the revenue center associated with this line item.<p>First Available Version: 20.1.16</p>",
            "title":"Revenue Center Number",
            "maxLength":10
        },
        "wsNum":{
            "type":"integer",
            "description":"The number of the workstation where the line item was modified",
            "title":"Workstation Number",
            "maxLength":16
        },
        "prepCost":{
            "type":"number",
            "description":"Preparation Cost of the line item. This attribute will not be returned in the response if value is 0 or null",
            "title":"Preparation Cost"
        },
        "weight":{
            "type":"number",
            "description":"Weight or Volume of the line item. This attribute will not be returned in the response if value is 0 or null",
            "title":"Weight"
        },
        "vdFlag":{
            "type":"boolean",
            "description":"A flag indicating if this detail item is a voided item. This attribute will not be returned in the response if value is false or null",
            "title":"Void Flag"
        },
        "errCorFlag":{
            "type":"boolean",
            "description":"A flag indicating if this detail item is an error correct. This attribute will not be returned in the response if value is false or null",
            "title":"Error Correct Flag"
        },
        "refInfo1":{
            "type":"string",
            "description":"Any manually entered text associated with this detail item. This attribute will not be returned in the response if value is null",
            "title":"Check Information",
            "maxLength":99
        },
        "refInfo2":{
            "type":"string",
            "description":"Any manually entered text associated with this detail item. This attribute will not be returned in the response if value is null",
            "title":"Check Information",
            "maxLength":99
        },
        "dspTtl":{
            "type":"number",
            "description":"Display total of the line item",
            "title":"Display Total"
        },
        "dspQty":{
            "type":"integer",
            "description":"Displayed quantity of the line item",
            "title":"Display Quantiy",
            "maxLength":16
        },
        "aggTtl":{
            "type":"number",
            "description":"Aggregate total of the line item",
            "title":"Aggregate Total"
        },
        "aggQty":{
            "type":"integer",
            "description":"The number of the workstation where the line item was modified",
            "title":"Aggregate Quantity",
            "maxLength":16
        },
        "doNotShowFlag":{
            "type":"boolean",
            "description":"A flag indicating if the line item is not shown on the check. This attribute will not be returned in the response if value is false or null",
            "title":"DoNot Show Flag"
        },
        "chkEmpNum":{
            "type":"integer",
            "description":"Unique identifier of the employee who has entered the check",
            "title":"Check Employee Number",
            "maxLength":16
        },
        "transEmpNum":{
            "type":"integer",
            "description":"Unique identifier of the employee who has entered the transaction. This attribute will not be returned in the response if value is same as check employee",
            "title":"Transaction Employee Number",
            "maxLength":16
        },
        "mgrEmpNum":{
            "type":"integer",
            "description":"Unique identifier of the manager of the employee who has entered the transaction. This attribute will not be returned in the response if value is null",
            "title":"Manager Employee Number",
            "maxLength":16
        },
        "rsnCodeNum":{
            "type":"integer",
            "description":"Reason code number. This attribute will not be returned in the response if value is 0 or null",
            "title":"Reason Code Number",
            "maxLength":16
        },
        "svcRndNum":{
            "type":"integer",
            "description":"Service Round Number",
            "title":"Service Round Number",
            "maxLength":16
        },
        "cashierNum":{
            "type":"integer",
            "description":"Unique identifier of the cashier of the line item. This attribute will not be returned in the response if value is null",
            "title":"Cashier Number",
            "maxLength":16
        },
        "dtlOcNum":{
            "type":"integer",
            "description":"Unique identifier of the order channel associated with this guest check detail. This attribute will not be returned in the response if value is 0 or null.<p>First available version 20.1.15</p>",
            "title":"Order channel identifier",
            "maxLength":16
        },
        "dtlOtNum":{
            "type":"integer",
            "description":"The number of the order type associated with this guest check detail. This attribute will not be returned in the response if value is null",
            "title":"Detail Order Type Number",
            "maxLength":16
        },
        "menuItem":{
            "$ref":"#/definitions/guestCheckMenuItem"
        },
        "discount":{
            "$ref":"#/definitions/guestCheckDiscount"
        },
        "serviceCharge":{
            "$ref":"#/definitions/guestCheckServiceCharge"
        },
        "tenderMedia":{
            "$ref":"#/definitions/guestCheckTenderMedia"
        },
        "errorCorrect":{
            "$ref":"#/definitions/guestCheckErrorCorrect"
        },
        "other":{
            "$ref":"#/definitions/guestCheckOtherDetails"
        }
    },
    "required":[
        "guestCheckLineItemId",
        "lineNum",
        "dtlId",
        "parDtlId",
        "detailUTC",
        "detailLcl",
        "busDt",
        "lastUpdatedUTC",
        "lastUpdatedLcl",
        "wsNum",
        "dspTtl",
        "dspQty",
        "aggTtl",
        "aggQty",
        "chkEmpNum",
        "svcRndNum",
        "prepCost",
        "weight",
        "vdFlag",
        "errCorFlag",
        "refInfo1",
        "refInfo2",
        "doNotShowFlag",
        "transEmpNum",
        "mgrEmpNum",
        "rsnCodeNum",
        "cashierNum",
        "dtlOtNum",
        "menuItem",
        "discount",
        "serviceCharge",
        "tenderMedia",
        "errorCorrect",
        "other"
    ]
}

Nested Schema : guestCheckDiscount

Type: object

If this detail line is a discount, a discount JSON object will be present. This attribute will not be returned in the response if detail type is not a discount

Show Source

• activeTaxes(required): string
  Title: Comma separated string of tax numbers that are active on the discount

  Comma separated string of tax numbers that are active on the discount. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.10.1

• dscMiNum(required): integer
  Title: Discount Menu Item Number

  Maximum Length: 16

  The number associated with the menu item that is discounted. This attribute will not be returned in the response if value is null
• dscNum(required): integer
  Title: Discount Number

  Maximum Length: 16

  The number associated with this discount
• inclTax(required): number
  Title: Total of the inclusive tax on the discounted item

  Total of the inclusive tax on the discounted item. This attribute will not be returned in the response if value is 0 or null.

  First Available Version: 20.1.10.1

• mealEmpNum(required): integer
  Title: Meal Employee Number

  Maximum Length: 16

  If this is an employee meal, the number associated with the employee. This attribute will not be returned in the response if value is null
• vatTaxTtl(required): number
  Title: VAT Tax Total

  Total of the vat tax on the discounted item. This attribute will not be returned in the response if value is 0 or null

{
    "description":"If this detail line is a discount, a discount JSON object will be present. This attribute will not be returned in the response if detail type is not a discount",
    "properties":{
        "dscNum":{
            "type":"integer",
            "description":"The number associated with this discount",
            "title":"Discount Number",
            "maxLength":16
        },
        "dscMiNum":{
            "type":"integer",
            "description":"The number associated with the menu item that is discounted. This attribute will not be returned in the response if value is null",
            "title":"Discount Menu Item Number",
            "maxLength":16
        },
        "mealEmpNum":{
            "type":"integer",
            "description":"If this is an employee meal, the number associated with the employee. This attribute will not be returned in the response if value is null",
            "title":"Meal Employee Number",
            "maxLength":16
        },
        "vatTaxTtl":{
            "type":"number",
            "description":"Total of the vat tax on the discounted item. This attribute will not be returned in the response if value is 0 or null",
            "title":"VAT Tax Total"
        },
        "inclTax":{
            "type":"number",
            "description":"Total of the inclusive tax on the discounted item. This attribute will not be returned in the response if value is 0 or null. <p>First Available Version: 20.1.10.1</p>",
            "title":"Total of the inclusive tax on the discounted item"
        },
        "activeTaxes":{
            "type":"string",
            "description":"Comma separated string of tax numbers that are active on the discount. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.10.1</p>",
            "title":"Comma separated string of tax numbers that are active on the discount"
        }
    },
    "required":[
        "dscNum",
        "dscMiNum",
        "mealEmpNum",
        "vatTaxTtl",
        "inclTax",
        "activeTaxes"
    ]
}

Nested Schema : guestCheckErrorCorrect

Type: object

If this detail line is a error correct, a errorCorrect JSON object will be present. This attribute will not be returned in the response if detail type is not a error correct.

First Available Version: 20.1.10

Show Source

• objectNum(required): integer
  Title: Object Number

  Maximum Length: 16

  Object number of the detail line that is error corrected.

  First Available Version: 20.1.10

• type(required): integer
  Title: Type

  Maximum Length: 16

  The type of the detail line which is error corrected.
  1 - Menu Item
  2 - Service Charge

  First Available Version: 20.1.10

{
    "description":"If this detail line is a error correct, a errorCorrect JSON object will be present. This attribute will not be returned in the response if detail type is not a error correct. <p>First Available Version: 20.1.10</p>",
    "properties":{
        "type":{
            "type":"integer",
            "description":"The type of the detail line which is error corrected.<br>1 - Menu Item<br>2 - Service Charge <p>First Available Version: 20.1.10</p>",
            "title":"Type",
            "maxLength":16
        },
        "objectNum":{
            "type":"integer",
            "description":"Object number of the detail line that is error corrected.<p>First Available Version: 20.1.10</p>",
            "title":"Object Number",
            "maxLength":16
        }
    },
    "required":[
        "type",
        "objectNum"
    ]
}

Nested Schema : guestCheckMenuItem

Type: object

If this detail line is a menu item, a menu item JSON object will be present. This attribute will not be returned in the response if detail type is not a menu item

Show Source

• activeTaxes(required): string
  Title: Active Taxes

  Comma separated string of tax numbers that are active on the menu item. This attribute will not be returned in the response if value is null
• comboGrpNum(required): integer
  Title: Combo Group Number

  Maximum Length: 16

  The number of the combo group associated with the menu item. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.8.3

• comboMealSeq(required): integer
  Title: Combo Meal Sequence Number

  Maximum Length: 16

  The sequence number of the combo meal. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.8.3

• comboSideSeq(required): integer
  Title: Combo Side Sequence Number

  Maximum Length: 16

  The sequence number of the combo side item. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.8.3

• inclTax(required): number
  Title: Inclusive Tax

  The tax included in this menu item's price. This attribute will not be returned in the response if value is 0 or null
• miNum(required): integer
  Title: Menu Item Number

  Maximum Length: 16

  The number of the menu item
• modFlag: boolean
  Title: Modifier flag

  Flag specifying whether the line item is a modifier or not. This attribute will not be returned in the response if value is false or null.

  Requires Simphony 19.6

• modPrfx: integer
  Title: Modifier prefix

  Maximum Length: 16

  If this item is a modifier, this is the modifier prefix. Possible values: 1 = DESCRIPTOR, 2 = NO, 3 = ADD, 4 = SUB, 5 = PLAIN, 6 = RESET. This attribute will not be returned in the response if value is 0 or null.

  Requires Simphony 19.6

• prcLvl(required): integer
  Title: Price Level

  Maximum Length: 16

  Price Level of the menu item
• returnFlag(required): boolean
  Title: Return Flag

  Flag indicating if this menu item is being returned. This attribute will not be returned in the response if value is false or null

{
    "description":"If this detail line is a menu item, a menu item JSON object will be present. This attribute will not be returned in the response if detail type is not a menu item",
    "properties":{
        "miNum":{
            "type":"integer",
            "description":"The number of the menu item",
            "title":"Menu Item Number",
            "maxLength":16
        },
        "comboMealSeq":{
            "type":"integer",
            "description":"The sequence number of the combo meal. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.8.3</p>",
            "title":"Combo Meal Sequence Number",
            "maxLength":16
        },
        "comboSideSeq":{
            "type":"integer",
            "description":"The sequence number of the combo side item. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.8.3</p>",
            "title":"Combo Side Sequence Number",
            "maxLength":16
        },
        "modFlag":{
            "type":"boolean",
            "description":"Flag specifying whether the line item is a modifier or not. This attribute will not be returned in the response if value is false or null. <p>Requires Simphony 19.6</p>",
            "title":"Modifier flag"
        },
        "modPrfx":{
            "type":"integer",
            "description":"If this item is a modifier, this is the modifier prefix. Possible values: 1 = DESCRIPTOR, 2 = NO, 3 = ADD, 4 = SUB, 5 = PLAIN, 6 = RESET. This attribute will not be returned in the response if value is 0 or null. <p>Requires Simphony 19.6</p>",
            "title":"Modifier prefix",
            "maxLength":16
        },
        "comboGrpNum":{
            "type":"integer",
            "description":"The number of the combo group associated with the menu item. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.8.3</p>",
            "title":"Combo Group Number",
            "maxLength":16
        },
        "inclTax":{
            "type":"number",
            "description":"The tax included in this menu item's price. This attribute will not be returned in the response if value is 0 or null",
            "title":"Inclusive Tax"
        },
        "returnFlag":{
            "type":"boolean",
            "description":"Flag indicating if this menu item is being returned. This attribute will not be returned in the response if value is false or null",
            "title":"Return Flag"
        },
        "activeTaxes":{
            "type":"string",
            "description":"Comma separated string of tax numbers that are active on the menu item. This attribute will not be returned in the response if value is null",
            "title":"Active Taxes"
        },
        "prcLvl":{
            "type":"integer",
            "description":"Price Level of the menu item",
            "title":"Price Level",
            "maxLength":16
        }
    },
    "required":[
        "miNum",
        "comboMealSeq",
        "comboSideSeq",
        "comboGrpNum",
        "prcLvl",
        "inclTax",
        "returnFlag",
        "activeTaxes"
    ]
}

Nested Schema : guestCheckOtherDetails

Type: object

If this detail line is any other type like reference, transfer, error correct, a other JSON object will be present. This attribute will not be returned in the response if detail type is a menu item, discount, service charge or tender media

Show Source

• detailNum(required): integer
  Title: Detail Number

  Maximum Length: 16

  The number associated with the other detail. This attribute will not be returned in the response if value is null
• detailType(required): integer
  Title: Detail Type

  Maximum Length: 16

  The type of the gust check line item detail. The following are the different detail types that could be returned:
  5 - Reference
  6 - Reference
  7 - Transfer
  11 - CreditAuth
  12 - CreditVoucher

{
    "description":"If this detail line is any other type like reference, transfer, error correct, a other JSON object will be present. This attribute will not be returned in the response if detail type is a menu item, discount, service charge or tender media",
    "properties":{
        "detailType":{
            "type":"integer",
            "description":"The type of the gust check line item detail. The following are the different detail types that could be returned:<br>5 - Reference<br>6 - Reference<br>7 - Transfer<br>11 - CreditAuth<br>12 - CreditVoucher",
            "title":"Detail Type",
            "maxLength":16
        },
        "detailNum":{
            "type":"integer",
            "description":"The number associated with the other detail. This attribute will not be returned in the response if value is null",
            "title":"Detail Number",
            "maxLength":16
        }
    },
    "required":[
        "detailType",
        "detailNum"
    ]
}

Nested Schema : guestCheckServiceCharge

Type: object

If this detail line is a service charge, a service charge JSON object will be present.Note autogratuity also appears here. This attribute will not be returned in the response if detail type is not a service charge

Show Source

• activeTaxes(required): string
  Title: Comma separated string of tax numbers that are active on the service charge

  Comma separated string of tax numbers that are active on the service charge. This attribute will not be returned in the response if value is null.

  First Available Version: 20.1.10.1

• inclTax(required): number
  Title: Total of the inclusive tax on the taxable service charge

  Total of the inclusive tax on the taxable service charge. This attribute will not be returned in the response if value is 0 or null.

  First Available Version: 20.1.10.1

• svcChgNum(required): integer
  Title: Service Charge Number

  Maximum Length: 16

  The number associated with this service charge

{
    "description":"If this detail line is a service charge, a service charge JSON object will be present.Note autogratuity also appears here. This attribute will not be returned in the response if detail type is not a service charge",
    "properties":{
        "svcChgNum":{
            "type":"integer",
            "description":"The number associated with this service charge",
            "title":"Service Charge Number",
            "maxLength":16
        },
        "inclTax":{
            "type":"number",
            "description":"Total of the inclusive tax on the taxable service charge. This attribute will not be returned in the response if value is 0 or null. <p>First Available Version: 20.1.10.1</p>",
            "title":"Total of the inclusive tax on the taxable service charge"
        },
        "activeTaxes":{
            "type":"string",
            "description":"Comma separated string of tax numbers that are active on the service charge. This attribute will not be returned in the response if value is null. <p>First Available Version: 20.1.10.1</p>",
            "title":"Comma separated string of tax numbers that are active on the service charge"
        }
    },
    "required":[
        "svcChgNum",
        "inclTax",
        "activeTaxes"
    ]
}

Nested Schema : guestCheckTenderMedia

Type: object

If this detail line is a tender/media, a tender/media JSON object will be present. This attribute will not be returned in the response if detail type is not a tender media

Show Source

• mealEmpNum(required): integer
  Title: Meal Employee Number

  Maximum Length: 16

  If this is an employee meal, the number associated with the employee. This attribute will not be returned in the response if value is null
• tmedNum(required): integer
  Title: Tender Media Number

  Maximum Length: 16

  The number associated with this tender/media.

{
    "description":"If this detail line is a tender/media, a tender/media JSON object will be present. This attribute will not be returned in the response if detail type is not a tender media",
    "properties":{
        "tmedNum":{
            "type":"integer",
            "description":"The number associated with this tender/media.",
            "title":"Tender Media Number",
            "maxLength":16
        },
        "mealEmpNum":{
            "type":"integer",
            "description":"If this is an employee meal, the number associated with the employee. This attribute will not be returned in the response if value is null",
            "title":"Meal Employee Number",
            "maxLength":16
        }
    },
    "required":[
        "tmedNum",
        "mealEmpNum"
    ]
}

Nested Schema : guestCheckTax

Type: object

The aggregated tax totals for a given tax associated with the guest check

Show Source

• taxCollTtl(required): number
  Title: Tax Collected Total

  The total tax collected for this tax number in the check.
• taxNum(required): integer
  Title: Tax Number

  Maximum Length: 16

  The number associated with tax.
• taxRate(required): number
  Title: VAT Tax Rate associated with the tax number

  The VAT Tax Rate associated with the tax number on the check.

  First Available Version: 20.1.10.1

• taxType(required): integer
  Title: Tax Type associated with the tax number

  The Tax Type associated with the tax number on the check.
  Possible values:
  1 = Breakpoint add-on
  2 = Add-on percentage
  3 = Inclusive
  4 = Surcharge
  5 = Open

  First Available Version: 20.1.10.1

• txblSlsTtl(required): number
  Title: Taxable Sales Total

  The taxable sales associated with this tax number for the check.

{
    "description":"The aggregated tax totals for a given tax associated with the guest check",
    "properties":{
        "taxNum":{
            "type":"integer",
            "description":"The number associated with tax.",
            "title":"Tax Number",
            "maxLength":16
        },
        "txblSlsTtl":{
            "type":"number",
            "description":"The taxable sales associated with this tax number for the check.",
            "title":"Taxable Sales Total"
        },
        "taxCollTtl":{
            "type":"number",
            "description":"The total tax collected for this tax number in the check.",
            "title":"Tax Collected Total"
        },
        "taxRate":{
            "type":"number",
            "description":"The VAT Tax Rate associated with the tax number on the check. <p>First Available Version: 20.1.10.1</p>",
            "title":"VAT Tax Rate associated with the tax number"
        },
        "taxType":{
            "type":"integer",
            "description":"The Tax Type associated with the tax number on the check. <br>Possible values: <br>1 = Breakpoint add-on <br>2 = Add-on percentage <br>3 = Inclusive <br>4 = Surcharge <br>5 = Open <p>First Available Version: 20.1.10.1</p>",
            "title":"Tax Type associated with the tax number"
        }
    },
    "required":[
        "svcNum",
        "taxNum",
        "txblSlsTtl",
        "taxCollTtl",
        "taxRate",
        "taxType"
    ]
}

400 Response

Bad Request

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle error code

  Oracle error code
• status: integer
  Title: Status

  HTTP response code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

401 Response

Unauthorized

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle error code

  Oracle error code
• status: integer
  Title: Status

  HTTP response code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

403 Response

Service Unavailable

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle error code

  Oracle error code
• status: integer
  Title: Status

  HTTP response code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

404 Response

Resource Not Found

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle error code

  Oracle error code
• status: integer
  Title: Status

  HTTP response code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Default Response

Unexpected Error

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle error code

  Oracle error code
• status: integer
  Title: Status

  HTTP response code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to get the guest checks for a specified location and closed business date after a given date time by submitting a POST request on the REST resource using cURL. For more information, see Use cURL

curl -i -X POST -H "Authorization: Bearer 
  
   " -H "Content-Type:application/json" -d {"locRef":"1234","rvcNum": 1, "clsdBusDt":"2020-10-20", "changedSinceUTC":"2020-10-20T16:00:00"} https://baseurl/bi/v1/orgidentifier/getGuestChecks 
  

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK  Date: Tue, 20 Oct 2020 21:24:33 GMT  Transfer-Encoding: chunked  Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
 "curUTC": "2020-10-20T16:42:42",
 "locRef" : "SAC",
 "guestChecks": [
 {
  "guestCheckId": 829084,
  "chkNum": 9735,
  "chkName": "Check",
  "opnBusDt": "2020-10-20",
  "opnUTC": "2020-10-20T15:41:54",
  "opnLcl": "2020-10-20T11:41:54",
  "clsdBusDt": "2020-10-20",
  "clsdUTC": "2020-10-20T16:20:44",
  "clsdLcl": "2020-10-20T12:20:44",
  "reopnClsdChkClsdBusDt": "2020-10-20",
  "reopnClsdChkClsdUTC": "2020-10-20T16:20:44",
  "reopnClsdChkClsdLcl": "2020-10-20T12:20:44",
  "lastUpdatedUTC": "2020-10-20T16:20:45",
  "lastUpdatedLcl": "2020-10-20T12:20:45",
  "lastTransUTC": "2020-10-20T12:20:45",
  "lastTransLcl": "2020-10-20T12:20:45",
  "clsdFlag": true,
  "cancelFlag": false,
  "gstCnt": 2,
  "subTtl": 16.66,
  "autoSvcTtl": 0.00,
  "svcChgTtl": 3.5,
  "taxExmpSlsTtl": 0.00,
  "taxCollTtl": 0.83,
  "chkTtl": 20.99,
  "dscTtl": -5,
  "payTtl": 15.00,
  "tipTotal": 3.5,
  "balDueTtl": 0.99,
  "rndTtl": 21.00,
  "reopnFrmChk": 9736,
  "reopnToChk": 9738,
  "spltFrmChk": 9735,
  "rvcNum": 1,
  "ocNum": 2,
  "otNum": 12,
  "tblNum": 1,
  "tblName": "5",
  "empNum": 258,
  "chkInfo": "Check Info",
  "chkRef": "Check Reference",
  "xferStatus": "X",
  "xferToChkNum": 8,
  "autoFireUTC": "2020-10-20T12:20:45",
  "autoFireLcl": "2020-10-20T12:20:45",
  "taxes": [
  {
   "taxNum": 1,
   "txblSlsTtl": 12.34,
   "taxCollTtl": 0.83,
   "taxRate": 19,
   "taxType": 3
    }],
  "detailLines": [
  {
   "guestCheckLineItemId": 9433187,
   "lineNum": 1,
   "dtlId": 17,
   "parDtlId": 0,
   "detailUTC": "2020-10-20T15:42:08",
   "detailLcl": "2020-10-20T11:42:08",
   "busDt": "2020-10-20",
   "lastUpdatedUTC": "2020-10-20T12:20:45",
   "lastUpdatedLcl": "2020-10-20T12:20:45",
   "rvcNum": 152,
   "prepCost": 0.481,
   "weight": 1.23,
   "vdFlag": false,
   "errCorFlag": false,
   "wsNum": 6,
   "refInfo1": "reference info 1",
   "refInfo2": "reference info 2",
   "dspTtl": 2.09,
   "dspQty": 1,
   "aggTtl": 2.09,
   "aggQty": 1,
   "doNotShowFlag": false,
   "chkEmpNum": 69405,
   "transEmpNum": 69405,
   "mgrEmpNum": null,
   "rsnCodeNum": null,
   "svcRndNum": 1,
   "cashierNum": null,
   "dtlOcNum": 2,
   "dtlOtNum": 123,
   "menuItem": {
    "miNum": 3401,
    "comboMealSeq": 1,
    "comboSideSeq": 1,
    "comboGrpNum": 101,
    "modFlag": false,
    "modPrfx": 1,
    "inclTax": 0,
    "returnFlag": false,
    "activeTaxes": {1},
    "prcLvl": 1
    }
  },
  {
   "guestCheckLineItemId": 9433353,
   "lineNum": 21,
   "dtlId": 37,
   "parDtlId": 20,
   "detailUTC": "2020-10-20T16:06:06",
   "detailLcl": "2020-10-20T12:06:06",
   "busDt": "2020-10-20",
   "prepCost": 0,
   "vdFlag": false,
   "errCorFlag": false,
   "wsNum": 5,
   "refInfo1": "SV012003621910405",
   "refInfo2": null,
   "dspTtl": -2.19,
   "dspQty": 1,
   "aggTtl": -2.19,
   "aggQty": 0,
   "doNotShowFlag": true,
   "chkEmpNum": 69405,
   "transEmpNum": 69405,
   "mgrEmpNum": null,
   "rsnCodeNum": null,
   "svcRndNum": 4,
   "cashierNum": null,
   "dtlOtNum": 123,
   "discount": {
    "dscNum": 210,
    "dscMiNum": 1509,
    "mealEmpNum": null,
    "vatTaxTtl": 0,
    "inclTax": 123.456789,
    "activeTaxes": "1,2,5"
   }
  },
  {
   "guestCheckLineItemId": 9433400,
   "lineNum": 3,
   "dtlId": 0,
   "parDtlId": 0,
   "detailUTC": "2020-10-20T16:20:45",
   "detailLcl": "2020-10-20T12:20:45",
   "busDt": "2020-10-20",
   "prepCost": 0,
   "vdFlag": false,
   "errCorFlag": false,
   "wsNum": 5,
   "refInfo1": null,
   "refInfo2": null,
   "dspTtl": 3.5,
   "dspQty": 1,
   "aggTtl": 3.5,
   "aggQty": 1,
   "doNotShowFlag": false,
   "chkEmpNum": 69405,
   "transEmpNum": 69405,
   "mgrEmpNum": null,
   "rsnCodeNum": null,
   "svcRndNum": 6,
   "cashierNum": null,
   "dtlOtNum": 123,
   "serviceCharge": {
    "svcChgNum": 101,
    "inclTax": 123.456789,
    "activeTaxes": "1,2,5"
   }
  },
  {
   "guestCheckLineItemId": 9433401,
   "lineNum": 4,
   "dtlId": 0,
   "parDtlId": 0,
   "detailUTC": "2020-10-20T16:20:45",
   "detailLcl": "2020-10-20T12:20:45",
   "busDt": "2020-10-20",
   "prepCost": 0,
   "vdFlag": false,
   "errCorFlag": false,
   "wsNum": 5,
   "refInfo1": "XXXXXXXXXXX6008",
   "refInfo2": null,
   "dspTtl": 3.5,
   "dspQty": 1,
   "aggTtl": 3.5,
   "aggQty": 1,
   "doNotShowFlag": true,
   "chkEmpNum": 69405,
   "transEmpNum": 69405,
   "mgrEmpNum": null,
   "rsnCodeNum": null,
   "svcRndNum": 6,
   "cashierNum": null,
   "dtlOtNum": 123,
   "tenderMedia": {
    "tmedNum": 503,
    "mealEmpNum": 258
   }
  },
  {
   "guestCheckLineItemId": 9433402,
   "lineNum": 39,
   "dtlId": 55,
   "parDtlId": 0,
   "detailUTC": "2011-01-17T16:20:45",
   "detailLcl": "2011-01-17T12:20:45",
   "busDt": "2011-01-17",
   "prepCost": 0,
   "vdFlag": false,
   "errCorFlag": false,
   "wsNum": 5,
   "refInfo1": "XXXXXXXXXXX6008",
   "refInfo2": null,
   "dspTtl": 0,
   "dspQty": 0,
   "aggTtl": 20.99,
   "aggQty": 0,
   "doNotShowFlag": false,
   "chkEmpNum": 69405,
   "transEmpNum": 69405,
   "mgrEmpNum": null,
   "rsnCodeNum": null,
   "svcRndNum": 6,
   "cashierNum": null,
   "dtlOtNum": 123,
   "other": {
    "detailType": 6,
    "detailNum": 53415
   }
  },
  {
   "guestCheckLineItemId": 9433409,
   "lineNum": 40,
   "dtlId": 56,
   "parDtlId": 0,
   "detailUTC": "2011-01-17T16:20:45",
   "detailLcl": "2011-01-17T12:20:45",
   "busDt": "2011-01-17",
   "prepCost": 0,
   "vdFlag": false,
   "errCorFlag": false,
   "wsNum": 5,
   "refInfo1": "XXXXXXXXXXX6008",
   "refInfo2": null,
   "dspTtl": 0,
   "dspQty": 0,
   "aggTtl": 20.99,
   "aggQty": 0,
   "doNotShowFlag": false,
   "chkEmpNum": 69405,
   "transEmpNum": 69405,
   "mgrEmpNum": null,
   "rsnCodeNum": null,
   "svcRndNum": 6,
   "cashierNum": null,
   "dtlOtNum": 123,
   "errorCorrect": {
    "type": 1,
    "objectNum": 123
   }
  }]
 }]
}

Back to Top