ARPayment object
ARPayment 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 | |||||
---|---|---|---|---|---|---|
Name |
Data Type (in C#) |
Name |
Data Type |
Modifiable |
Comments |
|
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 |
N/A |
Not mapped |
|||
14 |
VendorID |
int |
r.tmw_gp_ar_payid |
int |
Insert/Update |
Required for update |
ARPayment methods
The Return Value for all methods is ARPayment.ReturnObject.
Internal
Parameters | ||||
---|---|---|---|---|
Method Name |
Name |
Data type (in C#) |
ARPayment.ReturnObject. |
Description |
N/A |
0 = successful 1000 = errors occurred |
Creates a new ARPayment object in memory |
||
total |
int |
0 = successful 1000 = errors occurred |
Creates the specified number of new ARPayment objects in memory |
|
criteria |
0 = successful 100 = no records found 1000 = errors occurred |
Retrieves all ARPayment objects that meet the provided criteria |
||
Payments |
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 ARPayments 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#) |
ARPayment.ReturnObject. |
Description |
NewARPayment |
tokenValue |
string |
0 = successful 1000 = errors occurred |
Creates a new ARPayment object in memory |
NewARPayments |
tokenValue |
string |
0 = successful 1000 = errors occurred |
Creates the specified number of new ARPayment objects in memory |
total |
int |
|||
RetrieveARPayment |
tokenValue |
string |
0 = successful 100 = no records found 1000 = errors occurred |
Retrieves all ARPayment objects that meet the provided criteria |
criteria |
||||
SaveARPayment |
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 ARPayments objects and updates the database if requested, then returns the saved objects if the save was successful |
Payments |
List<ARPayment> |
|||
updateDB |
bool |
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 |
ARPayment Criteria object
To condense the information in the table, the Database Column uses the following abbreviations for database tables:
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? |
Creates a range which limits the ApplyDate in the retrieve service |
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? |
Creates a range which limits the GL PostDate in the retrieve service |
7 |
ApplyToDate |
r.tmw_gp_ar_applydate |
DateTime? |
Creates a range which limits the BillDate in the retrieve service |
8 |
ApplyToDateFrom |
r.tmw_gp_ar_applydate |
DateTime? |
Creates a range which limits the BillDate in the retrieve service |
9 |
ApplyToDateTo |
r.tmw_gp_ar_applydate |
DateTime? |
Creates a range which limits the ApplyToDate in the retrieve service |
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? |
Creates a range which limits the DueDate in the retrieve service |
18 |
DueDateTo |
i.ivh_GPDuedate |
DateTime? |
Creates a range which limits the DueDate in the retrieve service |
19 |
InvoiceNumber |
r.tmw_gp_ar_invhdrnumber |
int? |
|
20 |
PONumber |
i.ivh_gpponumber |
string |
|
21 |
PostDateFrom |
i.ivh_GPpostdate |
DateTime? |
Creates a range which limits the PostDate in the retrieve service |
22 |
PostDateTo |
i.ivh_GPpostdate |
DateTime? |
Creates a range which limits the PostDate in the retrieve service |
23 |
VendorID |
r.tmw_gp_ar_payid |
int? |