03. Customers

Interface

It allows you:

to get customers catalogue
to create new customers

Prerequisites:

In order to use this API Method for PUT there must be accomplished the following requirements in SocrateCloud:

to have an Organization active

Columns that can be used as filters:

Organization
Active
Value
Name
TaxID
DUNS
PriceList
LastModified (UTC time format ISO 8601: yyyy-MM-dd HH:mm:ss Z, max date from Customer tab).Use this filter to get the newest customer.

Actions can be done:

list
insert
update
delete

API Methods:

List:

URL: https://api.socratecloud.com/webapi/rest/customer/list/0?startRow={0}&endRow={100}&accessToken={access_token}

Method: GET

Return: JSON object with next format:

{

"data": [

{

"Organization": "Demo SRL",

"Created": "2007-08-22 08:30:18",

"CreatedBy": "System",

"Updated": "2014-02-04 14:40:58",

"UpdatedBy": "SuperUser",

"Value": "bp_value",

"Name": "bp_name",

"Description": null,

"Active": true,

"TaxID": null,

"DUNS": null,

"BPGroup": "Customers",

"IsIndividual": false,

"InvoiceRule": "After Delivery",

"DeliveryRule": "Availability",

"DeliveryViaRule": "Shipper",

"PaymentMethod": "On Credit",

"PaymentTerm": "Immediate",

"CreditStatus": "No Credit Check",

"CreditLimit": 0,

"CreditUsed": 4.45087348,

"PriceList": "EUR Standard",

"FlatDiscount": null,

"DiscountPrinted": false,

"BPGroup_ID": 1003183,

"BPGroupValue": "PREMIUM",

"BPSize": "SG2",

"BPSize_ID": 1000310,

"SalesRep": null,

"PaymentMode": null,

"InvoiceCurrency": null,

"OrderDescription": "Order Description From Customer",

"Language": "ro_RO",

"IndustryCode": "Industrie B",

"IndustryCode_ID": 1000263

}

],

}

Create:

URL: https://api.socratecloud.com/webapi/rest/customer/create/{version}?accessToken={access_token}

Method: POST

Return: customer value for success or error message (start with "ERROR: ")

Data format:

{

"Organization": "Demo SRL",

"Value": "bp_value",

"Name": "bp_name",

"Description": null,

"Active": true,

"TaxID": null,

"DUNS": null,

"BPGroup": "Customers",

"IsIndividual": false,

"InvoiceRule": "After Delivery",

"DeliveryRule": "Availability",

"DeliveryViaRule": "Shipper",

"PaymentMethod": "On Credit",

"PaymentTerm": "Immediate",

"CreditLimit": 0,

"PriceList": "EUR Standard",

"FlatDiscount": null,

"DiscountPrinted": false,

"SalesRep": null,

"BPGroup_ID": 1003183,

"BPGroupValue": "PREMIUM",

"BPSize": "SG2",

"BPSize_ID": 1000310,

"IndustryCode": "Industrie B",

"IndustryCode_ID": 1000263,

"PaymentMode": null,

"InvoiceCurrency": "RON",

"OrderDescription": "Order Description From Customer",

"Language": "ro_RO"

}

Update:

URL: https://api.socratecloud.com/webapi/rest/customer/update/{version}?accessToken={access_token}&Value={customer_value}

Method: POST

Return: customer value for success or error message (start with "ERROR: ")

Data format:

{

"Organization": "Demo SRL",

"Value": "bp_value",

"Name": "bp_name",

"Description": null,

"Active": true,

"TaxID": null,

"DUNS": null,

"BPGroup": "Customers",

"IsIndividual": false,

"InvoiceRule": "After Delivery",

"DeliveryRule": "Availability",

"DeliveryViaRule": "Shipper",

"PaymentMethod": "On Credit",

"PaymentTerm": "Immediate",

"CreditLimit": 0,

"PriceList": "EUR Standard",

"FlatDiscount": null,

"DiscountPrinted": false,

"SalesRep": null,

"BPGroup_ID": 1003183,

"BPGroupValue": "PREMIUM",

"BPSize": "SG2",

"BPSize_ID": 1000310,

"IndustryCode": "Industrie B",

"IndustryCode_ID": 1000263,

"PaymentMode": null,

"InvoiceCurrency": "RON",

"OrderDescription": "Order Description From Customer",

"Language": "ro_RO"

}

Delete:

URL: https://api.socratecloud.com/webapi/rest/customer/delete/{version}?&accessToken={access_token}&Value={customer_value}

Method: POST

Return: 'Deleted' for success or error message (start with "ERROR: ")