Skip to main content
GL

Batch

PX.Objects.GL
Field NameTypeDisplay NameForeign Key
BatchNbr API Default Navigation
nvarchar(15)Batch Number-
Description:Key field. Auto-generated unique number of the batch. The number is generated from the Numbering Sequence specified in the setup record of the Module, to which the batch belongs. For example, the numbering sequence for the batches belonging to the General Ledger module is specified in the GLSetup.BatchNumberingID field. For other modules see corresponding setup DACs.
Module API
char(2)Module-
Description:Key field. The code of the module, to which the batch belongs. Allowed values are: "GL", "AP", "AR", "CM", "CA", "IN", "DR", "FA", "PM", "TX", "SO", "PO".
Approved
bit-
Description:No description available
ApproverIDDefault NavigationNonexistent in DB
intOwnerContact
Description:No description available
ApproverWorkgroupIDDefault NavigationNonexistent in DB
intEPCompanyTree
Description:No description available
AutoReverse
bitAuto Reversing-
Description:When set to "true", indicates that the batch is auto-reversing. For a batch of this kind the system automatically generates a reversing batch in the next period. The reversing batch is generated either when the original batch is posted or when it is released, depending on the value of the GLSetup.AutoRevOption field of the GL preferences record.
AutoReverseCopy
bitReversing Entry-
Description:When set to "true", indicates that the batch is a reversing batch. See also the OrigModule and OrigBatchNbr fields.
BatchType
varchar(3)Type-
Description:The type of the batch. Allowed values are: ""H"" - Normal, ""R"" - Recurring, ""C"" - Consolidation, ""T"" - Trial Balance, ""RCL"" - Reclassification, ""A"" - Allocation. Defaults to ""H"" - Normal.
BranchID API Default Navigation
intBranchBranch
Description:Identifier of the Branch, to which the batch belongs. Corresponds to the Branch.BranchID field.
ControlTotal
decimal(19, 4)-
Description:The control total of the batch in the base currency of the company. See also CuryControlTotal.
CreatedByIDDefault Navigation
uniqueidentifierCreated ByUsers
Description:No description available
CreatedByScreenID
char(8)-
Description:No description available
CreatedDateTime API
datetimeCreated On-
Description:No description available
CreateTaxTrans
bitCreate Tax Transactions-
Description:When set to "true", indicates that the system must generate tax transactions for the batch. This field is taken into account only if the FeaturesSet.TaxEntryFromGL feature is on. Affects only those batches, which belong to the General Ledger Module. Defaults to "false".
CreditTotal
decimal(19, 4)-
Description:The total credit amount of the batch in the base currency of the company. See also CuryCreditTotal.
CuryControlTotal
decimal(19, 4)Control Total-
Description:The control total of the batch in its currency.
CuryCreditTotal
decimal(19, 4)Credit Total-
Description:The total credit amount of the batch in its currency. See also CreditTotal.
CuryDebitTotal
decimal(19, 4)Debit Total-
Description:The total debit amount of the batch in its currency. See also DebitTotal.
CuryIDDefault Navigation
nvarchar(5)CurrencyCurrency
Description:The code of the Currency of the batch. Defaults to the base currency of the company.
CuryInfoID
bigintCurrencyInfo
Description:Identifier of the CurrencyInfo record associated with the batch. Corresponds to the PCurrencyInfo.CurrencyInfoID field.
DateEntered
datetime2Transaction Date-
Description:The date of the batch, specified by user. Defaults to the current Business Date.
DebitTotal
decimal(19, 4)-
Description:The total debit amount of the batch in the base currency of the company. See also CuryDebitTotal.
Description API
nvarchar(512)Description-
Description:The description of the batch.
DontApprove
bit-
Description:Indicates that the current document should be excluded from the approval process. Maintenance of this property is on graph level.
Draft
bit-
Description:When set to "true", indicates the the batch is a draft. The drafts of batches are not displayed in the Journal Transactions (GL301000) form. This field is set to "true" by the Journal Vouchers (GL304000) form (JournalWithSubEntry graph) when a new GLTranDoc defining a transactions batch is created. This allows to reserve a number for the batch, while not showing it in the interface until the GLTranDoc is released and the batch is actually created. Outside Journal Vouchers defaults to "false".
FinPeriodIDDefault Navigation
char(6)Post Period-
Description:No description available
HasRamainingAmountNonexistent in DBObsolete
bitHasRamainingAmount-
Description:Specifies (if set to "true") that the batch has a detail with the visible GLTran.CuryReclassRemainingAmt field. This field is populated only by the JournalEntry graph, which corresponds to the Journal Transactions (GL301000) form.
Hold API
bitHold-
Description:Indicates whether the batch is on hold. Defaults to "true", if the GLSetup.HoldEntry flag is set in the preferences of the module, and to "false" otherwise.
LastModifiedByIDDefault Navigation
uniqueidentifierLast Modified ByUsers
Description:No description available
LastModifiedByScreenID
char(8)-
Description:No description available
LastModifiedDateTime API
datetimeLast Modified On-
Description:No description available
LedgerID API Default Navigation
intLedgerLedger
Description:No description available
LineCntr
int-
Description:The counter of the document lines, used internally to assign consistent numbers to newly created lines. It is not recommended to rely on this field to determine the exact count of lines, because it might not reflect the latter under some conditions.
NoteID
uniqueidentifier-
Description:No description available
NumberCode
nvarchar(5)Number. Code-
Description:The identifier of the GLNumberCode record used to assign an auto-generated RefNbr to the batch. Corresponds to the GLNumberCode.NumberCode field. The number codes are assigned by the AllocationProcess and ScheduleProcess graphs, which allows to have separate numbering sequences for recurring and allocation batches.
OrigBatchNbrDefault Navigation
nvarchar(15)Orig. Batch NumberBatch
Description:The number of the original batch (e.g. the one reversed by this batch). Corresponds to the BatchNbr field.
OrigModule
char(2)Orig. Module-
Description:The module, to which the original batch (e.g. the one reversed by this batch) belongs. Corresponds to the Module field.
Posted
bitPosted-
Description:Indicates whether the batch has been posted.
PostedToVerifyNonexistent in DB
bit-
Description:When set, on persist checks, that the document has the corresponded Posted original value. When not set, on persist checks, that Posted value is not changed. Throws an error otherwise.
PostErrorCount
int-
Description:Indicates how many times system has failed while posting batch.
RefNbr
nvarchar(15)RefNbr-
Description:Auto-generated reference number assigned to the batch according to the Numbering Sequence specified in the GLNumberCode.NumberingID field of the corresponding GLNumberCode record (see the NumberCode field). The field will remain empty if NumberCode is not set for the batch.
Rejected
bit-
Description:No description available
Released
bitReleased-
Description:Indicates whether the batch 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.
RequirePost
bit-
Description:Indicates whether the batch is required to be posted.
ReverseCountNonexistent in DB
intReversing Batches-
Description:The read-only field, reflecting the number of batches in the system, which reverse this batch. This field is populated only by the JournalEntry graph, which corresponds to the Journal Transactions (GL301000) form.
Scheduled
bit-
Description:When "true", indicates that the batch is included as a template into a Schedule pointed to by the ScheduleID field.
ScheduleID
nvarchar(15)Schedule
Description:Identifier of the Schedule, associated with the batch. If Scheduled is "true" for the batch, then this field provides the identifier of the schedule, into which the batch is included as a template. Otherwise, the field is set to the identifier of the schedule that produced the batch. Corresponds to the Schedule.ScheduleID field.
SelectedNonexistent in DB
bitSelected-
Description:Indicates whether the record is selected for mass processing.
SkipTaxValidation
bitSkip Tax Amount Validation-
Description:When set to "true", indicates that the system should not validate the tax transactions associated with the batch. The value of this field is relevant only if CreateTaxTrans is "true".
Status API
char(1)Status-
Description:The read-only status of the batch. The value of this field is determined by the Hold, Released, Posted, Voided and Scheduled fields. Possible values are: ""H"" - Hold ""B"" - Balanced ""U"" - Unposted ""P"" - Posted ""C"" - Completed ""V"" - Voided ""R"" - Released ""Q"" - Partially Released ""S"" - Scheduled
TranPeriodID
char(6)-
Description:No description available
tstamp
timestamp-
Description:No description available
Voided
bitVoided-
Description:Indicates whether the batch has been voided.