CheckOrderDefault

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getCheckOrderDefault

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CheckOrderDefaultCheckOrderProcessorintegerRequired

Responses

200

Successful operation.

application/json

post/getCheckOrderDefault

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

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

200

Successful operation.

{
  "CheckOrderDefault": {
    "BillingCode": 0,
    "Branch": 0,
    "LastOrderDate": "1900-01-01",
    "NumberSigLines": 1,
    "Quantity": 150,
    "StartNumber": 101
  },
  "MessageId": "getCheckOrderDefault"
}

getCheckOrderDefaultSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

CheckOrderDefaultCheckOrderProcessorintegerOptional

Responses

200

Successful operation.

application/json

post/getCheckOrderDefaultSelectFields

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

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

200

Successful operation.

{
  "CheckOrderDefault": {
    "AcctAddrInkColor": 0,
    "BillingCode": 0,
    "Branch": 0,
    "CheckOrderProcessor": null,
    "CheckType": 0,
    "LastOrderDate": "1900-01-01",
    "NumberSigLines": 1,
    "Quantity": 150,
    "StartNumber": 101
  },
  "MessageId": "getCheckOrderDefaultSelectFields"
}

getCheckOrderDefaultPagedList

post

Retrieve CheckOrderDefault 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/getCheckOrderDefaultPagedList

POST /nexum/627/2022.01/parameter/getCheckOrderDefaultPagedList 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.

{
  "CheckOrderDefault": [],
  "Token": null,
  "MessageId": "getCheckOrderDefaultPagedList"
}

getCheckOrderDefaultListSelectFields

post

Retrieve CheckOrderDefault 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/getCheckOrderDefaultListSelectFields

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

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

200

Successful operation.

{
  "CheckOrderDefaultList": [],
  "MessageId": "getCheckOrderDefaultListSelectFields"
}

searchCheckOrderDefaultSelectFields

post

Search CheckOrderDefault 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/searchCheckOrderDefaultSelectFields

POST /nexum/627/2022.01/parameter/searchCheckOrderDefaultSelectFields 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&"
    }
  },
  "SelectableFields": {
    "IncludeAllCheckOrderDefaultFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "CheckOrderDefaultList": [],
  "MessageId": "searchCheckOrderDefaultSelectFields"
}

getCheckOrderDefaultPagedListSelectFields

post

Retrieve CheckOrderDefault 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/getCheckOrderDefaultPagedListSelectFields

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

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

200

Successful operation.

{
  "CheckOrderDefault": [
    {
      "AcctAddrInkColor": 0,
      "BillingCode": 0,
      "Branch": 0,
      "CheckOrderProcessor": null,
      "CheckType": 0,
      "LastOrderDate": "1900-01-01",
      "NumberSigLines": 1,
      "Quantity": 150,
      "StartNumber": 101
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getCheckOrderDefaultPagedListSelectFields"
}

searchCheckOrderDefaultPagedSelectFields

post

Search CheckOrderDefault 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/searchCheckOrderDefaultPagedSelectFields

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

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

200

Successful operation.

{
  "CheckOrderDefault": [
    {
      "AcctAddrInkColor": 0,
      "BillingCode": 0,
      "Branch": 0,
      "CheckOrderProcessor": null,
      "CheckType": 0,
      "LastOrderDate": "1900-01-01",
      "NumberSigLines": 1,
      "Quantity": 150,
      "StartNumber": 101
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchCheckOrderDefaultPagedSelectFields"
}

updateCheckOrderDefaultByID

post

Update CheckOrderDefault 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

CheckOrderDefaultCheckOrderProcessorintegerOptional

Responses

200

Successful operation.

application/json

post/updateCheckOrderDefaultByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CheckOrderDefaultCheckOrderProcessor": 1,
  "CheckOrderDefaultUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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