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 objects used by all other HORISEN services and API's It supports Oauth 2 authentication. An example on how to Implement Oauth 2 and obtain access token as wel as an example of using a HORISEN API service is available at Oauth2 Authentication Guidelines

The HORISEN Business Partner API belongs to the Biz Core domain and the endpoint URL is:

https://api.horisen.pro/biz-core/v2/account-managers-lov

2. Method's Overview

2.1 Documents Configuration

Endpoints for working with logo data of business partners.

POST/biz-partners/{partnerid}/upload-logos
Uploads logo fileRead More
GET/biz-partners/{partnerid}/download-logos/{logoid}
Download logo fileRead More
GET/biz-partners/{partnerid}/download-logos/{status}
Download logo fileRead More
PATCH/biz-partners/{partnerid}/logos-change-status/{logoid}
Change logo statusRead More
DELETE/biz-partners/{partnerid}/logos-delete/{logoid}
Change logo status by logoidRead More
GET/biz-partners/{partnerid}/biz-partner-logos
List of BizPartnersLogo with active statusRead More

2.2 Biz attribute section tag

Endpoints for working with biz attribute section tag table.

GET/attributes/{id}/attribute-sections/{secId}/tag/{tagId}
Returns a biz attribute section tag record from database for given attributeId, sectionId and tagIdsRead More
DELETE/attributes/{id}/attribute-sections/{secId}/tag/{tagId}
Deletes a biz attribute section tag record from database for given attributeId, sectionId and tagIdRead More
GET/attributes/{id}/attribute-sections/{secId}/tag
List of Biz attribute section tagRead More
POST/attributes/{id}/attribute-sections/{secId}/tag
Create new Biz attribute section tag recordRead More

2.3 Biz attribute tag

Endpoints for working with biz attribute tag table.

GET/attributes-tags/{id}
Returns a biz attribute tag record from database for given tagIdRead More
GET/attributes-tags
List of Biz attribute tag recordsRead More

2.4 Biz partner brief

Endpoints for biz partner brief.

GET/biz-partners-brief
Returns list of biz partner briefRead More

2.5 Account manager lov

Endpoints for account manager lov.

GET/account-managers-lov
Returns list of Account manager lovRead More

2.6 Account manager partner lov

Endpoints for account manager partner lov.

GET/acc-mgr-partners-lov
Returns list of Account manager partner lovRead More

2.7 Address type

Endpoints for address type.

GET/address-types
Returns list of Address typesRead More

2.8 Biz contact type

Endpoints for biz contact type.

GET/biz-contact-types
Returns list of Biz contact typeRead More
GET/biz-contact-types/{id}
Returns Biz contact typeRead More

2.9 Biz department

Endpoints for biz department.

GET/biz-departments
Returns list of Biz departmentRead More
GET/biz-departments/{id}
Get Biz departmentRead More

2.10 LegalForms

Endpoints for legal forms.

GET/legal-forms
Returns a list of legal forms. This endpoint accepts query parameters for filtering legal formsRead More
GET/legal-forms/{id}
Returns Legal Forms dataRead More

2.11 Biz partner active lov

Returns list of Biz partner active lov.

GET/active-biz-partners-lov
Returns list of Biz partner active lov. This endpoint accepts query parameters for filtering Biz partner active lovRead More

2.12 Biz partner address

Endpoints for biz partner addresses.

GET/biz-partners/{id}/addresses
Returns a list of Business addresses. This endpoint accepts query parameters for filtering.Read More
POST/biz-partners/{id}/addresses
Create Biz partner addressesRead More
GET/biz-partners/{id}/addresses/{addressId}
Returns Biz partner addressesRead More
PUT/biz-partners/{id}/addresses/{addressId}
Updates Biz partner addressesRead More
DELETE/biz-partners/{id}/addresses/{addressId}
Delete Biz partner addressesRead More

2.13 Biz partner contact

Endpoints for biz partner contacts.

GET/biz-partners/{id}/contacts/{contactId}
Returns a Biz partner contacts.Read More
PUT/biz-partners/{id}/contacts/{contactId}
Updates a Biz partner contacts.Read More
DELETE/biz-partners/{id}/contacts/{contactId}
Deletes a Biz partner contacts.Read More
GET/biz-partners/{id}/contacts/
Returns a list of Biz partner contacts.Read More
POST/biz-partners/{id}/contacts
Create Biz partner contacts.Read More
PUT/biz-partners/{id}/contacts-status/{contactId}
Updates Biz partner contact status.Read More

2.14 Products

Endpoints for products.

GET/all-products
Returns a list of all Products.Read More
GET/all-products/{id}
Returns product for given id.Read More
GET/products/{id}
Returns product information.Read More

2.15 BizPartnerProducts

Endpoints for Biz partner Products

GET/biz-partners/{partnerId}/biz-partner-products/{bizProductId}
Returns Biz Partner Product record for given partnerId and bizProductId.Read More
DELETE/biz-partners/{partnerId}/biz-partner-products/{bizProductId}
Deletes logically Biz Partner Product record for given partnerId and bizProductId.Read More
PUT/biz-partners/{partnerId}/biz-partner-products/{bizProductId}
Updates Biz Partner Product record for given partnerId and bizProductId.Read More
POST/biz-partners/{partnerId}/biz-partner-products
Creates Biz Partner Product record for given partnerId and bizProductId.Read More
GET/biz-partners/{partnerId}/biz-partner-products
Returns a list of Biz Partner Product records for given partnerId.Read More
GET/biz-partner/{partnerId}/allowed-products
List of all Biz Partner allowed products.Read More
GET/biz-partner-products
Returns a list of all Biz Partner Products.Read More
GET/biz-partner-products/{id}
Returns information about a Biz Partner Product.Read More
PATCH/biz-partner-products/{id}
Deactivates and activates biz partner products for given id.Read More

2.16 Currency

Endpoints for currencies.

GET/currencies
Returns a list of currencies.Read More
GET/currencies/{id}
Returns a currency record for given id.Read More

2.17 Country

Endpoints for countries.

GET/countries
Returns a list of countries.Read More
GET/countries/{id}
Returns Country record for given id.Read More
GET/biz-partner-countries
Returns a list of countries related to a business partners.Read More

2.18 Language

Endpoints for countries.

GET/languages
Returns a list of languages.Read More
GET/languages/{id}
Returns Language data. Read More

