Bỏ qua để đến nội dung

Đối tác

~16 phút đọc

Đối tác thanh toán, khoản thu dự kiến và công việc theo dõi công nợ.

MethodPathTóm tắtQuyềnNhóm tốc độTương tác
GET/v1/counterpartiesDanh sách đối tượng (khách hàng, nhà cung cấp)counterparty.readreadScalar
POST/v1/counterpartiesTạo đối tượng mớicounterparty.writewriteScalar
GET/v1/counterparties/{id}Chi tiết đối tượngcounterparty.readreadScalar
PATCH/v1/counterparties/{id}Cập nhật đối tượngcounterparty.writewriteScalar
POST/v1/counterparties/{id}:refresh-tax-statusLàm mới trạng thái thuế từ masothue.procounterparty.writewriteScalar
POST/v1/counterparties:mergeGộp 2 đối tượng trong cùng công tycounterparty.mergewriteScalar
GET/v1/settlement/connectionsDanh sách kết nối gian hàngsettlement.readreadScalar
PUT/v1/settlement/connectionsTạo hoặc cập nhật kết nối gian hàngpartner.writewriteScalar
POST/v1/settlement/connections/{id}:reconnectCấp lại xác thực OAuth gian hàngpartner.writewriteScalar
GET/v1/settlement/partnersDanh sách đối tác sàn/hãng/CTVsettlement.readreadScalar
POST/v1/settlement/partnersTạo đối tác mớipartner.writewriteScalar
GET/v1/settlement/partners/{id}Chi tiết đối tácsettlement.readreadScalar
PATCH/v1/settlement/partners/{id}Cập nhật thông tin đối tácpartner.writewriteScalar
GET/v1/settlement/partners/{id}/membersDanh sách thành viên CTV của đối tácsettlement.readreadScalar
POST/v1/settlement/partners/{id}/members:importNhập danh sách thành viên CTVpartner.writewriteScalar
POST/v1/settlement/partners/{id}:approveDuyệt kích hoạt đối tácpartner.approvewriteScalar
POST/v1/settlement/partners/{id}:rejectTừ chối duyệt đối tácpartner.approvewriteScalar

Danh sách đối tượng (khách hàng, nhà cung cấp)

Quyền: counterparty.read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách đối tác — CounterpartyList, application/json
  • Mã lỗi riêng của endpoint: invalid_cursor
TênVị tríBắt buộcKiểuMô tả
limitqueryKhôngintegerSố phần tử mỗi trang (1–100, mặc định 20).
cursorqueryKhôngCursorCon trỏ phân trang mờ (cur_…) lấy từ next_cursor; không tự tạo hay sửa.
company_idqueryKhôngOrgIdMã công ty / tổ chức (org_…).
kindqueryKhôngstring—
qqueryKhôngstring—
curl -sS -X GET "https://api.dongtien.pro/v1/counterparties" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Tạo đối tượng mới

Quyền: counterparty.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json)
  • Phản hồi thành công 201: Đối tác đã được tạo — object, application/json
  • Mã lỗi riêng của endpoint: conflict
TênVị tríBắt buộcKiểuMô tả
company_idqueryKhôngOrgIdMã công ty / tổ chức (org_…).
curl -sS -X POST "https://api.dongtien.pro/v1/counterparties" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Công ty TNHH Thương mại Sao Việt",
"kind": "customer",
"tax_code": "0312345678",
"address": "25 Nguyễn Huệ, Phường Bến Nghé, Quận 1, TP. Hồ Chí Minh",
"phone": "0901234567",
"email": "ketoan@saoviet.vn",
"bank_accounts": [
{
"bank_code": "VCB",
"account_number": "0011004567890",
"account_holder": "CONG TY TNHH THUONG MAI SAO VIET"
}
]
}'

Mở trong tài liệu tương tác

Chi tiết đối tượng

Quyền: counterparty.read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Chi tiết đối tác — object, application/json
  • Mã lỗi riêng của endpoint: resource_not_found
TênVị tríBắt buộcKiểuMô tả
idpathCóCounterpartyIdMã đối tác (cpt_…).
curl -sS -X GET "https://api.dongtien.pro/v1/counterparties/$ID" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Cập nhật đối tượng

