# PayAndCollectRunById: Twinfield Pay and collect run by identifier ## Documentation One payment or direct debit run. Carries the same columns as PayAndCollectRuns; the summaries the answer also holds are not exposed. - Catalog: `Twinfield` - Schema: `Twinfield` - Label: Pay and collect run by identifier The data in this table is partitioned per value of the `COMPANY_CODE` column. This is a read-only table function. The Twinfield API may not support changing the data or the Invantive UniversalSQL driver for Twinfield does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Twinfield API. - Filters on API Server: office (Equals ) ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `PayAndCollectRunById`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `COMPANY_CODE` | `` | ☐ | | Code of company. | | `payType` | `` | ☑ | | Code of the payment type of the run. | | `runId` | `` | ☑ | | Identifier of the run. | ## Columns of Table Function The columns of the table function `PayAndCollectRunById` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `BANK` | `varchar2` | Bank | ☐ | | | `COMPANY_CODE` | `varchar2` | Company ID | ☑ | | | `COMPANY_NAME` | `varchar2` | Company Name | ☑ | | | `CREATED` | `datetime` | Created | ☐ | | | `DIRECTREMOVE` | `char` | Direct remove | ☐ | | | `ID` | `int32` | | ☐ | | | `MODIFIED` | `datetime` | Modified | ☐ | | | `OFFICE` | `varchar2` | Office | ☐ | | | `PAYDATE` | `datetime` | Pay date | ☐ | | | `PAYTYPE` | `varchar2` | Payment type | ☐ | | | `PERIOD` | `int32` | | ☐ | | | `PHASE` | `varchar2` | Phase | ☐ | Select, Manipulate, Authorise, Post, Pay or Finalise. | | `RUNTYPE` | `varchar2` | Run type | ☐ | | | `STATUS` | `varchar2` | Status | ☐ | Started, Done or DoneWithErrors. | | `TOUCHED` | `int32` | Times changed | ☐ | | | `USER` | `varchar2` | User | ☐ | | | `YEAR` | `int32` | | ☐ | |