2.19 MeasureUnits

Endpoints for measurement units.

GET/measure-units
Returns a list of measurement units.Read More
GET/measure-units/{id}
Returns a measurement unit record for given id.Read More

2.20 BizPositions

Endpoints for biz positions.

GET/biz-positions
Returns a list of BizPositions.Read More
GET/biz-positions/{id}
Returns a BizPosition record for given id.Read More

2.21 RelationTypes

Endpoints for relation types.

GET/relation-types
Returns a list of relation types.Read More

2.22 ServiceCategories

Endpoints for service categories.

GET/service-categories
Returns a list of ServiceCategories.Read More
GET/service-categories/{id}
Returns a ServiceCategories record for given id.Read More

2.23 BizPartnerLov

Endpoints for biz partner lov.

GET/biz-partners-lov
Returns a list of BizPartnerLov.Read More
GET/biz-partners-lov/{id}
Returns a BizPartnerLov record for given id.Read More

2.24 BizPartnerStatus

Endpoints for biz partner status.

GET/biz-partners-statuses/{status}
Returns a BizPartnerStatus record for given id.Read More

2.25 BizPartnerStat

Endpoints for biz partner stat.

GET/biz-partners-stat
Returns a list of BizPartnerStat.Read More

2.26 ContextOwner

Endpoints for context owner.

GET/contexts-owner/{ownerParam}
Returns ContextOwner.Read More

2.27 EmailAccount

Endpoints for Email account.

GET/email-accounts
Returns a list of email accounts.Read More
GET/email-accounts/{id}
Returns an email account record for given id.Read More

2.28 FinanceEmailAddresses

Endpoints for finance email addresses.

GET/biz-partners/{partnerId}/finance-email-addresses
Returns a list of FinanceEmailAddresses.Read More

2.29 ProductFeatures

Endpoints for product features.

GET/products/{productId}/product-features
Returns a list of product features.Read More
GET/products/{productId}/product-features/{featureId}
Returns ProductFeature record for given id.Read More

2.30 ProductTypePartnersLov

Endpoint for product type partners lov.

GET/product-type-partners-lov
Returns a list of ProductTypePartnersLov.Read More

2.31 FinanceSettings

Endpoints for finance settings.

GET/finance-settings/{id}
Returns FinanceSettings record for given id.Read More
PUT/finance-settings/{id}
Updates FinanceSettings for given id.Read More

2.32 ProductTypes

Endpoint for product types.

GET/product-types
Returns a list of product types.Read More

2.33 Biz partner types

Endpoint for biz partner types.

GET/biz-partners/biz-partner-type-lov
Returns a list of all biz partner types.Read More

2.34 BizSettings

Endpoints for BizSettings.

GET/biz-settings/{param}
Returns a BizSettings record from database on biz partner instance id.Read More

2.35 WebSocials

Endpoints for WebSocials.

GET/web-socials
Returns a list of all WebSocial.Read More
POST/web-socials/section/{sectionCodeName}
Creates a new WebSocial record.Read More
GET/web-socials/{id}
Returns WebSocials details for given id.Read More
PUT/web-socials/{id}
Updates a WebSocial record.Read More
DELETE/web-socials/{id}
Deletes WebSocial data logically.Read More

2.36 PartnerTypes

Endpoints for PartnerTypes.

GET/partner-types
Returns list of PartnerTypes.Read More
POST/partner-types
Creates a new PartnerType record.Read More
GET/partner-types/{id}
Returns PartnerType data for given id.Read More
PUT/partner-types/{id}
Update PartnerType data for given id.Read More
DELETE/partner-types/{id}
Deletes PartnerType data for given id logically.Read More

2.37 Industries

Endpoints for Industries.

GET/industries
Returns list of all Industries.Read More
POST/industries
Creates a new Industry record.Read More
GET/industries/{id}
Returns Industry data for given id.Read More
PUT/industries{id}
Update Industry data for given id.Read More
DELETE/industries/{id}
Deletes Industry data for given id logically.Read More

2.38 CompanySize

Endpoints for CompanySizes.

GET/company-sizes
Returns list of all CompanySize.Read More
POST/company-sizes
Creates a new CompanySize record.Read More
GET/company-sizes/{id}
Returns CompanySize data for given id.Read More
PUT/company-sizes/{id}
Update CompanySize data for given id.Read More
DELETE/company-sizes/{id}
Deletes CompanySize data for given id logically.Read More

2.39 Partners

Endpoints for Partners.

GET/partners
Returns list of all Partners.Read More
GET/partners/{id}
Get Partner.Read More
PUT/partners/{id}
Update Partner data.Read More
DELETE/partners{id}
Delete business partner logically with all necessary checks at first (pricelists, billings, balances, connections, coOwner, nGage).Read More
PATCH/partners/{id}
Change biz partner status. For deactivating process first checks instance role, pricelists, billings, balances, connections, coOwner.Read More
GET/biz-partners/{id}
Get Business Partner for given id.Read More
PUT/biz-partners/{id}
Update Business Partner for given id.Read More
POST/biz-partners-reg
Create new Biz partner record.Read More

2.40 PartnerSections

Endpoints for PartnerSections.

GET/partner-sections
Returns list of all Partner sections.Read More
GET/partner-sections/{id}
Get Partner section.Read More

2.41 AccountManagers

Endpoints for AccountManagers.

GET/account-managers
List of all Account Managers.Read More
POST/partner-sections/{id}
Create new Account Manager.Read More
GET/account-managers/{id}
Returns list of all Partner sections.Read More
PUT/partner-sections/{id}
Update Account Manager data.Read More
DELETE/account-managers/{id}
Deletes Account Manager data logically.Read More
DELETE/account-managers-remove-all-assigned-biz-products/{accountManagerId}
Deletes all account_manager_id in biz partner products for adequate account_manager_id.Read More

2.42 Attributes

Endpoints for Attributes.

GET/attributes
Returns list of all Attributes.Read More
POST/attributes
Creates a new Attributes record.Read More
GET/attributes/{id}
Returns Attributes data for given id.Read More
PUT/attributes/{id}
Update Attributes data for given id.Read More
DELETE/attributes/{id}
Deletes Attributes data for given id logically.Read More
POST/attributes/code-name
Returns Attribute code name.Read More

2.43 PartnerAttributes

