/
SubmitClaim RESTified API
Document toolboxDocument toolbox

SubmitClaim RESTified API

Owned by Andrew Hill (Deactivated)
Last updated: Feb 06, 2025 by Jason Andrew

5.4.0

A pass-through API to Dispatch (when configured) which allows the Dispatch's "Submit Claim" API to be called.        

On this page:

Related pages:

Resource URL Summary

Pass Through Call to Dispatch's "Submit Claim" API

POST /up/v5/claims

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

Pass Through Call to Dispatch's "Submit Claim" API

This RESTified API will perform a pass-through call to the Dispatch sub-system's "Submit Claim" API (when configured).

URL

POST /up/v5/claims

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 Dispatch "Submit Claim" APi.

SubmitClaim Object Format

{
    "Claims": [
        {
            "RequiredParts": [
                {
                    "ProdNum": "PARTNUM1",
                    "Qty": 1,
                    "ProdAttrs": {
                        "Desc": "PART DESC 1",
                        "SchematicLocation": "SL",
                        "InvoiceNumber": "INVNUMBER1",
                        "UnitCost": 12.15,
                        "Returned": "N",
                        "DistributorNumber": "PRTDIST1",
                        "FaultCode": "FC1",
                        "JobCode": "JC1"
                    }
                },
				// ...
            ],
            "Asset": {
                "MfgId": "DEMO",
                "Mfg": "SONY",
                "Model": "NHT915AUC",
                "SerialNum": "SERIAL",
                "PurchaseDate": 20101001
            },
            "Booking": {
                "ServiceOrgInfo": {
                    "ServiceOrg": "11154",
                    "LocationId": "",
                    "Name": "LOCNAME"
                }
            },
            "Location": {
                "Type": "",
                "Address": {
                    "AddrLine1": "SOME STREET",
                    "AddrLine2": "APT B",
                    "City": "COSTA MESA",
                    "Region": "CA",
                    "Country": "USA",
                    "PostalCode": "92626"
                },
                "Contacts": [
                    {
                        "FirstName": "JANE",
                        "LastName": "FLOUNDER",
                        "ContactPoint": [
                            {
                                "Mode": "Phone",
                                "Value": 7145551000
                            },
                            {
                                "Mode": "Email",
                                "Value": "JANEF@HOTMAIL.COM"
                            }
                        ]
                    }
                ]
            },
            "ClaimNumber": "XYZ1SD422F_",
            "DistributorNumber": "DISTNBR",
            "DemographicCode": "",
            "EiaDefectOrComplaintCode": "DFC",
            "DefectOrComplaintDescription": "DEFECT DESCRIPTION",
            "ServicePerformedDescription": "SERVICE PERFORMANCE DESCRIPTION",
            "EiaRepairCode1": "RC1",
            "EiaRepairCode2": "RC2",
            "EiaRepairCode3": "RC3",
            "EiaRepairCode4": "RC4",
            "LaborSchematicLocation1": "SL1",
            "LaborSchematicLocation2": "SL2",
            "LaborSchematicLocation3": "SL3",
            "LaborSchematicLocation4": "SL4",
            "LaborSchematicLocation5": "SL5",
            "LaborSchematicLocation6": "SL6",
            "ReworkNumberOrPolicy": "RWNUMB",
            "WarrantyType": 1,
            "SoftwareVersion": "V1",
            "RepairCategory": "RC",
            "StockRepairFlag": "F",
            "Type": "CT",
            "ExistingClaimBatchNumber": 0,
            "ExistingClaimSequenceNumber": 0,
            "ProductSalesReceipt": "Y",
            "GlAccountNumber": "GLACCTNB",
            "ValidationFlag": "Y",
            "DebitNumber": "DEBIT",
            "KeypunchOperator": "KEYP",
            "DateReceived": 20181002,
            "DateRequested": 20181003,
            "DateStarted": 20181004,
            "TimeStarted": 1100,
            "DateCompleted": 20181005,
            "TimeCompleted": 1611,
            "TotalRepairMinutes": 23,
            "ServiceHours": 2,
            "TravelHours": 3,
            "TravelTime": 30,
            "TripCount": 2,
            "CallNumber": "CALLNBR",
            "DealerNumber": "DLRNBR",
            "DealerName": "SOME DEALER",
            "DealerAddress": "ANOTHER STREET",
            "DealerCity": "FOUNTAIN VALLEY",
            "DealerState": "CA",
            "DealerZipCode": "92728",
            "LaborAmount": 50.75,
            "PartsAmount": 125.25,
            "OtherAmount": 45.33,
            "TaxFederalAmount": 15.23,
            "TaxStateAmount": 7.27,
            "ShippingChargeAmount": 11.17,
            "CodOrFreightAmount": 12.93,
            "TravelChargeAmount": 13.24,
            "MileageAmount": 14.18,
            "TravelMiles": 15,
            "StickerType": "S",
            "StickerNumber": "STICKNUMB",
            "ServiceContractNumber": "SVCCONTRACTNBR",
            "DistributorTransmittalNumber": "DISTTRANS",
            "Refurbished": "Y",
            "Reference": "REFERENCER",
            "PurchasedOverseasFlag": "N",
            "AuthorizationNumber": "AUTHORIZATIONNUMBER",
            "PartMarkupPercentage": 15,
            "MicrowaveBefore": "MICBEF",
            "MicrowaveAfter": "MICAFT",
            "SpecialCode": "SPECCODE",
            "DefectivePartNumber": "DEFPARTNUMBR",
            "DefectivePartSerialNumber": "DEFSERIALNBR",
            "SpecialCustomerNote": "SPECIAL CUSTOMER NOTE",
            "ServiceSignedBy": "SERVICE SIGNED BY",
            "AlternateStoreNumber": "ALTS",
            "ProductSKU": "PRODUCTSKU",
            "WarrantySKU": "WARRANTYSKU",
            "ServiceBusinessUnit": "SBU",
            "PspSourceType": "PSPSOURCET",
            "FoodSpoilageCode": "FOODSC",
            "TpaContractNumber": "TPACONTRACTXXXXTPACONTRAC",
            "TpaClaimNumber": "TPACLAIMNBR",
            "TpaContractError": "CE",
            "TpaProductPurchaseDate": 20181010,
            "TpaLaborWarrantyDays": 365,
            "TpaPartsWarrantyDays": 365,
            "TpaSubProgram": "P",
            "TpaRuleSet": "RS",
            "TpaEquipmentRetailPrice": 15.75,
            "TpaProductCode": "TPAPRODTCD",
            "TpaResubmittedFlag": "Y",
            "TpaResubmittedClaimNumber": "RSBCLAIMNBR",
            "TpaClaimType": "TCT",
            "TpaContractStartDate": 20181011,
            "TpaContractEndDate": 20181012,
            "TpaProductDescription": "TPA PRODUCT DESCRIPTION",
            "TpaContractSKUDescription": "TPA CONTRACT SKU DESCRIPTION",
            "TpaProgramType": "TPAPROGRAMTYP",
            "TpaRemarkId": "TPAREMARKID"
        }
    ]
}

