AR
ARInvoice
Represents the accounts receivable invoices, credit and debit memos, overdue charges and credit write-offs as well as the invoices created in the Sales Orders module (see SO.SOInvoice). The records of this type are created and edited on the Invoices and Memos (AR301000) form (which corresponds to the ARInvoiceEntry graph). The SO invoices are created and edited through the Invoices (SO303000) form (which corresponds to the SOInvoiceEntry graph).
View API Entity: SalesInvoice
/entity/Default/25.200.001/SalesInvoice| Field Name | Type | Display Name | Foreign Key | |
|---|---|---|---|---|
ARAccountID | int | AR Account | Account | |
Description:The identifier of the AR account to which the document should be posted. The Cash account and Year-to-Date Net Income account cannot be selected as the value of this field. Corresponds to the Account.AccountID field. | ||||
ARSubID | int | AR Subaccount | Sub | |
Description:The identifier of the subaccount to which the document should be posted. Corresponds to the Sub.SubID field. | ||||
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. | ||||
ApplicationBalanceNonexistent in DB | decimal? | - | ||
Description:No description available | ||||
ApplyOverdueCharge | bit | Apply Overdue Charges | - | |
Description:Specifies (if set to "true") that the document can be available on the Calculate Overdue Charges (AR507000) processing form. | ||||
ApplyPaymentWhenTaxAvailableNonexistent in DB | bool? | - | ||
Description:Specifies (if set to "true") that the Avalara taxes should be included in the document balance calculation (because these taxes will be calculated only during the release process). | ||||
Approved | bit | - | ||
Description:No description available | ||||
ApprovedCaptureFailed | bit | - | ||
Description:Specifies (if set to "true") that invoice has been approved with CC payment that failed on attempt to capture. | ||||
ApprovedCredit | bit | - | ||
Description:Specifies (if set to "true") that credit has been approved for the document. | ||||
ApprovedCreditAmt | decimal | - | ||
Description:The amount of credit approved for the document. | ||||
ApprovedPrepaymentRequired | bit | - | ||
Description:Specifies (if set to "true") that invoice has been approved not fully prepaid. | ||||
ApproverID | int | Owner | Contact | |
Description:No description available | ||||
ApproverWorkgroupID | int | EPCompanyTree | ||
Description:No description available | ||||
AuthorizedPaymentCntr | int | - | ||
Description:The counter of the applied payments in pre-authorized status. | ||||
AvalaraCustomerUsageType | char(1) | Tax Exemption Type | - | |
Description:The customer entity type for reporting purposes. The field is used if the system is integrated with External Tax Calculation and the External Tax Calculation Integration feature is enabled. The field can have one of the values described in . Defaults to the customer entity type that is specified for the location of the customer. | ||||
BalanceWOTotal | decimal | - | ||
Description:No description available | ||||
BatchNbr | nvarchar(15) | Batch Nbr. | Batch | |
Description:The number of the Batch created from the document on release. Corresponds to the Batch.BatchNbr field. | ||||
BatchSeq | smallint | - | ||
Description:The batch sequence number. The field is not used. | ||||
BillAddressID | int | ARAddress | ||
Description:The identifier of the Billing Address object, associated with the customer. Corresponds to the ARAddress.AddressID field. | ||||
BillContactID | int | Billing Contact | ARContact | |
Description:The identifier of the Billing Contact object, associated with the customer. Corresponds to the ARContact.ContactID field. | ||||
BranchBaseCuryIDNonexistent in DB | string | - | ||
Description:No description available | ||||
BranchID | int | Branch | Branch | |
Description:The identifier of the branch to which the document belongs. Corresponds to the Branch.BranchID field. | ||||
CCAuthorizedAmtNonexistent in DB | decimal? | - | ||
Description:No description available | ||||
Canceled | bit | - | ||
Description:When set to "true", indicates that the invoice was canceled or corrected. | ||||
CaptureFailedCntr | int | - | ||
Description:No description available | ||||
CashAccountID | int | Cash Account | CashAccount | |
Description:The identifier of the Cash Account associated with the document. Defaults to the Cash Account selected for the Customer Payment Method, or (if the above is unavailable) to the Cash Account selected as the default one for Accounts Receivable in the settings of the Payment Method (see the PaymentMethodAccount.ARIsDefault field). | ||||
ChargeAmt | decimal | - | ||
Description:The total of all finance charges applied to the document. Given in the base currency of the company. | ||||
ClDisplayNameNonexistent in DB | string | - | ||
Description:No description available | ||||
ClosedDate | datetime | Closed Date | - | |
Description:The date of the last application. | ||||
ClosedFinPeriodID | string | Closed Period | - | |
Description:The Financial Period, in which the document was closed. Corresponds to the FinPeriodID field. | ||||
ClosedTranPeriodID | string | Closed Period | - | |
Description:The Financial Period, in which the document was closed. Corresponds to the TranPeriodID field. | ||||
CommnAmt | decimal | - | ||
Description:The commission amount calculated on this document for the salesperson. Given in the base currency of the company. | ||||
CommnPct | decimal | Commission % | - | |
Description:The commission percent used for the salesperson. | ||||
CommnblAmt | decimal | - | ||
Description:The amount used as the base to calculate commission for this document. Given in the base currency of the company. | ||||
CorrectionDocTypeNonexistent in DB | string | - | ||
Description:The type of the correction document. Corresponds to the DocType field. | ||||
CorrectionRefNbrNonexistent in DB | string | - | ||
Description:The reference number of the correction document. Corresponds to the RefNbr field. | ||||
CreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
CreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
CreatedDateTime API | datetime | Created On | - | |
Description:No description available | ||||
CreditHold API | bit | Credit Hold | - | |
Description:When set to "true" indicates that the document is on credit hold, which means that the credit check failed for the Customer. The document can't be released while it's on credit hold. | ||||
CuryApplicationBalanceNonexistent in DB | decimal? | Application Balance | - | |
Description:No description available | ||||
CuryBalanceWOTotal | decimal | Write-Off Total | - | |
Description:No description available | ||||
CuryCCAuthorizedAmtNonexistent in DB | decimal? | Authorized | - | |
Description:No description available | ||||
CuryChargeAmt | decimal | Finance Charges | - | |
Description:The total of all finance charges applied to the document. Given in the currency of the document. | ||||
CuryCommnAmt | decimal | Commission Amt. | - | |
Description:The commission amount calculated on this document for the salesperson. Given in the currency of the document. | ||||
CuryCommnblAmt | decimal | Total Commissionable | - | |
Description:The amount used as the base to calculate commission for this document. Given in the currency of the document. | ||||
CuryDetailExtPriceTotalNonexistent in DB | decimal? | Detail Total | - | |
Description:The sum of the goods and the misc. charges amount values. | ||||
CuryDiscAppliedAmt | decimal | Cash Discount Taken | - | |
Description:No description available | ||||
CuryDiscBal | decimal | Cash Discount Balance | - | |
Description:The cash discount balance of the document. Given in the currency of the document. | ||||
CuryDiscTaken | decimal | - | ||
Description:The cash discount amount actually applied to the document. Given in the currency of the document. | ||||
CuryDiscTot API | decimal | Group and Document Discount Total | - | |
Description:The group and document discount total for the document. Given in the currency of the document. | ||||
CuryDiscountedDocTotalNonexistent in DB | decimal? | Discounted Doc. Total | - | |
Description:The discounted amount of the document. Given in the currency of the document. | ||||
CuryDiscountedPriceNonexistent in DB | decimal? | Tax 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 | decimal? | Discounted Taxable Total | - | |
Description:No description available | ||||
CuryDocBal API | decimal | Balance | - | |
Description:The open balance of the document. Given in the currency of the document. | ||||
CuryDocDiscNonexistent in DBObsolete | decimal? | Document Discount | - | |
Description:The document discount total (without group discounts). Given in the currency of the document. | ||||
CuryDocumentDiscTotal | decimal | Document Discount | - | |
Description:The total discount of the document (in the currency of the document), which is calculated as the sum of document discounts of the invoice. | ||||
CuryFreightAmt API | decimal | Freight Price | - | |
Description:The amount of freight associated with the document. Given in the currency of the document. | ||||
CuryFreightCost | decimal | Freight Cost | - | |
Description:Freight cost of the document. Given in the currency of the document. | ||||
CuryFreightTot | decimal | Freight Total | - | |
Description:The total amount of freight associated with the document. Given in the currency of the document. | ||||
CuryGoodsExtPriceTotal | decimal | Goods | - | |
Description:The total amount on all lines of the document, except for Misc. Charges, before Line-level discounts are applied (in the currency of the document). | ||||
CuryGoodsTotal | decimal | Goods Total | - | |
Description:The total goods amount of the lines of the document. Given in the currency of the document. | ||||
CuryGroupDiscTotal | decimal | Group Discounts | - | |
Description:The total discount of the document (in the currency of the document), which is calculated as the sum of group discounts of the invoice. | ||||
CuryID API | nvarchar(5) | Currency | Currency | |
Description:The code of the Currency of the document. Defaults to the base currency of the company. Corresponds to the Currency.CuryID field. | ||||
CuryInfoID | bigint | CurrencyInfo | ||
Description:The identifier of the CurrencyInfo object associated with the document. Corresponds to the CurrencyInfoID field. | ||||
CuryInitDocBal | decimal | Balance | - | |
Description:The entered in migration mode balance of the document. Given in the currency of the document. | ||||
CuryLineDiscTotal | decimal | Line Discounts | - | |
Description:The total discount of the document (in the currency of the document), which is calculated as the sum of line discounts of the order. | ||||
CuryLineRetainageTotal | decimal | - | ||
Description:No description available | ||||
CuryLineTotal API | decimal | Detail Total | - | |
Description:The total amount of the lines of the document. Given in the currency of the document. | ||||
CuryMiscExtPriceTotal | decimal | Misc. Charges | - | |
Description:The total amount calculated as the sum of the amounts in Ext. Price of the order non-stock items (in the currency of the document). | ||||
CuryMiscTot | decimal | Misc. Total | - | |
Description:The total misc amount of the lines of the document. Given in the currency of the document. | ||||
CuryOrderDiscTotalNonexistent in DB | decimal? | Discount Total | - | |
Description:The total discount of the document (in the currency of the document), which is calculated as the sum of all group, document and line discounts of the invoice. | ||||
CuryOrigDiscAmt API | decimal | Cash Discount | - | |
Description:The cash discount entered for the document. Given in the currency of the document. | ||||
CuryOrigDocAmt API | decimal | Amount | - | |
Description:The amount of the document. Given in the currency of the document. | ||||
CuryOrigDocAmtWithRetainageTotalNonexistent in DB | decimal? | Total Amount | - | |
Description:No description available | ||||
CuryPaidAmtNonexistent in DB | decimal? | Released | - | |
Description:No description available | ||||
CuryPaymentTotal API | decimal | Total Paid | - | |
Description:No description available | ||||
CuryPremiumFreightAmt | decimal | Premium Freight Price | - | |
Description:The amount of premium freight associated with the document. Given in the currency of the document. | ||||
CuryPrepaymentAmtNonexistent in DB | decimal? | - | ||
Description:Part of the Sales Order amount on which a PPI document is creating. | ||||
CuryRetainagePaidTotalNonexistent in DB | decimal? | Paid/Adjusted Retainage | - | |
Description:No description available | ||||
CuryRetainageReleased | decimal | Released Retainage | - | |
Description:No description available | ||||
CuryRetainageTotal | decimal | Original Retainage | - | |
Description:No description available | ||||
CuryRetainageUnpaidTotal | decimal | Unpaid Retainage | - | |
Description:No description available | ||||
CuryRetainageUnreleasedAmt | decimal | Unreleased Retainage | - | |
Description:No description available | ||||
CuryRetainedDiscTotal | decimal | Discount on Retainage | - | |
Description:No description available | ||||
CuryRetainedTaxTotal | decimal | Tax on Retainage | - | |
Description:No description available | ||||
CuryRoundDiff | decimal | 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. | ||||
CuryTaxTotal API | decimal | Tax Total | - | |
Description:The total amount of tax associated with the document. Given in the currency of the document. | ||||
CuryUnpaidBalance | decimal | Unpaid Balance | - | |
Description:No description available | ||||
CuryUnreleasedPaymentAmtNonexistent in DB | decimal? | Not Released | - | |
Description:No description available | ||||
CuryVatExemptTotal API | decimal | Tax Exempt Total | - | |
Description:The portion of the document total that is exempt from VAT. Given in the currency of the document. This field is relevant only if the VAT Reporting feature is enabled. The value of this field is calculated as the taxable amount for the tax with Tax.ExemptTax set to "true". | ||||
CuryVatTaxableTotal API | decimal | Taxable Total | - | |
Description:The portion of the document total that is subjected to VAT. Given in the currency of the document. This field is relevant only if the VAT Reporting feature is enabled. | ||||
CuryWhTaxBalNonexistent in DB | decimal? | - | ||
Description:The balance of tax withheld on the document. Given in the currency of the document. | ||||
CustomerBaseCuryIDNonexistent in DB | string | - | ||
Description:No description available | ||||
CustomerID API | int | Customer | Customer | |
Description:The identifier of the Customer record associated with the document. Corresponds to the BAccount.BAccountID field. | ||||
CustomerLocationID | int | Location | Location | |
Description:Identifier of the Location of the Customer. Defaults to the Default Location of the Customer if it is specified, or to the first found Location, associated with the Customer. Corresponds to the Location.LocationID field. | ||||
DRSchedCntr | int | - | ||
Description:No description available | ||||
DefRetainagePct | decimal | Default Retainage Percent | - | |
Description:No description available | ||||
DeferPriceDiscountRecalculationNonexistent in DB | bool? | Defer Price/Discount Recalculation | - | |
Description:No description available | ||||
DeliveryMethod | char(1) | Link Delivery Method | - | |
Description:Payment Link delivery method (N - none, E - email). | ||||
DetailExtPriceTotalNonexistent in DB | decimal? | - | ||
Description:The sum of the goods and the misc. charges amount values. | ||||
DisableAutomaticDiscountCalculation | bit | Disable Automatic Discount Update | - | |
Description:No description available | ||||
DisableAutomaticTaxCalculation | bit | Disable Automatic Tax Calculation | - | |
Description:No description available | ||||
DiscAppliedAmt | decimal | - | ||
Description:No description available | ||||
DiscBal | decimal | - | ||
Description:The cash discount balance of the document. Given in the base currency of the company. | ||||
DiscDate | datetime | Cash Discount Date | - | |
Description:The date when the cash discount can be taken in accordance with the credit terms. | ||||
DiscTaken | decimal | - | ||
Description:The cash discount amount actually applied to the document. Given in the base currency of the company. | ||||
DiscTot | decimal | - | ||
Description:The group and document discount total for 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. | ||||
DisplayCuryInitDocBalNonexistent in DB | decimal? | Migrated Balance | - | |
Description:The non database field, displaying an entered in migration mode balance of the document ARRegister.CuryInitDocBal. Given in the currency of the document. Added to configure the different visibility of one field on one DAC cache. | ||||
DocBal | decimal | - | ||
Description:The open balance of the document. Given in the base currency of the company. | ||||
DocClassNonexistent in DB | string | - | ||
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 API | datetime | Date | - | |
Description:The date of the document. Defaults to the current Business Date. | ||||
DocDesc API | 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. | ||||
DocType API | 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 ARInvoiceType.ListAttribute. | ||||
DocumentDiscTotal | decimal | Document Discount | - | |
Description:The total document discount of the document, which is calculated as the sum of document discounts of the invoice. If the Customer Discounts feature is not enabled on the Enable/Disable Features (CS100000) form, a user can enter a document-level discount manually. This manual discount has no discount code or sequence and is not recalculated by the system. If the manual discount needs to be changed, a user has to correct it manually. | ||||
DocumentKeyNonexistent in DB | string | 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 | bit | Don't Email | - | |
Description:When set to "true" indicates that the document should not be sent to the Customer by email, and thus the system should not include it in the list of documents available for mass-emailing. Defaults to the value of the Customer.MailInvoices setting of the Customer. | ||||
DontPrint | bit | Don't Print | - | |
Description:When set to "true" indicates that the document should not be sent to the Customer as a printed document, and thus the system should not include it in the list of documents available for mass-printing. Defaults to the value of the Customer.PrintInvoices setting of the Customer. | ||||
DrCrNonexistent in DB | string | - | ||
Description:Read-only field indicating whether the document is of debit or credit type. Possible values are DrCr.Credit (for Invoice, Debit Memo, Financial Charge, Small Credit Write-Off and Cash Sale) and DrCr.Debit (for Credit Memo and Cash Return). | ||||
DueDate API | datetime | Due Date | - | |
Description:The due date of the document. | ||||
EmailCountNonexistent in DB | int? | - | ||
Description:No description available | ||||
EmailInvoiceNonexistent in DB | bool? | - | ||
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. | ||||
Emailed | bit | Emailed | - | |
Description:Specifies (if set to "true") that the document has been emailed to the customer. | ||||
ExternalRef API | nvarchar(80) | - | ||
Description:No description available | ||||
ExternalTaxExemptionNumber | nvarchar(30) | Tax Exemption Number | - | |
Description:The tax exemption number for reporting purposes. The field is used if the system is integrated with External Tax Calculation and the External Tax Calculation Integration feature is enabled. | ||||
bool? | - | |||
Description:No description available | ||||
FinPeriodID | string | Post Period | FinPeriod | |
Description:Financial Period of the document. Defaults to the period, to which the ARRegister.DocDate belongs, but can be overriden by user. | ||||
FreightAmt | decimal | - | ||
Description:The amount of freight associated with the document. Given in the base currency of the company. | ||||
FreightCost | decimal | - | ||
Description:Freight cost of the document. Given in the base currency of the company. | ||||
FreightTot | decimal | - | ||
Description:The total amount of freight associated with the document. Given in the base currency of the company. | ||||
FromScheduleNonexistent in DB | bool? | - | ||
Description:When set to "true" indicates that the document is generating by a "Scedule" process. | ||||
GoodsExtPriceTotal | decimal | - | ||
Description:The total amount on all lines of the document, except for Misc. Charges, before Line-level discounts are applied. This total is calculated as the sum of the amounts in the Ext. Price for all stock items and non-stock items that require shipment. This total does not include the freight amount. This field is not available for transfer orders. This field is available only if the Inventory feature is enabled on the Enable/Disable Features (CS100000) form. | ||||
GoodsTotal | decimal | - | ||
Description:The total goods amount of the lines of the document. Given in the base currency of the company. | ||||
GroupDiscTotal | decimal | Group Discounts | - | |
Description:The total group discount of the document, which is calculated as the sum of group discounts of the invoice. | ||||
HasFSEquipmentInfoNonexistent in DB | bool? | - | ||
Description:No description available | ||||
HasPPDTaxes | bit | - | ||
Description:If set to "true", indicates that the document has the taxes that reduce cash discount taxable amount on early payment. | ||||
HiddenNonexistent in DB | bool? | - | ||
Description:Specifies (if set to "true") that the document can be associated with only one sales order (which happens when SOOrder.BillSeparately is set to "true" for the sales order). | ||||
HiddenByShipmentNonexistent in DB | bool? | - | ||
Description:Specifies (if set to "true") that the document can be associated with only one shipment. | ||||
HiddenOrderNbrNonexistent in DB | string | - | ||
Description:The SOOrder.OrderNbr reference number of the related sales order when the document can be associated with only one sales order (which happens when SOOrder.BillSeparately is set to "true" for the sales order). | ||||
HiddenOrderTypeNonexistent in DB | string | - | ||
Description:The SOOrder.OrderType type of the related sales order when the document can be associated with only one sales order (which happens when SOOrder.BillSeparately is set to "true" for the sales order). | ||||
HiddenShipmentNbrNonexistent in DB | string | - | ||
Description:The SOShipment.ShipmentNbr reference number of the related shipment when the document can be associated with only one shipment. | ||||
HiddenShipmentTypeNonexistent in DB | string | - | ||
Description:The SOShipment.ShipmentType type of the related shipment when the document can be associated with only one shipment. | ||||
Hold API | bit | Hold | - | |
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 | - | ||
Description:The entered in migration mode balance of the document. Given in the base currency of the company. | ||||
InstallmentCntr | smallint | - | ||
Description:The counter of installments associated with the document. | ||||
InstallmentNbr | smallint | - | ||
Description:For the document representing one of several installments this field stores the number of the installment. | ||||
InternalDocTypeNonexistent in DB | string | Document Type (Internal) | - | |
Description:No description available | ||||
InvoiceDate | datetime | Customer Ref. Date | - | |
Description:The original date assigned by the customer to the customer document. | ||||
InvoiceNbr API | nvarchar(40) | Customer Order Nbr. | - | |
Description:The original reference number or ID assigned by the customer to the customer document. | ||||
IsCancellation | bit | - | ||
Description:When set to "true", indicates that the invoice is a cancellation invoice (credit memo). | ||||
IsCorrection | bit | Correction Inv. | - | |
Description:When set to "true", indicates that the invoice is a correction invoice. | ||||
IsFirstEmailNonexistent in DB | bool? | - | ||
Description:No description available | ||||
IsHiddenInIntercompanySales | bit | Exclude from Intercompany Processing | - | |
Description:No description available | ||||
IsLoadApplicationsNonexistent in DB | bool? | - | ||
Description:If "true", available applications are not loaded automatically during an invoice creation that is executed in an import scenario or an API call. If the value is "false", the automatic loading is on. The default value is "true". | ||||
IsMigratedRecord | bit | - | ||
Description:Specifies (if set to "true") that the record has been created in migration mode without affecting GL module. | ||||
IsPaymentsTransferred | bit | - | ||
Description:A Boolean field that indicates whether the payments and prepayment applied to the related sales orders should be transferred to the invoice during the document creation. When set to false, the payments and prepayments will not be transferred to the invoice during the document creation but will be transferred within the Complete Processing actions execution when all orders are already added to the invoice. | ||||
IsPriceAndDiscountsValidNonexistent in DB | bool? | Prices and discounts are up to date. | - | |
Description:No description available | ||||
IsRetainageDocument | bit | Retainage Document | - | |
Description:No description available | ||||
IsRetainageReversing | bit | Retainage Reversing | - | |
Description:No description available | ||||
IsTaxPosted | bit | Tax 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 | bit | Tax 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 | bit | Tax 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. | ||||
IsUnderCancellationNonexistent in DB | bool? | - | ||
Description:When set to "true", indicates that Cancel action was applied to the invoice. | ||||
IsUnderCorrection | bit | - | ||
Description:When set to "true", indicates that Cancel or Correct action was applied to the invoice. | ||||
LastFinChargeDateNonexistent in DB | DateTime? | Last Fin. Charge Date | - | |
Description:The date of the most recent Financial Charge associated with this document. | ||||
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 | ||||
LastPaymentDateNonexistent in DB | DateTime? | Last Payment Date | - | |
Description:The date of the most recent payment associated with this document. | ||||
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. | ||||
LineDiscTotal | decimal | Line Discounts | - | |
Description:The total line discount of the document, which is calculated as the sum of line discounts of the invoice. | ||||
LineRetainageTotal | decimal | - | ||
Description:No description available | ||||
LineTotal | decimal | - | ||
Description:The total amount of the lines of the document. Given in the base currency of the company. | ||||
MasterRefNbr | nvarchar(15) | - | ||
Description:For the document representing one of several installments this field stores the RefNbr of the master document - the one, to which the installment belongs. | ||||
MiscExtPriceTotal | decimal | - | ||
Description:The total amount calculated as the sum of the amounts in Ext. Price of the order non-stock items. This field is not available for transfer orders. | ||||
MiscTot | decimal | - | ||
Description:The total misc amount of the lines of the document. Given in the base currency of the company. | ||||
MultiShipAddress | bit | Multiple Ship-To Addresses | - | |
Description:The flag indicating that there are multiple shipments or orders with different addresses included in the invoice. | ||||
NonTaxable | bit | Non-Taxable | - | |
Description:Get or set NonTaxable that mark current document does not impose sales taxes. | ||||
NoteID | uniqueidentifier | - | ||
Description:The 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. | ||||
OrderDiscTotalNonexistent in DB | decimal? | Discount Total | - | |
Description:The total discount of the document, which is calculated as the sum of group, document and line discounts of the invoice. | ||||
OrigDiscAmt | decimal | - | ||
Description:The cash discount entered for the document. Given in the base currency of the company. | ||||
OrigDocAmt | decimal | - | ||
Description:The amount of the document. Given in the base currency of the company. | ||||
OrigDocAmtWithRetainageTotalNonexistent in DB | decimal? | Total Amount | - | |
Description:No description available | ||||
OrigDocDate | datetime | - | ||
Description:The date of the original document (e.g. the one reversed by this document). | ||||
OrigDocType | char(3) | Orig. Doc. Type | ARRegister | |
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. | ARRegister | |
Description:The reference number of the original (source) document. Corresponds to the RefNbr field. | ||||
OwnerID | int | Owner | Contact | |
Description:The Contact responsible for the document. Corresponds to the Contact.ContactID field. | ||||
PMInstanceID | int | Card/Account Nbr. | CustomerPaymentMethod | |
Description:The identifier of the customer payment method (card or account number) associated with the document. Defaults according to the settings of the customer payment methods that are specified for the customer associated with the document. Corresponds to the CustomerPaymentMethod.PMInstanceID field. | ||||
PaidAmtNonexistent in DB | decimal? | - | ||
Description:No description available | ||||
PayLinkID | int | - | ||
Description:Acumatica specific Payment Link Id. | ||||
PaymentMethodID | nvarchar(10) | Payment Method | PaymentMethod | |
Description:The identifier of the payment method that is used for the document. Corresponds to the PaymentMethod.PaymentMethodID field. | ||||
PaymentTotal | decimal | Total Paid | - | |
Description:No description available | ||||
PaymentsByLinesAllowed | bit | Pay by Line | - | |
Description:Specifies (if set to "true") that the record has been created with activated FeaturesSet.PaymentsByLines feature and such document allow payments by lines. | ||||
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. | ||||
PendingPayment | bit | - | ||
Description:When set to "true", indicates that the prepayment ready for payment applicaton when the feature FeaturesSet.VATRecognitionOnPrepaymentsAR is activated. | ||||
PendingProcessing | bit | - | ||
Description:No description available | ||||
PendingProcessingCntr | int | - | ||
Description:No description available | ||||
PostponePendingPaymentFlagNonexistent in DB | bool? | - | ||
Description:Indicates that events will be invoke in the ARDocumentRelease.ProcessPostponedFlags() method for pendingPayment field. Uses when the feature FeaturesSet.VATRecognitionOnPrepaymentsAR is activated. | ||||
PremiumFreightAmt | decimal | - | ||
Description:The amount of premium freight associated with the document. Given in the base currency of the company. | ||||
PrepaymentAccountID | int | Prepayment Account | Account | |
Description:The identifier of the account to which the Tax and Taxable amounts should be posted when the feature FeaturesSet.VATRecognitionOnPrepaymentsAR is activated. The Cash account and Year-to-Date Net Income account cannot be selected as the value of this field. Corresponds to the Account.AccountID field. | ||||
PrepaymentSubID | int | Prepayment Subaccount | Sub | |
Description:The identifier of the subaccount to which the Tax and Taxable amounts should be posted when the feature FeaturesSet.VATRecognitionOnPrepaymentsAR is activated. Corresponds to the Sub.SubID field. | ||||
PrintCuryDocTotalWithoutTaxNonexistent in DB | decimal? | - | ||
Description:This field is for calculating the correct document total without taxes and without the cash discount. It is for printing only. CuryDocBal has the right amount but only until the invoice is released or until payments are applied so it cannot be used reliably. When it's a cash sale, CuryDocBal's value drops to zero soon as the invoice is released. Instead of using CuryDocBal we compute the amount we need by using the following logic: CuryOrigDocAmt - CuryTaxTotal if cash sale or cash return and cash discount is not zero + CuryOrigDiscAmt | ||||
PrintDocTypeNonexistent in DB | string | 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. | ||||
PrintInvoiceNonexistent in DB | bool? | - | ||
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. | ||||
Printed | bit | Printed | - | |
Description:Specifies (if set to "true") that the document has been printed. | ||||
ProcessingCenterID | nvarchar(10) | Processing Center | CCProcessingCenter | |
Description:No description available | ||||
ProformaExists | bit | Pro Forma Invoice Exists | - | |
Description:If true a corresponding proforma document exists thus making this document (or part of it) read-only. | ||||
ProjectID API | int | Contract | Contract | |
Description:The identifier of the project associated with the document or the non-project code, which indicates that the document is not related to any particular project. Corresponds to the PMProject.ProjectID field. | ||||
RGOLAmt | decimal | - | ||
Description:Realized Gain or Loss amount associated with the document. Given in the base currency of the company. | ||||
RefNbr API | nvarchar(15) | Reference Nbr. | ARRegisterAlias | |
Description:The reference number of the document. This field is a part of the compound key of the document. For most document types, the reference number is generated automatically from the corresponding numbering sequence, which is specified in the Accounts Receivable module preferences. | ||||
RefNoteID | uniqueidentifier | - | ||
Description:The identifier of the Note object associated with the document reference. Corresponds to the Note.NoteID field. | ||||
Rejected | bit | - | ||
Description:No description available | ||||
Released | bit | - | ||
Description:When set to "true", indicates that the document has been released. | ||||
ReleasedToVerifyNonexistent in DB | bool? | - | ||
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. | ||||
RetainageAcctID | int | Retainage Receivable Account | Account | |
Description:No description available | ||||
RetainageApply | bit | Apply Retainage | - | |
Description:No description available | ||||
RetainagePaidTotalNonexistent in DB | decimal? | - | ||
Description:No description available | ||||
RetainageReleased | decimal | Released Retainage | - | |
Description:No description available | ||||
RetainageSubID | int | Retainage Receivable Sub. | Sub | |
Description:No description available | ||||
RetainageTotal | decimal | Original Retainage | - | |
Description:No description available | ||||
RetainageUnpaidTotal | decimal | - | ||
Description:No description available | ||||
RetainageUnreleasedAmt | decimal | Unreleased Retainage | - | |
Description:No description available | ||||
RetainedDiscTotal | decimal | - | ||
Description:No description available | ||||
RetainedTaxTotal | decimal | - | ||
Description:No description available | ||||
Revoked | bit | Revoked | - | |
Description:Specifies (if set to "true") that the document has been revoked. | ||||
RoundDiff | decimal | - | ||
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. | ||||
SalesPersonID | int | Default Salesperson | SalesPerson | |
Description:The identifier of the salesperson to whom the document belongs. Corresponds to the CustSalesPeople.SalesPersonID field. | ||||
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. | ||||
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. | ||||
SelectedNonexistent in DB | bool? | Selected | - | |
Description:Indicates whether the record is selected for processing. | ||||
SelfVoidingDocNonexistent in DB | bool? | - | ||
Description:When "true", indicates that the document can be voided only in full and it is not allow to delete reversing applications partially. | ||||
ShipAddressID | int | ARAddress | ||
Description:The identifier of the Shipping Address object, associated with the customer. Corresponds to the ARAddress.AddressID field. | ||||
ShipContactID | int | Shipping Contact | ARContact | |
Description:The identifier of the Shipping Contact object, associated with the customer. Corresponds to the ARContact.ContactID field. | ||||
StatementDate | datetime | - | ||
Description:The date of the Customer Statement, in which the document is reported. Corresponds to the ARStatement.StatementDate field. | ||||
Status API | 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, CRCaseStatusesAttribute.Released, Voided, Scheduled. The field can have one of the values described in ARDocStatus.ListAttribute. Defaults to ARDocStatus.Hold. | ||||
TaxCalcMode API | char(1) | Tax Calculation Mode | - | |
Description:No description available | ||||
TaxTotal | decimal | - | ||
Description:The total amount of tax associated with the document. Given in the base currency of the company. | ||||
TaxZoneID | nvarchar(10) | Customer Tax Zone | TaxZone | |
Description:The identifier of the TaxZone associated with the document. Corresponds to the TaxZone.TaxZoneID field. | ||||
TermsID | nvarchar(10) | Terms | Terms | |
Description:The identifier of the Credit Terms object associated with the document. Defaults to the credit terms that are selected for the customer. Corresponds to the Terms.TermsID field. | ||||
TranPeriodID | string | - | ||
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. | ||||
UnpaidBalance | decimal | - | ||
Description:No description available | ||||
UnreleasedPaymentAmtNonexistent in DB | decimal? | - | ||
Description:No description available | ||||
VatExemptTotal | decimal | - | ||
Description:The portion of the document total that is exempt from VAT. Given in the base currency of the company. This field is relevant only if the VAT Reporting feature is enabled. The value of this field is calculated as the taxable amount for the tax with Tax.ExemptTax set to "true". | ||||
VatTaxableTotal | decimal | - | ||
Description:The portion of the document total that is subjected to VAT. Given in the base currency of the company. This field is relevant only if the VAT Reporting feature is enabled. | ||||
Voided | bit | - | ||
Description:When set to "true" indicates that the document has been voided. | ||||
WhTaxBalNonexistent in DB | decimal? | - | ||
Description:The balance of tax withheld on the document. Given in the base currency of the company. | ||||
WorkgroupID | int | EPCompanyTree | ||
Description:The workgroup that is responsible for the document. Corresponds to the EPCompanyTree.WorkGroupID field. | ||||
tstamp | timestamp | - | ||
Description:No description available | ||||