Skip to content

Latest commit

 

History

History
59 lines (55 loc) · 9.61 KB

ServiceSpecificationDto.md

File metadata and controls

59 lines (55 loc) · 9.61 KB

ServiceSpecificationDto

Properties

Name Type Description Notes
id string Elements GUID identifier.
project_hourly_wage float The hourly wage that is used within this ElementContainerBase. Will be propagated to child elements.
project_tax_rate float The tax rate that is used within this ElementContainerBase. Will be propagated to child elements.
project_price_components string[] The price components that are used within this project. They are ignored during Json deserialization because they will be set from the parent project. [optional]
project_item_number_schema \Dangl\AVACloud\Model\ItemNumberSchemaDto The ItemNumberSchema that is used within this project. [optional]
elements \Dangl\AVACloud\Model\IElementDto[] The IElements within this ElementContainerBase. [optional]
project_labour_time_label string The label used in the parent Project to mark labour time, e.g. "Hours" or "Stunden". [optional]
contains_duplicate_item_numbers bool 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.
contains_duplicate_element_ids bool 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.
ignore_duplicate_item_numbers bool Indicate if duplicated ItemNumbers within child elements are to be ignored. Will not perform checks for duplicates if yes.
ignore_duplicate_element_ids bool Indicate if duplicated Ids within child elements are to be ignored. Will not perform checks for duplicates if yes.
total_price_gross_by_tax_rate \Dangl\AVACloud\Model\GrossPriceComponentDto[] Price composition by tax rate. [optional]
ignore_child_price_updates bool 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.
deducted_price float Net price after applied deductions.
deduction_factor float Factor of applied deductions to the total price. For example, "0.03" means that a 3% deduction is to be applied.
absolute_deduction float 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. [optional]
total_price float Will return this ElementContainerBase's total price.
total_price_gross float The total gross price for this ElementContainerBase including all child elements.
total_price_gross_deducted float Total gross price after applied deductions.
price_type \Dangl\AVACloud\Model\PriceTypeDto Indicates the PriceType of this ElementContainerBase, whether it should factor into total costs or not.
bidder \Dangl\AVACloud\Model\PartyInformationDto Information about the bidder. [optional]
bidder_discriminator 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. [optional]
gaeb_xml_id 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. [optional]
project_information \Dangl\AVACloud\Model\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. [optional]
exchange_phase \Dangl\AVACloud\Model\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 \Dangl\AVACloud\Model\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.
origin_detail 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. [optional]
creation_date \DateTime Creation date of this ServiceSpecification. [optional]
offer_by_date \DateTime Date indicating until when an offer has to be submitted. In German, this is often called the "Eröffnungstermin" [optional]
decision_date \DateTime Date indicating by when the buyer will select a contractor. [optional]
bid_date \DateTime Date of when the offer / bid was created [optional]
warranty_bond_percentage float 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.
execution_guarantee_percentage float 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.
submission_location string String indicating where the physical submission of the offer is taking place. [optional]
description string Description of this ServiceSpecification. [optional]
name string The name of this ServiceSpecification. [optional]
price_information \Dangl\AVACloud\Model\PriceInformationDto This PriceInformation contains global data for the ServiceSpecification. When inside a Project, do not set this property manually. [optional]
project_catalogues \Dangl\AVACloud\Model\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. [optional]
catalogue_references \Dangl\AVACloud\Model\CatalogueReferenceDto[] Referenced catalogues for this ElementContainerBase. [optional]
planned_execution_start \DateTime The date when the execution of the services is scheduled to start [optional]
planned_execution_end \DateTime The date then the execution of the services is scheduled to be finished [optional]
contract_date \DateTime The date on which the contract has been awarded. This matches "Auftragsdatum" in GAEB [optional]
contract_identifier string This value can be used to indicate the number or identifier of the contract. It matches "Auftragsnummer" in GAEB [optional]
warranty_duration \Dangl\AVACloud\Model\WarrantyDurationDto This indicates how long the warranty period is for this ServiceSpecification [optional]
warranty_end \DateTime The date on which the warranty period ends [optional]
approval_date \DateTime The date on which the services rendered by the bidder are scheduled to be approved by the buyer [optional]
type_of_approval string This should specify how the approval is performed by the buyer. This matches "AcceptType" in GAEB [optional]
addendum_number string This optional string property is shared by all IElements, and indicates if the element is part of an addendum, a 'Nachtrag' in German. [optional]
addendum_status \Dangl\AVACloud\Model\AddendumStatusDto This indicates, if this element is part of an addendum an, if yes, with what status. [optional]
commerce_properties \Dangl\AVACloud\Model\ServiceSpecificationCommercePropertiesDto This property holds additional information that's only valid in commerce exchange phases. [optional]

[Back to Model list] [Back to API list] [Back to README]