<commit_before>---
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)
* [Close a payment batch](#closepaymentbatch)
* [Retrieve a payment batch file](#getbatchfile)


## <a name="getpaymentbatches"></a>Retrieve the list of payment batches

Retrieves the list of payment batches with an optional requested status.

    GET /expense/paymentbatch/v1.1/batchlist/


### Parameters

Name | Type | Format | Description
-----|------| ------ | --------------
`batchlist`|`string` | | **Required.** The batchlist keyword.
`Status` | `Boolean` |  | The status of the batches. Can be either OPEN or CLOSED.


### Response

Name | Type | Format | Description
-----|------| ------ | --------------
`BatchName`|`string` | | The batch name, as it appears in Payment Manager.
`BatchID`|`string` | | The unique identifier for the batch.
`BatchTotal`|`Decimal` | | The batch total amount.
`Currency`|`string` | | The [3-letter ISO 4217 currency code](http://en.wikipedia.org/wiki/ISO_4217) for the batch.
`Count`|`string` | | The number of payment demands in the batch.
`Type`|`string` | | The payee of the batch. Either Employee or Card Program.
`PaymentMethod`|`string` | | The reimbursement method for the batch. Either Expense Pay by Concur, Company Check (via Accounts Payable), ADP (via EPIP file), or Other Reimbursement Methods.
`Batch-URL`|`string` | | The URL to use as a basis for other actions, such as closing the batch.


## <a name="closepaymentbatch"></a>Close a payment batch

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

    POST /expense/paymentbatch/v1.2/batch/{BatchID}/closed


### Parameters

Name | Type | Format | Description
-----|------| ------ | --------------
`BatchID`|`string` | | **Required.** The unique identifier for the batch.
`close` | `string` |  | **Required.** The close keyword


### Response

Name | Type | Format | Description
-----|------| ------ | --------------
`BatchStatus`|`string` | | The current status of the specified batch.
`File-Url`|`string` | | A URL for retrieving the extract file or files produced when the batch closes, with encrypted ID.
`Status`|`string` | | The status of the request to close the batch.
`JobQueueKey`|`string` | | The unique identifier for the batch job.

### Version
1.1 for GET methods  
1.2 for POST method

## <a name="getbatchfile"></a>Retrieve a payment batch file

Requests the expense transaction data for the specified payment batch.

    GET /expense/paymentbatch/v1.1/batch/_{BatchID}_/file

### Parameters

Name | Type | Format | Description
-----|------| ------ | --------------
`BatchID`|`string` | | **Required.** URI Source: The URI is returned in the Batch-URL element of the Get List of Payment Batches function. Do not use the BatchID value from the Get List of Payment Batches function in the URI, as it contains the unencrypted batch ID.<commit_msg>Moved versions to top to cover all in doc<commit_after>---
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)
* [Close a payment batch](#closepaymentbatch)
* [Retrieve a payment batch file](#getbatchfile)

### Version
1.1 for GET methods  
1.2 for POST method

## <a name="getpaymentbatches"></a>Retrieve the list of payment batches

Retrieves the list of payment batches with an optional requested status.

    GET /expense/paymentbatch/v1.1/batchlist/


### Parameters

Name | Type | Format | Description
-----|------| ------ | --------------
`batchlist`|`string` | | **Required.** The batchlist keyword.
`Status` | `Boolean` |  | The status of the batches. Can be either OPEN or CLOSED.


### Response

Name | Type | Format | Description
-----|------| ------ | --------------
`BatchName`|`string` | | The batch name, as it appears in Payment Manager.
`BatchID`|`string` | | The unique identifier for the batch.
`BatchTotal`|`Decimal` | | The batch total amount.
`Currency`|`string` | | The [3-letter ISO 4217 currency code](http://en.wikipedia.org/wiki/ISO_4217) for the batch.
`Count`|`string` | | The number of payment demands in the batch.
`Type`|`string` | | The payee of the batch. Either Employee or Card Program.
`PaymentMethod`|`string` | | The reimbursement method for the batch. Either Expense Pay by Concur, Company Check (via Accounts Payable), ADP (via EPIP file), or Other Reimbursement Methods.
`Batch-URL`|`string` | | The URL to use as a basis for other actions, such as closing the batch.


## <a name="closepaymentbatch"></a>Close a payment batch

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

    POST /expense/paymentbatch/v1.2/batch/{BatchID}/closed


### Parameters

Name | Type | Format | Description
-----|------| ------ | --------------
`BatchID`|`string` | | **Required.** The unique identifier for the batch.
`close` | `string` |  | **Required.** The close keyword


### Response

Name | Type | Format | Description
-----|------| ------ | --------------
`BatchStatus`|`string` | | The current status of the specified batch.
`File-Url`|`string` | | A URL for retrieving the extract file or files produced when the batch closes, with encrypted ID.
`Status`|`string` | | The status of the request to close the batch.
`JobQueueKey`|`string` | | The unique identifier for the batch job.


## <a name="getbatchfile"></a>Retrieve a payment batch file

Requests the expense transaction data for the specified payment batch.

    GET /expense/paymentbatch/v1.1/batch/_{BatchID}_/file

### Parameters

Name | Type | Format | Description
-----|------| ------ | --------------
`BatchID`|`string` | | **Required.** URI Source: The URI is returned in the Batch-URL element of the Get List of Payment Batches function. Do not use the BatchID value from the Get List of Payment Batches function in the URI, as it contains the unencrypted batch ID.
{'fraction_non_alphanumeric': 0.14517096580683864, 'fraction_numerical': 0.005698860227954409, 'mean_word_length': 3.4608695652173913, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2402046', 'n_tokens_mistral': 1873, 'n_tokens_neox': 1786, 'n_words': 781}