00-01_GLM001(GLM001A)傳票維護_畫面操作說明

系統說明文件：GLM001Controller API

簡介

GLM001Controller 是一組 Web API，用於維護傳票資料。該 API 包含多項功能，包括查詢傳票、檢查傳票狀態、刪除傳票以及新增或更新傳票等操作。本文將詳細描述每個 API 方法的運作流程、使用情境、輸入與輸出格式，以及檢核邏輯。

1. 查詢傳票（GetVoucherList）

目的

假設情境

使用者需要查詢特定公司的傳票資料，並希望能根據不同的條件（如公司別、傳票日期、傳票號碼等）進行篩選。

運作流程

  1. 前端發送 GET 請求到 GetVoucherList API，並包含查詢參數（如公司別、傳票日期等）。
  2. API 調用 GL_VOUCHER_MASTER 表，根據傳入的條件查詢傳票資料。
  3. 取得資料後，API 返回符合條件的傳票清單，並包含詳細資訊（如傳票編號、傳票日期、金額等）。
  4. 前端將傳回的資料顯示在畫面上。

輸入參數

輸出結果

範例結果

{
    "RESULT_CODE": "S0000001",
    "RESULT_MESSAGE": "查詢成功",
    "RESULT": [
        {
            "VOUCHER_NO": "12345678901",
            "VOUCHER_DATE": "2024-09-01",
            "AMOUNT": 1000,
            "STATUS": "Active"
        },
        {
            "VOUCHER_NO": "12345678902",
            "VOUCHER_DATE": "2024-09-02",
            "AMOUNT": 2000,
            "STATUS": "Active"
        }
    ]
}

2. 刪除傳票（DeleteVoucher）

Stored procedure 流程圖
Stored procedure 流程圖

目的

假設情境

使用者希望刪除特定的傳票，但需檢查該傳票是否可刪除，如是否已沖銷或是否存在相關應收應付資料。

運作流程

  1. 前端發送 POST 請求到 DeleteVoucher API，並包含要刪除的傳票資訊（如公司別、傳票編號、序號）。
  2. API 首先調用多個 DEL_CHECK_* 方法（如 DEL_CHECK_APM、DEL_CHECK_ARM 等）檢查傳票是否可刪除，這些方法將檢查 GL_VOUCHER_DETAIL 和相關表格中是否有沖銷記錄。
  3. 若所有檢查都通過，API 執行刪除操作，並將傳票狀態設為已刪除。
  4. 返回刪除結果。

輸入參數

檢查步驟

輸出結果

範例結果

成功刪除：

{
    "RESULT_CODE": "S0000001",
    "RESULT_MESSAGE": "傳票刪除成功"
}

刪除失敗：

{
    "RESULT_CODE": "E0000001",
    "RESULT_MESSAGE": "此資料不得刪除 !! (應付帳款已切出)"
}

3. 新增/更新傳票（SaveVoucher）

目的

假設情境

使用者需新增一筆新的傳票，或修改已存在的傳票資料。

運作流程

  1. 前端發送 POST 請求到 SaveVoucher API，並包含傳票的相關資訊。
  2. API 進行資料檢核，例如檢查傳票編號、傳票日期等資訊是否符合規則。
  3. 若為新增操作，將新傳票資料插入至 GL_VOUCHER_MASTER 和 GL_VOUCHER_DETAIL 表中。
  4. 若為更新操作，則更新指定的傳票資料。
  5. 返回操作結果。

輸入參數

檢查步驟

輸出結果

範例結果

新增/更新成功：

{
    "RESULT_CODE": "S0000001",
    "RESULT_MESSAGE": "傳票儲存成功"
}

這份文件提供了針對 GLM001Controller API 的詳細說明，涵蓋了主要功能的目的、流程、輸入輸出格式，以及情境舉例。