APPayment object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

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

Name

Data type (in C#)

NewAPPayment

N/A

0 = successful

1000 = errors occurred

Creates a new APPayment object in memory

NewAPPayments

total

int

0 = successful

1000 = errors occurred

Creates the specified number of new APPayment objects in memory

RetrieveAPPayment

criteria

APPayment.Criteria

0 = successful

100 = no records found

1000 = errors occurred

Returns all APPayment objects that meet the provided criteria

SaveAPPayment

appayments

List<APPayment>

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Saves the provided APPayment 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 = tmw_GP_AP_payment_information
Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

DataSourceID

string

N/A

Not mapped

2

IsDirty

bool

N/A

Not mapped or used in service

3

IsNew

bool

N/A

Not mapped, set to false during save to update

4

IsValid

bool

N/A

Not mapped or used in service

5

PayActualApplyAmt

decimal

p.tmw_gp_ap_pay_Actual_Apply_To_Amount

decimal(8,2)

Insert/Update

6

PayAppliedFromApplyAmt

decimal

p.tmw_gp_ap_pay_Applied_from_applied_amount

decimal(8,2)

Insert/Update

7

PayApplyFromDocnumber

string

p.tmw_gp_ap_pay_apply_from_docnumber

varchar(25)

Insert/Update

8

PayApplytoDocdate

DateTime

p.tmw_gp_ap_pay_applyto_docdate

datetime

Insert/Update

9

PayApplyToDocnumber

string

p.tmw_gp_ap_pay_applyto_docnumber

varchar(25)

Insert/Update

10

PayApplyToVouchernumber

string

p.tmw_gp_ap_pay_applyto_vouchernumber

varchar(25)

Insert/Update

11

PayDocDate

DateTime

p.tmw_gp_ap_pay_docdate

datetime

Insert/Update

12

PayDocNumber

string

p.tmw_gp_ap_pay_docnumber

varchar(25)

Insert/Update

13

PayHdrNumber

int

p.tmw_gp_ap_pay_payheadernumber

int

Insert/Update

14

PayId

int

p.tmw_gp_ap_pay_id

int

Insert/Update

15

PayVendorID

string

p.tmw_gp_ap_pay_vendorid

varchar(25)

Insert/Update

16

PayVoucherNumber

string

p.tmw_gp_ap_pay_vouchernumber

varchar(25)

Insert/Update

17

UpdateableProperties

APPaymentUpdateInfo

N/A

Not mapped

APPayment.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List <APPayment>

5

ReturnCode

int

6

TraceMessages

List <string>

7

WarningMessages

List <string>

APPaymentUpdateInfo object

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

  • Set the property to true to update the corresponding APPayment property.
Property Name

1

PayActualApplyAmt

2

PayAppliedFromApplyAmt

3

PayApplyFromDocnumber

4

PayApplytoDocdate

5

PayApplyToDocnumber

6

PayApplyToVouchernumber

7

PayDocDate

8

PayDocNumber

9

PayHdrNumber

10

PayId

11

PayVendorID

12

PayVoucherNumber

Criteria object

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

  • h = tmw_GP_AP_header_information

  • p = tmw_GP_AP_payment_information

All columns in the APPayment table are included.
Name Database Column Data Type (in C#) Comments

1

ACTGPostDate

h.tmw_gp_ap_GLPostDate

DateTime?

2

BatchDate

h.tmw_go_ap_bachdate

DateTime?

3

BatchNumber

h.tmw_gp_ap_bachnumber

string

4

CompanyID

h.tmw_gp_ap_GPcompDB

string

5

DocDate

h.tmw_gp_ap_docdate

DateTime?

6

DocDescription

h.tmw_gp_ap_docdescription

string

7

DocNumber

h.tmw_gp_ap _docnumber

string

8

DocTotal

h.tmw_gp_ap_documenttotal

decimal?

9

DocType

h.gp_ap_doctype

string

10

FullyApplied

h.tmw_gp_ap_PayheaderIsFullyApplied

int?

11

PayActualApplyAmt

p.tmw_gp_ap_pay_Actual_Apply_To_Amount

decimal?

12

PayAppliedFromApplyAmt

p.tmw_gp_ap_pay_Applied_from_applied_amount

decimal?

13

PayApplyFromDocnumber

p.tmw_gp_ap_pay_apply_from_docnumber

string

14

PayApplytoDocdate

p.tmw_gp_ap_pay_applyto_docdate

DateTime?

15

PayApplyToDocnumber

p.tmw_gp_ap_pay_applyto_docnumber

string

16

PayApplyToVouchernumber

p.tmw_gp_ap_pay_applyto_vouchernumber

string

17

PayDocDate

p.tmw_gp_ap_pay_docdate

DateTime?

18

PayDocNumber

p.tmw_gp_ap_pay_docnumber

string

19

PayHdrNumber

p.tmw_gp_ap_pay_payheadernumber

int?

20

PayHeaderNumber

p.tmw_gp_ap_pay_payheadernumber

int?

21

PayId

p.tmw_gp_ap_pay_id

int?

22

PayTo

h.tmw_gp_ap_payto

string

23

PayVendorID

p.tmw_gp_ap_pay_vendorid

string

24

PayVoucherNumber

p.tmw_gp_ap_pay_vouchernumber

string

25

PostDate

h.tmw_gp_ap_postdate

DateTime?

26

VendorID

h.tmw_gp_ap_vendorid

string

27

VoucherNumber

h.tmw_gp_ap_vouchernumber

string

28

VoucherNumberCM

h.tmw_gp_ap_vouchernumberCM

string