Reporting Category

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Endpoints

GET /reporting-category/master

Summary

Gets a master list of reporting category entities regardless of the site.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
query	`$top`	integer	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100.
query	`$skip`	integer	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$filter`	string	No	A filter expression in OData v4 format
query	`$orderby`	string	No	An order by expression in OData v4 format
query	`include_nested`	boolean	No	Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)
query	`include_mappings`	boolean	No	Include the mappings for the document in the response
query	`include_entities`	[ string ]	No	Specifies `entity_types` to be populated by nesting mechanism (For example, `include_entities`=['menu-category'] for menu call - populate a menu with menu categories)
query	`include_inactive`	boolean	No	Includes the documents that are inactive for the current sites

Responses

Code	Description	Schema
200	Success	reporting_category_list
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

GET /reporting-category/current

Summary

Gets a list of currently effective active reporting category entities for the specified sites as of the given effective_date:

effective_date=2099-11-18T19:04:58.124Z

To narrow the list to specific entity_ids:

?effective_date=2099-11-18T19:04:58.124Z&entity_ids=['578e98111fa261f4867bdf12','231e98111fa261f4867bdf08']

To include the audit fields:

?include_audit=true

To include the inactive documents:

?include_inactive=true

To populate nested entities:

?include_nested=true

To populate only specified nested entities:

?include_entities="menu-category","menu-item-group"

Other filters can be applied against the entity documents by using the $filter parameter

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
header	`X-SITE-IDs`	[ string ]	No	The unique identifiers (UIDs) of the site to manage data for
query	`$filter`	string	No	A filter expression in OData v4 format
query	`$top`	integer	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100.
query	`$skip`	integer	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$orderby`	string	No	An order by expression in OData v4 format
query	`effective_date`	string	Yes	The date and time to query against. If the entity is updated on a specific date, then specifying an `effective_date` prior to that date returns a previous version of the entity.
query	`entity_ids`	[ string ]	No	An array of entity identifiers
query	`include_nested`	boolean	No	Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)
query	`include_mappings`	boolean	No	Include the mappings for the document in the response
query	`include_mappings_for_entities`	[ string ]	No	Specifies entity types for which mappings are presented as a part of the response (For example, `include_mappings_for_entities_param`='product','product-price', etc).
query	`include_entities`	[ string ]	No	Specifies `entity_types` to be populated by nesting mechanism (For example, `include_entities`=['menu-category'] for menu call - populate a menu with menu categories)
query	`include_audit`	boolean	No	Adds audit fields to each document when returning a result (`is_active, is_master, created_at, created_by, updated_at, updated_by`)
query	`include_inactive`	boolean	No	Includes the documents that are inactive for the current sites

Responses

Code	Description	Schema
200	Success	reporting_category_list
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

GET /reporting-category/list

Summary

Gets a list of currently effective active reporting category entities for the specified sites as of the given effective_date:

effective_date=2099-11-18T19:04:58.124Z

To narrow the list to specific entity_ids:

?effective_date=2099-11-18T19:04:58.124Z&entity_ids=['578e98111fa261f4867bdf12','231e98111fa261f4867bdf08']

To include the audit fields:

?include_audit=true

To include the inactive documents:

?include_inactive=true

To populate nested entities:

?include_nested=true

To populate only specified nested entities:

?include_entities="menu-category","menu-item-group"

