Claim Input

Use this input to create a claim with claim items and optional documents.

Root XML Tag 

<ClaimInput>

JSON Example 

1{
2"name": "Medical reimbursement",
3"accountId": "001XXXXXXXXXXXXXXX",
4"status": "Open",
5"claimReason": "Out-of-pocket medical expenses",
6"estimatedAmount": "250.00",
7"claimItems": [
8{ "name": "Office visit", "quantity": 1, "productId": "01tXXXXXXXXXXXXXXX" }
9],
10"documents": [
11{ "contentDocumentId": "069XXXXXXXXXXXXXXX", "shareType": "V", "status": "New" }
12]
13}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
accountIdStringThe claim account ID.Optional68.0
claimItemsConnectApi.ClaimItemInput[]Claim items to create.Required68.0
claimReasonStringThe claim reason.Optional68.0
currencyIsoCodeStringThe ISO 4217 currency code. This field is required for multicurrency orgs.Optional68.0
customFieldsConnectApi.OutboundPaymentsCustomFieldInput[]Custom fields for this claim.Optional68.0
documentsConnectApi.DocumentInput[]Documents to attach to this claim.Optional68.0
estimatedAmountStringThe estimated claim amount.Optional68.0
nameStringName of the claim. If omitted, defaults to the constituent name from AuthorizedProductDelivery. If that value isn’t available, defaults to Support Services.Optional68.0
paymentInstrumentIdStringThe claim payment instrument ID.Optional68.0
statusStringThe claim status.Optional68.0
summaryStringThe claim summary.Optional68.0