SubmitClaim Object Properties

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch "Submit Claim" API response will be returned.

SubmitClaim Response Object Format

{
    "Success": true,
    "Code": 0,
    "Message": "OK",
    "Payload": {
        "TotalClaimsReceived": 1,
        "TransactionId": "2021040713411526232528DMWSTEST02",
        "ResponseCode": "OK",
        "TotalClaimsProcessedSuccessfully": 1,
        "Claims": [
            {
                "ClaimTransactionId": "100_32362",
                "ClaimResponseCode": "OK",
                "ServiceCenterNumber": "11154",
                "ClaimStatusDescription": "Incomplete",
                "ManufacturerName": "DEMO",
                "ServiceCenterLocationCode": "LOCNAME",
                "Type": "CT",
                "ClaimBatchNumber": 300001,
                "ClaimSequenceNumber": 109,
                "ClaimStatusCode": "I",
                "ClaimNumber": "XYZ1SD422F_01",
                "Errors": [
                    {
                        "ErrorDescription": "Invalid Dispatch#",
                        "PartNumber": ""
                    }
                ]
            }
        ],
        "TotalClaimsNotProcessedSuccessfully": 0
    }
}

SubmitClaim Response Object Properties

PropertyTypeDescriptionDispatch Field Mapping
SuccessbooleanPass through parameter from the Dispatch "Submit Claim" API.Success  
CodeintegerPass through parameter from the Dispatch "Submit Claim" API.Code
MessagestringPass through parameter from the Dispatch "Submit Claim" API.Message
PayloadobjectPass through parameter from the Dispatch "Submit Claim" API.Payload

