Business Partner API

1. Introduction

The HORISEN Business Partner API serves as the backbone of the Business Partner module within the HORISEN platform. It is a RESTful JSON-based API designed to facilitate the management and integration of Business Partner data, which are widely used across the HORISEN platform's services. This API enables seamless interaction with core data objects, such as companies, contacts, and partner relationships, ensuring consistent and centralized management of a Business Partner information for all dependent services and APIs.

The HORISEN Business Partner API endpoints belong to the biz-core service, developed for Business Core data management. The API endpoint base path is as follows:

https://api{separator}{platform_domain}/biz-core/v2

Note: A base domain is presented with placeholders as https://api{separator}{platform_domain}, where {separator} can be a dot (.) or a hyphen (-). Please, replace it with your actual platform domain name.

Use Cases

General use cases of the Business Partner API include operations such as retrieving partner and account manager information, managing addresses, contact types, uploading and handling logo documents, and organizing departmental data. This API supports efficient integration and centralized control of a Business Partner related assets and configurations, ensuring consistency and automation across connected services.

Authentication

The Business Partner API supports OAuth 2.0 authentication, a secure industry-standard protocol for authorization. This ensures that only authorized applications and users can access the API by requiring valid access tokens. OAuth 2.0 enables seamless integration with identity providers and ensures secure, token-based access management across all connected serves.
An example of how to implement OAuth 2.0 and obtain access token, as well as an example of using The HORISEN API service, is available at OAuth2 Authentication Guidelines page.

2. Methods Overview

2.1 Documents Configuration

The Documents Configuration section provides API methods and endpoints for managing logo-related data associated with Business Partners. It enables uploading, downloading, updating, and deleting logo files, as well as changing their status. These endpoints support typical document management operations, allowing flexible integration with Business Partner profiles. Use cases include assigning official logos, retrieving logos for branding purposes, and managing logo approval workflows.

Method Name	Description	Use Case
POST/biz-partners/{partnerid}/upload-logos Read More	Uploads a logo file for a given partnerId.	A logo for a Business Partner can be uploaded and associated with the Business Partner's profile. It can be used in email templates, invoices, reports, and other communications generated by the system.
GET/biz-partners/{partnerid}/download-logos/{logoid} Read More	Returns a logo file for a given partnerId and logoid.	An integration service needs to retrieve and display the logo of a Business Partner (for example, in a dashboard, email template, or partner profile).
GET/biz-partners/{partnerid}/download-logos/{status} Read More	Returns a logo file for a given partnerId and status.	For 'status=approved', the system returns a list of all logos for a Business Partner that have been approved and are ready for use.
PATCH/biz-partners/{partnerid}/logos-change-status/{logoid} Read More	Changes logo status for a given partnerId and logoid.	Updates the status of a specific logo, supporting processes like approval workflows or archiving.
DELETE/biz-partners/{partnerid}/logos-delete/{logoid} Read More	Changes logo status for a given partnerId and logoid.	Removing a Business Partner logo from the system, which is essential for maintaining up-to-date branding.
GET/biz-partners/{partnerid}/biz-partner-logos Read More	Returns a list of BizPartnersLogo with active status for a given partnerId.	Retrieving all a Business Partner logos with active status.

2.2 Biz Partner Brief

The Biz Partner Brief endpoint retrieves a summarized list of Business Partners, offering quick access to essential partner information for selection or overview purposes.

Method Name	Description	Use Case
GET/biz-partners-brief Read More	Returns a list of Biz Partner brief.	Useful for applications or services that need to quickly fetch a partners' high-level data — such as name, ID, status, or registration details.

2.3 Account Manager LOV

The Account Manager LOV section includes the endpoint that provides a list of account managers in lightweight, label-value format (LOV - List of Values), allowing the user to select the appropriate account manager for a Business Partner from predefined options.

Method Name	Description	Use Case
GET/account-managers-lov Read More	Returns a list of Account Manager list of values.	Useful for applications to fetch a list of available account managers to populate a selection field when assigning a manager to a Business Partner.

2.4 Account Manager Partner LOV

This endpoint provides a list of associations between account managers and their respective Business Partners, aiding in oversight and reporting tasks.

Method Name	Description	Use Case
GET/acc-mgr-partners-lov Read More	Returns a list of Account Manager Partner list of values.	Useful for applications to fetch a list of available partners account managers to populate a selection field when assigning a manager to a Business Partner.

2.5 Address Type

This endpoint retrieves predefined address types, ensuring standardized address entries across the platform for consistency and accuracy.

Method Name	Description	Use Case
GET/address-types Read More	Returns a list of Address types.	Use to populate dropdowns or validate address type fields in forms.

2.6 Biz Contact Type

The following endpoints manage business contact types, allowing the definition and retrieval of various contact roles associated with partners.

Method Name	Description	Use
GET/biz-contact-types Read More	Returns a list of Biz contact type.	Retrieve a list of all Biz contact types available.
GET/biz-contact-types/{id} Read More	Returns a Biz contact type for a given id.	Retrieve a Biz contact type record for a given ID.

2.7 Biz Department

These endpoints handle the creation, retrieval, updating, and deletion of business department records, supporting organizational structure within the platform.

Method Name	Description	Use Case
GET/biz-departments Read More	Returns a list of Biz departments.	Useful to fetch all defined business departments when populating department-related dropdowns in the UI.
POST/biz-departments Read More	Creates a new Biz department record.	Use to create a new Biz department in the system.
GET/biz-departments/{id} Read More	Returns a Biz department for a given id.	Retrieving details of a specific Biz department by ID.
PUT/biz-departments/{id} Read More	Updates a Biz department data for a given id.	Updating the details of an existing Biz department by ID.
DELETE/biz-departments/{id} Read More	Deletes a Biz department data logically for a given id.	Use to delete a Biz department from the system by ID, marking it as deleted.

2.8 Legal Forms

The following endpoints provide access to legal form records, helping to identify and manage the legal structures of Business Partners.

Method Name	Description	Use Case
GET/legal-forms Read More	Returns a list of legal forms.	Retrieving a list of all available legal forms.
GET/legal-forms/{id} Read More	Returns Legal Form record for a given id.	Retrieving the details of a specific legal form by its ID.

2.9 Biz Partner Active LOV

The endpoint that returns a list of currently active Business Partners, useful for filtering operations or generating reports that focus on active entities.

Method Name	Description	Use Case
GET/active-biz-partners-lov Read More	Returns a list of active Biz Partner LOV.	Use to populate dropdowns or selection lists with only active Biz Partners for assigning or filtering related records.

2.10 Biz Partner Addresses

These endpoints manage addresses associated with Business Partners, allowing addition, retrieval, updating, and deletion of address records to maintain accurate location information.

Method Name	Description	Use Case
GET/biz-partners/{id}/addresses Read More	Returns a list of addresses for a given Biz Partner id.	Retrieving all business addresses for a specific Biz Partner.
POST/biz-partners/{id}/addresses Read More	Creates Biz Partner addresses for a given Biz Partner id.	Use to add new addresses for a Biz Partner.
GET/biz-partners/{id}/addresses/{addressId} Read More	Returns Biz Partner address for a given Biz Partner id and addressId.	Retrieving a specific address of a Biz Partner based on the address ID.
PUT/biz-partners/{id}/addresses/{addressId} Read More	Updates Biz Partner addresses for a given Biz Partner id and addressId.	Updating an existing address for a Biz Partner.
DELETE/biz-partners/{id}/addresses/{addressId} Read More	Deletes Biz Partner address for a given Biz Partner id and addressId.	Use to delete a specific address for a Biz Partner based on the address ID.

2.11 Biz Partner Contact

These endpoints handle the management of contacts linked to Business Partners, facilitating the maintenance of up-to-date contact information for various roles within partner organizations.

Method Name	Description	Use Case
GET/biz-partners/{id}/contacts/{contactId} Read More	Returns a Biz Partner contact for a given Biz Partner id and contactId.	Retrieving a specific contact for a Biz Partner based on the contact ID.
PUT/biz-partners/{id}/contacts/{contactId} Read More	Updates a Biz Partner contact for a given Biz Partner id and contactId.	Updating an existing contact for a Biz Partner.
DELETE/biz-partners/{id}/contacts/{contactId} Read More	Deletes a Biz Partner contact for a given Biz Partner id and contactId.	Use to delete a specific contact for a Biz Partner based on the contact ID.
GET/biz-partners/{id}/contacts Read More	Returns a list of Biz Partner contacts for a given Biz Partner id.	Retrieving all contacts for a specific Biz Partner.
POST/biz-partners/{id}/contacts Read More	Creates Biz Partner contacts for a given Biz Partner id.	Use to add new contacts for a Biz Partner.
PUT/biz-partners/{id}/contacts-status/{contactId} Read More	Updates Biz Partner contact status for a given Biz Partner id and contactId.	Updating the status of a specific contact for a Biz Partner.
GET/biz-partners-contacts Read More	Returns a list of all Biz Partners contacts for an instance.	Retrieving all Biz Partner contacts across the entire instance.
PUT/biz-partners-contacts-update Read More	Updates Biz Partners contacts for departmentId and positionId.	Updating Biz Partner contacts by department ID and position ID.

2.12 Products

The following endpoints manage products associated with Business Partners, enabling the listing and detailed retrieval of products linked to partners for inventory and relationship management.

Method Name	Description	Use Case
GET/all-products Read More	Returns a list of all Products.	Retrieving all available products.
GET/all-products/{id} Read More	Returns Product for a given id.	Retrieving a specific product using its ID.
GET/products Read More	Returns a list of all Biz Partner products.	Retrieving all products associated with Biz Partners.
GET/products/{id} Read More	Returns a Biz Partner product for a given id.	Retrieving a specific Biz Partner product using its ID.

2.13 BizPartnerProducts

These endpoints manage products linked to Business Partners, allowing creating, retrieving, updating, and logically deleting partner-specific products, as well as listing available or assigned products for a partner.

Method Name	Description	Use Case
GET/biz-partners/{partnerId}/biz-partner-products/{bizProductId} Read More	Returns the Biz Partner product record for a given partnerId and bizProductId.	Retrieve detailed information about a specific product associated with a Business Partner.
DELETE/biz-partner/{partnerId}/biz-partner-products/{bizProductId} Read More	Logically deletes the Biz Partner product record for a given partnerId and bizProductId.	Remove a product from a partner's list while keeping it in the database for reference.
PUT/biz-partners/{partnerId}/biz-partner-products/{bizProductId} Read More	Updates the Biz Partner product record for a given partnerId and bizProductId.	Modify product details linked to a specific partner.
POST/biz-partners/{partnerId}/biz-partner-products Read More	Creates a new Biz Partner product record for a given partnerId.	Add a new product to a Business Partner's product list.
GET/biz-partners/{partnerId}/biz-partner-products Read More	Returns a list of Biz Partner product records for a given partnerId.	View all products associated with a specific partner.
GET/biz-partner/{partnerId}/allowed-products Read More	Returns a list of all allowed Biz Partner products for a given partnerId.	Check which products a partner is permitted to offer.
GET/biz-partner-products Read More	Returns a list of all Biz Partner products.	Get a full list of available partner products in the system.
GET/biz-partner-products/{id} Read More	Returns data for a specific Biz Partner product by id.	View detailed product information by product ID.
PATCH/biz-partner-products/{id} Read More	Activates or deactivates a Biz Partner product by id.	Enable or disable a product in the system for management or cleanup purposes.

2.14 Currency

These endpoints retrieve currency information. the endpoints can be used for fetching a list of all available currencies or retrieving details of a specific currency by its ID.

Method Name	Description	Use Case
GET/currencies Read More	Returns a list of currencies.	Retrieving all available currencies, useful for populating currency lists or validating currency codes.
GET/currencies/{id} Read More	Returns a Currency record for a given id.	Retrieving detailed information about a specific currency by ID, often for displaying full details of a selected currency.

2.15 Country

The Country section endpoints provide a list of available countries within the system, useful for country-specific configurations or settings.

Method Name	Description	Use Case
GET/countries Read More	Returns a list of countries.	Retrieving all available countries, often used for populating country dropdowns or validating country selections.
GET/countries/{id} Read More	Returns Country record for a given id.	Retrieving detailed information about a specific country to display information for a selected country.
GET/biz-partner-countries Read More	Returns a list of countries related to Business Partners.	Retrieving the countries associated with Business Partners, often used for filtering or segmenting partners by country.

2.16 Language

These endpoints retrieve a list and details of available languages within the system.

Method Name	Description	Use Case
GET/languages Read More	Returns a list of languages.	Retrieving all available languages when populating language selection dropdowns or validating language settings.
GET/languages/{id} Read More	Returns language record for a given id.	Retrieving detailed information about a specific language, often used to display language details or to validate language data.

2.17 MeasureUnits

The following endpoints return detailed information about measure units.

Method Name	Description	Use Case
GET/measure-units Read More	Returns a list of measure units.	Retrieving all available measure units when populating options for unit selection or validating measure unit settings.
GET/measure-units/{id} Read More	Returns measure unit record for a given id.	Retrieving detailed information about a specific measure unit, often used to display unit details or validate unit data.

2.18 BizPositions

The endpoints for managing business positions associated with partners. These endpoints allow creation, retrieval, updating, and logical deletion of business position records.

Method Name	Description	Use Case
GET/biz-positions Read More	Returns a list of Biz Positions.	Retrieving all available Biz Position records, often for listing positions or populating selection options.
POST/biz-positions Read More	Creates a new Biz Positions record.	Use to create a new Biz Position record in the system, used when adding new positions.
GET/biz-positions/{id} Read More	Returns a Biz Position record for a given id.	Retrieving details of a specific Biz Position, often used for displaying position details or verifying position data.
PUT/biz-positions/{id} Read More	Updates a Biz Positions data for a given id.	Updating an existing Biz Position record when modifying position details.
DELETE/biz-positions/{id} Read More	Deletes a Biz Positions data logically for a given id.	Use to logically delete a Biz Position record by its ID when deactivating or archiving a position.

2.19 RelationTypes

The endpoint for working with Relation Types that helps categorize and manage the connections between partners.

Method Name	Description	Use Case
GET/relation-types Read More	Returns a list of Relation Types.	Retrieving all available Relation Types used for displaying relation options or managing relationships in the system.

2.20 ServiceCategories

The endpoints for managing service categories associated with Business Partners. These categories help in organizing and classifying the services offered to or by partners.

Method Name	Description	Use Case
GET/service-categories Read More	Returns a list of Service Categories.	Retrieving all available Service Categories for categorizing services or displaying options related to service types.
GET/service-categories/{id} Read More	Returns Service Categories record for a given id.	Retrieving detailed information about a specific Service Category identified by its ID.

2.21 BizPartnerLOV

The endpoints to retrieve Business Partners list of values, which is typically used for selection purposes in UI elements.

Method Name	Description	Use Case
GET/biz-partners-lov Read More	Returns a list of BizPartnerLov.	Retrieving all available Biz Partner LOV (List of Values), providing a selection of Business Partners in forms or other interfaces.
GET/biz-partners-lov/{id} Read More	Returns a BizPartnerLov record for a given id.	Retrieving detailed information about a specific Biz Partner LOV identified by its ID.

2.22 BizPartnerStatus

This endpoint retrieves the operational status of Business Partners (e.g., active, inactive), assisting in the filtering and management of partner records based on their current status.

Method Name	Description	Use Case
GET/biz-partners-statuses/{status} Read More	Returns a BizPartnerStatus record for the specified status.	Retrieving Biz Partner status details for a specific status.

2.23 BizPartnerStat

This endpoint provides statistical data about Business Partners, supporting analysis and reporting on partner distribution, activity levels, and other metrics.

Method Name	Description	Use Case
GET/biz-partners-stat Read More	Returns a list of BizPartnerStat.	Retrieving a list of Biz Partner statistics.

2.24 ContextOwner

This endpoint retrieves information about the ownership of specific contexts or data sets, aiding in access control and permission management within the platform.

Method Name	Description	Use Case
GET/contexts-owner/{ownerParam} Read More	Returns ContextOwner.	Retrieving the context owner based on a specified owner parameter.

2.25 EmailAccount

These endpoints manage email accounts associated with Business Partners, facilitating the integration of email communications and ensuring accurate contact information.

Method Name	Description	Use Case
GET/email-accounts Read More	Returns a list of Email Accounts.	Retrieving a list of all available email accounts in the system.
GET/email-accounts/{id} Read More	Returns EmailAccount record for a given id.	Retrieving detailed information about a specific email account based on its unique ID.

2.26 FinanceEmailAddresses

This endpoint retrieves finance-related email addresses of Business Partners, ensuring that financial communications are directed to the appropriate contacts.

Method Name	Description	Use Case
GET/biz-partners/{partnerId}/finance-email-addresses Read More	Returns a list of Finance Email Addresses for a given partnerId.	Retrieving a list of finance-related email addresses associated with a specific Business Partner.

2.27 ProductFeatures

The following endpoints retrieve features of products associated with Business Partners, providing detailed information to assist in product comparisons and selections.

Method Name	Description	Use Case
GET/products/{productId}/product-features Read More	Returns a list of Product Features for a given productId.	Retrieving a list of product features associated with a specific product.
GET/products/{productId}/product-features/{featureId} Read More	Returns ProductFeature record for a given productId and featureId.	Retrieving details of a specific product feature based on the feature ID.

2.28 ProductTypePartnersLOV

This endpoint retrieves a list of product types associated with Business Partners, aiding in the classification and management of partner-related products.

Method Name	Description	Use Case
GET/product-type-partners-lov Read More	Returns a list of ProductTypePartnersLov.	Retrieving a list of product type partner LOV records.

2.29 FinanceSettings

The endpoints that manage financial settings for Business Partners, providing the ability to retrieve and update financial configurations relating to partner transactions.

Method Name	Description	Use Case
GET/finance-settings/{id} Read More	Returns FinanceSettings record for a given id.	Retrieving specific finance settings by ID.
PUT/finance-settings/{id} Read More	Updates FinanceSettings for a given id.	Updating finance settings for a specific ID.

2.30 ProductTypes

The following endpoint returns a list of available Product Types.

Method Name	Description	Use Case
GET/product-types Read More	Returns a list of Product Types.	Allows the user to select the correct type from a predefined list during product creation.

2.31 Biz Partner Types

The endpoint to retrieve all available Biz Partner Types.

Method Name	Description	Use Case
GET/biz-partners/biz-partner-type-lov Read More	Returns a list of all Biz Partner types.	By retrieving a list of all available Biz Partner types, the user can select from predefined options and maintain standardized partner categorization.

2.32 BizSettings

This endpoint retrieves Business Partner specific settings, allowing the customization and management of configuration parameters that influence partner behavior within the platform.

Method Name	Description	Use Case
GET/biz-settings/{param} Read More	Returns BizSettings for a given param.	Retrieving specific business settings based on a parameter key, useful for configuration-driven logic or UI behavior.

2.33 WebSocials

The following endpoints allow the user to work with social web services.

Method Name	Description	Use Case
GET/web-socials Read More	Returns a list of all WebSocial.	Retrieving all available WebSocial records, used when displaying or managing a list of social media web services in the application.
POST/web-socials/section/{sectionCodeName} Read More	Creates a new WebSocial record.	Use to create a new WebSocial record under a specific section identified by the section code name.
GET/web-socials/{id} Read More	Returns WebSocials details for a given id.	Retrieving detailed information about a specific WebSocial record identified by its ID.
PUT/web-socials/{id} Read More	Updates a WebSocial record for a given id.	Updating an existing WebSocial record identified by its ID.
DELETE/web-socials/{id} Read More	Deletes WebSocial data logically for a given id.	Use to logically delete a WebSocial record, marking it as deleted in the system.

2.34 PartnerTypes

The following endpoints retrieve all available Partner Types, typically used for displaying or managing a list of partner categories in the application.

Method Name	Description	Use Case
GET/partner-types Read More	Returns a list of all Partner Types.	Retrieving all available Partner Types for displaying or managing a list of partner categories in the application.
POST/partner-types Read More	Creates a new PartnerType record.	Use to create a new PartnerType record in the system.
GET/partner-types/{id} Read More	Returns PartnerType data for a given id.	Retrieving detailed information about a specific PartnerType record identified by its ID.
PUT/partner-types/{id} Read More	Updates PartnerType data for a given id.	Updating an existing PartnerType record identified by its ID.
DELETE/partner-types/{id} Read More	Deletes PartnerType data logically for a given id.	Use to logically delete a PartnerType record, marking it as deleted in the system.

2.35 Industries

The endpoints to work with Industries available within the system.

Method Name	Description	Use Case
GET/industries Read More	Returns a list of all Industries.	Retrieving a list of all available industries, typically for displaying or managing a list of industries in the application.
POST/industries Read More	Creates a new Industry record.	Use to create a new Industry record in the system.
GET/industries/{id} Read More	Returns Industry data for a given id.	Retrieving detailed information about a specific Industry record identified by its ID.
PUT/industries/{id} Read More	Updates Industry data for a given id.	Updating an existing Industry record identified by its ID.
DELETE/industries/{id} Read More	Deletes Industry data logically for a given id.	Use to logically delete an Industry record, marking it as deleted in the system.

2.36 CompanySize

The endpoint for managing company size options in the application.

Method Name	Description	Use Case
GET/company-sizes Read More	Returns a list of all Company Sizes.	Retrieving a list of all available company sizes, typically for displaying or managing a list of company size options in the application.
POST/company-sizes Read More	Creates a new Company Size record.	Use to create a new Company Size record in the system.
GET/company-sizes/{id} Read More	Returns Company Size data for a given id.	Retrieving detailed information about a specific Company Size record identified by its ID.
PUT/company-sizes/{id} Read More	Updates Company Size data for a given id.	Updating an existing Company Size record identified by its ID.
DELETE/company-sizes/{id} Read More	Deletes Company Size data logically for a given id.	Use to logically delete a Company Size record, marking it as deleted in the system.

2.37 Partners

The endpoints for managing partner entities within the system. These endpoints allow creating, retrieving, updating, and deleting partner records.

Method Name	Description	Use Case
GET/partners Read More	Returns a list of all Partners.	Retrieving a list of all available partners, typically for displaying or managing partner information in the application.
GET/partners/{id} Read More	Returns Partner data for a given id.	Retrieving detailed information about a specific partner identified by its ID.
PUT/partners/{id} Read More	Updates Partner data for a given id.	Updating an existing Partner record identified by its ID.
DELETE/partners/{id} Read More	Deletes a Business Partner logically with all necessary prior checks (price lists, billings, balances, connections, coOwner, Business Messenger).	Use to logically delete a Partner record, after performing necessary checks to ensure data integrity across related entities.
PATCH/partners/{id} Read More	Changes Biz Partner status. For deactivating process, first checks instance role, price lists, billings, balances, connections, coOwner.	Updating the status of a Business Partner, with checks to ensure data consistency.
GET/biz-partners/{id} Read More	Returns Business Partner data for a given id.	Retrieving detailed information about a specific Business Partner record identified by its ID.
PUT/biz-partners/{id} Read More	Updates Business Partner data for a given id.	Updating an existing Business Partner record identified by its ID.
POST/biz-partners-reg Read More	Creates a new Biz Partner record.	Use to create a new Business Partner record in the system.
DELETE/partners-multi/{ids} Read More	Deletes Business Partners for given IDs with all necessary prior checks (price lists, billings, balances, connections, coOwner, Business Messenger).	Use to delete multiple Business Partner records, performing necessary checks for each.
POST/name-vat-unique-check Read More	Checks if legal name and VAT are unique.	Use to check if a Business Partner's legal name and VAT number are unique, preventing duplicates.
POST/brief-name-unique-check Read More	Checks if brief name is unique.	Use to verify the uniqueness of a Business Partner's brief name.
GET/biz-partners-reg-dl/{extension} Read More	Downloads .xlsx and .csv templates for Business Partners.	Use to download preformatted templates for registering Business Partners in .xlsx or .csv formats.
POST/biz-partners-reg/import Read More	Imports Biz partner records.	Importing Business Partner records in bulk into the system.

2.38 PartnerSections

The following endpoints can be used for managing sections associated with Business Partners, enabling the organization of partner-related information into distinct segments for better structure and accessibility.

Method Name	Description	Use Case
GET/partner-sections Read More	Returns a list of all Partner sections.	Retrieving all partner sections.
GET/partner-sections/{id} Read More	Returns a Partner section data for a given id.	Retrieving a specific partner section by its ID.

2.39 AccountManagers

The following endpoints allow the users to retrieve a list of account managers, add new account managers, update their details, remove them when necessary, and retrieve account manager information for administrative and operational purposes.

2.40 Attributes / Custom Fields

The endpoints for working with Attributes/Custom fields.

The registry of attributes are used to enrich basic data in many sections (areas) of Business Partners model.

We have two general groups of attributes, predefined (there is attributeKind=predefined) and registered - custom fields (there is attributeKind=registered).

Predefined attributes have built-in meaning like web links (type is WWW), social networks (type is SOCIAL) etc., and new attributes of this types can be added only when software supports them. Types for these attributes have to have allCustomAttrs=no.

Registered attributes are predicted for special data enrichment approach, where software owner can register new attributes i.e. custom fields, where semantic meaning is not so strictly controlled. Code name prefix for these attributes is 'ATTR-'. Types for these attributes have to have allCustomAttrs=yes.

Method Name	Description	Use Case
GET/attributes Read More	Returns a list of all Attributes/Custom fields.	Retrieving a list of all Attributes/Custom fields available in the system.
POST/attributes Read More	Creates a new Attribute/Custom Field record.	Use to create a new Attribute/Custom Field record in the system.
GET/attributes/{id} Read More	Returns Attribute/Custom Field data for a given id.	Retrieving detailed information about a specific Attribute/Custom Field by its ID.
PUT/attributes/{id} Read More	Updates Attribute/Custom Field data for a given id.	Updating an existing Attribute/Custom Field record identified by its ID.
DELETE/attributes/{id} Read More	Deletes Attribute/Custom Field record logically.	Use to logically delete an Attribute/Custom Field record identified by its ID.
POST/attributes/code-name Read More	Creates Attribute/Custom Field code name.	Use to create a code name for an Attribute/Custom Field.

2.41 Attribute / Custom Field Sections

Endpoint for working with Attribute/Custom Field Sections.

Method Name	Description	Use Case
POST/attributes/{id}/attribute-sections Read More	Creates a new Attribute/Custom Field section record.	Use to create a new Attribute/Custom Field section.
GET/attributes/{id}/attribute-sections/{secId} Read More	Returns Attribute/Custom Field section.	Retrieving details of a specific Attribute/Custom Field section by its ID.
PUT/attributes/{id}/attribute-sections/{secId} Read More	Updates Attribute/Custom Field section data.	Updating the data of an existing Attribute/Custom Field section.
DELETE/attributes/{id}/attribute-sections/{secId} Read More	Deletes Attribute/Custom Field section data logically.	Use to logically delete a section within an Attribute/Custom Field.

2.42 Biz Attribute / Custom Field Section Tag

Endpoints for working with Biz Attribute/Custom Field section tag table.

2.43 Biz Attribute / Custom Field Tag

Endpoints for working with Biz Attribute/Custom Field tag table.

Method Name	Description	Use Case
GET/attributes-tags/{id} Read More	Returns a Biz Attribute/Custom Field tag record for a given tag ID.	Retrieving a specific Biz Attribute/Custom Field tag record by its tag ID.
GET/attributes-tags Read More	Returns a list of Biz Attribute/Custom Field tag records.	Retrieving all tag records for Attribute/Custom Fields.

2.44 Attribute / Custom Field Types

These endpoints handle the retrieval of Attribute Types/Custom Fields, supporting the extension of partner data models with additional, structured information.

We have two general groups of attributes, predefined (there is allCustomAttrs=no) and registered - custom fields (there is allCustomAttrs=yes).

Types for predefined attributes have built-in meaning like web links (type is WWW), social networks (type is SOCIAL) etc., and new attributes of this types can be added only when software supports them.

Types for registered attributes are predicted for special data enrichment approach, where software owner can register new attributes i.e. custom fields, where semantic meaning is not so strictly controlled. Code name prefix for these attribute types is 'INPUT-' (INPUT-STRING, INPUT-TEXT, INPUT-DATE).

Method Name	Description	Use Case
GET/attribute-types Read More	Returns a list of all Attribute/Custom Field types.	Retrieving all attribute/custom field types.
GET/attribute-types/{id} Read More	Returns Attribute/Custom Field type for a given id.	Retrieving a specific attribute/custom field type by its ID.

2.45 Partner Attributes / Custom Fields

Endpoints for working with Partner Attributes/Custom Fields.

2.46 Attribute / Custom Field Partners

This endpoint returns a list of Attributes/Custom Fields linked to Business Partners, allowing for the management and retrieval of partner-specific metadata.

Method Name	Description	Use Case
GET/attribute-partners Read More	Returns a list of all Attribute/Custom Fields Partners.	Retrieving all partners for attribute/custom fields.

2.47 Users

The endpoints for retrieving a list of Users and their details.

Method Name	Description	Use Case
GET/users Read More	Returns a list of users.	Retrieving all users.
GET/users/{uuid} Read More	Returns a user for a given UUID.	Retrieving a specific user by their UUID.

3. Methods Details

3.1 Documents Configuration

The Documents Configuration section provides API methods and endpoints for managing logo-related data associated with Business Partners. It enables uploading, downloading, updating, and deleting logo files, as well as changing their status. These endpoints support typical document management operations, allowing flexible integration with Business Partner profiles. Use cases include assigning official logos, retrieving logos for branding purposes, and managing logo approval workflows.

Method Overview

This method uploads a logo file.

Parameters

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

Responses

Code	Description	Links
201	File uploaded and record created.	No links
default	Unexpected error.	No links

Success Response: 201 File uploaded and record created

