偏远地区邮编判断调整

bms-back/bms-admin/src/main/java/com/bms/web/controller/price/PayBillController.java

@@ -27,6 +27,12 @@ public class PayBillController extends BaseController
     @Autowired
     private IPayBillService payBillService;
 
+    /**
+     * 分页查询应付账单。
+     *
+     * @param query 账单号、供应商、状态、币种，空着的条件不过滤
+     * @return 账单列表，不含费用明细
+     */
     @PreAuthorize("@ss.hasPermi('price:payBill:list')")
     @GetMapping("/list")
     public TableDataInfo list(PayBill query)
@@ -36,6 +42,12 @@ public class PayBillController extends BaseController
         return getDataTable(list);
     }
 
+    /**
+     * 查询一张应付账单的明细和操作日志。
+     *
+     * @param billId 应付账单ID
+     * @return 账单头、费用行和日志
+     */
     @PreAuthorize("@ss.hasPermi('price:payBill:query')")
     @GetMapping("/{billId}")
     public AjaxResult detail(@PathVariable Long billId)
@@ -43,6 +55,12 @@ public class PayBillController extends BaseController
         return success(payBillService.selectPayBillDetail(billId));
     }
 
+    /**
+     * 预览本次能生成账单的订单。只查询，不重算费用，也不写账单。
+     *
+     * @param command 查询方式，以及订单号、计费日或提单号
+     * @return 可生成订单、未找到的单号、已经入账的订单
+     */
     @PreAuthorize("@ss.hasPermi('price:payBill:query')")
     @PostMapping("/preview")
     public AjaxResult preview(@RequestBody PayBillCommand command)
@@ -50,6 +68,12 @@ public class PayBillController extends BaseController
         return success(payBillService.preview(command));
     }
 
+    /**
+     * 生成应付账单。先重算每票订单的尾程应付，再把当时的费用抄进草稿账单。
+     *
+     * @param command 供应商，以及按订单号、计费日或提单号划定的范围
+     * @return 刚生成的草稿账单
+     */
     @PreAuthorize("@ss.hasPermi('price:payBill:add')")
     @PostMapping
     public AjaxResult generate(@RequestBody PayBillCommand command)
@@ -57,6 +81,11 @@ public class PayBillController extends BaseController
         return success(payBillService.generate(command));
     }
 
+    /**
+     * 确认草稿账单。确认后才可以登记付款。
+     *
+     * @param billId 应付账单ID
+     */
     @PreAuthorize("@ss.hasPermi('price:payBill:confirm')")
     @PutMapping("/confirm/{billId}")
     public AjaxResult confirm(@PathVariable Long billId)
@@ -65,6 +94,11 @@ public class PayBillController extends BaseController
         return success();
     }
 
+    /**
+     * 把已确认的账单登记为已付款。已付款的账单不能直接作废。
+     *
+     * @param billId 应付账单ID
+     */
     @PreAuthorize("@ss.hasPermi('price:payBill:confirm')")
     @PutMapping("/paid/{billId}")
     public AjaxResult paid(@PathVariable Long billId)
@@ -73,6 +107,11 @@ public class PayBillController extends BaseController
         return success();
     }
 
+    /**
+     * 作废应付账单。账单和费用行保留，只改状态并记下作废原因。
+     *
+     * @param command 账单ID和作废原因
+     */
     @PreAuthorize("@ss.hasPermi('price:payBill:void')")
     @PutMapping("/void")
     public AjaxResult voidBill(@RequestBody PayBillCommand command)