Tpt

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getTpt

post

No description available.

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

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

Successful operation.

{
  "Tpt": {
    "BlankLines": 1,
    "CheckDetailLines": 1,
    "Compression": 1,
    "CustomFormat": true,
    "DocumentAccountCode": 1,
    "DocumentNumber": 1,
    "Forms": "text",
    "LinesPerPage": 1,
    "Printer": 1,
    "PrinterType": 1,
    "QueueNumber": 1,
    "QueueSubNumber": 1,
    "QueueSubType": 1,
    "QueueTypes": 1
  }
}

getTptSelectFields

post

No description available.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "TptPrinter": 1,
  "SelectableFields": {
    "IncludeAllTptFields": true,
    "TptFields": {
      "BlankLines": true,
      "CheckDetailLines": true,
      "Compression": true,
      "CustomFormat": true,
      "DocumentAccountCode": true,
      "DocumentNumber": true,
      "Forms": true,
      "LinesPerPage": true,
      "Printer": true,
      "PrinterType": true,
      "QueueNumber": true,
      "QueueSubNumber": true,
      "QueueSubType": true,
      "QueueTypes": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Tpt": {
    "BlankLines": 1,
    "CheckDetailLines": 1,
    "Compression": 1,
    "CustomFormat": true,
    "DocumentAccountCode": 1,
    "DocumentNumber": 1,
    "Forms": "text",
    "LinesPerPage": 1,
    "Printer": 1,
    "PrinterType": 1,
    "QueueNumber": 1,
    "QueueSubNumber": 1,
    "QueueSubType": 1,
    "QueueTypes": 1
  }
}

getTptPagedList

post

No description available.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getTptPagedList 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.

{
  "Tpt": [
    {
      "BlankLines": 1,
      "CheckDetailLines": 1,
      "Compression": 1,
      "CustomFormat": true,
      "DocumentAccountCode": 1,
      "DocumentNumber": 1,
      "Forms": "text",
      "LinesPerPage": 1,
      "Printer": 1,
      "PrinterType": 1,
      "QueueNumber": 1,
      "QueueSubNumber": 1,
      "QueueSubType": 1,
      "QueueTypes": 1
    }
  ],
  "Token": "text"
}

getTptListSelectFields

post

No description available.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllTptFields": true,
    "TptFields": {
      "BlankLines": true,
      "CheckDetailLines": true,
      "Compression": true,
      "CustomFormat": true,
      "DocumentAccountCode": true,
      "DocumentNumber": true,
      "Forms": true,
      "LinesPerPage": true,
      "Printer": true,
      "PrinterType": true,
      "QueueNumber": true,
      "QueueSubNumber": true,
      "QueueSubType": true,
      "QueueTypes": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TptList": {
    "hasReachedMaximumListSize": true,
    "Tpt": [
      {
        "BlankLines": 1,
        "CheckDetailLines": 1,
        "Compression": 1,
        "CustomFormat": true,
        "DocumentAccountCode": 1,
        "DocumentNumber": 1,
        "Forms": "text",
        "LinesPerPage": 1,
        "Printer": 1,
        "PrinterType": 1,
        "QueueNumber": 1,
        "QueueSubNumber": 1,
        "QueueSubType": 1,
        "QueueTypes": 1
      }
    ]
  }
}

searchTptSelectFields

post

Fields available for selecting when retrieving TPT data

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllTptFields": true,
    "TptFields": {
      "BlankLines": true,
      "CheckDetailLines": true,
      "Compression": true,
      "CustomFormat": true,
      "DocumentAccountCode": true,
      "DocumentNumber": true,
      "Forms": true,
      "LinesPerPage": true,
      "Printer": true,
      "PrinterType": true,
      "QueueNumber": true,
      "QueueSubNumber": true,
      "QueueSubType": true,
      "QueueTypes": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "TptList": {
    "hasReachedMaximumListSize": true,
    "Tpt": [
      {
        "BlankLines": 1,
        "CheckDetailLines": 1,
        "Compression": 1,
        "CustomFormat": true,
        "DocumentAccountCode": 1,
        "DocumentNumber": 1,
        "Forms": "text",
        "LinesPerPage": 1,
        "Printer": 1,
        "PrinterType": 1,
        "QueueNumber": 1,
        "QueueSubNumber": 1,
        "QueueSubType": 1,
        "QueueTypes": 1
      }
    ]
  }
}

getTptPagedListSelectFields

post

No description available.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllTptFields": true,
    "TptFields": {
      "BlankLines": true,
      "CheckDetailLines": true,
      "Compression": true,
      "CustomFormat": true,
      "DocumentAccountCode": true,
      "DocumentNumber": true,
      "Forms": true,
      "LinesPerPage": true,
      "Printer": true,
      "PrinterType": true,
      "QueueNumber": true,
      "QueueSubNumber": true,
      "QueueSubType": true,
      "QueueTypes": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Tpt": [
    {
      "BlankLines": 1,
      "CheckDetailLines": 1,
      "Compression": 1,
      "CustomFormat": true,
      "DocumentAccountCode": 1,
      "DocumentNumber": 1,
      "Forms": "text",
      "LinesPerPage": 1,
      "Printer": 1,
      "PrinterType": 1,
      "QueueNumber": 1,
      "QueueSubNumber": 1,
      "QueueSubType": 1,
      "QueueTypes": 1
    }
  ],
  "Token": "text"
}

searchTptPagedSelectFields

post

Fields available for selecting when retrieving paginated TPT data

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllTptFields": true,
    "TptFields": {
      "BlankLines": true,
      "CheckDetailLines": true,
      "Compression": true,
      "CustomFormat": true,
      "DocumentAccountCode": true,
      "DocumentNumber": true,
      "Forms": true,
      "LinesPerPage": true,
      "Printer": true,
      "PrinterType": true,
      "QueueNumber": true,
      "QueueSubNumber": true,
      "QueueSubType": true,
      "QueueTypes": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Tpt": [
    {
      "BlankLines": 1,
      "CheckDetailLines": 1,
      "Compression": 1,
      "CustomFormat": true,
      "DocumentAccountCode": 1,
      "DocumentNumber": 1,
      "Forms": "text",
      "LinesPerPage": 1,
      "Printer": 1,
      "PrinterType": 1,
      "QueueNumber": 1,
      "QueueSubNumber": 1,
      "QueueSubType": 1,
      "QueueTypes": 1
    }
  ],
  "Token": "text"
}
PreviousTellerTranValidateNextTrackingCode

Last updated

Was this helpful?