Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleAPI Spec Document

I. Danh sách đơn vị tiền tệ

Method

Get

URL

/application/currencyUnit/list

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Param

STT

Field

Required

Data Type / Length

Description

Note

1pagetrueInteger

2limittrueInteger

3namefalseStringTìm kiếm theo tên hoặc mã

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

1idInteger

2codeStringMã đơn vị tiền tệ
3nameStringTên đơn vị tiền tệ
4statusIntegerTrạng thái hoạt động (1: Hoạt động, 0: Không hoạt động)


II. Chi tiết đơn vị tiền tệ

Method

Get

URL

/application/currencyUnit/get

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Param

STT

Field

Required

Data Type / Length

Description

Note

1idtrueIntegerTìm kiếm theo tên hoặc mã

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

1idInteger

2codeStringMã đơn vị tiền tệ
3nameStringTên đơn vị tiền tệ
4statusIntegerTrạng thái hoạt động (1: Hoạt động, 0: Không hoạt động)


III. Thêm mới đơn vị tiền tệ

Method

Post

URL

/application/currencyUnit/update

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Body

STT

Field

Required

Data Type / Length

Description

Note

1codetrueStringMã đơn vị tiền tệ
2nametrueStringTên đơn vị tiền tệ
3statustrueIntegerTrạng thái hoạt động (1: Hoạt động, 0: Không hoạt động)

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

1idInteger

2codeStringMã đơn vị tiền tệ
3nameStringTên đơn vị tiền tệ
4statusIntegerTrạng thái hoạt động (1: Hoạt động, 0: Không hoạt động)


IV. Cập nhật đơn vị tiền tệ

Method

Post

URL

/application/currencyUnit/update

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Body

STT

Field

Required

Data Type / Length

Description

Note

1idtrueInteger

2codetrueStringMã đơn vị tiền tệ
3nametrueStringTên đơn vị tiền tệ
4statustrueIntegerTrạng thái hoạt động (1: Hoạt động, 0: Không hoạt động)

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

1idInteger

2codeStringMã đơn vị tiền tệ
3nameStringTên đơn vị tiền tệ
4statusIntegerTrạng thái hoạt động (1: Hoạt động, 0: Không hoạt động)


V. Cập nhật trạng thái đơn vị tiền tệ

Method

Post

URL

/application/currencyUnit/update/status

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Body

STT

Field

Required

Data Type / Length

Description

Note

1idtrueInteger

2statustrueIntegerTrạng thái hoạt động (1: Hoạt động, 0: Không hoạt động)

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

1idInteger

2statusIntegerTrạng thái hoạt động (1: Hoạt động, 0: Không hoạt động)


VI. Xóa đơn vị tiền tệ

Method

Delete

URL

/application/currencyUnit/delete

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Param

STT

Field

Required

Data Type / Length

Description

Note

1idtrueInteger

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

1resultIntegerSố lượng bản ghi được xóa


VII. Nhập đơn vị tiền tệ bằng file excel

Method

Post

URL

/application/currencyUnit/upload

1. Headers

STT

Field

Source Data Type / Length 

Description

Sample Values

1authorizationStringTokenBearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc

2. Body

STT

Field

Required

Data Type / Length

Description

Note

1filetrueFileFile Excel (.xlsx, .xls, .csv) chứa danh sách đơn vị tiền tệ

3. Response / Incoming Data Specification

STT

Field

Data Type / Length

Description

Note

1fileNameStringTên file

uploadIdIntegerId upload

numDupplicateLongSố bản ghi trùng lặp

numValidLongSố bản ghi hợp lệ

numDoneLongSố bản ghi hoàn thành

numInvalidLongSố bản ghi không hợp lệ

errorMessagesList<String>Danh sách lỗi


4. Mô tả các trường dữ liệu trên màn hình:

...

- Quy
STT

Field

(Trường dữ liệu)

Type

(Kiểu dữ liệu)

Required

(Bắt buộc)

Validation

(Quy định)


Description

(Mô tả)

1

Không thành công

File excel bạn nhập chưa chính xác

Nhãn (Label)

Nội dung thông báo lỗi nhập file excel
2Danh mục các lỗi gặp phảiNhãn (Label)

