Master Data Business Entities | Item Account Type

An Item Account Type represents a classifier used to decode the GL account for a given item.

Overview

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes

URL	api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST ItemAccountTypes
PUT:
DELETE:
- DELETE ItemAccountType by identifier
- DELETE ItemAccountType by key

All Resources

This service uses the following resources:

ApiItemAccountTypeResource
ItemAccountTypeResource

GET Operations

GET ItemAccountTypes

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See ItemAccountTypeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes

GET /businessCore/itemAccountTypes

GET ItemAccountTypes (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See ItemAccountTypeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes?page={page}&pageSize={pageSize}

GET /businessCore/itemAccountTypes?page={page}&pageSize={pageSize}

GET ItemAccountType by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See ItemAccountTypeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{id}

GET /businessCore/itemAccountTypes/{id}

GET ItemAccountType by key

Returns the entity record that matches the specified key.

The following elements are required:

itemAccountTypeKey

(string) The item account type key.

Response:

When successful, the response body contains the entity record. See ItemAccountTypeResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{itemAccountTypeKey}

GET /businessCore/itemAccountTypes/{itemAccountTypeKey}

GET Print ItemAccountType by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{id}/print?template={template}

GET /businessCore/itemAccountTypes/{id}/print?template={template}

GET Print ItemAccountType by key

Prints the specified entity record.

The following elements are required:

itemAccountTypeKey

(string) The item account type key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{itemAccountTypeKey}/print

GET /businessCore/itemAccountTypes/{itemAccountTypeKey}/print

GET Original Print ItemAccountTypeOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{id}/printOriginal?template={template}

GET /businessCore/itemAccountTypes/{id}/printOriginal?template={template}

GET Original Print ItemAccountType by key

Prints the specified entity record.

The following elements are required:

itemAccountTypeKey

(string) The item account type key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{itemAccountTypeKey}/printOriginal

GET /businessCore/itemAccountTypes/{itemAccountTypeKey}/printOriginal

POST Operations

POST ItemAccountTypes

Creates a new entity record.

The following elements are required:

itemAccountTypeResource

(ApiItemAccountTypeResource) The request body should contain the entity record that should be created.
See ApiItemAccountTypeResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiItemAccountTypeResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes

POST /businessCore/itemAccountTypes

PUT Operations

PUT Set Description ItemAccountType

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

itemAccountTypeKey	(string) The item account type key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{itemAccountTypeKey}/description

PUT /businessCore/itemAccountTypes/{itemAccountTypeKey}/description

PUT Set IsActive ItemAccountType

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

itemAccountTypeKey	(string) The item account type key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{itemAccountTypeKey}/isActive

PUT /businessCore/itemAccountTypes/{itemAccountTypeKey}/isActive

PUT Set ItemAccountTypeKey ItemAccountType

Updates the value of attribute 'ItemAccountTypeKey' in the specified entity record.

The following elements are required:

itemAccountTypeKey	(string) The item account type key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{itemAccountTypeKey}/itemAccountTypeKey

PUT /businessCore/itemAccountTypes/{itemAccountTypeKey}/itemAccountTypeKey

DELETE Operations

DELETE ItemAccountType by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{id}

DELETE /businessCore/itemAccountTypes/{id}

DELETE ItemAccountType by key

Deletes the entity record that matches the specified key.

The following elements are required:

itemAccountTypeKey

(string) The item account type key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/itemAccountTypes/{itemAccountTypeKey}

DELETE /businessCore/itemAccountTypes/{itemAccountTypeKey}

Resources

ApiItemAccountTypeResource

The following elements are required:

itemAccountTypeKey

(string) The item account type key.

The following elements are optional:

description

(string) The description of the item account type.

ItemAccountTypeResource

The following elements are required:

itemAccountTypeKey

(string) The item account type key.

The following elements are optional:

description

(string) The description of the item account type.