Chế độ xem
che do xemBộ lọc giao dịch đã lưu (riêng tôi, cả công ty, cả firm) và ghim lên bảng điều khiển. bo loc giao dich da luu (rieng toi, ca cong ty, ca firm) va ghim len bang dieu khien.Bộ lọc giao dịch đã lưu (riêng tôi, cả công ty, cả firm) và ghim lên bảng điều khiển.
Endpoint
Phần tiêu đề “Endpoint”| Method | Path | Tóm tắt | Quyền | Nhóm tốc độ | Tương tác |
|---|---|---|---|---|---|
GET | /v1/saved-views | Danh sách chế độ xem đã lưu | tx.read | read | Scalar |
POST | /v1/saved-views | Lưu chế độ xem | tx.read | write | Scalar |
PATCH | /v1/saved-views/{id} | Cập nhật chế độ xem | tx.read | write | Scalar |
DELETE | /v1/saved-views/{id} | Xoá chế độ xem | tx.read | write | Scalar |
Chi tiết endpoint
Phần tiêu đề “Chi tiết endpoint”GET /v1/saved-views
Phần tiêu đề “GET /v1/saved-views”Danh sách chế độ xem đã lưu
Chế độ xem của chính người gọi cộng chế độ xem company/firm trong phạm vi được xem. Không phân trang (mỗi người tối đa 100 chế độ xem).
- Nhóm tốc độ:
read - Phản hồi thành công
200: Danh sách. —SavedViewList,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ả |
|---|---|---|---|---|
visibility | query | Không | SavedViewVisibility | me: chỉ mình tôi. company: cả công ty (cần company_id). firm: cả tổ chức (cần quyền quản trị tổ chức). |
company_id | query | Không | OrgId | Mã công ty / tổ chức (org_…). |
curl -sS -X GET "https://api.dongtien.pro/v1/saved-views" \ -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/saved-views");import os
from dongtien import DongTienfrom dongtien_api.api.che_do_xem import list_saved_views
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = list_saved_views.sync(client=dt.client)POST /v1/saved-views
Phần tiêu đề “POST /v1/saved-views”Lưu chế độ xem
firm cần quyền tenant.manage; company cần company_id thuộc phạm vi. Mỗi người tối đa 100 chế độ xem (vượt → 409 conflict); trùng tên trong cùng phạm vi trả 409 conflict.
- Nhóm tốc độ:
write - Nội dung yêu cầu:
CreateSavedView(application/json, bắt buộc) - Phản hồi thành công
201: Đã lưu. —SavedView,application/json - Mã lỗi riêng của endpoint:
conflict,idempotency_in_flight,idempotency_key_reused
Tham số
Phần tiêu đề “Tham số”| Tên | Vị trí | Bắt buộc | Kiểu | Mô tả |
|---|---|---|---|---|
idempotency-key | header | Không | string | Khoá chống gửi trùng (≤ 255 ký tự, nên là UUID). Giữ 24 giờ; gửi lại cùng khoá + cùng nội dung trả lại kết quả cũ. |
curl -sS -X POST "https://api.dongtien.pro/v1/saved-views" \ -H "Authorization: Bearer $DT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Tiền vào hôm nay", "visibility": "me", "filters": {}}'import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.POST("/v1/saved-views", { body: { "name": "Tiền vào hôm nay", "visibility": "me", "filters": {} },});import os
from dongtien import DongTienfrom dongtien_api.api.che_do_xem import create_saved_viewfrom dongtien_api.models import CreateSavedView
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = create_saved_view.sync( client=dt.client, body=CreateSavedView.from_dict({ "name": "Tiền vào hôm nay", "visibility": "me", "filters": {}, }), )PATCH /v1/saved-views/{id}
Phần tiêu đề “PATCH /v1/saved-views/{id}”Cập nhật chế độ xem
Chỉ chủ chế độ xem sửa được; người khác thấy 404. Đổi sang/từ firm cần tenant.manage.
- Nhóm tốc độ:
write - Nội dung yêu cầu:
UpdateSavedView(application/json, bắt buộc) - Phản hồi thành công
200: Sau cập nhật. —SavedView,application/json - Mã lỗi riêng của endpoint:
resource_not_found,conflict,idempotency_in_flight,idempotency_key_reused
Tham số
Phần tiêu đề “Tham số”| Tên | Vị trí | Bắt buộc | Kiểu | Mô tả |
|---|---|---|---|---|
id | path | Có | SavedViewId | Mã chế độ xem đã lưu (svw_…). |
idempotency-key | header | Không | string | Khoá chống gửi trùng (≤ 255 ký tự, nên là UUID). Giữ 24 giờ; gửi lại cùng khoá + cùng nội dung trả lại kết quả cũ. |
curl -sS -X PATCH "https://api.dongtien.pro/v1/saved-views/$ID" \ -H "Authorization: Bearer $DT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "visibility": "me", "company_id": "org_0f5k2m9q4h7t3n8r6v1w0x5yz0"}'import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.PATCH("/v1/saved-views/{id}", { params: { path: { "id": "svw_0f5k2m9q4h7t3n8r6v1w0x5yz0" }, }, body: { "visibility": "me", "company_id": "org_0f5k2m9q4h7t3n8r6v1w0x5yz0" },});import os
from dongtien import DongTienfrom dongtien_api.api.che_do_xem import update_saved_viewfrom dongtien_api.models import UpdateSavedView
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = update_saved_view.sync( id="svw_0f5k2m9q4h7t3n8r6v1w0x5yz0", client=dt.client, body=UpdateSavedView.from_dict({ "visibility": "me", "company_id": "org_0f5k2m9q4h7t3n8r6v1w0x5yz0", }), )DELETE /v1/saved-views/{id}
Phần tiêu đề “DELETE /v1/saved-views/{id}”Xoá chế độ xem
Chỉ chủ chế độ xem xoá được. Chỉ xoá bộ lọc đã lưu, không xoá giao dịch.
Quyền: tx.read Idempotency-Key: tuỳ chọn- Nhóm tốc độ:
write - Phản hồi thành công
204: Đã xoá. — không có nội dung - Mã lỗi riêng của endpoint:
resource_not_found,conflict,idempotency_in_flight,idempotency_key_reused
Tham số
Phần tiêu đề “Tham số”| Tên | Vị trí | Bắt buộc | Kiểu | Mô tả |
|---|---|---|---|---|
id | path | Có | SavedViewId | Mã chế độ xem đã lưu (svw_…). |
idempotency-key | header | Không | string | Khoá chống gửi trùng (≤ 255 ký tự, nên là UUID). Giữ 24 giờ; gửi lại cùng khoá + cùng nội dung trả lại kết quả cũ. |
curl -sS -X DELETE "https://api.dongtien.pro/v1/saved-views/$ID" \ -H "Authorization: Bearer $DT_API_KEY"import { createClient } from "@dongtien/sdk";
const dt = createClient({ apiKey: process.env.DT_API_KEY! });
const { data } = await dt.DELETE("/v1/saved-views/{id}", { params: { path: { "id": "svw_0f5k2m9q4h7t3n8r6v1w0x5yz0" }, },});import os
from dongtien import DongTienfrom dongtien_api.api.che_do_xem import delete_saved_view
with DongTien(api_key=os.environ["DT_API_KEY"]) as dt: result = delete_saved_view.sync(id="svw_0f5k2m9q4h7t3n8r6v1w0x5yz0", client=dt.client)Đối tượng
Phần tiêu đề “Đối tượng”SavedViewList
Phần tiêu đề “SavedViewList”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
data | SavedView[] | Có | — |
data[].company_id | string | null | Có | Công ty của chế độ xem company; null với me/firm. |
data[].created_at | Timestamp | Có | — |
data[].filters | SavedViewFilters | Có | — |
data[].id | SavedViewId | Có | — |
data[].mine | boolean | Có | Người gọi là chủ của chế độ xem này. |
data[].name | string | Có | — |
data[].object | string | Có | Giá trị: saved_view. |
data[].owner_id | UserId | Có | — |
data[].show_count_on_card | boolean | Có | — |
data[].show_in_dashboard_todo | boolean | Có | — |
data[].updated_at | Timestamp | Có | — |
data[].visibility | SavedViewVisibility | Có | Giá trị: me, company, firm. |
has_more | boolean | Có | — |
next_cursor | string | null | Có | Con trỏ trang kế; null khi hết dữ liệu. |
object | string | Có | Giá trị: list. |
CreateSavedView
Phần tiêu đề “CreateSavedView”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_id | string | Không | Bắt buộc khi visibility=company. |
filters | SavedViewFilters | Không | — |
name | string | Có | — |
show_count_on_card | boolean | Không | — |
show_in_dashboard_todo | boolean | Không | — |
visibility | SavedViewVisibility | Không | Giá trị: me, company, firm. |
SavedView
Phần tiêu đề “SavedView”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_id | string | null | Có | Công ty của chế độ xem company; null với me/firm. |
created_at | Timestamp | Có | — |
filters | SavedViewFilters | Có | — |
id | SavedViewId | Có | — |
mine | boolean | Có | Người gọi là chủ của chế độ xem này. |
name | string | Có | — |
object | string | Có | Giá trị: saved_view. |
owner_id | UserId | Có | — |
show_count_on_card | boolean | Có | — |
show_in_dashboard_todo | boolean | Có | — |
updated_at | Timestamp | Có | — |
visibility | SavedViewVisibility | Có | Giá trị: me, company, firm. |
UpdateSavedView
Phần tiêu đề “UpdateSavedView”| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_id | OrgId | null | Không | — |
filters | SavedViewFilters | Không | — |
name | string | Không | — |
show_count_on_card | boolean | Không | — |
show_in_dashboard_todo | boolean | Không | — |
visibility | SavedViewVisibility | Không | Giá trị: me, company, firm. |