Overview

Provides access to Batch related data. In Workbench, documents are stored in batches before they can be exported to the financial software.

Endpoints

The resources available in this module.

BatchListApi

Provides API access to the Export Control(#/Batch/BatchList.aspx) Web Workbench screen.

/api/BatchListApi

/api/BatchListApi
Method	Description	Performed As	Request Query	Request Body	Response
GET	Retrieve (and create, if necessary) the default System Batch for the specified Type, Date, Location, and Financial Company.	Logged in User	SystemBatchKey	-	SystemBatchModel
POST	Retrieve a filtered list of Batches.	Logged in User	-	GridRequestParametersApi	GridResult<BatchLine>

BatchDetailApi

Provides API access to the Job Transaction Batch Entry (#/Batch/BatchEntryList.aspx) detail Web Workbench screens ('Job Adjustment Batch Entry', ‘Disbursement Batch Entry', ‘Stock Issue Batch Entry’, 'Stock Return Batch Entry’).

/api/BatchDetailApi

/api/BatchDetailApi

Method

Performed As

Request Query

Request Body

Response

GET

Retrieve a specific Batch (including its Job Transactions).

Admin User

JobTransactionKey

-

JobTransactionApiModel

POST

Update an existing Batch and its Job Transactions.

Admin User

-

JobTransactionApiModel

Models

The definitions of models specific to endpoints in this module.

SystemBatchKey

Property	Type	Description

Property	Type	Description
BatchType	String	The Batch Type. (required)
DocDate	DateTime	The Date. (required)
LocationCode	String	The Code of the Location. (required)
FinCoCode	String	The Code of the Financial Company. (required)
BatchGroup	String	The Batch Group.

SystemBatchModel

Property	Type	Description

Property	Type	Description
BatchNo	Integer	The Batch number.
BatchType	String	Type of the Batch.
BatchDate	String	The end date of the Period of the Batch..
PeriodNo	Integer	The period of the Batch.
YearNo	Integer	The year of the Batch
CreatedById	Integer	The ID of the user who created the Batch.
CreatedDateTime	String	The date and time when the Batch was created.
LocationCode	String	The Location Code from the Financial Company.
CompanyCode	String	The Financial Company Code of the Batch.
BatchReference	String	The Batch reference.
BatchNotes	String	The Batch comment.
ReversingJournal	Integer	The Reversing Journal flag on the Batch.
ClosedFlag	Integer	The Closed flag on the Batch.
ClosedDate	String	The date the Batch was closed.
ClosedById	Integer	The ID of the user who closed the Batch.
NotForExportFlag	Integer	The Not For Export flag on the Batch.
NotForExportDate	String	The date the Batch was marked as Not For Export.
NotForExportId	Integer	The ID of the user who marked the Batch as Not For Export.
ExportDate	String	The date the Batch was exported.
ExportedById	String	The ID of the user who exported the Batch.
ExportStatus	String	The status of the Batch (Created, In Progress, Error, Successful).

Back to top

BatchKey

Property	Type	Description

Property	Type	Description
BatchNo	Integer	The unique number of the Batch.
BatchType	String	The Batch Type.
FinCoCode	String	The Financial Company Code.
InterCoStatus	String	The Inter-Company status of the Batch.
Exported	Boolean	A flag indicating if the Batch has been exported.
HasExportErrored	Boolean	A flag indicating if the Batch has a status of ‘Error’.

BatchLine

Property	Type	Description

Property	Type	Description
Key	BatchKey	The unique key for the line.
Type	String	The Type of the Batch.
TypeValue	CellData	The Type of the Batch.
BatchNo	Integer	The unique number of the Batch.
BatchNoValue	CellData	The unique number of the Batch.
Date	String	The date of the Batch.
DateValue	CellData	The date of the Batch.
Year	String	The year of the Year/Period of the Batch.
Period	Integer	The period of the Year/Period of the Batch.
YearPeriodIndex	Integer	The unique index of the Year/Period of the Batch.
YearPeriodValue	CellData	The formatted Year/Period of the Batch.
CreatedDate	String	The date the Batch was created.
CreatedById	Integer	The ID of the user who created the Batch.
CreatedByName	String	The name of the user who created the Batch.
CreatedByValue	CellData	The name of the user who created the Batch.
Location	String	The Location Code of the Batch.
FinancialCompany	String	The Financial Company Code of the Batch.
FinancialCompanyValue	CellData	The Financial Company Code of the Batch.
Reference	String	The Batch reference.
ReferenceValue	CellData	The Batch reference.
Notes	String	The Batch comment.
NotesValue	CellData	The Batch comment.
Reversal	Integer	The Batch No of the Batch this Batch reverses.
ReversalValue	CellData	The Batch No of the Batch this Batch reverses.
Closed	Boolean	The Closed flag on the Batch.
ClosedValue	CellData	The Closed flag on the Batch.
ClosedById	Integer	The ID of the user who closed the Batch.
NotForExport	Boolean	The Not For Export flag on the Batch.
NotForExportValue	CellData	The Not For Export flag on the Batch.
Exported	Boolean	A flag indicating if the Batch has been exported.
ExportedById	Integer	The ID of the user who exported the Batch.
ExportDate	String	The date the Batch was exported.
ExportDateValue	CellData	The date the Batch was exported.
ExportStatus	String	The status of the Batch (Created, In Progress, Error, Successful).
ExportStatusValue	CellData	The status of the Batch (Created, In Progress, Error, Successful).
InterCoStatus	String	The Inter-Company status of the Batch.
InterCoStatusValue	CellData	The Inter-Company status of the Batch.

Back to top

JobTransactionKey

Property	Type	Description

Property	Type	Description
BatchNo	Integer	The unique number of the Batch.
BatchType	String	The Batch Type.

Back to top

JobTransactionApiModel

Property	Type	Description

Property	Type	Description
Key	JobTransactionKey	The unique key of the Batch.
Fields	BatchFields	General data associated with the Batch.
Rows	Array<JobTransactionLine>	Job Transactions associated with the Batch.
ValidationErrors	Array<MvcValidationError>	A list of specific validation errors if the save was unsuccessful.

Back to top

BatchFields

Property	Type	Description

Property	Type	Description
BatchNo	StringViewData	Number of the batch
BatchType	StringViewData	Batch type.
BatchDate	DateViewData	Batch date.
Period	StringViewData	The financial period of the batch
CreatedBy	StringViewData	Person who created the batch
CreatedDate	DateViewData	Created date..
Location	StringViewData	Location in the batch
FinancialCompany	StringViewData	Financial company for the batch
Closed	BoolViewData	Status of the batch
ClosedDate	DateViewData	Date the batch has been closed.
ClosedBy	StringViewData	Who closed the batch.
Exported	BoolViewData	Export status of the batch.
ExportedDate	DateViewData	Export date.
ExportedBy	StringViewData	Who exported the batch.
NotForExport	BoolViewData	The batch is not for exporting.
NotForExportDate	DateViewData	Date marked as Not for Export
NotForExportBy	StringViewData	Who marked Not for Export.
Reference	StringViewData	Reference text.
BatchNotes	StringViewData	Notes/comments
ReversalOfBatch	StringViewData	The Batch this Batch is a reversal of.
BatchStatus	StringViewData	Status of the batch
ReversingJournal	BoolViewData	The Reversing Journal flag on the Batch.
AttachmentsDialog	FileAttachmentsViewData	The file attachments information for the Batch.
Currency	PickerViewData	The currency
FcConversionRate	DecimalViewData	Foreign currency conversation rate.
UseForeignCurrency	Boolean	Foreign currency status.

Back to top

JobTransactionDetailKey

Property	Type	Description

Property	Type	Description
JobTranId	Integer	The unique ID of the Job Transaction.
PersonId	Integer	The ID of the User.
FinCoCode	String	The Financial Company Code on the Batch.
BatchType	String	The Batch Type of the Batch.
JobCode	String	The Job Code on the Job Transaction.
ActivityCodeValue	String	The Activity Code on the Job Transaction.
WorkCentreCodeValue	String	The Work Centre Code on the Job Transaction.
ItemId	Integer	The ID of the Item on the Job Transaction.
StockLocationCodeValue	String	The Reference on the Job Transaction.
Type	String	The Job Transaction Type ('Issue' or 'Return').
GSTTypeCodeValue	String	The GST Type Code on the Job Transaction.

Back to top

JobTransactionLine

Field	Type	Description

Field	Type	Description
Key	JobTransactionDetailKey	The unique key for the line.
EnteredByID	Integer	The ID of the Person who created the Job Transaction.
JobCode	String	The Job Code on the Job Transaction.
JobCodeValue	CellData	The Job Code on the Job Transaction.
LogHeaderID	Integer	The Log Header on the Job Transaction.
LogHeader	CellData	The Log Header on the Job Transaction.
StockItemCode	String	The Stock Item on the Job Transaction
StockItemCodeValue	CellData	The Stock Item on the Job Transaction
StockLocationCode	String	The Stock Location on the Job Transaction
StockLocationCodeValue	CellData	The Stock Location on the Job Transaction
StockLocationInactive	Boolean	A flag to indicate if the Stock Location is closed and finalised.
ActivityCode	String	The Activity Code on the Job Transaction.
ActivityCodeValue	CellData	The Activity Code on the Job Transaction.
WorkCentreCode	String	The Work Centre Code on the Job Transaction.
WorkCentreCodeValue	CellData	The Work Centre Code on the Job Transaction.
Unit	String	The Unit of the Stock Item on the Job Transaction.
UnitValue	CellData	The Unit of the Stock Item on the Job Transaction.
CostRate	Decimal	The Cost Rate.
CostRateValue	CellData	The Cost Rate.
Quantity	Decimal	The Quantity.
QuantityValue	CellData	The Quantity.
FcCost	Decimal	The Foreign Currency Cost.
FcCostValue	CellData	The Foreign Currency Cost.
Cost	Decimal	The Cost.
CostValue	CellData	The Cost.
FcRetail	Decimal	The Foreign Currency Retail Value.
FcRetailValue	CellData	The Foreign Currency Retail Value.
Retail	Decimal	The Retail Value.
RetailValue	CellData	The Retail Value.
FCGST	Decimal	The Foreign Currency Tax.
FCGSTValue	CellData	The Foreign Currency Tax.
LineDescription	String	The Description on the Job Transaction.
LineDescriptionValue	CellData	The Description on the Job Transaction.
Details	String	The Details on the Job Transaction.
DetailsValue	CellData	The Details on the Job Transaction.
GSTType	String	The GST Type Code on the Job Transaction.
GSTTypeDescription	String	The Description of the GST Type on the Job Transaction.
GSTTypeCodeValue	CellData	The GST Type on the Job Transaction.
GSTRate	Decimal	The Tax Rate of the GST Type on the Job Transaction.
GSTRateValue	CellData	The Tax Rate of the GST Type on the Job Transaction.
TotalLineCost	Decimal	The Cost Rate multiplied by the Quantity.
TotalLineCostValue	CellData	The Cost Rate multiplied by the Quantity.

Back to top

Sample

Returns a new Batch for Workbench Import.

Request

{
 "predicate": {
  "PredicateRows": [{
    "LeftOperand": "Closed",
    "Operator": "Eq",
    "RightOperand": [ "true" ],
    "Display": true
   }, 
   {
    "LeftOperand": "Exported",
    "Operator": "Eq",
    "RightOperand": ["false"],
    "Display": true
   }
  ]
 },
 "sidx": "Date",
 "sord": "desc",
 "page": 1,
 "rows": 20,
 "StringValue": "Adjustment,Adj Reversal,AP Credit,AP Invoice,AR Credit,AR Internal,AR Invoice,AR Receipt,CCC Accrual,Disbursement,Docket,Payroll,Plant Issue,PO Accrual,Revenue Journal,SCC Accrual,Stock Adjust,Stock Issue,Stock Qty,Stock Return,Stock Trf,Stock Value,Sub Claim,Timesheet,WIP Accrual"
}

Response

SystemBatchApiModel {
BatchNo (Integer, optional),
BatchType (string, optional),
BatchDate (string, optional),
PeriodNo (Integer, optional),
YearNo (Integer, optional),
CreatedById (Integer, optional),
CreatedDateTime (string, optional),
LocationCode (string, optional),
CompanyCode (string, optional),
BatchReference (string, optional),
BatchNotes (string, optional),
ClosedFlag (Integer, optional),
ReversingJournal (Integer, optional),
ClosedDate (string, optional),
ClosedById (Integer, optional),
NotForExportFlag (Integer, optional),
NotForExportDate (string, optional),
NotForExportId (Integer, optional),
ExportDate (string, optional),
ExportedById (Integer, optional),
ExportStatus (string, optional)
}

Response Sample

{
  "BatchNo": 224049,
  "BatchType": "AP Invoice",
  "BatchDate": "2023-11-30T00:00:00",
  "PeriodNo": 5,
  "YearNo": 2024,
  "CreatedDateTime": "2023-11-07T11:42:47.44",
  "LocationCode": "0",
  "CompanyCode": "01",
  "BatchReference": "AP Invoice Auto",
  "ClosedFlag": 0,
  "ReversingJournal": 0,
  "NotForExportFlag": 0
}

Get the list of Workbench batches

Request

Response

Response Sample

Get Batch with JobTransactions for a BatchID

Request

Response

Response Sample

Back to top

On this page

1 Overview
2 Endpoints
- 2.1 BatchListApi
- 2.2 BatchDetailApi
3 Models
- 3.1 SystemBatchKey
- 3.2 SystemBatchModel
- 3.3 BatchKey
- 3.4 BatchLine
- 3.5 JobTransactionKey
- 3.6 JobTransactionApiModel
- 3.7 BatchFields
- 3.8 JobTransactionDetailKey
- 3.9 JobTransactionLine
4 Sample

Batches

Overview

Endpoints

BatchListApi

BatchDetailApi

Models

SystemBatchKey

SystemBatchModel

BatchKey

BatchLine

JobTransactionKey

JobTransactionApiModel

BatchFields

JobTransactionDetailKey

JobTransactionLine

Sample

Returns a new Batch for Workbench Import.

Request

Response

Response Sample

Get the list of Workbench batches

Request

Response

Response Sample

Get Batch with JobTransactions for a BatchID

Request

Response

Response Sample