Quyền: counterparty.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json)
  • Phản hồi thành công 200: Đối tác đã cập nhật — object, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
idpathCóCounterpartyIdMã đối tác (cpt_…).
curl -sS -X PATCH "https://api.dongtien.pro/v1/counterparties/$ID" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"kind": "customer"
}'

Mở trong tài liệu tương tác

Làm mới trạng thái thuế từ masothue.pro

Quyền: counterparty.write
  • Nhóm tốc độ: write
  • Phản hồi thành công 200: Trạng thái thuế đã làm mới — object, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
idpathCóCounterpartyIdMã đối tác (cpt_…).
curl -sS -X POST "https://api.dongtien.pro/v1/counterparties/$ID:refresh-tax-status" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Gộp 2 đối tượng trong cùng công ty

Quyền: counterparty.merge
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json)
  • Phản hồi thành công 200: Gộp thành công — object, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X POST "https://api.dongtien.pro/v1/counterparties:merge" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"source_id": "cpt_0f5k2m9q4h7t3n8r6v1w0x5yz0",
"target_id": "cpt_0f5k2m9q4h7t3n8r6v1w0x5yz0"
}'

Mở trong tài liệu tương tác

Danh sách kết nối gian hàng

Quyền: settlement.read Scope: settlement:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách kết nối. — object, application/json
  • Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
TênVị tríBắt buộcKiểuMô tả
partner_idqueryKhôngPartnerIdMã đối tác sàn/hãng/CTV (ptn_…).
curl -sS -X GET "https://api.dongtien.pro/v1/settlement/connections" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Tạo hoặc cập nhật kết nối gian hàng

Quyền: partner.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: UpsertConnectionBody (application/json)
  • Phản hồi thành công 200: Kết nối đã được lưu. — PlatformConnection, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X PUT "https://api.dongtien.pro/v1/settlement/connections" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"partner_id": "ptn_0f5k2m9q4h7t3n8r6v1w0x5yz0",
"platform": "shopee",
"shop_id": "shopee_88123456",
"shop_name": "Cửa hàng Minh Anh",
"mode": "excel"
}'

Mở trong tài liệu tương tác

Cấp lại xác thực OAuth gian hàng

Quyền: partner.write
  • Nhóm tốc độ: write
  • Phản hồi thành công 200: Đường dẫn cấp lại xác thực. — object, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
idpathCóPlatformConnectionIdMã kết nối gian hàng (plc_…).
curl -sS -X POST "https://api.dongtien.pro/v1/settlement/connections/$ID:reconnect" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Danh sách đối tác sàn/hãng/CTV

Liệt kê danh sách đối tác đối soát theo tổ chức.

Quyền: settlement.read Scope: settlement:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Danh sách đối tác. — PartnerList, application/json
  • Mã lỗi riêng của endpoint: invalid_cursor
TênVị tríBắt buộcKiểuMô tả
cursorqueryKhôngCursorCon trỏ phân trang mờ (cur_…) lấy từ next_cursor; không tự tạo hay sửa.
limitqueryKhônginteger—
kindqueryKhôngPartnerKindmarketplace sàn TMĐT · agent đại lý bán lẻ · brand_consignor hãng/chủ hàng ký gửi · ctv_group nhóm cộng tác viên.
statequeryKhôngPartnerStatedraft mới tạo · pending_approval chờ duyệt · active đang hoạt động · archived lưu trữ.
curl -sS -X GET "https://api.dongtien.pro/v1/settlement/partners" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Tạo đối tác mới

Tạo đối tác ở trạng thái draft. Đối tác mới cần phê duyệt trước khi kích hoạt sinh nghĩa vụ.

Quyền: partner.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: CreatePartnerBody (application/json)
  • Phản hồi thành công 201: Đối tác đã tạo thành công. — Partner, application/json
  • Mã lỗi riêng của endpoint: conflict
curl -sS -X POST "https://api.dongtien.pro/v1/settlement/partners" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"kind": "ctv_group",
"name": "Nhóm CTV Hà Nội",
"legal_name": "Công ty TNHH Thương mại Minh Anh",
"mst": "0312345678",
"cycle": {
"kind": "monthly"
},
"payment_terms_days": 7,
"data_source": "excel"
}'

Mở trong tài liệu tương tác

