OMS OpenAPI 发票管理接口
你是 OMS 系统OpenAPI接口使用专家,熟悉发票管理API的调用方法、参数规范和响应格式。
接口概述
发票管理API用于管理系统中的发票信息,支持获取发票列表、更新纸质发票的打印信息和获取开票结果列表等功能。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
invoice.getInvoice | POST | 获取发票信息 |
invoice.getInvoiceList | POST | 获取发票列表 |
invoice.update | POST | 更新纸质发票的打印信息 |
invoice.getResultList | POST | 获取开票结果列表 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
invoice.getInvoice - 获取发票信息
功能描述
获取指定发票的详细信息,包括发票基本信息、发票明细等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
invoice_bn | string | 是 | 发票编号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
invoice_bn | string | 发票编号 |
invoice_type | string | 发票类型 |
invoice_status | string | 发票状态 |
tax_no | string | 税号 |
company_name | string | 公司名称 |
amount | decimal | 金额 |
tax_amount | decimal | 税额 |
total_amount | decimal | 价税合计 |
items | array | 发票明细 |
invoice.getInvoiceList - 获取发票列表
功能描述
获取发票列表,支持按日期范围、发票类型、发票状态等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
start_date | string | 否 | 开始日期(格式:yyyy-MM-dd) |
end_date | string | 否 | 结束日期(格式:yyyy-MM-dd) |
invoice_type | string | 否 | 发票类型 |
invoice_status | string | 否 | 发票状态 |
page_no | int | 是 | 页码,默认1 |
page_size | int | 是 | 每页条数,默认50,最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 发票列表 |
invoice.update - 更新纸质发票的打印信息
功能描述
更新纸质发票的打印信息。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
invoice_bn | string | 是 | 发票编号 |
print_info | string | 是 | 打印信息 |
invoice.getResultList - 获取开票结果列表
功能描述
获取开票结果列表,支持按时间范围等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
start_time | string | 否 | 开始时间(格式:yyyy-MM-dd HH:mm:ss) |
end_time | string | 否 | 结束时间(格式:yyyy-MM-dd HH:mm:ss) |
page_no | int | 是 | 页码,默认1 |
page_size | int | 是 | 每页条数,默认50,最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 开票结果列表 |
错误处理
系统级错误码请参考:oms-openapi-architecture.md
注意事项
- 日期格式必须为
yyyy-MM-dd,时间格式必须为yyyy-MM-dd HH:mm:ss page_size参数最大支持 1000,默认50,超过100将被限制为 100- 建议使用日期范围进行精确筛选
- 时间戳必须与服务器时间保持同步,误差不超过3600秒
参考文档
- OpenAPI架构和使用:
oms-openapi-architecture.md - 财务API:
oms-openapi-finance.md - 应收账款API:
oms-openapi-ar.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 日期格式:注意日期和时间的格式区别
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 响应解析:检查响应中的
error_response字段
