Get deal invoices.

# 1. Tổng quan

  • Action URL: /api/v1/deals/invoices
  • Đặc tả chi tiết: Swagger Link (opens new window)
  • Tính năng này cho phép trả về danh sách hóa đơn (invoices) thuộc về một Opportunity (Deal) trong CRM.
  • Chỉ áp dụng cho tài khoản Agency có quyền truy cập hợp lệ và cung cấp đúng thông tin xác thực trong header (token, password, account).

# 2. Hướng dẫn

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

# 3. Request

# 3.1 Ví dụ

{
  "dealId": "6898de48c1b560cbf",
  "primaryFilter": "",
  "select": [
    "amountCurrency",
    "amount",
    "createdAt",
    "transactionType",
    "type",
    "status",
    "name"
  ],
  "maxSize": 5,
  "offset": 0,
  "orderBy": "createdAt",
  "order": "desc"
}

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

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"
primaryFilter Không String Bộ lọc chính ""
Select Không Array Danh sách các trường lấy trong invoices ["name","status","amount"]
maxSize Có Number Số bản ghi tối đa trả về 5
offset Có Number Vị trí bắt đầu lấy dữ liệu (phân trang) 0
orderBy Có String Trường để sắp xếp kết quả "createdAt"
order Không String Thứ tự sắp xếp "desc"

# 4. Response

# 4.1 Ví dụ

{
  "StatusCode": 200,
  "Timestamp": "2:04:14 AM",
  "Path": "/api/v1/deals/invoices",
  "Message": "Lấy invoices thành công",
  "Data": {
    "total": 2,
    "list": [
      {
        "id": "68a1482f56f76cadf",
        "name": "Hóa đơn Đặt vé VNA - D3YXKH",
        "status": "Pending",
        "amount": 1216122,
        "createdAt": "2025-08-17 03:10:39",
        "type": "Flight",
        "transactionType": "Sale",
        "amountCurrency": "VND",
        "accountId": "68984182c8bec9a54",
        "createdById": "676cc0521107ef6ca",
        "assignedUserId": null
      },
      {
        "id": "6898de4a85edb0d61",
        "name": "Hóa đơn Đặt vé VNA - D3YXKH",
        "status": "Pending",
        "amount": 1216000,
        "createdAt": "2025-08-10 18:00:42",
        "type": "Flight",
        "transactionType": "Sale",
        "amountCurrency": "VND",
        "accountId": "68984182c8bec9a54",
        "createdById": "67b0376d4e804731f",
        "assignedUserId": null
      }
    ]
  },
  "Errors": null,
  "RequestId": "req_1760580254134_hxgndw5f3",
  "TotalDuration": 441
}

# 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ụ
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)
Data Có Object Đối tượng chứa dữ liệu chính trả về từ API
total Có Integer Tổng số lượng lead được tìm thấy
list Có Array Danh sách các lead (mỗi phần tử là một đối tượng lead)
id Có String Mã định danh duy nhất của hóa đơn
name Có String Tên hoặc tiêu đề của hóa đơn
status Có String Trạng thái hiện tại của hóa đơn
amount Có Number Tổng giá trị tiền của hóa đơn
createdAt Có String Thời gian tạo hóa đơn, định dạng yyyy-MM-DD
type Có String Loại dịch vụ liên quan đến hóa đơn
trannsactionType Có String Loại dịch vụ của đơn
amountCurrency Có String Loại tiền tệ của giá trị hóa đơn
accountId Có String Mã định danh của tài khoản liên quan đến hóa đơn
createdById Có String ID của người tạo hóa đơn
assignedUserId Không String ID của người được giao xử lý hóa đơn

# 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.