4.2 Rechnungsdaten-Prozess
Unter Punkt "4.2.1 Rechnungsdaten vom Partner zum Produkt" wird der Rechnungsdatenaustausch aus Sicht des Partners beschrieben.
Der Partner erzeugt die Rechungsdaten zur CloudApi und beendet den Austauschprozess.
Unter Punkt "4.2.2 Rechnungsdaten vom Produkt zum Partner" wird der Rechnungsdatenaustausch aus Sicht des Partners beschrieben.
Der Partner holt die Rechungsdaten aus der CloudApi ab.
optionale Rechnungsdaten-Endpunkte
Rechnungsdaten JSON-Schema
Gibt das JSON-Schema eines Rechnungsdaten-RequestType zurück
GET
SchemaRechungsdatenRequest
HTTP request
GET /CloudApi/V1/api//jobschemas/RechnungsdatenRequest HTTP/1.1
Ocp-Apim-Subscription-Key: ••••••••••••••••••••••••••••••••
Accept: */*
Cache-Control: no-cache
Host: api.realestatehub.haufe.io
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
HTTP response
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Transfer-Encoding: chunked
Content-Type: application/json
Content-Encoding: gzip
Expires: -1
Vary: Accept-Encoding
X-Powered-By: ASP.NET
Date: Wed, 18 Nov 2020 07:15:44 GMT
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "RechnungsdatenRequest",
"type": "object",
"properties": {
"RequestType": {
"type": [
"null",
"string"
]
},
"RechnungsEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/RechnungsEntity"
}
},
"PositionenEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/PositionenEntity"
}
},
"RechnungsstatusEntityCollection": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/RechnungsstatusEntity"
}
}
},
"definitions": {
"RechnungsEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"Rechnungsbetrag",
"Rechnungseingangsdatum",
"Rechnungsdatum",
"LeistungsdatumVon",
"LeistungsdatumBis",
"UniqueEntityIdentifierKreditor",
"UniqueEntityIdentifierUnternehmen",
"UniqueEntityIdentifier"
],
"properties": {
"Rechnungsnummer": {
"type": [
"null",
"string"
]
},
"RechnungsID": {
"type": [
"null",
"string"
]
},
"Rechnungsbetrag": {
"type": "string",
"minLength": 1
},
"Buchungstext": {
"type": [
"null",
"string"
]
},
"Ueberweisungstext": {
"type": [
"null",
"string"
]
},
"Rechnungseingangsdatum": {
"type": "string",
"minLength": 1
},
"Rechnungsdatum": {
"type": "string",
"minLength": 1
},
"LeistungsdatumVon": {
"type": "string",
"minLength": 1
},
"LeistungsdatumBis": {
"type": "string",
"minLength": 1
},
"Barcode": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierKreditor": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierBankKontoKreditor": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierBankKontoMandant": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierSachkonto": {
"type": [
"null",
"string"
]
},
"Skonto": {
"type": [
"null",
"object"
],
"additionalProperties": {
"type": "string"
}
},
"RechnungspruefStatus": {
"type": [
"null",
"string"
]
},
"Rechnungseingangsbuchnummer": {
"type": [
"null",
"string"
]
},
"Status": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierUnternehmen": {
"type": "string",
"minLength": 1
},
"Einzugsermaechtigung": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierBenutzer": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"PositionenEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierRechnung",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierAufwandskonto": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierVerbindlichkeitskonto": {
"type": [
"null",
"string"
]
},
"Buchungstext": {
"type": [
"null",
"string"
]
},
"Ueberweisungstext": {
"type": [
"null",
"string"
]
},
"Positionsbetrag": {
"type": [
"null",
"string"
]
},
"WertstellungsdatumBetriebskosten": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierWirtschaftseinheit": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierHaus": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierNutzungseinheit": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierNutzer": {
"type": [
"null",
"string"
]
},
"Zusatznummer": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierGewerk": {
"type": [
"null",
"string"
]
},
"Sicherheitseinbehaltsdatum": {
"type": [
"null",
"string"
]
},
"Sicherheitseinbehaltsbetrag": {
"type": [
"null",
"string"
]
},
"Steuersatz": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierBudget": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifierRechnung": {
"type": "string",
"minLength": 1
},
"UniqueEntityIdentifierKostenstelle": {
"type": [
"null",
"string"
]
},
"Menge": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
},
"RechnungsstatusEntity": {
"type": "object",
"additionalProperties": false,
"required": [
"UniqueEntityIdentifierRechnung",
"Status",
"UniqueEntityIdentifier"
],
"properties": {
"UniqueEntityIdentifierRechnung": {
"type": "string",
"minLength": 1
},
"Status": {
"type": "string",
"minLength": 1
},
"Belegnummer": {
"type": [
"null",
"string"
]
},
"Datum": {
"type": [
"null",
"string"
]
},
"Statusaenderungsdatum": {
"type": [
"null",
"string"
]
},
"Betrag": {
"type": [
"null",
"string"
]
},
"UniqueEntityIdentifier": {
"type": "string",
"minLength": 1
}
}
}
}
}
Nicht abgeschlossene Rechnungsdaten-Job´s aufrufen
Gibt die ersten 20 Job´s zurück, die nicht den Job-Status:"ResponseRetrieved" haben.
GET
Jobsexchangeincomplete
HTTP request
GET //CloudApi/V1/api/jobs/exchangeincomplete HTTP/1.1
Ocp-Apim-Subscription-Key: ••••••••••••••••••••••••••••••••
Authorization: Bearer 8b77010a-de03-45c8-a047-335c0ddd51f0
Accept: */*
Cache-Control: no-cache
Host: api.realestatehub.haufe.io
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
HTTP response
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 227
Content-Type: application/json; charset=utf-8
Content-Encoding: gzip
Expires: -1
Vary: Accept-Encoding
X-Powered-By: ASP.NET
Date: Wed, 18 Nov 2020 07:06:12 GMT
{
"ExchangeIncompleteJobs": [
{
"Id": "69483e04-e011-431e-8bcd-c0e14e2d14d5",
"State": "Queued"
},
{
"Id": "93f7b624-10ba-4ead-a166-2d8e7803f9af",
"State": "New"
},
{
"Id": "be098ca2-e08f-4246-b2ca-03a7e52573cd",
"State": "Confirmed"
},
{
"Id": "ce46f2ad-9b0e-4755-b1d2-9612b05e4c78",
"State": "Processed"
},
{
"Id": "27219e26-40ec-4385-ae63-ec39cce83bf6",
"State": "Error"
},
.
.
.
.
.
{
"Id": "6298d850-31d7-49b1-8fe5-b577f2c7f4ea",
"State": "New"
}
],
"_links": {
"self": {
"href": "https://api.realestatehub.haufe.io/CloudApi/V1/api/jobs/exchangeincomplete"
}
}
}