{
  "id": 0,
  "partnerId": 0,
  "filename": "string",
  "size": 0,
  "language": "string",
  "mimeType": "string",
  "insertDt": "2021-01-28T11:09:48.212Z",
  "status": "draft",
  "statusDt": "2021-01-28T11:09:48.212Z"
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a logo file.
The required privileges:
- biz-core.view - The logged user can download a logo for all Biz partners.
- biz-core-own.view - The logged user can download a logo for his own Biz Partner.

Parameters

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

Responses

Code	Description	Links
200	JPEG or JPG file downloaded.	No links
default	Unexpected error.	No links

Success Response 200: JPEG or JPG file downloaded

Error Response Unexpected Error: Default

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

Method Overview

This method returns a logo file.
The required privileges:
- biz-core.view - The logged user can download a logo for all Biz partners.
- biz-core-own.view - The logged user can download a logo for his own Biz Partner.

Parameters

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

Responses

Code	Description	Links
200	JPEG or JPG file downloaded.	No links
default	Unexpected error.	No links

Success Response 200: JPEG or JPG file downloaded

{
  "id": 0,
  "partnerId": 0,
  "filename": "string",
  "size": 0,
  "language": "string",
  "mimeType": "string",
  "insertDt": "2021-01-28T11:19:40.210Z",
  "status": "draft",
  "statusDt": "2021-01-28T11:19:40.210Z"
}

Error Response Unexpected Error: Default

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

Method Overview

This method changes a logo status by logoid.
Possible statuses are: draft, active, inactive. The default status is draft. The idea is that the method PATCH is used after a file with a logo is uploaded, to change the default draft status to active status, and also others rows for this Business Partner to change to inactive status.

Parameters

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

Data Parameters

Logo status data object example

{
  "status": "draft"
}

Responses

Code	Description	Links
200	Logo status changed.	No links
default	Unexpected error.	No links

Success Response 200: Logo Status Changed

Error Response Unexpected Error: Default

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

Method Overview

This method changes a logo status by logoid, (draft, active, inactive) => deleted.

Parameters

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

Responses

Code	Description	Links
204	Logo file deleted successfully.	No links
default	Unexpected error.	No links

Success Response 204: Logo file deleted successfully

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of BizPartnersLogo by ID and active status.
The required privileges:
- biz-core.view - The logged user can see logos for all Biz Partners in the list.
- biz-core-own.view - The logged user can see only a logo for his own Biz Partner on the list.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
partnerid (required)	string (path)	Partner ID.
all	string (query)	Returns all data for a given criteria. The available values are yes or no. Default value is no.
page_size	integer (query)	Page size. Default value is 10.
page_number	integer (query)	Page number. Default value is 1.
paging	string (query)	Paging options. The format is: &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sorting options. The format is: sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and the following attributes: id, filename, bizPartnerId, mimeType, size, insert_dt, status, status_dt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of BizPartnersLogo.	No links
default	Unexpected error.	No links

Success Response 200: List of BizPartnersLogo

 {
  "data": [
    {
      "id": 0,
      "partnerId": 0,
      "filename": "string",
      "size": 0,
      "language": "string",
      "mimeType": "string",
      "insertDt": "2021-01-08T11:13:54.738Z",
      "status": "draft",
      "statusDt": "2021-01-08T11:13:54.739Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
 }

Error Response Unexpected Error: Default

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

3.2 Biz Partner Brief

The Biz Partner Brief endpoint retrieves a summarized list of Business Partners, offering quick access to essential partner information for selection or overview purposes.

Method Overview

This method returns a list of Biz Partner brief.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull,isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and the following attributes: id, name, briefName, countryName, phone, eMail, vatNumber, vatApply, legalAddress, legalAddressName, legalAddressZipCode, city, regNumber, status, statusDt, legalAddressCountryName, creation, instanceOwnerName, industryName, partnerTypeName, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole, languageName, legalForm, legalFormID, companySizeID, companySize, dunsNumber, foundingD, externalRefId. Additional filters: cap_letter_search with operator eq, bp_type_filter with operator eq, product_filter with operator eq, real_product_filter with operator in. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Partner brief.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Partner brief

{
  "data": [
    {
      "id": 0,
      "instanceRole": "string",
      "name": "string",
      "briefName": "string",
      "externalRefId": "string",
      "countryId": 0,
      "countryName": "string",
      "phone": "string",
      "eMail": "string",
      "language": "string",
      "vatNumber": "string",
      "vatApply": "string",
      "legalAddressId": 0,
      "legalAddressName": "string",
      "legalAddress": "string",
      "legalAddressCountryId": 0,
      "legalAddressCountryName": "string",
      "legalAddressZipCode": "string",
      "statusActiveDt": "2022-09-19T14:38:37.187Z",
      "city": "string",
      "regNumber": "string",
      "status": "string",
      "statusDt": "2022-09-19T14:38:37.187Z",
      "relation": "string",
      "product": "string",
      "realProduct": "string",
      "partnerTypeId": 0,
      "partnerTypeName": "string",
      "industryId": 0,
      "industryName": "string",
      "creation": "string",
      "instanceOwnerName": "string",
      "ownerBpId": 0,
      "ownerBpName": "string",
      "ownerBpBriefName": "string",
      "addresses": [
        {
          "id": 0,
          "typeCodeName": "string",
          "typeName": "string"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.3 Account Manager LOV

The Account Manager LOV section includes the endpoint that provides a list of account managers in lightweight, label-value format (LOV - List of Values), allowing the user to select the appropriate account manager for a Business Partner from predefined options.

Method Overview

This method returns a list of Account Manager list of values.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and the following attributes: id, name. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Account Manager LOV.	No links
default	Unexpected error.	No links

Success Response 200: List of Account Manager LOV

{
  "data": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.4 Account Manager Partner LOV

This endpoint provides a list of associations between account managers and their respective Business Partners, aiding in oversight and reporting tasks.

Method Overview

This method returns a list of Account Manager partner LOV.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty,isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, status, briefName, productType, productTypeCodeName, relationTypeId, relationTypeCodeName, accountManagerId. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Account Manager partners LOV.	No links
default	Unexpected error.	No links

Success Response 200: List of Account Manager partners LOV

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "briefName": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.5 Address Type

This endpoint retrieves predefined address types, ensuring standardized address entries across the platform for consistency and accuracy.

Method Overview

This method returns a list of Address types.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, codeName, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Address types.	No links
default	Unexpected error.	No links

Success Response 200: List of Address types

{
  "data": [
    {
      "id": 0,
      "codeName": "string",
      "name": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.6 Biz Contact Type

The following endpoints manage business contact types, allowing the definition and retrieval of various contact roles associated with partners.

Method Overview

This method returns a list of Biz contact types.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, favorite, name, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz contact types.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz contact types

{
  "data": [
    {
      "id": 0,
      "codeName": "string",
      "name": "string",
      "status": "active"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a Biz contact type for a given ID.
The required privilege: biz-core.view.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz contact type ID.

Responses

Code	Description	Links
200	Biz contact type data.	No links
default	Unexpected error.	No links

Success Response 200: Biz contact type data

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

Error Response Unexpected Error: Default

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

3.7 Biz Department

These endpoints handle the creation, retrieval, updating, and deletion of business department records, supporting organizational structure within the platform.

Method Overview

This method returns a list of Biz departments.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, favorite, name, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz departments.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz departments

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "status": "active",
      "statusDt": "2021-01-13T14:14:14.369Z",
      "canBeDeleted": true,
      "favorite": "yes"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Biz department record.

Parameters

Name	Type	Description
post data (required)	object (body)	Biz department data.

Data Parameters

Post data object example

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

Responses

Code	Description	Links
200	Biz department record created.	No links
default	Unexpected error.	No links

Success Response 200: Biz department record created

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2023-01-11T14:01:49.055Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a Biz department data by ID.
The required privilege: biz-core.view.

Parameters

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

Responses

Code	Description	Links
200	Biz department data.	No links
default	Unexpected error.	No links

Success Response 200: Biz department data

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-01-13T14:19:35.549Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates a Biz department data.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz department ID.
put data (required)	object (body)	Biz department data.

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	Biz department updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Biz department updated successfully

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2023-01-11T14:09:50.941Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes a Biz department record logically for a given ID.

Parameters

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

Responses

Code	Description	Links
200	Biz department deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Logo file deleted successfully

Error Response Unexpected Error: Default

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

3.8 Legal Forms

The following endpoints provide access to legal form records, helping to identify and manage the legal structures of Business Partners.

Method Overview

This method returns a list of legal forms.
The required privilege: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, countryId, legalForm, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Legal Form Records.	No links
default	Unexpected error.	No links

Success Response 200: List of Legal Form Records

{
  "data": [
    {
      "id": 0,
      "countryId": 0,
      "legalForm": "string",
      "status": "active",
      "statusDt": "2021-01-13T18:06:33.953Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Legal Form record for a given ID.
The required privilege: biz-core.view.

Parameters

Name	Type	Description
id (required)	integer (path)	Legal Form ID.

Responses

Code	Description	Links
200	Legal Form data.	No links
default	Unexpected error.	No links

Success Response 200: Legal Form data

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

Error Response Unexpected Error: Default

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

3.9 Biz Partner Active LOV

The endpoint that returns a list of currently active Business Partners, useful for filtering operations or generating reports that focus on active entities.

Method Overview

This method returns a list of Biz Partner active LOV.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, countryName, vatNumber, vatApply, regNumber, legalForm, briefName, eMail, phone, fax, taxExempt, dunsNumber, industryName, companySize, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole, externalRefId. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Partner active LOV.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Partner Active LOV

{
  "data": [
    {
      "id": 0,
      "instanceOwnerName": "string",
      "externalRefId": 0,
      "name": "string",
      "briefName": "string",
      "country": 0,
      "countryName": "string",
      "vatNumber": "string",
      "vatApply": "string",
      "regNumber": "string",
      "dunsNumber": "string",
      "status": "string",
      "parentId": "string",
      "statusDt": "2021-01-13T18:14:20.888Z",
      "statusActiveDt": "2021-01-13T18:14:20.888Z",
      "legalAddressId": 0,
      "legalFormId": 0,
      "legalForm": "string",
      "language": "string",
      "languageName": "string",
      "taxExempt": "string",
      "foundingD": "string",
      "industryId": 0,
      "companySizeId": 0,
      "eMail": "string",
      "phone": "string",
      "fax": "string",
      "industryName": "string",
      "companySize": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.10 Biz Partner Addresses

These endpoints manage addresses associated with Business Partners, allowing addition, retrieval, updating, and deletion of address records to maintain accurate location information.

Method Overview

This method returns a list of Biz Partner addresses.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
all	string (query)	Returns all data for a given criteria. Available values: yes, no. 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, bizPartnerId, addressTypeId, addressTypeName, country, countryName, name, branchName, address, poBox, postalCode, city, province, attnPerson, eMail, phone, fax, bizPartnerBriefName, addressTypeCodeName. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Partner addresses.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Partner addresses

{
  "data": [
    {
      "id": 0,
      "bizPartnerId": 0,
      "bizPartnerName": "string",
      "bizPartnerBriefName": "string",
      "addressTypeId": 0,
      "addressTypeName": "string",
      "addressTypeCodeName": "string",
      "country": 0,
      "countryName": "string",
      "name": "string",
      "branchName": "string",
      "address": "string",
      "poBox": "string",
      "postalCode": "string",
      "city": "string",
      "province": "string",
      "attnPerson": "string",
      "latitude": "string",
      "longitude": "string",
      "eMail": "string",
      "phone": "string",
      "fax": "string",
      "copyToAddresses": [
        {
          "id": 0,
          "name": "string",
          "branchName": "string",
          "addressTypeId": 0
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates Biz Partner addresses.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
id (required)	string (path)	Biz Partner ID.
post data (required)	object (body)	Biz Partner address data.

Data Parameters

Biz Partner address data object example

{
  "addressTypeId": 0,
  "country": 0,
  "name": "string",
  "branchName": "string",
  "address": "string",
  "poBox": "string",
  "postalCode": "string",
  "city": "string",
  "province": "string",
  "attnPerson": "string",
  "latitude": 0,
  "longitude": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "copyToAddresses": {
    "data": [
      {
        "name": "string",
        "branchName": "string",
        "addressTypeId": 0
      }
    ]
  }
}

Responses

Code	Description	Links
201	Biz Partner address created.	No links
default	Unexpected error.	No links

Success Response 201: Biz Partner address created

{
  "id": 0,
  "bizPartnerId": 0,
  "bizPartnerName": "string",
  "bizPartnerBriefName": "string",
  "addressTypeId": 0,
  "addressTypeName": "string",
  "addressTypeCodeName": "string",
  "country": 0,
  "countryName": "string",
  "name": "string",
  "branchName": "string",
  "address": "string",
  "poBox": "string",
  "postalCode": "string",
  "city": "string",
  "province": "string",
  "attnPerson": "string",
  "latitude": "string",
  "longitude": "string",
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "copyToAddresses": [
    {
      "id": 0,
      "name": "string",
      "branchName": "string",
      "addressTypeId": 0
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Biz Partner addresses.
The required privileges: biz-core.view.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
addressId (required)	integer (path)	Address ID.

Responses

Code	Description	Links
200	Biz Partner address data.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partner address data

{
  "id": 0,
  "bizPartnerId": 0,
  "bizPartnerName": "string",
  "bizPartnerBriefName": "string",
  "addressTypeId": 0,
  "addressTypeName": "string",
  "addressTypeCodeName": "string",
  "country": 0,
  "countryName": "string",
  "name": "string",
  "branchName": "string",
  "address": "string",
  "poBox": "string",
  "postalCode": "string",
  "city": "string",
  "province": "string",
  "attnPerson": "string",
  "latitude": "string",
  "longitude": "string",
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "copyToAddresses": [
    {
      "id": 0,
      "name": "string",
      "branchName": "string",
      "addressTypeId": 0
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Biz Partner addresses.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
addressId (required)	integer (path)	Address ID.
put data (required)	object (body)	Biz Partner address data.

Data Parameters

put data object example

{
  "addressTypeId": 0,
  "country": 0,
  "name": "string",
  "branchName": "string",
  "address": "string",
  "poBox": "string",
  "postalCode": "string",
  "city": "string",
  "province": "string",
  "attnPerson": "string",
  "latitude": 0,
  "longitude": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "copyToAddresses": {
    "data": [
      {
        "id": 0,
        "name": "string",
        "branchName": "string",
        "addressTypeId": 0
      }
    ]
  }
}

Responses

Code	Description	Links
200	Biz Partner address updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partner address updated successfully

{
  "id": 0,
  "bizPartnerId": 0,
  "bizPartnerName": "string",
  "bizPartnerBriefName": "string",
  "addressTypeId": 0,
  "addressTypeName": "string",
  "addressTypeCodeName": "string",
  "country": 0,
  "countryName": "string",
  "name": "string",
  "branchName": "string",
  "address": "string",
  "poBox": "string",
  "postalCode": "string",
  "city": "string",
  "province": "string",
  "attnPerson": "string",
  "latitude": "string",
  "longitude": "string",
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "copyToAddresses": [
    {
      "id": 0,
      "name": "string",
      "branchName": "string",
      "addressTypeId": 0
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes Biz Partner addresses.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
addressId (required)	integer (path)	Address ID.

Responses

Code	Description	Links
204	Biz Partner address deleted successfully.	No links
default	Unexpected error.	No links

Success Response 204: Biz Partner address deleted successfully

Error Response Unexpected Error: Default

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

3.11 Biz Partner Contact

3

These endpoints handle the management of contacts linked to Business Partners, facilitating the maintenance of up-to-date contact information for various roles within partner organizations.

Method Overview

This method returns Biz Partner contact.
The required privileges: biz-core.view or biz-core.own.view.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
contactId (required)	integer (path)	Contact ID.

Responses

Code	Description	Links
200	Biz Partner contact data.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partner contact data

{
  "id": 0,
  "bizPartnerId": 0,
  "contactTypeId": 0,
  "customTypeName": "string",
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "salutation": "formal",
  "titel": "string",
  "gender": "male",
  "language": "string",
  "addressId": 0,
  "eMailBusiness": "string",
  "eMailPrivate": "string",
  "phoneOfficeDirect": "string",
  "phoneOfficeCentral": "string",
  "mobile": "string",
  "mobileBusiness": "string",
  "skype": "string",
  "birthday": "2021-01-14",
  "departmentId": 0,
  "positionId": 0,
  "customPositionName": "string",
  "picture": "string",
  "fax": "string",
  "status": "active",
  "statusDt": "2021-01-14T09:54:29.198Z",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "countryId": 0,
  "countryName": "string",
  "contactTypeName": "string",
  "partnerName": "string",
  "languageName": "string",
  "partnerBriefName": "string",
  "departmentName": "string",
  "positionName": "string",
  "note": "string",
  "extraAttributes": {
    "data": [
      {
        "id": 0,
        "sectionId": 0,
        "attributeId": 0,
        "attributeName": "string",
        "customAttrName": "string",
        "attributeValue": "string",
        "attributeCodeName": "string",
        "attributeTypeId": 0
      }
    ]
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates a Biz Partner contact.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
contactId (required)	integer (path)	Contact ID.
put data (required)	object (body)	Biz Partner contact data.

Data Parameters

put data object example

{
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "salutation": "string",
  "titel": "string",
  "gender": "string",
  "language": "string",
  "eMailBusiness": "string",
  "eMailPrivate": "string",
  "phoneOfficeDirect": "string",
  "phoneOfficeCentral": "string",
  "mobile": "string",
  "mobileBusiness": "string",
  "skype": "string",
  "birthday": "2021-01-14",
  "contactTypeId": 0,
  "customTypeName": "string",
  "departmentId": 0,
  "positionId": 0,
  "customPositionName": "string",
  "fax": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "countryId": 0,
  "extraAttributes": {
    "data": [
      {
        "id": 0,
        "attributeId": 0,
        "attributeValue": "string",
        "customAttrName": "string"
      }
    ]
  }
}

Responses

Code	Description	Links
200	Biz Partner contact updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partner contact updated successfully

{
  "id": 0,
  "bizPartnerId": 0,
  "contactTypeId": 0,
  "customTypeName": "string",
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "salutation": "formal",
  "titel": "string",
  "gender": "male",
  "language": "string",
  "addressId": 0,
  "eMailBusiness": "string",
  "eMailPrivate": "string",
  "phoneOfficeDirect": "string",
  "phoneOfficeCentral": "string",
  "mobile": "string",
  "mobileBusiness": "string",
  "skype": "string",
  "birthday": "2021-01-14",
  "departmentId": 0,
  "positionId": 0,
  "customPositionName": "string",
  "picture": "string",
  "fax": "string",
  "status": "active",
  "statusDt": "2021-01-14T09:59:00.378Z",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "countryId": 0,
  "countryName": "string",
  "contactTypeName": "string",
  "partnerName": "string",
  "languageName": "string",
  "partnerBriefName": "string",
  "departmentName": "string",
  "positionName": "string",
  "note": "string",
  "extraAttributes": {
    "data": [
      {
        "id": 0,
        "sectionId": 0,
        "attributeId": 0,
        "attributeName": "string",
        "customAttrName": "string",
        "attributeValue": "string",
        "attributeCodeName": "string",
        "attributeTypeId": 0
      }
    ]
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes a Biz Partner contact.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
contactId (required)	integer (path)	Contact ID.

Responses

Code	Description	Links
204	Biz Partner contact deleted successfully.	No links
default	Unexpected error.	No links

Success Response 204: Biz Partner contact deleted successfully

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of Biz Partner contacts.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
all	string (query)	Returns all data for a given criteria. Available values: yes, no. 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, contactTypeId, firstName, lastName, nickName, salutation, eMailBusiness, departmentName, positionName, phoneOfficeDirect, mobile, address, postalCode, city, countryName, note, contactTypeName, titel, birthday, gender, language, languageName, addressId, eMailPrivate, phoneOfficeCentral, mobileBusiness, skype, departmentId, positionId, fax, status, countryId. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Partner contacts.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Partner contacts

{
  "data": [
    {
      "id": 0,
      "bizPartnerId": 0,
      "contactTypeId": 0,
      "customTypeName": "string",
      "firstName": "string",
      "lastName": "string",
      "nickName": "string",
      "salutation": "formal",
      "titel": "string",
      "gender": "male",
      "language": "string",
      "addressId": 0,
      "eMailBusiness": "string",
      "eMailPrivate": "string",
      "phoneOfficeDirect": "string",
      "phoneOfficeCentral": "string",
      "mobile": "string",
      "mobileBusiness": "string",
      "skype": "string",
      "birthday": "2021-01-14",
      "departmentId": 0,
      "positionId": 0,
      "customPositionName": "string",
      "picture": "string",
      "fax": "string",
      "status": "active",
      "statusDt": "2021-01-14T14:38:07.170Z",
      "address": "string",
      "postalCode": "string",
      "city": "string",
      "countryId": 0,
      "countryName": "string",
      "contactTypeName": "string",
      "partnerName": "string",
      "languageName": "string",
      "partnerBriefName": "string",
      "departmentName": "string",
      "positionName": "string",
      "note": "string",
      "extraAttributes": {
        "data": [
          {
            "id": 0,
            "sectionId": 0,
            "attributeId": 0,
            "attributeName": "string",
            "customAttrName": "string",
            "attributeValue": "string",
            "attributeCodeName": "string",
            "attributeTypeId": 0
          }
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates Biz Partner contacts.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
post data	object (body)	Biz Partner contact data.

Data Parameters

post data object example

{
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "salutation": "string",
  "titel": "string",
  "gender": "string",
  "language": "string",
  "eMailBusiness": "string",
  "eMailPrivate": "string",
  "phoneOfficeDirect": "string",
  "phoneOfficeCentral": "string",
  "mobile": "string",
  "mobileBusiness": "string",
  "skype": "string",
  "birthday": "2021-01-14",
  "contactTypeId": 0,
  "customTypeName": "string",
  "departmentId": 0,
  "positionId": 0,
  "customPositionName": "string",
  "fax": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "countryId": 0,
  "extraAttributes": {
    "data": [
      {
        "attributeId": 0,
        "attributeValue": "string",
        "customAttrName": "string"
      }
    ]
  }
}

Responses

Code	Description	Links
201	Biz Partner contact created.	No links
default	Unexpected error.	No links

Success Response 201: Biz Partner contact created

{
  "id": 0,
  "bizPartnerId": 0,
  "contactTypeId": 0,
  "customTypeName": "string",
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "salutation": "formal",
  "titel": "string",
  "gender": "male",
  "language": "string",
  "addressId": 0,
  "eMailBusiness": "string",
  "eMailPrivate": "string",
  "phoneOfficeDirect": "string",
  "phoneOfficeCentral": "string",
  "mobile": "string",
  "mobileBusiness": "string",
  "skype": "string",
  "birthday": "2021-01-14",
  "departmentId": 0,
  "positionId": 0,
  "customPositionName": "string",
  "picture": "string",
  "fax": "string",
  "status": "active",
  "statusDt": "2021-01-14T14:44:17.851Z",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "countryId": 0,
  "countryName": "string",
  "contactTypeName": "string",
  "partnerName": "string",
  "languageName": "string",
  "partnerBriefName": "string",
  "departmentName": "string",
  "positionName": "string",
  "note": "string",
  "extraAttributes": {
    "data": [
      {
        "id": 0,
        "sectionId": 0,
        "attributeId": 0,
        "attributeName": "string",
        "customAttrName": "string",
        "attributeValue": "string",
        "attributeCodeName": "string",
        "attributeTypeId": 0
      }
    ]
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Biz Partner contact status.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
contactId (required)	integer (path)	Contact ID.
put data (required)	object (body)	Biz Partner contact status data.

Data Parameters

put data object example

{
  "status": "active"
}

Responses

Code	Description	Links
200	Biz Partner contact updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partner contact updated successfully

{
  "id": 0,
  "bizPartnerId": 0,
  "contactTypeId": 0,
  "customTypeName": "string",
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "salutation": "formal",
  "titel": "string",
  "gender": "male",
  "language": "string",
  "addressId": 0,
  "eMailBusiness": "string",
  "eMailPrivate": "string",
  "phoneOfficeDirect": "string",
  "phoneOfficeCentral": "string",
  "mobile": "string",
  "mobileBusiness": "string",
  "skype": "string",
  "birthday": "2021-02-09",
  "departmentId": 0,
  "positionId": 0,
  "customPositionName": "string",
  "picture": "string",
  "fax": "string",
  "status": "active",
  "statusDt": "2021-02-09T10:00:18.023Z",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "countryId": 0,
  "countryName": "string",
  "contactTypeName": "string",
  "partnerName": "string",
  "languageName": "string",
  "partnerBriefName": "string",
  "departmentName": "string",
  "positionName": "string",
  "note": "string",
  "extraAttributes": {
    "data": [
      {
        "id": 0,
        "sectionId": 0,
        "attributeId": 0,
        "attributeName": "string",
        "customAttrName": "string",
        "attributeValue": "string",
        "attributeCodeName": "string",
        "attributeTypeId": 0
      }
    ]
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of all Biz partners contacts for an instance.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, bizPartnerId, contactTypeId, firstName, lastName, nickName, salutation, eMailBusiness, departmentName, positionName, phoneOfficeDirect, mobile, address, postalCode, city, countryName, note, contactTypeName, titel, birthday, gender, language, languageName, addressId, eMailPrivate, phoneOfficeCentral, mobileBusiness, skype, departmentId, positionId, fax, status, countryId. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of all Biz Partner contacts for an instance.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Partners contacts for an instance

{
  "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": "2022-09-16",
      "departmentId": 0,
      "positionId": 0,
      "customPositionName": "string",
      "picture": "string",
      "fax": "string",
      "status": "active",
      "statusDt": "2022-09-16T11:33:34.248Z",
      "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,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Biz Partners contacts.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
put data (required)	object (body)	Biz Partner contact data.

Data Parameters

put data object example

{
  "departments": [
    {
      "id": 0
    }
  ],
  "positions": [
    {
      "id": 0
    }
  ]
}

Responses

Code	Description	Links
200	Biz Partners contacts' departments and positions are successfully updated.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partners contacts' departments and positions are successfully updated

{
  "departmentsId": {
    "value": "string"
  },
  "positionsId": {
    "value": "string"
  },
  "opStatus": "ok",
  "error": {
    "Code": 0,
    "Message": "string"
  }
}

Error Response Unexpected Error: Default

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

3.12 Products

The following endpoints manage products associated with Business Partners, enabling the listing and detailed retrieval of products linked to partners for inventory and relationship management.

Method Overview

This method returns a list of all Products.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, name, status, productType, statusDt, product_type, status_dt, code_name. Sort available options: id, codeName, name, status, productType, statusDt, product_type, status_dt, code_name. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Products.	No links
default	Unexpected error.	No links

Success Response 200: List of Products

{
  "data": [
    {
      "id": 0,
      "productType": 0,
      "name": "string",
      "codeName": "string",
      "status": "active",
      "statusDt": "2021-03-05T19:37:23.172Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns product for a given ID.

Parameters

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

Responses

Code	Description	Links
200	Product data.	No links
default	Unexpected error.	No links

Success Response 200: Product data

{
  "id": 0,
  "productType": 0,
  "name": "string",
  "codeName": "string",
  "status": "active",
  "statusDt": "2021-03-05T19:37:23.189Z"
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of all Biz Partner products.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, name, status, productType, productTypeCodeName, productTypeName, isOurProduct, isSupplierProduct. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Products.	No links
default	Unexpected error.	No links

Success Response 200: List of Products

{
  "data": [
    {
      "id": 0,
      "productType": 0,
      "name": "string",
      "codeName": "string",
      "status": "active",
      "statusDt": "2022-02-01T15:30:35.138Z",
      "productTypeName": "string",
      "productTypeCodeName": "string",
      "isOurProduct": "string",
      "isSupplierProduct": "string",
      "productContextStatus": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a Biz Partner product for a given ID.

Parameters

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

Responses

Code	Description	Links
200	Product data.	No links
default	Unexpected error.	No links

Success Response 200: Product data

{
  "id": 0,
  "productType": 0,
  "name": "string",
  "codeName": "string",
  "status": "active",
  "statusDt": "2021-03-05T19:37:23.199Z",
  "productTypeName": "string",
  "productTypeCodeName": "string",
  "isOurProduct": "string",
  "isSupplierProduct": "string",
  "productContextStatus": "string"
}

Error Response Unexpected Error: Default

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

3.13 BizPartnerProducts

These endpoints manage products linked to Business Partners, allowing creating, retrieving, updating, and logically deleting partner-specific products, as well as listing available or assigned products for a partner.

Method Overview

This method returns Biz Partner product record for a given partnerId and bizProductId.
The required privileges: biz-core.view or biz-core.own.view.

Parameters

Name	Type	Description
partnerId (required)	integer (path)	Biz Partner ID.
bizProductId (required)	integer (path)	Product ID.

Responses

Code	Description	Links
200	BizPartnerProduct data.	No links
default	Unexpected error.	No links

Success Response 200: BizPartnerProduct data

{
  "id": 0,
  "bizPartnerId": 0,
  "bizPartnerBriefName": "string",
  "productTypeName": "string",
  "productTypeCodeName": "string",
  "productId": 0,
  "productName": "string",
  "productCodeName": "string",
  "relationTypeId": 0,
  "relationTypeName": "string",
  "relationTypeCodeName": "string",
  "status": "string",
  "enabledDt": "2021-01-15T14:46:29.060Z",
  "disabledDt": "2021-01-15T14:46:29.060Z",
  "statusDt": "2021-01-15T14:46:29.060Z",
  "notes": "string",
  "customerType": "string",
  "accountManagerId": 0,
  "serviceCategoryId": 0,
  "serviceProductName": "string",
  "productBulkSms": {
    "id": 0,
    "bizpProductId": 0,
    "sellingPaymentType": "string",
    "sellingPaymentDue": 0,
    "validFromD": "2021-01-15",
    "billingCycle": 0,
    "billingCycleUnit": "string",
    "currencyId": 0,
    "invoiceTriggerAmount": 0,
    "overdraftLimit": 0,
    "creditLimit": 0,
    "deposit": 0,
    "bankGuarantee": 0,
    "disputePercent": 0,
    "maxDispute": 0,
    "announcementDays": 0,
    "currencyCode": "string",
    "currencyName": "string"
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes logically Biz Partner product record for a given partnerId and bizProductId.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
partnerId (required)	integer (path)	Biz Partner ID.
bizProductId (required)	integer (path)	Product ID.

Responses

Code	Description	Links
204	BizPartnerProduct data deleted.	No links
409	BizPartnerProduct data cannot be deleted due to its relation type owner.	No links
default	Unexpected error.	No links

Success Response 204: BizPartnerProduct data deleted

Error Response 409: BizPartnerProduct data cannot be deleted due to its relation type owner

Error Response Unexpected Error: Default

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

Method Overview

This method updates Biz Partner product record for a given partnerId and bizProductId.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
partnerId (required)	integer (path)	Biz Partner ID.
bizProductId (required)	integer (path)	Product ID.
put data (required)	object (body)	Biz Partner product data.

Data Parameters

put data object example

{
  "productType": 0,
  "productId": 0,
  "relationTypeId": 0,
  "status": "string",
  "notes": "string",
  "customerType": "enterprise",
  "accountManagerId": 0,
  "productBulkSms": {
    "sellingPaymentType": "prepaid",
    "sellingPaymentDue": 0,
    "validFromD": "2021-01-20",
    "billingCycle": 0,
    "billingCycleUnit": "Days",
    "currencyId": 0,
    "invoiceTriggerAmount": 0,
    "overdraftLimit": 0,
    "creditLimit": 0,
    "deposit": 0,
    "bankGuarantee": 0,
    "disputePercent": 0,
    "maxDispute": 0,
    "announcementDays": 0
  }
}

Responses

Code	Description	Links
200	BizPartnerProduct data updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: BizPartnerProduct data updated successfully

{
  "id": 0,
  "bizPartnerId": 0,
  "bizPartnerBriefName": "string",
  "productTypeName": "string",
  "productTypeCodeName": "string",
  "productId": 0,
  "productName": "string",
  "productCodeName": "string",
  "relationTypeId": 0,
  "relationTypeName": "string",
  "relationTypeCodeName": "string",
  "status": "string",
  "enabledDt": "2022-02-01T15:57:46.317Z",
  "disabledDt": "2022-02-01T15:57:46.317Z",
  "statusDt": "2022-02-01T15:57:46.317Z",
  "notes": "string",
  "customerType": "string",
  "accountManagerId": 0,
  "accountManagerName": "string",
  "serviceCategoryId": 0,
  "serviceProductName": "string",
  "productBulkSms": {
    "id": 0,
    "bizpProductId": 0,
    "sellingPaymentType": "string",
    "sellingPaymentDue": 0,
    "validFromD": "2022-02-01",
    "billingCycle": 0,
    "billingCycleUnit": "string",
    "currencyId": 0,
    "invoiceTriggerAmount": 0,
    "overdraftLimit": 0,
    "creditLimit": 0,
    "deposit": 0,
    "bankGuarantee": 0,
    "disputePercent": 0,
    "maxDispute": 0,
    "announcementDays": 0,
    "currencyCode": "string",
    "currencyName": "string"
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates Biz Partner product record for a given partnerId and bizProductId.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
partnerId (required)	integer (path)	Biz Partner ID.
post data (required)	object (body)	Biz Partner product data.

Data Parameters

post data object example

{
  "productType": 0,
  "productId": 0,
  "relationTypeId": 0,
  "status": "enabled",
  "notes": "string",
  "customerType": "enterprise",
  "accountManagerId": 0,
  "productBulkSms": {
    "sellingPaymentType": "prepaid",
    "sellingPaymentDue": 0,
    "validFromD": "2021-01-20",
    "billingCycle": 0,
    "billingCycleUnit": "Days",
    "currencyId": 0,
    "invoiceTriggerAmount": 0,
    "overdraftLimit": 0,
    "creditLimit": 0,
    "deposit": 0,
    "bankGuarantee": 0,
    "disputePercent": 0,
    "maxDispute": 0,
    "announcementDays": 0
  }
}

Responses

Code	Description	Links
200	BizPartnerProduct data updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: BizPartnerProduct data updated successfully

{
  "id": 0,
  "bizPartnerId": 0,
  "bizPartnerBriefName": "string",
  "productTypeName": "string",
  "productTypeCodeName": "string",
  "productId": 0,
  "productName": "string",
  "productCodeName": "string",
  "relationTypeId": 0,
  "relationTypeName": "string",
  "relationTypeCodeName": "string",
  "status": "string",
  "enabledDt": "2021-01-20T16:37:46.851Z",
  "disabledDt": "2021-01-20T16:37:46.851Z",
  "statusDt": "2021-01-20T16:37:46.851Z",
  "notes": "string",
  "customerType": "string",
  "accountManagerId": 0,
  "serviceCategoryId": 0,
  "serviceProductName": "string",
  "productBulkSms": {
    "id": 0,
    "bizpProductId": 0,
    "sellingPaymentType": "string",
    "sellingPaymentDue": 0,
    "validFromD": "2021-01-20",
    "billingCycle": 0,
    "billingCycleUnit": "string",
    "currencyId": 0,
    "invoiceTriggerAmount": 0,
    "overdraftLimit": 0,
    "creditLimit": 0,
    "deposit": 0,
    "bankGuarantee": 0,
    "disputePercent": 0,
    "maxDispute": 0,
    "announcementDays": 0,
    "currencyCode": "string",
    "currencyName": "string"
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of Biz Partner product records for a given partnerId.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
partnerId (required)	integer (path)	Biz Partner ID.
all	string (query)	Returns all data for a given criteria. Available values: yes, no. 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, productType, productTypeName, productTypeCodeName, productId, productName, productCodeName, relationTypeId, relationTypeName, status, sellingPaymentType, sellingPaymentDue, billingCycle, billingCycleUnit, accountManagerName, currencyId, currencyCode, currencyName, invoiceTriggerAmount, overdraftLimit, creditLimit, deposit, bankGuarantee, disputePercent, maxDispute, announcementDays. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of All Biz Partner Products.	No links
default	Unexpected error.	No links

Success Response 200: List of All Biz Partner Products

{
  "data": [
    {
      "id": 0,
      "bizPartnerId": 0,
      "bizPartnerBriefName": "string",
      "productTypeName": "string",
      "productTypeCodeName": "string",
      "productId": 0,
      "productName": "string",
      "productCodeName": "string",
      "relationTypeId": 0,
      "relationTypeName": "string",
      "relationTypeCodeName": "string",
      "status": "string",
      "enabledDt": "2021-01-20T16:40:34.843Z",
      "disabledDt": "2021-01-20T16:40:34.843Z",
      "statusDt": "2021-01-20T16:40:34.843Z",
      "notes": "string",
      "customerType": "string",
      "accountManagerId": 0,
      "serviceCategoryId": 0,
      "serviceProductName": "string",
      "productBulkSms": {
        "id": 0,
        "bizpProductId": 0,
        "sellingPaymentType": "string",
        "sellingPaymentDue": 0,
        "validFromD": "2021-01-20",
        "billingCycle": 0,
        "billingCycleUnit": "string",
        "currencyId": 0,
        "invoiceTriggerAmount": 0,
        "overdraftLimit": 0,
        "creditLimit": 0,
        "deposit": 0,
        "bankGuarantee": 0,
        "disputePercent": 0,
        "maxDispute": 0,
        "announcementDays": 0,
        "currencyCode": "string",
        "currencyName": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of Biz Partner allowed products.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
partnerId (required)	integer (path)	Biz Partner ID.
all	string (query)	Returns all data for a given criteria. Available values: yes, no. 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, bizPartnerId, bizPartnerName, status, productType, productTypeCodeName, productTypeName, productId, productCodeName, productName, relationTypeId, relationTypeCodeName, relationType, status, customerType, accountManagerId, accountManagerName, serviceCategoryId. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of allowed products for Biz Partner.	No links
default	Unexpected error.	No links

Success Response 200: List of allowed products for Biz Partner

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "codeName": "string",
      "productTypeId": 0,
      "productTypeName": "string",
      "productTypeCodeName": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of all Biz Partner products.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, bizPartnerId, bizPartnerName, status, productType, productTypeCodeName, productTypeName, productId, productCodeName, productName, relationTypeId, relationTypeCodeName, relationType, status, customerType, accountManagerId, accountManagerName, serviceCategoryId. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of All Biz Partner Products.	No links
default	Unexpected error.	No links

Success Response 200: List of All Biz Partner Products

{
  "data": [
    {
      "id": 0,
      "instanceId": 0,
      "bizPartnerId": 0,
      "bizPartnerName": "string",
      "productType": 0,
      "productTypeName": "string",
      "productTypeCodeName": "string",
      "productName": "string",
      "productCodeName": "string",
      "productId": 0,
      "relationTypeId": 0,
      "relationTypeCodeName": "string",
      "relationType": "string",
      "status": "enabled",
      "statusDt": "2021-01-20T16:51:26.519Z",
      "enabledDt": "2021-01-20T16:51:26.519Z",
      "disabledDt": "2021-01-20T16:51:26.519Z",
      "notes": "string",
      "customerType": "string",
      "accountManagerId": 0,
      "accountManagerName": "string",
      "serviceCategoryId": 0,
      "serviceCategoryName": "string",
      "serviceProductName": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Biz Partner product data.

Parameters

Name	Type	Description
partnerId (required)	integer (path)	Biz Partner products ID.

Responses

Code	Description	Links
200	Biz Partner Product data.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partner Product data

{  
  "id": 0,
  "instanceId": 0,
  "bizPartnerId": 0,
  "bizPartnerName": "string",
  "productType": 0,
  "productTypeName": "string",
  "productTypeCodeName": "string",
  "productName": "string",
  "productCodeName": "string",
  "productId": 0,
  "relationTypeId": 0,
  "relationTypeCodeName": "string",
  "relationType": "string",
  "status": "enabled",
  "statusDt": "2022-02-02T08:41:05.519Z",
  "enabledDt": "2022-02-02T08:41:05.519Z",
  "disabledDt": "2022-02-02T08:41:05.519Z",
  "notes": "string",
  "customerType": "string",
  "accountManagerId": 0,
  "accountManagerName": "string",
  "serviceCategoryId": 0,
  "serviceCategoryName": "string",
  "serviceProductName": "string"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deactivates and activates Biz Partner products for a given ID. It returns activated or deactivated Biz Partner product, with updated status.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner product ID.
put data (required)	object (body)	Biz Partner product data.

Data Parameters

patch data object example

{
  "status": "suspended"
}

Responses

Code	Description	Links
200	Biz Partner Product data.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partner Product data

{
  "id": 0,
  "instanceId": 0,
  "bizPartnerId": 0,
  "bizPartnerName": "string",
  "productType": 0,
  "productTypeName": "string",
  "productTypeCodeName": "string",
  "productName": "string",
  "productCodeName": "string",
  "productId": 0,
  "relationTypeId": 0,
  "relationTypeCodeName": "string",
  "relationType": "string",
  "status": "enabled",
  "statusDt": "2021-01-21T16:14:39.918Z",
  "enabledDt": "2021-01-21T16:14:39.918Z",
  "disabledDt": "2021-01-21T16:14:39.918Z",
  "notes": "string",
  "customerType": "string",
  "accountManagerId": 0,
  "accountManagerName": "string",
  "serviceCategoryId": 0,
  "serviceCategoryName": "string",
  "serviceProductName": "string"
}

Error Response Unexpected Error: Default

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

3.14 Currency

These endpoints retrieve currency information. the endpoints can be used for fetching a list of all available currencies or retrieving details of a specific currency by its ID.

Method Overview

This method returns a list of currencies.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, code, status, statusDt, type. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of currency records.	No links
default	Unexpected error.	No links

Success Response 200: List of currency records

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "code": "string",
      "status": "string",
      "statusDt": "2021-01-21T16:24:19.072Z",
      "type": "formal"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a Currency record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.

Parameters

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

Responses

Code	Description	Links
200	Currency data.	No links
default	Unexpected error.	No links

Success Response 200: Currency data

{
  {
  "id": 0,
  "name": "string",
  "code": "string",
  "status": "string",
  "statusDt": "2021-01-21T16:28:02.575Z",
  "type": "formal"
  }
}

Error Response Unexpected Error: Default

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

3.15 Country

The Country section endpoints provide a list of available countries within the system, useful for country-specific configurations or settings.

Method Overview

This method returns a list of countries.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, code2, code3, currency, defLang, status, statusDt, domain, dialCode, type, continent. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of country records.	No links
default	Unexpected error.	No links

Success Response 200: List of country records

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "code2": "string",
      "code3": "string",
      "type": "formal",
      "currency": 0,
      "defLang": "string",
      "status": "A",
      "statusDt": "2021-01-21T16:33:00.657Z",
      "domain": "string",
      "dialCode": "string",
      "continent": "string",
      "defTaxCategoryId": 0,
      "cashRounding": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Country record for a given ID.

Parameters

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

Responses

Code	Description	Links
200	Country data.	No links
default	Unexpected error.	No links

Success Response 200: Country data

{
  "id": 0,
  "name": "string",
  "code2": "string",
  "code3": "string",
  "type": "formal",
  "currency": 0,
  "defLang": "string",
  "status": "A",
  "statusDt": "2021-03-05T19:24:14.355Z",
  "domain": "string",
  "dialCode": "string",
  "continent": "string",
  "defTaxCategoryId": 0,
  "cashRounding": 0
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of countries related to Business Partners.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Partner country records.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Partner country records

{
  "data": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.16 Language

These endpoints retrieve a list and details of available languages within the system.

Method Overview

This method returns a list of languages.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of language records.	No links
default	Unexpected error.	No links

Success Response 200: List of language records

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "status": "A",
      "statusDt": "2021-01-21T16:37:17.762Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns language record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.

Parameters

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

Responses

Code	Description	Links
200	Language records.	No links
default	Unexpected error.	No links

Success Response 200: Language records

{
  "id": "string",
  "name": "string",
  "status": "A",
  "statusDt": "2021-01-21T16:39:05.012Z"
}

Error Response Unexpected Error: Default

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

3.17 MeasureUnits

The following endpoints return detailed information about measure units.

Method Overview

This method returns a list of measure units.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, code, type, ordNum, baseUnitId, baseNumerator, baseDenominator. Sort available fields: id, name, code, type, ordNum, baseUnitId, baseNumerator, baseDenominator. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Measure Units records.	No links
default	Unexpected error.	No links

Success Response 200: List of Measure Units records

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "code": "string",
      "type": "string",
      "ordNum": 0,
      "baseUnitId": 0,
      "baseNumerator": 0,
      "baseDenominator": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns measure unit record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.

Parameters

Name	Type	Description
id (required)	integer (path)	Measure Unit ID.

Responses

Code	Description	Links
200	Measure Unit data.	No links
default	Unexpected error.	No links

Success Response 200: Measure Unit data

{
  "id": 0,
  "name": "string",
  "code": "string",
  "type": "string",
  "ordNum": 0,
  "baseUnitId": 0,
  "baseNumerator": 0,
  "baseDenominator": 0
}

Error Response Unexpected Error: Default

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

3.18 BizPositions

The endpoints for managing business positions associated with partners. These endpoints allow creation, retrieval, updating, and logical deletion of business position records.

Method Overview

This method returns a list of Biz Positions.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, codeName, status, statusDt, favorite. Sort available fields: id, name, codeName, status, statusDt, favorite. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Positions records.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Positions records

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "codeName": "string",
      "status": "active",
      "statusDt": "2021-01-25T16:56:52.503Z",
      "canBeDeleted": true,
      "favorite": "yes"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Biz Positions record.

Parameters

Name	Type	Description
post data (required)	object (body)	Biz Positions data.

Data Parameters

post data object example

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

Responses

Code	Description	Links
200	Biz Positions record created successfully.	No links
default	Unexpected error.	No links

Success Response 200: Biz Positions record created successfully

{
  "id": 0,
  "name": "string",
  "codeName": "string",
  "status": "active",
  "statusDt": "2023-01-11T14:23:46.383Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a Biz Positions record for a given ID.
The required privileges: biz-core.view.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Positions ID.

Responses

Code	Description	Links
200	Biz Positions data.	No links
default	Unexpected error.	No links

Success Response 200: Biz Positions data

{
  "id": 0,
  "name": "string",
  "codeName": "string",
  "status": "active",
  "statusDt": "2023-01-12T11:20:37.618Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Biz Positions data.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Positions ID.
put data (required)	object (body)	Biz Positions data.

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	Biz Positions updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Biz Positions updated successfully

{
  "id": 0,
  "name": "string",
  "codeName": "string",
  "status": "active",
  "statusDt": "2023-01-11T14:26:36.697Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes a Biz Positions data logically for a given ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Positions ID.

Responses

Code	Description	Links
200	Biz Positions data deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Biz Positions data deleted successfully

Error Response Unexpected Error: Default

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

3.19 RelationTypes

The endpoint for working with Relation Types that helps categorize and manage the connections between partners.

Method Overview

This method returns a list of Relation Types.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, relationType.Sort available fields: id, codeName, relationType. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Relation Types records.	No links
default	Unexpected error.	No links

Success Response 200: List of Relation Types records

{
  "data": [
    {
      "id": 0,
      "codeName": "string",
      "relationType": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.20 ServiceCategories

The endpoints for managing service categories associated with Business Partners. These categories help in organizing and classifying the services offered to or by partners.

Method Overview

This method returns a list of Service Categories.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, category. Sort available fields: id, category. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Service Categories records.	No links
default	Unexpected error.	No links

Success Response 200: List of Service Categories records

{
  "data": [
    {
      "id": 0,
      "category": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Service Categories record for a given ID.
The required privileges: biz-core.view.

Parameters

Name	Type	Description
id (required)	integer (path)	Service Categories ID.

Responses

Code	Description	Links
200	Service Categories data.	No links
default	Unexpected error.	No links

Success Response 200: Service Categories data

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

Error Response Unexpected Error: Default

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

3.21 BizPartnerLOV

The endpoints to retrieve Business Partners list of values, which is typically used for selection purposes in UI elements.

Method Overview

This method returns a list of BizPartnerLov.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, briefName, city, postalCode, ownerBpId, instanceRole. Sort available fields: id, name, briefName, city, postalCode. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.
cap_letter_search	string (query)	Search criteria by first letter of a company name, for filter 0-9 just put =allnum.
bp_type_filter	string (query)	Filter criteria by relation type.
product_filter	string (query)	Filter criteria by product type.
real_product_filter	string (query)	Filter criteria by product (IN filter).
q	string (query)	General search criteria.

Responses

Code	Description	Links
200	A list of BizPartnerLov records.	No links
default	Unexpected error.	No links

Success Response 200: List of BizPartnerLov records

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "briefName": "string",
      "city": "string",
      "postalCode": "string",
      "code2": "string",
      "externalRefId": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns BizPartnerLov record for a given ID.
The required privileges: biz-core.view or biz-core.own.view.

Parameters

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

Responses

Code	Description	Links
200	BizPartnerLov data.	No links
default	Unexpected error.	No links

Success Response 200: BizPartnerLov data

{
  "id": 0,
  "name": "string",
  "briefName": "string",
  "city": "string",
  "postalCode": "string",
  "code2": "string",
  "externalRefId": "string"
}

Error Response Unexpected Error: Default

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

3.22 BizPartnerStatus

This endpoint retrieves the operational status of Business Partners (e.g., active, inactive), assisting in the filtering and management of partner records based on their current status.

Method Overview

This method returns a BizPartnerStatus record for the specified status. A BizPartnerStatus record contains a number of Business Partners with the given status.

The required privileges: biz-core.view or biz-core.own.view.

Parameters

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

Responses

Code	Description	Links
200	BizPartnerStatus data.	No links
default	Unexpected error.	No links

Success Response 200: BizPartnerStatus Data

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

Error Response Unexpected Error: Default

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

3.23 BizPartnerStat

This endpoint provides statistical data about Business Partners, supporting analysis and reporting on partner distribution, activity levels, and other metrics.

Method Overview

This method returns a list of BizPartnerStat.
The required privileges: biz-core.view or biz-core.own.view.

Search criteria using following operators: in, and by following attributes: id.

Parameters

No parameters

Responses

Code	Description	Links
200	A list of BizPartnerStat records.	No links
default	Unexpected error.	No links

Success Response 200: List of BizPartnerStat records

{
  "data": [
    {
      "relationType": "string",
      "productInfo": [
        {
          "product": "string",
          "productCount": 0
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.24 ContextOwner

This endpoint retrieves information about the ownership of specific contexts or data sets, aiding in access control and permission management within the platform.

Method Overview

This method returns ContextOwner.
The required privileges: biz-core.view.

Parameters

Name	Type	Description
ownerParam (required)	string (path)	Parameter. Available values: info.

Responses

Code	Description	Links
200	ContextOwner record.	No links
default	Unexpected error.	No links

Success Response 200: ContextOwner record

{
  "id": 0,
  "name": "string",
  "instanceRole": "string",
  "country": 0,
  "countryName": "string",
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalAddressId": 0,
  "status": "string",
  "parentId": 0,
  "legalFormId": 0,
  "language": "string",
  "languageName": "string",
  "legalForm": "string",
  "briefName": "string",
  "detailsId": 0,
  "hasAttributes": "no",
  "externalRefId": 0,
  "statusActiveDt": "2021-01-26T09:31:39.875Z",
  "statusDt": "2021-01-26T09:31:39.875Z",
  "industryId": 0,
  "companySizeId": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "taxExempt": "string",
  "foundingD": "2021-01-26",
  "dunsNumber": "string",
  "industryName": "string",
  "companySize": "string",
  "instanceOwnerName": "string",
  "bizPartnerInstanceUid": "string",
  "isIntercompany": "no",
  "partnerTypeId": 0,
  "partnerTypeName": "string",
  "ownerBpId": 0,
  "ownerBpName": "string",
  "ownerBpBriefName": "string",
  "selfOwner": "yes"
}

Error Response Unexpected Error: Default

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

3.25 EmailAccount

These endpoints manage email accounts associated with Business Partners, facilitating the integration of email communications and ensuring accurate contact information.

Method Overview

This method returns a list of Email Accounts.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, canReceive, inHost, inPort, inSecurity, canSend, outHost, outPort, outSecurity, status, statusDt, bizPartnerId. Sort available fields: id, name, canReceive, inHost, inPort, inSecurity, canSend, outHost, outPort, outSecurity, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.
can_send	string (query)	Filtering by column can_send. Available values: yes.

Responses

Code	Description	Links
200	A list of EmailAccounts records.	No links
default	Unexpected error.	No links

Success Response 200: List of EmailAccounts records

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "canReceive": "yes",
      "inHost": "string",
      "inPort": 0,
      "inSecurity": "string",
      "canSend": "yes",
      "outHost": "string",
      "outPort": 0,
      "outSecurity": "string",
      "status": "active",
      "statusDt": "2022-02-08T10:29:58.866Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns EmailAccount record for a given ID.
The required privileges: biz-core.view.

Parameters

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

Responses

Code	Description	Links
200	EmailAccount data.	No links
default	Unexpected error.	No links

Success Response 200: EmailAccount data

{
  "id": 0,
  "name": "string",
  "canReceive": "yes",
  "inHost": "string",
  "inPort": 0,
  "inSecurity": "string",
  "canSend": "yes",
  "outHost": "string",
  "outPort": 0,
  "outSecurity": "string",
  "status": "active",
  "statusDt": "2021-01-26T09:37:10.438Z"
}

Error Response Unexpected Error: Default

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

3.26 FinanceEmailAddresses

This endpoint retrieves finance-related email addresses of Business Partners, ensuring that financial communications are directed to the appropriate contacts.

Method Overview

This method returns a list of Finance Email Addresses.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
partnerId (required)	integer (path)	Biz Partner ID.
all	string (query)	Returns all data for a given criteria. Available values: yes, no. 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Sort available fields: id, emailContactId, addressType, eMail. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of FinanceEmailAddresses records.	No links
default	Unexpected error.	No links

Success Response 200: List of FinanceEmailAddresses records

{
  "data": [
    {
      "id": 0,
      "emailContactId": 0,
      "addressType": "string",
      "eMail": "string",
      "bizPartnerId": 0,
      "bizPartnerBriefName": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.27 ProductFeatures

The following endpoints retrieve features of products associated with Business Partners, providing detailed information to assist in product comparisons and selections.

Method Overview

This method returns a list of Product Features.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
productId (required)	integer (path)	Product ID.
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, productId, codeName, name, status, productName, productCodeName. Sort available fields: id, productId, codeName, name, status, productName, productCodeName. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Product Features records.	No links
default	Unexpected error.	No links

Success Response 200: List of Product Features records

{
  "data": [
    {
      "id": 0,
      "productId": 0,
      "codeName": "string",
      "name": "string",
      "status": "string",
      "productName": "string",
      "productCodeName": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns ProductFeature record for a given ID.
The required privileges: biz-core.view.

Parameters

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

Responses

Code	Description	Links
200	ProductFeature data.	No links
default	Unexpected error.	No links

Success Response 200: ProductFeature data

{
  "id": 0,
  "productId": 0,
  "codeName": "string",
  "name": "string",
  "status": "string",
  "productName": "string",
  "productCodeName": "string"
}

Error Response Unexpected Error: Default

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

3.28 ProductTypePartnersLOV

This endpoint retrieves a list of product types associated with Business Partners, aiding in the classification and management of partner-related products.

Method Overview

This method returns a list of ProductTypePartnersLov.
The required privileges: biz-core.view or biz-core.own.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, country, countryName, vatNumber, vatApply, regNumber, legalFormId, language, status, languageName, legalForm, briefName, industryId, companySizeId, eMail, phone, fax, taxExempt, dunsNumber, industryName, companySize, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole. Sort allowed attributes: id, name, country, countryName, vatNumber, vatApply, regNumber, legalFormId, language, status, languageName, legalForm, briefName, industryId, companySizeId, eMail, phone, fax, taxExempt, dunsNumber, industryName, companySize, ownerBpId, ownerBpName, ownerBpBriefName, instanceRole. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of ProductTypePartnersLov.	No links
default	Unexpected error.	No links

Success Response 200: List of ProductTypePartnersLov

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "instanceRole": "string",
      "country": 0,
      "countryName": "string",
      "vatNumber": "string",
      "vatApply": "string",
      "regNumber": "string",
      "legalAddressId": 0,
      "status": "string",
      "parentId": 0,
      "legalFormId": 0,
      "language": "string",
      "languageName": "string",
      "legalForm": "string",
      "instanceOwnerName": "string",
      "briefName": "string",
      "detailsId": 0,
      "hasAttributes": "yes",
      "externalRefId": 0,
      "bizPartnerInstanceUid": "string",
      "statusActiveDt": "2021-01-26T09:51:36.318Z",
      "statusDt": "2021-01-26T09:51:36.318Z",
      "industryId": 0,
      "companySizeId": 0,
      "eMail": "string",
      "phone": "string",
      "fax": "string",
      "taxExempt": "string",
      "foundingD": "2021-01-26T09:51:36.318Z",
      "dunsNumber": "string",
      "industryName": "string",
      "companySize": "string",
      "ownerBpId": 0,
      "ownerBpName": "string",
      "ownerBpBriefName": "string",
      "selfOwner": "yes",
      "isIntercompany": "yes",
      "partnerTypeId": 0,
      "partnerTypeName": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.29 FinanceSettings

The endpoints that manage financial settings for Business Partners, providing the ability to retrieve and update financial configurations relating to partner transactions.

Method Overview

This method returns FinanceSettings record for a given ID.
The required privileges: biz-core.view.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.

Responses

Code	Description	Links
200	FinanceSettings data.	No links
default	Unexpected error.	No links

Success Response 200: FinanceSettings data

{
  "id": 0,
  "productType": "string",
  "productId": 0,
  "invoiceAddressId": 0,
  "invoiceAddressIsDefault": "yes",
  "emailContactId": 0,
  "emailAddressIsDefault": "yes",
  "hardCopyAddressId": 0,
  "hardCopyAddressIsDefault": "yes",
  "nettingPartner": "yes",
  "emailAccountId": 0,
  "smtpAccount": "string",
  "emailAddressTO": "user@example.com",
  "emailAddressCC": "user@example.com",
  "emailAddressBcc": "user@example.com"
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates FinanceSettings for a given ID.
The required privileges: biz-core.manage.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
put data (required)	object (body)	Finance settings data.

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	Biz Partner address updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Biz Partner address updated successfully

{
  "id": 0,
  "productType": "string",
  "productId": 0,
  "invoiceAddressId": 0,
  "invoiceAddressIsDefault": "yes",
  "emailContactId": 0,
  "emailAddressIsDefault": "yes",
  "hardCopyAddressId": 0,
  "hardCopyAddressIsDefault": "yes",
  "nettingPartner": "yes",
  "emailAccountId": 0,
  "smtpAccount": "string",
  "emailAddressTO": "user@example.com",
  "emailAddressCC": "user@example.com",
  "emailAddressBcc": "user@example.com"
}

Error Response Unexpected Error: Default

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

3.30 ProductTypes

The following endpoint returns a list of available Product Types.

Method Overview

This method returns a list of Product Types.
The required privileges: biz-core.view.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, name, codeName, status, statusDt. Sort available fields: id, name, codeName, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Product Types records.	No links
default	Unexpected error.	No links

Success Response 200: List of Product Types records

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "codeName": "string",
      "status": "active",
      "statusDt": "2021-02-01T10:02:01.249Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.31 Biz Partner Types

The endpoint to retrieve all available Biz Partner Types.

Method Overview

This method returns a list of all Biz Partner types.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, and by following attributes: id, name, instanceId, favorite. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Partner types.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Partner types

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "status": "string",
      "favorite": "yes"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.32 BizSettings

This endpoint retrieves Business Partner specific settings, allowing the customization and management of configuration parameters that influence partner behavior within the platform.

Method Overview

This method returns BizSettings record from the database on the Biz Partner instance.

Parameters

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

Responses

Code	Description	Links
200	BizSettings data.	No links
default	Unexpected error.	No links

Success Response 200: BizSettings data

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

Error Response Unexpected Error: Default

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

3.33 WebSocials

The following endpoints allow the user to work with social web services.

Method Overview

This method returns a list of all WebSocial.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and by following attributes: id, name, sectionRowId, value, status, sectionCodeName(DETAILS, CONTACTS, FINANCE-SETTINGS). If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of WebSocials.	No links
default	Unexpected error.	No links

Success Response 200: List of WebSocials

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "sectionRowId": 0,
      "value": "string",
      "status": "active",
      "statusDt": "2021-02-01T13:15:44.579Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new WebSocial record.

Parameters

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

Data Parameters

post data object example

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

Responses

Code	Description	Links
200	WebSocial record created.	No links
default	Unexpected error.	No links

Success Response 200: WebSocial record created

{
  "id": 0,
  "name": "string",
  "sectionRowId": 0,
  "value": "string",
  "status": "active",
  "statusDt": "2021-02-01T13:19:05.861Z"
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns WebSocials details for a given ID.

Parameters

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

Responses

Code	Description	Links
200	WebSocial data.	No links
default	Unexpected error.	No links

Success Response 200: WebSocial data

{
  "id": 0,
  "name": "string",
  "sectionRowId": 0,
  "value": "string",
  "status": "active",
  "statusDt": "2021-02-01T13:23:23.357Z"
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates a WebSocial record.

Parameters

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

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	WebSocial updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: WebSocial updated successfully

{
  "id": 0,
  "name": "string",
  "sectionRowId": 0,
  "value": "string",
  "status": "active",
  "statusDt": "2021-02-01T13:27:17.172Z"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes WebSocial data with given ID logically.

Parameters

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

Responses

Code	Description	Links
200	WebSocial deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: WebSocial deleted successfully

Error Response Unexpected Error: Default

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

3.34 PartnerTypes

The following endpoints retrieve all available Partner Types, typically used for displaying or managing a list of partner categories in the application.

Method Overview

This method returns a list of all Partner Types.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, name, status, favorite. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Partner Types.	No links
default	Unexpected error.	No links

Success Response 200: List of Partner Types

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "status": "active",
      "statusDt": "2021-02-01T13:35:51.271Z",
      "dbCodeName": "string",
      "comment": "yes"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new PartnerType record.

Parameters

Name	Type	Description
post data (required)	object (body)	Partner type data.

Data Parameters

post data object example

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

Responses

Code	Description	Links
200	PartnerType record created.	No links
default	Unexpected error.	No links

Success Response 200: PartnerType record created

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-01T13:42:20.637Z",
  "dbCodeName": "string",
  "comment": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns PartnerType data for a given ID.

Parameters

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

Responses

Code	Description	Links
200	PartnerType data.	No links
default	Unexpected error.	No links

Success Response 200: PartnerType data

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-01T13:42:20.637Z",
  "dbCodeName": "string",
  "comment": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates PartnerType data for a given ID.

Parameters

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

Data Parameters

put data object example

{
  "name": "string",
  "taxExempt": "string",
  "foundingD": "2021-02-01T13:48:47.047Z",
  "industryId": 0,
  "companySizeId": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "industryName": "string",
  "companySize": "string",
  "hasAttributes": "yes",
  "isIntercompany": "yes"
}

Responses

Code	Description	Links
200	PartnerType updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: PartnerType updated successfully

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-01T13:49:39.022Z",
  "dbCodeName": "string",
  "comment": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes PartnerType record with given ID logically.

Parameters

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

Responses

Code	Description	Links
200	Partner Type data deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Partner Type data deleted successfully

Error Response Unexpected Error: Default

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

3.35 Industries

The endpoints to work with Industries available within the system.

Method Overview

This method returns a list of all Industries.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, name, status, favorite. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Industries.	No links
default	Unexpected error.	No links

Success Response 200: List of Industries

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "status": "active",
      "statusDt": "2021-02-02T12:56:10.108Z",
      "canBeDeleted": true,
      "favorite": "yes"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Industry record.

Parameters

Name	Type	Description
post data (required)	object (body)	Industry data.

Data Parameters

post data object example

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

Responses

Code	Description	Links
200	Industry record created.	No links
default	Unexpected error.	No links

Success Response 200: Industry record created

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-02T12:58:35.192Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Industry data for a given ID.

Parameters

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

Responses

Code	Description	Links
200	Industry data.	No links
default	Unexpected error.	No links

Success Response 200: Industry data

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-02T13:01:11.368Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Industry data for a given ID.

Parameters

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

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	Industry data updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Industry data updated successfully

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-02T13:01:11.368Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes Industry record with given ID logically.

Parameters

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

Responses

Code	Description	Links
200	Industry record deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Industry record deleted successfully

Error Response Unexpected Error: Default

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

3.36 CompanySize

The endpoint for managing company size options in the application.

Method Overview

This method returns a list of all Company Sizes.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, companySize, status, favorite. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Company Sizes.	No links
default	Unexpected error.	No links

Success Response 200: List of Company Sizes

{
  "data": [
    {
      "id": 0,
      "companySize": "string",
      "status": "active",
      "statusDt": "2021-02-02T13:18:15.807Z",
      "canBeDeleted": true,
      "favorite": "yes"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Company Size record.

Parameters

Name	Type	Description
post data (required)	object (body)	Company size data.

Data Parameters

post data object example

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

Responses

Code	Description	Links
200	Company Size record created.	No links
default	Unexpected error.	No links

Success Response 200: Company Size record created

{
  "id": 0,
  "companySize": "string",
  "status": "active",
  "statusDt": "2021-02-02T13:18:46.685Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Company Size data for a given ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Company Size ID.

Responses

Code	Description	Links
200	Company Size data.	No links
default	Unexpected error.	No links

Success Response 200: Company Size data

{
  "id": 0,
  "companySize": "string",
  "status": "active",
  "statusDt": "2021-02-02T13:19:49.252Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Company Size data for a given ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Company Size ID.
put data (required)	object (body)	Company Size data.

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	Company Size updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Company Size updated successfully

{
  "id": 0,
  "companySize": "string",
  "status": "active",
  "statusDt": "2021-02-02T13:20:11.935Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes Company Size record with given ID logically.

Parameters

Name	Type	Description
id (required)	integer (path)	Company Size ID.

Responses

Code	Description	Links
200	Company Size deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Company Size deleted successfully

Error Response Unexpected Error: Default

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

3.37 Partners

The endpoints for managing partner entities within the system. These endpoints allow creating, retrieving, updating, and deleting partner records.

Method Overview

This method returns a list of all Partners.
The required privileges:
- biz-core.view - Logged user can see all Biz partners in the list.
- biz-core-own.view - Logged user can see only his own Biz Partner in the list.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds, and by following attributes: id, instanceId, name, country, vatNumber, vatApply, regNumber, legalAddressId, status, parentId, legalFormId, language, bizPartnerUid, briefName, partnerDetailsId, notificationAddressId, hasAttributes, externalRefId, partnerTypeId, isIntercompany, partnerTypeName, dunsNumber, taxExempt, statusActiveDt, statusDt, foundingD, industryId, companySizeId, eMail, phone, fax, creation, industryName, companySize, languageName. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Partners.	No links
default	Unexpected error.	No links

Success Response 200: List of Partners

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "country": 0,
      "vatNumber": "string",
      "vatApply": "yes",
      "regNumber": "string",
      "legalAddressId": 0,
      "value": "string",
      "status": "potential",
      "parentId": 0,
      "legalFormId": 0,
      "language": "string",
      "bizPartnerUid": "string",
      "partnerDetailsId": 0,
      "briefName": "string",
      "notificationAddressId": 0,
      "externalRefId": "string",
      "partnerTypeId": 0,
      "partnerTypeName": "string",
      "statusActiveDt": "2021-02-02T13:31:49.562Z",
      "statusDt": "2021-02-02T13:31:49.562Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a Partner data for a given ID.
The required privileges:
- biz-core.view - Logged user can see all Biz partners.
- biz-core-own.view - Logged user can see only his own Biz Partner.

Parameters

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

Responses

Code	Description	Links
200	Partner data.	No links
default	Unexpected error.	No links

Success Response 200: Partner data

{
  "id": 0,
  "name": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalAddressId": 0,
  "status": "potential",
  "parentId": 0,
  "legalFormId": 0,
  "language": "string",
  "bizPartnerUid": "string",
  "partnerDetailsId": 0,
  "briefName": "string",
  "notificationAddressId": 0,
  "externalRefId": "string",
  "partnerTypeId": 0,
  "partnerTypeName": "string",
  "statusActiveDt": "2022-02-18T12:41:21.202Z",
  "statusDt": "2022-02-18T12:41:21.202Z",
  "dunsNumber": "string",
  "taxExempt": "string",
  "foundingD": "2022-02-18",
  "industryId": 0,
  "companySizeId": 0,
  "email": "string",
  "phone": "string",
  "fax": "string",
  "industryName": "string",
  "companySize": "string",
  "hasAttributes": "yes",
  "isIntercompany": "yes",
  "creation": "2022-02-18",
  "instanceRole": "string",
  "ownerBpId": 0,
  "ownerBpName": "string",
  "ownerBpBriefName": "string",
  "selfOwner": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Partner data.

Parameters

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

Data Parameters

put data object example

{
  "name": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalFormId": 0,
  "language": "string",
  "briefName": "string",
  "externalRefId": "string",
  "partnerTypeId": 0,
  "isIntercompany": "yes",
  "dunsNumber": "string",
  "taxExempt": "string",
  "foundingD": "2021-02-02",
  "industryId": 0,
  "companySizeId": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "creation": "manually",
  "selfOwner": "yes",
  "ownerBpId": 0
}

Responses

Code	Description	Links
200	Partner updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Partner updated successfully

{
  "id": 0,
  "name": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalAddressId": 0,
  "status": "potential",
  "parentId": 0,
  "legalFormId": 0,
  "language": "string",
  "bizPartnerUid": "string",
  "partnerDetailsId": 0,
  "briefName": "string",
  "notificationAddressId": 0,
  "externalRefId": "string",
  "partnerTypeId": 0,
  "partnerTypeName": "string",
  "statusActiveDt": "2022-02-18T12:53:12.957Z",
  "statusDt": "2022-02-18T12:53:12.957Z",
  "dunsNumber": "string",
  "taxExempt": "string",
  "foundingD": "2022-02-18",
  "industryId": 0,
  "companySizeId": 0,
  "email": "string",
  "phone": "string",
  "fax": "string",
  "industryName": "string",
  "companySize": "string",
  "hasAttributes": "yes",
  "isIntercompany": "yes",
  "creation": "2022-02-18",
  "instanceRole": "string",
  "ownerBpId": 0,
  "ownerBpName": "string",
  "ownerBpBriefName": "string",
  "selfOwner": "yes"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes Business Partner logically with all necessary prior checks (price lists, billings, balances, connections, coOwner, Business Messenger).

Parameters

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

Responses

Code	Description	Links
204	Partner deleted successfully.	No links
409	Unable to delete Business Partner due to its instance role or relations (could be with price lists, billings, balances, connections, coOwner, Business Messenger): Biz Partner (bizPartnerId = xxxx) can have price lists as customer and supplier for products SMS and MNP. - API endpoint for customerSMSPricelists: /bulk/pricelists/sms/selling?eq(customerId)=xxxx&all=yes - API endpoint for supplierSMSPricelists: /bulk/pricelists/sms/buying?eq(supplierId)=xxxx&all=yes - API endpoint for customerMNPPricelists: /bulk/pricelists/mnp/selling?eq(customerId)=xxxx&all=yes - API endpoint for supplierMNPPricelists: /bulk/pricelists/mnp/buying?eq(supplierId)=xxxx&all=yes - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive) Biz Partner (bizPartnerId = xxxx) can have total balances as customer and supplier for products SMS and MNP. - API endpoint for customerSMSTotalBalances: /bulk/billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes - API endpoint for supplierSMSTotalBalances: /bulk/gate-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes - API endpoint for customerMNPTotalBalances: /bulk/mnp-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes - API endpoint for supplierMNPTotalBalances: /bulk/mnp-gate-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive) Biz Partner (bizPartnerId = xxxx) can have billing accounts as customer and supplier for products SMS and MNP. - API endpoint for customerSMSBillingAccounts: /bulk/billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes - API endpoint for supplierSMSBillingAccounts: /bulk/gate-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes - API endpoint for customerMNPBillingAccounts: /bulk/mnp-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes - API endpoint for supplierMNPBillingAccounts: /bulk/mnp-gate-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive) Biz Partner (bizPartnerId = xxxx) can have connections as customer and supplier for products SMS and MNP. - API endpoint for customerSMSConnections: /bulk/sms-accounts/v1/accounts?eq(customerId)=xxxx&all=yes - API endpoint for supplierSMSConnections: /bulk/gates/v1/out-gates?eq(supplierId)=xxxx&all=yes - API endpoint for customerMNPConnections: /bulk/mnp-accounts/v1/out-gates?eq(customerId)=xxxx&all=yes - API endpoint for supplierMNPConnections: /bulk/mnp-supplier-accounts/v1/supplier-accounts?eq(supplierId)=xxxx&all=yes - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive) Biz Partner (bizPartnerId = xxxx) can have coOwners. - API endpoint for bizPartnerCoOwner: /biz-core/v2/partners?ownerBpId=xxxx Biz Partner (bizPartnerId = xxxx) can have Business Messenger linked. - API endpoint for Biz Partner's Business Messenger: /news/v1/services?partnerId=xxxx - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive)	No links
default	Unexpected error.	No links

Success Response 204: Partner deleted successfully

Error Response 409: Unable to delete Partner due to its instance role or relations

Example

{
  "error": {
      "code": "INVALID-PARAMETERS",
      "message": "Invalid parameters",
      "items": [
          {
              "name": "customerSMSConnections",
              "message": "customerSMSConnections",
              "description": "ID: 1547 Name: 3396_VOICES_EUR; ID: 1639 Name: 3396_VOICES;"
          },
          {
              "name": "supplierSMSConnections",
              "message": "supplierSMSConnections",
              "description": "ID: 369 Name: ODTTELEKOM;"
          },
          {
              "name": "supplierSMSPricelists",
              "message": "supplierSMSPricelists",
              "description": "ID: 1105 Name: AV Pack PL 1; ID: 1110 Name: AV Pack PL 1;"
          },
          {
              "name": "customerSMSPricelists",
              "message": "customerSMSPricelists",
              "description": "ID: 469 Name: 1061_ECO; ID: 470 Name: 1061_FIXID;"
          },
          {
              "name": "customerSMSTotalBalances",
              "message": "customerSMSTotalBalances",
              "description": "ID: 37 Name: Co"
          },
          {
              "name": "supplierSMSTotalBalances",
              "message": "supplierSMSTotalBalances",
              "description": "ID: 33 Name: Communications"
          },
          {
              "name": "customerSMSBillingAccount",
              "message": "customerSMSBillingAccount",
              "description": "ID: 41 Name: 3396_VOICES; ID: 42 Name: 3396_VOICES; ID: 43 Name: 1061_FIXID; "
          },
          {
              "name": "users",
              "message": "users",
              "description": "Users"
          },
          {
              "name": "appSubjects",
              "message": "appSubjects",
              "description": "App subject"
          },
          {
              "name": "groupSubjects",
              "message": "groupSubjects",
              "description": "Group subject"
          },
          {
              "name": "unknownSubjects",
              "message": "unknownSubjects",
              "description": "Unknown subject"
          }
      ]
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method changes Biz Partner status. For deactivating process, first checks instance role, price lists, billings, balances, connections, coOwner.

Errors

Name	Description
BIZ_CORE:PARTNERS_PRODUCTS_MUST_BE_DEFINED	Please define products for partner, partner without products can not be active.
BIZ_CORE:PARTNERS_ADDRESS_BAD_RESPONSE	Partner address bad response, partner without legal address can not be active.
BIZ_CORE:PARTNERS_ADDRESS_NOT_FOUND	Partner address not found, partner without legal address can not be active.
BIZ_CORE:PARTNERS_LEGAL_ADDRESS_MUST_BE_DEFINED	Please define partners legal address, partner without legal address can not be active.
BIZ_CORE:CANT_CHANGE_BIZ_PARTNER_STATUS_NEW_AND_OLD_STATUS_ARE_SAME	New status and old status are the same.
BIZ_CORE:STATUS_CHANGE_IS_NOT_ALLOWED	Status change from old to new not allowed.
BIZ_CORE:PARTNER_COUNTRY_IS_DIFFERENT	Country of the Partner is different from legal address country.

Parameters

Name	Type	Description
id (required)	integer (path)	Biz Partner ID.
put data (required)	object (body)	Biz Partner status.

Data Parameters

patch data object example

{
  "status": "suspended"
}

Responses

Code	Description	Links
200	Partner's status changed successfully.	No links
409	Unable to delete Business Partner due to its instance role or relations (could be with price lists, billings, balances, connections, coOwner, Business Messenger): Biz Partner (bizPartnerId = xxxx) can have price lists as customer and supplier for products SMS and MNP. - API endpoint for customerSMSPricelists: /bulk/pricelists/sms/selling?eq(customerId)=xxxx&all=yes - API endpoint for supplierSMSPricelists: /bulk/pricelists/sms/buying?eq(supplierId)=xxxx&all=yes - API endpoint for customerMNPPricelists: /bulk/pricelists/mnp/selling?eq(customerId)=xxxx&all=yes - API endpoint for supplierMNPPricelists: /bulk/pricelists/mnp/buying?eq(supplierId)=xxxx&all=yes - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive) Biz Partner (bizPartnerId = xxxx) can have total balances as customer and supplier for products SMS and MNP. - API endpoint for customerSMSTotalBalances: /bulk/billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes - API endpoint for supplierSMSTotalBalances: /bulk/gate-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes - API endpoint for customerMNPTotalBalances: /bulk/mnp-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes - API endpoint for supplierMNPTotalBalances: /bulk/mnp-gate-billing/v2/total-balances?eq(bizPartnerId)=xxxx&all=yes - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive) Biz Partner (bizPartnerId = xxxx) can have billing accounts as customer and supplier for products SMS and MNP. - API endpoint for customerSMSBillingAccounts: /bulk/billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes - API endpoint for supplierSMSBillingAccounts: /bulk/gate-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes - API endpoint for customerMNPBillingAccounts: /bulk/mnp-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes - API endpoint for supplierMNPBillingAccounts: /bulk/mnp-gate-billing/v2/accounts?eq(bizPartnerId)=xxxx&all=yes - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive) Biz Partner (bizPartnerId = xxxx) can have connections as customer and supplier for products SMS and MNP. - API endpoint for customerSMSConnections: /bulk/sms-accounts/v1/accounts?eq(customerId)=xxxx&all=yes - API endpoint for supplierSMSConnections: /bulk/gates/v1/out-gates?eq(supplierId)=xxxx&all=yes - API endpoint for customerMNPConnections: /bulk/mnp-accounts/v1/out-gates?eq(customerId)=xxxx&all=yes - API endpoint for supplierMNPConnections: /bulk/mnp-supplier-accounts/v1/supplier-accounts?eq(supplierId)=xxxx&all=yes - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive) Biz Partner (bizPartnerId = xxxx) can have coOwners. - API endpoint for bizPartnerCoOwner: /biz-core/v2/partners?ownerBpId=xxxx Biz Partner (bizPartnerId = xxxx) can have Business Messenger linked. - API endpoint for Biz Partner's Business Messenger: /news/v1/services?partnerId=xxxx - For activate/deactivate Biz Partner additional parameter must be sent on URI (&neq(status)=inactive)	No links
default	Unexpected error.	No links

Success Response 200: Partner's status changed successfully

{
  "id": 0,
  "name": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalAddressId": 0,
  "status": "potential",
  "parentId": 0,
  "legalFormId": 0,
  "language": "string",
  "bizPartnerUid": "string",
  "partnerDetailsId": 0,
  "briefName": "string",
  "notificationAddressId": 0,
  "externalRefId": "string",
  "partnerTypeId": 0,
  "partnerTypeName": "string",
  "statusActiveDt": "2022-02-18T14:08:40.702Z",
  "statusDt": "2022-02-18T14:08:40.702Z",
  "dunsNumber": "string",
  "taxExempt": "string",
  "foundingD": "2022-02-18",
  "industryId": 0,
  "companySizeId": 0,
  "email": "string",
  "phone": "string",
  "fax": "string",
  "industryName": "string",
  "companySize": "string",
  "hasAttributes": "yes",
  "isIntercompany": "yes",
  "creation": "2022-02-18",
  "instanceRole": "string",
  "ownerBpId": 0,
  "ownerBpName": "string",
  "ownerBpBriefName": "string",
  "selfOwner": "yes"
}

Error Response 409: Unable to delete Partner due to its instance role or relations

"error": {
    "code": "INVALID-PARAMETERS",
    "message": "Invalid parameters",
    "items": [
        {
            "name": "customerSMSConnections",
            "message": "customerSMSConnections",
            "description": "ID: 1547 Name: 3396_VOICES_EUR; ID: 1639 Name: 3396_VOICES;"
        },
        {
            "name": "supplierSMSConnections",
            "message": "supplierSMSConnections",
            "description": "ID: 369 Name: ODTTELEKOM;"
        },
        {
            "name": "supplierSMSPricelists",
            "message": "supplierSMSPricelists",
            "description": "ID: 1105 Name: AV Pack PL 1; ID: 1110 Name: AV Pack PL 1; ID: 1107 Name: AV Pack PL 1;"
        },
        {
            "name": "customerSMSPricelists",
            "message": "customerSMSPricelists",
            "description": "ID: 469 Name: 1061_ECO; ID: 470 Name: 1061_FIXID; ID: 1038;"
        },
        {
            "name": "customerSMSTotalBalances",
            "message": "customerSMSTotalBalances",
            "description": "ID: 37 Name: Cortex Postpaid CHF; ID: 38 Name: Cortex Postpaid EUR;"
        },
        {
            "name": "supplierSMSTotalBalances",
            "message": "supplierSMSTotalBalances",
            "description": "ID: 33 Name: Co Communications"
        },
        {
            "name": "customerSMSBillingAccount",
            "message": "customerSMSBillingAccount",
            "description": "ID: 41 Name: 3396_VOICES_EUR; ID: 42 Name: 3396_VOICES; ID:"
        }
    ]
}

Error Response 409: Unable to delete Partner due to its instance role or relations

{
  "code": "string",
  "message": "string",
  "items": [
    {
      "name": "string",
      "sectionRowId": 0,
      "value": "string",
      "description": "string"
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Business Partner data for a given ID.
The required privileges: biz-core.view or biz-core.own.view.

Allowed embedded objects: legalAddress, bizPartnerProduct.
Example:
embed=legalAddress
embed=bizPartnerProduct.

Parameters

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

Responses

Code	Description	Links
200	Business Partner data.	No links
default	Unexpected error.	No links

Success Response 200: Business Partner data

{
  "id": 0,
  "instanceId": 0,
  "name": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalAddressId": "string",
  "status": "string",
  "parentId": 0,
  "legalFormId": 0,
  "language": "string",
  "bizPartnerUid": "string",
  "instanceOwnerName": "string",
  "briefName": "string",
  "countryName": "string",
  "dunsNumber": "string",
  "statusDt": "2021-02-02T13:51:21.794Z",
  "statusActiveDt": "2021-02-02T13:51:21.794Z",
  "legalForm": "string",
  "languageName": "string",
  "taxExempt": "string",
  "foundingD": "2021-02-02",
  "industryId": 0,
  "companySizeId": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "industryName": "string",
  "companySize": "string",
  "instanceRole": "string",
  "externalRefId": "string",
  "bizPartnerInstanceUid": "string",
  "hasAttributes": "string",
  "isIntercompany": "string",
  "partnerTypeId": 0,
  "partnerTypeName": "string",
  "detailsId": 0,
  "ownerBpId": 0,
  "ownerBpName": "string",
  "ownerBpBriefName": "string",
  "selfOwner": "yes",
  "legalAddress": {
    "id": 0,
    "bizPartnerId": 0,
    "bizPartnerName": "string",
    "bizPartnerBriefName": "string",
    "addressTypeId": 0,
    "addressTypeName": "string",
    "addressTypeCodeName": "string",
    "branchName": "string",
    "country": 0,
    "countryName": "string",
    "name": "string",
    "address": "string",
    "poBox": "string",
    "postalCode": "string",
    "city": "string",
    "province": "string",
    "attnPerson": "string",
    "latitude": "string",
    "longitude": "string",
    "eMail": "string",
    "phone": "string",
    "fax": "string",
    "copyOfAddresses": [
      {
        "id": 0,
        "bizPartnerId": 0,
        "bizPartnerName": "string",
        "bizPartnerBriefName": "string",
        "addressTypeId": 0,
        "addressTypeName": "string",
        "addressTypeCodeName": "string",
        "country": 0,
        "countryName": "string",
        "name": "string",
        "branchName": "string",
        "address": "string",
        "poBox": "string",
        "postalCode": "string",
        "city": "string",
        "province": "string",
        "attnPerson": "string",
        "latitude": "string",
        "longitude": "string",
        "eMail": "string",
        "phone": "string",
        "fax": "string",
        "copyToAddresses": [
          {
            "id": 0,
            "name": "string",
            "branchName": "string",
            "addressTypeId": 0
          }
        ]
      }
    ]
  },
  "extraAttributes": {
    "data": [
      {
        "id": 0,
        "sectionId": 0,
        "attributeId": 0,
        "attributeName": "string",
        "customAttrName": "string",
        "attributeValue": "string",
        "attributeCodeName": "string",
        "attributeTypeId": 0
      }
    ]
  },
  "businessPartnerProducts": {
    "data": [
      {
        "id": 0,
        "bizPartnerId": 0,
        "bizPartnerBriefName": "string",
        "productTypeName": "string",
        "productTypeCodeName": "string",
        "productId": 0,
        "productName": "string",
        "productCodeName": "string",
        "relationTypeId": 0,
        "relationTypeName": "string",
        "relationTypeCodeName": "string",
        "status": "string",
        "enabledDt": "2021-02-02T13:51:21.795Z",
        "disabledDt": "2021-02-02T13:51:21.795Z",
        "statusDt": "2021-02-02T13:51:21.795Z",
        "notes": "string",
        "customerType": "string",
        "accountManagerId": 0,
        "serviceCategoryId": 0,
        "serviceProductName": "string",
        "productBulkSms": {
          "id": 0,
          "bizpProductId": 0,
          "sellingPaymentType": "string",
          "sellingPaymentDue": 0,
          "validFromD": "2021-02-02",
          "billingCycle": 0,
          "billingCycleUnit": "string",
          "currencyId": 0,
          "invoiceTriggerAmount": 0,
          "overdraftLimit": 0,
          "creditLimit": 0,
          "deposit": 0,
          "bankGuarantee": 0,
          "disputePercent": 0,
          "maxDispute": 0,
          "announcementDays": 0,
          "currencyCode": "string",
          "currencyName": "string"
        }
      }
    ]
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Business Partner data for a given ID.
The required privilege: biz-core.manage.

Parameters

Name	Type	Description
id (required)	integer (path)	Business Partner ID.
put data (required)	object (body)	Business Partner update data.

Data Parameters

put data object example

{
  "name": "string",
  "briefName": "string",
  "externalRefId": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "dunsNumber": "string",
  "statusActiveDt": "2021-02-02T13:55:28.477Z",
  "legalFormId": 0,
  "language": "string",
  "taxExempt": "string",
  "foundingD": "2021-02-02",
  "industryId": 0,
  "companySizeId": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "isIntercompany": "string",
  "partnerTypeId": 0,
  "selfOwner": "string",
  "ownerBpId": 0,
  "extraAttributes": {
    "data": [
      {
        "attributeId": 0,
        "attributeValue": "string",
        "customAttrName": "string"
      }
    ]
  }
}

Responses

Code	Description	Links
200	Business Partner data.	No links
default	Unexpected error.	No links

Success Response 200: Business Partner data

{
  "id": 0,
  "instanceId": 0,
  "name": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalAddressId": "string",
  "status": "string",
  "parentId": 0,
  "legalFormId": 0,
  "language": "string",
  "bizPartnerUid": "string",
  "instanceOwnerName": "string",
  "briefName": "string",
  "countryName": "string",
  "dunsNumber": "string",
  "statusDt": "2022-02-28T09:51:28.728Z",
  "statusActiveDt": "2022-02-28T09:51:28.728Z",
  "legalForm": "string",
  "languageName": "string",
  "taxExempt": "string",
  "foundingD": "2022-02-28",
  "industryId": 0,
  "companySizeId": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "industryName": "string",
  "companySize": "string",
  "instanceRole": "string",
  "externalRefId": "string",
  "bizPartnerInstanceUid": "string",
  "hasAttributes": "string",
  "isIntercompany": "string",
  "partnerTypeId": 0,
  "partnerTypeName": "string",
  "detailsId": 0,
  "ownerBpId": 0,
  "ownerBpName": "string",
  "ownerBpBriefName": "string",
  "selfOwner": "yes",
  "legalAddress": {
    "id": 0,
    "bizPartnerId": 0,
    "bizPartnerName": "string",
    "bizPartnerBriefName": "string",
    "addressTypeId": 0,
    "addressTypeName": "string",
    "addressTypeCodeName": "string",
    "branchName": "string",
    "country": 0,
    "countryName": "string",
    "name": "string",
    "address": "string",
    "poBox": "string",
    "postalCode": "string",
    "city": "string",
    "province": "string",
    "attnPerson": "string",
    "latitude": "string",
    "longitude": "string",
    "eMail": "string",
    "phone": "string",
    "fax": "string",
    "copyOfAddresses": [
      {
        "id": 0,
        "bizPartnerId": 0,
        "bizPartnerName": "string",
        "bizPartnerBriefName": "string",
        "addressTypeId": 0,
        "addressTypeName": "string",
        "addressTypeCodeName": "string",
        "country": 0,
        "countryName": "string",
        "name": "string",
        "branchName": "string",
        "address": "string",
        "poBox": "string",
        "postalCode": "string",
        "city": "string",
        "province": "string",
        "attnPerson": "string",
        "latitude": "string",
        "longitude": "string",
        "eMail": "string",
        "phone": "string",
        "fax": "string",
        "copyToAddresses": [
          {
            "id": 0,
            "name": "string",
            "branchName": "string",
            "addressTypeId": 0
          }
        ]
      }
    ]
  },
  "extraAttributes": {
    "data": [
      {
        "id": 0,
        "sectionId": 0,
        "attributeId": 0,
        "attributeName": "string",
        "customAttrName": "string",
        "attributeValue": "string",
        "attributeCodeName": "string",
        "attributeTypeId": 0
      }
    ]
  },
  "businessPartnerProducts": {
    "data": [
      {
        "id": 0,
        "bizPartnerId": 0,
        "bizPartnerBriefName": "string",
        "productTypeName": "string",
        "productTypeCodeName": "string",
        "productId": 0,
        "productName": "string",
        "productCodeName": "string",
        "relationTypeId": 0,
        "relationTypeName": "string",
        "relationTypeCodeName": "string",
        "status": "string",
        "enabledDt": "2022-02-28T09:51:28.728Z",
        "disabledDt": "2022-02-28T09:51:28.728Z",
        "statusDt": "2022-02-28T09:51:28.728Z",
        "notes": "string",
        "customerType": "string",
        "accountManagerId": 0,
        "accountManagerName": "string",
        "serviceCategoryId": 0,
        "serviceProductName": "string",
        "productBulkSms": {
          "id": 0,
          "bizpProductId": 0,
          "sellingPaymentType": "string",
          "sellingPaymentDue": 0,
          "validFromD": "2022-02-28",
          "billingCycle": 0,
          "billingCycleUnit": "string",
          "currencyId": 0,
          "invoiceTriggerAmount": 0,
          "overdraftLimit": 0,
          "creditLimit": 0,
          "deposit": 0,
          "bankGuarantee": 0,
          "disputePercent": 0,
          "maxDispute": 0,
          "announcementDays": 0,
          "currencyCode": "string",
          "currencyName": "string"
        }
      }
    ]
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Biz Partner record.
The required privileges: biz-core.manage, auth.resource.add.

Errors

Name	Description
BIZ_CORE:SELF_OWNER_IS_NOT_VALID	Given value for self owner is not supported.
BIZ_CORE:OWNER_BP_ID_IS_NOT_VALID	Owner BP ID of the Partner is not valid.
BIZ_CORE:GIVEN_OWNER_BP_ID_IS_NOT_OWNER_OR_CO-OWNER	Given owner BP ID is not owner or co-owner.
BIZ_CORE:OWNER_NOT_FOUND_FOR_OWNER_BP_ID	Owner not found for owner BP ID.
BIZ_CORE:PARTNER_NAME_REQUIRED	Name of the Partner must be provided.
BIZ_CORE:PARTNER_NAME_OUT_OF_LIMIT	Name of the Partner cannot be longer than 150 characters.
BIZ_CORE:PARTNER_COUNTRY_IS_NOT_VALID	Country of the Partner is not valid.
BIZ_CORE:PARTNER_COUNTRY_NOT_FOUND	Country of the Partner is not found.
BIZ_CORE:PARTNER_COUNTRY_NOT_ACTIVE	Country of the Partner is not active.
BIZ_CORE:PARTNER_COUNTRY_MUST_BE_PROVIDED	Country of the Partner must be provided.
BIZ_CORE:PARTNER_VAT_APPLY_NOT_SUPPORTED	VAT apply of the Partner is not supported.
BIZ_CORE:PARTNER_REG_NUMBER_OUT_OF_LIMIT	Reg number of the Partner cannot be longer than 30 characters.
BIZ_CORE:PARTNER_LEGAL_FORM_ID_IS_NOT_VALID	Legal form ID of the Partner is not valid.
BIZ_CORE:PARTNER_LEGAL_FORM_NOT_SUPPORTED	Legal form of the Partner is not supported.
BIZ_CORE:PARTNER_LEGAL_FORM_NOT_ACTIVE	Legal form of the Partner is not active.
BIZ_CORE:PARTNER_LANGUAGE_NOT_SUPPORTED	Language of the Partner is not supported.
BIZ_CORE:PARTNER_LANGUAGE_NOT_ACTIVE	Language of the Partner is not active.
BIZ_CORE:PARTNER_BRIEF_NAME_REQUIRED	Brief name of the Partner must be provided.
BIZ_CORE:PARTNER_BRIEF_NAME_OUT_OF_LIMIT	Brief name of the Partner cannot be longer than 50 characters.
BIZ_CORE:PARTNER_EXTERNAL_REF_OUT_OF_LIMIT	External ref of the Partner cannot be longer than 100 characters.
BIZ_CORE:PARTNER_PARTNER_TYPE_ID_IS_NOT_VALID	Partner type ID of the Partner is not valid.
BIZ_CORE:PARTNER_PARTNER_TYPE_NOT_FOUND	Partner type of the Partner is not found.
BIZ_CORE:PARTNER_PARTNER_TYPE_NOT_ACTIVE	Partner type of the Partner is not active.
BIZ_CORE:PARTNER_IS_INTERCOMPANY_NOT_SUPPORTED	Is intercompany of the Partner is not supported.
BIZ_CORE:PARTNER_DUNS_NUMBER_OUT_OF_LIMIT	DUNS number of the Partner cannot be longer than 20 characters.
BIZ_CORE:PARTNER_FOUNDING_DATE_IS_NOT_VALID	Founding date of the Partner is not valid.
BIZ_CORE:PARTNER_FOUNDING_DATE_SHOULD_BE_TODAY_OR_LESS	Founding date of the Partner should be today or less.
BIZ_CORE:STATUS_ACTIVE_DT_IS_NOT_VALID	Status active date is not valid.
BIZ_CORE:PARTNER_INDUSTRY_ID_IS_NOT_VALID	Industry ID of the Partner is not valid.
BIZ_CORE:PARTNER_INDUSTRY_NOT_SUPPORTED	Industry of the Partner is not supported.
BIZ_CORE:PARTNER_INDUSTRY_NOT_ACTIVE	Industry of the Partner is not active.
BIZ_CORE:PARTNER_COMPANY_SIZE_ID_IS_NOT_VALID	Company size ID of the Partner is not valid.
BIZ_CORE:PARTNER_COMPANY_SIZE_NOT_SUPPORTED	Company size of the Partner is not supported.
BIZ_CORE:PARTNER_COMPANY_SIZE_NOT_ACTIVE	Company size of the Partner is not active.
BIZ_CORE:PARTNER_E_MAIL_OUT_OF_LIMIT	Email of the Partner cannot be longer than 255 characters.
BIZ_CORE:PARTNER_E_MAIL_NOT_VALID	Email of the Partner is not valid.
BIZ_CORE:PARTNER_PHONE_OUT_OF_LIMIT	Phone of the Partner cannot be longer than 30 characters.
BIZ_CORE:PARTNER_PHONE_NOT_VALID	Partner phone not valid.
BIZ_CORE:PARTNER_FAX_OUT_OF_LIMIT	Fax of the Partner cannot be longer than 30 characters.
BIZ_CORE:PARTNER_FAX_NOT_VALID	Partner fax not valid.
BIZ_CORE:ATTRIBUTE_FOR_GIVEN_ID_NOT_FOUND	Attribute for given ID not found.
BIZ_CORE:ATTRIBUTE_VALUE_CANNOT_BE_LONGER_THAN_1000_CHARACTERS	Attribute value cannot be longer than 1000 characters.
BIZ_CORE:ATTRIBUTE_VALUE_CANNOT_BE_LONGER_THAN_50_CHARACTERS	Attribute value cannot be longer than 50 characters.
BIZ_CORE:ADDRESS_TYPE_LEGAL_NOT_FOUND	Address type legal not found.
BIZ_CORE:ADDRESS_TYPE_HEADQUARTER_NOT_FOUND	Address type headquarter not found.
BIZ_CORE:ADDRESS_TYPE_INVOICE_NOT_FOUND	Address type invoice not found.
BIZ_CORE:ADDRESS_TYPE_INVOICE HARDCOPY_NOT_FOUND	Address type invoice hardcopy not found.
BIZ_CORE:ADDRESS_TYPE_NOT_VALID	Address type ID not valid.
BIZ_CORE:ADDRESS_TYPE_IS_NOT_FOUND	Address type is not found.
BIZ_CORE:ADDRESS_TYPE_IS_REQUIRED_FIELD_AND_IT_MUST_BE_PROVIDED	Address type ID is required field and it must be provided.
BIZ_CORE:COUNTRY_NOT_VALID	Country not valid.
BIZ_CORE:COUNTRY_IS_NOT_FOUND	Country is not found.
BIZ_CORE:COUNTRY_IS_REQUIRED_FIELD_AND_IT_MUST_BE_PROVIDED	Country is required field and it must be provided.
BIZ_CORE:LEGAL_ADDRESS_CAN_BE_INSERTED_ONLY_ONCE	Legal address can be inserted only once.
BIZ_CORE:BIZ_PARTNER_COUNTRY_CANNOT_BE_DIFFERENT_THAN_LEGAL_ADDRESS_COUNTRY	Biz Partner country cannot be different from Legal Address country.
BIZ_CORE:HEADQUARTER_ADDRESS_CAN_BE_INSERTED_ONLY_ONC	Headquarter address can be inserted only once.
BIZ_CORE:INVOICE_ADDRESS_CAN_BE_INSERTED_ONLY_ONCE	Invoice address can be inserted only once.
BIZ_CORE:INVOICE_HARDCOPY_ADDRESS_CAN_BE_INSERTED_ONLY_ONCE	Invoice hardcopy address can be inserted only once.
BIZ_CORE:BIZ_PARTNER_ADDRESS_NAME_CANNOT_BE_LONGER_THAN_150_CHARACTERS	Biz Partner Address name cannot be longer than 150 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_BRANCH_NAME_CANNOT_BE_LONGER_THAN_150_CHARACTERS	Biz Partner Address branchName cannot be longer than 150 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_MUST_BE_PROVIDED	Biz Partner Address must be provided.
BIZ_CORE:BIZ_PARTNER_ADDRESS_PO_BOX_CANNOT_BE_LONGER_THAN_20_CHARACTERS	Biz Partner Address PO box cannot be longer than 20 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_POSTAL_CODE_CANNOT_BE_LONGER_THAN_20_CHARACTERS	Biz Partner Address postal code cannot be longer than 20 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_CITY_MUST_BE_PROVIDED_FOR_PARTNERS_WHO_IS_NOT_IN_STATUS_DRAFT	Biz Partner Address city must be provided for partners who is not in status draft.
BIZ_CORE:BIZ_PARTNER_ADDRESS_CITY_CANNOT_BE_LONGER_THAN_100_CHARACTERS	Biz Partner Address city cannot be longer than 100 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_PROVINCE_CANNOT_BE_LONGER_THAN_100_CHARACTERS	Biz Partner Address province cannot be longer than 100 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_ATTN_PERSON_CANNOT_BE_LONGER_THAN_100_CHARACTERS	Biz Partner Address Attn. person cannot be longer than 100 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_E_MAIL_CANNOT_BE_LONGER_THAN_255_CHARACTERS	Biz Partner Address email cannot be longer than 255 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_E_MAIL_NOT_VALID	Email of the Biz Partner address is not valid.
BIZ_CORE:BIZ_PARTNER_ADDRESS_PHONE_CANNOT_BE_LONGER_THAN_30_CHARACTERS	Biz Partner Address phone cannot be longer than 30 characters.
BIZ_CORE:BIZ_PARTNER_ADDRESS_PHONE_NOT_VALID	Parnter address phone not valid.
BIZ_CORE:CANNOT_INSERT_COPY_ADDRESS_TYPE_TWICE	Cannot insert same copyToAddr address type twice.
BIZ_CORE:LEGAL_ADDRESS_CANNOT_BE_A_COPY_ADDRESS	Legal address cannot be a copyToAddr address.
BIZ_CORE:HEADQUARTER_ADDRESS_CANNOT_BE_A_COPY_ADDRESS_EXCEPT_FROM_A_LEGAL_ADDRESS	Head quarter address cannot be a copyToAddr address except from a legal address.
BIZ_CORE:LEGAL_ADDRESS_MUST_EXIST_FOR_PARTNER_WHO_IS_NOT_IN_STATUS_DRAFT	Legal address must exists.
BIZ_CORE:AT_LEAST_ONE_ADDRESS_MUST_EXIST_FOR_PARTNER_WHO_IS_NOT_IN_STATUS_DRAFT	At least one address must exists.
BIZ_CORE:PARTNER_OWNER_BP_ID_IS_NOT_VALID	Owner BP ID of the Partner is not valid.
BIZ_CORE:OWNER_BP_ID_CANNOT_BE_EMPTY	Owner BP ID cannot be empty.
BIZ_CORE:OWNER_BP_ID_CANNOT_BE_0	Owner BP ID cannot be 0.
BIZ_CORE:CO_OWNER_HAS_PARTNERS	Co-owner BP ID cannot be changed for this partner because it is owner of some other partners.
BIZ_CORE:OWNER_BP_DOES_NOT_EXIST	Partner does not exist for given owner BP ID.
BIZ_CORE:GIVEN_PARTNER_IS_NOT_CO_OWNER_OR_OWNER	Given partner is not co-owner or owner.
BIZ_CORE:OWNER_BP_ID_CANNOT_BE_EQUAL_TO_0	Owner BP ID cannot be equal to 0.
BIZ_CORE:PARTNER_COUNTRY_ID_IS_NOT_VALID	Country ID of the Partner is not valid.
BIZ_CORE:PARTNER_COUNTRY_NOT_SUPPORTED	Country of the Partner is not supported.
BIZ_CORE:COUNTRY_IN_BIZ_PARTNER_MUST_BE_ACTIVE	Country in Biz Partner must be active.
BIZ_CORE:PARTNER_VAT_NUMBER_OUT_OF_LIMIT	VAT number of the Partner cannot be longer than 30 characters.
BIZ_CORE:PARTNER_LEGAL_FORM_NOT_FOUND	Legal form of the Partner is not found.
BIZ_CORE:PARTNER_LANGUAGE_NOT_FOUND	Language of the Partner is not found.
BIZ_CORE:PARTNER_INDUSTRY_NOT_FOUND	Industry of the Partner is not found.
BIZ_CORE:PARTNER_COMPANY_SIZE_NOT_FOUND	Company size of the Partner is not found.
BIZ_CORE:PARTNER_STATUS_ACTIVE_DT_IS_NOT_VALID	Status active dt of the Partner is not valid.
BIZ_CORE:SECTION_DETAILS_NOT_FOUND	Section details not found.
BIZ_CORE:ATTRIBUTE_NOT_FOUND	Attribute not found.
BIZ_CORE:CUSTOM_ATTR_NAME_CANNOT_BE_LONGER_THAN_50_CHARACTERS	Custom Attribute name cannot be longer than 50 characters.
BIZ_CORE:BIZ_SETTINGS_NOTFOUND	Biz settings with given instance_id not found.
BIZ_CORE:APP_INSTANCE_NOTFOUND	App instance with given ID not found.
BIZ_CORE:PARTNER_SECTION_NOTFOUND	Partner section with given ID not found.
BIZ_CORE:PARTNER_NOTFOUND	Partner with given ID not found.

Parameters

Name	Type	Description
post data (required)	object (body)	Biz Partner data.

Data Parameters

post data object example

{
  "name": "string",
  "briefName": "string",
  "externalRefId": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "dunsNumber": "string",
  "status": "string",
  "taxExempt": "string",
  "foundingD": "2021-02-02",
  "statusActiveDt": "2021-02-02T14:00:34.554Z",
  "industryID": 0,
  "companySizeId": 0,
  "legalFormId": 0,
  "language": "string",
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "isIntercompany": "yes",
  "partnerTypeId": 0,
  "selfOwner": "yes",
  "ownerBpId": 0,
  "addresses": {
    "data": [
      {
        "addressTypeId": 0,
        "country": 0,
        "name": "string",
        "branchName": "string",
        "address": "string",
        "poBox": "string",
        "postalCode": "string",
        "city": "string",
        "province": "string",
        "attnPerson": "string",
        "latitude": 0,
        "longitude": 0,
        "eMail": "string",
        "phone": "string",
        "fax": "string",
        "copyToAddresses": {
          "data": [
            {
              "name": "string",
              "branchName": "string",
              "addressTypeId": 0
            }
          ]
        }
      }
    ]
  },
  "extraAttributes": {
    "data": [
      {
        "attributeId": 0,
        "attributeValue": "string",
        "customAttrName": "string"
      }
    ]
  }
}

Responses

Code	Description	Links
201	Business Partner record created.	No links
default	Unexpected error.	No links

Success Response 201: Business Partner record created

{
  "id": 0,
  "instanceId": 0,
  "name": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalAddressId": "string",
  "status": "string",
  "parentId": 0,
  "legalFormId": 0,
  "language": "string",
  "bizPartnerUid": "string",
  "instanceOwnerName": "string",
  "briefName": "string",
  "countryName": "string",
  "dunsNumber": "string",
  "statusDt": "2021-02-02T14:02:01.184Z",
  "statusActiveDt": "2021-02-02T14:02:01.184Z",
  "legalForm": "string",
  "languageName": "string",
  "taxExempt": "string",
  "foundingD": "2021-02-02",
  "industryId": 0,
  "companySizeId": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "industryName": "string",
  "companySize": "string",
  "instanceRole": "string",
  "externalRefId": "string",
  "bizPartnerInstanceUid": "string",
  "hasAttributes": "string",
  "isIntercompany": "string",
  "partnerTypeId": 0,
  "partnerTypeName": "string",
  "detailsId": 0,
  "ownerBpId": 0,
  "ownerBpName": "string",
  "ownerBpBriefName": "string",
  "selfOwner": "yes",
  "legalAddress": {
    "id": 0,
    "bizPartnerId": 0,
    "bizPartnerName": "string",
    "bizPartnerBriefName": "string",
    "addressTypeId": 0,
    "addressTypeName": "string",
    "addressTypeCodeName": "string",
    "branchName": "string",
    "country": 0,
    "countryName": "string",
    "name": "string",
    "address": "string",
    "poBox": "string",
    "postalCode": "string",
    "city": "string",
    "province": "string",
    "attnPerson": "string",
    "latitude": "string",
    "longitude": "string",
    "eMail": "string",
    "phone": "string",
    "fax": "string",
    "copyOfAddresses": [
      {
        "id": 0,
        "bizPartnerId": 0,
        "bizPartnerName": "string",
        "bizPartnerBriefName": "string",
        "addressTypeId": 0,
        "addressTypeName": "string",
        "addressTypeCodeName": "string",
        "country": 0,
        "countryName": "string",
        "name": "string",
        "branchName": "string",
        "address": "string",
        "poBox": "string",
        "postalCode": "string",
        "city": "string",
        "province": "string",
        "attnPerson": "string",
        "latitude": "string",
        "longitude": "string",
        "eMail": "string",
        "phone": "string",
        "fax": "string",
        "copyToAddresses": [
          {
            "id": 0,
            "name": "string",
            "branchName": "string",
            "addressTypeId": 0
          }
        ]
      }
    ]
  },
  "extraAttributes": {
    "data": [
      {
        "id": 0,
        "sectionId": 0,
        "attributeId": 0,
        "attributeName": "string",
        "customAttrName": "string",
        "attributeValue": "string",
        "attributeCodeName": "string",
        "attributeTypeId": 0
      }
    ]
  },
  "businessPartnerProducts": {
    "data": [
      {
        "id": 0,
        "bizPartnerId": 0,
        "bizPartnerBriefName": "string",
        "productTypeName": "string",
        "productTypeCodeName": "string",
        "productId": 0,
        "productName": "string",
        "productCodeName": "string",
        "relationTypeId": 0,
        "relationTypeName": "string",
        "relationTypeCodeName": "string",
        "status": "string",
        "enabledDt": "2021-02-02T14:02:01.184Z",
        "disabledDt": "2021-02-02T14:02:01.184Z",
        "statusDt": "2021-02-02T14:02:01.184Z",
        "notes": "string",
        "customerType": "string",
        "accountManagerId": 0,
        "serviceCategoryId": 0,
        "serviceProductName": "string",
        "productBulkSms": {
          "id": 0,
          "bizpProductId": 0,
          "sellingPaymentType": "string",
          "sellingPaymentDue": 0,
          "validFromD": "2021-02-02",
          "billingCycle": 0,
          "billingCycleUnit": "string",
          "currencyId": 0,
          "invoiceTriggerAmount": 0,
          "overdraftLimit": 0,
          "creditLimit": 0,
          "deposit": 0,
          "bankGuarantee": 0,
          "disputePercent": 0,
          "maxDispute": 0,
          "announcementDays": 0,
          "currencyCode": "string",
          "currencyName": "string"
        }
      }
    ]
  }
}

Error Response Unexpected Error: Default

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

Method Overview

The method deletes Business Partners for given IDs with all necessary prior checks (pricelists, billings, balances, connections, coOwner).

Parameters

Name	Type	Description
ids (required)	string (path)	Comma separated list of BP IDs.

Responses

Code	Description	Links
200	Business Partners for given IDs are deleted.	No links
default	Unexpected error.	No links

Success Response 200: Business Partners for given IDs are deleted

{
  "id": 0,
  "result": "string",
  "reason": {}
}

Error Response Unexpected Error: Default

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

Method Overview

The method checks if legal name and VAT are unique. Here we have excludedId parameter. It represents biz_core.biz_partner.id. The API will search all IDs except given excludedID, if excludedID <> 0 it will skip this value. The default value is 0, which means that all IDs will be serached. CompareDate is a parameter when we have date for compare. If the date of briefName is before compareDate, we will not check this briefName. Default date is "2007-01-01".

Parameters

Name	Type	Description
request data (required)	object (body)	Request data.

Data Parameters

request data object example

{
  "name": "string",
  "vatNumber": "string",
  "excludedId": 0,
  "compareDate": "string"
}

Responses

Code	Description	Links
200	Result.	No links
default	Unexpected error.	No links

Success Response 200: Result

{
  "name": "string",
  "vatNumber": "string",
  "excludedId": 0,
  "unique": true
}

Error Response Unexpected Error: Default

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

Method Overview

The method checks if brief name is unique. Here we have excludedId parameter. It represents biz_core.biz_partner.id. The API will search all IDs except excludedID, if excludedID <> 0 it will skip this value. The default value is 0, which means that all IDs will be serached. CompareDate is a parameter when we have date for compare. If the date of briefName before compareDate we will not check this briefName. Default date is "2007-01-01".

Parameters

Name	Type	Description
request data (required)	object (body)	Request data.

Responses

Code	Description	Links
200	Result.	No links
default	Unexpected error.	No links

Success Response 200: Result

{
  "briefName": "string",
  "excludedId": 0,
  "unique": true
}

Error Response Unexpected Error: Default

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

Method Overview

The method downloads .xlsx and .csv templates for Business Partners.
Also, we have humanReadable part and language, "?humanReadable=yes&language=fr". If humanReadable=yes, it means the data will be retrieved from databases, otherwise the data will be retrieved from hardcoded code. If the labales with different lanaguage are needed, it is also need to put for example language=it in path or URL.

Parameters

Name	Type	Description
extension (required)	string (path)	A file extension, .xlsx or .csv.

Responses

Code	Description	Links
201	Download .xlsx or .csv.	No links
default	Unexpected error.	No links

Success Response 201: Download .xlsx or .csv

Error Response Unexpected Error: Default

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

Method Overview

The method imports a new Biz partner records.
The required privileges: biz-core.manage, auth.resource.add.

Errors

Name	Description
BIZ_CORE_IMPORT_BIZ_PARTNER_FILE_NAME_TOO_LONG	File name is too long.
BIZ_CORE:BIZ_SETTINGS_NOTFOUND	Biz settings with given instance_id not found.
BIZ_CORE_IMPORT_BIZ_PARTNER_HEADER_NOT_FOUND	Header not found in the given file.
BIZ_CORE_IMPORT_BIZ_PARTNER_NO_PARTNERS_IN_FILE	At least one Biz Partner must exists in the given file.
BIZ_CORE_VAT_APPLY_VALUE_NOT_SUPPORTED	The given value for the VAT apply field is not supported.
BIZ_CORE_VAT_NUMBER_REQUIRED	The VAT number field is required and cannot be empty.
BIZ_CORE_TAX_EXEMPT_REQUIRED	The tax exempt number field is required and cannot be empty.
BIZ_CORE:PARTNER_ATTRIBUTE_ATTRIBUTE_SECTION_NOT_ACTIVE	The attribute section is not active.
BIZ_CORE_IMPORT_BIZ_PARTNER_NOT_SUPPORTED_CUSTOM_FIELDS	The given custom fields are not supported.
BIZ_CORE_CUSTOM_FIELD_NOT_FOUND	The given custom field is not found.
BIZ_CORE_ATTRIBUTE_SECTION_NOT_SUPPORTED	The given attribute section is not supported.
BIZ_CORE_CUSTOM_FIELD_VALUE_TOO_LONG	The given custom field value is too long.
BIZ_CORE_ATTRIBUTE_SHORT_SECTION_NAME_NOT_SUPPORTED	The given attribute short section name is not supported.

For other errors, please check the list of errors in the section about /biz-partners-reg endpoint.

Parameters

Name	Type	Description
uploadfile (required)	file (formData)	Prices, .csv or .xlsx file. File name can be max 150 characters long.

Responses

Code	Description	Links
201	Business Partner record created.	No links
default	Unexpected error.	No links

Success Response 201: Business Partner record created

{
  "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": "2025-03-21T15:05:38.378Z",
      "statusActiveDt": "2025-03-21T15:05:38.378Z",
      "legalForm": "string",
      "languageName": "string",
      "taxExempt": "string",
      "foundingD": "2025-03-21",
      "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": "2025-03-21T15:05:38.378Z",
            "disabledDt": "2025-03-21T15:05:38.378Z",
            "statusDt": "2025-03-21T15:05:38.378Z",
            "notes": "string",
            "customerType": "string",
            "accountManagerId": 0,
            "accountManagerName": "string",
            "serviceCategoryId": 0,
            "serviceProductName": "string",
            "productBulkSms": {
              "id": 0,
              "bizpProductId": 0,
              "sellingPaymentType": "string",
              "sellingPaymentDue": 0,
              "validFromD": "2025-03-21",
              "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"
            }
          }
        ]
      }
    }
  ],
  "errors": [
    {
      "row": 0,
      "message": "string",
      "description": "string",
      "code": 0,
      "items": [
        {
          "name": "string",
          "message": "string",
          "description": "string"
        }
      ]
    }
  ]
}

Error Response Unexpected Error: Default

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

3.38 PartnerSections

The following endpoints can be used for managing sections associated with Business Partners, enabling the organization of partner-related information into distinct segments for better structure and accessibility.

Method Overview

This method returns a list of all Partner sections.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, name, status, dbCodeName, comment. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Partner sections.	No links
default	Unexpected error.	No links

Success Response 200: List of Partner sections

{
  "data": [
    {
      "id": 0,
      "codeName": "string",
      "name": "string",
      "status": "active",
      "statusDt": "2021-02-02T14:47:29.960Z",
      "dbCodeName": "string",
      "comment": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a Partner section data.

Parameters

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

Responses

Code	Description	Links
200	Partner section data.	No links
default	Unexpected error.	No links

Success Response 200: Partner section data

{
  "id": 0,
  "codeName": "string",
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-02T14:49:45.934Z",
  "dbCodeName": "string",
  "comment": "string"
}

Error Response Unexpected Error: Default

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

3.39 AccountManagers

The following endpoints allow the users to retrieve a list of account managers, add new account managers, update their details, remove them when necessary, and retrieve account manager information for administrative and operational purposes.

Method Overview

This method returns a list of all Account Managers.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, name, email, status, productId, productCodeName, productName. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Account Managers.	No links
default	Unexpected error.	No links

Success Response 200: List of Account Managers

{
  "data": [
    {
      "id": 0,
      "instanceId": 0,
      "email": "string",
      "name": "string",
      "status": "active",
      "statusDt": "2021-02-02T14:56:49.745Z",
      "products": "string",
      "productCodeNames": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Account Manager.

Parameters

Name	Type	Description
post data (required)	object (body)	Account Manager data.

Data Parameters

post data object example

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

Responses

Code	Description	Links
200	Account Manager record created.	No links
default	Unexpected error.	No links

Success Response 200: Account Manager record created

{
  "id": 0,
  "instanceId": 0,
  "email": "string",
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-02T15:02:48.009Z",
  "accountMgrProduct": [
    {
      "id": 0,
      "accountMgrId": 0,
      "productId": 0,
      "productType": 0,
      "status": "active",
      "statusDt": "2021-02-02T15:02:48.009Z",
      "productName": "string",
      "productCodeName": "string",
      "productTypeName": "string",
      "productTypeCodeName": "string",
      "isOurProduct": "yes",
      "isSupplierProduct": "yes"
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns an Account Manager data for a given ID.

Parameters

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

Responses

Code	Description	Links
200	Account Manager data.	No links
default	Unexpected error.	No links

Success Response 200: Account Manager data

{
  "id": 0,
  "instanceId": 0,
  "email": "string",
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-03T11:52:28.185Z",
  "accountMgrProduct": [
    {
      "id": 0,
      "accountMgrId": 0,
      "productId": 0,
      "productType": 0,
      "status": "active",
      "statusDt": "2021-02-03T11:52:28.185Z",
      "productName": "string",
      "productCodeName": "string",
      "productTypeName": "string",
      "productTypeCodeName": "string",
      "isOurProduct": "yes",
      "isSupplierProduct": "yes"
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates an Account Manager data.

Parameters

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

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	Account Manager updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Account Manager updated successfully

{
  "id": 0,
  "instanceId": 0,
  "email": "string",
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-03T11:55:49.931Z",
  "accountMgrProduct": [
    {
      "id": 0,
      "accountMgrId": 0,
      "productId": 0,
      "productType": 0,
      "status": "active",
      "statusDt": "2021-02-03T11:55:49.931Z",
      "productName": "string",
      "productCodeName": "string",
      "productTypeName": "string",
      "productTypeCodeName": "string",
      "isOurProduct": "yes",
      "isSupplierProduct": "yes"
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes an Account Manager data with given ID logically.

Parameters

Name	Type	Description
id (required)	integer (path)	An Account Manager ID.

Responses

Code	Description	Links
200	Account Manager deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Account Manager deleted successfully

Error Response Unexpected Error: Default

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

Method Overview

This method deletes all account_manager_id in Biz Partner products for adequate account_manager_id.

Parameters

Name	Type	Description
accountManagerId (required)	integer (path)	An Account Manager ID.

Responses

Code	Description	Links
200	All account_manager_id in Biz Partner products for adequate account_manager_id deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: All account_manager_id in Biz Partner products for adequate account_manager_id deleted successfully

Error Response Unexpected Error: Default

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

3.40 Attributes / Custom Fields

The endpoints for working with Attributes/Custom fields.

The registry of attributes are used to enrich basic data in many sections (areas) of Business Partners model.

We have two general groups of attributes, predefined (there is attributeKind=predefined) and registered - custom fields (there is attributeKind=registered).

Predefined attributes have built-in meaning like web links (type is WWW), social networks (type is SOCIAL) etc., and new attributes of this types can be added only when software supports them. Types for these attributes have to have allCustomAttrs=no.

Registered attributes are predicted for special data enrichment approach, where software owner can register new attributes i.e. custom fields, where semantic meaning is not so strictly controlled. Code name prefix for these attributes is 'ATTR-'. Types for these attributes have to have allCustomAttrs=yes.

Method Overview

This method returns a list of all Attributes/Custom fields.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, attributeTypeId, codeName, name, status, attributeKind, sectionId, sectionCodeName, sectionName, dbCodeName, comment, attributeTypeCodeName, attributeTypeName, attributeSectionStatus. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Attributes/Custom fields.	No links
default	Unexpected error.	No links

Success Response 200: List of Attributes/Custom fields

{
  "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,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Attribute/Custom Field record.

Parameters

Name	Type	Description
post data (required)	object (body)	Attribute/Custom Field data.

Data Parameters

post data object example

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

Responses

Code	Description	Links
200	Attribute/Custom Field created.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field created

{
  "id": 0,
  "attributeTypeId": 0,
  "codeName": "string",
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-03T12:07:57.469Z",
  "attributeKind": "registered",
  "attributeTypeCodeName": "string",
  "attributeTypeName": "string",
  "canBeDeleted": true,
  "canCodeNameChange": true,
  "attributeSections": [
    {
      "attributeId": 0,
      "sectionId": 0,
      "status": "active",
      "statusDt": "2021-02-03T12:07:57.469Z",
      "sectionCodeName": "string",
      "sectionName": "string",
      "dbCodeName": "string",
      "sectionStatus": "active",
      "attributeStatus": "active",
      "attributeSectionTags": [
        {
          "sectionId": 0,
          "attributeId": 0,
          "tagId": 0,
          "insertTs": "2021-02-03T12:07:57.469Z",
          "attributeTagCategoryId": 0,
          "attributeTagRowType": "string",
          "attributeTagCodeName": "string",
          "attributeTagName": "string",
          "attributeTagStatus": "string",
          "attributeTagStatusDt": "string"
        }
      ]
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Attribute/Custom Field data for a given ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.

Responses

Code	Description	Links
200	Attribute/Custom Field data.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field data

{
  "id": 0,
  "attributeTypeId": 0,
  "codeName": "string",
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-03T12:10:22.086Z",
  "attributeKind": "predefined",
  "attributeTypeCodeName": "string",
  "attributeTypeName": "string",
  "canBeDeleted": true,
  "canCodeNameChange": true,
  "attributeSections": [
    {
      "attributeId": 0,
      "sectionId": 0,
      "status": "active",
      "statusDt": "2021-02-03T12:10:22.086Z",
      "sectionCodeName": "string",
      "sectionName": "string",
      "dbCodeName": "string",
      "sectionStatus": "active",
      "attributeStatus": "active",
      "attributeSectionTags": [
        {
          "sectionId": 0,
          "attributeId": 0,
          "tagId": 0,
          "insertTs": "2021-02-03T12:10:22.087Z",
          "attributeTagCategoryId": 0,
          "attributeTagRowType": "string",
          "attributeTagCodeName": "string",
          "attributeTagName": "string",
          "attributeTagStatus": "string",
          "attributeTagStatusDt": "string"
        }
      ]
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Attribute/Custom Field data for a given ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
put data (required)	object (body)	Attribute/Custom Field data.

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	Attribute/Custom Field updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field updated successfully

{
  "id": 0,
  "attributeTypeId": 0,
  "codeName": "string",
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-03T12:13:02.394Z",
  "attributeKind": "registered",
  "attributeTypeCodeName": "string",
  "attributeTypeName": "string",
  "canBeDeleted": true,
  "canCodeNameChange": true,
  "attributeSections": [
    {
      "attributeId": 0,
      "sectionId": 0,
      "status": "active",
      "statusDt": "2021-02-03T12:13:02.394Z",
      "sectionCodeName": "string",
      "sectionName": "string",
      "dbCodeName": "string",
      "sectionStatus": "active",
      "attributeStatus": "active",
      "attributeSectionTags": [
        {
          "sectionId": 0,
          "attributeId": 0,
          "tagId": 0,
          "insertTs": "2021-02-03T12:13:02.394Z",
          "attributeTagCategoryId": 0,
          "attributeTagRowType": "string",
          "attributeTagCodeName": "string",
          "attributeTagName": "string",
          "attributeTagStatus": "string",
          "attributeTagStatusDt": "string"
        }
      ]
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes Attribute/Custom Field record with given ID logically.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.

Responses

Code	Description	Links
200	Attribute/Custom Field deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field deleted successfully

Error Response Unexpected Error: Default

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

Method Overview

This method creates Attribute/Custom Field code name.

Parameters

Name	Type	Description
post data (required)	object (body)	Attribute/Custom Field code data.

Data Parameters

post data object example

{
  "name": "string"
}

Responses

Code	Description	Links
200	Attribute/Custom Field code name data.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field code name data

{
  "codeName": "string"
}

Error Response Unexpected Error: Default

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

3.41 Attribute / Custom Field Sections

Endpoint for working with Attribute/Custom Field Sections.

Method Overview

This method creates a new Attribute/Custom Field section record.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
post data (required)	object (body)	Attribute/Custom Field section data.

Data Parameters

post data object example

{
  "sectionId": 0
}

Responses

Code	Description	Links
200	Attribute/Custom Field section record created.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field section record created

{
  "attributeId": 0,
  "sectionId": 0,
  "status": "active",
  "statusDt": "2021-02-04T10:30:54.681Z",
  "sectionCodeName": "string",
  "sectionName": "string",
  "dbCodeName": "string",
  "sectionStatus": "active",
  "attributeStatus": "active",
  "attributeSectionTags": [
    {
      "sectionId": 0,
      "attributeId": 0,
      "tagId": 0,
      "insertTs": "2021-02-04T10:30:54.681Z",
      "attributeTagCategoryId": 0,
      "attributeTagRowType": "string",
      "attributeTagCodeName": "string",
      "attributeTagName": "string",
      "attributeTagStatus": "string",
      "attributeTagStatusDt": "string"
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Attribute/Custom Field section data.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
secId (required)	integer (path)	Section ID.

Responses

Code	Description	Links
200	Attribute/Custom Field section data.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field section data

{
  "attributeId": 0,
  "sectionId": 0,
  "status": "active",
  "statusDt": "2021-02-04T10:33:36.668Z",
  "sectionCodeName": "string",
  "sectionName": "string",
  "dbCodeName": "string",
  "sectionStatus": "active",
  "attributeStatus": "active",
  "attributeSectionTags": [
    {
      "sectionId": 0,
      "attributeId": 0,
      "tagId": 0,
      "insertTs": "2021-02-04T10:33:36.668Z",
      "attributeTagCategoryId": 0,
      "attributeTagRowType": "string",
      "attributeTagCodeName": "string",
      "attributeTagName": "string",
      "attributeTagStatus": "string",
      "attributeTagStatusDt": "string"
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Attribute/Custom Field section data.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
secId (required)	integer (path)	Section ID.
put data (required)	object (body)	Attribute/Custom Field section data.

Data Parameters

put data object example

{
  "status": "active"
}

Responses

Code	Description	Links
200	Attribute/Custom Field section updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field section updated successfully

{
  "attributeId": 0,
  "sectionId": 0,
  "status": "active",
  "statusDt": "2021-02-04T10:36:56.131Z",
  "sectionCodeName": "string",
  "sectionName": "string",
  "dbCodeName": "string",
  "sectionStatus": "active",
  "attributeStatus": "active",
  "attributeSectionTags": [
    {
      "sectionId": 0,
      "attributeId": 0,
      "tagId": 0,
      "insertTs": "2021-02-04T10:36:56.131Z",
      "attributeTagCategoryId": 0,
      "attributeTagRowType": "string",
      "attributeTagCodeName": "string",
      "attributeTagName": "string",
      "attributeTagStatus": "string",
      "attributeTagStatusDt": "string"
    }
  ]
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes Attribute/Custom Field section record with a given Attribute ID and Section ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
secId (required)	integer (path)	Section ID.

Responses

Code	Description	Links
200	Attribute/Custom Field section deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field section deleted successfully

Error Response Unexpected Error: Default

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

3.42 Biz Attribute / Custom Field Section Tag

Endpoints for working with Biz Attribute/Custom Field section tag table.

Method Overview

This method returns a Biz Attribute/Custom Field section tag record from the database for a given attribute/custom field ID, section ID and tag ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
secId (required)	integer (path)	Section ID.
tagId (required)	integer (path)	Tag ID.

Responses

Code	Description	Links
200	BizAttributeSectionTag data.	No links
default	Unexpected error.	No links

Success Response 200: BizAttributeSectionTag data

{
  "sectionId": 0,
  "attributeId": 0,
  "tagId": 0,
  "insertTs": "2022-01-31T10:39:46.704Z",
  "attributeTagCategoryId": 0,
  "attributeTagRowType": "string",
  "attributeTagCodeName": "string",
  "attributeTagName": "string",
  "attributeTagStatus": "string",
  "attributeTagStatusDt": "string"
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes a Biz Attribute/Custom Field section tag record from the database for a given attribute/custom field ID, section ID and tag ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
secId (required)	integer (path)	Section ID.
tagId (required)	integer (path)	Tag ID.

Responses

Code	Description	Links
204	Biz Attribute/Custom Field section successfully deleted.	No links
default	Unexpected error.	No links

Success Response 204: Biz Attribute/Custom Field section successfully deleted

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of Biz Attribute/Custom Field section tag.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
secId (required)	integer (path)	Section ID.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and the following attributes: sectionId, attributeId, tagId, insertTs, attributeTagCategoryId, attributeTagRowType, attributeTagCodeName, attributeTagName, attributeInstanceId, attributeAttributeTypeId, attributeCodeName, attributeName, attributeKind, sectionCodeName, sectionName. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Attribute/Custom Field section tag.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Attribute/Custom Field 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,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Biz Attribute/Custom Field section tag record.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field ID.
secId (required)	integer (path)	Section ID.
post data (required)	object (body)	Biz Attribute/Custom Field section tag data.

Data Parameters

Post data object example

{
  "tagId": 0
}

Responses

Code	Description	Links
200	Biz Attribute/Custom Field section tag record created.	No links
default	Unexpected error.	No links

Success Response 200: Biz Attribute/Custom Field section tag record created

{
  "sectionId": 0,
  "attributeId": 0,
  "tagId": 0,
  "insertTs": "2022-01-31T10:58:52.386Z",
  "attributeTagCategoryId": 0,
  "attributeTagRowType": "string",
  "attributeTagCodeName": "string",
  "attributeTagName": "string",
  "attributeTagStatus": "string",
  "attributeTagStatusDt": "string"
}

Error Response Unexpected Error: Default

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

3.43 Biz Attribute / Custom Field Tag

Endpoints for working with Biz Attribute/Custom Field tag table.

Method Overview

This method returns a Biz Attribute/Custom Field tag record from the database for a given tag ID.

Parameters

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

Responses

Code	Description	Links
200	BizAttributeTag data.	No links
default	Unexpected error.	No links

Success Response 200: BizAttributeTag data

{
  "id": 0,
  "categoryId": 0,
  "rowType": "string",
  "codeName": "string",
  "customAttrName": "string",
  "attributeValue": "string",
  "attributeCodeName": "string",
  "attributeTypeId": 0
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of Biz Attribute/Custom Field tag records.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween and the following attributes: id, categoryId, rowType, codeName, name, status, statusDt. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Biz Attribute/Custom Field section tag.	No links
default	Unexpected error.	No links

Success Response 200: List of Biz Attribute/Custom Field section tag

{
  "data": [
    {
      "id": 0,
      "categoryId": 0,
      "rowType": "string",
      "codeName": "string",
      "customAttrName": "string",
      "attributeValue": "string",
      "attributeCodeName": "string",
      "attributeTypeId": 0
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.44 Attribute / Custom Field Types

These endpoints handle the retrieval of Attribute Types/Custom Fields, supporting the extension of partner data models with additional, structured information.

We have two general groups of attributes, predefined (there is allCustomAttrs=no) and registered - custom fields (there is allCustomAttrs=yes).

Types for predefined attributes have built-in meaning like web links (type is WWW), social networks (type is SOCIAL) etc., and new attributes of this types can be added only when software supports them.

Types for registered attributes are predicted for special data enrichment approach, where software owner can register new attributes i.e. custom fields, where semantic meaning is not so strictly controlled. Code name prefix for these attribute types is 'INPUT-' (INPUT-STRING, INPUT-TEXT, INPUT-DATE).

Method Overview

This method returns a list of Attribute/Custom Field types.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, codeName, name, allCustomAttrs, status. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Attribute/Custom Field types.	No links
default	Unexpected error.	No links

Success Response 200: List of Attribute/Custom Field types

{
  "data": [
    {
      "id": 0,
      "codeName": "string",
      "name": "string",
      "allCustomAttrs": "yes",
      "status": "active",
      "statusDt": "2021-02-04T10:43:46.323Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Attribute/Custom Field type data.

Parameters

Name	Type	Description
id (required)	integer (path)	Attribute/Custom Field type ID.

Responses

Code	Description	Links
200	Attribute/Custom Field type data.	No links
default	Unexpected error.	No links

Success Response 200: Attribute/Custom Field 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"
}

3.45 Partner Attributes / Custom Fields

Endpoints for working with Partner Attributes/Custom Fields.

Method Overview

This method returns a list of all Partner Attributes/Custom fields.
The required privileges:
- bp-settings-custom-fields.view - Logged user can see partner Attributes/Custom Fields for all Biz partners in the list.
- bp-settings-custom-fields-own.view - Logged user can see only partner Attributes/Custom Fields for his own Biz Partner in the list.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, sectionId, sectionRowId, attributeId, customAttrName, attributeValue, valueType, status, sectionCodeName, sectionName, attributeCodeName, attributeName, attributeTypeCodeName, attributeTypeName. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Partner Attributes/Custom fields.	No links
default	Unexpected error.	No links

Success Response 200: List of Partner Attributes/Custom fields

{
  "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,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method creates a new Partner Attribute/Custom Field record.

Parameters

Name	Type	Description
post data (required)	object (body)	Partner attribute/custom field data.

Data Parameters

post data object example

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

Responses

Code	Description	Links
200	Partner Attribute/Custom Field record created.	No links
default	Unexpected error.	No links

Success Response 200: Partner Attribute/Custom Field record created

{
  "id": 0,
  "sectionId": 0,
  "sectionRowId": 0,
  "attributeId": 0,
  "bizPartnerId": 0,
  "customAttrName": "string",
  "attributeValue": "string",
  "jsonValue": {
    "value": "string"
  },
  "valueType": "simple",
  "status": "active",
  "statusDt": "2021-02-04T09:16:07.712Z",
  "sectionCodeName": "string",
  "sectionName": "string",
  "dbCodeName": "string",
  "attributeCodeName": "string",
  "attributeName": "string",
  "attributeTypeCodeName": "string",
  "attributeTypeName": "string",
  "canBeChanged": true
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a list of all Partner Attributes/Custom fields extend.
The required privileges:
- bp-settings-custom-fields.view - Logged user can see partner Attributes/Custom Fields for all Biz partners in the list.
- bp-settings-custom-fields-own.view - Logged user can see only partner Attributes/Custom Fields for his own Biz Partner in the list.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
all	string (query)	Returns all data for a 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 the form of &paging=page_num,page_size, e.g. paging=1,10.
sort	string (query)	Sort options in the form of sort=-attribute1,attribute2,-attribute3.
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: id, instanceId, sectionId, sectionRowId, attributeId, customAttrName, attributeValue, valueType, status, sectionCodeName, sectionName, attributeCodeName, attributeName, attributeTypeCodeName, attributeTypeName, attributeTagCodeName, attributeTagName. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of PartnerAttributesExtend.	No links
default	Unexpected error.	No links

Success Response 200: List of PartnerAttributesExtend

{
  "data": [
    {
      "id": 0,
      "sectionId": 0,
      "sectionRowId": 0,
      "attributeId": 0,
      "bizPartnerId": 0,
      "customAttrName": "string",
      "attributeValue": "string",
      "jsonValue": {
        "value": "string"
      },
      "status": "active",
      "statusDt": "2021-02-04T09:19:19.278Z",
      "sectionCodeName": "string",
      "sectionName": "string",
      "dbCodeName": "string",
      "attributeCodeName": "string",
      "attributeName": "string",
      "attributeTypeCodeName": "string",
      "attributeTypeName": "string",
      "attributeTagCodeName": "string",
      "attributeTagName": "string",
      "canBeChanged": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns Partner Attribute/Custom Field data.
The required privileges:
- bp-settings-custom-fields.view - Logged user can see partner Attributes/Custom Fields for all Biz partners.
- bp-settings-custom-fields-own.view - Logged user can see only partner attribute/custom fields for his own Biz Partner in the list.

Parameters

Name	Type	Description
id (required)	integer (path)	Partner Attribute/Custom Field ID.

Responses

Code	Description	Links
200	Partner Attribute/Custom Field data.	No links
default	Unexpected error.	No links

Success Response 200: Partner Attribute/Custom Field data

{
  "id": 0,
  "sectionId": 0,
  "sectionRowId": 0,
  "attributeId": 0,
  "bizPartnerId": 0,
  "customAttrName": "string",
  "attributeValue": "string",
  "jsonValue": {
    "value": "string"
  },
  "valueType": "simple",
  "status": "active",
  "statusDt": "2021-02-04T09:21:55.713Z",
  "sectionCodeName": "string",
  "sectionName": "string",
  "dbCodeName": "string",
  "attributeCodeName": "string",
  "attributeName": "string",
  "attributeTypeCodeName": "string",
  "attributeTypeName": "string",
  "canBeChanged": true
}

Error Response Unexpected Error: Default

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

Method Overview

This method updates Partner Attribute/Custom Field data for a given ID.

Parameters

Name	Type	Description
id (required)	integer (path)	Partner Attribute/Custom Field ID.
put data (required)	object (body)	Partner Attribute/Custom Field data.

Data Parameters

put data object example

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

Responses

Code	Description	Links
200	Partner Attribute/Custom Field updated successfully.	No links
default	Unexpected error.	No links

Success Response 200: Partner Attribute/Custom Field updated successfully

{
  "id": 0,
  "sectionId": 0,
  "sectionRowId": 0,
  "attributeId": 0,
  "bizPartnerId": 0,
  "customAttrName": "string",
  "attributeValue": "string",
  "jsonValue": {
    "value": "string"
  },
  "valueType": "simple",
  "status": "active",
  "statusDt": "2021-02-04T09:22:58.894Z",
  "sectionCodeName": "string",
  "sectionName": "string",
  "dbCodeName": "string",
  "attributeCodeName": "string",
  "attributeName": "string",
  "attributeTypeCodeName": "string",
  "attributeTypeName": "string",
  "canBeChanged": true
}

Error Response Unexpected Error: Default

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

Method Overview

This method deletes Partner Attribute/Custom Field record with a given ID logically.

Parameters

Name	Type	Description
id (required)	integer (path)	Partner Attribute/Custom Field ID.

Responses

Code	Description	Links
200	Partner Attribute/Custom Field deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Partner Attribute/Custom Field deleted successfully

Error Response Unexpected Error: Default

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

Method Overview

This method deletes Partner Attribute/Custom Field record with a given attribute ID and section ID.

Parameters

Name	Type	Description
attrId (required)	integer (path)	Attribute/Custom Field ID.
secId (required)	integer (path)	Section ID.

Responses

Code	Description	Links
200	Partner Attribute/Custom Field deleted successfully.	No links
default	Unexpected error.	No links

Success Response 200: Partner Attribute/Custom Field deleted successfully

Error Response Unexpected Error: Default

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

3.46 Attribute / Custom Field Partners

This endpoint returns a list of Attributes/Custom Fields linked to Business Partners, allowing for the management and retrieval of partner-specific metadata.

Method Overview

This method returns a list of all Attribute/Custom Field Partners.
The required privileges:
- bp-settings-custom-fields.view - Logged user can see partner Attributes/Custom Fields for all Biz partners in the list.
- bp-settings-custom-fields-own.view - Logged user can see only partner Attributes/Custom Fields for his own Biz Partner in the list.
This endpoint accepts query parameters for filtering data described on URL Filtering Guidelines page.

Parameters

Name	Type	Description
operator(fieldName)	string (query)	Search criteria by using the following operators: isnull, isnotnull, isempty, isnotempty, eq, neq, startswith, contains, endswith, doesnotcontain, lt, lte, gt, gte, in, notin, between, notbetween, includeIds and by following attributes: attributeId, sectionId. If operator is one of isnull, isnotnull, isempty, isnotempty, a field value can be omitted. If operator is in or notin, a field value must be a comma separated list of values. If operator is between or notbetween, a field value must be a comma separated list of two values, representing the beginning and the end of a range. Operator can be omitted, and in that case, it will be treated as operator is eq (E.g.: fieldName=fieldValue). Example: startswith(clientName)=hor, starts with hor in field 'clientName'. If fieldName is 'q', and operator is eq or omitted, a field value will be used in general search across multiple attributes.

Responses

Code	Description	Links
200	A list of Attribute/Custom Field Partners.	No links
default	Unexpected error.	No links

Success Response 200: List of Attribute/Custom Field Partners

{
  "data": [
    {
      "partnerId": 0,
      "partnerName": "string",
      "partnerBriefName": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

3.47 Users

The endpoints for retrieving a list of Users and their details.

Method Overview

This method returns a list of users.
The required privileges:
- biz-core.view - All users must have this privilege.
- biz-core-own-user.view - If a user has this privilege, he will see only his own user in a response list.

Parameters

Name	Type	Description
kind	string (query)	Kind of a user. Available values: user, app.
status	string (query)	A user's status. Available values: active, inactive, invited, disabled.

Responses

Code	Description	Links
200	A list of users' data.	No links
default	Unexpected error.	No links

Success Response 200: List of users' data

{
  "data": [
    {
      "uuid": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "status": "active"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }
}

Error Response Unexpected Error: Default

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

Method Overview

This method returns a user for a given UUID.
The required privileges:
- biz-core.view - All users must have this privilege.
- biz-core-own-user.view - If a user has this privilege, he will see only his own user in a response list.

Parameters

Name	Type	Description
uuid (required)	string (path)	A user's UUID.

Responses

Code	Description	Links
200	A user's data.	No links
default	Unexpected error.	No links

Success Response 200: User's data

{
  "uuid": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "status": "active"
}

Error Response Unexpected Error: Default

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

4. Data Models

Data Models define the structure of a JSON document and describe the data related to the Business Partner API.

4.1 DocLogoFile

DocLogoFile object properties:

Name	Type	Description
id	integer	Logo ID.
partnerId	integer	Partner ID.
filename	string	Logo file name.
size	integer	File size.
language	string	Language.
mimeType	string	Mime type.
insertDt	string($date‑time)	Date of insertion.
status	string	Logo status. Possible values: draft, active, deleted, inactive.
statusDt	string($date‑time)	Date of logo status.

JSON Example

{
  "id": 0,
  "partnerId": 0,
  "filename": "string",
  "size": 0,
  "language": "string",
  "mimeType": "string",
  "insertDt": "2021-01-28T11:09:48.212Z",
  "status": "draft",
  "statusDt": "2021-01-28T11:09:48.212Z"
}

4.2 DocTemplateFileStatus

DocTemplateFileStatus object properties:

Name	Type	Description
status	string	File status. Possible values: draft, active, deleted, inactive.

4.3 BizPartnerTypeCollection

BizPartnerTypeCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerTypeItem objects.
meta (required)	object	CollectionMeta object.

4.4 BizPartnerTypeItem

BizPartnerTypeItem object properties:

Name	Type	Description
id	integer	Business Partner ID.
name	string	Name.
status	string	Status.
favorite	string	Possible values: yes, no.

4.5 BizSettings

BizSettings object properties:

Name	Type	Description
instanceId	integer	Instance ID.
coOwnersEnabled	string	Possible values: yes, no.
resellersEnabled	string	Possible values: yes, no.

JSON Example

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

4.6 BizAttributeSectionTagCollection

BizAttributeSectionTagCollection object properties:

Name	Type	Description
data (required)	array	An array of BizAttributeSectionTag objects.
meta (required)	object	CollectionMeta object.

4.7 BizAttributeSectionTag

BizAttributeSectionTag object properties:

Name	Type	Description
sectionId	integer	Section ID.
attributeId	integer	Attribute/Custom Field ID.
tagId	integer	Tag ID.
insertTs	string($date‑time)	Date of insertion.
attributeTagCategoryId	integer	Attribute tag category ID.
attributeTagRowType	string	Attribute tag row type.
attributeTagCodeName	string	Attribute tag code name.
attributeTagName	string	Attribute tag name.
attributeTagStatus	string	Attribute tag status.
attributeTagStatusDt	string	Attribute tag status date and time.

4.8 BizAttributeSectionTagPost

BizAttributeSectionTagPost object properties:

Name	Type	Description
tagId	integer	Tag ID.

JSON Example

{
  "sectionId": 0,
  "attributeId": 0,
  "tagId": 0,
  "insertTs": "2022-01-31T10:39:46.704Z",
  "attributeTagCategoryId": 0,
  "attributeTagRowType": "string",
  "attributeTagCodeName": "string",
  "attributeTagName": "string",
  "attributeTagStatus": "string",
  "attributeTagStatusDt": "string"
}

4.9 BizAttributeTagCollection

BizAttributeTagCollection object properties:

Name	Type	Description
data (required)	array	An array of BizAttributeTag objects.
meta (required)	object	CollectionMeta object.

4.10 BizAttributeTag

BizAttributeTag object properties:

Name	Type	Description
id	integer	Tag ID.
categoryId	integer	Category ID.
rowType	string	Row type.
codeName	string	Code name.
customAttrName	string	Custom attribute name.
attributeValue	string	Attribute value.
attributeCodeName	string	Attribute code name.
attributeTypeId	integer	Attribute type ID.

JSON Example

{
  "id": 0,
  "categoryId": 0,
  "rowType": "string",
  "codeName": "string",
  "customAttrName": "string",
  "attributeValue": "string",
  "attributeCodeName": "string",
  "attributeTypeId": 0
}

4.11 WebSocialCollection

WebSocialCollection object properties:

Name	Type	Description
data (required)	array	An array of WebSocial objects.
meta (required)	object	CollectionMeta object.

4.12 WebSocial

WebSocial object properties:

Name	Type	Description
id	integer	Web social ID.
name	string	Web social name.
sectionRowId	integer	ID of details for section DETAILS or ID of contact for section CONTACTS.
value	string	Value.
status	string	Possible value: active, deleted.
statusDt	string($date‑time)	Web social status date and time.

4.13 WebSocialPut

WebSocialPut object properties:

Name	Type	Description
name (required)	string	maxLength: 50.
value	string	maxLength: 1000.

4.14 WebSocialPost

WebSocialPost object properties:

Name	Type	Description
name (required)	string	maxLength: 50.
sectionRowId	integer	maxLength: 10. ID of details for section DETAILS or ID of contact for section CONTACTS.
value	string	maxLength: 1000.

JSON Example

{
  "id": 0,
  "name": "string",
  "sectionRowId": 0,
  "value": "string",
  "status": "active",
  "statusDt": "2021-02-01T13:15:44.579Z"
}

4.15 ErrorObjectsFixFirst

ErrorObjectsFixFirst object properties:

Name	Type	Description
code	string	Error code.
message	string	Error message.
items	array	An array of ErrorItems object.

4.16 ErrorItems

ErrorItems object properties:

Name	Type	Description
name	string	maxLength: 50.
sectionRowId	integer	maxLength: 10. ID of details for section DETAILS or ID of contact for section CONTACTS.
value	string	Error value.
description	string	Error description.

4.17 PartnerPatch

PartnerPatch object properties:

Name	Type	Description
status	string	Possible values: suspended, active, draft.

4.18 BizpProductPatch

BizpProductPatch object properties:

Name	Type	Description
status	string	Possible values: suspended, enabled.

4.19 Partner

Partner object properties:

Name	Type	Description
id	integer	Partner ID.
name	string	Partner name.
country	integer	Country code.
vatNumber	string	VAT number.
vatApply	string	Possible values: yes, no, unknown.
regNumber	string	Partner's reg number.
legalAddressId	integer	Partner's legal address ID.
value	string	Value.
status	string	Possible values: potential, active, suspended, archived,deleted, mics, draft.
parentId	integer	Partner's parent ID.
legalFormId	integer	Legal form ID.
language	string	Language.
bizPartnerUid	string	Biz Partner UID.
partnerDetailsId	integer	Partner's details ID.
briefName	string	Partner's brief name.
notificationAddressId	integer	Notification address ID.
externalRefId	string	External reference ID.
partnerTypeId	integer	Partner type ID.
partnerTypeName	string	Partner type name.
statusActiveDt	string($date‑time)	Date of active status.
statusDt	string($date‑time)	Date of status.

JSON Example

{
  "id": 0,
  "name": "string",
  "country": 0,
  "vatNumber": "string",
  "vatApply": "yes",
  "regNumber": "string",
  "legalAddressId": 0,
  "value": "string",
  "status": "potential",
  "parentId": 0,
  "legalFormId": 0,
  "language": "string",
  "bizPartnerUid": "string",
  "partnerDetailsId": 0,
  "briefName": "string",
  "notificationAddressId": 0,
  "externalRefId": "string",
  "partnerTypeId": 0,
  "partnerTypeName": "string",
  "statusActiveDt": "2021-02-02T13:31:49.562Z",
  "statusDt": "2021-02-02T13:31:49.562Z"
}

4.20 PartnerTypeCollection

PartnerTypeCollection object properties:

Name	Type	Description
data (required)	array	An array of PartnerType objects.
meta (required)	object	CollectionMeta object.

4.21 PartnerType

PartnerType object properties:

Name	Type	Description
id	integer	Partner type ID.
name	string	Partner type name.
status	string	Possible values: active, inactive, deleted, misc.
statusDt	string($date‑time)	Status date and time.
dbCodeName	string	Code name.
comment	string	Possible values: yes, no.

JSON Example

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-01T13:35:51.271Z",
  "dbCodeName": "string",
  "comment": "yes"
}

4.22 PartnerTypePut

PartnerTypePut object properties:

Name	Type	Description
name	string	Partner type name.
taxExempt	string	Tax exemption.
foundingD	string($date‑time)	Founding date and time.
industryId	integer	Industry ID.
companySizeId	integer	Company size ID.
eMail	string	Partner's E-mail.
phone	string	Partner's phone.
fax	string	Partner's fax.
industryName	string	Industry name.
companySize	string	Company size.
hasAttributes	string	Possible values: yes, no.
isIntercompany	string	Possible values: yes, no.

4.23 PartnerTypePost

PartnerTypePost object properties:

Name	Type	Description
name (required)	string	Possible values: manually, self_service.
selfOwner	string	Possible values: yes, no.

JSON Example

{
  "name": "string",
  "taxExempt": "string",
  "foundingD": "2021-02-01T13:48:47.047Z",
  "industryId": 0,
  "companySizeId": 0,
  "eMail": "string",
  "phone": "string",
  "fax": "string",
  "industryName": "string",
  "companySize": "string",
  "hasAttributes": "yes",
  "isIntercompany": "yes"
}

4.24 IndustryCollection

IndustryCollection object properties:

Name	Type	Description
data (required)	array	An array of Industry objects.
meta (required)	object	CollectionMeta object.

4.25 Industry

Industry object properties:

Name	Type	Description
id	integer	Industry ID.
name	string	Industry name.
status	string	Possible values: active, inactive, deleted.
statusDt	string($date‑time)	Status date and time.
canBeDeleted	boolean	If industry can be deleted.
favorite	string	Possible values: yes, no.

4.26 IndustryPut

IndustryPut object properties:

Name	Type	Description
name	string	Industry name. maxLength: 50.
status	string	Possible values: active, inactive.
favorite	string	Possible values: yes, no.

4.27 IndustryPost

IndustryPost object properties:

Name	Type	Description
name (required)	string	Industry name. maxLength: 50.
favorite	string	Possible values: yes, no.

JSON Example

{
  "id": 0,
  "name": "string",
  "status": "active",
  "statusDt": "2021-02-02T12:56:10.108Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

4.28 CompanySizeCollection

CompanySizeCollection object properties:

Name	Type	Description
data (required)	array	An array of CompanySize objects.
meta (required)	object	CollectionMeta object.

4.29 CompanySize

CompanySize object properties:

Name	Type	Description
id	integer	Company ID.
companySize	string	Company size.
status	string	Company status. Possible values: active, inactive, deleted.
statusDt	string($date‑time)	Status date and time.
canBeDeleted	boolean	If company size can be deleted.
favorite	string	Possible values: yes, no.

4.30 CompanySizePut

CompanySizePut object properties:

Name	Type	Description
companySize	string	Company size. maxLength: 20.
status	string	Company status. Possible values: active, inactive.
favorite	string	Possible values: yes, no.

4.31 CompanySizePost

CompanySizePost object properties:

Name	Type	Description
companySize (required)	string	Company size. maxLength: 20.
favorite	string	Possible values: yes, no.

JSON Example

{
  "id": 0,
  "companySize": "string",
  "status": "active",
  "statusDt": "2021-02-02T13:18:15.807Z",
  "canBeDeleted": true,
  "favorite": "yes"
}

4.32 BusinessPartner

BusinessPartner object properties:

Name	Type	Description
id	integer	Business Partner ID.
instanceId	integer	Instance ID.
name	string	Business Partner name.
country	integer	Country code.
vatNumber	string	VAT number.
vatApply	string	Possible values: yes, no.
regNumber	string	Registration number.
legalAddressId	string	Legal address ID.
status	string	Status.
parentId	integer	Parent ID.
legalFormId	integer	Legal form ID.
language	string	Language.
bizPartnerUid	string	Business Partner UID.
instanceOwnerName	string	Instance owner name.
briefName	string	Business Partner brief name.
countryName	string	Country name.
dunsNumber	string	DUNS number.
statusDt	string($date‑time)	Status date and time.
statusActiveDt	string($date‑time)	Date of active status.
legalForm	string	Legal form.
languageName	string	Language name.
taxExempt	string	Tax exemption.
foundingD	string($date)	Founding date.
industryId	integer	Industry ID.
companySizeId	integer	Company size ID.
eMail	string	Business Partner E-mail.
phone	string	Business Partner phone.
fax	string	Business Partner fax.
industryName	string	Industry name.
companySize	string	Company size.
instanceRole	string	Instance role.
externalRefId	string	External reference ID.
bizPartnerInstanceUid	string	Business Partner instance ID.
hasAttributes	string	Possible values: yes, no.
isIntercompany	string	Possible values: yes, no.
partnerTypeId	integer	Partner type ID.
partnerTypeName	string	Partner type name.
detailsId	integer	Detail ID.
ownerBpId	integer	Owner Business Partner ID.
ownerBpName	string	Owner Business Partner name.
ownerBpBriefName	string	Owner Business Partner brief name.
selfOwner	string	Possible values: yes, no.
legalAddress	object	BizPartnerLegalAddress object.
extraAttributes	object	ExtraAttributesDataResponse object.
businessPartnerProducts	object	BizPartnerProductDataResponse object.

4.33 BusinessPartnerPostData

BusinessPartnerPostData object properties:

Name	Type	Description
name	string	Business Partner name.
briefName	string	Business Partner brief name.
externalRefId	string	External reference ID.
country	integer	Country code.
vatNumber	string	VAT number.
vatApply	string	Possible values: yes, no.
regNumber	string	Registration number.
dunsNumber	string	DUNS number.
status	string	Status.
taxExempt	string	Tax exemption.
foundingD	string($date)	Founding date.
statusActiveDt	string($date)	Date of active status.
industryID	integer	Industry ID.
companySizeId	integer	Company size ID.
legalFormId	integer	Legal form ID.
language	string	Language.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
isIntercompany	string	Possible values: yes, no.
partnerTypeId	integer	Partner type ID.
selfOwner	string	Possible values: yes, no.
ownerBpId	integer	Owner Business Partner ID.
addresses	object	BizPartnerAddressesDataReqObj object.
extraAttributes	object	ExtraAttributeDataReqObj object.

4.34 BizPartnerAddressesDataReqObj

BizPartnerAddressesDataReqObj object properties:

Name	Type	Description
data	array	An array of BizPartnerAddressPostData objects.

4.35 BizPartnerAddressPostData

BizPartnerAddressPostData object properties:

Name	Type	Description
addressTypeId	integer	Address type ID.
country	integer	Country code.
name	string	Name.
branchName	string	Branch name.
address	string	Address.
poBox	string	PO box.
postalCode	string	Postal code.
city	string	City.
province	string	Province.
attnPerson	string	Attn person.
latitude	number($float)	Address latitude.
longitude	number($float)	Address longitude.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
copyToAddresses	object	CopyAddressesCreateDataReqObj object.

4.36 ExtraAttributeDataReqObj

ExtraAttributeDataReqObj object properties:

Name	Type	Description
data	array	An array of BizPartnerExtraAttributes objects.

4.37 BizPartnerExtraAttributes

BizPartnerExtraAttributes object properties:

Name	Type	Description
attributeId	integer	Attribute/Custom Field ID.
attributeValue	string	Attribute value.
customAttrName	string	Custom attribute name.

4.38 CopyAddressesCreateDataReqObj

CopyAddressesCreateDataReqObj object properties:

Name	Type	Description
data	array	An array of BizPartnerAddressCopyCreateData objects.

4.39 BizPartnerAddressCopyCreateData

BizPartnerAddressCopyCreateData object properties:

Name	Type	Description
name	string	Business Partner name.
branchName	string	Branch name.
addressTypeId	integer	Address type ID.

4.40 BizPartnerLegalAddress

BizPartnerLegalAddress object properties:

Name	Type	Description
id	integer	Address ID.
bizPartnerId	integer	Business Partner ID.
bizPartnerName	string	Business Partner name.
bizPartnerBriefName	string	Business Partner brief name.
addressTypeId	integer	Address type ID.
addressTypeName	string	Address type name.
addressTypeCodeName	string	Address type code name.
branchName	string	Branch name.
country	integer	Country code.
countryName	string	Country name.
name	string	Business Partner name.
address	string	Business Partner address.
poBox	string	PO box.
postalCode	string	Postal code.
city	string	City.
province	string	Province.
attnPerson	string	Attn person.
latitude	string	Address latitude.
longitude	string	Address longitude.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
copyOfAddresses	array	An array of BizPartnerAddress object.

4.41 BizPartnerAddress

BizPartnerAddress object properties:

Name	Type	Description
id	integer	Business Partner address ID.
bizPartnerId	integer	Business Partner ID.
bizPartnerName	string	Business Partner name.
bizPartnerBriefName	string	Business Partner brief name.
addressTypeId	integer	Address type ID.
addressTypeName	string	Address type name.
addressTypeCodeName	string	Address type code name.
country	integer	Country code.
countryName	string	Country name.
name	string	Business Partner name.
branchName	string	Branch name.
address	string	Business Partner address.
poBox	string	PO box.
postalCode	string	Postal code.
city	string	City.
province	string	Province.
attnPerson	string	Attn person.
latitude	string	Address latitude.
longitude	string	Address longitude.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
copyToAddresses	array	An array of BizPartnerAddressCopy object.

4.42 BizPartnerAddressCopy

BizPartnerAddressCopy object properties:

Name	Type	Description
id	integer	Address ID.
name	string	Name.
branchName	string	Branch name.
addressTypeId	integer	Address type ID.

4.43 ExtraAttributesDataResponse

ExtraAttributesDataResponse object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerExtraAttributesRes objects.

4.44 BizPartnerExtraAttributesRes

BizPartnerExtraAttributesRes object properties:

Name	Type	Description
id	integer	Business Partner ID.
sectionId	integer	Section ID.
attributeId	integer	Attribute/Custom Field ID.
attributeName	string	Attribute name.
customAttrName	string	Custom attribute name.
attributeValue	string	Attribute value.
attributeCodeName	string	Attribute code name.
attributeTypeId	integer	Attribute type ID.

4.45 BizPartnerProductDataResponse

BizPartnerProductDataResponse object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerProduct objects.

4.46 BizPartnerProduct

BizPartnerProduct object properties:

Name	Type	Description
id	integer	BizPartnerProduct ID.
bizPartnerId	integer	Business Partner ID.
bizPartnerBriefName	string	Business Partner brief name.
productTypeName	string	Product type name.
productTypeCodeName	string	Product type code name.
productId	integer	Product ID.
productName	string	Product name.
productCodeName	string	Product code name.
relationTypeId	integer	Relation type ID.
relationTypeName	string	Relation type name.
relationTypeCodeName	string	Relation type code name.
status	string	Status.
enabledDt	string($date‑time)	Activation date and time.
disabledDt	string($date‑time)	Deactivation date and time.
statusDt	string($date‑time)	Status date and time.
notes	string	Notes.
customerType	string	Customer type.
accountManagerId	integer	Account Manager ID.
accountManagerName	string	Account Manager name.
serviceCategoryId	integer	Service category ID.
serviceProductName	string	Service product name.
productBulkSms	object	ProductBulkSMS object.

JSON Example

{
  "id": 0,
  "bizPartnerId": 0,
  "bizPartnerBriefName": "string",
  "productTypeName": "string",
  "productTypeCodeName": "string",
  "productId": 0,
  "productName": "string",
  "productCodeName": "string",
  "relationTypeId": 0,
  "relationTypeName": "string",
  "relationTypeCodeName": "string",
  "status": "string",
  "enabledDt": "2021-01-15T14:46:29.060Z",
  "disabledDt": "2021-01-15T14:46:29.060Z",
  "statusDt": "2021-01-15T14:46:29.060Z",
  "notes": "string",
  "customerType": "string",
  "accountManagerId": 0,
  "serviceCategoryId": 0,
  "serviceProductName": "string",
  "productBulkSms": {
    "id": 0,
    "bizpProductId": 0,
    "sellingPaymentType": "string",
    "sellingPaymentDue": 0,
    "validFromD": "2021-01-15",
    "billingCycle": 0,
    "billingCycleUnit": "string",
    "currencyId": 0,
    "invoiceTriggerAmount": 0,
    "overdraftLimit": 0,
    "creditLimit": 0,
    "deposit": 0,
    "bankGuarantee": 0,
    "disputePercent": 0,
    "maxDispute": 0,
    "announcementDays": 0,
    "currencyCode": "string",
    "currencyName": "string"
  }
}

4.47 ProductBulkSMS

ProductBulkSMS object properties:

Name	Type	Description
id	integer	Product ID.
bizpProductId	integer	Business Partner product ID.
sellingPaymentType	string	Selling payment type.
sellingPaymentDue	integer	Selling payment due period.
validFromD	string($data)	Valid from date.
billingCycle	integer	Billing cycle.
billingCycleUnit	string	Billing cycle unit. Possible values: Days, Months, Years, Weeks, Quarters, Semesters.
currencyId	integer	Currency ID.
invoiceTriggerAmount	number($float64)	Invoice trigger amount.
overdraftLimit	number($float64)	Overdraft limit.
creditLimit	number($float64)	Credit limit.
deposit	number($float64)	Deposit.
bankGuarantee	number($float64)	Bank guarantee amount.
disputePercent	number($float64)	Dispute percent.
maxDispute	number($float64)	Max dispute.
announcementDays	integer	Announcement days.
currencyCode	string	Currency code.
currencyName	string	Currency name.

4.48 BusinessPartnerUpdateData

BusinessPartnerUpdateData object properties:

Name	Type	Description
name	string	Business Partner name.
briefName	string	Business Partner brief name.
externalRefId	string	External reference ID.
country	integer	Country code.
vatNumber	string	VAT number.
vatApply	string	Possible values: yes, no.
regNumber	string	Registration number.
dunsNumber	string	DUNS number.
statusActiveDt	string($date‑time)	Date of active status.
legalFormId	integer	Legal form ID.
language	string	Language.
taxExempt	string	Tax exemption.
foundingD	string($date)	Founding date.
industryId	integer	Industry ID.
companySizeId	integer	Company size ID.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
isIntercompany	string	Possible values: yes, no.
partnerTypeId	integer	Partner type ID.
selfOwner	string	Possible values: yes, no.
ownerBpId	integer	Owner Business Partner ID.
extraAttributes	object	ExtraAttributeDataReqObj object.

4.49 PartnerCollection

PartnerCollection object properties:

Name	Type	Description
data (required)	array	An array of Partner object.

4.50 Partner

Partner object properties:

Name	Type	Description
id	integer	Partner ID.
name	string	Partner name.
country	integer	Country code.
vatNumber	string	VAT number.
vatApply	string	Possible values: yes, no, unknown.
regNumber	string	Registration number.
legalAddressId	integer	Legal address ID.
value	string	Value.
status	string	Possible values: potential, active, suspended, archived, deleted, misc, draft.
parentId	integer	Parent ID.
legalFormId	integer	Legal form ID.
language	string	Language.
bizPartnerUid	string	Biz Partner UID.
partnerDetailsId	integer	Partner's details ID.
briefName	string	Partner brief name.
notificationAddressId	integer	Notification address ID.
externalRefId	string	External reference ID.
partnerTypeId	integer	Partner type ID.
partnerTypeName	string	Partner type name.
statusActiveDt	string($date‑time)	Date of active status.
statusDt	string($date‑time)	Status date and time.

4.51 PartnerPut

PartnerPut object properties:

Name	Type	Description
name	string	maxLength: 150.
country	integer	Country code.
vatNumber	string	VAT number. maxLength: 30.
vatApply	string	Possible values: yes, no, unknown.
regNumber	string	Registration number. maxLength: 150.
legalFormId	integer	Legal form ID.
language	string	Language.
briefName	string	maxLength: 50.
externalRefId	string	External reference ID. maxLength: 100.
partnerTypeId	integer	Partner type ID.
isIntercompany	string	Possible values: yes, no.
dunsNumber	string	DUNS number. maxLength: 20.
taxExempt	string	Tax exemption.
foundingD	string($date)	Founding date.
industryId	integer	Industry ID.
companySizeId	integer	Company size ID.
eMail	string	E-mail. maxLength: 150.
phone	string	maxLength: 30.
fax	string	maxLength: 30.
creation	string	Possible values: manually, self_service.
selfOwner	string	Possible values: yes, no.
ownerBpId	integer	Owner Business Partner ID.

4.52 PartnerSectionCollection

PartnerSectionCollection object properties:

Name	Type	Description
data (required)	array	An array of PartnerSection objects.
meta (required)	object	CollectionMeta object.

4.53 PartnerSection

PartnerSection object properties:

Name	Type	Description
id	integer	PartnerSection ID.
codeName	string	Code name.
name	string	Name.
status	string	Possible values: active, inactive, deleted, misc.
statusDt	string($date‑time)	Status date and time.
dbCodeName	string	Code name.
comment	string	Comment.

4.54 AttributeCollection

AttributeCollection object properties:

Name	Type	Description
data (required)	array	An array of AttributeList objects.
meta (required)	object	CollectionMeta object.

4.55 AttributeList

AttributeList object properties:

Name	Type	Description
id	integer	Attribute list ID.
attributeTypeId	integer	Attribute type ID.
codeName	string	Code name.
name	string	Name.
status	string	Possible values: active, inactive, deleted, misc.
statusDt	string($date‑time)	Status date and time.
attributeKind	string	Possible values: predefined, registered. Defines if attribute is predefined (attributeKind=predefined e.g. "Note") or register i.e. custom field (attributeKind=registered).
sections	string	Sections.
sectionCodeNames	string	Sections code names.
attributeTypeCodeName	string	Attribute type code name.
attributeTypeName	string	Attribute type name.
canBeDeleted	boolean	If attribute list can be deleted.
canCodeNameChange	boolean	Value if code name can change.

4.56 Attribute

Attribute object properties:

Name	Type	Description
id	integer	Attribute/Custom Field ID.
attributeTypeId	integer	Attribute type ID.
codeName	string	Attribute code name. Attribute that is created as custom field will have code name prefix 'ATTR-'.
name	string	Name.
status	string	Attribute status. Possible values: active, inactive, deleted, misc.
statusDt	string($date‑time)	Status date and time.
attributeKind	string	Possible values: predefined, registered. Defines if attribute is predefined (attributeKind=predefined e.g. "Note") or register i.e. custom field (attributeKind=registered).
attributeTypeCodeName	string	Attribute type code name.
attributeTypeName	string	Attribute type name.
canBeDeleted	boolean	If attribute can be deleted.
canCodeNameChange	boolean	Value if code name can change.
attributeSections	array	An array of AttributeSection objects.

4.57 AttributeSection

AttributeSection object properties:

Name	Type	Description
attributeId	integer	Attribute/Custom Field ID.
sectionId	integer	Section ID.
status	string	Possible values: active, inactive, deleted.
statusDt	string($date‑time)	Status date and time.
sectionCodeName	string	Section code name.
sectionName	string	Section name.
dbCodeName	string	Code name.
sectionStatus	string	Possible values: active, inactive, deleted.
attributeStatus	string	Attribute status.
attributeSectionTags	array	An array of BizAttributeSectionTag objects.

4.58 AttributePost

AttributePost object properties:

Name	Type	Description
attributeTypeId (required)	integer	Attribute/Custom Field type ID.
codeName (required)	string	Code name. maxLength: 30.
name (required)	string	Name. maxLength: 50.

4.59 AttributePut

AttributePut object properties:

Name	Type	Description
attributeTypeId	integer	Attribute/Custom Field type ID.
codeName	string	Code name. maxLength: 30.
name	string	maxLength: 50.
status	string	Possible values: active, inactive.

JSON Example

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

4.60 AllProductCollection

AllProductCollection object properties:

Name	Type	Description
data (required)	array	An array of AllProduct objects.
meta (required)	object	CollectionMeta object.

4.61 AllProduct

AllProduct object properties:

Name	Type	Description
id	integer	AllProduct ID.
productType	integer	Product type.
name	string	Name.
codeName	string	Code name.
status	string	Possible values: active, inactive.
statusDt	string($date‑time)	Status date and time.

4.62 ProductCollection

ProductCollection object properties:

Name	Type	Description
data (required)	array	An array of ProductList objects.
meta (required)	object	CollectionMeta object.

4.63 ProductList

ProductList object properties:

Name	Type	Description
id	integer	ProductList ID.
productType	integer	Product type.
name	string	Name.
codeName	string	Code name.
status	string	Possible values: active, inactive, deleted.
statusDt	string($date‑time)	Status date and time.
productTypeName	string	Product type name.
productTypeCodeName	string	Product type code name.
isOurProduct	string	Possible values: yes, no.
isSupplierProduct	string	Possible values: yes, no.
productContextStatus	string	Product context status.

4.64 BizPartnerProductCreate

BizPartnerProductCreate object properties:

Name	Type	Description
productType	integer	Product type.
productId	integer	Product ID.
relationTypeId	integer	Relation type ID.
status	string	Status.
notes	string	Notes.
customerType	string	Customer type.
accountManagerId	integer	Account Manager ID.
productBulkSms	object	ProductBulkSMSCreate object.

4.65 ProductBulkSMSCreate

ProductBulkSMSCreate object properties:

Name	Type	Description
sellingPaymentType	string	Possible values: prepaid, postpaid, none.
sellingPaymentDue	integer	Selling payment due period.
validFromD	string($date)	Valid from date.
billingCycle	integer	Billing cycle.
billingCycleUnit	string	Possible values: Days, Months, Years, Weeks, Quarters, Semesters.
currencyId	integer	Currency ID.
invoiceTriggerAmount	number($float64)	Invoice trigger amount.
overdraftLimit	number($float64)	Overdraft limit.
creditLimit	number($float64)	Credit limit.
deposit	number($float64)	Deposit.
bankGuarantee	number($float64)	Bank guarantee amount.
disputePercent	number($float64)	Dispute percent.
maxDispute	number($float64)	Max dispute.
announcementDays	integer	Announcement days.

4.66 BizPartnerProductUpdate

BizPartnerProductUpdate object properties:

Name	Type	Description
productType	integer	Product type.
productId	integer	Product ID.
relationTypeId	integer	Relation type ID.
status	string	Status.
notes	string	Notes.
customerType	string	Customer type. Possible values: enterprise, wholesale, inter-company.
accountManagerId	integer	Account Manager ID.
productBulkSms	object	ProductBulkSMSUpdate object.

4.67 ProductBulkSMSUpdate

ProductBulkSMSUpdate object properties:

Name	Type	Description
sellingPaymentType	string	Possible values: prepaid, postpaid, none.
sellingPaymentDue	integer	Selling payment due period.
validFromD	string($date)	Valid from date.
billingCycle	integer	Billing cycle.
billingCycleUnit	string	Possible values: Days, Months, Years, Weeks, Quarters, Semesters.
currencyId	integer	Currency ID.
invoiceTriggerAmount	number($float64)	Invoice trigger amount.
overdraftLimit	number($float64)	Overdraft limit.
creditLimit	number($float64)	Credit limit.
deposit	number($float64)	Deposit.
bankGuarantee	number($float64)	Bank guarantee amount.
disputePercent	number($float64)	Dispute percent.
maxDispute	number($float64)	Max dispute.
announcementDays	integer	Announcement days.

4.68 BizPartnerAllowedProductCollection

BizPartnerAllowedProductCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerAllowedProduct objects.
meta (required)	object	CollectionMeta object.

4.69 BizPartnerAllowedProduct

BizPartnerAllowedProduct object properties:

Name	Type	Description
id	integer	BizPartnerAllowedProduct ID.
name	string	Name.
codeName	string	Code name.
productTypeId	integer	Product type id.
productTypeName	string	Product type name.
productTypeCodeName	string	Product type code name.

4.70 BizPartnerProductCollection

BizPartnerProductCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerProduct objects.
meta (required)	object	CollectionMeta object.

4.71 BizPartnerProduct

BizPartnerProduct object properties:

Name	Type	Description
id	integer	BizPartnerProduct ID.
bizPartnerId	integer	Business Partner ID.
bizPartnerBriefName	string	Business Partner brief name.
productTypeName	string	Product type name.
productTypeCodeName	string	Product type code name.
productId	integer	Product ID.
productName	string	Product name.
productCodeName	string	Product code name.
relationTypeId	integer	Relation type ID.
relationTypeName	string	Relation type name.
relationTypeCodeName	string	Relation type code name.
status	string	Status.
enabledDt	string($date‑time)	Activation date and time.
disabledDt	string($date‑time)	Deactivation date and time.
statusDt	string($date‑time)	Status date and time.
notes	string	Notes.
customerType	string	Customer type.
accountManagerId	integer	Account Manager ID.
accountManagerName	string	Account Manager name.
serviceCategoryId	integer	Service category ID.
serviceProductName	string	Service product name.
productBulkSms	object	ProductBulkSMS object.

4.72 BizpProductCollection

BizpProductCollection object properties:

Name	Type	Description
data (required)	array	An array of BizpProductList objects.
meta (required)	object	CollectionMeta object.

4.73 BizpProductList

BizpProductList object properties:

Name	Type	Description
id	integer	BizpProductList ID.
instanceId	integer	Instance ID.
bizPartnerId	integer	Business Partner ID.
bizPartnerName	string	Business Partner name.
productType	integer	Product type.
productTypeName	string	Product type name.
productTypeCodeName	string	Product type code name.
productName	string	Product name.
productCodeName	string	Product code name.
productId	integer	Product ID.
relationTypeId	integer	Relation type ID.
relationTypeCodeName	string	Relation type code name.
relationType	string	Relation type.
status	string	Status.
statusDt	string($date‑time)	Status date and time.
enabledDt	string($date‑time)	Activation date and time.
disabledDt	string($date‑time)	Deactivation date and time.
notes	string	Notes.
customerType	string	Customer type.
accountManagerId	integer	Account Manager ID.
accountManagerName	string	Account Manager name.
serviceCategoryId	integer	Service category ID.
serviceCategoryName	string	Service category name.
serviceProductName	string	Service product name.

4.74 AccountManagerData

AccountManagerData object properties:

Name	Type	Description
Name	Type	Description
id	integer	AccountManagerData ID.
instanceId	integer	Instance ID.
email	string	E-mail.
name	string	Name.
status	string	Possible values: active, inactive, deleted.
statusDt	string($date‑time)	Status date and time.
accountMgrProduct	array	An array of AccountMgrProduct objects.

4.75 AccountMgrProduct

AccountMgrProduct objects properties:

Name	Type	Description
id	integer	AccountMgrProduct ID.
accountMgrId	integer	Account Manager ID.
productId	integer	Product ID.
productType	integer	Product type.
status	string	Possible values: active, inactive, deleted.
statusDt	string($date‑time)	Status date and time.
productName	string	Product name.
productCodeName	string	Product code name.
productTypeName	string	Product type name.
productTypeCodeName	string	Product type code name.
isOurProduct	string	Possible values: yes, no.
isSupplierProduct	string	Possible values: yes, no.

4.76 AccountManagerCollection

AccountManagerCollection object properties:

Name	Type	Description
data (required)	array	An array of AccountManagerDataList objects.
meta (required)	object	CollectionMeta object.

4.77 AccountManagerDataList

AccountManagerDataList object properties:

Name	Type	Description
id	integer	AccountManagerDataList ID.
instanceId	integer	Instance ID.
email	string	E-mail.
name	string	Name.
status	string	Possible values: active, inactive, deleted.
statusDt	string($date‑time)	Status date and time.
products	string	Products.
productCodeNames	string	Product code name.

4.78 AccountManagerPost

AccountManagerPost object properties:

Name	Type	Description
name (required)	string	Account Manager name.
email (required)	string	E-mail.
accountMgrProducts	array	An array of AccountMgrProductRequestData objects.

4.79 AccountMgrProductRequestData

AccountMgrProductRequestData object properties:

Name	Type	Description
productId	integer	Product ID.

4.80 PartnerAttributeCollection

PartnerAttributeCollection object properties:

Name	Type	Description
data (required)	array	An array of PartnerAttribute objects.
meta (required)	object	CollectionMeta object.

4.81 PartnerAttribute

PartnerAttribute object properties:

Name	Type	Description
id	integer	Partner Attribute/Custom Field ID.
sectionId	integer	Section ID.
sectionRowId	integer	Section row ID.
attributeId	integer	Attribute/Custom Field ID.
bizPartnerId	integer	Business Partner ID.
customAttrName	string	Custom attribute name.
attributeValue	string	Attribute value.
jsonValue	object	{value: string($JSON)}.
valueType	string	Possible values: simple, json.
status	string	Possible values: active, deleted.
statusDt	string($date‑time)	Status date and time.
sectionCodeName	string	Section code name.
sectionName	string	Section name.
dbCodeName	string	Code name.
attributeCodeName	string	Attribute code name.
attributeName	string	Attribute name.
attributeTypeCodeName	string	Attribute type code name.
attributeTypeName	string	Attribute type name.
canBeChanged	boolean	If it can be changed.

4.82 PartnerAttributePut

PartnerAttributePut object properties:

Name	Type	Description
sectionId	integer	Section ID.
sectionRowId	integer	Section row ID.
attributeId	integer	Attribute/Custom Field ID.
bizPartnerId	integer	Business Partner ID.
customAttrName	string	maxLength: 50.
attributeValue	string	maxLength: 255.
jsonValue	object	{value: string($JSON)}.

4.83 PartnerAttributePost

PartnerAttributePost object properties:

Name	Type	Description
sectionId	integer	Section ID.
sectionRowId	integer	Section row ID.
attributeId	integer	Attribute/Custom Field ID.
bizPartnerId	integer	Business Partner ID.
customAttrName	string	maxLength: 255.
attributeValue	string	maxLength: 255.
jsonValue	object	{value: string($JSON)}.

4.84 PartnerAttributeExtendCollection

PartnerAttributeExtendCollection object properties:

Name	Type	Description
data (required)	array	An array of PartnerAttributeExtend objects.
meta (required)	object	CollectionMeta object.

4.85 PartnerAttributeExtend

PartnerAttributeExtend object properties:

Name	Type	Description
id	integer	PartnerAttributeExtend ID.
sectionId	integer	Section ID.
sectionRowId	integer	Section row ID.
attributeId	integer	Attribute/Custom Field ID.
bizPartnerId	integer	Business Partner ID.
customAttrName	string	Custom attribute name.
attributeValue	string	Attribute value.
jsonValue	object	{value: string($JSON)}.
status	string	Possible values: active, deleted.
statusDt	string($date‑time)	Status date and time.
sectionCodeName	string	Section code name.
sectionName	string	Section name.
dbCodeName	string	Code name.
attributeCodeName	string	Attribute code name.
attributeName	string	Attribute name.
attributeTypeCodeName	string	Attribute type code name.
attributeTypeName	string	Attribute type name.
attributeTagCodeName	string	Attribute tag code name.
attributeTagName	string	Attribute tag name.
canBeChanged	boolean	If it can be changed.

4.86 AttributeSectionPut

AttributeSectionPut object properties:

Name	Type	Description
status	string	Possible values: active, inactive.

4.87 AttributeSectionPost

AttributeSectionPost object properties:

Name	Type	Description
sectionId	integer	Section ID.

4.88 AttributePartnerCollection

AttributePartnerCollection object properties:

Name	Type	Description
data (required)	array	An array of AttributePartner objects.
meta (required)	object	CollectionMeta object.

4.89 AttributePartner

AttributePartner object properties:

Name	Type	Description
partnerId	integer	Partner ID.
partnerName	string	Partner name.
partnerBriefName	string	Partner brief name.
partnerStatus	string	Partner status.

4.90 AttributeCodeName

AttributeCodeName object properties:

Name	Type	Description
codeName	string	Code name.

4.91 AttributeCodeNamePost

AttributeCodeNamePost object properties:

Name	Type	Description
name	string	AttributeCodeName name.

4.92 AttributeTypeCollection

AttributeTypeCollection object properties:

Name	Type	Description
data (required)	array	An array of AttributeType objects.
meta (required)	object	CollectionMeta object.

4.93 AttributeType

AttributeType object properties:

Name	Type	Description
id	integer	Attribute/Custom Field type ID.
codeName	string	Code name.
name	string	Name.
allCustomAttrs	string	Possible values: yes, no. For allCustomAttrs=yes it will return all custom attributes (custom fields).
status	string	Possible values: active, inactive, deleted, misc.
statusDt	string($date‑time)	Status date and time.

4.94 BizPartnerLogoCollection

BizPartnerLogoCollection object properties:

Name	Type	Description
data (required)	array	An array of DocLogoFile objects.
meta (required)	object	CollectionMeta object.

4.95 BizPartnerContactPostData

BizPartnerContactPostData object properties:

Name	Type	Description
firstName	string	BizPartnerContact first name.
lastName	string	BizPartnerContact last name.
nickName	string	BizPartnerContact nickname.
salutation	string	Salutation.
titel	string	Titel.
gender	string	Gender.
language	string	Language.
eMailBusiness	string	Business E-mail.
eMailPrivate	string	Private E-mail.
phoneOfficeDirect	string	Phone office direct.
phoneOfficeCentral	string	Phone office central.
mobile	string	Mobile.
mobileBusiness	string	Contact business mobile.
skype	string	Contact skype.
birthday	string($date)	Birthday.
contactTypeId	integer	Contact type ID.
customTypeName	string	Custom type name.
departmentId	integer	Department ID.
positionId	integer	Position ID.
customPositionName	string	Custom position name.
fax	string	Fax.
address	string	Business Partner contact address.
postalCode	string	Postal code.
city	string	City.
countryId	integer	Country ID.
extraAttributes	object	ExtraAttributeDataReqObj.

4.96 BizPartnerContactStatusPutData

BizPartnerContactStatusPutData object properties:

Name	Type	Description
status	string	Possible values: active, inactive.

4.97 BizPartnerContactUpdateDP

BizPartnerContactUpdateDP object properties:

Name	Type	Description
departments	array	An array of DepartmentDataReqObj objects.
positions	array	An array of PositionDataReqObj objects.

4.98 DepartmentDataReqObj

DepartmentDataReqObj object properties:

Name	Type	Description
id	integer	Department ID.

4.99 PositionDataReqObj

PositionDataReqObj object properties:

Name	Type	Description
id	integer	Position ID.

4.100 BizPartnerContactPutData

BizPartnerContactPutData object properties:

Name	Type	Description
firstName	string	BizPartnerContact first name.
lastName	string	BizPartnerContact last name.
nickName	string	BizPartnerContact nickname.
salutation	string	Salutation.
titel	string	Titel.
gender	string	Gender.
language	string	Language.
eMailBusiness	string	Business E-mail.
eMailPrivate	string	Private E-mail.
phoneOfficeDirect	string	Phone office direct.
phoneOfficeCentral	string	Phone office central.
mobile	string	Mobile.
mobileBusiness	string	Contact business mobile.
skype	string	Contact skype.
birthday	string($date)	Birthday.
contactTypeId	integer	Contact type ID.
customTypeName	string	Custom type name.
departmentId	integer	Department ID.
positionId	integer	Position ID.
customPositionName	string	Custom position name.
fax	string	Fax.
address	string	Address.
postalCode	string	Postal code.
city	string	City.
countryId	integer	Country ID.
extraAttributes	object	ExtraAttributesUpdateData.

4.101 ExtraAttributesUpdateData

ExtraAttributesUpdateData object properties:

Name	Type	Description
data	array	An array of BizPartnerExtraAttributesUpdate objects.

4.102 BizPartnerExtraAttributesUpdate

BizPartnerExtraAttributesUpdate object properties:

Name	Type	Description
id	integer	BizPartnerExtraAttributes ID.
attributeId	integer	Attribute/Custom Field ID.
attributeValue	string	Attribute value.
customAttrName	string	Custom attribute name.

4.103 BizPartnerContactCollection

BizPartnerContactCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerContact objects.
meta (required)	object	CollectionMeta object.

4.104 BizPartnerContact

BizPartnerContact object properties:

Name	Type	Description
id	integer	BizPartnerContact ID.
bizPartnerId	integer	Business Partner ID.
contactTypeId	integer	Contact type ID.
customTypeName	string	Custom type name.
firstName	string	BizPartnerContact first name.
lastName	string	BizPartnerContact last name.
nickName	string	BizPartnerContact nickname.
salutation	string	Possible values: formal, informal.
titel	string	Titel.
gender	string	Possible values: male, female, unknown.
language	string	Language.
addressId	integer	Address ID.
eMailBusiness	string	Business E-mail.
eMailPrivate	string	Private E-mail.
phoneOfficeDirect	string	Phone office direct.
phoneOfficeCentral	string	Phone office central.
mobile	string	Mobile.
mobileBusiness	string	Contact business mobile.
skype	string	Contact skype.
birthday	string($date)	Birthday.
departmentId	integer	Department ID.
positionId	integer	Position ID.
customPositionName	string	Custom position name.
picture	string	Picture.
fax	string	Fax.
status	string	Possible values: active, inactive.
statusDt	string($date‑time)	Status date and time.
address	string	Business Partner contact address.
postalCode	string	Postal code.
city	string	City.
countryId	integer	Country ID.
countryName	string	Country name.
contactTypeName	string	Country type name.
partnerName	string	Partner name.
languageName	string	Language.
partnerBriefName	string	Partner brief name.
departmentName	string	Department name.
positionName	string	Position name.
note	string	Note.
extraAttributes	object	ExtraAttributesDataResponse object.

4.105 BizPartnerAddressCollection

BizPartnerAddressCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerAddress objects.
meta (required)	object	CollectionMeta object.

4.106 BizPartnerAddressPutData

BizPartnerAddressPutData object properties:

Name	Type	Description
addressTypeId	integer	Address type ID.
country	integer	Country code.
name	string	Name.
branchName	string	Branch name.
address	string	Address.
poBox	string	PO box.
postalCode	string	Postal code.
city	string	City.
province	string	Province
attnPerson	string	Attn person.
latitude	number($float)	Address latitude.
longitude	number($float)	Address longitude.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
copyToAddresses	object	CopyAddressesUpdateDataReqObj object.

4.107 CopyAddressesUpdateDataReqObj

CopyAddressesUpdateDataReqObj object properties:

Name	Type	Description
data	array	An array of BizPartnerAddressCopyUpdateData objects.

4.108 BizPartnerAddressCopyUpdateData

BizPartnerAddressCopyUpdateData object properties:

Name	Type	Description
id	integer	BizPartnerAddressCopy ID.
name	string	Name.
branchName	string	Branch name.
addressTypeId	integer	Address type ID.

4.109 BizContactTypeCollection

BizContactTypeCollection object properties:

Name	Type	Description
data (required)	array	An array of BizContactType objects.
meta (required)	object	CollectionMeta object.

4.110 BizContactType

BizContactType object properties:

Name	Type	Description
id	integer	BizContactType ID.
codeName	string	Code name.
name	string	Name.
status	string	Possible values: active, inactive, deleted, misc.

4.111 RelationTypesCollection

RelationTypesCollection object properties:

Name	Type	Description
data (required)	array	An array of BizRelationType objects.
meta (required)	object	CollectionMeta object.

4.112 BizRelationType

BizRelationType object properties:

Name	Type	Description
id	integer	BizRelationType ID.
codeName	string	Code name.
relationType	string	Relation type.

4.113 BizPartnerStatus

BizPartnerStatus object properties:

Name	Type	Description
partnerStatus	string	Possible values: active, potential, archived, misc, suspended, draft.
partnerStatusCount	integer	A number of Business Partners with the given status.

4.114 ContextOwner

ContextOwner object properties:

Name	Type	Description
id	integer	ContextOwner ID.
name	string	ContextOwner name.
instanceRole	string	Instance role.
country	integer	Country code.
countryName	string	Country name.
vatNumber	string	VAT number.
vatApply	string	Possible value: yes, no.
regNumber	string	Registration number.
legalAddressId	integer	Legal address ID.
status	string	Status.
parentId	integer	Parent ID.
legalFormId	integer	Legal form ID.
language	string	Language.
languageName	string	Language name.
legalForm	string	Legal form.
briefName	string	Brief name.
detailsId	integer	Details ID.
hasAttributes	string	Possible value: no, yes.
externalRefId	string	External reference ID.
statusActiveDt	string($date)	Date of active status.
statusDt	string($date‑time)	Status date and time.
industryId	integer	Industry ID.
companySizeId	integer	Company size ID.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
taxExempt	string	Tax exemption.
foundingD	string($date)	Founding date.
dunsNumber	string	DUNS number.
industryName	string	Industry name.
companySize	string	Company size.
instanceOwnerName	string	Instance owner name.
bizPartnerInstanceUid	string	Business Partner instance UID.
isIntercompany	string	Possible value: no, yes.
partnerTypeId	integer	Partner type ID.
partnerTypeName	string	Partner type name.
ownerBpId	integer	Owner Business Partner ID.
ownerBpName	string	Business Partner name.
ownerBpBriefName	string	Business Partner brief name.
selfOwner	string	Possible value: yes, no.

4.115 BizPartnerStatCollection

BizPartnerStatCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerStat objects.
meta (required)	object	CollectionMeta object.

4.116 BizPartnerStat

BizPartnerStat object properties:

Name	Type	Description
relationType	string	Relation type.
productInfo	array	An array of BizPartnerStatProduct object.

4.117 BizPartnerStatProduct

BizPartnerStatProduct object properties:

Name	Type	Description
product	string	BizPartnerStatProduct name.
productCount	integer	BizPartnerStatProduct count.

4.118 BizPartnerLovCollection

BizPartnerLovCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerLov objects.
meta (required)	object	CollectionMeta object.

4.119 BizPartnerLov

BizPartnerLov object properties:

Name	Type	Description
id	integer	BizPartnerLov ID.
name	string	BizPartnerLov name.
briefName	string	Business Partner brief name.
city	string	City.
postalCode	string	Postal code.
code2	string	Code2.
externalRefId	string	External reference ID.

4.120 ProductTypePartnersLovCollection

ProductTypePartnersLovCollection object properties:

Name	Type	Description
data (required)	array	An array of ProductTypePartnersLov objects.
meta (required)	object	CollectionMeta object.

4.121 ProductTypePartnersLov

ProductTypePartnersLov object properties:

Name	Type	Description
id	integer	ProductTypePartnersLov ID.
name	string	ProductTypePartnersLov name.
instanceRole	string	Instance role.
country	integer	Country code.
countryName	string	Country name.
vatNumber	string	VAT number.
vatApply	string	Possible values: yes, no, unknown.
regNumber	string	Registration number.
legalAddressId	integer	Legal address ID.
status	string	Status.
parentId	integer	Parent ID.
legalFormId	integer	Legal form ID.
language	string	Language.
languageName	string	Language name.
legalForm	string	Legal form.
instanceOwnerName	string	Instance owner name.
briefName	string	Brief name.
detailsId	integer	Details ID.
hasAttributes	string	Possible values: yes, no.
externalRefId	integer	External reference ID.
bizPartnerInstanceUid	string	BizPartnerInstance UID.
statusActiveDt	string($date‑time)	Date of active status.
statusDt	string($date‑time)	Status date and time.
industryId	integer	Industry ID.
companySizeId	integer	Company size ID.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
taxExempt	string	Tax exemption.
foundingD	string($date‑time)	Founding date and time.
dunsNumber	string	DUNS number.
industryName	string	Industry name.
companySize	string	Company size.
ownerBpId	integer	Owner Business Partner ID.
ownerBpName	string	Business Partner name.
ownerBpBriefName	string	Business Partner brief name.
selfOwner	string	Possible values: yes, no.
isIntercompany	string	Possible values: yes, no.
partnerTypeId	integer	Partner type ID.
partnerTypeName	string	Partner type name.

4.122 ProductFeatureCollection

ProductFeatureCollection object properties:

Name	Type	Description
data (required)	array	An array of ProductFeature objects.
meta (required)	object	CollectionMeta object.

4.123 ProductFeature

ProductFeature object properties:

Name	Type	Description
id	integer	ProductFeature ID.
productId	integer	Product ID.
codeName	string	Code name.
name	string	Name.
status	string	Status.
productName	string	Product name.
productCodeName	string	Product code name.

JSON Example

{
  "id": 0,
  "productId": 0,
  "codeName": "string",
  "name": "string",
  "status": "string",
  "productName": "string",
  "productCodeName": "string"
}

4.124 FinanceSettingsPutData

FinanceSettingsPutData object properties:

Name	Type	Description
partnerInDraft	string	Possible values: yes, no.
nettingPartner	string	Possible values: yes, no.
hardCopyAddressIsDefault	Possible values: yes, no.
invoiceAddressId	integer	Invoice address ID.
emailContact	object	EmailContactFinanceSettings object

4.125 EmailContactFinanceSettings

EmailContactFinanceSettings object properties:

Name	Type	Description
emailAccountId	integer	E-mail account ID.
emailAddresses	array	An array of EmailAddressFinanceSettings objects.

4.126 EmailAddressFinanceSettings

EmailAddressFinanceSettings object properties:

Name	Type	Description
addressType	string	Possible values: to, cc, bcc.
eMail	string($email)	E-mail.

4.127 FinanceSettings

FinanceSettings object properties:

Name	Type	Description
id	integer	FinanceSettings ID.
productType	string	Product type.
productId	integer	Product ID.
invoiceAddressId	integer	Invoice address ID.
invoiceAddressIsDefault	string	Possible values: yes, no.
emailContactId	integer	E-mail contact ID.
emailAddressIsDefault	string	Possible values: yes, no.
hardCopyAddressId	integer	Address ID for hardcopy.
hardCopyAddressIsDefault	string	Possible values: yes, no.
nettingPartner	string	Possible values: yes, no.
emailAccountId	integer	E-mail account ID.
smtpAccount	string	SMTP account.
emailAddressTO	string($email)	E-mail TO address.
emailAddressCC	string($email)	E-mail CC address.
emailAddressBcc	string($email)	E-mail BCC address.

4.128 ProductTypeCollection

ProductTypeCollection object properties:

Name	Type	Description
data (required)	array	An array of ProductType objects.
meta (required)	object	CollectionMeta object.

4.129 ProductType

ProductType object properties:

Name	Type	Description
id	integer	Product type ID.
name	string	Product type name.
codeName	string	Code name.
status	string	Possible values: active.
statusDt	string($date‑time)	Status date and time.

4.130 EmailAccountCollection

EmailAccountCollection object properties:

Name	Type	Description
data (required)	array	An array of EmailAccount objects.
meta (required)	object	CollectionMeta object.

4.131 EmailAccount

EmailAccount object properties:

Name	Type	Description
id	integer	EmailAccount ID.
name	string	Name.
canReceive	string	Possible values: yes, no.
inHost	string	IMAP host name.
inPort	integer	IMAP port.
inSecurity	string	Optional security method like TLS or SSL.
canSend	string	Possible values: yes, no.
outHost	string	SMTP host name.
outPort	integer	SMTP port.
outSecurity	string	Optional security method like TLS or SSL.
status	string	Possible values: yes, no.
statusDt	string($date‑time)	Status date and time.

4.132 FinanceEmailAddressCollection

FinanceEmailAddressCollection object properties:

Name	Type	Description
data (required)	array	An array of FinanceEmailAddress objects.
meta (required)	object	CollectionMeta object.

4.133 FinanceEmailAddress

FinanceEmailAddress object properties:

Name	Type	Description
id	integer	FinanceEmailAddress ID.
emailContactId	integer	E-mail contact ID.
addressType	string	Address type.
eMail	string	E-mail.
bizPartnerId	integer	Business Partner ID.
bizPartnerBriefName	string	Business Partner brief name.

4.134 ServiceCategoryCollection

ServiceCategoryCollection object properties:

Name	Type	Description
data (required)	array	An array of ServiceCategory objects.
meta (required)	object	CollectionMeta object.

4.135 ServiceCategory

ServiceCategory object properties:

Name	Type	Description
id	integer	ServiceCategory ID.
category	string	Category.

4.136 BizPositionCollection

BizPositionCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPosition objects.
meta (required)	object	CollectionMeta object.

4.137 BizPosition

BizPosition object properties:

Name	Type	Description
id	integer	Biz Position ID.
name	string	Biz Position Name.
codeName	string	Biz Position Code name.
status	string	Biz Position status. Possible values: active, inactive.
statusDt	string($date‑time)	Status date and time.
canBeDeleted	boolean	If Biz Position can be deleted.
favorite	string	Possible values: yes, no.

4.138 BizPositionPost

BizPositionPost object properties:

Name	Type	Description
name (required)	string	Biz Position Name. maxLength: 50.
favorite	string	Possible values: yes, no.

4.139 BizPositionPut

BizPositionPut object properties:

Name	Type	Description
name	string	Biz Position Name. maxLength: 50.
status	string	Possible values: active, inactive.
favorite	string	Possible values: yes, no.

4.140 MeasureUnitCollection

MeasureUnitCollection object properties:

Name	Type	Description
data (required)	array	An array of MeasureUnit objects.
meta (required)	object	CollectionMeta object.

4.141 MeasureUnit

MeasureUnit object properties:

Name	Type	Description
id	integer	Measure Unit ID.
name	string	Measure Unit name.
code	string	Measure Unit code.
type	string	Measure Unit type.
ordNum	integer	Measure Unit ordinal number.
baseUnitId	integer	Base unit ID.
baseNumerator	integer	Base numerator.
baseDenominator	integer	Base denominator.

4.142 LanguageCollection

LanguageCollection object properties:

Name	Type	Description
data (required)	array	An array of Language objects.
meta (required)	object	CollectionMeta object.

4.143 Language

Language object properties:

Name	Type	Description
id	string	Language ID. maxLength: 2.
name	string	Language name.
status	string	Possible values: A, N.
statusDt	string($date‑time)	Status date and time.

4.144 BizPartnerCountryCollection

BizPartnerCountryCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerCountry objects.
meta (required)	object	CollectionMeta object.

4.145 BizPartnerCountry

BizPartnerCountry object properties:

Name	Type	Description
id	integer	Business Partner country ID.
name	string	Business Partner country name.

4.146 CountryCollection

CountryCollection object properties:

Name	Type	Description
data (required)	array	An array of Country objects.
meta (required)	object	CollectionMeta object.

4.147 Country

Country object properties:

Name	Type	Description
id	integer	Country ID.
name	string	Country name.
code2	string	Country code.
code3	string	Country code.
type	string	Possible values: formal, undefined, virtual, informal.
currency	integer	Country currency.
defLang	string	Default language. maxLenght: 2.
status	string	Possible values: A, N.
statusDt	string($date‑time)	Status date and time.
domain	string	maxLenght: 5.
dialCode	string	maxLenght: 10.
continent	string	maxLenght: 2.
defTaxCategoryId	integer	Deferred tax category.
cashRounding	number($float)	Rounding.

4.148 CurrencyCollection

CurrencyCollection object properties:

Name	Type	Description
data (required)	array	An array of Currency objects.
meta (required)	object	CollectionMeta object.

4.149 Currency

Currency object properties:

Name	Type	Description
id	integer	Currency ID.
name	string	Currency name.
code	string	Currency code.
status	string	maxLength: 1.
statusDt	string($date‑time)	Status date and time.
type	string	Possible values: formal, internal, virtual, informal.

4.150 LegalFormCollection

LegalFormCollection object properties:

Name	Type	Description
data (required)	array	An array of LegalForm objects.
meta (required)	object	CollectionMeta object.

4.151 LegalForm

LegalForm object properties:

Name	Type	Description
id	integer	Legal form ID.
countryId	integer	Country ID.
legalForm	string	Legal form name.
status	string	Possible values: active, inactive, deleted.
statusDt	string($date‑time)	Status date and time.

4.152 BizDepartmentCollection

BizDepartmentCollection object properties:

Name	Type	Description
data (required)	array	An array of BizDepartment objects.
meta (required)	object	CollectionMeta object.

4.153 BizDepartment

BizDepartment object properties:

Name	Type	Description
id	integer	Business department ID.
name	string	Business department name.
status	string	Possible values: active, inactive.
statusDt	string($date‑time)	Status date and time.
canBeDeleted	boolean	If Business department can be deleted.
favorite	string	Possible values: yes, no.

4.154 AccountManagersLovCollection

AccountManagersLovCollection object properties:

Name	Type	Description
data (required)	array	An array of AccountManagersLov objects.
meta (required)	object	CollectionMeta object.

4.155 AccountManagersLov

AccountManagersLov object properties:

Name	Type	Description
id	integer	Account Manager ID.
name	string	Account Manager name.

4.156 AddressTypeCollection

AddressTypeCollection object properties:

Name	Type	Description
data (required)	array	An array of AddressType objects.
meta (required)	object	CollectionMeta object.

4.157 AddressType

AddressType object properties:

Name	Type	Description
id	integer	Address type ID.
name	string	Address type name.

4.158 BizPartnerActiveLovCollection

BizPartnerActiveLovCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerActiveLov objects.
meta (required)	object	CollectionMeta object.

4.159 BizPartnerActiveLov

BizPartnerActiveLov object properties:

Name	Type	Description
id	integer	BizPartnerActiveLov ID.
instanceOwnerName	string	Instance owner name.
externalRefId	string	External reference ID.
name	string	Business Partner name.
briefName	string	Business Partner brief name.
country	integer	Country code.
countryName	string	Country name.
vatNumber	string	VAT number.
vatApply	string	Possible values: yes, no, unknown.
regNumber	string	Registration number.
dunsNumber	string	DUNS number.
status	string	Status.
parentId	string	Parent ID.
statusDt	string($date‑time)	Status date and time.
statusActiveDt	string($date‑time)	Date of active status.
legalAddressId	integer	Legal address ID.
legalFormId	integer	Legal form ID.
legalForm	string	Legal form.
language	string	Language.
languageName	string	Language name.
taxExempt	string	Tax exemption.
foundingD	string	Founding date.
industryId	integer	Industry ID.
companySizeId	integer	Company size ID.
eMail	string	E-mail.
phone	string	Phone.
fax	string	Fax.
industryName	string	Industry name.
companySize	string	Company size.

4.160 AccountManagersPartnerLovCollection

AccountManagersPartnerLovCollection object properties:

Name	Type	Description
data (required)	array	An array of AccountManagersPartnerLov objects.
meta (required)	object	CollectionMeta object.

4.161 AccountManagersPartnerLov

AccountManagersPartnerLov object properties:

Name	Type	Description
id	integer	AccountManagersPartnerLov ID.
name	string	AccountManagersPartnerLov name.
briefName	string	AccountManagersPartnerLov brief name.

4.162 BizPartnerBriefCollection

BizPartnerBriefCollection object properties:

Name	Type	Description
data (required)	array	An array of BizPartnerBrief objects.
meta (required)	object	CollectionMeta object.

4.163 BizPartnerBrief

BizPartnerBrief object properties:

Name	Type	Description
id	integer	BizPartnerBrief ID.
instanceRole	string	Instance role.
name	string	Name.
briefName	string	Brief name.
externalRefId	string	External reference ID.
countryId	integer	Country ID.
countryName	string	Country name.
phone	string	Phone.
eMail	string	E-mail.
language	string	Language.
vatNumber	string	VAT number.
vatApply	string	Possible values: yes, no, unknown.
legalAddressId	integer	Legal address ID.
legalAddressName	string	Legal address name.
legalAddress	string	Legal address.
legalAddressCountryId	integer	Legal address country ID.
legalAddressCountryName	string	Legal address country name.
legalAddressZipCode	string	Legal address ZIP code.
statusActiveDt	string($date‑time)	Date of active status.
city	string	City.
regNumber	string	Registration number.
status	string	Status.
statusDt	string($date‑time)	Status date and time.
relation	string	Relation.
relationCodeName	string	Relation code name.
product	string	Product.
realProduct	string	Related product list.
realProductCodeName	string	Related product list code name.
partnerTypeId	integer	Partner type ID.
partnerTypeName	string	Partner type name.
industryId	integer	Industry ID.
industryName	string	Industry name.
creation	string	Date of creation.
instanceOwnerName	string	Instance owner name.
ownerBpId	integer	Owner Business Partner ID.
ownerBpName	string	Business Partner name.
ownerBpBriefName	string	Business Partner brief name.
detailsId	integer	Details ID.
languageName	string	Language name.
legalForm	string	Legal form.
legalFormId	integer	Legal form ID.
companySizeId	integer	Comapany size ID.
CompanySize	string	Company size.
dunsNumber	string	DUNS number.
foundingD	string	Founfing date.
addresses	array	An array of briefAddresses objects.
attributes	array	An array of PartnerAttribute
webSocials	array	An array of WebSocial
extraAttributes	object	ExtraAttributesDataResponse object.

4.164 briefAddresses

briefAddresses object properties:

Name	Type	Description
id	integer	Biz Partner Address ID.
typeCodeName	string	Address type code name.
typeName	string	Address type name.

4.165 UserCollection

UserCollection object properties:

Name	Type	Description
data (required)	array	An array of User objects.
meta (required)	object	CollectionMeta object.

4.166 User

User object properties:

Name	Type	Description
uuid	string	User's UUID.
email	string	User's E-mail.
firstName	string	User's first name.
lastName	string	User's last name.
status	string	User's status. Possible values: active, inactive, invited, disabled.

JSON Example

{
  "uuid": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "status": "active"
}

4.167 BizPartnerBulkActionCoownerUpdate

BizPartnerBulkActionCoownerUpdate object properties:

Name	Type	Description
bizPartnerIdsToSync (required)	array	An array of bpId objects.
ownerBpId (required)	integer	Owner Biz Partner ID.

4.168 BpBulkActionTotalResult

BpBulkActionTotalResult object properies:

Name	Type	Description
synchronizedBp	array	An array of bpId objects.
unsynchronizedBp	array	An array of bpId objects.
total	integer	Total number.

4.169 bpId

bpId object properies:

Name	Type	Description
bpId	integer	Biz Partner ID.

4.170 MultiBpIdsData

MultiBpIdsData object properies:

Name	Type	Description
id	integer	ID.
result	string	Result.
reason	object	Reason of deletion.

4.171 LegalNameVatUniqueCheckRequest

LegalNameVatUniqueCheckRequest object properies:

Name	Type	Description
name (required)	string	Name to check.
vatNumber (required)	string	VAT number.
excludedId	integer	Represents biz_core.biz_partner.id.
compareDate	string	A parameter when a date is available for comparison. If the date of briefName is before compareDate, the briefName will be checked. Default date is "2007-01-01".

4.172 LegalNameVatUniqueCheckResult

LegalNameVatUniqueCheckResult object properies:

Name	Type	Description
name (required)	string	Name to check.
vatNumber (required)	string	VAT number.
excludedId	integer	Represents biz_core.biz_partner.id.
unique (required)	boolean	If legal name and VAT are unique. Possible values: yes, no.

4.173 BriefNameUniqueCheckRequest

BriefNameUniqueCheckRequest object properies:

Name	Type	Description
briefName (required)	string	Brief name to check.
excludedId	integer	Represents biz_core.biz_partner.id.
compareDate	string	A parameter when a date is available for comparison. If the date of briefName is before compareDate, the briefName will be checked. Default date is "2007-01-01".

4.174 BriefNameUniqueCheckResult

BriefNameUniqueCheckResult object properies:

Name	Type	Description
briefName (required)	string	Brief name to check.
excludedId	integer	Represents biz_core.biz_partner.id.
unique (required)	boolean	If legal name and VAT are unique. Possible values: yes, no.

4.175 Error

Error object properties:

Name	Type	Description
code (required)	integer($int32)	Error code.
message (required)	string	Error message.

JSON Example

{
  "code": 0,
  "message": "string"
}

4.176 ErrorRow

ErrorRow object properties:

Name	Type	Description
row	integer	Error row number.
message	string	Error message.
description	string	Error description.
code	integer	Error code.
items	array	An array of ErrorItemsRow objects.

4.177 ErrorItemsRow

ErrorItemsRow object properties:

Name	Type	Description
name	string	Name.
message	string	Message.
description	string	Description.

4.178 CollectionMeta

CollectionMeta object properties:

Name	Type	Description
pagination (required)	object	CollectionMetaPagination object.

4.179 CollectionMetaPagination

CollectionMetaPagination object properties:

Name	Type	Description
total (required)	integer	Total number of rows.
totalPages (required)	integer	Total number of pages.
currentPage (required)	integer	The current page number.
perPage (required)	integer	The maximum rows per page.
count (required)	integer	A number of rows in the current page.
links	object	CollectionMetaPaginationLinks object.

4.180 CollectionMetaPaginationLinks

CollectionMetaPaginationLinks object properties:

Name	Type	Description
first	string	Link to the first page.
last	string	Link to the last page.
prev	string	Link to the previous page.
next	string	Link to the next page.

JSON Example

"meta": {
    "pagination": {
      "total": 0,
      "totalPages": 0,
      "currentPage": 0,
      "perPage": 0,
      "count": 0
    }
  }

5. API Call Examples

This section presents a set of sample cURL API calls that shows some of numerous use cases for the API.

Note: A domain is presented with placeholders as https://api{separator}{platform_domain}, where {separator} can be a dot (.) or a hyphen (-). Please, replace it with your actual platform domain name.

1. An example of how to filter the Business Partners results and make segmentation to see all Business Partners with 'Customer' relation type is given below:

curl 'https://api{separator}{platform_domain}/biz-core/v1/biz-partners-brief?bp_type_filter=1&sort=briefName' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer ACCESS_TOKEN'

2. An example of how to filter the Platform Products results and make segmentation to see all platform products with 'Supplier' relation type is given below:

curl 'https://api{separator}{platform_domain}/biz-core/v1/biz-partners/BIZ_PARTNER_ID/biz-partner-products?contains(relationTypeName)=Supplier' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer ACCESS_TOKEN'

3. The following API call creates a Custom field:

curl 'https://api{separator}{platform_domain}/biz-core/v2/attributes?attributeKind=registered&name=CUSTOM_FIELD_NAME&sort=name' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data '{
    "attributeTypeId": 4,
    "codeName": "ATTR-CUSTOM_FIELD_NAME",
    "name": "CUSTOM_FIELD_NAME"
    }'

4. An example of API call which adds an Attribute Section to a custom field, i.e. section where the custom field will be in use in the system:

curl 'https://api{separator}{platform_domain}/biz-core/v2/attributes/ATTRIBUTE_ID/attribute-sections' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data '{
    "id": ATTRIBUTE_ID,
    "sectionId": SECTION_ID
    }'

5. The following examples of API calls creates a Biz Partner product 'Bulk SMS' for a Customer. The custom field, created in the previous example, is also in use:

curl 'https://api{separator}{platform_domain}/biz-core/v1/biz-partners/BIZ_PARTNER_ID/biz-partner-products' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data '{
    "sellingPaymentType": "prepaid",
    "relationTypeId": 1,
    "relationTypeName": "Customer",
    "productId": 1,
    "productType": 3,
    "productName": "Bulk SMS",
    "validFromDateFull": "2023-03-31T22:00:00.000Z",
    "validFromDat": "01.04.2023.",
    "currencyId": "978",
    "currencyCode": "EUR",
    "status": "enabled",
    "accountManagerId": null,
    "productBulkSms": {
      "sellingPaymentType": "prepaid",
      "sellingPaymentDue": 0,
      "validFromD": "2023-04-01",
      "currencyId": "978",
      "disputePercent": 0,
      "maxDispute": 0,
      "announcementDays": 0,
      "invoiceTriggerAmount": 0,
      "overdraftLimit": null,
      "creditLimit": 0,
      "deposit": null,
      "bankGuarantee": null
      }
    }'

curl 'https://api{separator}{platform_domain}/biz-core/v2/partner-attributes' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data '{
    "attributeValue": "123",
    "visible": true,
    "fieldData": {
      "name": "CUSTOM_FIELD_NAME",
      "id": ATTRIBUTE_ID,
      "attributeTypeId": 4,
      "codeName": "ATTR-CUSTOM_FIELD_NAME",
      "status": "active",
      "statusDt": "2023-03-06T13:09:58Z",
      "attributeKind": "registered",
      "sections": "Product Relation",
      "sectionCodeNames": "PRODUCT-RELATION",
      "attributeTypeCodeName": "INPUT-STRING",
      "attributeTypeName": "Input String",
      "canBeDeleted": false,
      "canCodeNameChange": true,
      "visible": true,
      "disabled": false
      },
    "sectionId": SECTION_ID,
    "attributeId": ATTRIBUTE_ID,
    "valueType": "simple",
    "error": false,
    "sectionRowId": SECTION_ROW_ID,
    "bizPartnerId": BIZ_PARTNER_ID
    }'

6. The following example of API call returns a product for the selected productName and relationTypeName, e.g. product name 'Bulk SMS' for relation type 'Customer', for a Biz Partner:

curl 'https://api{separator}{platform_domain}/biz-core/v1/biz-partners/BIZ_PARTNER_ID/biz-partner-products?contains(productName)=Bulk+SMS&contains(relationTypeName)=Customer' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer ACCESS_TOKEN'

7. The value of an attribute/custom field for a product (e.g. for a product that is returned in the previous example), can be found from the response of the API call presented below. The request is based on the values of bizProductId and sectionCodeNames, where bizProductId value is used for sectionRowId parameter.

curl 'https://api{separator}{platform_domain}/biz-core/v2/partner-attributes?all=yes&sectionRowId=BIZ_PRODUCT_ID&sectionCodeNames=PRODUCT-RELATION' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Authorization: Bearer ACCESS_TOKEN'