ARPayment object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

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

Name

Data type (in C#)

NewARPayment

N/A

0 = successful

1000 = errors occurred

Creates a new ARPayment object in memory

NewARPayments

total

int

0 = successful

1000 = errors occurred

Creates the specified number of new ARPayment objects in memory

RetrieveARPayment

criteria

ARPayment.Criteria

0 = successful

100 = no records found

1000 = errors occurred

Returns all ARPayment objects that meet the provided criteria

SaveARPayment

arpayments

List<ARPayment>

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

Saves the provided ARPayment 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:

r = TMW_GP_AR_payment_information
Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

AppliedAmt

decimal

r.tmw_gp_ar_appliedamount

money

Insert/Update

2

ApplyDate

DateTime

r.tmw_gp_ar_applydate

datetime

Insert/Update

3

ApplyFromNumber

string

r.tmw_gp_ar_applyfromdocnumber

varchar(25)

Insert/Update

4

ApplyGlPostDate

DateTime

r.tmw_gp_ar_applyglfrompostdate

datetime

Insert/Update

5

ApplyToDate

DateTime

r.tmw_gp_ar_appltoyglpostdate

datetime

Insert/Update

6

CustomerID

string

r.tmw_gp_ar_custnumber

varchar(25)

Insert/Update

7

DataSourceID

string

N/A

Not mapped

8

DocNumber

string

r.tmw_gp_ar_docnumber

varchar(25)

Insert/Update

9

InvoiceNumber

int

r.tmw_gp_ar_invhdrnumber

int

Insert/Update

10

IsDirty

bool

N/A

Not mapped or used in service

11

IsNew

bool

N/A

Not mapped, set to false during save to update

12

IsValid

bool

N/A

Not mapped or used in service

13

UpdateableProperties

ARPaymentUpdateInfo

N/A

Not mapped

14

VendorID

int

r.tmw_gp_ar_payid

int

Insert/Update

ARPayment.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List <ARPayment>

5

ReturnCode

int

6

TraceMessages

List <string>

7

WarningMessages

List <string>

ARPaymentUpdateInfo object

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

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

1

AppliedAmt

2

ApplyDate

3

ApplyFromNumber

4

ApplyGlPostDate

5

ApplyToDate

6

CustomerID

7

DocNumber

8

InvoiceNumber

9

VendorID

Criteria object

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

  • r = TMW_GP_AR_payment_information

  • i = invoiceheader

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

1

AppliedAmt

r.tmw_gp_ar_appliedamount

decimal?

2

ApplyDateFrom

r.tmw_gp_ar_applydate

DateTime?

Returns payments with apply dates following the provided date

3

ApplyDateTo

r.tmw_gp_ar_applydate

DateTime?

Returns payments with apply dates prior the provided date

4

ApplyFromNumber

r.tmw_gp_ar_applyfromdocnumber

string

5

ApplyGLPostDateFrom

r.tmw_gp_ar_appltoyglpostdate

DateTime?

Returns payments with gl post dates following the provided date

6

ApplyGLPostDateTo

r.tmw_gp_ar_appltoyglpostdate

DateTime?

Returns payments with gl post dates prior the provided date

7

ApplyToDate

r.tmw_gp_ar_applydate

DateTime?

Returns payments with apply dates equal to the provided date

8

ApplyToDateFrom

r.tmw_gp_ar_applydate

DateTime?

Returns payments with apply dates following the provided date

9

ApplyToDateTo

r.tmw_gp_ar_applydate

DateTime?

Returns payments with apply dates prior the provided date

10

BatchNumber

i.ivh_GPbachnumbeer

string

11

BillDateFrom

i.ivh_GPbilldate

DateTime?

Returns payments with bill dates following the provided date

12

BillDateTo

i.ivh_GPbilldate

DateTime?

Returns payments with bill dates prior the provided date

13

CustNumber

r.tmw_gp_ar_custnumber

string

14

CustomerID

r.tmw_gp_ar_custnumber

string

15

DocDescr

i.ivh_GPDocDescription

string

16

DocNumber

r.tmw_gp_ar_docnumber

string

17

DueDateFrom

i.ivh_GPDuedate

DateTime?

Returns payments with due dates following the provided date

18

DueDateTo

i.ivh_GPDuedate

DateTime?

Returns payments with due dates prior the provided date

19

InvoiceNumber

r.tmw_gp_ar_invhdrnumber

int?

20

PONumber

i.ivh_gpponumber

string

21

PostDateFrom

i.ivh_GPpostdate

DateTime?

Returns payments with post dates following the provided date

22

PostDateTo

i.ivh_GPpostdate

DateTime?

Returns payments with post dates prior the provided date

23

VendorID

r.tmw_gp_ar_payid

int?