Webhook
These are the endpoints that are available under the /reports path, which lists all the different reports you have available on your business' reports page.
Endpoint | Description |
---|---|
GET /reports/category | Returns all reports category objects on an account in array format. |
POST /report/print/file |
Data points passed on in the request URL portion of the API call that are used to filter the data being requested.
Parameter | Type | Endpoints to be used with | Description |
---|---|---|---|
attach | POST /report/print/file | ||
endDate | string | POST /report/print/file | Should be set as the end date of the report to be returned following a GET report call, formatted as YYYY-MM-DD. |
format | string | POST /report/print/file | Should be set as the format of the report to be returned. |
locationId | integer | POST /report/print/file | Should be set as the ID of the location of the report to be returned. |
startDate | string | POST /report/print/file | Should be set as the start date of the report to be returned following a GET report call, formatted as YYYY-MM-DD. |
Property name | Type | Description |
---|---|---|
active | boolean | Indicates whether or not the specified report is active. |
businessId | integer | Provides the unique numeric ID for the business that the specified report belongs to. |
category | string | Displays as the category of the specified report. |
createdDate | integer | Displays as the date the specified report was created, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. |
createdUser | string | Displays the username of the user who created the specified report. |
modifiedDate | integer | Displays as the date the specified report was last modified, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. |
modifiedUser | string | Displays the username of the user who last modified the specified report. |
planIds | integer | |
reportFileName | string | Displays as the file name of the specified report. |
reportId | integer | Provides the unique numeric ID for the specified report. |
reportName | string | Displays as the name of the specified report. |
reportType | string | Displays as the type of the specified report. |
resellerIds | integer | |
securityFunctions | string | Displays the names of the security role functions required for a staff to be able to access the specified report. |