Skip to content
mediation-files/
Retrieve page of mediatio...

Elevate Mediation API (1.0)

File mediation management

Provides read access to mediation file entities

Definitions

  • Mediation File - a representation of a mediation file loaded into the Elevate billing system
Download OpenAPI description
billing-rest-mediation.json
billing-rest-mediation.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

mediation-files

A representation of a mediation file that Elevate loads and processes

Operations

Retrieve page of mediation files loaded into Elevate

Request

The call is restricted to a max of one month's worth of data and/or the first 100 entries retrieved. Use proper pagination to obtain the required data

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
fileNamestring

Filter by fileName

fileTypestring

Filter by fileType

supplierIdinteger

Filter by supplierId

statusstring(MediationFileStatus)

Filter by status (ERROR, SUCCESS, PENDING)

Enum"NEW""TO_BE_PROCESSED""DELETED""BEING_PROCESSED""ERROR""PENDING_DELETE""PENDING_REPROCESS""PROCESSING_DECOMPRESS""SUCCESS""DUPLICATE"
dateLoadedstring(DateTimeFilterParam)

Filter by dateLoaded

Example: dateLoaded=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
dateDetectedFromstring(DateTimeFilterParam)required

Filter by dateDetected from date/time (inclusive)

Example: dateDetectedFrom=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
dateDetectedTostring(DateTimeFilterParam)required

Filter by dateDetected to date/time (exclusive)

Example: dateDetectedTo=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/mediation-files?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&fileName=string&fileType=string&supplierId=0&status=NEW&dateLoaded=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&dateDetectedFrom=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&dateDetectedTo=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Mediation file identifier

Example: 1
fileNamestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Mediation file name

Example: "ABCD_9640856_ABCDEF_010821_000000.DAT"
compressedFileNamestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

If the file originated in a compressed file then this is the name of that file

Example: "ABCD_9640856_ABCDEF_010821_000000.DAT.pgp"
fileTypestring[ 0 .. 50 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...required

Mediation file type

Example: "SupplierA SSBS"
supplierIdinteger(int64)required

Mediation supplier id

Example: 1
statusstring(MediationFileStatus)required

Mediation file status

Enum"NEW""TO_BE_PROCESSED""DELETED""BEING_PROCESSED""ERROR""PENDING_DELETE""PENDING_REPROCESS""PROCESSING_DECOMPRESS""SUCCESS""DUPLICATE"
dateDetectedstring(date-time)read-onlyrequired

When the mediation file was first detected

dateLoadedstring(date-time)read-only

When the mediation file was loaded

totalRecordsinteger(int64)

Number of records in the mediation file

Example: 1000
ignoredRecordsinteger(int64)

Number of records ignored in the mediation file

Example: 3
]
Response
application/json
[
  {
    "id": 1,
    "fileName": "ABCD_9640856_ABCDEF_010821_000000.DAT",
    "compressedFileName": "ABCD_9640856_ABCDEF_010821_000000.DAT.pgp",
    "fileType": "SupplierA SSBS",
    "supplierId": 1,
    "status": "NEW",
    "dateDetected": "2019-08-24T14:15:22Z",
    "dateLoaded": "2019-08-24T14:15:22Z",
    "totalRecords": 1000,
    "ignoredRecords": 3
  }
]