Bảng điều khiển
bang dieu khienSố liệu tổng quan từ sổ giao dịch: số dư, vào/ra hôm nay, việc cần xử lý. so lieu tong quan tu so giao dich: so du, vao/ra hom nay, viec can xu ly.Số liệu tổng quan từ sổ giao dịch: số dư, vào/ra hôm nay, việc cần xử lý.
Endpoint
Phần tiêu đề “Endpoint”| Method | Path | Tóm tắt | Quyền | Nhóm tốc độ | Tương tác |
|---|---|---|---|---|---|
GET | /v1/dashboard/summary | Tổng quan bảng điều khiển | tx.read | read | Scalar |
Chi tiết endpoint
Phần tiêu đề “Chi tiết endpoint”GET /v1/dashboard/summary
Phần tiêu đề “GET /v1/dashboard/summary”Tổng quan bảng điều khiển
Số dư báo cáo, tiền vào/ra (kèm phần tạm tính), bộ đếm việc cần xử lý. Giao dịch cách ly và đã gộp không nằm trong tổng. Quota và dòng tiền do các route riêng trả.
Quyền: tx.read Scope: transactions:read- Nhóm tốc độ:
read - Phản hồi thành công
200: Tổng quan. —DashboardSummary,application/json - Mã lỗi: chỉ các mã lỗi chung ở Tổng quan
Tham số
Phần tiêu đề “Tham số”| Tên | Vị trí | Bắt buộc | Kiểu | Mô tả |
|---|---|---|---|---|
period | query | Không | string | — |
company_id | query | Không | OrgId | Mã công ty / tổ chức (org_…). |
curl -sS -X GET "https://api.dongtien.pro/v1/dashboard/summary" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.GET("/v1/dashboard/summary");import os
from dongtien import DongTienfrom dongtien_api.api.bang_dieu_khien import get_dashboard_summary
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = get_dashboard_summary.sync(client=dt.client)Đối tượng
Phần tiêu đề “Đối tượng”DashboardSummary
Phần tiêu đề “DashboardSummary”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
as_of | Timestamp | Có | — |
balances | object | Có | Số dư hợp nhất: chỉ cộng số dư báo cáo; tài khoản chưa có số dư đếm ở accounts_total. |
balances.accounts | object[] | Có | — |
balances.accounts_reported | integer | Có | — |
balances.accounts_total | integer | Có | — |
balances.reported_total | integer | Có | Tổng số dư báo cáo của các tài khoản đã có số dư (không cộng số tính toán). |
flow | object | Có | — |
flow.count | integer | Có | — |
flow.in | Vnd | Có | — |
flow.out | Vnd | Có | — |
flow.provisional_in | Vnd | Có | — |
flow.provisional_out | Vnd | Có | — |
flow.provisional_share_pct | number | Có | Phần trăm (làm tròn 1 chữ số) tiền vào + ra còn tạm tính trên tổng. |
object | string | Có | Giá trị: dashboard_summary. |
period | object | Có | — |
period.from | Timestamp | Có | — |
period.preset | string | Có | Giá trị: today, 7d, 30d, month. |
period.to | Timestamp | Có | — |
pinned_views | object[] | Có | Chế độ xem ghim lên bảng điều khiển (show_in_dashboard_todo); count chỉ có khi bật show_count_on_card. |
pinned_views[].count | integer | null | Có | — |
pinned_views[].id | SavedViewId | Có | — |
pinned_views[].name | string | Có | — |
today | object | Có | — |
today.from | Timestamp | Có | — |
today.in | Vnd | Có | — |
today.in_count | integer | Có | — |
today.out | Vnd | Có | — |
today.out_count | integer | Có | — |
todos | object | Có | Việc cần xử lý. unrouted_messages đếm tin chưa gán được tài khoản (cần quyền xử lý tin chưa gán, ngược lại 0). reversal_review đếm giao dịch hoàn/huỷ chưa được xem xét (đã liên kết giao dịch gốc, hoặc mồ côi vì không tìm được một giao dịch gốc duy nhất); đóng bằng thẻ reversal_reviewed. |
todos.chain_gaps | integer | Có | — |
todos.needs_attention | integer | Có | — |
todos.provisional_over_24h | integer | Có | — |
todos.quarantined | integer | Có | — |
todos.reversal_review | integer | Có | — |
todos.statement_unmatched | integer | Không | Giao dịch tạm tính nằm trong kỳ của sao kê nhập gần nhất của tài khoản nhưng sao kê không có ("Không có trong sao kê"). Xác thực hoặc lưu trữ giao dịch thì giảm. |
todos.unreconciled | integer | Có | — |
todos.unrouted_messages | integer | Có | — |