Create a Line Item
post
/damageClaims/{claimGid}/lineItems
Request
Path Parameters
-
claimGid(required): string
Resource ID
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Nested Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : costs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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
Nested Schema : newCylinderDiam
For cylindrical objects, the new diameter of the object.
Match All
Show Source
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
Nested Schema : origCylinderDiam
For cylindrical objects, the original diameter prior to damage.
Match All
Show Source
Nested Schema : originalVolume
Total or original volume for the line item (undamaged + damaged goods).
Match All
Show Source
Nested Schema : originalWeight
Total or original weight for the line item (undamaged + damaged goods).
Match All
Show Source
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
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : removedCylDepth
For cylindrical objects, the depth from the outer edge of the cylinder that was removed.
Match All
Show Source
Nested Schema : removedVolume
Volume of portion that was removed as part of reconditioning.
Match All
Show Source
Nested Schema : removedWeight
Weight of portion that was removed as part of reconditioning.
Match All
Show Source
Nested Schema : sizeOfLoss
The calculated total of all claim line item costs for this claim line item.
Match All
Show Source
Nested Schema : damageClaims.lineItems.costs
Type:
Show Source
object
-
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.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : damageClaims.lineItems.refnums
Type:
Show Source
object
-
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.
Root Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : costs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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
Nested Schema : newCylinderDiam
For cylindrical objects, the new diameter of the object.
Match All
Show Source
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
Nested Schema : origCylinderDiam
For cylindrical objects, the original diameter prior to damage.
Match All
Show Source
Nested Schema : originalVolume
Total or original volume for the line item (undamaged + damaged goods).
Match All
Show Source
Nested Schema : originalWeight
Total or original weight for the line item (undamaged + damaged goods).
Match All
Show Source
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
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : removedCylDepth
For cylindrical objects, the depth from the outer edge of the cylinder that was removed.
Match All
Show Source
Nested Schema : removedVolume
Volume of portion that was removed as part of reconditioning.
Match All
Show Source
Nested Schema : removedWeight
Weight of portion that was removed as part of reconditioning.
Match All
Show Source
Nested Schema : sizeOfLoss
The calculated total of all claim line item costs for this claim line item.
Match All
Show Source
Nested Schema : damageClaims.lineItems.costs
Type:
Show Source
object
-
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.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : damageClaims.lineItems.refnums
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : costs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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
Nested Schema : newCylinderDiam
For cylindrical objects, the new diameter of the object.
Match All
Show Source
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
Nested Schema : origCylinderDiam
For cylindrical objects, the original diameter prior to damage.
Match All
Show Source
Nested Schema : originalVolume
Total or original volume for the line item (undamaged + damaged goods).
Match All
Show Source
Nested Schema : originalWeight
Total or original weight for the line item (undamaged + damaged goods).
Match All
Show Source
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
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : removedCylDepth
For cylindrical objects, the depth from the outer edge of the cylinder that was removed.
Match All
Show Source
Nested Schema : removedVolume
Volume of portion that was removed as part of reconditioning.
Match All
Show Source
Nested Schema : removedWeight
Weight of portion that was removed as part of reconditioning.
Match All
Show Source
Nested Schema : sizeOfLoss
The calculated total of all claim line item costs for this claim line item.
Match All
Show Source
Nested Schema : damageClaims.lineItems.costs
Type:
Show Source
object
-
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.
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : damageClaims.lineItems.refnums
Type:
Show Source
object
-
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.