Sales Credit Note
- Sales Credit Note List
- Get Sales Credit Note
- Create Sales Credit Note
- Edit Sales Credit Note
- Delete 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."
}