# 收付款 API

# 审核收付款

接口地址:/api/open/payment/audit

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "code": "",
    "message": "",
    "result": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
auditParam	auditParam	body	true	RequestParameter«InvoiceAuditParam»	RequestParameter«InvoiceAuditParam»
body			false	InvoiceAuditParam	InvoiceAuditParam
code	销售订单编码		true	string
message	审核人意见		false	string
result	审核人结论,可用值:PASS,REFUSAL		true	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 创建收付款

接口地址:/api/open/payment/create

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "amount": 0,
    "businessDatetime": 0,
    "comments": "",
    "enterpriseCode": "",
    "staffCode": "",
    "type": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerSaveParamRequestParameter	customerSaveParamRequestParameter	body	true	RequestParameter«PaymentSaveParams»	RequestParameter«PaymentSaveParams»
body			false	PaymentSaveParams	PaymentSaveParams
amount	金额		false	number
businessDatetime	收付款日期		false	integer
comments	备注		false	string
enterpriseCode	企业编码		false	string
staffCode	创建人		false	string
type	类型,可用值:SALES_ORDER_IN,SALES_ORDER_OUT,PURCHASE_ORDER_OUT,PURCHASE_ORDER_IN		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 删除收付款

接口地址:/api/open/payment/delete

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

参数是编码

请求示例:

{
  "body": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
code	code	body	false	RequestParameter«string»	RequestParameter«string»
body			false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

# 查询收付款列表

接口地址:/api/open/payment/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "createByLike": "",
    "endTime": "",
    "enterpriseCategoryIds": [],
    "enterpriseCodeLike": "",
    "isReject": "",
    "pagingParam": {
      "length": 0,
      "start": 0
    },
    "paymentNumberLike": "",
    "sortOrder": "",
    "sortType": "",
    "startTime": "",
    "states": [],
    "types": [],
    "writeOffsProgress": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
queryParamRequestParameter	queryParamRequestParameter	body	true	RequestParameter«PaymentQueryParam»	RequestParameter«PaymentQueryParam»
body			false	PaymentQueryParam	PaymentQueryParam
createByLike	创建人		false	string
endTime	时间		false	string
enterpriseCategoryIds	企业分类-多选		false	array	integer
enterpriseCodeLike	企业编号模糊搜索		false	string
isReject	驳回状态筛选,可用值:ON,OFF		false	string
pagingParam			false	PagingParam	PagingParam
length			false	integer
start			false	integer
paymentNumberLike	账款单号模糊搜索		false	string
sortOrder	排序方式 asc：正序 desc：倒序		false	string
sortType	排序类型		false	string
startTime	开始时间		false	string
states	1 待确认，2 已确认，3 已取消		false	array	integer
types	0：订单收款 1：订单付退款 2：采购单付款 3：采购单收退款		false	array	integer
writeOffsProgress	0：未核销 1：部分核销 2：全部核销,可用值:NO_WRITE_OFFS,PART_WRITE_OFFS,ALL_WRITE_OFFS		false	string

响应状态:

状态码	说明	schema
200	OK	ListPagingResponse«Payment»
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		ListPagingResponseData«Payment»	ListPagingResponseData«Payment»
length		integer(int32)
list		array	Payment
amount	金额	number
businessDatetime	收付款日期	string
code	账款单号	string
comments	备注	string
enterpriseCode	企业编码	string
enterpriseName	企业编码	string
staffCode	创建人	string
staffName	创建人	string
status	审核状态,可用值:PASS,REFUSAL	string
type	类型,可用值:SALES_ORDER_IN,SALES_ORDER_OUT,PURCHASE_ORDER_OUT,PURCHASE_ORDER_IN	string
recordsTotal		integer(int32)
start		integer(int32)
message		string

响应示例:

{
	"code": 0,
	"data": {
		"length": 0,
		"list": [
			{
				"amount": 0,
				"businessDatetime": "",
				"code": "",
				"comments": "",
				"enterpriseCode": "",
				"enterpriseName": "",
				"staffCode": "",
				"staffName": "",
				"status": "",
				"type": ""
			}
		],
		"recordsTotal": 0,
		"start": 0
	},
	"message": ""
}

# 修改收付款

接口地址:/api/open/payment/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "body": {
    "amount": 0,
    "businessDatetime": 0,
    "comments": "",
    "enterpriseCode": "",
    "paymentCode": "",
    "staffCode": "",
    "type": ""
  }
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
customerSaveParamRequestParameter	customerSaveParamRequestParameter	body	true	RequestParameter«PaymentEditParam»	RequestParameter«PaymentEditParam»
body			false	PaymentEditParam	PaymentEditParam
amount	金额		false	number
businessDatetime	收付款日期		false	integer
comments	备注		false	string
enterpriseCode	企业编码		false	string
paymentCode	收付款单号		false	string
staffCode	创建人		false	string
type	类型,可用值:SALES_ORDER_IN,SALES_ORDER_OUT,PURCHASE_ORDER_OUT,PURCHASE_ORDER_IN		false	string

响应状态:

状态码	说明	schema
200	OK	BaseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
message		string

响应示例:

{
	"code": 0,
	"message": ""
}

← 退货单 API 销售发票 API →