Aufträge

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Aufträge abrufen

Version 1.0

get

Autorisierungen

Abfrageparameter

apiKeystringOptional

Antworten

200

400

Bad Request

401

Unauthorized

get

GET /openwowi/v1.0/Commissioning/Commissions HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "CraftsProcess": {
      "Id": 1,
      "IdNum": "text",
      "CraftsProcessDescription": "text",
      "ProjectId": 1,
      "CraftProcessTypeId": 1
    },
    "CommissionTypeId": 1,
    "EconomicUnitId": 1,
    "BuildingId": 1,
    "UseUnitId": 1,
    "LicenseAgreementId": 1,
    "PropertyManagementContractId": 1,
    "CraftsmanId": 1,
    "RecordingDate": "2025-10-14T18:22:44.336Z",
    "PlacingDate": "2025-10-14T18:22:44.336Z",
    "AcceptanceDate": "2025-10-14T18:22:44.336Z",
    "CurrentStatusStepId": 1,
    "CurrentStatusStepCode": "text"
  }
]

Version 1.2

get

Autorisierungen

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

idinteger · int32Optional

idNumstringOptional

craftsProcessIdinteger · int32Optional

craftsProcessIdNumstringOptional

companyCodeIdinteger · int32Optional

companyCodeCodestringOptional

includeCommissionItemsbooleanOptionalDefault: false

includeAlsoCanceledCommissionItemsbooleanOptionalDefault: false

includeResponsibleOfficialRepairbooleanOptionalDefault: false

includeCommissionDetailsbooleanOptionalDefault: false

includeAdditionalFieldbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Antworten

200

400

Bad Request

401

Unauthorized

get

GET /openwowi/v1.2/CommissioningRead/Commissions HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "Code": "text",
    "DamageReportCode": "text",
    "DamageLocation": "text",
    "DamageReportBy": "text",
    "ReasonForRefusal": "text",
    "ContactPersonOnSite": "text",
    "ContactPersonEngineering": "text",
    "RecordingDate": "2025-10-14",
    "ReleaseDate": "2025-10-14",
    "PlacingDate": "2025-10-14",
    "ExecutionFrom": "2025-10-14",
    "ExecutionTo": "2025-10-14",
    "AcceptanceDate": "2025-10-14",
    "CompletionDate": "2025-10-14",
    "CraftsmanPortalImportDate": "2025-10-14",
    "TimeDamage": "2025-10-14",
    "CommissionType": {
      "Id": 1,
      "Code": "text"
    },
    "CommissionStatus": {
      "Id": 1,
      "Code": "text"
    },
    "CraftsProcess": {
      "Id": 1,
      "IdNum": "text"
    },
    "CompanyCode": {
      "Id": 1,
      "Name": "text",
      "Code": "text"
    },
    "Craftsman": {
      "Id": 1,
      "CreditorId": 1,
      "CreditorNumber": "text"
    },
    "LicenseAgreement": {
      "Id": 1,
      "IdNum": "text"
    },
    "UseUnit": {
      "Id": 1,
      "UseUnitNumber": "text"
    },
    "EconomicUnit": {
      "Id": 1,
      "IdNum": "text"
    },
    "Building": {
      "Id": 1,
      "IdNum": "text",
      "BuildingLandType": "text"
    },
    "ResponsibleOfficialRepair": {
      "Id": 1,
      "CodeShort": "text",
      "AutomaticMailsActivated": true,
      "UniversalResponsibilityPossible": true,
      "PersonId": 1,
      "PersonName": "text",
      "UserId": 1
    },
    "Caretaker": {
      "Id": 1,
      "PersonId": 1,
      "PersonIdNum": "text",
      "PersonName": "text"
    },
    "Architect": {
      "Id": 1,
      "PersonId": 1,
      "PersonIdNum": "text",
      "PersonName": "text"
    },
    "Component": {
      "Id": 1,
      "Name": "text"
    },
    "Facility": {
      "Id": 1,
      "Name": "text"
    },
    "EstateAddress": {
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "CountryId": 1,
      "CountryCode": "text",
      "StreetComplete": "text",
      "HouseNumberComplete": "text"
    },
    "CommissionDetails": {
      "AlternativeDiscountPercentage": 1,
      "AlternativeDiscountInDays": 1,
      "SecurityWithhold": {
        "Id": 1,
        "Name": "text",
        "Percentage": 1,
        "MaturityInMonths": 1
      },
      "WarrantyWithhold": {
        "Id": 1,
        "Name": "text",
        "Percentage": 1,
        "MaturityInMonths": 1
      }
    },
    "CommissionNotificationMethod": {
      "Id": 1,
      "Code": "text"
    },
    "Project": {
      "Id": 1,
      "Code": "text",
      "Name": "text"
    },
    "Land": {
      "Id": 1,
      "IdNum": "text"
    },
    "Department": {
      "Id": 1,
      "Name": "text"
    },
    "PropertyManagementContractData": {
      "PropertyManagementContract": {
        "Id": 1,
        "IdNum": "text"
      }
    },
    "CommissionItems": [
      {
        "Id": 1,
        "Code": "text",
        "UnitPrice": 1,
        "GrossAmount": 1,
        "NetAmount": 1,
        "Units": 1,
        "CommissionText": "text",
        "InternalDescription": "text",
        "PositionNumber": 1,
        "IsCanceled": true,
        "IsSmallRepair": true,
        "TransferToCraftsmanPortalWithoutCosts": true,
        "BudgetData": {
          "Budget": {
            "Id": 1,
            "Code": "text"
          },
          "BudgetDetail": {
            "Id": 1,
            "BudgetId": 1,
            "Hierarchy1Value": "text",
            "Hierarchy2Value": "text",
            "Hierarchy3Value": "text"
          }
        },
        "SalesTax": {
          "Id": 1,
          "Code": "text"
        },
        "ServiceCatalogue": {
          "Id": 1,
          "IdNum": "text",
          "Description": "text",
          "QuantityType": {
            "Id": 1,
            "Name": "text",
            "Code": "text",
            "ArgeCode": "text"
          }
        },
        "CraftActivity": {
          "Id": 1,
          "Code": "text"
        },
        "QuantityType": {
          "Id": 1,
          "Name": "text",
          "Code": "text",
          "ArgeCode": "text"
        },
        "Component": {
          "Id": 1,
          "Name": "text"
        },
        "Facility": {
          "Id": 1,
          "Name": "text"
        },
        "ComponentCatalog": {
          "Id": 1,
          "Name": "text"
        },
        "FacilityCatalog": {
          "Id": 1,
          "Name": "text"
        }
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ]
  }
]

Aufträge anlegen

Hinweise zur Funktion

Es können mehrere Aufträge mit einem Vorgang verknüpft werden.

Wenn einem Auftrag die "Adresse" fehlt, dann benötigt der Auftrag mehr als eine Wirtschaftseinheit. In diesem Fall muss mindestens eine Entität angegeben werden, welche auf ein Gebäude/Grundstück zurückzuführen ist (z.B. BuildingId, UseUnitId oder LicenseAgreementId).

Die Auftragsstatus der Auftragsarten sind durch den Kunden frei definierbar. Für jede Auftragsart muss deshalb der Auftragsstatusverlauf individuell geplant werden. Den Verlauf des Status finden Sie im Katalog "CommissionTypes" wenn Sie den Parameter "includeCommissionControl=true" mitsenden.

Im selben Katalog finden Sie auch alle Pflichtfelder, welche zur Auftragsart zusätzlich definiert wurden.

Version 1.2

Aufträge im Status "Erfasst" anlegen

post

Autorisierungen

Abfrageparameter

apiKeystringErforderlich

Rumpf

CraftsProcessIdinteger · int32Optional

IdNumstring | nullfähigOptional

Codestring | nullfähigOptional

ExternalIdentificationNumberstring | nullfähigOptional

CommissionTypeIdinteger · int32Optional

CreditorIdinteger · int32 | nullfähigOptional

UseUnitIdinteger · int32 | nullfähigOptional

BuildingIdinteger · int32 | nullfähigOptional