Endpoints for PartnerAttributes.

GET/partner-attributes
Returns list of all PartnerAttributes.Read More
POST/partner-attributes
Creates a new PartnerAttribute record.Read More
GET/partner-attributes-ext
Returns a list of all PartnerAttributesExtend.Read More
GET/partner-attributes/{id}
Returns PartnerAttribute data.Read More
PUT/partner-attributes/{id}
Update PartnerAttribute data for given id.Read More
DELETE/partner-attributes/{id}
Deletes PartnerAttribute data logically.Read More
DELETE/partner-attributes/attributes/{attrId}/sections/{secId}
Deletes PartnerAttribute data logically.Read More

2.44 AttributePartners

Endpoints for AttributePartners.

GET/attribute-partners
Returns list of all AttributePartners.Read More

2.45 AttributeSections

Endpoints for AttributeSections.

POST/attributes/{id}/attribute-sections
Create new AttributeSection record.Read More
GET/attributes/{id}/attribute-sections/{secId}
Get AttributeSection.Read More
PUT/attributes/{id}/attribute-sections/{secId}
Update AttributeSection data.Read More
DELETE/attributes/{id}/attribute-sections/{secId}
Deletes AttributeSection record with given attribute Id and section Id.Read More

2.46 AttributeTypes

Endpoints for AttributeTypes.

GET/attribute-types
Returns list of Attribute types. Read More
GET/attribute-types/{id}
Get Attribute type.Read More

3. Methods Details

POST/biz-partners/{partnerid}/upload-logos
This Method is used to upload a logo file.Up

Method Overview

Uploads logo file

URL Parameters

Name Type Description
partnerid (required) string (path) Partner ID.
uploadfile (required) file Logo file.

Success Response: 201 Uploaded file and created record

{
  "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"
}
GET/biz-partners/{partnerid}/download-logos/{logoid}
Returns logo file.Up

Method Overview

Downloads logo file

URL Parameters

Name Type Description
partnerid (required) string (path) Partner ID.
logoid (required) string Logo file id.

Success Response 200: JPEG- or JPG- file downloaded

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/biz-partners/{partnerid}/download-logos/{status}
Download logo file.Up

Method Overview

Downloads logo file

URL Parameters

Name Type Description
partnerid (required) string (path) Partner ID.
status (required) string Available values : active.

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"
}
PATCH/biz-partners/{partnerid}/logos-change-status/{logoid}
Change logo statusUp

Method Overview

Changes the logo status by logoid. Possible statuses are: draft, active, inactive. The idea is that patch is used after a file with logo is uploaded. The default status is **draft**

URL Parameters

Name Type Description
partnerid (required) string (path) Partner ID.
logoid (required) string Logo file id.
put data (required) object (body) -

Success Response 200: Logo Changed

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}

Responses

Code Description
200 Logo status changed
default unexpected error
DELETE​/biz-partners​/{partnerid}​/logos-delete​/{logoid}
Change logo status by logoidUp

Method Overview

Change logo status by logoid, (draft, active, inactive) => deleted

URL Parameters

Name Type Description
partnerid (required) string (path) Partner ID.
logoid (required) string Logo file id.

Success Response 204: Logo file deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/biz-partners/{partnerid}/biz-partner-logos
List of BizPartnersLogo with active statusUp

Method Overview

Returns list of BizPartnersLogo by id and active status. This endpoint accepts query parameters for filtering.

URL Parameters

Name Type Description
partnerid (required) string (path) Partner ID.
all string Returns all data for given criteria. The available values are yes or no. The default value is no
page_size integer Page size. Default value is 10
page_number integer Page number. The default value is 1.
paging string Paging options. The format is: &paging=page_num,page_size eg. paging=1,10
sort string Sorting options. The format is: sort=-attribute1,attribute2,-attribute3
operator(fieldName) string URL Filtering Guidelines
 {
  "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"
}
GET/attributes/{id}/attribute-sections/{secId}/tag/{tagId}
Returns a biz attribute section tag record from database for given attributeId, sectionId and tagIdUp

URL Parameters

Name Type Description
id (required) integer (path) AttributeID.
secId (required) integer Section id.
tagId (required) integer Tag id

Success Response 200: BizAttributeSectionTag data

  "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"
}
DELETE/attributes/{id}/attribute-sections/{secId}/tag/{tagId}
Deletes a biz attribute section tag record from database for given attributeId, sectionId and tagIdUp

URL Parameters

Name Type Description
id (required) integer (path) AttributeID.
secId (required) integer Section id.
tagId (required) integer Tag id

Success Response 204: Biz attribute section deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/attributes/{id}/attribute-sections/{secId}/tag
List of Biz attribute section tagUp

Method Overview

Returns list of Biz attribute section tag. This endpoint accepts query parameters for filtering Biz attribute section tag.

URL Parameters

Name Type Description
id (required) integer (path) AttributeID.
secId (required) integer Section id.
operator(filedName) string URL Filtering Guidelines

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"
}
POST/attributes/{id}/attribute-sections/{secId}/tag
Create new Biz attribute section tag recordUp

URL Parameters

Name Type Description
id (required) integer (path) AttributeID.
secId (required) integer Section id.
post data (required) object -

Success Response 200: List of Biz attribute section tag

{
  "sectionId": 0,
  "attributeId": 0,
  "tagId": 0,
  "insertTs": "2021-01-28T11:34:08.258Z",
  "attributeTagCategoryId": 0,
  "attributeTagRowType": "string",
  "attributeTagCodeName": "string",
  "attributeTagName": "string",
  "attributeTagStatus": "string",
  "attributeTagStatusDt": "string"
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET​/attributes-tags​/{id}
Returns a biz attribute tag record for given tagIdUp

Method Overview

Returns a biz attribute tag record from database for given tagId.

URL Parameters

Name Type Description
id (required) integer (path) Tag id.

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"
}
GET​/attributes-tags​
Returns a list of Biz attribute tag recordsUp

Method Overview

Returns list of Biz attribute tag records. This endpoint accepts query parameters for filtering Biz attribute tag records.

URL Parameters

Name Type Description
operator(filedName) string (query) URL Filtering Guidelines

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"
}
GET​/biz-partners-brief
Returns a list of biz partner briefUp

Method Overview

