Skip to content

Commit b0c5504

Browse files
Merge pull request #7 from Garaio-REM/topic/REM-20717/document_Masterdata.Person.Create_and_Masterdata.Person.Update
feat: document `Masterdata.Person.Create` and `Masterdata.Person.Update`
2 parents 666aa5a + fae6a0d commit b0c5504

8 files changed

+235
-31
lines changed

invoicing_context.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ This message goes from the order provider to GARAIO REM. Set the recipient prope
225225
| ------------------------------- | -------- | --------------------------------------------------------------------------------- |
226226
| `eventType` | `string` | Invoicing.Order.Deleted |
227227
| `data` | `hash` | |
228-
|   `reference` | `string` | unique identifer for the order; maybe required, see (1) |
228+
|   `reference` | `string` | unique identifier for the order; maybe required, see (1) |
229229
|   `externalReference` | `string` | external order identifier from the order provider; maybe required, see (1) |
230230

231231
Notes

letting_context.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ Field | Type | Content / Remarks
279279
eventType | string | Letting.TenancyAgreement.Create
280280
data | hash |
281281
  primaryUnitReference | string | reference of an available unit; **required**
282-
  tenancyAgreementTypeCode | string | a valid tenancy agreement type code (see code table entries (mietvertrag_typ)for valid codes); **required**
282+
  tenancyAgreementTypeCode | string | a valid tenancy agreement type code (see code table entries (`mietvertrag_typ`) for valid codes); **required**
283283
  rentStartDate | string | ISO 8601 encoded date, eg '2019-03-01'; **required**
284284
  contractDate | string | ISO 8601 encoded date, eg '2019-02-18'; **required**
285285
  paymentModeCode | string | a valid code from the zahlmodus code table; defaults to '01' (monthly in advance)
@@ -292,10 +292,10 @@ data | hash |
292292
      street | string | street incl. number; **required**
293293
      countryCode | string | ISO country code, eg 'CH'; defaults to 'CH'
294294
    correspondenceLanguageCode | string | de, fr, it or en; **must be lower case, required**
295-
    tenantIndustryCode | string | a valid rental type code (see code table entries (branche_mieter) for valid codes)
295+
    tenantIndustryCode | string | a valid rental type code (see code table entries (`branche_mieter`) for valid codes)
296296
    email | string | email address
297297
    phoneNumber | string | phone number (international format)
298-
    maritalStatus | string | one of the following values will be accepted: `unmarried`, `marrided`, `widowed`, `divorced`, `separated`, `civil_union`
298+
    maritalStatus | string | one of the following values will be accepted: `unmarried`, `married`, `widowed`, `divorced`, `separated`, `civil_union`
299299
    dateOfBirth | string | ISO 8601 encoded date, eg '2019-03-01'; **required**
300300
    homeTown | string | home town
301301
    nationalityCode | string | ISO country code, eg 'CH'
@@ -314,20 +314,20 @@ data | hash |
314314
    correspondenceLanguageCode | string | de, fr, it or en; **must be lower case, required**
315315
    email | string | email address
316316
    phoneNumber | string | phone number (international format)
317-
    maritalStatus | string | one of the following values will be accepted: `unmarried`, `marrided`, `widowed`, `divorced`, `separated`, `civil_union`
317+
    maritalStatus | string | one of the following values will be accepted: `unmarried`, `married`, `widowed`, `divorced`, `separated`, `civil_union`
318318
    dateOfBirth | string | ISO 8601 encoded date, eg '2019-03-01'; **required**
319319
    homeTown | string | home town
320320
    nationalityCode | string | ISO country code, eg 'CH'
321321
    jobTitle | string | job title
322322
    salutation | string | one of the following values will be accepted: `none`, `sir`, `madam`
323323
    assignBuildingAddress | boolean | should the building address be assigned per rent start date?
324324
  rentRegulations | hash | optional rent regulations
325-
    rentalTypeCode | string | a valid rental type code (see code table entries (mieter_art) for valid codes)
325+
    rentalTypeCode | string | a valid rental type code (see code table entries (`mieter_art`) for valid codes)
326326
    rentLockedUntil | string | ISO 8601 encoded date, eg '2019-03-01'
327327
    rentLockedReason | string | reason why the rent is locked
328328
  limitedUntil | string | optional ISO 8601 encoded date, eg '2019-03-31'; if applied, valid cancellationRegulations must be applied, too
329329
  cancellationRegulations | hash | cancellation regulations
330-
    cancellationModeCode | string | a valid cancellation mode code (see code table entries (kuendigungs_termin) for valid codes)
330+
    cancellationModeCode | string | a valid cancellation mode code (see code table entries (`kuendigungs_termin`) for valid codes)
331331
    cancellationPeriodInMonths | integer | minimum number of months a cancellation must be announced in advance by the landlord
332332
    cancellationPeriodTenantInMonths | integer | minimum number of months a cancellation must be announced in advance by the tenant
333333
    earliestPossibleTerminationDateLandlord | string | ISO 8601 encoded date, eg '2019-03-01'
@@ -345,7 +345,7 @@ data | hash |
345345
    numberOfPeople | integer | number of people
346346
    installationsForCommonUsage | string | freetext describing installations for common usage
347347
    roomsForSoleUsage | array | rooms for sole usage
348-
      unitTypeCode | string | a valid unit type code (see code table entries (objekt_art) for valid codes)
348+
      unitTypeCode | string | a valid unit type code (see code table entries (`objekt_art`) for valid codes)
349349
      number | string | unit number
350350
  initialRentForm | hash | initial rent form data
351351
    reason | string | Reason for the rent
@@ -623,7 +623,7 @@ Additional `data` fields:
623623
| ----------- | -------- | ------------------------------- |
624624
| `reference` | `string` | The tenancy agreement reference |
625625

626-
#### Letting.TenaancyAgreementSecurityDepot.UpdateRejected
626+
#### Letting.TenancyAgreementSecurityDepot.UpdateRejected
627627

628628
The [Reject](./result_messages.md#rejected-message) message.
629629

0 commit comments

Comments
 (0)