From f2d4ab0ef8169fd3375c43eb9912723820164919 Mon Sep 17 00:00:00 2001 From: concur-docs-machine Date: Wed, 23 Aug 2023 16:53:17 +0000 Subject: [PATCH] [skip ci] Updates --- .../expense/expense-report/v4.comments.html | 768 ++++++++++++++++-- feed.xml | 4 +- 2 files changed, 718 insertions(+), 54 deletions(-) diff --git a/api-reference/expense/expense-report/v4.comments.html b/api-reference/expense/expense-report/v4.comments.html index e40a7845b..48ab24f82 100644 --- a/api-reference/expense/expense-report/v4.comments.html +++ b/api-reference/expense/expense-report/v4.comments.html @@ -1167,7 +1167,9 @@

Comments v4

-

The Comments v4 API is used to read the comments entered on the expense report header, or expenses of an existing expense report. This API is used to detail information about spending that occurs out of policy, which is justified by the report owner, or inaccuracies pointed out by the approvers of the expense report.

+

The Comments v4 API POSTs, GETs, PUTs, and DELETEs comments associated with an expense or a report.

+ +

Comments are typically added to an expense or a report to add additional information about an expense or a report. For example, a comment may highlight spending that is out of policy or a comment may be added to justify a particular expenditure.

Prior Versions

@@ -1238,7 +1240,7 @@

Scope Usage

Dependencies

-

SAP Concur clients must purchase Concur Expense in order to use this API. This API requires the Identity v4 API which is currently only available to approved early access partners. Please contact your SAP Concur representative for more information.

+

SAP Concur clients must purchase Concur Expense in order to use this API. Please contact your SAP Concur representative for more information.

Access Token Usage

@@ -1316,7 +1318,7 @@

Response

Status Codes

+

Payload

+ + +

Response

Status Codes

-

Payload

+

Payload

Example

Request

-
curl --location --request GET 'https://us.api.concursolutions.com/expensereports/v4/users/32C2FCC3-B2E8-4907-9672-5B3F49B1C643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1/comments' \
+
curl --location --request 'POST' \
+'https://us.api.concursolutions.com/expensereports/v4/users/750524a2-907b-4dde-9fec-d038ab043f53/context/TRAVELER/reports/93B9D238A6864C019258/comments' \
 --header 'Authorization: Bearer {access_token}' \
 --header 'Concur-CorrelationId: Expense-Report-test' \
 --header 'Content-Type: application/json'
+--data-raw '{
+  "comment": "This is a new comment."
+}'
 

 
-
 Expense Comments Response

+
Response

+
+
201 Created
+
+{
+  "uri": "https://us.api.concursolutions.com/expensereports/v4/users/750524a2-907b-4dde-9fec-d038ab043f53/context/TRAVELER/reports/93B9D238A6864C019258/comments"
+}
+

+
+
Update Report Header Comments

+
+
Updates the latest comment for the specified report.

+
+
Scopes

+
+
expense.report.readwrite - Refer to Scope Usage for full details.

+
+
Request

+
+
URI Template

+
+
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/comments
+

+
+
Parameters

+
+
+  
+    
+      
+      
+      
+      
+    
+  
+  
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+  
+
NameTypeFormatDescription
userIDstring-Required The unique identifier of the SAP Concur user. Use Identity v4 to retrieve the userID.
contextTypestring-Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY
reportIdstring-Required The unique identifier of the report that is being read.

+
+
Headers

+
+
+
+
Payload

+
+
+
+
Response

+
+
Status Codes

+
+
+
+
Headers

+
+
+
+
Payload

+
+
+
+
Example

+
+
Request

+
+
curl --location --request 'PUT' \
+'https://us.api.concursolutions.com/expensereports/v4/users/750524a2-907b-4dde-9fec-d038ab043f53/context/TRAVELER/reports/93B9D238A6864C019258/comments' \
+--header 'Authorization: Bearer {access_token}' \
+--header 'Concur-CorrelationId: Expense-Report-test' \
+--header 'Content-Type: application/json'
+--data-raw '{
+  "comment": "This report is for stationery expenses."
+}'
+

+
+
Response

 
 
200 OK
 
-[
-    {
-        "comment": "This expense is allowed due to the pandemic",
-        "author": {
-            "firstName": "Concur",
-            "lastName": "Administrator",
-            "middleInitial": ""
-        },
-        "createdForEmployee": {
-            "firstName": "Tester",
-            "lastName": "Insert",
-            "middleInitial": "A"
-        },
-        "createdForEmployeeId": "32c2fcc3-b2e8-4907-9672-5b3f49b1c643",
-        "creationDate": "2021-03-17T23:05:40.340Z",
-        "expenseId": "84FCBB92BD4E5342B849DAC29FD163A1",
-        "isAuditorComment": false,
-        "isLatest": true,
-        "stepInstanceId": "54279E6A6D940741A9CEEDEE2240C5D3"
-    }
-]
+{
+  "uri": "https://us.api.concursolutions.com/expensereports/v4/users/750524a2-907b-4dde-9fec-d038ab043f53/context/TRAVELER/reports/93B9D238A6864C019258/comments"
+}
 

 
-
Schema

