GET /ediBilling/retrieveRecords
Allows a partner to retrieve a List of EdiBatch objects for a single batch number, a range of batch numbers, or a range of dates.
Roles that can access this endpoint are Users, Fusion Partners.
Parameters
name |
description |
type |
default |
type |
partnerId |
string indicating which partner's data should be retrieved |
query
|
|
String
|
altPartnerId |
string indicating which partner's data should be retrieved |
query
|
|
String
|
version |
string indicating the version of the data to be retrieved |
query
|
|
String
|
transactionSet |
string indicating the type of transaction set to be retrieved |
query
|
|
String
|
batch |
integer indicating a single batch number to be retrieved |
query
|
|
int
|
beginBatch |
integer indicating the beginning of the batch number range (both begin and end batch numbers must be specified if a range is desired) |
query
|
|
int
|
endBatch |
integer indicating the end of the batch number range (both begin and end batch numbers must be specified if a range is desired) |
query
|
|
int
|
beginDate |
date/time indicating the beginning of the date range (both begin and end dates must be specified if a date range is desired) |
query
|
|
Date
|
endDate |
date/time indicating the beginning of the date range (both begin and end dates must be specified if a date range is desired) |
query
|
|
Date
|
Result
Object
of type:
application/xml
application/json
a list of EdiBatch objects
Child Elements:
RowEdiStop
These elements represent the stops associated with the invoice.
Each element contains a __name
attribute with the value stops
.
RowOtherCharge
These elements represent the other charges associated with the invoice.
Each element contains a __name
attribute with the value otherCharges
.
Try It Out
Request