Skip to main content

Request Formats

Request formats for the following methods:

AddTlogs (Sales)

The AddTologs method attaches additional data rows to the previously existing data.

{ "api_version":"2.00", "provider":"PROVIDER", "password":"PASSWORD", ”method":"addTlogs", "params":{ "restaurant_id":"SITE_NUMBER", "tlogs":[TLOG DATA, TLOG DATA, ...] } }

Note: only send items within closed checks.

ModifyTlogs (Sales)

The ModifyTlogs method compares and updates previously existing data.

Chef fetches data from the JSON file, starting with the first transaction. Then, Chef compares the JSON file with the data that already exists in the Chef saved transactions database. Chef updates the data to match the JSON file based on the property, sale_id where one of the following occurs:

  • When data exists in both the JSON file and the Chef saved transactions database, data is updated (if necessary) to match the JSON file.

  • When data exists in the Chef saved transaction database, but not in the JSON file, Chef deletes the entry from the Chef saved transaction database.

  • When data exists in the JSON file, but not the Chef saved transactions database, Chef creates an entry to the Chef saved transaction database.

{ "api_version":"2.00", "provider":"PROVIDER", "password":"PASSWORD", ”method":"modifyTlogs", "params":{ "restaurant_id":"SITE_NUMBER", "tlogs":[TLOG DATA, TLOG DATA, ...] } }

Note: only send items within closed checks.

Delete All Sales Within a Business Date

{ "api_version":"2.00", "provider":"PROVIDER", "password":"PASSWORD", ”method":"deleteTlogs", "params":{ "restaurant_id":"RESTAURANT_NUMBER", "date":"DATE" } }

Responses

Request Successful

{ "result":{ "message":"OK" } }

Request Failed

{ "error":{ "error_number":400, "messate":"Message pertaining to error" } }

The result or error objects may contain additional keys/values depending on the request.

See also: