diff --git a/index.html b/index.html index 065851a..940ab63 100644 --- a/index.html +++ b/index.html @@ -12,6 +12,7 @@ a { color: #0b63ce; text-decoration: none; } a:hover { text-decoration: underline; } ul { margin: 0; padding-left: 18px; } + li { margin-bottom: 12px; } .note { font-size: 14px; color: #4b5563; } @@ -31,6 +32,12 @@

Danh sách module API

Mở module Order (HTML)
Mở module Order (MD) + +
  • + TaxCDS
    + Mở module TaxCDS (HTML)
    + Mở module TaxCDS (MD) +
    • @@ -64,10 +71,13 @@

    Callback / Webhooks

    Data test tham chiếu

    Lưu ý: chỉ dùng để test/integration, cần thay bằng dữ liệu môi trường thật trước production.

    - + \ No newline at end of file diff --git a/index.md b/index.md index 4e37917..42e721c 100644 --- a/index.md +++ b/index.md @@ -8,6 +8,10 @@ Tài liệu này là trang chủ cho toàn bộ API dành cho đối tác. - Module index HTML: ./modules/Order/index.html - Module index MD: ./modules/Order/index.md +2. TaxCDS +- Module index HTML: ./modules/TaxCDS/index.html +- Module index MD: ./modules/TaxCDS/index.md + ## Callback / Webhooks 1. Lịch hẹn @@ -38,4 +42,11 @@ Tài liệu này là trang chủ cho toàn bộ API dành cho đối tác. - clientId: TESTCLIENT - apiKey: 07e73e61-0dce-4b39-8ecf-06ef70b35c08 -Developer cần thay lại credential và dữ liệu order theo môi trường thật trước khi UAT/production. +## Data test đang dùng cho TaxCDS + +- apikey: 911abff6-137a-4aa3-a836-555a1d30359b +- taxCode: 8173748371 +- citizenIdentityNumber: 079183000002 +- taxpayerName: Nguyễn Văn A + +Developer cần thay lại credential và dữ liệu theo môi trường thật trước khi UAT/production. \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSDeclarationStatusLookup_LookupDeclarationStatus.html b/modules/TaxCDS/TaxCDSDeclarationStatusLookup_LookupDeclarationStatus.html new file mode 100644 index 0000000..535012e --- /dev/null +++ b/modules/TaxCDS/TaxCDSDeclarationStatusLookup_LookupDeclarationStatus.html @@ -0,0 +1,171 @@ + + + + + + Tra cứu tình trạng nộp tờ khai + + + +
    +
    +

    Partner API - Tra cứu tình trạng nộp tờ khai

    +

    Tra cứu tình trạng nộp tờ khai theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế.

    +

    Về module TaxCDS

    +
    + +
    +

    Endpoint

    + + + +
    URL/TaxCDSDeclarationStatusLookup/partner/lookupDeclarationStatus
    MethodPOST
    +
    + +
    +

    Headers schema

    + + + +
    HeaderRequiredMô tả
    apikeyYesKhóa xác thực API của đối tác
    +
    + +
    +

    Body schema

    + + + + + + + + + + + + + + + +
    FieldTypeRequiredRuleMô tả
    filterobjectYesBắt buộcNhóm điều kiện tra cứu.
    filter.taxCodestringNoCó thể rỗngMã số thuế cần tra cứu.
    filter.citizenIdentityNumberstringNoCó thể rỗngSố CCCD/CMND cần tra cứu.
    filter.taxpayerNamestringNoCó thể rỗng, hỗ trợ tìm gần đúngTên người nộp thuế cần tra cứu.
    filter.declarationStatusstringNoCó thể rỗngTrạng thái nộp tờ khai.
    filter.declarationPeriodstringNoCó thể rỗngKỳ kê khai.
    filter.declarationTypestringNoCó thể rỗngLoại tờ khai.
    skipnumberNoMặc định 0, nhỏ nhất 0Số bản ghi bỏ qua.
    limitnumberNoMặc định 20, lớn nhất 100Số bản ghi tối đa trả về.
    startDatestringNoChuỗi ngày thángLọc bản ghi tạo từ ngày.
    endDatestringNoChuỗi ngày thángLọc bản ghi tạo đến ngày.
    order.keystringNoMặc định createdAtTên trường dùng để sắp xếp.
    order.valuestringNoasc hoặc desc, mặc định descChiều sắp xếp.
    +

    Cần truyền ít nhất một điều kiện tra cứu trong filter: taxCode, citizenIdentityNumber hoặc taxpayerName.

    +
    + +
    +

    + Sample Request + +

    + 
    curl --location 'http://localhost:4001/TaxCDSDeclarationStatusLookup/partner/lookupDeclarationStatus' \
+  --header 'Content-Type: application/json' \
+  --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \
+  --data '{
+  "filter": {
+    "taxCode": "8173748371"
+  },
+  "skip": 0,
+  "limit": 10
+}'
    +
    + +
    +

    Success response

    + 
    {
+  "statusCode": 200,
+  "error": null,
+  "message": "Success",
+  "data": {
+    "data": [
+      {
+        "taxCDSDeclStatusLookupId": 1,
+        "taxCode": "8173748371",
+        "citizenIdentityNumber": "079183000002",
+        "taxpayerName": "Nguyễn Văn A",
+        "taxDepartment": "Chi cục Thuế khu vực",
+        "declarationStatus": "OVERDUE",
+        "statusTitle": "Quá hạn nộp tờ khai",
+        "statusDescription": "Đã quá hạn nộp tờ khai.",
+        "submitDate": "15/01/2026",
+        "declarationPeriod": "01/2026",
+        "declarationType": "Tờ khai thuế",
+        "declarationCode": "TK-001",
+        "receivedDate": "",
+        "processedDate": "",
+        "rejectedReason": "",
+        "additionalRequest": "",
+        "note": "",
+        "updatedAt": "2026-05-27T04:11:56.000Z",
+        "createdAt": "2026-05-27T04:11:56.000Z",
+        "isHidden": 0,
+        "isDeleted": 0
+      }
+    ],
+    "totalNextPage": 0
+  }
+}
    +
    + +
    +

    Mã lỗi

    + + + + + + +
    HTTPMã lỗiMô tả
    400Validation ErrorPayload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn.
    429QUOTA_EXCEEDEDapikey không hợp lệ hoặc vượt quota.
    500MISSING_LOOKUP_FIELDThiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế.
    500UNKNOWN_ERRORLỗi không xác định.
    +
    + +
    +

    Tham khảo

    + +
    + +
    +

    Data test cho developer

    + +

    Cần thay bằng dữ liệu môi trường thật khi tích hợp.

    +
    +
    + + +
    Sao chép thành công
    + + \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSDeclarationStatusLookup_LookupDeclarationStatus.md b/modules/TaxCDS/TaxCDSDeclarationStatusLookup_LookupDeclarationStatus.md new file mode 100644 index 0000000..4a3451f --- /dev/null +++ b/modules/TaxCDS/TaxCDSDeclarationStatusLookup_LookupDeclarationStatus.md @@ -0,0 +1,128 @@ +# Partner API - Tra cứu tình trạng nộp tờ khai + +Tra cứu tình trạng nộp tờ khai theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế. + +[Về module TaxCDS](./index.html) + +--- + +## Endpoint + +| | | +|---|---| +| URL | `/TaxCDSDeclarationStatusLookup/partner/lookupDeclarationStatus` | +| Method | `POST` | + +--- + +## Headers schema + +| Header | Required | Mô tả | +|---|---|---| +| apikey | Yes | Khóa xác thực API của đối tác | +--- + +## Body schema + +| Field | Type | Required | Rule | Mô tả | +|---|---|---|---|---| +| filter | object | Yes | Bắt buộc | Nhóm điều kiện tra cứu. | +| filter.taxCode | string | No | Có thể rỗng | Mã số thuế cần tra cứu. | +| filter.citizenIdentityNumber | string | No | Có thể rỗng | Số CCCD/CMND cần tra cứu. | +| filter.taxpayerName | string | No | Có thể rỗng, hỗ trợ tìm gần đúng | Tên người nộp thuế cần tra cứu. | +| filter.declarationStatus | string | No | Có thể rỗng | Trạng thái nộp tờ khai. | +| filter.declarationPeriod | string | No | Có thể rỗng | Kỳ kê khai. | +| filter.declarationType | string | No | Có thể rỗng | Loại tờ khai. | +| skip | number | No | Mặc định 0, nhỏ nhất 0 | Số bản ghi bỏ qua. | +| limit | number | No | Mặc định 20, lớn nhất 100 | Số bản ghi tối đa trả về. | +| startDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo từ ngày. | +| endDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo đến ngày. | +| order.key | string | No | Mặc định createdAt | Tên trường dùng để sắp xếp. | +| order.value | string | No | asc hoặc desc, mặc định desc | Chiều sắp xếp. | + +Cần truyền ít nhất một điều kiện tra cứu trong `filter`: `taxCode`, `citizenIdentityNumber` hoặc `taxpayerName`. + +--- + +## Sample Request + +```bash +curl --location 'http://localhost:4001/TaxCDSDeclarationStatusLookup/partner/lookupDeclarationStatus' \ + --header 'Content-Type: application/json' \ + --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \ + --data '{ + "filter": { + "taxCode": "8173748371" + }, + "skip": 0, + "limit": 10 +}' +``` + +--- + +## Success response + +```json +{ + "statusCode": 200, + "error": null, + "message": "Success", + "data": { + "data": [ + { + "taxCDSDeclStatusLookupId": 1, + "taxCode": "8173748371", + "citizenIdentityNumber": "079183000002", + "taxpayerName": "Nguyễn Văn A", + "taxDepartment": "Chi cục Thuế khu vực", + "declarationStatus": "OVERDUE", + "statusTitle": "Quá hạn nộp tờ khai", + "statusDescription": "Đã quá hạn nộp tờ khai.", + "submitDate": "15/01/2026", + "declarationPeriod": "01/2026", + "declarationType": "Tờ khai thuế", + "declarationCode": "TK-001", + "receivedDate": "", + "processedDate": "", + "rejectedReason": "", + "additionalRequest": "", + "note": "", + "updatedAt": "2026-05-27T04:11:56.000Z", + "createdAt": "2026-05-27T04:11:56.000Z", + "isHidden": 0, + "isDeleted": 0 + } + ], + "totalNextPage": 0 + } +} +``` + +--- + +## Mã lỗi + +| HTTP | Mã lỗi | Mô tả | +|---|---|---| +| 400 | _Validation Error_ | Payload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn. | +| 429 | `QUOTA_EXCEEDED` | apikey không hợp lệ hoặc vượt quota. | +| 500 | `MISSING_LOOKUP_FIELD` | Thiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế. | +| 500 | `UNKNOWN_ERROR` | Lỗi không xác định. | + +--- + +## Tham khảo + +- [Quy chuẩn chung → Common Error](../../Common.html#common-error) — danh sách mã lỗi hệ thống trả về trong trường `error`. + +--- + +## Data test cho developer + +- apikey: 911abff6-137a-4aa3-a836-555a1d30359b +- taxCode: 8173748371 +- citizenIdentityNumber: 079183000002 +- taxpayerName: Nguyễn Văn A + +Cần thay bằng dữ liệu môi trường thật khi tích hợp. \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSFinalizationLookup_LookupTaxFinalization.html b/modules/TaxCDS/TaxCDSFinalizationLookup_LookupTaxFinalization.html new file mode 100644 index 0000000..9ec8dbc --- /dev/null +++ b/modules/TaxCDS/TaxCDSFinalizationLookup_LookupTaxFinalization.html @@ -0,0 +1,172 @@ + + + + + + Tra cứu quyết toán thuế + + + +
    +
    +

    Partner API - Tra cứu quyết toán thuế

    +

    Tra cứu tình trạng quyết toán thuế theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế.

    +

    Về module TaxCDS

    +
    + +
    +

    Endpoint

    + + + +
    URL/TaxCDSFinalizationLookup/partner/lookupTaxFinalization
    MethodPOST
    +
    + +
    +

    Headers schema

    + + + +
    HeaderRequiredMô tả
    apikeyYesKhóa xác thực API của đối tác
    +
    + +
    +

    Body schema

    + + + + + + + + + + + + + + +
    FieldTypeRequiredRuleMô tả
    filterobjectYesBắt buộcNhóm điều kiện tra cứu.
    filter.taxCodestringNoCó thể rỗngMã số thuế cần tra cứu.
    filter.citizenIdentityNumberstringNoCó thể rỗngSố CCCD/CMND cần tra cứu.
    filter.taxpayerNamestringNoCó thể rỗng, hỗ trợ tìm gần đúngTên người nộp thuế cần tra cứu.
    filter.taxYearnumberNoSố nguyênNăm quyết toán thuế.
    filter.finalizationStatusstringNoCó thể rỗngTrạng thái quyết toán thuế.
    skipnumberNoMặc định 0, nhỏ nhất 0Số bản ghi bỏ qua.
    limitnumberNoMặc định 20, lớn nhất 100Số bản ghi tối đa trả về.
    startDatestringNoChuỗi ngày thángLọc bản ghi tạo từ ngày.
    endDatestringNoChuỗi ngày thángLọc bản ghi tạo đến ngày.
    order.keystringNoMặc định createdAtTên trường dùng để sắp xếp.
    order.valuestringNoasc hoặc desc, mặc định descChiều sắp xếp.
    +

    Cần truyền ít nhất một điều kiện tra cứu trong filter: taxCode, citizenIdentityNumber hoặc taxpayerName.

    +
    + +
    +

    + Sample Request + +

    + 
    curl --location 'http://localhost:4001/TaxCDSFinalizationLookup/partner/lookupTaxFinalization' \
+  --header 'Content-Type: application/json' \
+  --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \
+  --data '{
+  "filter": {
+    "taxCode": "8173748371",
+    "taxYear": 2026
+  },
+  "skip": 0,
+  "limit": 10
+}'
    +
    + +
    +

    Success response

    + 
    {
+  "statusCode": 200,
+  "error": null,
+  "message": "Success",
+  "data": {
+    "data": [
+      {
+        "taxCDSFinalizationLookupId": 1,
+        "taxCode": "8173748371",
+        "citizenIdentityNumber": "079183000002",
+        "taxpayerName": "Nguyễn Văn A",
+        "taxDepartment": "Chi cục Thuế khu vực",
+        "taxYear": 2026,
+        "finalizationStatus": "PROCESSING",
+        "statusTitle": "Đang xử lý quyết toán thuế",
+        "statusDescription": "Hồ sơ quyết toán thuế đang được xử lý.",
+        "finalizationDate": "2026-01-15T00:00:00.000Z",
+        "submittedDate": "2026-01-15T00:00:00.000Z",
+        "receivedDate": "2026-01-15T00:00:00.000Z",
+        "completedDate": null,
+        "taxAmount": 1000000,
+        "paidAmount": 0,
+        "debtAmount": 1000000,
+        "refundAmount": 0,
+        "note": "",
+        "updatedAt": "2026-05-27T04:00:00.000Z",
+        "createdAt": "2026-05-27T04:00:00.000Z",
+        "isHidden": 0,
+        "isDeleted": 0
+      }
+    ],
+    "totalNextPage": 0
+  }
+}
    +
    + +
    +

    Mã lỗi

    + + + + + + +
    HTTPMã lỗiMô tả
    400Validation ErrorPayload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn.
    429QUOTA_EXCEEDEDapikey không hợp lệ hoặc vượt quota.
    500MISSING_LOOKUP_FIELDThiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế.
    500UNKNOWN_ERRORLỗi không xác định.
    +
    + +
    +

    Tham khảo

    + +
    + +
    +

    Data test cho developer

    + +

    Cần thay bằng dữ liệu môi trường thật khi tích hợp.

    +
    +
    + + +
    Sao chép thành công
    + + \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSFinalizationLookup_LookupTaxFinalization.md b/modules/TaxCDS/TaxCDSFinalizationLookup_LookupTaxFinalization.md new file mode 100644 index 0000000..176d26e --- /dev/null +++ b/modules/TaxCDS/TaxCDSFinalizationLookup_LookupTaxFinalization.md @@ -0,0 +1,130 @@ +# Partner API - Tra cứu quyết toán thuế + +Tra cứu tình trạng quyết toán thuế theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế. + +[Về module TaxCDS](./index.html) + +--- + +## Endpoint + +| | | +|---|---| +| URL | `/TaxCDSFinalizationLookup/partner/lookupTaxFinalization` | +| Method | `POST` | + +--- + +## Headers schema + +| Header | Required | Mô tả | +|---|---|---| +| apikey | Yes | Khóa xác thực API của đối tác | + +--- + +## Body schema + +| Field | Type | Required | Rule | Mô tả | +|---|---|---|---|---| +| filter | object | Yes | Bắt buộc | Nhóm điều kiện tra cứu. | +| filter.taxCode | string | No | Có thể rỗng | Mã số thuế cần tra cứu. | +| filter.citizenIdentityNumber | string | No | Có thể rỗng | Số CCCD/CMND cần tra cứu. | +| filter.taxpayerName | string | No | Có thể rỗng, hỗ trợ tìm gần đúng | Tên người nộp thuế cần tra cứu. | +| filter.taxYear | number | No | Số nguyên | Năm quyết toán thuế. | +| filter.finalizationStatus | string | No | Có thể rỗng | Trạng thái quyết toán thuế. | +| skip | number | No | Mặc định 0, nhỏ nhất 0 | Số bản ghi bỏ qua. | +| limit | number | No | Mặc định 20, lớn nhất 100 | Số bản ghi tối đa trả về. | +| startDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo từ ngày. | +| endDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo đến ngày. | +| order.key | string | No | Mặc định createdAt | Tên trường dùng để sắp xếp. | +| order.value | string | No | asc hoặc desc, mặc định desc | Chiều sắp xếp. | + +Cần truyền ít nhất một điều kiện tra cứu trong `filter`: `taxCode`, `citizenIdentityNumber` hoặc `taxpayerName`. + +--- + +## Sample Request + +```bash +curl --location 'http://localhost:4001/TaxCDSFinalizationLookup/partner/lookupTaxFinalization' \ + --header 'Content-Type: application/json' \ + --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \ + --data '{ + "filter": { + "taxCode": "8173748371", + "taxYear": 2026 + }, + "skip": 0, + "limit": 10 +}' +``` + +--- + +## Success response + +```json +{ + "statusCode": 200, + "error": null, + "message": "Success", + "data": { + "data": [ + { + "taxCDSFinalizationLookupId": 1, + "taxCode": "8173748371", + "citizenIdentityNumber": "079183000002", + "taxpayerName": "Nguyễn Văn A", + "taxDepartment": "Chi cục Thuế khu vực", + "taxYear": 2026, + "finalizationStatus": "PROCESSING", + "statusTitle": "Đang xử lý quyết toán thuế", + "statusDescription": "Hồ sơ quyết toán thuế đang được xử lý.", + "finalizationDate": "2026-01-15T00:00:00.000Z", + "submittedDate": "2026-01-15T00:00:00.000Z", + "receivedDate": "2026-01-15T00:00:00.000Z", + "completedDate": null, + "taxAmount": 1000000, + "paidAmount": 0, + "debtAmount": 1000000, + "refundAmount": 0, + "note": "", + "updatedAt": "2026-05-27T04:00:00.000Z", + "createdAt": "2026-05-27T04:00:00.000Z", + "isHidden": 0, + "isDeleted": 0 + } + ], + "totalNextPage": 0 + } +} +``` + +--- + +## Mã lỗi + +| HTTP | Mã lỗi | Mô tả | +|---|---|---| +| 400 | _Validation Error_ | Payload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn. | +| 429 | `QUOTA_EXCEEDED` | apikey không hợp lệ hoặc vượt quota. | +| 500 | `MISSING_LOOKUP_FIELD` | Thiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế. | +| 500 | `UNKNOWN_ERROR` | Lỗi không xác định. | + +--- + +## Tham khảo + +- [Quy chuẩn chung → Common Error](../../Common.html#common-error) — danh sách mã lỗi hệ thống trả về trong trường `error`. + +--- + +## Data test cho developer + +- apikey: 911abff6-137a-4aa3-a836-555a1d30359b +- taxCode: 8173748371 +- citizenIdentityNumber: 079183000002 +- taxYear: 2026 + +Cần thay bằng dữ liệu môi trường thật khi tích hợp. \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSMstLookup_LookupHkdStatus.html b/modules/TaxCDS/TaxCDSMstLookup_LookupHkdStatus.html new file mode 100644 index 0000000..dcc2085 --- /dev/null +++ b/modules/TaxCDS/TaxCDSMstLookup_LookupHkdStatus.html @@ -0,0 +1,159 @@ + + + + + + Tra cứu tình trạng hộ kinh doanh + + + +
    +
    +

    Partner API - Tra cứu tình trạng hộ kinh doanh

    +

    Tra cứu tình trạng hộ kinh doanh theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế.

    +

    Về module TaxCDS

    +
    + +
    +

    Endpoint

    + + + +
    URL/TaxCDSMstLookup/partner/lookupHkdStatus
    MethodPOST
    +
    + +
    +

    Headers schema

    + + + +
    HeaderRequiredMô tả
    apikeyYesKhóa xác thực API của đối tác
    +
    + +
    +

    Body schema

    + + + + + + + + + + + + +
    FieldTypeRequiredRuleMô tả
    filterobjectYesBắt buộcNhóm điều kiện tra cứu.
    filter.taxCodestringNoCó thể rỗngMã số thuế hộ kinh doanh cần tra cứu.
    filter.citizenIdentityNumberstringNoCó thể rỗngSố CCCD/CMND của chủ hộ kinh doanh.
    filter.taxpayerNamestringNoCó thể rỗng, hỗ trợ tìm gần đúngTên hộ kinh doanh hoặc tên người nộp thuế.
    skipnumberNoMặc định 0, nhỏ nhất 0Số bản ghi bỏ qua.
    limitnumberNoMặc định 20, lớn nhất 100Số bản ghi tối đa trả về.
    startDatestringNoChuỗi ngày thángLọc bản ghi tạo từ ngày.
    endDatestringNoChuỗi ngày thángLọc bản ghi tạo đến ngày.
    order.keystringNoMặc định createdAtTên trường dùng để sắp xếp.
    order.valuestringNoasc hoặc desc, mặc định descChiều sắp xếp.
    +

    Cần truyền ít nhất một điều kiện tra cứu trong filter: taxCode, citizenIdentityNumber hoặc taxpayerName.

    +
    + +
    +

    + Sample Request + +

    + 
    curl --location 'http://localhost:4001/TaxCDSMstLookup/partner/lookupHkdStatus' \
