API docs by Redocly

pCon.configurator Online Plugin - Excel (1.5.1)

Download OpenAPI specification:

E-mail: support@easterngraphics.com

Overview

EAIWS Plugin that generates Excel exports.

API Endpoints

All API endpoints are under the plugin-path (baseurl).

baseurl: http://<eaiws-server>/EAIWS/plugins/excel/

Eg.: https://s1.eaiws.pcon-solutions.com/4.18.2-001/EAIWS/plugins/excel/v1/export

Errors

API errors fall into two categories. Some errors will abort the request while others will be suppressed. Errors that abort will either have a json body or rarely a text response. In the case of aborted errors it is good practice to check the http error code in case of a text response. Suppressed errors are appended as a list to a successfull (eg.: http status code 200) request response.

Example of an aborted error:

{
    "additionalInformation": {},
    "cause": [],
    "code": 422,
    "id": "request-session-not-found",
    "message": "No active session was found for the specified session id.",
    "scopes": [],
    "type": "request"
}

Example of an appended suppressed error:

{
    "errors": [
      {
        "additionalInformation": {},
        "cause": ["Some exception..."],
        "id": "item-text-error",
        "message": "Failed to get item app data!",
        "scopes": ["ERROR"],
        "type": "item"
      }     
    ],
    "name": "somecustomname.xlsx",
    "url": "https://www.../.../.../.../somecustomname.xlsx"
}

Suppressed errors do not have an error code and instead have one of two scopes: WARN or ERROR. A response can have multiple suppressed errors or warnings attached to it.

Project export

Generate excel project workbook.

Request Body schema: application/json
sessionId
required
string

uuid of the current session.

calculationScheme
string
Default: "STDB2B_WBK"

Scheme for the price calculation.

preferredImageColumn
string
Default: "73bd68f4-da62-11d8-b9d6-00e081513ada"

User defined image column. Used to retrieve a user defined image for an article before getting an internal image.

externalRefColumn
string

UUID to reference the basket column that contains the external reference number

object

JSON object with the following fields: articleStartRow, articleStartColumn, calcStartRow, calcStartColumn, reportStartRow, reportStartColumn. Used to define starting points for filling out the workbook sheets.

items
Array of strings

Selected article UUIDs. Acts as a filter.

matchBasketItemIds
boolean
Default: false

Boolean value to match the selected items against the basket item IDs instead of view item IDs

viewId
string

UUID of the view to use for this export.

imageOptions
Array of strings

Image options to override the default image. Reference the EAIWS documentation for valid image options.

filename
string

Custom filename for the report. Will override default genarated filename. Valid filename examples: somecustomname.xlsx, somecustomname. The .xlsx file extension is optional.

hideMargins
boolean
Default: false

Boolean flag to hide margin calculation. Hides margins when true.

hideTaxes
boolean
Default: false

Boolean flag to hide tax calculation. Hides taxes when true.

hideDiscounts
boolean
Default: false

Hide all discounts.

hideHeaderDiscounts
boolean
Default: false

Hide header discounts.

hidePurchaseDiscounts
boolean
Default: false

Hide purchase discounts.

hideSalesDiscounts
boolean
Default: false

Hide sales discounts.

hideFinalTotal
boolean
Default: false

Boolean flag to hide final total. Hides values when true.

showVariantText
boolean
Default: false

Shows variant text in Report Sheet when true.

hideLineTags
Array of strings

List of tags for hiding specific calculation lines that match any of the tags.

hideConditionTypes
Array of strings

List of condition types for hiding specific calculation lines that match any of the types.

hideAccessMethods
Array of strings

List of access methods for hiding specific calculation lines that match any of the access methods.

Responses

Request samples

