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

-

-

SystemBatchApiModel

POST

Return all Workbench batches.

Logged in User

GridRequestParametersApi

DynamicPredicateApi

DynamicPredicateRowApi

GridResult_BatchBatchLine

ViewData_GridWidget

CellData

BatchBatchLine

BatchBatchKey

ViewData_GridWidgetLine

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

Table of Contents
stylenone

Include Page
KB1:How-to footer
KB1:How-to footer