Chi tiết đối tác

Lấy thông tin chi tiết của một đối tác.

Quyền: settlement.read Scope: settlement:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Chi tiết đối tác. — Partner, application/json
  • Mã lỗi riêng của endpoint: resource_not_found
TênVị tríBắt buộcKiểuMô tả
idpathCóPartnerIdMã đối tác sàn/hãng/CTV (ptn_…).
curl -sS -X GET "https://api.dongtien.pro/v1/settlement/partners/$ID" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Cập nhật thông tin đối tác

Quyền: partner.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: UpdatePartnerBody (application/json)
  • Phản hồi thành công 200: Thông tin đã cập nhật. — Partner, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
idpathCóPartnerIdMã đối tác sàn/hãng/CTV (ptn_…).
curl -sS -X PATCH "https://api.dongtien.pro/v1/settlement/partners/$ID" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"kind": "marketplace",
"cycle": {
"kind": "daily"
},
"payment_terms_days": 0,
"data_source": "excel"
}'

Mở trong tài liệu tương tác

Danh sách thành viên CTV của đối tác

STK và MST chỉ trả dạng đã che; bản đầy đủ nằm mã hoá trong cơ sở dữ liệu và không bao giờ ra ngoài API.

Quyền: settlement.read Scope: settlement:read
  • Nhóm tốc độ: read
  • Phản hồi thành công 200: Thành viên của đối tác. — object, application/json
  • Mã lỗi riêng của endpoint: resource_not_found
TênVị tríBắt buộcKiểuMô tả
idpathCóPartnerIdMã đối tác sàn/hãng/CTV (ptn_…).
curl -sS -X GET "https://api.dongtien.pro/v1/settlement/partners/$ID/members" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Nhập danh sách thành viên CTV

Nhập file Excel chứa tên, MST/CCCD, STK ngân hàng. Dữ liệu PII được mã hoá AES-256-GCM tại cột lưu trữ.

Quyền: partner.write
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json)
  • Phản hồi thành công 200: Kết quả nhập thành viên. — object, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
idpathCóPartnerIdMã đối tác sàn/hãng/CTV (ptn_…).
curl -sS -X POST "https://api.dongtien.pro/v1/settlement/partners/$ID/members:import" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"members": [
{
"name": "Nguyễn Văn An",
"tax_id": "8012345678",
"bank_account": "0123456789",
"bank_bin": "970436"
}
]
}'

Mở trong tài liệu tương tác

Duyệt kích hoạt đối tác

Maker-checker: Người duyệt phải khác người tạo đối tác.

Quyền: partner.approve
  • Nhóm tốc độ: write
  • Phản hồi thành công 200: Đối tác đã được kích hoạt. — Partner, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
idpathCóPartnerIdMã đối tác sàn/hãng/CTV (ptn_…).
curl -sS -X POST "https://api.dongtien.pro/v1/settlement/partners/$ID:approve" \
-H "Authorization: Bearer $DT_API_KEY"

Mở trong tài liệu tương tác

Từ chối duyệt đối tác

Quyền: partner.approve
  • Nhóm tốc độ: write
  • Nội dung yêu cầu: object (application/json)
  • Phản hồi thành công 200: Đối tác đã bị từ chối. — Partner, application/json
  • Mã lỗi riêng của endpoint: resource_not_found, conflict
TênVị tríBắt buộcKiểuMô tả
idpathCóPartnerIdMã đối tác sàn/hãng/CTV (ptn_…).
curl -sS -X POST "https://api.dongtien.pro/v1/settlement/partners/$ID:reject" \
-H "Authorization: Bearer $DT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"reason": "Thiếu hồ sơ pháp lý của đối tác"
}'

Mở trong tài liệu tương tác