Content type
application/json
{
  • "sessionId": "39d105c0-5254-4860-9865-935aba7cc78a",
  • "calculationScheme": "STDB2B_WBK",
  • "preferredImageColumn": "cc080d73-88f4-4bfc-8ec1-e7e2ad30739a",
  • "externalRefColumn": "c962203c-7e83-4a2f-8060-acaa4a06c921",
  • "sheetSettings": {
    },
  • "filename": "somecustomname.xlsx",
  • "imageOptions": [
    ]
}

Response samples

Content type
application/json
{}

Management export

Generate excel management workbook.

Request Body schema: application/json
sessionId
required
string

uuid of the current session.

calculationScheme
string
Default: "STDB2B_WBK"

Scheme for the price calculation.

items
Array of strings

Selected article UUIDs. Acts as a filter.

matchBasketItemIds
boolean
Default: false

Boolean value to match the selected items against the basket item IDs instead of view item IDs

viewId
string

UUID of the view to use for this export.

filename
string

Custom filename for the excel workbook. Will override default genarated filename. Valid filename examples: somecustomname.xlsx, somecustomname. The .xlsx file extension is optional.

Responses

Request samples

Content type
application/json
{
  • "sessionId": "62afce0a-6304-4484-8f52-780c4ae28b3e",
  • "calculationScheme": "STDB2B_WBK",
  • "viewId": "f6a20aef-8fe4-4fcd-9854-8701b792563f",
  • "filename": "somecustomname.xlsx"
}

Response samples

Content type
application/json
{}

CSV project export

Generate excel project workbook and exports it as CSV. Results in a zip file containing Article_List.csv, Calculation_Scheme.csv, Header_Calculation.csv & Header_Data.csv.

Request Body schema: application/json
sessionId
required
string

uuid of the current session.

calculationScheme
string
Default: "STDB2B_WBK"

Scheme for the price calculation.

externalRefColumn
string

UUID to reference the basket column that contains the external reference number

object

JSON object with the following fields: articleStartRow, articleStartColumn, calcStartRow, calcStartColumn, reportStartRow, reportStartColumn. Used to define starting points for filling out the workbook sheets.

items
Array of strings

Selected article UUIDs. Acts as a filter.

matchBasketItemIds
boolean
Default: false

Boolean value to match the selected items against the basket item IDs instead of view item IDs

viewId
string

UUID of the view to use for this export.

filename
string

Custom filename for the report. Will override default genarated filename. Valid filename examples: somecustomname.xlsx, somecustomname. The .xlsx file extension is optional.

hideMargins
boolean
Default: false

Boolean flag to hide margin calculation. Hides margins when true.

hideTaxes
boolean
Default: false

Boolean flag to hide tax calculation. Hides taxes when true.

hideDiscounts
boolean
Default: false

Hide all discounts.

hideHeaderDiscounts
boolean
Default: false

Hide header discounts.

hidePurchaseDiscounts
boolean
Default: false

Hide purchase discounts.

hideSalesDiscounts
boolean
Default: false

Hide sales discounts.

hideFinalTotal
boolean
Default: false

Boolean flag to hide final total. Hides values when true.

hideLineTags
Array of strings

List of tags for hiding specific calculation lines that match any of the tags.

hideConditionTypes
Array of strings

List of condition types for hiding specific calculation lines that match any of the types.

hideAccessMethods
Array of strings

List of access methods for hiding specific calculation lines that match any of the access methods.

Responses

Request samples

Content type
application/json
{
  • "sessionId": "39d105c0-5254-4860-9865-935aba7cc78a",
  • "calculationScheme": "STDB2B_WBK",
  • "externalRefColumn": "c962203c-7e83-4a2f-8060-acaa4a06c921",
  • "filename": "somecustomname.zip"
}

Response samples

Content type
application/json
{}

CSV articlelist export

Generate article list excel sheet and exports it as CSV.

Request Body schema: application/json
sessionId
required
string

uuid of the current session.

calculationScheme
string
Default: "STDB2B_WBK"

Scheme for the price calculation.

externalRefColumn
string

UUID to reference the basket column that contains the external reference number

object

