Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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
BatchDetailApi
Return or create batchThe 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 |
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 batchesRetrieve (and create, if necessary) the default System Batch for the specified Type, Date, Location, and Financial Company. | Logged in User | - | |||
POST | Retrieve a filtered list of Batches. | Logged in User | - |
BatchDetailApi
Return or create batch Web Workbench screen.
/api/ |
---|
BatchDetailApi | |||||
---|---|---|---|---|---|
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
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.
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 | stringString | Type of the batchBatch. | |
BatchDate | StringTo | determines what period the batch is createdThe end date of the Period of the Batch.. | |
PeriodNo | Integer | The period of the batchBatch. | |
YearNo | Integer | The year of the batchBatch | |
CreatedById | Integer | [The ID of user or account?]the user who created the Batch. | |
CreatedDateTime | String | Date The date and time when the batch is Batch was created. | |
LocationCode | String | The location Location Code from the financial companyFinancial Company. | |
CompanyCode | String | The Financial Company Code of the company for the batchBatch. | |
BatchReference | String | Reference textThe Batch reference. | |
BatchNotes | String | The Batch comment. | |
ClosedFlagReversingJournal | IntegerReversingJournal | The Reversing Journal flag on the Batch. | |
ClosedFlag | Integer | ReversingJournal | IntegerThe Closed flag on the Batch. |
ClosedDate | String | Date the batch is The date the Batch was closed. | |
ClosedById | Integer | Code The ID of person the user who close closed the batchBatch. | |
NotForExportFlag | IntegerFlag | to mark the batch is for exporting or notThe Not For Export flag on the Batch. | |
NotForExportDate | String | Date the batch is The date the Batch was marked as Not for For Export. | |
NotForExportId | Integer | Code The ID of person the user who marked batch the Batch as Not for For Export. | |
ExportDate | StringDate | of the exportThe date the Batch was exported. | |
ExportedById | String | Code The ID of person the user who made exported the exportBatch. | |
ExportStatus | String | Includes: The status of the Batch (Created, In progressProgress, Error, Successful). |
⬆️ Back to top
GridResult_BatchBatchLine
BatchLine
Property | Type | Description |
---|---|---|
Total | Integer | Total number of batches |
Page | Integer | Page |
Records | Integer | Records |
Rows | Array | Array [BatchBatchLine] |
Form | Object |
|
Widgets |
|
⬆️ Back to top
BatchBatchFields
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 |
| |
HiddenBatchNotes | String |
|
BatchStatus | Status of the batch | |
BatchTotal |
| |
ReversingJournal |
| |
AttachmentsDialog |
| |
Import |
| |
ImportAdjustment |
| |
PayrollPeriod |
| |
Currency | The currency | |
FcConversionRate | Foreign currency conversation rate. | |
UseForeignCurrency | Boolean | Foreign currency status. |
⬆️ Back to top
BatchBatchKey
Property | Type | Description |
---|---|---|
BatchNo | Integer | Batch number/code |
BatchType | String | Batch type. |
FinCoCode | String | Code of the finance company |
Exported | Boolean | Exported status. |
InterCoStatus | String |
|
HasExportErrored | Boolean | The exporting error status. |
⬆️ Back to top
BatchBatchLine
Property | Type | Description |
---|---|---|
Type | String | Line type |
BatchNo | Integer | Batch number |
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
Property | Type | Description |
---|---|---|
Key |
| |
Fields |
| |
Rows |
| |
ValidationErrors | Array [MvcValidationError] |
|
⬆️ Back to top
JobTransactionsJobTransactionKey
Property | Type | Description |
---|---|---|
BatchNo | Integer | Number of the batch. |
BatchType | String | Batch type. |
⬆️ Back to top
JobTransactionsJobTransactionDetailKey
Property | 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 |
---|---|---|
Property | String |
|
LogHeaderID | Integer | Log header id. |
lFcCost | Number | Foreign currency code |
FcRetail | Number | Foreign currency retail. |
PurchaseOrderLineId | Integer | Purchase Order line id. |
StockLocationInactive | Boolean |
|
Unit | String | Unit |
EnteredByID | Integer | ID of person who entered data. |
SourceID | Integer |
|
FCGST | Number | Foreign currency tax. |
JobCodeValue | Job code. | |
LogHeader | Job code. | |
ActivityCodeValue | Activity code. | |
WorkCentreCodeValue | Work Centre code. | |
QuantityValue | Quantity | |
FcCostValue | Foreign currency cost. | |
CostValue | Cost. | |
GSTTypeValue | Tax type. | |
GSTTypeCodeValue | Code of tax type. | |
GSTRateValue | Tax rate | |
GSTValue | 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 |
|
⬆️ 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 | ||||
---|---|---|---|---|
|