Get printed check
get
/api/v1/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.
Response
Supported Media Types
- application/json
200 Response
An array of lines representing the printed output.
Root Schema : printedLines
Type:
object
Response contains printed lines object.
Show Source
-
lines(required):
array lines
Response contains an array of strings formatted for printing.
Nested Schema : lines
Type:
array
Response contains an array of strings formatted for printing.
Show Source
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
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.
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
Nested Schema : items
Type:
Show Source
object
-
code:
string
Short, unique identifier for the type of errorExample:
check_not_found
521 Response
521 Service Timeout
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:
"printedlines": {
"lines": [
"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 "
]
}