BachListApi

Field	Type	Description
BatchNo	integer	Batch number.
BatchType	string	Type of the batch.
BatchDate	string	To determines what period the batch is created.
PeriodNo	integer	The period of the batch.
YearNo	integer	The year of the batch
CreatedById	integer	[ID of user or account?]
CreatedDateTime	string	Date and time when the batch is created.
LocationCode	string	The location from the FinCo.
CompanyCode	string	Code of the company [or Finco] for the batch
BatchReference	string	Reference text.
BatchNotes	string	Batch comment.
ClosedFlag	integer	???
ReversingJournal	integer	???
ReversingJournal	integer	???
ClosedDate	string	Date the batch is closed.
ClosedById	integer	Code of person who close the batch.
NotForExportFlag	integer	Flag to mark the batch is for exporting or not.
NotForExportDate	string	Date the batch is marked as Not for Export.
NotForExportId	integer	Code of person who marked batch as Not for Export.
ExportDate	string	Date of the export
ExportedById	string	Code of person who made the export.
ExportStatus	string	Includes: Created, In progress, Error, Successful.

Parameters

Parameter	Description	Parameter Type	Data Type

Parameter	Description	Parameter Type	Data Type
batchType	Type of the batch	query	string
docDate	Batch date?	query	date-time
locationCode	Location comes from the FinCo	query	string
finCoCode	Code of the finance company of the batch.	query	string
batchGroup	Batch group.	query	string

Model

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
}

Back to top

POST

GridResult_BatchBatchLine

Field	Type	Description

Field	Type	Description
Total	Integer	Total number of batches
Page	Integer	Number of screen page?
Records	Integer	Total of record?
Rows	Array	Array[BatchBatchLine], optional
Form	Object
Widgets		ViewData_GridWidget

BatchBatchLine

Field	Type	Description

Field	Type	Description
Type	String
BatchNo	Integer
Date	String
Year	String
Period	Integer
YearPeriodIndex	Integer
CreatedDate	String
CreatedById	Integer
CreatedByName	String
FinancialCompany	String
Location	String
Reference	String
Notes	String
Reversal	Integer
Closed	Boolean
ReversingJournal	Boolean
ClosedById	Integer
NotForExport	Boolean
Exported	Boolean
ExportedById	Integer
ExportDate	String
ClosedDate	String
ExportStatus	String
InterCoStatus	String
Select	CellData
Export	CellData
TypeValue	CellData
BatchNoValue	CellData
DateValue	CellData
YearPeriodValue	CellData
CreatedByValue	CellData
FinancialCompanyValue	CellData
ReferenceValue	CellData
NotesValue	CellData
ReversalValue	CellData
ClosedValue	CellData
NotForExportValue	CellData
ClosedDateValue	CellData
ExportDateValue	CellData
ExportStatusValue	CellData
InterCo	CellData
InterCoStatusValue	CellData
BatchStatus	String
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	BatchBatchKey
CurrentKey	BatchBatchKey
Key	BatchBatchKey
Index	Integer

BatchBatchKey

Field	Type	Description

Field	Type	Description
BatchNo	Integer
BatchType	String
FinCoCode	String
Exported	Boolean
InterCoStatus	String
HasExportErrored	Boolean

Model

Request

Response

Response sample

Back to top

On this page

1 Overview
2 BatchListApi
3 GET
- 3.1 SystemBatchApiModel
- 3.2 Parameters
- 3.3 Model
  - 3.3.1 Request
  - 3.3.2 Response
  - 3.3.3 Response Sample
4 POST
- 4.1 GridResult_BatchBatchLine
- 4.2 BatchBatchLine
- 4.3 BatchBatchKey
- 4.4 Model
  - 4.4.1 Request
  - 4.4.2 Response
  - 4.4.3 Response sample