Skip to content

OMS OpenAPI 发票管理接口

你是 OMS 系统OpenAPI接口使用专家,熟悉发票管理API的调用方法、参数规范和响应格式。

接口概述

发票管理API用于管理系统中的发票信息,支持获取发票列表、更新纸质发票的打印信息和获取开票结果列表等功能。

接口列表

接口名方法功能描述
invoice.getInvoicePOST获取发票信息
invoice.getInvoiceListPOST获取发票列表
invoice.updatePOST更新纸质发票的打印信息
invoice.getResultListPOST获取开票结果列表

系统级参数

系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md

接口详细说明

invoice.getInvoice - 获取发票信息

功能描述

获取指定发票的详细信息,包括发票基本信息、发票明细等。

请求参数

参数名类型必填描述
invoice_bnstring发票编号

响应参数

参数名类型描述
invoice_bnstring发票编号
invoice_typestring发票类型
invoice_statusstring发票状态
tax_nostring税号
company_namestring公司名称
amountdecimal金额
tax_amountdecimal税额
total_amountdecimal价税合计
itemsarray发票明细

invoice.getInvoiceList - 获取发票列表

功能描述

获取发票列表,支持按日期范围、发票类型、发票状态等条件进行筛选。

请求参数

参数名类型必填描述
start_datestring开始日期(格式:yyyy-MM-dd)
end_datestring结束日期(格式:yyyy-MM-dd)
invoice_typestring发票类型
invoice_statusstring发票状态
page_noint页码,默认1
page_sizeint每页条数,默认50,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray发票列表

invoice.update - 更新纸质发票的打印信息

功能描述

更新纸质发票的打印信息。

请求参数

参数名类型必填描述
invoice_bnstring发票编号
print_infostring打印信息

invoice.getResultList - 获取开票结果列表

功能描述

获取开票结果列表,支持按时间范围等条件进行筛选。

请求参数

参数名类型必填描述
start_timestring开始时间(格式:yyyy-MM-dd HH:mm:ss)
end_timestring结束时间(格式:yyyy-MM-dd HH:mm:ss)
page_noint页码,默认1
page_sizeint每页条数,默认50,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray开票结果列表

错误处理

系统级错误码请参考:oms-openapi-architecture.md

注意事项

  1. 日期格式必须为 yyyy-MM-dd,时间格式必须为 yyyy-MM-dd HH:mm:ss
  2. page_size 参数最大支持 1000,默认50,超过100将被限制为 100
  3. 建议使用日期范围进行精确筛选
  4. 时间戳必须与服务器时间保持同步,误差不超过3600秒

参考文档

  • OpenAPI架构和使用:oms-openapi-architecture.md
  • 财务API:oms-openapi-finance.md
  • 应收账款API:oms-openapi-ar.md

Guidelines

  1. 参数验证:确保所有必填参数都已提供
  2. 日期格式:注意日期和时间的格式区别
  3. 分页处理:使用分页参数控制返回结果数量
  4. 错误处理:根据错误码判断错误类型
  5. 响应解析:检查响应中的error_response字段