AVACloud API 1.60.10

AslvConversion

AslvConversion_ConvertToAva

Converts Aslv files to Dangl.AVA projects

Request

POST /conversion/aslv/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
aslvFile			The input file
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

AslvConversion_ConvertToFlatAva

Converts Aslv files to Dangl.AVA projects

Request

POST /conversion/aslv/flat-ava

Parameters

Name	Type	Default	Notes
aslvFile			The input file

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

AslvConversion_ConvertToGaeb

Converts Aslv files to GAEB files

Request

POST /conversion/aslv/gaeb[?DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts&ForceIncludeDescriptions&TreatNullItemNumberSchemaAsInvalid]

Parameters

Name	Type	Default	Notes
aslvFile			The input file
DestinationGaebType			Defaults to GAEB XML V3.2
TargetExchangePhaseTransform			Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
EnforceStrictOfferPhaseLongTextOutput			Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
ExportQuantityDetermination			Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
ForceIncludeDescriptions			If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
TreatNullItemNumberSchemaAsInvalid			When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AslvConversion_ConvertToExcel

Converts Aslv files to Excel

Request

POST /conversion/aslv/excel[?WritePrices&WriteLongTexts&ConversionCulture&IncludeArticleNumbers&LockAllCellsButPrices]

Parameters

Name	Type	Default	Notes
aslvFile			The input file
WritePrices			Defaults to true
WriteLongTexts			Defaults to true
ConversionCulture			The culture that should be used for the conversion process, to have localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
IncludeArticleNumbers			If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from 'position.commerceProperties.articleNumber'
LockAllCellsButPrices			If this is enabled, then all cells except the unit price cells will be locked, so users can not accidentally modify other fields.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AslvConversion_ConvertToOenorm

Converts Aslv files to Oenorm files

Request

POST /conversion/aslv/oenorm[?DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]

Parameters

Name	Type	Default	Notes
aslvFile			The input file
DestinationOenormType			Defaults to Lv2015
TryRepairProjectStructure			Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
SkipTryEnforceSchemaCompliantXmlOutput			If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AvaConversion

AvaConversion_ConvertToAva

Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.

Request

