Payment Batch GET
Use the Payment Batch GET method to acquire a collection of payment batches based on a status of either OPEN or CLOSED. This feature is a non-destructive lookup that returns a collection of payment batches and their corresponding fields.
| HTTP Method: | GET |
| Content Type: | N/A |
| Request Header: | REQUIRED |
Authorization: OAuth {access_token} |
| Request Body |
All parameters are URI based |
| PARAMETERS |
NAME | DESCRIPTION | DATA TYPE | PARAMETER TYPE | REQUIRED |
|
STATUS | The status of the batches. Can be either OPEN or CLOSED. | URI | STRING | False |
|
|
| Content Type: | application/xml |
| Response Body |
will include the following elements: |
| PARAMETERS |
NAME | DESCRIPTION | DATA TYPE | PARAMETER TYPE | REQUIRED |
|
BATCHID | The unique identifier for the batch. | CONTENT | STRING | True |
BATCHNAMEID | The batch name, as it appears in Payment Manager. | CONTENT | STRING | True |
BATCHSUMMARY | the collection of results | CONTENT | ARRAY[] | True |
BATCHTOTAL | The batch total amount. | CONTENT | STRING | True |
BATCH-URL | The URL to use as a basis for other actions, such as closing the batch. | CONTENT | STRING | True |
COUNT | The number of payment demands in the batch. | CONTENT | STRING | True |
CURRENCY | The 3-letter ISO 4217 currency code for the batch. | CONTENT | STRING | True |
PAYMENTMETHOD | The reimbursement method for the batch. Either Expense Pay by Concur, Company Check (via Accounts Payable), ADP (via EPIP file), or Other Reimbursement Methods. | CONTENT | STRING | True |
TYPE | The payee of the batch. Either Employee or Card Program. | CONTENT | STRING | True |
|
|
Payment Batch GET{id}
Use the Payment Batch File GET {id} method to acquire the batch file of a closed payment batch. This feature is a non-destructive lookup that returns a file containing the information for a closed payment batch.
| HTTP Method: | GET |
| Content Type: | N/A |
| Request Header: | REQUIRED |
Authorization: OAuth {access_token} |
| Request Body |
All parameters are URI based |
| PARAMETERS |
NAME | DESCRIPTION | DATA TYPE | PARAMETER TYPE | REQUIRED |
|
BATCHID | 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. | URI | STRING | True |
|
|
| Content Type: | application/xml |
| Response Body |
will include the following elements: |
| PARAMETERS |
NAME | DESCRIPTION | DATA TYPE | PARAMETER TYPE | REQUIRED |
|
FILECONTENTS | 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. | CONTENT | STRING | True |
|
|
Payment Batch POST
Use the Payment Batch POST method to close a payment batch and ready it for extraction. This feature is a destructive action that alters data in the Concur environment. Your customized process will need to acquire the Batch-URL from the GET request and use it to POST the close action.
| HTTP Method: | POST |
| Content Type: | application/xml |
| Request Header: | REQUIRED |
Authorization: OAuth {access_token} |
| Request Body |
Available parameters: |
| PARAMETERS |
NAME | DESCRIPTION | DATA TYPE | PARAMETER TYPE | REQUIRED |
|
BATCHID | 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. | URI | STRING | True |
|
|
| Content Type: | application/xml |
| Response Body |
will include the following elements: |
| PARAMETERS |
NAME | DESCRIPTION | DATA TYPE | PARAMETER TYPE | REQUIRED |
|
BATCHSTATUS | The current status of the specified batch. | CONTENT | STRING | True |
FILE-URL | A URL for retrieving the extract file or files produced when the batch closes, with encrypted ID. | CONTENT | STRING | True |
JOBQUEUEKEY | The unique identifier for the batch job. | CONTENT | STRING | True |
STATUS | The status of the request to close the batch. | CONTENT | STRING | True |
|
|
Request Header
The Request Header is a required part of the API call and must contain a valid OAuth Token acquired from Concur (please refer to the Authentication section of the site for more detail on how to request an Access Token).
Errors/Error Handling
When doing a GET, POST, PUT, or DELETE via the Concur Web Services there are several different error codes you may encounter. These include your basic HTTP errors codes such as 400, 500, or 403 but are not limited to just the HTTP codes.
Working with Web Services
After a Web Service administrator for your organization has been setup use the Client API Construct page to generate a Token, Destroy a Token, and even construct different API calls before you program them.
|