Pass Through Call to Claims's "Get Claims Data" API

This RESTified API will perform a pass-through call to the Claims sub-system's "Get Claims Data" API (when configured).

URL

POST /up/v5/claims/_query

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Claims "Get Claims Data" API.

GetClaimsData Object Format

js

GetClaimsData Object Properties

Property	Type	Required?	Description	Claims Field Mapping
`ManufacturerName`	`string`	No	Pass through parameter to the Claims "Get Claims Data" API.	`manufacturerName`
`ServiceCenterNumber`	`string`	No	Pass through parameter to the Claims "Get Claims Data" API.	`serviceCenterNumber`
`ClaimIdentifier`	`string`	No	Pass through parameter to the Claims "Get Claims Data" API.	`claimIdentifier`
`ClaimBatchNumber`	`integer`	No	Pass through parameter to the Claims "Get Claims Data" API.	`claimBatchNumber`
`ClaimSequenceNumber`	`integer`	No	Pass through parameter to the Claims "Get Claims Data" API.	`claimSequenceNumber`
`ClaimNumber`	`string`	No	Pass through parameter to the Claims "Get Claims Data" API.	`claimNumber`
`CallNumber`	`string`	No	Pass through parameter to the Claims "Get Claims Data" API.	`callNumber`

HTTP Response

Success

On success, a JSON-formatted version of the Claims "Get Claims Data" API response will be returned.

GetClaimsData Response Object Format

js

GetClaimsData Response Object Properties

Property		Type	Description
`Claims`		`array`	Pass through parameter from the Claims "Get Claims Data" API.
		`object`	Pass through parameter from the Claims "Get Claims Data" API.
	`PeriodEndingDate`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidStateTaxAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidIncentiveAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ServicerNumber`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidTravelAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaymentAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ClaimBatchNumber`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ProductName`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaymentType`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidOtherAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidPartsHandlingAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidFederalTaxAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ClaimSequenceNumber`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ReceivedDate`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ClaimNumber`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidLaborAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`BrandName`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`ClaimStatusDescription`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`SerialNumber`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`EditedDate`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ClaimIdentifier`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidShippingAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidPartsAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidTotal`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`AuthorizationNumber`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`CallNumber`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidMileageAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ServicerName`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaymentMethod`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`ModelNumber`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaidFreightAmount`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`ClaimStatusCode`	`string`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaymentDate`	`integer`	Pass through parameter from the Claims "Get Claims Data" API.
	`PaymentTransactionNumber`	`string`	Pass through parameter from the Claims "Get Claims Data" API.

Error

On error, a JSON-formatted version of the Claims "Get Claims Data" API response will be returned.

js

Return Codes

In addition to the Standard Return Codes, there are ServiceDispatch Error codes.

Browser not supported