Jump to

• Request
• Response

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(required): string
  Check identifier

Header Parameters

• Accept-Language: string
  The Accept Language header identifies the language that is desired for the response.
• Simphony-LocRef(required): string
  The location identifier. Will be forced to lower-case.
• Simphony-OrgShortName(required): string
  The organization identifier. Will be forced to lower-case.
• Simphony-RvcRef(required): 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 : checkPrintedLines

Type: object

Response contains printed lines object.

Show Source

• lines(required): array lines
  Response contains an array of strings formatted for printing.

{
    "description":"Response contains printed lines object.",
    "type":"object",
    "required":[
        "lines"
    ],
    "properties":{
        "lines":{
            "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 : lines

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

401 Response

401 Unauthorized

403 Response

403 Forbidden

404 Response

404 Requested resource not found

Body ()

Root Schema : ChecksApiProblemDetailsNotFoundPrinted

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

• detail: string
  A human-readable explanation specific to this occurrence of the problem.

  Example: The POS system is unable to process the request.
• instance: string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  Example: error:pos-error
• posDetails: array posDetails
  (Problem Details Extension) Contains a list of the problem details from the POS System processing the request.
• status: string
  A HTTP response status code.

  Example: 404
• title: string
  A short, human-readable summary of the problem type.

  Example: Check is invalid.

{
    "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":{
        "title":"POS Error",
        "status":404,
        "detail":"The POS system is unable to process the request.",
        "instance":"error:pos-error",
        "posDetails":[
            {
                "code":"check_not_found"
            }
        ]
    },
    "properties":{
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"Check is invalid."
        },
        "status":{
            "description":"A HTTP response status code.",
            "type":"string",
            "example":404
        },
        "detail":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"The POS system is unable to process the request."
        },
        "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:pos-error"
        },
        "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":"check_not_found"
                    }
                }
            }
        }
    }
}

Example:

{
    "title":"POS Error",
    "status":404,
    "detail":"The POS system is unable to process the request.",
    "instance":"error:pos-error",
    "posDetails":[
        {
            "code":"check_not_found"
        }
    ]
}

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

Nested Schema : items

Type: object

Show Source

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

  Example: check_not_found

{
    "type":"object",
    "properties":{
        "code":{
            "description":"Short, unique identifier for the type of error",
            "type":"string",
            "example":"check_not_found"
        }
    }
}

521 Response

521 Service Timeout

Back to Top