Purchases | Purchases Parameters

The PurchasesSetups is used to manage each company's default values, such as the document Types.

Overview

api/{tenantKey}/{orgKey}/purchasesCore/purchasesSetups

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

All Operations

This service includes the following operations:

GET:
POST:
- POST PurchasesSetups
PUT:
DELETE:
- DELETE PurchasesSetup by identifier
- DELETE PurchasesSetup by key

All Resources

This service uses the following resources:

ApiPurchasesSetupResource
PurchasesSetupResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET PurchasesSetups

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/purchasesSetups

GET /purchasesCore/purchasesSetups

GET PurchasesSetups (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 PurchasesSetupResource.

Response status codes:

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

Resource URL:

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

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

GET PurchasesSetup 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 PurchasesSetupResource.

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

GET /purchasesCore/purchasesSetups/{id}

GET PurchasesSetup by key

Returns the entity record that matches the specified key.

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

Response:

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

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/purchasesSetups/{company}

GET /purchasesCore/purchasesSetups/{company}

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

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

GET Print PurchasesSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

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/purchasesSetups/{company}/print

GET /purchasesCore/purchasesSetups/{company}/print

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

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

GET Original Print PurchasesSetup by key

Prints the specified entity record.

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

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/purchasesSetups/{company}/printOriginal

GET /purchasesCore/purchasesSetups/{company}/printOriginal

POST Operations

POST PurchasesSetups

Creates a new entity record.

The following elements are required:

purchasesSetupResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/purchasesSetups

POST /purchasesCore/purchasesSetups

PUT Operations

PUT Set Company PurchasesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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/purchasesSetups/{company}/company

PUT /purchasesCore/purchasesSetups/{company}/company

PUT Set DefaultGoodsReceiptNoteType PurchasesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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/purchasesSetups/{company}/defaultGoodsReceiptNoteType

PUT /purchasesCore/purchasesSetups/{company}/defaultGoodsReceiptNoteType

PUT Set DefaultInvoiceType PurchasesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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/purchasesSetups/{company}/defaultInvoiceType

PUT /purchasesCore/purchasesSetups/{company}/defaultInvoiceType

PUT Set DefaultMemoType PurchasesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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/purchasesSetups/{company}/defaultMemoType

PUT /purchasesCore/purchasesSetups/{company}/defaultMemoType

PUT Set DefaultOrderType PurchasesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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/purchasesSetups/{company}/defaultOrderType

PUT /purchasesCore/purchasesSetups/{company}/defaultOrderType

PUT Set DefaultReturnOrderType PurchasesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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/purchasesSetups/{company}/defaultReturnOrderType

PUT /purchasesCore/purchasesSetups/{company}/defaultReturnOrderType

PUT Set IsActive PurchasesSetup

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

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
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/purchasesSetups/{company}/isActive

PUT /purchasesCore/purchasesSetups/{company}/isActive

PUT Set Custom Attribute PurchasesSetup

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

The following elements are required:

companyKey	(string) The company key.
company	(string) The company code is the central organizational unit within the system.
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/purchasesSetups/{companyKey}/{company}/{customAttributeName}

PUT /purchasesCore/purchasesSetups/{companyKey}/{company}/{customAttributeName}

DELETE Operations

DELETE PurchasesSetup 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/purchasesSetups/{id}

DELETE /purchasesCore/purchasesSetups/{id}

DELETE PurchasesSetup by key

Deletes the entity record that matches the specified key.

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

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/purchasesSetups/{company}

DELETE /purchasesCore/purchasesSetups/{company}

Resources

ApiPurchasesSetupResource

The following elements are required:

company

(string) The company code is the central organizational unit within the system.

The following elements are optional:

defaultOrderType	(string) The order type for the purchases setup.
defaultInvoiceType	(string) The invoice type for the purchases setup.
defaultMemoType	(string) The memo type for the purchases setup.
defaultGoodsReceiptNoteType	(string) The goods receipt note type for the purchases setup.
defaultReturnOrderType	(string) The return order type for the purchases setup.

PurchasesSetupResource

The following elements are required:

company

(string) The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

defaultOrderType	(string) The order type for the purchases setup. (fk) Allowed value: the natural key of a record of type OrderType. These records are accessibly through the OrderTypes service.
defaultInvoiceType	(string) The invoice type for the purchases setup. (fk) Allowed value: the natural key of a record of type InvoiceType. These records are accessibly through the InvoiceTypes service.
defaultMemoType	(string) The memo type for the purchases setup. (fk) Allowed value: the natural key of a record of type MemoType. These records are accessibly through the MemoTypes service.
defaultGoodsReceiptNoteType	(string) The goods receipt note type for the purchases setup. (fk) Allowed value: the natural key of a record of type GoodsReceiptNoteType. These records are accessibly through the GoodsReceiptNoteTypes service.
defaultReturnOrderType	(string) The return order type for the purchases setup. (fk) Allowed value: the natural key of a record of type OrderType. These records are accessibly through the OrderTypes service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.