API
- API Description
- System Token Auth
- Branch
- Tool Option
- Debtor Type Option
- Creditor Type Option
- Chart Account Option ( Using In Create Debtor )
- Chart Account Option ( Using In Create Creditor)
- Area Option
- Sales Agent Option
- Purchase Agent Option
- Currency Option
- Credit Term Option
- Creditor Option
- Debtor Option
- Number Format Option
- Chart Account Option (ALL)
- Stock Group Option
- Stock Item Type Option
- Supply Tax Code Option
- Purchase Tax Code Option
- Tariff Option
- UOM Option
- Payment Method Option
- Normal Account Option
- Package Item Data Option
- Debtor / Accounts Receivable (A/R)
- Creditor / Accounts Payable (A/P)
- Stock
- Sales Invoice
- A/R Receive Payment
- A/R Receive Payment List
- Get A/R Receive Payment
- Create A/R Receive Payment
- Edit A/R Receive Payment
- Delete A/R Receive Payment
- A/P Payment
- Sales Order
- Sales Delivery Order
- Sales Delivery Order List
- Get Sales Delivery Order
- Create Sales Delivery Order
- Edit Sales Delivery Order
- Delete Sales Delivery Order
- Sales Credit Note
- Sales Credit Note List
- Get Sales Credit Note
- Create Sales Credit Note
- Edit Sales Credit Note
- Delete Sales Credit Note
- Purchase Invoice
- Purchase Invoice List
- Get Purchase Invoice
- Create Purchase Invoice
- Edit Purchase Invoice
- Delete Purchase Invoice
- Purchase Order
API Description
API Description
API is dedicated to the platform data connection for the third-party system. The third-party system can read and set business data flexibly, which effectively reduces the complexity of the third-party system business integration and provides convenient, fast standard connection mode and data structure.
System Token Auth
System Access
Request Token Auth
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/token-auth/ Content Type application/json Response Type JSON Parameter Description public_key: string is required.
private_key: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"public_key" : "B7ABD5DEEC6588997DE41B0FE0665",
"private_key" : "317bae9de9416cff0eef92c82b942acbce427c3acf6"}
- Response JSON Format
Successful Example {
"status" : true,
"token" : "13d03d8c0edb14632d43316ffc8b0858f70049fc9c3d1084",
"start_time" : "2020-01-14 02:43:00",
"end_time" : "2020-01-14 03:13:00"
}
Fail Example {
"status" : false,
"error" : "Account Book does not existing."
}
Branch
Access Branch
Branch List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/branch/list Content Type application/json Response Type JSON Parameter Description token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Branch 1",
"short_code" : "B0001,
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid."
}
Tool Option
Debtor Type Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "debtor_type"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Book Supplier",
"item_code" : "S0001",
"description_1" : "English Text Book",
"description_2" : "",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Creditor Type Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "creditor_type"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Book Supplier",
"item_code" : "S0001",
"description_1" : "English Text Book",
"description_2" : "",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Chart Account Option ( Using In Create Debtor )
- This chart account option is using in create new debtor or edit debtor chooses.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "debtor_account_option"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Trade Debtor",
"account_number" : "300-000",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Chart Account Option ( Using In Create Creditor)
- This chart account option is using in create new creditor or edit creditor chooses.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "creditor_account_option"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Trade Creditor",
"account_number" : "400-000",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Area Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "area"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"area_code" : "11600",
"description_1" : "Bayan Lepas",
"description_2" : "Near Tesco",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Sales Agent Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "sales_agent"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Alex Lim",
"description_1" : "Responsible for Kuala Lumpur business",
"description_2" : "",
"image" : "http://supersuite.my/img/logo.png",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Purchase Agent Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "purchase_agent"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Alex Lim",
"description_1" : "Responsible for Kuala Lumpur business",
"description_2" : "",
"image" : "http://supersuite.my/img/logo.png",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Currency Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "currency"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"code" : "MYR",
"name" : "Malaysian Ringgit (MYR)",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Credit Term Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "credit_term"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"type" : "S",
"name" : "Net 30 days",
"days" : "30"
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
- Remark Property
Type Only Accept : S, U
S = System,
U = User
Creditor Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "creditor"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"company_name" : "Company A",
"account_number" : "300-0001",
"description" : "Selling Book",
"registration_number" : "1234567889",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Debtor Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "debtor"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"company_name" : "Company A",
"account_number" : "300-0001",
"description" : "Selling Book",
"registration_number" : "1234567889",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Number Format Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "number_format"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "IV Default",
"format" : "I-<00000>",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Chart Account Option (ALL)
- This chart account option is showing all chart of account.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "chart_account"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Fixed Assets",
"account_number" : "200-000",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Stock Group Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "stock_group"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Book",
"short_code" : "BB",
"description" : "Book Set",
"description_2" : "",
"remark" : "",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Stock Item Type Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "stock_item_type"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "Book",
"short_code" : "BB",
"description" : "Book Set",
"description_2" : "",
"remark" : "",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Supply Tax Code Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "supply_tax_code"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"tax_code" : "TX-O",
"gov_tax_code" : "TX",
"chart_account_id" : "",
"is_default" : "Y",
"zero_rate" : "N",
"transaction_account_posting" : ""N,
"description" : "Input Tax 0% – To Make Taxable Supplies (standard rated)",
"tax_percentage" : "6.00",
"basic_type" : "A",
"add _to_cost" : "N",
"genre" : "S",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
- Remark Property
Is Default / Zero Rate / Transaction Account Posting / Add To Cost Y= Yes,
N = No
Basis Type A = Accrual Basis ,
P = Payment Basis
Genre G = GST,
S = SST
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Purchase Tax Code Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "purchase_tax_code"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"tax_code" : "TX-O",
"gov_tax_code" : "TX",
"chart_account_id" : "",
"is_default" : "Y",
"zero_rate" : "N",
"transaction_account_posting" : ""N,
"description" : "Input Tax 0% – To Make Taxable Supplies (standard rated)",
"tax_percentage" : "6.00",
"basic_type" : "A",
"add _to_cost" : "N",
"genre" : "S",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
- Remark Property
Is Default / Zero Rate / Transaction Account Posting / Add To Cost Y= Yes,
N = No
Basis Type A = Accrual Basis ,
P = Payment Basis
Genre G = GST,
S = SST
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Tariff Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "tariff"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"code" : "123456789",
"description_1" : "Tariff Code",
"description_2" : "",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
UOM Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "uom"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "CM",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Payment Method Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "payment_method"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"id" : "1",
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "CIMB - IBG",
"account_number" : "300-001",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Normal Account Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "normal_account"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"name" : "100-0000 Capital",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
Package Item Data Option
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/tool/option Content Type application/json Response Type JSON Parameter Description token : string, is required.
type : string, is required.
item_code: string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"type" : "package_item_data",
"item_code" : "P0001"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" : {"net_total":500,"purchase_net_total":198.4,"total_tax":0,"total_purchase_tax":8.4,"data":[{"package_id":"15","stock_item_id":"1","chart_account_arr":{"sales_account_code":"E7A62066E65FF0B5E15D8234DF124937","cash_sale_account_code":"E7A62066E65FF0B5E15D8234DF124937","sales_return_account_code":"E7A62066E65FF0B5E15D8234DF124937","sales_discount_account_code":"E7A62066E65FF0B5E15D8234DF124937","purchase_account_code":"E7A62066E65FF0B5E15D8234DF124937","purchase_return_account_code":"E7A62066E65FF0B5E15D8234DF124937","purchase_discount_account_code":"E7A62066E65FF0B5E15D8234DF124937","balance_stock_account_code":"E7A62066E65FF0B5E15D8234DF124937"},"item_code":"AP001","description":"ACADEMY PROGRAMMES","description_2":"testv 2","uom":"","qty":"1","unit_price":"100.00","subtotal":"100.00","purchase_price":"50.00","purchase_subtotal":"50.00","tax_rate":"0.00","purchase_tax_rate":"0.00","tax_amount":"0.00","purchase_tax_amount":"0.00","tax_type":"SR-O ( 0.00 )","purchase_tax_type":"","supply_config_tax_code_id":"3","purchase_config_tax_code_id":null},{"package_id":"15","stock_item_id":"4","chart_account_arr":{"sales_account_code":"9D2561F56C94894E922653461C81FC0D","cash_sale_account_code":"9D2561F56C94894E922653461C81FC0D","sales_return_account_code":"9D2561F56C94894E922653461C81FC0D","sales_discount_account_code":"9D2561F56C94894E922653461C81FC0D","purchase_account_code":"692A4F8DC6BE6396A8CC893C4BCE31A7","purchase_return_account_code":"692A4F8DC6BE6396A8CC893C4BCE31A7","purchase_discount_account_code":"692A4F8DC6BE6396A8CC893C4BCE31A7","balance_stock_account_code":"692A4F8DC6BE6396A8CC893C4BCE31A7"},"item_code":"MI001","description":"MISC","description_2":"s23213sd","uom":"","qty":"2","unit_price":"200.00","subtotal":"400.00","purchase_price":"70.00","purchase_subtotal":"148.40","tax_rate":"0.00","purchase_tax_rate":"6.00","tax_amount":"0.00","purchase_tax_amount":"8.40","tax_type":"","purchase_tax_type":"TX-O ( 6.00 )","supply_config_tax_code_id":null,"purchase_config_tax_code_id":"1"}]}
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No found data."
}
- Remark Property
Data This data is a json ecode data, please do not edit the data. It will using in saving package item. If you edit it, it will follow u edited to save and the calculation will follow to edit to calculate.
Debtor / Accounts Receivable (A/R)
Debtor Access
Debtor List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/debtor/list Content Type application/json Response Type JSON Parameter Description token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"chart_account_id" : "1",
"debtor_type_id" : null,
"company_name" : "SuperCounting",
"registration_number" : "R1234-123",
"debtor_account_number" : "300-0001",
"billing_address_1" : "Bayan Lepas Industrial Park,",
"billing_address_2" : "Penang, Malaysia",
"billing_address_3" : "",
"billing_address_4" : "",
"email" : "supercounting@kedios.com",
"phone_1" : "0123456789",
"phone_2" : "",
"fax_1" : "0421345",
"fax_2" : "",
"postcode" : "11600",
"currency_id" : "105",
"statement_type" : "O",
"aging_on" : "I",
"credit_limit" : "1000.00",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid."
}
- Remark Property
Statement Type Only Accept : O, B, N
O = Open Item,
B = Balance Forward,
N = No Statement
Aging On Only Accept : I, D
I = Invoice Date,
D = Due Date
Get Debtor
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/debtor/get-debtor/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"chart_account_id" : "1",
"debtor_type_id" : null,
"company_name" : "SuperCounting",
"registration_number" : "R1234-123",
"debtor_account_number" : "300-0001",
"billing_address_1" : "Bayan Lepas Industrial Park,",
"billing_address_2" : "Penang, Malaysia",
"billing_address_3" : "",
"billing_address_4" : "",
"email" : "supercounting@kedios.com",
"phone_1" : "0123456789",
"phone_2" : "",
"fax_1" : "0421345",
"fax_2" : "",
"postcode" : "11600",
"currency_id" : "105",
"statement_type" : "O",
"aging_on" : "I",
"credit_limit" : "1000.00",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Debtor does not existing."
}
- Remark Property
Statement Type Only Accept : O, B, N
O = Open Item,
B = Balance Forward,
N = No Statement
Aging On Only Accept : I, D
I = Invoice Date,
D = Due Date
Create Debtor
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/debtor/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
chart_account_number: string, is required.
company_name : string , is required.
currency_id : int, is required.
statement_type : Only accept O/B/N , is required.
aging_on : Only accept I/ D, is required.
credit_limit : decimal, is required.
debtor_type_id : int or null.
registration_number : string.
debtor_account_number : string.
billing_address_1 : string.
billing_address_2 : string.
billing_address_3 : string.
billing_address_4 : string.
email : string.
phone_1 : string.
phone_2 : string.
fax_1: string.
fax_2 : string.
postcode : string.
confirm : Only accept Y/N.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"chart_account_number" : "300-0000",
"debtor_type_id" : null,
"company_name" : "SuperCounting",
"registration_number" : "R1234-123",
"debtor_account_number" : "300-0001",
"billing_address_1" : "Bayan Lepas Industrial Park,",
"billing_address_2" : "Penang, Malaysia",
"billing_address_3" : "",
"billing_address_4" : "",
"email" : "supercounting@kedios.com",
"phone_1" : "0123456789",
"phone_2" : "",
"fax_1" : "0421345",
"fax_2" : "",
"postcode" : "11600",
"currency_id" : "105",
"statement_type" : "O",
"aging_on" : "I",
"credit_limit" : "1000.00",
"confirm" : "Y"
}
- Response JSON Format
Successful Example {
"status" : true,
"debtor_account_number" : "300-F001",
"ref_id" : "FFFBD5DEEC6588997DE41B0FE0665",
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Debtor save fail."
}
- Remark Property
Debtor Account Number If debtor account number is empty, it will auto generate by system.
Statement Type Only Accept : O, B, N
O = Open Item,
B = Balance Forward,
N = No Statement
Aging On Only Accept : I, D
I = Invoice Date,
D = Due Date
Confirm If your company name already exiting and you still want to create the same name so you need to put the confirm key as "Y" else "N".
Only Accept : Y,N
Y = Yes,
N = No
Edit Debtor
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/debtor/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
chart_account_number: string, is required.
debtor_type_id : int or null.
company_name : string , is required.
registration_number : string.
debtor_account_number : string, is required.
billing_address_1 : string.
billing_address_2 : string.
billing_address_3 : string.
billing_address_4 : string.
email : string.
phone_1 : string.
phone_2 : string.
fax_1: string.
fax_2 : string.
postcode : string.
currency_id : int, is required.
statement_type : Only accept O/B/N , is required.
aging_on : Only accept I/ D, is required.
credit_limit : decimal, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"chart_account_number" : "300-0000",
"debtor_type_id" : null,
"company_name" : "SuperCounting",
"registration_number" : "R1234-123",
"debtor_account_number" : "300-0001",
"billing_address_1" : "Bayan Lepas Industrial Park,",
"billing_address_2" : "Penang, Malaysia",
"billing_address_3" : "",
"billing_address_4" : "",
"email" : "supercounting@kedios.com",
"phone_1" : "0123456789",
"phone_2" : "",
"fax_1" : "0421345",
"fax_2" : "",
"postcode" : "11600",
"currency_id" : "105",
"statement_type" : "O",
"aging_on" : "I",
"credit_limit" : "1000.00",
}
- Response JSON Format
Successful Example {
"status" : true,
"debtor_account_number" : "300-F001",
"ref_id" : "FFFBD5DEEC6588997DE41B0FE0665",
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Debtor save fail."
}
- Remark Property
Debtor Account Number If debtor account number is empty, it will auto generate by system.
Statement Type Only Accept : O, B, N
O = Open Item,
B = Balance Forward,
N = No Statement
Aging On Only Accept : I, D
I = Invoice Date,
D = Due Date
Delete Debtor
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/debtor/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Debtor delete fail."
}
Creditor / Accounts Payable (A/P)
Creditor Access
Creditor List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/creditor/list Content Type application/json Response Type JSON Parameter Description token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"chart_account_id" : "1",
"creditor_type_id" : null,
"company_name" : "SuperCounting",
"registration_number" : "R1234-123",
"creditor_account_number" : "300-0001",
"billing_address_1" : "Bayan Lepas Industrial Park,",
"billing_address_2" : "Penang, Malaysia",
"billing_address_3" : "",
"billing_address_4" : "",
"email" : "supercounting@kedios.com",
"phone_1" : "0123456789",
"phone_2" : "",
"fax_1" : "0421345",
"fax_2" : "",
"postcode" : "11600",
"currency_id" : "105",
"statement_type" : "O",
"aging_on" : "I",
"credit_limit" : "1000.00",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid."
}
- Remark Property
Statement Type Only Accept : O, B, N
O = Open Item,
B = Balance Forward,
N = No Statement
Aging On Only Accept : I, D
I = Invoice Date,
D = Due Date
Get Creditor
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/creditor/get-creditor/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"chart_account_id" : "1",
"creditor_type_id" : null,
"company_name" : "SuperCounting",
"registration_number" : "R1234-123",
"creditor_account_number" : "300-0001",
"billing_address_1" : "Bayan Lepas Industrial Park,",
"billing_address_2" : "Penang, Malaysia",
"billing_address_3" : "",
"billing_address_4" : "",
"email" : "supercounting@kedios.com",
"phone_1" : "0123456789",
"phone_2" : "",
"fax_1" : "0421345",
"fax_2" : "",
"postcode" : "11600",
"currency_id" : "105",
"statement_type" : "O",
"aging_on" : "I",
"credit_limit" : "1000.00",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Creditor does not existing."
}
- Remark Property
Statement Type Only Accept : O, B, N
O = Open Item,
B = Balance Forward,
N = No Statement
Aging On Only Accept : I, D
I = Invoice Date,
D = Due Date
Create Creditor
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/creditor/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
chart_account_number: string, is required.
creditor_type_id : int or null.
company_name : string , is required.
registration_number : string.
creditor_account_number : string.
billing_address_1 : string.
billing_address_2 : string.
billing_address_3 : string.
billing_address_4 : string.
email : string.
phone_1 : string.
phone_2 : string.
fax_1: string.
fax_2 : string.
postcode : string.
currency_id : int, is required.
statement_type : Only accept O/B/N , is required.
aging_on : Only accept I/ D, is required.
credit_limit : decimal, is required.
confirm : Only accept Y/N.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"chart_account_number" : "400-0000",
"creditor_type_id" : null,
"company_name" : "SuperCounting",
"registration_number" : "R1234-123",
"creditor_account_number" : "300-0001",
"billing_address_1" : "Bayan Lepas Industrial Park,",
"billing_address_2" : "Penang, Malaysia",
"billing_address_3" : "",
"billing_address_4" : "",
"email" : "supercounting@kedios.com",
"phone_1" : "0123456789",
"phone_2" : "",
"fax_1" : "0421345",
"fax_2" : "",
"postcode" : "11600",
"currency_id" : "105",
"statement_type" : "O",
"aging_on" : "I",
"credit_limit" : "1000.00",
"confirm" : "Y"
}
- Response JSON Format
Successful Example {
"status" : true,
"creditor_account_number" : "400-F001",
"ref_id" : "FFFBD5DEEC6588997DE41B0FE0665",
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Creditor save fail."
}
- Remark Property
Creditor Account Number If creditor account number is empty, it will auto generate by system. Statement Type Only Accept : O, B, N
O = Open Item,
B = Balance Forward,
N = No Statement
Aging On Only Accept : I, D
I = Invoice Date,
D = Due Date
Confirm If your company name already exiting and you still want to create the same name so you need to put the confirm key as "Y" else "N".
Only Accept : Y,N
Y = Yes,
N = No
Edit Creditor
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/creditor/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
chart_account_number: string, is required.
creditor_type_id : int or null.
company_name : string , is required.
registration_number : string.
creditor_account_number : string, is required.
billing_address_1 : string.
billing_address_2 : string.
billing_address_3 : string.
billing_address_4 : string.
email : string.
phone_1 : string.
phone_2 : string.
fax_1: string.
fax_2 : string.
postcode : string.
currency_id : int, is required.
statement_type : Only accept O/B/N , is required.
aging_on : Only accept I/ D, is required.
credit_limit : decimal, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"chart_account_number" : "400-0000",
"creditor_type_id" : null,
"company_name" : "SuperCounting",
"registration_number" : "R1234-123",
"creditor_account_number" : "300-0001",
"billing_address_1" : "Bayan Lepas Industrial Park,",
"billing_address_2" : "Penang, Malaysia",
"billing_address_3" : "",
"billing_address_4" : "",
"email" : "supercounting@kedios.com",
"phone_1" : "0123456789",
"phone_2" : "",
"fax_1" : "0421345",
"fax_2" : "",
"postcode" : "11600",
"currency_id" : "105",
"statement_type" : "O",
"aging_on" : "I",
"credit_limit" : "1000.00",
}
- Response JSON Format
Successful Example {
"status" : true,
"creditor_account_number" : "400-F001",
"ref_id" : "FFFBD5DEEC6588997DE41B0FE0665",
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Creditor save fail."
}
- Remark Property
Creditor Account Number If creditor account number is empty, it will auto generate by system.
Statement Type Only Accept : O, B, N
O = Open Item,
B = Balance Forward,
N = No Statement
Aging On Only Accept : I, D
I = Invoice Date,
D = Due Date
Delete Creditor
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/creditor/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Creditor delete fail."
}
Stock
Access Stock
Stock List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/stock/list Content Type application/json Response Type JSON Parameter Description token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"total_balance_qty" : "",
"stock_group_id" : "1",
"stock_item_type_id" : "2",
"item_code" : "B0001",
"status" : "A",
"description" : "English Book",
"description_2" : "Text Book",
"duty_rate" : "1.00",
"discontinued" : "N",
"lead_time" : "",
"has_promoter" : "N",
"supply_tax_code_ref_id" : "SS31CD0066F81E3C27674B1BB8BC7FB1",
"purchase_tax_code_ref_id" : "PP31CD0066F81E3C27674B1BB8BC7FB1",
"tariff_code_ref_id" : "TT31CD0066F81E3C27674B1BB8BC7FB1",
"stock_control" : "Y",
"costing_method" : "WA",
"config_uom_id" : "1",
"standard_selling_price" : "10.00",
"standard_selling_price_2" : "11.00",
"min_selling_price" : "10.00",
"max_selling_price" : "11.00",
"min_purchase_price" : "5.00",
"max_purchase_price" : "8.00",
"standard_cost" : "7.00",
"real_cost" : "7.00",
"min_qty" : "100",
"balance_qty" : "100",
"re_order_level" : "50",
"re_order_qty" : "100",
"normal_level" : "70",
"max_qty" : "200",
"weight" : "100",
"weight_uom" : "g",
"volume" : "100",
"volume_uom" : "",
"shelf" : "",
"barcode" : "123456789",
"redeem_bonus_point" : "100",
"image" : "",
"remark" : "",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid."
}
- Remark Property
Status Only Accept : A, I
A = Active,
I = Inactive
Discontinued / Has Promoter / Stock Control Only Accept : Y, N
Y = Yes,
N = No
Costing Method Only Accept : FC, WA, FI, LI, MR
FC = Fixed Cost,
WA = Weighted Average,
FI = FIFO,
LI = LIFO,
MR = Most Recently
Get Stock
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/stock/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"total_balance_qty" : "",
"stock_group_id" : "1",
"stock_item_type_id" : "2",
"item_code" : "B0001",
"status" : "A",
"description" : "English Book",
"description_2" : "Text Book",
"duty_rate" : "1.00",
"discontinued" : "N",
"lead_time" : "",
"has_promoter" : "N",
"supply_tax_code_ref_id" : "SS31CD0066F81E3C27674B1BB8BC7FB1",
"purchase_tax_code_ref_id" : "PP31CD0066F81E3C27674B1BB8BC7FB1",
"tariff_code_ref_id" : "TT31CD0066F81E3C27674B1BB8BC7FB1",
"stock_control" : "Y",
"costing_method" : "WA",
"config_uom_id" : "1",
"standard_selling_price" : "10.00",
"standard_selling_price_2" : "11.00",
"min_selling_price" : "10.00",
"max_selling_price" : "11.00",
"min_purchase_price" : "5.00",
"max_purchase_price" : "8.00",
"standard_cost" : "7.00",
"real_cost" : "7.00",
"min_qty" : "100",
"balance_qty" : "100",
"re_order_level" : "50",
"re_order_qty" : "100",
"normal_level" : "70",
"max_qty" : "200",
"weight" : "100",
"weight_uom" : "g",
"volume" : "100",
"volume_uom" : "",
"shelf" : "",
"barcode" : "123456789",
"redeem_bonus_point" : "100",
"image" : "",
"remark" : "",
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Stock does not existing."
}
- Remark Property
Status Only Accept : A, I
A = Active,
I = Inactive
Discontinued / Has Promoter / Stock Control Only Accept : Y, N
Y = Yes,
N = No
Costing Method Only Accept : FC, WA, FI, LI, MR
FC = Fixed Cost,
WA = Weighted Average,
FI = FIFO,
LI = LIFO,
MR = Most Recently
Create Stock
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/stock/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
stock_group_id : int.
stock_item_type_id" : int.
item_code : string.
status : char (1), is required.
description : string, is required.
description_2 : string
duty_rate : decimal.
discontinued : char (1), is required.
lead_time : string.
has_promoter : char (1),is required.
supply_tax_code_ref_id : string.
purchase_tax_code_ref_id : string.
tariff_code_ref_id : string.
stock_control : char (1),is required.
costing_method : char (2).
config_uom_id : int.
standard_selling_price : decimal.
standard_selling_price_2 : decimal.
min_selling_price : decimal.
max_selling_price : decimal.
min_purchase_price : decimal.
max_purchase_price : decimal.
standard_cost : decimal.
min_qty : int.
re_order_level : int.
re_order_qty : int.
normal_level : int.
max_qty : int.
weight : int.
weight_uom : string.
volume : int.
volume_uom : string.
shelf : string.
barcode : string.
redeem_bonus_point : int.
image : string.
remark : string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"stock_group_id" : "1",
"stock_item_type_id" : "2",
"item_code" : "B0001",
"status" : "A",
"description" : "English Book",
"description_2" : "Text Book",
"duty_rate" : "1.00",
"discontinued" : "N",
"lead_time" : "",
"has_promoter" : "N",
"supply_tax_code_ref_id" : "SS31CD0066F81E3C27674B1BB8BC7FB1",
"purchase_tax_code_ref_id" : "PP31CD0066F81E3C27674B1BB8BC7FB1",
"tariff_code_ref_id" : "TT31CD0066F81E3C27674B1BB8BC7FB1",
"stock_control" : "Y",
"costing_method" : "WA",
"config_uom_id" : "1",
"standard_selling_price" : "10.00",
"standard_selling_price_2" : "11.00",
"min_selling_price" : "10.00",
"max_selling_price" : "11.00",
"min_purchase_price" : "5.00",
"max_purchase_price" : "8.00",
"standard_cost" : "7.00",
"min_qty" : "100",
"re_order_level" : "50",
"re_order_qty" : "100",
"normal_level" : "70",
"max_qty" : "200",
"weight" : "100",
"weight_uom" : "g",
"volume" : "100",
"volume_uom" : "",
"shelf" : "",
"barcode" : "123456789",
"redeem_bonus_point" : "100",
"image" : "",
"remark" : "",
}
- Response JSON Format
Successful Example {
"status" : true,
"item_code" : "B001",
"ref_id" : "SSBD5DEEC6588997DE41B0FE0665",
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Stock save fail."
}
- Remark Property
Item Code If item code is empty, it will auto generate by system.
Status Only Accept : A, I
A = Active,
I = Inactive
Discontinued / Has Promoter / Stock Control Only Accept : Y, N
Y = Yes,
N = No
Costing Method Only Accept : FC, WA, FI, LI, MR
FC = Fixed Cost,
WA = Weighted Average,
FI = FIFO,
LI = LIFO,
MR = Most Recently
Edit Stock
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/stock/edit Content Type application/json Response Type JSON Parameter Description token : string, is required.
stock_group_id : int.
stock_item_type_id" : int.
item_code : string, is required.
status : char (1), is required.
description : string, is required.
description_2 : string
duty_rate : decimal.
discontinued : char (1), is required.
lead_time : string.
has_promoter : char (1),is required.
supply_tax_code_ref_id : string.
purchase_tax_code_ref_id : string.
tariff_code_ref_id : string.
stock_control : char (1),is required.
costing_method : char (2).
config_uom_id : int.
standard_selling_price : decimal.
standard_selling_price_2 : decimal.
min_selling_price : decimal.
max_selling_price : decimal.
min_purchase_price : decimal.
max_purchase_price : decimal.
standard_cost : decimal.
min_qty : int.
re_order_level : int.
re_order_qty : int.
normal_level : int.
max_qty : int.
weight : int.
weight_uom : string.
volume : int.
volume_uom : string.
shelf : string.
barcode : string.
redeem_bonus_point : int.
image : string.
remark : string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"stock_group_id" : "1",
"stock_item_type_id" : "2",
"item_code" : "B0001",
"status" : "A",
"description" : "English Book",
"description_2" : "Text Book",
"duty_rate" : "1.00",
"discontinued" : "N",
"lead_time" : "",
"has_promoter" : "N",
"supply_tax_code_ref_id" : "SS31CD0066F81E3C27674B1BB8BC7FB1",
"purchase_tax_code_ref_id" : "PP31CD0066F81E3C27674B1BB8BC7FB1",
"tariff_code_ref_id" : "TT31CD0066F81E3C27674B1BB8BC7FB1",
"stock_control" : "Y",
"costing_method" : "WA",
"config_uom_id" : "1",
"standard_selling_price" : "10.00",
"standard_selling_price_2" : "11.00",
"min_selling_price" : "10.00",
"max_selling_price" : "11.00",
"min_purchase_price" : "5.00",
"max_purchase_price" : "8.00",
"standard_cost" : "7.00",
"min_qty" : "100",
"re_order_level" : "50",
"re_order_qty" : "100",
"normal_level" : "70",
"max_qty" : "200",
"weight" : "100",
"weight_uom" : "g",
"volume" : "100",
"volume_uom" : "",
"shelf" : "",
"barcode" : "123456789",
"redeem_bonus_point" : "100",
"image" : "",
"remark" : "",
}
- Response JSON Format
Successful Example {
"status" : true,
"item_code" : "B001",
"ref_id" : "SSBD5DEEC6588997DE41B0FE0665",
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Stock save fail."
}
- Remark Property
Status Only Accept : A, I
A = Active,
I = Inactive
Discontinued / Has Promoter / Stock Control Only Accept : Y, N
Y = Yes,
N = No
Costing Method Only Accept : FC, WA, FI, LI, MR
FC = Fixed Cost,
WA = Weighted Average,
FI = FIFO,
LI = LIFO,
MR = Most Recently
Delete Stock
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/stock/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Stock delete fail."
}
Sales Invoice
Sales Invoice List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-invoice/list Content Type application/json Response Type JSON Parameter Description token: string is required.
branch_ref_id: string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "",
"doc_no" : "I-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No data found. "
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Get Sales Invoice
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-invoice/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "I-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code " : "B0001",
"chart_account_number " : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document does not existing."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Create Sales Invoice
- Sales Invoice created successful, it will auto generate A/R Invoice.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-invoice/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
branch_ref_id : string, is required.
doc_no : string.
number_format_ref_id : string, is required.
debtor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
allow_to_transfer : char, is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "I-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"sales_invoice_doc_no" : "I-00001",
"invoice_doc_no" : "I-00001",
"sales_invoice_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"sales_invoice_doc_no" : false,
"invoice_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Doc No If doc no is empty, it will auto generate by system.
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Edit Sales Invoice
- Sales Invoice edit successful, it will auto edit the A/R Invoice.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-invoice/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string, is required.
token : string, is required.
branch_ref_id : string, is required.
doc_no : string, is required.
debtor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
allow_to_transfer : char, is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "I-00001",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"sales_invoice_doc_no" : "I-00001",
"invoice_doc_no" : "I-00001",
"sales_invoice_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"sales_invoice_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Delete Sales Invoice
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-invoice/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document delete fail."
}
A/R Receive Payment
A/R Receive Payment List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ar-receive-payment/list Content Type application/json Response Type JSON Parameter Description token: string is required.
branch_ref_id: string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "OR-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"project_id" : "1",
"department_id" : "",
"description" : "Deposit Payment",
"second_voucher_code" : "",
"amount" : "80.00",
"unapplied_payment" : "0.00",
"refund_amount" : "0.00",
"remark" : "",
"payments" : [
{
"payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",
"chart_account_number" : "310-1000",
"department_id" : "",
"project_id" : "",
"cheque_number" : "",
"payment_amount" : "80.00",
"bank_charge" : "10.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "6.00",
"tax_amount" : "0.60",
"bank_charge_bill_number" : "",
"float_day" : "1",
"payment_by" : "Alex",
"is_rchq" : "off",
"rchq_date" : "",
}
],
"knock_offs" : [
{
"ref_id" : "RRC1CD0066F81E3C27674B1BB8BC7F",
"type" : "ARI",
"date" : "2019-12-12",
"doc_no" : "I-00001",
"supplier_no" : "",
"org_amount" : "100.00",
"outstanding" : "20.00",
"discount_due" : "",
"with_disc" : "off",
"amount" : "80.00",
"knock_off_date" : "2020-01-14",
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No data found. "
}
- Remark Property
Is RCHQ Only Accept : on, off
With Disc Only Accept : on, off
Get A/R Receive Payment
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ar-receive-payment/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "OR-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"project_id" : "1",
"department_id" : "",
"description" : "Deposit Payment",
"second_voucher_code" : "",
"amount" : "80.00",
"unapplied_payment" : "0.00",
"refund_amount" : "0.00",
"remark" : "",
"payments" : [
{
"payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",
"chart_account_number" : "310-1000",
"department_id" : "",
"project_id" : "",
"cheque_number" : "",
"payment_amount" : "80.00",
"bank_charge" : "10.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "6.00",
"tax_amount" : "0.60",
"bank_charge_bill_number" : "",
"float_day" : "1",
"payment_by" : "Alex",
"is_rchq" : "off",
"rchq_date" : "",
}
],
"knock_offs" : [
{
"ref_id" : "RRC1CD0066F81E3C27674B1BB8BC7F",
"type" : "ARI",
"date" : "2019-12-12",
"doc_no" : "I-00001",
"supplier_no" : "",
"org_amount" : "100.00",
"outstanding" : "20.00",
"discount_due" : "",
"with_disc" : "off",
"amount" : "80.00",
"knock_off_date" : "2020-01-14",
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document does not existing."
}
- Remark Property
Is RCHQ Only Accept : on, off
With Disc Only Accept : on, off
Create A/R Receive Payment
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ar-receive-payment/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
branch_ref_id : string, is required.
doc_no : string,
number_format_ref_id : string, is required.
date : date, is required. (Format : Y-m-d)
debtor_account_number : string, is required.
project_id : int.
department_id : int.
description : string, is required.
second_voucher_code : string.
remark : text.
payments : [
{
payment_method_ref_id : string, is required.
department_id : int.
project_id : int.
cheque_number : string.
payment_amount : decimal, is required.
bank_charge : decimal.
tax_code_ref_id : string.
tax_rate : decimal.
tax_amount : decimal.
bank_charge_bill_number : string.
float_day : int.
payment_by : string, is required.
is_rchq : char (3), is required.
rchq_date : date. (Format : Y-m-d)
}
],
knock_offs : [
{
doc_no : string, is required.
doc_ref_id : string, is required.
with_disc : char (3).
amount : decimal, is required.
knock_off_date : date. (Format : Y-m-d)
discount_amount : decimal.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"project_id" : "1",
"department_id" : "",
"description" : "Deposit Payment",
"second_voucher_code" : "",
"remark" : "",
"payments" : [
{
"payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",
"department_id" : "",
"project_id" : "",
"cheque_number" : "",
"payment_amount" : "80.00",
"bank_charge" : "10.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "6.00",
"tax_amount" : "0.60",
"bank_charge_bill_number" : "",
"float_day" : "1",
"payment_by" : "Alex",
"is_rchq" : "off",
"rchq_date" : "",
}
],
"knock_offs" : [
{
"doc_ref_id " : "TTC1CD0066F81E3C27674B1BB8BC7F",
"with_disc" : "off",
"amount" : "80.00",
"knock_off_date" : "2020-01-14",
"discount_amount" : "10.00,
}
]
}
- Response JSON Format
Successful Example {
"receive_payment_doc_no" : "I-00001",
"credit_note_doc_no" : "CN-00001",
"receive_payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
OR
{
"receive_payment_doc_no" : "I-00001",
"receive_payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"receive_payment_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Doc No If doc no is empty, it will auto generate by system.
Is RCHQ Only Accept : on, off
With Disc Only Accept : on, off
Knock Offs > Discount Amount When discount amount is bigger than 0 , it will auto generate Credit Note after completed receive payment document.
* Remark : Every time save it will generate new Credit Note (IF discount amount > 0), IF want to do edit this credit note please manually edit it in this credit note document
- Bold word is Important message.
Edit A/R Receive Payment
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ar-receive-payment/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string, is required.
token : string, is required.
branch_ref_id : string, is required.
number_format_ref_id : string, is required.
doc_no : string, is required,
date : date, is required. (Format : Y-m-d)
debtor_account_number : string, is required.
project_id : int.
department_id : int.
description : string, is required.
second_voucher_code : string.
remark : text.
payments : [
{
payment_method_ref_id: string, is required.
department_id : int.
project_id : int.
cheque_number : string.
payment_amount : decimal, is required.
bank_charge : decimal.
tax_code_ref_id : string.
tax_rate : decimal.
tax_amount : decimal.
bank_charge_bill_number : string.
float_day : int.
payment_by : string, is required.
is_rchq : char (3), is required.
rchq_date : date. (Format : Y-m-d)
}
],
knock_offs : [
{
doc_no : string, is required.
with_disc : char (3).
amount : decimal, is required.
knock_off_date : date. (Format : Y-m-d)
discount_amount : decimal.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "OR-0001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"project_id" : "1",
"department_id" : "",
"description" : "Deposit Payment",
"second_voucher_code" : "",
"remark" : "",
"payments" : [
{
"payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",
"department_id" : "",
"project_id" : "",
"cheque_number" : "",
"payment_amount" : "80.00",
"bank_charge" : "10.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "6.00",
"tax_amount" : "0.60",
"bank_charge_bill_number" : "",
"float_day" : "1",
"payment_by" : "Alex",
"is_rchq" : "off",
"rchq_date" : "",
}
],
"knock_offs" : [
{
"doc_no" : "I-00001",
"with_disc" : "off",
"amount" : "80.00",
"knock_off_date" : "2020-01-14",
"discount_amount" : "10.00,
}
]
}
- Response JSON Format
Successful Example {
"receive_payment_doc_no" : "I-00001",
"credit_note_doc_no" : "CN-00001",
"receive_payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
OR
{
"receive_payment_doc_no" : "I-00001",
"receive_payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"receive_payment_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Is RCHQ Only Accept : on, off
With Disc Only Accept : on, off
Knock Offs > Discount Amount When discount amount is bigger than 0 , it will auto generate Credit Note after completed receive payment document.
* Remark : Every time save it will generate new Credit Note (IF discount amount > 0), IF want to do edit this credit note please manually edit it in this credit note document
- Bold word is Important message.
Delete A/R Receive Payment
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ar-receive-payment/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document delete fail."
}
A/P Payment
A/P Payment List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ap-payment/list Content Type application/json Response Type JSON Parameter Description token: string is required.
branch_ref_id: string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "PV-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "400-F001",
"project_id" : "1",
"department_id" : "",
"description" : "Deposit Payment",
"second_voucher_code" : "",
"amount" : "80.00",
"unapplied_payment" : "0.00",
"refund_amount" : "0.00",
"remark" : "",
"payments" : [
{
"payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",
"chart_account_number" : "310-1000",
"department_id" : "",
"project_id" : "",
"cheque_number" : "",
"payment_amount" : "80.00",
"bank_charge" : "10.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "6.00",
"tax_amount" : "0.60",
"bank_charge_bill_number" : "",
"float_day" : "1",
"payment_by" : "Alex",
"is_rchq" : "off",
"rchq_date" : "",
}
],
"knock_offs" : [
{
"ref_id" : "RRC1CD0066F81E3C27674B1BB8BC7F",
"type" : "API",
"date" : "2019-12-12",
"doc_no" : "PI-00001",
"supplier_no" : "",
"org_amount" : "100.00",
"outstanding" : "20.00",
"discount_due" : "",
"with_disc" : "off",
"amount" : "80.00",
"knock_off_date" : "2020-01-14",
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No data found. "
}
- Remark Property
Is RCHQ Only Accept : on, off
With Disc Only Accept : on, off
Get A/P Payment
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ap-payment/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "PV-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "400-F001",
"project_id" : "1",
"department_id" : "",
"description" : "Deposit Payment",
"second_voucher_code" : "",
"amount" : "80.00",
"unapplied_payment" : "0.00",
"refund_amount" : "0.00",
"remark" : "",
"payments" : [
{
"payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",
"chart_account_number" : "310-1000",
"department_id" : "",
"project_id" : "",
"cheque_number" : "",
"payment_amount" : "80.00",
"bank_charge" : "10.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "6.00",
"tax_amount" : "0.60",
"bank_charge_bill_number" : "",
"float_day" : "1",
"payment_by" : "Alex",
"is_rchq" : "off",
"rchq_date" : "",
}
],
"knock_offs" : [
{
"ref_id" : "RRC1CD0066F81E3C27674B1BB8BC7F",
"type" : "ARI",
"date" : "2019-12-12",
"doc_no" : "PI-00001",
"supplier_no" : "",
"org_amount" : "100.00",
"outstanding" : "20.00",
"discount_due" : "",
"with_disc" : "off",
"amount" : "80.00",
"knock_off_date" : "2020-01-14",
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document does not existing."
}
- Remark Property
Is RCHQ Only Accept : on, off
With Disc Only Accept : on, off
Create A/P Payment
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ap-payment/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
branch_ref_id : string, is required.
doc_no : string,
number_format_ref_id : string, is required.
date : date, is required. (Format : Y-m-d)
debtor_account_number : string, is required.
project_id : int.
department_id : int.
description : string, is required.
second_voucher_code : string.
remark : text.
payments : [
{
payment_method_ref_id : string, is required.
department_id : int.
project_id : int.
cheque_number : string.
payment_amount : decimal, is required.
bank_charge : decimal.
tax_code_ref_id : string.
tax_rate : decimal.
tax_amount : decimal.
bank_charge_bill_number : string.
float_day : int.
payment_by : string, is required.
is_rchq : char (3), is required.
rchq_date : date. (Format : Y-m-d)
}
],
knock_offs : [
{
doc_no : string, is required.
with_disc : char (3).
amount : decimal, is required.
knock_off_date : date. (Format : Y-m-d)
discount_amount : decimal.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "400-F001",
"project_id" : "1",
"department_id" : "",
"description" : "Deposit Payment",
"second_voucher_code" : "",
"remark" : "",
"payments" : [
{
"payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",
"department_id" : "",
"project_id" : "",
"cheque_number" : "",
"payment_amount" : "80.00",
"bank_charge" : "10.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "6.00",
"tax_amount" : "0.60",
"bank_charge_bill_number" : "",
"float_day" : "1",
"payment_by" : "Alex",
"is_rchq" : "off",
"rchq_date" : "",
}
],
"knock_offs" : [
{
"doc_no" : "PI-00001",
"with_disc" : "off",
"amount" : "80.00",
"knock_off_date" : "2020-01-14",
"discount_amount" : "10.00,
}
]
}
- Response JSON Format
Successful Example {
"payment_doc_no" : "I-00001",
"credit_note_doc_no" : "CN-00001",
"payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
OR
{
"payment_doc_no" : "I-00001",
"payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"payment_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Doc No If doc no is empty, it will auto generate by system.
Is RCHQ Only Accept : on, off
With Disc Only Accept : on, off
Knock Offs > Discount Amount When discount amount is bigger than 0 , it will auto generate Credit Note after completed payment document.
* Remark : Every time save it will generate new Credit Note (IF discount amount > 0), IF want to do edit this credit note please manually edit it in this credit note document
- Bold word is Important message.
Edit A/P Payment
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ap-payment/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string, is required.
token : string, is required.
branch_ref_id : string, is required.
number_format_ref_id : string, is required.
doc_no : string, is required,
date : date, is required. (Format : Y-m-d)
debtor_account_number : string, is required.
project_id : int.
department_id : int.
description : string, is required.
second_voucher_code : string.
remark : text.
payments : [
{
payment_method_ref_id : string, is required.
department_id : int.
project_id : int.
cheque_number : string.
payment_amount : decimal, is required.
bank_charge : decimal.
tax_code_ref_id : string.
tax_rate : decimal.
tax_amount : decimal.
bank_charge_bill_number : string.
float_day : int.
payment_by : string, is required.
is_rchq : char (3), is required.
rchq_date : date. (Format : Y-m-d)
}
],
knock_offs : [
{
doc_no : string, is required.
with_disc : char (3).
amount : decimal, is required.
knock_off_date : date. (Format : Y-m-d)
discount_amount : decimal.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "PV-0001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "400-F001",
"project_id" : "1",
"department_id" : "",
"description" : "Deposit Payment",
"second_voucher_code" : "",
"remark" : "",
"payments" : [
{
"payment_method_ref_id" : "PPC1CD0066F81E3C27674B1BB8BC7F",
"department_id" : "",
"project_id" : "",
"cheque_number" : "",
"payment_amount" : "80.00",
"bank_charge" : "10.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "6.00",
"tax_amount" : "0.60",
"bank_charge_bill_number" : "",
"float_day" : "1",
"payment_by" : "Alex",
"is_rchq" : "off",
"rchq_date" : "",
}
],
"knock_offs" : [
{
"doc_no" : "PI-00001",
"with_disc" : "off",
"amount" : "80.00",
"knock_off_date" : "2020-01-14",
"discount_amount" : "10.00,
}
]
}
- Response JSON Format
Successful Example {
"payment_doc_no" : "I-00001",
"credit_note_doc_no" : "CN-00001",
"payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
OR
{
"payment_doc_no" : "I-00001",
"payment_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"payment_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Is RCHQ Only Accept : on, off
With Disc Only Accept : on, off
Knock Offs > Discount Amount When discount amount is bigger than 0 , it will auto generate Credit Note after completed payment document.
* Remark : Every time save it will generate new Credit Note (IF discount amount > 0), IF want to do edit this credit note please manually edit it in this credit note document
- Bold word is Important message.
Delete A/P Payment
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/ap-payment/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document delete fail."
}
Sales Order
Sales Order List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-order/list Content Type application/json Response Type JSON Parameter Description token: string is required.
branch_ref_id: string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"transfer_value" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00","net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No data found. "
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Transfer Value Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Get Sales Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-order/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"transfer_value" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document does not existing."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Transfer Value Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Create Sales Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-order/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
branch_ref_id : string, is required.
doc_no : string.
number_format_ref_id : string, is required.
debtor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
allow_to_transfer : char (1), is required.
transfer_value : char (1), is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
delivery_date: date, is required. (Format : Y-m-d)
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"transfer_value" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"sales_order_doc_no" : "SO-00001",
"sales_order_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"sales_order_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Doc No If doc no is empty, it will auto generate by system.
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Transfer Value Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Edit Sales Order
- Sales Invoice edit successful, it will auto edit the A/R Invoice.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-order/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string, is required.
token : string, is required.
branch_ref_id : string, is required.
doc_no : string, is required.
debtor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
allow_to_transfer : char, is required.
transfer_value : char (1), is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
delivery_date: date, is required. (Format : Y-m-d)
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"transfer_value" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"sales_order_doc_no" : "SO-00001",
"sales_order_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"sales_order_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Transfer Value Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Delete Sales Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-order/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document delete fail."
}
Sales Delivery Order
Sales Delivery Order List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-delivery-order/list Content Type application/json Response Type JSON Parameter Description token: string is required.
branch_ref_id: string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00","net_total" : "80.00",
"local_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No data found. "
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Get Sales Delivery Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-delivery-order/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00",
"local_total" : "80.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document does not existing."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Create Sales Delivery Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-delivery-order/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
branch_ref_id : string, is required.
doc_no : string.
number_format_ref_id : string, is required.
debtor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
allow_to_transfer : char (1), is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
delivery_date: date, is required. (Format : Y-m-d)
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"sales_delivery_order_doc_no" : "SO-00001",
"sales_delivery_order_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"sales_delivery_order_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Doc No If doc no is empty, it will auto generate by system.
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Edit Sales Delivery Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-delivery-order/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string, is required.
token : string, is required.
branch_ref_id : string, is required.
doc_no : string, is required.
debtor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
allow_to_transfer : char, is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
delivery_date: date, is required. (Format : Y-m-d)
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"sales_delivery_order_doc_no" : "SO-00001",
"sales_delivery_order_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"sales_delivery_order_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Delete Sales Delivery Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-deliver-order/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document delete fail."
}
Sales Credit Note
Sales Credit Note List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-credit-note/list Content Type application/json Response Type JSON Parameter Description token: string is required.
branch_ref_id: string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"reason" : "Stock Have Problem",
"credit_note_type_ref_id" : "",
"invoice_no" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00","net_total" : "80.00",
"local_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"supply_purchase" : "S",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No data found. "
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Supply Purchase Only Accept : S, P
S= Supply,
P = Purchase
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Get Sales Credit Note
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-credit-note/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"debtor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"reason" : "Stock Have Problem",
"credit_note_type_ref_id" : "",
"invoice_no" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00",
"local_total" : "80.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"supply_purchase" : "S",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document does not existing."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Supply Purchase Only Accept : S, P
S= Supply,
P = Purchase
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Create Sales Credit Note
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-credit-note/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
branch_ref_id : string, is required.
doc_no : string.
number_format_ref_id : string, is required.
debtor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int.
agent_ref_id : string.
creditor_debtor_branch_id : int.
reason : string, is required.
credit_note_type_ref_id: string.
invoice_no: string.
allow_to_transfer : char (1), is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
supply_purchase: char (1).
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"reason" : "Stock Have Problem",
"credit_note_type_ref_id" : "",
"invoice_no" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"supply_purchase" : "S",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"sales_credit_note_doc_no" : "SO-00001",
"sales_credit_note_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"sales_credit_note_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Doc No If doc no is empty, it will auto generate by system.
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Supply Purchase Only Accept : S, P
S= Supply,
P = Purchase
* Remark : supply / purchase will affect tax_code_ref_id. EX : Select "S" , tax code ref id will need to choose is category "Supply"
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Edit Sales Credit Note
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-credit-note/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string, is required.
token : string, is required.
branch_ref_id : string, is required.
doc_no : string, is required.
debtor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
reason : string, is required.
credit_note_type_ref_id: string.
invoice_no: string.
allow_to_transfer : char, is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
delivery_date: date, is required. (Format : Y-m-d)
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
supply_purchase: char (1).
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"reason" : "Stock Have Problem",
"credit_note_type_ref_id" : "",
"invoice_no" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"supply_purchase" : "S",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"sales_credit_note_doc_no" : "SO-00001",
"sales_credit_note_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"sales_credit_note_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Supply Purchase Only Accept : S, P
S= Supply,
P = Purchase
* Remark : supply / purchase will affect tax_code_ref_id. EX : Select "S" , tax code ref id will need to choose is category "Supply"
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Delete Sales Credit Note
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/sales-credit-note/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document delete fail."
}
Purchase Invoice
Purchase Invoice List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-invoice/list Content Type application/json Response Type JSON Parameter Description token: string is required.
branch_ref_id: string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "I-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"creditor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"supplier_do_no" : "",
"supplier_invoice_no" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"cn_amount" : "0.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No data found. "
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Get Purchase Invoice
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-invoice/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "I-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"creditor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"supplier_do_no" : "",
"supplier_invoice_no" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code " : "B0001",
"chart_account_number " : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"cn_amount" : "0.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document does not existing."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Create Purchase Invoice
- Purchase Invoice created successful, it will auto generate A/R Invoice.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-invoice/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
branch_ref_id : string, is required.
doc_no : string.
number_format_ref_id : string, is required.
creditor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
supplier_do_no: string.
supplier_invoice_no: string.
allow_to_transfer : char, is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
cn_amount: decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "I-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"creditor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"supplier_do_no" : "",
"supplier_invoice_no" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"cn_amount" : "0.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"purchase_invoice_doc_no" : "I-00001",
"invoice_doc_no" : "I-00001",
"purchase_invoice_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"purchase_invoice_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Doc No If doc no is empty, it will auto generate by system.
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Edit Purchase Invoice
- Sales Invoice edit successful, it will auto edit the A/R Invoice.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-invoice/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string, is required.
token : string, is required.
branch_ref_id : string, is required.
doc_no : string, is required.
creditor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
supplier_do_no: string.
supplier_invoice_no: string.
allow_to_transfer : char, is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
cn_amount: decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "I-00001",
"debtor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"supplier_do_no" : "",
"supplier_invoice_no" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"cn_amount" : "0.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"purchase_invoice_doc_no" : "I-00001",
"invoice_doc_no" : "I-00001",
"purchase_invoice_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"purchase_invoice_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Delete Purchase Invoice
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-invoice/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document delete fail."
}
Purchase Order
Purchase Order List
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-order/list Content Type application/json Response Type JSON Parameter Description token: string is required.
branch_ref_id: string.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"creditor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00","local_total" : "80.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / No data found. "
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Get Purchase Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-order/get-detail/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string is required.
token: string is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665"
}
- Response JSON Format
Successful Example {
"status" : true,
"data" :
[
{
"ref_id" : "0B31CD0066F81E3C27674B1BB8BC7FB1",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"date" : "2020-01-14",
"creditor_account_number" : "300-F001",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"sub_total" : "80.00",
"taxable_amount" : "80.00",
"tax_amount" : "0.00",
"local_total" : "80.00",
"net_total" : "80.00",
"total_qty" : "10",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"sub_total" : "80.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"tax_rate" : "2.00",
"sales_tax_exemption_no" : "",
"tax_amount" : "80.00",
"total_ex" : "80.00",
"total_inc" : "80.00",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_ref_id" : "",
"package_item" : ""
}
]
}
]
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document does not existing."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off
Type Only Accept : Product, Discount
Discount Type Only Accept : P, V
P = Percentage,
V = Value
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
Create Purchase Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-order/create Content Type application/json Response Type JSON Parameter Description token : string, is required.
branch_ref_id : string, is required.
doc_no : string.
number_format_ref_id : string, is required.
creditor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
allow_to_transfer : char (1), is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
delivery_date: date, is required. (Format : Y-m-d)
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "",
"number_format_ref_id" : "NN31CD0066F81E3C27674B1BB8BC7F",
"creditor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"purchase_order_doc_no" : "SO-00001",
"purchase_order_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"purchase_order_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Doc No If doc no is empty, it will auto generate by system.
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Edit Purchase Order
- Sales Invoice edit successful, it will auto edit the A/R Invoice.
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-order/edit/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id : string, is required.
token : string, is required.
branch_ref_id : string, is required.
doc_no : string, is required.
creditor_account_number : string, is required.
date : date, is required. (Format : Y-m-d)
name : string, is required.
address_1 : string.
address_2 : string.
address_3 : string.
address_4 : string.
credit_term_id : int, is required.
agent_ref_id : string.
creditor_debtor_branch_id : int.
shipping_info : string.
shipping_method_ref_id : string.
allow_to_transfer : char, is required.
inclusive : char (3), is required.
currency_id : int, is required.
remark : text.
items : [
{
item_code : string.
chart_account_number : string, is required.
description : string, is required.
description_2 : string.
delivery_date: date, is required. (Format : Y-m-d)
department_id : int.
project_id : int.
qty : int, is required.
unit_price : decimal, is required.
discount : decimal.
tax_code_ref_id : string.
sales_tax_exemption_no : string.
type : string, is required.,
discount_type : char (1).
discount_percentage : decimal.
discount_amount : decimal.
discount_parent_account_number : string.
package_item ; json_encode.
}
]
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
"branch_ref_id" : "BB31CD0066F81E3C27674B1BB8BC7F",
"doc_no" : "SO-00001",
"creditor_account_number" : "300-F001",
"date" : "2020-01-14",
"name" : "Alex Lim",
"address_1" : "Bayan Lepas Industrial Park,",
"address_2" : "Penang, Malaysia",
"address_3" : "",
"address_4" : "",
"credit_term_id" : "1",
"agent_ref_id" : "AA31CD0066F81E3C27674B1BB8BC7F",
"creditor_debtor_branch_id" : "",
"shipping_info" : "",
"shipping_method_ref_id" : "",
"allow_to_transfer" : "Y",
"inclusive" : "off",
"currency_id" : "105",
"remark" : "",
"items" : [
{
"item_code" : "B0001",
"chart_account_number" : "500-0000",
"description" : "Stock 1",
"description_2" : "",
"delivery_date" : "2020-01-14",
"department_id" : "",
"project_id" : "",
"qty" : "10",
"unit_price" : "10.00",
"discount" : "20.00",
"tax_code_ref_id" : "TTC1CD0066F81E3C27674B1BB8BC7F",
"sales_tax_exemption_no" : "",
"type" : "Product",
"discount_type" : "",
"discount_percentage" : "",
"discount_amount" : "",
"discount_parent_account_number" : "",
"package_item" : ""
}
]
}
- Response JSON Format
Successful Example {
"purchase_order_doc_no" : "SO-00001",
"purchase_order_ref_id" :"SSC1CD0066F81E3C27674B1BB8BC7F",
}
Fail Example {
"purchase_order_doc_no" : false,
"error" : "Token invalid. / Document save fail."
}
- Remark Property
Allow To Transfer Only Accept : Y, N
Y= Yes,
N = No
Inclusive Only Accept : on, off Type Only Accept : Product, Discount Discount Type * Only type is D (Discount) need to fill in value.
Only Accept : P, V
P = Percentage,
V = Value
Discount Percentage * Only discount type is P (Percentage) need to fill in value.
Discount Amount * Total discount amount giving for this item.
Discount Parent Account Number * This discount parent account number is record this discount from which parent item / product item.
Package Item When Item is Package Item, you need to fill it and the data format is json encode.
The package item is important, do not allow you to edit the data. It will affect you entry calculation. If you edited it, it will follow you edit to saving. if the system could not catch the special key, you document amount will be calculate wrongly.
You can take the data from below link:
https://knowledge.supersuite.my/books/api/page/package-item-data-option
- Bold word is Important message.
Delete Purchase Order
- Request Instruction
HTTPS Method POST URL http://subdomain.supersuite.my/api/purchase-order/delete/<ref_id> Content Type application/json Response Type JSON Parameter Description ref_id: string, is required.
token : string, is required.
Request Headers {
"Content-Type":"application/json"
}
Request Body {
"token" : "B7ABD5DEEC6588997DE41B0FE0665",
}
- Response JSON Format
Successful Example {
"status" : true,
}
Fail Example {
"status" : false,
"error" : "Token invalid. / Document delete fail."
}