Returns list of biz partner brief. This endpoint accepts query parameters for filtering a biz partner brief.

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) Search criteria using 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, countryName, phone, eMail, vatNumber, vatApply, egalAddress, legalAddressName, city, regNumber, status, statusDt, legalAddressCountryName, creation, instanceOwnerName, industryName, partnerTypeName, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole if operator is one of isnull, isnotnull, isempty, isnotempty field value can be ommited. If the operator is in or notin field value must be comma separated list of values. If the operator is between or notbetween field value must be comma separated list of two values representing the beginning and the end of range. Operator can be omitted and in that case it will be treated as operator is eq (Eg: fieldName=fieldValue) Example: startswith(clientName)=hor, starts with hor in field clientName if fieldName is q and operator is eq or omitted, field value will be used in general search across multiple attributes.

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"
}
GET​/account-managers-lov
Returns a list of Account manager lovUp

Method Overview

Returns list of Account manager lov. This endpoint accepts query parameters for filtering Account manager lov. For more information refer to URL Filtering Guidelines|

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: Returns 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"
}
GET/acc-mgr-partners-lov
Returns list of Account manager partner lovUp

Method Overview

Returns list of Account manager partner lov. This endpoint accepts query parameters for filtering Account manager lov. For more information refer to URL Filtering Guidelines|

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/address-types
Returns a list of Address types.Up

Method Overview

Returns list of Address types. This endpoint accepts query parameters for filtering Address types described at URL Filtering Guidelines|

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: Returns 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"
}
GET/biz-contact-types
Returns a list of Biz contact types.Up

Method Overview

Returns list of Biz contact types. This endpoint accepts query parameters for filtering Biz contact types. For more information refer to the URL Filtering Guidelines. The Required privileges are: biz-core.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: Returns 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"
}
GET/biz-contact-types/{id}
Get Biz contact type.Up

Method Overview

Returns Biz contact type for given id. The Required privileges are: biz-core.view

URL Parameters

Name Type Description
id (required) integer (path) Returns the Biz contact type for given id

Success Response 200: Returns Biz contact type data

{
  "id": 0,
  "codeName": "string",
  "name": "string",
  "status": "active"
}

#### Error Response Unexpected Error: Default

