Skip to content
Permalink
Browse files

Merge pull request #2053 from concur/preview

Preview -> livesite 2019-08-08
  • Loading branch information...
jonikamelcher committed Aug 9, 2019
2 parents fe139a4 + 3a20f3d commit d822291d310b38d976f153ed9734342718d4cd81
Showing with 17,882 additions and 1,896 deletions.
  1. +4 −2 src/_data/sidebars/api-explorer.yml
  2. +2 −2 src/_data/sidebars/api-reference.yml
  3. +15 −2 src/api-reference/common/ess/getting-started.markdown
  4. +1 −0 src/api-reference/deprecated.markdown
  5. +2 −0 src/api-reference/expense/quick-expense/v3.quick-expense.markdown
  6. +0 −2 src/api-reference/expense/quick-expense/v4.quick-expense.md
  7. +117 −0 ...nancial-integration/json/FI-API-CashAdvanceID-2E6DA12BB8B87D468BD666383E44033D-Example-5.2.1.json
  8. +117 −0 ...nancial-integration/json/FI-API-CashAdvanceID-30D6B657B6A50946AC6C2DAB537C8CD9-Example-5.2.2.json
  9. +117 −0 ...nancial-integration/json/FI-API-CashAdvanceID-E2A086D30B88AE4683BC48ADE47B8116-Example-5.1.1.json
  10. +734 −0 src/api-reference/financial-integration/json/FI-API-ReportID-0C45F960C3064ED88C39-Example-3.1.json
  11. +734 −0 src/api-reference/financial-integration/json/FI-API-ReportID-0C45F960C3064ED88C39-Example-6.1.4.json
  12. +376 −0 src/api-reference/financial-integration/json/FI-API-ReportID-0EE74C75C9344DEA942F-Example-2.3.json
  13. +759 −0 src/api-reference/financial-integration/json/FI-API-ReportID-14A40453BED6493EB53F-Example-5.2.1.json
  14. +534 −0 src/api-reference/financial-integration/json/FI-API-ReportID-15298B27B5FC4EBC98B3-Example-6.2.1.json
  15. +927 −0 src/api-reference/financial-integration/json/FI-API-ReportID-1B25850DD8B94D5F8B2D-Example-6.1.6.json
  16. +541 −0 src/api-reference/financial-integration/json/FI-API-ReportID-2519BED4A22B43C4B8E7-Example-2.5.json
  17. +793 −0 src/api-reference/financial-integration/json/FI-API-ReportID-460EFDDC98634EA9A0AD-Example-4.1.json
  18. +348 −0 src/api-reference/financial-integration/json/FI-API-ReportID-473498AF26AE45A094A6-Example-1.3.json
  19. +541 −0 src/api-reference/financial-integration/json/FI-API-ReportID-4B643D954FF64AF0B771-Example-6.1.5.json
  20. +759 −0 src/api-reference/financial-integration/json/FI-API-ReportID-52F40A7F26D74F1AAFFB-Example-5.2.2.json
  21. +348 −0 src/api-reference/financial-integration/json/FI-API-ReportID-57A29232093E4B7AADF7-Example-6.1.3.json
  22. +363 −0 src/api-reference/financial-integration/json/FI-API-ReportID-641C4F998328438284A2-Example-2.2.json
  23. +348 −0 src/api-reference/financial-integration/json/FI-API-ReportID-6517F735E33A47B98D80-Example-1.2.json
  24. +939 −0 ...inancial-integration/json/FI-API-ReportID-7E141428931340B990A3-Example-6.1.6-with-offsetting.json
  25. +1,132 −0 src/api-reference/financial-integration/json/FI-API-ReportID-7F00502973D84DEFA49E-Example-6.2.4.json
  26. +1,132 −0 src/api-reference/financial-integration/json/FI-API-ReportID-815EF4FB5B4448A9B09E-Example-6.2.2.json
  27. +534 −0 src/api-reference/financial-integration/json/FI-API-ReportID-9616BC579E7246D8BDB9-Example-6.2.3.json
  28. +927 −0 ...inancial-integration/json/FI-API-ReportID-9AAA32338A264AC1908E-Example-6.1.7-with-offsetting.json
  29. +541 −0 src/api-reference/financial-integration/json/FI-API-ReportID-AA45D472EC0D456D9D73-Example-1.4.json
  30. +512 −0 src/api-reference/financial-integration/json/FI-API-ReportID-B1041655B4CE4171BDAA-Example-1.1.json
  31. +512 −0 src/api-reference/financial-integration/json/FI-API-ReportID-B1041655B4CE4171BDAA-Example-6.1.1.json
  32. +516 −0 src/api-reference/financial-integration/json/FI-API-ReportID-CDFDE0F4CACE4426A913-Example-6.1.2.json
  33. +927 −0 src/api-reference/financial-integration/json/FI-API-ReportID-EEBD898C643A40DEB4E9-Example-6.1.7.json
  34. +363 −0 src/api-reference/financial-integration/json/FI-API-ReportID-F071FADEA6B142DD884A-Example-2.1.json
  35. +376 −0 src/api-reference/financial-integration/json/FI-API-ReportID-FABA2A8599224AE5A6C8-Example-2.4.json
  36. +0 −264 ...i-reference/financial-integration/v4.Financial-Integration-Use-Cases-Extract-Information.markdown
  37. +223 −224 src/api-reference/financial-integration/v4.financial-documents-schema.markdown
  38. +319 −1,281 src/api-reference/financial-integration/v4.financial-integration-service-use-cases.markdown
  39. +283 −0 ...i-reference/financial-integration/v4.financial-integration-use-cases-extract-information.markdown
  40. +108 −106 src/api-reference/financial-integration/v4.financial-integration.markdown
  41. +8 −13 src/manage-apps/go-market-docs/app-center-partner-marketing-toolkit.markdown
  42. +49 −0 src/tools-support/release-notes/api/2019-08-01.md
  43. +1 −0 src/tools-support/release-notes/index.markdown
