Get deal activity history.

# 1. Tổng quan

  • Action URL: /api/v1/deals/history
  • Đặc tả chi tiết: Swagger Link (opens new window)
  • Chức năng: Trả về lịch sử hoạt động của một Opportunity.
  • Điều kiện áp dụng:
    • Chỉ áp dụng cho tài khoản Agency có quyền truy cập hợp lệ.

# 2. Hướng dẫn sử dụng

  1. Bước 1: Xây dựng request với đầy đủ header và body.
  2. Bước 2: Gửi request POST tới Action URL.
  3. Bước 3: Nhận về response chứa danh sách invoices.

# 3. Request

# 3.1 Ví dụ Request

{
  "dealId": "6898de48c1b560cbf",
  "entityType": "",
  "maxSize": 5,
  "offset": 0,
  "orderBy": "createdAt",
  "order": "desc"
}

# 3.2 Cấu trúc dữ liệu Request:

Thuộc tính Bắt buộc Kiểu dữ liệu Mô tả Ví dụ
dealId Có String Mã định danh của deal/opportunity cần lấy invoices 6898de48c1b560cbf
entityType Không String Lọc theo loại entity "Meeting"
maxSize Không Number Giới hạn số bản ghi trả về 5
offset Không Number Vị trí bắt đầu lấy dữ liệu (phân trang) 0
orderBy Không String Trường để sắp xếp kết quả "createdAt"
order Không String Thứ tự sắp xếp (asc hoặc desc) "desc"

# 4. Response

# 4.1 Ví dụ (Response)

{
  "StatusCode": 200,
  "Timestamp": "3:13:45 AM",
  "Path": "/api/v1/deals/history",
  "Message": "Lấy history thành công",
  "Data": {
    "total": 1,
    "list": [
      {
        "id": "68994b1fd85405212",
        "name": "fsdf",
        "deleted": false,
        "status": "Held",
        "dateStart": "2025-08-11 01:45:00",
        "dateEnd": "2025-08-11 02:45:00",
        "isAllDay": false,
        "duration": 3600,
        "createdAt": "2025-08-11 01:45:03",
        "totalSeat": 0,
        "totalPrice": 0,
        "ticketType": "Admission Ticket Included",
        "dateStartDate": null,
        "dateEndDate": null,
        "parentId": "6898de48c1b560cbf",
        "parentType": "Opportunity",
        "assignedUserId": null,
        "assignedUserName": null,
        "_scope": "Meeting"
      }
    ]
  },
  "Errors": null,
  "RequestId": "req_1760584425095_aujy9gzhx",
  "TotalDuration": 469
}

# 4.2 Bảng mô tả trường (Response)

| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả | Ví dụ |

Thuộc tính Bắt buộc Kiểu dữ liệu Mô tả Ví dụ
StatusCode Có String Tình trạng tạo sub
Timestamp Có String Thời gian xử lý request
Path Có String
Message Có String Thông báo kết quả
Errors Không String Thông tin lỗi nếu có
RequestId Có String Mã định danh request
TotalDuration Có string Thời gian xử lý (ms)
total Có Integer Tổng số bản ghi lịch sử được tìm thấy.
list Có Array Danh sách các bản ghi lịch sử.
id Có String Mã định danh duy nhất của bản ghi lịch sử.
name Có String Tên hoặc mô tả của hoạt động.
deleted Có Boolean Trạng thái đã xóa hay chưa.
status Có String Trạng thái hoạt động
dateStart Có string Thời gian bắt đầu hoạt động.
dateEnd Có string Thời gian kết thúc hoạt động.
isAllDay Không boolean Hoạt động kéo dài cả ngày hay không.
duration Không interger Thời lượng của hoạt động
createdAt Có String Thời gian tạo bản ghi
totalSeat Không integer Tông số ghế
totalPrice Không Number Tổng số tiền
ticketType Không String Loại vé hoặc hạng mục liên quan
dateStartDate Không String Ngày bắt đầu
dateEndDate Không String Ngày kết thúc
parentId Có String ID của đối tượng cha
parentType Có String Loại đối tượng cha
assignedUserId Không String ID của người được giao phụ trách
assignedUserName Không String Tên người được giao phụ trách
scope Có String Phạm vi hoặc loại hoạt động

# Bảng mô tả mã tình trạng tạo sub

Mã Ý nghĩa
200 Thành công
400 Dữ liệu không hợp lệ
401 Không có quyền tạo sub
404 DealId không tồn tại trong hệ thống
500 Lỗi từ phía server

This site uses cookies to learn which topics interest our readers.