Outputs



QueryOutputBase [Schema]

The output base type. Used to specify the elements outputted to the report.

Name Type Required Description
Output xsd:string (enumeration)
  • Element
  • Attribute
  • Variable
  • VariableSum
  • VariableAppend
  • VariablePrepend
  • ElementDatePart
 no The target location for the output. Allows the output to be directed towards: element, attribute or variable. If omitted; defaults to element.
MaxLength xsd:integer ( min: 0) no The maximum character length. Specifies the maximum number of characters to be output.

RenderEntity

Interits from: QueryOutputBase

The render entity type. Used to render the entire serialised entity to the report output.

Name Type Required Description

Interits from: QueryOutputBase

The render entity link type. Used to render the entity resource locator link to the report output.

Name Type Required Description

RenderProperty

Interits from: QueryOutputBase

The render property type. Used to render the property values of the matched entities during the report generation process.

Name Type Required Description
Name xsd:string no The output name. Specifies the name of the output target.
Property xsd:string
Pattern: [A-Za-z0-9_\.]+		 no The property name. Indicates the entity property to be used in the filter expression.
Format xsd:string no The output formatting. Used to apply string formatting to the output result.

RenderTaxPeriod

Interits from: QueryOutputBase

The render tax period type. Used to render details of the tax period matched bt the specified date and payment frequency.

Tax Period Format:

  • pp-yyyy/yy (01-2017/18)
  • pp: Tax Period (padded with leading zero if required)
  • yyyy: The starting year for the tax period.
  • yy: The ending year for the tax period.

Name Type Required Description
DisplayName xsd:string no The output display name. Specifies the name of the output target.
PayFrequency xsd:string no The payment frequency. Used to identify the required tax period. Variable names are allowed.
Date xsd:string no The context date. Used to identify the required tax period. Variable names are allowed.
RenderOption xsd:string (enumeration)
  • AsString
  • PeriodOnly
  • YearOnly
 no The optional tax period output type. Enables the selection of the tax year output type.

RenderTaxPeriodDate

Interits from: QueryOutputBase

The render tax period date. Used to render the start or end tax period dates.

Name Type Required Description
DisplayName xsd:string no The output display name. Specifies the name of the output target.
TaxYear xsd:string no The starting year. The year in which the required tax period stated. Variable names are allowed.
TaxPeriod xsd:string no The tax period number. Variable names are allowed.
PayFrequency xsd:string no The payment frequency. Used to identify the required tax period. If omitted; defaults to Monthly.
Format xsd:string no The formatting option. Used to format the resulting tax period date.
EndDate xsd:boolean no The end date option. Used to select the tax period end date. If omitted; defaults to False.

RenderTypeName

Interits from: QueryOutputBase

The render entity type name. Used to render data type name for the matched entities during the query execution.

Name Type Required Description
Name xsd:string no The output display name. Specifies the name of the output target.

RenderValue

Interits from: QueryOutputBase

The render value output. Used to render a value during the query processing. Enables the output of variable values.

Name Type Required Description
Name xsd:string no The output name. Specifies the name of the output target.
Value xsd:string no The output value. Specifies the value to be written to the query output. Variable names are allowed.
Format xsd:string no The output formatting. Used to apply string formatting to the output result.
Negate xsd:boolean no The value negation option. Determines if the rendered numeric value should be negated.

RenderConstant

Interits from: QueryOutputBase

The render output constant type. Used to select constant values from within the API.

Name Type Required Description
Name xsd:string no The output name. Provides the name of the outputted value.
ConstantName xsd:string no The name of the API constant value. Provides the name of the constant value to be rendered.
ConstantType xsd:string (enumeration)
  • System.Decimal
  • System.Integer
  • System.String
 no The data type name of constant value. Provides the name of the constant value data type to be rendered.

RenderArrayHint

Interits from: QueryOutputBase

The render array hint. Used to force the generation of Json array brackets around child entity collections.

Name Type Required Description

RenderIndex

Interits from: QueryOutputBase

The render index output type. Used to create an incrementing index attribute. Indexes are used to provide paging support across large data sets.

Name Type Required Description

RenderNextDate

Interits from: QueryOutputBase

The render next date output type. Used to calculate the next per period date based on a specified start date and pay frequency.

Name Type Required Description
Name xsd:string no The output display name. Specifies the name of the output target.
Date xsd:string no The context date. Used to identify the required tax period. Variable names are allowed.
PayFrequency xsd:string no The payment frequency. Used to identify the required tax period. Variable names are allowed.
Format xsd:string no The formatting option. Used to format the resulting tax period date.

RenderDateAdd

Interits from: QueryOutputBase

The render date add output type. Used to calculate a new date based on interval and increment values.

Name Type Required Description
Name xsd:string no The output display name. Specifies the name of the output target.
Date xsd:string no The source date that the calculated date will be based upon.
Interval xsd:string no The interval type to add or subtract from the source date.
Increment xsd:integer no The increment value to add or subtract from the source date; can be negative.
Format xsd:string no The formatting option. Used to format the resulting tax period date.

Interits from: QueryOutputBase

The render unique key from link output. Used to render the unique key value from a link href during the query processing.

Name Type Required Description
Name xsd:string no The output name. Specifies the name of the output target.
Href xsd:string no The link href value. Specifies the link href from which the unique key should be extracted.