Skip to content
This repository has been archived by the owner on Apr 29, 2022. It is now read-only.

Commit

Permalink
Merge pull request #2053 from concur/preview
Browse files Browse the repository at this point in the history
Preview -> livesite 2019-08-08
  • Loading branch information
jonikamelcher committed Aug 9, 2019
2 parents fe139a4 + 3a20f3d commit d822291
Show file tree
Hide file tree
Showing 43 changed files with 17,882 additions and 1,896 deletions.
6 changes: 4 additions & 2 deletions src/_data/sidebars/api-explorer.yml
Expand Up @@ -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
4 changes: 2 additions & 2 deletions src/_data/sidebars/api-reference.yml
Expand Up @@ -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:
Expand Down
17 changes: 15 additions & 2 deletions src/api-reference/common/ess/getting-started.markdown
Expand Up @@ -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)
Expand All @@ -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.

Expand All @@ -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.
Expand Down
1 change: 1 addition & 0 deletions src/api-reference/deprecated.markdown
Expand Up @@ -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)
Expand Down
Expand Up @@ -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)
Expand Down
2 changes: 0 additions & 2 deletions src/api-reference/expense/quick-expense/v4.quick-expense.md
Expand Up @@ -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.
Expand Down
@@ -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.