hv2-all-in-one/api/openapi.yaml

1952 lines
52 KiB
YAML

# -----------------------------------------
# THIS FILE HAS BEEN GENERATED
# DO NOT EDIT MANUALLY
# -----------------------------------------
openapi: 3.0.0
info:
title: hv2-api
version: "1"
description: "REST-API for the Nober Grundbesitz GbR Hausverwaltungs-Software"
termsOfService: "https://home.hottis.de/dokuwiki/doku.php?id=hv2pub:termsofuse"
contact:
name: "Wolfgang Hottgenroth"
email: "wolfgang.hottgenroth@icloud.com"
externalDocs:
description: "Find more details here"
url: "https://home.hottis.de/dokuwiki/doku.php?id=hv2pub:externaldocs"
paths:
/v1/accounts:
get:
tags: [ "account" ]
summary: Return all normalized accounts
operationId: methods.get_accounts
responses:
'200':
description: accounts response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account'
security:
- jwt: ['secret']
post:
tags: [ "account" ]
summary: Insert a account
operationId: methods.insert_account
requestBody:
description: account
content:
application/json:
schema:
$ref: '#/components/schemas/account'
responses:
'200':
description: account successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account'
security:
- jwt: ['secret']
/v1/accounts/{accountId}:
get:
tags: [ "account" ]
summary: Return the normalized account with given id
operationId: methods.get_account
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
responses:
'200':
description: account response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account'
security:
- jwt: ['secret']
put:
tags: [ "account" ]
summary: Update a account
operationId: methods.update_account
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
requestBody:
description: account
content:
application/json:
schema:
$ref: '#/components/schemas/account'
responses:
'200':
description: account successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account'
security:
- jwt: ['secret']
/v1/tenants:
get:
tags: [ "tenant" ]
summary: Return all normalized tenants
operationId: methods.get_tenants
responses:
'200':
description: tenants response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenant'
security:
- jwt: ['secret']
post:
tags: [ "tenant" ]
summary: Insert a tenant
operationId: methods.insert_tenant
requestBody:
description: tenant
content:
application/json:
schema:
$ref: '#/components/schemas/tenant'
responses:
'200':
description: tenant successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenant'
security:
- jwt: ['secret']
/v1/tenants/{tenantId}:
get:
tags: [ "tenant" ]
summary: Return the normalized tenant with given id
operationId: methods.get_tenant
parameters:
- name: tenantId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenant response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenant'
security:
- jwt: ['secret']
put:
tags: [ "tenant" ]
summary: Update a tenant
operationId: methods.update_tenant
parameters:
- name: tenantId
in: path
required: true
schema:
type: integer
requestBody:
description: tenant
content:
application/json:
schema:
$ref: '#/components/schemas/tenant'
responses:
'200':
description: tenant successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenant'
security:
- jwt: ['secret']
/v1/tenants/account/{accountId}:
get:
tags: [ "tenant", "account" ]
summary: Return tenant by $account
operationId: methods.get_tenant_by_account
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenant response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenant'
security:
- jwt: ['secret']
/v1/premises:
get:
tags: [ "premise" ]
summary: Return all normalized premises
operationId: methods.get_premises
responses:
'200':
description: premises response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/premise'
security:
- jwt: ['secret']
post:
tags: [ "premise" ]
summary: Insert a premise
operationId: methods.insert_premise
requestBody:
description: premise
content:
application/json:
schema:
$ref: '#/components/schemas/premise'
responses:
'200':
description: premise successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/premise'
security:
- jwt: ['secret']
/v1/premises/{premiseId}:
get:
tags: [ "premise" ]
summary: Return the normalized premise with given id
operationId: methods.get_premise
parameters:
- name: premiseId
in: path
required: true
schema:
type: integer
responses:
'200':
description: premise response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/premise'
security:
- jwt: ['secret']
put:
tags: [ "premise" ]
summary: Update a premise
operationId: methods.update_premise
parameters:
- name: premiseId
in: path
required: true
schema:
type: integer
requestBody:
description: premise
content:
application/json:
schema:
$ref: '#/components/schemas/premise'
responses:
'200':
description: premise successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/premise'
security:
- jwt: ['secret']
/v1/premises/account/{accountId}:
get:
tags: [ "premise", "account" ]
summary: Return premise by $account
operationId: methods.get_premise_by_account
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
responses:
'200':
description: premise response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/premise'
security:
- jwt: ['secret']
/v1/flats:
get:
tags: [ "flat" ]
summary: Return all normalized flats
operationId: methods.get_flats
responses:
'200':
description: flats response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/flat'
security:
- jwt: ['secret']
post:
tags: [ "flat" ]
summary: Insert a flat
operationId: methods.insert_flat
requestBody:
description: flat
content:
application/json:
schema:
$ref: '#/components/schemas/flat'
responses:
'200':
description: flat successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/flat'
security:
- jwt: ['secret']
/v1/flats/{flatId}:
get:
tags: [ "flat" ]
summary: Return the normalized flat with given id
operationId: methods.get_flat
parameters:
- name: flatId
in: path
required: true
schema:
type: integer
responses:
'200':
description: flat response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/flat'
security:
- jwt: ['secret']
put:
tags: [ "flat" ]
summary: Update a flat
operationId: methods.update_flat
parameters:
- name: flatId
in: path
required: true
schema:
type: integer
requestBody:
description: flat
content:
application/json:
schema:
$ref: '#/components/schemas/flat'
responses:
'200':
description: flat successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/flat'
security:
- jwt: ['secret']
/v1/flats/premise/{premiseId}:
get:
tags: [ "flat", "premise" ]
summary: Return flat by $premise
operationId: methods.get_flat_by_premise
parameters:
- name: premiseId
in: path
required: true
schema:
type: integer
responses:
'200':
description: flat response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/flat'
security:
- jwt: ['secret']
/v1/overhead_advances:
get:
tags: [ "overhead_advance" ]
summary: Return all normalized overhead_advances
operationId: methods.get_overhead_advances
responses:
'200':
description: overhead_advances response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance'
security:
- jwt: ['secret']
post:
tags: [ "overhead_advance" ]
summary: Insert a overhead_advance
operationId: methods.insert_overhead_advance
requestBody:
description: overhead_advance
content:
application/json:
schema:
$ref: '#/components/schemas/overhead_advance'
responses:
'200':
description: overhead_advance successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance'
security:
- jwt: ['secret']
/v1/overhead_advances/{overhead_advanceId}:
get:
tags: [ "overhead_advance" ]
summary: Return the normalized overhead_advance with given id
operationId: methods.get_overhead_advance
parameters:
- name: overhead_advanceId
in: path
required: true
schema:
type: integer
responses:
'200':
description: overhead_advance response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance'
security:
- jwt: ['secret']
put:
tags: [ "overhead_advance" ]
summary: Update a overhead_advance
operationId: methods.update_overhead_advance
parameters:
- name: overhead_advanceId
in: path
required: true
schema:
type: integer
requestBody:
description: overhead_advance
content:
application/json:
schema:
$ref: '#/components/schemas/overhead_advance'
responses:
'200':
description: overhead_advance successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance'
security:
- jwt: ['secret']
/v1/overhead_advance_flat_mappings:
get:
tags: [ "overhead_advance_flat_mapping" ]
summary: Return all normalized overhead_advance_flat_mappings
operationId: methods.get_overhead_advance_flat_mappings
responses:
'200':
description: overhead_advance_flat_mappings response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance_flat_mapping'
security:
- jwt: ['secret']
post:
tags: [ "overhead_advance_flat_mapping" ]
summary: Insert a overhead_advance_flat_mapping
operationId: methods.insert_overhead_advance_flat_mapping
requestBody:
description: overhead_advance_flat_mapping
content:
application/json:
schema:
$ref: '#/components/schemas/overhead_advance_flat_mapping'
responses:
'200':
description: overhead_advance_flat_mapping successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance_flat_mapping'
security:
- jwt: ['secret']
/v1/overhead_advance_flat_mappings/{overhead_advance_flat_mappingId}:
get:
tags: [ "overhead_advance_flat_mapping" ]
summary: Return the normalized overhead_advance_flat_mapping with given id
operationId: methods.get_overhead_advance_flat_mapping
parameters:
- name: overhead_advance_flat_mappingId
in: path
required: true
schema:
type: integer
responses:
'200':
description: overhead_advance_flat_mapping response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance_flat_mapping'
security:
- jwt: ['secret']
/v1/overhead_advance_flat_mappings/overhead_advance/{overhead_advanceId}:
get:
tags: [ "overhead_advance_flat_mapping", "overhead_advance" ]
summary: Return overhead_advance_flat_mapping by $overhead_advance
operationId: methods.get_overhead_advance_flat_mapping_by_overhead_advance
parameters:
- name: overhead_advanceId
in: path
required: true
schema:
type: integer
responses:
'200':
description: overhead_advance_flat_mapping response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance_flat_mapping'
security:
- jwt: ['secret']
/v1/overhead_advance_flat_mappings/flat/{flatId}:
get:
tags: [ "overhead_advance_flat_mapping", "flat" ]
summary: Return overhead_advance_flat_mapping by $flat
operationId: methods.get_overhead_advance_flat_mapping_by_flat
parameters:
- name: flatId
in: path
required: true
schema:
type: integer
responses:
'200':
description: overhead_advance_flat_mapping response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance_flat_mapping'
security:
- jwt: ['secret']
/v1/parkings:
get:
tags: [ "parking" ]
summary: Return all normalized parkings
operationId: methods.get_parkings
responses:
'200':
description: parkings response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/parking'
security:
- jwt: ['secret']
post:
tags: [ "parking" ]
summary: Insert a parking
operationId: methods.insert_parking
requestBody:
description: parking
content:
application/json:
schema:
$ref: '#/components/schemas/parking'
responses:
'200':
description: parking successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/parking'
security:
- jwt: ['secret']
/v1/parkings/{parkingId}:
get:
tags: [ "parking" ]
summary: Return the normalized parking with given id
operationId: methods.get_parking
parameters:
- name: parkingId
in: path
required: true
schema:
type: integer
responses:
'200':
description: parking response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/parking'
security:
- jwt: ['secret']
put:
tags: [ "parking" ]
summary: Update a parking
operationId: methods.update_parking
parameters:
- name: parkingId
in: path
required: true
schema:
type: integer
requestBody:
description: parking
content:
application/json:
schema:
$ref: '#/components/schemas/parking'
responses:
'200':
description: parking successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/parking'
security:
- jwt: ['secret']
/v1/parkings/premise/{premiseId}:
get:
tags: [ "parking", "premise" ]
summary: Return parking by $premise
operationId: methods.get_parking_by_premise
parameters:
- name: premiseId
in: path
required: true
schema:
type: integer
responses:
'200':
description: parking response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/parking'
security:
- jwt: ['secret']
/v1/commercial_premises:
get:
tags: [ "commercial_premise" ]
summary: Return all normalized commercial_premises
operationId: methods.get_commercial_premises
responses:
'200':
description: commercial_premises response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/commercial_premise'
security:
- jwt: ['secret']
post:
tags: [ "commercial_premise" ]
summary: Insert a commercial_premise
operationId: methods.insert_commercial_premise
requestBody:
description: commercial_premise
content:
application/json:
schema:
$ref: '#/components/schemas/commercial_premise'
responses:
'200':
description: commercial_premise successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/commercial_premise'
security:
- jwt: ['secret']
/v1/commercial_premises/{commercial_premiseId}:
get:
tags: [ "commercial_premise" ]
summary: Return the normalized commercial_premise with given id
operationId: methods.get_commercial_premise
parameters:
- name: commercial_premiseId
in: path
required: true
schema:
type: integer
responses:
'200':
description: commercial_premise response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/commercial_premise'
security:
- jwt: ['secret']
put:
tags: [ "commercial_premise" ]
summary: Update a commercial_premise
operationId: methods.update_commercial_premise
parameters:
- name: commercial_premiseId
in: path
required: true
schema:
type: integer
requestBody:
description: commercial_premise
content:
application/json:
schema:
$ref: '#/components/schemas/commercial_premise'
responses:
'200':
description: commercial_premise successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/commercial_premise'
security:
- jwt: ['secret']
/v1/commercial_premises/premise/{premiseId}:
get:
tags: [ "commercial_premise", "premise" ]
summary: Return commercial_premise by $premise
operationId: methods.get_commercial_premise_by_premise
parameters:
- name: premiseId
in: path
required: true
schema:
type: integer
responses:
'200':
description: commercial_premise response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/commercial_premise'
security:
- jwt: ['secret']
/v1/tenancys:
get:
tags: [ "tenancy" ]
summary: Return all normalized tenancys
operationId: methods.get_tenancys
responses:
'200':
description: tenancys response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy'
security:
- jwt: ['secret']
post:
tags: [ "tenancy" ]
summary: Insert a tenancy
operationId: methods.insert_tenancy
requestBody:
description: tenancy
content:
application/json:
schema:
$ref: '#/components/schemas/tenancy'
responses:
'200':
description: tenancy successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy'
security:
- jwt: ['secret']
/v1/tenancys/{tenancyId}:
get:
tags: [ "tenancy" ]
summary: Return the normalized tenancy with given id
operationId: methods.get_tenancy
parameters:
- name: tenancyId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenancy response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy'
security:
- jwt: ['secret']
put:
tags: [ "tenancy" ]
summary: Update a tenancy
operationId: methods.update_tenancy
parameters:
- name: tenancyId
in: path
required: true
schema:
type: integer
requestBody:
description: tenancy
content:
application/json:
schema:
$ref: '#/components/schemas/tenancy'
responses:
'200':
description: tenancy successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy'
security:
- jwt: ['secret']
/v1/tenancys/tenant/{tenantId}:
get:
tags: [ "tenancy", "tenant" ]
summary: Return tenancy by $tenant
operationId: methods.get_tenancy_by_tenant
parameters:
- name: tenantId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenancy response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy'
security:
- jwt: ['secret']
/v1/tenancys/flat/{flatId}:
get:
tags: [ "tenancy", "flat" ]
summary: Return tenancy by $flat
operationId: methods.get_tenancy_by_flat
parameters:
- name: flatId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenancy response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy'
security:
- jwt: ['secret']
/v1/tenancys/parking/{parkingId}:
get:
tags: [ "tenancy", "parking" ]
summary: Return tenancy by $parking
operationId: methods.get_tenancy_by_parking
parameters:
- name: parkingId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenancy response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy'
security:
- jwt: ['secret']
/v1/tenancys/commercial_premise/{commercial_premiseId}:
get:
tags: [ "tenancy", "commercial_premise" ]
summary: Return tenancy by $commercial_premise
operationId: methods.get_tenancy_by_commercial_premise
parameters:
- name: commercial_premiseId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenancy response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy'
security:
- jwt: ['secret']
/v1/fees:
get:
tags: [ "fee" ]
summary: Return all normalized fees
operationId: methods.get_fees
responses:
'200':
description: fees response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/fee'
security:
- jwt: ['secret']
post:
tags: [ "fee" ]
summary: Insert a fee
operationId: methods.insert_fee
requestBody:
description: fee
content:
application/json:
schema:
$ref: '#/components/schemas/fee'
responses:
'200':
description: fee successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/fee'
security:
- jwt: ['secret']
/v1/fees/{feeId}:
get:
tags: [ "fee" ]
summary: Return the normalized fee with given id
operationId: methods.get_fee
parameters:
- name: feeId
in: path
required: true
schema:
type: integer
responses:
'200':
description: fee response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/fee'
security:
- jwt: ['secret']
put:
tags: [ "fee" ]
summary: Update a fee
operationId: methods.update_fee
parameters:
- name: feeId
in: path
required: true
schema:
type: integer
requestBody:
description: fee
content:
application/json:
schema:
$ref: '#/components/schemas/fee'
responses:
'200':
description: fee successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/fee'
security:
- jwt: ['secret']
/v1/tenancy_fee_mappings:
get:
tags: [ "tenancy_fee_mapping" ]
summary: Return all normalized tenancy_fee_mappings
operationId: methods.get_tenancy_fee_mappings
responses:
'200':
description: tenancy_fee_mappings response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy_fee_mapping'
security:
- jwt: ['secret']
post:
tags: [ "tenancy_fee_mapping" ]
summary: Insert a tenancy_fee_mapping
operationId: methods.insert_tenancy_fee_mapping
requestBody:
description: tenancy_fee_mapping
content:
application/json:
schema:
$ref: '#/components/schemas/tenancy_fee_mapping'
responses:
'200':
description: tenancy_fee_mapping successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy_fee_mapping'
security:
- jwt: ['secret']
/v1/tenancy_fee_mappings/{tenancy_fee_mappingId}:
get:
tags: [ "tenancy_fee_mapping" ]
summary: Return the normalized tenancy_fee_mapping with given id
operationId: methods.get_tenancy_fee_mapping
parameters:
- name: tenancy_fee_mappingId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenancy_fee_mapping response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy_fee_mapping'
security:
- jwt: ['secret']
/v1/tenancy_fee_mappings/tenancy/{tenancyId}:
get:
tags: [ "tenancy_fee_mapping", "tenancy" ]
summary: Return tenancy_fee_mapping by $tenancy
operationId: methods.get_tenancy_fee_mapping_by_tenancy
parameters:
- name: tenancyId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenancy_fee_mapping response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy_fee_mapping'
security:
- jwt: ['secret']
/v1/tenancy_fee_mappings/fee/{feeId}:
get:
tags: [ "tenancy_fee_mapping", "fee" ]
summary: Return tenancy_fee_mapping by $fee
operationId: methods.get_tenancy_fee_mapping_by_fee
parameters:
- name: feeId
in: path
required: true
schema:
type: integer
responses:
'200':
description: tenancy_fee_mapping response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenancy_fee_mapping'
security:
- jwt: ['secret']
/v1/account_entry_categorys:
get:
tags: [ "account_entry_category" ]
summary: Return all normalized account_entry_categorys
operationId: methods.get_account_entry_categorys
responses:
'200':
description: account_entry_categorys response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account_entry_category'
security:
- jwt: ['secret']
post:
tags: [ "account_entry_category" ]
summary: Insert a account_entry_category
operationId: methods.insert_account_entry_category
requestBody:
description: account_entry_category
content:
application/json:
schema:
$ref: '#/components/schemas/account_entry_category'
responses:
'200':
description: account_entry_category successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account_entry_category'
security:
- jwt: ['secret']
/v1/account_entry_categorys/{account_entry_categoryId}:
get:
tags: [ "account_entry_category" ]
summary: Return the normalized account_entry_category with given id
operationId: methods.get_account_entry_category
parameters:
- name: account_entry_categoryId
in: path
required: true
schema:
type: integer
responses:
'200':
description: account_entry_category response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account_entry_category'
security:
- jwt: ['secret']
/v1/account_entrys:
get:
tags: [ "account_entry" ]
summary: Return all normalized account_entrys
operationId: methods.get_account_entrys
responses:
'200':
description: account_entrys response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account_entry'
security:
- jwt: ['secret']
post:
tags: [ "account_entry" ]
summary: Insert a account_entry
operationId: methods.insert_account_entry
requestBody:
description: account_entry
content:
application/json:
schema:
$ref: '#/components/schemas/account_entry'
responses:
'200':
description: account_entry successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account_entry'
security:
- jwt: ['secret']
/v1/account_entrys/{account_entryId}:
get:
tags: [ "account_entry" ]
summary: Return the normalized account_entry with given id
operationId: methods.get_account_entry
parameters:
- name: account_entryId
in: path
required: true
schema:
type: integer
responses:
'200':
description: account_entry response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account_entry'
security:
- jwt: ['secret']
/v1/account_entrys/account/{accountId}:
get:
tags: [ "account_entry", "account" ]
summary: Return account_entry by $account
operationId: methods.get_account_entry_by_account
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
responses:
'200':
description: account_entry response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account_entry'
security:
- jwt: ['secret']
/v1/account_entrys/account_entry_category/{account_entry_categoryId}:
get:
tags: [ "account_entry", "account_entry_category" ]
summary: Return account_entry by $account_entry_category
operationId: methods.get_account_entry_by_account_entry_category
parameters:
- name: account_entry_categoryId
in: path
required: true
schema:
type: integer
responses:
'200':
description: account_entry response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account_entry'
security:
- jwt: ['secret']
/v1/notes:
get:
tags: [ "note" ]
summary: Return all normalized notes
operationId: methods.get_notes
responses:
'200':
description: notes response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/note'
security:
- jwt: ['secret']
post:
tags: [ "note" ]
summary: Insert a note
operationId: methods.insert_note
requestBody:
description: note
content:
application/json:
schema:
$ref: '#/components/schemas/note'
responses:
'200':
description: note successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/note'
security:
- jwt: ['secret']
/v1/notes/{noteId}:
get:
tags: [ "note" ]
summary: Return the normalized note with given id
operationId: methods.get_note
parameters:
- name: noteId
in: path
required: true
schema:
type: integer
responses:
'200':
description: note response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/note'
security:
- jwt: ['secret']
/v1/notes/tenant/{tenantId}:
get:
tags: [ "note", "tenant" ]
summary: Return note by $tenant
operationId: methods.get_note_by_tenant
parameters:
- name: tenantId
in: path
required: true
schema:
type: integer
responses:
'200':
description: note response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/note'
security:
- jwt: ['secret']
/v1/contracts:
get:
tags: [ "contract" ]
summary: Return all normalized contracts
operationId: methods.get_contracts
responses:
'200':
description: contracts response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/contract'
security:
- jwt: ['secret']
post:
tags: [ "contract" ]
summary: Insert a contract
operationId: methods.insert_contract
requestBody:
description: contract
content:
application/json:
schema:
$ref: '#/components/schemas/contract'
responses:
'200':
description: contract successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/contract'
security:
- jwt: ['secret']
/v1/contracts/{contractId}:
get:
tags: [ "contract" ]
summary: Return the normalized contract with given id
operationId: methods.get_contract
parameters:
- name: contractId
in: path
required: true
schema:
type: integer
responses:
'200':
description: contract response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/contract'
security:
- jwt: ['secret']
put:
tags: [ "contract" ]
summary: Update a contract
operationId: methods.update_contract
parameters:
- name: contractId
in: path
required: true
schema:
type: integer
requestBody:
description: contract
content:
application/json:
schema:
$ref: '#/components/schemas/contract'
responses:
'200':
description: contract successfully inserted
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/contract'
security:
- jwt: ['secret']
# -------------------------------------------------------------------
# ATTENTION: This file will not be parsed by Cheetah
# Use plain openapi/yaml syntax, no Cheetah
# escaping
# -------------------------------------------------------------------
/v1/overhead_advances/flat/{flatId}:
get:
tags: [ "overhead_advance", "flat" ]
summary: Return overhead_advances by flat
operationId: additional_methods.get_overhead_advances_by_flat
parameters:
- name: flatId
in: path
required: true
schema:
type: integer
responses:
'200':
description: overhead_advances_by_flat response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/overhead_advance'
security:
- jwt: ['secret']
/v1/fees/tenancy/{tenancyId}:
get:
tags: [ "fee", "tenancy" ]
summary: Return fees by tenancy
operationId: additional_methods.get_fees_by_tenancy
parameters:
- name: tenancyId
in: path
required: true
schema:
type: integer
responses:
'200':
description: get_fees_by_tenancy response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/fee'
security:
- jwt: ['secret']
/v1/account/saldo/{accountId}:
get:
tags: [ "account" ]
summary: Return saldo of the account
operationId: additional_methods.get_account_saldo
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
responses:
'200':
description: get_account_saldo
content:
'application/json':
schema:
type: object
properties:
saldo:
type: number
security:
- jwt: ['secret']
/v1/tenants/saldo:
get:
tags: [ "tenant", "account" ]
summary: Return tenant with saldo of the account
operationId: additional_methods.get_tenant_with_saldo
responses:
'200':
description: get_tenant_with_saldo
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/tenant_with_saldo'
security:
- jwt: ['secret']
/v1/accounts/bydescription/{description}:
get:
tags: [ "account" ]
summary: Return the normalized account with given description
operationId: additional_methods.get_account_by_description
parameters:
- name: description
in: path
required: true
schema:
type: string
responses:
'200':
description: account response
content:
'application/json':
schema:
type: array
items:
$ref: '#/components/schemas/account'
security:
- jwt: ['secret']
/v1/uniquenumber:
get:
tags: [ "uniquenumber" ]
summary: Returns a unique number
operationId: additional_methods.get_unique_number
responses:
'200':
description: get_unique_number
content:
'application/json':
schema:
type: object
properties:
number:
type: number
security:
- jwt: ['secret']
components:
securitySchemes:
jwt:
type: http
scheme: bearer
bearerFormat: JWT
x-bearerInfoFunc: auth.decodeToken
schemas:
account:
description: account
type: object
properties:
id:
type: integer
description:
type: string
tenant:
description: tenant
type: object
properties:
id:
type: integer
salutation:
type: string
nullable: true
firstname:
type: string
nullable: true
lastname:
type: string
nullable: true
address1:
type: string
nullable: true
address2:
type: string
nullable: true
address3:
type: string
nullable: true
zip:
type: string
nullable: true
city:
type: string
nullable: true
phone1:
type: string
nullable: true
phone2:
type: string
nullable: true
iban:
type: string
nullable: true
account:
type: integer
premise:
description: premise
type: object
properties:
id:
type: integer
description:
type: string
nullable: true
street:
type: string
zip:
type: string
city:
type: string
minus_area:
type: number
account:
type: integer
flat:
description: flat
type: object
properties:
id:
type: integer
description:
type: string
nullable: true
premise:
type: integer
nullable: true
area:
type: number
flat_no:
type: integer
nullable: true
overhead_advance:
description: overhead_advance
type: object
properties:
id:
type: integer
description:
type: string
nullable: true
amount:
type: number
startdate:
type: string
nullable: true
enddate:
type: string
nullable: true
overhead_advance_flat_mapping:
description: overhead_advance_flat_mapping
type: object
properties:
id:
type: integer
overhead_advance:
type: integer
flat:
type: integer
parking:
description: parking
type: object
properties:
id:
type: integer
description:
type: string
nullable: true
premise:
type: integer
nullable: true
commercial_premise:
description: commercial_premise
type: object
properties:
id:
type: integer
description:
type: string
nullable: true
premise:
type: integer
nullable: true
area:
type: number
nullable: true
tenancy:
description: tenancy
type: object
properties:
id:
type: integer
description:
type: string
nullable: true
tenant:
type: integer
flat:
type: integer
nullable: true
parking:
type: integer
nullable: true
commercial_premise:
type: integer
nullable: true
startdate:
type: string
enddate:
type: string
nullable: true
fee:
description: fee
type: object
properties:
id:
type: integer
description:
type: string
nullable: true
amount:
type: number
fee_type:
type: string
startdate:
type: string
nullable: true
enddate:
type: string
nullable: true
tenancy_fee_mapping:
description: tenancy_fee_mapping
type: object
properties:
id:
type: integer
tenancy:
type: integer
fee:
type: integer
account_entry_category:
description: account_entry_category
type: object
properties:
id:
type: integer
description:
type: string
considerMinusArea:
type: boolean
overhead_relevant:
type: boolean
account_entry:
description: account_entry
type: object
properties:
id:
type: integer
description:
type: string
account:
type: integer
created_at:
type: string
fiscal_year:
type: integer
amount:
type: number
document_no:
type: integer
nullable: true
account_entry_category:
type: integer
note:
description: note
type: object
properties:
id:
type: integer
created_at:
type: string
tenant:
type: integer
note:
type: string
contract:
description: contract
type: object
properties:
id:
type: integer
supplier:
type: string
content:
type: string
identifier:
type: string
notes:
type: string
nullable: true
# -------------------------------------------------------------------
# ATTENTION: This file will not be parsed by Cheetah
# Use plain openapi/yaml syntax, no Cheetah
# escaping
# -------------------------------------------------------------------
tenant_with_saldo:
description: tenant with saldo
type: object
properties:
id:
type: integer
salutation:
type: string
nullable: true
firstname:
type: string
nullable: true
lastname:
type: string
nullable: true
address1:
type: string
nullable: true
saldo:
type: number
nullable: true