schema.py 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  1. from datetime import datetime
  2. from decimal import Decimal
  3. from typing import List, Optional
  4. from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
  5. class BankcardExtInfoSchema(BaseModel):
  6. """银行卡信息"""
  7. # account_type|收款账户类型
  8. # 【描述】收款账户类型。 1:对公(在金融机构开设的公司账户),如果银行卡为对公,必须传递省市支行信息或者联行号
  9. # 2:对私(在金融机构开设的个人账户)
  10. account_type: str = Field(description="收款账户类型: 1/2。对公: 1,对私: 2")
  11. # inst_name|机构名称
  12. # 【描述】当收款账户为对公账户时,机构名称必填;当收款账户为对私账户时,机构名称可为空。
  13. inst_name: Optional[str] = Field(default=None, description="机构名称")
  14. # 【描述】银行所在省份
  15. inst_province: Optional[str] = Field(default=None, description="银行所在省份")
  16. # inst_city|收款银行所在市
  17. # 【描述】收款银行所在市
  18. inst_city: Optional[str] = Field(default=None, description="收款银行所在市")
  19. # inst_branch_name|收款银行所属支行
  20. # 【描述】收款银行所属支行
  21. inst_branch_name: Optional[str] = Field(default=None, description="收款银行所属支行")
  22. # bank_code|银行支行联行号
  23. # 【描述】银行支行联行号
  24. bank_code: Optional[str] = Field(default=None, description="银行支行联行号")
  25. @field_validator("account_type")
  26. def validate_account_type(cls, v: str) -> str:
  27. if v not in ["1", "2"]:
  28. raise ValueError(f"account_type 必须是 {['1', '2']}")
  29. return v
  30. @field_validator("inst_name")
  31. def validate_inst_name(cls, v: Optional[str]) -> Optional[str]:
  32. if cls.account_type == "1" and v is None:
  33. raise ValueError("当 account_type 是 1 时,inst_name 必填")
  34. return v
  35. class PayeeInfoSchema(BaseModel):
  36. """收款方信息"""
  37. identity_type: str = Field(description="收款方类型: ALIPAY_ACCOUNT/BANK_CARD/BOOK")
  38. name: str = Field(description="收款方真实姓名")
  39. identity: str = Field(description="收款方唯一标识")
  40. bankcard_ext_info: Optional[BankcardExtInfoSchema] = Field(default=None, description="银行卡信息")
  41. @field_validator("identity_type")
  42. def validate_identity_type(cls, v: str) -> str:
  43. if v == "alipay":
  44. return "ALIPAY_ACCOUNT"
  45. elif v == "bank":
  46. return "BANK_CARD"
  47. elif v == "book":
  48. return "BOOK"
  49. else:
  50. raise ValueError(f"identity_type must be one of {['alipay', 'bank', 'book']}")
  51. @model_validator(mode='after')
  52. def validate_bankcard_ext_info(self) -> 'PayeeInfoSchema':
  53. """验证银行卡类型时bankcard_ext_info必填"""
  54. if self.identity_type == "BANK_CARD" and self.bankcard_ext_info is None:
  55. raise ValueError("当 identity_type 是银行卡时,bankcard_ext_info 必填")
  56. return self
  57. class AccountAuthorizeApplySchema(BaseModel):
  58. """申请转账授权签约请求"""
  59. enterprise_id: str = Field(description="企业ID")
  60. class AccountAuthorizeCallbackSchema(BaseModel):
  61. """转账授权回调通知请求"""
  62. enterprise_id: str = Field(description="企业ID")
  63. status: str = Field(description="协议状态: NORMAL")
  64. sign_time: str = Field(description="签约时间")
  65. class AccountCreateSchema(BaseModel):
  66. """开通资金专户请求"""
  67. enterprise_id: str = Field(description="企业ID")
  68. account_type: Optional[str] = Field(default="ALL", description="账户类型: INCOME/DISBURSE/ALL")
  69. scene: Optional[str] = Field(default="B2B_TRANS", description="场景类型: ENT_CREDIT/B2B_TRANS")
  70. account_book_id: Optional[str] = Field(default=None, description="资金专户号")
  71. remark: Optional[str] = Field(default=None, description="备注")
  72. class AccountDepositSchema(BaseModel):
  73. """资金专户充值请求"""
  74. enterprise_id: str = Field(description="企业ID")
  75. account_book_id: str = Field(description="资金专户号")
  76. amount: Decimal = Field(max_digits=10, decimal_places=2, gt=0, description="充值金额")
  77. out_biz_no: Optional[str] = Field(default=None, description="外部订单号")
  78. remark: Optional[str] = Field(default=None, description="充值备注")
  79. class AccountTransferSchema(BaseModel):
  80. """资金专户转账请求"""
  81. enterprise_id: str = Field(description="企业ID")
  82. account_book_id: Optional[str] = Field(default=None, description="付款方资金专户号")
  83. out_biz_no: Optional[str] = Field(default=None, description="商家侧订单号")
  84. # 转账总金额,单位为元,精确到小数点后两位
  85. amount: Decimal = Field(max_digits=10, decimal_places=2, gt=0, description="转账金额")
  86. order_title: Optional[str] = Field(default=None, description="转账标题")
  87. remark: Optional[str] = Field(default=None, description="转账备注")
  88. payee_info: PayeeInfoSchema = Field(description="收款方信息")
  89. employee_id: Optional[str] = Field(default=None, description="员工ID")
  90. priority: Optional[str] = Field(default="NORMAL", description="优先级: HIGH/NORMAL/LOW")
  91. ext_info: Optional[dict] = Field(default=None, description="扩展信息")
  92. @model_validator(mode="after")
  93. def validate_ext_info(self):
  94. if self.ext_info and not isinstance(self.ext_info, dict):
  95. raise ValueError("ext_info 需要是字典类型")
  96. return self
  97. class AccountWithdrawSchema(BaseModel):
  98. """资金专户提现请求"""
  99. enterprise_id: str = Field(description="企业ID")
  100. account_book_id: str = Field(description="资金专户号")
  101. amount: Decimal = Field(max_digits=10, decimal_places=2, gt=0, description="提现金额")
  102. out_biz_no: str = Field(description="商家侧订单号")
  103. class ReceiptApplySchema(BaseModel):
  104. """申请资金回单请求"""
  105. enterprise_id: str = Field(description="企业ID")
  106. order_no: str = Field(description="支付宝转账单号")
  107. class AccountQuerySchema(BaseModel):
  108. """资金专户查询请求"""
  109. enterprise_id: str = Field(description="企业ID")
  110. class AccountOutSchema(BaseModel):
  111. """资金专户响应模型"""
  112. model_config = ConfigDict(from_attributes=True)
  113. id: int = Field(description="主键ID")
  114. enterprise_id: Optional[str] = Field(default=None, description="所属企业ID")
  115. account_book_id: Optional[str] = Field(default=None, description="资金专户号")
  116. account_name: Optional[str] = Field(default=None, description="专户名称")
  117. scene: str = Field(description="场景类型")
  118. sign_status: str = Field(description="授权状态")
  119. sign_time: Optional[datetime] = Field(default=None, description="授权时间")
  120. status: str = Field(description="专户状态")
  121. created_time: datetime = Field(description="创建时间")
  122. updated_time: datetime = Field(description="更新时间")
  123. class AccountAuthorizeApplyOutSchema(BaseModel):
  124. """申请转账授权响应"""
  125. sign_url: Optional[str] = Field(description="签约链接")
  126. class AccountDepositOutSchema(BaseModel):
  127. """充值响应"""
  128. url: Optional[str] = Field(description="充值确认页面URL")
  129. class AccountTransferOutSchema(BaseModel):
  130. """转账响应"""
  131. status: Optional[str] = Field(description="转账状态,SUCCESS:成功(对转账到银行卡的单据, 该状态可能变为退票[REFUND]); FAIL:失败; DEALING:处理中(转账到支付宝账户不涉及); REFUND:退票(转账到支付宝账户不涉及)")
  132. order_no: Optional[str] = Field(default=None, description="支付宝转账单号")
  133. fund_order_id: Optional[str] = Field(default=None, description="宝支付资金流水号")
  134. class AccountTransferBatchSchema(BaseModel):
  135. """批量资金专户转账请求"""
  136. transfers: List[AccountTransferSchema] = Field(
  137. description="转账列表"
  138. )
  139. callback_url: Optional[str] = Field(
  140. default=None,
  141. description="转账结果回调URL"
  142. )
  143. class AccountTransferBatchOutSchema(BaseModel):
  144. """批量转账响应"""
  145. batch_id: str = Field(description="批次ID")
  146. status: str = Field(description="状态: PENDING/PROCESSING/COMPLETED")
  147. total: int = Field(description="总笔数")
  148. processed: int = Field(description="已处理笔数")
  149. success: int = Field(description="成功笔数")
  150. failed: int = Field(description="失败笔数")
  151. class TransferResultSchema(BaseModel):
  152. """单笔转账结果"""
  153. out_biz_no: str = Field(description="商家侧订单号")
  154. status: str = Field(description="状态: SUCCESS/FAIL")
  155. order_no: Optional[str] = Field(default=None, description="支付宝转账单号")
  156. error_msg: Optional[str] = Field(default=None, description="错误信息")
  157. class TransferTaskSchema(BaseModel):
  158. """转账任务"""
  159. task_id: str = Field(description="任务ID")
  160. enterprise_id: str = Field(description="企业ID")
  161. account_book_id: str = Field(description="资金专户号")
  162. out_biz_no: str = Field(description="商家侧订单号")
  163. amount: Decimal = Field(max_digits=10, decimal_places=2, gt=0, description="转账金额")
  164. order_title: str = Field(description="转账标题")
  165. payee_info: PayeeInfoSchema = Field(description="收款方信息")
  166. priority: str = Field(default="NORMAL", description="优先级: HIGH/NORMAL/LOW")
  167. status: str = Field(default="PENDING", description="状态: PENDING/PROCESSING/SUCCESS/FAILED/RETRYING")
  168. retries: int = Field(default=0, description="重试次数")
  169. created_at: str = Field(description="创建时间")
  170. class TransferTaskOutSchema(BaseModel):
  171. """转账任务响应"""
  172. task_id: str = Field(description="任务ID")
  173. status: str = Field(description="任务状态")
  174. enterprise_id: str = Field(description="企业ID")
  175. out_biz_no: str = Field(description="商家侧订单号")
  176. amount: Decimal = Field(max_digits=10, decimal_places=2, gt=0, description="转账金额")
  177. priority: str = Field(description="优先级")
  178. created_at: str = Field(description="创建时间")
  179. class TransferQueueStatusSchema(BaseModel):
  180. """队列状态"""
  181. enterprise_id: str = Field(description="企业ID")
  182. pending_count: int = Field(description="待处理任务数")
  183. processing_count: int = Field(description="处理中任务数")
  184. completed_count: int = Field(description="已完成任务数")
  185. high_priority_count: int = Field(description="高优先级任务数")
  186. normal_priority_count: int = Field(description="普通优先级任务数")
  187. low_priority_count: int = Field(description="低优先级任务数")
  188. class TransferOutSchema(BaseModel):
  189. """转账记录响应"""
  190. model_config = ConfigDict(from_attributes=True)
  191. # id: int = Field(description="主键ID")
  192. enterprise_id: Optional[str] = Field(default=None, description="所属企业ID")
  193. out_biz_no: Optional[str] = Field(default=None, description="商家侧订单号")
  194. account_book_id: Optional[str] = Field(default=None, description="付款方资金专户号")
  195. amount: Decimal = Field(max_digits=10, decimal_places=2, gt=0, description="转账金额")
  196. order_title: Optional[str] = Field(default=None, description="转账标题")
  197. payee_info: Optional[dict] = Field(default=None, description="收款方信息")
  198. status: str = Field(description="转账状态")
  199. order_no: Optional[str] = Field(default=None, description="支付宝转账单号")
  200. error_code: Optional[str] = Field(default=None, description="错误码")
  201. error_msg: Optional[str] = Field(default=None, description="错误信息")
  202. ext_info: Optional[dict] = Field(default=None, description="扩展信息")
  203. created_time: datetime = Field(description="创建时间")
  204. class TransferListOutSchema(BaseModel):
  205. """转账记录列表响应"""
  206. model_config = ConfigDict(from_attributes=True)
  207. id: int = Field(description="主键ID")
  208. out_biz_no: Optional[str] = Field(default=None, description="商家侧订单号")
  209. account_book_id: Optional[str] = Field(default=None, description="付款方资金专户号")
  210. amount: Optional[float] = Field(default=None, description="转账金额")
  211. order_title: Optional[str] = Field(default=None, description="转账标题")
  212. status: str = Field(description="转账状态")
  213. order_no: Optional[str] = Field(default=None, description="支付宝转账单号")
  214. fund_order_id: Optional[str] = Field(default=None, description="宝支付资金流水号")
  215. payee_info: Optional[dict] = Field(default=None, description="收款方信息")
  216. created_time: datetime = Field(description="创建时间")
  217. class DepositOutSchema(BaseModel):
  218. """充值记录响应"""
  219. model_config = ConfigDict(from_attributes=True)
  220. id: int = Field(description="主键ID")
  221. enterprise_id: Optional[str] = Field(default=None, description="所属企业ID")
  222. out_biz_no: Optional[str] = Field(default=None, description="商家侧订单号")
  223. account_book_id: Optional[str] = Field(default=None, description="资金专户号")
  224. amount: Optional[float] = Field(default=None, description="充值金额")
  225. deposit_url: Optional[str] = Field(default=None, description="充值确认页面URL")
  226. status: str = Field(description="充值状态")
  227. created_time: datetime = Field(description="创建时间")
  228. class WithdrawOutSchema(BaseModel):
  229. """提现记录响应"""
  230. model_config = ConfigDict(from_attributes=True)
  231. id: int = Field(description="主键ID")
  232. enterprise_id: Optional[str] = Field(default=None, description="所属企业ID")
  233. out_biz_no: Optional[str] = Field(default=None, description="商家侧订单号")
  234. account_book_id: Optional[str] = Field(default=None, description="资金专户号")
  235. amount: Optional[Decimal] = Field(default=None, description="提现金额")
  236. status: str = Field(description="提现状态")
  237. order_no: Optional[str] = Field(default=None, description="支付宝提现单号")
  238. error_code: Optional[str] = Field(default=None, description="错误码")
  239. error_msg: Optional[str] = Field(default=None, description="错误信息")
  240. created_time: datetime = Field(description="创建时间")
  241. class ReceiptApplyOutSchema(BaseModel):
  242. """申请回单响应"""
  243. model_config = ConfigDict(from_attributes=True)
  244. file_id: str = Field(description="文件申请号")
  245. class ReceiptQueryOutSchema(BaseModel):
  246. """查询回单响应"""
  247. model_config = ConfigDict(from_attributes=True)
  248. file_id: str = Field(description="文件申请号")
  249. status: str = Field(description="处理状态: INIT/PROCESS/SUCCESS/FAIL")
  250. download_url: Optional[str] = Field(default=None, description="下载链接")
  251. error_message: Optional[str] = Field(default=None, description="错误信息")
  252. class AccountOperationOutSchema(BaseModel):
  253. """资金专户操作响应"""
  254. model_config = ConfigDict(from_attributes=True)
  255. enterprise_id: Optional[str] = Field(default=None, description="企业ID")
  256. account_book_id: Optional[str] = Field(default=None, description="资金专户号")
  257. class ConsumeDetailQuerySchema(BaseModel):
  258. """账单详情查询请求"""
  259. pay_no: str = Field(..., description="支付宝账单号")
  260. enterprise_id: Optional[str] = Field(default=None, description="企业ID(2.0接口签约企业必填)")
  261. ant_shop_id: Optional[str] = Field(default=None, description="蚂蚁门店ID(商户服务商必填)")
  262. query_options: Optional[List[str]] = Field(
  263. default=None,
  264. description="查询选项: Refund(关联退款账单)/Order(关联订单)/Ticket(关联票据)"
  265. )
  266. class EcConsumeInfoSchema(BaseModel):
  267. """账单信息子属性"""
  268. model_config = ConfigDict(from_attributes=True)
  269. account_id: str = Field(description="共同账户ID")
  270. pay_no: str = Field(description="交易流水号")
  271. consume_type: str = Field(description="账单类型: CONSUME(消费账单)/REFUND(退款账单)/TRANSFER(转账账单)")
  272. gmt_biz_create: str = Field(description="账单创建时间,格式:yyyy-MM-dd HH:mm:ss")
  273. consume_biz_type: str = Field(description="账单业务类型: EC_PAY(因公支付)/EC_CLLCT(因公收款)")
  274. consume_amount: str = Field(description="账单金额,单位:元")
  275. order_complete_label: str = Field(description="订单完结标识: 0(未完结)/1(已完结)")
  276. refund_status: str = Field(description="退款状态: INIT(未退款)/REFUND_PART(部分退款)/REFUND_FULL(全额退款)")
  277. refund_amount: str = Field(description="退款金额,单位:元")
  278. peer_payer_card_name: str = Field(description="实际出资人名称")
  279. user_id: Optional[str] = Field(default=None, description="员工支付宝UID")
  280. open_id: Optional[str] = Field(default=None, description="员工open_id")
  281. enterprise_id: str = Field(description="企业ID")
  282. employee_id: str = Field(description="员工ID")
  283. enterprise_name: Optional[str] = Field(default=None, description="企业名称")
  284. employee_name: Optional[str] = Field(default=None, description="员工名称")
  285. consume_scene_code: Optional[str] = Field(default=None, description="消费场景编码")
  286. consume_type_sub_category: Optional[str] = Field(default=None, description="消费类型子类")
  287. consume_title: Optional[str] = Field(default=None, description="账单标题")
  288. gmt_pay: Optional[str] = Field(default=None, description="账单支付时间")
  289. gmt_refund: Optional[str] = Field(default=None, description="退款时间")
  290. pay_amount: Optional[str] = Field(default=None, description="用户实际支付金额")
  291. invoice_amount: Optional[str] = Field(default=None, description="用户实际承担金额")
  292. peer_pay_amount: Optional[str] = Field(default=None, description="企业代付金额")
  293. subsidy_amount: Optional[str] = Field(default=None, description="补贴金额")
  294. ext_infos: Optional[dict] = Field(default=None, description="扩展信息")
  295. class ConsumeDetailOutSchema(BaseModel):
  296. """账单详情查询响应"""
  297. model_config = ConfigDict(from_attributes=True)
  298. consume_info: EcConsumeInfoSchema = Field(description="账单信息")