Financials | Posting Category

The Posting Category represents the decoded gl accounts for the account posting of taxes.

Overview

api/{tenantKey}/{orgKey}/financialCore/postingCategories

URL	api/{tenantKey}/{orgKey}/financialCore/postingCategories
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST PostingCategories
- POST Posting Category
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiPostingCategoryPostingCategoryAccountsResource
ApiPostingCategoryResource
PostingCategoryAccountResource
PostingCategoryResource

GET Operations

GET PostingCategories

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/postingCategories

GET /financialCore/postingCategories

GET PostingCategories (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 PostingCategoryResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/postingCategories?page={page}&pageSize={pageSize}

GET /financialCore/postingCategories?page={page}&pageSize={pageSize}

GET PostingCategory 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 PostingCategoryResource.

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}/financialCore/postingCategories/{id}

GET /financialCore/postingCategories/{id}

GET PostingCategory by key

Returns the entity record that matches the specified key.

The following elements are required:

postingCategoryKey

(string) The posting category key.

Response:

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

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}/financialCore/postingCategories/{postingCategoryKey}

GET /financialCore/postingCategories/{postingCategoryKey}

GET Print PostingCategory 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}/financialCore/postingCategories/{id}/print?template={template}

GET /financialCore/postingCategories/{id}/print?template={template}

GET Print PostingCategory by key

Prints the specified entity record.

The following elements are required:

postingCategoryKey

(string) The posting category 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}/financialCore/postingCategories/{postingCategoryKey}/print

GET /financialCore/postingCategories/{postingCategoryKey}/print

GET Original Print PostingCategoryOriginal 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}/financialCore/postingCategories/{id}/printOriginal?template={template}

GET /financialCore/postingCategories/{id}/printOriginal?template={template}

GET Original Print PostingCategory by key

Prints the specified entity record.

The following elements are required:

postingCategoryKey

(string) The posting category 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}/financialCore/postingCategories/{postingCategoryKey}/printOriginal

GET /financialCore/postingCategories/{postingCategoryKey}/printOriginal

POST Operations

POST PostingCategories

Creates a new entity record.

The following elements are required:

postingCategoryResource

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

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 ApiPostingCategoryResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/postingCategories

POST /financialCore/postingCategories

POST Posting Category

Inserts a new 'Posting Category Account' in the 'Posting Category'.

The following elements are required:

postingCategoryKey	(string) The posting category key.
value	(ApiPostingCategoryPostingCategoryAccountsResource) The ApiPostingCategoryPostingCategoryAccountsResource instance. See ApiPostingCategoryPostingCategoryAccountsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts

POST /financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts

PUT Operations

PUT Set ChartOfAccount PostingCategoryAccount

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

The following elements are required:

postingCategoryKey	(string) The posting category key.
lineId	(string) The detail identifier.
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}/financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}/chartOfAccount

PUT /financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}/chartOfAccount

PUT Set Description PostingCategory

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

The following elements are required:

postingCategoryKey	(string) The posting category 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}/financialCore/postingCategories/{postingCategoryKey}/description

PUT /financialCore/postingCategories/{postingCategoryKey}/description

PUT Set FiscalMemoReason PostingCategoryAccount

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

The following elements are required:

postingCategoryKey	(string) The posting category key.
lineId	(string) The detail identifier.
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}/financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}/fiscalMemoReason

PUT /financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}/fiscalMemoReason

PUT Set GlAccount PostingCategoryAccount

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

The following elements are required:

postingCategoryKey	(string) The posting category key.
lineId	(string) The detail identifier.
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}/financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}/glAccount

PUT /financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}/glAccount

PUT Set GlAccountReverseCharge PostingCategoryAccount

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

The following elements are required:

postingCategoryKey	(string) The posting category key.
lineId	(string) The detail identifier.
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}/financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}/glAccountReverseCharge

PUT /financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}/glAccountReverseCharge

PUT Set IsActive PostingCategory

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

The following elements are required:

postingCategoryKey	(string) The posting category 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}/financialCore/postingCategories/{postingCategoryKey}/isActive

PUT /financialCore/postingCategories/{postingCategoryKey}/isActive

PUT Set PostingCategoryKey PostingCategory

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

The following elements are required:

postingCategoryKey	(string) The posting category 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}/financialCore/postingCategories/{postingCategoryKey}/postingCategoryKey

PUT /financialCore/postingCategories/{postingCategoryKey}/postingCategoryKey

DELETE Operations

DELETE Posting Category Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

postingCategoryKey	(string) The posting category key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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}/financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}

DELETE /financialCore/postingCategories/{postingCategoryKey}/postingCategoryAccounts/{lineId}

DELETE PostingCategory 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}/financialCore/postingCategories/{id}

DELETE /financialCore/postingCategories/{id}

DELETE PostingCategory by key

Deletes the entity record that matches the specified key.

The following elements are required:

postingCategoryKey

(string) The posting category 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}/financialCore/postingCategories/{postingCategoryKey}

DELETE /financialCore/postingCategories/{postingCategoryKey}

Resources

ApiPostingCategoryPostingCategoryAccountsResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
glAccount	(string) The tax GL account for the chart of accounts and fiscal memo reason.

The following elements are optional:

glAccountReverseCharge	(string) The general ledger account reversal for the chart of accounts and fiscal memo reason.
fiscalMemoReason	(string) The fiscal memo reason (optional).

ApiPostingCategoryResource

The following elements are required:

postingCategoryKey

(string) The posting category key.

The following elements are optional:

description	(string) The posting category description.
postingCategoryAccounts	(List of ApiPostingCategoryPostingCategoryAccountsResource) The posting category accounts lines. See ApiPostingCategoryPostingCategoryAccountsResource.

PostingCategoryAccountResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
glAccount	(string) The tax GL account for the chart of accounts and fiscal memo reason.

The following elements are optional:

glAccountReverseCharge	(string) The general ledger account reversal for the chart of accounts and fiscal memo reason.
fiscalMemoReason	(string) The fiscal memo reason (optional).

PostingCategoryResource

The following elements are required:

postingCategoryKey

(string) The posting category key.

The following elements are optional:

description	(string) The posting category description.
postingCategoryAccounts	(List of PostingCategoryAccountResource) The posting category accounts lines. See PostingCategoryAccountResource.