From 9f689273242a4af47e1792b2e4c6e45d52d4131a Mon Sep 17 00:00:00 2001 From: prithvirajv Date: Fri, 12 Mar 2021 12:10:38 -0500 Subject: [PATCH 1/4] INV-34723: Invoice Pay API Documentation - Get, PATCH --- .../invoice/v4.invoice-pay.markdown | 130 +++++++++++++++++- 1 file changed, 127 insertions(+), 3 deletions(-) diff --git a/src/api-reference/invoice/v4.invoice-pay.markdown b/src/api-reference/invoice/v4.invoice-pay.markdown index b6fdf35f1..1e9b6169d 100644 --- a/src/api-reference/invoice/v4.invoice-pay.markdown +++ b/src/api-reference/invoice/v4.invoice-pay.markdown @@ -11,6 +11,7 @@ layout: reference * [Access Token Usage](#access-token-usage) * [Obtaining Payments](#obtain-payment) * [Updating a Payment With Status](#updating-payment) +* [Updating a Payment With ErpDocumentNumber](#updating-payment-erpdocumentnumber) * [Schema](#schema) * [Payments](#schema-payments) * [Payment](#schema-payment) @@ -18,7 +19,9 @@ layout: reference * [Vendor](#schema-vendor) * [Amount](#schema-amount) * [Payment Update](#schema-payment-update) - * [Payment Update Result](#schema-payment-update-result) + * [Payment Update Result](#schema-payment-patch-result) + * [Payment Patch](#schema-payment-update) + * [Payment Patch Result](#schema-payment-patch-result) * [Errors](#schema-errors) * [Definitions](#definitions) * [Payment Update Status](#schema-payment-update-status) @@ -70,6 +73,13 @@ Payment providers can use this endpoint to get a list of payments. GET https://us.api.concursolutions.com/invoice/provider-payment/v4/payments ``` +##### Parameters + +Name|Type|Format|Description +---|---|---|--- +`invoiceId`|`string`|-|**Optional**: Gets Specific payment info along with erpDocumentNumber. + + #### Headers * [RFC 7235 Authorization](https://tools.ietf.org/html/rfc7235#section-4.2) @@ -137,7 +147,8 @@ Content-Type: application/json "amount": "30.00", "currency": "USD" }, - "notesToSupplier": null + "notesToSupplier": null, + "erpDocumentNumber": "erp1234" } ], "vendor":{ @@ -163,6 +174,94 @@ Content-Type: application/json } ``` +## Updating a Payment With ErpDocumentNumber + +Payment providers can use this endpoint to provide erpdocumentnumber to the payments. + +### Request + +#### URI + +##### Template + +``` +POST https://us.api.concursolutions.com/invoice/provider-payment/v4/invoices/{invoiceId}/paymentmetadata +``` + +#### Parameters + +Name|Type|Format|Description +---|---|---|--- +`invoiceId`|`string`|-|**Required** The identifier of the invoice to update. + +#### Headers + +* [RFC 7235 Authorization](https://tools.ietf.org/html/rfc7235#section-4.2) +* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5) + +#### Payload + +[Payment Update](#schema-payment-update) + +### Response + +#### Status Codes + +* [200 OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) +* [400 Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) +* [403 Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3) +* [404 Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) +* [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) + +#### Headers + +* `concur-correlationid` is a SAP Concur specific custom header used for technical support in the form of a [RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace](https://tools.ietf.org/html/rfc4122) +* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5) + +#### Payload + +[Payment Update Result](#schema-payment-update-result) + +### Example + +#### Request + +``` +POST https://us.api.concursolutions.com/invoice/provider-payment/v4/payments/0f27533f-ce38-4f43-a2f3-fa9f0e6b33fc +Authorization: BEARER {token} +Content-Type: application/json +``` + +```json +{ +"erpDocumentNumber": "patch erpDocumentNumber - success" +} +``` + +#### Response + +``` +200 OK +Content-Type: application/json +``` + +```json +{ + "erpDocumentNumber": "patch erpDocumentNumber - success" +} +``` + + + + + + + + + + + + ## Updating a Payment With Status Payment providers can use this endpoint to provide updates to the status of payments. @@ -209,7 +308,7 @@ Name|Type|Format|Description #### Payload -[Payment Update Result](#schema-payment-update-result) +[Payment Patch Result](#schema-payment-patch-result) ### Example @@ -265,6 +364,16 @@ Content-Type: application/json } ``` + + + + + + + + + + ## Schema ### Payments @@ -293,6 +402,7 @@ Name | Type | Format | Description `invoiceId`|`string`|-|Unique identifier of the invoice in SAP Concur. This can be used to get additional invoice information from other APIs. This is the same as `paymentRequestID` in other Invoice APIs. Maximum 20 characters. `notesToSupplier`|`string`|-|Notes to the supplier contain remittance information that the buyer wants to provide to the supplier. Maximum 500 characters. `paymentAmount`|`object`|[Amount](#schema-amount)|Payment amount on the invoice. +`erpDocumentNumber`|`string`|-|ErpDocumentNumber of that invoice. ### Vendor @@ -337,6 +447,20 @@ Name|Type|Format|Description `paymentMethod`|`string`|[Payment Provider Method](#schema-payment-provider-method)|**Required if the status is PAID, CHECK_PROCESSED, or CARD_SETTLED** Payment method used by the payment provider. `paidAmount`|`object`|[Amount](#schema-amount)|**Required if the status is PAID, CHECK_PROCESSED, or CARD_SETTLED** Amount paid by the payment provider. + +### Payment Patch + +Name|Type|Format|Description +---|---|---|--- +`erpDocumentNumber`|`string`|-|ErpDocumentNumber of the invoice. + +### Payment Patch Result + +Name|Type|Format|Description +---|---|---|--- +`erpDocumentNumber`|`string`|-|ErpDocumentNumber of the invoice. + + ### Payment Update Result Name|Type|Format|Description From 718d1a226f537c1cb4ab02cd9b724e1a46f3a719 Mon Sep 17 00:00:00 2001 From: prithvirajv Date: Fri, 12 Mar 2021 12:36:32 -0500 Subject: [PATCH 2/4] INV-34723: Invoice Pay API Documentation - Get, PATCH --- .../invoice/v4.invoice-pay.markdown | 23 +++++-------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/src/api-reference/invoice/v4.invoice-pay.markdown b/src/api-reference/invoice/v4.invoice-pay.markdown index 1e9b6169d..61c3871db 100644 --- a/src/api-reference/invoice/v4.invoice-pay.markdown +++ b/src/api-reference/invoice/v4.invoice-pay.markdown @@ -19,8 +19,8 @@ layout: reference * [Vendor](#schema-vendor) * [Amount](#schema-amount) * [Payment Update](#schema-payment-update) - * [Payment Update Result](#schema-payment-patch-result) - * [Payment Patch](#schema-payment-update) + * [Payment Update Result](#schema-payment-update-result) + * [Payment Patch](#schema-payment-patch) * [Payment Patch Result](#schema-payment-patch-result) * [Errors](#schema-errors) * [Definitions](#definitions) @@ -77,7 +77,7 @@ GET https://us.api.concursolutions.com/invoice/provider-payment/v4/payments Name|Type|Format|Description ---|---|---|--- -`invoiceId`|`string`|-|**Optional**: Gets Specific payment info along with erpDocumentNumber. +`invoiceId`|`string`|-|**Optional**: Gets specific payment info along with erpDocumentNumber. #### Headers @@ -185,7 +185,7 @@ Payment providers can use this endpoint to provide erpdocumentnumber to the paym ##### Template ``` -POST https://us.api.concursolutions.com/invoice/provider-payment/v4/invoices/{invoiceId}/paymentmetadata +PATCH https://us.api.concursolutions.com/invoice/provider-payment/v4/invoices/{invoiceId}/paymentmetadata ``` #### Parameters @@ -201,7 +201,7 @@ Name|Type|Format|Description #### Payload -[Payment Update](#schema-payment-update) +[Payment Patch](#schema-payment-patch) ### Response @@ -220,7 +220,7 @@ Name|Type|Format|Description #### Payload -[Payment Update Result](#schema-payment-update-result) +[Payment Patch Result](#schema-payment-patch-result) ### Example @@ -251,17 +251,6 @@ Content-Type: application/json } ``` - - - - - - - - - - - ## Updating a Payment With Status Payment providers can use this endpoint to provide updates to the status of payments. From b2dbc301b52915959a37c3605e99ac894b965034 Mon Sep 17 00:00:00 2001 From: prithvirajv Date: Fri, 12 Mar 2021 12:38:24 -0500 Subject: [PATCH 3/4] INV-34723: Invoice Pay API Documentation - Get, PATCH --- src/api-reference/invoice/v4.invoice-pay.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/api-reference/invoice/v4.invoice-pay.markdown b/src/api-reference/invoice/v4.invoice-pay.markdown index 61c3871db..c2bdbd4e2 100644 --- a/src/api-reference/invoice/v4.invoice-pay.markdown +++ b/src/api-reference/invoice/v4.invoice-pay.markdown @@ -297,7 +297,7 @@ Name|Type|Format|Description #### Payload -[Payment Patch Result](#schema-payment-patch-result) +[Payment Update Result](#schema-payment-update-result) ### Example From e0c51c080b83e72d019db12035ab301cf5ac367c Mon Sep 17 00:00:00 2001 From: prithvirajv Date: Fri, 12 Mar 2021 12:39:18 -0500 Subject: [PATCH 4/4] INV-34723: Invoice Pay API Documentation - Get, PATCH --- src/api-reference/invoice/v4.invoice-pay.markdown | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/src/api-reference/invoice/v4.invoice-pay.markdown b/src/api-reference/invoice/v4.invoice-pay.markdown index c2bdbd4e2..8ed33be0c 100644 --- a/src/api-reference/invoice/v4.invoice-pay.markdown +++ b/src/api-reference/invoice/v4.invoice-pay.markdown @@ -353,16 +353,6 @@ Content-Type: application/json } ``` - - - - - - - - - - ## Schema ### Payments