Business Core | Customer Party
Service to manage entities of type 'CustomerParty'.
This service extends Parties.
Overview
| URL | api/{tenantKey}/{orgKey}/businessCore/customerParties |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
- ApiBaseCustomerPartyPartyAddressesResource
- ApiBaseCustomerPartyPartyContactsResource
- ApiBaseCustomerPartyResource
- ApiCustomerPartyResource
- BaseCustomerPartyPartyAddressesResource
- BaseCustomerPartyPartyContactsResource
- BaseCustomerPartyResource
- CustomerPartyResource
- ExtensibilityCustomAttributeValueResource
GET CustomerParties (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
Response:
| When successful, the response body contains the list of records available. See CustomerPartyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/customerParties/extension/odata
GET /businessCore/customerParties/extension/odata
GET CustomerParty 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 CustomerPartyResource. |
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}/businessCore/customerParties/{id}/extension
GET /businessCore/customerParties/{id}/extension
GET CustomerParty 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 CustomerPartyResource. |
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}/businessCore/customerParties/{partyKey}/extension
GET /businessCore/customerParties/{partyKey}/extension
GET CustomerParties (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 BaseCustomerPartyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/customerParties
GET /businessCore/customerParties
GET CustomerParties (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 BaseCustomerPartyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/customerParties?page={page}&pageSize={pageSize}
GET /businessCore/customerParties?page={page}&pageSize={pageSize}
GET CustomerParty (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 BaseCustomerPartyResource. |
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}/businessCore/customerParties/{id}
GET /businessCore/customerParties/{id}
GET CustomerParty (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 BaseCustomerPartyResource. |
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}/businessCore/customerParties/{partyKey}
GET /businessCore/customerParties/{partyKey}
POST CustomerParties
Creates a new entity record.
The following elements are required:
| customerPartyResource | (ApiCustomerPartyResource) The request body should contain the entity record that should be created. See ApiCustomerPartyResource. |
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 ApiCustomerPartyResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/customerParties/extension
POST /businessCore/customerParties/extension
POST CustomerParties (with ApiBaseCustomerParty)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| customerPartyResource | (ApiCustomerPartyResource) The request body should contain the entity record that should be created. See ApiCustomerPartyResource. |
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 ApiBaseCustomerPartyResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/customerParties
POST /businessCore/customerParties
PUT Set CustomerGroup CustomerParty
Updates the value of attribute 'CustomerGroup' 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}/businessCore/customerParties/{partyKey}/customerGroup
PUT /businessCore/customerParties/{partyKey}/customerGroup
PUT Set IsActive CustomerParty
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}/businessCore/customerParties/{partyKey}/isActive
PUT /businessCore/customerParties/{partyKey}/isActive
PUT Set PriceList CustomerParty
Updates the value of attribute 'PriceList' 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}/businessCore/customerParties/{partyKey}/priceList
PUT /businessCore/customerParties/{partyKey}/priceList
PUT Set SettlementDiscountPercent CustomerParty
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}/businessCore/customerParties/{partyKey}/settlementDiscountPercent
PUT /businessCore/customerParties/{partyKey}/settlementDiscountPercent
PUT Set Custom Attribute CustomerParty
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}/businessCore/customerParties/{partyKey}/{customAttributeName}
PUT /businessCore/customerParties/{partyKey}/{customAttributeName}
DELETE CustomerParty 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}/businessCore/customerParties/{id}
DELETE /businessCore/customerParties/{id}
DELETE CustomerParty 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}/businessCore/customerParties/{partyKey}
DELETE /businessCore/customerParties/{partyKey}
Resources
ApiBaseCustomerPartyPartyAddressesResource
The following elements are required:
| country | (string) The country for the party address. |
The following elements are optional:
| streetName | (string) The street name for the party address. |
| buildingNumber | (string) The building number for the party address. |
| postalZone | (string) The postal zone for the party address. |
| cityName | (string) The city name for the party address. |
| contactName | (string) The contact name for the party address. |
| contactTitle | (string) The contact title for the party address. |
ApiBaseCustomerPartyPartyContactsResource
The following elements are required:
| contactName | (string) The name for the party contact. |
| contactType | (string) The contact type for the party contact. |
The following elements are optional:
| contactTitle | (string) The title for the party contact. |
| electronicMail | (string) The electronic mail for the party contact. |
| mobile | (string) The mobile for the party contact. |
| telephone | (string) The telephone for the party contact. |
ApiBaseCustomerPartyResource
The following elements are required:
| customerGroup | (string) Customer Group. |
| 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) One Time Party. |
| currency | (string) The party's default currency. |
| country | (string) The party's country. |
| isPerson | (bool) Indicates that this entity is a person. |
| isEmployee | (bool) Indicates that this entity is an employee. |
The following elements are optional:
| priceList | (string) Price List. |
| settlementDiscountPercent | (decimal) Settlement Discount Percent. |
| searchTerm | (string) The search term. |
| keyword | (string) Keyword. |
| 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. |
| partyAddresses | (List of ApiBaseCustomerPartyPartyAddressesResource) The party's alternative addresses.
See ApiBaseCustomerPartyPartyAddressesResource. |
| partyContacts | (List of ApiBaseCustomerPartyPartyContactsResource) The party's alternative contacts.
See ApiBaseCustomerPartyPartyContactsResource. |
| address | (string) The party's main address. |
| contact | (string) The party's main contact. |
| culture | (string) The culture for the party. |
| partyAccountType | (string) The type of party for accounting purposes. |
| isSupplier | (bool) Indicates that this entity is a Supplier. |
| isCustomer | (bool) Indicates that this entity is an customer. |
ApiCustomerPartyResource
The following elements are required:
| customerGroup | (string) Customer Group. |
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
The following elements are optional:
| priceList | (string) Price List. |
| settlementDiscountPercent | (decimal) Settlement Discount Percent. |
BaseCustomerPartyPartyAddressesResource
The following elements are required:
| country | (string) The country for the party address. |
The following elements are optional:
| streetName | (string) The street name for the party address. |
| buildingNumber | (string) The building number for the party address. |
| postalZone | (string) The postal zone for the party address. |
| cityName | (string) The city name for the party address. |
| contactName | (string) The contact name for the party address. |
| contactTitle | (string) The contact title for the party address. |
BaseCustomerPartyPartyContactsResource
The following elements are required:
| contactName | (string) The name for the party contact. |
| contactType | (string) The contact type for the party contact. |
The following elements are optional:
| contactTitle | (string) The title for the party contact. |
| electronicMail | (string) The electronic mail for the party contact. |
| mobile | (string) The mobile for the party contact. |
| telephone | (string) The telephone for the party contact. |
BaseCustomerPartyResource
The following elements are required:
| customerGroup | (string) Customer Group. |
| 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) One Time Party. |
| currency | (string) The party's default currency. |
| country | (string) The party's country. |
| isPerson | (bool) Indicates that this entity is a person. |
| isEmployee | (bool) Indicates that this entity is an employee. |
The following elements are optional:
| priceList | (string) Price List. |
| settlementDiscountPercent | (decimal) Settlement Discount Percent. |
| searchTerm | (string) The search term. |
| keyword | (string) Keyword. |
| 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. |
| partyAddresses | (List of BaseCustomerPartyPartyAddressesResource) The party's alternative addresses.
See BaseCustomerPartyPartyAddressesResource. |
| partyContacts | (List of BaseCustomerPartyPartyContactsResource) The party's alternative contacts.
See BaseCustomerPartyPartyContactsResource. |
| address | (string) The party's main address. |
| contact | (string) The party's main contact. |
| culture | (string) The culture for the party. |
| partyAccountType | (string) The type of party for accounting purposes. |
| isSupplier | (bool) Indicates that this entity is a Supplier. |
| isCustomer | (bool) Indicates that this entity is an customer. |
CustomerPartyResource
The following elements are required:
| customerGroup | (string) Customer Group.
(fk) Allowed value: the natural key of a record of type CustomerGroup. These records are accessibly through the CustomerGroups service. |
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
The following elements are optional:
| priceList | (string) Price List.
(fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service. |
| settlementDiscountPercent | (decimal) Settlement Discount Percent. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |