DealerService⁠

Manage dealer record information.

Operations⁠

searchReservePlanPagedSelectFields⁠

POST

Searches reserve plans with pagination and selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

DealerNumberstringoptional

Querystringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/dealer/searchReservePlanPagedSelectFields

POST /nexum/627/2022.01/dealer/searchReservePlanPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DealerNumber": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllReservePlanFields": true,
    "ReservePlanFields": {
      "Active": true,
      "Balance": true,
      "ChargeOffBalance": true,
      "ChargeOffDays": true,
      "ChargeOffLoanCount": true,
      "ChargeOffPmts": true,
      "ChargebackBalance": true,
      "ChargebackCoOption": true,
      "ChargebackPoOption": true,
      "CloseDate": true,
      "Description": true,
      "EarlyPayoffDays": true,
      "EarlyPayoffPmts": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "HoldbackAmount": true,
      "HoldbackBalance": true,
      "HoldbackBalanceLS": true,
      "HoldbackPercent": true,
      "Id": true
    }
  },
  "Query": "string",
  "nxAttributes": {
    "customFields": {}
  }
}

getReservePlanLoan⁠

POST

Retrieves reserve plan loans.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

DealerNumberstringoptional

ReservePlanIdstringoptional

ReservePlanLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/dealer/getReservePlanLoan

POST /nexum/627/2022.01/dealer/getReservePlanLoan HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DealerNumber": "string",
  "ReservePlanId": "string",
  "ReservePlanLoanLocator": 0,
  "nxAttributes": {
    "customFields": {}
  }
}

getReservePlanLoanSelectFields⁠

POST

Retrieves reserve plan loans with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

DealerNumberstringoptional

ReservePlanIdstringoptional

ReservePlanLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/dealer/getReservePlanLoanSelectFields

POST /nexum/627/2022.01/dealer/getReservePlanLoanSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DealerNumber": "string",
  "ReservePlanId": "string",
  "ReservePlanLoanLocator": 0,
  "SelectableFields": {
    "IncludeAllReservePlanLoanFields": true,
    "ReservePlanLoanFields": {
      "AccountNumber": true,
      "AmortizedReserve": true,
      "BuyRate": true,
      "Chargeback": true,
      "CloseDate": true,
      "ContractRate": true,
      "DealerNumber": true,
      "EarnedReserve": true,
      "EffectiveRate": true,
      "LastFmDate": true,
      "LoanAmount": true,
      "LoanId": true,
      "Locator": true,
      "MemberFee": true,
      "Name": true,
      "OpenDate": true,
      "OriginalLoanDate": true,
      "PlanDescription": true,
      "PlanId": true,
      "PlanType": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getReservePlanLoanPagedList⁠

POST

Retrieves a paged list of reserve plan loans.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

DealerNumberstringoptional

ReservePlanIdstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/2022.01/dealer/getReservePlanLoanPagedList

POST /nexum/627/2022.01/dealer/getReservePlanLoanPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DealerNumber": "string",
  "ReservePlanId": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getReservePlanLoanListSelectFields⁠

POST

Retrieves a list of reserve plan loans with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

DealerNumberstringoptional

ReservePlanIdstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/dealer/getReservePlanLoanListSelectFields

POST /nexum/627/2022.01/dealer/getReservePlanLoanListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DealerNumber": "string",
  "ReservePlanId": "string",
  "SelectableFields": {
    "IncludeAllReservePlanLoanFields": true,
    "ReservePlanLoanFields": {
      "AccountNumber": true,
      "AmortizedReserve": true,
      "BuyRate": true,
      "Chargeback": true,
      "CloseDate": true,
      "ContractRate": true,
      "DealerNumber": true,
      "EarnedReserve": true,
      "EffectiveRate": true,
      "LastFmDate": true,
      "LoanAmount": true,
      "LoanId": true,
      "Locator": true,
      "MemberFee": true,
      "Name": true,
      "OpenDate": true,
      "OriginalLoanDate": true,
      "PlanDescription": true,
      "PlanId": true,
      "PlanType": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchReservePlanLoanSelectFields⁠

POST

Searches reserve plan loans with selected fields.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

DealerNumberstringoptional

ReservePlanIdstringoptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/2022.01/dealer/searchReservePlanLoanSelectFields

POST /nexum/627/2022.01/dealer/searchReservePlanLoanSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DealerNumber": "string",
  "ReservePlanId": "string",
  "SelectableFields": {
    "IncludeAllReservePlanLoanFields": true,
    "ReservePlanLoanFields": {
      "AccountNumber": true,
      "AmortizedReserve": true,
      "BuyRate": true,
      "Chargeback": true,
      "CloseDate": true,
      "ContractRate": true,
      "DealerNumber": true,
      "EarnedReserve": true,
      "EffectiveRate": true,
      "LastFmDate": true,
      "LoanAmount": true,
      "LoanId": true,
      "Locator": true,
      "MemberFee": true,
      "Name": true,
      "OpenDate": true,
      "OriginalLoanDate": true,
      "PlanDescription": true,
      "PlanId": true,
      "PlanType": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}