Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
In Workbench, documents are stored in batches before they can be exported to the financial software. These APIs are about these batches.
Endpoints
BatchDetailApi
Return or create batch Web Workbench screen.
/api/BatchDetailApi | |||||
---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GET | Get Batch with JobTransactions for a BatchID | - | |||
POST | Create a new batch or update existing batch with batch transactions. |
BatchListApi
Reuse or return a new System Batch for Workbench Import or list of all Workbench batches.
/api/BatchListApi | |||||
---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GET | Reuse or returns a new System Batch for Workbench Import. Requires: BatchType, LocationCode, FinCoCode, YearNo and PeriodNo | - | - | ||
POST | Return all Workbench batches. |
BatchDetailApi
Return or create batch Web Workbench screen.
/api/BatchDetailApi
Method
Description
Performed As
Request Query
Request Body
Response
GET
Get Batch with JobTransactions for a BatchID
-
POST
Create a new batch or update existing batch with batch transactions.
Models
The definitions of models specific to endpoints in this module.
SystemBatchApiModel
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 financial company |
CompanyCode | String | Code of the company 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. |
⬆️ Back to top
Parameters
GridResult_BatchBatchLine
Field |
---|
Type | Description |
---|
Field | Type | Description |
---|---|---|
Total | Integer | Total number of batches |
Page | Integer | Number of screen page or current page? |
Records | Integer | Total of record? |
Total |
batchType
String
Type of the batch
query
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
Integer | Total number of batches | |
Page | Integer | Page |
Records | Integer | Records |
Rows | Array | Array [BatchBatchLine] |
Form | Object |
|
Widgets |
|
⬆️ Back to top
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? |
Foreign currency status. |
⬆️ Back to top
BatchBatchKey
Field | Type | Description |
---|---|---|
BatchNo | Integer | Batch number/code |
BatchType | String | Batch type. |
FinCoCode | String | Number code Code of the finance company |
Exported | Boolean Is the batch exported? | Exported status. |
InterCoStatus | String |
|
HasExportErrored | Boolean | The exporting error status. |
⬆️ Back to top
BatchBatchLine
Field | Type | Description |
---|---|---|
Type | String | Line type |
BatchNo | Integer | Code/ Batch number of the batch |
Date | String | Date |
Year | String | Year |
Period | Integer | The financial period |
YearPeriodIndex | Integer |
|
CreatedDate | String | Date created. |
CreatedById | Integer | ID of person who created the batch. |
CreatedByName | String | Name of person who created the batch. |
FinancialCompany | String | Financial company. |
Location | String | Location. |
Reference | String | Reference text |
Notes | String | Batch note |
Reversal | Integer |
|
Closed | Boolean | Status of the batch. |
ReversingJournal | Boolean |
|
ClosedById | Integer | Code of person who closed the batch. |
NotForExport | Boolean | Value of Not For Export flag. |
Exported | Boolean | Exported status. |
ExportedById | Integer | ID of person exported the batch. |
ExportDate | String | Exported date. |
ClosedDate | String | Closed date. |
ExportStatus | String | Export status. |
InterCoStatus | String | Status of inter-company. |
Select |
| |
Export |
| |
TypeValue | Batch type. | |
BatchNoValue | Batch number. | |
DateValue | Batch date. | |
YearPeriodValue | Financial year period of the batch. | |
CreatedByValue | Person who created the batch. | |
FinancialCompanyValue | Financial company. | |
ReferenceValue | Reference text | |
NotesValue | Batch note. | |
ReversalValue |
| |
ClosedValue | Closed status. | |
NotForExportValue | Value of Not for Export flag. | |
ClosedDateValue | Closed date. | |
ExportDateValue | Exported date. | |
ExportStatusValue | Export status. | |
InterCo | Internal company. | |
InterCoStatusValue | Internal company. | |
BatchStatus | String | Batch status. |
Status | String | Batch status. |
ReadonlyFlag | Integer | Value of Read-Only property. |
ReadonlyMessage | String |
|
OriginalKey |
| |
CurrentKey |
| |
Key |
| |
Index | Integer |
|
⬆️ Back to top
JobTransactionApiModel
Field | Type | Description |
---|---|---|
Key |
| |
Fields |
| |
Rows |
| |
ValidationErrors | Array [MvcValidationError] |
|
Parameters
Parameter
Data Type
Description
Parameter Type
batchNo
Integer
Number of the batch
batchType
String
Batch type.
⬆️ Back to top
JobTransactionsJobTransactionKey
Field | Type | Description |
---|---|---|
BatchNo | Integer | Number of the batch. |
BatchType | String | Batch type. |
⬆️ Back to top
JobTransactionsJobTransactionDetailKey
Field | Type | Description | |
---|---|---|---|
JobTranId | Integer |
| |
PersonId | Integer | Person id. | |
JobCode | String | Job code. | |
FinCoCode | String | Code of financial company. | |
ActivityCode | String | Activity code. | |
ActivityCodeValue | String | Activity code. | |
ActivityType | String | Activity type. | |
ActivitySubType | String | Activity sub type | |
WorkCentreCode | String | Code of Work Centre. | |
WorkCentreCodeValue | String | Code of Work Centre. | |
ItemId | Integer | Item id. | |
StockLocationCodeValue | String | Stock location code. | |
CostRateValue | Number | Cost rate. | |
BatchType | String | Batch type | |
OrderDerivedLine | Boolean | ||
DocketDerivedLine | Boolean |
| |
StockDerivedLine | Boolean |
| |
Type | String | = ['InwardsGoodsEntry', 'InwardsGoodsEdit', 'Issue', 'Return', 'Transfer', 'Requisition'] |
|
PurchaseOrderLineIdValue | Integer | Purchase Order line id. | |
LogHeaderId | Integer | Log header id. | |
KeyName | String |
| |
CompanyId | Integer | company id. | |
GSTTypeCodeValue | String |
|
⬆️ Back to top
JobTransactionsJobTransactionLine
Field | Type | Description | |
---|---|---|---|
TranDate | String |
| |
LogHeaderID | Integer |
| FcCostLog header id. |
lFcCost | Number | Foreign Foreign currency code | |
FcRetail | Number | Foreign currency retail. | |
PurchaseOrderLineId | Integer | Purchase Order line id. | |
StockLocationInactive | Boolean |
| |
Unit | String | Unit | |
EnteredByID | Integer | ID ID of person who entered data. | |
SourceID | Integer |
| |
FCGST | Number | Foreign currency tax. | |
JobCodeValue | Job Job code. | ||
LogHeader | Job code. | ||
ActivityCodeValue | Activity Activity code. | ||
WorkCentreCodeValue | Work Centre code. | ||
QuantityValue | Quantity | ||
FcCostValue | Foreign currency cost. | ||
CostValue | Cost. | ||
GSTTypeValue | GST Tax type. | ||
GSTTypeCodeValue | Code of tax type. | ||
GSTRateValue | GST Tax rate | ||
GSTValue | GST Tax value | ||
NetValueValue | Net value | ||
ReferenceValue | Reference. | ||
FcRetailValue | Foreign currency retail | ||
RetailValue | Retail. | ||
LineDescriptionValue | Description of line | ||
DetailsValue | Details | ||
FromPONumberValue | From Purchase Order number | ||
PurchaseOrderLineIdValue | Purchase Order line id. | ||
StockLocationCodeValue |
| ||
StockItemCodeValue | Stock item code. | ||
TotalLineCostValue | Total line cost. | ||
CostRateValue | Cost rate. | ||
UnitValue | Unit. | ||
FCGSTValue | Foreign currency tax. | ||
Delete |
| ||
Serials |
| ||
SerialRows | Array [TabletSerialLine] |
| |
Status | String | Status. | |
ReadonlyFlag | Integer |
| |
ReadonlyMessage | String |
| |
OriginalKey |
| ||
CurrentKey |
| ||
Key |
| ||
Index | Integer |
|
MvcValidationError
Field
Type
Description
TranDate
String
LogHeaderID
Integer
⬆️ 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
|
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response Sample
|
⬆️ Back to top
On this page
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|