v4报告
Reports v4 API可以用于读取和修改现有费用报告的费用报告标题。该API可用于更改报表名称、业务用途等属性。
之前的版本
- 报告头v1(已弃用)文档可用在这里
- 已获取Reports v3文档在这里
限制
这个API只对那些被SAP Concur授予访问权限的合作伙伴可用。访问此文档并不提供对API的访问。
产品和版本
使用范围
要求的范围:
的名字 |
描述 |
端点 |
expense.report.read |
获取有关费用报告的信息。 |
得到 |
expense.report.readwrite |
读写费用报告标题。 |
补丁 |
expense.report.workflowstatus.write |
在工作流中批准或发回报告 |
补丁 |
user.read |
获取必要的用户信息用户标识 . |
得到 |
可选范围:
的名字 |
描述 |
端点 |
spend.listitem.read |
对花费列表项的只读访问listItemId . |
得到 |
spend.list.read |
只读访问支出列表和类别详细信息。 |
得到 |
依赖关系
SAP Concur客户端必须购买Concur Expense才能使用这个API。此API需要Identity v4 API,目前仅对已批准的早期访问合作伙伴可用。有关更多信息,请与您的SAP Concur代表联系。
访问令牌的使用
该API支持公司级和用户级访问令牌。
按ID检索报表
检索特定报表标头的详细信息。
作用域
expense.report.read
——是指使用范围全部细节。
请求
URI模板
https://{datacenterURI}/ / expensereports / v4 /用户{用户标识}/环境/{contextType}/报告/{reportId}
参数
的名字 |
类型 |
格式 |
描述 |
用户标识 |
字符串 |
- |
要求SAP Concur用户的唯一标识符。使用身份v4 API检索用户标识 . |
contextType |
字符串 |
- |
要求SAP Concur用户的访问级别,它决定了他们可以查看/修改的表单字段。支持的价值观:旅行者 ,代理 |
reportId |
字符串 |
- |
要求正在读取的报表的唯一标识符。 |
响应
状态码
有效载荷
例子
请求
旋度——位置——请求得到“https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3 b2e8 - 4907 - 9672 - 5 - b3f49b1c643/context/traveler/reports/764428dd6a664af0bfcb”\——头“授权:无记名{access_token}”\——头“Concur-CorrelationId: Expense-Report-test”\——头“application / json内容类型:
响应
200好了{“approvalStatus”:“不提交”,“approvalStatusId”:“A_NOTF”,“concurAuditStatus”:“设立特委会”,“customData”:[{“id”:“custom15”,“价值”:“4366 a89a916f074099a971b000989a94”,“isValid”:真正的,“listItemUrl”:“https://us.api.concursolutions.com/list/v4/items?id=4366A89A916F074099A971B000989A94”},{“id”:“custom16”,“价值”:“Test33224ASDF”,“isValid”:真正的,“listItemUrl”:零},{“id”:“custom3”,“价值”:“582 ae31d0f506c4baa97573f2a90f03b”,“isValid”:真正的,“listItemUrl”:“https://us.api.concursolutions.com/list/v4/items?id=582AE31D0F506C4BAA97573F2A90F03B”},{“id”:“custom4”,“价值”:“79 ae45d0f6757946ac2b01cdfa6ca326”,“isValid”:真正的,“listItemUrl”:“https://us.api.concursolutions.com/list/v4/items?id=79AE45D0F6757946AC2B01CDFA6CA326”}],“分类帐”:“默认”,“ledgerId”:“2703 e3fbd393da4484ed3cb07303407c”,“paymentStatus”:“没有了”,“paymentStatusId”:“P_NOTP”,“submitDate”:零,“approvedAmount”:{“价值”: 525.00000000,“currencyCode”:“美元”},“claimedAmount”:{“价值”: 525.00000000,“currencyCode”:“美元”},“amountCompanyPaid”:{“价值”: 0 e-8,“currencyCode”:“美元”},“paymentConfirmedAmount”:{“价值”: 0 e-8,“currencyCode”:“美元”},“amountDueCompany”:{“价值”: 0 e-8,“currencyCode”:“美元”},“amountDueCompanyCard”:{“价值”: 0 e-8,“currencyCode”:“美元”},“amountDueEmployee”:{“价值”: 0 e-8,“currencyCode”:“美元”},“personalAmount”:{“价值”: 0 e-8,“currencyCode”:“美元”},“reportTotal”:{“价值”: 525.00000000,“currencyCode”:“美元”},“amountNotApproved”:{“价值”: 0 e-8,“currencyCode”:“美元”},“isFinancialIntegrationEnabled”:假,“canReopen”:假,“isReopened”:假,“isReceiptImageAvailable”:假,“isReceiptImageRequired”:真正的,“isPaperReceiptsReceived”:假,“reportId”:“764428 dd6a664af0bfcb”,“货币”:“我们,美元”,“currencyCode”:“美元”,“analyticsGroupId”:“C8CB395275EC4FE9AF6CD5B535EA2B17”,“hierarchyNodeId”:“0 f941e0b0a2c974eb2b06cda67973052”,“allocationFormId”:“FD7E9C6389EF495B85042319D58CAE53”,“链接”:[{“rel”:“自我”,“href”:“https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3 - b2e8 - 4907 - 9672 - 5 - b3f49b1c643/context/traveler/reports/764428dd6a664af0bfcb”,“hreflang”:零,“媒体”:零,“标题”:零,“类型”:零,“弃用”:零,“方法”:“获得”,“isTemplated”:假}],“reportDate”:“2020-03-25”,“reportFormId”:“674 b67f0c6bd4e9ca5d91afb82cc8abb”,“businessPurpose”:“设施清洁及翻新”,“countryCode”:“我们”,“countrySubDivisionCode”:“US-WA”,“policyId”:“EE095F66AEF52B4A9CE62952601E5CB1”,“startDate可以”:“2020-03-10”,“endDate”:“2020-03-14”,“名称”:“3月费用”,“政策”:“JH -美国费用政策”,“国家”:“美国”,“标识”:“32 c2fcc3——b2e8 - 4907 - 9672 - 5 - b3f49b1c643”,“reportType”:“普通”,“redirectFund”:零,“创建日期”:“2020 - 03 - 25 - t20:42:39z”,“canRecall”:假,“reportVersion”: 0}
更新特定报告
更新指定报表的属性。
作用域
expense.report.readwrite
——是指使用范围全部细节。
请求
URI模板
https://{datacenterURI}/ / expensereports / v4 /用户{用户标识}/环境/{contextType}/报告/{reportId}
参数
的名字 |
类型 |
格式 |
描述 |
用户标识 |
字符串 |
- |
要求SAP Concur用户的唯一标识符。使用身份v4 API检索用户标识 . |
contextType |
字符串 |
- |
要求SAP Concur用户的访问级别,它决定了他们可以查看/修改的表单字段。支持的价值观:旅行者 ,代理 |
reportId |
字符串 |
- |
要求正在修改的报表的唯一标识符。 |
其他设计规范
费用报告v4中的PATCH操作符合JSON合并补丁规范:
有效载荷
响应
状态码
有效载荷
例子
请求
旋度——位置——请求补丁“https://us.api.concursolutions.com/expensereports/v4/users/32c2fcc3 b2e8 - 4907 - 9672 - 5 - b3f49b1c643/context/traveler/reports/764428dd6a664af0bfcb”\——头“授权:无记名{access_token}”\——头“Concur-CorrelationId: Viswa测试”\——头“application / json内容类型:\——data-raw'{"customData": [{"id": "custom15", "value": "E31CB42509F9FF408BA7DD6713AB49BD", "isValid": true}], "businessPurpose":"Office Facility Supplies", "reportSource":"OTHER"}'
响应
批准或发回报告
如果指定的报表位于系统步骤中,则Approve功能将该报表推进到下一个步骤。Send Back函数将指定的报表发送回报表所有者。
作用域
expense.report.workflowstatus.write
——是指使用范围全部细节。
请求
URI模板
https://{datacenterURI}/ / expensereports / v4 /报告{reportId}/通过https://{datacenterURI}/ / expensereports / v4 /报告{reportId}/ sendBack
参数
的名字 |
类型 |
格式 |
描述 |
reportId |
字符串 |
- |
要求正在被批准或发送回的报告的唯一标识符。 |
其他设计规范
费用报告v4中的PATCH操作符合JSON合并补丁规范:
有效载荷
响应
状态码
有效载荷
例子
请求
旋度——位置——请求补丁“https://us.api.concursolutions.com/expensereports/reports/764428DD6A664AF0BFCB/Approve”\——头“授权:无记名{access_token}”\——头“Concur-CorrelationId: Viswa测试”\——头“application / json内容类型:\——data-raw”{“reportSource”:“其他”}’
响应
模式
ReportDetails
的名字 |
类型 |
格式 |
描述 |
allocationFormId |
字符串 |
- |
分配表单的唯一标识符。 |
amountCompanyPaid |
量 |
- |
要求公司支付的金额。 |
amountDueCompany |
量 |
- |
要求雇员欠公司的金额。 |
amountDueCompanyCard |
量 |
- |
要求员工/公司欠公司卡的金额。 |
amountDueEmployee |
量 |
- |
要求公司欠员工的金额。 |
amountNotApproved |
量 |
- |
要求报告中未批准的金额。 |
analyticsGroupId |
字符串 |
- |
要求商业智能层次结构节点的唯一标识符。 |
approvalStatus |
字符串 |
- |
要求报告的批准状态,用用户的语言表示。 |
approvalStatusId |
字符串 |
- |
要求批准状态的唯一标识符。 |
approvedAmount |
量 |
- |
要求报告中批准的费用总额。 |
businessPurpose |
字符串 |
- |
用户为业务目的输入的文本。 |
canRecall |
布尔 |
真正的 /假 |
要求当前用户是否可以收回报表。 |
canReopen |
布尔 |
真正的 /假 |
付款后是否可以重新打开报告。 |
cardProgramStatementPeriodId |
字符串 |
- |
卡程序报表期间在报表上的唯一标识符。 |
claimedAmount |
量 |
- |
要求报告中所有非个人支出的总额。 |
concurAuditStatus |
字符串 |
- |
要求报告的审计状态。 |
国家 |
字符串 |
- |
与报告关联的国家名称(按接收语言 头)。 |
countryCode |
字符串 |
ISO 3166-1 alpha-2国家代码 |
该报告的国家。最大特点:2。例子:我们 ——美国 |
countrySubDivisionCode |
字符串 |
- |
位置国家分司ISO 3166-2代码。 |
创建日期 |
字符串 |
YYYY-MM-DDTHH: mm: ssZ |
要求用户创建报表时的UTC日期时间。 |
货币 |
字符串 |
- |
要求报告的货币名称(按接收语言 头)。 |
currencyCode |
字符串 |
- |
要求3个字母的ISO 4217货币代码用于报销报告货币。例子:美元 ——美元;强 ——巴西雷亚尔;计算机辅助设计 -加拿大元;瑞士法郎 ——瑞士法郎;欧元 欧元;GBO ——英镑;港币 ——香港 |
customData |
CustomData |
- |
详情请参阅customData 字段。这些字段可能没有数据,这取决于配置。 |
endDate |
字符串 |
YYYY-MM-DD |
报告的结束日期(ISO-8601),用于基于行程的报告。 |
hierarchyNodeId |
字符串 |
- |
要求报表资源的组层次结构节点的唯一标识符。 |
isFinancialIntegrationEnabled |
布尔 |
真正的 /假 |
要求是否已为该报表启用财务集成设置。 |
isPaperReceiptsReceived |
布尔 |
真正的 /假 |
要求是否收到报告的纸质收据。 |
isReceiptImageAvailable |
布尔 |
真正的 /假 |
要求收据图像在报表级别是否可用。 |
isReceiptImageRequired |
布尔 |
真正的 /假 |
要求在报告级别上是否需要接收图像。 |
isReopened |
布尔 |
真正的 /假 |
是否重新打开报表。 |
分类帐 |
字符串 |
- |
要求报表所属的分类帐名称(按接收语言 头)。 |
ledgerId |
字符串 |
- |
要求分类账的唯一标识符。 |
链接 |
链接 |
- |
与此调用相关的资源链接。 |
的名字 |
字符串 |
- |
要求用户输入的费用报告名称。 |
paymentConfirmedAmount |
量 |
- |
要求报告上的金额。 |
paymentStatus |
字符串 |
- |
要求用用户语言显示的报告的支付状态。 |
paymentStatusId |
字符串 |
- |
要求报告的支付状态的唯一标识符。 |
personalAmount |
量 |
- |
要求在报告上标明为个人费用的总金额。 |
政策 |
字符串 |
- |
要求报表所遵循的策略名称(按接收语言 头)。 |
policyId |
字符串 |
- |
要求应用于此报表的策略的唯一标识符。 |
redirectFund |
RedirectFund |
- |
资金转至IBCP卡。 |
reportDate |
字符串 |
YYYY-MM-DD |
由用户分配给报告的日期。 |
reportFormId |
字符串 |
- |
要求报表的唯一标识符。 |
reportId |
字符串 |
- |
要求报表资源的唯一标识符。 |
reportNumber |
字符串 |
- |
用户友好的报表唯一标识符。 |
reportTotal |
量 |
- |
要求报告上的总额。 |
reportType |
字符串 |
- |
此值标识用于创建报告的方法。报表指的是公司账单报表,自动创建的是由费用助理创建的报表。 |
reportVersion |
整数 |
int32 |
要求报告的当前版本。 |
startDate可以 |
字符串 |
YYYY-MM-DD |
报告的开始日期,用于基于行程的报告。 |
submitDate |
字符串 |
YYYY-MM-DDTHH: mm: ssZ |
用户提交报告的UTC日期时间。 |
submitterId |
字符串 |
- |
提交报告的雇员的唯一标识符。 |
taxConfigId |
字符串 |
- |
报表的税务配置ID。 |
用户标识 |
字符串 |
- |
要求作为报表所有者的Concur用户的唯一标识符。 |
UpdateReport
的名字 |
类型 |
格式 |
描述 |
businessPurpose |
字符串 |
- |
用户为业务目的输入的文本。 |
评论 |
字符串 |
- |
由用户添加的费用报告注释。 |
国家 |
字符串 |
- |
与报告关联的国家名称(按接收语言 头)。 |
countryCode |
字符串 |
- |
位置国家ISO 3166-1代码。 |
countrySubDivisionCode |
字符串 |
- |
位置国家分司ISO 3166-2代码。 |
customData |
CustomData |
- |
详情请参阅customData 字段。这些字段可能没有数据,这取决于配置。 |
endDate |
字符串 |
YYYY-MM-DD |
报告的结束日期,用于基于行程的报告。 |
isCopyDownInherited |
布尔 |
真正的 /假 |
如果真正的 ,报告报头字段中的任何更改都将被复制到费用、分项和分配,根据配置。应该慎重使用此标志,因为可能导致数据损坏。 |
isPaperReceiptsReceived |
布尔 |
真正的 /假 |
是否收到报告的纸质收据。 |
的名字 |
字符串 |
- |
用户输入的费用报告名称。 |
政策 |
字符串 |
- |
报表所遵循的策略名称。 |
policyId |
字符串 |
- |
应用于此报表的策略的唯一标识符。 |
redirectFund |
RedirectFund |
- |
资金转至IBCP卡。 |
reportDate |
字符串 |
YYYY-MM-DD |
由用户分配给报告的日期。 |
reportSource |
字符串 |
- |
要求报告的来源。支持的价值观:EA ——费用助理,暴徒 ——移动,其他 未知,SE ——聪明的费用,TR ——旅行请求,用户界面 ——Web UI |
startDate可以 |
字符串 |
YYYY-MM-DD |
报告的开始日期,用于基于行程的报告。 |
CustomData
的名字 |
类型 |
格式 |
描述 |
id |
字符串 |
- |
要求自定义字段的唯一标识符。例子:custom1 ,orgUnit1 |
isValid |
布尔 |
真正的 /假 |
返回值是否有效。对于所有数据类型的自定义字段返回此值,并为表示当前状态的列表项专门求值。默认值:真正的 |
价值 |
字符串 |
- |
自定义字段的值。该字段可以包含所有支持的数据类型的值,例如文本 ,整数 ,布尔 而且listItemId .最大长度为48个字符 |
量
的名字 |
类型 |
格式 |
描述 |
currencyCode |
字符串 |
- |
要求费用报告货币的3个字母的ISO 4217货币代码,基于创建报告时用户指定的报销货币。例子:美元 ——美元;强 ——巴西雷亚尔;计算机辅助设计 -加拿大元;瑞士法郎 ——瑞士法郎;欧元 欧元;GBO ——英镑;港币 -港元;印度卢比 ——印度卢比;麦根 ——墨西哥比索;nokia -挪威克朗;瑞典克朗 ——瑞典克朗 |
价值 |
数量 |
双 |
要求所定义货币的金额。 |
RedirectFund
的名字 |
类型 |
格式 |
描述 |
量 |
量 |
- |
要求重定向到IBCP卡账户的资金价值。 |
creditCardId |
字符串 |
- |
要求IBCP卡账户的唯一标识符,需要将资金转到该账户。 |
ReportSendBackRequest
的名字 |
类型 |
格式 |
描述 |
评论 |
字符串 |
- |
要求返回报告的注释。 |
currentProcessInstanceId |
字符串 |
- |
用于验证的当前工作流流程实例ID。 |
currentSequence |
整数 |
int32 |
用于验证的当前工作流过程序列号。 |
reasonCodeId |
字符串 |
- |
原因码的唯一标识符仅由处理器决定。 |
reportSource |
字符串 |
- |
报告的来源。支持的价值观:EA ——费用助理,暴徒 ——移动,其他 未知,SE ——聪明的费用,TR ——旅行请求,用户界面 ——Web UI |
ReportApproveRequest
的名字 |
类型 |
格式 |
描述 |
评论 |
字符串 |
- |
赞同者的评论。 |
currentProcessInstanceId |
字符串 |
- |
用于验证的当前工作流流程实例ID。 |
currentSequence |
整数 |
int32 |
用于验证的当前工作流过程序列号。 |
reportSource |
字符串 |
- |
报告的来源。支持的价值观:EA ——费用助理,暴徒 ——移动,其他 未知,SE ——聪明的费用,TR ——旅行请求,用户界面 ——Web UI |
statusId |
字符串 |
- |
此工作流转换将分配给报表的状态。 |
链接
的名字 |
类型 |
格式 |
描述 |
弃用 |
字符串 |
- |
- |
href |
字符串 |
- |
要求相关的URLHATEOAS 可以用于后续调用的链接。 |
hreflang |
字符串 |
- |
- |
isTemplated |
布尔 |
真正的 /假 |
要求是否href 是参数化的。 |
媒体 |
字符串 |
- |
- |
方法 |
字符串 |
- |
要求相关调用所需的HTTP方法。 |
rel |
字符串 |
- |
要求该链接关系描述如何href 与API调用相关。 |
标题 |
字符串 |
- |
- |
类型 |
字符串 |
- |
- |
ErrorMessage
的名字 |
类型 |
格式 |
描述 |
errorId |
字符串 |
- |
与响应关联的错误的唯一标识符。 |
errorMessage |
字符串 |
- |
要求详细的错误消息。 |
httpStatus |
字符串 |
- |
要求http响应代码和响应短语。 |
路径 |
字符串 |
- |
要求尝试请求的URI。 |
时间戳 |
字符串 |
日期-时间 |
要求捕获错误的时间。 |
validationErrors |
ValidationError |
- |
验证错误消息。 |
ValidationError
的名字 |
类型 |
格式 |
描述 |
id |
字符串 |
- |
验证错误的ID。 |
消息 |
字符串 |
- |
验证错误的详细消息。 |
源 |
字符串 |
- |
失败的验证类型。 |