ExternalLoan⁠

Browse the ExternalLoan operations available through the SymXchange AccountService.

Operations⁠

createExternalLoan⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

ExternalLoanLocatorintegeroptional

POST/nexum/{sym}/persistent/account/createExternalLoan

POST /nexum/627/persistent/account/createExternalLoan HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanFields": {
    "AccountNumber": "0000000000",
    "Type": 0,
    "Status": 0,
    "Description": "string",
    "CreditLimit": 0,
    "PaymentDue": 0,
    "DueDate": "2026-01-01"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createExternalLoanName⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

ExternalLoanNameLocatorintegeroptional

POST/nexum/{sym}/persistent/account/createExternalLoanName

POST /nexum/627/persistent/account/createExternalLoanName HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanNameFields": {
    "First": "string",
    "Last": "string",
    "Type": 0,
    "Ssn": "0",
    "Street": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "0"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createExternalLoanNote⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

ExternalLoanNoteLocatorintegeroptional

POST/nexum/{sym}/persistent/account/createExternalLoanNote

POST /nexum/627/persistent/account/createExternalLoanNote HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanNoteFields": {
    "Code": 0,
    "Text": [
      {
        "EntryId": 0,
        "Text": "string"
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createExternalLoanTracking⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

ExternalLoanTrackingLocatorintegeroptional

POST/nexum/{sym}/persistent/account/createExternalLoanTracking

POST /nexum/627/persistent/account/createExternalLoanTracking HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanTrackingFields": {
    "Type": 0,
    "TrackingCode": 0,
    "UserChar1": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createExternalLoanTransfer⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

ExternalLoanTransferLocatorintegeroptional

POST/nexum/{sym}/persistent/account/createExternalLoanTransfer

POST /nexum/627/persistent/account/createExternalLoanTransfer HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanTransferFields": {
    "Type": 0,
    "AccountNumber": "0000000000",
    "Id": "0",
    "IdType": 0,
    "Amount": 0,
    "Frequency": 0,
    "Day1": 0,
    "EffectiveDate": "2026-01-01"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteExternalLoan⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.

POST/nexum/{sym}/persistent/account/deleteExternalLoan

POST /nexum/627/persistent/account/deleteExternalLoan HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteExternalLoanName⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanNameLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.

POST/nexum/{sym}/persistent/account/deleteExternalLoanName

POST /nexum/627/persistent/account/deleteExternalLoanName HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanNameLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteExternalLoanNote⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanNoteLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.

POST/nexum/{sym}/persistent/account/deleteExternalLoanNote

POST /nexum/627/persistent/account/deleteExternalLoanNote HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanNoteLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteExternalLoanTracking⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanTrackingLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.

POST/nexum/{sym}/persistent/account/deleteExternalLoanTracking

POST /nexum/627/persistent/account/deleteExternalLoanTracking HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanTrackingLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteExternalLoanTransfer⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanTransferLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.

POST/nexum/{sym}/persistent/account/deleteExternalLoanTransfer

POST /nexum/627/persistent/account/deleteExternalLoanTransfer HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanTransferLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getExternalLoanSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/getExternalLoanSelectFields

POST /nexum/627/persistent/account/getExternalLoanSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "SelectableFields": {
    "IncludeAllExternalLoanFields": false,
    "ExternalLoanFields": {
      "Locator": true,
      "AccountNumber": true,
      "Type": true,
      "Balance": true,
      "Description": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getExternalLoanSelectFieldsFilterChildren⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/getExternalLoanSelectFieldsFilterChildren

POST /nexum/627/persistent/account/getExternalLoanSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "SelectableFields": {
    "ExternalLoanFields": {
      "Locator": true,
      "AccountNumber": true,
      "Description": true,
      "Type": true,
      "Status": true
    },
    "ExternalLoanNameSelectableFields": {
      "IncludeAllExternalLoanNameFields": true
    },
    "ExternalLoanNoteSelectableFields": {
      "IncludeAllExternalLoanNoteFields": true
    },
    "ExternalLoanTrackingSelectableFields": {
      "IncludeAllExternalLoanTrackingFields": true
    },
    "ExternalLoanTransferSelectableFields": {
      "IncludeAllExternalLoanTransferFields": true
    }
  },
  "ChildrenSearchFilter": {
    "ExternalLoanNameFilter": {
      "Query": "string"
    },
    "ExternalLoanNoteFilter": {
      "Query": "string"
    },
    "ExternalLoanTrackingFilter": {
      "Query": "string"
    },
    "ExternalLoanTransferFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getExternalLoanPagedListSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/getExternalLoanPagedListSelectFields

POST /nexum/627/persistent/account/getExternalLoanPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllExternalLoanFields": false,
    "ExternalLoanFields": {
      "AccountNumber": true,
      "Locator": true,
      "Type": true,
      "Description": true,
      "Balance": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getExternalLoanNameSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanNameLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/getExternalLoanNameSelectFields

POST /nexum/627/persistent/account/getExternalLoanNameSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "ExternalLoanNameLocator": 0,
  "SelectableFields": {
    "IncludeAllExternalLoanNameFields": true,
    "ExternalLoanNameFields": {
      "ActiveDuty": true,
      "ActiveDutySeparationDate": true,
      "ActiveDutyStartDate": true,
      "ActiveDutyVerificationDate": true,
      "AddrCreateDate": true,
      "AddrDisconnectDate": true,
      "AddrExpDate": true,
      "AddrFmLastDate": true,
      "AddrFmLastPurgeDate": true,
      "AddrRecordChangeDate": true,
      "AddressType": true,
      "AltEmail": true,
      "BeneficialOwner": true,
      "BeneficialPercent": true,
      "BeneficiaryPercent": true,
      "BirthDate": true,
      "CarrierRoute": true,
      "Chapter4StatusCode": true,
      "City": true,
      "Confidential": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExternalLoanNamePagedListSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/getExternalLoanNamePagedListSelectFields

POST /nexum/627/persistent/account/getExternalLoanNamePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllExternalLoanNameFields": true,
    "ExternalLoanNameFields": {
      "ActiveDuty": true,
      "ActiveDutySeparationDate": true,
      "ActiveDutyStartDate": true,
      "ActiveDutyVerificationDate": true,
      "AddrCreateDate": true,
      "AddrDisconnectDate": true,
      "AddrExpDate": true,
      "AddrFmLastDate": true,
      "AddrFmLastPurgeDate": true,
      "AddrRecordChangeDate": true,
      "AddressType": true,
      "AltEmail": true,
      "BeneficialOwner": true,
      "BeneficialPercent": true,
      "BeneficiaryPercent": true,
      "BirthDate": true,
      "CarrierRoute": true,
      "Chapter4StatusCode": true,
      "City": true,
      "Confidential": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExternalLoanNoteSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanNoteLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/getExternalLoanNoteSelectFields

POST /nexum/627/persistent/account/getExternalLoanNoteSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "ExternalLoanNoteLocator": 0,
  "SelectableFields": {
    "IncludeAllExternalLoanNoteFields": true,
    "ExternalLoanNoteFields": {
      "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExternalLoanNotePagedListSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/getExternalLoanNotePagedListSelectFields

POST /nexum/627/persistent/account/getExternalLoanNotePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllExternalLoanNoteFields": true,
    "ExternalLoanNoteFields": {
      "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
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExternalLoanTrackingSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanTrackingLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/getExternalLoanTrackingSelectFields

POST /nexum/627/persistent/account/getExternalLoanTrackingSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "ExternalLoanTrackingLocator": 0,
  "SelectableFields": {
    "IncludeAllExternalLoanTrackingFields": true,
    "ExternalLoanTrackingFields": {
      "CreationDate": true,
      "CreationTime": true,
      "ExpireDate": true,
      "FmLastDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "NrtExternalStatus": true,
      "NrtInternalStatus": true,
      "RecordChangeDate": true,
      "TrackingCode": true,
      "Type": true,
      "UserAmount1": true,
      "UserAmount10": true,
      "UserAmount11": true,
      "UserAmount12": true,
      "UserAmount13": true,
      "UserAmount14": true,
      "UserAmount15": true,
      "UserAmount16": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExternalLoanTrackingPagedListSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/getExternalLoanTrackingPagedListSelectFields

POST /nexum/627/persistent/account/getExternalLoanTrackingPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllExternalLoanTrackingFields": true,
    "ExternalLoanTrackingFields": {
      "CreationDate": true,
      "CreationTime": true,
      "ExpireDate": true,
      "FmLastDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "NrtExternalStatus": true,
      "NrtInternalStatus": true,
      "RecordChangeDate": true,
      "TrackingCode": true,
      "Type": true,
      "UserAmount1": true,
      "UserAmount10": true,
      "UserAmount11": true,
      "UserAmount12": true,
      "UserAmount13": true,
      "UserAmount14": true,
      "UserAmount15": true,
      "UserAmount16": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExternalLoanTransferSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanTransferLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/getExternalLoanTransferSelectFields

POST /nexum/627/persistent/account/getExternalLoanTransferSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "ExternalLoanTransferLocator": 0,
  "SelectableFields": {
    "IncludeAllExternalLoanTransferFields": true,
    "ExternalLoanTransferFields": {
      "AccountNumber": true,
      "Amount": true,
      "AmountOption": true,
      "Day1": true,
      "Day2": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "ExtLoanAccount": true,
      "Frequency": true,
      "Id": true,
      "IdType": true,
      "LastDate": true,
      "Locator": true,
      "MaturityCheck": true,
      "MaximumBalance": true,
      "MinimumBalance": true,
      "NextDate": true,
      "PaymentType": true,
      "Percent": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getExternalLoanTransferPagedListSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/getExternalLoanTransferPagedListSelectFields

POST /nexum/627/persistent/account/getExternalLoanTransferPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllExternalLoanTransferFields": true,
    "ExternalLoanTransferFields": {
      "AccountNumber": true,
      "Amount": true,
      "AmountOption": true,
      "Day1": true,
      "Day2": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "ExtLoanAccount": true,
      "Frequency": true,
      "Id": true,
      "IdType": true,
      "LastDate": true,
      "Locator": true,
      "MaturityCheck": true,
      "MaximumBalance": true,
      "MinimumBalance": true,
      "NextDate": true,
      "PaymentType": true,
      "Percent": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchExternalLoanPagedSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/searchExternalLoanPagedSelectFields

POST /nexum/627/persistent/account/searchExternalLoanPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllExternalLoanFields": false,
    "ExternalLoanFields": {
      "AccountNumber": true,
      "Locator": true,
      "Type": true,
      "Description": true,
      "Balance": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchExternalLoanNamePagedSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/searchExternalLoanNamePagedSelectFields

POST /nexum/627/persistent/account/searchExternalLoanNamePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllExternalLoanNameFields": true,
    "ExternalLoanNameFields": {
      "ActiveDuty": true,
      "ActiveDutySeparationDate": true,
      "ActiveDutyStartDate": true,
      "ActiveDutyVerificationDate": true,
      "AddrCreateDate": true,
      "AddrDisconnectDate": true,
      "AddrExpDate": true,
      "AddrFmLastDate": true,
      "AddrFmLastPurgeDate": true,
      "AddrRecordChangeDate": true,
      "AddressType": true,
      "AltEmail": true,
      "BeneficialOwner": true,
      "BeneficialPercent": true,
      "BeneficiaryPercent": true,
      "BirthDate": true,
      "CarrierRoute": true,
      "Chapter4StatusCode": true,
      "City": true,
      "Confidential": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchExternalLoanNotePagedSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/searchExternalLoanNotePagedSelectFields

POST /nexum/627/persistent/account/searchExternalLoanNotePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllExternalLoanNoteFields": true,
    "ExternalLoanNoteFields": {
      "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
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchExternalLoanTrackingPagedSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/searchExternalLoanTrackingPagedSelectFields

POST /nexum/627/persistent/account/searchExternalLoanTrackingPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllExternalLoanTrackingFields": true,
    "ExternalLoanTrackingFields": {
      "CreationDate": true,
      "CreationTime": true,
      "ExpireDate": true,
      "FmLastDate": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "NrtExternalStatus": true,
      "NrtInternalStatus": true,
      "RecordChangeDate": true,
      "TrackingCode": true,
      "Type": true,
      "UserAmount1": true,
      "UserAmount10": true,
      "UserAmount11": true,
      "UserAmount12": true,
      "UserAmount13": true,
      "UserAmount14": true,
      "UserAmount15": true,
      "UserAmount16": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchExternalLoanTransferPagedSelectFields⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

POST/nexum/{sym}/persistent/account/searchExternalLoanTransferPagedSelectFields

POST /nexum/627/persistent/account/searchExternalLoanTransferPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "string",
  "ExternalLoanLocator": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllExternalLoanTransferFields": true,
    "ExternalLoanTransferFields": {
      "AccountNumber": true,
      "Amount": true,
      "AmountOption": true,
      "Day1": true,
      "Day2": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "ExtLoanAccount": true,
      "Frequency": true,
      "Id": true,
      "IdType": true,
      "LastDate": true,
      "Locator": true,
      "MaturityCheck": true,
      "MaximumBalance": true,
      "MinimumBalance": true,
      "NextDate": true,
      "PaymentType": true,
      "Percent": true,
      "RecordChangeDate": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateExternalLoanByID⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/updateExternalLoanByID

POST /nexum/627/persistent/account/updateExternalLoanByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanFields": {
    "Description": "string",
    "Status": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateExternalLoanNameByID⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanNameLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/updateExternalLoanNameByID

POST /nexum/627/persistent/account/updateExternalLoanNameByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanNameLocator": 0,
  "ExternalLoanNameFields": {
    "First": "string",
    "UserChar1": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateExternalLoanNoteByID⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanNoteLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/updateExternalLoanNoteByID

POST /nexum/627/persistent/account/updateExternalLoanNoteByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanNoteLocator": 0,
  "ExternalLoanNoteFields": {
    "Text": [
      {
        "EntryId": 0,
        "Text": "string"
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateExternalLoanTrackingByID⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanTrackingLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/updateExternalLoanTrackingByID

POST /nexum/627/persistent/account/updateExternalLoanTrackingByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanTrackingLocator": 0,
  "ExternalLoanTrackingFields": {
    "UserChar1": "string",
    "TrackingCode": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateExternalLoanTransferByID⁠

POST

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

AccountNumberstringoptional

ExternalLoanLocatorintegeroptional

ExternalLoanTransferLocatorintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

POST/nexum/{sym}/persistent/account/updateExternalLoanTransferByID

POST /nexum/627/persistent/account/updateExternalLoanTransferByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "ExternalLoanLocator": 0,
  "ExternalLoanTransferLocator": 0,
  "ExternalLoanTransferFields": {
    "PaymentType": 0,
    "RegE": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}