端点

资源的定义

电子收据-使用数据和图像（可选）执行架构的资源。如果未提供图像，将从数据资源生成一个图像。
纯图像收据-没有数据的独立映像。

笔记：Receipts V4 API仅提供对通过此API提交的个人或用户收据的访问权限，因此，响应不会全面到SAP Concur中的每个用户收据。所有其他图像应通过图像v1api. 此外，只返回收据，不会有任何相应的分录数据。应使用Image v1 API的企业应用程序示例包括：用于财务日记账分录过账的ERP集成、用于获得交易以计算增值税回收的增值税回收集成、用于证实已报销费用的项目计费集成等。

支持的图像格式

图像大小不得超过25MB。
任何尺寸超过2200像素的图像都将缩小，最长尺寸缩小为2200像素，其余尺寸使用固定的纵横比缩小。
图像必须是支持的文件类型之一：Image/png、Image/jpg、Image/jpeg、Image/tiff、Image/tif、Image/gif和application/pdf。图像/tiff和图像/tif中提供的图像将转换为PDF文档，其中嵌入图像。

全体的

端点	响应格式	请求摘要
得到/	JSON	获取服务索引URL
GET/v4/status/：receiptId	JSON	获取收据的状态

端点：服务索引

得到/

向服务的根目录发出GET请求将返回当前端点的列表。如果端点URL发生更改，服务索引将被更新。为了确保使用正确的URL，最安全的做法是在每次请求之前检查服务索引。响应将包括接收服务中所有端点的当前URL。

请求示例：

卷曲：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/
        

HTTPie：

         httphttps://us.api.concursolutions.com/receipts/'授权：持有者{您的访问令牌}'
        

答复示例：

         {“链接”:[{“rel”:“自我”,“href”:"https://us.api.concursolutions.com/receipts/v4"},{“rel”:“收到收据”,“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/v4/{receiptId}”},{“rel”:“收件处”,“方法”:“职位”,“href”:"https://us.api.concursolutions.com/receipts/v4/users/{userId}”},{“rel”:“获取用户的收据”,“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/v4/users/{userId}”},{“rel”:“架构获取”,“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas"}]}
        

回到顶端

电子收据

端点	响应格式	请求摘要
获取/获取模式	JSON	获取当前支持的接收架构
POST/v4/users/：userId	不适用	寄收据
GET/v4/users/：userId	JSON	获取用户的收据
GET/v4/：receiptId	JSON	凭身份证领取收据
GET/v4/：receiptId/image	图像文件	获取收据图像。

端点：模式

GET/schemas/：schemaId

参数	要求	价值
阴谋家	可选择的	要返回的架构的ID。

对GET请求的响应/模式将有一个可用收据类型的JSON验证模式列表。一系列支持模式也会返回，但这些不代表实际的收据类型。

如果提供了架构ID，则只返回具有该ID的架构，而不是返回整个架构索引。模式的ID不是UUID，而是具有扩展名的模式的名称.schema.json. 例如car-rental-receipt.schema.json或air-receipt.schema.json.

其中一个收据架构必须包含在链接头与关系为描述. 这看起来像链接：；rel=描述对象.

请求示例：

架构索引的cURL：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/schemas/
        

架构索引的HTTPie：

         httphttps://us.api.concursolutions.com/receipts/schemas'授权：持有者{您的访问令牌}'
        

对于单个架构：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/schemas/car-rental-receipt.schema.json
        

单个架构的HTTPie：

         httphttps://us.api.concursolutions.com/receipts/schemas/car-rental-receipt.schema.json'授权：持有者{您的访问令牌}'
        

答复示例：

         {“接收模式”:[{“rel”:"http://schema.concursolutions.com/air-receipt.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/air-receipt.schema.json"},{“rel”:"http://schema.concursolutions.com/car-rental-receipt.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/car-rental-receipt.schema.json"},{“rel”:"http://schema.concursolutions.com/general-receipt.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/general-receipt.schema.json"},{“rel”:"http://schema.concursolutions.com/ground-transport-receipt.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/ground-transport-receipt.schema.json"},{“rel”:"http://schema.concursolutions.com/hotel-receipt.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/hotel-receipt.schema.json"},{“rel”:"http://schema.concursolutions.com/jpt-ic-card-receipt.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/jpt-ic-card-receipt.schema.json"},{“rel”:"http://schema.concursolutions.com/rail-receipt.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/rail-receipt.schema.json"}],“支持模式”:[{“rel”:"http://schema.concursolutions.com/address-original.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/address-original.schema.json"},{“rel”:"http://schema.concursolutions.com/address.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/address.schema.json"},{“rel”:"http://schema.concursolutions.com/common.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/common.schema.json"},{“rel”:"http://schema.concursolutions.com/discount.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/discount.schema.json"},{“rel”:"http://schema.concursolutions.com/line-item.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/line-item.schema.json"},{“rel”:"http://schema.concursolutions.com/location.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/location.schema.json"},{“rel”:"http://schema.concursolutions.com/merchant.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/merchant.schema.json"},{“rel”:"http://schema.concursolutions.com/payments.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/payments.schema.json"},{“rel”:"http://schema.concursolutions.com/receipt-core.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/receipt-core.schema.json"},{“rel”:"http://schema.concursolutions.com/taxes.schema.json",“方法”:“得到”,“href”:"https://us.api.concursolutions.com/receipts/schemas/taxes.schema.json"}]}
        