TotalClaimsReceivedintegerPass through parameter from the Dispatch "Submit Claim" API.TotalClaimsReceived

TransactionIdstringPass through parameter from the Dispatch "Submit Claim" API.TransactionId

ResponseCodestringPass through parameter from the Dispatch "Submit Claim" API.ResponseCode

TotalClaimsProcessedSuccessfullyintegerPass through parameter from the Dispatch "Submit Claim" API.TotalClaimsProcessedSuccessfully

ClaimsarrayPass through parameter from the Dispatch "Submit Claim" API.Claims


ClaimTransactionIdstringPass through parameter from the Dispatch "Submit Claim" API.ClaimTransactionId


ClaimResponseCodestringPass through parameter from the Dispatch "Submit Claim" API.ClaimResponseCode


ServiceCenterNumberstringPass through parameter from the Dispatch "Submit Claim" API.ServiceCenterNumber


ClaimStatusDescriptionstringPass through parameter from the Dispatch "Submit Claim" API.ClaimStatusDescription


ManufacturerNamestringPass through parameter from the Dispatch "Submit Claim" API.ManufacturerName


ServiceCenterLocationCodestringPass through parameter from the Dispatch "Submit Claim" API.ServiceCenterLocationCode


TypestringPass through parameter from the Dispatch "Submit Claim" API.Type


ClaimBatchNumberintegerPass through parameter from the Dispatch "Submit Claim" API.ClaimBatchNumber


ClaimSequenceNumberintegerPass through parameter from the Dispatch "Submit Claim" API.ClaimSequenceNumber


ClaimStatusCodestringPass through parameter from the Dispatch "Submit Claim" API.ClaimStatusCode


ClaimNumberstringPass through parameter from the Dispatch "Submit Claim" API.ClaimNumber


ErrorsarrayPass through parameter from the Dispatch "Submit Claim" API.Errors



ErrorDescriptionstringPass through parameter from the Dispatch "Submit Claim" API.ErrorDescription



PartNumberstringPass through parameter from the Dispatch "Submit Claim" API.PartNumber

TotalClaimsNotProcessedSuccessfullyintegerPass through parameter from the Dispatch "Submit Claim" API.TotalClaimsNotProcessedSuccessfully

Error

On error, a JSON-formatted version of the Dispatch "Submit Claim" API response will be returned.

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "message": "Dispatch Error Code"
        }
    }
}


Return Codes

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

Related content

GetClaimsData RESTified API
GetClaimsData RESTified API
ServiceBroker 5
More like this
UpdateRequestForAuthorizationStatus RESTified API
UpdateRequestForAuthorizationStatus RESTified API
ServiceBroker 5
More like this
GetRequestForAuthorization RESTified API
GetRequestForAuthorization RESTified API
ServiceBroker 5
Read with this
CreateOrUpdateRequestForAuthorization RESTified API
CreateOrUpdateRequestForAuthorization RESTified API
ServiceBroker 5
More like this
Claims RESTified APIs
Claims RESTified APIs
ServiceBroker 5
Read with this
_Claims Provider Object Format
_Claims Provider Object Format
ServiceBroker 5
More like this