LandIdinteger · int32 | nullfähigOptional

EconomicUnitIdinteger · int32 | nullfähigOptional

LicenseAgreementIdinteger · int32 | nullfähigOptional

PropertyManagementContractIdinteger · int32 | nullfähigOptional

ResponsibleOfficialRepairIdinteger · int32 | nullfähigOptional

DepartmentIdinteger · int32 | nullfähigOptional

RecordingDatestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CompletionDatestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

PlacingDatestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

AcceptanceDatestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionFromstring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionTostring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

TimeDamagestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

FacilityIdinteger · int32 | nullfähigOptional

ComponentIdinteger · int32 | nullfähigOptional

CommissionStatusIdinteger · int32Optional

ShortDescriptionCraftsProcessstring | nullfähigOptional

Antworten

201

Created

400

Bad Request

401

Unauthorized

post

POST /openwowi/v1.2/CommissioningEdit/Commission?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 912

{
  "CraftsProcessId": 1,
  "IdNum": "text",
  "Code": "text",
  "ExternalIdentificationNumber": "text",
  "CommissionTypeId": 1,
  "CreditorId": 1,
  "UseUnitId": 1,
  "BuildingId": 1,
  "LandId": 1,
  "EconomicUnitId": 1,
  "LicenseAgreementId": 1,
  "PropertyManagementContractId": 1,
  "ResponsibleOfficialRepairId": 1,
  "DepartmentId": 1,
  "RecordingDate": "2025-10-14",
  "CompletionDate": "2025-10-14",
  "PlacingDate": "2025-10-14",
  "AcceptanceDate": "2025-10-14",
  "ExecutionFrom": "2025-10-14",
  "ExecutionTo": "2025-10-14",
  "TimeDamage": "2025-10-14",
  "Positions": [
    {
      "CraftActivityId": 1,
      "Code": "text",
      "ServiceCatalogId": 1,
      "CommissionText": "text",
      "FacilityId": 1,
      "ComponentId": 1,
      "FacilityCatalogId": 1,
      "ComponentCatalogId": 1,
      "UnderComponentId": 1,
      "Units": 1,
      "UnitPrice": 1,
      "NetAmount": 1,
      "SalesTaxId": 1,
      "MaterialCosts": 1,
      "LabourCosts": 1,
      "Description": "text",
      "BudgetId": 1,
      "BudgetDetailsId": 1
    }
  ],
  "FacilityId": 1,
  "ComponentId": 1,
  "CommissionStatusId": 1,
  "ShortDescriptionCraftsProcess": "text"
}

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

Aufträge im Status "Warte auf Annahme" anlegen

post

Autorisierungen

Abfrageparameter

apiKeystringErforderlich

Rumpf

CraftsProcessIdinteger · int32Optional

IdNumstring | nullfähigOptional

Codestring | nullfähigOptional

ExternalIdentificationNumberstring | nullfähigOptional

CommissionTypeIdinteger · int32Optional

CreditorIdinteger · int32 | nullfähigOptional

UseUnitIdinteger · int32 | nullfähigOptional

BuildingIdinteger · int32 | nullfähigOptional

LandIdinteger · int32 | nullfähigOptional

EconomicUnitIdinteger · int32 | nullfähigOptional

LicenseAgreementIdinteger · int32 | nullfähigOptional

PropertyManagementContractIdinteger · int32 | nullfähigOptional

ResponsibleOfficialRepairIdinteger · int32 | nullfähigOptional

DepartmentIdinteger · int32 | nullfähigOptional

RecordingDatestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

CompletionDatestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

PlacingDatestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

AcceptanceDatestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionFromstring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ExecutionTostring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

TimeDamagestring · date | nullfähigOptionalExample: 2025-10-14Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

FacilityIdinteger · int32 | nullfähigOptional

ComponentIdinteger · int32 | nullfähigOptional

ShortDescriptionCraftsProcessstring | nullfähigOptional

Antworten

200

400

Bad Request

401

Unauthorized

post

POST /openwowi/v1.2/CommissioningEdit/Commission/WaitForCraftsmanFeedback?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 889