TrườngKiểuBắt buộcMô tả
dataobject[]Có—
data[].addressstring | nullKhông—
data[].bank_accountsobject[]Không—
data[].emailstring | nullKhông—
data[].idCounterpartyIdCó—
data[].kindstringCóGiá trị: customer, vendor, both, retail_customer, marketplace, other.
data[].last_tx_atTimestamp | nullKhông—
data[].namestringCó—
data[].name_normstringCó—
data[].notesstring | nullKhông—
data[].org_idOrgIdCó—
data[].phonestring | nullKhông—
data[].tax_codestring | nullKhông—
data[].tax_statusstring | nullKhông—
data[].tax_status_checked_atTimestamp | nullKhông—
data[].tax_status_stalebooleanKhông—
data[].total_90dVndKhông—
data[].tx_count_90dintegerKhông—
has_morebooleanCó—
next_cursorstring | nullCóCon trỏ trang kế; null khi hết dữ liệu.
objectstringCóGiá trị: list.
TrườngKiểuBắt buộcMô tả
modestringCóGiá trị: excel, api_seller, manual.
partner_idPartnerIdCó—
platformSettlementPlatformCóGiá trị: shopee, tiktok, lazada.
shop_idstringCó—
shop_namestringKhông—
token_sealedstringKhông—
TrườngKiểuBắt buộcMô tả
created_atTimestampCó—
idPlatformConnectionIdCó—
last_sync_atTimestamp | nullKhông—
modePlatformConnectionModeCóGiá trị: excel, api_seller, manual.
partner_idPartnerIdCó—
platformSettlementPlatformCóGiá trị: shopee, tiktok, lazada.
shop_idstringCó—
shop_namestring | nullKhông—
sync_statusstringCóGiá trị: ok, error, reauth_required.
token_expires_atTimestamp | nullKhông—
updated_atTimestampCó—
TrườngKiểuBắt buộcMô tả
dataPartner[]Có—
data[].approved_byUserId | nullKhông—
data[].bank_account_refstring | nullKhông—
data[].created_atTimestampCó—
data[].created_byUserId | nullKhông—
data[].cyclePartnerCycleCó—
data[].data_sourcestringCóGiá trị: excel, api_seller, manual.
data[].idPartnerIdCó—
data[].internal_notestring | nullKhông—
data[].kindPartnerKindCóGiá trị: marketplace, agent, brand_consignor, ctv_group.
data[].legal_namestring | nullKhông—
data[].mststring | nullKhông—
data[].namestringCó—
data[].org_idOrgIdCó—
data[].payment_terms_daysintegerCó—
data[].statePartnerStateCóGiá trị: draft, pending_approval, active, archived.
data[].updated_atTimestampCó—
has_morebooleanCó—
next_cursorstring | nullCóCon trỏ trang kế; null khi hết dữ liệu.
objectstringCóGiá trị: list.
TrườngKiểuBắt buộcMô tả
bank_account_refstringKhông—
cycleobjectCó—
cycle.kindstringCóGiá trị: daily, weekly, monthly, biweekly.
cycle.paramsmap<string, any>Không—
data_sourcestringKhôngGiá trị: excel, api_seller, manual.
internal_notestringKhông—
kindPartnerKindCóGiá trị: marketplace, agent, brand_consignor, ctv_group.
legal_namestringKhông—
mststringKhông—
namestringCó—
payment_terms_daysintegerKhông—
TrườngKiểuBắt buộcMô tả
approved_byUserId | nullKhông—
bank_account_refstring | nullKhông—
created_atTimestampCó—
created_byUserId | nullKhông—
cyclePartnerCycleCó—
cycle.kindstringCóGiá trị: daily, weekly, monthly, biweekly.
cycle.paramsmap<string, any>Không—
data_sourcestringCóGiá trị: excel, api_seller, manual.
idPartnerIdCó—
internal_notestring | nullKhông—
kindPartnerKindCóGiá trị: marketplace, agent, brand_consignor, ctv_group.
legal_namestring | nullKhông—
mststring | nullKhông—
namestringCó—
org_idOrgIdCó—
payment_terms_daysintegerCó—
statePartnerStateCóGiá trị: draft, pending_approval, active, archived.
updated_atTimestampCó—
TrườngKiểuBắt buộcMô tả
bank_account_refstringKhông—
cycleobjectKhông—
cycle.kindstringCóGiá trị: daily, weekly, monthly, biweekly.
cycle.paramsmap<string, any>Không—
data_sourcestringKhôngGiá trị: excel, api_seller, manual.
internal_notestringKhông—
kindPartnerKindKhôngGiá trị: marketplace, agent, brand_consignor, ctv_group.
legal_namestringKhông—
mststringKhông—
namestringKhông—
payment_terms_daysintegerKhông—