Purchases | Supplier
The Supplier Party represents companies or individuals who provide you with products or services.
This service extends Parties.
Overview
| URL | api/{tenantKey}/{orgKey}/purchasesCore/supplierParties |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute SupplierParty
- PUT Set Custom Attribute SupplierItemPrice
- PUT Set IsActive SupplierParty
- PUT Set SettlementDiscountPercent SupplierParty
- PUT Set SupplierGroup SupplierParty
- PUT Set PaymentTerm SupplierParty
- PUT Set DeliveryTerm SupplierParty
- PUT Set PaymentMethod SupplierParty
- PUT Set PartyTaxSchema SupplierParty
- PUT Set PartyWithholdingTaxSchema SupplierParty
- PUT Set ExchangeRateDate SupplierParty
- PUT Set Locked SupplierParty
- PUT Set AccountingParty SupplierParty
- PUT Set SupplierSet SupplierParty
- PUT Set DeliveryMode SupplierParty
- PUT Set Price SupplierItemPrice
- PUT Set LastPrice SupplierItemPrice
- PUT Set Currency SupplierItemPrice
- PUT Set Unit SupplierItemPrice
- PUT Set LastSourceDoc SupplierItemPrice
- PUT Set LastSourceDocDate SupplierItemPrice
- PUT Set Item SupplierItemPrice
- PUT Set DimensionValue SupplierPartyDimension
- DELETE:
All Resources
This service uses the following resources:
- ApiBaseSupplierPartyEntityDimensionDetailsResource
- ApiBaseSupplierPartyResource
- ApiBaseSupplierPartySupplierItemPricesResource
- ApiSupplierPartyEntityDimensionDetailsResource
- ApiSupplierPartyResource
- ApiSupplierPartySupplierItemPricesResource
- BaseSupplierPartyEntityDimensionDetailsResource
- BaseSupplierPartyResource
- BaseSupplierPartySupplierItemPricesResource
- MoneyResource
- SupplierItemPriceResource
- SupplierPartyDimensionResource
- SupplierPartyResource
- ExtensibilityCustomAttributeValueResource
GET SupplierParties
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See SupplierPartyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/supplierParties/extension
GET /purchasesCore/supplierParties/extension
GET SupplierParties (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 SupplierPartyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/supplierParties/extension?page={page}&pageSize={pageSize}
GET /purchasesCore/supplierParties/extension?page={page}&pageSize={pageSize}
GET SupplierParty 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 SupplierPartyResource. |
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/supplierParties/{id}/extension
GET /purchasesCore/supplierParties/{id}/extension
GET SupplierParty by key
Returns the entity record that matches the specified key.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
Response:
| When successful, the response body contains the entity record. See SupplierPartyResource. |
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/supplierParties/{partyKey}/extension
GET /purchasesCore/supplierParties/{partyKey}/extension
GET SupplierParties (with Party)
Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.
Response:
| When successful, the response body contains the list of records available. See BaseSupplierPartyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/supplierParties
GET /purchasesCore/supplierParties
GET SupplierParties (with Party) (paged)
Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.
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 BaseSupplierPartyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/supplierParties?page={page}&pageSize={pageSize}
GET /purchasesCore/supplierParties?page={page}&pageSize={pageSize}
GET SupplierParty (with Party) by identifier
Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See BaseSupplierPartyResource. |
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/supplierParties/{id}
GET /purchasesCore/supplierParties/{id}
GET SupplierParty (with Party) by key
Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
Response:
| When successful, the response body contains the entity record. See BaseSupplierPartyResource. |
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/supplierParties/{partyKey}
GET /purchasesCore/supplierParties/{partyKey}
POST SupplierParties
Creates a new entity record.
The following elements are required:
| supplierPartyResource | (ApiSupplierPartyResource) The request body should contain the entity record that should be created. See ApiSupplierPartyResource. |
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 ApiSupplierPartyResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/supplierParties/extension
POST /purchasesCore/supplierParties/extension
POST SupplierParties (with ApiBaseSupplierParty)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| supplierPartyResource | (ApiSupplierPartyResource) The request body should contain the entity record that should be created. See ApiSupplierPartyResource. |
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 ApiBaseSupplierPartyResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/supplierParties
POST /purchasesCore/supplierParties
POST Supplier
Inserts a new 'Supplier Item Price' in the 'Supplier'.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| value | (ApiSupplierPartySupplierItemPricesResource) The ApiSupplierPartySupplierItemPricesResource instance. See ApiSupplierPartySupplierItemPricesResource. |
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/supplierParties/{partyKey}/supplierItemPrices
POST /purchasesCore/supplierParties/{partyKey}/supplierItemPrices
POST Supplier
Inserts a new 'Supplier Party Dimension' in the 'Supplier'.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| value | (ApiSupplierPartyEntityDimensionDetailsResource) The ApiSupplierPartyEntityDimensionDetailsResource instance. See ApiSupplierPartyEntityDimensionDetailsResource. |
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/supplierParties/{partyKey}/entityDimensionDetails
POST /purchasesCore/supplierParties/{partyKey}/entityDimensionDetails
PUT Set AccountingParty SupplierParty
Updates the value of attribute 'AccountingParty' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/accountingParty
PUT /purchasesCore/supplierParties/{partyKey}/accountingParty
PUT Set Currency SupplierItemPrice
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}/currency
PUT /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}/currency
PUT Set DeliveryMode SupplierParty
Updates the value of attribute 'DeliveryMode' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/deliveryMode
PUT /purchasesCore/supplierParties/{partyKey}/deliveryMode
PUT Set DeliveryTerm SupplierParty
Updates the value of attribute 'DeliveryTerm' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/deliveryTerm
PUT /purchasesCore/supplierParties/{partyKey}/deliveryTerm
PUT Set DimensionValue SupplierPartyDimension
Updates the value of attribute 'DimensionValue' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/entityDimensionDetails/{lineId}/dimensionValue
PUT /purchasesCore/supplierParties/{partyKey}/entityDimensionDetails/{lineId}/dimensionValue
PUT Set ExchangeRateDate SupplierParty
Updates the value of attribute 'ExchangeRateDate' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| value | (DateTime) 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/supplierParties/{partyKey}/exchangeRateDate
PUT /purchasesCore/supplierParties/{partyKey}/exchangeRateDate
PUT Set IsActive SupplierParty
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/isActive
PUT /purchasesCore/supplierParties/{partyKey}/isActive
PUT Set Item SupplierItemPrice
Updates the value of attribute 'Item' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}/item
PUT /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}/item
PUT Set LastPrice SupplierItemPrice
Updates the value of attribute 'LastPrice' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| lineId | (string) The detail identifier. |
| value | (decimal) 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}/lastPrice
PUT /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}/lastPrice
PUT Set LastSourceDoc SupplierItemPrice
Updates the value of attribute 'LastSourceDoc' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}/lastSourceDoc
PUT /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}/lastSourceDoc
PUT Set LastSourceDocDate SupplierItemPrice
Updates the value of attribute 'LastSourceDocDate' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| lineId | (string) The detail identifier. |
| value | (DateTime) 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}/lastSourceDocDate
PUT /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}/lastSourceDocDate
PUT Set Locked SupplierParty
Updates the value of attribute 'Locked' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/supplierParties/{partyKey}/locked
PUT /purchasesCore/supplierParties/{partyKey}/locked
PUT Set PartyTaxSchema SupplierParty
Updates the value of attribute 'PartyTaxSchema' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/partyTaxSchema
PUT /purchasesCore/supplierParties/{partyKey}/partyTaxSchema
PUT Set PartyWithholdingTaxSchema SupplierParty
Updates the value of attribute 'PartyWithholdingTaxSchema' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/partyWithholdingTaxSchema
PUT /purchasesCore/supplierParties/{partyKey}/partyWithholdingTaxSchema
PUT Set PaymentMethod SupplierParty
Updates the value of attribute 'PaymentMethod' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/paymentMethod
PUT /purchasesCore/supplierParties/{partyKey}/paymentMethod
PUT Set PaymentTerm SupplierParty
Updates the value of attribute 'PaymentTerm' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/paymentTerm
PUT /purchasesCore/supplierParties/{partyKey}/paymentTerm
PUT Set Price SupplierItemPrice
Updates the value of attribute 'Price' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| lineId | (string) The detail identifier. |
| value | (decimal) 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}/price
PUT /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}/price
PUT Set SettlementDiscountPercent SupplierParty
Updates the value of attribute 'SettlementDiscountPercent' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| value | (decimal) 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/supplierParties/{partyKey}/settlementDiscountPercent
PUT /purchasesCore/supplierParties/{partyKey}/settlementDiscountPercent
PUT Set SupplierGroup SupplierParty
Updates the value of attribute 'SupplierGroup' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/supplierGroup
PUT /purchasesCore/supplierParties/{partyKey}/supplierGroup
PUT Set SupplierSet SupplierParty
Updates the value of attribute 'SupplierSet' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/supplierSet
PUT /purchasesCore/supplierParties/{partyKey}/supplierSet
PUT Set Unit SupplierItemPrice
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}/unit
PUT /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}/unit
PUT Set Custom Attribute SupplierParty
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/{customAttributeName}
PUT /purchasesCore/supplierParties/{partyKey}/{customAttributeName}
PUT Set Custom Attribute SupplierItemPrice
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| lineId | (string) The detail identifier. |
| 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}/{customAttributeName}
PUT /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}/{customAttributeName}
DELETE Supplier Item Price by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/supplierItemPrices/{lineId}
DELETE /purchasesCore/supplierParties/{partyKey}/supplierItemPrices/{lineId}
DELETE Supplier Party Dimension by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| 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/supplierParties/{partyKey}/entityDimensionDetails/{lineId}
DELETE /purchasesCore/supplierParties/{partyKey}/entityDimensionDetails/{lineId}
DELETE SupplierParty 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/supplierParties/{id}
DELETE /purchasesCore/supplierParties/{id}
DELETE SupplierParty by key
Deletes the entity record that matches the specified key.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
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/supplierParties/{partyKey}
DELETE /purchasesCore/supplierParties/{partyKey}
Resources
ApiBaseSupplierPartyEntityDimensionDetailsResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The dimension value. |
ApiBaseSupplierPartyResource
The following elements are required:
| supplierGroup | (string) The supplier group for the party. |
| paymentTerm | (string) The payment term for the party. |
| paymentMethod | (string) The payment method for the party. |
| partyTaxSchema | (string) The purchases party tax schema. The tax schema identifies the group of taxes a party is liable for. |
| locked | (bool) When checked, the supplier party is locked. |
| supplierSet | (string) The supplier set of supplier party. |
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| name | (string) The name for the party. |
| isExternallyManaged | (bool) A flag indicating if the party is externally managed. |
| oneTimeParty | (bool) A flag indicating if the party has frequent transactions. |
| currency | (string) The party's default currency. |
| country | (string) The party's country. |
| partyAccountType | (string) The type of party for accounting purposes. |
| isPerson | (bool) Indicates that this entity is a person. |
The following elements are optional:
| settlementDiscountPercent | (decimal) The Settlement discount percentage. |
| deliveryTerm | (string) The delivery term for the party. |
| partyWithholdingTaxSchema | (string) The party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for. |
| supplierItemPrices | (List of ApiBaseSupplierPartySupplierItemPricesResource) The supplier item prices.
See ApiBaseSupplierPartySupplierItemPricesResource. |
| exchangeRateDate | (DateTime) The exchange rate date for the supplier party. |
| accountingParty | (string) The customer designated in the document as the party to whom the document should be sent for payment. It may or may not be the party to whom the goods or services are delivered. |
| entityDimensionDetails | (List of ApiBaseSupplierPartyEntityDimensionDetailsResource) The list of entity dimensions.
See ApiBaseSupplierPartyEntityDimensionDetailsResource. |
| deliveryMode | (string) The default delivery mode(ex: mail). |
| searchTerm | (string) The search term. |
| companyTaxID | (string) The party tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. |
| electronicMail | (string) The electronic mail for the party. |
| telephone | (string) The telephone for the party. |
| mobile | (string) The mobile for the party. |
| websiteUrl | (string) The website url for the party. |
| notes | (string) The notes for the party. |
| picture | (string) The picture for the party. |
| streetName | (string) The party main address street's name. |
| buildingNumber | (string) The party main address building's number. |
| postalZone | (string) The party main address postal zone. |
| cityName | (string) The party main address city's name. |
| contactName | (string) The party main contact's name. |
| contactTitle | (string) The party main contact's title. |
| username | (string) The party's Identity Username. |
| externalId | (string) The external identifier for the party. |
| externalVersion | (string) The external version for the party. |
| address | (string) The party's main address. |
| contact | (string) The party's main contact. |
| culture | (string) The culture for the party. |
ApiBaseSupplierPartySupplierItemPricesResource
The following elements are required:
| price | (MoneyResource) The amount of money which needs to be paid or paid beforehand for a product.
See MoneyResource . |
| lastPrice | (MoneyResource) The last price paided for a product.
See MoneyResource . |
| currency | (string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. |
| unit | (string) The unit for this item and group suppliers. |
| item | (string) The item. |
The following elements are optional:
| lastSourceDoc | (string) The last document for the supplier group. |
| lastSourceDocDate | (DateTime) The last document date for the supplier group. |
ApiSupplierPartyEntityDimensionDetailsResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The dimension value. |
ApiSupplierPartyResource
The following elements are required:
| supplierGroup | (string) The supplier group for the party. |
| paymentTerm | (string) The payment term for the party. |
| paymentMethod | (string) The payment method for the party. |
| partyTaxSchema | (string) The purchases party tax schema. The tax schema identifies the group of taxes a party is liable for. |
| locked | (bool) When checked, the supplier party is locked. |
| supplierSet | (string) The supplier set of supplier party. |
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
The following elements are optional:
| settlementDiscountPercent | (decimal) The Settlement discount percentage. |
| deliveryTerm | (string) The delivery term for the party. |
| partyWithholdingTaxSchema | (string) The party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for. |
| supplierItemPrices | (List of ApiSupplierPartySupplierItemPricesResource) The supplier item prices.
See ApiSupplierPartySupplierItemPricesResource. |
| exchangeRateDate | (DateTime) The exchange rate date for the supplier party. |
| accountingParty | (string) The customer designated in the document as the party to whom the document should be sent for payment. It may or may not be the party to whom the goods or services are delivered. |
| entityDimensionDetails | (List of ApiSupplierPartyEntityDimensionDetailsResource) The list of entity dimensions.
See ApiSupplierPartyEntityDimensionDetailsResource. |
| deliveryMode | (string) The default delivery mode(ex: mail). |
ApiSupplierPartySupplierItemPricesResource
The following elements are required:
| price | (MoneyResource) The amount of money which needs to be paid or paid beforehand for a product.
See MoneyResource . |
| lastPrice | (MoneyResource) The last price paided for a product.
See MoneyResource . |
| currency | (string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. |
| unit | (string) The unit for this item and group suppliers. |
| item | (string) The item. |
The following elements are optional:
| lastSourceDoc | (string) The last document for the supplier group. |
| lastSourceDocDate | (DateTime) The last document date for the supplier group. |
BaseSupplierPartyEntityDimensionDetailsResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The dimension value. |
BaseSupplierPartyResource
The following elements are required:
| supplierGroup | (string) The supplier group for the party. |
| paymentTerm | (string) The payment term for the party. |
| paymentMethod | (string) The payment method for the party. |
| partyTaxSchema | (string) The purchases party tax schema. The tax schema identifies the group of taxes a party is liable for. |
| locked | (bool) When checked, the supplier party is locked. |
| supplierSet | (string) The supplier set of supplier party. |
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| name | (string) The name for the party. |
| isExternallyManaged | (bool) A flag indicating if the party is externally managed. |
| oneTimeParty | (bool) A flag indicating if the party has frequent transactions. |
| currency | (string) The party's default currency. |
| country | (string) The party's country. |
| partyAccountType | (string) The type of party for accounting purposes. |
| isPerson | (bool) Indicates that this entity is a person. |
The following elements are optional:
| settlementDiscountPercent | (decimal) The Settlement discount percentage. |
| deliveryTerm | (string) The delivery term for the party. |
| partyWithholdingTaxSchema | (string) The party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for. |
| supplierItemPrices | (List of BaseSupplierPartySupplierItemPricesResource) The supplier item prices.
See BaseSupplierPartySupplierItemPricesResource. |
| exchangeRateDate | (DateTime) The exchange rate date for the supplier party. |
| accountingParty | (string) The customer designated in the document as the party to whom the document should be sent for payment. It may or may not be the party to whom the goods or services are delivered. |
| entityDimensionDetails | (List of BaseSupplierPartyEntityDimensionDetailsResource) The list of entity dimensions.
See BaseSupplierPartyEntityDimensionDetailsResource. |
| deliveryMode | (string) The default delivery mode(ex: mail). |
| searchTerm | (string) The search term. |
| companyTaxID | (string) The party tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. |
| electronicMail | (string) The electronic mail for the party. |
| telephone | (string) The telephone for the party. |
| mobile | (string) The mobile for the party. |
| websiteUrl | (string) The website url for the party. |
| notes | (string) The notes for the party. |
| picture | (string) The picture for the party. |
| streetName | (string) The party main address street's name. |
| buildingNumber | (string) The party main address building's number. |
| postalZone | (string) The party main address postal zone. |
| cityName | (string) The party main address city's name. |
| contactName | (string) The party main contact's name. |
| contactTitle | (string) The party main contact's title. |
| username | (string) The party's Identity Username. |
| externalId | (string) The external identifier for the party. |
| externalVersion | (string) The external version for the party. |
| address | (string) The party's main address. |
| contact | (string) The party's main contact. |
| culture | (string) The culture for the party. |
BaseSupplierPartySupplierItemPricesResource
The following elements are required:
| price | (MoneyResource) The amount of money which needs to be paid or paid beforehand for a product.
See MoneyResource . |
| lastPrice | (MoneyResource) The last price paided for a product.
See MoneyResource . |
| currency | (string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. |
| unit | (string) The unit for this item and group suppliers. |
| item | (string) The item. |
The following elements are optional:
| lastSourceDoc | (string) The last document for the supplier group. |
| lastSourceDocDate | (DateTime) The last document date for the supplier group. |
MoneyResource
The following elements are required:
| amount | (decimal) The amount. |
The following elements are optional:
| baseAmount | (decimal) The base amount. |
| reportingAmount | (decimal) The reporting amount. |
| fractionDigits | (int) The fraction digits. |
| symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.
SupplierItemPriceResource
The following elements are required:
| price | (MoneyResource) The amount of money which needs to be paid or paid beforehand for a product.
See MoneyResource . |
| lastPrice | (MoneyResource) The last price paided for a product.
See MoneyResource . |
| currency | (string) The money unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. |
| unit | (string) The unit for this item and group suppliers. |
| item | (string) The item. |
The following elements are optional:
| lastSourceDoc | (string) The last document for the supplier group. |
| lastSourceDocDate | (DateTime) The last document date for the supplier group. |
SupplierPartyDimensionResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The dimension value. |
SupplierPartyResource
The following elements are required:
| supplierGroup | (string) The supplier group for the party.
(fk) Allowed value: the natural key of a record of type SupplierGroup. These records are accessibly through the SupplierGroups service. |
| paymentTerm | (string) The payment term for the party.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service. |
| paymentMethod | (string) The payment method for the party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service. |
| partyTaxSchema | (string) The purchases party tax schema. The tax schema identifies the group of taxes a party is liable for.
(fk) Allowed value: the natural key of a record of type PartyTaxSchema. These records are accessibly through the PartyTaxSchemas service. |
| locked | (bool) When checked, the supplier party is locked. |
| supplierSet | (string) The supplier set of supplier party.
(fk) Allowed value: the natural key of a record of type SupplierSet. These records are accessibly through the SupplierSets service. |
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
The following elements are optional:
| settlementDiscountPercent | (decimal) The Settlement discount percentage. |
| deliveryTerm | (string) The delivery term for the party.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service. |
| partyWithholdingTaxSchema | (string) The party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for.
(fk) Allowed value: the natural key of a record of type PartyWithholdingTaxSchema. These records are accessibly through the PartyWithholdingTaxSchemas service. |
| supplierItemPrices | (List of SupplierItemPriceResource) The supplier item prices.
See SupplierItemPriceResource. |
| exchangeRateDate | (DateTime) The exchange rate date for the supplier party. |
| accountingParty | (string) The customer designated in the document as the party to whom the document should be sent for payment. It may or may not be the party to whom the goods or services are delivered.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
| entityDimensionDetails | (List of SupplierPartyDimensionResource) The list of entity dimensions.
See SupplierPartyDimensionResource. |
| deliveryMode | (string) The default delivery mode(ex: mail).
(fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |