PayDetail object
First available in SystemsLink: 2014.2
Used by External SystemsLink for TMWSuite.
Methods
The Return Value for all methods is PayDetail.ReturnObject. |
Method Name | Parameters | PayDetail.ReturnObject. ReturnCode |
Description | |
---|---|---|---|---|
Name |
Data type (in C#) |
|||
N/A |
0 = successful 1000 = errors occurred |
Creates a new PayDetail object in memory |
||
total |
int |
0 = successful 1000 = errors occurred |
Creates the specified number of new PayDetail objects in memory |
|
criteria |
0 = successful 100 = no records found 1000 = errors occurred |
Returns all PayDetail objects that meet the provided criteria |
||
payDetails |
List<PayDetail> |
0 = successful 100 = validation errors occurred and updates prevented 500 = update proceeded with warnings 1000 = error occurred and updates prevented |
Saves the provided PayDetail objects and updates the database if requested, then returns the saved objects if the save was successful |
|
updateDB |
bool |
|||
pyd_number |
0 = successful 100 = no records found 1000 = errors occurred |
Deletes all PayDetail objects with the provided pyd_number |
Properties and column mapping
To condense the information in this table, the Database Column Name uses the following abbreviations for database tables: p =paydetail |
Property | Database Column | Modifiable | Comments | |||
---|---|---|---|---|---|---|
Name |
Data Type (in C#) |
Name |
Data Type |
|||
1 |
Amount |
decimal |
p.pyd_amount |
money |
Insert/Update |
|
2 |
AuthCode |
string |
p.pyd_authcode |
varchar(30) |
Insert/Update |
|
3 |
CardNumber |
string |
p.crd_cardnumber |
varchar(20) |
Insert/Update |
|
4 |
CreatedBy |
string |
pyd_createdby |
char(20) |
Insert/Update |
|
5 |
CreatedOn |
DateTime |
pyd_createdon |
datetime |
Insert/Update |
|
6 |
DataSourceID |
string |
N/A |
Not mapped |
||
7 |
Description |
string |
p.pyd_description |
varchar(75) |
Insert/Update |
|
8 |
Fee1 |
decimal |
p.pyt_fee1 |
money |
Insert/Update |
|
9 |
Fee2 |
decimal |
p.pyt_fee2 |
money |
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 |
IssueTo |
string |
p.asgn_id |
varchar(13) |
Insert/Update |
|
13 |
IssueToType |
string |
p.asgn_type |
varchar(6) |
Insert/Update |
|
14 |
IsValid |
bool |
N/A |
Not mapped or used in service |
||
15 |
ItemCode |
string |
p.pyt_itemcode |
varchar(6) |
Insert/Update |
|
16 |
LoadState |
string |
p.pyd_loadstate |
varchar(6) |
Insert/Update |
|
17 |
MoveNumber |
int |
p.mov_number |
int |
Insert/Update |
|
18 |
OrderNumber |
int |
p.ord_hdrnumber |
int |
Insert/Update |
|
19 |
PayDetailNumber |
int |
p.pyd_number |
int |
Insert/Update |
|
20 |
PayTo |
string |
p.pyd_payto |
varchar(12) |
Insert/Update |
|
21 |
Quantity |
decimal |
p.pyd_quantity |
float |
Insert/Update |
|
22 |
Rate |
decimal |
p.pyd_rate |
money |
Insert/Update |
|
23 |
ReferenceNumber |
string |
p.pyd_refnum |
varchar(30) |
Insert/Update |
|
24 |
ReferenceType |
string |
p.pyd_refnumtype |
varchar(6) |
Insert/Update |
|
25 |
ScheduleID |
int |
p.psd_id |
int |
Insert/Update |
|
26 |
Seq |
int |
p.pyd_sequence |
int |
Insert/Update |
|
27 |
Status |
string |
p.pyd_status |
varchar(6) |
Insert/Update |
|
28 |
TransactionDate |
DateTime |
p.pyd_transdate |
datetime |
Insert/Update |
|
29 |
TripLeg |
int |
p.lgh_number |
int |
Insert/Update |
|
30 |
Unit |
string |
p.pyd_unit |
varchar(6) |
Insert/Update |
|
31 |
UpdateableProperties |
N/A |
Not mapped |
|||
32 |
UpdatedBy |
string |
p.pyd_updatedby |
char(20) |
Insert/Update |
|
33 |
UpdatedOn |
DateTime |
p.pyd_updatedon |
datetime |
Insert/Update |
PayDetail.ReturnObject
Property Name | Data Type (in C#) | Comments | |
---|---|---|---|
1 |
ErrorMessages |
List <string> |
|
2 |
ErrorObjectIndexList |
List <int> |
|
3 |
Exceptions |
List <Exception> |
|
4 |
ReferenceObjects |
List <PayDetail> |
|
5 |
ReturnCode |
int |
|
6 |
TraceMessages |
List <string> |
|
7 |
WarningMessages |
List <string> |
PayDetailUpdateInfo object
|
Property Name | |
---|---|
1 |
AuthCode |
2 |
CardNumber |
3 |
CreatedBy |
4 |
CreatedOn |
5 |
Description |
6 |
Fee1 |
7 |
Fee2 |
8 |
IssueTo |
9 |
IssueToType |
10 |
ItemCode |
11 |
LoadState |
12 |
MoveNumber |
13 |
OrderNumber |
14 |
PayTo |
15 |
Quantity |
16 |
Rate |
17 |
ReferenceNumber |
18 |
ReferenceType |
19 |
Seq |
20 |
Status |
21 |
TransactionDate |
22 |
TripLeg |
23 |
Unit |
24 |
UpdatedBy |
25 |
UpdatedOn |
Criteria object
To condense the information in table, the Database Column uses the following abbreviations for database tables: p = paydetail |
Name | Database Column | Data Type (in C#) | Comments | |
---|---|---|---|---|
1 |
AmountFrom |
p.pyd_amount |
decimal? |
Creates a range which limits the paydetails by amount |
2 |
AmountTo |
p.pyd_amount |
decimal? |
|
3 |
CardNumber |
p.crd_cardnumber |
string |
|
4 |
Description |
p.pyd_description |
string |
|
5 |
IssueTo |
p.asgn_id |
string |
|
6 |
IssueToType |
p.asgn_type |
string |
|
7 |
ItemCode |
p.pyt_itemcode |
string |
|
8 |
MoveNumber |
p.mov_number |
int? |
|
9 |
OrderNumber |
p.ord_hdrnumber |
int? |
|
10 |
PayDetailNumber |
p.pyd_number |
int? |
|
11 |
PayTo |
p.pyd_payto |
string |
|
12 |
ReferenceNumber |
p.pyd_refnum |
string |
|
13 |
ReferenceType |
p.pyd_refnumbtype |
string |
|
14 |
Status |
p.pyd_status |
string |
|
15 |
TransactionDateFrom |
p.pyd_transdate |
DateTime? |
Creates a range which limits the pay details returned by transaction date |
16 |
TransactionDateTo |
p.pyd_transdate |
DateTime? |
|
17 |
TripLeg |
p.lgh_number |
int? |