Skip to content
NexumAPI Docs

DealerService⁠

Manage dealer record information.

Operations⁠

getDealer⁠

POST

Retrieves dealer information.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

getDealerSelectFields⁠

POST

Retrieves dealers 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/getDealerSelectFields
POST /nexum/627/2022.01/dealer/getDealerSelectFields 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": {
    "IncludeAllDealerFields": true,
    "DealerFields": {
      "AchTranCodeOut": true,
      "Active": true,
      "AdjLS": true,
      "Balance": true,
      "BeginningBalLS": true,
      "Branch": true,
      "Buckets": [
        0
      ],
      "ChargeOffBalance": true,
      "ChargebackBalance": true,
      "ChargebackLS": true,
      "ChgOffLoanCount": true,
      "CloseDate": true,
      "DealerAvailBalance": true,
      "DealerTotalBalance": true,
      "FeesLS": true,
      "FmLastPurgeDate": true,
      "HoldbackLS": true,
      "LastDisbursalDate": true,
      "LastFmDate": true,
      "LastPurgeDate": true
    },
    "DealerCommentSelectableFields": {
      "IncludeAllDealerCommentFields": true,
      "DealerCommentFields": {
        "Comment": true,
        "EffectiveDate": true,
        "ExpirationDate": true,
        "Locator": true,
        "RecordChangeDate": true,
        "Type": true
      }
    },
    "DealerFmHistorySelectableFields": {
      "IncludeAllDealerFmHistoryFields": true,
      "DealerFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldName": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true
      }
    },
    "DealerNoteSelectableFields": {
      "IncludeAllDealerNoteFields": true,
      "DealerNoteFields": {
        "Code": true,
        "EnterDate": true,
        "EnterTime": true,
        "ExpirationDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "Text": [
          0
        ],
        "TextLineCount": true,
        "UserId": true,
        "VoidFlag": true,
        "VoidedBy": true
      }
    },
    "DealerTrackingSelectableFields": {
      "IncludeAllDealerTrackingFields": true,
      "DealerTrackingFields": {
        "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
      }
    },
    "ReservePlanSelectableFields": {
      "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
        }
      },
      "ReservePlanTransactionSelectableFields": null
    }
  },
  "nxAttributes": null
}

getDealerSelectFieldsFilterChildren⁠

POST

Retrieves dealers 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
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/dealer/getDealerSelectFieldsFilterChildren
POST /nexum/627/2022.01/dealer/getDealerSelectFieldsFilterChildren 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": {
    "IncludeAllDealerFields": true,
    "DealerFields": {
      "AchTranCodeOut": true,
      "Active": true,
      "AdjLS": true,
      "Balance": true,
      "BeginningBalLS": true,
      "Branch": true,
      "Buckets": [
        0
      ],
      "ChargeOffBalance": true,
      "ChargebackBalance": true,
      "ChargebackLS": true,
      "ChgOffLoanCount": true,
      "CloseDate": true,
      "DealerAvailBalance": true,
      "DealerTotalBalance": true,
      "FeesLS": true,
      "FmLastPurgeDate": true,
      "HoldbackLS": true,
      "LastDisbursalDate": true,
      "LastFmDate": true,
      "LastPurgeDate": true
    },
    "DealerCommentSelectableFields": {
      "IncludeAllDealerCommentFields": true,
      "DealerCommentFields": {
        "Comment": true,
        "EffectiveDate": true,
        "ExpirationDate": true,
        "Locator": true,
        "RecordChangeDate": true,
        "Type": true
      }
    },
    "DealerFmHistorySelectableFields": {
      "IncludeAllDealerFmHistoryFields": true,
      "DealerFmHistoryFields": {
        "AccountNumber": true,
        "BatchSequence": true,
        "Branch": true,
        "ConfirmationSeq": true,
        "ConsoleNumber": true,
        "DataType": true,
        "FieldName": true,
        "FieldNumber": true,
        "FmType": true,
        "Id": true,
        "IdType": true,
        "LastFmDate": true,
        "NewCharacter": true,
        "NewDate": true,
        "NewMoney": true,
        "NewNumber": true,
        "NewRate": true,
        "OldCharacter": true,
        "OldDate": true,
        "OldMoney": true
      }
    },
    "DealerNoteSelectableFields": {
      "IncludeAllDealerNoteFields": true,
      "DealerNoteFields": {
        "Code": true,
        "EnterDate": true,
        "EnterTime": true,
        "ExpirationDate": true,
        "Id": true,
        "IdType": true,
        "Locator": true,
        "RecordChangeDate": true,
        "Text": [
          0
        ],
        "TextLineCount": true,
        "UserId": true,
        "VoidFlag": true,
        "VoidedBy": true
      }
    },
    "DealerTrackingSelectableFields": {
      "IncludeAllDealerTrackingFields": true,
      "DealerTrackingFields": {
        "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
      }
    },
    "ReservePlanSelectableFields": {
      "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
        }
      },
      "ReservePlanTransactionSelectableFields": null
    }
  },
  "ChildrenSearchFilter": null,
  "nxAttributes": null
}

getDealerComment⁠

POST

Retrieves dealer comments.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

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

getDealerCommentSelectFields⁠

POST

Retrieves dealer comments with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
DealerNumberstringoptional
DealerCommentLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/dealer/getDealerCommentSelectFields
POST /nexum/627/2022.01/dealer/getDealerCommentSelectFields 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",
  "DealerCommentLocator": 0,
  "SelectableFields": {
    "IncludeAllDealerCommentFields": true,
    "DealerCommentFields": {
      "Comment": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "Locator": true,
      "RecordChangeDate": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getDealerCommentPagedList⁠

POST

Retrieves a paged list of dealer comments.

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/getDealerCommentPagedList
POST /nexum/627/2022.01/dealer/getDealerCommentPagedList 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": {}
  }
}