Master Data Business Entities | Entity

A Party represents an entity that provides or consumes services or goods.

Overview

api/{tenantKey}/{orgKey}/businessCore/parties

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

ApiPartyPartyAddressesResource
ApiPartyPartyContactsResource
ApiPartyPartyTypesResource
ApiPartyResource
PartyAddressResource
PartyBasePartyTypesResource
PartyBaseResource
PartyContactResource
PartyResource
PartyTypeDetailResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

PartyType

GET Operations

GET Parties

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties

GET /businessCore/parties

GET Parties (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 PartyResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties?page={page}&pageSize={pageSize}

GET /businessCore/parties?page={page}&pageSize={pageSize}

GET Party 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 PartyResource.

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

GET /businessCore/parties/{id}

GET Party 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 PartyResource.

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/parties/{partyKey}

GET /businessCore/parties/{partyKey}

GET Print Party by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties/{id}/print?template={template}

GET /businessCore/parties/{id}/print?template={template}

GET Print Party by key

Prints the specified entity record.

The following elements are required:

partyKey

(string) The key for the party. Uniquely identifies the entity/party within the organization.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties/{partyKey}/print

GET /businessCore/parties/{partyKey}/print

GET Original Print PartyOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties/{id}/printOriginal?template={template}

GET /businessCore/parties/{id}/printOriginal?template={template}

GET Original Print Party by key

Prints the specified entity record.

The following elements are required:

partyKey

(string) The key for the party. Uniquely identifies the entity/party within the organization.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties/{partyKey}/printOriginal

GET /businessCore/parties/{partyKey}/printOriginal

GET Entity Picture.

Returns the value of attribute 'Picture' of the specified entity record.

The following elements are required:

id	(string) The record identifier.
fileName	(string) The file name.

Response:

When successful, the response is a stream with the image file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties/{id}/picture

GET /businessCore/parties/{id}/picture

POST Operations

POST Parties

Creates a new entity record.

The following elements are required:

partyResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties

POST /businessCore/parties

POST Entity

Inserts a new 'Party Address' in the 'Entity'.

The following elements are required:

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

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}/businessCore/parties/{partyKey}/partyAddresses

POST /businessCore/parties/{partyKey}/partyAddresses

POST Entity

Inserts a new 'Party Contact' in the 'Entity'.

The following elements are required:

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

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}/businessCore/parties/{partyKey}/partyContacts

POST /businessCore/parties/{partyKey}/partyContacts

POST Entity

Inserts a new 'Party Type Detail' in the 'Entity'.

The following elements are required:

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

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}/businessCore/parties/{partyKey}/partyTypes

POST /businessCore/parties/{partyKey}/partyTypes

POST Bulk Create Parties

Creates the party in bulk.

The following elements are required:

bulkParties

(List) The party instances to be created in bulk.

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.

Resource URL:

api/{tenantKey}/{orgKey}/businessCore/parties/bulkCreateParties

POST /businessCore/parties/bulkCreateParties

PUT Operations

PUT Set Address Party

Updates the value of attribute 'Address' 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/parties/{partyKey}/address

PUT /businessCore/parties/{partyKey}/address

PUT Set BuildingNumber Party

Updates the value of attribute 'BuildingNumber' 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/parties/{partyKey}/buildingNumber

PUT /businessCore/parties/{partyKey}/buildingNumber

PUT Set BuildingNumber PartyAddress

Updates the value of attribute 'BuildingNumber' 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}/businessCore/parties/{partyKey}/partyAddresses/{lineId}/buildingNumber

PUT /businessCore/parties/{partyKey}/partyAddresses/{lineId}/buildingNumber

PUT Set CityName Party

Updates the value of attribute 'CityName' 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/parties/{partyKey}/cityName

PUT /businessCore/parties/{partyKey}/cityName

PUT Set CityName PartyAddress

Updates the value of attribute 'CityName' 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}/businessCore/parties/{partyKey}/partyAddresses/{lineId}/cityName

PUT /businessCore/parties/{partyKey}/partyAddresses/{lineId}/cityName

