サービス要求請求書
サービスの見積と実行のサービス要求、サービスのみのサービス要求、または管理されていないサービス要求が作業完了ステージに到達したら、サービス要求の請求書を作成できます。
請求書の構成要素は次のとおりです。
- 説明。
- オプションの参照番号。
- 1 つ以上の明細項目。明細項目の構成要素は次のとおりです。
- 金額（金額と通貨）
- カテゴリ
- オプションの説明
請求書が追加されたら、承認できます。請求書の承認は、請求書が受理可能で、支払う準備ができていることを意味します。請求書を支払済みとしてマークすることもできます。
受理されたサービス要求とサービス要求請求書の両方に対する追加作業を一時停止するメカニズムが存在することに注意してください。ただし、各メカニズムで使用される動詞は異なります。
- 受理されたサービス要求に対する追加作業を中止するには、キャンセル（内部キャンセル）します。
- 請求書に対する追加作業を中止するには、取り消します。
請求書の問い合わせ
以下の Claim API エンドポイントを使用して、サービス要求請求書に関する情報を要求できます。
| エンドポイント | 応答 |
|---|---|
GET /claims/{claimId}/service-requests/{serviceRequestId}/invoices |
指定したサービス要求に関するすべての請求書 |
GET /claims/{claimId}/servicerequests/{serviceRequestId}/invoices/{invoiceId} |
指定した請求書。特定の請求書に関する情報を取得するには、その親クレームおよびサービス要求から請求書にアクセスする必要があります。 |
サービス要求の請求書の作成
サービス要求の請求書を作成するには、以下を使用します。
- POST
/claims/{claimId}/service-requests/{serviceRequestId}/invoices
最小作成条件
請求書には以下の情報を含める必要があります。
- 説明
- 1 つまたは複数の明細項目によるセット。各明細項目では以下を指定する必要があります。
- 金額（金額と通貨の値）
- カテゴリ（
ServiceRequestStatementLineItemCategoryタイプリストのコード）
次の例は、サービス要求 cc:9 に関する請求書を作成しています。この請求書には、150 米ドルの人件費と 50 米ドルのパーツ料金に対する 2 つの明細項目が含まれています。また、請求書に対するオプションの参照番号と、各明細項目のオプションの説明も含まれています。
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"
}
]
}
}
}サービス要求請求書の承認
請求書を承認するには、以下を使用します。
- POST
/claims/{claimId}/service-requests/{serviceRequestId}/invoices/{invoice-id}/approve
POST invoices/{invoice-id}/approve エンドポイントに要求本文は必要ありません。
次の例は、サービス要求 cc:9 に関する請求書 cc:06 を承認しています。
POST /claim/v1/claims/demo_sample:20/service-requests/cc:9/invoices/cc:6/approve
(no request body)請求書を支払済みとしてマーク
請求書を支払済みとしてマークするには、以下を使用します。
- POST
/claims/{claimId}/service-requests/{serviceRequestId}/invoices/{invoice-id}/mark-as-paid
請求書を支払済みとしてマークするときには、関連する保険金支払が存在する必要があります（これが請求書の支払に使用されたと推定されます）。/mark-as-paid 要求ペイロードで、関連する保険金支払の ID を含む保険金支払属性を含める必要があります。例えば、次のペイロードは請求書 cc:6（クレーム demo_sample:20 のサービス要求 cc:9 用）を支払済みとしてマークしています。関連する保険金支払は 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"
}
}
}
}ClaimCenter には請求書の状態に基づいて請求書を支払済みとしてマークする機能を制限する検証ルールがあるので、注意してください。
サービス要求請求書の取消
請求書を取り消すには、以下を使用します。
- POST
/claims/{claimId}/service-requests/{serviceRequestId}/invoices/{invoice-id}/withdraw
請求書を取り消す場合は、理由を指定する必要があります。これは、任意の文字列値に設定できます。
請求書を取り消すと、ユーザーインターフェイスでその請求書に取消というフラグが付けられます。
以下は、サービス要求 cc:9 に対する請求書 cc:06 を取り消します。
POST /claim/v1/claims/demo_sample:20/service-requests/cc:9/invoices/cc:6/withdraw
{
"data": {
"attributes": {
"reason": "Invoice submitted in error"
}
}
}