Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Overview
Provides access to Batch related data. In Workbench, documents are stored in batches before they can be exported to the financial software. These APIs are about these batches.
Endpoints
BatchListApi
Reuse or return a new System Batch for Workbench Import or list of all Workbench batchesThe resources available in this module.
BatchListApi
Provides API access to the Export Control(#/Batch/BatchList.aspx) Web Workbench screen.
/api/BatchListApi | |||||
---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GET | Reuse or returns a new Retrieve (and create, if necessary) the default System Batch for Workbench Import. Requires: BatchType, LocationCode, FinCoCode, YearNo and PeriodNothe specified Type, Date, Location, and Financial Company. | Logged in User | -- | ||
POST | Return all Workbench batches. |
BatchDetailApi
Return or create batch Web Workbench screenRetrieve a filtered list of Batches. | Logged in User | - |
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 | |||||
---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GETGet Batch with JobTransactions for a BatchID Retrieve a specific Batch (including its Job Transactions). | Admin User | - | |||
POST | Create a new batch or update existing batch with batch transactions. |
Models
TheUpdate an existing Batch and its Job Transactions. | Admin User | - |
Models
The definitions of models specific to endpoints in this module.
SystemBatchApiModel
Field.
SystemBatchKey
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 |
---|---|---|
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. |
ClosedFlag
Integer
ReversingJournal
Integer
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). |
Parameters
Parameter
⬆️ Back to top
BatchKey
Property | Type | Description |
---|
BatchNo |
batchType
String
Integer | The unique number of the |
Batch. |
BatchType |
docDate
date-time
Batch date?
query
locationCode
String
Location comes from the FinCo
query
finCoCode
String
Code of the finance company of the batch.
query
batchGroup
String
Batch group.
query
GridResult_BatchBatchLine
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 |
---|
Key |
Integer
Total number of batches
Page
Integer
Number of screen page?
Records
Integer
Total of record?
Rows
Array
Array [BatchBatchLine]
Form
Object
Widgets
BatchBatchFields
Field
Type
Description
BatchNo
Number of the batch
BatchType
Batch type.
BatchDate
Batch date.
Period
The financial period of the batch
CreatedBy
Person who created the batch
CreatedDate
Created date..
Location
Location in the batch
FinancialCompany
Financial company for the batch
Closed
Status of the batch
ClosedDate
Date the batch has been closed.
ClosedBy
Who closed the batch.
Exported
Export status of the batch.
ExportedDate
Export date.
ExportedBy
Who exported the batch.
NotForExport
The batch is not for exporting.
NotForExportDate
Date marked as Not for Export
NotForExportBy
Who marked Not for Export.
Reference
Reference text.
BatchNotes
Notes/comments
ReversalOfBatch
HiddenBatchNotes
String
BatchStatus
Status of the batch
BatchTotal
ReversingJournal
Button
AttachmentsDialog
Import
Button
ImportAdjustment
PayrollPeriod
Currency
The currency
FcConversionRate
Foreign currency conversation rate.
UseForeignCurrency
Boolean
Does the batch use foreign currency.
BatchBatchKey
Field
Type
Description
BatchNo
Integer
Batch number/code
BatchType
String
Batch type.
FinCoCode
String
Number code of the finance company
Exported
Boolean
Is the batch exported?
InterCoStatus
String
HasExportErrored
Boolean
The exporting error.
BatchBatchLine
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
Export
TypeValue
BatchNoValue
DateValue
YearPeriodValue
CreatedByValue
FinancialCompanyValue
ReferenceValue
NotesValue
ReversalValue
ClosedValue
NotForExportValue
ClosedDateValue
ExportDateValue
ExportStatusValue
InterCo
InterCoStatusValue
BatchStatus
String
Status
String
ReadonlyFlag
Integer
ReadonlyMessage
String
OriginalKey
BatchBatchKey
CurrentKey
BatchBatchKey
Key
BatchBatchKey
Index
Integer
JobTransactionApiModel
Field
Type
Description
Key
JobTransactionsJobTransactionKey
Fields
BatchBatchFields
Rows
Array[JobTransactionsJobTransactionLine]
ValidationErrors
Array [MvcValidationError]
Parameters
Parameter
Description
Parameter Type
Data Type
batchNo
Integer
batchType
String
JobTransactionsJobTransactionKey
Field
Type
Description
BatchNo
Integer
BatchType
String
JobTransactionsJobTransactionDetailKey
Field
Type
Description
JobTranId
Integer
PersonId
Integer
JobCode
String
FinCoCode
String
ActivityCode
String
ActivityCodeValue
String
ActivityType
String
ActivitySubType
String
WorkCentreCode
String
WorkCentreCodeValue
String
ItemId
Integer
StockLocationCodeValue
String
CostRateValue
Number
BatchType
String
OrderDerivedLine
Boolean
DocketDerivedLine
Boolean
StockDerivedLine
Boolean
Type
String = ['InwardsGoodsEntry', 'InwardsGoodsEdit', 'Issue', 'Return', 'Transfer', 'Requisition']
PurchaseOrderLineIdValue
Integer
LogHeaderId
Integer
KeyName
String
CompanyId
Integer
GSTTypeCodeValue
String
JobTransactionsJobTransactionLine
Field
Type
Description
TranDate
String
LogHeaderID
Integer
FcCost
Number
FcRetail
Number
PurchaseOrderLineId
Integer
StockLocationInactive
Boolean
Unit
String
EnteredByID
Integer
SourceID
Integer
FCGST
Number
JobCodeValue
LogHeader
ActivityCodeValue
WorkCentreCodeValue
QuantityValue
FcCostValue
CostValue
GSTTypeValue
GSTTypeCodeValue
GSTRateValue
GSTValue
NetValueValue
ReferenceValue
FcRetailValue
RetailValue
LineDescriptionValue
DetailsValue
FromPONumberValue
PurchaseOrderLineIdValue
StockLocationCodeValue
StockItemCodeValue
TotalLineCostValue
CostRateValue
UnitValue
FCGSTValue
Delete
Serials
SerialRows
Array[TabletSerialLine]
Status
String
ReadonlyFlag
Integer
ReadonlyMessage
String
OriginalKey
JobTransactionsJobTransactionDetailKey
CurrentKey
JobTransactionsJobTransactionDetailKey
Key
JobTransactionsJobTransactionDetailKey
Index
Integer
MvcValidationError
Field
Type
Description
TranDate
String
LogHeaderID
Integer
The unique key for the line. | ||
Type | String | The Type of the Batch. |
TypeValue | The Type of the Batch. | |
BatchNo | Integer | The unique number of the Batch. |
BatchNoValue | The unique number of the Batch. | |
Date | String | The date of the Batch. |
DateValue | 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 | 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 | 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 | The Financial Company Code of the Batch. | |
Reference | String | The Batch reference. |
ReferenceValue | The Batch reference. | |
Notes | String | The Batch comment. |
NotesValue | The Batch comment. | |
Reversal | Integer | The Batch No of the Batch this Batch reverses. |
ReversalValue | The Batch No of the Batch this Batch reverses. | |
Closed | Boolean | The Closed flag on the Batch. |
ClosedValue | 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 | 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 | The date the Batch was exported. | |
ExportStatus | String | The status of the Batch (Created, In Progress, Error, Successful). |
ExportStatusValue | The status of the Batch (Created, In Progress, Error, Successful). | |
InterCoStatus | String | The Inter-Company status of the Batch. |
InterCoStatusValue | The Inter-Company status of the Batch. |
⬆️ Back to top
JobTransactionKey
Property | Type | Description |
---|---|---|
BatchNo | Integer | The unique number of the Batch. |
BatchType | String | The Batch Type. |
⬆️ Back to top
JobTransactionApiModel
Property | Type | Description |
---|---|---|
Key | The unique key of the Batch. | |
Fields | 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 |
---|---|---|
BatchNo | Number of the batch | |
BatchType | Batch type. | |
BatchDate | Batch date. | |
Period | The financial period of the batch | |
CreatedBy | Person who created the batch | |
CreatedDate | Created date.. | |
Location | Location in the batch | |
FinancialCompany | Financial company for the batch | |
Closed | Status of the batch | |
ClosedDate | Date the batch has been closed. | |
ClosedBy | Who closed the batch. | |
Exported | Export status of the batch. | |
ExportedDate | Export date. | |
ExportedBy | Who exported the batch. | |
NotForExport | The batch is not for exporting. | |
NotForExportDate | Date marked as Not for Export | |
NotForExportBy | Who marked Not for Export. | |
Reference | Reference text. | |
BatchNotes | Notes/comments | |
ReversalOfBatch | The Batch this Batch is a reversal of. | |
BatchStatus | Status of the batch | |
ReversingJournal | The Reversing Journal flag on the Batch. | |
AttachmentsDialog | The file attachments information for the Batch. | |
Currency | The currency | |
FcConversionRate | Foreign currency conversation rate. | |
UseForeignCurrency | Boolean | Foreign currency status. |
⬆️ Back to top
JobTransactionDetailKey
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 |
---|---|---|
Key | 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 | The Job Code on the Job Transaction. | |
LogHeaderID | Integer | The Log Header on the Job Transaction. |
LogHeader | The Log Header on the Job Transaction. | |
StockItemCode | String | The Stock Item on the Job Transaction |
StockItemCodeValue | The Stock Item on the Job Transaction | |
StockLocationCode | String | The Stock Location on the Job Transaction |
StockLocationCodeValue | 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 | The Activity Code on the Job Transaction. | |
WorkCentreCode | String | The Work Centre Code on the Job Transaction. |
WorkCentreCodeValue | The Work Centre Code on the Job Transaction. | |
Unit | String | The Unit of the Stock Item on the Job Transaction. |
UnitValue | The Unit of the Stock Item on the Job Transaction. | |
CostRate | Decimal | The Cost Rate. |
CostRateValue | The Cost Rate. | |
Quantity | Decimal | The Quantity. |
QuantityValue | The Quantity. | |
FcCost | Decimal | The Foreign Currency Cost. |
FcCostValue | The Foreign Currency Cost. | |
Cost | Decimal | The Cost. |
CostValue | The Cost. | |
FcRetail | Decimal | The Foreign Currency Retail Value. |
FcRetailValue | The Foreign Currency Retail Value. | |
Retail | Decimal | The Retail Value. |
RetailValue | The Retail Value. | |
FCGST | Decimal | The Foreign Currency Tax. |
FCGSTValue | The Foreign Currency Tax. | |
LineDescription | String | The Description on the Job Transaction. |
LineDescriptionValue | The Description on the Job Transaction. | |
Details | String | The Details on the Job Transaction. |
DetailsValue | 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 | The GST Type on the Job Transaction. | |
GSTRate | Decimal | The Tax Rate of the GST Type on the Job Transaction. |
GSTRateValue | The Tax Rate of the GST Type on the Job Transaction. | |
TotalLineCost | Decimal | The Cost Rate multiplied by the Quantity. |
TotalLineCostValue | The Cost Rate multiplied by the Quantity. |
⬆️ Back to top
Sample
Returns a new Batch for Workbench Import.
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response Sample
|
Get the list of Workbench batches
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response Sample
|
Get Batch with JobTransactions for a BatchID
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response Sample
|
title | Click to view |
---|
Request
language | json |
---|
Response
language | json |
---|
Response Sample
⬆️ Back to top
On this page
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|