Appearance
获取合同列表 API
| Path | Method | Created At |
|---|---|---|
| /api/contracts/{customerId}/paginate | GET | 2025-11-29 00:39:11 |
Request
| Key | Rule | Description |
|---|---|---|
| customerId | string,size:24 | trans:validate.CUSTOMER_NOT_FOUND |
| page | integer,min:1,max:100 | 页码必须为正整数 |
| page_size | integer,min:5,max:1000 | 每页数量必须为正整数 |
Response
| Key | Type | Example | Comment |
|---|---|---|---|
| id | string | 43ab23 | 编号 |
| contractNo | string | HS245 | 合同编号 |
| customerId | string | 23d82 | 客户ID |
| agentId | string | 43d32 | 渠道ID |
| isAgent | bool | true | 是否为渠道 |
| contractor | string | 杭州市金职院 | 签约单位 |
| title | string | 一期合同 | 合同名称 |
| deliveryAmount | string | 23.34 | 发货金额 |
| purchaseCost | string | 123.34 | 采购费用 |
| prePurchaseCost | string | 1234.23 | 预采购成本 |
| advanceCost | string | 1234.23 | 垫资成本 |
| projectName | string | 金职院基础网络建设项目 | 项目名称 |
| customerName | string | 金职院 | 客户名称 |
| totalAmount | string | 300000.00 | 总金额 |
| salesLeadId | int | 1 | 销售负责人编号 |
| salesLeaderName | string | 张三 | 销售负责人 |
| grossProfit | float | 24 | 毛利 |
| grossProfitMargin | float | 0.34 | 毛利率 |
| purchaseAmount | float | 1.24 | 采购金额 |
| retentionMoney | float | 1.24 | 质保金 |
| cumulativeInvoicedAmount | float | 1.24 | 累计开票金额 |
| sellingExpenses | float | 1.24 | 销售费用 |
| cumulativeReceipts | float | 1.24 | 累计收款项 |
| outstandingReceivables | float | 1.24 | 未收款项 |
| signingMethodName | string | 合作过签 | 签订方式 |
| signingDate | string | 2021-01-01 | 签订日期 |
| industryAttribute | string | 工商 | 行业属性 |
| productCategory | string | 路由器 | 产品分类 |
| remark | string | 没 | 备注 |
| isRoutineCheck | bool | true | 是否巡检 |
| routineCheckCycle | string | MONTH | 巡检周期 |
| routineCheckYears | int | 1 | 巡检年限 |
| projectType | string | 集成无初验 | 项目类型 |
TypeScript Result Example:
TypeScript
interface Result {
/** 编号 */
id: string;
/** 合同编号 */
contractNo: string;
/** 客户ID */
customerId: string;
/** 渠道ID */
agentId: string;
/** 是否为渠道 */
isAgent: any;
/** 签约单位 */
contractor: string;
/** 合同名称 */
title: string;
/** 发货金额 */
deliveryAmount: string;
/** 采购费用 */
purchaseCost: string;
/** 预采购成本 */
prePurchaseCost: string;
/** 垫资成本 */
advanceCost: string;
/** 项目名称 */
projectName: string;
/** 客户名称 */
customerName: string;
/** 总金额 */
totalAmount: string;
/** 销售负责人编号 */
salesLeadId: number;
/** 销售负责人 */
salesLeaderName: string;
/** 毛利 */
grossProfit: any;
/** 毛利率 */
grossProfitMargin: any;
/** 采购金额 */
purchaseAmount: any;
/** 质保金 */
retentionMoney: any;
/** 累计开票金额 */
cumulativeInvoicedAmount: any;
/** 销售费用 */
sellingExpenses: any;
/** 累计收款项 */
cumulativeReceipts: any;
/** 未收款项 */
outstandingReceivables: any;
/** 签订方式 */
signingMethodName: string;
/** 签订日期 */
signingDate: string;
/** 行业属性 */
industryAttribute: string;
/** 产品分类 */
productCategory: string;
/** 备注 */
remark: string;
/** 是否巡检 */
isRoutineCheck: any;
/** 巡检周期 */
routineCheckCycle: string;
/** 巡检年限 */
routineCheckYears: number;
/** 项目类型 */
projectType: string;
}