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.
Endpoints
The 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 | Retrieve (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 | 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.
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. |
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). |
⬆️ Back to top
BatchLineBatchKey
Property | Type | Description |
---|
BatchNo | Integer |
Total number of batches
Page
Integer
Page
Records
Integer
Records
Rows
Array
Array [BatchBatchLine]
Form
Object
Widgets
⬆️ Back to top
The unique number of the Batch. | ||
BatchType | 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 | 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
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 | ||||
---|---|---|---|---|
|