Sales | Sales Account

The Sales Account Profile Determination endpoint is used to discover the sales account in the company chart of account.

Overview

api/{tenantKey}/{orgKey}/salesCore/salesAccountDeterminations

URL	api/{tenantKey}/{orgKey}/salesCore/salesAccountDeterminations
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST SalesAccountDeterminations
- POST Sales Account
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiSalesAccountDeterminationResource
ApiSalesAccountDeterminationSalesGLAccountsResource
SalesAccountDeterminationResource
SalesGLAccountResource

GET Operations

GET SalesAccountDeterminations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salesAccountDeterminations

GET /salesCore/salesAccountDeterminations

GET SalesAccountDeterminations (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 SalesAccountDeterminationResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salesAccountDeterminations?page={page}&pageSize={pageSize}

GET /salesCore/salesAccountDeterminations?page={page}&pageSize={pageSize}

GET SalesAccountDetermination 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 SalesAccountDeterminationResource.

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}/salesCore/salesAccountDeterminations/{id}

GET /salesCore/salesAccountDeterminations/{id}

GET SalesAccountDetermination by key

Returns the entity record that matches the specified key.

The following elements are required:

salesAccountDeterminationKey

(string) The sales account determination key.

Response:

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

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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}

GET /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}

GET Print SalesAccountDetermination 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}/salesCore/salesAccountDeterminations/{id}/print?template={template}

GET /salesCore/salesAccountDeterminations/{id}/print?template={template}

GET Print SalesAccountDetermination by key

Prints the specified entity record.

The following elements are required:

salesAccountDeterminationKey

(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/print

GET /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/print

GET Original Print SalesAccountDeterminationOriginal 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}/salesCore/salesAccountDeterminations/{id}/printOriginal?template={template}

GET /salesCore/salesAccountDeterminations/{id}/printOriginal?template={template}

GET Original Print SalesAccountDetermination by key

Prints the specified entity record.

The following elements are required:

salesAccountDeterminationKey

(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/printOriginal

GET /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/printOriginal

POST Operations

POST SalesAccountDeterminations

Creates a new entity record.

The following elements are required:

salesAccountDeterminationResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salesAccountDeterminations

POST /salesCore/salesAccountDeterminations

POST Sales Account

Inserts a new 'Sales GL Account' in the 'Sales Account'.

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination key.
value	(ApiSalesAccountDeterminationSalesGLAccountsResource) The ApiSalesAccountDeterminationSalesGLAccountsResource instance. See ApiSalesAccountDeterminationSalesGLAccountsResource.

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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts

POST /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts

PUT Operations

PUT Set ChartOfAccount SalesGLAccount

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/chartOfAccount

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/chartOfAccount

PUT Set Description SalesAccountDetermination

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/description

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/description

PUT Set DiscountAccount SalesGLAccount

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/discountAccount

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/discountAccount

PUT Set IsActive SalesAccountDetermination

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/isActive

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/isActive

PUT Set ItemAccountType SalesGLAccount

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/itemAccountType

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/itemAccountType

PUT Set ItemTaxSchema SalesGLAccount

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/itemTaxSchema

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/itemTaxSchema

PUT Set PartyTaxSchema SalesGLAccount

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/partyTaxSchema

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/partyTaxSchema

PUT Set SalesAccount SalesGLAccount

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/salesAccount

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}/salesAccount

PUT Set SalesAccountDeterminationKey SalesAccountDetermination

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

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesAccountDeterminationKey

PUT /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesAccountDeterminationKey

DELETE Operations

DELETE Sales GL Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

salesAccountDeterminationKey	(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}

DELETE /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}/salesGLAccounts/{lineId}

DELETE SalesAccountDetermination 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}/salesCore/salesAccountDeterminations/{id}

DELETE /salesCore/salesAccountDeterminations/{id}

DELETE SalesAccountDetermination by key

Deletes the entity record that matches the specified key.

The following elements are required:

salesAccountDeterminationKey

(string) The sales account determination 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}/salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}

DELETE /salesCore/salesAccountDeterminations/{salesAccountDeterminationKey}

Resources

ApiSalesAccountDeterminationResource

The following elements are required:

salesAccountDeterminationKey

(string) The sales account determination key.

The following elements are optional:

description	(string) The description of the sales account determination.
salesGLAccounts	(List of ApiSalesAccountDeterminationSalesGLAccountsResource) The list of GL accounts. See ApiSalesAccountDeterminationSalesGLAccountsResource.

ApiSalesAccountDeterminationSalesGLAccountsResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
itemAccountType	(string) The item account type.
salesAccount	(string) The sales GL account for the item tax schema and party tax schema and item account type.

The following elements are optional:

itemTaxSchema	(string) The item tax schema.
partyTaxSchema	(string) The party tax schema.
discountAccount	(string) The discount GL account for the item tax schema and party tax schema and item account type.

SalesAccountDeterminationResource

The following elements are required:

salesAccountDeterminationKey

(string) The sales account determination key.

The following elements are optional:

description	(string) The description of the sales account determination.
salesGLAccounts	(List of SalesGLAccountResource) The list of GL accounts. See SalesGLAccountResource.

SalesGLAccountResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
itemAccountType	(string) The item account type.
salesAccount	(string) The sales GL account for the item tax schema and party tax schema and item account type.

The following elements are optional:

itemTaxSchema	(string) The item tax schema.
partyTaxSchema	(string) The party tax schema.
discountAccount	(string) The discount GL account for the item tax schema and party tax schema and item account type.