POST /conversion/ava/ava[?TryAutoGenerateItemNumbersAndSchema&RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

AvaConversion_ConvertToFlatAva

Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.

Request

POST /conversion/ava/flat-ava[?TryAutoGenerateItemNumbersAndSchema]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

AvaConversion_ConvertToGaeb

Converts Dangl.AVA projects to GAEB

Request

POST /conversion/ava/gaeb[?TryAutoGenerateItemNumbersAndSchema&DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts&ForceIncludeDescriptions&TreatNullItemNumberSchemaAsInvalid]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
DestinationGaebType			Defaults to GAEB XML V3.2
TargetExchangePhaseTransform			Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
EnforceStrictOfferPhaseLongTextOutput			Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
ExportQuantityDetermination			Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
ForceIncludeDescriptions			If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
TreatNullItemNumberSchemaAsInvalid			When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AvaConversion_ConvertToExcel

Converts Dangl.AVA projects to Excel

Request

POST /conversion/ava/excel[?TryAutoGenerateItemNumbersAndSchema&WritePrices&WriteLongTexts&ConversionCulture&IncludeArticleNumbers&LockAllCellsButPrices]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
WritePrices			Defaults to true
WriteLongTexts			Defaults to true
ConversionCulture			The culture that should be used for the conversion process, to have localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
IncludeArticleNumbers			If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from 'position.commerceProperties.articleNumber'
LockAllCellsButPrices			If this is enabled, then all cells except the unit price cells will be locked, so users can not accidentally modify other fields.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AvaConversion_ConvertToReb

Converts Dangl.AVA projects to REB

Request

POST /conversion/ava/reb[?TryAutoGenerateItemNumbersAndSchema&DestinationRebType&LastRowAddress]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
DestinationRebType			Defaults to D11
LastRowAddress			If this is present, the export to REB will be started from the next available row address after the given one. This must be a valid 6 character address, e.g. "1234A0"

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AvaConversion_ConvertToOenorm

Converts Dangl.AVA projects to Oenorm

Request

POST /conversion/ava/oenorm[?TryAutoGenerateItemNumbersAndSchema&DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
DestinationOenormType			Defaults to Lv2015
TryRepairProjectStructure			Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
SkipTryEnforceSchemaCompliantXmlOutput			If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AvaConversion_ConvertToSia

Converts Dangl.AVA projects to SIA 451

Request

POST /conversion/ava/sia[?TryAutoGenerateItemNumbersAndSchema&SiaDestinationType]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
SiaDestinationType			Defaults to Sia451

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AvaConversion_ConvertToDatanorm

Converts Dangl.AVA projects to Datanorm

Request

POST /conversion/ava/datanorm[?TryAutoGenerateItemNumbersAndSchema&DatanormDestinationVersion]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
DatanormDestinationVersion			The Datanorm version to convert to. Defaults to V4.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AvaConversion_ConvertToUgl

Converts Dangl.AVA projects to UGL

Request

POST /conversion/ava/ugl[?TryAutoGenerateItemNumbersAndSchema&UglDestinationVersion]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
UglDestinationVersion			The UGL version to convert to. Defaults to V1.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

AvaConversion_ConvertToIdsConnect

Converts Dangl.AVA projects to IDS Connect files

Request

POST /conversion/ava/ids-connect[?TryAutoGenerateItemNumbersAndSchema&Version]

Parameters

Name	Type	Default	Notes
*avaProject	ProjectDto		The Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
Version			The IDS Connect version to convert to. Defaults to V2_5.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

DanglIdentity

DanglIdentity_LoginWithCookie

Request

POST /identity/login[?redirectUrl]

Parameters

Name	Type	Default	Notes
*model	LoginPost
redirectUrl

Responses

Status Code	Type	Description	Samples
204
401

DanglIdentity_SignOutWithSignInManager

Request

DELETE /identity/login

Responses

Status Code	Type	Description	Samples
204

DanglIdentity_LoginAndReturnToken

Request

POST /identity/token-login

Parameters

Name	Type	Default	Notes
*model	TokenLoginPost

Responses

Status Code	Type	Description	Samples
200	TokenResponseGet
400	TokenResponseGet
401

DanglIdentity_RefreshToken

Request

POST /identity/token-refresh

Parameters

Name	Type	Default	Notes
*model	TokenRefreshPost

Responses

Status Code	Type	Description	Samples
200	TokenResponseGet
400	TokenResponseGet
401

DanglIdentity_Register

Request

POST /identity/register

Parameters

Name	Type	Default	Notes
*registerModel	RegisterPost

Responses

Status Code	Type	Description	Samples
204
400	ApiError

DanglIdentity_RequestPasswordReset

Request

POST /identity/password-forgotten

Parameters

Name	Type	Default	Notes
*forgotPasswordModel	ForgotPasswordPost

Responses

Status Code	Type	Description	Samples
204
400	ApiError

DanglIdentity_GetUserInfo

Request

GET /identity/user-info

Responses

Status Code	Type	Description	Samples
200	UserInfoGet
400	ApiError

DatanormConversion

DatanormConversion_ConvertToAva

Converts Datanorm files to Dangl.AVA projects

Request

POST /conversion/datanorm/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
datanormFile			The input file
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

DatanormConversion_ConvertToFlatAva

Converts Datanorm files to Dangl.AVA projects

Request

POST /conversion/datanorm/flat-ava

Parameters

Name	Type	Default	Notes
datanormFile			The input file

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

ExcelConversion

ExcelConversion_ConvertToAva

Converts Excel files to Dangl.AVA projects.

Request

POST /conversion/excel/ava[?ReadNewElements&RebuildItemNumberSchema&RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
excelFile			The input file
ReadNewElements			Defaults to false
RebuildItemNumberSchema			When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
400	ApiError
200	ProjectDto

ExcelConversion_ConvertToFlatAva

Converts Excel files to Dangl.AVA projects.

Request

POST /conversion/excel/flat-ava[?ReadNewElements&RebuildItemNumberSchema]

Parameters

Name	Type	Default	Notes
excelFile			The input file
ReadNewElements			Defaults to false
RebuildItemNumberSchema			When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

ExcelConversion_ConvertToGaeb

Converts Excel files to GAEB files.

Request

POST /conversion/excel/gaeb[?ReadNewElements&RebuildItemNumberSchema&DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts&ForceIncludeDescriptions&TreatNullItemNumberSchemaAsInvalid]

Parameters

Name	Type	Default	Notes
excelFile			The input file
ReadNewElements			Defaults to false
RebuildItemNumberSchema			When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
DestinationGaebType			Defaults to GAEB XML V3.2
TargetExchangePhaseTransform			Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
EnforceStrictOfferPhaseLongTextOutput			Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
ExportQuantityDetermination			Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
ForceIncludeDescriptions			If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
TreatNullItemNumberSchemaAsInvalid			When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

ExcelConversion_ConvertToExcel

Converts Excel files to Excel files. Used, for example, when elements were added in excel to generate or modify a project. The Excel file can then be shared containing the full project with all formattings, formulas and styles applied.

Request

POST /conversion/excel/excel[?ReadNewElements&RebuildItemNumberSchema&WritePrices&WriteLongTexts&ConversionCulture&IncludeArticleNumbers&LockAllCellsButPrices]

Parameters

Name	Type	Default	Notes
excelFile			The input file
ReadNewElements			Defaults to false
RebuildItemNumberSchema			When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
WritePrices			Defaults to true
WriteLongTexts			Defaults to true
ConversionCulture			The culture that should be used for the conversion process, to have localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
IncludeArticleNumbers			If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from 'position.commerceProperties.articleNumber'
LockAllCellsButPrices			If this is enabled, then all cells except the unit price cells will be locked, so users can not accidentally modify other fields.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

ExcelConversion_ConvertToOenorm

Converts Excel files to Oenorm files.

Request

POST /conversion/excel/oenorm[?ReadNewElements&RebuildItemNumberSchema&DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]

Parameters

Name	Type	Default	Notes
excelFile			The input file
ReadNewElements			Defaults to false
RebuildItemNumberSchema			When importing new elements from Excel, sometimes the ItemNumberSchema in the file is not in compliance with the GAEB requirements. Enabling this option tries to repair the ItemNumberSchema. Defaults to false.
DestinationOenormType			Defaults to Lv2015
TryRepairProjectStructure			Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
SkipTryEnforceSchemaCompliantXmlOutput			If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

FlatAvaConversion

FlatAvaConversion_ConvertToAva

Converts flat Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.

Request

POST /conversion/flat-ava/ava[?TryAutoGenerateItemNumbersAndSchema&RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

FlatAvaConversion_ConvertToFlatAva

Converts flat Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.

Request

POST /conversion/flat-ava/flat-ava[?TryAutoGenerateItemNumbersAndSchema]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

FlatAvaConversion_ConvertToGaeb

Converts flat Dangl.AVA projects to GAEB

Request

POST /conversion/flat-ava/gaeb[?TryAutoGenerateItemNumbersAndSchema&DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts&ForceIncludeDescriptions&TreatNullItemNumberSchemaAsInvalid]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
DestinationGaebType			Defaults to GAEB XML V3.2
TargetExchangePhaseTransform			Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
EnforceStrictOfferPhaseLongTextOutput			Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
ExportQuantityDetermination			Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
ForceIncludeDescriptions			If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
TreatNullItemNumberSchemaAsInvalid			When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

FlatAvaConversion_ConvertToExcel

Converts flat Dangl.AVA projects to Excel

Request

POST /conversion/flat-ava/excel[?TryAutoGenerateItemNumbersAndSchema&WritePrices&WriteLongTexts&ConversionCulture&IncludeArticleNumbers&LockAllCellsButPrices]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
WritePrices			Defaults to true
WriteLongTexts			Defaults to true
ConversionCulture			The culture that should be used for the conversion process, to have localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
IncludeArticleNumbers			If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from 'position.commerceProperties.articleNumber'
LockAllCellsButPrices			If this is enabled, then all cells except the unit price cells will be locked, so users can not accidentally modify other fields.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

FlatAvaConversion_ConvertToReb

Converts flat Dangl.AVA projects to REB

Request

POST /conversion/flat-ava/reb[?TryAutoGenerateItemNumbersAndSchema&DestinationRebType&LastRowAddress]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
DestinationRebType			Defaults to D11
LastRowAddress			If this is present, the export to REB will be started from the next available row address after the given one. This must be a valid 6 character address, e.g. "1234A0"

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

FlatAvaConversion_ConvertToOenorm

Converts flat Dangl.AVA projects to Oenorm

Request

POST /conversion/flat-ava/oenorm[?TryAutoGenerateItemNumbersAndSchema&DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
DestinationOenormType			Defaults to Lv2015
TryRepairProjectStructure			Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
SkipTryEnforceSchemaCompliantXmlOutput			If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

FlatAvaConversion_ConvertToSia

Converts flat Dangl.AVA projects to SIA 451

Request

POST /conversion/flat-ava/sia[?TryAutoGenerateItemNumbersAndSchema&SiaDestinationType]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
SiaDestinationType			Defaults to Sia451

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

FlatAvaConversion_ConvertToDatanorm

Converts flat Dangl.AVA projects to Datanorm

Request

POST /conversion/flat-ava/datanorm[?TryAutoGenerateItemNumbersAndSchema&DatanormDestinationVersion]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
DatanormDestinationVersion			The Datanorm version to convert to. Defaults to V4.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

FlatAvaConversion_ConvertToUgl

Converts flat Dangl.AVA projects to UGL

Request

POST /conversion/flat-ava/ugl[?TryAutoGenerateItemNumbersAndSchema&UglDestinationVersion]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
UglDestinationVersion			The UGL version to convert to. Defaults to V1.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

FlatAvaConversion_ConvertToIdsConnect

Converts flat Dangl.AVA projects to IDS Connect files

Request

POST /conversion/flat-ava/ids-connect[?TryAutoGenerateItemNumbersAndSchema&Version]

Parameters

Name	Type	Default	Notes
*flatAvaProject	FlatAvaProject		The flat Dangl.AVA project
TryAutoGenerateItemNumbersAndSchema			If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
Version			The IDS Connect version to convert to. Defaults to V2_5.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

GaebConversion

GaebConversion_ConvertToAva

Converts GAEB files to Dangl.AVA projects

Request

POST /conversion/gaeb/ava[?SupportSkippedItemNumberLevelsInPositions&RemovePlainTextLongTexts&RemoveHtmlLongTexts&OutputHtmlAsXml&KeepEmptyHtmlText&AllowUpperCaseItemNumbers&AllowLumpSumItemsWithDifferingQuantities&DisableItemNumberIdentifierTransformations]

Parameters

Name	Type	Default	Notes
gaebFile			The input file
SupportSkippedItemNumberLevelsInPositions			Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes
OutputHtmlAsXml			Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce ' ' instead of ' '.
KeepEmptyHtmlText			Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
AllowUpperCaseItemNumbers			Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
AllowLumpSumItemsWithDifferingQuantities			Defaults to 'false'. By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then differing quantities will be kept during the import.
DisableItemNumberIdentifierTransformations			If this is enabled, single item number tiers will only be left padded with spaces to their respective length, but spaces will not be filled with zeroes at the beginning. Defaults to 'false'. This can be used to preserve item numbers exactly as they are in the source file, but it is not recommended to use this option since it may also allow incorrect or non schema compliant item numbers to be imported.

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

GaebConversion_ConvertToFlatAva

Converts GAEB files to Dangl.AVA projects

Request

POST /conversion/gaeb/flat-ava[?SupportSkippedItemNumberLevelsInPositions&OutputHtmlAsXml&KeepEmptyHtmlText&AllowUpperCaseItemNumbers&AllowLumpSumItemsWithDifferingQuantities&DisableItemNumberIdentifierTransformations]

Parameters

Name	Type	Default	Notes
gaebFile			The input file
SupportSkippedItemNumberLevelsInPositions			Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
OutputHtmlAsXml			Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce ' ' instead of ' '.
KeepEmptyHtmlText			Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
AllowUpperCaseItemNumbers			Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
AllowLumpSumItemsWithDifferingQuantities			Defaults to 'false'. By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then differing quantities will be kept during the import.
DisableItemNumberIdentifierTransformations			If this is enabled, single item number tiers will only be left padded with spaces to their respective length, but spaces will not be filled with zeroes at the beginning. Defaults to 'false'. This can be used to preserve item numbers exactly as they are in the source file, but it is not recommended to use this option since it may also allow incorrect or non schema compliant item numbers to be imported.

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

GaebConversion_ConvertToGaeb

Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.

Request

POST /conversion/gaeb/gaeb[?SupportSkippedItemNumberLevelsInPositions&DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts&ForceIncludeDescriptions&TreatNullItemNumberSchemaAsInvalid&OutputHtmlAsXml&KeepEmptyHtmlText&AllowUpperCaseItemNumbers&AllowLumpSumItemsWithDifferingQuantities&DisableItemNumberIdentifierTransformations]

Parameters

Name	Type	Default	Notes
gaebFile			The input file
SupportSkippedItemNumberLevelsInPositions			Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
DestinationGaebType			Defaults to GAEB XML V3.2
TargetExchangePhaseTransform			Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
EnforceStrictOfferPhaseLongTextOutput			Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
ExportQuantityDetermination			Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
ForceIncludeDescriptions			If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
TreatNullItemNumberSchemaAsInvalid			When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.
OutputHtmlAsXml			Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce ' ' instead of ' '.
KeepEmptyHtmlText			Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
AllowUpperCaseItemNumbers			Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
AllowLumpSumItemsWithDifferingQuantities			Defaults to 'false'. By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then differing quantities will be kept during the import.
DisableItemNumberIdentifierTransformations			If this is enabled, single item number tiers will only be left padded with spaces to their respective length, but spaces will not be filled with zeroes at the beginning. Defaults to 'false'. This can be used to preserve item numbers exactly as they are in the source file, but it is not recommended to use this option since it may also allow incorrect or non schema compliant item numbers to be imported.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

GaebConversion_ConvertToExcel

Converts GAEB files to Excel

Request

POST /conversion/gaeb/excel[?SupportSkippedItemNumberLevelsInPositions&WritePrices&WriteLongTexts&ConversionCulture&IncludeArticleNumbers&LockAllCellsButPrices&OutputHtmlAsXml&KeepEmptyHtmlText&AllowUpperCaseItemNumbers&AllowLumpSumItemsWithDifferingQuantities&DisableItemNumberIdentifierTransformations]

Parameters

Name	Type	Default	Notes
gaebFile			The input file
SupportSkippedItemNumberLevelsInPositions			Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
WritePrices			Defaults to true
WriteLongTexts			Defaults to true
ConversionCulture			The culture that should be used for the conversion process, to have localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
IncludeArticleNumbers			If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from 'position.commerceProperties.articleNumber'
LockAllCellsButPrices			If this is enabled, then all cells except the unit price cells will be locked, so users can not accidentally modify other fields.
OutputHtmlAsXml			Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce ' ' instead of ' '.
KeepEmptyHtmlText			Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
AllowUpperCaseItemNumbers			Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
AllowLumpSumItemsWithDifferingQuantities			Defaults to 'false'. By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then differing quantities will be kept during the import.
DisableItemNumberIdentifierTransformations			If this is enabled, single item number tiers will only be left padded with spaces to their respective length, but spaces will not be filled with zeroes at the beginning. Defaults to 'false'. This can be used to preserve item numbers exactly as they are in the source file, but it is not recommended to use this option since it may also allow incorrect or non schema compliant item numbers to be imported.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

GaebConversion_ConvertToOenorm

Converts GAEB files to Oenorm files

Request

POST /conversion/gaeb/oenorm[?SupportSkippedItemNumberLevelsInPositions&DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts&OutputHtmlAsXml&KeepEmptyHtmlText&AllowUpperCaseItemNumbers&AllowLumpSumItemsWithDifferingQuantities&DisableItemNumberIdentifierTransformations]

Parameters

Name	Type	Default	Notes
gaebFile			The input file
SupportSkippedItemNumberLevelsInPositions			Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position item numbers should be supported. For example, if an ItemNumberSchema defines three levels - two group levels and one position level - but the ItemNumber of the position is just '01.02', then it will be displayed as '01.__.02' if this is set to true.
DestinationOenormType			Defaults to Lv2015
TryRepairProjectStructure			Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
SkipTryEnforceSchemaCompliantXmlOutput			If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
OutputHtmlAsXml			Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output. This means that e.g. void Html tags will always be output with their closing tag, e.g. it will produce ' ' instead of ' '.
KeepEmptyHtmlText			Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output. Otherwise, Html text without any plain text will be removed. This is useful for example if you want to keep texts that only consist of empty paragraphs in the output.
AllowUpperCaseItemNumbers			Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase format if the source file has them. By default, all item numbers will be converted to lowercase, but this option will enable the option to support uppercase item numbers as well.
AllowLumpSumItemsWithDifferingQuantities			Defaults to 'false'. By default, the GAEB standard requires lump sum items ('Pauschalpositionen' in German) to have a quantity of exactly 1. AVACloud does enforce this convention, but if you set this property to 'true', then differing quantities will be kept during the import.
DisableItemNumberIdentifierTransformations			If this is enabled, single item number tiers will only be left padded with spaces to their respective length, but spaces will not be filled with zeroes at the beginning. Defaults to 'false'. This can be used to preserve item numbers exactly as they are in the source file, but it is not recommended to use this option since it may also allow incorrect or non schema compliant item numbers to be imported.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

IdsConnectConversion

IdsConnectConversion_ConvertToAva

Converts IDS Connect files to Dangl.AVA projects

Request

POST /conversion/ids-connect/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
idsConnectFile			The input file
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

IdsConnectConversion_ConvertToFlatAva

Converts IDS Connect files to Dangl.AVA projects

Request

POST /conversion/ids-connect/flat-ava

Parameters

Name	Type	Default	Notes
idsConnectFile			The input file

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

OenormConversion

OenormConversion_ConvertToAva

Converts ÖNorm files to Dangl.AVA projects

Request

POST /conversion/oenorm/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
oenormFile			The input file
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

OenormConversion_ConvertToFlatAva

Converts ÖNorm files to Dangl.AVA projects

Request

POST /conversion/oenorm/flat-ava

Parameters

Name	Type	Default	Notes
oenormFile			The input file

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

OenormConversion_ConvertToGaeb

Converts ÖNorm files to GAEB files.

Request

POST /conversion/oenorm/gaeb[?DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts&ForceIncludeDescriptions&TreatNullItemNumberSchemaAsInvalid]

Parameters

Name	Type	Default	Notes
oenormFile			The input file
DestinationGaebType			Defaults to GAEB XML V3.2
TargetExchangePhaseTransform			Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
EnforceStrictOfferPhaseLongTextOutput			Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
ExportQuantityDetermination			Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
ForceIncludeDescriptions			If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
TreatNullItemNumberSchemaAsInvalid			When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

OenormConversion_ConvertToExcel

Converts ÖNorm files to Excel

Request

POST /conversion/oenorm/excel[?WritePrices&WriteLongTexts&ConversionCulture&IncludeArticleNumbers&LockAllCellsButPrices]

Parameters

Name	Type	Default	Notes
oenormFile			The input file
WritePrices			Defaults to true
WriteLongTexts			Defaults to true
ConversionCulture			The culture that should be used for the conversion process, to have localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
IncludeArticleNumbers			If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from 'position.commerceProperties.articleNumber'
LockAllCellsButPrices			If this is enabled, then all cells except the unit price cells will be locked, so users can not accidentally modify other fields.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

OenormConversion_ConvertToOenorm

Converts ÖNorm files to Oenorm files.

Request

POST /conversion/oenorm/oenorm[?DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]

Parameters

Name	Type	Default	Notes
oenormFile			The input file
DestinationOenormType			Defaults to Lv2015
TryRepairProjectStructure			Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
SkipTryEnforceSchemaCompliantXmlOutput			If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

RebConversion

RebConversion_ConvertToAva

Converts REB files to Dangl.AVA projects

Request

POST /conversion/reb/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
rebFile			The input file
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

RebConversion_ConvertToFlatAva

Converts REB files to Dangl.AVA projects

Request

POST /conversion/reb/flat-ava

Parameters

Name	Type	Default	Notes
rebFile			The input file

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

RebConversion_ConvertToGaeb

Converts REB files to GAEB files

Request

POST /conversion/reb/gaeb[?DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts&ForceIncludeDescriptions&TreatNullItemNumberSchemaAsInvalid]

Parameters

Name	Type	Default	Notes
rebFile			The input file
DestinationGaebType			Defaults to GAEB XML V3.2
TargetExchangePhaseTransform			Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
EnforceStrictOfferPhaseLongTextOutput			Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
ExportQuantityDetermination			Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
ForceIncludeDescriptions			If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
TreatNullItemNumberSchemaAsInvalid			When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

RebConversion_ConvertToExcel

Converts REB files to Excel

Request

POST /conversion/reb/excel[?WritePrices&WriteLongTexts&ConversionCulture&IncludeArticleNumbers&LockAllCellsButPrices]

Parameters

Name	Type	Default	Notes
rebFile			The input file
WritePrices			Defaults to true
WriteLongTexts			Defaults to true
ConversionCulture			The culture that should be used for the conversion process, to have localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
IncludeArticleNumbers			If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from 'position.commerceProperties.articleNumber'
LockAllCellsButPrices			If this is enabled, then all cells except the unit price cells will be locked, so users can not accidentally modify other fields.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

RebConversion_ConvertToOenorm

Converts REB files to Oenorm

Request

POST /conversion/reb/oenorm[?DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]

Parameters

Name	Type	Default	Notes
rebFile			The input file
DestinationOenormType			Defaults to Lv2015
TryRepairProjectStructure			Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
SkipTryEnforceSchemaCompliantXmlOutput			If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

SiaConversion

SiaConversion_ConvertToAva

Converts SIA 451 files to Dangl.AVA projects

Request

POST /conversion/sia/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
siaFile			The input file
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

SiaConversion_ConvertToFlatAva

Converts SIA 451 files to Dangl.AVA projects

Request

POST /conversion/sia/flat-ava

Parameters

Name	Type	Default	Notes
siaFile			The input file

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

SiaConversion_ConvertToGaeb

Converts SIA 451 files to GAEB files

Request

POST /conversion/sia/gaeb[?DestinationGaebType&TargetExchangePhaseTransform&EnforceStrictOfferPhaseLongTextOutput&ExportQuantityDetermination&RemoveUnprintableCharactersFromTexts&ForceIncludeDescriptions&TreatNullItemNumberSchemaAsInvalid]

Parameters

Name	Type	Default	Notes
siaFile			The input file
DestinationGaebType			Defaults to GAEB XML V3.2
TargetExchangePhaseTransform			Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
EnforceStrictOfferPhaseLongTextOutput			Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
ExportQuantityDetermination			Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
ForceIncludeDescriptions			If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
TreatNullItemNumberSchemaAsInvalid			When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

SiaConversion_ConvertToExcel

Converts SIA 451 files to Excel

Request

POST /conversion/sia/excel[?WritePrices&WriteLongTexts&ConversionCulture&IncludeArticleNumbers&LockAllCellsButPrices]

Parameters

Name	Type	Default	Notes
siaFile			The input file
WritePrices			Defaults to true
WriteLongTexts			Defaults to true
ConversionCulture			The culture that should be used for the conversion process, to have localized Excel files. The following conversion cultures are available: 'en' for English, 'de' for German, 'fr' for French, ' it' for Italian and ' es' for Spanish. If the culture is not supported, 'en' will be used.
IncludeArticleNumbers			If this is enabled, then a new column will be created in the overview worksheet that contains the article numbers for positions. Article numbers will be read from 'position.commerceProperties.articleNumber'
LockAllCellsButPrices			If this is enabled, then all cells except the unit price cells will be locked, so users can not accidentally modify other fields.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

SiaConversion_ConvertToOenorm

Converts SIA 451 files to Oenorm files

Request

POST /conversion/sia/oenorm[?DestinationOenormType&TryRepairProjectStructure&SkipTryEnforceSchemaCompliantXmlOutput&RemoveUnprintableCharactersFromTexts]

Parameters

Name	Type	Default	Notes
siaFile			The input file
DestinationOenormType			Defaults to Lv2015
TryRepairProjectStructure			Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
SkipTryEnforceSchemaCompliantXmlOutput			If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
RemoveUnprintableCharactersFromTexts			If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.

Responses

Status Code	Type	Description	Samples
400	ApiError
200	file

Status

Status_GetStatus

Reports the health status of the AVACloud API

Request

GET /status

Responses

Status Code	Type	Description	Samples
200	GetStatus

UglConversion

UglConversion_ConvertToAva

Converts Ugl files to Dangl.AVA projects

Request

POST /conversion/ugl/ava[?RemovePlainTextLongTexts&RemoveHtmlLongTexts]

Parameters

Name	Type	Default	Notes
uglFile			The input file
RemovePlainTextLongTexts			If set to true, plain text long texts will be removed from the output to reduce response sizes
RemoveHtmlLongTexts			If set to true, html long texts will be removed from the output to reduce response sizes

Responses

Status Code	Type	Description	Samples
200	ProjectDto
400	ApiError

UglConversion_ConvertToFlatAva

Converts Ugl files to Dangl.AVA projects

Request

POST /conversion/ugl/flat-ava

Parameters

Name	Type	Default	Notes
uglFile			The input file

Responses

Status Code	Type	Description	Samples
200	FlatAvaProject
400	ApiError

Validation

Validation_ValidateFile

This endpoint validates AVA files, typically GAEB or ÖNorm. The type of file needs to be provided as a query parameter, since there is no auto detection of the uploaded file type.

Request

POST /validation/file[?fileValidationSourceType]

Parameters

Name	Type	Default	Notes
avaFile			The file to validate
fileValidationSourceType			You need to indicate which type of file is being provided, there is no auto detection mechanism

Responses

Status Code	Type	Description	Samples
400	ApiError
200	ValidationResult

Validation_ValidateProject

This endpoint provides a full validation of a provided ProjectDto. It will take the given exchange phase into account and do some general project validation. Optionally, a conversion to a desired target can also be done, in which case the target file will also be validated.

Request

POST /validation/project

Parameters

Name	Type	Default	Notes
*avaProjectValidationSourceOptions	PostAvaProjectValidationSourceOptions		The options used for the validation operation

Responses

Status Code	Type	Description	Samples
400	ApiError
200	ValidationResult

XRechnungConversion

XRechnungConversion_ConvertXRechnungToInvoice

This will read an XRechnung file and convert it to an Invoice object

Request

POST /conversion/xrechnung/invoice

Parameters

Name	Type	Default	Notes
xrechnungFile

Responses

Status Code	Type	Description	Samples
200	Invoice
400	ApiError

XRechnungConversion_ConvertXRechnungToAva

This will read an XRechnung file and convert it to an AVA wrapper object

Request

POST /conversion/xrechnung/ava-wrapper

Parameters

Name	Type	Default	Notes
xrechnungFile

Responses

Status Code	Type	Description	Samples
200	AvaProjectWrapper
400	ApiError

XRechnungConversion_ConvertInvoiceToXRechnung

This will convert an Invoice object to an XRechnung file

Request

POST /conversion/xrechnung/invoice/xrechnung[?TargetFormat]

Parameters

Name	Type	Default	Notes
*invoice	Invoice
TargetFormat			The target format for the XRechnung export. Defaults to Ubl. Options are: Ubl, CrossIndustryInvoice and FacturX (ZUGFerd)

Responses

Status Code	Type	Description	Samples
200	file
400	ApiError

XRechnungConversion_ConvertAvaToXRechnung

This will convert an AVA wrapper object to an XRechnung file

Request

POST /conversion/xrechnung/ava-wrapper/xrechnung[?TargetFormat]

Parameters

Name	Type	Default	Notes
*avaWrapper	AvaProjectWrapper
TargetFormat			The target format for the XRechnung export. Defaults to Ubl. Options are: Ubl, CrossIndustryInvoice and FacturX (ZUGFerd)

Responses

Status Code	Type	Description	Samples
200	file
400	ApiError

XRechnungConversion_ConvertInvoiceToPdfInvoice

This will convert an Invoice object to a PDF file

Request

POST /conversion/xrechnung/invoice/pdf

Parameters

Name	Type	Default	Notes
*invoice	Invoice

Responses

Status Code	Type	Description	Samples
200	file
400	ApiError

XRechnungConversion_ConvertAvaToPdfInvoice

This will convert an AVA wrapper object to a PDF file

Request

POST /conversion/xrechnung/ava-wrapper/pdf

Parameters

Name	Type	Default	Notes
*avaWrapper	AvaProjectWrapper

Responses

Status Code	Type	Description	Samples
200	file
400	ApiError

Definitions

ProjectDto

A Project contains all relevant information for a construction project.

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
priceAccuracy	integer (int32)	This property controls the accuracy of all price properties, meaning how many decimal places are preserved in calculations. It defaults to DEFAULT_PRICE_ACCURACY. Please see the Dangl.AVA documentation for further information about decimal precision. If UnitPriceAccuracy is set, then this property is ignored for unit prices.
unitPriceAccuracy	integer (int32)	This property controls the accuracy of position unit price properties, meaning how many decimal places are preserved in calculations. Please see the Dangl.AVA documentation for further information about decimal precision. This can be separately set from PriceAccuracy, and it only controls the accuracy of the unit price of positions, not the total price. It defaults to null, which means the standard PriceAccuracy is used for unit prices.
forceStrictTotals	boolean	This forces total prices to be the strict product of quantities times unit price in positions. It is enabled by default. If this is disabled, both the unit price and the total price of positions is calculated from the non-rounded values. Please see the documentation for a more detailed explanation of this setting.
priceRoundingMode	PriceRoundingModeDto	This property controls the rounding mode of all price properties, meaning how rounding of decimal places is performed in price calculations. It defaults to DEFAULT_ROUNDING_MODE. Please see the Dangl.AVA documentation for further information about decimal precision.
projectInformation	ProjectInformationDto[]	The ProjectInformation contains information that describes the project and its structure.
serviceSpecifications	ServiceSpecificationDto[]	The ServiceSpecifications in this Project.
gaebXmlId	string	This is used to store the GAEB XML Id within this Project. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization.

PriceRoundingModeDto

This property controls the rounding mode of all price properties, meaning how rounding of decimal places is performed in price calculations. It defaults to DEFAULT_ROUNDING_MODE. Please see the Dangl.AVA documentation for further information about decimal precision.

Enum Values

Normal
Floor
Ceiling

ProjectInformationDto

The ProjectInformation contains information that describes the project and its structure.

Name	Type	Notes
buyer	PartyInformationDto[]	Information about the buyer.
description	string	Description for the project.
descriptionShort	string	Short description for the project.
name	string	Name of the project.
site	PartyInformationDto[]	Information about the site.
itemNumberSchema	ItemNumberSchemaDto[]	The ItemNumberSchema used in the project.
currencyShort	string	Short label for the currency used.
currencyLong	string	Full label of the currency used.
labourTimeLabel	string	Label for the labour time part of prices used in the project.
priceComponents	array	Labels for the price components used in the project. Caution: Removal of a price component will trigger to have dependent price informations be deleted in IElements that use this property. If this property is changed or altered after the project has already been used, it is strongly advised to do operations step by step, e.g. if renaming and reordering multiple price components, this should be done one by one. Otherwise, a combination of rename and reordering will not be correctly propagated downwards to child objects in this Project.
priceComponentTypes	object	This dictionary specifies actual types used for the PriceComponents. For example, a single price component might have the name 'Material' as a string, ans this dictionary would then have a key 'Material' and a value of Materials. You can not add keys here that are not also present in the PriceComponents property, and removing price components will also remove them from this dictionary here.
bidderCommentAllowed	boolean	This bool indicates if this project allows the bidder to add bidder comments. Bidder comments are a way to attach clarifying information when submitting an offer.
sideOffersAllowed	boolean	This property indicates if the project should allow side offers from contractors. In GAEB, a side offer would typically be in exchange phase 85.
awardType	AwardTypeDto	This enumeration describes the type of the award / procurement process. If this is used in a GAEB context, more information about award types can be found in the German VOB/A rules and the GAEB standard
specialAwardKind	SpecialAwardKindDto	This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary
requesters	PartyInformationDto[]	Requesters in a construction project, in German also called 'Bedarfsträger', are parties connected to the building process, e.g. architects or planners.
notificationSites	PartyInformationDto[]	Notification sites are addresses that are used for delivering messages in the context of construction projects.

PartyInformationDto

Information about the buyer.

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
name	string	This party's name.
street	string	This party's street.
zipCode	string	This party's ZipCode.
city	string	This party's City.
country	string	This party's Country.
identifier	string	This party's Identifier.
remarks	string	Remarks for this party.
email	string	An email address for this party.
phone	string	A phone number for this party.
contactPersonName	string	The name of a contact person.
awardIdentifier	string	This is an identifier related to this PartyInformation and their internal reference of the tender (or award). This might be used to assign an identifier (German "Vergabenummer") for the current project. This is typically only used in Buyer and Bidder representations and should map to the concept of "Vergabenummer" or "AwardNo" in GAEB.
isInEuropeanEconomicArea	boolean	This property indicates if the party is registered within the European Economic Area.
vatId	string	If this is within the European Economic Area (see IsInEuropeanEconomicArea, then as a business entity it likely has an EU VAT Id.
fax	string	The fax number for this party.
countryCode	string	The two letter ISO country code, e.g. DE for Germany.
creditorOrDebtorIdentifier	string	Depending on which party this class represents, it might have either a 'creditor' or 'debtor' number. This is often used in internal accounting systems.
globalLocationNumber	string	The Global Location Number (GLN) is issued by GS1 and is intended to be a unique identifier for the physical address of a party, e.g. a business office.
bankingInformation	BankingInformationDto[]	This list contains information about bank accounts associated with this PartyInformation. It's typically used for buyers and bidders.
registrationNumber	string	This can be used to specify a registration number for this party, e.g. a company registration number. It is usually used in GAEB XML commerce exchanges for bidders to supply their WEEE registration number, which is used to identify them as a registered WEEE company.
taxId	string	This can be used to specify a tax id for this party. It is different from the VatId and the RegistrationNumber. For example, in Germany this would be the "Steuernummer". This is usually not mapped to any AVA exchanges, but it's used e.g. in the XRechnung electronic invoices.

BankingInformationDto

This list contains information about bank accounts associated with this PartyInformation. It's typically used for buyers and bidders.

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
name	string	The name of the bank.
iban	string	The international identifier for the bank account.
accountNumber	string	The account number. Typically no longer used since the introduction of IBAN within the SEPA area.
bic	string	The international bank identifier.
routingNumber	string	The routing number for the bank. Typically no longer used since the introduction of IBAN within the SEPA area.

ItemNumberSchemaDto

The ItemNumberSchema used in the project.

Name	Type	Notes
totalLength	integer (int32)	The count of tiers in the ItemNumberSchema
tiers	ItemNumberSchemaTierDto[]	The collection of tiers for this ItemNumberSchema.
separator	string	The separator to use for separiting the different levels in an ItemNumber. Defaults to DEFAULT_SEPARATOR, which is a point '.'. Setting this to a space or other whitespaces is discouraged, as this might not work correct in all situations and item numbers could be displayed not as intended. This can not be set to an empty or null string, trying that will default to the DEFAULT_SEPARATOR. If a value is set that has a different length than one '1', the DEFAULT_SEPARATOR will be used instead. You should also not use values for the separator that are also valid for the item numbers themselves, as that might also lead to incorrect results
filler	string	This string is used to fill (left-pad) item numbers. For example, if a tier has a length of '4' but the given item number is '12', with a Filler of '0', then the final item number will be represented as '0'. This must be a single character string, if a value is given where the Length property does not evaluate to '1', the DEFAULT_FILLER '0' is used. A space is fine to use. You should ensure that you use a value different than Separator, as that might produce unexpected results. No attempt is done by the code to recover from such ambiguous configurations.
identifier	string	This is just a string property that can optionally be used to store additional data for this ItemNumberSchema, e.g. an identification or a type. It does not have any influence over how item numbers are generated, and is not supported in most exchange formats. However, it is used to store ÖNorm service specification structure types.
skipNonExistingLevelsInPositionItemNumbers	boolean	This property indicates if ItemNumbers using this ItemNumberSchema should skip empty group levels. This is commonly only used in GAEB files, where there might be gaps in the hierarchy of elements and position identifiers should be placed at the end of the string representation.
skippedTiersFiller	string	This string is used only when the property SkipNonExistingLevelsInPositionItemNumbers in this ItemNumberSchema is also set to true. It defaults to DEFAULT_SKIPPED_TIERS_FILLER, but can be set to any string with a lenght of one. Null values or values with a longer length will lead to this property reverting back to the default value. This is used to fill skipped tiers in item numbers where a position is placed in a higher hierarchy level than what would be defined in the Tiers. For example, it could produce an item number like '01.__.02', which would indicate a skipped second level. This should be using different values than Filler and Separator, since that could cause ambiguities in the code that generates the actual item numbers. No attempt is done by the code to recover from such ambiguous configurations.
schemaIsCorrectlyDefined	boolean	This is a read-only property that indicates if this schema has a valid structure. It internally just returns the result from IsCorrectlyDefined. This will return if the ItemNumberSchema is correctly defined. For it to be correctly defined, the following conditions must be true: There may only be one lot group, if there is one, it must be at the top. Following lot levels, there may be at least one group level. After the group levels, there must be one position level. After the position level, there may be one index level. If no tiers are defined at all, this will also return false.
allowUpperCaseLettering	boolean	Defaults to false. If this is disabled, all letters in the ItemNumber string representations will be transformed to their lowercase representation.
disableLeftPaddingTiersWithFiller	boolean	If this is set to true, single identifiers in an item number will not be left padded to fill the length of the tier. This is useful for allowing custom formats in item numbers, without following the GAEB standard. Defaults to false.
disableItemNumberIdentifierTransformations	boolean	If this is enabled, then item numbers will not be transformed, except padded. This makes it possible to represent item numbers as-is from e.g. a GAEB file, and also mixing padded and non-padded segments in an item number. This is not recommonded to use by default, since it will lead to inconsistent item numbers in the project.
disableItemNumberIdentifierTransformationsOnlyForAlphanumericTiers	boolean	This property is used in combination with DisableItemNumberIdentifierTransformations. If this is enabled, then the transformation of item numbers is only disabled for alphanumeric tiers. This means that numeric tiers will still be padded with the filler character, but alphanumeric tiers will not be transformed

ItemNumberSchemaTierDto

The collection of tiers for this ItemNumberSchema.

Name	Type	Notes
length	integer (int32)	The (maximum) length for this tier. Will not accept a length less than 1. Defaults to 1 if length less than one is specified.
type	ItemNumberTypeDto	This ItemNumberSchemaTier's type.
alignment	ItemNumberSchemaTierAlignmentDto	This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value.
tierType	ItemNumberSchemaTierTypeDto	This specifies which ItemNumberSchemaTierType this tier represents. This can be, for example, a group tier / level, a position level or a lot level.
isLot	boolean	Indicates if this tier represents a lot. See the documentation for more information about lots.
increment	integer (int32)	This value is the increment, or step size, that should be used for new item numbers. It defaults to DEFAULT_INCREMENT, but can be changed to any other positive number greater than zero. Invalid values make this be set to one '1'
tierName	string	This is an optional name for the given tier

ItemNumberTypeDto

This ItemNumberSchemaTier's type.

Enum Values

Numeric
Alphanumeric

ItemNumberSchemaTierAlignmentDto

This enum represents the alignment value for a tier in an ItemNumberSchema. It is not used anywhere for computations at the moment, and is mostly an informational value.

Enum Values

Undefined
Left
Right

ItemNumberSchemaTierTypeDto

This specifies which ItemNumberSchemaTierType this tier represents. This can be, for example, a group tier / level, a position level or a lot level.

Enum Values

Undefined
Index
Position
Group
Lot

AwardTypeDto

This enumeration describes the type of the award / procurement process. If this is used in a GAEB context, more information about award types can be found in the German VOB/A rules and the GAEB standard

Enum Values

Unspecified
OpenProcurement
ClosedProducrement
NegotiationProcurementWithoutPublicAnnouncement
NegotiationProcurement
OpenCall
SelectedCallWithoutPublicCompetition
SelectedCall
DirectAward
InternationalNATOProcurement
CompetitiveDialog

SpecialAwardKindDto

This enumeration describes awards for project that are not just a regular procurement. For example, it can be used to describe recurring maintenance or an outline contract (German: Rahmenvertrag) which just specifies services and prices but may be requested on demand when necessary

Enum Values

Unspecified
MaintenanceContract
OutlineContract
OutlineForMaintenanceContract

ServiceSpecificationDto

The ServiceSpecifications in this Project.

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
projectHourlyWage	number (decimal)	The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements.
projectTaxRate	number (decimal)	The tax rate that is used within this ElementContainerBase. Will be propagated to child elements.
projectPriceComponents	array	The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project.
projectItemNumberSchema	ItemNumberSchemaDto[]	The ItemNumberSchema that is used within this project.
elements	IElementDto[]	The IElements within this ElementContainerBase.
projectLabourTimeLabel	string	The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden".
containsDuplicateItemNumbers	boolean	Indicates if there are child IElements that have conflicting, duplicated ItemNumbers or if any child ElementContainerBase elements themselves contain duplicate ItemNumber s. Will always indicate false when told to ignore duplicate item numbers.
containsDuplicateElementIds	boolean	Indicates if there are child IElements that have conflicting, duplicated Ids or if any child ElementContainerBase elements themselves contain duplicate Id s. Will always indicate false when told to ignore duplicate item numbers.
ignoreDuplicateItemNumbers	boolean	Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes.
ignoreProjectCataloguePropagation	boolean	If this is set to true, the ProjectCatalogues property will not be propagated to child elements. This is useful in mapping scenarios, where you want to disable propagation for multiple changes, and only enable it once you have mapped all properties
ignoreDuplicateElementIds	boolean	Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes.
totalPriceGrossByTaxRate	GrossPriceComponentDto[]	Price composition by tax rate.
ignoreChildPriceUpdates	boolean	Internally used to indicate that a propagation is currently done, this is done to not recalculate every single result from a lot of changes when it is sufficient to calculate the total price at once.
deductedPrice	number (decimal)	Net price after applied deductions.
deductionFactor	number (decimal)	Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied.
absoluteDeduction	number (decimal)	The exact amount of the discount as an absolute value. For backwards compatibility reasons, setting this value will also set a calculated value to DeductionFactor, which will also be updated in case the total price is changed to reflect a relative value of the absolute discount sum.
totalPrice	number (decimal)	Will return this ElementContainerBase's total price.
totalPriceGross	number (decimal)	The total gross price for this ElementContainerBase including all child elements.
totalPriceGrossDeducted	number (decimal)	Total gross price after applied deductions.
priceType	PriceTypeDto	Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not.
bidder	PartyInformationDto[]	Information about the bidder.
bidderDiscriminator	string	This discriminator is used to identify different bidders in a project. It is different from the Identifier property in the Bidder in that the BidderDiscriminator is intended to be a numerical identifier within a project, while the Identifier does uniquely identify a bidder in the system independent of a specific project. This property should map to "Bieternummer" or "BidderNo" in GAEB.
gaebXmlId	string	This is used to store the GAEB XML Id within this ServiceSpecification. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization.
projectInformation	ProjectInformationDto[]	The ProjectInformation used within the Project in which this ElementContainerBase is contained. This is reference equal to the ProjectInformation used in the parent project.
exchangePhase	ExchangePhaseDto	This service specifications exchange phase, i.e. the current status in the project it is intended to be used (such as request for offer, offer, awarding...).
origin	OriginDto	This indicates where the service specification originates, i.e. from an exchange file format or self created. If applicable, additional information is present in the OriginDetail property.
originDetail	string	This property complements the Origin property. Some formats, e.g. GaebXml might have additional information attached, e.g. GAEB XML V3.2 oder GAEB XML V3.1. This string property is used to hold such data. The Dangl.AVA module does not have a list of possible values, since this is defined in the native format assemblies, e.g. Dangl.GAEB or Dangl.Oenorm.
creationDate	string (date-time)	Creation date of this ServiceSpecification.
offerByDate	string (date-time)	Date indicating until when an offer has to be submitted. In German, this is often called the "Eröffnungstermin"
decisionDate	string (date-time)	Date indicating by when the buyer will select a contractor.
bidDate	string (date-time)	Date of when the offer / bid was created
warrantyBondPercentage	number (decimal)	If a construction project requires a warranty bond, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as a warranty bond.
executionGuaranteePercentage	number (decimal)	If a construction project requires an execution guarantty, this property indicates the amount as a percentage, e.g. '0.15m' means 15% of the construction total amount as an execution guarantee. In practice, this percentage is usually deducted from intermediate invoices and only billed in the final invoice.
submissionLocation	string	String indicating where the physical submission of the offer is taking place.
description	string	Description of this ServiceSpecification.
name	string	The name of this ServiceSpecification.
priceInformation	PriceInformationDto[]	This PriceInformation contains global data for the ServiceSpecification. When inside a Project, do not set this property manually.
projectCatalogues	CatalogueDto[]	These are Catalogue that are used within this ElementContainerBase. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves.
catalogueReferences	CatalogueReferenceDto[]	Referenced catalogues for this ElementContainerBase.
plannedExecutionStart	string (date-time)	The date when the execution of the services is scheduled to start
plannedExecutionEnd	string (date-time)	The date then the execution of the services is scheduled to be finished
contractDate	string (date-time)	The date on which the contract has been awarded. This matches "Auftragsdatum" in GAEB
contractIdentifier	string	This value can be used to indicate the number or identifier of the contract. It matches "Auftragsnummer" in GAEB
warrantyDuration	WarrantyDurationDto[]	This indicates how long the warranty period is for this ServiceSpecification
warrantyEnd	string (date-time)	The date on which the warranty period ends
approvalDate	string (date-time)	The date on which the services rendered by the bidder are scheduled to be approved by the buyer
typeOfApproval	string	This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB
addendumNumber	string	This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German.
addendumStatus	AddendumStatusDto	This indicates, if this element is part of an addendum an, if yes, with what status.
commerceProperties	ServiceSpecificationCommercePropertiesDto[]	This property holds additional information that's only valid in commerce exchange phases.

IElementDto

The IElements within this ElementContainerBase.

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
gaebXmlId	string	This is used to store the GAEB XML Id within this IElement. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization.
addendumNumber	string	This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German.
projectCatalogues	CatalogueDto[]
catalogueReferences	CatalogueReferenceDto[]
elementTypeDiscriminator	string

CatalogueDto

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
gaebXmlId	string	This is used to store the GAEB XML Id within this Catalogue. This data is not used for any calculations or evaluations but only for GAEB serialization and deserialization.
name	string	The name that is given for this catalogue.
description	string	Additional information about this catalogue.
catalogueType	CatalogueTypeDto	If given, this gives a classification for the contents of the catalogue
catalogueTypeDetail	string	This property may hold additional information about the catalogue type. It is currently only used in GAEB XML exchange to carry detailed information about a catalogue type, but it's otherwise just a free text field.

CatalogueTypeDto

If given, this gives a classification for the contents of the catalogue

Enum Values

Unknown
Location
DIN276
CostUnit
WorkCategory
OenormB1801CostGroup
BIM
Attachment

CatalogueReferenceDto

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
catalogueReferenceKey	string	This points to the item in the catalogue itself. This means that, for example when this quantity assignment references a "DIN 276" catalogue, this property indicates the number / identifier / key in DIN 276 that is referenced.
catalogueReferenceId	string (guid)	The Id of the CatalogueReference that is targeted by this item. Set this property to set the referenced catalogue.
projectCatalogues	CatalogueDto[]	These are CatalogueReference that are used within this ServiceSpecification. Catalogue references are used to describe catalogues, or collections, that can be used to describe elements with commonly known properties. For example, QuantityAssignments use these to categorize themselves.
catalogue	CatalogueDto[]	This returns the referenced catalogue. Will return null if there is no reference or the catalogue is not present in the ProjectCatalogues.

GrossPriceComponentDto

Price composition by tax rate.

Name	Type	Notes
taxRate	number (decimal)	This components tax rate.
deductionFactor	number (decimal)	This is the factor of applied deductions for this component
totalNet	number (decimal)	The total net price for all components of a given tax rate.
totalDeducted	number (decimal)	The resulting price component after applied deductions
totalTax	number (decimal)	The total tax amount for all components of a given tax rate.
totalGross	number (decimal)	The total gross price for all components of a given tax rate.
totalGrossDeducted	number (decimal)	The total gross price for all components of a given tax rate, after applied deductions.
totalTaxDeducted	number (decimal)	The total tax amount for all components of a given tax rate, after applied deductions.

PriceTypeDto

Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not.

Enum Values

WithTotal
WithoutTotal

ExchangePhaseDto

This service specifications exchange phase, i.e. the current status in the project it is intended to be used (such as request for offer, offer, awarding...).

Enum Values

Undefined
Base
CostEstimate
OfferRequest
Offer
SideOffer
Grant

OriginDto

This indicates where the service specification originates, i.e. from an exchange file format or self created. If applicable, additional information is present in the OriginDetail property.

Enum Values

Self
Gaeb90
Gaeb2000
GaebXml
Oenorm
Reb
Sia

PriceInformationDto

This PriceInformation contains global data for the ServiceSpecification. When inside a Project, do not set this property manually.

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
hourlyWage	number (decimal)	The amount of currency per one hour of manual labour work in this project.
deductionFactor	number (decimal)	The final, total price will be deducted by this rate.
flatSum	number (decimal)	This is given when there is only one flat price for the whole service specification.
taxRate	number (decimal)	Global tax rate for the project. Note that certain elements may have a different, specific tax rate.
hasUnsetTaxRate	boolean	This property indicates if the TaxRate property is actually zero (0) or if it's just unset. The TaxRate is a non-nullable property, so it can't be null and therefore a distinction between unset and zero relies on this additional property. When exporting to GAEB, this can be used e.g. to decide whether or not the tax rate should be serialized. This property is automtically set to false when the TaxRate is set to any value, even zero. If the TaxRate is not set to zero, this property will always return false and can not be set to true.
tradeDiscounts	TradeDiscountDto[]	Trade discounts for offered in this ServiceSpecification.

TradeDiscountDto

Trade discounts for offered in this ServiceSpecification.

Name	Type	Notes
id	string (guid)	Elements GUID identifier.
deadline	integer (int32)	The amount of days for how long a declared trade discount applies. Must be a positive number, negative values will be ignored and not set.
rate	number (decimal)	The rate of the trade discount.

WarrantyDurationDto

This indicates how long the warranty period is for this ServiceSpecification

Name	Type	Notes
duration	integer (int32)	The scalar value of the duration. This value must be equal to or bigger than zero (>= 0). Negative values can not be set and will be ignored.
unit	DurationUnitDto	The unit of the duration

DurationUnitDto

The unit of the duration

Enum Values

Months
Years

AddendumStatusDto

This indicates, if this element is part of an addendum an, if yes, with what status.

Enum Values

Unknown
Recognized
Filed
Offered
Withdrawn
Rejected
RejectionObjected
FormallyAcknowledged
Approved

ServiceSpecificationCommercePropertiesDto

This property holds additional information that's only valid in commerce exchange phases.

Name	Type	Notes
fixedPriceDate	string (date-time)	The date until the price is valid or fixed.
deliveryVoucherDate	string (date-time)	The date of the delivery voucher note.
deliveryDate	string (date-time)	The actual date of delivery.
inquiryNumber	string	The number of the inquiry, usually in a context of offer requests.
offerNumber	string	The number of the offer, usually in a context of an offer.
orderNumber	string	The order number, usually in the context of a grant or contract.
orderConfirmationNumber	string	The order confirmation number
deliveryNumber	string	The number of the delivery, e.g. on the delivery note voucher.
customerReferenceNumber	string	The reference number of the customer / buyer.
supplierReferenceNumber	string	The reference number of the supplier / bidder.
shippingType	string	The type of shippment.
inquiryType	CommerceInquiryTypeDto	The type of the price inquiry.

CommerceInquiryTypeDto

The type of the price inquiry.

Enum Values

Unknown
Project
Immediate
Exhibition

ApiError

Data transfer class to convey api errors

Name	Type	Notes
errors	object	This dictionary contains a set of all errors and their messages

FlatAvaProject

This model contains a flattened represention of an AVA project, which makes it easy to use in systems that expect elements in a list form.

Name	Type	Notes
project	ProjectDto[]	The original project, including the service specification, but no elements.
elements	FlatElementDto[]	The flattened elements of the project.

FlatElementDto

The flattened elements of the project.

Name	Type	Notes
previousElementId	string (guid)	If this is not null, then this contains the id of the previous element in the hierarchy on the same level.
parentElementId	string (guid)	If this is not null, then this contains the id of the parent element.
element	IElementDto[]	The element itself.

LoginPost

Name	Type	Notes
identifier	string
password	string
staySignedIn	boolean

TokenLoginPost

Name	Type	Notes
identifier	string
password	string

TokenResponseGet

Name	Type	Notes
accessToken	string
error	string
errorDescription	string
expiresIn	integer (int64)
httpErrorReason	string
httpStatusCode	HttpStatusCode
identityToken	string
isError	boolean
refreshToken	string
tokenType	string
errorType	ResponseErrorType

HttpStatusCode

Enum Values

Continue
SwitchingProtocols
Processing
EarlyHints
OK
Created
Accepted
NonAuthoritativeInformation
NoContent
ResetContent
PartialContent
MultiStatus
AlreadyReported
IMUsed
MultipleChoices
MovedPermanently
Found
SeeOther
NotModified
UseProxy
Unused
RedirectKeepVerb
PermanentRedirect
BadRequest
Unauthorized
PaymentRequired
Forbidden
NotFound
MethodNotAllowed
NotAcceptable
ProxyAuthenticationRequired
RequestTimeout
Conflict
Gone
LengthRequired
PreconditionFailed
RequestEntityTooLarge
RequestUriTooLong
UnsupportedMediaType
RequestedRangeNotSatisfiable
ExpectationFailed
MisdirectedRequest
UnprocessableEntity
Locked
FailedDependency
UpgradeRequired
PreconditionRequired
TooManyRequests
RequestHeaderFieldsTooLarge
UnavailableForLegalReasons
InternalServerError
NotImplemented
BadGateway
ServiceUnavailable
GatewayTimeout
HttpVersionNotSupported
VariantAlsoNegotiates
InsufficientStorage
LoopDetected
NotExtended
NetworkAuthenticationRequired

ResponseErrorType

Enum Values

None
Protocol
Http
Exception
PolicyViolation

TokenRefreshPost

Name	Type	Notes
refreshToken	string

RegisterPost

Name	Type	Notes
username	string
email	string (email)
password	string
preferredLanguages	array
serviceLoginRedirectUri	string

ForgotPasswordPost

Name	Type	Notes
identifier	string
preferredLanguages	array
serviceLoginRedirectUri	string

UserInfoGet

Name	Type	Notes
userIsAuthenticated	boolean
clientIsAuthenticated	boolean
currentUserId	string (guid)
currentUserIdenticonId	string (guid)
currentUserName	string
currentUserEmail	string
currentClientId	string
userClaims	ClaimGet[]
clientClaims	ClaimGet[]

ClaimGet

Name	Type	Notes
issuer	string
type	string
value	string

GetStatus

Indicates the status of the AVACloud service

Name	Type	Notes
isHealthy	boolean	If any problems in the service health are known, this is set to false
version	string	The current version of the AVACloud service
environment	string	The environment of the current instance

ValidationResult

This class represents the result of a validation operation

Name	Type	Notes
isSchemaCompliant	boolean	Indicates if the validation produced no errors
checkResults	ValidationCheckResult[]	List of validation check results, which are usually errors
validationType	ValidationType	The type of the validation that was performed
fileName	string	Name of the validated file

ValidationCheckResult

List of validation check results, which are usually errors

Name	Type	Notes
severity	ValidationSeverity	The severity for this check. Usually, low severity checks do not impact data exchange with third party applications
checkType	ValidationCheckType	The actual check that is represented by this result. Additional information may be found in other properties of this class, depending on the check.
message	string	A human readable message describing the result of the check.
objectValidationCheckDetails	ObjectValidationCheckDetails[]	For CheckType of types ObjectValidation
xmlSchemaValidationCheckDetails	XmlSchemaValidationCheckDetails[]	For CheckType of types XmlSchemaCheck
projectValidationCheckDetails	ProjectValidationCheckDetails[]	For CheckType of types ProjectValidation

ValidationSeverity

The severity for this check. Usually, low severity checks do not impact data exchange with third party applications

Enum Values

Information
Warning
Error
Critical

ValidationCheckType

The actual check that is represented by this result. Additional information may be found in other properties of this class, depending on the check.

Enum Values

General
XmlSchemaCheck
ObjectValidation
ProjectValidation

ObjectValidationCheckDetails

For CheckType of types ObjectValidation

Name	Type	Notes
elementPath	string	The path under which the element with error was found.

XmlSchemaValidationCheckDetails

For CheckType of types XmlSchemaCheck

Name	Type	Notes
lineNumber	integer (int32)	The line number on which the validation happened
linePosition	integer (int32)	The position in the line
invoiceDataPointId	string	Official data point identifier for XRechnung values, e.g. BT-1 Should be null for other data types, e.g. GAEB or ÖNorm

ProjectValidationCheckDetails

For CheckType of types ProjectValidation

Name	Type	Notes
elementId	string (guid)	The id of the element

ValidationType

The type of the validation that was performed

Enum Values

Project
Gaeb
Oenorm
XRechnung

PostAvaProjectValidationSourceOptions

Options for validating an AVA project

Name	Type	Notes
avaProject	ProjectDto[]	The project that should be validated
serviceSpecificationIndex	integer (int32)	The index of the ServiceSpecification that should be validated. If not given, will default to the first one in the project.
validationType	ValidationType	This can optionally be specified to simulate a conversion to a specific target.
exchangePhase	ExchangePhaseDto	This can optionally be supplied to test for a specific exchange phase. For example, missing prices will only trigger errors in some specific exchange phases. Please note: If a conversion to a specific format, e.g. GAEB or ÖNorm, is given, this parameter is not applied to the internal conversion. The converter options must be set in the appropriate properties as well.
avaSourceOptions	PostAvaSourceOptions[]	Options for importing the AVA project
oenormDestinationOptions	PostOenormDestinationOptions[]	Options for conversion to Oenorm. Should be given if ValidationType is set to Oenorm.
gaebDestinationOptions	PostGaebDestinationOptions[]	Options for conversion to GAEB. Should be given if ValidationType is set to GAEB.

PostAvaSourceOptions

Options for importing the AVA project

Name	Type	Notes
tryAutoGenerateItemNumbersAndSchema	boolean	If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.

PostOenormDestinationOptions

Options for conversion to Oenorm. Should be given if ValidationType is set to Oenorm.

Name	Type	Notes
destinationOenormType	DestinationOenormType	Defaults to Lv2015
tryRepairProjectStructure	boolean	Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
skipTryEnforceSchemaCompliantXmlOutput	boolean	If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
removeUnprintableCharactersFromTexts	boolean	If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.

DestinationOenormType

Defaults to Lv2015

Enum Values

Lv2015
Lb2015
B2063
Lv2009
Lb2009
Lv2021
Lb2021
Re2009
Re2015
Re2021

PostGaebDestinationOptions

Options for conversion to GAEB. Should be given if ValidationType is set to GAEB.

Name	Type	Notes
destinationGaebType	DestinationGaebType	Defaults to GAEB XML V3.2
targetExchangePhaseTransform	DestinationGaebExchangePhase	Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86
enforceStrictOfferPhaseLongTextOutput	boolean	Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
exportQuantityDetermination	boolean	Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
removeUnprintableCharactersFromTexts	boolean	If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats. Defaults to true.
forceIncludeDescriptions	boolean	If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.
treatNullItemNumberSchemaAsInvalid	boolean	When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas. With this setting, you can also tell AVACloud to treat a null value as invalid. Otherwise, null schemas will simply be ignored and not lead to any schema being generated. It is recommended to enable this option, but it is disabled by default for compatibility reasons.

DestinationGaebType

Defaults to GAEB XML V3.2

Enum Values

Gaeb90
Gaeb2000
Gaeb2000Commerce
GaebXml_V3_1
GaebXml_V3_2
GaebXml_V3_2_Commerce
GaebXml_V3_3
GaebXml_V3_3_Commerce
GaebXml_V3_3_2019
GaebXml_V3_3_2019_Commerce

DestinationGaebExchangePhase

Defaults to none, meaning no transformation will be done. The phases are: Base = 81 CostEstimate = 82 OfferRequest = 83 Offer = 84 SideOffer = 85 Grant = 86

Enum Values

None
Base
OfferRequest
Offer
Grant
CostEstimate
SideOffer

Invoice

This class represents an invoice

Name	Type	Notes
invoiceNumber	string	BT-1 The number of the invoice
invoiceDate	string (date-time)	BT-2 The date of the invoice
invoiceType	InvoiceType	BT-3 The type of the invoice
currencyCode	string	BT-5 The three letter ISO currency code
paymentDueDate	string (date-time)	BT-9 Until when the payment is due
references	References[]	An object holding reference used in this invoice
paymentTerms	string	BT-20 A text description of payment terms, e.g. cash discounts or payment conditions
parsedPaymentTerms	PaymentTerm[]	If the PaymentTerms are present and in a correct format, this read-only property can be used to get the actual parsed payment terms in a deserialized and structured format. This will be null if PaymentTerms are not present or not in the correct format
previousInvoices	PreviousInvoice[]	BG-3 In case of partial or final invoices, it's possible to reference the previous invoice numbers
buyer	Organization[]	BG-7 Information about the buyer
seller	Organization[]	BG-4 Information about the seller
sellerTaxRepresentative	Organization[]	BG-11 Information about the sellers tax representative
payee	Payee[]	BG-10 A payee is someone who receives the payment that is different from the seller
invoiceNotes	InvoiceNote[]	BG-1 If present, this is an unstructured text that can be used to give additional information about the invoice. Field BG-1
invoicePeriod	InvoicePeriod[]	BG-14 The period during which the services or goods were delivered
deliveryInformation	DeliveryInformation[]	BG-13 Information about the delivery BG-13 in XRechnung
totals	InvoiceTotals[]	BG-22 Totals for the invoice
paymentInstructions	PaymentInstructions[]	Instructions how to perform the payment
documents	SupportingDocument[]	BG-24 Attached documents to the invoice
vatBreakdown	VatBreakdown[]	BG-23 This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories
allowances	InvoiceAllowance[]	BG-20 Allowances / deductions on the invoice
charges	InvoiceCharge[]	BG-21 Charges / additional costs on the invoice
lineItems	InvoiceLineItem[]	BG-25 Single line items in the invoice
sourceType	SourceType	The source type from which the invoice was created

InvoiceType

BT-3 The type of the invoice

Enum Values

PartialInvoice
CommercialInvoice
CreditNote
CorrectedInvoice
SelfBilledInvoice
PartialConstructionInvoice
PartialFinalConstructionInvoice
FinalConstructionInvoice

References

An object holding reference used in this invoice

Name	Type	Notes
buyerReference	string	BT-10 An internal reference used by the buyer, this can also be used as the 'Leitweg-ID' in Germany BT-10 in XRechnung.
projectReference	string	BT-11 Reference to a project BT-11 in XRechnung.
contractReference	string	BT-12 Reference to a contract BT-12 in XRechnung.
purchaseOrderReference	string	BT-13 Reference to a purchase order created by the buyer BT-13 in XRechnung.
salesOrderReference	string	BT-14 Reference to a sales order created by the seller BT-14 in XRechnung.
receivingAdviceReference	string	BT-15 Reference to a delivery note BT-15 in XRechnung.
dispatchAdviceReference	string	BT-16 Reference to a dispatch advice BT-16 in XRechnung.
tenderOrLotReference	string	BT-17 Reference to a tender or lot BT-17 in XRechnung.
invoicedObjectIdentifier	string	BT-18 Reference to a custom item, e.g. a phone number, person, contract or anything that would identify the invoice in the buyer's system BT-18 in XRechnung.
accountingReference	string	BT-19 This is a reference for accounting, like a cost center or similar. In German, this would be a "Kostenstelle". BT-19 in XRechnung.

PaymentTerm

If the PaymentTerms are present and in a correct format, this read-only property can be used to get the actual parsed payment terms in a deserialized and structured format. This will be null if PaymentTerms are not present or not in the correct format

Name	Type	Notes
days	integer (int32)	The number of days until the discount is valid.
percent	number (decimal)	The percentage of the discount.
baseAmount	number (decimal)	The base amount for the discount, if applicable.

PreviousInvoice

BG-3 In case of partial or final invoices, it's possible to reference the previous invoice numbers

Name	Type	Notes
invoiceDate	string (date-time)	BT-26 The date of the previous invoice
invoiceNumber	string	BT-25 The number of the previous invoice

Organization

BG-7 Information about the buyer

Name	Type	Notes
identifier	string	BT-46 (BT-29 for the Seller) The identifier of the organization
name	string	BT-44 (BT-27 for the seller, BT-62 for the seller tax representative) The name of the organization
registrationNumber	string	BT-30, for the seller, doesn't exist in the buyer actually A registration number, e.g. a Handelsregisternummer in Germany
vatId	string	BT-48, BT-32 for the seller, BT-63 for the seller tax representative The VAT ID for the organization
taxId	string	BT-32 for the seller, does not exist for the buyer The tax ID for the organization
email	string	BT-49 An email address for the organization
contactPersonName	string	BT-56 The name of a contact person
contactPersonPhone	string	BT-57 The phone of a contact person
contactPersonEmail	string	BT-58 The email of a contact person
address	string	BT-50, BT-35 for the seller, BT-64 for the seller tax representative BT-51, BT-36 for the seller, BT-65 for the seller tax representative BT-163, BT-162 for the seller, BT-164 for the seller tax representative The address of the organization
city	string	BT-52, BT-37 for the seller, BT-66 for the seller tax representative The city of the organization
zipCode	string	BT-53, BT-38 for the seller, BT-67 for the seller tax representative The zip code of the organization
countryCode	string	BT-55, BT-40 for the seller, BT-69 for the seller tax representative The ISO 3166-1 2 letter country code
state	string	BT-54, BT-39 for the seller, BT-68 for the seller tax representative The state of the organization, e.g. a federal state in Germany
additionalLegalInformation	string	BT-33 This provides some additional legal information. BT-33 in XRechnung, and this is only used for the seller.

Payee

BG-10 A payee is someone who receives the payment that is different from the seller

Name	Type	Notes
name	string	BT-59 The name of the payee
identifier	string	BT-60 The identifier of the payee
legalRegistrationIdentifier	string	BT-61 A registered identifier for the payee, e.g. a VAT ID or Tax ID

InvoiceNote

BG-1 If present, this is an unstructured text that can be used to give additional information about the invoice. Field BG-1

Name	Type	Notes
shortText	string	BT-21 Short summary / heading. Should be a text code from this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred4451.htm Field BT-21
shortTextType	ShortTextType	Short summary / heading type. This will be automatically parsed from ShortText and is a read-only property.
longText	string	BT-22 Explanation of this note Field BT-22

ShortTextType

Short summary / heading type. This will be automatically parsed from ShortText and is a read-only property.

Enum Values

GoodsItemDescription
PaymentTerm
DangerousGoodsAdditionalInformation
DangerousGoodsTechnicalName
AcknowledgementDescription
RateAdditionalInformation
PartyInstructions
GeneralInformation
AdditionalConditionsOfSalePurchase
PriceConditions
GoodsDimensionsInCharacters
EquipmentReUsageRestrictions
HandlingRestriction
ErrorDescriptionFreeText
ResponseFreeText
PackageContentsDescription
TermsOfDelivery
BillOfLadingRemarks
ModeOfSettlementInformation
ConsignmentInvoiceInformation
ClearanceInvoiceInformation
LetterOfCreditInformation
LicenseInformation
CertificationStatements
AdditionalExportInformation
TariffStatements
MedicalHistory
ConditionsOfSaleOrPurchase
ContractDocumentType
AdditionalTermsAndOrConditionsDocumentaryCredit
InstructionsOrInformationAboutStandbyDocumentary
InstructionsOrInformationAboutPartialShipments
InstructionsOrInformationAboutTranshipments
AdditionalHandlingInstructionsDocumentaryCredit
DomesticRoutingInformation
ChargeableCategoryOfEquipment
GovernmentInformation
OnwardRoutingInformation
AccountingInformation
DiscrepancyInformation
ConfirmationInstructions
MethodOfIssuance
DocumentsDeliveryInstructions
AdditionalConditions
InformationInstructionsAboutAdditionalAmountsCovered
DeferredPaymentTermedAdditional
AcceptanceTermsAdditional
NegotiationTermsAdditional
DocumentNameAndDocumentaryRequirements
InstructionsInformationAboutRevolvingDocumentaryCredit
DocumentaryRequirements
AdditionalInformation
FactorAssignmentClause
Reason
Dispute
AdditionalAttributeInformation
AbsenceDeclaration
AggregationStatement
CompilationStatement
DefinitionalException
PrivacyStatement
QualityStatement
StatisticalDescription
StatisticalDefinition
StatisticalName
StatisticalTitle
OffDimensionInformation
UnexpectedStopsInformation
Principles
TermsAndDefinition
SegmentName
SimpleDataElementName
Scope
MessageTypeName
Introduction
Glossary
FunctionalDefinition
Examples
CoverPage
DependencySyntaxNotes
CodeValueName
CodeListName
ClarificationOfUsage
CompositeDataElementName
FieldOfApplication
TypeOfAssetsAndLiabilities
PromotionInformation
MeterCondition
MeterReadingInformation
TypeOfTransactionReason
TypeOfSurveyQuestion
CarriersAgentCounterInformation
DescriptionOfWorkItemOnEquipment
MessageDefinition
BookedItemInformation
SourceOfDocument
Note
FixedPartOfSegmentClarificationText
CharacteristicsOfGoods
AdditionalDischargeInstructions
ContainerStrippingInstructions
CscContainerSafetyConventionPlateInformation
CargoRemarks
TemperatureControlInstructions
TextRefersToExpectedData
TextRefersToReceivedData
SectionClarificationText
InformationToTheBeneficiary
InformationToTheApplicant
InstructionsToTheBeneficiary
InstructionsToTheApplicant
ControlledAtmosphere
TakeOffAnnotation
PriceVariationNarrative
DocumentaryCreditAmendmentInstructions
StandardMethodNarrative
ProjectNarrative
RadioactiveGoodsAdditionalInformation
BankToBankInformation
ReimbursementInstructions
ReasonForAmendingAMessage
InstructionsToThePayingAndOrAcceptingAndOr
InterestInstructions
AgentCommission
RemittingBankInstructions
InstructionsToTheCollectingBank
CollectionAmountInstructions
InternalAuditingInformation
Constraint
Comment
SemanticNote
HelpText
Legend
BatchCodeStructure
ProductApplication
CustomerComplaint
ProbableCauseOfFault
DefectDescription
RepairDescription
ReviewComments
Title
DescriptionOfAmount
Responsibilities
Supplier
PurchaseRegion
Affiliation
Borrower
LineOfBusiness
FinancialInstitution
BusinessFounder
BusinessHistory
BankingArrangements
BusinessOrigin
BrandNamesDescription
BusinessFinancingDetails
Competition
ConstructionProcessDetails
ConstructionSpecialty
ContractInformation
CorporateFiling
CustomerInformation
CopyrightNotice
ContingentDebt
ConvictionDetails
Equipment
WorkforceDescription
Exemption
FuturePlans
IntervieweeConversationInformation
IntangibleAsset
Inventory
Investment
IntercompanyRelationsInformation
JointVenture
Loan
LongTermDebt
Location
CurrentLegalStructure
MaritalContract
MarketingActivities
Merger
MarketableSecurities
BusinessDebt
OriginalLegalStructure
EmployeeSharingArrangements
OrganizationDetails
PublicRecordDetails
PriceRange
Qualifications
RegisteredActivity
CriminalSentence
SalesMethod
EducationalInstitutionInformation
StatusDetails
Sales
SpouseInformation
EducationalDegreeInformation
ShareholdingInformation
SalesTerritory
AccountantsComments
ExemptionLawLocation
ShareClassifications
Forecast
EventLocation
FacilityOccupancy
ImportAndExportDetails
AdditionalFacilityInformation
InventoryValue
Education
Event
Agent
DomesticallyAgreedFinancialStatementDetails
OtherCurrentAssetDescription
OtherCurrentLiabilityDescription
FormerBusinessActivity
TradeNameUse
SigningAuthority
Guarantee
HoldingCompanyOperation
ConsignmentRouting
LetterOfProtest
Question
PartyInformation
AreaBoundariesDescription
AdvertisementInformation
FinancialStatementDetails
AccessInstructions
Liquidity
CreditLine
WarrantyTerms
DivisionDescription
ReportingInstruction
ExaminationResult
LaboratoryResult
AllowanceChargeInformation
XRayResult
PathologyResult
InterventionDescription
SummaryOfAdmittance
MedicalTreatmentCourseDetail
Prognosis
InstructionToPatient
InstructionToPhysician
AllDocuments
MedicineTreatment
MedicineDosageAndAdministration
AvailabilityOfPatient
ReasonForServiceRequest
PurposeOfService
ArrivalConditions
ServiceRequestersComment
Authentication
RequestedLocationDescription
MedicineAdministrationCondition
PatientInformation
PrecautionaryMeasure
ServiceCharacteristic
PlannedEventComment
ExpectedDelayComment
TransportRequirementsComment
TemporaryApprovalCondition
CustomsValuationInformation
ValueAddedTaxVatMarginScheme
PassengerBaggageInformation
AdditionalProductInformationAddress
InformationToBePrintedOnDespatchAdvice
MissingGoodsRemarks
NonAcceptanceInformation
ReturnsInformation
SubLineItemInformation
TestInformation
ExternalLink
VatExemptionReason
TransportContractDocumentClause
InstructionToPrepareThePatient
MedicineTreatmentComment
ExaminationResultComment
ServiceRequestComment
PrescriptionReason
PrescriptionComment
ClinicalInvestigationComment
MedicinalSpecificationComment
EconomicContributionComment
StatusOfAPlan
RandomSampleTestInformation
PeriodOfTime
Legislation
SecurityMeasuresRequested
TransportContractDocumentRemark
PreviousPortOfCallSecurityInformation
SecurityInformation
WasteInformation
B2cMarketingInformationShortDescription
B2bMarketingInformationLongDescription
B2cMarketingInformationLongDescription
ProductIngredients
LocationShortName
PackagingMaterialInformation
FillerMaterialInformation
ShipToShipActivityInformation
PackageMaterialDescription
ConsumerLevelPackageMarking
CustomsClearanceInstructions
CustomsClearanceInstructionsExport
ChangeInformation
CustomsClearanceInstructionImport
ClearancePlaceRequested
LoadingRemarks
OrderInformation
CustomerRemarks
CustomsDeclarationInformation
DamageRemarks
DocumentIssuerDeclaration
DeliveryInformation
DeliveryInstructions
DocumentationInstructions
DutyDeclaration
EffectiveUsedRouting
FirstBlockToBePrintedOnTheTransportContract
GovernmentBillOfLadingInformation
EntireTransactionSet
FurtherInformationConcerningGGVSPar7
ConsignmentHandlingInstruction
HazardInformation
ConsignmentInformationForConsignee
InsuranceInstructions
InvoiceMailingInstructions
CommercialInvoiceItemDescription
InsuranceInformation
InvoiceInstruction
InformationForRailwayPurpose
InlandTransportDetails
TestingInstructions
LocationAlias
LineItem
LoadingInstruction
MiscellaneousChargeOrder
MaritimeDeclarationOfHealth
AdditionalMarksNumbersInformation
OrderInstruction
OtherServiceInformation
PackingMarkingInformation
PaymentInstructionsInformation
PayablesInformation
PackagingInformation
PackagingTermsInformation
PaymentDetailRemittanceInformation
PaymentInformation
ProductInformation
PriceCalculationFormula
PriorityInformation
PurchasingInformation
QuarantineInstructions
QualityDemandsRequirements
QuotationInstructionInformation
RiskAndHandlingInformation
RegulatoryInformation
ReturnToOriginInformation
Receivables
ConsignmentRoute
SafetyInformation
ConsignmentDocumentaryInstruction
SpecialInstructions
ShipLineRequested
SpecialPermissionForTransportGenerally
SpecialPermissionConcerningTheGoodsToBeTransported
SpecialHandling
SpecialPermissionConcerningPackage
SpecialPermissionConcerningTransportMeans
SubsidiaryRiskNumberIataDgr
SpecialServiceRequest
SupplierRemarks
ConsignmentTariff
ConsignmentTransport
TransportationInformation
RequestedTariff
TaxDeclaration
WarehouseInstructionInformation
MutuallyDefined

InvoicePeriod

BG-14 The period during which the services or goods were delivered

Name	Type	Notes
start	string (date-time)	BT-134 The start date
end	string (date-time)	BT-135 The end date

DeliveryInformation

BG-13 Information about the delivery BG-13 in XRechnung

Name	Type	Notes
deliverToName	string	BT-70 BT-70 in XRechnung
deliverToLocationIdentifier	string	BT-71 BT-71 in XRechnung
deliveryDate	string (date-time)	BT-72 BT-72 in XRechnung
deliveryAddress	DeliveryAddress[]	BG-15 BG-15 in XRechnung

DeliveryAddress

BG-15 BG-15 in XRechnung

Name	Type	Notes
address	string	BT-75, BT-76 and BT-165 The address. BT-75, BT-76 and BT-165 in XRechnung.
city	string	BT-77 The city. BT-77 in XRechnung.
zipCode	string	BT-78 The zip code. BT-78 in XRechnung.
countryCode	string	BT-80 The ISO 3166-1 2 letter country code. BT-80 in XRechnung.

InvoiceTotals

BG-22 Totals for the invoice

Name	Type	Notes
totalNet	number (decimal)	BT-106 Sum of all invoice items in net. BT-106 in XRechnung.
totalAllowances	number (decimal)	BT-107 This is the sum of all allowances (e.g. deductions or withheld tax) in the invoice BT-107 in XRechnung.
totalCharges	number (decimal)	BT-108 This is the sum of all charges in the invoice, except VAT. For example, late fees or surcharges. BT-108 in XRechnung.
totalAfterDeductions	number (decimal)	BT-109 This is the total net value of the invoice after applied allowances and charges, meaning the actual net sum to be paid. BT-109 in XRechnung.
totalVatAmount	number (decimal)	BT-110 The total amount of VAT in the invoice. BT-110 in XRechnung.
totalGross	number (decimal)	BT-112 The total gross amount of the invoice, including all taxes and deductions. BT-112 in XRechnung.
alreadyPaidTotal	number (decimal)	BT-113 The total amount that has already been paid for this invoice, e.g. used when previous invoice sums are included here that have already been paid. BT-113 in XRechnung.
payableRoundingAmount	number (decimal)	BT-114 If this is given, this specifies if any rounding amount is applied to the invoice, before calculating the TotalToBePaid value. BT-114 in XRechnung.
totalToBePaid	number (decimal)	BT-115 The sum that needs to be paid for this invoice. This is the total gross amount minus the already paid amount. BT-115 in XRechnung.

PaymentInstructions

Instructions how to perform the payment

Name	Type	Notes
description	string	BT-82 Additional text to describe the payment instructions.
paymentTypeCode	string	BT-81 This should be a code according to UNCL 4461 to identify the type of payment. For example, code "58" means SEPA Credit Transfer, and code "30" means non-SEPA Credit Transfer. See this list: https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/
paymentType	PaymentType	This should be a type according to UNCL 4461 to identify the type of payment.
paymentCreditorIdentifier	string	BT-90 If a SEPA direct debit payment mean is used, then this reference should be provided. It's the creditor identifier in SEPA, in German "Gläubiger-Identifikationsnummer". Field BT-90 in XRechnung.
paymentMeans	PaymentMeans[]	BG-16 A list of payment means that can be used to pay the invoice.

PaymentType

This should be a type according to UNCL 4461 to identify the type of payment.

Enum Values

MutuallyDefined
InstrumentNotDefined
AutomatedClearingHouseCredit
AutomatedClearingHouseDebit
ACHDemandDebitReversal
ACHDemandCreditReversal
ACHDemandCredit
ACHDemandDebit
Hold
NationalOrRegionalClearing
InCash
ACHSavingsCreditReversal
ACHSavingsDebitReversal
ACHSavingsCredit
ACHSavingsDebit
BookentryCredit
BookentryDebit
ACHDemandCashConcentrationDisbursementCCDCredit
ACHDemandCashConcentrationDisbursementCCDDebit
ACHDemandCorporateTradePaymentCTPCredit
Cheque
BankerSDraft
CertifiedBankerSDraft
BankChequeIssuedByABankingOrSimilarEstablishment
BillOfExchangeAwaitingAcceptance
CertifiedCheque
LocalCheque
ACHDemandCorporateTradePaymentCTPDebit
ACHDemandCorporateTradeExchangeCTXCredit
ACHDemandCorporateTradeExchangeCTXDebit
CreditTransfer
DebitTransfer
ACHDemandCashConcentrationDisbursementPlusCCDCredit
ACHDemandCashConcentrationDisbursementPlusCCDDebit
ACHPrearrangedPaymentAndDepositPPD
ACHSavingsCashConcentrationDisbursementCCDCredit
ACHSavingsCashConcentrationDisbursementCCDDebit
ACHSavingsCorporateTradePaymentCTPCredit
ACHSavingsCorporateTradePaymentCTPDebit
ACHSavingsCorporateTradeExchangeCTXCredit
ACHSavingsCorporateTradeExchangeCTXDebit
ACHSavingsCashConcentrationDisbursementPlusCCDCredit
PaymentToBankAccount
ACHSavingsCashConcentrationDisbursementPlusCCDDebit
AcceptedBillOfExchange
ReferencedHomeBankingCreditTransfer
InterbankDebitTransfer
HomeBankingDebitTransfer
BankCard
DirectDebit
PaymentByPostgiro
FRNorme697TelereglementCFONBFrenchOrganisationFor
UrgentCommercialPayment
UrgentTreasuryPayment
CreditCard
DebitCard
Bankgiro
StandingAgreement
SEPACreditTransfer
SEPADirectDebit
PromissoryNote
PromissoryNoteSignedByTheDebtor
PromissoryNoteSignedByTheDebtorAndEndorsedByABank
PromissoryNoteSignedByTheDebtorAndEndorsedByAThirdParty
PromissoryNoteSignedByABank
PromissoryNoteSignedByABankAndEndorsedByAnotherBank
PromissoryNoteSignedByAThirdParty
PromissoryNoteSignedByAThirdPartyAndEndorsedByABank
OnlinePaymentService
BillDrawnByTheCreditorOnTheDebtor
BillDrawnByTheCreditorOnABank
BillDrawnByTheCreditorEndorsedByAnotherBank
BillDrawnByTheCreditorOnABankAndEndorsedByAThirdParty
BillDrawnByTheCreditorOnAThirdParty
BillDrawnByCreditorOnThirdPartyAcceptedAndEndorsedByBank
NotTransferableBankerSDraft
NotTransferableLocalCheque
ReferenceGiro
UrgentGiro
FreeFormatGiro
RequestedMethodForPaymentWasNotUsed
ClearingBetweenPartners
JPElectronicallyRecordedMonetaryClaims

PaymentMeans

BG-16 A list of payment means that can be used to pay the invoice.

Name	Type	Notes
accountIdentifier	string	BT-84 This is typically the IBAN or account number BT-84 in XRechnung.
accountName	string	BT-85 The name for the account, typically the name of the owner for a bank account. BT-85 in XRechnung.
serviceProviderIdentifier	string	BT-86 This can be the BIC BT-86 in XRechnung. This will be saved in BG-17.
directDebitMandateId	string	BT-89 If used, this is the mandate id for direct debit under which the direct debit will be performed BT-89 in XRechnung. This will be saved in BG-19.
directDebitIban	string	BT-91 If used, this is the IBAN for direct debit BT-91 in XRechnung.
paymentId	string	BT-83 The payment id, e.g. a reference number for the payment. In German, this would be called "Verwendungszweck". BT-83 in XRechnung.
paymentCardHolderName	string	BT-88 If this is a card payment, then this is the name of the cardholder. BT-88 in XRechnung.
paymentCardPrimaryAccountNumber	string	BT-87 If this is a card payment, then this is the type of card. BT-87 in XRechnung. This will be saved in BG-18.
paymentCardNetworkId	string	If this is a card payment, then this is the type of card. This has no mapping yet in XRechnung, see: https://github.com/itplr-kosit/validator-configuration-xrechnung/issues/53

SupportingDocument

BG-24 Attached documents to the invoice

Name	Type	Notes
documentReference	string	BT-122 This is typically an id or a name
description	string	BT-123 A description of the document
externalDocumentUrl	string	BT-124 A link to the document in case this is an external reference
documentBase64	string	BT-125 The document in base64 encoded form as binary data. This is ignored if you set PlaceholderId.
fileName	string	BT-125 This should be present if DocumentBase64 is set.
documentMimeType	AttachmentMimeType	BT-125 The type of the document
placeholderId	string (guid)	This is placeholder id to use instead of DocumentBase64 property for lazy-loading of documents. The use case of this is to avoid having the documents be processed in memory when they might be handled by the calling code. For example, in the AVACloud webservice, this placeholder can be used to avoid having to send the Base64 encoded document to the server and then downloading it again in the result. If this is given, the generated XML file will not be valid, since it will include the literal Guid value as a placeholder. You can use the 'xmlExportCallback' parameter in the XRechnungWriter to replace the placeholder with the actual Base64 contents of the file in this library, or just use a string replace method if you're working with the XML in a different context.

AttachmentMimeType

BT-125 The type of the document

Enum Values

Unknown
Pdf
Png
Jpeg
Csv
Excel
OpenOfficeSpreadsheet

VatBreakdown

BG-23 This is used to list VAT by category, e.g. for invoices where parts are in different VAT categories

Name	Type	Notes
netTaxableAmount	number (decimal)	BT-116 The total net amount of this VAT category
vatAmount	number (decimal)	BT-117 The total VAT
vatCategory	VatCategory	BT-118 The category of the VAT
taxRate	number (decimal)	BT-119 The actual tax rate as a decimal value, e.g. 19% would be 0.19
vatExemptionReasonText	string	BT-120 If the VAT is exempt, there should be a description here. For example, in reverse charge scenarios, this text should contain a reference to "Reverse charge according to ...".
vatExemptionReasonCode	string	BT-121 A code from the VAT exemption reason code list(VATEX)“

VatCategory

BT-118 The category of the VAT

Enum Values

Unknown
StandardRate
ZeroRatedGoods
ExemptFromTax
VatReverseCharge
VatExemptReverseCharge
FreeExportItem
ServicesOutsideScopeOfTaxation
CanaryIslandsGeneralIndirectTax
TaxInCeutaAndMelilla

InvoiceAllowance

BG-20 Allowances / deductions on the invoice

Name	Type	Notes
netAmount	number (decimal)	BT-92 The net amount of the allowance
relativeAllowanceBaseAmount	number (decimal)	BT-93 If this is a relative / percentage allowance, this should be set and give the base amount that is being used for the calculation
relativeAllowancePercentage	number (decimal)	BT-94 If this is a relative / percentage allowance, this should be set and be given in decimal representation, meaning 19% would be 0.19
vatCategory	VatCategory	BT-95 The VAT category for the allowance
vatRate	number (decimal)	BT-96 The actual tax rate as a decimal value, meaning 19% would be 0.19
reason	string	BT-97 A description of the allowance. This should not be set it ReasonCode is provided, otherwise this one takes precedence.
reasonCode	string	BT-98 A reason code for the allowance according to UNTDID 5189. See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm
reasonType	AllowanceReasonType	A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode and is a read-only property.

AllowanceReasonType

A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode and is a read-only property.

Enum Values

HandlingCommission
AmendmentCommission
AcceptanceCommission
CommissionForObtainingAcceptance
CommissionOnDelivery
AdvisingCommission
ConfirmationCommission
DeferredPaymentCommission
CommissionForTakingUpDocuments
OpeningCommission
FeeForPaymentUnderReserve
DiscrepancyFee
DomicilationCommission
CommissionForReleaseOfGoods
CollectionCommission
NegotiationCommission
ReturnCommission
BLSplittingCharges
TrustCommission
TransferCommission
CommissionForOpeningIrrevocableDocumentaryCredits
PreAdviceCommission
SupervisoryCommission
ModelCharges
RiskCommission
GuaranteeCommission
ReimbursementCommission
StampDuty
Brokerage
BankCharges
BankChargesInformation
CourierFee
PhoneFee
PostageFee
SWIFTFee
TelexFee
PenaltyForLateDeliveryOfDocuments
PenaltyForLateDeliveryOfValuationOfWorks
PenaltyForExecutionOfWorksBehindSchedule
OtherPenalties
BonusForWorksAheadOfSchedule
OtherBonus
ProjectManagementCost
ProRataRetention
ContractualRetention
OtherRetentions
InterestOnArrears
Interest
ChargePerCreditCover
ChargePerUnusedCreditCover
MinimumCommission
FactoringCommission
ChamberOfCommerceCharge
TransferCharges
RepatriationCharges
MiscellaneousCharges
ForeignExchangeCharges
AgreedDebitInterestCharge
ManufacturersConsumerDiscount
FaxAdviceCharge
DueToMilitaryStatus
DueToWorkAccident
SpecialAgreement
ProductionErrorDiscount
NewOutletDiscount
SampleDiscount
EndOfRangeDiscount
ChargeForACustomerSpecificFinish
IncotermDiscount
PointOfSalesThresholdAllowance
TechnicalModificationCosts
JobOrderProductionCosts
OffPremisesCosts
AdditionalProcessingCosts
AttestingCharge
RushDeliverySurcharge
SpecialConstructionCosts
FreightCharges
PackingCharge
RepairCharge
LoadingCharge
SetupCharge
TestingCharge
WarehousingCharge
GoldSurcharge
CopperSurcharge
MaterialSurchargeDeduction
LeadSurcharge
PriceIndexSurcharge
PlatinumSurcharge
SilverSurcharge
WolframSurcharge
AluminumSurcharge
Discount
Insurance
MinimumOrderMinimumBillingCharge
MaterialSurchargeSpecialMaterials
Surcharge
SpecialRebate
CarbonFootprintCharge
FixedLongTerm
Temporary
Standard
YearlyTurnover

InvoiceCharge

BG-21 Charges / additional costs on the invoice

Name	Type	Notes
netAmount	number (decimal)	BT-99 The net amount of the charge
relativeChargeBaseAmount	number (decimal)	BT-100 If this is a relative / percentage charge, this should be set and give the base amount that is being used for the calculation
relativeChargePercentage	number (decimal)	BT-101 If this is a relative / percentage charge, this should be set and be given in decimal representation, meaning 19% would be 0.19
vatCategory	VatCategory	BT-102 The VAT category for the charge
vatRate	number (decimal)	BT-103 The actual tax rate as a decimal value, meaning 19% would be 0.19
reason	string	BT-104 A description of the charge. This should not be set it ReasonCode is provided, otherwise this one takes precedence.
reasonCode	string	BT-105 A reason code for the charge according to UNTDID 7161. See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm
reasonType	ChargeReasonType	A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode and is a read-only property.

ChargeReasonType

A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode and is a read-only property.

Enum Values

Advertising
Telecommunication
TechnicalModification
JobOrderProduction
Outlays
OffPremises
AdditionalProcessing
Attesting
Acceptance
RushDelivery
SpecialConstruction
AirportFacilities
Concession
CompulsoryStorage
FuelRemoval
IntoPlane
Overtime
Tooling
Miscellaneous
AdditionalPackaging
Dunnage
Containerisation
CartonPacking
HessianWrapped
PolyethyleneWrapPacking
MiscellaneousTreatment
EnamellingTreatment
HeatTreatment
PlatingTreatment
Painting
Polishing
Priming
PreservationTreatment
Fitting
Consolidation
BillOfLading
Airbag
Transfer
Slipsheet
Binding
RepairOrReplacementOfBrokenReturnablePackage
EfficientLogistics
Merchandising
ProductMix
OtherServices
PickUp
ChronicIllness
NewProductIntroduction
DirectDelivery
Diversion
Disconnect
Distribution
HandlingOfHazardousCargo
RentsAndLeases
LocationDifferential
AircraftRefueling
FuelShippedIntoStorage
CashOnDelivery
SmallOrderProcessingService
ClericalOrAdministrativeServices
Guarantee
CollectionAndRecycling
CopyrightFeeCollection
VeterinaryInspectionService
PensionerService
MedicineFreePassHolder
EnvironmentalProtectionService
EnvironmentalCleanUpService
NationalChequeProcessingServiceOutsideAccountArea
NationalPaymentServiceOutsideAccountArea
NationalPaymentServiceWithinAccountArea
Adjustments
Authentication
Cataloguing
Cartage
Certification
CertificateOfConformance
CertificateOfOrigin
Cutting
ConsularService
CustomerCollection
PayrollPaymentService
CashTransportation
HomeBankingService
BilateralAgreementService
InsuranceBrokerageService
ChequeGeneration
PreferentialMerchandisingLocation
Crane
SpecialColourService
Sorting
BatteryCollectionAndRecycling
ProductTakeBackFee
CarLoading
Cleaning
CigaretteStamping
CountAndRecount
LayoutDesign
DriverAssignedUnloading
Delivery
Engraving
Expediting
ExchangeRateGuarantee
Fabrication
FreightEqualization
FreightExtraordinaryHandling
FreightService
FillingHandling
Financing
Grinding
Hose
Handling
HoistingAndHauling
Installation
InstallationAndWarranty
InsideDelivery
Inspection
InstallationAndTraining
Invoicing
Koshering
CarrierCount
Labelling
Labour
RepairAndReturn
Legalisation
Mounting
MailInvoice
MailInvoiceToEachLocation
NonReturnableContainers
OutsideCableConnectors
InvoiceWithShipment
PhosphatizingSteelTreatment
Packing
Palletizing
Repacking
Repair
ReturnableContainer
Restocking
ReDelivery
Refurbishing
RailWagonHire
Loading
Salvaging
ShippingAndHandling
SpecialPackaging
Stamping
ConsigneeUnload
ShrinkWrap
SpecialHandling
SpecialFinish
SetUp
TankRenting
Testing
TransportationThirdPartyBilling
TransportationByVendor
DropYard
DropDock
Warehousing
CombineAllSameDayShipment
SplitPickUp
MutuallyDefined

InvoiceLineItem

BG-25 Single line items in the invoice

Name	Type	Notes
identifier	string	BT-126 An unique identifier for the line item
note	string	BT-127 An unstructured note to classify line items
objectIdentifier	string	BT-128 A seller-defined object identifier for this line item, meaning an identifier for the actual line. This could be a numbering sequence or a reference to a product.
quantity	number (decimal)	BT-129 The actual invoiced quantity of the line item
unitCode	string	BT-130 A code for the unit of the quantity. This should be a code as defined in UN/ECE Recommendation No. 20 „Codes for Units of Measure Used in International Trade“ und UN/ECE Recommendation No 21 „Codes for Passengers, Types of Cargo, Packages and Packaging Materials(with Complementary Codes for Package Names). See here: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931
netAmount	number (decimal)	BT-131 The net amount for this line item. This is the total price for positions
purchaseOrderReference	string	BT-132 A reference to an item in the buyers purachase order
lineItemPeriod	InvoicePeriod[]	BG-26 Information about the invoice period for this line item.
allowances	LineItemAllowance[]	BG-27 Allowances specific to this line item
charges	LineItemCharge[]	BG-28 charges specific to this line item
priceDetails	LineItemPriceDetail[]	BG-29 Price details for this line item.
vatInformation	LineItemVatInformation[]	BG-30 VAT information for this line item
itemInformation	LineItemInformation[]	BG-31 Information about this line item
subItems	array	BG-DEX-01 Line items can be nested, in which case this property holds the sub items

LineItemAllowance

BG-27 Allowances specific to this line item

Name	Type	Notes
netAmount	number (decimal)	BT-136 The net amount of the allowance
relativeAllowanceBaseAmount	number (decimal)	BT-137 If this is a relative / percentage allowance, this should be set and give the base amount that is being used for the calculation
relativeAllowancePercentage	number (decimal)	BT-138 If this is a relative / percentage allowance, this should be set and be given in decimal representation, meaning 19% would be 0.19
reason	string	BT-139 A description of the allowance.
reasonCode	string	BT-140 A reason code for the allowance according to UNTDID 5189. Should be a code from this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred5189.htm
reasonType	AllowanceReasonType	A reason type for the allowance according to UNTDID 5189. This will be automatically parsed from ReasonCode and is a read-only property.

LineItemCharge

BG-28 charges specific to this line item

Name	Type	Notes
netAmount	number (decimal)	BT-141 The net amount of the charge
relativeChargeBaseAmount	number (decimal)	BT-142 If this is a relative / percentage charge, this should be set and give the base amount that is being used for the calculation
relativeChargePercentage	number (decimal)	BT-143 If this is a relative / percentage charge, this should be set and be given in decimal representation, meaning 19% would be 0.19
reason	string	BT-144 A description of the charge.
reasonCode	string	BT-145 A reason code for the charge according to UNTDID 7161. See this list: https://unece.org/fileadmin/DAM/trade/untdid/d16b/tred/tred7161.htm
reasonType	ChargeReasonType	A reason type for the charge according to UNTDID 7161. This will be automatically parsed from ReasonCode and is a read-only property.

LineItemPriceDetail

BG-29 Price details for this line item.

Name	Type	Notes
netPrice	number (decimal)	BT-146 The net price of this line item. This is the unit price
absoluteDiscountPerItem	number (decimal)	BT-147 A discount for this line item, given as an absolute value. It is essentially the difference between NetPrice (or the list price) and the actual invoiced price GrossPrice.
grossPrice	number (decimal)	BT-148 The gross price of this line item, meaning the price without taxes that will be invoiced
baseQuantity	number (decimal)	BT-149 The quantity for which this price is valid. In combination with the NetPrice, you basically specify the denominator of the unit price for a line item.
baseQuantityUnitCode	string	BT-150 A code representing the unit for the base quantity

LineItemVatInformation

BG-30 VAT information for this line item

Name	Type	Notes
vatCategory	VatCategory	BT-151 The VAT category for the charge
vatRate	number (decimal)	BT-152 The actual tax rate as a decimal value, meaning 19% would be 0.19

LineItemInformation

BG-31 Information about this line item

Name	Type	Notes
name	string	BT-153 A name for the line item
description	string	BT-154 A description for the line item
sellerIdentifier	string	BT-155 An identifier assigned by the seller, e.g. an internal article number
buyerIdentifier	string	BT-156 An identifier assigned by the buyer, e.g. an internal article number
standardIdentifier	string	BT-157 A standard identifier for the line item, e.g. an EAN or a GTIN
standardSchemeId	string	BT-157 If used together with StandardIdentifier, this is the scheme identifier for which standard is used.
classificationIdentifiers	array	BT-158 A list of classification identifiers for the line item. You can further use ClassificationTypes to specify the scheme identifier for each classification identifier.
classificationTypes	array	BT-158 This is used in connection with ClassificationIdentifiers. It is the scheme identifier for each identifier. If this list is used, it should have the same length as ClassificationIdentifiers, with null or empty values used for non-existing scheme identifiers.
countryOfOrigin	string	BT-159 The origin country code according to ISO 3166-1 in 2 letter format
attributes	LineItemAttribute[]	BG-32 Optional additional attributes for this line item

LineItemAttribute

BG-32 Optional additional attributes for this line item

Name	Type	Notes
name	string	BT-160 The key / name of the attribute
value	string	BT-161 The value of the attribute

SourceType

The source type from which the invoice was created

Enum Values

Self
Ubl
Cii
FacturX

AvaProjectWrapper

This is a wrapper class that maps Dangl.AVA projects along with additional required information to create invoices

Name	Type	Notes
project	ProjectDto[]	The Dangl.AVA.Project from which to convert
invoiceNumber	string	The number of the invoice
documents	SupportingDocument[]	Attached documents to the invoice
invoicePeriod	InvoicePeriod[]	The period during which the services or goods were delivered
paymentInstructions	PaymentInstructions[]	Instructions how to perform the payment
invoiceType	InvoiceType	The type of the invoice
isEuReverseChargeInvoice	boolean	If this is set to true, the invoice will be marked as a reverse charge invoice in all VAT rates. You still need to ensure that the actual tax rates are set to zero in all elements
paymentDueDate	string (date-time)	Until when the payment is due
paymentTerms	string	A text description of payment terms, e.g. cash discounts or payment conditions
previousInvoices	PreviousInvoice[]	In case of partial of final invoices, it's possible to reference the previous invoice numbers
alreadyPaidTotalGross	number (decimal)	If parts of this invoice (or of previous invoices) have already been paid, then this property can be used to specify that some parts of the invoice are already paid and this will be deducted from the to be paid amount.
references	References[]	An object holding reference used in this invoice
allowances	InvoiceAllowance[]	Optional document level allowances. For example, those can be used to supply global discounts e.g. for security deposits. When using this property, please pay attention that a deduction factor on the exported ServiceSpecification will also be exported as an allowance, in this case the total price of the invoice might be different from the total price of the ServiceSpecification.
charges	InvoiceCharge[]	Optional document level charges, e.g. for shipping or handling. When using this property, please pay attention that the charges given here will be applied to the already calculated total price of the ServiceSpecification, in this case the total price of the invoice might be different from the total price of the ServiceSpecification.
deliveryInformation	DeliveryInformation[]	Information about the delivery BG-13 in XRechnung
sellerTaxRepresentative	Organization[]	Information about the sellers tax representative. BG-11 in XRechnung