EscrowType

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getEscrowType

post

Retrieve escrow type data.

Authorizations
Body
EscrowTypeEscrowTypeintegerRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getEscrowType HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "EscrowTypeEscrowType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "EscrowType": {
    "AdjustPaymentPortion": true,
    "CrEscDividendinPayoff": true,
    "DaysinAdvancetoPrintRpt": 1,
    "DefinedCode": 1,
    "Description": "text",
    "IncludeEscrowBalinPayoff": 1,
    "IncludeinEscrowAnalysis": true,
    "InvoiceType": 1,
    "NumberofCushionMonths": 1,
    "PaymentType": 1,
    "StatementDescription": "text",
    "TransactionDescription": "text",
    "EscrowType": 1
  }
}

getEscrowTypeSelectFields

post

Retrieve select fields for escrow type data.

Authorizations
Body
EscrowTypeEscrowTypeintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getEscrowTypeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 557

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "EscrowTypeEscrowType": 1,
  "SelectableFields": {
    "IncludeAllEscrowTypeFields": true,
    "EscrowTypeFields": {
      "AdjustPaymentPortion": true,
      "CrEscDividendinPayoff": true,
      "DaysinAdvancetoPrintRpt": true,
      "DefinedCode": true,
      "Description": true,
      "EscrowType": true,
      "IncludeEscrowBalinPayoff": true,
      "IncludeinEscrowAnalysis": true,
      "InvoiceType": true,
      "NumberofCushionMonths": true,
      "PaymentType": true,
      "StatementDescription": true,
      "TransactionDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "EscrowType": {
    "AdjustPaymentPortion": true,
    "CrEscDividendinPayoff": true,
    "DaysinAdvancetoPrintRpt": 1,
    "DefinedCode": 1,
    "Description": "text",
    "IncludeEscrowBalinPayoff": 1,
    "IncludeinEscrowAnalysis": true,
    "InvoiceType": 1,
    "NumberofCushionMonths": 1,
    "PaymentType": 1,
    "StatementDescription": "text",
    "TransactionDescription": "text",
    "EscrowType": 1
  }
}

getEscrowTypePagedList

post

Retrieve paged escrow type data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getEscrowTypePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "EscrowType": [
    {
      "AdjustPaymentPortion": true,
      "CrEscDividendinPayoff": true,
      "DaysinAdvancetoPrintRpt": 1,
      "DefinedCode": 1,
      "Description": "text",
      "IncludeEscrowBalinPayoff": 1,
      "IncludeinEscrowAnalysis": true,
      "InvoiceType": 1,
      "NumberofCushionMonths": 1,
      "PaymentType": 1,
      "StatementDescription": "text",
      "TransactionDescription": "text",
      "EscrowType": 1
    }
  ],
  "Token": "text"
}

getEscrowTypeListSelectFields

post

Retrieve select fields for a list of escrow type data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getEscrowTypeListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllEscrowTypeFields": true,
    "EscrowTypeFields": {
      "AdjustPaymentPortion": true,
      "CrEscDividendinPayoff": true,
      "DaysinAdvancetoPrintRpt": true,
      "DefinedCode": true,
      "Description": true,
      "EscrowType": true,
      "IncludeEscrowBalinPayoff": true,
      "IncludeinEscrowAnalysis": true,
      "InvoiceType": true,
      "NumberofCushionMonths": true,
      "PaymentType": true,
      "StatementDescription": true,
      "TransactionDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "EscrowTypeList": {
    "hasReachedMaximumListSize": true,
    "EscrowType": [
      {
        "AdjustPaymentPortion": true,
        "CrEscDividendinPayoff": true,
        "DaysinAdvancetoPrintRpt": 1,
        "DefinedCode": 1,
        "Description": "text",
        "IncludeEscrowBalinPayoff": 1,
        "IncludeinEscrowAnalysis": true,
        "InvoiceType": 1,
        "NumberofCushionMonths": 1,
        "PaymentType": 1,
        "StatementDescription": "text",
        "TransactionDescription": "text",
        "EscrowType": 1
      }
    ]
  }
}

searchEscrowTypeSelectFields

post

