🖊️
Moderan API
  • Moderan API
  • Authentication
    • API key & Domain ID
  • Assets
    • Spaces
      • Space sizes
  • Contracts
    • Contracts
      • Contract rent and fees
      • Contract spaces
      • Contract persons
  • Turnover rent
    • Turnover
    • Turnover rent
  • Contacts
    • Organizations
    • Persons
  • Reports
    • Rent and fees calculation
    • Building performance
    • Property performance
    • Spaces
  • Costs API
    • Get Property-Building sets
    • Periods
    • Cost types
    • Bills
    • Contract terms
    • Get Costs for a period
    • Get Cost Rates for a period
    • Send Readings data
  • Classifiers
    • Billing names
    • Distribution Basis
Powered by GitBook
On this page
  • Returns all retail turnovers
  • Creates a new turnover entry
  • Example payload for POST
  • Updates a turnover entry
  • Example of payload for PUT

Was this helpful?

  1. Turnover rent

Turnover

Returns all retail turnovers

GET https://www.moderan.net/api/domains/DOMAIN_ID/propertysets/0/retailturnovers?startDate=2023-10-01&endDate=2023-10-31

Path Parameters

Name
Type
Description

DOMAIN_ID*

String

Domain ID of customer

Query Parameters

Name
Type
Description

startDate*

String

Start time of period (format DD.MM.YYYY)

endDate*

String

End time of period (format DD.MM.YYYY)

Creates a new turnover entry

POST https://www.moderan.net/api/domains/DOMAIN_ID/propertysets/0/retailturnovers

Example payload for POST

{
   "turnoverRentMonth":"2023-10-19",
   "shopName":"Pineapple",
   "property":{
      "id":2488,
      "name":"Mänd"
   },
   "turnoverRentAmount":44,
   "tenant":{
      "id":12358,
      "name":"Ananass"
   }
}

Updates a turnover entry

PUT https://www.moderan.net/api/domains/DOMAIN_ID/propertysets/2488/retailturnovers/TURNOVER_ID

Path Parameters

Name
Type
Description

DOMAINID

String

Domain ID of customer

TURNOVER_ID

String

ID of updated turnover

Example of payload for PUT

{
   "shopName":"Raspberry",
   "id":174,
   "property":{
      "id":2488,
      "name":"Mänd"
   },
   "tenant":{
      "id":12239,
      "name":"Vaarikas"
   },
   "turnoverRentMonth":"2023-10-15",
   "turnoverRentAmount":14452,
}
PreviousContract personsNextTurnover rent

Last updated 4 months ago

Was this helpful?