Clients Suppliers

Endpoints

Get one partner data

POST/api/RPC.common.Api.Partners.get?token=<TOKEN>

Key Partners.get · Open page

Parameters

9 body parameters inside data[]
FieldTypeDescription
idIntegerPartner ID
is_companyBooleanThe customer is a Company
egnStringID
eikStringUIC
dds_numStringVAT Number
phoneStringPhone
emailStringE-mail
from_dateStringFrom date
to_dateStringTo date

Request example

Search Partner By ID:
{
   "data" : [
      {
         "id" : 1026831288
      }
   ]
}
Search Partner By Phone, E-mail, UIC, PID:
{
   "data" : [
      {
         "email" : "b.krastev@antipodes.bg",
         "phone" : "+359878100027"
      }
   ]
}

cURL

Search Partner By ID:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 1026831288      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Partners.get?token=<TOKEN>"
Search Partner by Phone, E-mail, UIC, PID:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "email" : "b.krastev@antipodes.bg",         "phone" : "+359878100027"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Partners.get?token=<TOKEN>"

Response example

// Success-Response (company):
    HTTP/1.1 200 OK
{
   "total_count" : "Total matching records",
   "count" : "Returned records count",
   "result" : [
      {
         "nickname" : "Nickname",
         "updatedon" : "YYYY-MM-DD HH:MM:SS",
         "createdon" : "YYYY-MM-DD HH:MM:SS",
         "status" : "Partner status",
         "fax" : "Fax",
         "archive" : 0,
         "is_client" : 1,
         "id" : "Partner Id",
         "trader" : "Trader username",
         "is_company" : 1,
         "dds_num" : "VAT number",
         "eik" : "UIC (company)",
         "params" : {
            "Param name" : "Param value"
         },
         "promo_cards" : [
            {
               "last_update_date" : "YYYY-MM-DD HH:MM:SS",
               "status" : "active | archive",
               "points" : "Points balance",
               "num" : "Card number"
            }
         ],
         "name" : "Partner Name",
         "email" : "E-mail",
         "note" : "Note",
         "client_type" : "Client type name",
         "phone" : "Phone",
         "vendor_type" : "Vendor type name",
         "is_vendor" : 0
      }
   ]
}

// Success-Response (person):
    HTTP/1.1 200 OK
{
   "result" : [
      {
         "email" : "E-mail",
         "name" : "Partner Name",
         "promo_cards" : [
            {
               "last_update_date" : "YYYY-MM-DD HH:MM:SS",
               "status" : "active | archive",
               "num" : "Card number",
               "points" : "Points balance"
            }
         ],
         "note" : "Note",
         "client_type" : "Client type name",
         "is_vendor" : 0,
         "vendor_type" : "Vendor type name",
         "phone" : "Phone",
         "createdon" : "YYYY-MM-DD HH:MM:SS",
         "egn" : "PID (person)",
         "updatedon" : "YYYY-MM-DD HH:MM:SS",
         "nickname" : "Nickname",
         "status" : "Partner status",
         "fax" : "Fax",
         "trader" : "Trader username",
         "id" : "Partner Id",
         "archive" : 0,
         "is_client" : 1,
         "params" : {
            "Param name" : "Param value"
         },
         "is_company" : 0
      }
   ],
   "total_count" : "Total matching records",
   "count" : "Returned records count"
}

Create clients-suppliers

POST/api/RPC.common.Api.Partners.set?token=<TOKEN>

Key Partners.set · Open page

Parameters

18 body parameters inside data[]
FieldTypeDescription
namerequiredStringName
nicknameStringAlias
is_companyBooleanThe customer is a Company
is_clientBooleanThe Account is a Client
client_typerequiredStringCustomer type
is_vendorBooleanThis CRM Account is a Supplier
vendor_typerequiredStringSupplier type
holdingStringHoldings
statusStringClient status
traderStringMerchant
egnStringID
eikStringUIC
dds_numStringVAT Number
emailStringE-mail
phoneStringPhone
faxStringFax
noteStringNote
archiveBooleanArchived

Get Client settings

POST/api/RPC.common.Api.Partners.getClientSettings?token=<TOKEN>

Key Partners.getClientSettings · Open page

Parameters

1 body parameter inside data[]
FieldTypeDescription
partner_idrequiredIntegerPartner ID

Request example

Get Client Settings:
{
   "data" : [
      {
         "partner_id" : 1220544213
      }
   ]
}

cURL

Get Client Settings:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "partner_id" : 1220544213      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Partners.getClientSettings?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "result" : [
      {
         "pay_type_name" : "Some Name",
         "default_pricelist_id" : "Price List Id",
         "fin_type" : "fin type",
         "partner_name" : "Some Name",
         "partner_id" : "Id",
         "default_currency" : "Currency Code",
         "pay_type" : "pay type",
         "period" : "Period",
         "default_pricelist_name" : "Some Name",
         "pay_limit" : "Limit"
      }
   ]
}

Get Supplier settings

POST/api/RPC.common.Api.Partners.getVendorSettings?token=<TOKEN>

Key Partners.getVendorSettings · Open page

Parameters

1 body parameter inside data[]
FieldTypeDescription
partner_idrequiredIntegerPartner ID

Request example

Get Vendor Settings:
{
   "data" : [
      {
         "partner_id" : 3139568
      }
   ]
}

cURL

Get Vendor Settings:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "partner_id" : 3139568      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Partners.getVendorSettings?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "result" : [
      {
         "partner_name" : "Some Name",
         "default_pricelist_id" : "Price List Id",
         "pay_type_name" : "Some Name",
         "fin_type" : "fin type",
         "period" : "Period",
         "default_currency" : "Currency Code",
         "pay_type" : "pay type",
         "pay_limit" : "Limit",
         "default_pricelist_name" : "Some Name",
         "partner_id" : "Id"
      }
   ]
}