Jump to

• Request
• Response

Get Damage Claims

get

/damageClaims

Request

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : damageClaims

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attributeCurrency1: attributeCurrency1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency2: attributeCurrency2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeCurrency3: attributeCurrency3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeDate1: attributeDate1
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate10: attributeDate10
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate2: attributeDate2
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate3: attributeDate3
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate4: attributeDate4
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate5: attributeDate5
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate6: attributeDate6
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate7: attributeDate7
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate8: attributeDate8
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate9: attributeDate9
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeNumber1: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber10: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber2: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber3: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber4: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber5: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber6: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber7: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber8: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber9: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• claimGid: string
  The GID for damage claim.
• claimXid: string
  The XID for the claim.
• costs: costs
• damageCauseGid: string
  Code for cause of damage, user defined in power data.
• damageInformation: string
  Text description of damage.
• damageNatureGid: string
  Code for nature of damage, user defined in power data.
• damageNotifyPointGid: string
  Code for notification point for damage claim, user defined in power data.
• damageValue: damageValue
  Financial loss (value) of only the damaged goods; may be calculated by the system or specified by the user.
• documents: documents
• domainName: string
  Database domain where this data is stored.
• incidentDate: incidentDate
  Date incident occurred.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isDamageValueFixed: boolean
  If Y, the system will not calculate damage value and will keep the value entered by user.
• isSelfRecondition: boolean
  Indicates if the claim is self-reconditioning.
• isSizeOfLossFixed: boolean
  If Y, the system will not calculate size of loss and will keep the value entered by user.
• liablePartyContactGid: string
  Party responsible for causing damage.
• lineItems: lineItems
• links: array links
  Read Only: true
• notes: notes
• notificationDate: notificationDate
  Date of notification for the claim.
• notifyPartyContactGid: string
  Party that notified of the damage.
• refnums: refnums
• remarks: remarks
• reportDate: reportDate
  Date incident is reported.
• shipmentGid: string
  The GID of the shipment relating to the claim.
• sizeOfLoss: sizeOfLoss
  Financial loss for the entire claim including all losses incurred and credits; may be calculated by the system or specified by the user.
• statuses: statuses
• updateDate: updateDate
  Read Only: true

  update date
• userDefined1IconGid: string
  A user-defined icon for the claim.
• userDefined2IconGid: string
  A user-defined icon for the claim.
• userDefined3IconGid: string
  A user-defined icon for the claim.
• userDefined4IconGid: string
  A user-defined icon for the claim.
• userDefined5IconGid: string
  A user-defined icon for the claim.

