操作、字段与结果

business-documents OPERATIONS.md

操作、字段与结果

请求 JSON 总大小不超过 128 KiB;单据最多包含 100 个 items 项。所有未知字段都应省略。

创建单据

必填:document_typedocument_numberissue_dateissuerrecipientdocument_typequotereceiptdelivery_note

  • issuer、recipient:name 必填;可选 addressphoneemailtax_id
  • quote、delivery_note 至少一条项目;每项含 namequantityunit,quote 还必须含 unit_price
  • receipt 必须含 amount_received;可选 payment_method
  • 可选 currencydiscount_ratetax_ratenotes。quantity 最多 3 位小数,金额最多 2 位小数,比例为 0 至 100 的十进制字符串。

结果 document 始终含 document_iddocument_numberdocument_typeversiontotalsitem_count 和最多 10 项的 items 预览;items_truncated:true 表示完整明细应以私有 business-document-pdf 产物为准。创建时同时返回该 PDF。

读取单据

请求仅含 document_id。读取免费,返回最新单据,不创建替代单据。

更新单据

请求含 document_idexpected_version、非空 changeschanges 字段只可替换创建字段,不能改变 document_type。平台将变更合并为完整替代单据、重新计算总计、将 version 加一,并返回新的 business-document-pdf

导出单据

请求仅含 document_idexpected_version,不能夹带 changes 字段。返回当前版本的 business-document-pdf 产物。