CashOrderVendor

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCashOrderVendor

post

Retrieve CashOrderVendor parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CashOrderVendorCashOrderVendorintegerRequired

Responses

200

Successful operation.

application/json

post/getCashOrderVendor

POST /nexum/627/2022.01/parameter/getCashOrderVendor HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CashOrderVendorCashOrderVendor": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CashOrderVendor": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCashOrderVendor"
}

getCashOrderVendorSelectFields

post

Retrieve CashOrderVendor parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CashOrderVendorCashOrderVendorintegerOptional

Responses

200

Successful operation.

application/json

post/getCashOrderVendorSelectFields

POST /nexum/627/2022.01/parameter/getCashOrderVendorSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllCashOrderVendorFields": true
  }
}

200

Successful operation.

{
  "CashOrderVendor": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getCashOrderVendorSelectFields"
}

getCashOrderVendorPagedList

post

Retrieve CashOrderVendor parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getCashOrderVendorPagedList

POST /nexum/627/2022.01/parameter/getCashOrderVendorPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CashOrderVendor": [],
  "Token": null,
  "MessageId": "getCashOrderVendorPagedList"
}

getCashOrderVendorListSelectFields

post

Retrieve CashOrderVendor parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getCashOrderVendorListSelectFields

POST /nexum/627/2022.01/parameter/getCashOrderVendorListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllCashOrderVendorFields": true
  }
}

200

Successful operation.

{
  "CashOrderVendorList": [],
  "MessageId": "getCashOrderVendorListSelectFields"
}

searchCashOrderVendorSelectFields

post

Search CashOrderVendor parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchCashOrderVendorSelectFields

POST /nexum/627/2022.01/parameter/searchCashOrderVendorSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCashOrderVendorFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CashOrderVendorList": [],
  "MessageId": "searchCashOrderVendorSelectFields"
}

getCashOrderVendorPagedListSelectFields

post

Retrieve CashOrderVendor parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getCashOrderVendorPagedListSelectFields

POST /nexum/627/2022.01/parameter/getCashOrderVendorPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 277

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllCashOrderVendorFields": true
  }
}

200

Successful operation.

{
  "CashOrderVendor": [],
  "Token": null,
  "MessageId": "getCashOrderVendorPagedListSelectFields"
}

searchCashOrderVendorPagedSelectFields

post

Search CashOrderVendor parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchCashOrderVendorPagedSelectFields

POST /nexum/627/2022.01/parameter/searchCashOrderVendorPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 288

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllCashOrderVendorFields": true
  }
}

200

Successful operation.

{
  "CashOrderVendor": [],
  "Token": null,
  "MessageId": "searchCashOrderVendorPagedSelectFields"
}

updateCashOrderVendorByID

post

Update CashOrderVendor parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CashOrderVendorCashOrderVendorintegerOptional

Responses

200

Successful operation.

application/json

post/updateCashOrderVendorByID

POST /nexum/627/2022.01/parameter/updateCashOrderVendorByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 329

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CashOrderVendorCashOrderVendor": 1,
  "CashOrderVendorUpdatableFields": {
    "Number": "NEXW45",
    "Name": "NEXUM W45",
    "Payee": "NEXUMW45",
    "Street": "123 TEST ST",
    "City": "TEST",
    "State": "CA",
    "ZipCode": "90000"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateCashOrderVendorByID"
}