Other filters can be applied against the entity documents by using the $filter parameter

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
header	`X-SITE-IDs`	[ string ]	No	The unique identifiers (UIDs) of the site to manage data for
query	`$filter`	string	No	A filter expression in OData v4 format
query	`$top`	integer	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100.
query	`$skip`	integer	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$orderby`	string	No	An order by expression in OData v4 format
query	`effective_date`	string	Yes	The date and time to query against. If the entity is updated on a specific date, then specifying an effective_date prior to that date returns a previous version of the entity.
query	`entity_ids`	[ string ]	No	An array of entity identifiers
query	`include_nested`	boolean	No	Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)
query	`include_entities`	[ string ]	No	Specifies `entity_types` to be populated by nesting mechanism (For example, `include_entities`=['menu-category'] for menu call - populate a menu with menu categories)
query	`include_audit`	boolean	No	Adds audit fields to each document when returning a result (`is_active, is_master, created_at, created_by, updated_at, updated_by`)
query	`include_inactive`	boolean	No	Includes the documents that are inactive for the current sites
query	`include_mappings_for_entities`	[ string ]	No	Specifies entity types for which mappings are presented as a part of the response (For example, `include_mappings_for_entities_param`='product','product-price', etc).

Responses

Code	Description	Schema
200	Success	reporting_category_list
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

POST /reporting-category

Summary

Adds a new reporting category.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
query	`include_nested`	boolean	No	Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)
query	`include_entities`	[ string ]	No	Specifies `entity_types` to be populated by nesting mechanism (For example, `include_entities`=['menu-category'] for menu call - populate a menu with menu categories)
body	`body`	reporting_category_create	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	reporting_category
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

POST /reporting-category/entity/<entity_id>

Summary

Creates/Updates reporting categories.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
path	`entity_id`	string	Yes	The identifier of the entity
body	`body`	[ reporting_category_create ]	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	[ reporting_category ]
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

DELETE /reporting-category/entity/<entity_id>

Summary

Deletes an entity and all versions of the entity.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
path	`entity_id`	string	Yes	The identifier of the entity

Responses

Code	Description	Schema
200	Success
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

POST /reporting-category/updateEntitiesWithDependencies

Summary

Creates/Updates reporting categories with the mappings.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
header	`X-SITE-IDs`	[ string ]	No	The unique identifiers (UIDs) of the site to manage data for
body	`body`	[ reporting_category_create ]	Yes	Supports the mappings field (array/boolean) for each document. With mappings: True mappings are created for the current date and sites from the `X-SITE-IDs` header.

Responses

Code	Description	Schema
200	Success	reporting_category_list
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

GET /reporting-category/document/<_id>

Summary

Gets one reporting category by a specific document identifier.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
path	`_id`	string	Yes	The identifier of the document
query	`include_nested`	boolean	No	Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)
query	`include_entities`	[ string ]	No	Specifies `entity_types` to be populated by nesting mechanism (For example, `include_entities`=['menu-category'] for menu call - populate a menu with menu categories)
query	`include_mappings_for_entities`	[ string ]	No	Specifies entity types for which mappings are presented as a part of the response (For example, `include_mappings_for_entities_param`='product','product-price', etc).

Responses

Code	Description	Schema
200	Success	reporting_category
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

PATCH /reporting-category/document/<_id>

Summary

Partially updates a reporting category.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
path	`_id`	string	Yes	The identifier of the document
query	`include_nested`	boolean	No	Hydrates-related nested objects when returning a result (For example, populate a menu with menu categories and menu groups)
query	`include_entities`	[ string ]	No	Specifies `entity_types` to be populated by nesting mechanism (For example, `include_entities`=['menu-category'] for menu call - populate a menu with menu categories)
body	body	reporting_category_edit	No	The JSON of the category being patched

Responses

Code	Description	Schema
200	Success	reporting_category_edit
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

DELETE /reporting-category/document/<_id>

Summary

Deletes a reporting category.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
path	`_id`	string	Yes	The identifier of the document

Responses

Code	Description	Schema
200	Success
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

POST /reporting-category/documents/dependencies

Summary

Checks for document dependencies.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
body	body	[ reporting_category ]	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	reporting_category_list
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

GET /reporting-category/mapping/entity/<entity_id>

Summary

Gets a list of reporting category mappings for specified sites.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
header	`X-SITE-IDs`	[ string ]	No	The unique identifiers (UIDs) of the site to manage data for
path	`entity_id`	string	Yes	The identifier of the entity
query	`$top`	integer	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100.
query	`$skip`	integer	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$filter`	string	No	A filter expression in OData v4 format
query	`$orderby`	string	No	An order by expression in OData v4 format
query	`include_inactive`	boolean	No	Includes the documents that are inactive for the current sites

Responses

Code	Description	Schema
200	Success	mapping_list_response
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

POST /reporting-category/mapping/entity/<entity_id>

Summary

Creates the list of reporting category mappings for an entity and sites.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
header	`X-SITE-IDs`	[ string ]	No	The unique identifiers (UIDs) of the site to manage data for
path	`entity_id`	string	Yes	The identifier of the entity
body	`body`	mappings_update_request	Yes	The array of the inventory item venue mappings being added

Responses

Code	Description	Schema
200	Success	mapping_list_response
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

POST /reporting-category/mapping

Summary

Adds a new reporting category mapping.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier of the company to manage data for
body	`body`	[ mapping_create_request ]	Yes	The JSON of the reporting category mapping being added

Responses

Code	Description	Schema
200	Success	mapping_list_response
400	Bad request, for more information look at body error
403	Invalid token
404	Not Found
422	Unprocessable error
default	Unexpected Error

Data Models

reporting_category

reporting_category_create

reporting_category_edit

reporting_category_list