Sales | Customer Posting Profile

The Customer Posting Profile represents a way to discover the customer account in the company chart of account.

Overview

api/{tenantKey}/{orgKey}/salesCore/customerPostingProfiles

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

All Operations

This service includes the following operations:

GET:
POST:
- POST CustomerPostingProfiles
- POST Customer Posting Profile
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiCustomerPostingProfileCustomerPostProfileAccountsResource
ApiCustomerPostingProfileResource
CustomerPostingProfileResource
CustomerPostProfileAccountResource

GET Operations

GET CustomerPostingProfiles

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerPostingProfiles

GET /salesCore/customerPostingProfiles

GET CustomerPostingProfiles (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 CustomerPostingProfileResource.

Response status codes:

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

Resource URL:

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

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

GET CustomerPostingProfile 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 CustomerPostingProfileResource.

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

GET /salesCore/customerPostingProfiles/{id}

GET CustomerPostingProfile by key

Returns the entity record that matches the specified key.

The following elements are required:

postingCustomerProfileKey

(string) The posting profile key.

Response:

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

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/customerPostingProfiles/{postingCustomerProfileKey}

GET /salesCore/customerPostingProfiles/{postingCustomerProfileKey}

GET Print CustomerPostingProfile 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/customerPostingProfiles/{id}/print?template={template}

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

GET Print CustomerPostingProfile by key

Prints the specified entity record.

The following elements are required:

postingCustomerProfileKey

(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/print

GET /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/print

GET Original Print CustomerPostingProfileOriginal 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/customerPostingProfiles/{id}/printOriginal?template={template}

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

GET Original Print CustomerPostingProfile by key

Prints the specified entity record.

The following elements are required:

postingCustomerProfileKey

(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/printOriginal

GET /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/printOriginal

POST Operations

POST CustomerPostingProfiles

Creates a new entity record.

The following elements are required:

customerPostingProfileResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerPostingProfiles

POST /salesCore/customerPostingProfiles

POST Customer Posting Profile

Inserts a new 'Customer Post. Profile Account' in the 'Customer Posting Profile'.

The following elements are required:

postingCustomerProfileKey	(string) The posting profile key.
value	(ApiCustomerPostingProfileCustomerPostProfileAccountsResource) The ApiCustomerPostingProfileCustomerPostProfileAccountsResource instance. See ApiCustomerPostingProfileCustomerPostProfileAccountsResource.

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/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts

POST /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts

PUT Operations

PUT Set ChartOfAccount CustomerPostProfileAccount

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

The following elements are required:

postingCustomerProfileKey	(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}/chartOfAccount

PUT /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}/chartOfAccount

PUT Set Description CustomerPostingProfile

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

The following elements are required:

postingCustomerProfileKey	(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/description

PUT /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/description

PUT Set GlAccount CustomerPostProfileAccount

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

The following elements are required:

postingCustomerProfileKey	(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}/glAccount

PUT /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}/glAccount

PUT Set IsActive CustomerPostingProfile

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

The following elements are required:

postingCustomerProfileKey	(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/isActive

PUT /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/isActive

PUT Set PartyAccountType CustomerPostProfileAccount

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

The following elements are required:

postingCustomerProfileKey	(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}/partyAccountType

PUT /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}/partyAccountType

PUT Set PartyTaxSchema CustomerPostProfileAccount

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

The following elements are required:

postingCustomerProfileKey	(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}/partyTaxSchema

PUT /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}/partyTaxSchema

PUT Set PostingCustomerProfileKey CustomerPostingProfile

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

The following elements are required:

postingCustomerProfileKey	(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/postingCustomerProfileKey

PUT /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/postingCustomerProfileKey

DELETE Operations

DELETE Customer Post. Profile Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

postingCustomerProfileKey	(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}

DELETE /salesCore/customerPostingProfiles/{postingCustomerProfileKey}/customerPostProfileAccounts/{lineId}

DELETE CustomerPostingProfile 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/customerPostingProfiles/{id}

DELETE /salesCore/customerPostingProfiles/{id}

DELETE CustomerPostingProfile by key

Deletes the entity record that matches the specified key.

The following elements are required:

postingCustomerProfileKey

(string) The posting profile 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/customerPostingProfiles/{postingCustomerProfileKey}

DELETE /salesCore/customerPostingProfiles/{postingCustomerProfileKey}

Resources

ApiCustomerPostingProfileCustomerPostProfileAccountsResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
glAccount	(string) The GL account assigned to the party account type and party tax schema.
partyAccountType	(string) The party account type.

The following elements are optional:

partyTaxSchema

(string) The party tax schema (optional).

ApiCustomerPostingProfileResource

The following elements are required:

postingCustomerProfileKey

(string) The posting profile key.

The following elements are optional:

description	(string) The description of the posting profile.
customerPostProfileAccounts	(List of ApiCustomerPostingProfileCustomerPostProfileAccountsResource) The list of customer posting profile accounts. See ApiCustomerPostingProfileCustomerPostProfileAccountsResource.

CustomerPostingProfileResource

The following elements are required:

postingCustomerProfileKey

(string) The posting profile key.

The following elements are optional:

description	(string) The description of the posting profile.
customerPostProfileAccounts	(List of CustomerPostProfileAccountResource) The list of customer posting profile accounts. See CustomerPostProfileAccountResource.

CustomerPostProfileAccountResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
glAccount	(string) The GL account assigned to the party account type and party tax schema.
partyAccountType	(string) The party account type.

The following elements are optional:

partyTaxSchema

(string) The party tax schema (optional).