Field for selecting various options related to searchescrowtypeselectfields

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchEscrowTypeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 564

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllEscrowTypeFields": true,
    "EscrowTypeFields": {
      "AdjustPaymentPortion": true,
      "CrEscDividendinPayoff": true,
      "DaysinAdvancetoPrintRpt": true,
      "DefinedCode": true,
      "Description": true,
      "EscrowType": true,
      "IncludeEscrowBalinPayoff": true,
      "IncludeinEscrowAnalysis": true,
      "InvoiceType": true,
      "NumberofCushionMonths": true,
      "PaymentType": true,
      "StatementDescription": true,
      "TransactionDescription": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "EscrowTypeList": {
    "hasReachedMaximumListSize": true,
    "EscrowType": [
      {
        "AdjustPaymentPortion": true,
        "CrEscDividendinPayoff": true,
        "DaysinAdvancetoPrintRpt": 1,
        "DefinedCode": 1,
        "Description": "text",
        "IncludeEscrowBalinPayoff": 1,
        "IncludeinEscrowAnalysis": true,
        "InvoiceType": 1,
        "NumberofCushionMonths": 1,
        "PaymentType": 1,
        "StatementDescription": "text",
        "TransactionDescription": "text",
        "EscrowType": 1
      }
    ]
  }
}

getEscrowTypePagedListSelectFields

post

Retrieve select fields for paged escrow type data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getEscrowTypePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 626

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllEscrowTypeFields": true,
    "EscrowTypeFields": {
      "AdjustPaymentPortion": true,
      "CrEscDividendinPayoff": true,
      "DaysinAdvancetoPrintRpt": true,
      "DefinedCode": true,
      "Description": true,
      "EscrowType": true,
      "IncludeEscrowBalinPayoff": true,
      "IncludeinEscrowAnalysis": true,
      "InvoiceType": true,
      "NumberofCushionMonths": true,
      "PaymentType": true,
      "StatementDescription": true,
      "TransactionDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "EscrowType": [
    {
      "AdjustPaymentPortion": true,
      "CrEscDividendinPayoff": true,
      "DaysinAdvancetoPrintRpt": 1,
      "DefinedCode": 1,
      "Description": "text",
      "IncludeEscrowBalinPayoff": 1,
      "IncludeinEscrowAnalysis": true,
      "InvoiceType": 1,
      "NumberofCushionMonths": 1,
      "PaymentType": 1,
      "StatementDescription": "text",
      "TransactionDescription": "text",
      "EscrowType": 1
    }
  ],
  "Token": "text"
}

searchEscrowTypePagedSelectFields

post

Field for selecting various options related to searchescrowtypepagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchEscrowTypePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 641

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllEscrowTypeFields": true,
    "EscrowTypeFields": {
      "AdjustPaymentPortion": true,
      "CrEscDividendinPayoff": true,
      "DaysinAdvancetoPrintRpt": true,
      "DefinedCode": true,
      "Description": true,
      "EscrowType": true,
      "IncludeEscrowBalinPayoff": true,
      "IncludeinEscrowAnalysis": true,
      "InvoiceType": true,
      "NumberofCushionMonths": true,
      "PaymentType": true,
      "StatementDescription": true,
      "TransactionDescription": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "EscrowType": [
    {
      "AdjustPaymentPortion": true,
      "CrEscDividendinPayoff": true,
      "DaysinAdvancetoPrintRpt": 1,
      "DefinedCode": 1,
      "Description": "text",
      "IncludeEscrowBalinPayoff": 1,
      "IncludeinEscrowAnalysis": true,
      "InvoiceType": 1,
      "NumberofCushionMonths": 1,
      "PaymentType": 1,
      "StatementDescription": "text",
      "TransactionDescription": "text",
      "EscrowType": 1
    }
  ],
  "Token": "text"
}

updateEscrowTypeByID

post
Authorizations
Body
EscrowTypeEscrowTypeintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/updateEscrowTypeByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "EscrowTypeEscrowType": 1,
  "EscrowTypeUpdatableFields": {
    "AdjustPaymentPortion": true,
    "CrEscDividendinPayoff": true,
    "DaysinAdvancetoPrintRpt": 1,
    "DefinedCode": 1,
    "Description": "text",
    "IncludeEscrowBalinPayoff": 1,
    "IncludeinEscrowAnalysis": true,
    "InvoiceType": 1,
    "NumberofCushionMonths": 1,
    "PaymentType": 1,
    "StatementDescription": "text",
    "TransactionDescription": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

Last updated

Was this helpful?