Skip to content
Permalink
Browse files

Merge pull request #2060 from concur/preview

Preview -> livesite 2019-08-22
  • Loading branch information...
jonikamelcher committed Aug 22, 2019
2 parents d6e1d72 + 1f23688 commit 2d60300478a5014b60fd6c0f4739944c0e75af54
@@ -3,14 +3,18 @@ title: Payment Batches
layout: reference
---


# Payment Batches

The Payment Batch File web service provides an automated solution to clients who would like to manage their payment batches and collect their batch files.

* [Retrieve the list of payment batches](#getpaymentbatches)
* [Schema](#getpaymentbatchesschema)
* [Close a payment batch asynchronously](#closepaymentbatch)
* [Schema](#closepaymentbatchschema)
* [Close a payment batch synchronously](#closepaymentbatchsync)
* [Schema](#closepaymentbatchsyncschema)
* [Retrieve a payment batch file](#getbatchfile)
* [Schema](#getbatchfileschema)
* [Error Messages](#errormessages)

## Product and Edition
@@ -33,7 +37,7 @@ Name|Type|Format|Description
`batchlist`|`string`|-|**Required.** The batchlist keyword.
`Status`|`Boolean`|-|The status of the batches. Can be either OPEN or CLOSED.

### Response
### <a name="getpaymentbatchesschema"></a>Retrieve Payment Batches Response Schema

Name|Type|Format|Description
---|---|---|---
@@ -49,7 +53,7 @@ Name|Type|Format|Description
## <a name="closepaymentbatch"></a>Close a Payment Batch Asynchronously
### Version 1.2

This asynchronous request schedules closing of the specified batch, preventing any new expenses from entering it. After the batch closes, you can use Close Payment Batch v1.1 to get the `File-Url` to download the file containing the expense transaction information.
This asynchronous request schedules closing of the specified batch, preventing any new expenses from entering it. After the batch closes, you can use Close Payment Batch v1.1 to get the `File-Url` to download the file containing the expense transaction information.

> **Note**: You can check batch status using the Retrieve the List of Payment Batches method.
@@ -64,7 +68,7 @@ Name|Type|Format|Description
`BatchID`|`string`|-|**Required.** The unique identifier for the batch.
`close`|`string`|-|**Required.** The close keyword.

### Response
### <a name="closepaymentbatchschema"></a>Close Payment Batch Asynchronously Response Schema

Name|Type|Format|Description
---|---|---|---
@@ -74,7 +78,7 @@ Name|Type|Format|Description
## <a name="closepaymentbatchsync"></a>Close a Payment Batch Synchronously
### Version 1.1

This request synchronously closes the batch preventing any new expenses from entering it. After the batch closes, SAP Concur creates the batch file containing the expense transaction information. If a batch ID for an already closed batch is sent, SAP Concur regenerates the batch file for the specified batch.
This request synchronously closes the batch preventing any new expenses from entering it. After the batch closes, SAP Concur creates the batch file containing the expense transaction information. If a batch ID for an already closed batch is sent, SAP Concur regenerates the batch file for the specified batch.

This synchronous call has a time limit that can be superseded by the time it takes to close the batch. It is recommended that you use Close a Payment Batch Asynchronously (v1.2) to close batches, then use this request after the batch is closed to obtain the `File-Url` needed to download the file with the expense transaction information.

@@ -91,7 +95,7 @@ Name|Type|Format|Description
`BatchID`|`string`|-|**Required.** The unique identifier for the batch.
`close`|`string`|-|**Required.** The close keyword.

### Response
### <a name="closepaymentbatchsyncschema"></a>Close Payment Batch Synchronously Response Schema

Name|Type|Format|Description
---|---|---|---
@@ -113,7 +117,7 @@ Name|Type|Format|Description
---|---|---|---
`JobRunKey`|`string`|-|**Required.** The `File-Url` element returned by the Close Batches 1.1 API response contains the encrypted JobRunKey. In practice, you can use the `File-Url` whole value to download the file.

### Response
### <a name="getbatchfileschema"></a>Retrieve Payment Batch File Response Schema

This request will return the expense transaction data in text/csv format if there was a single file produced or as a zip archive if the batch is configured to produce more than one file. An example of a client who will receive multiple files is a client using QuickBooks, who receives one file formatted for import into QuickBooks (.IIF extension), and one file for the general ledger (.CSV extension), inside a .ZIP file.

@@ -6,25 +6,27 @@ redirect_from:
- /api-reference/travel-profile/03-loyalty-program-resource.html
---

The loyalty program information for the user, as entered in Concur.
The loyalty program information for the user, as entered in SAP Concur.

## URI

`https://www.concursolutions.com/api/travelprofile/v1.0/loyalty`

## Content types
## Content Types

* application/xml

## Accept types
## Accept Types

* application/xml

## Operations

* [Update loyalty program information](#a1)
* [Request schema](#requestschema)
* [Response schema](#responseschema)

## <a name="a1">Update loyalty program information</a>
## <a name="a1">Update Loyalty Program Information</a>

Updates the loyalty program information for the OAuth consumer. Loyalty contains a variety of information about the user's loyalty membership, including:

@@ -47,40 +49,38 @@ If the request is sent by a TMC, the request can update any loyalty program for

### Restrictions

This function is only available to travel suppliers who have completed the [Concur application review process](/manage-apps/app-certification.html). Suppliers may post loyalty membership information for their loyalty programs only.
This function is only available to travel suppliers who have completed the [SAP Concur application review process](/manage-apps/app-certification.html). Suppliers may post loyalty membership information for their loyalty programs only.

## Request

### Headers

#### Authorization header
#### Authorization Header

Authorization header with OAuth token for valid Concur user. Required.
Authorization header with OAuth token for valid SAP Concur user. Required.

#### Accept header
#### Accept Header

application/xml

### Request body
### Request Body

#### Root elements
This request contains the `LoyaltyMembershipUpdate` parent element with a `Membership` child element for each included loyalty program. The `Membership` element has a `UniqueID` attribute containing the loyalty program identifier, and the following child elements.

This request contains the **LoyaltyMembershipUpdate** parent element with a **Membership** child element for each included loyalty program. The **Membership** element has a **UniqueID** attribute containing the loyalty program identifier, and the following child elements.

##### Membership element
#### <a name="requestschema"></a>Update Loyalty Program Membership Request Schema

Element|Description
---|---
VendorCode|The code for the vendor that manages the loyalty program. This element is required when the request is sent by a TMC, and is ignored when the request is sent by a travel supplier.
VendorType|The type of vendor that manages the loyalty program. Format: A, C or H<br>A – Air<br>C – Car<br>H – Hotel<br>This element is required when the request is sent by a TMC, and is ignored when the request is sent by a travel supplier.
AccountNo|The user's account identifier in the loyalty program.
Status|Name of the user's current level in the loyalty program.  Examples: Gold or Premier.
StatusBenefits|Description of a benefit of the loyalty program at the current status. Example: You are entitled to free breakfast.
PointTotal|The user's total number of points in the loyalty program.
SegmentTotal|The user's total segments in the loyalty program.
NextStatus|Name or description of next higher status level in the  loyalty program.
PointsUntilNextStatus|Loyalty points required to next status level.
SegmentsUntilNextStatus|Booking segments to next status level.
`VendorCode`|The code for the vendor that manages the loyalty program. This element is required when the request is sent by a TMC, and is ignored when the request is sent by a travel supplier.
`VendorType`|The type of vendor that manages the loyalty program. Format: A, C or H<br>A – Air<br>C – Car<br>H – Hotel<br>This element is required when the request is sent by a TMC, and is ignored when the request is sent by a travel supplier.
`AccountNo`|The user's account identifier in the loyalty program.
`Status`|Name of the user's current level in the loyalty program.  Examples: Gold or Premier.
`StatusBenefits`|Description of a benefit of the loyalty program at the current status. Example: You are entitled to free breakfast.
`PointTotal`|The user's total number of points in the loyalty program.
`SegmentTotal`|The user's total segments in the loyalty program.
`NextStatus`|Name or description of next higher status level in the  loyalty program.
`PointsUntilNextStatus`|Loyalty points required to next status level.
`SegmentsUntilNextStatus`|Booking segments to next status level.

### XML Example Request From Travel Supplier

@@ -156,14 +156,14 @@ Authorization: OAuth {access token}

application/xml

### Response body root elements
### <a name="responseschema"></a>Update Loyalty Program Membership Response Schema

This request will return a **LoyaltyMembershipResponse** parent element with the following child elements:
This request will return a `LoyaltyMembershipResponse` parent element with the following child elements:

Element|Description
---|---
Status|The status of the update request. Format: OK or ERROR
ErrorDescription|The details of the error. Only contains data if the **Status** is ERROR.
`Status`|The status of the update request. Format: OK or ERROR
`ErrorDescription`|The details of the error. Only contains data if the `Status` is ERROR.

### XML Example of Successful Response

@@ -6,9 +6,9 @@ redirect_from:
- /api-reference/travel-profile/04-notification-company-resource.html
---

A subscription to a notification when any user in the Concur company changes the specified features of their Concur account or data. Currently supports notifications for the following events: Itinerary change (create or update), Travel Profile basic information change.
A subscription to a notification when any user in the SAP Concur company changes the specified features of their SAP Concur account or data. Currently supports notifications for the following events: Itinerary change (create or update), Travel Profile basic information change.

This functionality requires that the partner complete the OAuth process with an administrative user from the Concur company. This resource can only be accessed by partner applications that have selected the User API scope.
This functionality requires that the partner complete the OAuth process with an administrative user from the SAP Concur company. This resource can only be accessed by partner applications that have selected the User API scope.

## URI

@@ -31,6 +31,7 @@ application/xml
## Operations

* [Post Company Notification Subscription for Itinerary Changes](#a1)
* [Schema](#itineraryschema)
* [Post Company Notification Subscription for Payment Changes](#a2)
* [Post Company Notification Subscription for Travel Profile Changes](#a3)

@@ -44,11 +45,11 @@ Subscribes or unsubscribes the partner from notifications when any users in the

#### Headers

#### Request parameters
#### Request Parameters

Name|Description
---|---
type=itinerary|Required. The type of subscription.
`type=itinerary`|Required. The type of subscription.

**Examples**

@@ -63,9 +64,9 @@ To unsubscribe:
https://www.concursolutions.com/api/company/v1.0/unsubscribe?type=itinerary
```

##### Authorization header
##### Authorization Header

Required. Authorization header with OAuth token for an administrative user at the company. The user must have one of the following user roles in Concur: Company Administrator or Web Services Administrator for Professional, or Can Administer for Standard.
Required. Authorization header with OAuth token for an administrative user at the company. The user must have one of the following user roles in SAP Concur: Company Administrator or Web Services Administrator for Professional, or Can Administer for Standard.

#### XML Example Request

@@ -78,24 +79,24 @@ Authorization: OAuth {access token}

#### Notification Format

The notification will be sent to the Postback URL that the partner has registered with Concur during application review. Partners can only have one postback URL for all notification types. The notification will include the **type**, **oauth_token_key**, **userid_type**, and **userid_value** query parameters, specifying the updated user:
The notification will be sent to the Postback URL that the partner has registered with SAP Concur during application review. Partners can only have one Postback URL for all notification types. The notification will include the `type`, `oauth_token_key`, `userid_type`, and `userid_value` query parameters, specifying the updated user:

```
https://postbackurl.com?type=itinerary&oauth_token_key={oauthtoken}&userid_type=login&userid_value=cm@example.com
```

#### Response body root elements
#### <a name="itineraryschema"></a>Company Notification Subscription for Itinerary Changes Response Schema

The response body will include a **Notification** parent element, with the following child elements.
The response body will include a `Notification` parent element, with the following child elements.

Element|Description
---|---
ObjectType|ITINERARY
ObjectURI|The URI for the object. The developer can use the appropriate GET endpoint with the ObjectURI to get complete details for the trip.
EventDateTime|When the event happened. Format: YYYY-MM-DDThh:mm:ss
EventType|The type of the change. Format: CREATE, UPDATE, CANCEL
Context|This is not used yet but will be used in the future to specify the change in the trip. Developers can use this in conjunction with EventType to decide how to process the notification.
TripId|The unique identifier for the trip. Format: String
`ObjectType`|ITINERARY
`ObjectURI`|The URI for the object. The developer can use the appropriate GET endpoint with the `ObjectURI` to get complete details for the trip.
`EventDateTime`|When the event happened. Format: YYYY-MM-DDThh:mm:ss
`EventType`|The type of the change. Format: CREATE, UPDATE, CANCEL
`Context`|This is not used yet but will be used in the future to specify the change in the trip. Developers can use this in conjunction with `EventType` to decide how to process the notification.
`TripId`|The unique identifier for the trip. Format: String

#### XML Example of Successful Response

@@ -130,11 +131,11 @@ Subscribes or unsubscribes the partner from notifications when the company's Pay

#### Headers

#### Request parameters
#### Request Parameters

Name|Description
---|---
type=fop|The type of subscription. Required.
`type=fop`|The type of subscription. Required.

**Examples**

@@ -152,8 +153,9 @@ https://www.concursolutions.com/api/company/v1.0/unsubscribe?type=fop

#### Headers

##### Authorization header
Required. Authorization header with OAuth token for the desired Concur user. This token is granted as part of the [OAuth 2.0 Web flow authorization process](/api-reference/authentication/apidoc.html).
##### Authorization Header

Required. Authorization header with OAuth token for the desired SAP Concur user. This token is granted as part of the [OAuth 2.0 Web flow authorization process](/api-reference/authentication/apidoc.html).

### XML Example Request

@@ -166,13 +168,13 @@ Authorization: OAuth {access token}

#### Notification Format

The notification will be sent to the Postback URL that the supplier has registered with Concur during application review. Suppliers can only have one postback URL for all notification types. The notification will include the **type** and **oauth_token_key** query parameters, specifying the OAuth information for the updated user:
The notification will be sent to the Postback URL that the supplier has registered with Concur during application review. Suppliers can only have one Postback URL for all notification types. The notification will include the `type` and `oauth_token_key` query parameters, specifying the OAuth information for the updated user:

```
https://postbackurl.com?type=FOP&oauth_token_key={oauth_token}
```

### XML Example of successful response
### XML Example of Successful Response

`200 OK`

@@ -188,11 +190,11 @@ Subscribes or unsubscribes the partner from notifications when the company's Tra

#### Headers

##### Request parameters
##### Request Parameters

Name|Description
---|---
type=profile|Required. The type of subscription.
`type=profile`|Required. The type of subscription.

**Examples**

@@ -208,9 +210,9 @@ To unsubscribe:
https://www.concursolutions.com/api/company/v1.0/unsubscribe?type=profile
```

##### Authorization header
##### Authorization Header

Required. Authorization header with OAuth token for an administrative user at the company. The user must have one of the following user roles in Concur: Company Administrator or Web Services Administrator for Professional, or Can Administer for Standard.
Required. Authorization header with OAuth token for an administrative user at the company. The user must have one of the following user roles in SAP Concur: Company Administrator or Web Services Administrator for Professional, or Can Administer for Standard.

#### XML Example Request

@@ -223,7 +225,7 @@ Authorization: OAuth {access token}

#### Notification Format

The notification will be sent to the Postback URL that the partner has registered with Concur during application review. Partners can only have one postback URL for all notification types. The notification will include the **type**, **oauth_token_key**, **userid_type**, and **userid_value** query parameters, specifying the updated user:
The notification will be sent to the Postback URL that the partner has registered with SAP Concur during application review. Partners can only have one Postback URL for all notification types. The notification will include the `type`, `oauth_token_key`, `userid_type`, and `userid_value` query parameters, specifying the updated user:

```
https://postbackurl.com?type=profile&oauth_token_key={oauthtoken}&userid_type=login&userid_value=cm@example.com

0 comments on commit 2d60300

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