+  --header 'Content-Type: application/json' \
+  --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \
+  --data '{
+  "filter": {
+    "taxCode": "8010000001"
+  },
+  "skip": 0,
+  "limit": 10
+}'
    +
    + +
    +

    Success response

    + 
    {
+  "statusCode": 200,
+  "error": null,
+  "message": "Success",
+  "data": {
+    "data": [
+      {
+        "taxCDSMstLookupId": 2,
+        "taxCode": "8010000001",
+        "citizenIdentityNumber": "079183000001",
+        "taxpayerName": "Hộ kinh doanh Nguyễn Văn A",
+        "taxDepartment": "Chi cục Thuế khu vực",
+        "mstStatus": "ACTIVE",
+        "statusTitle": "Đang hoạt động",
+        "statusDescription": "Hộ kinh doanh đang hoạt động.",
+        "updatedAt": "2026-05-27T04:00:00.000Z",
+        "createdAt": "2026-05-27T04:00:00.000Z",
+        "isHidden": 0,
+        "isDeleted": 0
+      }
+    ],
+    "totalNextPage": 0
+  }
+}
    +
    + +
    +

    Mã lỗi

    + + + + + + +
    HTTPMã lỗiMô tả
    400Validation ErrorPayload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn.
    429QUOTA_EXCEEDEDapikey không hợp lệ hoặc vượt quota.
    500MISSING_LOOKUP_FIELDThiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế.
    500UNKNOWN_ERRORLỗi không xác định.
    +
    + +
    +

    Tham khảo

    + +
    + +
    +

    Data test cho developer

    + +

    Cần thay bằng dữ liệu môi trường thật khi tích hợp.

    +
    +
    + + +
    Sao chép thành công
    + + \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSMstLookup_LookupHkdStatus.md b/modules/TaxCDS/TaxCDSMstLookup_LookupHkdStatus.md new file mode 100644 index 0000000..93996cf --- /dev/null +++ b/modules/TaxCDS/TaxCDSMstLookup_LookupHkdStatus.md @@ -0,0 +1,117 @@ +# Partner API - Tra cứu tình trạng hộ kinh doanh + +Tra cứu tình trạng hộ kinh doanh theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế. + +[Về module TaxCDS](./index.html) + +--- + +## Endpoint + +| | | +|---|---| +| URL | `/TaxCDSMstLookup/partner/lookupHkdStatus` | +| Method | `POST` | + +--- + +## Headers schema + +| Header | Required | Mô tả | +|---|---|---| +| apikey | Yes | Khóa xác thực API của đối tác | + +--- + +## Body schema + +| Field | Type | Required | Rule | Mô tả | +|---|---|---|---|---| +| filter | object | Yes | Bắt buộc | Nhóm điều kiện tra cứu. | +| filter.taxCode | string | No | Có thể rỗng | Mã số thuế hộ kinh doanh cần tra cứu. | +| filter.citizenIdentityNumber | string | No | Có thể rỗng | Số CCCD/CMND của chủ hộ kinh doanh. | +| filter.taxpayerName | string | No | Có thể rỗng, hỗ trợ tìm gần đúng | Tên hộ kinh doanh hoặc tên người nộp thuế. | +| skip | number | No | Mặc định 0, nhỏ nhất 0 | Số bản ghi bỏ qua. | +| limit | number | No | Mặc định 20, lớn nhất 100 | Số bản ghi tối đa trả về. | +| startDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo từ ngày. | +| endDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo đến ngày. | +| order.key | string | No | Mặc định createdAt | Tên trường dùng để sắp xếp. | +| order.value | string | No | asc hoặc desc, mặc định desc | Chiều sắp xếp. | + +Cần truyền ít nhất một điều kiện tra cứu trong `filter`: `taxCode`, `citizenIdentityNumber` hoặc `taxpayerName`. + +--- + +## Sample Request + +```bash +curl --location 'http://localhost:4001/TaxCDSMstLookup/partner/lookupHkdStatus' \ + --header 'Content-Type: application/json' \ + --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \ + --data '{ + "filter": { + "taxCode": "8010000001" + }, + "skip": 0, + "limit": 10 +}' +``` + +--- + +## Success response + +```json +{ + "statusCode": 200, + "error": null, + "message": "Success", + "data": { + "data": [ + { + "taxCDSMstLookupId": 2, + "taxCode": "8010000001", + "citizenIdentityNumber": "079183000001", + "taxpayerName": "Hộ kinh doanh Nguyễn Văn A", + "taxDepartment": "Chi cục Thuế khu vực", + "mstStatus": "ACTIVE", + "statusTitle": "Đang hoạt động", + "statusDescription": "Hộ kinh doanh đang hoạt động.", + "updatedAt": "2026-05-27T04:00:00.000Z", + "createdAt": "2026-05-27T04:00:00.000Z", + "isHidden": 0, + "isDeleted": 0 + } + ], + "totalNextPage": 0 + } +} +``` + +--- + +## Mã lỗi + +| HTTP | Mã lỗi | Mô tả | +|---|---|---| +| 400 | _Validation Error_ | Payload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn. | +| 429 | `QUOTA_EXCEEDED` | apikey không hợp lệ hoặc vượt quota. | +| 500 | `MISSING_LOOKUP_FIELD` | Thiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế. | +| 500 | `UNKNOWN_ERROR` | Lỗi không xác định. | + +--- + +## Tham khảo + +- [Quy chuẩn chung → Common Error](../../Common.html#common-error) — danh sách mã lỗi hệ thống trả về trong trường `error`. + +--- + +## Data test cho developer + +- apikey: 911abff6-137a-4aa3-a836-555a1d30359b +- taxCode: 8010000001 +- citizenIdentityNumber: 079183000001 +- taxpayerName: Hộ kinh doanh Nguyễn Văn A + +Cần thay bằng dữ liệu môi trường thật khi tích hợp. \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSMstLookup_LookupMst.html b/modules/TaxCDS/TaxCDSMstLookup_LookupMst.html new file mode 100644 index 0000000..a64e74b --- /dev/null +++ b/modules/TaxCDS/TaxCDSMstLookup_LookupMst.html @@ -0,0 +1,159 @@ + + + + + + Tra cứu mã số thuế + + + +
    +
    +

    Partner API - Tra cứu mã số thuế

    +

    Tra cứu thông tin mã số thuế theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế.

    +

    Về module TaxCDS

    +
    + +
    +

    Endpoint

    + + + +
    URL/TaxCDSMstLookup/partner/lookupMst
    MethodPOST
    +
    + +
    +

    Headers schema

    + + + +
    HeaderRequiredMô tả
    apikeyYesKhóa xác thực API của đối tác
    +
    + +
    +

    Body schema

    + + + + + + + + + + + + +
    FieldTypeRequiredRuleMô tả
    filterobjectYesBắt buộcNhóm điều kiện tra cứu.
    filter.taxCodestringNoCó thể rỗngMã số thuế cần tra cứu.
    filter.citizenIdentityNumberstringNoCó thể rỗngSố CCCD/CMND cần tra cứu.
    filter.taxpayerNamestringNoCó thể rỗng, hỗ trợ tìm gần đúngTên người nộp thuế cần tra cứu.
    skipnumberNoMặc định 0, nhỏ nhất 0Số bản ghi bỏ qua.
    limitnumberNoMặc định 20, lớn nhất 100Số bản ghi tối đa trả về.
    startDatestringNoChuỗi ngày thángLọc bản ghi tạo từ ngày.
    endDatestringNoChuỗi ngày thángLọc bản ghi tạo đến ngày.
    order.keystringNoMặc định createdAtTên trường dùng để sắp xếp.
    order.valuestringNoasc hoặc desc, mặc định descChiều sắp xếp.
    +

    Cần truyền ít nhất một điều kiện tra cứu trong filter: taxCode, citizenIdentityNumber hoặc taxpayerName.

    +
    + +
    +

    + Sample Request + +

    + 
    curl --location 'http://localhost:4001/TaxCDSMstLookup/partner/lookupMst' \