{
    "properties":{
        "claimGid":{
            "description":"The GID for damage claim.",
            "type":"string"
        },
        "claimXid":{
            "description":"The XID for the claim.",
            "type":"string"
        },
        "damageInformation":{
            "description":"Text description of damage.",
            "type":"string"
        },
        "reportDate":{
            "description":"Date incident is reported.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "incidentDate":{
            "description":"Date incident occurred.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "damageNotifyPointGid":{
            "description":"Code for notification point for damage claim, user defined in power data.",
            "type":"string"
        },
        "damageCauseGid":{
            "description":"Code for cause of damage, user defined in power data.",
            "type":"string"
        },
        "damageNatureGid":{
            "description":"Code for nature of damage, user defined in power data.",
            "type":"string"
        },
        "damageValue":{
            "description":"Financial loss (value) of only the damaged goods; may be calculated by the system or specified by the user.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isDamageValueFixed":{
            "description":"If Y, the system will not calculate damage value and will keep the value entered by user.",
            "type":"boolean"
        },
        "sizeOfLoss":{
            "description":"Financial loss for the entire claim including all losses incurred and credits; may be calculated by the system or specified by the user.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isSizeOfLossFixed":{
            "description":"If Y, the system will not calculate size of loss and will keep the value entered by user.",
            "type":"boolean"
        },
        "shipmentGid":{
            "description":"The GID of the shipment relating to the claim.",
            "type":"string"
        },
        "userDefined1IconGid":{
            "description":"A user-defined icon for the claim.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"A user-defined icon for the claim.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"A user-defined icon for the claim.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"A user-defined icon for the claim.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"A user-defined icon for the claim.",
            "type":"string"
        },
        "notificationDate":{
            "description":"Date of notification for the claim.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "notifyPartyContactGid":{
            "description":"Party that notified of the damage.",
            "type":"string"
        },
        "liablePartyContactGid":{
            "description":"Party responsible for causing damage.",
            "type":"string"
        },
        "isSelfRecondition":{
            "description":"Indicates if the claim is self-reconditioning.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "lineItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.lineItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "notes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.notes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : costs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : damageValue

Financial loss (value) of only the damaged goods; may be calculated by the system or specified by the user.

Match All

Show Source

• object currencyType

{
    "description":"Financial loss (value) of only the damaged goods; may be calculated by the system or specified by the user.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : incidentDate

Date incident occurred.

Match All

Show Source

• object dateType

{
    "description":"Date incident occurred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : lineItems

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.lineItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : notes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.notes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : notificationDate

Date of notification for the claim.

Match All

Show Source

• object dateType

{
    "description":"Date of notification for the claim.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : reportDate

Date incident is reported.

Match All

Show Source

• object dateType

{
    "description":"Date incident is reported.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : sizeOfLoss

Financial loss for the entire claim including all losses incurred and credits; may be calculated by the system or specified by the user.

Match All

Show Source

• object currencyType

{
    "description":"Financial loss for the entire claim including all losses incurred and credits; may be calculated by the system or specified by the user.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.costs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.costs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.costs

Type: object

Show Source

• claimCostTypeGid: string
  Cost type of the claim cost. These values are a combination of PUBLIC types shippped with the system and types specified by the user. The cost type will indicate if this cost should be added or subtracted from the claim damage/loss value.
• cost: cost
  Value of the claim cost.
• costSeqNo: number (int64)
  Sequence number to keep costs unique.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• payeeContactGid: string
  The GID for the payee contact.
• payorContactGid: string
  The GID for the payor contact.

{
    "properties":{
        "costSeqNo":{
            "description":"Sequence number to keep costs unique.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"Value of the claim cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "claimCostTypeGid":{
            "description":"Cost type of the claim cost. These values are a combination of PUBLIC types shippped with the system and types specified by the user. The cost type will indicate if this cost should be added or subtracted from the claim damage/loss value.",
            "type":"string"
        },
        "payeeContactGid":{
            "description":"The GID for the payee contact.",
            "type":"string"
        },
        "payorContactGid":{
            "description":"The GID for the payor contact.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

Value of the claim cost.

Match All

Show Source

• object currencyType

{
    "description":"Value of the claim cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.documents

Type: object

Show Source

• contentManagementSystemGid: string
  No description.
• documentCmsId: string
  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description.
• documentTrackingNum: string
  No description.
• documentType: string
  No description.
• documentUrl: string
  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method GID.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContactGid: string
  Involved party contact GID.
• involvedPartyQualGid: string
  Involved party qualifier GID.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"Involved party qualifier GID.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"Involved party contact GID.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.lineItems

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.lineItems"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.lineItems

Type: object

Show Source

• costs: costs
• damagedFraction: number (double)
  Percentage of damage.
• damagedQuantity: number (int64)
  Quantity of damaged goods.
• damagedVolume: damagedVolume
  Volume of damaged portion.
• damagedWeight: damagedWeight
  Weight of damaged portion.
• damageTypeGid: string
  Type of damage; these values are user defined.
• declaredValue: declaredValue
  Declared value of the entire amount of goods represented on the line; the system will populate this when creating a claim from objects in GC3 if the declared value is available.
• domainName: string
  Database domain where this data is stored.
• lineItemSeqNo: number (int64)
  Sequence number to keep claim line items unique; actual line items should start with sequence number 1; 0 is reserved to attach costs that relate to the claim as a whole.
• links: array links
  Read Only: true
• newCylinderDiam: newCylinderDiam
  For cylindrical objects, the new diameter of the object.
• newQuantity: number (int64)
  New quantity after reconditioning activities.
• newVolume: newVolume
  New volume after reconditioning activities
• newWeight: newWeight
  New weight after reconditioning activities.
• orderReleaseLineGid: string
  The GID for the order release (if applicable) to which this claim line item applies.
• origCylCoreDiam: origCylCoreDiam
  For cylindrical objects, the hollow core diameter that should not be counted as damaged product in damage calculations.
• origCylinderDiam: origCylinderDiam
  For cylindrical objects, the original diameter prior to damage.
• originalQuantity: number (int64)
  Total or original quantity for the line item (undamaged + damaged goods).
• originalVolume: originalVolume
  Total or original volume for the line item (undamaged + damaged goods).
• originalWeight: originalWeight
  Total or original weight for the line item (undamaged + damaged goods).
• packageStatusGid: string
  Indicates the status of packages on the claim line item.
• pricePerUnit: pricePerUnit
  Sales value of goods per unit specified (for a $10/lb. value, this field represents the $10 part); used in the damage value calculation.
• pricePerUnitUomCode: string
  UOM for the per value for size of loss (for a $10/lb. value, this field represents the 'lb.' part); used in the damage value calculation.
• pricePerUnitUomType: string
  UOM type of the unit for which sales value is defined such as 'weight' or 'volume'; used in the damage value calculation.
• refnums: refnums
• removedCylDepth: removedCylDepth
  For cylindrical objects, the depth from the outer edge of the cylinder that was removed.
• removedFraction: number (double)
  Percentage of goods removed as part of reconditioning.
• removedQuantity: number (int64)
  Quantity of goods that were removed as part of reconditioning.
• removedVolume: removedVolume
  Volume of portion that was removed as part of reconditioning.
• removedWeight: removedWeight
  Weight of portion that was removed as part of reconditioning.
• serialNumber: string
  Serial number for the claim line item.
• sizeOfLoss: sizeOfLoss
  The calculated total of all claim line item costs for this claim line item.
• transportHandlingUnitGid: string
  Transport handling unit for the claim line item.

{
    "properties":{
        "lineItemSeqNo":{
            "description":"Sequence number to keep claim line items unique; actual line items should start with sequence number 1; 0 is reserved to attach costs that relate to the claim as a whole.",
            "type":"number",
            "format":"int64"
        },
        "orderReleaseLineGid":{
            "description":"The GID for the order release (if applicable) to which this claim line item applies.",
            "type":"string"
        },
        "serialNumber":{
            "description":"Serial number for the claim line item.",
            "type":"string"
        },
        "damageTypeGid":{
            "description":"Type of damage; these values are user defined.",
            "type":"string"
        },
        "damagedWeight":{
            "description":"Weight of damaged portion.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "damagedVolume":{
            "description":"Volume of damaged portion.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "damagedQuantity":{
            "description":"Quantity of damaged goods.",
            "type":"number",
            "format":"int64"
        },
        "damagedFraction":{
            "description":"Percentage of damage.",
            "type":"number",
            "format":"double"
        },
        "originalWeight":{
            "description":"Total or original weight for the line item (undamaged + damaged goods).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "originalVolume":{
            "description":"Total or original volume for the line item (undamaged + damaged goods).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "originalQuantity":{
            "description":"Total or original quantity for the line item (undamaged + damaged goods).",
            "type":"number",
            "format":"int64"
        },
        "newWeight":{
            "description":"New weight after reconditioning activities.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "newVolume":{
            "description":"New volume after reconditioning activities",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "newQuantity":{
            "description":"New quantity after reconditioning activities.",
            "type":"number",
            "format":"int64"
        },
        "removedWeight":{
            "description":"Weight of portion that was removed as part of reconditioning.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "removedVolume":{
            "description":"Volume of portion that was removed as part of reconditioning.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "removedQuantity":{
            "description":"Quantity of goods that were removed as part of reconditioning.",
            "type":"number",
            "format":"int64"
        },
        "origCylinderDiam":{
            "description":"For cylindrical objects, the original diameter prior to damage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "origCylCoreDiam":{
            "description":"For cylindrical objects, the hollow core diameter that should not be counted as damaged product in damage calculations.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "removedCylDepth":{
            "description":"For cylindrical objects, the depth from the outer edge of the cylinder that was removed.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "newCylinderDiam":{
            "description":"For cylindrical objects, the new diameter of the object.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "removedFraction":{
            "description":"Percentage of goods removed as part of reconditioning.",
            "type":"number",
            "format":"double"
        },
        "declaredValue":{
            "description":"Declared value of the entire amount of goods represented on the line; the system will populate this when creating a claim from objects in GC3 if the declared value is available.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packageStatusGid":{
            "description":"Indicates the status of packages on the claim line item.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"Transport handling unit for the claim line item.",
            "type":"string"
        },
        "pricePerUnit":{
            "description":"Sales value of goods per unit specified (for a $10/lb. value, this field represents the $10 part); used in the damage value calculation.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pricePerUnitUomType":{
            "description":"UOM type of the unit for which sales value is defined such as 'weight' or 'volume'; used in the damage value calculation.",
            "type":"string"
        },
        "pricePerUnitUomCode":{
            "description":"UOM for the per value for size of loss (for a $10/lb. value, this field represents the 'lb.' part); used in the damage value calculation.",
            "type":"string"
        },
        "sizeOfLoss":{
            "description":"The calculated total of all claim line item costs for this claim line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.lineItems.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/damageClaims.lineItems.costs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.lineItems.costs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : damagedVolume

Volume of damaged portion.

Match All

Show Source

• object amountType

{
    "description":"Volume of damaged portion.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : damagedWeight

Weight of damaged portion.

Match All

Show Source

• object amountType

{
    "description":"Weight of damaged portion.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : declaredValue

Declared value of the entire amount of goods represented on the line; the system will populate this when creating a claim from objects in GC3 if the declared value is available.

Match All

Show Source

• object currencyType

{
    "description":"Declared value of the entire amount of goods represented on the line; the system will populate this when creating a claim from objects in GC3 if the declared value is available.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : newCylinderDiam

For cylindrical objects, the new diameter of the object.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, the new diameter of the object.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : newVolume

New volume after reconditioning activities

Match All

Show Source

• object amountType

{
    "description":"New volume after reconditioning activities",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : newWeight

New weight after reconditioning activities.

Match All

Show Source

• object amountType

{
    "description":"New weight after reconditioning activities.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : origCylCoreDiam

For cylindrical objects, the hollow core diameter that should not be counted as damaged product in damage calculations.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, the hollow core diameter that should not be counted as damaged product in damage calculations.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : origCylinderDiam

For cylindrical objects, the original diameter prior to damage.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, the original diameter prior to damage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : originalVolume

Total or original volume for the line item (undamaged + damaged goods).

Match All

Show Source

• object amountType

{
    "description":"Total or original volume for the line item (undamaged + damaged goods).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : originalWeight

Total or original weight for the line item (undamaged + damaged goods).

Match All

Show Source

• object amountType

{
    "description":"Total or original weight for the line item (undamaged + damaged goods).",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : pricePerUnit

Sales value of goods per unit specified (for a $10/lb. value, this field represents the $10 part); used in the damage value calculation.

Match All

Show Source

• object currencyType

{
    "description":"Sales value of goods per unit specified (for a $10/lb. value, this field represents the $10 part); used in the damage value calculation.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/damageClaims.lineItems.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : removedCylDepth

For cylindrical objects, the depth from the outer edge of the cylinder that was removed.

Match All

Show Source

• object amountType

{
    "description":"For cylindrical objects, the depth from the outer edge of the cylinder that was removed.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : removedVolume

Volume of portion that was removed as part of reconditioning.

Match All

Show Source

• object amountType

{
    "description":"Volume of portion that was removed as part of reconditioning.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : removedWeight

Weight of portion that was removed as part of reconditioning.

Match All

Show Source

• object amountType

{
    "description":"Weight of portion that was removed as part of reconditioning.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : sizeOfLoss

The calculated total of all claim line item costs for this claim line item.

Match All

Show Source

• object currencyType

{
    "description":"The calculated total of all claim line item costs for this claim line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.lineItems.costs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.lineItems.costs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.lineItems.costs

Type: object

Show Source

• claimCostTypeGid: string
  The cost type such as DAMAGE or SALVAGE.
• cost: cost
  The cost amount.
• costSeqNo: number (int64)
  The sequence number to keep costs on claim lines unique.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• payeeContactGid: string
  The GID for the payee contact.
• payorContactGid: string
  The GID for the payer contact.

{
    "properties":{
        "costSeqNo":{
            "description":"The sequence number to keep costs on claim lines unique.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"The cost amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "claimCostTypeGid":{
            "description":"The cost type such as DAMAGE or SALVAGE.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "payeeContactGid":{
            "description":"The GID for the payee contact.",
            "type":"string"
        },
        "payorContactGid":{
            "description":"The GID for the payer contact.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cost

The cost amount.

Match All

Show Source

• object currencyType

{
    "description":"The cost amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.lineItems.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.lineItems.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.lineItems.refnums

Type: object

Show Source

• claimLiRefnumQualGid: string
  The qualifier for the reference number.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• refnumValue: string
  The value of reference number.

{
    "properties":{
        "claimLiRefnumQualGid":{
            "description":"The qualifier for the reference number.",
            "type":"string"
        },
        "refnumValue":{
            "description":"The value of reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.notes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.notes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.notes

Type: object

Show Source

• claimNoteSeqNo: number (int64)
  Sequence number to keep notes unique.
• domainName: string
  Database domain where this data is stored.
• isSystemGenerated: boolean
  Indicates if this note was added to the claim by the system.
• links: array links
  Read Only: true
• note: string
  The note text.
• timestamp: timestamp
  Timestamp for the note.

{
    "properties":{
        "claimNoteSeqNo":{
            "description":"Sequence number to keep notes unique.",
            "type":"number",
            "format":"int64"
        },
        "timestamp":{
            "description":"Timestamp for the note.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "note":{
            "description":"The note text.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Indicates if this note was added to the claim by the system.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : timestamp

Timestamp for the note.

Match All

Show Source

• object dateTimeType

{
    "description":"Timestamp for the note.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.refnums

Type: object

Show Source

• claimRefnumQualGid: string
  Qualifier for claim reference number.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• refnumValue: string
  Value of claim reference number.

{
    "properties":{
        "claimRefnumQualGid":{
            "description":"Qualifier for claim reference number.",
            "type":"string"
        },
        "refnumValue":{
            "description":"Value of claim reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier.
• remarkSeqNo: number (int64)
  The sequence number for remarks to allow multiple remarks.
• remarkText: string
  The text of the remark.

{
    "properties":{
        "remarkSeqNo":{
            "description":"The sequence number for remarks to allow multiple remarks.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remark.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object damageClaims.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/damageClaims.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : damageClaims.statuses

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• statusTypeGid: string
  Status type for claim status.
• statusValueGid: string
  Value of status type.

{
    "properties":{
        "statusTypeGid":{
            "description":"Status type for claim status.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"Value of status type.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top