概述
SAP Concur与外部支付提供商合作处理发票支付。这些支付提供商都列在App Center上,可以通过使用Invoice Pay api与Invoice产品集成。支付提供者可以获得授权处理的所有支付的列表,并发回这些支付的状态。
限制:此API仅供将处理发票支付的支付合作伙伴使用。这个API可以接受所有支付提供商每分钟最多10,000个请求。此API仅在北美数据中心可用。
工艺流程
产品和版本
使用范围
名称 |
描述 |
终点 |
发票.providerpayment.write. |
对未决支付的读访问权,以及对支付状态的写访问权 |
得到,帖子 |
依赖性
此API只能与已购买Concur发票的SAP Confor客户使用。
访问令牌用法
此API仅支持公司访问令牌。
获得付款
付款提供商可以使用此端点获取付款清单。
要求
URI
模板
获取https://us.api.concursolutions.com/invoice/provider-payment/v4/payments.
参数
名称 |
类型 |
格式 |
描述 |
invoiceId |
细绳 |
- |
可选:获取特定的支付信息和erpDocumentNumber。 |
有效载荷
一个也没有。
响应
状态代码
有效载荷
支付
例子
要求
GET https://us.api.concursolutions.com/invoice/provider-payment/v4/payments Accept: application/json授权:承载{token}
响应
Content-Type: application/json
{“支付”:[{“付款”:“0 f27533f-ce38-4f43-a2f3-fa9f0e6b33fc”,“paymentMethod”:“PAYPVD”,“付款截止日期”:“2018-08-09”,“总金额”:{“数量”:“30.00”,“货币”:“美元”},“发票”:[{“invoiceNumber”:“agh87”,“易用”:“1ADFBB440D7045F68DE2”,“inviceamount”:{“数量”:“30.00”,“货币”:“美元”},“支付金额”:{“数量”:“30.00”,“货币”:“美元”},“noteStosupplier”:无效的,“erpdocumentnumber”:“erp1234”}],“小贩”:{“addressLine1”:“1234雨街”,“addressLine2”:无效的,“addressLine3”:无效的,“VendorAddrCode”:“1160”,“城市”:“芝加哥”,“状态”:“他”,“邮政编码”:“60680-28160”,“国家的名字”:“美国”,“国家代码”:“我们”,“firstName”:“terry”,“姓”:“棕色的”,“phoneNumber”:无效的,“电子邮件”:“terry.brown@example.com”,“vendorCode”:“1160”,“vendorName”:“戴尔”,“buyerAccountNumber”:“1234567890”}}]}
使用状态更新付款
付款提供商可以使用此端点来提供付款状态的更新。
要求
URI
模板
post https://us.api.concursolutions.com/invoice/provider-payment/v4/payments/ {paymentid}
参数
名称 |
类型 |
格式 |
描述 |
款项 |
细绳 |
- |
要求要更新的支付的标识符。 |
有效载荷
付款更新
响应
状态代码
有效载荷
付款更新结果
例子
要求
POST https://us.api.concursolutions.com/invoice/provider-payment/v4/payments/0f27533f-ce38-4f43-a2f3-fa9f0e6b33fc授权:承载{token} Content-Type: application/json
{“ProviderReference”:“hdoesofdl”,“地位”:“支付”,“statusMessage”:“支付成功”,“支付教会发作”:无效的,“状态”:“2018-05-10”,“付款”:“2018-05-09”,“paymentSettlementDate”:“2018-05-09”,“thirdPartyPaymentIdentifier”:“69249”,“paymentMethod”:“查看”,“paidAmount”:{“数量”:“30.00”,“货币”:“美元”}}
响应
Content-Type: application/json
{“创建日期”:“2018-05-09”,“lastmodifieddate”:“2018-05-09”,“地位”:“支付”,“statusMessage”:“支付成功”,“支付教会发作”:无效的,“状态”:“2018-05-10”,“付款”:“2018-05-09”,“paymentSettlementDate”:“2018-05-09”,“thirdPartyPaymentIdentifier”:“69249”,“paymentMethod”:“查看”,“paidAmount”:{“数量”:“30.00”,“货币”:“美元”}}
架构
支付
名称 |
类型 |
格式 |
描述 |
支付 |
数组 |
支付 |
支付的数组。 |
支付
名称 |
类型 |
格式 |
描述 |
发票 |
数组 |
发票 |
在付款时需要分批处理的发票数组。 |
paymentDueDate |
细绳 |
yyyy-mm-dd |
付款的日期。 |
款项 |
细绳 |
- |
SAP Concur付款的唯一标识符。最多36个字符。 |
paymentMethod |
细绳 |
- |
价值始终是PAYPVD 这意味着客户想要使用付款提供商付款。最多15个字符。 |
总金额 |
对象 |
量 |
这个金额需要支付给供应商。 |
小贩 |
对象 |
小贩 |
要求付款的供应商。 |
发票
名称 |
类型 |
格式 |
描述 |
inviCeamount. |
对象 |
量 |
发票上的金额。 |
发票编号 |
细绳 |
- |
发票号码。最大的50个字符。 |
invoiceId |
细绳 |
- |
在SAP Concur中发票的唯一标识符。这可以用于从其他api获得额外的发票信息。这和paymentRequestID 在其他发票API中。最多20个字符。 |
noteStosupplier |
细绳 |
- |
给供应商的说明包含买方想要提供给供应商的汇款信息。最多500个字符。 |
paymentAmount |
对象 |
量 |
发票上的付款金额。 |
erpdocumentnumber |
细绳 |
- |
发票的ErpDocumentNumber。 |
小贩
名称 |
类型 |
格式 |
描述 |
buyerAccountNumber |
细绳 |
- |
买方帐号。最大的50个字符。 |
vendorcode. |
细绳 |
- |
供应商代码。最多32个字符。 |
供应商名称 |
细绳 |
- |
供应商的名字。最多255个字符。 |
addressLine1 |
细绳 |
- |
供应商地址行1。最多255个字符。 |
addressLine2 |
细绳 |
- |
供应商地址第2.最多255个字符。 |
addressLine3 |
细绳 |
- |
供应商地址第3行。最多255个字符。 |
城市 |
细绳 |
- |
供应商地址的城市。最多255个字符。 |
状态 |
细绳 |
- |
供应商地址状态。最大的10个字符。 |
countryCode |
细绳 |
- |
供应商地址国家代码。最大2字符。 |
countryName |
细绳 |
- |
供应商地址国家名称。最多64个字符。 |
邮政编码 |
细绳 |
- |
供应商地址邮政编码。最多20个字符。 |
VendorAddrcode. |
细绳 |
- |
供应商地址代码。最多64个字符。 |
电子邮件 |
细绳 |
- |
电子邮件地址。最多255个字符。 |
名 |
细绳 |
- |
名。最多255个字符。 |
姓 |
细绳 |
- |
姓。最多255个字符。 |
电话号码 |
细绳 |
- |
电话号码。最大的25个字符。 |
量
名称 |
类型 |
格式 |
描述 |
量 |
细绳 |
- |
数量。最多20个字符。 |
货币 |
细绳 |
- |
货币代码。最大的3个字符。 |
付款更新
名称 |
类型 |
格式 |
描述 |
providerReference |
细绳 |
- |
支付提供者系统中支付的唯一标识符。这将用于内部故障排除。最多100个字符。 |
状态 |
细绳 |
更新付款状态 |
要求用于描绘由SAP Concur定义的成功,错误或任何其他中间状态。 |
statusMessage |
细绳 |
- |
付款提供商状态描述。提供商可以提供任何消息。最多255个字符。 |
paymentAdjustmentNotes |
细绳 |
- |
付款提供商发送的付款调整说明。最多255个字符。 |
statusDate |
细绳 |
yyyy-mm-dd |
要求支付提供商记录此状态更改的日期。 |
paymentInitiationDate |
细绳 |
yyyy-mm-dd |
付款发起的日期。 |
paymentSettlementDate |
细绳 |
yyyy-mm-dd |
付款将在收款人帐户中的日期。 |
第三个百分比identifier |
细绳 |
- |
如果付款是通过支票或跟踪号码完成的支票编号,请进行ACH付款。最多255个字符。 |
paymentMethod |
细绳 |
付款提供商方法 |
如果状态是PAID, CHECK_PROCESSED,或card_settle,则为必选支付提供者使用的支付方法。 |
已付金额 |
对象 |
量 |
如果状态是PAID, CHECK_PROCESSED,或card_settle,则为必选支付提供商支付的金额。 |
付款更新结果
名称 |
类型 |
格式 |
描述 |
createdDate |
细绳 |
yyyy-mm-dd |
付款创建日期。 |
lastModifiedDate |
细绳 |
yyyy-mm-dd |
最后一次修改付款日期 |
providerReference |
细绳 |
- |
支付提供者系统中支付的唯一标识符。最多100个字符。 |
状态 |
细绳 |
更新付款状态 |
要求用于描绘由SAP Concur定义的成功,错误或任何其他中间状态。 |
statusMessage |
细绳 |
- |
付款提供商状态描述。提供商可以提供任何消息。最多255个字符。 |
paymentAdjustmentNotes |
细绳 |
- |
付款提供商发送的付款调整说明。最多255个字符。 |
statusDate |
细绳 |
yyyy-mm-dd |
要求支付提供商记录此状态更改的日期。 |
paymentInitiationDate |
细绳 |
yyyy-mm-dd |
付款发起的日期。 |
paymentSettlementDate |
细绳 |
yyyy-mm-dd |
付款将在收款人帐户中的日期。 |
第三个百分比identifier |
细绳 |
- |
如果付款是通过支票或跟踪号码完成的支票编号,请进行ACH付款。最多255个字符。 |
paymentMethod |
细绳 |
付款提供商方法 |
如果状态是PAID, CHECK_PROCESSED,或card_settle,则为必选支付提供者使用的支付方法。 |
已付金额 |
对象 |
量 |
如果状态是PAID, CHECK_PROCESSED,或card_settle,则为必选支付提供商支付的金额。 |
错误
名称 |
类型 |
格式 |
描述 |
错误 |
数组 |
错误 |
一系列错误。 |
错误
名称 |
类型 |
格式 |
描述 |
错误代码 |
细绳 |
- |
要求与错误相关的机器可读代码。 |
错误信息 |
细绳 |
- |
要求与错误相关的可读消息。 |
定义
更新付款状态
价值 |
描述 |
付款确认提取物中的状态 |
pending_reetrieval. |
尚未被支付提供者检索 |
无法使用 |
检索到 |
由付款提供者检索 |
无法使用 |
处理 |
付款提供商正在处理付款 |
无法使用 |
被拒绝 |
付款提供者拒绝付款 |
无法使用 |
返回 |
付款已被银行退回 |
无法使用 |
取消了 |
付款已被取消 |
失败的 |
CHECK_PRINTED |
检查印刷 |
无法使用 |
check_mailed. |
检查已邮寄 |
无法使用 |
check_processed. |
检查已处理 |
有薪酬的 |
CHECK_VOIDED |
支票是无效 |
空白 |
有薪酬的 |
付款成功 |
有薪酬的 |
card_email_sent. |
电子邮件与卡片信息发送给供应商 |
无法使用 |
CARD_AUTHORIZED |
此卡由商家授权使用 |
无法使用 |
card_settled. |
卡由供应商定居 |
有薪酬的 |
付款提供商方法
价值 |
描述 |
呵呀 |
上述付款 |
查看 |
支付付款 |
线 |
电汇 |
卡片 |
虚拟卡付款 |
其他 |
其他付款方式 |