+  --header 'Content-Type: application/json' \
+  --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \
+  --data '{
+  "filter": {
+    "taxCode": "0317545179"
+  },
+  "skip": 0,
+  "limit": 10
+}'
    +
    + +
    +

    Success response

    + 
    {
+  "statusCode": 200,
+  "error": null,
+  "message": "Success",
+  "data": {
+    "data": [
+      {
+        "taxCDSMstLookupId": 1,
+        "taxCode": "0317545179",
+        "citizenIdentityNumber": "074183774928",
+        "taxpayerName": "Công ty TNHH ABC",
+        "taxDepartment": "Chi cục Thuế khu vực",
+        "mstStatus": "ACTIVE",
+        "statusTitle": "Đang hoạt động",
+        "statusDescription": "Mã số thuế đang hoạt động.",
+        "updatedAt": "2026-05-27T04:00:00.000Z",
+        "createdAt": "2026-05-27T04:00:00.000Z",
+        "isHidden": 0,
+        "isDeleted": 0
+      }
+    ],
+    "totalNextPage": 0
+  }
+}
    +
    + +
    +

    Mã lỗi

    + + + + + + +
    HTTPMã lỗiMô tả
    400Validation ErrorPayload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn.
    429QUOTA_EXCEEDEDapikey không hợp lệ hoặc vượt quota.
    500MISSING_LOOKUP_FIELDThiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế.
    500UNKNOWN_ERRORLỗi không xác định.
    +
    + +
    +

    Tham khảo

    + +
    + +
    +

    Data test cho developer

    + +

    Cần thay bằng dữ liệu môi trường thật khi tích hợp.

    +
    +
    + + +
    Sao chép thành công
    + + \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSMstLookup_LookupMst.md b/modules/TaxCDS/TaxCDSMstLookup_LookupMst.md new file mode 100644 index 0000000..e39ab86 --- /dev/null +++ b/modules/TaxCDS/TaxCDSMstLookup_LookupMst.md @@ -0,0 +1,117 @@ +# Partner API - Tra cứu mã số thuế + +Tra cứu thông tin mã số thuế theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế. + +[Về module TaxCDS](./index.html) + +--- + +## Endpoint + +| | | +|---|---| +| URL | `/TaxCDSMstLookup/partner/lookupMst` | +| Method | `POST` | + +--- + +## Headers schema + +| Header | Required | Mô tả | +|---|---|---| +| apikey | Yes | Khóa xác thực API của đối tác | + +--- + +## Body schema + +| Field | Type | Required | Rule | Mô tả | +|---|---|---|---|---| +| filter | object | Yes | Bắt buộc | Nhóm điều kiện tra cứu. | +| filter.taxCode | string | No | Có thể rỗng | Mã số thuế cần tra cứu. | +| filter.citizenIdentityNumber | string | No | Có thể rỗng | Số CCCD/CMND cần tra cứu. | +| filter.taxpayerName | string | No | Có thể rỗng, hỗ trợ tìm gần đúng | Tên người nộp thuế cần tra cứu. | +| skip | number | No | Mặc định 0, nhỏ nhất 0 | Số bản ghi bỏ qua. | +| limit | number | No | Mặc định 20, lớn nhất 100 | Số bản ghi tối đa trả về. | +| startDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo từ ngày. | +| endDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo đến ngày. | +| order.key | string | No | Mặc định createdAt | Tên trường dùng để sắp xếp. | +| order.value | string | No | asc hoặc desc, mặc định desc | Chiều sắp xếp. | + +Cần truyền ít nhất một điều kiện tra cứu trong `filter`: `taxCode`, `citizenIdentityNumber` hoặc `taxpayerName`. + +--- + +## Sample Request + +```bash +curl --location 'http://localhost:4001/TaxCDSMstLookup/partner/lookupMst' \ + --header 'Content-Type: application/json' \ + --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \ + --data '{ + "filter": { + "taxCode": "0317545179" + }, + "skip": 0, + "limit": 10 +}' +``` + +--- + +## Success response + +```json +{ + "statusCode": 200, + "error": null, + "message": "Success", + "data": { + "data": [ + { + "taxCDSMstLookupId": 1, + "taxCode": "0317545179", + "citizenIdentityNumber": "074183774928", + "taxpayerName": "Công ty TNHH ABC", + "taxDepartment": "Chi cục Thuế khu vực", + "mstStatus": "ACTIVE", + "statusTitle": "Đang hoạt động", + "statusDescription": "Mã số thuế đang hoạt động.", + "updatedAt": "2026-05-27T04:00:00.000Z", + "createdAt": "2026-05-27T04:00:00.000Z", + "isHidden": 0, + "isDeleted": 0 + } + ], + "totalNextPage": 0 + } +} +``` + +--- + +## Mã lỗi + +| HTTP | Mã lỗi | Mô tả | +|---|---|---| +| 400 | _Validation Error_ | Payload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn. | +| 429 | `QUOTA_EXCEEDED` | apikey không hợp lệ hoặc vượt quota. | +| 500 | `MISSING_LOOKUP_FIELD` | Thiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế. | +| 500 | `UNKNOWN_ERROR` | Lỗi không xác định. | + +--- + +## Tham khảo + +- [Quy chuẩn chung → Common Error](../../Common.html#common-error) — danh sách mã lỗi hệ thống trả về trong trường `error`. + +--- + +## Data test cho developer + +- apikey: 911abff6-137a-4aa3-a836-555a1d30359b +- taxCode: 0317545179 +- citizenIdentityNumber: 074183774928 +- taxpayerName: Công ty TNHH ABC + +Cần thay bằng dữ liệu môi trường thật khi tích hợp. \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSObligationLookup_LookupTaxObligation.html b/modules/TaxCDS/TaxCDSObligationLookup_LookupTaxObligation.html new file mode 100644 index 0000000..c1a9e2e --- /dev/null +++ b/modules/TaxCDS/TaxCDSObligationLookup_LookupTaxObligation.html @@ -0,0 +1,159 @@ + + + + + + Tra cứu nghĩa vụ thuế + + + +
    +
    +

    Partner API - Tra cứu nghĩa vụ thuế

    +

    Tra cứu nghĩa vụ thuế theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế.

    +

    Về module TaxCDS

    +
    + +
    +

    Endpoint

    + + + +
    URL/TaxCDSObligationLookup/partner/lookupTaxObligation
    MethodPOST
    +
    + +
    +

    Headers schema

    + + + +
    HeaderRequiredMô tả
    apikeyYesKhóa xác thực API của đối tác
    +
    + +
    +

    Body schema

    + + + + + + + + + + + + +
    FieldTypeRequiredRuleMô tả
    filterobjectYesBắt buộcNhóm điều kiện tra cứu.
    filter.taxCodestringNoCó thể rỗngMã số thuế cần tra cứu.
    filter.citizenIdentityNumberstringNoCó thể rỗngSố CCCD/CMND cần tra cứu.
    filter.taxpayerNamestringNoCó thể rỗng, hỗ trợ tìm gần đúngTên người nộp thuế cần tra cứu.
    skipnumberNoMặc định 0, nhỏ nhất 0Số bản ghi bỏ qua.
    limitnumberNoMặc định 20, lớn nhất 100Số bản ghi tối đa trả về.
    startDatestringNoChuỗi ngày thángLọc bản ghi tạo từ ngày.
    endDatestringNoChuỗi ngày thángLọc bản ghi tạo đến ngày.
    order.keystringNoMặc định createdAtTên trường dùng để sắp xếp.
    order.valuestringNoasc hoặc desc, mặc định descChiều sắp xếp.
    +

    Cần truyền ít nhất một điều kiện tra cứu trong filter: taxCode, citizenIdentityNumber hoặc taxpayerName.

    +
    + +
    +

    + Sample Request + +

    + 
    curl --location 'http://localhost:4001/TaxCDSObligationLookup/partner/lookupTaxObligation' \