PUT Set CompanyTaxID Party

Updates the value of attribute 'CompanyTaxID' 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/parties/{partyKey}/companyTaxID

PUT /businessCore/parties/{partyKey}/companyTaxID

PUT Set Contact Party

Updates the value of attribute 'Contact' 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/parties/{partyKey}/contact

PUT /businessCore/parties/{partyKey}/contact

PUT Set ContactName Party

Updates the value of attribute 'ContactName' 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/parties/{partyKey}/contactName

PUT /businessCore/parties/{partyKey}/contactName

PUT Set ContactName PartyAddress

Updates the value of attribute 'ContactName' 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}/businessCore/parties/{partyKey}/partyAddresses/{lineId}/contactName

PUT /businessCore/parties/{partyKey}/partyAddresses/{lineId}/contactName

PUT Set ContactName PartyContact

Updates the value of attribute 'ContactName' 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}/businessCore/parties/{partyKey}/partyContacts/{lineId}/contactName

PUT /businessCore/parties/{partyKey}/partyContacts/{lineId}/contactName

PUT Set ContactTitle Party

Updates the value of attribute 'ContactTitle' 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/parties/{partyKey}/contactTitle

PUT /businessCore/parties/{partyKey}/contactTitle

PUT Set ContactTitle PartyAddress

Updates the value of attribute 'ContactTitle' 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}/businessCore/parties/{partyKey}/partyAddresses/{lineId}/contactTitle

PUT /businessCore/parties/{partyKey}/partyAddresses/{lineId}/contactTitle

PUT Set ContactTitle PartyContact

Updates the value of attribute 'ContactTitle' 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}/businessCore/parties/{partyKey}/partyContacts/{lineId}/contactTitle

PUT /businessCore/parties/{partyKey}/partyContacts/{lineId}/contactTitle

PUT Set ContactType PartyContact

Updates the value of attribute 'ContactType' 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}/businessCore/parties/{partyKey}/partyContacts/{lineId}/contactType

PUT /businessCore/parties/{partyKey}/partyContacts/{lineId}/contactType

PUT Set Country Party

Updates the value of attribute 'Country' 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/parties/{partyKey}/country

PUT /businessCore/parties/{partyKey}/country

PUT Set Country PartyAddress

Updates the value of attribute 'Country' 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}/businessCore/parties/{partyKey}/partyAddresses/{lineId}/country

PUT /businessCore/parties/{partyKey}/partyAddresses/{lineId}/country

PUT Set Culture Party

Updates the value of attribute 'Culture' 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/parties/{partyKey}/culture

PUT /businessCore/parties/{partyKey}/culture

PUT Set Currency Party

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.
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/parties/{partyKey}/currency

PUT /businessCore/parties/{partyKey}/currency

PUT Set ElectronicMail Party

Updates the value of attribute 'ElectronicMail' 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/parties/{partyKey}/electronicMail

PUT /businessCore/parties/{partyKey}/electronicMail

PUT Set ElectronicMail PartyContact

Updates the value of attribute 'ElectronicMail' 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}/businessCore/parties/{partyKey}/partyContacts/{lineId}/electronicMail

PUT /businessCore/parties/{partyKey}/partyContacts/{lineId}/electronicMail

PUT Set Enabled PartyTypeDetail

Updates the value of attribute 'Enabled' 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	(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}/businessCore/parties/{partyKey}/partyTypes/{lineId}/enabled

PUT /businessCore/parties/{partyKey}/partyTypes/{lineId}/enabled

PUT Set ExternalId Party

Updates the value of attribute 'ExternalId' 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/parties/{partyKey}/externalId

PUT /businessCore/parties/{partyKey}/externalId

PUT Set IsActive Party

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

PUT /businessCore/parties/{partyKey}/isActive

PUT Set IsPerson Party

Updates the value of attribute 'IsPerson' 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}/businessCore/parties/{partyKey}/isPerson

PUT /businessCore/parties/{partyKey}/isPerson

PUT Set Mobile Party

