Paid In/Outs

GET /locations/:locationId/paid-in-outs

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/paid-in-outs?createdAtStart=&createdAtEnd=

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//paid-in-outs?createdAtStart=&createdAtEnd=' \
--header 'x-api-key;'

Retrieves all paid in/outs within the specified date/time range for the supplied location.

Only paid in/outs that were created within the last 90 days (approximately) are available.
The duration of the date range cannot exceed 7 days.
createdAtStart is inclusive and createdAtEnd is exclusive.
createdAtEnd must be 5 or more minutes in the past. This delay is imposed to ensure that updates to orders are not "missed" due to internal database replication lag.

A Note On Paid In/Outs Retrieval

The POS currently does not track the last updated date for paid in/outs (we only have the created date/time). This means that the API Consumer will have to periodically pull paid/in outs for the last 3 days or so to ensure that voids are captured.

Also note that, as with orders, a 5 minute “lag” is imposed to account for secondary database server replication delays. See documentation for the “Orders” endpoint for more detailed information on this topic.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of paid in/out objects. Each object in the array will be structured as follows:

Field Name	Field Type	Field Description	Org Level Attribute*
id	string	The unique ID for the paid in/out.
locationId	string	The unique ID for the location.
deleted	boolean	True if the paid in/out has been marked as deleted.
voided	boolean	True if the paid in/out has been voided.
paymentOptionId	string	The unique ID of the payment option that was used for the paid in/out.	Yes
amount	string	The amount (in US dollars) of the paid in/out as a decimal number string. For example, $5.20 will be represented as "5.2".
employeeId	string	The unique ID of the employee who made the paid in/out.	Yes
employeeName	string	The full name of the employee who made the paid in/out.	Yes
createdAt	string	The RFC 3339 formatted date/time that the paid in/out was created.
kind	string	"IN" if a paid in. "OUT" if a paid out.
reason	string	The predefined reason selected by the POS operator who made the paid in/out.	Yes
notes	string	Notes supplied by the POS operator who made the paid in/out.

📘
*Note that the values of fields marked as "Org Level Attribute" are shared amongst all locations that reside in the same POS organization.

Example Response

[
    {
        "id": "abc123",
        "locationId": "LocationX",
        "deleted": false,
        "voided": false,
        "paymentOptionId": "abc1234",
        "amount": "5.2",
        "employeeId": "abc12345",
        "employeeName": "Sandy  Smith",
        "createdAt": "2020-01-31T11:15:42Z",
        "kind": "IN",
        "reason": "Cash Low",        
        "notes": "Low on cash"
    }
]

Headers
x-api-key	Your API Key

Params
createdAtStart	Inclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the start of the date/time range. The duration of the date/time range cannot exceed 7 days. Paid In/outs that were created during the specified date/time range will be returned.
createdAtEnd	Exclusive. An RFC 3339 formatted date/time string (w/o milliseconds) for the end of the date/time range.

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/paid-in-outs/:paidInOutId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/paid-in-outs/:paidInOutId

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//paid-in-outs/' \
--header 'x-api-key;'

Retrieves a single paid in/out for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single JSON paid in/out object. See the parent route's documentation for more details.

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location
paidInOutId	The unique ID for the paid in/out