+
Delete Report Header Comments

 
-
 Report Header Comments

+
Deletes the latest comment for the specified report.

+
+
Scopes

+
+
expense.report.delete - Refer to Scope Usage for full details.

+
+
Request

+
+
URI Template

+
+
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/comments
+

+
+
Parameters

 
 
@@ -1516,15 +1633,89 @@ 
commentDetails
-      

-      
-      
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      

   
arraycommentDetailsA key linking to another schema for the format.userIDstring-Required The unique identifier of the SAP Concur user. Use Identity v4 to retrieve the userID.
contextTypestring-Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY
reportIdstring-Required The unique identifier of the report that is being read.
     

   
 

 
-
 Expense Comments

+
Headers

+
+
+
+
Response

+
+
Status Codes

+
+
+
+
Headers

+
+
+
+
Example

+
+
Request

+
+
curl --location --request 'DELETE' \
+'https://us.api.concursolutions.com/expensereports/v4/users/750524a2-907b-4dde-9fec-d038ab043f53/context/TRAVELER/reports/93B9D238A6864C019258/comments' \
+--header 'Authorization: Bearer {access_token}' \
+--header 'Concur-CorrelationId: Expense-Report-test' \
+--header 'Content-Type: application/json'
+

+
+
Response

+
+
204 No Content
+

+
Retrieve Expense Comments

+
+
Retrieves the comments on the specific expense within an expense report.

+
+
Scopes

+
+
expense.report.read - Refer to Scope Usage for full details.

+
+
Request

+
+
URI Template

+
+
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/expenses/{expenseId}/comments
+

+
+
Parameters

 
 
@@ -1537,14 +1728,487 @@ 
 Expen
   

-      
-      
-      
-      
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      

   
   
     
commentDetailsarraycommentDetailsA key linking to another schema for the format.userIDstring-Required The unique identifier of the SAP Concur user. Use Identity v4 to retrieve the userID.
contextTypestring-Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY
reportIdstring-Required The unique identifier of the report to which this expense entry belongs.
expenseIdstring-Required The unique identifier of the expense entry to which the comments belong.
     

   
 

 
+
Headers

+
+
+
+
Response

+
+
Status Codes

+
+
+
+
Headers

+
+
+
+
Payload

+
+
+
+
Example

+
+
Request

+
+
curl --location --request GET 'https://us.api.concursolutions.com/expensereports/v4/users/32C2FCC3-B2E8-4907-9672-5B3F49B1C643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1/comments' \
+--header 'Authorization: Bearer {access_token}' \
+--header 'Concur-CorrelationId: Expense-Report-test' \
+--header 'Content-Type: application/json'
+

+
+
 Expense Comments Response

+
+
200 OK
+
+[
+    {
+        "comment": "This expense is allowed due to the pandemic",
+        "author": {
+            "firstName": "Concur",
+            "lastName": "Administrator",
+            "middleInitial": ""
+        },
+        "createdForEmployee": {
+            "firstName": "Tester",
+            "lastName": "Insert",
+            "middleInitial": "A"
+        },
+        "createdForEmployeeId": "32c2fcc3-b2e8-4907-9672-5b3f49b1c643",
+        "creationDate": "2021-03-17T23:05:40.340Z",
+        "expenseId": "84FCBB92BD4E5342B849DAC29FD163A1",
+        "isAuditorComment": false,
+        "isLatest": true,
+        "stepInstanceId": "54279E6A6D940741A9CEEDEE2240C5D3"
+    }
+]
+

+
+
Post Expense Comments

+
+
Creates a new comment for the specified expense.

+
+
Scopes

+
+
expense.report.readwrite - Refer to Scope Usage for full details.

+
+
Request

+
+
URI Template

+
+
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/expenses/{expenseId}/comments
+

+
+
Parameters

+
+
+  
+    
+      
+      
+      
+      
+    
+  
+  
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+  
+
NameTypeFormatDescription
userIDstring-Required The unique identifier of the SAP Concur user. Use Identity v4 to retrieve the userID.
contextTypestring-Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY
reportIdstring-Required The unique identifier of the report to which this expense entry belongs.
expenseIdstring-Required The unique identifier of the expense entry to which the comments belong.

+
+
Headers

+
+
+
+
Payload

+
+
+
+
Response

+
+
Status Codes

+
+
+
+
Headers

+
+
+
+
Payload

+
+
+
+
Example

+
+
Request

