Skip to main content
AR

ARRegister

PX.Objects.AR
Field NameTypeDisplay NameForeign Key
DocType
char(3)Type-
Description:The type of the document. This field is a part of the compound key of the document. The field can have one of the values described in ARDocType.ListAttribute.
RefNbrDefault Navigation
nvarchar(15)Reference Nbr.-
Description:The reference number of the document. This field is a part of the compound key of the document.
AdjCntr
int-
Description:The counter of the document applications, which is used internally to assign numbers to newly created lines. The value is used to determine old and new applications.
Approved
bit-
Description:No description available
ApproverIDDefault Navigation
intOwnerContact
Description:No description available
ApproverWorkgroupIDDefault Navigation
intApproval Workgroup IDEPCompanyTree
Description:No description available
ARAccountIDDefault Navigation
intAR AccountAccount
Description:No description available
ARSubIDDefault Navigation
intAR SubaccountSub
Description:The identifier of the subaccount to which the document should be posted. Corresponds to the Sub.SubID field.
BatchNbrDefault Navigation
nvarchar(15)Batch Nbr.Batch
Description:No description available
BatchSeq
smallint-
Description:The batch sequence number. The field is not used.
BranchIDDefault Navigation
intBranchBranch
Description:The identifier of the branch to which the document belongs. Corresponds to the Branch.BranchID field.
Canceled
bit-
Description:When set to "true", indicates that the invoice was canceled or corrected.
ChargeAmt
decimal(19, 4)-
Description:The total of all finance charges applied to the document. Given in the base currency of the company.
ClosedDate
datetime2Closed Date-
Description:The date of the last application.
ClosedFinPeriodID
char(6)Closed Period-
Description:No description available
ClosedTranPeriodID
char(6)Closed Period-
Description:The Financial Period, in which the document was closed. Corresponds to the TranPeriodID field.
CreatedByIDDefault Navigation
uniqueidentifierCreated ByUsers
Description:No description available
CreatedByScreenID
char(8)-
Description:No description available
CreatedDateTime
datetimeCreated On-
Description:No description available
CuryChargeAmt
decimal(19, 4)Finance Charges-
Description:The total of all finance charges applied to the document. Given in the currency of the document.
CuryDiscBal
decimal(19, 4)Cash Discount Balance-
Description:The cash discount balance of the document. Given in the currency of the document.
CuryDiscountedDocTotalNonexistent in DB
decimalDiscounted Doc. Total-
Description:The discounted amount of the document. Given in the currency of the document.
CuryDiscountedPriceNonexistent in DB
decimalTax on Discounted Price-
Description:The total tax amount reduced on early payment, according to cash discount. Given in the currency of the document.
CuryDiscountedTaxableTotalNonexistent in DB
decimalDiscounted Taxable Total-
Description:No description available
CuryDiscTaken
decimal(19, 4)-
Description:The cash discount amount actually applied to the document. Given in the currency of the document.
CuryDocBal
decimal(19, 4)Balance-
Description:The open balance of the document. Given in the currency of the document.
CuryDocDiscNonexistent in DBObsolete
decimalDocument Discount-
Description:The document discount total (without group discounts). Given in the currency of the document.
CuryIDDefault Navigation
nvarchar(5)CurrencyCurrency
Description:The code of the Currency of the document. Defaults to the base currency of the company. Corresponds to the Currency.CuryID field.
CuryInfoID
bigintCurrencyInfo
Description:The identifier of the CurrencyInfo object associated with the document. Corresponds to the CurrencyInfoID field.
CuryInitDocBal
decimal(19, 4)Balance-
Description:The entered in migration mode balance of the document. Given in the currency of the document.
CuryLineRetainageTotal
decimal(19, 4)-
Description:No description available
CuryOrigDiscAmt
decimal(19, 4)Cash Discount-
Description:The cash discount entered for the document. Given in the currency of the document.
CuryOrigDocAmt
decimal(19, 4)Amount-
Description:The amount of the document. Given in the currency of the document.
CuryOrigDocAmtWithRetainageTotalNonexistent in DB
decimalTotal Amount-
Description:No description available
CuryRetainagePaidTotalNonexistent in DB
decimalPaid/Adjusted 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
CuryRetainageUnpaidTotal
decimal(19, 4)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:The difference between the original amount of the document and the rounded amount. Given in the currency of the document. Applicable only if Invoice Rounding feature is enabled.
CustomerIDDefault Navigation
intCustomerCustomer
Description:The identifier of the Customer record associated with the document. Corresponds to the BAccount.BAccountID field.
CustomerLocationIDDefault Navigation
intLocationLocation
Description:No description available
DefRetainagePct
decimal(9, 6)Default Retainage Percent-
Description:No description available
DisableAutomaticTaxCalculation
bitDisable Automatic Tax Calculation-
Description:No description available
DiscBal
decimal(19, 4)-
Description:The cash discount balance of the document. Given in the base currency of the company.
DiscountedDocTotalNonexistent in DB
decimal-
Description:The discounted amount of the document. Given in the base currency of the company.
DiscountedPriceNonexistent in DB
decimal-
Description:The total tax amount reduced on early payment, according to cash discount. Given in the base currency of the company.
DiscountedTaxableTotalNonexistent in DB
decimal-
Description:The total taxable amount reduced on early payment, according to cash discount. Given in the base currency of the company.
DiscTaken
decimal(19, 4)-
Description:The cash discount amount actually applied to the document. Given in the base currency of the company.
DisplayCuryInitDocBal
decimalMigrated Balance-
Description:The non database field, displaying an entered in migration mode balance of the document . Given in the currency of the document. Added to configure the different visibility of one field on one DAC cache.
DocBal
decimal(19, 4)-
Description:The open balance of the document. Given in the base currency of the company.
DocClassNonexistent in DB
nchar(1)-
Description:Reserved for internal use. The read-only class of the document determined by the DocType. Affects the way the document is posted to the General Ledger. Corresponds to the GLTran.TranClass field.
DocDate
datetime2Date-
Description:The date of the document. Defaults to the current Business Date.
DocDesc
nvarchar(512)Description-
Description:The description of the document.
DocDiscNonexistent in DBObsolete
decimal-
Description:The document discount total (without group discounts). Given in the base currency of the company.
DocumentKey
nvarchar(50)Document Description-
Description:No description available
DontApprove
bit-
Description:Indicates that the current document should be excluded from the approval process. Maintenance of this property is on graph level.
DontEmail
bitDon't Email-
Description:No description available
DontPrint
bitDon't Print-
Description:No description available
DRSchedCntr
int-
Description:No description available
DueDate
datetime2Due Date-
Description:The due date of the document.
Emailed
bitEmailed-
Description:Specifies (if set to "true") that the document has been emailed to the customer.
EmailInvoice
bit-
Description:When set to "true", indicates that the document awaits emailing. The field is used in automation steps for the Invoices and Memos (SO303000) form and thus defines participates in determining whether the document is available for processing on the Process Invoices and Memos (SO505000) form.
ExternalRef
nvarchar(80)-
Description:No description available
FinPeriodIDDefault Navigation
char(6)Post Period-
Description:No description available
FromScheduleNonexistent in DB
bit-
Description:When set to "true" indicates that the document is generating by a "Scedule" process.
HasPPDTaxes
bit-
Description:If set to "true", indicates that the document has the taxes that reduce cash discount taxable amount on early payment.
Hold
bitHold-
Description:When set to "true" indicates that the document is on hold and thus cannot be released.
ImpRefNbr
nvarchar(15)-
Description:Implementation specific reference number of the document. This field is neither filled nor used by the core Acumatica itself, but may be utilized by customizations or extensions.
InitDocBal
decimal(19, 4)-
Description:The entered in migration mode balance of the document. Given in the base currency of the company.
IsCancellation
bit-
Description:When set to "true", indicates that the invoice is a cancellation invoice (credit memo).
IsCorrection
bitCorrection Inv.-
Description:When set to "true", indicates that the invoice is a correction invoice.
IsMigratedRecord
bit-
Description:Specifies (if set to "true") that the record has been created in migration mode without affecting GL module.
IsRetainageDocument
bitRetainage Document-
Description:No description available
IsRetainageReversing
bitRetainage Reversing-
Description:No description available
IsTaxPosted
bitTax Is Posted/Committed to External Tax Engine (Avalara)-
Description:When "true", indicates that the tax information was successfully commited to the external Tax Engine(Avalara).
IsTaxSaved
bitTax Is Saved in External Tax Engine (Avalara)-
Description:Indicates whether the tax information related to the document was saved to the external Tax Engine (Avalara).
IsTaxValid
bitTax Is Up to Date-
Description:When "true", indicates that the amount of tax calculated with the external Tax Engine(Avalara) is up to date. If this field equals "false", the document was updated since last synchronization with the Tax Engine and taxes might need recalculation.
IsUnderCorrection
bit-
Description:When set to "true", indicates that Cancel or Correct action was applied to the invoice.
LastModifiedByIDDefault Navigation
uniqueidentifierLast Modified ByUsers
Description:No description available
LastModifiedByScreenID
char(8)-
Description:No description available
LastModifiedDateTime
datetimeLast Modified On-
Description:No description available
LineCntr
int-
Description:The counter of the document lines, which is used internally to assign numbers to newly created lines. We do not recommended that you rely on this field to determine the exact number of lines, which might not be reflected by the value of this field under various conditions.
LineRetainageTotal
decimal(19, 4)-
Description:No description available
NonTaxable
bitNon-Taxable-
Description:Get or set NonTaxable that mark current document does not impose sales taxes.
NoteID
uniqueidentifier-
Description:Identifier of the Note object, associated with the document. Corresponds to the Note.NoteID field.
OpenDoc
bit-
Description:When set to "true", indicates that the document is open.
OrigDiscAmt
decimal(19, 4)-
Description:The cash discount entered for the document. Given in the base currency of the company.
OrigDocAmt
decimal(19, 4)-
Description:The amount of the document. Given in the base currency of the company.
OrigDocAmtWithRetainageTotalNonexistent in DB
decimalTotal Amount-
Description:No description available
OrigDocDate
datetime2-
Description:The date of the original document (e.g. the one reversed by this document).
OrigDocType
char(3)Orig. Doc. TypeARRegister
Description:The type of the original (source) document. Corresponds to the DocType field.
OrigModule
char(2)Source-
Description:The module from which the document originates. The field can have one of the values described in BatchModule.FullListAttribute.
OrigRefNbr
nvarchar(15)Orig. Ref. Nbr.-
Description:The reference number of the original (source) document. Corresponds to the RefNbr field.
PaymentsByLinesAllowed
bitPay by Line-
Description:No description available
PendingPayment
bit-
Description:When set to "true", indicates that the prepayment ready for payment applicaton when the feature FeaturesSet.VATRecognitionOnPrepayments is activated.
PendingPPD
bit-
Description:If set to "true", indicates that the document has been fully paid and to close the document, you need to apply the cash discount by generating a credit memo on the Generate AR Tax Adjustments (AR504500) form.
PendingProcessing
bit-
Description:No description available
PostponePendingPaymentFlagNonexistent in DB
bit-
Description:Indicates that events will be invoke in the ARDocumentRelease.ProcessPostponedFlags() method for pendingPayment field. Uses when the feature FeaturesSet.VATRecognitionOnPrepayments is activated.
PrepaymentAccountIDDefault Navigation
intPrepayment AccountAccount
Description:No description available
PrepaymentSubIDDefault Navigation
intPrepayment SubaccountSub
Description:The identifier of the subaccount to which the Tax and Taxable amounts should be posted when the feature FeaturesSet.VATRecognitionOnPrepayments is activated. Corresponds to the Sub.SubID field.
PrintDocTypeNonexistent in DB
nchar(3)Type-
Description:The type of the document for printing, which is used in reports. The field can have one of the values described in ARDocType.PrintListAttribute.
Printed
bitPrinted-
Description:Specifies (if set to "true") that the document has been printed.
PrintInvoice
bit-
Description:When set to "true", indicates that the document awaits printing. The field is used in automation steps for the Invoices and Memos (SO303000) form and thus defines participates in determining whether the document is available for processing on the Process Invoices and Memos (SO505000) form.
RefNoteID
uniqueidentifier-
Description:No description available
Rejected
bit-
Description:No description available
Released
bit-
Description:When set to "true", indicates that the document has been released.
ReleasedToVerifyNonexistent in DB
bit-
Description:When set, on persist checks, that the document has the corresponded Released original value. When not set, on persist checks, that Released value is not changed. Throws an error otherwise.
RetainageAcctIDDefault Navigation
intRetainage Receivable AccountAccount
Description:No description available
RetainageApply
bitApply Retainage-
Description:No description available
RetainagePaidTotalNonexistent in DB
decimal-
Description:No description available
RetainageReleased
decimal(19, 4)Released Retainage-
Description:No description available
RetainageSubIDDefault Navigation
intRetainage Receivable Sub.Sub
Description:No description available
RetainageTotal
decimal(19, 4)Original Retainage-
Description:No description available
RetainageUnpaidTotal
decimal(19, 4)-
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:Realized Gain or Loss amount associated with the document. Given in the base currency of the company.
RoundDiff
decimal(19, 4)-
Description:The difference between the original amount of the document and the rounded amount, in the base currency of the company. The field is used only if the Invoice Rounding feature is enabled.
SalesPersonIDDefault Navigation
intSalesperson IDSalesPerson
Description:The identifier of the salesperson to whom the document belongs. Corresponds to the CustSalesPeople.SalesPersonID field.
Scheduled
bit-
Description:When set to "true" indicates that the document is part of a "Schedule" and serves as a template for generating other documents according to it.
ScheduleID
nvarchar(15)Schedule
Description:Identifier of the Schedule, associated with the document. In case Scheduled is "true", the field points to the Schedule, to which the document belongs as a template. Otherwise, the field points to the Schedule, from which this document was generated, if any. Corresponds to the Schedule.ScheduleID field.
SelectedNonexistent in DB
bitSelected-
Description:Indicates whether the record is selected for processing.
SelfVoidingDocNonexistent in DB
bit-
Description:When "true", indicates that the document can be voided only in full and it is not allow to delete reversing applications partially.
StatementDate
datetime2-
Description:The date of the Customer Statement, in which the document is reported. Corresponds to the ARStatement.StatementDate field.
Status
char(1)Status-
Description:The status of the document. The value of the field is determined by the values of the status flags, such as Hold, Released, Voided, Scheduled. The field can have one of the values described in ARDocStatus.ListAttribute. Defaults to ARDocStatus.Hold.
TaxCalcMode
char(1)Tax Calculation Mode-
Description:No description available
TranPeriodID
char(6)-
Description:Financial Period of the document. Determined by the date of the document. Unlike ARRegister.FinPeriodID the value of this field can't be overriden by user.
tstamp
timestamp-
Description:No description available
Voided
bit-
Description:When set to "true" indicates that the document has been voided.