invantive documentation
Invantive Support ForumsLog In / Sign Up

PayAndCollectRunById: Twinfield Pay and Collect Run by Identifier

read only per partition XML

  • 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.

Can only retrieve data.

Summary

One payment or direct debit run. Carries the same columns as PayAndCollectRuns; the summaries the answer also holds are not exposed.

API Source

  • XML service: webservices/payandcollect.asmx
  • XML topic: PayAndCollectRunById
  • XML path: /tns:GetRunInfoResult
  • SOAP action: GetRunInfo

Performance Characteristics

Characteristic Value
Average access latency (ms) 54
Full scan rows per minute 1,690
Point query rows per minute 1,111
Write rows per minute 431

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
COMPANY_CODE `` Code of company.
payType `` Code of the payment type of the run.
runId `` Identifier of the run.

Table Columns

The columns of the table PayAndCollectRunById are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
BANK varchar2 Bank /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Bank
COMPANY_CODE varchar2 Company ID
COMPANY_NAME varchar2 Company Name
CREATED datetime Created /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Created
DIRECTREMOVE char Direct Remove /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:DirectRemove
ID int32 Tfd ID /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Id
MODIFIED datetime Modified /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Modified
OFFICE varchar2 Office /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Office
PAYDATE datetime Pay Date /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:PayDate
PAYTYPE varchar2 Payment Type /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:PayType
PERIOD int32 Tfd Period /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Period
PHASE varchar2 Phase /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Phase Select, Manipulate, Authorise, Post, Pay or Finalise.
RUNTYPE varchar2 Run Type /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:RunType
STATUS varchar2 Status /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Status Started, Done or DoneWithErrors.
TOUCHED int32 Times Changed /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Touched
USER varchar2 User /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:User
YEAR int32 Tfd Year /soap:Envelope/soap:Body/tns:GetRunInfoResponse/tns:GetRunInfoResult/tns:Year

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

Changes of This Table, 26.0 to 27.0

Table function Twinfield.Twinfield.PayAndCollectRunById is added

The table function has 17 columns and can select.

  • importance 3

All changes of the driver, 26.0 to 27.0