Sales | Customer Party

Service to manage entities of type 'CustomerParty'.

This service extends Parties.

Overview

URL	api/{tenantKey}/{orgKey}/salesCore/customerParties
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET CustomerParties
  • GET CustomerParties (paged)
  • GET CustomerParty by identifier
  • GET CustomerParty by key
  • GET CustomerParties (with Party)
  • GET CustomerParties (with Party) (paged)
  • GET CustomerParty (with Party) by identifier
  • GET CustomerParty (with Party) by key
  • GET Get Customer By Company Tax Id
• POST:
  • POST CustomerParties
  • POST CustomerParties (with ApiBaseCustomerParty)
• PUT:
  • PUT Set IsActive CustomerParty
  • PUT Set CustomerGroup CustomerParty
  • PUT Set PriceList CustomerParty
  • PUT Set SettlementDiscountPercent CustomerParty
  • PUT Set PaymentMethod CustomerParty
  • PUT Set PaymentTerm CustomerParty
  • PUT Set Salesperson CustomerParty
  • PUT Set PartyTaxSchema CustomerParty
  • PUT Set PartyWithholdingTaxSchema CustomerParty
  • PUT Set DeliveryTerm CustomerParty
  • PUT Set Locked CustomerParty
  • PUT Set AccountingSchema CustomerParty
  • PUT Set OneTimeCustomer CustomerParty
  • PUT Set EndCustomer CustomerParty
  • PUT Set AccountingParty CustomerParty
• DELETE:
  • DELETE CustomerParty by identifier
  • DELETE CustomerParty by key

All Resources

This service uses the following resources:

• ApiBaseCustomerPartyResource
• ApiCustomerPartyResource
• BaseCustomerPartyResource
• CustomerDataResource
• CustomerPartyResource

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:

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:

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:

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:

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:

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:

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:

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:

GET Get Customer By Company Tax Id

Custom operation 'GetCustomerByCompanyTaxId'.

The following elements are required:

companyTaxId

(string) CompanyTaxId.

Response:

When successful, the response body contains a resource of type 'CustomerDataResource'. See CustomerDataResource.

Response status codes:

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

Resource URL:

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.

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:

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.

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:

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:

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:

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:

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:

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:

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:

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:

PUT Set OneTimeCustomer CustomerParty

Updates the value of attribute 'OneTimeCustomer' 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:

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:

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:

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:

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:

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:

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:

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:

DELETE Operations

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:

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:

Resources

ApiBaseCustomerPartyResource

The following elements are required:

customerGroup	(string) The customer's party customer group.
paymentMethod	(string) The payment's method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
paymentTerm	(string) The payment's term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment.
partyTaxSchema	(string) The customer's party tax schema. 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) Indicates what type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash. See AccountingSchema.
oneTimeCustomer	(bool) Indicates whether the record is used in sales for non-regular customers (without a specific record).
endCustomer	(bool) Indicates whether the customer is an end customer or not.
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.
currency	(string) The party's default currency.
country	(string) The party's country.
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.
salesperson	(string) The sales person associated to the party. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company.
partyWithholdingTaxSchema	(string) The customer's party withholding tax schema. 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 delivery's term. 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.
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.

ApiCustomerPartyResource

The following elements are required:

customerGroup	(string) The customer's party customer group.
paymentMethod	(string) The payment's method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
paymentTerm	(string) The payment's term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment.
partyTaxSchema	(string) The customer's party tax schema. 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) Indicates what type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash. See AccountingSchema.
oneTimeCustomer	(bool) Indicates whether the record is used in sales for non-regular customers (without a specific record).
endCustomer	(bool) Indicates whether the customer is an end customer or not.
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.
salesperson	(string) The sales person associated to the party. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company.
partyWithholdingTaxSchema	(string) The customer's party withholding tax schema. 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 delivery's term. 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.

BaseCustomerPartyResource

The following elements are required:

customerGroup	(string) The customer's party customer group.
paymentMethod	(string) The payment's method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
paymentTerm	(string) The payment's term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment.
partyTaxSchema	(string) The customer's party tax schema. 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) Indicates what type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash. See AccountingSchema.
oneTimeCustomer	(bool) Indicates whether the record is used in sales for non-regular customers (without a specific record).
endCustomer	(bool) Indicates whether the customer is an end customer or not.
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.
currency	(string) The party's default currency.
country	(string) The party's country.
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.
salesperson	(string) The sales person associated to the party. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company.
partyWithholdingTaxSchema	(string) The customer's party withholding tax schema. 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 delivery's term. 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.
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.

CustomerDataResource

The following elements are required:

oneTimeCustomer

(bool) Indicates whether the record is used in sales for non-regular customers (without a specific record).

The following elements are optional:

customerName	(string) The customer's name.
customerPartyKey	(string) The customer's party key.

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 payment's method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
paymentTerm	(string) The payment's term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. (fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
partyTaxSchema	(string) The customer's party tax schema. 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) Indicates what type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash. See AccountingSchema.
oneTimeCustomer	(bool) Indicates whether the record is used in sales for non-regular customers (without a specific record).
endCustomer	(bool) Indicates whether the customer is an end customer or not.
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.
salesperson	(string) The sales person associated to the party. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. (fk) Allowed value: the natural key of a record of type Salesperson. These records are accessibly through the Salespersons service.
partyWithholdingTaxSchema	(string) The customer's party withholding tax schema. 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 delivery's term. 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.

Enumerations

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash