Sales | Customer Party

The Customer Party represents a consumer of the service or product that your company offers.

This service extends Parties.

Overview

api/{tenantKey}/{orgKey}/salesCore/customerParties

URL	api/{tenantKey}/{orgKey}/salesCore/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:

ApiBaseCustomerPartyEntityDimensionDetailsResource
ApiBaseCustomerPartyResource
ApiCustomerPartyEntityDimensionDetailsResource
ApiCustomerPartyResource
BaseCustomerPartyEntityDimensionDetailsResource
BaseCustomerPartyResource
CustomerPartyDimensionResource
CustomerPartyResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

AccountingSchema

GET Operations

GET CustomerParties

Returns the list of all the entity records available.

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}/salesCore/customerParties/extension

GET /salesCore/customerParties/extension

GET CustomerParties (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 CustomerPartyResource.

Response status codes:

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

Resource URL:

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

GET /salesCore/customerParties/extension?page={page}&pageSize={pageSize}

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}/salesCore/customerParties/{id}/extension

GET /salesCore/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}/salesCore/customerParties/{partyKey}/extension

GET /salesCore/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}/salesCore/customerParties

GET /salesCore/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}/salesCore/customerParties?page={page}&pageSize={pageSize}

GET /salesCore/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}/salesCore/customerParties/{id}

GET /salesCore/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}/salesCore/customerParties/{partyKey}

GET /salesCore/customerParties/{partyKey}

POST Operations

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}/salesCore/customerParties/extension

POST /salesCore/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}/salesCore/customerParties

POST /salesCore/customerParties

POST Customer Entity

Inserts a new 'Customer Party Dimension' in the 'Customer Entity'.

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
value	(ApiCustomerPartyEntityDimensionDetailsResource) The ApiCustomerPartyEntityDimensionDetailsResource instance. See ApiCustomerPartyEntityDimensionDetailsResource.

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}/salesCore/customerParties/{partyKey}/entityDimensionDetails

POST /salesCore/customerParties/{partyKey}/entityDimensionDetails

PUT Operations

PUT Set AccountingParty CustomerParty

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}/salesCore/customerParties/{partyKey}/accountingParty

PUT /salesCore/customerParties/{partyKey}/accountingParty

PUT Set AccountingSchema CustomerParty

Updates the value of attribute 'AccountingSchema' 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	(enum AccountingSchema) The request body should contain the new value for the attribute. See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/customerParties/{partyKey}/accountingSchema

PUT /salesCore/customerParties/{partyKey}/accountingSchema

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}/salesCore/customerParties/{partyKey}/customerGroup

PUT /salesCore/customerParties/{partyKey}/customerGroup

PUT Set CustomerSet CustomerParty

Updates the value of attribute 'CustomerSet' 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}/salesCore/customerParties/{partyKey}/customerSet

PUT /salesCore/customerParties/{partyKey}/customerSet

PUT Set DeliveryMode CustomerParty

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}/salesCore/customerParties/{partyKey}/deliveryMode

PUT /salesCore/customerParties/{partyKey}/deliveryMode

PUT Set DeliveryTerm CustomerParty

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}/salesCore/customerParties/{partyKey}/deliveryTerm

PUT /salesCore/customerParties/{partyKey}/deliveryTerm

PUT Set DimensionValue CustomerPartyDimension

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}/salesCore/customerParties/{partyKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT /salesCore/customerParties/{partyKey}/entityDimensionDetails/{lineId}/dimensionValue

PUT Set EndCustomer CustomerParty

Updates the value of attribute 'EndCustomer' 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}/salesCore/customerParties/{partyKey}/endCustomer

PUT /salesCore/customerParties/{partyKey}/endCustomer

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}/salesCore/customerParties/{partyKey}/isActive

PUT /salesCore/customerParties/{partyKey}/isActive

PUT Set Locked CustomerParty

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}/salesCore/customerParties/{partyKey}/locked

PUT /salesCore/customerParties/{partyKey}/locked

PUT Set PartyTaxSchema CustomerParty

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}/salesCore/customerParties/{partyKey}/partyTaxSchema

PUT /salesCore/customerParties/{partyKey}/partyTaxSchema

PUT Set PartyWithholdingTaxSchema CustomerParty

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}/salesCore/customerParties/{partyKey}/partyWithholdingTaxSchema

PUT /salesCore/customerParties/{partyKey}/partyWithholdingTaxSchema

PUT Set PaymentMethod CustomerParty

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}/salesCore/customerParties/{partyKey}/paymentMethod

PUT /salesCore/customerParties/{partyKey}/paymentMethod

PUT Set PaymentTerm CustomerParty

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}/salesCore/customerParties/{partyKey}/paymentTerm

PUT /salesCore/customerParties/{partyKey}/paymentTerm

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}/salesCore/customerParties/{partyKey}/priceList

PUT /salesCore/customerParties/{partyKey}/priceList

PUT Set Salesperson CustomerParty

Updates the value of attribute 'Salesperson' 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}/salesCore/customerParties/{partyKey}/salesperson

PUT /salesCore/customerParties/{partyKey}/salesperson

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}/salesCore/customerParties/{partyKey}/settlementDiscountPercent

PUT /salesCore/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}/salesCore/customerParties/{partyKey}/{customAttributeName}

PUT /salesCore/customerParties/{partyKey}/{customAttributeName}

DELETE Operations

DELETE Customer 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}/salesCore/customerParties/{partyKey}/entityDimensionDetails/{lineId}