Tiêu đề danh sách các lỗi
3Dòng lỗi

Văn bản (Text)

Bắt buộc

Đối với trường hợp dữ liệu trong file lỗi

Trả về số thứ tự của dòng lỗi

4Ghi chú lỗi

Văn bản (Text)

Bắt buộc

Hiển thị danh sách lỗi khi gán dữ liệu Excel:

  • Lỗi nhập thiếu trường bắt buộc: "
  • Giá trị trường <Tên trường> chưa nhập
  • <Tên trường> - Thiếu thông tin <tên trường>"
  • Lỗi nhập thừa ký tự tại trường: "
  • Giá trị trường
  • <Tên trường>
  • vượt quá giới hạn độ
  • - Vượt quá <độ dài ký tự
  • cho phép
  • của trường> ký tự"
  • Lỗi trùng mã
  • đơn vị
  • duy nhất: "
  • <Tên trường> - <Tên trường> đã tồn tại"
  • Lỗi khi mã
  • đơn vị
  • của bản ghi bị trùng với bản ghi khác trong tệp được tải lên: "
  • Mã bị trùng với mã tại dòng (X)" (Trong đó, (X) là số thứ tự của bản ghi trùng mã nằm trong chính tệp được tải lên. Trường hợp có nhiều bản ghi trùng lắp, liệt kê các bản ghi và phân cách bằng dấu ",")
Hiển thị ghi chú lỗi của dòng lỗi
5Tải xuống

Nút chức năng (Button)

Không bắt buộc

  • <Tên trường> - <Tên trường> trong danh sách import"


Hiển thị ghi chú lỗi của dòng lỗi
5Tải xuống

Nút chức năng (Button)

Không bắt buộc

- Quy tắc đặt tên: DonViTienTe_Error-yyyymmdd

  • VD: DonViTienTe_Error-20251205

- Sau khi nhấn nút, hệ thống thực hiện tải xuống tài liệu và hiển thị toast thành công màu xanh lá sau khi tải xong: "Thành công - Xuất dữ liệu thành công"

Cho phép người dùng tải xuống file danh sách các lỗi theo định dạng excel
6Nhập lại

Nút chức năng (Button)

Không bắt buộc

Sau khi nhấn nút, hệ thống đóng pop-up và quay về màn hình pop-up "Nhập file Excel"Cho phép người dùng nhập lại file excel
7Nút “Hủy”/Nút Đóng “X” 

Nút chức năng (Button)

Không bắt buộc

Sau khi nhấn nút, hệ thống đóng pop-up và quay về giao diện Màn hình Danh sách Danh mục đơn vị tiền tệ

Cho phép người dùng đóng pop-up

...

STT

Field

(Trường dữ liệu)

Description

(Mô tả)


1 

Thời gian xuấtThể hiện thời gian xuất dữ liệu theo định dạng: dd/mm/yyyy hh:mm:ss

2

Người xuấtThể hiện thông tin tên của người thực hiện xuất dữ liệu

3 

Dòng lỗiTrả về số thứ tự của dòng lỗi

4

Ghi chú lỗi

Hiển thị danh sách lỗi khi gán dữ liệu Excel:

  • Lỗi nhập thiếu trường bắt buộc: "Giá trị trường <Tên trường> chưa nhập- Thiếu thông tin <tên trường>"
  • Lỗi nhập thừa ký tự tại trường: "Giá trị trường <Tên trường> vượt quá giới hạn độ - Vượt quá <độ dài ký tự cho phépcủa trường> ký tự"
  • Lỗi trùng mã đơn vịduy nhất: "<Tên trường> - <Tên trường> đã tồn tại"
  • Lỗi khi mã đơn vị của bản ghi bị trùng với bản ghi khác trong tệp được tải lên: "Mã bị trùng với mã tại dòng (X)" (Trong đó, (X) là số thứ tự của bản ghi trùng mã nằm trong chính tệp được tải lên. Trường hợp có nhiều bản ghi trùng lắp, liệt kê các bản ghi và phân cách bằng dấu ",")<Tên trường> - <Tên trường> trong danh sách import"

4.1.10. Màn hình pop-up "Xác nhận hủy"

...