Jump to

• Request
• Response
• Examples

Get printed check

get

{basePath}/checks/{checkRef}/printed

{basePath}/checks/929aacee2c6d42c78ae877e824c28eed00000431/printed

API returns an array of strings containing text suitable for printing on a 40-column printer.

Request

Supported Media Types

• application/json

Path Parameters

• checkRef: string
  Check identifier

Header Parameters

• Accept-Language(optional): string
  The Accept Language header identifies the language that is desired for the response.
• Simphony-LocRef: string
  The location identifier.
• Simphony-OrgShortName: string
  The organization identifier.
• Simphony-RvcRef: integer
  The revenue center identifier.

Back to Top

Response

Supported Media Types

• application/json

200 Response

An array of lines representing the printed output.

Body ()

Root Schema : CheckPrintedLinesItem

Type: object

Response contains an items object..

Show Source

• items: array items
  Response contains an Array of Strings formatted for printing.

{
    "description":"Response contains an items object..",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"Response contains an Array of Strings formatted for printing.\n",
            "type":"array",
            "example":[
                "12 STS                            Page 2",
                "----------------------------------------",
                "CHK 75                           TBL 2/1",
                "               11/3/2020                ",
                "----------------------------------------",
                "       DineIn                           ",
                " 1 Carrot Soup               10.00      ",
                " 1 Beetroot Roll             120.00     ",
                "   *SPECIAL REQUESTS*                   ",
                "   Please include extra sauce on side   ",
                " 1 Potato Tower              10.00      ",
                "   STS Open $ SC              1.23      ",
                " 1 Potato Tower              10.00      ",
                "   CashAuto                $151.23      ",
                "   Subtotal                $150.00      ",
                "   Other                     $1.23      ",
                "   Payment                 $151.23      ",
                "   Change Due                $0.00      ",
                "  ----------- Check Closed -----------  ",
                "           11/3/2020 5:02 PM            "
            ]
        }
    }
}

Nested Schema : items

Type: array

Response contains an Array of Strings formatted for printing.

Example:

[
    "12 STS                            Page 2",
    "----------------------------------------",
    "CHK 75                           TBL 2/1",
    "               11/3/2020                ",
    "----------------------------------------",
    "       DineIn                           ",
    " 1 Carrot Soup               10.00      ",
    " 1 Beetroot Roll             120.00     ",
    "   *SPECIAL REQUESTS*                   ",
    "   Please include extra sauce on side   ",
    " 1 Potato Tower              10.00      ",
    "   STS Open $ SC              1.23      ",
    " 1 Potato Tower              10.00      ",
    "   CashAuto                $151.23      ",
    "   Subtotal                $150.00      ",
    "   Other                     $1.23      ",
    "   Payment                 $151.23      ",
    "   Change Due                $0.00      ",
    "  ----------- Check Closed -----------  ",
    "           11/3/2020 5:02 PM            "
]

400 Response

400 Bad Request

Body ()

Root Schema : ChecksApiProblemDetails

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). **Extensions** * posDetails

Show Source

• details(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: The Check provided is not valid.
• instance(optional): string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  Example: error:check_validation_failure
• posDetails(optional): array posDetails
  (Problem Details Extension) Contains a list of the problem details from the POS System processing the request.
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: Check is invalid.
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: error:validation

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). \n\n  **Extensions**\n  * posDetails\n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Check is invalid.",
        "details":"The Check provided is not valid.",
        "instance":"error:check_validation_failure",
        "posDetails":[
            {
                "code":"menu_item_invalid",
                "message":"invalid 'definitionSequence' value for menuItem '123'"
            }
        ]
    },
    "properties":{
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"Check is invalid."
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"The Check provided is not valid."
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "type":"string",
            "example":"error:check_validation_failure"
        },
        "posDetails":{
            "description":"(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "code":{
                        "description":"Short, unique identifier for the type of error",
                        "type":"string",
                        "example":"menu_item_invalid"
                    },
                    "message":{
                        "description":"A human-readable explanation specific to this occurrence of the problem.",
                        "type":"string",
                        "example":"invalid 'definitionSequence' value for menuItem '123'"
                    }
                }
            }
        }
    }
}

Example:

{
    "type":"error:validation",
    "title":"Check is invalid.",
    "details":"The Check provided is not valid.",
    "instance":"error:check_validation_failure",
    "posDetails":[
        {
            "code":"menu_item_invalid",
            "message":"invalid 'definitionSequence' value for menuItem '123'"
        }
    ]
}

Nested Schema : posDetails

Type: array

(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.

Show Source

• Array of: object items

{
    "description":"(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "code":{
                "description":"Short, unique identifier for the type of error",
                "type":"string",
                "example":"menu_item_invalid"
            },
            "message":{
                "description":"A human-readable explanation specific to this occurrence of the problem.",
                "type":"string",
                "example":"invalid 'definitionSequence' value for menuItem '123'"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(optional): string
  Short, unique identifier for the type of error

  Example: menu_item_invalid
• message(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: invalid 'definitionSequence' value for menuItem '123'

{
    "type":"object",
    "properties":{
        "code":{
            "description":"Short, unique identifier for the type of error",
            "type":"string",
            "example":"menu_item_invalid"
        },
        "message":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"invalid 'definitionSequence' value for menuItem '123'"
        }
    }
}

404 Response

404 Requested resource not found

521 Response

521 Service Timeout

Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

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

{
  "items": [
    "12 STS                            Page 2",
    "----------------------------------------",
    "CHK 75                           TBL 2/1",
    "               11/3/2020                ",
    "----------------------------------------",
    "       DineIn                           ",
    " 1 Carrot Soup               10.00      ",
    " 1 Beetroot Roll             120.00     ",
    "   *SPECIAL REQUESTS*                   ",
    "   Please include extra sauce on side   ",
    " 1 Potato Tower              10.00      ",
    "   STS Open $ SC              1.23      ",
    " 1 Potato Tower              10.00      ",
    "   CashAuto                $151.23      ",
    "   Subtotal                $150.00      ",
    "   Other                     $1.23      ",
    "   Payment                 $151.23      ",
    "   Change Due                $0.00      ",
    "  ----------- Check Closed -----------  ",
    "           11/3/2020 5:02 PM            "
  ]
}

Back to Top