APPaymentHeader object :: SystemsLink

APPaymentHeader properties and column mapping

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

h = tmw_GP_AP_header_information

	Property	Database Column
	Name	Data Type (in C#)	Name	Data Type	Modifiable	Comments
1	ACTGPostDate	DateTime	h.tmw_gp_ap_GLPostDate	datetime	Insert/Update
2	BachDate	DateTime	h.tmw_gp_ap_bachdate	datetime	Insert/Update
3	BachNumber	string	h.tmw_gp_ap_bachnumber	varchar(25)	Insert/Update
4	CompanyID	string	h.tmw_gp_ap_GPcompDB	varchar(6)	Insert/Update
5	DataSourceID	string			N/A	Not mapped
6	DocDate	DateTime	h.tmw_gp_ap_docdate	datetime	Insert/Update
7	DocDescription	string	h.tmw_gp_ap_docdescription	varchar(31)	Insert/Update
8	DocNumber	string	h.tmw_gp_ap_docnumber	varchar(25)	Insert/Update
9	DocTotal	decimal	h.tmw_gp_ap_doucumenttotal	decimal(8,2)	Insert/Update
10	FullyApplied	int	h.tmw_gp_ap_PayheaderIsFullyApplied	int	Insert/Update
11	gp_ap_server	string	h.gp_ap_server	varchar(25)	Insert/Update
12	IsDirty	bool			N/A	Not mapped or used in service
13	IsNew	bool			N/A	Not mapped, set to false during save to update
14	IsValid	bool			N/A	Not mapped or used in service
15	PayHeaderNumber	int	h.tmw_gp_ap_payheadernumber	int	Insert/Update	Required for update
16	PayTo	string	h.tmw_gp_ap_payto	varchar(16)	Insert/Update
17	PostDate	DateTime	h.tmw_gp_ap_postdate	datetime	Insert/Update
18	UpdateableProperties	APPaymentHeaderUpdateInfo			N/A	Not mapped
19	VendorID	string	h.tmw_gp_ap_vendorid	varchar(16)	Insert/Update
20	VoucherNumber	string	h.tmw_gp_ap_vouchernumber	varchar(25)	Insert/Update
21	VoucherNumberCM	string	h.tmw_gp_ap_vouchernumberCM	varchar(25)	Insert/Update

Property

Database Column

Name

Data Type (in C#)

Name

Data Type

Modifiable

Comments

1

ACTGPostDate

DateTime

h.tmw_gp_ap_GLPostDate

datetime

Insert/Update

2

BachDate

DateTime

h.tmw_gp_ap_bachdate

datetime

Insert/Update

3

BachNumber

string

h.tmw_gp_ap_bachnumber

varchar(25)

Insert/Update

4

CompanyID

string

h.tmw_gp_ap_GPcompDB

varchar(6)

Insert/Update

5

DataSourceID

string

N/A

Not mapped

6

DocDate

DateTime

h.tmw_gp_ap_docdate

datetime

Insert/Update

7

DocDescription

string

h.tmw_gp_ap_docdescription

varchar(31)

Insert/Update

8

DocNumber

string

h.tmw_gp_ap_docnumber

varchar(25)

Insert/Update

9

DocTotal

decimal

h.tmw_gp_ap_doucumenttotal

decimal(8,2)

Insert/Update

10

FullyApplied

int

h.tmw_gp_ap_PayheaderIsFullyApplied

int

Insert/Update

11

gp_ap_server

string

h.gp_ap_server

varchar(25)

Insert/Update

12

IsDirty

bool

N/A

Not mapped or used in service

13

IsNew

bool

N/A

Not mapped, set to false during save to update

14

IsValid

bool

N/A

Not mapped or used in service

15

PayHeaderNumber

int

h.tmw_gp_ap_payheadernumber

int

Insert/Update

Required for update

16

PayTo

string

h.tmw_gp_ap_payto

varchar(16)

Insert/Update

17

PostDate

DateTime

h.tmw_gp_ap_postdate

datetime

Insert/Update

18

UpdateableProperties

APPaymentHeaderUpdateInfo

N/A

Not mapped

19

VendorID

string

h.tmw_gp_ap_vendorid

varchar(16)

Insert/Update

20

VoucherNumber

string

h.tmw_gp_ap_vouchernumber

varchar(25)

Insert/Update

21

VoucherNumberCM

string

h.tmw_gp_ap_vouchernumberCM

varchar(25)

Insert/Update

APPaymentHeader methods

The Return Value for all methods is APPaymentHeader.ReturnObject.

Internal

	Parameters
Method Name	Name	Data type (in C#)	APPaymentHeader.ReturnObject. ReturnCode	Description
RetrieveAPHeader	criteria	APPaymentHeader.Criteria	0 = successful 100 = no records found 1000 = errors occurred	Returns all APPaymentHeader objects that meet the provided criteria
SaveAPHeader	Payments	List<APPaymentHeader>	0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented	Saves the provided APPaymentHeader objects and updates the database if requested, then returns the saved objects if the save was successful
	updateDB	bool

Parameters

Method Name

Name

Data type (in C#)

APPaymentHeader.ReturnObject.
ReturnCode

Description

RetrieveAPHeader

criteria

APPaymentHeader.Criteria

0 = successful

100 = no records found

1000 = errors occurred

Returns all APPaymentHeader objects that meet the provided criteria

SaveAPHeader

Payments

List<APPaymentHeader>

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

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

updateDB

bool

External

	Parameters
Method Name	Name	Data type (in C#)	APPaymentHeader.ReturnObject. ReturnCode	Description
RetrieveAPHeader	tokenValue	string	0 = successful 100 = no records found 1000 = errors occurred	Returns all APPaymentHeader objects that meet the provided criteria
	criteria	APPaymentHeader.Criteria
SaveAPHeader	tokenValue	string	0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented	Saves the provided APPaymentHeader objects and updates the database if requested, then returns the saved objects if the save was successful
	Payments	List<APPaymentHeader>
	updateDB	bool

Parameters

Method Name

Name

Data type (in C#)

APPaymentHeader.ReturnObject.
ReturnCode

Description

RetrieveAPHeader

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Returns all APPaymentHeader objects that meet the provided criteria

criteria

APPaymentHeader.Criteria

SaveAPHeader

tokenValue

string

0 = successful

100 = validation errors occurred and updates prevented

500 = update proceeded with warnings

1000 = error occurred and updates prevented

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

Payments

List<APPaymentHeader>

updateDB

bool

APPaymentHeader.ReturnObject

	Property Name	Data Type (in C#)
1	ErrorMessages	List<string>
2	ErrorObjectIndexList	List<int>
3	Exceptions	List<Exception>
4	ReferenceObjects	List<APPaymentHeader>
5	ReturnCode	int
6	TraceMessages	List<string>
7	WarningMessages	List<string>

Property Name

Data Type (in C#)

Comments

1

ErrorMessages

List<string>

2

ErrorObjectIndexList

List<int>

3

Exceptions

List<Exception>

4

ReferenceObjects

List<APPaymentHeader>

5

ReturnCode

int

6

TraceMessages

List<string>

7

WarningMessages

List<string>

APPaymentHeaderUpdateInfo object

Data types (in C#) for all properties are bool.
Set the property to true to update the corresponding APPayment property.

	Property Name
1	ACTGPostDate
2	BachDate
3	BachNumber
4	CompanyID
5	DocDate
6	DocDescription
7	DocNumber
8	DocTotal
9	FullyApplied
10	gp_ap_server
11	PayHeaderNumber
12	PayTo
13	PostDate
14	VendorID
15	VoucherNumber
16	VoucherNumberCM

APPaymentHeader Criteria object

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

h = tmw_GP_AP_header_information

All columns in the APPayment table are included.

	Name	Database Column	Data Type (in C#)
1	ACTGPostDate	h.tmw_gp_ap_GLPostDate	DateTime?
2	BachDate	h.tmw_gp_ap_bachdate	DateTime?
3	BachNumber	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	FullyApplied	h.tmw_gp_ap_PayheaderIsFullyApplied	int?
10	PayHeaderNumber	h.tmw_gp_ap_payheadernumber	int?
11	PayTo	h.tmw_gp_ap_payto	string
12	PostDate	h.tmw_gp_ap_postdate	DateTime?
13	VendorID	h.tmw_gp_ap_vendorid	string
14	VoucherNumber	h.tmw_gp_ap_vouchernumber	string
15	VoucherNumberCM	h.tmw_gp_ap_vouchernumberCM	string

Name

Database Column

Data Type (in C#)

Comments

1

ACTGPostDate

h.tmw_gp_ap_GLPostDate

DateTime?

2

BachDate

h.tmw_gp_ap_bachdate

DateTime?

3

BachNumber

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

FullyApplied

h.tmw_gp_ap_PayheaderIsFullyApplied

int?

10

PayHeaderNumber

h.tmw_gp_ap_payheadernumber

int?

11

PayTo

h.tmw_gp_ap_payto

string

12

PostDate

h.tmw_gp_ap_postdate

DateTime?

13

VendorID

h.tmw_gp_ap_vendorid

string

14

VoucherNumber

h.tmw_gp_ap_vouchernumber

string

15

VoucherNumberCM

h.tmw_gp_ap_vouchernumberCM

string