Merge pull request #557 from concur/preview

Update API docs
concur · May 25, 2016 · 4d8e095 · 4d8e095
2 parents 19a6c9b + b2d145b
commit 4d8e095
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 3 deletions.
diff --git a/api-alpha/receipts/index.markdown → api-alpha/receipts/apidoc.markdown b/api-alpha/receipts/index.markdown → api-alpha/receipts/apidoc.markdown
@@ -145,7 +145,7 @@ general-receipt.json
 HTTP/1.1 201 Created
 concur-correlationid: 0f839dfc-1537-441b-a2f0-8a574b2a2776
 Link: <http://schema.concursolutions.com/general-receipt.schema.json>; rel="describedBy"
-Location: https://us.api.concursolutions.com/receipts/v4/{receiptId}
+Location: https://us.api.concursolutions.com/receipts/v4/7c22adcfaf6b4622be0d4e28f7aa2f79
 Date: Mon, 23 May 2016 21:31:31 GMT
 Connection: keep-alive
 Content-Length: 0
@@ -177,10 +177,48 @@ A receipt (including metadata) matching the [schema](#Schema) in which it was cr
 
 #### Request
 
-
+`curl -v https://us.api.concursolutions.com/receipts/v4/7c22adcfaf6b4622be0d4e28f7aa2f79 -H "Authorization: Bearer {valid JWT}`
 
 #### Response
 
+```
+HTTP/1.1 200 OK
+X-Powered-By: Express
+concur-correlationid: 0f839dfc-1537-441b-a2f0-8a574b2a2776
+Content-Type: application/json; charset=utf-8
+Content-Length: 1152
+ETag: W/"480-2083390041"
+Date: Tue, 24 May 2016 23:05:44 GMT
+Connection: keep-alive
+
+{
+  "dateTimeReceived": "",
+  "id": "7c22adcfaf6b4622be0d4e28f7aa2f79",
+  "image": null,
+  "imageId": "2834476850AC36F1965F1A6555697D00",
+  "receipt":{
+      "app": "{app URL}",
+      "dateTime": "2016-05-23T13:40:00+0700",
+      "total": "10.00",
+      "currencyCode": "USD",
+      "merchant": {
+          "name": "General Book Store",
+          "location": {
+              "name": "Downtown Bellevue",
+              "address": {
+                  "countryCode": "US"
+              }
+          }
+      },
+      "payments": [
+          {
+              "amount": "10.00"
+          }
+      ]
+  }
+}
+```
+
 ## <a name="GetReceiptsForUser"></a>Retrieve receipts for a user
 
 ### Header

diff --git a/api-alpha/receipts/quickstart.markdown b/api-alpha/receipts/quickstart.markdown
@@ -0,0 +1,16 @@
+---
+title: Quick Start Guide
+layout: reference
+---
+
+- How to create a sandbox?
+- How to obtain client_id and client_secret for the Auth service?
+  - Sandbox
+  - Production
+- How to obtain user URL?
+  - Sandbox
+  - Production
+- How to obtain app URL?
+  - Sandbox
+  - Production
+- How to test the e-receipt workflow end-to-end? 
diff --git a/api-reference/expense/attendees/index.markdown b/api-reference/expense/attendees/index.markdown
@@ -255,7 +255,7 @@ Name | Type | Format | Description
 `Company`	|	``string``	|	-	|	The name of the attendee's company. Maximum length: 150 characters
 `CurrencyCode`	|	`string`	|	-	|	The 3-letter ISO 4217 currency code for monetary amounts related to an attendee.
 `Custom1 through Custom25`	|	`CustomField`	|	-	|	A custom field associated with the attendee. This field may or may not have data, depending on how Expense is configured.
-`ExternalID`	|	`string`	|	-	|	A unique identifier for the attendee, assigned outside of Concur. Maximum length: 48 characters
+`ExternalID`	|	`string`	|	-	|	A unique identifier for the attendee, assigned outside of Concur. Maximum length: 48 characters **NOTE: For HCP connectors where information returned to Concur represents one record per attendee+address pair, this value should be a unique identifier for that pair, and the unique identifier for the individual should be placed into a custom field.**
 `FirstName`	|	`string`	|	-	|	The attendee's first name. Maximum length: 50 characters
 `HasExceptionsPrevYear`	|	`Boolean`	|	-	|	Determines whether the attendee had exceptions in the previous year, based on yearly total limits for attendees. Format: true or false
 `HasExceptionsYTD`	|	`Boolean`	|	-	|	Determines whether the attendee has exceptions in the current year, based on yearly total limits for attendees. Format: true or false