The Shireburn Business Suite (SBS) API enables you to interact with SBS systems. You will need an API key which should be passed as a query string with each of the requests below.

POST api/SFM/ImportClient?companyKey={companyKey}

Creates a client

Request Information

URI Parameters

Name	Description	Type	Additional information
companyKey	The company name if the service is connected to multiple SIMS/SFM companies (Optional)	string	Default value is

Body Parameters

The Client object

Client

Name	Type	Additional information
Code	string	Required
Name	string	Required
Address1	string	N/A
Address2	string	N/A
Address3	string	N/A
Address4	string	N/A
Address5	string	N/A
Phone	string	N/A
Fax	string	N/A
Telex	string	N/A
ContTitle	string	N/A
ContName	string	N/A
ContSurn	string	N/A
SalesMan	string	N/A
Group	string	Required
Currency	string	Required
Credit	integer	N/A
CreditDys	integer	N/A
Rectag	boolean	N/A
Discount	decimal number	N/A
VatReg	string	N/A
OnHold	boolean	N/A
Tag	string	N/A
Remark	string	N/A
Add1	string	N/A
Add2	string	N/A
Add3	string	N/A
Add4	string	N/A
Add5	string	N/A
MobileNo	string	N/A
IdNo	string	N/A
Email	string	N/A
Created	date	N/A
AmendedBy	string	N/A
LastAmend	date	N/A
Class	string	N/A
Commission	decimal number	N/A
NewFlag	string	N/A
SellingP	integer	N/A
ReplicId	string	N/A
Archive	boolean	N/A
AccessLevel	string	N/A
Report	string	N/A
EuCountry	string	N/A
CreatedBy	string	N/A
EWebPage	string	N/A
EVatCode	string	N/A
Category1	string	N/A
Category2	string	N/A
Category3	string	N/A
Category4	string	N/A
Category5	string	N/A
EBankAcc	string	N/A
ERelated	boolean	N/A
SecName	string	N/A
PrintChq	boolean	N/A
SecCode	string	N/A
CreditTrm	string	N/A
PrintOpt	string	N/A
Hidden	boolean	N/A
CashOnly	boolean	N/A
OnCrHold	boolean	N/A
PayType	string	N/A
UID	string	N/A
BankBIC	string	N/A
BankAccNo	string	N/A
IBAN	string	N/A
PostMsg1	string	N/A
PostMsg2	string	N/A
FollowUpDt	date	N/A

Request Formats

application/json, text/json

Sample:

{
  "Code": "sample string 1",
  "Name": "sample string 2",
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "Address3": "sample string 5",
  "Address4": "sample string 6",
  "Address5": "sample string 7",
  "Phone": "sample string 8",
  "Fax": "sample string 9",
  "Telex": "sample string 10",
  "ContTitle": "sample string 11",
  "ContName": "sample string 12",
  "ContSurn": "sample string 13",
  "SalesMan": "sample string 14",
  "Group": "sample string 15",
  "Currency": "sample string 16",
  "Credit": 17,
  "CreditDys": 18,
  "Rectag": true,
  "Discount": 20.0,
  "VatReg": "sample string 21",
  "OnHold": true,
  "Tag": "sample string 23",
  "Remark": "sample string 24",
  "Add1": "sample string 25",
  "Add2": "sample string 26",
  "Add3": "sample string 27",
  "Add4": "sample string 28",
  "Add5": "sample string 29",
  "MobileNo": "sample string 30",
  "IdNo": "sample string 31",
  "Email": "sample string 32",
  "Created": "2024-11-23T18:08:55.2055649",
  "AmendedBy": "sample string 34",
  "LastAmend": "2024-11-23T18:08:55.2055649",
  "Class": "sample string 36",
  "Commission": 37.0,
  "NewFlag": "sample string 38",
  "SellingP": 39,
  "ReplicId": "sample string 40",
  "Archive": true,
  "AccessLevel": "sample string 42",
  "Report": "sample string 43",
  "EuCountry": "sample string 44",
  "CreatedBy": "sample string 45",
  "EWebPage": "sample string 46",
  "EVatCode": "sample string 47",
  "Category1": "sample string 48",
  "Category2": "sample string 49",
  "Category3": "sample string 50",
  "Category4": "sample string 51",
  "Category5": "sample string 52",
  "EBankAcc": "sample string 53",
  "ERelated": true,
  "SecName": "sample string 55",
  "PrintChq": true,
  "SecCode": "sample string 57",
  "CreditTrm": "sample string 58",
  "PrintOpt": "sample string 59",
  "Hidden": true,
  "CashOnly": true,
  "OnCrHold": true,
  "PayType": "sample string 63",
  "UID": "sample string 64",
  "BankBIC": "sample string 65",
  "BankAccNo": "sample string 66",
  "IBAN": "sample string 67",
  "PostMsg1": "sample string 68",
  "PostMsg2": "sample string 69",
  "FollowUpDt": "2024-11-23T18:08:55.2055649"
}

Response Information

Resource Description

The operation's result

ImportClientResult

Name	Description	Type	Additional information
Status	The status of the sales order after the attempt to post it to SIMS	ImportStatus	N/A
ErrorMessage	The message returned in case of an error.	string	N/A
Client	The resulting client object.	Object	N/A

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "ErrorMessage": "sample string 1",
  "Client": {}
}