+  --header 'Content-Type: application/json' \
+  --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \
+  --data '{
+  "filter": {
+    "taxCode": "8173748371"
+  },
+  "skip": 0,
+  "limit": 10
+}'
    +
    + +
    +

    Success response

    + 
    {
+  "statusCode": 200,
+  "error": null,
+  "message": "Success",
+  "data": {
+    "data": [
+      {
+        "taxCDSObligationLookupId": 1,
+        "taxCode": "8173748371",
+        "citizenIdentityNumber": "079183000002",
+        "taxpayerName": "Nguyễn Văn A",
+        "taxDepartment": "Chi cục Thuế khu vực",
+        "obligationStatus": "HAS_TAX_DEBT",
+        "statusTitle": "Có nghĩa vụ thuế cần xử lý",
+        "statusDescription": "Người nộp thuế đang có nghĩa vụ thuế cần hoàn tất.",
+        "updatedAt": "2026-05-27T04:00:00.000Z",
+        "createdAt": "2026-05-27T04:00:00.000Z",
+        "isHidden": 0,
+        "isDeleted": 0
+      }
+    ],
+    "totalNextPage": 0
+  }
+}
    +
    + +
    +

    Mã lỗi

    + + + + + + +
    HTTPMã lỗiMô tả
    400Validation ErrorPayload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn.
    429QUOTA_EXCEEDEDapikey không hợp lệ hoặc vượt quota.
    500MISSING_LOOKUP_FIELDThiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế.
    500UNKNOWN_ERRORLỗi không xác định.
    +
    + +
    +

    Tham khảo

    + +
    + +
    +

    Data test cho developer

    + +

    Cần thay bằng dữ liệu môi trường thật khi tích hợp.

    +
    +
    + + +
    Sao chép thành công
    + + \ No newline at end of file diff --git a/modules/TaxCDS/TaxCDSObligationLookup_LookupTaxObligation.md b/modules/TaxCDS/TaxCDSObligationLookup_LookupTaxObligation.md new file mode 100644 index 0000000..388cc40 --- /dev/null +++ b/modules/TaxCDS/TaxCDSObligationLookup_LookupTaxObligation.md @@ -0,0 +1,117 @@ +# Partner API - Tra cứu nghĩa vụ thuế + +Tra cứu nghĩa vụ thuế theo mã số thuế, CCCD/CMND hoặc tên người nộp thuế. + +[Về module TaxCDS](./index.html) + +--- + +## Endpoint + +| | | +|---|---| +| URL | `/TaxCDSObligationLookup/partner/lookupTaxObligation` | +| Method | `POST` | + +--- + +## Headers schema + +| Header | Required | Mô tả | +|---|---|---| +| apikey | Yes | Khóa xác thực API của đối tác | + +--- + +## Body schema + +| Field | Type | Required | Rule | Mô tả | +|---|---|---|---|---| +| filter | object | Yes | Bắt buộc | Nhóm điều kiện tra cứu. | +| filter.taxCode | string | No | Có thể rỗng | Mã số thuế cần tra cứu. | +| filter.citizenIdentityNumber | string | No | Có thể rỗng | Số CCCD/CMND cần tra cứu. | +| filter.taxpayerName | string | No | Có thể rỗng, hỗ trợ tìm gần đúng | Tên người nộp thuế cần tra cứu. | +| skip | number | No | Mặc định 0, nhỏ nhất 0 | Số bản ghi bỏ qua. | +| limit | number | No | Mặc định 20, lớn nhất 100 | Số bản ghi tối đa trả về. | +| startDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo từ ngày. | +| endDate | string | No | Chuỗi ngày tháng | Lọc bản ghi tạo đến ngày. | +| order.key | string | No | Mặc định createdAt | Tên trường dùng để sắp xếp. | +| order.value | string | No | asc hoặc desc, mặc định desc | Chiều sắp xếp. | + +Cần truyền ít nhất một điều kiện tra cứu trong `filter`: `taxCode`, `citizenIdentityNumber` hoặc `taxpayerName`. + +--- + +## Sample Request + +```bash +curl --location 'http://localhost:4001/TaxCDSObligationLookup/partner/lookupTaxObligation' \ + --header 'Content-Type: application/json' \ + --header 'apikey: 911abff6-137a-4aa3-a836-555a1d30359b' \ + --data '{ + "filter": { + "taxCode": "8173748371" + }, + "skip": 0, + "limit": 10 +}' +``` + +--- + +## Success response + +```json +{ + "statusCode": 200, + "error": null, + "message": "Success", + "data": { + "data": [ + { + "taxCDSObligationLookupId": 1, + "taxCode": "8173748371", + "citizenIdentityNumber": "079183000002", + "taxpayerName": "Nguyễn Văn A", + "taxDepartment": "Chi cục Thuế khu vực", + "obligationStatus": "HAS_TAX_DEBT", + "statusTitle": "Có nghĩa vụ thuế cần xử lý", + "statusDescription": "Người nộp thuế đang có nghĩa vụ thuế cần hoàn tất.", + "updatedAt": "2026-05-27T04:00:00.000Z", + "createdAt": "2026-05-27T04:00:00.000Z", + "isHidden": 0, + "isDeleted": 0 + } + ], + "totalNextPage": 0 + } +} +``` + +--- + +## Mã lỗi + +| HTTP | Mã lỗi | Mô tả | +|---|---|---| +| 400 | _Validation Error_ | Payload không đúng schema, thiếu field bắt buộc, sai kiểu hoặc vượt giới hạn. | +| 429 | `QUOTA_EXCEEDED` | apikey không hợp lệ hoặc vượt quota. | +| 500 | `MISSING_LOOKUP_FIELD` | Thiếu điều kiện tra cứu: cần ít nhất một trong các trường MST, CCCD/CMND hoặc tên người nộp thuế. | +| 500 | `UNKNOWN_ERROR` | Lỗi không xác định. | + +--- + +## Tham khảo + +- [Quy chuẩn chung → Common Error](../../Common.html#common-error) — danh sách mã lỗi hệ thống trả về trong trường `error`. + +--- + +## Data test cho developer + +- apikey: 911abff6-137a-4aa3-a836-555a1d30359b +- taxCode: 8173748371 +- citizenIdentityNumber: 079183000002 +- taxpayerName: Nguyễn Văn A + +Cần thay bằng dữ liệu môi trường thật khi tích hợp. \ No newline at end of file diff --git a/modules/TaxCDS/index.html b/modules/TaxCDS/index.html new file mode 100644 index 0000000..f19a0aa --- /dev/null +++ b/modules/TaxCDS/index.html @@ -0,0 +1,126 @@ + + + + + + Partner API - TaxCDS + + + +
    +
    +

    Partner API Module: TaxCDS

    +

    Các API tra cứu thông tin thuế dành cho đối tác.

    +

    + Quay về trang chủ | + Mở bản Markdown module +

    +
    + +
    +

    Danh sách API

    + +
    + +
    +

    Headers chung

    + +
    + +
    +

    Payload chung

    +

    Các API tra cứu TaxCDS dùng chung cấu trúc payload:

    + 
    {
+  "filter": {
+    "taxCode": "8173748371"
+  },
+  "skip": 0,
+  "limit": 10
+}
    +

    + Cần truyền ít nhất một điều kiện trong filter: + taxCode, citizenIdentityNumber hoặc taxpayerName. +

    +
    + +
    +

    Data test tham chiếu

    + +

    Cần thay bằng dữ liệu môi trường thật khi tích hợp.

    +
    +
    + + \ No newline at end of file diff --git a/modules/TaxCDS/index.md b/modules/TaxCDS/index.md new file mode 100644 index 0000000..7db826d --- /dev/null +++ b/modules/TaxCDS/index.md @@ -0,0 +1,123 @@ +# Partner API Module: TaxCDS + +Các API tra cứu thông tin thuế dành cho đối tác. + +[Quay về trang chủ](../../index.html) + +--- + +## Danh sách API + +### 1. Tra cứu mã số thuế + +Endpoint: + +```txt +POST /TaxCDSMstLookup/partner/lookupMst +``` + +Tài liệu: + +- HTML: ./TaxCDSMstLookup_LookupMst.html +- MD: ./TaxCDSMstLookup_LookupMst.md + +--- + +### 2. Tra cứu tình trạng hộ kinh doanh + +Endpoint: + +```txt +POST /TaxCDSMstLookup/partner/lookupHkdStatus +``` + +Tài liệu: + +- HTML: ./TaxCDSMstLookup_LookupHkdStatus.html +- MD: ./TaxCDSMstLookup_LookupHkdStatus.md + +--- + +### 3. Tra cứu nghĩa vụ thuế + +Endpoint: + +```txt +POST /TaxCDSObligationLookup/partner/lookupTaxObligation +``` + +Tài liệu: + +- HTML: ./TaxCDSObligationLookup_LookupTaxObligation.html +- MD: ./TaxCDSObligationLookup_LookupTaxObligation.md + +--- + +### 4. Tra cứu quyết toán thuế + +Endpoint: + +```txt +POST /TaxCDSFinalizationLookup/partner/lookupTaxFinalization +``` + +Tài liệu: + +- HTML: ./TaxCDSFinalizationLookup_LookupTaxFinalization.html +- MD: ./TaxCDSFinalizationLookup_LookupTaxFinalization.md + +--- + +### 5. Tra cứu tình trạng nộp tờ khai + +Endpoint: + +```txt +POST /TaxCDSDeclarationStatusLookup/partner/lookupDeclarationStatus +``` + +Tài liệu: + +- HTML: ./TaxCDSDeclarationStatusLookup_LookupDeclarationStatus.html +- MD: ./TaxCDSDeclarationStatusLookup_LookupDeclarationStatus.md + +--- + +## Headers chung + +| Header | Required | Mô tả | +|---|---|---| +| apikey | Yes | Khóa xác thực API của đối tác | + +--- + +## Payload chung + +Các API tra cứu TaxCDS dùng chung cấu trúc payload: + +```json +{ + "filter": { + "taxCode": "8173748371" + }, + "skip": 0, + "limit": 10 +} +``` + +Cần truyền ít nhất một điều kiện trong `filter`: + +- `taxCode` +- `citizenIdentityNumber` +- `taxpayerName` + +--- + +## Data test tham chiếu + +- apikey: 911abff6-137a-4aa3-a836-555a1d30359b +- taxCode: 8173748371 +- citizenIdentityNumber: 079183000002 +- taxpayerName: Nguyễn Văn A + +Cần thay bằng dữ liệu môi trường thật khi tích hợp. \ No newline at end of file