Skip to content
NexumAPI Docs

DealerService⁠

Manage dealer record information.

Operations⁠

getReservePlanSelectFields⁠

POST

Retrieves reserve plans 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/getReservePlanSelectFields
POST /nexum/627/2022.01/dealer/getReservePlanSelectFields 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": {
    "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
    },
    "ReservePlanLoanSelectableFields": {
      "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
      }
    },
    "ReservePlanTrackingSelectableFields": {
      "IncludeAllReservePlanTrackingFields": true,
      "ReservePlanTrackingFields": {
        "CreationDate": true,
        "CreationTime": true,
        "ExpireDate": true,
        "FmLastDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "TrackingCode": true,
        "Type": true,
        "UserAmount1": true,
        "UserAmount10": true,
        "UserAmount11": true,
        "UserAmount12": true,
        "UserAmount13": true,
        "UserAmount14": true,
        "UserAmount15": true,
        "UserAmount16": true,
        "UserAmount17": true,
        "UserAmount18": true
      }
    },
    "ReservePlanTransactionSelectableFields": {
      "IncludeAllReservePlanTransactionFields": true,
      "ReservePlanTransactionFields": {
        "AccountNumber": true,
        "ActionCode": true,
        "ActivityDate": true,
        "AdjustmentCode": true,
        "BalanceChange": true,
        "BatchSequence": true,
        "Branch": true,
        "Comment": true,
        "CommentFlag": true,
        "ConsoleNumber": true,
        "DealerNumber": true,
        "Description": true,
        "EffectiveDate": true,
        "LoanId": true,
        "MemberBranch": true,
        "NewBalance": true,
        "ParticipantType": true,
        "PlanId": true,
        "PostDate": true,
        "PostTime": true
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getReservePlanSelectFieldsFilterChildren⁠

POST

Retrieves reserve plans with selected fields and filtered children.

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/getReservePlanSelectFieldsFilterChildren
POST /nexum/627/2022.01/dealer/getReservePlanSelectFieldsFilterChildren 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": {
    "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
    },
    "ReservePlanLoanSelectableFields": {
      "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
      }
    },
    "ReservePlanTrackingSelectableFields": {
      "IncludeAllReservePlanTrackingFields": true,
      "ReservePlanTrackingFields": {
        "CreationDate": true,
        "CreationTime": true,
        "ExpireDate": true,
        "FmLastDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "TrackingCode": true,
        "Type": true,
        "UserAmount1": true,
        "UserAmount10": true,
        "UserAmount11": true,
        "UserAmount12": true,
        "UserAmount13": true,
        "UserAmount14": true,
        "UserAmount15": true,
        "UserAmount16": true,
        "UserAmount17": true,
        "UserAmount18": true
      }
    },
    "ReservePlanTransactionSelectableFields": {
      "IncludeAllReservePlanTransactionFields": true,
      "ReservePlanTransactionFields": {
        "AccountNumber": true,
        "ActionCode": true,
        "ActivityDate": true,
        "AdjustmentCode": true,
        "BalanceChange": true,
        "BatchSequence": true,
        "Branch": true,
        "Comment": true,
        "CommentFlag": true,
        "ConsoleNumber": true,
        "DealerNumber": true,
        "Description": true,
        "EffectiveDate": true,
        "LoanId": true,
        "MemberBranch": true,
        "NewBalance": true,
        "ParticipantType": true,
        "PlanId": true,
        "PostDate": true,
        "PostTime": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "ReservePlanLoanFilter": {
      "Query": "string"
    },
    "ReservePlanTrackingFilter": {
      "Query": "string"
    },
    "ReservePlanTransactionFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getReservePlanPagedList⁠

POST

Retrieves a paged list of reserve plans.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
DealerNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/dealer/getReservePlanPagedList
POST /nexum/627/2022.01/dealer/getReservePlanPagedList 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"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getReservePlanListSelectFields⁠

POST

Retrieves a list of reserve plans with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
DealerNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/dealer/getReservePlanListSelectFields
POST /nexum/627/2022.01/dealer/getReservePlanListSelectFields 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",
  "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
    },
    "ReservePlanLoanSelectableFields": {
      "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
      }
    },
    "ReservePlanTrackingSelectableFields": {
      "IncludeAllReservePlanTrackingFields": true,
      "ReservePlanTrackingFields": {
        "CreationDate": true,
        "CreationTime": true,
        "ExpireDate": true,
        "FmLastDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "TrackingCode": true,
        "Type": true,
        "UserAmount1": true,
        "UserAmount10": true,
        "UserAmount11": true,
        "UserAmount12": true,
        "UserAmount13": true,
        "UserAmount14": true,
        "UserAmount15": true,
        "UserAmount16": true,
        "UserAmount17": true,
        "UserAmount18": true
      }
    },
    "ReservePlanTransactionSelectableFields": {
      "IncludeAllReservePlanTransactionFields": true,
      "ReservePlanTransactionFields": {
        "AccountNumber": true,
        "ActionCode": true,
        "ActivityDate": true,
        "AdjustmentCode": true,
        "BalanceChange": true,
        "BatchSequence": true,
        "Branch": true,
        "Comment": true,
        "CommentFlag": true,
        "ConsoleNumber": true,
        "DealerNumber": true,
        "Description": true,
        "EffectiveDate": true,
        "LoanId": true,
        "MemberBranch": true,
        "NewBalance": true,
        "ParticipantType": true,
        "PlanId": true,
        "PostDate": true,
        "PostTime": true
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchReservePlanSelectFields⁠

POST

Searches reserve plans with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
DealerNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/dealer/searchReservePlanSelectFields
POST /nexum/627/2022.01/dealer/searchReservePlanSelectFields 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",
  "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
    },
    "ReservePlanLoanSelectableFields": {
      "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
      }
    },
    "ReservePlanTrackingSelectableFields": {
      "IncludeAllReservePlanTrackingFields": true,
      "ReservePlanTrackingFields": {
        "CreationDate": true,
        "CreationTime": true,
        "ExpireDate": true,
        "FmLastDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "TrackingCode": true,
        "Type": true,
        "UserAmount1": true,
        "UserAmount10": true,
        "UserAmount11": true,
        "UserAmount12": true,
        "UserAmount13": true,
        "UserAmount14": true,
        "UserAmount15": true,
        "UserAmount16": true,
        "UserAmount17": true,
        "UserAmount18": true
      }
    },
    "ReservePlanTransactionSelectableFields": {
      "IncludeAllReservePlanTransactionFields": true,
      "ReservePlanTransactionFields": {
        "AccountNumber": true,
        "ActionCode": true,
        "ActivityDate": true,
        "AdjustmentCode": true,
        "BalanceChange": true,
        "BatchSequence": true,
        "Branch": true,
        "Comment": true,
        "CommentFlag": true,
        "ConsoleNumber": true,
        "DealerNumber": true,
        "Description": true,
        "EffectiveDate": true,
        "LoanId": true,
        "MemberBranch": true,
        "NewBalance": true,
        "ParticipantType": true,
        "PlanId": true,
        "PostDate": true,
        "PostTime": true
      }
    }
  },
  "SearchFilter": {
    "Query": "string",
    "ReservePlanChildrenFilter": {
      "ReservePlanLoanFilter": {
        "Query": "string"
      },
      "ReservePlanTrackingFilter": {
        "Query": "string"
      },
      "ReservePlanTransactionFilter": {
        "Query": "string"
      }
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getReservePlanPagedListSelectFields⁠

POST

Retrieves a paged list of reserve plans with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
DealerNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/dealer/getReservePlanPagedListSelectFields
POST /nexum/627/2022.01/dealer/getReservePlanPagedListSelectFields 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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}