Updates the value of attribute 'Mobile' 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/parties/{partyKey}/mobile

PUT /businessCore/parties/{partyKey}/mobile

PUT Set Mobile PartyContact

Updates the value of attribute 'Mobile' 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}/businessCore/parties/{partyKey}/partyContacts/{lineId}/mobile

PUT /businessCore/parties/{partyKey}/partyContacts/{lineId}/mobile

PUT Set Name Party

Updates the value of attribute 'Name' 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/parties/{partyKey}/name

PUT /businessCore/parties/{partyKey}/name

PUT Set Notes Party

Updates the value of attribute 'Notes' 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/parties/{partyKey}/notes

PUT /businessCore/parties/{partyKey}/notes

PUT Set OneTimeParty Party

Updates the value of attribute 'OneTimeParty' 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}/businessCore/parties/{partyKey}/oneTimeParty

PUT /businessCore/parties/{partyKey}/oneTimeParty

PUT Set PartyAccountType Party

Updates the value of attribute 'PartyAccountType' 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/parties/{partyKey}/partyAccountType

PUT /businessCore/parties/{partyKey}/partyAccountType

PUT Set PartyKey Party

Updates the value of attribute 'PartyKey' 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/parties/{partyKey}/partyKey

PUT /businessCore/parties/{partyKey}/partyKey

PUT Set PartyType PartyTypeDetail

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

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/parties/{partyKey}/partyTypes/{lineId}/partyType

PUT /businessCore/parties/{partyKey}/partyTypes/{lineId}/partyType

PUT Set Picture Party

Updates the value of attribute 'Picture' 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/parties/{partyKey}/picture

PUT /businessCore/parties/{partyKey}/picture

PUT Set PostalZone Party

Updates the value of attribute 'PostalZone' 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/parties/{partyKey}/postalZone

PUT /businessCore/parties/{partyKey}/postalZone

PUT Set PostalZone PartyAddress

Updates the value of attribute 'PostalZone' 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}/businessCore/parties/{partyKey}/partyAddresses/{lineId}/postalZone

PUT /businessCore/parties/{partyKey}/partyAddresses/{lineId}/postalZone

PUT Set SearchTerm Party

Updates the value of attribute 'SearchTerm' 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/parties/{partyKey}/searchTerm

PUT /businessCore/parties/{partyKey}/searchTerm

PUT Set StreetName Party

Updates the value of attribute 'StreetName' 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/parties/{partyKey}/streetName

PUT /businessCore/parties/{partyKey}/streetName

PUT Set StreetName PartyAddress

Updates the value of attribute 'StreetName' 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}/businessCore/parties/{partyKey}/partyAddresses/{lineId}/streetName

PUT /businessCore/parties/{partyKey}/partyAddresses/{lineId}/streetName

PUT Set Telephone Party

Updates the value of attribute 'Telephone' 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/parties/{partyKey}/telephone

PUT /businessCore/parties/{partyKey}/telephone

PUT Set Telephone PartyContact

Updates the value of attribute 'Telephone' 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}/businessCore/parties/{partyKey}/partyContacts/{lineId}/telephone

PUT /businessCore/parties/{partyKey}/partyContacts/{lineId}/telephone

PUT Set Username Party

Updates the value of attribute 'Username' 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/parties/{partyKey}/username

PUT /businessCore/parties/{partyKey}/username

PUT Set WebsiteUrl Party

Updates the value of attribute 'WebsiteUrl' 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/parties/{partyKey}/websiteUrl

PUT /businessCore/parties/{partyKey}/websiteUrl

PUT Set Custom Attribute Party

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/parties/{partyKey}/{customAttributeName}

PUT /businessCore/parties/{partyKey}/{customAttributeName}

DELETE Operations

DELETE Party Address 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}/businessCore/parties/{partyKey}/partyAddresses/{lineId}

DELETE /businessCore/parties/{partyKey}/partyAddresses/{lineId}

DELETE Party Contact 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}/businessCore/parties/{partyKey}/partyContacts/{lineId}

DELETE /businessCore/parties/{partyKey}/partyContacts/{lineId}