JSON object with the following fields: articleStartRow, articleStartColumn, calcStartRow, calcStartColumn, reportStartRow, reportStartColumn. Used to define starting points for filling out the workbook sheets.

items
Array of strings

Selected article UUIDs. Acts as a filter.

matchBasketItemIds
boolean
Default: false

Boolean value to match the selected items against the basket item IDs instead of view item IDs

viewId
string

UUID of the view to use for this export.

filename
string

Custom filename for the report. Will override default genarated filename. Valid filename examples: somecustomname.xlsx, somecustomname. The .xlsx file extension is optional.

hideMargins
boolean
Default: false

Boolean flag to hide margin calculation. Hides margins when true.

hideTaxes
boolean
Default: false

Boolean flag to hide tax calculation. Hides taxes when true.

hideDiscounts
boolean
Default: false

Hide all discounts.

hideHeaderDiscounts
boolean
Default: false

Hide header discounts.

hidePurchaseDiscounts
boolean
Default: false

Hide purchase discounts.

hideSalesDiscounts
boolean
Default: false

Hide sales discounts.

hideFinalTotal
boolean
Default: false

Boolean flag to hide final total. Hides values when true.

hideLineTags
Array of strings

List of tags for hiding specific calculation lines that match any of the tags.

hideConditionTypes
Array of strings

List of condition types for hiding specific calculation lines that match any of the types.

hideAccessMethods
Array of strings

List of access methods for hiding specific calculation lines that match any of the access methods.

Responses

Request samples

Content type
application/json
{
  • "sessionId": "39d105c0-5254-4860-9865-935aba7cc78a",
  • "calculationScheme": "STDB2B_WBK",
  • "externalRefColumn": "c962203c-7e83-4a2f-8060-acaa4a06c921",
  • "filename": "somecustomname.csv"
}

Response samples

Content type
application/json
{}

CSV header calculation export

Generate header calculation excel sheet and exports it as CSV.

Request Body schema: application/json
sessionId
required
string

uuid of the current session.

calculationScheme
string
Default: "STDB2B_WBK"

Scheme for the price calculation.

externalRefColumn
string

UUID to reference the basket column that contains the external reference number

object

JSON object with the following fields: articleStartRow, articleStartColumn, calcStartRow, calcStartColumn, reportStartRow, reportStartColumn. Used to define starting points for filling out the workbook sheets.

items
Array of strings

Selected article UUIDs. Acts as a filter.

matchBasketItemIds
boolean
Default: false

Boolean value to match the selected items against the basket item IDs instead of view item IDs

viewId
string

UUID of the view to use for this export.

filename
string

Custom filename for the report. Will override default genarated filename. Valid filename examples: somecustomname.xlsx, somecustomname. The .xlsx file extension is optional.

Responses

Request samples

Content type
application/json
{
  • "sessionId": "39d105c0-5254-4860-9865-935aba7cc78a",
  • "calculationScheme": "STDB2B_WBK",
  • "externalRefColumn": "c962203c-7e83-4a2f-8060-acaa4a06c921",
  • "filename": "somecustomname.csv"
}

Response samples

Content type
application/json
{}

CSV header data export

Generate header data excel sheet and exports it as CSV.

Request Body schema: application/json
sessionId
required
string

uuid of the current session.

calculationScheme
string
Default: "STDB2B_WBK"

Scheme for the price calculation.

externalRefColumn
string

UUID to reference the basket column that contains the external reference number

object

JSON object with the following fields: articleStartRow, articleStartColumn, calcStartRow, calcStartColumn, reportStartRow, reportStartColumn. Used to define starting points for filling out the workbook sheets.

items
Array of strings

Selected article UUIDs. Acts as a filter.

matchBasketItemIds
boolean
Default: false

Boolean value to match the selected items against the basket item IDs instead of view item IDs

viewId
string

UUID of the view to use for this export.

filename
string

Custom filename for the report. Will override default genarated filename. Valid filename examples: somecustomname.xlsx, somecustomname. The .xlsx file extension is optional.

