zReports

zReports integrates stock control and accounting with data from your restaurant/bar POS system. You can upload data and receive notifications about activity in your account.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name	Summary
GetStores ()	Get list of stores
DeleteHook (string brandId, string hookId)	Deletes specified hook
UploadDocument (string brandId, string storeId, file document)	Upload delivery or invoice document

 

Triggers:

Name	Summary
NewDispatchAdvice (string brandId, NewDispatchAdviceParameterBody body)	When a despatch advice is received
NewInvoice (string brandId, NewInvoiceParameterBody body)	When an invoice is received

 

Objects:

Name	Summary
CreateWebhookResponseBody
file	Document
GetStoresResponseItem
NewDispatchAdviceParameterBody
NewInvoiceParameterBody

 

Actions:

GetStores

Summary: Get list of stores

Description: Get list of stores that one can upload documents to and receive EDI notifications for.

 

Syntax:

 

Returns:

          Type:array of (GetStoresResponseItem)

 

DeleteHook

Summary: Deletes specified hook

Description: Deletes specified hook.

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
brandId	string (Brand ID)	The brand identifier.	True
hookId	string (Hook ID)	The hook identifier.	True

 

Returns:

 

UploadDocument

Summary: Upload delivery or invoice document

Description: Upload delivery or invoice document.

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
brandId	string (Brand ID)	The brand identifier.	True
storeId	string (Store ID)	The store identifier.	True
document	file (Document)	The document to be uploaded.	True

 

Returns:

 

Triggers:

Trigger NewDispatchAdvice

Summary: When a despatch advice is received

Description: When an EDI despatch advice document is received by zReports this notification is triggered.

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
brandId	string (Brand ID)	The brand identifier.	True
body	NewDispatchAdviceParameterBody		True

 

Returns:

          Type:CreateWebhookResponseBody

 

Trigger NewInvoice

Summary: When an invoice is received

Description: When an EDI invoice document is received by zReports this notification is triggered.

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
brandId	string (Brand ID)	The brand identifier.	True
body	NewInvoiceParameterBody		True

 

Returns:

          Type:CreateWebhookResponseBody

 

 

CreateWebhookResponseBody

Summary:

Description:

 

          Properties:

Name	Type	Summary
event	string
id	string
url	string	The delete hook URL.

 

file

Summary: Document

Description: The document to be uploaded.

 

          Properties:

Name

Type

Summary

 

GetStoresResponseItem

Summary:

Description:

 

          Properties:

Name	Type	Summary
brandId	string	brandId
name	string	name
storeId	string	storeId

 

NewDispatchAdviceParameterBody

Summary:

Description:

 

          Properties:

Name	Type	Summary
storeIds	string	The optional list of 3-digit store identifiers.
url	string	The URL to which payloads will be delivered.

 

NewInvoiceParameterBody

Summary:

Description:

 

          Properties:

Name	Type	Summary
storeIds	string	The optional list of 3-digit store identifiers.
url	string	The URL to which payloads will be delivered.