Danh sách hợp đồng bán
1. Thông tin API
- Endpoint:
/api/v6.1/sale_contracts - Method:
GET - Authentication: Yêu cầu
X-API-KEY - Header:
X-API-KEY: <your_api_key>
2. Tham số Request
2.1. Filtering (Lọc dữ liệu)
| Trường | Hỗ trợ | Kiểu dữ liệu | Mô tả |
|---|---|---|---|
id | eq, in | integer | Định danh |
valid | eq | integer | Hợp đồng hợp lệ |
expiration_year | eq | integer | Năm hợp đồng kết thúc |
expiration_month | eq | integer | Tháng hợp đồng kết thúc |
expiration_day | eq | integer | Ngày hợp đồng kết thúc |
2.2. Sorting (Sắp xếp dữ liệu)
| Trường | Hướng |
|---|---|
id | asc, desc |
2.3. Pagination (Phân trang)
| Tham số | Kiểu dữ liệu | Mô tả |
|---|---|---|
limit | integer | Số bản ghi cần lấy |
offset | integer | Số bản ghi cần bỏ qua |
3. Response Mẫu
{
"data": [
{
"id": 1,
"contract_code": "HD14912",
"contract_name": "Hợp đồng mẫu",
"contract_status": 1,
"contract_status_label": "Chờ duyệt",
"effective_date": "2025-01-01",
"expiration_date": "2025-12-31",
"vendor_account_id": 532,
"vendor_account_name": "Thành Nguyễn",
"total_payment": 10000000,
"custom_fields": {}
}
],
"has_more": false,
"offset": 0,
"limited": 20,
"sorted": {
"id": "DESC"
}
}
4. Mô tả các Trường Dữ Liệu
4.1. Thông tin hợp đồng
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
id | integer | Định danh |
contract_code | string | Mã hợp đồng |
contract_name | string | Tên hợp đồng |
expiration_day_remain | integer | Số ngày hợp đồng còn lại |
number_of_contract | integer | Số hợp đồng |
contract_status | integer | Trạng thái hợp đồng |
contract_status_label | string | Nhãn trạng thái hợp đồng |
new_contract_label | string | Nhãn loại hợp đồng |
contract_type | integer | Loại hợp đồng |
effective_date | string | Ngày có hiệu lực |
expiration_date | string | Ngày hết hiệu lực |
contract_date | string | Ngày tạo |
contract_terms | array | Danh sách điều khoản |
quote_id | integer | Định danh báo giá |
quote_code | string | Mã báo giá |
payment_methods | integer | Hình thức thanh toán hợp đồng |
payment_methods_name | string | Tên hình thức thanh toán hợp đồng |
start_actual_time | string | Ngày thực tế hợp đồng bắt đầu có hiệu lực |
end_actual_time | string | Ngày thực tế hợp đồng hết hiệu lực |
contract_used | integer | Mã loại sử dụng hợp đồng |
contract_used_label | string | Loại sử dụng hợp đồng |
actual_value | float | Giá trị thực hiện |
project_name | string | Dự án |
project_address | string | Địa điểm dự án |
contract_origin_code | string | Mã hợp đồng gốc |
payment_periods | array | Danh sách kỳ thanh toán |
contract_parent_id | integer | Định danh hợp đồng liên quan |
contract_parent | integer | Hợp đồng liên quan |
contract_children | array | Danh sách hợp đồng con |
4.2. Thông tin khách hàng (Bên A)
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
vendor_account_id | integer | Định danh khách hàng |
vendor_account_name | string | Tên khách hàng |
vendor_account_address | string | Địa chỉ khách hàng |
vendor_account_phone | string | Số điện thoại khách hàng |
vendor_account_fax | string | Số fax khách hàng |
vendor_account_manager | integer | Người phụ trách khách hàng |
vendor_account_manager_name | string | Tên người phụ trách khách hàng |
vendor_contact_name | string | Tên người đại diện bên A |
vendor_contact_title | string | Chức vụ liên hệ khách hàng |
vendor_contact_id | integer | Định danh người đại diện bên A |
vendor_positions | string | Chức vụ người đại diện bên A |
vendor_bank_address | string | Địa chỉ ngân hàng bên A |
vendor_bank_account_number | string | Số tài khoản ngân hàng bên A |
vendor_sic_code | string | Mã số thuế khách hàng |
4.3. Thông tin công ty (Bên B)
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
buyers_account_id | integer | Định danh công ty |
buyers_account_name | string | Tên công ty |
buyers_account_address | string | Địa chỉ công ty |
buyers_account_phone | string | Số điện thoại công ty |
buyers_account_fax | string | Số fax công ty |
buyers_contact_name | string | Tên ngư ời đại diện bên B |
buyers_contact_id | integer | Định danh người đại diện bên B |
buyers_positions | string | Chức vụ người đại diện bên B |
buyers_bank_address | string | Địa chỉ ngân hàng bên B |
buyers_bank_account_number | string | Số tài khoản ngân hàng bên B |
buyers_sic_code | string | Mã số thuế công ty |
4.4. Thông tin tài chính
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
after_vat | integer | Áp dụng chiết khấu sau thuế? |
discount | float | Chiết khấu (%) |
discount_amount | float | Chiết khấu thành tiền ($) |
vat | float | VAT (%) |
vat_amount | float | VAT thành tiền ($) |
total_payment | float | Doanh thu |
total_sale_order_real_amount | float | Tổng doanh thu đơn hàng bán |
total_sale_order_remain_amount | float | Tổng tiền đơn hàng bán còn lại (chưa thanh toán) |
total_sale_order_f_amount | float | Tổng tiền đơn hàng bán đã thanh toán |
performed | string | Đã thực hiện |
number_performed | float | Số tiền đã thực hiện (dạng số) |
4.5. Thông tin người dùng
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
create_user | integer | Định danh người tạo hợp đồng |
create_user_display_name | string | Tên người tạo hợp đồng |
approved_by | integer | Định danh người duyệt hợp đồng |
approved_at | string | Thời gian duyệt |
approved_by_display_name | string | Tên người duyệt hợp đồng |
custom_fields | object | Định nghĩa dữ liệu |
5. Ghi chú
- Trường
custom_fieldschứa các dữ liệu tùy chỉnh của hợp đồng. - Nếu cần lọc dữ liệu nâng cao, có thể kết hợp các tham số filtering, sorting, limit, offset.