Skip to main content

Danh sách hợp đồng mua

1. Thông tin API

  • Endpoint: /api/v6.1/purchase_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ườngHỗ trợKiểu dữ liệuMô tả
ideq, inintegerĐịnh danh
valideqintegerHợp đồng hợp lệ
expiration_yeareqintegerNăm hợp đồng kết thúc
expiration_montheqintegerTháng hợp đồng kết thúc
expiration_dayeqintegerNgày hợp đồng kết thúc

2.2. Sorting (Sắp xếp dữ liệu)

TrườngHướng
idasc, desc

2.3. Pagination (Phân trang)

Tham sốKiểu dữ liệuMô tả
limitintegerSố bản ghi cần lấy
offsetintegerSố bản ghi cần bỏ qua

3. Response Mẫu

{
"data": [
{
"id": 1,
"contract_code": "HDM001",
"contract_name": "Hợp đồng mua 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": "Nhà cung cấp A",
"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ườngKiểu dữ liệuMô tả
idintegerĐịnh danh
contract_codestringMã hợp đồng
contract_namestringTên hợp đồng
expiration_day_remainintegerSố ngày hợp đồng còn lại
number_of_contractintegerSố hợp đồng
contract_statusintegerTrạng thái hợp đồng
contract_status_labelstringNhãn trạng thái hợp đồng
new_contract_labelstringNhãn loại hợp đồng
contract_typeintegerLoại hợp đồng
effective_datestringNgày có hiệu lực
expiration_datestringNgày hết hiệu lực
contract_datestringNgày tạo
contract_termsarrayDanh sách điều khoản
quote_idintegerĐịnh danh báo giá
quote_codestringMã báo giá
payment_methodsintegerHình thức thanh toán hợp đồng
payment_methods_namestringTên hình thức thanh toán hợp đồng
start_actual_timestringNgày thực tế hợp đồng bắt đầu có hiệu lực
end_actual_timestringNgày thực tế hợp đồng hết hiệu lực
contract_usedintegerMã loại sử dụng hợp đồng
contract_used_labelstringLoại sử dụng hợp đồng
actual_valuefloatGiá trị thực hiện
project_namestringDự án
project_addressstringĐịa điểm dự án
contract_origin_codestringMã hợp đồng gốc
payment_periodsarrayDanh sách kỳ thanh toán
contract_parent_idintegerĐịnh danh hợp đồng liên quan
contract_parentintegerHợp đồng liên quan
contract_childrenarrayDanh sách hợp đồng con

4.2. Thông tin khách hàng (Bên A)

TrườngKiểu dữ liệuMô tả
vendor_account_idintegerĐịnh danh khách hàng
vendor_account_namestringTên khách hàng
vendor_account_addressstringĐịa chỉ khách hàng
vendor_account_phonestringSố điện thoại khách hàng
vendor_account_faxstringSố fax khách hàng
vendor_account_managerintegerNgười phụ trách khách hàng
vendor_account_manager_namestringTên người phụ trách khách hàng
vendor_contact_namestringTên người đại diện bên A
vendor_contact_titlestringChức vụ liên hệ khách hàng
vendor_contact_idintegerĐịnh danh người đại diện bên A
vendor_positionsstringChức vụ người đại diện bên A
vendor_bank_addressstringĐịa chỉ ngân hàng bên A
vendor_bank_account_numberstringSố tài khoản ngân hàng bên A
vendor_sic_codestringMã số thuế khách hàng

4.3. Thông tin công ty (Bên B)

TrườngKiểu dữ liệuMô tả
buyers_account_idintegerĐịnh danh công ty
buyers_account_namestringTên công ty
buyers_account_addressstringĐịa chỉ công ty
buyers_account_phonestringSố điện thoại công ty
buyers_account_faxstringSố fax công ty
buyers_contact_namestringTên người đại diện bên B
buyers_contact_idintegerĐịnh danh người đại diện bên B
buyers_positionsstringChức vụ người đại diện bên B
buyers_bank_addressstringĐịa chỉ ngân hàng bên B
buyers_bank_account_numberstringSố tài khoản ngân hàng bên B
buyers_sic_codestringMã số thuế công ty

4.4. Thông tin tài chính

TrườngKiểu dữ liệuMô tả
after_vatintegerÁp dụng chiết khấu sau thuế?
discountfloatChiết khấu (%)
discount_amountfloatChiết khấu thành tiền ($)
vatfloatVAT (%)
vat_amountfloatVAT thành tiền ($)
total_paymentfloatDoanh thu
total_purchase_order_real_amountfloatTổng doanh thu đơn hàng mua
total_purchase_order_remain_amountfloatTổng tiền đơn hàng mua còn lại (chưa thanh toán)
total_purchase_order_f_amountfloatTổng tiền đơn hàng mua đã thanh toán
performedstringĐã thực hiện
number_performedfloatSố tiền đã thực hiện (dạng số)

4.5. Thông tin người dùng

TrườngKiểu dữ liệuMô tả
create_userintegerĐịnh danh người tạo hợp đồng
create_user_display_namestringTên người tạo hợp đồng
approved_byintegerĐịnh danh người duyệt hợp đồng
approved_atstringThời gian duyệt
approved_by_display_namestringTên người duyệt hợp đồng
custom_fieldsobjectĐịnh nghĩa dữ liệu

5. Ghi chú

  • Trường custom_fields chứ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.