MSP Credit Sessions
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
This API provides an admin-only Credit Session facility. A Credit Session is used to correct a previously created MSP Session object. This can happen when third-party providers send manual corrections to Road.
POST/1/credit-sessions/search
Search Credit Session
Authorization
User sessionAPI credentialPermissions
credit-sessions:readOAuth
-
Request
Request bodyapplication/json
accountIdstring
filenamestring
default
credit-sessions.csvformatstring
default
jsonfromstring <date-time>
idstring
idsstring[]
limitnumber
default
50monthnumber
searchIdstring
searchPhrasestring
skipnumber
default
0sortobjectdefault {"field":"createdAt","order":"desc"}
sortobject
default
{"field":"createdAt","order":"desc"}fieldstringREQUIRED
orderstringREQUIRED
ascdesctostring <date-time>
useNegativeKwhboolean
yearnumber
Responses
200OK application/json
dataCreditSessionResource[]REQUIRED
dataCreditSessionResource[]REQUIRED
accountIdstringREQUIRED
correctionTypestringREQUIRED
createdAtstringREQUIRED
currencystringREQUIRED
deletedbooleanREQUIRED
deletedAtstring
externalUniqueIdstringREQUIRED
idstringREQUIRED
newAmountnumberREQUIRED
pastAmountnumberREQUIRED
providerIdstringREQUIRED
sessionEndedAtstringREQUIRED
sessionIdstringREQUIRED
sessionKwhnumberREQUIRED
totalAmountnumberREQUIRED
updatedAtstringREQUIRED
metaobjectREQUIRED
metaobjectREQUIRED
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED