AP
APPayment
PX.Objects.APView API Entity: Check
/entity/Default/24.200.001/Check188 of 188 fields
| Field Name | Type | Display Name | Foreign Key | |
|---|---|---|---|---|
DocType | char(3) | Type | - | |
Description:Type of the document. Possible values are: "CHK" - Payment, "ADR" - Debit Adjustment, "PPM" - Prepayment, "REF" - Refund, "VCK" - Voided Payment | ||||
RefNbr | nvarchar(15) | Reference Nbr. | APRegister | |
Description:No description available | ||||
AdjCntr | int | - | ||
Description:No description available | ||||
AdjDate | datetime2 | Application Date | - | |
Description:The date when the payment is applied. Defaults to the current business date. | ||||
AdjFinPeriodID | char(6) | Application Period | - | |
Description:No description available | ||||
AdjTranPeriodID | char(6) | - | ||
Description:The financial period of payment application. Unlike the AdjFinPeriodID, the value of this field is determined solely by the AdjDate field and can't be overriden. | ||||
AmountToWordsNonexistent in DB | nvarchar(255) | - | ||
Description:Returns the word representation of the amount of the document. (English only) | ||||
APAccountID | int | AP Account | Account | |
Description:No description available | ||||
ApplAmtNonexistent in DB | decimal | - | ||
Description:The amount to be applied on the application date. (Presented in the base currency of the company, see Company.BaseCuryID) | ||||
Approved | bit | - | ||
Description:No description available | ||||
APSubID | int | AP Subaccount | Sub | |
Description:This property was copied from the APRegister class. It is overriden only for correct order of the fields in _ClassFields list of PXCache class. The order of the fields is important for proper Restriction Groups operation. Corresponds to the Sub.SubID field. | ||||
BatchNbr | nvarchar(15) | Batch Nbr. | Batch | |
Description:No description available | ||||
BatchPaymentRefNbrNonexistent in DB | nvarchar(MAX) | - | ||
Description:No description available | ||||
BillCntr | int | - | ||
Description:The counter of the related bills. Note that this field is used internally for numbering purposes and its value may not reflect the actual count of the bills. | ||||
BranchID | int | Branch | Branch | |
Description:No description available | ||||
CanHaveBalanceNonexistent in DB | bit | Can Have Balance | - | |
Description:Read-only field indicating whether the document can have balance. "true" for Debit Adjustments, Prepayments, Cash Purchases and Voided Payments. "false" for other documents. | ||||
CashAccountID | int | Cash Account | CashAccount | |
Description:No description available | ||||
CATranID | bigint | CATran | ||
Description:Identifier of the related transaction in Cash Management module. Corresponds to the CATran.CATranID field. | ||||
ChargeAmt | decimal(19, 4) | - | ||
Description:No description available | ||||
ChargeCntr | int | - | ||
Description:The counter of the related charge entries. Note that this field is used internally for numbering purposes and its value may not reflect the actual count of the charges. | ||||
ClearDate | datetime2 | Clear Date | - | |
Description:The date when the check was cleared. | ||||
Cleared | bit | Cleared | - | |
Description:When set to "true" indicates that the check was cleared in the process of reconciliation. | ||||
ClosedDate | datetime2 | Closed Date | - | |
Description:No description available | ||||
ClosedFinPeriodID | char(6) | Closed Period | - | |
Description:No description available | ||||
ClosedTranPeriodID | char(6) | Closed Master Period | - | |
Description:No description available | ||||
CreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
CreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
CreatedDateTime | datetime | Created On | - | |
Description:No description available | ||||
CuryApplAmtNonexistent in DB | decimal | Application Amount | - | |
Description:The amount to be applied on the application date. (Presented in the currency of the document, see CuryID) | ||||
CuryChargeAmt | decimal(19, 4) | Finance Charges | - | |
Description:No description available | ||||
CuryDiscBal | decimal(19, 4) | Cash Discount Balance | - | |
Description:No description available | ||||
CuryDiscountedDocTotalNonexistent in DB | decimal | Discounted Doc. Total | - | |
Description:No description available | ||||
CuryDiscountedPriceNonexistent in DB | decimal | Tax on Discounted Price | - | |
Description:No description available | ||||
CuryDiscountedTaxableTotalNonexistent in DB | decimal | Discounted Taxable Total | - | |
Description:No description available | ||||
CuryDiscTaken | decimal(19, 4) | - | ||
Description:No description available | ||||
CuryDiscTot | decimal(19, 4) | Discount Total | - | |
Description:No description available | ||||
CuryDocBal | decimal(19, 4) | Balance | - | |
Description:No description available | ||||
CuryDocDiscNonexistent in DBObsolete | decimal | Document Discount | - | |
Description:No description available | ||||
CuryID | nvarchar(5) | Currency | Currency | |
Description:No description available | ||||
CuryInfoID | bigint | CurrencyInfo | ||
Description:No description available | ||||
CuryInitDocBal | decimal(19, 4) | Unapplied Balance | - | |
Description:No description available | ||||
CuryLineRetainageTotal | decimal(19, 4) | - | ||
Description:No description available | ||||
CuryOrigDiscAmt | decimal(19, 4) | Cash Discount | - | |
Description:No description available | ||||
CuryOrigDocAmt | decimal(19, 4) | Payment Amount | - | |
Description:The total payment amount that should be applied to the documents. (Presented in the currency of the document, see CuryID) | ||||
CuryOrigDocAmtWithRetainageTotalNonexistent in DB | decimal | Total Amount | - | |
Description:No description available | ||||
CuryOrigTaxDiscAmt | decimal(19, 4) | - | ||
Description:No description available | ||||
CuryOrigWhTaxAmt | decimal(19, 4) | With. Tax | - | |
Description:No description available | ||||
CuryPOApplAmtNonexistent in DB | decimal | Applied to Order | - | |
Description:The total prepayment amount that should be applied to the PO Orders. (Presented in the currency of the document, see CuryID) | ||||
CuryPOFullApplAmtNonexistent in DB | decimal | - | ||
Description:The total prepayment amount (released and not, request and not documents) that should be applied to the PO Orders. (Presented in the currency of the document, see CuryID) | ||||
CuryPOUnreleasedApplAmtNonexistent in DB | decimal | - | ||
Description:The total prepayment amount (unreleased documents) that should be applied to the PO Orders. (Presented in the currency of the document, see CuryID) | ||||
CuryRetainagePaidTotalNonexistent in DB | decimal | Paid Retainage | - | |
Description:No description available | ||||
CuryRetainageReleased | decimal(19, 4) | Released Retainage | - | |
Description:No description available | ||||
CuryRetainageTotal | decimal(19, 4) | Original Retainage | - | |
Description:No description available | ||||
CuryRetainageUnpaidTotalNonexistent in DB | decimal | Unpaid Retainage | - | |
Description:No description available | ||||
CuryRetainageUnreleasedAmt | decimal(19, 4) | Unreleased Retainage | - | |
Description:No description available | ||||
CuryRetainedDiscTotal | decimal(19, 4) | Discount on Retainage | - | |
Description:No description available | ||||
CuryRetainedTaxTotal | decimal(19, 4) | Tax on Retainage | - | |
Description:No description available | ||||
CuryRoundDiff | decimal(19, 4) | Rounding Diff. | - | |
Description:No description available | ||||
CuryTaxRoundDiff | decimal(19, 4) | Rounding Diff. | - | |
Description:No description available | ||||
CuryTaxWheld | decimal(19, 4) | - | ||
Description:No description available | ||||
CuryUnappliedBalNonexistent in DB | decimal | Unapplied Balance | - | |
Description:The balance that has not been applied. This will be a nonzero value if the payment amount is not equal to a document’s total amount. Checks shall always have a zero unapplied balance. (Presented in the currency of the document, see CuryID) | ||||
CuryWhTaxBal | decimal(19, 4) | - | ||
Description:No description available | ||||
DefRetainagePct | decimal(9, 6) | Default Retainage Percent | - | |
Description:No description available | ||||
DepositAfter | datetime2 | Deposit After | - | |
Description:Informational date specified on the document, which is the source of the deposit. Normally defaults to AdjDate for payments with DepositAsBatch set to "true". | ||||
DepositAsBatch | bit | Batch Deposit | - | |
Description:When set to "true" indicates that the payment can be included in a deposit. | ||||
DepositDateNonexistent in DB | datetime | Batch Deposit Date | - | |
Description:The date of deposit. Corresponds to the CADeposit.TranDate field | ||||
Deposited | bit | Deposited | - | |
Description:When equal to "true" indicates that the payment was deposited. | ||||
DepositNbr | nvarchar(15) | Batch Deposit Nbr. | CADeposit | |
Description:The reference number of the deposit document. Corresponds to the CADeposit.RefNbr field | ||||
DepositType | char(3) | DepositType | - | |
Description:The type of the deposit document. Corresponds to the CADeposit.TranType field | ||||
DiscBal | decimal(19, 4) | - | ||
Description:No description available | ||||
DiscountedDocTotalNonexistent in DB | decimal | - | ||
Description:No description available | ||||
DiscountedPriceNonexistent in DB | decimal | - | ||
Description:No description available | ||||
DiscountedTaxableTotalNonexistent in DB | decimal | - | ||
Description:No description available | ||||
DiscTaken | decimal(19, 4) | - | ||
Description:No description available | ||||
DiscTot | decimal(19, 4) | - | ||
Description:No description available | ||||
DisplayCuryInitDocBal | decimal | Migrated Balance | - | |
Description:No description available | ||||
DocBal | decimal(19, 4) | - | ||
Description:No description available | ||||
DocClassNonexistent in DB | nchar(1) | - | ||
Description:No description available | ||||
DocDate | datetime2 | Payment Date | - | |
Description:The date of the payment document. | ||||
DocDesc | nvarchar(512) | Description | - | |
Description:No description available | ||||
DocDiscNonexistent in DBObsolete | decimal | - | ||
Description:No description available | ||||
DontApprove | bit | - | ||
Description:No description available | ||||
DrCrNonexistent in DB | nchar(1) | - | ||
Description:Read-only field indicating whether the document is of debit or credit type. The value of this field is based solely on the DocType field. Possible values are ""D"" (for Refund and Voided Cash Purchase) and ""C"" (for Payment, Voided Payment, Debit Adjustment, Prepayment and Cash Purchase). | ||||
EmployeeID | int | Owner | Contact | |
Description:No description available | ||||
EmployeeWorkgroupID | int | Workgroup ID | EPCompanyTree | |
Description:No description available | ||||
ExternalOrganizationID | nvarchar(50) | External Organization ID | - | |
Description:No description available | ||||
ExternalPaymentBatchNbr | nvarchar(10) | Batch Number | - | |
Description:No description available | ||||
ExternalPaymentCanceled | bit | - | ||
Description:No description available | ||||
ExternalPaymentCardNbr | nvarchar(20) | Card Number | - | |
Description:No description available | ||||
ExternalPaymentCheckNbr | nvarchar(20) | Check Number | - | |
Description:No description available | ||||
ExternalPaymentDisbursementType | nvarchar(25) | Disbursement Method | - | |
Description:No description available | ||||
ExternalPaymentID | nvarchar(50) | External Payment ID | - | |
Description:No description available | ||||
ExternalPaymentIsVoidable | bit | - | ||
Description:No description available | ||||
ExternalPaymentSentDate | datetime | Sent Date | - | |
Description:No description available | ||||
ExternalPaymentStatus | nvarchar(50) | Processing Status | - | |
Description:No description available | ||||
ExternalPaymentTraceNbr | nvarchar(10) | Trace Number | - | |
Description:No description available | ||||
ExternalPaymentUpdateTime | datetime | Update Date | - | |
Description:No description available | ||||
ExtRefNbr | nvarchar(40) | Payment Ref. | - | |
Description:A payment reference number, which can be a system-generated number or an external reference number (such as a wire transfer number or a bank check number) entered manually. Irrelevant for Debit Adjustments. | ||||
FinPeriodID | char(6) | Payment Period | - | |
Description:No description available | ||||
HasMultipleProjects | bit | - | ||
Description:No description available | ||||
HasPPDTaxes | bit | - | ||
Description:No description available | ||||
HiddenKeyNonexistent in DB | nvarchar(MAX) | - | ||
Description:No description available | ||||
Hold API | bit | Hold | - | |
Description:No description available | ||||
ImpRefNbr | nvarchar(15) | - | ||
Description:No description available | ||||
InitDocBal | decimal(19, 4) | - | ||
Description:No description available | ||||
IsExpectedPPVValid | bit | - | ||
Description:No description available | ||||
IsMigratedRecord | bit | - | ||
Description:No description available | ||||
IsPrintingProcessNonexistent in DB | bit | - | ||
Description:Indicates that this check under printing processing to prevent update CashAccountCheck table by AP.PaymentRefAttribute /> | ||||
IsRequestPrepaymentNonexistent in DB | bit | - | ||
Description:No description available | ||||
IsRetainageDocument | bit | Retainage Document | - | |
Description:No description available | ||||
IsRetainageReversing | bit | Retainage Reversing | - | |
Description:No description available | ||||
IsTaxPosted | bit | Tax has been posted to the external tax provider | - | |
Description:No description available | ||||
IsTaxSaved | bit | Tax has been saved in the external tax provider | - | |
Description:No description available | ||||
IsTaxValid | bit | Tax Is Up to Date | - | |
Description:No description available | ||||
JointPayeeID | int | - | ||
Description:No description available | ||||
LastModifiedByID | uniqueidentifier | Last Modified By | Users | |
Description:No description available | ||||
LastModifiedByScreenID | char(8) | - | ||
Description:No description available | ||||
LastModifiedDateTime API | datetime | Last Modified On | - | |
Description:No description available | ||||
LineCntr | int | - | ||
Description:No description available | ||||
LineRetainageTotal | decimal(19, 4) | - | ||
Description:No description available | ||||
NonTaxable | bit | Non-Taxable | - | |
Description:No description available | ||||
NoteID | uniqueidentifier | - | ||
Description:No description available | ||||
OpenDoc | bit | Open | - | |
Description:No description available | ||||
OrigDiscAmt | decimal(19, 4) | - | ||
Description:No description available | ||||
OrigDocAmt | decimal(19, 4) | Amount | - | |
Description:No description available | ||||
OrigDocAmtWithRetainageTotalNonexistent in DB | decimal | Total Amount | - | |
Description:No description available | ||||
OrigDocDate | datetime2 | - | ||
Description:No description available | ||||
OrigDocType | char(3) | Orig. Doc. Type | - | |
Description:No description available | ||||
OrigModule | char(2) | Source | - | |
Description:No description available | ||||
OrigRefNbr | nvarchar(15) | Orig. Ref. Nbr. | - | |
Description:No description available | ||||
OrigTaxDiscAmt | decimal(19, 4) | - | ||
Description:No description available | ||||
OrigWhTaxAmt | decimal(19, 4) | - | ||
Description:No description available | ||||
OwnerIDNonexistent in DB | int | Approver | Contact | |
Description:No description available | ||||
PaymentCannotbeVoidedMessageNonexistent in DB | nvarchar(128) | PaymentCannotbeVoidedMessage | - | |
Description:No description available | ||||
PaymentMethodID | nvarchar(10) | Payment Method | PaymentMethod | |
Description:No description available | ||||
PaymentsByLinesAllowed | bit | Pay by Line | - | |
Description:No description available | ||||
PendingPayment | bit | - | ||
Description:No description available | ||||
PendingPPD | bit | - | ||
Description:No description available | ||||
PendingProcessing | bit | - | ||
Description:No description available | ||||
POApplAmtNonexistent in DB | decimal | - | ||
Description:The total prepayment amount that should be applied to the PO Orders. | ||||
POFullApplAmtNonexistent in DB | decimal | - | ||
Description:The total prepayment amount (released and not, request and not documents) that should be applied to the PO Orders. | ||||
POUnreleasedApplAmtNonexistent in DB | decimal | - | ||
Description:The total prepayment amount (unreleased documents) that should be applied to the PO Orders. | ||||
PrebookBatchNbr | nvarchar(15) | Pre-Releasing Batch Nbr. | Batch | |
Description:No description available | ||||
Prebooked | bit | Prebooked | - | |
Description:No description available | ||||
PrepaymentAccountID | int | Prepayment Account | Account | |
Description:No description available | ||||
PrepaymentSubID | int | Prepayment Subaccount | Sub | |
Description:No description available | ||||
PrintCheck | bit | Print Check | - | |
Description:No description available | ||||
PrintDocTypeNonexistent in DB | nchar(3) | Type | - | |
Description:No description available | ||||
Printed | bit | - | ||
Description:No description available | ||||
ProjectID | int | Project | PMProject | |
Description:No description available | ||||
RefNoteID | uniqueidentifier | - | ||
Description:No description available | ||||
Rejected | bit | - | ||
Description:No description available | ||||
Released | bit | Released | - | |
Description:No description available | ||||
ReleasedOrPrebookedNonexistent in DB | bit | - | ||
Description:No description available | ||||
ReleasedToVerifyNonexistent in DB | bit | - | ||
Description:No description available | ||||
RemitAddressID | int | Address | ||
Description:No description available | ||||
RemitContactID | int | Remittance Contact | Contact | |
Description:No description available | ||||
RetainageAcctID | int | Retainage Payable Account | Account | |
Description:No description available | ||||
RetainageApply | bit | Apply Retainage | - | |
Description:No description available | ||||
RetainagePaidTotalNonexistent in DB | decimal | - | ||
Description:No description available | ||||
RetainageReleased | decimal(19, 4) | Released Retainage | - | |
Description:No description available | ||||
RetainageSubID | int | Retainage Payable Sub. | Sub | |
Description:No description available | ||||
RetainageTotal | decimal(19, 4) | Original Retainage | - | |
Description:No description available | ||||
RetainageUnpaidTotalNonexistent in DB | decimal | - | ||
Description:No description available | ||||
RetainageUnreleasedAmt | decimal(19, 4) | Unreleased Retainage | - | |
Description:No description available | ||||
RetainedDiscTotal | decimal(19, 4) | - | ||
Description:No description available | ||||
RetainedTaxTotal | decimal(19, 4) | - | ||
Description:No description available | ||||
RGOLAmt | decimal(19, 4) | - | ||
Description:No description available | ||||
RoundDiff | decimal(19, 4) | - | ||
Description:No description available | ||||
Scheduled | bit | - | ||
Description:No description available | ||||
ScheduleID | nvarchar(15) | - | ||
Description:No description available | ||||
SelectedNonexistent in DB | bit | Selected | - | |
Description:No description available | ||||
Status API | char(1) | Status | - | |
Description:No description available | ||||
StubCntr | int | - | ||
Description:The counter of the related pay stubs. Note that this field is used internally for numbering purposes and its value may not reflect the actual count of the pay stubs. | ||||
TaxCalcMode | char(1) | Tax Calculation Mode | - | |
Description:No description available | ||||
TaxCostINAdjRefNbr | nvarchar(15) | Adjustment Nbr. | INRegister | |
Description:No description available | ||||
TaxRoundDiff | decimal(19, 4) | - | ||
Description:No description available | ||||
TaxWheld | decimal(19, 4) | - | ||
Description:No description available | ||||
TranPeriodID | char(6) | - | ||
Description:The financial period of the document corresponding to the payment date. Unlike the FinPeriodID, the value of this field is determined solely by the AdjDate field and can't be overriden. | ||||
tstamp | timestamp | - | ||
Description:No description available | ||||
UnappliedBalNonexistent in DB | decimal | - | ||
Description:The balance that has not been applied. This will be a nonzero value if the payment amount is not equal to a document’s total amount. Checks shall always have a zero unapplied balance. (Presented in the base currency of the company, see Company.BaseCuryID) | ||||
VendorID | int | Vendor | Vendor | |
Description:No description available | ||||
VendorLocationID | int | Location | Location | |
Description:No description available | ||||
VoidApplNonexistent in DB | bit | Void Application | - | |
Description:When "true" indicates that the document is Voided Payment. Setting this field to "true" will change the type of the document to Voided Payment (""VCK""). | ||||
VoidBatchNbr | nvarchar(15) | Void Batch Nbr. | Batch | |
Description:No description available | ||||
Voided | bit | Voided | - | |
Description:When set to "true" indicates that the document was voided. In this case VoidBatchNbr field will hold the number of the voiding Batch. | ||||
WhTaxBal | decimal(19, 4) | - | ||
Description:No description available | ||||
WorkgroupIDNonexistent in DB | int | Approval Workgroup ID | EPCompanyTree | |
Description:No description available | ||||