Responses

Request samples

Content type
application/json
{
  • "sessionId": "39d105c0-5254-4860-9865-935aba7cc78a",
  • "calculationScheme": "STDB2B_WBK",
  • "externalRefColumn": "c962203c-7e83-4a2f-8060-acaa4a06c921",
  • "filename": "somecustomname.csv"
}

Response samples

Content type
application/json
{}

Changelog

Changes since v1.0.0

1.5.1 - 27.10.2025

  • Updated polish translations.

1.5.0 - 16.10.2025

  • Added calculation level & counter to headers as a prefix.
  • Added Calculation Scheme excel sheet to the article list workbook.
  • Also added calculation scheme sheet to CSV Archive export.
  • Added article number column to the management excel sheet.
  • Fixed bug where margin value and percentage were switched (Management Export). Now matches report format.
  • Language files converted from Latin-1 to UTF-8.
  • Updated to JAVA 21.

1.4.0 - 22.04.2025

  • Fixed an issue in the commons-exports API that caused Set-Article parts to be incorrectly removed sometimes.
  • Added Manufacturer Overview excel workbook as a new export.
  • Accounting format adjusted to not align negative sign with the left cell border.
  • Updated to EAIWS 4.17beta1 & updated some dependencies.

1.3.0 - 15.10.2024

  • Improved performance of large excel exports with images using multithreading.
  • Fixed export fail when there were multiple VAT calculation lines.
  • Added showVariantText option to the excel request.
  • Improved api request exceptions and error messages.
  • Suppressed errors are now handled using the SuppressedErrorHandler.
  • Added special condition for "NET_VALUE_ECO" in header calculation sheet.

1.2.1 - 28.06.2024

  • Added ECO-Tax category description to the amount column of the eco-contribution in the article list.

1.2.0 - 17.05.2024

  • Changed CSV language handling to use project language for data and en_US for labels & currency.
  • Adjusted the article type in the article list sheet to match the mapping used by the EAIWS SOAP API.
  • Fixed issue in Report Sheet where header amounts weren't shown in the document currency.
  • Fixed error where an unknown tax category caused a NullPointerException when retrieving a procedure value.
  • Unit values in the Report Sheet are now all exported in the document currency.
  • Added Currency columns for all pricing procedures of type Money.
  • Moved % sign for Percentage type procedures into the column header.
  • Fixed an issue that incorrectly added percentage amounts as fractions.
  • Adjusted workbook accounting cell format.
  • Fixed date format in CSV export to ISO 8601 format.
  • Added Currency columns to header calculation sheet.
  • Added individual CSV exports for article list, header calculation & header data.
  • Session locale now depends on the SoldTo address country and project language with the application locale as fallback.
  • Fixed article list sheet showing an error value when an -/+ inifnite percentage amount is present.
  • Added Price Date column to the article list sheet.
  • Fixed header calculation sheet having an invalid order.
  • Added CSV export.
  • Fixed header calculation sheet text header formatting.
  • Changed the article list sheet to be static instead of dynamic.
  • Moved all description fields to the left in the article list sheet.
  • Now exporting all pricing procedure lines for the selected calculation scheme with the article list.
  • Added empty placeholder columns to the article list sheet.
  • All ECO-Tax lines are now exported in the same column in the article list.
  • Variant prices are exported together in a single column in the article list.
  • Added a Currency column after Base Price (Amount) (BPR00 & BPR01)

1.1.0 - 17.10.2023

  • Fixed NullPointerException when calling isZero on some calculation lines.
  • Added improved logging for tracking excel export generation tasks
  • Updated commons-exports
  • Updated Apache POI dependency
  • Added hideLineTags, hideConditionTypes, hideAccessMethods options to the export request

1.0.0 - 26.05.2023

  • Updated plugin classes to inherit from commons-exports
  • Improved logging.
  • Removed genson bundle. Imported from commons-exports now
  • Export is now a session-cache URL