Rechnungen für Serviceanforderungen
Sobald eine Serviceanforderung, die den Status „Angebot abgeben und Dienst ausführen“, „Nur Service“ oder „Nicht verwaltet“ aufweist, die Phase „Auftrag abgeschlossen“ erreicht, können Rechnungen für die Serviceanforderung erstellt werden.
Eine Rechnung besteht aus:
- Einer Beschreibung
- Einer optionalen Referenznummer
- Einer oder mehreren Einzelpositionen Jede Einzelposition besteht aus:
- Einem Geldbetrag (Betrag und Währung)
- Einer Kategorie
- Einer optionalen Beschreibung
Sobald eine Rechnung hinzugefügt wurde, kann sie genehmigt werden. Wenn eine Rechnung genehmigt wird, bedeutet das, dass sie akzeptabel ist und bezahlt werden kann. Sie können eine Rechnung auch als bezahlt markieren.
Beachten Sie, dass es Mechanismen gibt, um weitere Arbeiten an akzeptierten Serviceanforderungen und Rechnungen für Serviceanforderungen auszusetzen. Aber das für jeden Mechanismus verwendete Verb ist unterschiedlich.
- Um weitere Arbeiten an einer angenommenen Serviceanforderung zu stoppen, müssen Sie sie stornieren (oder intern stornieren).
- Um weitere Arbeiten an einer Rechnung zu stoppen, müssen Sie sie widerrufen.
Abfragen von Rechnungen
Die folgenden Claim-API-Endpunkte können verwendet werden, um Informationen über Rechnungen für Serviceanforderungen abzufragen:
| Endpunkt | Antwort |
|---|---|
GET /claims/{claimId}/service-requests/{serviceRequestId}/invoices |
Alle Rechnungen für die angegebene Serviceanforderung |
GET /claims/{claimId}/servicerequests/{serviceRequestId}/invoices/{invoiceId} |
Die angegebene Rechnung. Beachten Sie, dass Sie auf die Rechnung über den übergeordneten Schadenfall und die Serviceanforderung zugreifen müssen, um Informationen zu einer bestimmten Rechnung zu erhalten. |
Erstellen von Rechnungen für Serviceanforderungen
Zum Erstellen einer Rechnung für eine Serviceanforderung verwenden Sie:
- POST
/claims/{claimId}/service-requests/{serviceRequestId}/invoices
Mindestkriterien für die Erstellung
Eine Rechnung muss die folgenden Informationen enthalten:
- eine Beschreibung
- einem Satz oder mehrerer Sätze von Einzelpositionen. Jede Einzelposition muss Folgendes angeben:
- einem Geldbetrag (mit Werten für Betrag und Währung)
- eine Kategorie (ein Code aus der Typenliste
ServiceRequestStatementLineItemCategory)
Folgendes erstellt eine Rechnung für die Serviceanforderung cc:9. Die Rechnung enthält zwei Einzelpositionen: eine Forderung von 150 USD für Arbeitskosten und eine Forderung von 50 USD für Teile. Sie enthält auch eine optionale Referenznummer für die Rechnung und optionale Beschreibungen für jede Einzelposition.
POST /claim/v1/claims/demo_sample:20/service-requests/cc:9/invoices
{
"data": {
"attributes": {
"description": "Invoice submitted using system APIs",
"referenceNumber": "771-DX5667",
"lineItems": [
{
"amount": {
"amount": "150.00",
"currency": "usd"
},
"category": {
"code": "labor"
},
"description": "Invoiced labor"
},
{
"amount": {
"amount": "50.00",
"currency": "usd"
},
"category": {
"code": "parts"
},
"description": "Invoiced parts"
}
]
}
}
}
Genehmigen von Rechnungen für Serviceanforderungen
Zum Genehmigen einer Rechnung verwenden Sie:
- POST
/claims/{claimId}/service-requests/{serviceRequestId}/invoices/{invoice-id}/approve
Für den POST invoices/{invoice-id}/approve-Endpunkt ist kein Anforderungstext erforderlich.
Im Folgenden wird die Rechnung cc:06 für die Serviceanforderung cc:9 genehmigt.
POST /claim/v1/claims/demo_sample:20/service-requests/cc:9/invoices/cc:6/approve
(no request body)
Rechnungen als bezahlt kennzeichnen
Um eine Rechnung als bezahlt zu kennzeichnen, verwenden Sie:
- POST
/claims/{claimId}/service-requests/{serviceRequestId}/invoices/{invoice-id}/mark-as-paid
Wenn eine Rechnung als bezahlt gekennzeichnet ist, muss ein Scheck zugeordnet sein (der vermutlich zur Bezahlung der Rechnung verwendet wurde). In den /mark-as-paid-Anforderungs-Nutzdaten müssen Sie ein Scheck-Attribut mit der ID des zugehörigen Schecks einfügen. Beispielsweise kennzeichnen die folgenden Nutzdaten die Rechnung cc:6 (für Serviceanforderung cc:9 für Schadenfall demo_sample:20) als bezahlt. Der zugehörige Scheck ist cc:413.
POST /claim/v1/claims/demo_sample:20/service-requests/cc:9/invoices/cc:6/mark-as-paid
{
"data": {
"attributes": {
"check": {
"id": "cc:413"
}
}
}
}
Beachten Sie, dass ClaimCenter über Validierungsregeln verfügt, welche die Möglichkeit einschränken, eine Rechnung basierend auf dem Status der Rechnung als bezahlt zu markieren.
Widerrufen von Rechnungen für Serviceanforderungen
Zum Widerrufen einer Rechnung verwenden Sie:
- POST
/claims/{claimId}/service-requests/{serviceRequestId}/invoices/{invoice-id}/withdraw
Beim Widerrufen einer Rechnung müssen Sie einen Grund angeben. Dieser kann auf einen beliebigen Zeichenfolgenwert gesetzt werden.
Wenn Sie eine Rechnung widerrufen, wird sie in der Benutzeroberfläche als „Widerrufen“ markiert.
Im Folgenden wird die Rechnung cc:06 für die Serviceanforderung cc:9 widerrufen.
POST /claim/v1/claims/demo_sample:20/service-requests/cc:9/invoices/cc:6/withdraw
{
"data": {
"attributes": {
"reason": "Invoice submitted in error"
}
}
}