PayTo object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

The Return Value for all methods is PayTo.ReturnObject.
Method Name Parameters PayTo.ReturnObject.ReturnCode Description

Name

Data type (in C#)

NewPayTo

N/A

0 = successful

1000 = errors occurred

Creates a new PayTo object in memory

NewPayTos

total

int

0 = successful

1000 = errors occurred

Creates the specified number of new PayTo objects in memory

RetrievePayTo

criteria

PayTo.Criteria

0 = successful

100 = no records found

1000 = errors occurred

Returns all PayTo objects that meet the provided criteria

SavePayTo

cities

List<PayTo>

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Saves the provided PayTo objects and updates the database if requested, then returns the saved objects if the save was successful

updateDB

bool

Properties and column mapping

To condense the information in this table, the Database Column Name uses the following abbreviations for database tables:

p = payto

Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

Address1

string

p.pto_address1

varchar(30)

Insert/Update

2

Address2

string

p.pto_address2

varchar(30)

Insert/Update

3

AltID

string

p.pto_altid

char(12)

Insert/Update

4

City

int

p.pto_city

int

Insert/Update

5

CompanyName

string

p.pto_companyname

varchar(65)

Insert/Update

6

County

string

p.pto_country

varchar(6)

Insert/Update

7

Currency

string

p.pto_currency

char(6)

Insert/Update

8

DataSourceID

string

N/A

Not mapped

9

DirectDeposit

string

p.pto_dirdeposit

char(6)

Insert/Update

10

FirstName

string

p.pto_fname

varchar(20)

Insert/Update

11

FleetTractor

string

p.pto_fleettrc

varchar(8)

Insert/Update

12

GPClass

string

p.pto_gp_class

char(11)

Insert/Update

13

IsDirty

bool

N/A

Not mapped or used in service

14

IsNew

bool

N/A

Not mapped, set to false during save to update

15

IsValid

bool

N/A

Not mapped or used in service

16

LastName

string

p.pto_lname

varchar(20)

Insert/Update

17

MiddleInitial

string

p.pto_mname

char(1)

Insert/Update

18

Phone1

string

p.pto_phone1

char(10)

Insert/Update

19

Phone2

string

p.pto_phone2

char(10)

Insert/Update

20

Phone3

string

p.pto_phone3

char(10)

Insert/Update

21

PTO1099Type

int

p.pto_1099type

int

Insert/Update

22

PTOFactorID

string

p.pto_factorid

varchar(12)

Insert/Update

23

PTOID

string

p.pto_id

char(12)

Insert

24

PTOMisc1

string

p.pto_misc1

varchar(254)

Insert/Update

25

PTOMisc2

string

p.pto_misc2

varchar(254)

Insert/Update

26

PTOMisc3

string

p.pto_misc3

varchar(254)

Insert/Update

27

PTOMisc4

string

p.pto_misc4

varchar(254)

Insert/Update

28

PTOType1

string

p.pto_type1

char(6)

Insert/Update

29

PTOType2

string

p.pto_type2

char(6)

Insert/Update

30

PTOType3

string

p.pto_type3

char(6)

Insert/Update

31

PTOType4

string

p.pto_type4

char(6)

Insert/Update

32

StartDate

DateTime

p.pto_startdate

datetime

Insert/Update

33

Status

string

p.pto_status

char(6)

Insert/Update

34

TaxID

string

p.pto_ssn

char(9)

Insert/Update

35

TaxIDType

string

p.pto_sossecfedtax

varchar(10)

Insert/Update

36

TerminationDate

DateTime

p.pto_terminatedate

datetime

Insert/Update

37

UpdateableProperties

PayToUpdateInfo

N/A

Not mapped

38

Zip

string

p.pto_zip

varchar(10)

Insert/Update

PayTo.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List <PayTo>

5

ReturnCode

int

6

TraceMessages

List <string>

7

WarningMessages

List <string>

PayToUpdateInfo object

  • Data types (in C#) for all properties are bool.

  • Set the property to true to update the corresponding PayTo property.

Property Name

1

Address1

2

Address2

3

AltID

4

City

5

CompanyName

6

County

7

Currency

8

DirectDeposit

9

FirstName

10

FleetTractor

11

GPClass

12

LastName

13

MiddleInitial

14

Phone1

15

Phone2

16

Phone3

17

PTO1099Type

18

PTOFactorID

19

PTOID

20

PTOMisc1

21

PTOMisc2

22

PTOMisc3

23

PTOMisc4

24

PTOType1

25

PTOType2

26

PTOType3

27

PTOType4

28

StartDate

29

Status

30

TaxID

31

TaxIDType

32

TerminationDate

33

Zip

Criteria object

To condense the information in table, the Database Column uses the following abbreviations for database tables:

p = payto

Name Database Column Data Type (in C#) Comments

1

Address1

p.pto_address1

string

2

Address2

p.pto_address2

string

3

AltID

p.pto_altid

string

4

City

p.pto_city

int?

5

CompanyName

p.pto_companyname

string

6

FirstName

p.pto_fname

string

7

LastName

p.pto_lname

string

8

Phone1

p.pto_phone1

string

9

Phone2

p.pto_phone2

string

10

PTOID

p.pto_id

string

11

PTOMisc1

p.pto_misc1

string

12

PTOMisc2

p.pto_misc2

string

13

PTOMisc3

p.pto_misc3

string

14

PTOMisc4

p.pto_misc4

string

15

TaxID

p.pto_ssn

string

16

Zip

p.pto_zip

string