Sales | Salesperson

Service to manage entities of type 'Salesperson'.

This service extends Parties.

Overview

api/{tenantKey}/{orgKey}/salesCore/salespersons

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Salespeople
- POST Salespeople (with ApiBaseSalesperson)
PUT:
- PUT Set IsActive Salesperson
- PUT Set Commission Salesperson
DELETE:
- DELETE Salesperson by identifier
- DELETE Salesperson by key

All Resources

This service uses the following resources:

ApiBaseSalespersonResource
ApiSalespersonResource
BaseSalespersonResource
SalespersonResource

GET Operations

GET Salespersons

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salespersons/extension

GET /salesCore/salespersons/extension

GET Salespersons (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 SalespersonResource.

Response status codes:

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

Resource URL:

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

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

GET Salesperson 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 SalespersonResource.

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

GET /salesCore/salespersons/{id}/extension

GET Salesperson 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 SalespersonResource.

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

GET /salesCore/salespersons/{partyKey}/extension

GET Salespersons (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 BaseSalespersonResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salespersons

GET /salesCore/salespersons

GET Salespersons (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 BaseSalespersonResource.

Response status codes:

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

Resource URL:

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

GET /salesCore/salespersons?page={page}&pageSize={pageSize}

GET Salesperson (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 BaseSalespersonResource.

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

GET /salesCore/salespersons/{id}

GET Salesperson (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 BaseSalespersonResource.

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

GET /salesCore/salespersons/{partyKey}

POST Operations

POST Salespeople

Creates a new entity record.

The following elements are required:

salespersonResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salespersons/extension

POST /salesCore/salespersons/extension

POST Salespeople (with ApiBaseSalesperson)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

salespersonResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/salesCore/salespersons

POST /salesCore/salespersons

PUT Operations

PUT Set Commission Salesperson

Updates the value of attribute 'Commission' 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/salespersons/{partyKey}/commission

PUT /salesCore/salespersons/{partyKey}/commission

PUT Set IsActive Salesperson

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

PUT /salesCore/salespersons/{partyKey}/isActive

DELETE Operations

DELETE Salesperson 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/salespersons/{id}

DELETE /salesCore/salespersons/{id}

DELETE Salesperson 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/salespersons/{partyKey}

DELETE /salesCore/salespersons/{partyKey}

Resources

ApiBaseSalespersonResource

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

commission	(decimal) The salesman's commission.
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.

ApiSalespersonResource

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:

commission

(decimal) The salesman's commission.

BaseSalespersonResource

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

commission	(decimal) The salesman's commission.
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.

SalespersonResource

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:

commission

(decimal) The salesman's commission.