- Introduction
- Activity
- Authentication API
- Customer
- Case
- Deal
- Employee
- Expense
- Product
- Create Or Update Products
- Get a Product Ticket
- Get Products With Take & Status
- Get a Product by ProductCode
- Get Product Groups
- Get Product Properties
- Get Products By Filter
- Verify Serial Number
- /v3/Products/serials/status
- Create or Update Codeguard Products
- Update Product Stock
- /v1/products/units
- /v1/products/units Copy
- Quotation
- SalesOrder
- Webhooks
- Task
- Setting
Create Or Update SalesOrder
POST
https://api.gofive.co.th/v2/salesorder
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Header Params
Content-Type
string
required
Example:
application/json
Ocp-Apim-Subscription-Key
string
required
Example:
<Your Subscription-Key>
Body Params application/json
salesOrderSubject
string
required
salesOrderNo
string
optional
salesOrderDate
string
required
referenceNo
string
optional
customerCode
string
required
contactId
integer | null
optional
recipientName
string | null
optional
recipientAddress
string
optional
headerTemplateId
integer | null
optional
salesOrderDetails
array [object {10}]
required
productCode
string
required
productName
string | null
optional
price
number | null
optional
qty
integer
required
productUnitName
string | null
optional
productDescription
string | null
optional
discountValue
number | null
optional
discountType
boolean | null
optional
vatTaxValue
number | null
optional
whtTaxValue
number | null
optional
vatCalculation
boolean
required
discountName
string | null
optional
discountValue
number | null
optional
discountType
boolean | null
optional
paymentTerm
string | null
optional
remark
string | null
optional
staffCode
string
required
salesOrderStatus
integer
required
1 = draft
2 = open
3 = completed
4 = rejected
5 = cancelled]
salesOrderNote
string | null
optional
currencyCode
string | null
optional
payment
object
required
valueType
enum<integer>
optional
Allowed values:
12
schedulePayments
object
required
Example
{
"salesOrderSubject": "string", //หัวเรื่องใบสั่งขาย Required
"salesOrderNo": "string", // เลขใบสั่งขาย (*ถ้าไม่มีการใส่เลขมาเท่ากับการสร้าง)
"salesOrderDate": "2023-01-26", //วันที่สั่งขาย Required โดยมี Format : "YYYY-MM-DD"
"referenceNo": "string", // เลขที่อ้างอิง
"customerCode": "string", // รหัสลูกค้า Required [ตอน Update SalesOrder ไม่สามารถเปลี่ยน Customer ได้]
"contactId": 0, // รหัสผู้ติดต่อ
"recipientName": "test", // ชื่อผู้รับสินค้า
"recipientAddress": "test", // ที่อยู่จัดส่งสินค้า
"headerTemplateId": 1, // หัวเอกสารใน PDF [ถ้าไม่ส่งค่ามาให้เท่ากับ header default company]
"salesOrderDetails": [
{
"productCode": "string", // รหัสสินค้า Required
"productName": "string", // ชื่อสินค้าที่ต้องการกำหนด [null = ชื่อสินค้าตามในระบบ]
"price": 10, // ราคาสินค้าที่ต้องการกำหนด [null = ราคาสินค้าตามในระบบ]
"qty": 1, // จำนวนสินค้า (*กรอกจำนวนได้ไม่เกินสินค้าที่มีใน stock จนกว่าจะมีการเปิด Permission บน Web)
"productUnitName": "", // หน่วยสินค้า [null = หน่วยสินค้าตามในระบบ] (*ถ้าใส่ค่า Unit ไม่ตรงกับระบบ ให้ error)
"productDescription": "", // รายละเอียดสินค้า [null = ราคาละเอียดสินค้าตามในระบบ]
"discountValue": 2.0, // ส่วนลดสินค้า (*ตัว Discount ต้องมีค่าไม่เกิน ราคาของสินค้านั้น)
"discountType": true, // ประเภทส่วนลด true = percentage false = amount (*ระบบจะ required เมื่อมีการใส่ discountValue)
"vatTaxValue": 3.0, // ภาษีมูลค่าเพิ่ม(%) (*ถ้าไม่มีอยู่ในระบบ ให้สร้างใหม่ กรณี inactive ระบบ จะแสดง error) [ถ้าส่ง Null มา ระบบจะ Set เป็น No Vat]
"whtTaxValue": 3.0 // ภาษีหัก ณ ที่จ่าย(%) (*ถ้าไม่มีอยู่ในระบบ จะแสดง error) [ถ้าส่ง Null มา ระบบจะ Set เป็น none]
}
], // รายการสินค้าในใบสั่งขาย Required
"vatCalculation": true, // การคำนวณภาษีมูลค่าเพิ่ม Required [true = ไม่รวมภาษีมูลค่าเพิ่ม false = รวมภาษีมูลค่าเพิ่ม]
"discountName": "just for test", // ชื่อส่วนลดสินค้า
"discountValue": 8.0, // ส่วนลดสินค้า (*ตัว Discount ต้องมีค่าไม่เกิน ราคาของสินค้าทั้งหมด)
"discountType": true, // ประเภทส่วนลด [true = percentage false = amount] (*ระบบจะ required เมื่อมีการใส่ discountValue)
"paymentTerm": "string", // เงื่อนไขการชำระเงิน
"remark": "string", // หมายเหตุใบสั่งขาย
"staffCode": "string", // รหัสพนักงานขาย
"salesOrderStatus": 2, // สถานะใบสั่งขาย [1 = draft 2 = open 3 = completed 4 = rejected 5 = cancelled]
"salesOrderNote": "string", // บันทึกใบสั่งขายเพิ่มเติม
"currencyCode": "string", // สกุลเงิน เช่น "THB" , "USD" [ถ้าไม่ส่ง หรือ null ระบบจะหยิบ System Currency ของ Company นั้นๆให้]
"payment": {
"valueType": 1, //ประเภทยอดชำระ (จำนวนเงิน , เปอร์เซ็นต์)
"schedulePayments": [
{
"installmentNumber": 1, //ช่วงชำระ (รอบ)
"installmentAmount": 10.0, //จำนวนเงิน
"installmentPercent": 50.0 //เปอร์เซ็นต์
},
{
"installmentNumber": 2, //ช่วงชำระ (รอบ)
"installmentAmount": 10.0, //จำนวนเงิน
"installmentPercent": 50.0 //เปอร์เซ็นต์
}
]
}
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.gofive.co.th/v2/salesorder' \
--header 'Ocp-Apim-Subscription-Key: <Your Subscription-Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"salesOrderSubject": "string", //หัวเรื่องใบสั่งขาย Required
"salesOrderNo": "string", // เลขใบสั่งขาย (*ถ้าไม่มีการใส่เลขมาเท่ากับการสร้าง)
"salesOrderDate": "2023-01-26", //วันที่สั่งขาย Required โดยมี Format : "YYYY-MM-DD"
"referenceNo": "string", // เลขที่อ้างอิง
"customerCode": "string", // รหัสลูกค้า Required [ตอน Update SalesOrder ไม่สามารถเปลี่ยน Customer ได้]
"contactId": 0, // รหัสผู้ติดต่อ
"recipientName": "test", // ชื่อผู้รับสินค้า
"recipientAddress": "test", // ที่อยู่จัดส่งสินค้า
"headerTemplateId": 1, // หัวเอกสารใน PDF [ถ้าไม่ส่งค่ามาให้เท่ากับ header default company]
"salesOrderDetails": [
{
"productCode": "string", // รหัสสินค้า Required
"productName": "string", // ชื่อสินค้าที่ต้องการกำหนด [null = ชื่อสินค้าตามในระบบ]
"price": 10, // ราคาสินค้าที่ต้องการกำหนด [null = ราคาสินค้าตามในระบบ]
"qty": 1, // จำนวนสินค้า (*กรอกจำนวนได้ไม่เกินสินค้าที่มีใน stock จนกว่าจะมีการเปิด Permission บน Web)
"productUnitName": "", // หน่วยสินค้า [null = หน่วยสินค้าตามในระบบ] (*ถ้าใส่ค่า Unit ไม่ตรงกับระบบ ให้ error)
"productDescription": "", // รายละเอียดสินค้า [null = ราคาละเอียดสินค้าตามในระบบ]
"discountValue": 2.0, // ส่วนลดสินค้า (*ตัว Discount ต้องมีค่าไม่เกิน ราคาของสินค้านั้น)
"discountType": true, // ประเภทส่วนลด true = percentage false = amount (*ระบบจะ required เมื่อมีการใส่ discountValue)
"vatTaxValue": 3.0, // ภาษีมูลค่าเพิ่ม(%) (*ถ้าไม่มีอยู่ในระบบ ให้สร้างใหม่ กรณี inactive ระบบ จะแสดง error) [ถ้าส่ง Null มา ระบบจะ Set เป็น No Vat]
"whtTaxValue": 3.0 // ภาษีหัก ณ ที่จ่าย(%) (*ถ้าไม่มีอยู่ในระบบ จะแสดง error) [ถ้าส่ง Null มา ระบบจะ Set เป็น none]
}
], // รายการสินค้าในใบสั่งขาย Required
"vatCalculation": true, // การคำนวณภาษีมูลค่าเพิ่ม Required [true = ไม่รวมภาษีมูลค่าเพิ่ม false = รวมภาษีมูลค่าเพิ่ม]
"discountName": "just for test", // ชื่อส่วนลดสินค้า
"discountValue": 8.0, // ส่วนลดสินค้า (*ตัว Discount ต้องมีค่าไม่เกิน ราคาของสินค้าทั้งหมด)
"discountType": true, // ประเภทส่วนลด [true = percentage false = amount] (*ระบบจะ required เมื่อมีการใส่ discountValue)
"paymentTerm": "string", // เงื่อนไขการชำระเงิน
"remark": "string", // หมายเหตุใบสั่งขาย
"staffCode": "string", // รหัสพนักงานขาย
"salesOrderStatus": 2, // สถานะใบสั่งขาย [1 = draft 2 = open 3 = completed 4 = rejected 5 = cancelled]
"salesOrderNote": "string", // บันทึกใบสั่งขายเพิ่มเติม
"currencyCode": "string", // สกุลเงิน เช่น "THB" , "USD" [ถ้าไม่ส่ง หรือ null ระบบจะหยิบ System Currency ของ Company นั้นๆให้]
"payment": {
"valueType": 1, //ประเภทยอดชำระ (จำนวนเงิน , เปอร์เซ็นต์)
"schedulePayments": [
{
"installmentNumber": 1, //ช่วงชำระ (รอบ)
"installmentAmount": 10.0, //จำนวนเงิน
"installmentPercent": 50.0 //เปอร์เซ็นต์
},
{
"installmentNumber": 2, //ช่วงชำระ (รอบ)
"installmentAmount": 10.0, //จำนวนเงิน
"installmentPercent": 50.0 //เปอร์เซ็นต์
}
]
}
}'
Responses
🟢201Created
application/json
Body
status
object
required
code
string
required
description
string
required
data
object
required
salesOrderSubject
string
required
salesOrderNo
string
required
salesOrderStatus
integer
required
salesOrderDate
string
required
referenceNo
string
required
customerCode
string
required
contactId
integer
required
recipientName
string
required
recipientAddress
string
required
headerTemplateId
integer
required
salesorderDetails
array [object {11}]
required
discountName
string
required
discountValue
integer
required
discountType
boolean
required
paymentTerm
string
required
remark
string
required
staffCode
string
required
salesOrderNote
string
required
currencyCode
string
required
vatCalculation
boolean
required
subTotal
number
required
subTotalWithDiscount
number
required
totalVat
number
required
grandTotal
number
required
payment
object
required
Example
{
"status": {
"code": "1000",
"description": "Success"
},
"data": {
"salesOrderSubject": "string",
"salesOrderNo": "string",
"salesOrderStatus": 2,
"salesOrderDate": "2023-01-26T00:00:00+0700",
"referenceNo": "string",
"customerCode": "string",
"contactId": 1,
"recipientName": "string",
"recipientAddress": "string",
"headerTemplateId": 1,
"salesorderDetails": [
{
"productCode": "string",
"productName": "string",
"price": 10,
"qty": 1,
"productUnitName": "อัน",
"productDescription": "",
"discountValue": 2,
"discountType": true,
"vatTaxValue": 3,
"whtTaxValue": 3,
"totalPrice": 9.8
}
],
"discountName": "string",
"discountValue": 8,
"discountType": true,
"paymentTerm": "string",
"remark": "string",
"staffCode": "string",
"salesOrderNote": "string",
"currencyCode": "string",
"vatCalculation": true,
"subTotal": 9.8,
"subTotalWithDiscount": 9.02,
"totalVat": 0.27,
"grandTotal": 9.2906,
"payment": {
"valueType": 1,
"schedulePayments": [
{
"installmentNumber": 1,
"installmentAmount": 10,
"installmentPercent": 50
},
{
"installmentNumber": 2,
"installmentAmount": 10,
"installmentPercent": 50
}
]
}
}
}
🟢200Update
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠401User authentication required V2.
Modified at 2024-09-05 07:27:12