Claims (POST)

Create multiple claims, each with claim items and supporting documents, in a single request.

Resource

1/connect/outbound-payments/claims

Available Version

68.0

HTTP Methods

POST

Usage

Use this resource to create claims in bulk on behalf of a constituent. In one request, create multiple claims and include claim items and supporting documents for each claim.

If any claim in the request can’t be created, the entire request is rolled back and records aren’t saved. The response returns one result entry for each submitted claim, in request order.

For each claim in the request, this resource creates a Claim record and, under it, one ClaimItem record for each claim item and a ContentDocumentLink and DocumentChecklistItem record for each document. When a claim item includes an authorized product delivery ID, the resource also updates the AuthorizedProductDelivery record to reference the new claim item.

Request Body for POST

Root XML Tag

<ClaimCollectionInput>

Claim Collection Input

Request Parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`bulkClaimRecord`	Object	The collection of claims to create, each with its claim items and documents. The request body maps to `ClaimCollectionInputRepresentation`.	Required	68.0

Response Body for POST

Claim Collection Output

Properties

Status Code	Description
200	The claims, claim items, and documents were created successfully.
400	The request failed validation, or a claim couldn’t be created. Because this request runs in all-or-nothing mode, records aren’t saved.
403	The user doesn’t have access to this resource.