...
2. Confirmation/ Acceptance Criteria (Tiêu chí nghiệm thu)
...
Danh mục BPM đồng bộ theo SAP: Danh mục hợp đồng
...
3. Conversation (Mô tả chi tiết)
3.1 UIUX:
3.2 Luồng:
3.3 API Spec: <gắn link tài liệu mô tả API vào đây>
...
...
Method
...
URL
...
STT
...
Field
...
Source Data Type / Length
...
Description
...
Sample Values
2. Body
...
STT
...
Path
...
Field
...
Data Type / Length
...
Description
...
Note
...
Sample Values
3. Response / Incoming Data Specification
...
Field
...
Data Type / Length
...
Description
...
Note
...
- Tôi muốn đồng bộ thông tin hợp đồng về SAP bao gồm các thông tin:
- Loại hợp đồng*
- Nhà thầu*
- Ngày tạo HĐ*
- Tổ chức mua hàng*
- Phòng ban thực hiện*
- Ngày hiệu lực*
- Ngày hết hạn*
- Tổng GTHĐ trước thuế*
- Đơn vị tiền tệ
- Tỷ giá
- Số HĐ gốc
- Mã HĐ/PL
- Ngày ký
- Ngày bắt đầu hiệu lực
- Ngày hết hạn bảo hành
- Dự án
- Tình trạng
- Nội dung hợp đồng
- Tiến độ thực hiện (Ngày)
- Thông tin chi tiết hàng hóa
- Mã thuế
- Số thứ tự line tổng quan*
- Loại HĐ đặc biệt 1*
- Loại HĐ đặc biệt 2*
- Tên Dịch vụ/Hạng mục tổng quan*
- Kho/Đơn vị*
- Nhóm công việc (Nhóm vật tư/dịch vụ* )
- Số thứ tự line chi tiết*
- Tên Dịch vụ/Hạng mục chi tiết*
- Khối lượng*
- Đơn vị tính*
- Đơn giá*
- Khoản mục phí (Thêm trên BoQ)
- Hạng mục
- Phòng ban KD: Để sẵn, hiện tại với XDCB chưa dùng đến
- Phòng ban VPTĐ: Để sẵn, hiện tại với XDCB chưa dùng đến
- Tài sản: Để sẵn, hiện tại với XDCB chưa dùng đến
- Validity start date of the condition record ( Truyền theo thông tin ngày hiệu lực)
- ID danh mục tích hợp
- Tôi muốn đồng bộ thông tin hợp đồng sang hệ thống SAP theo sự kiện khi có thông tin hợp đồng cập nhật tại BPM
- Tôi muốn trong trường hợp update hợp đồng, BPM truyền bổ sung thông tin Mã hợp đồng SAP để SAP so sánh theo mã hợp đồng SAP
- Tôi muốn quản lý được lịch sử đồng bộ danh mục
- Thời gian băt đầu
- Thời gian kết thúc
- Người đồng bộ
- Trạng thái
- Mã lỗi
- Mô tả lỗi
- Số hợp đồng BPM
- Số hợp đồng SAP (Có data khi đẩy sang SAP thành công)
- Tôi muốn lọc được thông tin lịch sử đồng bộ theo
- Ngày: Từ- Đến
- Người đồng bộ
- Số hợp đồng BPM
- Số hợp đồng SAP
- Trạng thái
- Mã lỗi
...
- Thông tin mapping các trường tích hợp tại file: Mapping_SAP_QLHD.docx
3. Conversation (Mô tả chi tiết)
3.1 UIUX:
3.2 Luồng:
3.3 API Spec: <gắn link tài liệu mô tả API vào đây>
| Panel |
|---|
|
Method | POST | URL | /integration/partnerSyncLog/list |
|---|
Description | API Lấy thông tin lịch sử đông bộ |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request bodySTT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | errorCode | false | String | mã lỗi |
| | 2 | page | false | Integer | Trang dữ liệu (phân trang) |
| | 3 | limit | false | Integer | Số bản ghi mỗi trang |
| | 4 | startTime | false | String | Thời gian đồng bộ ("2026-02-26") |
| | 5 | endTime | false | String | Thời gian đồng bộ ("2026-02-26") |
| | 6 | syncBy | false | Integer | Người đồng bộ |
| | 7 | type | false | String | loại (PROJECT: dự án...) |
| | 8 | status | false | Integer | trạng thái |
| | 9 | addition | false | Object |
|
| | 10 | (addition) contractNo | false | String | số hợp đồng |
| | 11 | (addition) sapContractNo | false | String | Số hợp đồng SAP |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
|
| | 2 | message | String |
|
|
| | 3 | result | List<Object> |
|
|
| | 4 | (result) page | Integer | trang bao nhiêu |
|
| | 5 | (result) total | Integer | số lượng bản ghi |
|
| | 6 | (result) items | List<Object> | danh sách bản ghi |
|
| | 7 | (items) id | Integer | id |
|
| | 8 | (items) endTime | String | thời gian kết thúc đòng bộ |
|
| | 9 | (items) errorCode | String | mã lỗi |
|
| | 10 | (items) String | String | chi tiết lỗi |
|
| | 11 | (items) startTime | String | Thời gian bắt đầu đồng bộ |
|
| | 12 | (items) status | Integer | trang thái |
|
| | 13 | (items) syncBy | String | người đồng bộ |
|
| | 14 | (items) addition | false | Object |
|
| | 15 | (addition) contractNo | String | số hợp đồng |
|
| | 16 | (addition) sapContractNo | String | Số hợp đồng SAP |
|
|
|
| Panel |
|---|
|
Method | POST | URL | /application/contractIntegrationSap/get |
|---|
Description | API Chi tiết thông tin gửi sang SAP |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request bodySTT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | contractId | true | String | id hợp đồng |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
|
| | 2 | message | String |
|
|
| | 3 | result | Object |
|
|
| | 4 | (result) id | Integer | id |
|
| | 5 | (result) projectId | Integer | id dự án |
|
| | 6 | (result) organizationId | Integer | id nhà thầu |
|
| | 7 | (items) contractTypeId | Integer | id loại hợp đồng |
|
| | 8 | (items) departmentId | Integer | id phòng ban thực hiện |
|
| | 9 | (items) signedAt | String | Ngày kí hợp đồng |
|
| | 10 | (items) executionTime | Integer | Thời gian thực hiện |
|
| | 11 | (items) warrantyExpiredAt | String | ngày hết hạn bảo hành |
|
| | 12 | (items) amountBeforeTax | BigDecimal | giá trị HĐ trước thuế |
|
| | 13 | (items) currencyUnitId | Integer | id tiền tệ |
|
| | 14 | (items) exchangeRate | String | tỉ giá tương ứng |
|
| | 15 | (items) status | Integer | Tình trạng. 1: Đã quyết toán, 2: Chưa quyết toán, 3: Chưa thực hiện, 4: Đang bảo hành, 5: Hợp đồng đã xóa |
|
| | 16 | (items) contractNo | String | số hợp đồng |
|
|
| (items) sapContractNo | String | Mã hợp đồng SAP |
|
|
| (items) fieldId | Integer | id lĩnh vực |
|
|
| (items) implementationProgress | String | tiến độ thực hiện |
|
|
| (items) createdDate | String | Ngày tạo hợp đồng |
|
|
| (items) purchasingOrgId | String | Tổ chức mua hàng |
|
|
| (items) effectiveDate | String | ngày hiệu lực |
|
|
| (items) effectiveStartDate | String | ngày bắt đầu hiệu lực |
|
|
| (items) expectedEndDate | String | Ngày hết hạn |
|
|
| (items) appendixCode | String | mã phụ lục hợp đồng |
|
|
| (items) contractContent | String | Nội dùng hợp đồng |
|
|
| (items) potId | Integer | id hồ sơ |
|
|
| (items) contractId | Integer | id hợp đồng |
|
|
| (items) contractStatus | Integer | Trạng thái hợp đồng |
|
|
| (items) syncStatus | Integer | trạng thái đồng bộ |
|
|
| (items) isSynced | Integer | Đánh dấu bản ghi đã đồng bộ trên SAP |
|
|
| (items) contractTypeName | String | Tên loại hợp đồng |
|
|
| (items) projectName | String | tên dự án |
|
|
| (items) organizationName | String | tên nhà thầu |
|
|
| (items) currencyUnitName | String | tên đơn vị tiền tệ |
|
|
| (items) departmentName | String | tên phòng ban thực hiện |
|
|
| (items) fieldName | String | tên lĩnh vực |
|
|
| (items) purchasingOrgName | String | tên tổ chức mua hàng |
|
|
| (items) contractItems | List<Object> | Thông tin chi tiết hàng hóa |
|
|
| (contractItems) id | Integer |
|
|
|
| (contractItems) taxId | Integer | id mã thuế |
|
|
| (contractItems) generalLineNo | String | STT line tổng quan |
|
|
| (contractItems) specialContract1 | String | Loại hợp đồng đặc biệt 1 |
|
|
| (contractItems) specialContract2 | String | Loại hợp đồng đặc biệt 2 |
|
|
| (contractItems) generalServiceName | String | Tên Dịch vụ/ Hạng mục tổng quan |
|
|
| (contractItems) investorId | Integer | id Kho/ Đơn vị |
|
|
| (contractItems) groupId | Integer | id Nhóm vật tư/ Dịch vụ |
|
|
| (contractItems) detailLineNo | String | STT line chi tiết |
|
|
| (contractItems) detailServiceName | String | Tên Dịch vụ/ Hạng mục chi tiết |
|
|
| (contractItems) quantity | Integer | Khối lượng |
|
|
| (contractItems) unitId | Integer | id Đơn vị tính |
|
|
| (contractItems) price | Integer | Đơn giá |
|
|
| (contractItems) feeItemId | Integer | id Khoản mục phí |
|
|
| (contractItems) budgetSection | String | Hạng mục ngân sách |
|
|
| (contractItems) effectiveDate | String | Ngày hiệu lực |
|
|
| (contractItems) integrationCategoryId | String | ID danh mục tích hợp |
|
|
| (contractItems) contractId | String | id hợp đồng |
|
|
| (contractItems) status | String | trạng thái |
|
|
| (contractItems) warehouse | Integer | tên kho/đơn vị |
|
|
| (contractItems) unitName | String | tên đơn vị |
|
|
| (contractItems) feeItemName | String | Khoản mục phí |
|
|
| (contractItems) taxName | String | tên mã thuế |
|
|
| (contractItems) groupName | String | Nhóm vật tư/ Dịch vụ |
|
|
| (contractItems) isDeleted | String | đánh dấu bản ghi bị xóa |
|
|
| (contractItems) taxCode | String | mã thuế |
|
|
| (contractItems) investorSapCode | String |
|
|
|
| (contractItems) groupCode | String |
|
|
|
| (contractItems) unitCode | String |
|
|
|
| (contractItems) feeItemCode | String |
|
|
|
|
| Panel |
|---|
|
Method | POST | URL | /application/contractIntegrationSap/upsertAndSynDataToSap |
|---|
Description | API Thêm mới/cập nhật thông tin gửi sang SAP |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request bodySTT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | id |
| Integer | id |
|
| projectId |
| Integer | id dự án |
|
| organizationId |
| Integer | id nhà thầu |
|
| contractTypeId |
| Integer | id loại hợp đồng |
|
| departmentId |
| Integer | id phòng ban thực hiện |
|
| signedAtStr |
| String | Ngày kí hợp đồng |
|
| executionTime |
| Integer | Thời gian thực hiện |
|
| warrantyExpiredAtStr |
| String | ngày hết hạn bảo hành |
|
| amountBeforeTax |
| BigDecimal | giá trị HĐ trước thuế |
|
| currencyUnitId |
| Integer | id tiền tệ |
|
| exchangeRate |
| String | tỉ giá tương ứng |
|
| status |
| Integer | Tình trạng. 1: Đã quyết toán, 2: Chưa quyết toán, 3: Chưa thực hiện, 4: Đang bảo hành, 5: Hợp đồng đã xóa |
|
| contractNo |
| String | số hợp đồng |
|
| sapContractNo |
| String | Mã hợp đồng SAP |
|
| fieldId |
| Integer | id lĩnh vực |
|
| implementationProgress |
| String | tiến độ thực hiện |
|
| createdDateStr |
| String | Ngày tạo hợp đồng |
|
| purchasingOrgId |
| String | Tổ chức mua hàng |
|
| effectiveDateStr |
| String | ngày hiệu lực |
|
| effectiveStartDateStr |
| String | ngày bắt đầu hiệu lực |
|
| expectedEndDateStr |
| String | Ngày hết hạn |
|
| appendixCode |
| String | mã phụ lục hợp đồng |
|
| contractContent |
| String | Nội dùng hợp đồng |
|
| potId |
| Integer | id hồ sơ |
|
| contractId |
| Integer | id hợp đồng |
|
| isDraft |
| Boolean | Đánh dấu lưu nháp hay áp dụng |
|
| contractItems |
| List<Object> | Thông tin chi tiết hàng hóa |
|
| (contractItems) id |
| Integer |
|
|
| (contractItems) taxId |
| Integer | id mã thuế |
|
| (contractItems) generalLineNo |
| String | STT line tổng quan |
|
| (contractItems) specialContract1 |
| String | Loại hợp đồng đặc biệt 1 |
|
| (contractItems) specialContract2 |
| String | Loại hợp đồng đặc biệt 2 |
|
| (contractItems) generalServiceName |
| String | Tên Dịch vụ/ Hạng mục tổng quan |
|
| (contractItems) investorId |
| Integer | id Kho/ Đơn vị |
|
| (contractItems) groupId |
| Integer | id Nhóm vật tư/ Dịch vụ |
|
| (contractItems) detailLineNo |
| String | STT line chi tiết |
|
| (contractItems) detailServiceName |
| String | Tên Dịch vụ/ Hạng mục chi tiết |
|
| (contractItems) quantity |
| Integer | Khối lượng |
|
| (contractItems) unitId |
| Integer | id Đơn vị tính |
|
| (contractItems) price |
| Integer | Đơn giá |
|
| (contractItems) feeItemId |
| Integer | id Khoản mục phí |
|
| (contractItems) budgetSection |
| String | Hạng mục ngân sách |
|
| (contractItems) effectiveDate |
| String | Ngày hiệu lực |
|
| (contractItems) integrationCategoryId |
| String | ID danh mục tích hợp |
|
| (contractItems) contractId |
| String | id hợp đồng |
|
| (contractItems) isDeleted |
| String | đánh dấu bản ghi bị xóa |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
|
| | 2 | message | String |
|
|
|
|
| Panel |
|---|
|
Method | POST | URL | /application/contract/preparedForSap |
|---|
Description | API lấy thông tin hồ sơ tài chính và chi tiết hàng hóa |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | String | Token | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjYzOTgyNDUsInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.qRoaRDxjqyWS-3Az_ZqLmR0KAcPTM7jXggW1Ja5wpEc |
2. Request bodySTT | Field | Required | Data Type / Length | Description | Note |
|---|
| 1 | potId | true | Integer | id hồ sơ |
|
| orgId | true | Integer | id nhà thầu |
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note |
|
|---|
| 1 | code | Integer | 0: thành công, != 0 thất bại |
|
| | 2 | message | String |
|
|
| | 3 | result | Object |
|
|
| | 4 | (result) documentDetail | Object | thông tin hồ sơ tài chính |
|
| | 5 | (documentDetail) documentType | String | loại |
|
| | 6 | (documentDetail) note | String | Ghi chú |
|
| | 7 | (documentDetail) attachments | String | file đính kèm |
|
| | 8 | (documentDetail) data | String | dữ liệu grid |
|
|
| (result) contractItems | List<Object> | Thông tin chi tiết hàng hóa |
|
|
| (contractItems) id | Integer |
|
|
|
| (contractItems) taxId | Integer | id mã thuế |
|
|
| (contractItems) generalLineNo | String | STT line tổng quan |
|
|
| (contractItems) specialContract1 | String | Loại hợp đồng đặc biệt 1 |
|
|
| (contractItems) specialContract2 | String | Loại hợp đồng đặc biệt 2 |
|
|
| (contractItems) generalServiceName | String | Tên Dịch vụ/ Hạng mục tổng quan |
|
|
| (contractItems) investorId | Integer | id Kho/ Đơn vị |
|
|
| (contractItems) groupId | Integer | id Nhóm vật tư/ Dịch vụ |
|
|
| (contractItems) detailLineNo | String | STT line chi tiết |
|
|
| (contractItems) detailServiceName | String | Tên Dịch vụ/ Hạng mục chi tiết |
|
|
| (contractItems) quantity | Integer | Khối lượng |
|
|
| (contractItems) unitId | Integer | id Đơn vị tính |
|
|
| (contractItems) price | Integer | Đơn giá |
|
|
| (contractItems) feeItemId | Integer | id Khoản mục phí |
|
|
| (contractItems) budgetSection | String | Hạng mục ngân sách |
|
|
| (contractItems) effectiveDate | String | Ngày hiệu lực |
|
|
| (contractItems) integrationCategoryId | String | ID danh mục tích hợp |
|
|
| (contractItems) contractId | String | id hợp đồng |
|
|
| (contractItems) status | String | trạng thái |
|
|
| (contractItems) warehouse | Integer | tên kho/đơn vị |
|
|
| (contractItems) unitName | String | tên đơn vị |
|
|
| (contractItems) feeItemName | String | Khoản mục phí |
|
|
| (contractItems) taxName | String | tên mã thuế |
|
|
| (contractItems) groupName | String | Nhóm vật tư/ Dịch vụ |
|
|
| (contractItems) isDeleted | String | đánh dấu bản ghi bị xóa |
|
|
| (contractItems) taxCode | String | mã thuế |
|
|
| (contractItems) investorSapCode | String |
|
|
|
| (contractItems) groupCode | String |
|
|
|
| (contractItems) unitCode | String |
|
|
|
| (contractItems) feeItemCode | String |
|
|
|
|
3.4 Mô tả các trường dữ liệu trên màn hình:
...
3.4.3 Pop-up chi tiết mã lỗi
| Field (Trường dữ liệu) | Type (Kiểu dữ liệu) | Required (Bắt buộc) | Validation (Quy định) | Description (Mô tả) |
|---|
| 1 | Tiêu đề màn hình | Nhãn hiệu (Label) | Không bắt buộc |
| Hiển thị tiêu đề "Đồng bộ thất bại" |
| 2 | Văn bản thông báo | Nút chức năng (Button) | Không bắt buộc | - Không cho phép người dùng thao tác tương tác (nhấn/chọn/sửa).
| - Thể hiện văn bản thông báo - Nội dung văn bản thông báo: "Mã lỗi. Mô tả chi tiết lỗi" |
| 3 | Nút "Thoát | Nút chức năng (Button) | Không bắt buộc | - Cho phép người dùng nhấn để tắt màn hình pop-up.
Khi nhấn, màn hình pop-up đóng lại và hệ thống điều hướng về màn hình về màn hình danh sách "Tích hợp dữ liệu chủ đầu tư"
| Thể hiện nút "Thoát" để đóng màn hình pop up cảnh báo |
...
