Purchases | Supplier Posting Profile

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

Overview

api/{tenantKey}/{orgKey}/purchasesCore/supplierPostingProfiles

URL	api/{tenantKey}/{orgKey}/purchasesCore/supplierPostingProfiles
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST SupplierPostingProfiles
- POST Supplier Posting Profile
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiSupplierPostingProfileResource
ApiSupplierPostingProfileSupplierPostProfileAccountsResource
SupplierPostingProfileResource
SupplierPostProfileAccountResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET SupplierPostingProfiles

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/supplierPostingProfiles

GET /purchasesCore/supplierPostingProfiles

GET SupplierPostingProfiles (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 SupplierPostingProfileResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/supplierPostingProfiles?page={page}&pageSize={pageSize}

GET /purchasesCore/supplierPostingProfiles?page={page}&pageSize={pageSize}

GET SupplierPostingProfile 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 SupplierPostingProfileResource.

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

GET /purchasesCore/supplierPostingProfiles/{id}

GET SupplierPostingProfile by key

Returns the entity record that matches the specified key.

The following elements are required:

postingProfileKey

(string) The posting profile key.

Response:

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

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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}

GET /purchasesCore/supplierPostingProfiles/{postingProfileKey}

GET Print SupplierPostingProfile 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}/purchasesCore/supplierPostingProfiles/{id}/print?template={template}

GET /purchasesCore/supplierPostingProfiles/{id}/print?template={template}

GET Print SupplierPostingProfile by key

Prints the specified entity record.

The following elements are required:

postingProfileKey

(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/print

GET /purchasesCore/supplierPostingProfiles/{postingProfileKey}/print

GET Original Print SupplierPostingProfileOriginal 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}/purchasesCore/supplierPostingProfiles/{id}/printOriginal?template={template}

GET /purchasesCore/supplierPostingProfiles/{id}/printOriginal?template={template}

GET Original Print SupplierPostingProfile by key

Prints the specified entity record.

The following elements are required:

postingProfileKey

(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/printOriginal

GET /purchasesCore/supplierPostingProfiles/{postingProfileKey}/printOriginal

POST Operations

POST SupplierPostingProfiles

Creates a new entity record.

The following elements are required:

supplierPostingProfileResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/supplierPostingProfiles

POST /purchasesCore/supplierPostingProfiles

POST Supplier Posting Profile

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

The following elements are required:

postingProfileKey	(string) The posting profile key.
value	(ApiSupplierPostingProfileSupplierPostProfileAccountsResource) The ApiSupplierPostingProfileSupplierPostProfileAccountsResource instance. See ApiSupplierPostingProfileSupplierPostProfileAccountsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts

POST /purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts

PUT Operations

PUT Set ChartOfAccount SupplierPostProfileAccount

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

The following elements are required:

postingProfileKey	(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}/chartOfAccount

PUT /purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}/chartOfAccount

PUT Set Description SupplierPostingProfile

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

The following elements are required:

postingProfileKey	(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/description

PUT /purchasesCore/supplierPostingProfiles/{postingProfileKey}/description

PUT Set GlAccount SupplierPostProfileAccount

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

The following elements are required:

postingProfileKey	(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}/glAccount

PUT /purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}/glAccount

PUT Set IsActive SupplierPostingProfile

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

The following elements are required:

postingProfileKey	(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/isActive

PUT /purchasesCore/supplierPostingProfiles/{postingProfileKey}/isActive

PUT Set PartyAccountType SupplierPostProfileAccount

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

The following elements are required:

postingProfileKey	(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}/partyAccountType

PUT /purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}/partyAccountType

PUT Set PartyTaxSchema SupplierPostProfileAccount

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

The following elements are required:

postingProfileKey	(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}/partyTaxSchema

PUT /purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}/partyTaxSchema

PUT Set PostingProfileKey SupplierPostingProfile

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

The following elements are required:

postingProfileKey	(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/postingProfileKey

PUT /purchasesCore/supplierPostingProfiles/{postingProfileKey}/postingProfileKey

PUT Set Custom Attribute SupplierPostingProfile

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

postingProfileKey	(string) The posting profile key.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/{customAttributeName}

PUT /purchasesCore/supplierPostingProfiles/{postingProfileKey}/{customAttributeName}

DELETE Operations

DELETE Supplier Post. Profile Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

postingProfileKey	(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}

DELETE /purchasesCore/supplierPostingProfiles/{postingProfileKey}/supplierPostProfileAccounts/{lineId}

DELETE SupplierPostingProfile 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}/purchasesCore/supplierPostingProfiles/{id}

DELETE /purchasesCore/supplierPostingProfiles/{id}

DELETE SupplierPostingProfile by key

Deletes the entity record that matches the specified key.

The following elements are required:

postingProfileKey

(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}/purchasesCore/supplierPostingProfiles/{postingProfileKey}

DELETE /purchasesCore/supplierPostingProfiles/{postingProfileKey}

Resources

ApiSupplierPostingProfileResource

The following elements are required:

postingProfileKey

(string) The posting profile key.

The following elements are optional:

description	(string) The description of the posting profile.
supplierPostProfileAccounts	(List of ApiSupplierPostingProfileSupplierPostProfileAccountsResource) The list of the posting profile keys. See ApiSupplierPostingProfileSupplierPostProfileAccountsResource.

ApiSupplierPostingProfileSupplierPostProfileAccountsResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
glAccount	(string) The GL account assign for the party tax schema and party account type selected. Must be of subledger type of supplier.
partyAccountType	(string) The party account type.

The following elements are optional:

partyTaxSchema

(string) The party tax schema (optional).

SupplierPostingProfileResource

The following elements are required:

postingProfileKey

(string) The posting profile key.

The following elements are optional:

description	(string) The description of the posting profile.
supplierPostProfileAccounts	(List of SupplierPostProfileAccountResource) The list of the posting profile keys. See SupplierPostProfileAccountResource.

SupplierPostProfileAccountResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
glAccount	(string) The GL account assign for the party tax schema and party account type selected. Must be of subledger type of supplier.
partyAccountType	(string) The party account type.

The following elements are optional:

partyTaxSchema

(string) The party tax schema (optional).

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.