DELETE Party Type Detail 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}/businessCore/parties/{partyKey}/partyTypes/{lineId}

DELETE /businessCore/parties/{partyKey}/partyTypes/{lineId}

DELETE Party 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/parties/{id}

DELETE /businessCore/parties/{id}

DELETE Party 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/parties/{partyKey}

DELETE /businessCore/parties/{partyKey}

Resources

ApiPartyPartyAddressesResource

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.

ApiPartyPartyContactsResource

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.

ApiPartyPartyTypesResource

The following elements are required:

partyType	(enum PartyType) Type of Party. See PartyType.
enabled	(bool) If true the party has this type.

ApiPartyResource

The following elements are required:

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:

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.
partyAddresses	(List of ApiPartyPartyAddressesResource) The party's alternative addresses. See ApiPartyPartyAddressesResource.
partyContacts	(List of ApiPartyPartyContactsResource) The party's alternative contacts. See ApiPartyPartyContactsResource.
address	(string) The party's main address.
contact	(string) The party's main contact.
culture	(string) The culture for the party.
partyTypes	(List of ApiPartyPartyTypesResource) The list of types that party can assume. See ApiPartyPartyTypesResource.

PartyAddressResource

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.

PartyBasePartyTypesResource

The following elements are required:

enabled	(bool) If true the party has this type.
partyType	(enum PartyType) Type of Party. See PartyType.

PartyBaseResource

The following elements are required:

country	(string) The party's country.
currency	(string) The party's default currency.
isExternallyManaged	(bool) A flag indicating if the party is externally managed.
name	(string) The name for the party.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
partyAccountType	(string) The type of party for accounting purposes.
oneTimeParty	(bool) A flag indicating if the party has frequent transactions.
isPerson	(bool) Indicates that this entity is a person.

The following elements are optional:

buildingNumber	(string) The party main address building's number.
cityName	(string) The party main address city's name.
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.
contactName	(string) The party main contact's name.
contactTitle	(string) The party main contact's title.
electronicMail	(string) The electronic mail for the party.
externalId	(string) The external identifier for the party.
externalVersion	(string) The external version for the party.
mobile	(string) The mobile for the party.
notes	(string) The notes for the party.
picture	(string) The picture for the party.
postalZone	(string) The party main address postal zone.
searchTerm	(string) The search term.
streetName	(string) The party main address street's name.
telephone	(string) The telephone for the party.
username	(string) The party's Identity Username.
websiteUrl	(string) The website url for the party.
address	(string) The party's main address.
contact	(string) The party's main contact.
culture	(string) The culture for the party.
partyTypes	(List of PartyBasePartyTypesResource) The list of types that party can assume. See PartyBasePartyTypesResource.

PartyContactResource

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.
culture	(string) Culture.

PartyResource

The following elements are required:

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. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
country	(string) The party's country. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
partyAccountType	(string) The type of party for accounting purposes. (fk) Allowed value: the natural key of a record of type PartyAccountType. These records are accessibly through the PartyAccountTypes service.
isPerson	(bool) Indicates that this entity is a person.

The following elements are optional:

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.
partyAddresses	(List of PartyAddressResource) The party's alternative addresses. See PartyAddressResource.
partyContacts	(List of PartyContactResource) The party's alternative contacts. See PartyContactResource.
address	(string) The party's main address. (fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
contact	(string) The party's main contact. (fk) Allowed value: the natural key of a record of type Contact. These records are accessibly through the Contacts service.
culture	(string) The culture for the party. (fk) Allowed value: the natural key of a record of type Culture. These records are accessibly through the Cultures service.
partyTypes	(List of PartyTypeDetailResource) The list of types that party can assume. See PartyTypeDetailResource.

PartyTypeDetailResource

The following elements are required:

partyType	(enum PartyType) Type of Party. See PartyType.
enabled	(bool) If true the party has this type.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

PartyType

1	Customer
2	Supplier
3	FinancialInstitution
5	SalesPerson
6	OtherPayable
7	OtherReceivable
8	PublicAuthority
9	Employee