回到顶端

端点：获取收据状态

GET/v4/status/：receiptId

参数	要求	价值
接收人	必修的	与图像关联的收据的id。

此端点可用于查看收据的当前处理状态。

当成功发出POST请求时链接响应的标题包含“处理状态”URL。此处理状态URL将在首次发布后的两周内可用，并将提供有关收据处理状态的信息。

有四种可能的顶级状态：认可的,失败,处理和处理.

除高级状态外，还将在一系列事件日志中提供信息。日志中可能包含的事件将被键入信息,调试,警告或错误.

事件消息示例：

类型	消息
信息	接受收据。排队等待处理。
信息	已启动收据处理。（每次尝试的事件）
错误	来自用户配置文件服务的错误。排队等待重新处理。
错误	来自图像服务的错误。排队等待重新处理。
错误	生成或检索图像时出错。排队等待重新处理。
信息	生成收据图像。
错误	处理失败。
信息	处理完毕。

请求示例：

卷曲：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/v4/status/{收据ID}
        

HTTPie：

         httphttps://us.api.concursolutions.com/receipts/v4/status/{收据ID}“授权：持有人{您的访问令牌}”
        

答复示例：

         {“地位”:“已处理”,“日志”:[{“日志级别”:“信息”,“消息”:“已接受收据。已排队等待处理。”,“时间戳”:“2017年5月8日星期一23:05:52 GMT”},{“日志级别”:“信息”,“消息”:“已启动收据处理。”,“时间戳”:“2017年5月8日星期一23:05:52 GMT”},{“日志级别”:“信息”,“消息”:“已生成收据图像。”,“时间戳”:“2017年5月8日星期一23:05:53 GMT”},{“日志级别”:“信息”,“消息”:“处理已完成。”,“时间戳”:“2017年5月8日星期一23:05:54 GMT”}]}
        

回到顶端

端点：过帐收据

POST/v4/users/：userId

参数	要求	价值
用户ID	必修的	收据所属用户的id。
收据	必修的	要过帐的JSON收据。
形象	可选择的	收据的图像。如果没有提供图像，将从JSON自动生成一个图像。提到支持的图像格式了解更多信息。

创建收据需要关于交易的JSON数据，还需要收据的图像（可选）。如果请求中未提供图像，SAP Concur将根据提供的数据自动生成收据图像。JSON模式用于验证POST请求中接收的接收数据的格式。

SAP Concur系统和客户依赖电子收据作为相关政府管辖区内合法有效的税务文件。请参阅此信息重要的使用限制.

成功的POST请求将收到201的响应。这个地方响应的标题包含收据的URL。处理完收据后，可以在此URL处检索收据。这个链接响应的标题包含收据的处理状态URL。可以找到更多信息在这里.

有用说明：

