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/CreateSupplier?companyKey={companyKey}

Creates a supplier

Request Information

URI Parameters

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

Body Parameters

The supplier object

Supplier

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
Balance	decimal number	N/A
FcBalance	decimal number	N/A
Credit	integer	N/A
CreditDys	integer	N/A
LastInv	date	N/A
LastPay	date	N/A
TurnYear	decimal number	N/A
TurnLSyr	decimal number	N/A
Rectag	boolean	N/A
LyTotal	decimal number	N/A
TyTotal	decimal number	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
LastPAmt	decimal number	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",
  "Balance": 17.0,
  "FcBalance": 18.0,
  "Credit": 19,
  "CreditDys": 20,
  "LastInv": "2025-12-26T22:49:22.4956112",
  "LastPay": "2025-12-26T22:49:22.4956112",
  "TurnYear": 23.0,
  "TurnLSyr": 24.0,
  "Rectag": true,
  "LyTotal": 26.0,
  "TyTotal": 27.0,
  "Discount": 28.0,
  "VatReg": "sample string 29",
  "OnHold": true,
  "Tag": "sample string 31",
  "Remark": "sample string 32",
  "Add1": "sample string 33",
  "Add2": "sample string 34",
  "Add3": "sample string 35",
  "Add4": "sample string 36",
  "Add5": "sample string 37",
  "MobileNo": "sample string 38",
  "IdNo": "sample string 39",
  "Email": "sample string 40",
  "Created": "2025-12-26T22:49:22.4956112",
  "AmendedBy": "sample string 42",
  "LastAmend": "2025-12-26T22:49:22.4956112",
  "LastPAmt": 44.0,
  "Class": "sample string 45",
  "Commission": 46.0,
  "NewFlag": "sample string 47",
  "SellingP": 48,
  "ReplicId": "sample string 49",
  "Archive": true,
  "AccessLevel": "sample string 51",
  "Report": "sample string 52",
  "EuCountry": "sample string 53",
  "CreatedBy": "sample string 54",
  "EWebPage": "sample string 55",
  "EVatCode": "sample string 56",
  "Category1": "sample string 57",
  "Category2": "sample string 58",
  "Category3": "sample string 59",
  "Category4": "sample string 60",
  "Category5": "sample string 61",
  "EBankAcc": "sample string 62",
  "ERelated": true,
  "SecName": "sample string 64",
  "PrintChq": true,
  "SecCode": "sample string 66",
  "CreditTrm": "sample string 67",
  "PrintOpt": "sample string 68",
  "Hidden": true,
  "CashOnly": true,
  "OnCrHold": true,
  "PayType": "sample string 72",
  "UID": "sample string 73",
  "BankBIC": "sample string 74",
  "BankAccNo": "sample string 75",
  "IBAN": "sample string 76",
  "PostMsg1": "sample string 77",
  "PostMsg2": "sample string 78",
  "FollowUpDt": "2025-12-26T22:49:22.4956112"
}

Response Information

Resource Description

Success or error message for creation of supplier in the database

CreateSupplierResult

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
Supplier	The resulting client object.	Object	N/A

Response Formats

application/json, text/json

Sample:

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