CRM 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

Content:

Resource information

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

List partners

Url https://api.profit365.eu/1.6/CRM/partners
Method GET
Params
{take} optional Limit results range for given count.
{page} optional Split result into pages and take selected page
{fullName} optional

Query partners by full name

Type: String range
{editedAt} optional

Query partners by date of edit

Type: DateTime range
Example

Get all partners edited after 2015-04-08

https://api.profit365.eu/1.6/CRM/partners?editedAt=[2015-04-08;]

 

Get all partners with name starting as "Some Company"

https://api.profit365.eu/1.6/CRM/partners??fullName=Some%20Company*

Create new partner

Url https://api.profit365.eu/1.6/CRM/partners
Method POST
Example POST https://api.profit365.eu/1.6/CRM/partners

Authorization: Basic *** hidden credentials ***
ClientID: C7A36D...
ClientSecret: j7896WnI0U1...
CompanyID: CCA256B...
Content-Type: application/json

{
"fullName": "My Best Partner s.r.o",
"country": "SK",
"fields": { "date1": "2017-03-12",
"string1": "AdWords Campaign January",
"number1": 10.50,
"quantity": 1
} }

Partner data

fullName

required

A full name of partner.

Type: String

 request, response

code

optional

Code is a custom unique identifier of the partner

Type: String

 request, response

country

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

 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
  • Pubished at 5/3/2017 12:22:56 PM
  • Last edited 10/19/2018 11:37:29 AM

Back to top ↑