{
  "CraftsProcessId": 1,
  "IdNum": "text",
  "Code": "text",
  "ExternalIdentificationNumber": "text",
  "CommissionTypeId": 1,
  "CreditorId": 1,
  "UseUnitId": 1,
  "BuildingId": 1,
  "LandId": 1,
  "EconomicUnitId": 1,
  "LicenseAgreementId": 1,
  "PropertyManagementContractId": 1,
  "ResponsibleOfficialRepairId": 1,
  "DepartmentId": 1,
  "RecordingDate": "2025-10-14",
  "CompletionDate": "2025-10-14",
  "PlacingDate": "2025-10-14",
  "AcceptanceDate": "2025-10-14",
  "ExecutionFrom": "2025-10-14",
  "ExecutionTo": "2025-10-14",
  "TimeDamage": "2025-10-14",
  "Positions": [
    {
      "CraftActivityId": 1,
      "Code": "text",
      "ServiceCatalogId": 1,
      "CommissionText": "text",
      "FacilityId": 1,
      "ComponentId": 1,
      "FacilityCatalogId": 1,
      "ComponentCatalogId": 1,
      "UnderComponentId": 1,
      "Units": 1,
      "UnitPrice": 1,
      "NetAmount": 1,
      "SalesTaxId": 1,
      "MaterialCosts": 1,
      "LabourCosts": 1,
      "Description": "text",
      "BudgetId": 1,
      "BudgetDetailsId": 1
    }
  ],
  "FacilityId": 1,
  "ComponentId": 1,
  "ShortDescriptionCraftsProcess": "text"
}

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

Ändern des Auftragsstatus

Version 1.2

Ändern auf "Angenommen"

put

Autorisierungen

Pfadparameter

commissionIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringErforderlich

Antworten

200

400

Bad Request

401

Unauthorized

put

PUT /openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Accepted?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

Ändern auf "Abgelehnt"

put

Autorisierungen

Pfadparameter

commissionIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringErforderlich

Rumpf

ReasonForRefusalstring | nullfähigOptional

Antworten

200

400

Bad Request

401

Unauthorized

put

PUT /openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Refused?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "ReasonForRefusal": "text"
}

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

Ändern auf "Erledigt"

put

Autorisierungen

Pfadparameter

commissionIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringErforderlich

Antworten

200

400

Bad Request

401

Unauthorized

put

PUT /openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Done?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

Ändern auf "An Handwerkerportal übertragen"

put

Autorisierungen

Pfadparameter

commissionIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringErforderlich

Antworten

200

400

Bad Request

401

Unauthorized

put

PUT /openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Imported?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

Ändern auf "Rechnungseingang erwartet"

put

Autorisierungen

Pfadparameter

commissionIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringErforderlich

Antworten

200

400

Bad Request

401

Unauthorized

put

PUT /openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/AwaitInvoice?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

Ändern auf "Storniert"

put

Autorisierungen

Pfadparameter

commissionIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringErforderlich

Antworten

200

400

Bad Request

401

Unauthorized

put

PUT /openwowi/v1.2/CommissioningEdit/Commission/{commissionId}/Canceled?apiKey=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "Id": 1,
  "IdNum": "text",
  "CraftsProcess": {
    "Id": 1,
    "IdNum": "text"
  }
}

Enumerator für "CommissionStatus" und "Id"

Code

Deutsch

EffortRecording

Leistungserfassung

CommissionRecorded

Erfasst

CommissionPlaced

Auftragsvergabe

ApprovalRequired

Freigabe erforderlich

Approved

Freigegeben

Accepted

Angenommen

Refused

Abgelehnt

Done

Erledigt

Suspended

Aussetzen

AwaitInvoice

Rechnungseingang erwartet

WaitForCraftsmanFeedback

Warte auf Annahme

Canceled

Storniert

InvoiceRecorded

Rechnung erfasst

PartSettled

Teilabgerechnet

CraftsmanPortalImported

An Handwerkerportal übertragen

VorherigeAuftragswesen NächsteAuftragspositionen

Zuletzt aktualisiert vor 4 Tagen