Receive recovery claim from external system
Receives recovery claim data from external warranty systems (currently Trane). A recovery claim occurs when a supplier (Trane) identifies that METUS supplied a defective part and needs to be debited for repair costs. This endpoint validates the claim, maps distributor/owner IDs based on the source system, and queues the claim for background processing in Salesforce. The endpoint returns 202 Accepted immediately after validation, and the actual Salesforce integration happens asynchronously.
path Parameters
sourcestring · enum · requiredThe source system identifier. Determines how distributor/owner IDs are resolved. Currently only 'trane' is supported.
Enum values:trane
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
recoveryClaimNumberstring · requiredUnique identifier for the recovery claim in the source system.
warrantyClaimNumberstring · requiredReference to the original warranty claim that this recovery claim is associated with.
skustring · requiredSKU/model number of the unit that failed.
serialNumberstring · requiredSerial number of the unit that failed.
debitAmountinteger · min: 0 · requiredTotal amount to be debited for this recovery claim in cents (e.g., 45000 = $450.00). Cannot be negative. Follows the Stripe pattern for currency representation.
submittedDatestring · date-timeDate when the recovery claim was submitted (RFC3339 timestamp).
approvedOnDatestring · date-timeDate when the recovery claim was approved (RFC3339 timestamp).
accountNumberstringAccount number in the source system.
dealerIdstringDealer/contractor identifier.
dealerStatestringState where the dealer is located.
dealerCitystringCity where the dealer is located.
installDatestring · date-timeDate when the unit was installed (RFC3339 timestamp).
failureDatestring · date-timeDate when the unit failure occurred (RFC3339 timestamp).
repairDatestring · date-timeDate when the repair was completed (RFC3339 timestamp).
faultLocationstringDescription of where the fault occurred in the unit.
installedPartsobject[]Parts that were installed during the warranty repair. At least one installedParts or recoverableParts entry is required.
recoverablePartsobject[]Parts for which we can charge back the supplier for warranty costs. At least one installedParts or recoverableParts entry is required.
originalSourceIdstringSource system identifier used to map to internal distributor/owner IDs. For Trane: 'CS' = Control Systems, 'GP' = Gulfport, 'DS' or other = Default/Distribution.
Responses
Recovery claim accepted for processing. The claim has passed initial validation and has been queued for background processing. The actual Salesforce integration will happen asynchronously.
statusintegerdataobject
Send debit confirmation to Trane
Sends debit memo confirmation to Trane to close out recovery claims. After METUS has issued a debit memo for an approved recovery claim, Cadence (or Salesforce workflows) calls this endpoint with the debit details. The endpoint validates the payload and forwards it to Trane's system to complete the recovery claim lifecycle. This is the final step in the recovery claim process, notifying Trane that we've officially debited them for the warranty recovery costs.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
recoveryClaimNumberstring · requiredThe recovery claim number that this debit memo is associated with. Must match a previously submitted recovery claim.
debitMemoNumberstring · requiredThe debit memo number issued by METUS for this recovery claim.
debitMemoDatestring · date-time · requiredThe date when the debit memo was issued (RFC3339 timestamp).
Responses
Debit confirmation successfully sent to Trane.
statusintegerdataobject