InvoiceWarrantyDetail

The InvoiceWarrantyDetail object represents the model associated with an extended warranty in an invoice.
Tags:
Categories:

POST /invoicing/invoice/warrantydetail/add

This endpoint links models to an extended warranty on an open invoice. An existing open invoice with an existing extended warranty is required to use this endpoint.

Invoice Conditions

The following Invoice conditions must be satisfied in order to add any InvoiceWarrantyDetail record.

Condition Value
Invoice Status Invoice Status must be Open or Committed.
WarrantyDateStamp The extended warranty must exist in the invoice with the same DateStamp as the invoice.
WarrantyLineTimeStamp The extended warranty must exist in the invoice with the same LineTimeStamp as the invoice

Payload

Required Fields

The following fields are the absolute minimum fields that are required in the payload.

Field Type Value
InvoiceCode string Must be a valid invoice code.
WarrantyDateStamp string Format: YYYY-MM-DD
The date stamp of the warranty associated with this warranty detail.
WarrantyLineStamp string Format: hh:mm:ss.sssZ
The time stamp of the warranty associated with this warranty detail.

Optional Fields

These fields are optional and not required in the payload.

Field Type Value
model string Must be a valid model code.
serial string The model serial number. (No validation for this field.)
OriginalSellingPrice string If different from InvoiceModel selling price, then a warning is provided in the response.
invoiceModelInvoiceCode string Invoice code containing the model.
invoiceModelDateStamp string Format: YYYY-MM-DD
Date stamp of the model in the InvoiceModel table.
invoiceModelLineTimeStamp string Format: hh:mm:ss.sssZ
Time stamp of the model in the InvoiceModel table.

Sample: Linking a Model to an Extended Warranty

POST /invoicing/invoice/warrantydetail/add
{
"invoiceCode": "3724659",
     "WarrantyDateStamp": "2025-12-05",
     "WarrantyLineTimeStamp": "14:19:50:527",
     "model": "41025",     
     "serial": "123",
     "originalSellingPrice": 196.16
}
{
    "Success": true,
    "Warning": false,
    "HttpStatusCode": 201,
    "GeneralMessage": null,
    "ExceptionMessage": null,
    "Keys": [
        {
            "Table": "InvoiceWarrantyDetail",
            "Keys": [
                {
                    "Key": "ID",
                    "Fields": [
                        {
                            "FieldName": "ID",
                            "FieldValue": 312591
                        }
                    ]
                }
            ]
        }
    ],
    "Messages": [],
    "Warnings": []
}
{
    "Success": false,
    "Warning": false,
    "HttpStatusCode": 422,
    "GeneralMessage": "One or more of the fields has an invalid or missing value.",
    "ExceptionMessage": null,
    "Keys": [],
    "Messages": [
        {
            "Code": "INV-0120010",
            "Message": "InvoiceModel '[41025]' must be on invoice."
        }
    ],
    "Warnings": []
}