Business Partner API
1. Introduction
The HORISEN Business Partner API contains the logic behind the Business Partner application part on the HORISEN platform. It is a JSON based REST API that provides access to the objects which are in use by all other HORISEN services and APIs.
It supports OAuth 2.0 authentication. An example of how to implement OAuth 2.0 and obtain access token, as well as an example of using a HORISEN API service, is available at Oauth2 Authentication Guidelines page.
The HORISEN Business Partner API belongs to the Biz Core domain and the endpoint URL is:
https://api.horisen.pro/biz-core/v2
2. Methods Overview
2.1 Documents Configuration
Endpoints for working with logo data of Business Partners.
2.2 Biz attribute section tag
Endpoints for working with biz attribute section tag table.
2.3 Biz attribute tag
Endpoints for working with biz attribute tag table.
2.4 Biz partner brief
Endpoint for working with Biz partner brief.
2.5 Account manager lov
Endpoint for working with account manager lov.
2.6 Account manager partner lov
Endpoint for working with account manager partner lov.
2.7 Address type
Endpoint for working with address type.
2.8 Biz contact type
Endpoints for working with biz contact type.
2.9 Biz department
Endpoints for working with biz department.
2.10 LegalForms
Endpoints for working with legal forms.
2.11 Biz partner active lov
This endpoint returns a list of Biz partner active lov.
2.12 Biz partner address
Endpoints for working with Biz partner addresses.
2.13 Biz partner contact
Endpoints for working with Biz partner contacts.
2.14 Products
Endpoints for working with products.
2.15 BizPartnerProducts
Endpoints for working with Biz partner Products.
2.16 Currency
Endpoints for working with currencies.
2.17 Country
Endpoints for working with countries.
2.18 Language
Endpoints for working with countries.
2.19 MeasureUnits
Endpoints for working with measurement units.
2.20 BizPositions
Endpoints for working with biz positions.
2.21 RelationTypes
Endpoint for working with relation types.
2.22 ServiceCategories
Endpoints for working with service categories.
2.23 BizPartnerLov
Endpoints for working with Biz partner lov.
2.24 BizPartnerStatus
Endpoint for working with Biz partner status.
2.25 BizPartnerStat
Endpoint for working with Biz partner stat.
2.26 ContextOwner
Endpoint for working with context owner.
2.27 EmailAccount
Endpoints for working with Email account.
2.28 FinanceEmailAddresses
Endpoint for working with finance email addresses.
2.29 ProductFeatures
Endpoints for working with product features.
2.30 ProductTypePartnersLov
Endpoint for working with product type partners lov.
2.31 FinanceSettings
Endpoints for working with finance settings.
2.32 ProductTypes
Endpoint for working with product types.
2.33 Biz partner types
Endpoint for working with Biz partner types.
2.34 BizSettings
Endpoint for working with BizSettings.
2.35 WebSocials
Endpoints for working with WebSocials.
2.36 PartnerTypes
Endpoints for working with PartnerTypes.
2.37 Industries
Endpoints for working with Industries.
2.38 CompanySize
Endpoints for working with CompanySizes.
2.39 Partners
Endpoints for working with Partners.
2.40 PartnerSections
Endpoints for working with PartnerSections.
2.41 AccountManagers
Endpoints for working with AccountManagers.
2.42 Attributes
Endpoints for working with Attributes.
2.43 PartnerAttributes
Endpoints for working with PartnerAttributes.
2.44 AttributePartners
Endpoint for working with AttributePartners.
2.45 AttributeSections
Endpoints for working with AttributeSections.
2.46 AttributeTypes
Endpoints for working with AttributeTypes.
3. Methods Details
3.1 Documents Configuration
Endpoints for working with logo data of Business Partners.
Method Overview
This method uploads a logo file.
URL Parameters
Name | Type | Description |
---|---|---|
partnerid (required) | string (path) | Partner ID. |
uploadfile (required) | file (formData) | Logo file. |
Responses
Code | Description | Links |
---|---|---|
201 | File uploaded and record created. | No links |
default | Unexpected error. | No links |
Success Response: 201 File uploaded and record created
{
"id": 0,
"partnerId": 0,
"filename": "string",
"size": 0,
"language": "string",
"mimeType": "string",
"insertDt": "2021-01-28T11:09:48.212Z",
"status": "draft",
"statusDt": "2021-01-28T11:09:48.212Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a logo file.
The required privileges:
- biz-core.view - The logged user can download a logo for all biz partners.
- biz-core-own.view - The logged user can download a logo for his own Biz partner.
URL Parameters
Name | Type | Description |
---|---|---|
partnerid (required) | string (path) | Partner ID. |
logoid (required) | string (path) | Logo file ID. |
Responses
Code | Description | Links |
---|---|---|
200 | JPEG or JPG file downloaded. | No links |
default | Unexpected error. | No links |
Success Response 200: JPEG or JPG file downloaded
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a logo file.
The required privileges:
- biz-core.view - The logged user can download a logo for all biz partners.
- biz-core-own.view - The logged user can download a logo for his own Biz partner.
URL Parameters
Name | Type | Description |
---|---|---|
partnerid (required) | string (path) | Partner ID. |
status (required) | string (path) | Available values: active. |
Responses
Code | Description | Links |
---|---|---|
200 | JPEG or JPG file downloaded. | No links |
default | Unexpected error. | No links |
Success Response 200: JPEG or JPG file downloaded
{
"id": 0,
"partnerId": 0,
"filename": "string",
"size": 0,
"language": "string",
"mimeType": "string",
"insertDt": "2021-01-28T11:19:40.210Z",
"status": "draft",
"statusDt": "2021-01-28T11:19:40.210Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method changes a logo status by logoid.
Possible statuses are: draft, active, inactive. The default status is draft. The idea is that the method PATCH is used after a file with logo is uploaded, which changes the default draft status to active status.
URL Parameters
Name | Type | Description |
---|---|---|
partnerid (required) | string (path) | Partner ID. |
logoid (required) | string (path) | Logo file ID. |
put data (required) | object (body) | Logo status data. |
Data Parameters
Logo status data object example
{
"status": "draft"
}
Responses
Code | Description | Links |
---|---|---|
200 | Logo status changed. | No links |
default | Unexpected error. | No links |
Success Response 200: Logo Status Changed
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method changes a logo status by logoid, (draft, active, inactive) => deleted.
URL Parameters
Name | Type | Description |
---|---|---|
partnerid (required) | string (path) | Partner ID. |
logoid (required) | string (path) | Logo file ID. |
Responses
Code | Description | Links |
---|---|---|
204 | Logo file deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 204: Logo file deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of BizPartnersLogo by ID and active status.
This endpoint accepts query parameters for filtering described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
partnerid (required) | string (path) | Partner ID. |
all | string (query) | Returns all data for a given criteria. The available values are yes or no. The default value is no. |
page_size | integer (query) | A page size. The default value is 10. |
page_number | integer (query) | A page number. The default value is 1. |
paging | string (query) | Paging options. The format is: &paging=page_num,page_size, e.g. paging=1,10. |
sort | string (query) | Sorting options. The format is: sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and the following attributes: id, filename, bizPartnerId, mimeType, size, insert_dt, status, status_dt.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of BizPartnersLogo. | No links |
default | Unexpected error. | No links |
Success Response 200: List of BizPartnersLogo
{
"data": [
{
"id": 0,
"partnerId": 0,
"filename": "string",
"size": 0,
"language": "string",
"mimeType": "string",
"insertDt": "2021-01-08T11:13:54.738Z",
"status": "draft",
"statusDt": "2021-01-08T11:13:54.739Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.2 Biz attribute section tag
Endpoints for working with biz attribute section tag table.
Method Overview
This method returns a biz attribute section tag record from the database for a given attributeId, sectionId and tagId.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | AttributeId. |
secId (required) | integer (path) | Section ID. |
tagId (required) | integer (path) | Tag ID. |
Responses
Code | Description | Links |
---|---|---|
200 | BizAttributeSectionTag data. | No links |
default | Unexpected error. | No links |
Success Response 200: BizAttributeSectionTag data
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2022-01-31T10:39:46.704Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes a biz attribute section tag record from the database for a given attributeId, sectionId and tagId.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | AttributeID. |
secId (required) | integer (path) | Section ID. |
tagId (required) | integer (path) | Tag ID. |
Responses
Code | Description | Links |
---|---|---|
204 | Biz attribute section successfully deleted. | No links |
default | Unexpected error. | No links |
Success Response 204: Biz attribute section successfully deleted
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of Biz attribute section tag.
This endpoint accepts query parameters for filtering Biz attribute section tag described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | AttributeId. |
secId (required) | integer (path) | Section ID. |
operator(filedName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and the following attributes: sectionId, attributeId, tagId, insertTs, attributeTagCategoryId, attributeTagRowType, attributeTagCodeName, attributeTagName, attributeInstanceId, attributeAttributeTypeId, attributeCodeName, attributeName, attributeKind, sectionCodeName, sectionName.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz attribute section tag. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Biz attribute section tag
{
"data": [
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2021-01-08T12:59:24.431Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new Biz attribute section tag record.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | AttributeId. |
secId (required) | integer (path) | Section ID. |
post data (required) | object (body) | Biz attribute section tag data. |
Data Parameters
Post data object example
{
"tagID": 0
}
Responses
Code | Description | Links |
---|---|---|
200 | Biz Attribute Section Tag record created. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz Attribute Section Tag record created
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2022-01-31T10:58:52.386Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.3 Biz attribute tag
Endpoints for working with biz attribute tag table.
Method Overview
This method returns a biz attribute tag record from the database for a given tagId.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Tag ID. |
Responses
Code | Description | Links |
---|---|---|
200 | BizAttributeTag data. | No links |
default | Unexpected error. | No links |
Success Response 200: BizAttributeTag data
{
"id": 0,
"categoryId": 0,
"rowType": "string",
"codeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of Biz attribute tag records.
This endpoint accepts query parameters for filtering Biz attribute tag records described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
operator(filedName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and the following attributes: id, categoryId, rowType, codeName, name, status, statusDt.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz attribute section tag. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Biz attribute section tag
{
"data": [
{
"id": 0,
"categoryId": 0,
"rowType": "string",
"codeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.4 Biz partner brief
Endpoint for Biz partner brief.
Method Overview
This method returns a list of Biz partner brief.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering a Biz partner brief described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull,isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and the following attributes: id, name, briefName, countryName, phone, eMail, vatNumber, vatApply, legalAddress, legalAddressName, city, regNumber, status, statusDt, legalAddressCountryName, creation, instanceOwnerName, industryName, partnerTypeName, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz partner brief. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Biz partner brief
{
"data": [
{
"id": 0,
"instanceRole": "string",
"name": "string",
"briefName": "string",
"externalRefId": "string",
"countryId": 0,
"countryName": "string",
"phone": "string",
"eMail": "string",
"language": "string",
"vatNumber": "string",
"vatApply": "string",
"legalAddressId": 0,
"legalAddressName": "string",
"legalAddress": "string",
"legalAddressCountryId": 0,
"legalAddressCountryName": "string",
"statusActiveDt": "2021-01-11T09:16:17.967Z",
"city": "string",
"regNumber": "string",
"status": "string",
"statusDt": "2021-01-11T09:16:17.967Z",
"relation": "string",
"product": "string",
"realProduct": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"industryId": 0,
"industryName": "string",
"creation": "string",
"instanceOwnerName": "string",
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.5 Account manager lov
Endpoint for account manager lov.
Method Overview
This method returns a list of Account manager lov.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering Account manager lov described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and the following attributes: id, name.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of account manager lov. | No links |
default | Unexpected error. | No links |
Success Response 200: A list of account manager lov
{
"data": [
{
"id": 0,
"name": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.6 Account manager partner lov
Endpoint for account manager partner lov.
Method Overview
This method returns a list of Account manager partner lov.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering Account manager lov described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty,isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, status, briefName, productType, productTypeCodeName, relationTypeId, relationTypeCodeName, accountManagerId.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of account manager partners lov. | No links |
default | Unexpected error. | No links |
Success Response 200: List of account manager partners lov
{
"data": [
{
"id": 0,
"name": "string",
"briefName": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.7 Address type
Endpoint for address type.
Method Overview
This method returns a list of Address types.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering Address types described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, codeName, status, statusDt.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Address types. | No links |
default | Unexpected error. | No links |
Success Response 200: A list of Address types
{
"data": [
{
"id": 0,
"codeName": "string",
"name": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.8 Biz contact type
Endpoints for working with biz contact type.
Method Overview
This method returns a list of Biz contact types.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering Biz contact types described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, favorite, name, status, statusDt.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz contact types. | No links |
default | Unexpected error. | No links |
Success Response 200: A list of Biz contact types
{
"data": [
{
"id": 0,
"codeName": "string",
"name": "string",
"status": "active"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a Biz contact type for a given ID.
The required privilege: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz contact type ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Biz contact type data. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz contact type data
{
"id": 0,
"codeName": "string",
"name": "string",
"status": "active"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.9 Biz department
Endpoints for working with biz department.
Method Overview
This method returns a list of Biz departments.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering Biz departments described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, favorite, name, status, statusDt.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz departments. | No links |
default | Unexpected error. | No links |
Success Response 200: A list of Biz departments
{
"data": [
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-01-13T14:14:14.369Z",
"favorite": "yes"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a Biz department data by ID.
The required privilege: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz department ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Biz department data. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz department data
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-01-13T14:19:35.549Z",
"favorite": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.10 LegalForms
Endpoints for working with legal forms.
Method Overview
This method returns a list of legal forms.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering legal forms described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, countryId, legalForm, status, statusDt.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Legal Form Records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Legal Form Records
{
"data": [
{
"id": 0,
"countryId": 0,
"legalForm": "string",
"status": "active",
"statusDt": "2021-01-13T18:06:33.953Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns Legal Form record for a given ID.
The required privilege: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | LegalForms ID. |
Responses
Code | Description | Links |
---|---|---|
200 | LegalForms data. | No links |
default | Unexpected error. | No links |
Success Response 200: LegalForms data
{
"id": 0,
"countryId": 0,
"legalForm": "string",
"status": "active",
"statusDt": "2021-01-13T18:11:44.996Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.11 Biz partner active lov
This endpoint returns a list of Biz partner active lov.
Method Overview
This method returns a list of Biz partner active lov.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering Biz partner active lov described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, countryName, vatNumber, vatApply, regNumber, legalForm, briefName, eMail, phone, fax, taxExempt, dunsNumber, industryName, companySize, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz partner active lov. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Biz partner active lov
{
"data": [
{
"id": 0,
"instanceOwnerName": "string",
"externalRefId": 0,
"name": "string",
"briefName": "string",
"country": 0,
"countryName": "string",
"vatNumber": "string",
"vatApply": "string",
"regNumber": "string",
"dunsNumber": "string",
"status": "string",
"parentId": "string",
"statusDt": "2021-01-13T18:14:20.888Z",
"statusActiveDt": "2021-01-13T18:14:20.888Z",
"legalAddressId": 0,
"legalFormId": 0,
"legalForm": "string",
"language": "string",
"languageName": "string",
"taxExempt": "string",
"foundingD": "string",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.12 Biz partner address
Endpoints for working with Biz partner addresses.
Method Overview
This method returns a list of Biz partner addresses.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering Biz partner addresses described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, bizPartnerId, addressTypeId, addressTypeName, country, countryName, name, branchName, address, poBox, postalCode, city, province, attnPerson, eMail, phone, fax, bizPartnerBriefName, addressTypeCodeName.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz partner addresses. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Biz partner addresses
{
"data": [
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": [
{
"id": 0,
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates Biz partner addresses.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | string (path) | Biz partner ID. |
post data (required) | object (body) | Biz partner address data. |
Data Parameters
Biz partner address data object example
{
"addressTypeId": 0,
"country": 0,
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": 0,
"longitude": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": {
"data": [
{
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
}
Responses
Code | Description | Links |
---|---|---|
201 | Biz partner address created. | No links |
default | Unexpected error. | No links |
Success Response 201: Biz partner address created
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": [
{
"id": 0,
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns Biz partner addresses.
The required privileges: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
addressId (required) | integer (path) | Address ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Biz partner address data. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz partner address data
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": [
{
"id": 0,
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates Biz partner addresses.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
addressId (required) | integer (path) | Address ID. |
put data (required) | object (body) | Biz partner address data. |
Data Parameters
put data object example
{
"addressTypeId": 0,
"country": 0,
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": 0,
"longitude": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": {
"data": [
{
"id": 0,
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
}
Responses
Code | Description | Links |
---|---|---|
200 | Biz partner address updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz partner address updated successfully
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": [
{
"id": 0,
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes Biz partner addresses.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
addressId (required) | integer (path) | Address ID. |
Responses
Code | Description | Links |
---|---|---|
204 | Biz partner address deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 204: Biz partner address deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.13 Biz partner contact
Endpoints for working with Biz partner contacts.
Method Overview
This method returns Biz partner contact.
The required privileges: biz-core.view or biz-core.own.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
contactId (required) | integer (path) | Contact ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Biz partner contact data. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz partner contact data
{
"id": 0,
"bizPartnerId": 0,
"contactTypeId": 0,
"customTypeName": "string",
"firstName": "string",
"lastName": "string",
"nickName": "string",
"salutation": "formal",
"titel": "string",
"gender": "male",
"language": "string",
"addressId": 0,
"eMailBusiness": "string",
"eMailPrivate": "string",
"phoneOfficeDirect": "string",
"phoneOfficeCentral": "string",
"mobile": "string",
"mobileBusiness": "string",
"skype": "string",
"birthday": "2021-01-14",
"departmentId": 0,
"positionId": 0,
"customPositionName": "string",
"picture": "string",
"fax": "string",
"status": "active",
"statusDt": "2021-01-14T09:54:29.198Z",
"address": "string",
"postalCode": "string",
"city": "string",
"countryId": 0,
"countryName": "string",
"contactTypeName": "string",
"partnerName": "string",
"languageName": "string",
"partnerBriefName": "string",
"departmentName": "string",
"positionName": "string",
"note": "string",
"extraAttributes": {
"data": [
{
"id": 0,
"sectionId": 0,
"attributeId": 0,
"attributeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
]
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates a Biz partner contact.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
contactId (required) | integer (path) | Contact ID. |
put data (required) | object (body) | Biz partner contact data. |
Data Parameters
put data object example
{
"firstName": "string",
"lastName": "string",
"nickName": "string",
"salutation": "string",
"titel": "string",
"gender": "string",
"language": "string",
"eMailBusiness": "string",
"eMailPrivate": "string",
"phoneOfficeDirect": "string",
"phoneOfficeCentral": "string",
"mobile": "string",
"mobileBusiness": "string",
"skype": "string",
"birthday": "2021-01-14",
"contactTypeId": 0,
"customTypeName": "string",
"departmentId": 0,
"positionId": 0,
"customPositionName": "string",
"fax": "string",
"address": "string",
"postalCode": "string",
"city": "string",
"countryId": 0,
"extraAttributes": {
"data": [
{
"id": 0,
"attributeId": 0,
"attributeValue": "string",
"customAttrName": "string"
}
]
}
}
Responses
Code | Description | Links |
---|---|---|
200 | Biz partner contact updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz partner contact updated successfully
{
"id": 0,
"bizPartnerId": 0,
"contactTypeId": 0,
"customTypeName": "string",
"firstName": "string",
"lastName": "string",
"nickName": "string",
"salutation": "formal",
"titel": "string",
"gender": "male",
"language": "string",
"addressId": 0,
"eMailBusiness": "string",
"eMailPrivate": "string",
"phoneOfficeDirect": "string",
"phoneOfficeCentral": "string",
"mobile": "string",
"mobileBusiness": "string",
"skype": "string",
"birthday": "2021-01-14",
"departmentId": 0,
"positionId": 0,
"customPositionName": "string",
"picture": "string",
"fax": "string",
"status": "active",
"statusDt": "2021-01-14T09:59:00.378Z",
"address": "string",
"postalCode": "string",
"city": "string",
"countryId": 0,
"countryName": "string",
"contactTypeName": "string",
"partnerName": "string",
"languageName": "string",
"partnerBriefName": "string",
"departmentName": "string",
"positionName": "string",
"note": "string",
"extraAttributes": {
"data": [
{
"id": 0,
"sectionId": 0,
"attributeId": 0,
"attributeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
]
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes a Biz partner contact.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
contactId (required) | integer (path) | Contact ID. |
Responses
Code | Description | Links |
---|---|---|
204 | Biz partner contact deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 204: Biz partner contact deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of Biz partner contacts.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering Biz partner contacts described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, contactTypeId, firstName, lastName, nickName, salutation, eMailBusiness, departmentName, positionName, phoneOfficeDirect, mobile, address, postalCode, city, countryName, note, contactTypeName, titel, birthday, gender, language, languageName, addressId, eMailPrivate, phoneOfficeCentral, mobileBusiness, skype, departmentId, positionId, fax, status, countryId.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz partner contacts. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Biz partner contacts
{
"data": [
{
"id": 0,
"bizPartnerId": 0,
"contactTypeId": 0,
"customTypeName": "string",
"firstName": "string",
"lastName": "string",
"nickName": "string",
"salutation": "formal",
"titel": "string",
"gender": "male",
"language": "string",
"addressId": 0,
"eMailBusiness": "string",
"eMailPrivate": "string",
"phoneOfficeDirect": "string",
"phoneOfficeCentral": "string",
"mobile": "string",
"mobileBusiness": "string",
"skype": "string",
"birthday": "2021-01-14",
"departmentId": 0,
"positionId": 0,
"customPositionName": "string",
"picture": "string",
"fax": "string",
"status": "active",
"statusDt": "2021-01-14T14:38:07.170Z",
"address": "string",
"postalCode": "string",
"city": "string",
"countryId": 0,
"countryName": "string",
"contactTypeName": "string",
"partnerName": "string",
"languageName": "string",
"partnerBriefName": "string",
"departmentName": "string",
"positionName": "string",
"note": "string",
"extraAttributes": {
"data": [
{
"id": 0,
"sectionId": 0,
"attributeId": 0,
"attributeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
]
}
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates Biz partner contacts.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
post data | object (body) | Biz partner contact data. |
Data Parameters
post data object example
{
"firstName": "string",
"lastName": "string",
"nickName": "string",
"salutation": "string",
"titel": "string",
"gender": "string",
"language": "string",
"eMailBusiness": "string",
"eMailPrivate": "string",
"phoneOfficeDirect": "string",
"phoneOfficeCentral": "string",
"mobile": "string",
"mobileBusiness": "string",
"skype": "string",
"birthday": "2021-01-14",
"contactTypeId": 0,
"customTypeName": "string",
"departmentId": 0,
"positionId": 0,
"customPositionName": "string",
"fax": "string",
"address": "string",
"postalCode": "string",
"city": "string",
"countryId": 0,
"extraAttributes": {
"data": [
{
"attributeId": 0,
"attributeValue": "string",
"customAttrName": "string"
}
]
}
}
Responses
Code | Description | Links |
---|---|---|
201 | Biz partner address created. | No links |
default | Unexpected error. | No links |
Success Response 201: Biz partner address created
{
"id": 0,
"bizPartnerId": 0,
"contactTypeId": 0,
"customTypeName": "string",
"firstName": "string",
"lastName": "string",
"nickName": "string",
"salutation": "formal",
"titel": "string",
"gender": "male",
"language": "string",
"addressId": 0,
"eMailBusiness": "string",
"eMailPrivate": "string",
"phoneOfficeDirect": "string",
"phoneOfficeCentral": "string",
"mobile": "string",
"mobileBusiness": "string",
"skype": "string",
"birthday": "2021-01-14",
"departmentId": 0,
"positionId": 0,
"customPositionName": "string",
"picture": "string",
"fax": "string",
"status": "active",
"statusDt": "2021-01-14T14:44:17.851Z",
"address": "string",
"postalCode": "string",
"city": "string",
"countryId": 0,
"countryName": "string",
"contactTypeName": "string",
"partnerName": "string",
"languageName": "string",
"partnerBriefName": "string",
"departmentName": "string",
"positionName": "string",
"note": "string",
"extraAttributes": {
"data": [
{
"id": 0,
"sectionId": 0,
"attributeId": 0,
"attributeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
]
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates Biz partner contact status.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
contactId (required) | integer (path) | Contact ID. |
put data (required) | object (body) | Biz partner contact status data. |
Data Parameters
put data object example
{
"status": "active"
}
Responses
Code | Description | Links |
---|---|---|
200 | Biz partner contact updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz partner contact updated successfully
{
"id": 0,
"bizPartnerId": 0,
"contactTypeId": 0,
"customTypeName": "string",
"firstName": "string",
"lastName": "string",
"nickName": "string",
"salutation": "formal",
"titel": "string",
"gender": "male",
"language": "string",
"addressId": 0,
"eMailBusiness": "string",
"eMailPrivate": "string",
"phoneOfficeDirect": "string",
"phoneOfficeCentral": "string",
"mobile": "string",
"mobileBusiness": "string",
"skype": "string",
"birthday": "2021-02-09",
"departmentId": 0,
"positionId": 0,
"customPositionName": "string",
"picture": "string",
"fax": "string",
"status": "active",
"statusDt": "2021-02-09T10:00:18.023Z",
"address": "string",
"postalCode": "string",
"city": "string",
"countryId": 0,
"countryName": "string",
"contactTypeName": "string",
"partnerName": "string",
"languageName": "string",
"partnerBriefName": "string",
"departmentName": "string",
"positionName": "string",
"note": "string",
"extraAttributes": {
"data": [
{
"id": 0,
"sectionId": 0,
"attributeId": 0,
"attributeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
]
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.14 Products
Endpoints for working with products.
Method Overview
This method returns a list of all Products.
This endpoint accepts query parameters for filtering Products described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, name, status, productType, statusDt, product_type, status_dt, code_name. Sort available options: id, codeName, name, status, productType, statusDt, product_type, status_dt, code_name.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Products. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Products
{
"data": [
{
"id": 0,
"productType": 0,
"name": "string",
"codeName": "string",
"status": "active",
"statusDt": "2021-03-05T19:37:23.172Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns product for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Product ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Product data. | No links |
default | Unexpected error. | No links |
Success Response 200: Product data
{
"id": 0,
"productType": 0,
"name": "string",
"codeName": "string",
"status": "active",
"statusDt": "2021-03-05T19:37:23.189Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of all Biz partner products.
This endpoint accepts query parameters for filtering Biz partner products described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, name, status, productType, productTypeCodeName, productTypeName, isOurProduct, isSupplierProduct.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Products. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Products
{
"data": [
{
"id": 0,
"productType": 0,
"name": "string",
"codeName": "string",
"status": "active",
"statusDt": "2022-02-01T15:30:35.138Z",
"productTypeName": "string",
"productTypeCodeName": "string",
"isOurProduct": "string",
"isSupplierProduct": "string",
"productContextStatus": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a Biz partner product for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Product ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Product data. | No links |
default | Unexpected error. | No links |
Success Response 200: Product data
{
"id": 0,
"productType": 0,
"name": "string",
"codeName": "string",
"status": "active",
"statusDt": "2021-03-05T19:37:23.199Z",
"productTypeName": "string",
"productTypeCodeName": "string",
"isOurProduct": "string",
"isSupplierProduct": "string",
"productContextStatus": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.15 BizPartnerProducts
Endpoints for working with Biz partner Products.
Method Overview
This method returns Biz partner product record for a given partnerId and bizProductId.
The required privileges: biz-core.view or biz-core.own.view.
URL Parameters
Name | Type | Description |
---|---|---|
partnerId (required) | integer (path) | Biz partner ID. |
bizProductId (required) | integer (path) | Product ID. |
Responses
Code | Description | Links |
---|---|---|
200 | BizPartnerProduct data. | No links |
default | Unexpected error. | No links |
Success Response 200: BizPartnerProduct data
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerBriefName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"productId": 0,
"productName": "string",
"productCodeName": "string",
"relationTypeId": 0,
"relationTypeName": "string",
"relationTypeCodeName": "string",
"status": "string",
"enabledDt": "2021-01-15T14:46:29.060Z",
"disabledDt": "2021-01-15T14:46:29.060Z",
"statusDt": "2021-01-15T14:46:29.060Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"serviceCategoryId": 0,
"serviceProductName": "string",
"productBulkSms": {
"id": 0,
"bizpProductId": 0,
"sellingPaymentType": "string",
"sellingPaymentDue": 0,
"validFromD": "2021-01-15",
"billingCycle": 0,
"billingCycleUnit": "string",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0,
"currencyCode": "string",
"currencyName": "string"
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes logically Biz partner product record for a given partnerId and bizProductId.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
partnerId (required) | integer (path) | Biz partner ID. |
bizProductId (required) | integer (path) | Product ID. |
Responses
Code | Description | Links |
---|---|---|
204 | BizPartnerProduct data deleted. | No links |
409 | BizPartnerProduct data can not be deleted due to its relation type owner. | No links |
default | Unexpected error. | No links |
Success Response 204: BizPartnerProduct data deleted
Error Response 409: BizPartnerProduct data can not be deleted due to its relation type owner
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates Biz partner product record for a given partnerId and bizProductId.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
partnerId (required) | integer (path) | Biz partner ID. |
bizProductId (required) | integer (path) | Product ID. |
put data (required) | object (body) | Biz partner product data. |
Data Parameters
put data object example
{
"productType": 0,
"productId": 0,
"relationTypeId": 0,
"status": "string",
"notes": "string",
"customerType": "enterprise",
"accountManagerId": 0,
"productBulkSms": {
"sellingPaymentType": "prepaid",
"sellingPaymentDue": 0,
"validFromD": "2021-01-20",
"billingCycle": 0,
"billingCycleUnit": "Days",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0
}
}
Responses
Code | Description | Links |
---|---|---|
200 | BizPartnerProduct data updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: BizPartnerProduct data updated successfully
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerBriefName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"productId": 0,
"productName": "string",
"productCodeName": "string",
"relationTypeId": 0,
"relationTypeName": "string",
"relationTypeCodeName": "string",
"status": "string",
"enabledDt": "2022-02-01T15:57:46.317Z",
"disabledDt": "2022-02-01T15:57:46.317Z",
"statusDt": "2022-02-01T15:57:46.317Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"accountManagerName": "string",
"serviceCategoryId": 0,
"serviceProductName": "string",
"productBulkSms": {
"id": 0,
"bizpProductId": 0,
"sellingPaymentType": "string",
"sellingPaymentDue": 0,
"validFromD": "2022-02-01",
"billingCycle": 0,
"billingCycleUnit": "string",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0,
"currencyCode": "string",
"currencyName": "string"
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates Biz partner product record for a given partnerId and bizProductId.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
partnerId (required) | integer (path) | Biz partner ID. |
post data (required) | object (body) | Biz partner product data. |
Data Parameters
post data object example
{
"productType": 0,
"productId": 0,
"relationTypeId": 0,
"status": "enabled",
"notes": "string",
"customerType": "enterprise",
"accountManagerId": 0,
"productBulkSms": {
"sellingPaymentType": "prepaid",
"sellingPaymentDue": 0,
"validFromD": "2021-01-20",
"billingCycle": 0,
"billingCycleUnit": "Days",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0
}
}
Responses
Code | Description | Links |
---|---|---|
200 | BizPartnerProduct data updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: BizPartnerProduct data updated successfully
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerBriefName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"productId": 0,
"productName": "string",
"productCodeName": "string",
"relationTypeId": 0,
"relationTypeName": "string",
"relationTypeCodeName": "string",
"status": "string",
"enabledDt": "2021-01-20T16:37:46.851Z",
"disabledDt": "2021-01-20T16:37:46.851Z",
"statusDt": "2021-01-20T16:37:46.851Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"serviceCategoryId": 0,
"serviceProductName": "string",
"productBulkSms": {
"id": 0,
"bizpProductId": 0,
"sellingPaymentType": "string",
"sellingPaymentDue": 0,
"validFromD": "2021-01-20",
"billingCycle": 0,
"billingCycleUnit": "string",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0,
"currencyCode": "string",
"currencyName": "string"
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of Biz partner product records for a given partnerId.
This endpoint accepts query parameters for filtering Biz partner products described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
partnerId (required) | integer (path) | Biz partner ID. |
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, productType, productTypeName, productTypeCodeName, productId, productName, productCodeName, relationTypeId, relationTypeName, status, sellingPaymentType, sellingPaymentDue, billingCycle, billingCycleUnit, accountManagerName, currencyId, currencyCode, currencyName, invoiceTriggerAmount, overdraftLimit, creditLimit, deposit, bankGuarantee, disputePercent, maxDispute, announcementDays.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of All Biz partner Products. | No links |
default | Unexpected error. | No links |
Success Response 200: List of All Biz partner Products
{
"data": [
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerBriefName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"productId": 0,
"productName": "string",
"productCodeName": "string",
"relationTypeId": 0,
"relationTypeName": "string",
"relationTypeCodeName": "string",
"status": "string",
"enabledDt": "2021-01-20T16:40:34.843Z",
"disabledDt": "2021-01-20T16:40:34.843Z",
"statusDt": "2021-01-20T16:40:34.843Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"serviceCategoryId": 0,
"serviceProductName": "string",
"productBulkSms": {
"id": 0,
"bizpProductId": 0,
"sellingPaymentType": "string",
"sellingPaymentDue": 0,
"validFromD": "2021-01-20",
"billingCycle": 0,
"billingCycleUnit": "string",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0,
"currencyCode": "string",
"currencyName": "string"
}
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of Biz partner allowed products.
This endpoint accepts query parameters for filtering Biz partner allowed products described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
partnerId (required) | integer (path) | Biz partner ID. |
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, bizPartnerId, bizPartnerName, status, productType, productTypeCodeName, productTypeName, productId, productCodeName, productName, relationTypeId, relationTypeCodeName, relationType, status, customerType, accountManagerId, accountManagerName, serviceCategoryId.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of allowed products for Biz partner. | No links |
default | Unexpected error. | No links |
Success Response 200: List of allowed products for Biz partner
{
"data": [
{
"id": 0,
"name": "string",
"codeName": "string",
"productTypeId": 0,
"productTypeName": "string",
"productTypeCodeName": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of all Biz partner products.
This endpoint accepts query parameters for filtering Biz partner products described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, bizPartnerId, bizPartnerName, status, productType, productTypeCodeName, productTypeName, productId, productCodeName, productName, relationTypeId, relationTypeCodeName, relationType, status, customerType, accountManagerId, accountManagerName, serviceCategoryId.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of All Biz partner Products. | No links |
default | Unexpected error. | No links |
Success Response 200: List of All Biz partner Products
{
"data": [
{
"id": 0,
"instanceId": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"productType": 0,
"productTypeName": "string",
"productTypeCodeName": "string",
"productName": "string",
"productCodeName": "string",
"productId": 0,
"relationTypeId": 0,
"relationTypeCodeName": "string",
"relationType": "string",
"status": "enabled",
"statusDt": "2021-01-20T16:51:26.519Z",
"enabledDt": "2021-01-20T16:51:26.519Z",
"disabledDt": "2021-01-20T16:51:26.519Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"accountManagerName": "string",
"serviceCategoryId": 0,
"serviceCategoryName": "string",
"serviceProductName": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns Biz partner product data.
URL Parameters
Name | Type | Description |
---|---|---|
partnerId (required) | integer (path) | Biz partner products ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Biz partner Product data. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz partner Product data
{
"id": 0,
"instanceId": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"productType": 0,
"productTypeName": "string",
"productTypeCodeName": "string",
"productName": "string",
"productCodeName": "string",
"productId": 0,
"relationTypeId": 0,
"relationTypeCodeName": "string",
"relationType": "string",
"status": "enabled",
"statusDt": "2022-02-02T08:41:05.519Z",
"enabledDt": "2022-02-02T08:41:05.519Z",
"disabledDt": "2022-02-02T08:41:05.519Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"accountManagerName": "string",
"serviceCategoryId": 0,
"serviceCategoryName": "string",
"serviceProductName": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deactivates and activates Biz partner products for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner product ID. |
put data (required) | object (body) | Biz partner product data. |
Data Parameters
put data object example
{
"status": "suspended"
}
Responses
Code | Description | Links |
---|---|---|
200 | Biz partner Product data. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz partner Product data
{
"id": 0,
"instanceId": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"productType": 0,
"productTypeName": "string",
"productTypeCodeName": "string",
"productName": "string",
"productCodeName": "string",
"productId": 0,
"relationTypeId": 0,
"relationTypeCodeName": "string",
"relationType": "string",
"status": "enabled",
"statusDt": "2021-01-21T16:14:39.918Z",
"enabledDt": "2021-01-21T16:14:39.918Z",
"disabledDt": "2021-01-21T16:14:39.918Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"accountManagerName": "string",
"serviceCategoryId": 0,
"serviceCategoryName": "string",
"serviceProductName": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.16 Currency
Endpoints for working with currencies.
Method Overview
This method returns a list of currencies.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering currencies described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, code, status, statusDt, type.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of currency records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of currency records.
{
"data": [
{
"id": 0,
"name": "string",
"code": "string",
"status": "string",
"statusDt": "2021-01-21T16:24:19.072Z",
"type": "formal"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a Currency record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Currency ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Currency data. | No links |
default | Unexpected error. | No links |
Success Response 200: Currency data
{
{
"id": 0,
"name": "string",
"code": "string",
"status": "string",
"statusDt": "2021-01-21T16:28:02.575Z",
"type": "formal"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.17 Country
Endpoints for working with countries.
Method Overview
This method returns a list of countries.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering countries described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, code2, code3, currency, defLang, status, statusDt, domain, dialCode, type, continent.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of country records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of country records
{
"data": [
{
"id": 0,
"name": "string",
"code2": "string",
"code3": "string",
"type": "formal",
"currency": 0,
"defLang": "string",
"status": "A",
"statusDt": "2021-01-21T16:33:00.657Z",
"domain": "string",
"dialCode": "string",
"continent": "string",
"defTaxCategoryId": 0,
"cashRounding": 0
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns Country record for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Country ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Country data. | No links |
default | Unexpected error. | No links |
Success Response 200: Country data
{
"id": 0,
"name": "string",
"code2": "string",
"code3": "string",
"type": "formal",
"currency": 0,
"defLang": "string",
"status": "A",
"statusDt": "2021-03-05T19:24:14.355Z",
"domain": "string",
"dialCode": "string",
"continent": "string",
"defTaxCategoryId": 0,
"cashRounding": 0
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of countries related to business partners.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering countries described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz partner country records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Biz partner country records
{
"data": [
{
"id": 0,
"name": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.18 Language
Endpoints for working with countries.
Method Overview
This method returns a list of languages.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering languages described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, status, statusDt.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of language records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of language records.
{
"data": [
{
"id": "string",
"name": "string",
"status": "A",
"statusDt": "2021-01-21T16:37:17.762Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns language record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Language ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Language records. | No links |
default | Unexpected error. | No links |
Success Response 200: Language records.
{
"id": "string",
"name": "string",
"status": "A",
"statusDt": "2021-01-21T16:39:05.012Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.19 MeasureUnits
Endpoints for working with measurement units.
Method Overview
This method returns a list of measurement units.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering MeasureUnits described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, code, type, ordNum, baseUnitId, baseNumerator, baseDenominator. Sort available fields: id, name, code, type, ordNum, baseUnitId, baseNumerator, baseDenominator.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of MeasureUnits records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of MeasureUnits records.
{
"data": [
{
"id": 0,
"name": "string",
"code": "string",
"type": "string",
"ordNum": 0,
"baseUnitId": 0,
"baseNumerator": 0,
"baseDenominator": 0
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns MeasureUnit record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | MeasureUnit ID. |
Responses
Code | Description | Links |
---|---|---|
200 | MeasureUnit data. | No links |
default | Unexpected error. | No links |
Success Response 200: MeasureUnit data
{
"id": 0,
"name": "string",
"code": "string",
"type": "string",
"ordNum": 0,
"baseUnitId": 0,
"baseNumerator": 0,
"baseDenominator": 0
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.20 BizPositions
Endpoints for working with biz positions.
Method Overview
This method returns a list of BizPositions.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering BizPositions described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, codeName, status, statusDt, favorite. Sort available fields: id, name, codeName, status, statusDt, favorite.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of BizPositions records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of BizPositions records
{
"data": [
{
"id": 0,
"name": "string",
"codeName": "string",
"status": "active",
"statusDt": "2021-01-25T16:56:52.503Z",
"favorite": "yes"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a BizPosition record for a given ID.
The required privileges: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | BizPositions ID. |
Responses
Code | Description | Links |
---|---|---|
200 | BizPositions data. | No links |
default | Unexpected error. | No links |
Success Response 200: BizPositions data
{
"id": 0,
"name": "string",
"codeName": "string",
"status": "active",
"statusDt": "2021-01-25T16:58:58.382Z",
"favorite": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.21 RelationTypes
Endpoint for working with relation types.
Method Overview
This method returns a list of RelationTypes.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering RelationTypes described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, relationType.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of RelationTypes records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of RelationTypes records
{
"data": [
{
"id": 0,
"codeName": "string",
"relationType": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.22 ServiceCategories
Endpoints for working with service categories.
Method Overview
This method returns a list of ServiceCategories.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering ServiceCategories described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, category. Sort available fields: id, category.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of ServiceCategories records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of ServiceCategories records
{
"data": [
{
"id": 0,
"category": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns ServiceCategories record for a given ID.
The required privileges: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | ServiceCategories ID. |
Responses
Code | Description | Links |
---|---|---|
200 | ServiceCategories data. | No links |
default | Unexpected error. | No links |
Success Response 200: ServiceCategories data
{
"id": 0,
"category": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.23 BizPartnerLov
Endpoints for working with Biz partner lov.
Method Overview
This method returns a list of BizPartnerLov.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering BizPartnerLov described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, briefName, city, postalCode, ownerBpId, instanceRole. Sort available fields: id, name, briefName, city, postalCode.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of BizPartnerLov records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of BizPartnerLov records
{
"data": [
{
"id": 0,
"name": "string",
"briefName": "string",
"city": "string",
"postalCode": "string",
"code2": "string",
"externalRefId": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns BizPartnerLov record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | BizPartnerLov ID. |
Responses
Code | Description | Links |
---|---|---|
200 | BizPartnerLov data. | No links |
default | Unexpected error. | No links |
Success Response 200: BizPartnerLov data
{
"id": 0,
"name": "string",
"briefName": "string",
"city": "string",
"postalCode": "string",
"code2": "string",
"externalRefId": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.24 BizPartnerStatus
Endpoint for working with Biz partner status.
Method Overview
This method returns BizPartnerStatus record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.
URL Parameters
Name | Type | Description |
---|---|---|
status (required) | string (path) | Status. Available values: active, potential, archived, misc, suspended, draft. |
Responses
Code | Description | Links |
---|---|---|
200 | BizPartnerStatus data. | No links |
default | Unexpected error. | No links |
Success Response 200: BizPartnerStatus data
{
"partnerStatus": "active",
"partnerStatusCount": 0
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.25 BizPartnerStat
Endpoint for working with Biz partner stat.
Method Overview
This method returns a list of BizPartnerStat.
The required privileges: biz-core.view or biz-core.own.view.
URL Parameters
No parameters
Responses
Code | Description | Links |
---|---|---|
200 | A list of BizPartnerStat records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of BizPartnerStat records
{
"data": [
{
"relationType": "string",
"productInfo": [
{
"product": "string",
"productCount": 0
}
]
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.26 ContextOwner
Endpoint for working with context owner.
Method Overview
This method returns ContextOwner.
The required privileges: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
ownerParam (required) | string (path) | Parameter. Available values: info. |
Responses
Code | Description | Links |
---|---|---|
200 | ContextOwner record. | No links |
default | Unexpected error. | No links |
Success Response 200: ContextOwner record
{
"id": 0,
"name": "string",
"instanceRole": "string",
"country": 0,
"countryName": "string",
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": 0,
"status": "string",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"languageName": "string",
"legalForm": "string",
"briefName": "string",
"detailsId": 0,
"hasAttributes": "no",
"externalRefId": 0,
"statusActiveDt": "2021-01-26T09:31:39.875Z",
"statusDt": "2021-01-26T09:31:39.875Z",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"taxExempt": "string",
"foundingD": "2021-01-26",
"dunsNumber": "string",
"industryName": "string",
"companySize": "string",
"instanceOwnerName": "string",
"bizPartnerInstanceUid": "string",
"isIntercompany": "no",
"partnerTypeId": 0,
"partnerTypeName": "string",
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"selfOwner": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.27 EmailAccount
Endpoints for working with Email account.
Method Overview
This method returns a list of Email Accounts.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering EmailAccounts described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, canReceive, inHost, inPort, inSecurity, canSend, outHost, outPort, outSecurity, status, statusDt, bizPartnerId. Sort available fields: id, name, canReceive, inHost, inPort, inSecurity, canSend, outHost, outPort, outSecurity, status, statusDt.
|
can_send | string (query) | Filtering by column can_send. Available values: yes. |
Responses
Code | Description | Links |
---|---|---|
200 | A list of EmailAccounts records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of EmailAccounts records
{
"data": [
{
"id": 0,
"name": "string",
"canReceive": "yes",
"inHost": "string",
"inPort": 0,
"inSecurity": "string",
"canSend": "yes",
"outHost": "string",
"outPort": 0,
"outSecurity": "string",
"status": "active",
"statusDt": "2022-02-08T10:29:58.866Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns EmailAccount record for a given ID.
The required privileges: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | EmailAccount ID. |
Responses
Code | Description | Links |
---|---|---|
200 | EmailAccount data. | No links |
default | Unexpected error. | No links |
Success Response 200: EmailAccount data
{
"id": 0,
"name": "string",
"canReceive": "yes",
"inHost": "string",
"inPort": 0,
"inSecurity": "string",
"canSend": "yes",
"outHost": "string",
"outPort": 0,
"outSecurity": "string",
"status": "active",
"statusDt": "2021-01-26T09:37:10.438Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.28 FinanceEmailAddresses
Endpoint for working with finance email addresses.
Method Overview
This method returns a list of Finance Email Addresses.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering FinanceEmailAddresses described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
partnerId (required) | integer (path) | Biz partner ID. |
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Sort available fields: id, emailContactId, addressType, eMail.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of FinanceEmailAddresses records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of FinanceEmailAddresses records
{
"data": [
{
"id": 0,
"emailContactId": 0,
"addressType": "string",
"eMail": "string",
"bizPartnerId": 0,
"bizPartnerBriefName": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.29 ProductFeatures
Endpoints for working with product features.
Method Overview
This method returns a list of ProductFeatures.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering ProductFeatures described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
productId (required) | integer (path) | Product ID. |
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, productId, codeName, name, status, productName, productCodeName. Sort available fields: id, productId, codeName, name, status, productName, productCodeName.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of ProductFeatures records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of ProductFeatures records
{
"data": [
{
"id": 0,
"productId": 0,
"codeName": "string",
"name": "string",
"status": "string",
"productName": "string",
"productCodeName": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns ProductFeature record for a given ID.
The required privileges: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
productId (required) | integer (path) | Product ID. |
featureId (required) | integer (path) | Feature ID. |
Responses
Code | Description | Links |
---|---|---|
200 | ProductFeature data. | No links |
default | Unexpected error. | No links |
Success Response 200: ProductFeature data
{
"id": 0,
"productId": 0,
"codeName": "string",
"name": "string",
"status": "string",
"productName": "string",
"productCodeName": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.30 ProductTypePartnersLov
Endpoint for working with product type partners lov.
Method Overview
This method returns a list of ProductTypePartnersLov.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering ProductTypePartnersLov described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, country, countryName, vatNumber, vatApply, regNumber, legalFormId, language, status, languageName, legalForm, briefName, industryId, companySizeId, eMail, phone, fax, taxExempt, dunsNumber, industryName, companySize, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole. Sort allowed attributes: id, name, country, countryName, vatNumber, vatApply, regNumber, legalFormId, language, status, languageName, legalForm, briefName, industryId, companySizeId, eMail, phone, fax, taxExempt, dunsNumber, industryName, companySize, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of ProductTypePartnersLov. | No links |
default | Unexpected error. | No links |
Success Response 200: List of ProductTypePartnersLov
{
"data": [
{
"id": 0,
"name": "string",
"instanceRole": "string",
"country": 0,
"countryName": "string",
"vatNumber": "string",
"vatApply": "string",
"regNumber": "string",
"legalAddressId": 0,
"status": "string",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"languageName": "string",
"legalForm": "string",
"instanceOwnerName": "string",
"briefName": "string",
"detailsId": 0,
"hasAttributes": "yes",
"externalRefId": 0,
"bizPartnerInstanceUid": "string",
"statusActiveDt": "2021-01-26T09:51:36.318Z",
"statusDt": "2021-01-26T09:51:36.318Z",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"taxExempt": "string",
"foundingD": "2021-01-26T09:51:36.318Z",
"dunsNumber": "string",
"industryName": "string",
"companySize": "string",
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"selfOwner": "yes",
"isIntercompany": "yes",
"partnerTypeId": 0,
"partnerTypeName": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.31 FinanceSettings
Endpoints for working with finance settings.
Method Overview
This method returns FinanceSettings record for a given ID.
The required privileges: biz-core.view.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
Responses
Code | Description | Links |
---|---|---|
200 | FinanceSettings data. | No links |
default | Unexpected error. | No links |
Success Response 200: FinanceSettings data
{
"id": 0,
"productType": "string",
"productId": 0,
"invoiceAddressId": 0,
"invoiceAddressIsDefault": "yes",
"emailContactId": 0,
"emailAddressIsDefault": "yes",
"hardCopyAddressId": 0,
"hardCopyAddressIsDefault": "yes",
"nettingPartner": "yes",
"emailAccountId": 0,
"smtpAccount": "string",
"emailAddressTO": "user@example.com",
"emailAddressCC": "user@example.com",
"emailAddressBcc": "user@example.com"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates FinanceSettings for a given ID.
The required privileges: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
put data (required) | object (body) | Finance settings data. |
Data Parameters
put data object example
{
"partnerInDraft": "yes",
"nettingPartner": "yes",
"hardCopyAddressIsDefault": "yes",
"invoiceAddressId": 0,
"emailContact": {
"emailAccountId": 0,
"emailAddresses": [
{
"addressType": "to",
"eMail": "user@example.com"
}
]
}
}
Responses
Code | Description | Links |
---|---|---|
200 | Biz partner address updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Biz partner address updated successfully
{
"id": 0,
"productType": "string",
"productId": 0,
"invoiceAddressId": 0,
"invoiceAddressIsDefault": "yes",
"emailContactId": 0,
"emailAddressIsDefault": "yes",
"hardCopyAddressId": 0,
"hardCopyAddressIsDefault": "yes",
"nettingPartner": "yes",
"emailAccountId": 0,
"smtpAccount": "string",
"emailAddressTO": "user@example.com",
"emailAddressCC": "user@example.com",
"emailAddressBcc": "user@example.com"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.32 ProductTypes
Endpoint for working with product types.
Method Overview
This method returns a list of ProductTypes.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering ProductTypes described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, codeName, status, statusDt. Sort available fields: id, name, codeName, status, statusDt.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of ProductTypes records. | No links |
default | Unexpected error. | No links |
Success Response 200: List of ProductTypes records
{
"data": [
{
"id": 0,
"name": "string",
"codeName": "string",
"status": "active",
"statusDt": "2021-02-01T10:02:01.249Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.33 Biz partner types
Endpoint for working with Biz partner types.
Method Overview
This method returns a list of all Biz partner types.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering fee product categories described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, and by following attributes: id, name, instanceId, favorite.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Biz partner types. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Biz partner types
{
"data": [
{
"id": 0,
"name": "string",
"status": "string",
"favorite": "yes"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.34 BizSettings
Endpoint for working with BizSettings.
Method Overview
This method returns BizSettings record from the database on the Biz partner instance.
URL Parameters
Name | Type | Description |
---|---|---|
param (required) | string (path) | BizSettings param to get. |
Responses
Code | Description | Links |
---|---|---|
200 | BizSettings data. | No links |
default | Unexpected error. | No links |
Success Response 200: BizSettings data
{
"instanceId": 0,
"coOwnersEnabled": "no",
"resellersEnabled": "no"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.35 WebSocials
Endpoints for working with WebSocials.
Method Overview
This method returns a list of all WebSocial.
This endpoint accepts query parameters for filtering WebSocial described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and by following attributes: id, name, sectionRowId, value, status, sectionCodeName(DETAILS, CONTACTS, FINANCE-SETTINGS).
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of WebSocials. | No links |
default | Unexpected error. | No links |
Success Response 200: List of WebSocials
{
"data": [
{
"id": 0,
"name": "string",
"sectionRowId": 0,
"value": "string",
"status": "active",
"statusDt": "2021-02-01T13:15:44.579Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new WebSocial record.
URL Parameters
Name | Type | Description |
---|---|---|
sectionCodeName (required) | string (path) | Code name for section - DETAILS, CONTACTS, FINANCE-SETTINGS. |
post data (required) | object (body) | WebSocial data. |
Data Parameters
post data object example
{
"name": "string",
"sectionRowId": 0,
"value": "string"
}
Responses
Code | Description | Links |
---|---|---|
200 | WebSocial record created. | No links |
default | Unexpected error. | No links |
Success Response 200: WebSocial record created
{
"id": 0,
"name": "string",
"sectionRowId": 0,
"value": "string",
"status": "active",
"statusDt": "2021-02-01T13:19:05.861Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns WebSocials details for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | WebSocial ID. |
Responses
Code | Description | Links |
---|---|---|
200 | WebSocial data. | No links |
default | Unexpected error. | No links |
Success Response 200: WebSocial data
{
"id": 0,
"name": "string",
"sectionRowId": 0,
"value": "string",
"status": "active",
"statusDt": "2021-02-01T13:23:23.357Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates a WebSocial record.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | WebSocial ID. |
put data (required) | object (body) | WebSocial data. |
Data Parameters
put data object example
{
"name": "string",
"value": "string"
}
Responses
Code | Description | Links |
---|---|---|
200 | WebSocial updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: WebSocial updated successfully
{
"id": 0,
"name": "string",
"sectionRowId": 0,
"value": "string",
"status": "active",
"statusDt": "2021-02-01T13:27:17.172Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes a WebSocial record for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | WebSocial ID. |
Responses
Code | Description | Links |
---|---|---|
200 | WebSocial deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: WebSocial deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.36 PartnerTypes
Endpoints for working with PartnerTypes.
Method Overview
This method returns a list of all PartnerTypes.
This endpoint accepts query parameters for filtering PartnerTypes described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, name, status, favorite.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of PartnerTypes. | No links |
default | Unexpected error. | No links |
Success Response 200: List of PartnerTypes
{
"data": [
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-01T13:35:51.271Z",
"dbCodeName": "string",
"comment": "yes"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new PartnerType record.
URL Parameters
Name | Type | Description |
---|---|---|
post data (required) | object (body) | Partner type data. |
Data Parameters
post data object example
{
"name": "manually",
"selfOwner": "yes"
}
Responses
Code | Description | Links |
---|---|---|
200 | PartnerType record created. | No links |
default | Unexpected error. | No links |
Success Response 200: PartnerType record created
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-01T13:42:20.637Z",
"dbCodeName": "string",
"comment": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns PartnerType data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | PartnerType ID. |
Responses
Code | Description | Links |
---|---|---|
200 | PartnerType data. | No links |
default | Unexpected error. | No links |
Success Response 200: PartnerType data
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-01T13:42:20.637Z",
"dbCodeName": "string",
"comment": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates PartnerType data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | PartnerType ID. |
put data (required) | object (body) | PartnerType data. |
Data Parameters
put data object example
{
"name": "string",
"taxExempt": "string",
"foundingD": "2021-02-01T13:48:47.047Z",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string",
"hasAttributes": "yes",
"isIntercompany": "yes"
}
Responses
Code | Description | Links |
---|---|---|
200 | PartnerType updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: PartnerType updated successfully
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-01T13:49:39.022Z",
"dbCodeName": "string",
"comment": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes PartnerType data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | PartnerType ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Partner Type data deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Partner Type data deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.37 Industries
Endpoints for working with Industries.
Method Overview
This method returns a list of all Industries.
This endpoint accepts query parameters for filtering Industries described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, name, status, favorite.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Industries. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Industries
{
"data": [
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-02T12:56:10.108Z",
"canBeDeleted": true,
"favorite": "yes"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new Industry record.
URL Parameters
Name | Type | Description |
---|---|---|
post data (required) | object (body) | Industry data. |
Data Parameters
post data object example
{
"name": "string",
"favorite": "yes"
}
Responses
Code | Description | Links |
---|---|---|
200 | Industry record created. | No links |
default | Unexpected error. | No links |
Success Response 200: Industry record created
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-02T12:58:35.192Z",
"canBeDeleted": true,
"favorite": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns Industry data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Industry ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Industry data. | No links |
default | Unexpected error. | No links |
Success Response 200: Industry data
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-02T13:01:11.368Z",
"canBeDeleted": true,
"favorite": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates Industry data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Industry ID. |
put data (required) | object (body) | Industry data. |
Data Parameters
put data object example
{
"name": "string",
"status": "active",
"favorite": "yes"
}
Responses
Code | Description | Links |
---|---|---|
200 | Industry data updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Industry data updated successfully
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-02T13:01:11.368Z",
"canBeDeleted": true,
"favorite": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes Industry data for a given ID logically.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Industry ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Industry record deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Industry record deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.38 CompanySize
Endpoints for working with CompanySizes.
Method Overview
This method returns a list of all CompanySizes.
This endpoint accepts query parameters for filtering CompanySizes described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, companySize, status, favorite.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of CompanySizes. | No links |
default | Unexpected error. | No links |
Success Response 200: List of CompanySizes
{
"data": [
{
"id": 0,
"companySize": "string",
"status": "active",
"statusDt": "2021-02-02T13:18:15.807Z",
"canBeDeleted": true,
"favorite": "yes"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new CompanySize record.
URL Parameters
Name | Type | Description |
---|---|---|
post data (required) | object (body) | Company size data. |
Data Parameters
post data object example
{
"companySize": "string",
"favorite": "yes"
}
Responses
Code | Description | Links |
---|---|---|
200 | CompanySize record created. | No links |
default | Unexpected error. | No links |
Success Response 200: CompanySize record created
{
"id": 0,
"companySize": "string",
"status": "active",
"statusDt": "2021-02-02T13:18:46.685Z",
"canBeDeleted": true,
"favorite": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns CompanySize data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | CompanySize ID. |
Responses
Code | Description | Links |
---|---|---|
200 | CompanySize data. | No links |
default | Unexpected error. | No links |
Success Response 200: CompanySize data
{
"id": 0,
"companySize": "string",
"status": "active",
"statusDt": "2021-02-02T13:19:49.252Z",
"canBeDeleted": true,
"favorite": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates CompanySize data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | CompanySize ID. |
put data (required) | object (body) | CompanySize data. |
Data Parameters
put data object example
{
"companySize": "string",
"status": "active",
"favorite": "yes"
}
Responses
Code | Description | Links |
---|---|---|
200 | CompanySize updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: CompanySize updated successfully
{
"id": 0,
"companySize": "string",
"status": "active",
"statusDt": "2021-02-02T13:20:11.935Z",
"canBeDeleted": true,
"favorite": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes CompanySize record for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | CompanySize ID. |
Responses
Code | Description | Links |
---|---|---|
200 | CompanySize deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: CompanySize deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.39 Partners
Endpoints for working with Partners.
Method Overview
This method returns a list of all Partners.
The required privileges:
- biz-core.view - Logged user can see all biz partners in the list.
- biz-core-own.view - Logged user can see only his own Biz partner in the list.
This endpoint accepts query parameters for filtering Partners described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds, and by following attributes: id, instanceId, name, country, vatNumber, vatApply, regNumber, legalAddressId, status, parentId, legalFormId, language, bizPartnerUid, briefName, partnerDetailsId, notificationAddressId, hasAttributes, externalRefId, partnerTypeId, isIntercompany, partnerTypeName, dunsNumber, taxExempt, statusActiveDt, statusDt, foundingD, industryId, companySizeId, eMail, phone, fax, creation, industryName, companySize, languageName.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Partners. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Partners
{
"data": [
{
"id": 0,
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": 0,
"value": "string",
"status": "potential",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"bizPartnerUid": "string",
"partnerDetailsId": 0,
"briefName": "string",
"notificationAddressId": 0,
"externalRefId": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"statusActiveDt": "2021-02-02T13:31:49.562Z",
"statusDt": "2021-02-02T13:31:49.562Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a Partner data for a given ID.
The required privileges:
- biz-core.view - Logged user can see all biz partners.
- biz-core-own.view - Logged user can see only his own Biz partner.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Partner ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Partner data. | No links |
default | Unexpected error. | No links |
Success Response 200: Partner data
{
"id": 0,
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": 0,
"status": "potential",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"bizPartnerUid": "string",
"partnerDetailsId": 0,
"briefName": "string",
"notificationAddressId": 0,
"externalRefId": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"statusActiveDt": "2022-02-18T12:41:21.202Z",
"statusDt": "2022-02-18T12:41:21.202Z",
"dunsNumber": "string",
"taxExempt": "string",
"foundingD": "2022-02-18",
"industryId": 0,
"companySizeId": 0,
"email": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string",
"hasAttributes": "yes",
"isIntercompany": "yes",
"creation": "2022-02-18",
"instanceRole": "string",
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"selfOwner": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates Partner data.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Partner ID. |
put data (required) | object (body) | Partner data. |
Data Parameters
put data object example
{
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalFormId": 0,
"language": "string",
"briefName": "string",
"externalRefId": "string",
"partnerTypeId": 0,
"isIntercompany": "yes",
"dunsNumber": "string",
"taxExempt": "string",
"foundingD": "2021-02-02",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"creation": "manually",
"selfOwner": "yes",
"ownerBpId": 0
}
Responses
Code | Description | Links |
---|---|---|
200 | Partner updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Partner updated successfully
{
"id": 0,
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": 0,
"status": "potential",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"bizPartnerUid": "string",
"partnerDetailsId": 0,
"briefName": "string",
"notificationAddressId": 0,
"externalRefId": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"statusActiveDt": "2022-02-18T12:53:12.957Z",
"statusDt": "2022-02-18T12:53:12.957Z",
"dunsNumber": "string",
"taxExempt": "string",
"foundingD": "2022-02-18",
"industryId": 0,
"companySizeId": 0,
"email": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string",
"hasAttributes": "yes",
"isIntercompany": "yes",
"creation": "2022-02-18",
"instanceRole": "string",
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"selfOwner": "yes"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes business partner logically with all necessary prior checks (pricelists, billings, balances, connections, coOwner, Business Messenger).
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Partner ID. |
Responses
Code | Description | Links |
---|---|---|
204 | Partner deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 204: Partner deleted successfully
Error Response 409: Unable to delete Partner due to its instance role or relations
{
"code": "string",
"message": "string",
"items": [
{
"name": "string",
"sectionRowId": 0,
"value": "string",
"description": "string"
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method changes Biz partner status. For deactivating process, first checks instance role, pricelists, billings, balances, connections, coOwner.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Biz partner ID. |
put data (required) | object (body) | Biz partner status. |
Data Parameters
put data object example
{
"status": "suspended"
}
Responses
Code | Description | Links |
---|---|---|
200 | Partner's status changed successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Partner's status changed successfully
{
"id": 0,
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": 0,
"status": "potential",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"bizPartnerUid": "string",
"partnerDetailsId": 0,
"briefName": "string",
"notificationAddressId": 0,
"externalRefId": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"statusActiveDt": "2022-02-18T14:08:40.702Z",
"statusDt": "2022-02-18T14:08:40.702Z",
"dunsNumber": "string",
"taxExempt": "string",
"foundingD": "2022-02-18",
"industryId": 0,
"companySizeId": 0,
"email": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string",
"hasAttributes": "yes",
"isIntercompany": "yes",
"creation": "2022-02-18",
"instanceRole": "string",
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"selfOwner": "yes"
}
Error Response 409: Unable to delete Partner due to its instance role or relations
{
"code": "string",
"message": "string",
"items": [
{
"name": "string",
"sectionRowId": 0,
"value": "string",
"description": "string"
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns Business Partner data for a given ID.
The required privileges: biz-core.view or biz-core.own.view.
Allowed embedded objects: legalAddress, bizPartnerProduct.
Example:
embed=legalAddress
embed=bizPartnerProduct.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Business Partner ID. |
embed | integer (query) | Allowed embedded objects: legalAddress, bizPartnerProducts. Example: embed=legalAddress, embed=bizPartnerProduct. |
Responses
Code | Description | Links |
---|---|---|
200 | Business Partner data. | No links |
default | Unexpected error. | No links |
Success Response 200: Business Partner data
{
"id": 0,
"instanceId": 0,
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": "string",
"status": "string",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"bizPartnerUid": "string",
"instanceOwnerName": "string",
"briefName": "string",
"countryName": "string",
"dunsNumber": "string",
"statusDt": "2021-02-02T13:51:21.794Z",
"statusActiveDt": "2021-02-02T13:51:21.794Z",
"legalForm": "string",
"languageName": "string",
"taxExempt": "string",
"foundingD": "2021-02-02",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string",
"instanceRole": "string",
"externalRefId": "string",
"bizPartnerInstanceUid": "string",
"hasAttributes": "string",
"isIntercompany": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"detailsId": 0,
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"selfOwner": "yes",
"legalAddress": {
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"branchName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyOfAddresses": [
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": [
{
"id": 0,
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
]
},
"extraAttributes": {
"data": [
{
"id": 0,
"sectionId": 0,
"attributeId": 0,
"attributeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
]
},
"businessPartnerProducts": {
"data": [
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerBriefName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"productId": 0,
"productName": "string",
"productCodeName": "string",
"relationTypeId": 0,
"relationTypeName": "string",
"relationTypeCodeName": "string",
"status": "string",
"enabledDt": "2021-02-02T13:51:21.795Z",
"disabledDt": "2021-02-02T13:51:21.795Z",
"statusDt": "2021-02-02T13:51:21.795Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"serviceCategoryId": 0,
"serviceProductName": "string",
"productBulkSms": {
"id": 0,
"bizpProductId": 0,
"sellingPaymentType": "string",
"sellingPaymentDue": 0,
"validFromD": "2021-02-02",
"billingCycle": 0,
"billingCycleUnit": "string",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0,
"currencyCode": "string",
"currencyName": "string"
}
}
]
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates Business Partner data for a given ID.
The required privilege: biz-core.manage.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Business Partner ID. |
put data (required) | object (body) | Business Partner update data. |
Data Parameters
put data object example
{
"name": "string",
"briefName": "string",
"externalRefId": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"dunsNumber": "string",
"statusActiveDt": "2021-02-02T13:55:28.477Z",
"legalFormId": 0,
"language": "string",
"taxExempt": "string",
"foundingD": "2021-02-02",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"isIntercompany": "string",
"partnerTypeId": 0,
"selfOwner": "string",
"ownerBpId": 0,
"extraAttributes": {
"data": [
{
"attributeId": 0,
"attributeValue": "string",
"customAttrName": "string"
}
]
}
}
Responses
Code | Description | Links |
---|---|---|
200 | Business Partner data. | No links |
default | Unexpected error. | No links |
Success Response 200: Business Partner data
{
"id": 0,
"instanceId": 0,
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": "string",
"status": "string",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"bizPartnerUid": "string",
"instanceOwnerName": "string",
"briefName": "string",
"countryName": "string",
"dunsNumber": "string",
"statusDt": "2022-02-28T09:51:28.728Z",
"statusActiveDt": "2022-02-28T09:51:28.728Z",
"legalForm": "string",
"languageName": "string",
"taxExempt": "string",
"foundingD": "2022-02-28",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string",
"instanceRole": "string",
"externalRefId": "string",
"bizPartnerInstanceUid": "string",
"hasAttributes": "string",
"isIntercompany": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"detailsId": 0,
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"selfOwner": "yes",
"legalAddress": {
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"branchName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyOfAddresses": [
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": [
{
"id": 0,
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
]
},
"extraAttributes": {
"data": [
{
"id": 0,
"sectionId": 0,
"attributeId": 0,
"attributeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
]
},
"businessPartnerProducts": {
"data": [
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerBriefName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"productId": 0,
"productName": "string",
"productCodeName": "string",
"relationTypeId": 0,
"relationTypeName": "string",
"relationTypeCodeName": "string",
"status": "string",
"enabledDt": "2022-02-28T09:51:28.728Z",
"disabledDt": "2022-02-28T09:51:28.728Z",
"statusDt": "2022-02-28T09:51:28.728Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"accountManagerName": "string",
"serviceCategoryId": 0,
"serviceProductName": "string",
"productBulkSms": {
"id": 0,
"bizpProductId": 0,
"sellingPaymentType": "string",
"sellingPaymentDue": 0,
"validFromD": "2022-02-28",
"billingCycle": 0,
"billingCycleUnit": "string",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0,
"currencyCode": "string",
"currencyName": "string"
}
}
]
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new Biz partner record.
The required privileges: biz-core.manage, auth.resource.add.
URL Parameters
Name | Type | Description |
---|---|---|
post data (required) | object (body) | Biz partner data. |
Data Parameters
post data object example
{
"name": "string",
"briefName": "string",
"externalRefId": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"dunsNumber": "string",
"status": "string",
"taxExempt": "string",
"foundingD": "2021-02-02",
"statusActiveDt": "2021-02-02T14:00:34.554Z",
"industryID": 0,
"companySizeId": 0,
"legalFormId": 0,
"language": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"isIntercompany": "yes",
"partnerTypeId": 0,
"selfOwner": "yes",
"ownerBpId": 0,
"addresses": {
"data": [
{
"addressTypeId": 0,
"country": 0,
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": 0,
"longitude": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": {
"data": [
{
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
}
]
},
"extraAttributes": {
"data": [
{
"attributeId": 0,
"attributeValue": "string",
"customAttrName": "string"
}
]
}
}
Responses
Code | Description | Links |
---|---|---|
201 | Business Partner record created. | No links |
default | Unexpected error. | No links |
Success Response 201: Business Partner record created
{
"id": 0,
"instanceId": 0,
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": "string",
"status": "string",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"bizPartnerUid": "string",
"instanceOwnerName": "string",
"briefName": "string",
"countryName": "string",
"dunsNumber": "string",
"statusDt": "2021-02-02T14:02:01.184Z",
"statusActiveDt": "2021-02-02T14:02:01.184Z",
"legalForm": "string",
"languageName": "string",
"taxExempt": "string",
"foundingD": "2021-02-02",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string",
"instanceRole": "string",
"externalRefId": "string",
"bizPartnerInstanceUid": "string",
"hasAttributes": "string",
"isIntercompany": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"detailsId": 0,
"ownerBpId": 0,
"ownerBpName": "string",
"ownerBpBriefName": "string",
"selfOwner": "yes",
"legalAddress": {
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"branchName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyOfAddresses": [
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerName": "string",
"bizPartnerBriefName": "string",
"addressTypeId": 0,
"addressTypeName": "string",
"addressTypeCodeName": "string",
"country": 0,
"countryName": "string",
"name": "string",
"branchName": "string",
"address": "string",
"poBox": "string",
"postalCode": "string",
"city": "string",
"province": "string",
"attnPerson": "string",
"latitude": "string",
"longitude": "string",
"eMail": "string",
"phone": "string",
"fax": "string",
"copyToAddresses": [
{
"id": 0,
"name": "string",
"branchName": "string",
"addressTypeId": 0
}
]
}
]
},
"extraAttributes": {
"data": [
{
"id": 0,
"sectionId": 0,
"attributeId": 0,
"attributeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
]
},
"businessPartnerProducts": {
"data": [
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerBriefName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"productId": 0,
"productName": "string",
"productCodeName": "string",
"relationTypeId": 0,
"relationTypeName": "string",
"relationTypeCodeName": "string",
"status": "string",
"enabledDt": "2021-02-02T14:02:01.184Z",
"disabledDt": "2021-02-02T14:02:01.184Z",
"statusDt": "2021-02-02T14:02:01.184Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"serviceCategoryId": 0,
"serviceProductName": "string",
"productBulkSms": {
"id": 0,
"bizpProductId": 0,
"sellingPaymentType": "string",
"sellingPaymentDue": 0,
"validFromD": "2021-02-02",
"billingCycle": 0,
"billingCycleUnit": "string",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0,
"currencyCode": "string",
"currencyName": "string"
}
}
]
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.40 PartnerSections
Endpoints for working with PartnerSections.
Method Overview
This method returns a list of all Partner sections.
This endpoint accepts query parameters for filtering Partner sections described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, name, status, dbCodeName, comment.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Partner sections. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Partner sections
{
"data": [
{
"id": 0,
"codeName": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-02T14:47:29.960Z",
"dbCodeName": "string",
"comment": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a Partner section data.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Partner section ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Partner section data. | No links |
default | Unexpected error. | No links |
Success Response 200: Partner section data
{
"id": 0,
"codeName": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-02T14:49:45.934Z",
"dbCodeName": "string",
"comment": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.41 AccountManagers
Endpoints for working with AccountManagers.
Method Overview
This method returns a list of all Account Managers.
This endpoint accepts query parameters for filtering Account Managers described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, name, email, status, productId, productCodeName, productName.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Account Managers. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Account Managers
{
"data": [
{
"id": 0,
"instanceId": 0,
"email": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-02T14:56:49.745Z",
"products": "string",
"productCodeNames": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new Account Manager.
URL Parameters
Name | Type | Description |
---|---|---|
post data (required) | object (body) | Account Manager data. |
Data Parameters
post data object example
{
"name": "string",
"email": "string",
"accountMgrProducts": [
{
"productId": 0
}
]
}
Responses
Code | Description | Links |
---|---|---|
200 | Account manager record created. | No links |
default | Unexpected error. | No links |
Success Response 200: Account manager record created
{
"id": 0,
"instanceId": 0,
"email": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-02T15:02:48.009Z",
"accountMgrProduct": [
{
"id": 0,
"accountMgrId": 0,
"productId": 0,
"productType": 0,
"status": "active",
"statusDt": "2021-02-02T15:02:48.009Z",
"productName": "string",
"productCodeName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"isOurProduct": "yes",
"isSupplierProduct": "yes"
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns an Account Manager data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Account Manager ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Account Manager data. | No links |
default | Unexpected error. | No links |
Success Response 200: Account Manager data
{
"id": 0,
"instanceId": 0,
"email": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-03T11:52:28.185Z",
"accountMgrProduct": [
{
"id": 0,
"accountMgrId": 0,
"productId": 0,
"productType": 0,
"status": "active",
"statusDt": "2021-02-03T11:52:28.185Z",
"productName": "string",
"productCodeName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"isOurProduct": "yes",
"isSupplierProduct": "yes"
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates an Account Manager data.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Account Manager ID. |
put data (required) | object (body) | Account Manager data. |
Data Parameters
put data object example
{
"name": "string",
"email": "string",
"status": "active",
"accountMgrProducts": [
{
"productId": 0
}
]
}
Responses
Code | Description | Links |
---|---|---|
200 | Account Manager updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Account Manager updated successfully
{
"id": 0,
"instanceId": 0,
"email": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-03T11:55:49.931Z",
"accountMgrProduct": [
{
"id": 0,
"accountMgrId": 0,
"productId": 0,
"productType": 0,
"status": "active",
"statusDt": "2021-02-03T11:55:49.931Z",
"productName": "string",
"productCodeName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"isOurProduct": "yes",
"isSupplierProduct": "yes"
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes an Account Manager data with a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | An Account Manager ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Account Manager deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Account Manager deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes all account manager assigned biz products in Biz partner products for adequate account manager ID.
URL Parameters
Name | Type | Description |
---|---|---|
accountManagerId (required) | integer (path) | An account manager ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Account manager assigned biz products in Biz partner products deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Account manager assigned biz products in Biz partner products deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.42 Attributes
Endpoints for working with Attributes.
Method Overview
This method returns a list of all Attributes.
This endpoint accepts query parameters for filtering Attributes described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, attributeTypeId, codeName, name, status, attributeKind, sectionId, sectionCodeName, sectionName, dbCodeName, comment, attributeTypeCodeName, attributeTypeName, attributeSectionStatus.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Attributes. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Attributes
{
"data": [
{
"id": 0,
"attributeTypeId": 0,
"codeName": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-03T12:04:35.206Z",
"attributeKind": "predefined",
"sections": "string",
"sectionCodeNames": "string",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"canBeDeleted": true,
"canCodeNameChange": true
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new Attribute record.
URL Parameters
Name | Type | Description |
---|---|---|
post data (required) | object (body) | Attribute data. |
Data Parameters
post data object example
{
"attributeTypeId": 0,
"codeName": "string",
"name": "string"
}
Responses
Code | Description | Links |
---|---|---|
200 | Attribute record created. | No links |
default | Unexpected error. | No links |
Success Response 200: Attribute record created
{
"id": 0,
"attributeTypeId": 0,
"codeName": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-03T12:07:57.469Z",
"attributeKind": "predefined",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"canBeDeleted": true,
"canCodeNameChange": true,
"attributeSections": [
{
"attributeId": 0,
"sectionId": 0,
"status": "active",
"statusDt": "2021-02-03T12:07:57.469Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"sectionStatus": "active",
"attributeStatus": "active",
"attributeSectionTags": [
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2021-02-03T12:07:57.469Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
]
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns Attribute data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | An Attribute ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Attribute data. | No links |
default | Unexpected error. | No links |
Success Response 200: Attribute data
{
"id": 0,
"attributeTypeId": 0,
"codeName": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-03T12:10:22.086Z",
"attributeKind": "predefined",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"canBeDeleted": true,
"canCodeNameChange": true,
"attributeSections": [
{
"attributeId": 0,
"sectionId": 0,
"status": "active",
"statusDt": "2021-02-03T12:10:22.086Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"sectionStatus": "active",
"attributeStatus": "active",
"attributeSectionTags": [
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2021-02-03T12:10:22.087Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
]
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates Attribute data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | An Attribute ID. |
put data (required) | object (body) | Attribute data. |
Data Parameters
put data object example
{
"attributeTypeId": 0,
"codeName": "string",
"name": "string",
"status": "active"
}
Responses
Code | Description | Links |
---|---|---|
200 | Attribute updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Attribute updated successfully
{
"id": 0,
"attributeTypeId": 0,
"codeName": "string",
"name": "string",
"status": "active",
"statusDt": "2021-02-03T12:13:02.394Z",
"attributeKind": "predefined",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"canBeDeleted": true,
"canCodeNameChange": true,
"attributeSections": [
{
"attributeId": 0,
"sectionId": 0,
"status": "active",
"statusDt": "2021-02-03T12:13:02.394Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"sectionStatus": "active",
"attributeStatus": "active",
"attributeSectionTags": [
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2021-02-03T12:13:02.394Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
]
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes Attribute record with a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | An Attribute ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Attribute deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Attribute deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates Attribute code name.
URL Parameters
Name | Type | Description |
---|---|---|
post data (required) | object (body) | Attribute code data. |
Data Parameters
put data object example
{
"name": "string"
}
Responses
Code | Description | Links |
---|---|---|
200 | Attribute code name data. | No links |
default | Unexpected error. | No links |
Success Response 200: Attribute code name data
{
"codeName": "string"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.43 PartnerAttributes
Endpoints for working with PartnerAttributes.
Method Overview
This method returns a list of all PartnerAttributes.
The required privileges:
- bp-settings-custom-fields.view - Logged user can see partner attributes for all biz partners in the list.
- bp-settings-custom-fields-own.view - Logged user can see only partner attributes for his own Biz partner in the list.
This endpoint accepts query parameters for filtering PartnerAttributes described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, sectionId, sectionRowId, attributeId, customAttrName, attributeValue, valueType, status, sectionCodeName, sectionName, attributeCodeName, attributeName, attributeTypeCodeName, attributeTypeName.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of PartnerAttributes. | No links |
default | Unexpected error. | No links |
Success Response 200: List of PartnerAttributes
{
"data": [
{
"id": 0,
"sectionId": 0,
"sectionRowId": 0,
"attributeId": 0,
"bizPartnerId": 0,
"customAttrName": "string",
"attributeValue": "string",
"jsonValue": {
"value": "string"
},
"valueType": "simple",
"status": "active",
"statusDt": "2021-02-04T09:14:38.360Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"attributeCodeName": "string",
"attributeName": "string",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"canBeChanged": true
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method creates a new PartnerAttribute record.
URL Parameters
Name | Type | Description |
---|---|---|
post data (required) | object (body) | Partner attribute data. |
Data Parameters
post data object example
{
"sectionId": 0,
"sectionRowId": 0,
"attributeId": 0,
"bizPartnerId": 0,
"customAttrName": "string",
"attributeValue": "string",
"jsonValue": {
"value": "string"
}
}
Responses
Code | Description | Links |
---|---|---|
200 | PartnerAttribute record created. | No links |
default | Unexpected error. | No links |
Success Response 200: PartnerAttribute record created
{
"id": 0,
"sectionId": 0,
"sectionRowId": 0,
"attributeId": 0,
"bizPartnerId": 0,
"customAttrName": "string",
"attributeValue": "string",
"jsonValue": {
"value": "string"
},
"valueType": "simple",
"status": "active",
"statusDt": "2021-02-04T09:16:07.712Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"attributeCodeName": "string",
"attributeName": "string",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"canBeChanged": true
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns a list of all PartnerAttributesExtend.
The required privileges:
- bp-settings-custom-fields.view - Logged user can see partner attributes for all biz partners in the list.
- bp-settings-custom-fields-own.view - Logged user can see only partner attributes for his own Biz partner in the list.
This endpoint accepts query parameters for filtering PartnerAttributesExtend described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, sectionId, sectionRowId, attributeId, customAttrName, attributeValue, valueType, status, sectionCodeName, sectionName, attributeCodeName, attributeName, attributeTypeCodeName, attributeTypeName, attributeTagCodeName, attributeTagName.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of PartnerAttributesExtend. | No links |
default | Unexpected error. | No links |
Success Response 200: List of PartnerAttributesExtend
{
"data": [
{
"id": 0,
"sectionId": 0,
"sectionRowId": 0,
"attributeId": 0,
"bizPartnerId": 0,
"customAttrName": "string",
"attributeValue": "string",
"jsonValue": {
"value": "string"
},
"status": "active",
"statusDt": "2021-02-04T09:19:19.278Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"attributeCodeName": "string",
"attributeName": "string",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"canBeChanged": true
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns PartnerAttribute data.
The required privileges:
- bp-settings-custom-fields.view - Logged user can see partner attributes for all biz partners.
- bp-settings-custom-fields-own.view - Logged user can see only partner attribute for his own Biz partner in the list.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | PartnerAttribute ID. |
Responses
Code | Description | Links |
---|---|---|
200 | PartnerAttribute data. | No links |
default | Unexpected error. | No links |
Success Response 200: PartnerAttribute data
{
"id": 0,
"sectionId": 0,
"sectionRowId": 0,
"attributeId": 0,
"bizPartnerId": 0,
"customAttrName": "string",
"attributeValue": "string",
"jsonValue": {
"value": "string"
},
"valueType": "simple",
"status": "active",
"statusDt": "2021-02-04T09:21:55.713Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"attributeCodeName": "string",
"attributeName": "string",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"canBeChanged": true
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates PartnerAttribute data for a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | PartnerAttribute ID. |
put data (required) | object (body) | PartnerAttribute data. |
Data Parameters
put data object example
{
"sectionId": 0,
"sectionRowId": 0,
"attributeId": 0,
"bizPartnerId": 0,
"customAttrName": "string",
"attributeValue": "string",
"jsonValue": {
"value": "string"
}
}
Responses
Code | Description | Links |
---|---|---|
200 | PartnerAttribute updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: PartnerAttribute updated successfully
{
"id": 0,
"sectionId": 0,
"sectionRowId": 0,
"attributeId": 0,
"bizPartnerId": 0,
"customAttrName": "string",
"attributeValue": "string",
"jsonValue": {
"value": "string"
},
"valueType": "simple",
"status": "active",
"statusDt": "2021-02-04T09:22:58.894Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"attributeCodeName": "string",
"attributeName": "string",
"attributeTypeCodeName": "string",
"attributeTypeName": "string",
"canBeChanged": true
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes PartnerAttribute record with a given ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | PartnerAttribute ID. |
Responses
Code | Description | Links |
---|---|---|
200 | PartnerAttribute deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: PartnerAttribute deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes PartnerAttribute record with a given attributeId and sectionId.
URL Parameters
Name | Type | Description |
---|---|---|
attrId (required) | integer (path) | Attribute ID. |
secId (required) | integer (path) | Section ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Partner attributes deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Partner attributes deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.44 AttributePartners
Endpoint for working with AttributePartners.
Method Overview
This method returns a list of all AttributePartners.
The required privileges:
- bp-settings-custom-fields.view - Logged user can see partner attributes for all biz partners in the list.
- bp-settings-custom-fields-own.view - Logged user can see only partner attributes for his own Biz partner in the list.
This endpoint accepts query parameters for filtering AttributePartners described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: attributeId, sectionId.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of AttributePartners. | No links |
default | Unexpected error. | No links |
Success Response 200: List of AttributePartners
{
"data": [
{
"partnerId": 0,
"partnerName": "string",
"partnerBriefName": "string"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.45 AttributeSections
Endpoints for working with AttributeSections.
Method Overview
This method creates a new AttributeSection record.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Attribute ID. |
post data (required) | object (body) | Attribute section data. |
Data Parameters
post data object example
{
"sectionId": 0
}
Responses
Code | Description | Links |
---|---|---|
200 | AttributeSection record created. | No links |
default | Unexpected error. | No links |
Success Response 200: AttributeSection record created
{
"attributeId": 0,
"sectionId": 0,
"status": "active",
"statusDt": "2021-02-04T10:30:54.681Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"sectionStatus": "active",
"attributeStatus": "active",
"attributeSectionTags": [
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2021-02-04T10:30:54.681Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns AttributeSection data.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Attribute ID. |
secId (required) | integer (path) | Section ID. |
Responses
Code | Description | Links |
---|---|---|
200 | AttributeSection data. | No links |
default | Unexpected error. | No links |
Success Response 200: AttributeSection data
{
"attributeId": 0,
"sectionId": 0,
"status": "active",
"statusDt": "2021-02-04T10:33:36.668Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"sectionStatus": "active",
"attributeStatus": "active",
"attributeSectionTags": [
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2021-02-04T10:33:36.668Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method updates AttributeSection data.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Attribute ID. |
secId (required) | integer (path) | Section ID. |
put data (required) | object (body) | Attribute section data. |
Data Parameters
put data object example
{
"status": "active"
}
Responses
Code | Description | Links |
---|---|---|
200 | AttributeSection updated successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: AttributeSection updated successfully
{
"attributeId": 0,
"sectionId": 0,
"status": "active",
"statusDt": "2021-02-04T10:36:56.131Z",
"sectionCodeName": "string",
"sectionName": "string",
"dbCodeName": "string",
"sectionStatus": "active",
"attributeStatus": "active",
"attributeSectionTags": [
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2021-02-04T10:36:56.131Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
]
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method deletes AttributeSection record with a given Attribute Id and Section ID.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Attribute ID. |
secId (required) | integer (path) | Section ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Attribute section deleted successfully. | No links |
default | Unexpected error. | No links |
Success Response 200: Attribute section deleted successfully
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
3.46 AttributeTypes
Endpoints for working with AttributeTypes.
Method Overview
This method returns a list of Attribute types.
This endpoint accepts query parameters for filtering Attribute types described at URL Filtering Guidelines page.
URL Parameters
Name | Type | Description |
---|---|---|
all | string (query) | Returns all data for a given criteria. Available values: yes, no. The default value: no. |
page_size | integer (query) | A page size. The default value: 10. |
page_number | integer (query) | A page number. The default value: 1. |
paging | string (query) | Paging options in the form of &paging=page_num page_size, e.g. paging=1,10. |
sort | string (query) | Sort options in the form of sort=-attribute1,attribute2,-attribute3. |
operator(fieldName) | string (query) | Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains,endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, name, allCustomAttrs, status.
|
Responses
Code | Description | Links |
---|---|---|
200 | A list of Attribute types. | No links |
default | Unexpected error. | No links |
Success Response 200: List of Attribute types
{
"data": [
{
"id": 0,
"codeName": "string",
"name": "string",
"allCustomAttrs": "yes",
"status": "active",
"statusDt": "2021-02-04T10:43:46.323Z"
}
],
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
Method Overview
This method returns Attribute type data.
URL Parameters
Name | Type | Description |
---|---|---|
id (required) | integer (path) | Attribute type ID. |
Responses
Code | Description | Links |
---|---|---|
200 | Attribute type data. | No links |
default | Unexpected error. | No links |
Success Response 200: Attribute type data
{
"id": 0,
"codeName": "string",
"name": "string",
"allCustomAttrs": "yes",
"status": "active",
"statusDt": "2021-02-04T10:46:04.210Z"
}
Error Response Unexpected Error: Default
{
"Code": 0,
"Message": "string"
}
4. Data Models
Data Models define the structure of a JSON document.
4.1 Data
Data describe all the data related to the Business Partners API.
DocLogoFile object properties:
Name | Type | Description |
---|---|---|
id | integer | Logo ID. |
partnerId | integer | Partner ID. |
filename | string | Logo file name. |
size | integer | File size. |
language | string | Language. |
mimeType | string | Mime type. |
insertDt | string($date‑time) | Date of insertion. |
status | string | Logo status. Possible values: draft, active, deleted, inactive. |
statusDt | string($date‑time) | Date of logo status. |
DocTemplateFileStatus object properties:
Name | Type | Description |
---|---|---|
status | string | File status. Possible values: draft, active, deleted, inactive. |
JSON example
{
"id": 0,
"partnerId": 0,
"filename": "string",
"size": 0,
"language": "string",
"mimeType": "string",
"insertDt": "2021-01-28T11:09:48.212Z",
"status": "draft",
"statusDt": "2021-01-28T11:09:48.212Z"
}
BizPartnerTypeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerTypeItem objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerTypeItem object properties:
Name | Type | Description |
---|---|---|
id | integer | Business Partner ID. |
name | string | Name. |
status | string | Status. |
favorite | string | Possible values: yes, no. |
BizSettings object properties:
Name | Type | Description |
---|---|---|
instanceId | integer | Instance ID. |
coOwnersEnabled | string | Possible values: yes, no. |
resellersEnabled | string | Possible values: yes, no. |
JSON example
{
"instanceId": 0,
"coOwnersEnabled": "no",
"resellersEnabled": "no"
}
BizAttributeSectionTagCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizAttributeSectionTag objects. |
meta (required) | object | CollectionMeta object. |
BizAttributeSectionTag object properties:
Name | Type | Description |
---|---|---|
sectionId | integer | Section ID. |
attributeId | integer | Attribute ID. |
tagId | integer | Tag ID. |
insertTs | string($date‑time) | Date of insertion. |
attributeTagCategoryId | integer | Attribute tag category ID. |
attributeTagRowType | string | Attribute tag row type. |
attributeTagCodeName | string | Attribute tag code name. |
attributeTagName | string | Attribute tag name. |
attributeTagStatus | string | Attribute tag status. |
attributeTagStatusDt | string | Attribute tag status date. |
BizAttributeSectionTagPost object properties:
Name | Type | Description |
---|---|---|
tagId | integer | Tag ID. |
JSON example
{
"sectionId": 0,
"attributeId": 0,
"tagId": 0,
"insertTs": "2022-01-31T10:39:46.704Z",
"attributeTagCategoryId": 0,
"attributeTagRowType": "string",
"attributeTagCodeName": "string",
"attributeTagName": "string",
"attributeTagStatus": "string",
"attributeTagStatusDt": "string"
}
BizAttributeTagCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizAttributeTag objects. |
meta (required) | object | CollectionMeta object. |
BizAttributeTag object properties:
Name | Type | Description |
---|---|---|
id | integer | Tag ID. |
categoryId | integer | Category ID. |
rowType | string | Row type. |
codeName | string | Code name. |
customAttrName | string | Custom attribute name. |
attributeValue | string | Attribute value. |
attributeCodeName | string | Attribute code name. |
attributeTypeId | integer | Attribute type ID. |
JSON example
{
"id": 0,
"categoryId": 0,
"rowType": "string",
"codeName": "string",
"customAttrName": "string",
"attributeValue": "string",
"attributeCodeName": "string",
"attributeTypeId": 0
}
WebSocialCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of WebSocial objects. |
meta (required) | object | CollectionMeta object. |
Name | Type | Description |
---|---|---|
id | integer | Web social ID. |
name | string | Web social name. |
sectionRowId | integer | ID of details for section DETAILS or ID of contact for section CONTACTS. |
value | string | Value. |
status | string | Possible value: active, deleted. |
statusDt | string($date‑time) | Web social status date. |
WebSocialPut object properties:
Name | Type | Description |
---|---|---|
name (required) | string | maxLength: 50. |
value | string | maxLength: 1000. |
WebSocialPost object properties:
Name | Type | Description |
---|---|---|
name (required) | string | maxLength: 50. |
sectionRowId | integer | maxLength: 10. ID of details for section DETAILS or ID of contact for section CONTACTS. |
value | string | maxLength: 1000. |
JSON example
{
"id": 0,
"name": "string",
"sectionRowId": 0,
"value": "string",
"status": "active",
"statusDt": "2021-02-01T13:15:44.579Z"
}
ErroObjectsFixFirst object properties:
Name | Type | Description |
---|---|---|
code | string | Error code. |
message | string | Error message. |
items | array | An array of ErrorItems object. |
Name | Type | Description |
---|---|---|
name | string | maxLength: 50. |
sectionRowId | integer | maxLength: 10. ID of details for section DETAILS or ID of contact for section CONTACTS. |
value | string | Error value. |
description | string | Error description. |
PartnerPatch object properties:
Name | Type | Description |
---|---|---|
status | string | Possible values: suspended, active, draft. |
BizProductPatch object properties:
Name | Type | Description |
---|---|---|
status | string | Possible values: suspended, enabled. |
Name | Type | Description |
---|---|---|
id | integer | Partner ID. |
name | string | Partne name. |
country | integer | Country code. |
vatNumber | string | Vat number. |
vatApply | string | Possible values: yes, no, unknown. |
regNumber | string | Partner's reg number. |
legalAddressId | integer | Partner's legal address ID. |
value | string | Value. |
status | string | Possible values: potential, active, suspended, archived,deleted, mics, draft. |
parentId | integer | Partner's parent ID. |
legalFormId | integer | Legal form ID. |
language | string | Language. |
bizPartnerUid | string | Biz partner UID. |
partnerDetailsId | integer | Partner's details ID. |
briefName | string | Partner's brief name. |
notificationAddressId | integer | Notification address ID. |
externalRefId | string | External reference ID. |
partnerTypeId | integer | Partner type ID. |
partnerTypeName | string | Partner type name. |
statusActiveDt | string($date‑time) | Date of acttive status. |
statusDt | string($date‑time) | Date of status. |
JSON example
{
"id": 0,
"name": "string",
"country": 0,
"vatNumber": "string",
"vatApply": "yes",
"regNumber": "string",
"legalAddressId": 0,
"value": "string",
"status": "potential",
"parentId": 0,
"legalFormId": 0,
"language": "string",
"bizPartnerUid": "string",
"partnerDetailsId": 0,
"briefName": "string",
"notificationAddressId": 0,
"externalRefId": "string",
"partnerTypeId": 0,
"partnerTypeName": "string",
"statusActiveDt": "2021-02-02T13:31:49.562Z",
"statusDt": "2021-02-02T13:31:49.562Z"
}
PartnerTypeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of PartnerType objects. |
meta (required) | object | CollectionMeta object. |
PartnerType object properties:
Name | Type | Description |
---|---|---|
id | integer | Partner type ID. |
name | string | Partner type name. |
status | string | Possible values: active, inactive, deleted, misc. |
statusDt | string($date‑time) | Status date. |
dbCodeName | string | Code name. |
comment | string | Possible values: yes, no. |
JSON example
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-01T13:35:51.271Z",
"dbCodeName": "string",
"comment": "yes"
}
PartnerTypePut object properties:
Name | Type | Description |
---|---|---|
name | string | Partner type name. |
taxExempt | string | Tax exemption. |
foundingD | string($date‑time) | Founding date. |
industryId | integer | Industry ID. |
companySizeId | integer | Company size ID. |
string | Partner's E-mail. | |
phone | string | Partner's phone. |
fax | string | Partner's fax. |
industryName | string | Industry name. |
companySize | string | Company size. |
hasAttributes | string | Possible values: yes, no. |
isIntercompany | string | Possible values: yes, no. |
PartnerTypePost object properties:
Name | Type | Description |
---|---|---|
name (required) | string | Possible values: manually, self_service. |
selfOwner | string | Possible values: yes, no. |
JSON example
{
"name": "string",
"taxExempt": "string",
"foundingD": "2021-02-01T13:48:47.047Z",
"industryId": 0,
"companySizeId": 0,
"eMail": "string",
"phone": "string",
"fax": "string",
"industryName": "string",
"companySize": "string",
"hasAttributes": "yes",
"isIntercompany": "yes"
}
IndustryCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of Industry objects. |
meta (required) | object | CollectionMeta object. |
Name | Type | Description |
---|---|---|
id | integer | Industry ID. |
name | string | Industry name. |
status | string | Possible values: active, inactive, deleted. |
statusDt | string($date‑time) | Status date. |
canBeDeleted | boolean | If industry can be deleted. |
favorite | string | Possible values: yes, no. |
IndustryPut object properties:
Name | Type | Description |
---|---|---|
name | string | Industry name. maxLength: 50. |
status | string | Possible values: active, inactive. |
favorite | string | Possible values: yes, no. |
IndustryPost object properties:
Name | Type | Description |
---|---|---|
name (required) | string | Industry name. maxLength: 50. |
favorite | string | Possible values: yes, no. |
JSON example
{
"id": 0,
"name": "string",
"status": "active",
"statusDt": "2021-02-02T12:56:10.108Z",
"canBeDeleted": true,
"favorite": "yes"
}
CompanySizeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of CompanySize objects. |
meta (required) | object | CollectionMeta object. |
CompanySize object properties:
Name | Type | Description |
---|---|---|
id | integer | Company ID. |
companySize | string | Company size. |
status | string | Company status. Possible values: active, inactive, deleted. |
statusDt | string($date‑time) | Status date. |
canBeDeleted | boolean | If industry can be deleted. |
favorite | string | Possible values: yes, no. |
CompanySizePut object properties:
Name | Type | Description |
---|---|---|
companySize | string | Company size. maxLength: 20. |
status | string | Company status. Possible values: active, inactive. |
favorite | string | Possible values: yes, no. |
CompanySizePost object properties:
Name | Type | Description |
---|---|---|
companySize (required) | string | Company size. maxLength: 20. |
favorite | string | Possible values: yes, no. |
JSON example
{
"id": 0,
"companySize": "string",
"status": "active",
"statusDt": "2021-02-02T13:18:15.807Z",
"canBeDeleted": true,
"favorite": "yes"
}
BusinessPartner object properties:
Name | Type | Description |
---|---|---|
id | integer | Business Partner ID. |
instanceId | integer | Instance ID. |
name | string | Business Partner name. |
country | integer | Country code. |
vatNumber | string | VAT number. |
vatApply | string | Possible values: yes, no. |
regNumber | string | Registration number. |
legalAddressId | string | Legal address ID. |
status | string | Status. |
parentId | integer | Parent ID. |
legalFormId | integer | Legal form ID. |
language | string | Language. |
bizPartnerUid | string | Business Partner UID. |
instanceOwnerName | string | Instance owner name. |
briefName | string | Business Partner brief name. |
countryName | string | Country name. |
dunsNumber | string | DUNS number. |
statusDt | string($date‑time) | Status date. |
statusActiveDt | string($date‑time) | Date of active status. |
legalForm | string | Legal form. |
languageName | string | Language name. |
taxExempt | string | Tax exemption. |
foundingD | string($date) | Founding date. |
industryId | integer | Industry ID. |
companySizeId | integer | Company size ID. |
string | Business Partner E-mail. | |
phone | string | Business Partner phone. |
fax | string | Business Partner fax. |
industryName | string | Industry name. |
companySize | string | Company size. |
instanceRole | string | Instance role. |
externalRefId | string | External reference ID. |
bizPartnerInstanceUid | string | Business Partner instance ID. |
hasAttributes | string | Possible values: yes, no. |
isIntercompany | string | Possible values: yes, no. |
partnerTypeId | integer | Partner type ID. |
partnerTypeName | string | Partner type name. |
detailsId | integer | Detail ID. |
ownerBpId | integer | Owner business partner ID. |
ownerBpName | string | Owner business partner name. |
ownerBpBriefName | string | Owner business partner brief name. |
selfOwner | string | Possible values: yes, no. |
legalAddress | object | BizPartnerLegalAddress object. |
extraAttributes | object | ExtraAttributesDataResponse object. |
businessPartnerProducts | object | BizPartnerProductDataResponse object. |
BusinessPartnerPostData object properties:
Name | Type | Description |
---|---|---|
name | string | Business partner name. |
briefName | string | Business partner brief name. |
externalRefId | string | External reference ID. |
country | integer | Country code. |
vatNumber | string | VAT number. |
vatApply | string | Possible values: yes, no. |
regNumber | string | Registration number. |
dunsNumber | string | DUNS number. |
status | string | Status. |
taxExempt | string | Tax exemption. |
foundingD | string($date) | Founding date. |
statusActiveDt | string($date) | Date of active status. |
industryID | integer | Industry ID. |
companySizeId | integer | Company size ID. |
legalFormId | integer | Legal form ID. |
language | string | Language. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
isIntercompany | string | Possible values: yes, no. |
partnerTypeId | integer | Partner type ID. |
selfOwner | string | Possible values: yes, no. |
ownerBpId | integer | Owner business partner ID. |
addresses | object | BizPartnerAddressesDataReqObj object. |
extraAttributes | object | ExtraAttributeDataReqObj object. |
BizPartnerAddressesDataReqObj object properties:
Name | Type | Description |
---|---|---|
data | array | An array of BizPartnerAddressPostData objects. |
BizPartnerAddressPostData object properties:
Name | Type | Description |
---|---|---|
addressTypeId | integer | Address type ID. |
country | integer | Country code. |
name | string | Name. |
branchName | string | Branch name. |
address | string | Address. |
poBox | string | PO box. |
postalCode | string | Postal code. |
city | string | City. |
province | string | Province. |
attnPerson | string | Attn person. |
latitude | number($float) | Address latitude. |
longitude | number($float) | Address longitude. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
copyToAddresses | object | CopyAddressesCreateDataReqObj object. |
ExtraAttributeDataReqObj object properties:
Name | Type | Description |
---|---|---|
data | array | An array of BizPartnerExtraAttributes objects. |
BizPartnerExtraAttributes object properties:
Name | Type | Description |
---|---|---|
attributeId | integer | Attribute ID. |
attributeValue | string | Attribute value. |
customAttrName | string | Custom attribute name. |
CopyAddressesCreateDataReqObj object properties:
Name | Type | Description |
---|---|---|
data | array | An array of BizPartnerAddressCopyCreateData objects. |
BizPartnerAddressCopyCreateData object properties:
Name | Type | Description |
---|---|---|
name | string | Business partner name. |
branchName | string | Branch name. |
addressTypeId | integer | Address type ID. |
BizPartnerLegalAddress object properties:
Name | Type | Description |
---|---|---|
id | integer | Address ID. |
bizPartnerId | integer | Business Partner ID. |
bizPartnerName | string | Business Partner name. |
bizPartnerBriefName | string | Business Partner brief name. |
addressTypeId | integer | Address type ID. |
addressTypeName | string | Address type name. |
addressTypeCodeName | string | Address type code name. |
branchName | string | Branch name. |
country | integer | Country code. |
countryName | string | Country name. |
name | string | Business Partner name. |
address | string | Business partner address. |
poBox | string | PO box. |
postalCode | string | Postal code. |
city | string | City. |
province | string | Province. |
attnPerson | string | Attn person. |
latitude | string | Address latitude. |
longitude | string | Address longitude. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
copyOfAddresses | array | An array of BizPartnerAddress object. |
BizPartnerAddress object properties:
Name | Type | Description |
---|---|---|
id | integer | Business partner address ID. |
bizPartnerId | integer | Business Partner ID. |
bizPartnerName | string | Business Partner name. |
bizPartnerBriefName | string | Business Partner brief name. |
addressTypeId | integer | Address type ID. |
addressTypeName | string | Address type name. |
addressTypeCodeName | string | Address type code name. |
country | integer | Country code. |
countryName | string | Country name. |
name | string | Business Partner name. |
branchName | string | Branch name. |
address | string | Business partner address. |
poBox | string | PO box. |
postalCode | string | Postal code. |
city | string | City. |
province | string | Province. |
attnPerson | string | Attn person. |
latitude | string | Address latitude. |
longitude | string | Address longitude. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
copyToAddresses | array | An array of BizPartnerAddressCopy object. |
BizPartnerAddressCopy object properties:
Name | Type | Description |
---|---|---|
id | integer | Address ID. |
name | string | Name. |
branchName | string | Branch name. |
addressTypeId | integer | Address type ID. |
ExtraAttributesDataResponse object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerExtraAttributesRes objects. |
BizPartnerExtraAttributesRes object properties:
Name | Type | Description |
---|---|---|
id | integer | Business partner ID. |
sectionId | integer | Section ID. |
attributeId | integer | Attribute ID. |
attributeName | string | Attribute name. |
customAttrName | string | Custom attribute name. |
attributeValue | string | Attribute value. |
attributeCodeName | string | Attribute code name. |
attributeTypeId | integer | Attribute type ID. |
BizPartnerProductDataResponse object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerProduct objects. |
BizPartnerProduct object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerProduct ID. |
bizPartnerId | integer | Business partner ID. |
bizPartnerBriefName | string | Business partner brief name. |
productTypeName | string | Product type name. |
productTypeCodeName | string | Product type code name. |
productId | integer | Product ID. |
productName | string | Product name. |
productCodeName | string | Product code name. |
relationTypeId | integer | Relation type ID. |
relationTypeName | string | Relation type name. |
relationTypeCodeName | string | Relation type code name. |
status | string | Status. |
enabledDt | string($date‑time) | Activation date. |
disabledDt | string($date‑time) | Deactivation date. |
statusDt | string($date‑time) | Status date. |
notes | string | Notes. |
customerType | string | Customer type. |
accountManagerId | integer | Account manager ID. |
accountManagerName | string | Account manager name. |
serviceCategoryId | integer | Service category ID. |
serviceProductName | string | Service product name. |
productBulkSms | object | ProductBulkSMS object. |
JSON example
{
"id": 0,
"bizPartnerId": 0,
"bizPartnerBriefName": "string",
"productTypeName": "string",
"productTypeCodeName": "string",
"productId": 0,
"productName": "string",
"productCodeName": "string",
"relationTypeId": 0,
"relationTypeName": "string",
"relationTypeCodeName": "string",
"status": "string",
"enabledDt": "2021-01-15T14:46:29.060Z",
"disabledDt": "2021-01-15T14:46:29.060Z",
"statusDt": "2021-01-15T14:46:29.060Z",
"notes": "string",
"customerType": "string",
"accountManagerId": 0,
"serviceCategoryId": 0,
"serviceProductName": "string",
"productBulkSms": {
"id": 0,
"bizpProductId": 0,
"sellingPaymentType": "string",
"sellingPaymentDue": 0,
"validFromD": "2021-01-15",
"billingCycle": 0,
"billingCycleUnit": "string",
"currencyId": 0,
"invoiceTriggerAmount": 0,
"overdraftLimit": 0,
"creditLimit": 0,
"deposit": 0,
"bankGuarantee": 0,
"disputePercent": 0,
"maxDispute": 0,
"announcementDays": 0,
"currencyCode": "string",
"currencyName": "string"
}
}
ProductBulkSMS object properties:
Name | Type | Description |
---|---|---|
id | integer | Product ID. |
bizpProductId | integer | Business partner product ID. |
sellingPaymentType | string | Selling payment type. |
sellingPaymentDue | integer | Selling payment due period. |
validFromD | string($data) | Valid from date. |
billingCycle | integer | Billing cycle. |
billingCycleUnit | string | Billing cycle unit. Possible values: Days, Months, Years, Weeks, Quarters, Semesters. |
currencyId | integer | Currency ID. |
invoiceTriggerAmount | number($float64) | Invoice trigger amount. |
overdraftLimit | number($float64) | Overdraft limit. |
creditLimit | number($float64) | Credit limit. |
deposit | number($float64) | Deposit. |
bankGuarantee | number($float64) | Bank guarantee amount. |
disputePercent | number($float64) | Dispute percent. |
maxDispute | number($float64) | Max dispute. |
announcementDays | integer | Announcement days. |
currencyCode | string | Currency code. |
currencyName | string | Currency name. |
BusinessPartnerUpdateData object properties:
Name | Type | Description |
---|---|---|
name | string | Business partner name. |
briefName | string | Business partner brief name. |
externalRefId | string | External reference ID. |
country | integer | Country code. |
vatNumber | string | VAT number. |
vatApply | string | Possible values: yes, no. |
regNumber | string | Registration number. |
dunsNumber | string | DUNS number. |
statusActiveDt | string($date‑time) | Date of active status. |
legalFormId | integer | Legal form ID. |
language | string | Language. |
taxExempt | string | Tax exemption. |
foundingD | string($date) | Founding date. |
industryId | integer | Industry ID. |
companySizeId | integer | Company size ID. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
isIntercompany | string | Possible values: yes, no. |
partnerTypeId | integer | Partner type ID. |
selfOwner | string | Possible values: yes, no. |
ownerBpId | integer | Owner business partner ID. |
extraAttributes | object | ExtraAttributeDataReqObj object. |
PartnerCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of Partner object. |
Name | Type | Description |
---|---|---|
id | integer | Partner ID. |
name | string | Partner name. |
country | integer | Country code. |
vatNumber | string | VAT number. |
vatApply | string | Possible values: yes, no, unknown. |
regNumber | string | Registration number. |
legalAddressId | integer | Legal address ID. |
value | string | Value. |
status | string | Possible values: potential, active, suspended, archived, deleted, misc, draft. |
parentId | integer | Parent ID. |
legalFormId | integer | Legal form ID. |
language | string | Language. |
bizPartnerUid | string | Biz partner UID. |
partnerDetailsId | integer | Partner's details ID. |
briefName | string | Partner brief name. |
notificationAddressId | integer | Notification address ID. |
externalRefId | string | External reference ID. |
partnerTypeId | integer | Partner type ID. |
partnerTypeName | string | Partner type name. |
statusActiveDt | string($date‑time) | Date of active status. |
statusDt | string($date‑time) | Status date. |
Name | Type | Description |
---|---|---|
name | string | maxLength: 150. |
country | integer | Country code. |
vatNumber | string | VAT number. maxLength: 30. |
vatApply | string | Possible values: yes, no, unknown. |
regNumber | string | Registration number. maxLength: 150. |
legalFormId | integer | Legal form ID. |
language | string | Language. |
briefName | string | maxLength: 50. |
externalRefId | string | External reference ID. maxLength: 100. |
partnerTypeId | integer | Partner type ID. |
isIntercompany | string | Possible values: yes, no. |
dunsNumber | string | DUNS number. maxLength: 20. |
taxExempt | string | Tax exemption. |
foundingD | string($date) | Founding date. |
industryId | integer | Industry ID. |
companySizeId | integer | Company size ID. |
string | E-mail. maxLength: 150. | |
phone | string | maxLength: 30. |
fax | string | maxLength: 30. |
creation | string | Possible values: manually, self_service. |
selfOwner | string | Possible values: yes, no. |
ownerBpId | integer | Owner business partner ID. |
PartnerSectionCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of PartnerSection objects. |
meta (required) | object | CollectionMeta object. |
PartnerSection object properties:
Name | Type | Description |
---|---|---|
id | integer | PartnerSection ID. |
codeName | string | Code name. |
name | string | Name. |
status | string | Possible values: active, inactive, deleted, misc. |
statusDt | string($date‑time) | Status date. |
dbCodeName | string | Code name. |
comment | string | Comment. |
AttributeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of AttributeList objects. |
meta (required) | object | CollectionMeta object. |
AttributeList object properties:
Name | Type | Description |
---|---|---|
id | integer | Attribute list ID. |
attributeTypeId | integer | Attribute type ID. |
codeName | string | Code name. |
name | string | Name. |
status | string | Possible values: active, inactive, deleted, misc. |
statusDt | string($date‑time) | Status date. |
attributeKind | string | Possible values: predefined, registered. |
sections | string | Sections. |
sectionCodeNames | string | Sections code names. |
attributeTypeCodeName | string | Attribute type code name. |
attributeTypeName | string | Attribute type name. |
canBeDeleted | boolean | If industry can be deleted. |
canCodeNameChange | boolean | Value if code name can change. |
Name | Type | Description |
---|---|---|
id | integer | Attribute ID. |
attributeTypeId | integer | Attribute type ID. |
codeName | string | Code name. |
name | string | Name. |
status | string | Possible values: active, inactive, deleted, misc. |
statusDt | string($date‑time) | Status date. |
attributeKind | string | Possible values: predefined, registered. |
attributeTypeCodeName | string | Attribute type code name. |
attributeTypeName | string | Attribute type name. |
canBeDeleted | boolean | If industry can be deleted. |
canCodeNameChange | boolean | Value if code name can change. |
attributeSections | array | An array of AttributeSection objects. |
AttributeSection object properties:
Name | Type | Description |
---|---|---|
attributeId | integer | Attribute ID. |
sectionId | integer | Section ID. |
status | string | Possible values: active, inactive, deleted. |
statusDt | string($date‑time) | Status date. |
sectionCodeName | string | Section code name. |
sectionName | string | Section name. |
dbCodeName | string | Code name. |
sectionStatus | string | Possible values: active, inactive, deleted. |
attributeStatus | string | Attribute status. |
attributeSectionTags | array | An array of BizAttributeSectionTag objects. |
AttributePost object properties:
Name | Type | Description |
---|---|---|
attributeTypeId (required) | integer | Attribute type ID. |
codeName (required) | string | Code name. maxLength: 30. |
name (required) | string | Name. maxLength: 50. |
AttributePut object properties:
Name | Type | Description |
---|---|---|
attributeTypeId | integer | Attribute type ID. |
codeName | string | Code name. maxLength: 30. |
name | string | maxLength: 50. |
status | string | Possible values: active, inactive. |
JSON example
{
"attributeTypeId": 0,
"codeName": "string",
"name": "string",
"status": "active"
}
AllProductCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of AllProduct objects. |
meta (required) | object | CollectionMeta object. |
Name | Type | Description |
---|---|---|
id | integer | AllProduct ID. |
productType | integer | Product type. |
name | string | Name. |
codeName | string | Code name. |
status | string | Possible values: active, inactive. |
statusDt | string($date‑time) | Status date. |
ProductCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of ProductList objects. |
meta (required) | object | CollectionMeta object. |
ProductList object properties:
Name | Type | Description |
---|---|---|
id | integer | ProductList ID. |
productType | integer | Product type. |
name | string | Name. |
codeName | string | Code name. |
status | string | Possible values: active, inactive, deleted. |
statusDt | string($date‑time) | Status date. |
productTypeName | string | Product type name. |
productTypeCodeName | string | Product type code name. |
isOurProduct | string | Possible values: yes, no. |
isSupplierProduct | string | Possible values: yes, no. |
productContextStatus | string | Product context status. |
BizPartnerProductCreate object properties:
Name | Type | Description |
---|---|---|
productType | integer | Product type. |
productId | integer | Product ID. |
relationTypeId | integer | Relation type ID. |
status | string | Status. |
notes | string | Notes. |
customerType | string | Customer type. |
accountManagerId | integer | Account manager ID. |
productBulkSms | object | ProductBulkSMSCreate object. |
ProductBulkSMSCreate object properties:
Name | Type | Description |
---|---|---|
sellingPaymentType | string | Possible values: prepaid, postpaid, none. |
sellingPaymentDue | integer | Selling payment due period. |
validFromD | string($date) | Valid from date. |
billingCycle | integer | Billing cycle. |
billingCycleUnit | string | Possible values: Days, Months, Years, Weeks, Quarters, Semesters. |
currencyId | integer | Currency ID. |
invoiceTriggerAmount | number($float64) | Invoice trigger amount. |
overdraftLimit | number($float64) | Overdraft limit. |
creditLimit | number($float64) | Credit limit. |
deposit | number($float64) | Deposit. |
bankGuarantee | number($float64) | Bank guarantee amount. |
disputePercent | number($float64) | Dispute percent. |
maxDispute | number($float64) | Max dispute. |
announcementDays | integer | Announcement days. |
BizPartnerProductUpdate object properties:
Name | Type | Description |
---|---|---|
productType | integer | Product type. |
productId | integer | Product ID. |
relationTypeId | integer | Relation type ID. |
status | string | Status. |
notes | string | Notes. |
customerType | string | Customer type. Possible values: enterprise, wholesale, inter-company. |
accountManagerId | integer | Account manager ID. |
productBulkSms | object | ProductBulkSMSUpdate object. |
ProductBulkSMSUpdate object properties:
Name | Type | Description |
---|---|---|
sellingPaymentType | string | Possible values: prepaid, postpaid, none. |
sellingPaymentDue | integer | Selling payment due period. |
validFromD | string($date) | Valid from date. |
billingCycle | integer | Billing cycle. |
billingCycleUnit | string | Possible values: Days, Months, Years, Weeks, Quarters, Semesters. |
currencyId | integer | Currency ID. |
invoiceTriggerAmount | number($float64) | Invoice trigger amount. |
overdraftLimit | number($float64) | Overdraft limit. |
creditLimit | number($float64) | Credit limit. |
deposit | number($float64) | Deposit. |
bankGuarantee | number($float64) | Bank guarantee amount. |
disputePercent | number($float64) | Dispute percent. |
maxDispute | number($float64) | Max dispute. |
announcementDays | integer | Announcement days. |
BizPartnerAllowedProductCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerAllowedProduct objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerAllowedProduct object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerAllowedProduct ID. |
name | string | Name. |
codeName | string | Code name. |
productTypeId | integer | Product type id. |
productTypeName | string | Product type name. |
productTypeCodeName | string | Product type code name. |
BizPartnerProductCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerProduct objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerProduct object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerProduct ID. |
bizPartnerId | integer | Business partner ID. |
bizPartnerBriefName | string | Business partner brief name. |
productTypeName | string | Product type name. |
productTypeCodeName | string | Product type code name. |
productId | integer | Product ID. |
productName | string | Product name. |
productCodeName | string | Product code name. |
relationTypeId | integer | Relation type ID. |
relationTypeName | string | Relation type name. |
relationTypeCodeName | string | Relation type code name. |
status | string | Status. |
enabledDt | string($date‑time) | Activation date. |
disabledDt | string($date‑time) | Deactivation date. |
statusDt | string($date‑time) | Status date. |
notes | string | Notes. |
customerType | string | Customer type. |
accountManagerId | integer | Account manager ID. |
accountManagerName | string | Account manager name. |
serviceCategoryId | integer | Service category ID. |
serviceProductName | string | Service product name. |
productBulkSms | object | ProductBulkSMS object. |
ProductBulkSMS object properties:
Name | Type | Description |
---|---|---|
id | integer | ProductBulkSMS ID. |
bizpProductId | integer | Business partner product ID. |
sellingPaymentType | string | Selling payment type. |
sellingPaymentDue | integer | Selling payment due period. |
validFromD | string($date) | Valid from date. |
billingCycle | integer | Billing cycle. |
billingCycleUnit | string | Possible values: Days, Months, Years, Weeks, Quarters, Semesters. |
currencyId | integer | Currency ID. |
invoiceTriggerAmount | number($float64) | Invoice trigger amount. |
overdraftLimit | number($float64) | Overdraft limit. |
creditLimit | number($float64) | Credit limit. |
deposit | number($float64) | Deposit. |
bankGuarantee | number($float64) | Bank guarantee amount. |
disputePercent | number($float64) | Dispute percent. |
maxDispute | number($float64) | Max dispute. |
announcementDays | integer | Announcement days. |
currencyCode | string | Currency code. |
currencyName | string | Currency name. |
BizpProductCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizpProductList objects. |
meta (required) | object | CollectionMeta object. |
BizpProductList object properties:
Name | Type | Description |
---|---|---|
id | integer | BizpProductList ID. |
instanceId | integer | Instance ID. |
bizPartnerId | integer | Business partner ID. |
bizPartnerName | string | Business Partner name. |
productType | integer | Product type. |
productTypeName | string | Product type name. |
productTypeCodeName | string | Product type code name. |
productName | string | Product name. |
productCodeName | string | Product code name. |
productId | integer | Product ID. |
relationTypeId | integer | Relation type ID. |
relationTypeCodeName | string | Relation type code name. |
relationType | string | Relation type. |
status | string | Status. |
statusDt | string($date‑time) | Status date. |
enabledDt | string($date‑time) | Activation date. |
disabledDt | string($date‑time) | Deactivation date. |
notes | string | Notes. |
customerType | string | Customer type. |
accountManagerId | integer | Account manager ID. |
accountManagerName | string | Account manager name. |
serviceCategoryId | integer | Service category ID. |
serviceCategoryName | string | Service category name. |
serviceProductName | string | Service product name. |
AccountManagerData object properties:
Name | Type | Description |
---|---|---|
Name | Type | Description |
id | integer | AccountManagerData ID. |
instanceId | integer | Instance ID. |
string | E-mail. | |
name | string | Name. |
status | string | Possible values: active, inactive, deleted. |
statusDt | string($date‑time) | Status date. |
accountMgrProduct | array | An array of AccountMgrProduct objects. |
AccountMgrProduct objects properties:
Name | Type | Description |
---|---|---|
id | integer | AccountMgrProduct ID. |
accountMgrId | integer | Account Manager ID. |
productId | integer | Product ID. |
productType | integer | Product type. |
status | string | Possible values: active, inactive, deleted. |
statusDt | string($date‑time) | Status date. |
productName | string | Product name. |
productCodeName | string | Product code name. |
productTypeName | string | Product type name. |
productTypeCodeName | string | Product type code name. |
isOurProduct | string | Possible values: yes, no. |
isSupplierProduct | string | Possible values: yes, no. |
AccountManagerCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of AccountManagerDataList objects. |
meta (required) | object | CollectionMeta object. |
AccountManagerDataList object properties:
Name | Type | Description |
---|---|---|
id | integer | AccountManagerDataList ID. |
instanceId | integer | Instance ID. |
string | E-mail. | |
name | string | Name. |
status | string | Possible values: active, inactive, deleted. |
statusDt | string($date‑time) | Status date. |
products | string | Products. |
productCodeNames | string | Product code name. |
AccountManagerPost object properties:
Name | Type | Description |
---|---|---|
name (required) | string | Account manager name. |
email (required) | string | E-mail. |
accountMgrProducts | array | An array of AccountMgrProductRequestData objects. |
AccountMgrProductRequestData object properties:
Name | Type | Description |
---|---|---|
productId | integer | Product ID. |
PartnerAttributeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of PartnerAttribute objects. |
meta (required) | object | CollectionMeta object. |
PartnerAttribute object properties:
Name | Type | Description |
---|---|---|
id | integer | PartnerAttribute ID. |
sectionId | integer | Section ID. |
sectionRowId | integer | Section row ID. |
attributeId | integer | Attribute ID. |
bizPartnerId | integer | Business partner ID. |
customAttrName | string | Custom attribute name. |
attributeValue | string | Attribute value. |
jsonValue | object | {value: string($JSON)}. |
valueType | string | Possible values: simple, json. |
status | string | Possible values: active, deleted. |
statusDt | string($date‑time) | Status date. |
sectionCodeName | string | Section code name. |
sectionName | string | Section name. |
dbCodeName | string | Code name. |
attributeCodeName | string | Attribute code name. |
attributeName | string | Attribute name. |
attributeTypeCodeName | string | Attribute type code name. |
attributeTypeName | string | Attribute type name. |
canBeChanged | boolean | If it can be changed. |
PartnerAttributePut object properties:
Name | Type | Description |
---|---|---|
sectionId | integer | Section ID. |
sectionRowId | integer | Section row ID. |
attributeId | integer | Attribute ID. |
bizPartnerId | integer | Business partner ID. |
customAttrName | string | maxLength: 50. |
attributeValue | string | maxLength: 255. |
jsonValue | object | {value: string($JSON)}. |
PartnerAttributePost object properties:
Name | Type | Description |
---|---|---|
sectionId | integer | Section ID. |
sectionRowId | integer | Section row ID. |
attributeId | integer | Attribute ID. |
bizPartnerId | integer | Business partner ID. |
customAttrName | string | maxLength: 255. |
attributeValue | string | maxLength: 255. |
jsonValue | object | {value: string($JSON)}. |
PartnerAttributeExtendCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of PartnerAttributeExtend objects. |
meta (required) | object | CollectionMeta object. |
PartnerAttributeExtend object properties:
Name | Type | Description |
---|---|---|
id | integer | PartnerAttributeExtend ID. |
sectionId | integer | Section ID. |
sectionRowId | integer | Section row ID. |
attributeId | integer | Attribute ID. |
bizPartnerId | integer | Business partner ID. |
customAttrName | string | Custom attribute name. |
attributeValue | string | Attribute value. |
jsonValue | object | {value: string($JSON)}. |
status | string | Possible values: active, deleted. |
statusDt | string($date‑time) | Status date. |
sectionCodeName | string | Section code name. |
sectionName | string | Section name. |
dbCodeName | string | Code name. |
attributeCodeName | string | Attribute code name. |
attributeName | string | Attribute name. |
attributeTypeCodeName | string | Attribute type code name. |
attributeTypeName | string | Attribute type name. |
attributeTagCodeName | string | Attribute tag code name. |
attributeTagName | string | Attribute tag name. |
canBeChanged | boolean | If it can be changed. |
AttributeSectionPut object properties:
Name | Type | Description |
---|---|---|
status | string | Possible values: active, inactive. |
AttributeSectionPost object properties:
Name | Type | Description |
---|---|---|
sectionId | integer | Section ID. |
AttributePartnerCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of AttributePartner objects. |
meta (required) | object | CollectionMeta object. |
AttributePartner object properties:
Name | Type | Description |
---|---|---|
partnerId | integer | Partner ID. |
partnerName | string | Partner name. |
partnerBriefName | string | Partner brief name. |
AttributeCodeName object properties:
Name | Type | Description |
---|---|---|
codeName | string | Code name. |
AttributeCodeNamePost object properties:
Name | Type | Description |
---|---|---|
name | string | AttributeCodeName name. |
AttributeTypeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of AttributeType objects. |
meta (required) | object | CollectionMeta object. |
AttributeType object properties:
Name | Type | Description |
---|---|---|
id | integer | AttributeType ID. |
codeName | string | Code name. |
name | string | Name. |
allCustomAttrs | string | Possible values: yes, no. |
status | string | Possible values: active, inactive, deleted, misc. |
statusDt | string($date‑time) | Status date. |
BizPartnerLogoCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of DocLogoFile objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerContactPostData object properties:
Name | Type | Description |
---|---|---|
firstName | string | BizPartnerContact first name. |
lastName | string | BizPartnerContact last name. |
nickName | string | BizPartnerContact nickname. |
salutation | string | Salutation. |
titel | string | Titel. |
gender | string | Gender. |
language | string | Language. |
eMailBusiness | string | Business E-mail. |
eMailPrivate | string | Private E-mail. |
phoneOfficeDirect | string | Phone office direct. |
phoneOfficeCentral | string | Phone office central. |
mobile | string | Mobile. |
mobileBusiness | string | Contact business mobile. |
skype | string | Contact skype. |
birthday | string($date) | Birthday. |
contactTypeId | integer | Contact type ID. |
customTypeName | string | Custom type name. |
departmentId | integer | Department ID. |
positionId | integer | Position ID. |
customPositionName | string | Custom position name. |
fax | string | Fax. |
address | string | Business partner contact address. |
postalCode | string | Postal code. |
city | string | City. |
countryId | integer | Country ID. |
extraAttributes | object | ExtraAttributeDataReqObj. |
BizPartnerContactStatusPutData object properties:
Name | Type | Description |
---|---|---|
status | string | Possible values: active, inactive. |
BizPartnerContactPutData object properties:
Name | Type | Description |
---|---|---|
firstName | string | BizPartnerContact first name. |
lastName | string | BizPartnerContact last name. |
nickName | string | BizPartnerContact nickname. |
salutation | string | Salutation. |
titel | string | Titel. |
gender | string | Gender. |
language | string | Language. |
eMailBusiness | string | Business E-mail. |
eMailPrivate | string | Private E-mail. |
phoneOfficeDirect | string | Phone office direct. |
phoneOfficeCentral | string | Phone office central. |
mobile | string | Mobile. |
mobileBusiness | string | Contact business mobile. |
skype | string | Contact skype. |
birthday | string($date) | Birthday. |
contactTypeId | integer | Contact type ID. |
customTypeName | string | Custom type name. |
departmentId | integer | Department ID. |
positionId | integer | Position ID. |
customPositionName | string | Custom position name. |
fax | string | Fax. |
address | string | Address. |
postalCode | string | Postal code. |
city | string | City. |
countryId | integer | Country ID. |
extraAttributes | object | ExtraAttributesUpdateData. |
ExtraAttributesUpdateData object properties:
Name | Type | Description |
---|---|---|
data | array | An array of BizPartnerExtraAttributesUpdate objects. |
BizPartnerExtraAttributesUpdate object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerExtraAttributes ID. |
attributeId | integer | Attribute ID. |
attributeValue | string | Attribute value. |
customAttrName | string | Custom attribute name. |
BizPartnerContactCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerContact objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerContact object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerContact ID. |
bizPartnerId | integer | Business partner ID. |
contactTypeId | integer | Contact type ID. |
customTypeName | string | Custom type name. |
firstName | string | BizPartnerContact first name. |
lastName | string | BizPartnerContact last name. |
nickName | string | BizPartnerContact nickname. |
salutation | string | Possible values: formal, informal. |
titel | string | Titel. |
gender | string | Possible values: male, female, unknown. |
language | string | Language. |
addressId | integer | Address ID. |
eMailBusiness | string | Business E-mail. |
eMailPrivate | string | Private E-mail. |
phoneOfficeDirect | string | Phone office direct. |
phoneOfficeCentral | string | Phone office central. |
mobile | string | Mobile. |
mobileBusiness | string | Contact business mobile. |
skype | string | Contact skype. |
birthday | string($date) | Birthday. |
departmentId | integer | Department ID. |
positionId | integer | Position ID. |
customPositionName | string | Custom position name. |
picture | string | Picture. |
fax | string | Fax. |
status | string | Possible values: active, inactive. |
statusDt | string($date‑time) | Status date. |
address | string | Business partner contact address. |
postalCode | string | Postal code. |
city | string | City. |
countryId | integer | Country ID. |
countryName | string | Country name. |
contactTypeName | string | Country type name. |
partnerName | string | Partner name. |
languageName | string | Language. |
partnerBriefName | string | Partner brief name. |
departmentName | string | Department name. |
positionName | string | Position name. |
note | string | Note. |
extraAttributes | object | ExtraAttributesDataResponse object. |
BizPartnerAddressCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerAddress objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerAddressPutData object properties:
Name | Type | Description |
---|---|---|
addressTypeId | integer | Address type ID. |
country | integer | Country code. |
name | string | Name. |
branchName | string | Branch name. |
address | string | Address. |
poBox | string | PO box. |
postalCode | string | Postal code. |
city | string | City. |
province | string | Province |
attnPerson | string | Attn person. |
latitude | number($float) | Address latitude. |
longitude | number($float) | Address longitude. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
copyToAddresses | object | CopyAddressesUpdateDataReqObj object. |
CopyAddressesUpdateDataReqObj object properties:
Name | Type | Description |
---|---|---|
data | array | An array of BizPartnerAddressCopyUpdateData objects. |
BizPartnerAddressCopyUpdateData object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerAddressCopy ID. |
name | string | Name. |
branchName | string | Branch name. |
addressTypeId | integer | Address type ID. |
BizContactTypeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizContactType objects. |
meta (required) | object | CollectionMeta object. |
BizContactType object properties:
Name | Type | Description |
---|---|---|
id | integer | BizContactType ID. |
codeName | string | Code name. |
name | string | Name. |
status | string | Possible values: active, inactive, deleted, misc. |
RelationTypesCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizRelationType objects. |
meta (required) | object | CollectionMeta object. |
BizRelationType object properties:
Name | Type | Description |
---|---|---|
id | integer | BizRelationType ID. |
codeName | string | Code name. |
relationType | string | Relation type. |
BizPartnerStatus object properties:
Name | Type | Description |
---|---|---|
partnerStatus | string | Possible values: active, potential, archived, misc, suspended, draft. |
partnerStatusCount | integer | Business partner status count. |
ContextOwner object properties:
Name | Type | Description |
---|---|---|
id | integer | ContextOwner ID. |
name | string | ContextOwner name. |
instanceRole | string | Instance role. |
country | integer | Country code. |
countryName | string | Country name. |
vatNumber | string | VAT number. |
vatApply | string | Possible value: yes, no. |
regNumber | string | Registration number. |
legalAddressId | integer | Legal address ID. |
status | string | Status. |
parentId | integer | Parent ID. |
legalFormId | integer | Legal form ID. |
language | string | Language. |
languageName | string | Language name. |
legalForm | string | Legal form. |
briefName | string | Brief name. |
detailsId | integer | Details ID. |
hasAttributes | string | Possible value: no, yes. |
externalRefId | string | External reference ID. |
statusActiveDt | string($date) | Date of active status. |
statusDt | string($date‑time) | Status date. |
industryId | integer | Industry ID. |
companySizeId | integer | Company size ID. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
taxExempt | string | Tax exemption. |
foundingD | string($date) | Founding date. |
dunsNumber | string | DUNS number. |
industryName | string | Industry name. |
companySize | string | Company size. |
instanceOwnerName | string | Instance owner name. |
bizPartnerInstanceUid | string | Business partner instance UID. |
isIntercompany | string | Possible value: no, yes. |
partnerTypeId | integer | Partner type ID. |
partnerTypeName | string | Partner type name. |
ownerBpId | integer | Owner business partner ID. |
ownerBpName | string | Business partner name. |
ownerBpBriefName | string | Business partner brief name. |
selfOwner | string | Possible value: yes, no. |
BizPartnerStatCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerStat objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerStat object properties:
Name | Type | Description |
---|---|---|
relationType | string | Relation type. |
productInfo | array | An array of BizPartnerStatProduct object. |
BizPartnerStatProduct object properties:
Name | Type | Description |
---|---|---|
product | string | BizPartnerStatProduct name. |
productCount | integer | BizPartnerStatProduct count. |
BizPartnerLovCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerLov objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerLov object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerLov ID. |
name | string | BizPartnerLov name. |
briefName | string | Business partner brief name. |
city | string | City. |
postalCode | string | Postal code. |
code2 | string | Code2. |
externalRefId | string | External reference ID. |
ProductTypePartnersLovCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of ProductTypePartnersLov objects. |
meta (required) | object | CollectionMeta object. |
ProductTypePartnersLov object properties:
Name | Type | Description |
---|---|---|
id | integer | ProductTypePartnersLov ID. |
name | string | ProductTypePartnersLov name. |
instanceRole | string | Instance role. |
country | integer | Country code. |
countryName | string | Country name. |
vatNumber | string | VAT number. |
vatApply | string | Possible values: yes, no, unknown. |
regNumber | string | Registration number. |
legalAddressId | integer | Legal address ID. |
status | string | Status. |
parentId | integer | Parent ID. |
legalFormId | integer | Legal form ID. |
language | string | Language. |
languageName | string | Language name. |
legalForm | string | Legal form. |
instanceOwnerName | string | Instance owner name. |
briefName | string | Brief name. |
detailsId | integer | Details ID. |
hasAttributes | string | Possible values: yes, no. |
externalRefId | integer | External reference ID. |
bizPartnerInstanceUid | string | BizPartnerInstance UID. |
statusActiveDt | string($date‑time) | Date of active status. |
statusDt | string($date‑time) | Status date. |
industryId | integer | Industry ID. |
companySizeId | integer | Company size ID. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
taxExempt | string | Tax exemption. |
foundingD | string($date‑time) | Founding date. |
dunsNumber | string | DUNS number. |
industryName | string | Industry name. |
companySize | string | Company size. |
ownerBpId | integer | Owner business partner ID. |
ownerBpName | string | Business partner name. |
ownerBpBriefName | string | Business partner brief name. |
selfOwner | string | Possible values: yes, no. |
isIntercompany | string | Possible values: yes, no. |
partnerTypeId | integer | Partner type ID. |
partnerTypeName | string | Partner type name. |
ProductFeatureCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of ProductFeature objects. |
meta (required) | object | CollectionMeta object. |
ProductFeature object properties:
Name | Type | Description |
---|---|---|
id | integer | ProductFeature ID. |
productId | integer | Product ID. |
codeName | string | Code name. |
name | string | Name. |
status | string | Status. |
productName | string | Product name. |
productCodeName | string | Product code name. |
JSON example
{
"id": 0,
"productId": 0,
"codeName": "string",
"name": "string",
"status": "string",
"productName": "string",
"productCodeName": "string"
}
FinanceSettingsPutData object properties:
Name | Type | Description |
---|---|---|
partnerInDraft | string | Possible values: yes, no. |
nettingPartner | string | Possible values: yes, no. |
hardCopyAddressIsDefault | Possible values: yes, no. | |
invoiceAddressId | integer | Invoice address ID. |
emailContact | object | EmailContactFinanceSettings object |
EmailContactFinanceSettings object properties:
Name | Type | Description |
---|---|---|
emailAccountId | integer | E-mail account ID. |
emailAddresses | array | An array of EmailAddressFinanceSettings objects. |
EmailAddressFinanceSettings object properties:
Name | Type | Description |
---|---|---|
addressType | string | Possible values: to, cc, bcc. |
string($email) | E-mail. |
FinanceSettings object properties:
Name | Type | Description |
---|---|---|
id | integer | FinanceSettings ID. |
productType | string | Product type. |
productId | integer | Product ID. |
invoiceAddressId | integer | Invoice address ID. |
invoiceAddressIsDefault | string | Possible values: yes, no. |
emailContactId | integer | E-mail contact ID. |
emailAddressIsDefault | string | Possible values: yes, no. |
hardCopyAddressId | integer | Address ID for hardcopy. |
hardCopyAddressIsDefault | string | Possible values: yes, no. |
nettingPartner | string | Possible values: yes, no. |
emailAccountId | integer | E-mail account ID. |
smtpAccount | string | SMTP account. |
emailAddressTO | string($email) | E-mail TO address. |
emailAddressCC | string($email) | E-mail CC address. |
emailAddressBcc | string($email) | E-mail BCC address. |
ProductTypeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of ProductType objects. |
meta (required) | object | CollectionMeta object. |
ProductType object properties:
Name | Type | Description |
---|---|---|
id | integer | Product type ID. |
name | string | Product type name. |
codeName | string | Code name. |
status | string | Possible values: active. |
statusDt | string($date‑time) | Status date. |
EmailAccountCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of EmailAccount objects. |
meta (required) | object | CollectionMeta object. |
EmailAccount object properties:
Name | Type | Description |
---|---|---|
id | integer | EmailAccount ID. |
name | string | Name. |
canReceive | string | Possible values: yes, no. |
inHost | string | IMAP host name. |
inPort | integer | IMAP port. |
inSecurity | string | Optional security method like TLS or SSL. |
canSend | string | Possible values: yes, no. |
outHost | string | SMTP host name. |
outPort | integer | SMTP port. |
outSecurity | string | Optional security method like TLS or SSL. |
status | string | Possible values: yes, no. |
statusDt | string)$date‑time | Status date. |
FinanceEmailAddressCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of FinanceEmailAddress objects. |
meta (required) | object | CollectionMeta object. |
FinanceEmailAddress object properties:
Name | Type | Description |
---|---|---|
id | integer | FinanceEmailAddress ID. |
emailContactId | integer | E-mail contact ID. |
addressType | string | Address type. |
string | E-mail. | |
bizPartnerId | integer | Business partner ID. |
bizPartnerBriefName | string | Business partner brief name. |
ServiceCategoryCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of ServiceCategory objects. |
meta (required) | object | CollectionMeta object. |
ServiceCategory object properties:
Name | Type | Description |
---|---|---|
id | integer | ServiceCategory ID. |
category | string | Category. |
BizPositionCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPosition objects. |
meta (required) | object | CollectionMeta object. |
BizPosition object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPosition ID. |
name | string | Name. |
codeName | string | Code name. |
status | string | Possible values: active, inactive. |
statusDt | string($date‑time) | Status date. |
favorite | string | Possible values: yes, no. |
MeasureUnitCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of MeasureUnit objects. |
meta (required) | object | CollectionMeta object. |
MeasureUnit object properties:
Name | Type | Description |
---|---|---|
id | integer | MeasureUnit ID. |
name | string | MeasureUnit name. |
code | string | MeasureUnit code. |
type | string | MeasureUnit type. |
ordNum | integer | MeasureUnit ordinal number. |
baseUnitId | integer | Base unit ID. |
baseNumerator | integer | Base numerator. |
baseDenominator | integer | Base denominator. |
LanguageCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of Language objects. |
meta (required) | object | CollectionMeta object. |
Name | Type | Description |
---|---|---|
id | string | Language ID. maxLength: 2. |
name | string | Language name. |
status | string | Possible values: A, N. |
statusDt | string($date‑time) | Status date. |
BizPartnerCountryCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerCountry objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerCountry object properties:
Name | Type | Description |
---|---|---|
id | integer | Business partner country ID. |
name | string | Business partner country name. |
CountryCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of Country objects. |
meta (required) | object | CollectionMeta object. |
Name | Type | Description |
---|---|---|
id | integer | Country ID. |
name | string | Country name. |
code2 | string | Country code. |
code3 | string | Country code. |
type | string | Possible values: formal, undefined, virtual, informal. |
currency | integer | Country currency. |
defLang | string | Default language. maxLenght: 2. |
status | string | Possible values: A, N. |
statusDt | string($date‑time) | Status date. |
domain | string | maxLenght: 5. |
dialCode | string | maxLenght: 10. |
continent | string | maxLenght: 2. |
defTaxCategoryId | integer | Deferred tax category. |
cashRounding | number($float) | Rounding. |
CurrencyCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of Currency objects. |
meta (required) | object | CollectionMeta object. |
Name | Type | Description |
---|---|---|
id | integer | Currency ID. |
name | string | Currency name. |
code | string | Currency code. |
status | string | maxLength: 1. |
statusDt | string($date‑time) | Status date. |
type | string | Possible values: formal, internal, virtual, informal. |
LegalFormCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of LegalForm objects. |
meta (required) | object | CollectionMeta object. |
Name | Type | Description |
---|---|---|
id | integer | Legal form ID. |
countryId | integer | Country ID. |
legalForm | string | Legal form name. |
status | string | Possible values: active, inactive, deleted. |
statusDt | string($date‑time) | Status date. |
BizDepartmentCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizDepartment objects. |
meta (required) | object | CollectionMeta object. |
BizDepartment object properties:
Name | Type | Description |
---|---|---|
id | integer | Business department ID. |
name | string | Business department name. |
status | string | Possible values: active, inactive. |
statusDt | string($date‑time) | Status date. |
favorite | string | Possible values: yes, no. |
AccountManagersLovCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of AccountManagersLov objects. |
meta (required) | object | CollectionMeta object. |
AccountManagersLov object properties:
Name | Type | Description |
---|---|---|
id | integer | AccountManagersLov ID. |
name | string | AccountManagersLov name. |
AddressTypeCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of AddressType objects. |
meta (required) | object | CollectionMeta object. |
AddressType object properties:
Name | Type | Description |
---|---|---|
id | integer | Address type ID. |
name | string | Address type name. |
BizPartnerActiveLovCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerActiveLov objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerActiveLov object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerActiveLov ID. |
instanceOwnerName | string | Instance owner name. |
externalRefId | string | External reference ID. |
name | string | Business partner name. |
briefName | string | Business partner brief name. |
country | integer | Country code. |
countryName | string | Country name. |
vatNumber | string | VAT number. |
vatApply | string | Possible values: yes, no, unknown. |
regNumber | string | Registration number. |
dunsNumber | string | DUNS number. |
status | string | Status. |
parentId | string | Parent ID. |
statusDt | string($date‑time) | Status date. |
statusActiveDt | string($date‑time) | Date of active status. |
legalAddressId | integer | Legal address ID. |
legalFormId | integer | Legal form ID. |
legalForm | string | Legal form. |
language | string | Language. |
languageName | string | Language name. |
taxExempt | string | Tax exemption. |
foundingD | string | Founding date. |
industryId | integer | Industry ID. |
companySizeId | integer | Company size ID. |
string | E-mail. | |
phone | string | Phone. |
fax | string | Fax. |
industryName | string | Industry name. |
companySize | string | Company size. |
AccountManagersPartnerLovCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of AccountManagersPartnerLov objects. |
meta (required) | object | CollectionMeta object. |
AccountManagersPartnerLov object properties:
Name | Type | Description |
---|---|---|
id | integer | AccountManagersPartnerLov ID. |
name | string | AccountManagersPartnerLov name. |
briefName | string | AccountManagersPartnerLov brief name. |
BizPartnerBriefCollection object properties:
Name | Type | Description |
---|---|---|
data (required) | array | An array of BizPartnerBrief objects. |
meta (required) | object | CollectionMeta object. |
BizPartnerBrief object properties:
Name | Type | Description |
---|---|---|
id | integer | BizPartnerBrief ID. |
instanceRole | string | Instance role. |
name | string | Name. |
briefName | string | Brief name. |
externalRefId | string | External reference ID. |
countryId | integer | Country ID. |
countryName | string | Country name. |
phone | string | Phone. |
string | E-mail. | |
language | string | Language. |
vatNumber | string | VAT number. |
vatApply | string | Possible values: yes, no, unknown. |
legalAddressId | integer | Legal address ID. |
legalAddressName | string | Legal address name. |
legalAddress | string | Legal address. |
legalAddressCountryId | integer | Legal address country ID. |
legalAddressCountryName | string | Legal address country name. |
statusActiveDt | string($date‑time) | Date of active status. |
city | string | City. |
regNumber | string | Registration number. |
status | string | Status. |
statusDt | string($date‑time) | Status date. |
relation | string | Relation. |
product | string | Product. |
realProduct | string | Related product list. |
partnerTypeId | integer | Partner type ID. |
partnerTypeName | string | Partner type name. |
industryId | integer | Industry ID. |
industryName | string | Industry name. |
creation | string | Date of creation. |
instanceOwnerName | string | Instance owner name. |
ownerBpId | integer | Owner business partner ID. |
ownerBpName | string | Business partner name. |
ownerBpBriefName | string | Business partner brief name. |
4.2 Meta
Meta contains data for the number of rows and pages that have been received for a given API call.
Name | Type | Description |
---|---|---|
CollectionMeta | object | CollectionMeta object. |
CollectionMeta object properties:
Name | Type | Description |
---|---|---|
pagination (required) | object | CollectionMetaPagination object. |
CollectionMetaPagination object properties:
Name | Type | Description |
---|---|---|
total (required) | integer | Total number of rows. |
count (required) | integer | A number of rows in the current page. |
per_page (required) | integer | The maximum rows per page. |
current_page (required) | integer | The current page number. |
total_pages (required) | integer | Total number of pages. |
links (required) | object | CollectionMetaPaginationLinks object. |
CollectionMetaPaginationLinks object properties:
Name | Type | Description |
---|---|---|
first | string | Link to the first page. |
last | string | Link to the last page. |
prev | string | Link to the previous page. |
next | string | Link to the next page. |
JSON example
"meta": {
"pagination": {
"total": 0,
"count": 0,
"per_page": 0,
"current_page": 0,
"total_pages": 0,
"links": {
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
}