@@ -80,7 +80,9 @@
- title: v4.0
url: ''
children:
- title: Purchase Requests
url: /api-explorer/v4-0/PurchaseRequest.html
- title: Invoice Pay
url: /api-explorer/v4-0/InvoicePay.html
- title: Purchase Requests
url: /api-explorer/v4-0/PurchaseRequest.html
- title: Quick Expenses
url: /api-explorer/v4-0/QuickExpenses.html
@@ -142,8 +142,8 @@
url: /api-reference/expense/expense-report/expense-report-get.html
- title: Payment Batches v1.1
url: /api-reference/expense/payment-batch/v1.payment-batches.html
- title: Quick Expense v3
url: /api-reference/expense/quick-expense/v3.quick-expense.html
- title: Quick Expense v4
url: /api-reference/expense/quick-expense/v4.quick-expense.html
- title: Insights
url: ''
children:
@@ -7,7 +7,8 @@ layout: reference

* [Overview](#ess)
* [Terminology](#ess-terminology)
* [Architecture](#ess-architecture)
* [Delivery model](#ess-delivery)
* [Access control](#access-control)
* [Subscribing](#subscribing)
* [Endpoint Requirements](#endpoint-requirements)
* [Authentication](#ess-authentication)
@@ -23,7 +24,7 @@ The Event Subscription Service (ESS) implements Publish/Subscribe pattern using
* Subscription - a topic consumer. Each subscription has a topic it is subscribed to.
* Webhook - an ESS application that uses subscription and delivers events to the endpoint.

## <a name="ess-architecture"></a>ESS Architecture
## <a name="ess-delivery"></a>ESS Delivery model

It is important to remember that ESS doesn't have any API that you can call for SAP Concur events, ESS delivers events to your endpoint.

@@ -32,6 +33,18 @@ It is important to remember that ESS doesn't have any API that you can call for
* The application endpoint can also use the related web services to retrieve or send SAP Concur data. For example, an event may be generated when a request for travel is submitted. The application endpoint may then leverage data from the event, such as the request ID, to retrieve the relevant travel request record from the published Request APIs.


## <a name="access-control"></a>Access control

ESS is requiring a caller to have a proper JWT and scopes, for more details please refer <a href="https://developer.concur.com/api-reference/authentication/scopes.html">our wiki</a>
A caller must have types of scopes

* ESS API level scope "events.topic.read" is required to be able to access ESS API

* Resource level scope example "expense.request.read" is required to be able to access "expense.request" topic and to be able to create subscriptions to that topic

All required scopes can be requested for a caller Application by Partner Enablement team.


## <a name="subscribing"></a>Subscribing your endpoint

In order to begin receiving events, you must first subscribe to the relevant topic(s) for your application.
@@ -41,6 +41,7 @@ The following application programming interfaces (APIs) have been deprecated acc
* [Quick Expense Resource](/api-reference/expense/quick-expense/v1.quick-expense-resource.html)
* [Get quick expenses](/api-reference/expense/quick-expense/v1.quick-expense-resource-get.html)
* [Post a quick expense](/api-reference/expense/quick-expense/v1.quick-expense-resource-post.html)
* [Quick Expense v3](/api-reference/expense/quick-expense/v3.quick-expense.html)
* [Receipts v3](/api-reference/receipts/v3.receipts.html)
* Travel Web Service v1
* [Profile Resource](/api-reference/travel-profile/v1.profile-resource.html)
@@ -6,6 +6,8 @@ redirect_from:
- /api-reference/expense/quick-expense/index.html
---

{% include deprecation-alert.html %}

The Quick Expense API can be used to create an expense with basic information such as date, amount, and expense type, with or without a receipt image. This expense can be added to an expense report within Concur Expense, allowing the user to provide additional details such as attendees, itemizations, etc.

* [Retrieve quick expenses](#get)
@@ -3,8 +3,6 @@ title: Quick Expense v4
layout: reference
---

{% include prerelease.html %}

The Quick Expense API can be used to create an expense with basic information such as date, amount, and expense type, with or without a receipt image. This expense can be added to an expense report within Concur Expense, allowing the user to provide additional details such as attendees, itemizations etc.

> **Limitations**: This API is only available to partners who have been granted access by SAP Concur. Access to this documentation does not provide access to the API. This API is not available in Implementation environments.
@@ -0,0 +1,117 @@
{
"fIDocuments": [
{
"id": "eba0eed3dd994eaa9d2007ed8053ad9f",
"docType": "cashadvance",
"companyId": "278515",
"entityId": "p0085104gigw",
"companyUuid": "2fbfd79f-90e7-4f2a-b950-680a107c9f93",
"erpSystemId": "",
"document": {
"employeeData": {
"employeeId": "tuan@dstaabfi-pro.com",
"employeeFirstName": "Tuan",
"employeeLastName": "UK-User",
"employeeMI": null,
"employeeOrgUnit2Value": "Engineering",
"employeeOrgUnit3Value": null,
"employeeOrgUnit6Value": null,
"employeeCustom1Code": null,
"employeeCustom2Code": null,
"employeeCustom3Code": null,
"employeeCustom4Code": null,
"employeeCustom5Code": null,
"employeeCustom6Code": null,
"employeeCustom7Code": null,
"employeeCustom8Code": null,
"employeeCustom9Code": null,
"employeeCustom10Code": null,
"employeeCustom11Code": null,
"employeeCustom12Code": null,
"employeeCustom13Code": null,
"employeeCustom14Code": null,
"employeeCustom15Code": null,
"employeeCustom16Code": null,
"employeeCustom17Code": null,
"employeeCustom18Code": null,
"employeeCustom19Code": null,
"employeeCustom20Code": null,
"employeeCustom21Code": "UK-Tuan",
"employeeCustom1Value": null,
"employeeCustom2Value": null,
"employeeOrgUnit5Value": null,
"employeeCustom3Value": null,
"employeeCustom4Value": null,
"employeeCustom5Value": null,
"employeeCustom6Value": null,
"employeeCustom7Value": null,
"employeeCustom8Value": null,
"employeeCustom9Value": null,
"employeeCustom10Value": null,
"employeeCustom11Value": null,
"employeeCustom12Value": null,
"employeeCustom13Value": null,
"employeeCustom14Value": null,
"employeeCustom15Value": null,
"employeeCustom16Value": null,
"employeeCustom17Value": null,
"employeeCustom18Value": null,
"employeeCustom19Value": null,
"employeeCustom20Value": null,
"employeeCustom21Value": "UK-Tuan",
"employeeOrgUnit1Code": "1",
"employeeOrgUnit2Code": "30",
"employeeOrgUnit3Code": null,
"employeeOrgUnit4Code": null,
"employeeOrgUnit5Code": null,
"employeeOrgUnit6Code": null,
"employeeOrgUnit1Value": "Company1",
"employeeOrgUnit4Value": null
},
"cashAdvanceData": {
"locationName": null,
"exchangeRate": 1,
"clearingAccountCode": null,
"purpose": null,
"cashAdvanceId": "2E6DA12BB8B87D468BD666383E44033D",
"paymentMethod": 0,
"issuedDate": "2019-06-22T03:48:43.600Z",
"requestAmount": 300,
"requestDate": "2019-06-21T23:59:53.040Z",
"currencyAlphaCode": "USD",
"isTest": "N",
"countryCode": null,
"countrySubCode": null,
"requestedDisbursementDate": null,
"travelStartDate": null,
"travelEndDate": null,
"currencyNumCode": "840",
"expensePayIndicator": "N",
"employeeCurrencyAlphaCode": "GBP",
"cardAccountID": null,
"cardTransactionID": null,
"cardTransactionAmount": null,
"cardTransactionCurrency": null,
"cardTransactionPostedAmount": null,
"cardTransactionPostedCurrency": null,
"transactionType": 1,
"name": "Example 5.2.1"
},
"journalData": [
{
"amount": 300,
"payee": "EMPL",
"accountCode": "CADV",
"debitOrCredit": "DR",
"payer": "COMP",
"paymentCode": "Cash"
}
]
},
"docStatus": "READY"
}
],
"offset": null,
"nextPage": null,
"numberReturned": 1
}
@@ -0,0 +1,117 @@
{
"fIDocuments": [
{
"id": "ad90f2b63645447885e5d7dabc59f8e0",
"docType": "cashadvance",
"companyId": "278515",
"entityId": "p0085104gigw",
"companyUuid": "2fbfd79f-90e7-4f2a-b950-680a107c9f93",
"erpSystemId": "",
"document": {
"employeeData": {
"employeeId": "tuan@dstaabfi-pro.com",
"employeeFirstName": "Tuan",
"employeeLastName": "UK-User",
"employeeMI": null,
"employeeCustom11Value": null,
"employeeCustom12Value": null,
"employeeCustom13Value": null,
"employeeCustom14Value": null,
"employeeCustom15Value": null,
"employeeCustom16Value": null,
"employeeCustom17Value": null,
"employeeCustom18Value": null,
"employeeCustom19Value": null,
"employeeCustom20Value": null,
"employeeCustom21Value": "UK-Tuan",
"employeeOrgUnit6Value": null,
"employeeCustom1Code": null,
"employeeCustom2Code": null,
"employeeCustom3Code": null,
"employeeCustom4Code": null,
"employeeCustom5Code": null,
"employeeCustom6Code": null,
"employeeCustom7Code": null,
"employeeCustom8Code": null,
"employeeCustom9Code": null,
"employeeCustom10Code": null,
"employeeCustom11Code": null,
"employeeCustom12Code": null,
"employeeCustom13Code": null,
"employeeCustom14Code": null,
"employeeCustom15Code": null,
"employeeCustom16Code": null,
"employeeCustom17Code": null,
"employeeCustom18Code": null,
"employeeCustom19Code": null,
"employeeCustom20Code": null,
"employeeCustom21Code": "UK-Tuan",
"employeeCustom1Value": null,
"employeeCustom2Value": null,
"employeeCustom3Value": null,
"employeeCustom4Value": null,
"employeeCustom5Value": null,
"employeeCustom6Value": null,
"employeeCustom7Value": null,
"employeeCustom8Value": null,
"employeeCustom9Value": null,
"employeeCustom10Value": null,
"employeeOrgUnit4Value": null,
"employeeOrgUnit5Value": null,
"employeeOrgUnit1Code": "1",
"employeeOrgUnit2Code": "30",
"employeeOrgUnit3Code": null,
"employeeOrgUnit4Code": null,
"employeeOrgUnit5Code": null,
"employeeOrgUnit6Code": null,
"employeeOrgUnit1Value": "Company1",
"employeeOrgUnit2Value": "Engineering",
"employeeOrgUnit3Value": null
},
"cashAdvanceData": {
"issuedDate": "2019-06-22T04:53:48.810Z",
"cashAdvanceId": "30D6B657B6A50946AC6C2DAB537C8CD9",
"paymentMethod": 0,
"requestAmount": 400,
"requestDate": "2019-06-22T04:51:36.120Z",
"currencyAlphaCode": "GBP",
"purpose": null,
"clearingAccountCode": null,
"countryCode": null,
"isTest": "N",
"locationName": null,
"exchangeRate": 1,
"countrySubCode": null,
"requestedDisbursementDate": null,
"travelStartDate": null,
"travelEndDate": null,
"currencyNumCode": "826",
"expensePayIndicator": "N",
"employeeCurrencyAlphaCode": "GBP",
"cardAccountID": null,
"cardTransactionID": null,
"cardTransactionAmount": null,
"cardTransactionCurrency": null,
"cardTransactionPostedAmount": null,
"cardTransactionPostedCurrency": null,
"transactionType": 1,
"name": "Example 5.2.2"
},
"journalData": [
{
"accountCode": "CADV",
"amount": 400,
"payee": "EMPL",
"debitOrCredit": "DR",
"paymentCode": "Cash",
"payer": "COMP"
}
]
},
"docStatus": "READY"
}
],
"offset": null,
"nextPage": null,
"numberReturned": 1
}

0 comments on commit d822291

Please sign in to comment.
You can’t perform that action at this time.