Get Format Parameters

post

/config/sim/v2/setup/getFormatParameters

Gets Format Parameters.

Request

Supported Media Types
Body ()
The input body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, linesOnFirstPage, customerIdentityLabel
  • If this value is specified, the include parameter is ignored.
    Value Description
    basic Forces the response to include all fields except option string details
    detailed Forces the response to include all fields including option string details
    Example: detailed
  • If specified, limits translated strings returned.
    Example: 1,2,3
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index.
    Example: 0
  • Sorts the response by the specified field name and sort order. All Format Parameter fields support orderBy.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria. All Format Parameter fields support searchCriteria.
    Example: where equals(hierUnitId, 3599)
Back to Top

Response

Supported Media Types

200 Response

A collection of Format Parameters.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Format Parameter objects.
Show Source
Nested Schema : FormatParameter
Type: object
Format Parameter record.
Show Source
Nested Schema : cfdOptionsExt
Type: object
Read-only derived helper object for meaningful Customer Facing Display options.
Show Source
Nested Schema : customerIdentityLabel
Type: object
Customer/Trade label to be displayed on the check tax invoice before Customer/Trade name when Inclusive Tax is exempted.
Example:
{
    "1":"Customer",
    "2":"Customer",
    "3":"Customer"
}
Nested Schema : optionsExt
Type: object
Read-only derived helper object for meaningful format options.
Show Source
Back to Top