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
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 | Logged in User | - | - | |||
POST | Return all Workbench batches. | Logged in User |
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 | Logged in User | - | |||
POST | Create a new batch or update existing batch with batch transactions. | Logged in User |
On this page
. |
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 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 | Data Type | Description | Parameter Type |
---|---|---|---|
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
Field | Type | Description |
---|---|---|
Total | 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 |
|
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 | ||||
---|---|---|---|---|
|