DELETE /salesCore/customerParties/{partyKey}/entityDimensionDetails/{lineId}

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

DELETE /salesCore/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}/salesCore/customerParties/{partyKey}

DELETE /salesCore/customerParties/{partyKey}

Resources

ApiBaseCustomerPartyEntityDimensionDetailsResource

The following elements are required:

dimension	(string) The dimension.
dimensionValue	(string) The dimension value.

ApiBaseCustomerPartyResource

The following elements are required:

customerGroup	(string) The customer's party customer group.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments.
paymentTerm	(string) Specify the away in which a trade will be done. Generally these terms specify a period in which the buyer can pay the due amount.
partyTaxSchema	(string) The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
locked	(bool) Indicates whether the customer party is locked.
accountingSchema	(enum AccountingSchema) The type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash. See AccountingSchema.
endCustomer	(bool) Specify if the customer is an end customer or not.
customerSet	(string) The select customer set.
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:

priceList	(string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
settlementDiscountPercent	(decimal) The settlement's discount percentage.
partyWithholdingTaxSchema	(string) The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
accountingParty	(string) The default accounting's customer party.
entityDimensionDetails	(List of ApiBaseCustomerPartyEntityDimensionDetailsResource) The customer party list of dimensions. See ApiBaseCustomerPartyEntityDimensionDetailsResource.
deliveryMode	(string) The Delivery mode. (ex: mail).
salesperson	(string) The sales person.
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.

ApiCustomerPartyEntityDimensionDetailsResource

The following elements are required:

dimension	(string) The dimension.
dimensionValue	(string) The dimension value.

ApiCustomerPartyResource

The following elements are required:

customerGroup	(string) The customer's party customer group.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments.
paymentTerm	(string) Specify the away in which a trade will be done. Generally these terms specify a period in which the buyer can pay the due amount.
partyTaxSchema	(string) The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
locked	(bool) Indicates whether the customer party is locked.
accountingSchema	(enum AccountingSchema) The type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash. See AccountingSchema.
endCustomer	(bool) Specify if the customer is an end customer or not.
customerSet	(string) The select customer set.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.

The following elements are optional:

priceList	(string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
settlementDiscountPercent	(decimal) The settlement's discount percentage.
partyWithholdingTaxSchema	(string) The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
accountingParty	(string) The default accounting's customer party.
entityDimensionDetails	(List of ApiCustomerPartyEntityDimensionDetailsResource) The customer party list of dimensions. See ApiCustomerPartyEntityDimensionDetailsResource.
deliveryMode	(string) The Delivery mode. (ex: mail).
salesperson	(string) The sales person.

BaseCustomerPartyEntityDimensionDetailsResource

The following elements are required:

dimension	(string) The dimension.
dimensionValue	(string) The dimension value.

BaseCustomerPartyResource

The following elements are required:

customerGroup	(string) The customer's party customer group.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments.
paymentTerm	(string) Specify the away in which a trade will be done. Generally these terms specify a period in which the buyer can pay the due amount.
partyTaxSchema	(string) The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
locked	(bool) Indicates whether the customer party is locked.
accountingSchema	(enum AccountingSchema) The type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash. See AccountingSchema.
endCustomer	(bool) Specify if the customer is an end customer or not.
customerSet	(string) The select customer set.
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:

priceList	(string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
settlementDiscountPercent	(decimal) The settlement's discount percentage.
partyWithholdingTaxSchema	(string) The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
accountingParty	(string) The default accounting's customer party.
entityDimensionDetails	(List of BaseCustomerPartyEntityDimensionDetailsResource) The customer party list of dimensions. See BaseCustomerPartyEntityDimensionDetailsResource.
deliveryMode	(string) The Delivery mode. (ex: mail).
salesperson	(string) The sales person.
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.

CustomerPartyDimensionResource

The following elements are required:

dimension	(string) The dimension.
dimensionValue	(string) The dimension value.

CustomerPartyResource

The following elements are required:

customerGroup	(string) The customer's party customer group. (fk) Allowed value: the natural key of a record of type CustomerGroup. These records are accessibly through the CustomerGroups service.
paymentMethod	(string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. (fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
paymentTerm	(string) Specify the away in which a trade will be done. Generally these terms specify a period in which the buyer can pay the due amount. (fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
partyTaxSchema	(string) The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party. (fk) Allowed value: the natural key of a record of type PartyTaxSchema. These records are accessibly through the PartyTaxSchemas service.
locked	(bool) Indicates whether the customer party is locked.
accountingSchema	(enum AccountingSchema) The type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash. See AccountingSchema.
endCustomer	(bool) Specify if the customer is an end customer or not.
customerSet	(string) The select customer set. (fk) Allowed value: the natural key of a record of type CustomerSet. These records are accessibly through the CustomerSets service.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.

The following elements are optional:

priceList	(string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup. (fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service.
settlementDiscountPercent	(decimal) The settlement's discount percentage.
partyWithholdingTaxSchema	(string) The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party. (fk) Allowed value: the natural key of a record of type PartyWithholdingTaxSchema. These records are accessibly through the PartyWithholdingTaxSchemas service.
deliveryTerm	(string) The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
accountingParty	(string) The default accounting's customer party. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
entityDimensionDetails	(List of CustomerPartyDimensionResource) The customer party list of dimensions. See CustomerPartyDimensionResource.
deliveryMode	(string) The Delivery mode. (ex: mail). (fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.
salesperson	(string) The sales person. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingSchema

1	Accrual	Acrrual Accounting Schema.
2	Cash