Skip to main content
API Family:Default
Version:22.200.001
Screen ID:GL301000

Properties

Select a row for its DAC field and description
PropertyTypeData Type
BatchNbrStringValuestring
DAC Field:PX.Objects.GL.Batch.BatchNbr
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.
BranchIDStringValuestring
DAC Field:PX.Objects.GL.Batch.BranchID
Description:Identifier of the Branch, to which the batch belongs. Corresponds to the Branch.BranchID field.
CreatedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.GL.Batch.CreatedDateTime
Description:No description available
CurrencyIDStringValuestring
DAC Field:PX.Objects.GL.Batch.CuryID
Description:The code of the Currency of the batch. Defaults to the base currency of the company.
DescriptionStringValuestring
DAC Field:PX.Objects.GL.Batch.Description
Description:The description of the batch.
DetailsListJournalTransactionDetail
DAC Field:Not mapped to a DAC field
Description:No description available
HoldBooleanValueboolean
DAC Field:PX.Objects.GL.Batch.Hold
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.
LastModifiedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.GL.Batch.LastModifiedDateTime
Description:No description available
LedgerIDStringValuestring
DAC Field:PX.Objects.GL.Batch.LedgerID
Description:Identifier of the Ledger, to which the batch belongs. Corresponds to the Ledger.LedgerID field.
ModuleStringValuestring
DAC Field:PX.Objects.GL.Batch.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".
PostPeriodStringValuestring
DAC Field:PX.Objects.GL.Batch.FinPeriodID
Description:Identifier of the Financial Period, to which the batch belongs. By default the period is deducted from the date of the batch. Can be overriden by user.
StatusStringValuestring
DAC Field:PX.Objects.GL.Batch.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
TransactionDateDateTimeValueDateTime
DAC Field:PX.Objects.GL.Batch.DateEntered
Description:The date of the batch, specified by user. Defaults to the current Business Date.

Minimum Payload

Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.

3 required fields
{
  "Module": {
    "value": "string"
  },
  "PostPeriod": {
    "value": "string"
  },
  "Status": {
    "value": "string"
  },
  "Details": [
    {
      "Account": {
        "value": "string"
      },
      "LineNbr": {
        "value": 0
      },
      "Subaccount": {
        "value": "string"
      }
    }
  ]
}

1 property could not be judged statically and is omitted; see the full properties table.

Details is the detail-lines collection (JournalTransactionDetail); one example row is included above because a document usually has lines, and each row needs AccountLineNbrSubaccount of its own.

Available in Versions