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
Name Type Description Required or Optional Available Version
accountId String The claim account ID. Optional 68.0
claimItems ConnectApi.ClaimItemInput[] Claim items to create. Required 68.0
claimReason String The claim reason. Optional 68.0
currencyIsoCode String The ISO 4217 currency code. This field is required for multicurrency orgs. Optional 68.0
customFields ConnectApi.OutboundPaymentsCustomFieldInput[] Custom fields for this claim. Optional 68.0
documents ConnectApi.DocumentInput[] Documents to attach to this claim. Optional 68.0
estimatedAmount String The estimated claim amount. Optional 68.0
name String Name of the claim. If omitted, defaults to the constituent name from AuthorizedProductDelivery. If that value isn’t available, defaults to Support Services. Optional 68.0
paymentInstrumentId String The claim payment instrument ID. Optional 68.0
status String The claim status. Optional 68.0
summary String The claim summary. Optional 68.0