Skip to content

Auction and bidding additions #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jensstalder wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Auction and bidding additions #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd7318d
auction, bidding, and documentation for pricing
jensstalder Nov 13, 2020
2bf6468
Documentation fixes
jensstalder Nov 13, 2020
a9de60a
updated doc
jensstalder Nov 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions docs/Prices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
[**◀ Home**](index.md)

# Prices

This provides an overview and documentation for the [prices](https://swissrets.ch/docs/noNamespace/complexType/prices.html) tag.

## Explanation

Prices defined in a property are essential. Because of it's inherit complexity and to make sure the values are understood correctly please refer to this guide as to what actually means what.

## Fixed price (buy)

Property for sale with a fixed price.
* **extra**: TODO: Good question? Is this similar to yearlyOperationAndMaintenanceCosts?
* **wirPercentage**: The percententage of the gross price which has to paid in WIR Franc electronic currency.

```xml
<property>
<availability start="2018-12-13T12:12:12" expiration="2019-12-13T12:12:12">active</availability>
<prices currency="CHF">
<buy referring="all">
<price>850000</price>
<extra>25000</extra>
<wirPercentage>5</wirPercentage>
</buy>
</prices>
</property>
```

## Auction

Property for sale within an auction. Bidders can consequently increase the current standing of the auction price. The last bidder usually wins.

The element `<auction>` has the following distinctions:

* **start:**: The time the property is up for auction and for sale.
* **expiration:**: The time when the property can not be auctioned any longer and gets disabled.
* **minimalIncrease:**: To a amount that is required for each bid to increase.
* **value:**: The starting price

```xml
<property>
<availability start="2018-12-13T12:12:12" expiration="2019-12-13T12:12:12">active</availability>
<prices currency="CHF">
<auction start="2012-12-13T12:12:12" expiration="2012-12-13T12:12:13" minimalIncrease="20000">745</auction>
</prices>
</property>
```

## Bidding process

Property for sale within a bidding war. Here anyone can bid a sum that is larger or equal to the asking price. The bidder with the largest commitment usually wins.

The element `<bidding>` has the following distinctions:

* **start:**: The time that bidding can commence.
* **bindingStart**: The start where offers become legally binding.
* **expiration:**: The time when the property gets removed from the bidding War.
* **value:**: The minimal asking price

```xml
<property>
<availability start="2018-12-13T12:12:12" expiration="2019-12-13T12:12:12">active</availability>
<prices currency="CHF">
<bidding start="2012-12-13T12:12:12" bindingStart="2012-12-14T12:12:12" expiration="2012-12-15T12:12:13">745</bidding>
</prices>
</property>
```

## Property for rent.

* **gross**: The total price (net + extra)
* **net**: The cost minus extra costs (gross - extra)
* **extra**: the difference between gross and net (gross - net)

Usually only two are required and the third can be calculated based on the other two. But the XML generator can choose to provide all three.

```xml
<property>
<availability start="2018-12-13T12:12:12" expiration="2019-12-13T12:12:12">active</availability>
<prices currency="CHF">
<rent referring="all" interval="monthly">
<gross>8500</gross>
<net>7500</net>
<extra>1000</extra>
</rent>
</prices>
</property>
```
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Schema location declaration for validation.
1. Details
- [Attachments](./Attachments.md) - images, documents, links
- [Availability](Availability.md) - lifecycle states
- [Prices](Prices.md) - Some clarifications for pricings (buy, rent, auction, bidding)
- [Categories](Categories.md) - categorization
- [Characteristics](./Characteristics.md) - facts and features
- [Applicables](./Characteristics.md#type-applicable)
Expand Down
15 changes: 15 additions & 0 deletions schema/schema.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,6 +730,21 @@
<xs:simpleContent>
<xs:extension base="xs:positiveInteger">
<xs:attribute name="start" type="xs:dateTime" />
<xs:attribute name="minimalIncrease" type="xs:positiveInteger" />
<xs:attribute name="expiration" type="xs:dateTime" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" maxOccurs="1" name="bidding">
<xs:annotation>
<xs:documentation>Starting price for a bidding war.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:positiveInteger">
<xs:attribute name="start" type="xs:dateTime" />
<xs:attribute name="bindingStart" type="xs:dateTime" />
<xs:attribute name="expiration" type="xs:dateTime" />
</xs:extension>
</xs:simpleContent>
Expand Down