将链接包含为标题并使其值：http://schema.concursolutions.com/{接收类型}.schema.json;rel=描述人“
从文档中复制该收据类型的收据样本(https://developer.concur.com/api-reference/receipts/sample-receipts.html)然后把它贴到这封邮件的正文里→ 然后可以根据您的规范编辑此正文

如果您没有提供带有收据数据的图像，那么请求的主体应该是您的收据JSON。

收据图像可能与数据一起发布。在这种情况下，SAP Concur将使用提供的映像，而不是生成新映像。要发布数据和图像，请使用多部分表单数据。这个内容类型：多部分/表单数据必须设置标题。图像应包含在键下形象，并且收据JSON应包含在密钥下收据. 有关图像大小、尺寸和类型的信息，请参阅支持的图像格式.

请求示例：

不带图像的卷曲数据：

         卷曲-五-X邮递https://us.api.concursolutions.com/receipts/v4/users/{ID令牌中的用户ID}\-H“授权：持有人{您的访问令牌}”\-H“内容类型：应用程序/json”\-H“链接：；rel=descripeby“\-d@{您的收据路径}
        

卷曲数据和图像：

         卷曲-五-k-X邮递https://us.api.concursolutions.com/receipts/v4/users/{ID令牌中的用户ID}\-H“授权：持有人{您的访问令牌}”\-H“内容类型：多部分/表单数据”\-H“链接：；rel=descripeby“\-F“收据=<{收据JSON的路径}；类型=应用程序/JSON”\-F“图像=@{图像的路径}；类型={图像的文件MIME类型}”
        

没有图像的HTTPie数据：

         http POSThttps://us.api.concursolutions.com/receipts/v4/users/{ID令牌中的用户ID}\“授权：持有人{您的访问令牌}”\“内容类型：应用程序/json”\“链接：；rel=descripeby“\<{您的收据路径}
        

答复示例：

         超文本传输协议/1.1201创建链接:; rel=“descripbedby”; rel=“处理状态”地方:https://us.api.concursolutions.com/receipts/v4/b0a4ab2bce8a49a08cf177cb997bf2ee内容长度:0联系:活命
        

回到顶端

端点：通过ID获取收据

GET/v4/：receiptId

参数	要求	价值
接收人	必修的	要返回的收据的id。

返回与URL中的ID关联的JSON回执。

请求示例：

卷曲：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/v4/{收据ID}
        

HTTPie：

         httphttps://us.api.concursolutions.com/receipts/v4/{收据ID}“授权：持有人{您的访问令牌}”
        

示例响应

         {“dateTimeReceived”:“2016-09-28221:41:21.087Z”,“id”:“85b76a2bf51a4ed7b8b252994d7d9e2b”,“图像”:"",“收据”:{收据JSON。。。},“用户ID”:“08bdda1e-0d4f-4261-9f1b-f9b8d9f817d6”,“验证模式”:"http://schema.concursolutions.com/car-rental-receipt.schema.json",“自我”:"https://us.api.concursolutions.com/receipts/v4/85b76a2bf51a4ed7b8b252994d7d9e2b",“模板”:"https://us.api.concursolutions.com/receipts/v4/{receiptId}”}
        

回到顶端

端点：按用户ID获取收据

GET/v4/users/：userId

参数	要求	价值
用户ID	必修的	将返回其收据的用户的id。

返回给定用户ID的所有收据。

请求示例：

卷曲：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/v4/users/{用户ID}
        

HTTPie：

         httphttps://us.api.concursolutions.com/receipts/v4/users/{用户ID}“授权：持有人{您的访问令牌}”
        

答复示例：

         {“收据”:[{“dateTimeReceived”:“2016-09-28221:41:21.087Z”,“id”:“85b76a2bf51a4ed7b8b252994d7d9e2b”,“图像”:"",“收据”:{收据JSON。。。},“用户ID”:“08bdda1e-0d4f-4261-9f1b-f9b8d9f817d6”,“验证模式”:"http://schema.concursolutions.com/car-rental-receipt.schema.json",“自我”:"https://us.api.concursolutions.com/receipts/v4/85b76a2bf51a4ed7b8b252994d7d9e2b",“模板”:"https://us.api.concursolutions.com/receipts/v4/{receiptId}”},{“dateTimeReceived”:“2016-09-28819:59:30.488Z”,“id”:“DF8C1161D917439C9E6f16lang1024 FD0D6B588”,“图像”:"",“收据”:{收据JSON。。。},“用户ID”:“08bdda1e-0d4f-4261-9f1b-f9b8d9f817d6”,“验证模式”:"http://schema.concursolutions.com/car-rental-receipt.schema.json",“自我”:"https://us.api.concursolutions.com/receipts/v4/df8c1161d917439c9e6f141fd0d6b588",“模板”:"https://us.api.concursolutions.com/receipts/v4/{receiptId}”},...]}
        

回到顶端

端点：获取收据图像

GET/v4/：receiptId/image

参数	要求	价值
接收人	必修的	与图像关联的收据的id。

如果图像或PDF文档由Receipts v4生成或发布到Receipts v4，则此端点可以以API最初接收到的相同格式返回图像。使用API的v3创建的收据的图像如下不可通过此端点访问。

请求示例：

卷曲：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/v4/{收据ID}/形象
        

HTTPie：

         httphttps://us.api.concursolutions.com/receipts/v4/{收据ID}/形象“授权：持有人{您的访问令牌}”
        

回到顶端

纯图像收据

笔记：此API不用于获取附加到费用报告的收据图像。如果您是创建集成的企业合作伙伴，该集成旨在获得最终批准的费用或发票数据，以及证明您需要使用的交易的随附收据图像图像v1. 这些场景包括但不限于：用于财务日记账分录过账的ERP集成、用于获得交易以计算增值税回收的增值税回收集成、用于证实已收回费用的项目计费集成等。

端点	响应格式	请求摘要
POST/v4/users/：userId/image-only收据	不适用	邮寄一张仅限图像的收据
GET/v4/users/：userId/image-only收据	JSON	仅获取用户的图像收据
GET/v4/仅图像收据/：receiptId	JSON	按ID获取仅图像收据

端点：仅发布图像收据

POST/v4/users/：userId/image-only收据

参数	要求	价值
用户ID	必修的	收据图像所属用户的id。
形象	必修的	收据的图像。提到支持的图像格式了解更多信息。

成功的POST请求将收到202个已接受的响应。响应的位置标头包含收据图像的URL。处理完收据后，可以在此URL处检索收据。响应的链接头包含收据图像的处理状态URL。

有用说明：

标头必须包含内容类型，其值为多部分/表单数据
在正文中，添加“image”作为键，并从下拉列表中选择“file”，因为您将链接一个图像文件。然后，选择保存的图像文件作为值。

有关图像大小、尺寸和类型的信息，请参阅支持的图像格式.

请求示例：

卷曲：

         卷曲-五-X邮递https://us.api.concursolutions.com/receipts/v4/users/{ID令牌中的用户ID}/纯图像收据\-H“授权：持有人{您的访问令牌}”\-H“内容类型：多部分/表单数据”\-F“image=@{图像的路径}；type=image/{图像的文件MIME类型}”
        

答复示例：

         HTTP/1.1 202接受的链接：;雷尔=“处理状态”地点：https://us.api.concursolutions.com/receipts/v4/images/b0a4ab2bce8a49a08cf177cb997bf2ee 内容长度：0连接：保持活动状态
        

回到顶端

端点：按用户ID获取仅图像收据

GET/v4/users/：userId/image-only收据

参数	要求	价值
用户ID	必修的	将返回其收据图像的用户的id。

返回URL中指定的用户ID的收据图像的JSON元数据。结果的分页方式应与电子收据端点相同。

请求示例：

卷曲：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/v4/users/{用户ID}/纯图像收据
        

HTTPie：

         httphttps://us.api.concursolutions.com/receipts/v4/users/{用户ID}/纯图像收据“授权：持有人{您的访问令牌}”
        

答复示例：

         HTTP/1.1200好啊内容长度:800联系:活命{“接收图像”:[{“dateTimeReceived”:“2017年5月24日星期三16:14:17 GMT+00:00”,“id”:“a90fc48e0f0a44f2bd4838fd773b07a5”,“图像”:"https://us.api.concursolutions.com/receipts/v4/image-only-receipts/a90fc48e0f0a44f2bd4838fd773b07a5/image",“用户ID”:“abcd123456efg”},{...},],“下一个”:"https://us.api.concursolutions.com/receipts/v4/users/abcd123456efg/image-only-receipts/page/1507587575592_d4721b2f3b304a9a9325fabdad5f50ad"}
        

回到顶端

端点：按ID获取仅图像收据

GET/v4/仅图像收据/：receiptId

参数	要求	价值
接收人	必修的	要返回的收据图像的id。

返回与URL中的ID关联的JSON元数据。

请求示例：

卷曲：

         卷曲-五-X收到https://us.api.concursolutions.com/receipts/v4/image-only-receipts/{收据ID}\-H“授权：持有人{您的访问令牌}”
        

HTTPie：

         httphttps://us.api.concursolutions.com/receipts/v4/image-only-receipts/{收据ID}“授权：持有人{您的访问令牌}”
        

示例响应

         HTTP/1.1200好啊内容长度:272联系:活命{“dateTimeReceived”:“2017年5月24日星期三16:14:17 GMT+00:00”,“id”:“a90fc48e0f0a44f2bd4838fd773b07a5”,“图像”:"https://us.api.concursolutions.com/receipts/v4/image-only-receipts/a90fc48e0f0a44f2bd4838fd773b07a5/image",“用户ID”:“abcd123456efg”}
        

回到顶端

端点：获取收据图像（仅图像）

GET/v4/image-only-receipts/：receiptId/image

参数	要求	价值
接收人	必修的	要返回的收据图像的id。

以API最初接收的相同格式返回图像（image/png、image/jpg、image/jpeg、image/tiff、image/tif、image/gif或application/pdf）。

请求示例：

卷曲：

         卷曲-H“授权：持有人{您的访问令牌}”https://us.api.concursolutions.com/receipts/v4/image-only-receipts/{收据ID}/形象
        

HTTPie：

         httphttps://us.api.concursolutions.com/receipts/v4/image-only-receipts/{收据ID}/形象“授权：持有人{您的访问令牌}”
        

回到顶端