```javascript
{
  "Code": 0,
  "Message": "string"
}
GET/biz-departments
Returns a list of Biz departments.Up

Method Overview

Returns a list of Biz departments. This endpoint accepts query parameters for filtering Biz departments. For more information refer to the URL Filtering Guidelines. Required privileges -> biz-core.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: Returns a list of address type

{
  "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"
}
GET/biz-departments/{id}
Get Biz department.Up

Method Overview

Returns Biz department data. Required privileges -> biz-core.view

URL Parameters

Name Type Description
id (required) integer (path) Biz department id

Success Response 200: Returns 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"
}
GET/legal-forms
List of legal forms.Up

Method Overview

Returns list of legal forms. This endpoint accepts query parameters for filtering legal forms described in URL Filtering Guidelines. Required privileges -> biz-core.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines
{
  "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"
}
GET/biz-departments/{id}
Returns Legal Form record for given id.Up

Method Overview

Returns Legal Forms data. Required privileges -> biz-core.view

URL Parameters

Name Type Description
id (required) integer (path) LegalForms id

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"
}
GET/active-biz-partners-lov
Returns a list of Biz partner active lov.Up

Method Overview

Returns list of Biz partner active lov. This endpoint accepts query parameters for filtering Biz partner active lov described in URL Filtering Guidelines. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/biz-partners/{id}/addresses
Returns a list of Biz partner addresses.Up

Method Overview

Returns list of Biz partner addresses. This endpoint accepts query parameters for filtering Biz partner addresses described in URL Filtering Guidelines. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) Biz partner id
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
POST/biz-partners/{id}/addresses
Create Biz partner addresses.Up

Method Overview

Create Biz partner addresses Required privileges -> biz-core.manage

URL Parameters

Name Type Description
id (required) string (path) biz partner id
post data (required) object (body) -

Data Parameters

post 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
      }
    ]
  }
}

Success Response 201: Biz partner address create

{
  "id": 0,
  "countryId": 0,
  "legalForm": "string",
  "status": "active",
  "statusDt": "2021-01-13T18:11:44.996Z"
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/biz-partners/{id}/addresses/{addressId}
Returns Biz partner addresses.Up

Method Overview

Returns Biz partner addresses. Required privileges -> biz-core.view

URL Parameters

Name Type Description
id (required) integer (path) Biz partner id
addressId (required) integer (path) Address id

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"
}
PUT/biz-partners/{id}/addresses/{addressId}
Updates Biz partner addresses.Up

Method Overview

Updates Biz partner addresses. Required privileges -> biz-core.manage

URL Parameters

Name Type Description
id (required) string (path) biz partner id
addressId (required) integer (path) address id
put data (required) object (body) -

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
      }
    ]
  }
}

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"
}
DELETE/biz-partners/{id}/addresses/{addressId}
Deletes Biz partner addresses.Up

Method Overview

Deletes Biz partner addresses. Required privileges -> biz-core.manage

URL Parameters

Name Type Description
id (required) integer (path) Biz partner id
addressId (required) integer (path) address id

Success Response 204: Biz partner address deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/biz-partners/{id}/contacts
Returns a list of Biz partner contacts.Up

Method Overview

Returns Biz partner contact. 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

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"
}
PUT/biz-partners/{id}/contacts/{contactId}
Updates the Biz partner contact information.Up

Method Overview

Updates Biz partner contact. 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) -

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"
      }
    ]
  }
}

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"
}
DELETE/biz-partners/{id}/contacts/{contactId}
Deletes the Biz partner contact information.Up

Method Overview

Delete Biz partner contact. Required privileges -> biz-core.manage

URL Parameters

Name Type Description
id (required) integer (path) Biz partner id
contactId (required) integer (path) Contact id

Success Response 204: Biz partner contact deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/biz-partners/{id}/contacts
Returns a list of Biz partner contacts.Up

Method Overview

Returns list of Biz partner contacts. This endpoint accepts query parameters for filtering Biz partner contacts described in URL Filtering Guidelines. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) Biz partner id
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
POST/biz-partners/{id}/contacts
Creates Biz partner contacts.Up

Method Overview

Create Biz partner contacts. Required privileges -> biz-core.manage

URL Parameters

Name Type Description
id (required) integer (path) Biz partner id
post data object (body) -

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"
      }
    ]
  }
}

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"
}
PUT/biz-partners/{id}/contacts-status/{contactId}
Updates Biz partner contact status.Up

Method Overview

Updates Biz partner status. 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) -

Data Parameters

put data object example

{
  "status": "active"
}

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"
}
GET/all-products
Returns a list of all Products.Up

Method Overview

Returns list of Products. This endpoint accepts query parameters for filtering Products described in URL Filtering Guidelines.

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/all-products/{id}
Returns product for given id.Up

Method Overview

Returns product for given id.

URL Parameters

Name Type Description
id (required) integer (path) Product id.

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"
}
GET/products/{id}
Returns Product data.Up

Method Overview

Returns Product data.

URL Parameters

Name Type Description
id (required) integer (path) Product id.

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"
}
GET/biz-partners/{partnerId}/biz-partner-products/{bizProductId}
Returns Biz Partner Product record for given partnerId and bizProductId.Up

Method Overview

Returns Biz Partner Product record for given partnerId and bizProductId. 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.

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"
}
DELETE/biz-partners/{partnerId}/biz-partner-products/{bizProductId}
Deletes logically Biz Partner Product record for given partnerId and bizProductId.Up

Method Overview

Deletes logically Biz Partner Product record for given partnerId and bizProductId. Required privileges -> biz-core.manage

URL Parameters

Name Type Description
partnerid (required) integer (path) Biz Partner Id.
bizProductId (required) integer (path) Product Id.

Success Response 204: BizPartnerProduct data deleted

{
  "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 409:BizPartnerProduct data can not be deleted due its relation type owner

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
PUT/biz-partners/{partnerId}/biz-partner-products/{bizProductId}
Updates Biz Partner Product record for given partnerId and bizProductId.Up

Method Overview

Updates Biz Partner Product record for given partnerId and bizProductId. 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) -

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
  }
}

Success Response 200: BizPartnerProduct data updated successfully

{
  "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
  }
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
POST/biz-partners/{partnerId}/biz-partner-products
Creates Biz Partner Product record for given partnerId and bizProductId.Up

Method Overview

Creates Biz Partner Product record for given partnerId and bizProductId. Required privileges -> biz-core.manage

URL Parameters

Name Type Description
post data (required) object (body) -

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
  }
}

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"
}
GET/biz-partners/{partnerId}/biz-partner-products
Returns a list of Biz Partner Product records for given partnerId.Up

Method Overview

Returns list of Biz Partner Products. This endpoint accepts query parameters for filtering Biz Partner Products described in URL Filtering Guidelines|

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines
partnerid (required) integer (path) Biz Partner Id.

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"
}
GET/biz-partner/{partnerId}/allowed-products
Returns a list of all Biz Partner allowed products.Up

Method Overview

Returns list of Biz Partner allowed products. This endpoint accepts query parameters for filtering Biz Partner allowed products described in URL Filtering Guidelines|

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines
partnerid (required) integer (path) Biz Partner Id.

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"
}
GET/biz-partner-products
Returns a list of all Biz Partner Productss.Up

Method Overview

Returns list of Biz Partner Products. This endpoint accepts query parameters for filtering Biz Partner Products described in URL Filtering Guidelines|

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines
partnerid (required) integer (path) Biz Partner Id.

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"
}
GET/biz-partner-products/{id}
Get Biz Partner Product.Up

Method Overview

Returns Biz Partner Product data.

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines
partnerid (required) integer (path) Biz Partner Id.

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"
}
PATCH/biz-partner-products/{id}
Deactivates and activates biz partner products for given id.Up

Method Overview

Returns activated or deactivated biz partner product (updated status)

URL Parameters

Name Type Description
partnerid (required) integer (path) Biz Partner Product Id.
put data (required) object (body) -

Data Parameters

put data object example

{
  "status": "suspended"
}

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"
}
GET/currencies
Returns a List of currencies.Up

Method Overview

Returns list of currencies. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/currencies/{id}
Returns Currency record for given id.Up

Method Overview

Returns Currency data. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) Currency Id.

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"
}
GET/countries
Returns a List of countries.Up

Method Overview

Returns list of countries. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/countries/{id}
Returns Country record for given id.Up

Method Overview

Returns Country data.

URL Parameters

Name Type Description
id (required) integer (path) Country Id.

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"
}
GET/biz-partner-countries
Returns list of countries related to business partners.Up

Method Overview

Returns list of countries related to business partners. This endpoint accepts query parameters for filtering countries described in URL Filtering Guidelines Required privileges -> biz-core.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/languages
Returns a List of languages.Up

Method Overview

Returns list of languages. This endpoint accepts query parameters for filtering languages described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/languages/{id}
Returns language record for given id.Up

Method Overview

Returns language data. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) Language Id.

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"
}
GET/measure-units
Returns a list of MeasureUnits.Up

Method Overview

Returns list of MeasureUnits. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/measure-units/{id}
Returns MeasureUnit record for given id.Up

Method Overview

Returns MeasureUnit data. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) MeasureUnit id.

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"
}
GET/biz-positions
Returns a list of BizPositions.Up

Method Overview

Returns list of BizPositions. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/biz-positions/{id}
Returns BizPositions record for given id.Up

Method Overview

Returns BizPositions data. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) BizPositions Id.

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"
}
GET/relation-types
Returns a list of RelationTypes.Up

Method Overview

Returns list of RelationTypes. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/service-categories
Returns a list of ServiceCategories.Up

Method Overview

Returns list of ServiceCategories. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/service-categories/{id}
Returns ServiceCategories record for given id.Up

Method Overview

Returns ServiceCategories data. Required privileges -> biz-core.view

URL Parameters

Name Type Description
id (required) integer (path) ServiceCategories Id.

Success Response 200: ServiceCategories data

{
  "id": 0,
  "category": "string"
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/biz-partners-lov
Returns a list of BizPartnerLov.Up

Method Overview

Returns list of BizPartnerLov. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: List of ServiceCategories 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"
}
GET/biz-partners-lov/{id}
Returns BizPartnerLov record for given id.Up

Method Overview

Returns BizPartnerLov data. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) BizPartnerLov Id.

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"
}
GET/biz-partners-statuses/{status}
Returns BizPartnerStatus record for given id.Up

Method Overview

Returns BizPartnerStatus data. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) Status. Available values : active, potential, archived, misc, suspended, draft.

Success Response 200: BizPartnerStatus data

{
  "partnerStatus": "active",
  "partnerStatusCount": 0
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/biz-partners-stat
Returns a list of BizPartnerStat.Up

Method Overview

Returns a list of BizPartnerStat. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

No parameters

Success Response 200: BizPartnerStat data

{
  "data": [
    {
      "partnerRelationTypeId": 0,
      "partnerRelationType": "string",
      "partnerRelationCount": 0,
      "partnerRelationPercentage": 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"
}
GET/contexts-owner/{ownerParam}
Returns ContextOwner.Up

Method Overview

Returns ContextOwner Required privileges -> biz-core.view

URL Parameters

Name Type Description
ownerParam (required) string (path) Parameter.

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"
}
GET/email-accounts
Returns a list of EmailAccounts.Up

Method Overview

Returns list of EmailAccounts. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: List of EmailAccounts 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"
}
GET/biz-partners-lov/{id}
Returns EmailAccount record for given id.Up

Method Overview

Returns EmailAccount data. Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
id (required) integer (path) EmailAccount Id.

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"
}
GET/biz-partners/{partnerId}/finance-email-addresses
Returns a list of FinanceEmailAddresses.Up

Method Overview

Returns list of FinanceEmailAddresses. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view

URL Parameters

Name Type Description
partnerId (required) integer (path) biz Partner id
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/products/{productId}/product-features
Returns a list of ProductFeatures.Up

Method Overview

Returns list of ProductFeatures. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view

URL Parameters

Name Type Description
productId (required) integer (path) Product id
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/products/{productId}/product-features/{featureId}
Returns ProductFeature record for given id.Up

Method Overview

Returns ProductFeature data. Required privileges -> biz-core.view

URL Parameters

Name Type Description
productId (required) integer (path) Product Id.
featureId (required) integer (path) Feature Id.

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"
}
GET/product-type-partners-lov
Returns a list of ProductTypePartnersLov.Up

Method Overview

Returns list of ProductTypePartnersLov. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/products/{productId}/product-features/{featureId}
Returns FinanceSettings record for given id.Up

Method Overview

Returns FinanceSettings data. Required privileges -> biz-core.view

URL Parameters

Name Type Description
id (required) integer (path) Biz partner Id.

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"
}
PUT/finance-settings/{id}
Updates FinanceSettings.Up

Method Overview

Updates FinanceSettings. Required privileges -> biz-core.manage

URL Parameters

Name Type Description
productId (required) integer (path) Product Id.
putdata (required) object (body) -

Data Parameters

put data object example

{
  "partnerInDraft": "yes",
  "nettingPartner": "yes",
  "hardCopyAddressIsDefault": "yes",
  "invoiceAddressId": 0,
  "emailContact": {
    "emailAccountId": 0,
    "emailAddresses": [
      {
        "addressType": "to",
        "eMail": "user@example.com"
      }
    ]
  }
}

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"
}
GET/product-types
Returns a list of ProductTypes.Up

Method Overview

Returns list of ProductTypes. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/biz-partners/biz-partner-type-lov
Returns a list of all biz partner types.Up

Method Overview

Returns list of biz partner types. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/biz-settings/{param}
Get BizSettings.Up

Method Overview

Returns BizSettings record from database on biz partner instance id.

URL Parameters

Name Type Description
param (required) string (path) BizSettings param to get

Success Response 200: BizSettings data

{
  "instanceId": 0,
  "coOwnersEnabled": "no",
  "resellersEnabled": "no"
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/web-socials
Returns a list of all WebSocial.Up

Method Overview

Returns list of WebSocial. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: List of WebSocial

{
  "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"
}
POST/web-socials/section/{sectionCodeName}
Creates new WebSocial record.Up

Method Overview

Returns BizSettings record from database on biz partner instance id.

URL Parameters

Name Type Description
sectionCodeName (required) string (path) code name for section - DETAILS, CONTACTS, FINANCE-SETTINGS
post data (required) object (body) -

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"
}
GET/web-socials/{id}
Gets WebSocial.Up

Method Overview

Returns WebSocial data.

URL Parameters

Name Type Description
id (required) integer (path) WebSocial id

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"
}
PUT/web-socials/{id}
Update WebSocial datal.Up

Method Overview

Update WebSocial data

URL Parameters

Name Type Description
id (required) integer (path) WebSocial id
put data (required) object (body) -

Data Parameters

put data object example

{
  "name": "string",
  "value": "string"
}

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"
}
DELETE/web-socials/{id}
Deletes WebSocial data logically.Up

Method Overview

Deletes WebSocial record with given Id.

URL Parameters

Name Type Description
id (required) integer (path) WebSocial id

Success Response 200: WebSocial deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/partner-types
List of all PartnerTypes.Up

Method Overview

Returns list of PartnerTypes. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
POST/partner-types
Creates new PartnerType record.Up

Method Overview

Create new PartnerType record.

URL Parameters

Name Type Description
post data (required) object (body) -

Data Parameters

post data object example

{
  "name": "manually",
  "selfOwner": "yes"
}

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"
}
GET/partner-types/{id}
Gets PartnerType.Up

Method Overview

Returns PartnerType data.

URL Parameters

Name Type Description
id (required) integer (path) PartnerType id

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"
}
PUT/partner-types/{id}
Updates PartnerType data.Up

Method Overview

Update PartnerType data

URL Parameters

Name Type Description
id (required) integer (path) PartnerType id
put data (required) object (body) -

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"
}

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"
}
DELETE/partner-types/{id}
Deletes PartnerType data logically.Up

Method Overview

Deletes PartnerType record with given Id.

URL Parameters

Name Type Description
id (required) integer (path) PartnerType id

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"
}

Success Response 200: Partner type deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/industries
Returns a list of all Industry.Up

Method Overview

Returns list of Industries. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
POST/industries
Creates new Industry record.Up

Method Overview

Create new Industry record.

URL Parameters

Name Type Description
post data (required) object (body) -

Data Parameters

post data object example

{
  "name": "string",
  "favorite": "yes"
}

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"
}
GET/industries/{id}
Returns Industry data.Up

Method Overview

Returns Industry data.

URL Parameters

Name Type Description
id (required) integer (path) Industry id

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"
}
PUT/industries/{id}
Update Industry data.Up

Method Overview

Updates Industry data.

URL Parameters

Name Type Description
id (required) integer (path) Industry id
put data (required) object (body) -

Data Parameters

put data object example

{
  "name": "string",
  "status": "active",
  "favorite": "yes"
}

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"
}
DELETE/industries/{id}
Deletes Industry data logically.Up

Method Overview

Deletes Industry record with given Id.

URL Parameters

Name Type Description
id (required) integer (path) Industry id

Success Response 200: Industry deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/company-sizes
Returns a list of all CompanySize.Up

Method Overview

Returns list of CompanySize. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: List of CompanySize

{
  "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"
}
POST/company-sizes
Creates new Industry record.Up

Method Overview

Create new CompanySize record.

URL Parameters

Name Type Description
post data (required) object (body) -

Data Parameters

post data object example

{
  "companySize": "string",
  "favorite": "yes"
}

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"
}
GET/company-sizes/{id}
Returns CompanySize data.Up

Method Overview

Returns CompanySize data.

URL Parameters

Name Type Description
id (required) integer (path) CompanySize id

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"
}
PUT/company-sizes/{id}
Update CompanySize data.Up

Method Overview

Updates CompanySize data.

URL Parameters

Name Type Description
id (required) integer (path) CompanySize id
put data (required) object (body) -

Data Parameters

put data object example

{
  "companySize": "string",
  "status": "active",
  "favorite": "yes"
}

Success Response 200: CompanySize data

{
  "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"
}
DELETE/company-sizes/{id}
Deletes CompanySize data logically.Up

Method Overview

Deletes CompanySize record with given Id.

URL Parameters

Name Type Description
id (required) integer (path) CompanySize id

Success Response 200: CompanySize deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/partners
Returns a list of all Partners.Up

Method Overview

Returns list of Partners. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
DELETE/partners/{id}
Returns Partner data.Up

Method Overview

Returns Partner data.

URL Parameters

Name Type Description
id (required) integer (path) Partner id

Success Response 200: Partner deleted successfully

{
  "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:33:29.092Z",
  "statusDt": "2021-02-02T13:33:29.092Z"
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
PUT/partners/{id}
Updates Partner data.Up

Method Overview

Updates Partner data.

URL Parameters

Name Type Description
id (required) integer (path) Partner id
put data (required) object (body) -

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
}

Success Response 200: Partner updated successfully

{
  "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:35:40.741Z",
  "statusDt": "2021-02-02T13:35:40.741Z"
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
DELETE/partners/{id}
Delete business partner logically with all necessary checks at first (pricelists, billings, balances, connections, coOwner, nGage).Up

Method Overview

Delete business partner logically with all necessary checks at first (pricelists, billings, balances, connections, coOwner, nGage)

URL Parameters

Name Type Description
id (required) integer (path) Partner id

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"
}
PATCH/partners/{id}
Change biz partner status. For deactivating process first checks instance role, pricelists, billings, balances, connections, coOwner.Up

Method Overview

Change biz partner status. For deactivating process first checks instance role, pricelists, billings, balances, connections, coOwner

URL Parameters

Name Type Description
id (required) integer (path) Partner id
put data (required) object (body) -

Data Parameters

put data object example

{
  "status": "suspended"
}

Success Response 200: Partners status changed successfully

{
  "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:44:58.503Z",
  "statusDt": "2021-02-02T13:44:58.503Z"
}

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"
}
GET/partners/{id}
Get Business Partner for given idUp

Method Overview

Returns Business Partner data. Required privilege -> biz-core.view or biz-core.own.view Embed - Legal Address Allowed embedded objects: legalAddress, bizPartnerProduct Example: embed=legalAddress embed=bizPartnerProduct

URL Parameters

Name Type Description
id (required) integer (path) Partner id
embed integer (query) Allowed embedded objects legalAddress, bizPartnerProducts; Example embed=legalAddress, embed=bizPartnerProduct

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"
}
PUT/biz-partners/{id}
Update Business Partner for given id.Up

Method Overview

Updates Business Partner data. Required privilege -> biz-core.manage

URL Parameters

Name Type Description
id (required) integer (path) Partner id
put data (required) object (body) -

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"
      }
    ]
  }
}

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:57:15.427Z",
  "statusActiveDt": "2021-02-02T13:57:15.427Z",
  "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:57:15.427Z",
        "disabledDt": "2021-02-02T13:57:15.427Z",
        "statusDt": "2021-02-02T13:57:15.427Z",
        "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"
}
POST/biz-partners-reg
Creates new Biz partner record.Up

Method Overview

Create new Biz partner record. Required privileges -> biz-core.manage, auth.resource.add

URL Parameters

Name Type Description
post data (required) object (body) -

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"
      }
    ]
  }
}

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"
}
GET/partner-sections
Returns a list of all Partner sections.Up

Method Overview

Returns list of Partner sections. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/partner-sections/{id}
Returns a Partner section.Up

Method Overview

Returns a Partner section data.

URL Parameters

Name Type Description
id (required) integer (path) Partner section id

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"
}
GET/account-managers
Returns a list of all Account Managers.Up

Method Overview

Returns a list of all Account Managers. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
POST/account-managers
Creates new Account Manager.Up

Method Overview

Creates new Account Manager.

URL Parameters

Name Type Description
post data (required) object (body) -

Data Parameters

post data object example

{
  "name": "string",
  "email": "string",
  "accountMgrProducts": [
    {
      "productId": 0
    }
  ]
}

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"
}
GET/account-managers/{id}
Returns an Account Manager data.Up

Method Overview

Returns Account Manager data.

URL Parameters

Name Type Description
id (required) integer (path) Account Manager id

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"
}
PUT/account-managers/{id}
Updates Account Manager data.Up

Method Overview

Updates Account Manager data.

URL Parameters

Name Type Description
id (required) integer (path) Account Manager id
put data (required) object (body) -

Data Parameters

put data object example

{
  "name": "string",
  "email": "string",
  "status": "active",
  "accountMgrProducts": [
    {
      "productId": 0
    }
  ]
}

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"
}
DELETE/account-managers/{id}
Deletes Account Manager data logically.Up

Method Overview

Delete Account Manager logically.

URL Parameters

Name Type Description
id (required) integer (path) Account Manager id

Success Response 200: Account Manager deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
DELETE/account-managers-remove-all-assigned-biz-products/{accountManagerId}
Deletes all account_manager_id in all biz partner products for adequate account_manager_id.Up

Method Overview

Deletes all account_manager_id in biz partner products for adequate account_manager_id.

URL Parameters

Name Type Description
accountManagerId (required) integer (path) Account Manager id

Success Response 200: Deletes all account_manager_id in biz partner products for adequate account_manager_id updated successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/attributes
Returns a list of all Attributes.Up

Method Overview

Returns a list of all Attributes. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
POST/account-managers
Creates new Attribute record.Up

Method Overview

Creates new Attribute record.

URL Parameters

Name Type Description
post data (required) object (body) -

Data Parameters

post data object example

{
  "attributeTypeId": 0,
  "codeName": "string",
  "name": "string"
}

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"
}
GET/attributes/{id}
Returns Attribute data.Up

Method Overview

Returns Attribute data.

URL Parameters

Name Type Description
id (required) integer (path) Attribute id

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"
}
PUT/attributes/{id}
Updates Attribute data.Up

Method Overview

Updates Attribute data.

URL Parameters

Name Type Description
id (required) integer (path) Attribute id
put data (required) object (body) -

Data Parameters

put data object example

{
  "attributeTypeId": 0,
  "codeName": "string",
  "name": "string",
  "status": "active"
}

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"
}
DELETE/attributes/{id}
Deletes Attribute data logically.Up

Method Overview

Deletes Attribute record with given Id.

URL Parameters

Name Type Description
id (required) integer (path) Attribute id

Success Response 200: Attribute deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
POST/attributes/code-name
Returns Attribute code name.Up

Method Overview

Returns Attribute code name.

URL Parameters

Name Type Description
post data (required) object (body) -

Data Parameters

put data object example

{
  "name": "string"
}

Success Response 200: Attribute code name data

{
  "codeName": "string"
}

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/partner-attributes
Returns a list of all PartnerAttributes.Up

Method Overview

Returns a list of all PartnerAttributes. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines Required privileges -> biz-core.view or biz-core.own.view

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
POST/partner-attributes
Creates new PartnerAttribute record.Up

Method Overview

Creates new PartnerAttribute record.

Data Parameters

post data object example

{
  "sectionId": 0,
  "sectionRowId": 0,
  "attributeId": 0,
  "bizPartnerId": 0,
  "customAttrName": "string",
  "attributeValue": "string",
  "jsonValue": {
    "value": "string"
  }
}

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"
}
GET/partner-attributes-ext
Returns list of all PartnerAttributesExtend.Up

Method Overview

Returns a list of PartnerAttributes. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: Attribute data

{
  "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"
}
GET/partner-attributes/{id}
Returns PartnerAttribute data.Up

Method Overview

Returns PartnerAttribute data.

URL Parameters

Name Type Description
id (required) integer (path) PartnerAttribute id

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"
}
PUT/partner-attributes/{id}
Updates PartnerAttribute data.Up

Method Overview

Updates PartnerAttribute data.

URL Parameters

Name Type Description
id (required) integer (path) PartnerAttribute id
put data (required) object (body) -

Data Parameters

put data object example

{
  "sectionId": 0,
  "sectionRowId": 0,
  "attributeId": 0,
  "bizPartnerId": 0,
  "customAttrName": "string",
  "attributeValue": "string",
  "jsonValue": {
    "value": "string"
  }
}

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"
}
DELETE/partner-attributes/{id}
Deletes PartnerAttribute data logically.Up

Method Overview

Deletes PartnerAttribute record with given Id.

URL Parameters

Name Type Description
id (required) integer (path) PartnerAttribute id

Success Response 200: PartnerAttribute deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
DELETE/partner-attributes/attributes/{attrId}/sections/{secId}
Deletes PartnerAttribute data logically.Up

Method Overview

Deletes PartnerAttribute record with given attributeId and sectionId.

URL Parameters

Name Type Description
attrId (required) object (body) integer (path) Attribute id
secId (required) integer (path) Section id

Success Response 200: Partner attributes deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/attribute-partners
Returns a list of AttributePartners.Up

Method Overview

Returns a list of AttributePartners. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines

URL Parameters

Name Type Description
operator(fieldName) string (query) URL Filtering Guidelines

Success Response 200: AttributePartners updated successfully

{
  "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"
}
POST/attributes/{id}/attribute-sections
Create new AttributeSection record.Up

Method Overview

Creates new AttributeSection record.

URL Parameters

Name Type Description
id (required) integer (path) Attribute id
post data (required) object (body) -

Data Parameters

post data object example

{
  "sectionId": 0
}

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"
}
GET/attributes/{id}/attribute-sections/{secId}
Returns AttributeSection.Up

Method Overview

Returns AttributeSection data.

URL Parameters

Name Type Description
Id (required) object (body) integer (path) Attribute id
secId (required) integer (path) Section id

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"
}
PUT/attributes/{id}/attribute-sections/{secId}
Updates AttributeSection data.Up

Method Overview

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) -

Data Parameters

put data object example

{
  "status": "active"
}

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"
}
DELETE/attributes/{id}/attribute-sections/{secId}
Deletes AttributeSection data logically.Up

Method Overview

Deletes AttributeSection record with given Attribute Id and Section Id.

URL Parameters

Name Type Description
id (required) integer (path) PartnerAttribute id
secId (required) integer (path) Section id

Success Response 200: Attribute section deleted successfully

Error Response Unexpected Error: Default

{
  "Code": 0,
  "Message": "string"
}
GET/attribute-types
Returns list of all Attribute types.Up

Method Overview

Returns list of Attribute types. This endpoint accepts query parameters for filtering currencies described in URL Filtering Guidelines

URL Parameters

Name Type Description
all string (query) Return all data for given criteria Available values : yes, no Default value : no
page_size integer (query) Page size. Default value : 10
page_number integer (query) Page number. Default value : 1
paging string (query) Paging options in form of &paging=page_num page_size eg. paging=1,10
sort string (query) Sort options in form of sort=-attribute1,attribute2,-attribute3
operator(fieldName) string (query) URL Filtering Guidelines

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"
}
GET/attribute-types/{id}
Returns Attribute type.Up

Method Overview

Returns Attribute type data.

URL Parameters

Name Type Description
id (required) integer (path) Attribute type id

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"
}