+
+
curl --location --request POST 'https://us.api.concursolutions.com/expensereports/v4/users/750524a2-907b-4dde-9fec-d038ab043f53/context/TRAVELER/reports/E364C14BAEEA4BE5922C/expenses/36CBAA8D4ADE6C46BB587C05293405DC/comments' \
+--header 'Authorization: Bearer {access_token}' \
+--header 'Concur-CorrelationId: Expense-Report-test' \
+--header 'Content-Type: application/json'
+--data-raw '{
+  "comment": "This expense is for a business meal."
+}'
+

+
+
Update Expense Comments

+
+
Updates the latest comment for the specified expense.

+
+
Scopes

+
+
expense.report.readwrite - Refer to Scope Usage for full details.

+
+
Request

+
+
URI Template

+
+
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/expenses/{expenseId}/comments
+

+
+
Parameters

+
+
+  
+    
+      
+      
+      
+      
+    
+  
+  
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+  
+
NameTypeFormatDescription
userIDstring-Required The unique identifier of the SAP Concur user. Use Identity v4 to retrieve the userID.
contextTypestring-Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY
reportIdstring-Required The unique identifier of the report to which this expense entry belongs.
expenseIdstring-Required The unique identifier of the expense entry to which the comments belong.

+
+
Headers

+
+
+
+
Payload

+
+
+
+
Response

+
+
Status Codes

+
+
+
+
Headers

+
+
+
+
Payload

+
+
+
+
Example

+
+
Request

+
+
curl --location --request GET 'https://us.api.concursolutions.com/expensereports/v4/users/32C2FCC3-B2E8-4907-9672-5B3F49B1C643/context/TRAVELER/reports/764428DD6A664AF0BFCB/expenses/84FCBB92BD4E5342B849DAC29FD163A1/comments' \
+--header 'Authorization: Bearer {access_token}' \
+--header 'Concur-CorrelationId: Expense-Report-test' \
+--header 'Content-Type: application/json'
+--data-raw '{
+  "comment": "This expense is for a leisure meal."
+}'
+

+
+
Delete Expense Comments

+
+
Deletes the latest comment for the specified expense.

+
+
Scopes

+
+
expense.report.delete - Refer to Scope Usage for full details.

+
+
Request

+
+
URI Template

+
+
https://{datacenterURI}/expensereports/v4/users/{userID}/context/{contextType}/reports/{reportId}/comments
+

+
+
Parameters

+
+
+  
+    
+      
+      
+      
+      
+    
+  
+  
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+    
+      
+      
+      
+      
+    
+  
+
NameTypeFormatDescription
userIDstring-Required The unique identifier of the SAP Concur user. Use Identity v4 to retrieve the userID.
contextTypestring-Required The access level of the SAP Concur user, which determines the form fields they can view/modify. Supported values: TRAVELER, PROXY
reportIdstring-Required The unique identifier of the report to which this expense entry belongs.
expenseIdstring-Required The unique identifier of the expense entry to which the comments belong.

+
+
Headers

+
+
+
+
Response

+
+
Status Codes

+
+
+
+
Headers

+
+
+
+
Example

+
+
Request

+
+
curl --location --request 'DELETE' \
+'https://us.api.concursolutions.com/expensereports/v4/users/750524a2-907b-4dde-9fec-d038ab043f53/context/TRAVELER/reports/93B9D238A6864C019258/comments' \
+--header 'Authorization: Bearer {access_token}' \
+--header 'Concur-CorrelationId: Expense-Report-test' \
+--header 'Content-Type: application/json'
+

+
+
Response

+
+
204 No Content
+

+
+
 Expense Comments Response

+
+
Schema

+
+
 Report Header Comments

+
+
+  
+    
+      
+      
+      
+      
+    
+  
+  
+    
+      
+      
+      
+      
+    
+  
+
NameTypeFormatDescription
commentDetailsarraycommentDetailsA key linking to another schema for the format.

+
+
 Expense Comments

+
+
+  
+    
+      
+      
+      
+      
+    
+  
+  
+    
+      
+      
+      
+      
+    
+  
+
NameTypeFormatDescription
commentDetailsarraycommentDetailsA key linking to another schema for the format.

+
+
 Comment

+
|Name|Type|Format|Description|
+|—|—|—|—|
+|comment|string|-|The comments input on the report/expense by all users.|

+
+
 Comment Save Response

+
|Name|Type|Format|Description|
+|—|—|—|—|
+|uri|string|-|The URI of the comment.|

+
 
commentDetails

 
 
diff --git a/feed.xml b/feed.xml
index 7c5d1b761..0aba48306 100644
--- a/feed.xml
+++ b/feed.xml
@@ -5,8 +5,8 @@
     Concur docs provides comprehensive information on working with the Concur platformhttps://preview.developer.concur.com/
-    Tue, 22 Aug 2023 21:27:08 +0000
-    Tue, 22 Aug 2023 21:27:08 +0000
+    Wed, 23 Aug 2023 16:52:15 +0000
+    Wed, 23 Aug 2023 16:52:15 +0000
     Jekyll v4.1.1