Partners

In Profit365, partner is a subject (company or a person) which has a relationship with your business. For example, a partner can be a customer, a supplier or both. Partner is widely used in Profit365 and selecting a partner is the most used process. The Partners API is also a background functionality of a web client at Profit365 > Sales > Customers (or Profit365 > Purchase > Suppliers).

Resource contents:

Resource information

Url https://api.profit365.eu/1.4/catalogs/partners
Authentication required
Access level company
Response JSON / XML
Class Masterdata entity

Find a partner

Finding a proper partner ID is slightly different from the other master data. You have to take into account two separate datasources:

  • Your own list, also called My partners. Contains only partners that had been used within any business case during all periods.
  • Common shared storage. Contains all business subjects available for your region. We try hard to keep this data up-to-date on daily base. More information about storage here.

The recommended process for finding proper partner ID is

  1. search your own list
  2. when no result is found, search common shared storage
  3. finally, when still no result is found, create new partner

Search own list

URL https://api.profit365.eu/1.4/catalogs/partners/search/{query}?externalId1={externalId1}&externalId2={externalId2}
Method GET
{query}

optional

A full-text search query that is applied on all fields. Should be applied only when expecting multiple results.

{externalId1}

optional

An external ID 1, returns exactly one matching partner. May not be combined within query or other external ID.

{externalId2}

optional

An external ID 2, returns exactly one matching partner. May not be combined within query or other external ID.

Examples Full-text search all partners for match "NiceCompany"

https://api.profit365.eu/1.4/catalogs/partners/search/NiceCompany


Get unique partner with ExternalID1 "734254"

https://api.profit365.eu/1.4/catalogs/partners/search/?externalId1=734254

Search common shared storage

URL https://api.profit365.eu/1.4/catalogs/partners/shared/search/{country}/{query}
Method GET

{country}

optional

A code of country (ISO 3166-1 alpha-2) for which the results are reduced.

{query}

A search query that is applied with OR condition on each string field. Should be applied only when expecting multiple results.

Examples

https://api.profit365.eu/1.4/catalogs/partners/shared/search/SK/NiceCompany

Create a partner

URL https://api.profit365.eu/1.4/catalogs/partners
Method POST
Create new partner object and POST it as payload data. Structure of an object here.

Delete a partner

URL https://api.profit365.eu/1.4/catalogs/partners/{id}
Method DELETE
{id}

An ID of the partner.

Type: GUID

Examples

https://api.profit365.eu/1.4/catalogs/partners/2db81330-6554-41e3-a743-3369410bd5a1

Delete existing partner. Partner must be from own list.

Partner parameters

fullName

required

A full name of partner.

Type: String

request, response

partnerNumber1

optional

Company registration number

Type: String, max 10 chars

request, response

partnerNumber2

optional

Company tax ID

Type: String

request, response

partnerNumber3

optional

VAT registration number

Type: String

request, response

code

optional

Code is a custom unique identifier of the partner

Type: String

request, response

countryCode

required

Code of partners country. Format ISO 3166-1 alpha-2.

Type: String

request, response

city

required

A string with partners city.

Type: String

request, response

postalCode

required

A string with postal (ZIP) code to partners invoicing address.

Type: String (5)

request, response

street

required

A string with street of parners invoicing address.

Type: String

request, response

streetNumber

optional

A string with street number of partners invoicing address.

Type: String

request, response

shortName

optional

A string with short name of partner. Short names are shown in partners search results. If not set during partner creating, value of fullName property is used.

Type: String

request, response

externalId1

optional

A string with external ID 1 is a custom unique identifier from external system (such as e-commerce customer ID)

Type: String

request, response

externalId2

optional

A string with external ID 2 is a custom unique identifier from external system (such as e-commerce customer ID)

Type: String

request, response

Exceptions

Partner not found in local nor shared database

System.ArgumentOutOfRangeException