Jump to

• Request
• Response

Create an Informational Cost

post

/shipmentNoSSUs/{shipmentGid}/informationalCosts

Request

Path Parameters

• shipmentGid(required): string
  Resource ID

Supported Media Types

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

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts"
    }
}

Nested Schema : schema

Type: object

Show Source

• cost: cost
  The cost amount.
• detail: string
  Generated text that details the calculation of the cost.
• details: details
• domainName: string
  Database domain where this data is stored.
• infCostType: string
  Type of informational cost. O = Original, D = Display
• links: array links
  Read Only: true
• remarks: remarks
• shipmentInfCostQualGid: string
  The shipment informational cost qualifier GID for this cost.
• shipmentInfCostSeqno: number (int64)
  The shipment informational cost sequence number.

{
    "properties":{
        "shipmentInfCostSeqno":{
            "description":"The shipment informational cost sequence number.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"The cost amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "detail":{
            "description":"Generated text that details the calculation of the cost.",
            "type":"string"
        },
        "infCostType":{
            "description":"Type of informational cost.  O = Original, D = Display",
            "type":"string"
        },
        "shipmentInfCostQualGid":{
            "description":"The shipment informational cost qualifier GID for this cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : details

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
            }
        },
        "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 : remarks

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "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 : items

Type: array

Show Source

• Array of: object shipmentNoSSUs.informationalCosts.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
    }
}

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 : shipmentNoSSUs.informationalCosts.details

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.
• accessorialCostGid: string
  The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.
• adjustmentReasonGid: string
  An adjustment reason code GID that categorizes the cost element as an adjustment and the type.
• cost: cost
  The cost value. Examples are base and accessorial.
• costType: string
  The cost type for this shipment cost record.
• detailSeqno: number (int64)
  The detail sequence number (key).
• domainName: string
  Database domain where this data is stored.
• generalLedgerGid: string
  The general ledger GID associated with the cost element and sent to financial systems.
• isCostFixed: boolean
  A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.
• links: array links
  Read Only: true
• processAsFlowThru: boolean
  A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.
• rateGeoCostGroupGid: string
  The rate detail cost group identifier that was used in calculating this cost value.
• rateGeoCostSeq: number (int64)
  The rate detail cost sequence that was used in calculating this cost value.
• specialServiceGid: string
  The special service identifier associated to the cost record if it was calculated from a special service.

{
    "properties":{
        "detailSeqno":{
            "description":"The detail sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "costType":{
            "description":"The cost type for this shipment cost record.",
            "type":"string"
        },
        "cost":{
            "description":"The cost value. Examples are base and accessorial.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "accessorialCostGid":{
            "description":"The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "rateGeoCostGroupGid":{
            "description":"The rate detail cost group identifier that was used in calculating this cost value.",
            "type":"string"
        },
        "rateGeoCostSeq":{
            "description":"The rate detail cost sequence that was used in calculating this cost value.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service identifier associated to the cost record if it was calculated from a special service.",
            "type":"string"
        },
        "isCostFixed":{
            "description":"A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"An adjustment reason code GID  that categorizes the cost element as an adjustment and the type.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"The general ledger GID associated with the cost element and sent to financial systems.",
            "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

The cost value. Examples are base and accessorial.

Match All

Show Source

• object currencyType

{
    "description":"The cost value. Examples are base and accessorial.",
    "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 shipmentNoSSUs.informationalCosts.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.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 : shipmentNoSSUs.informationalCosts.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 identifier defining the remark code.
• remarkSeq: number (int64)
  The remark sequence number (key).
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSeq":{
            "description":"The remark sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "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
}

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• cost: cost
  The cost amount.
• detail: string
  Generated text that details the calculation of the cost.
• details: details
• domainName: string
  Database domain where this data is stored.
• infCostType: string
  Type of informational cost. O = Original, D = Display
• links: array links
  Read Only: true
• remarks: remarks
• shipmentInfCostQualGid: string
  The shipment informational cost qualifier GID for this cost.
• shipmentInfCostSeqno: number (int64)
  The shipment informational cost sequence number.

{
    "properties":{
        "shipmentInfCostSeqno":{
            "description":"The shipment informational cost sequence number.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"The cost amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "detail":{
            "description":"Generated text that details the calculation of the cost.",
            "type":"string"
        },
        "infCostType":{
            "description":"Type of informational cost.  O = Original, D = Display",
            "type":"string"
        },
        "shipmentInfCostQualGid":{
            "description":"The shipment informational cost qualifier GID for this cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : details

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
            }
        },
        "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 : remarks

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "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 : items

Type: array

Show Source

• Array of: object shipmentNoSSUs.informationalCosts.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
    }
}

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 : shipmentNoSSUs.informationalCosts.details

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.
• accessorialCostGid: string
  The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.
• adjustmentReasonGid: string
  An adjustment reason code GID that categorizes the cost element as an adjustment and the type.
• cost: cost
  The cost value. Examples are base and accessorial.
• costType: string
  The cost type for this shipment cost record.
• detailSeqno: number (int64)
  The detail sequence number (key).
• domainName: string
  Database domain where this data is stored.
• generalLedgerGid: string
  The general ledger GID associated with the cost element and sent to financial systems.
• isCostFixed: boolean
  A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.
• links: array links
  Read Only: true
• processAsFlowThru: boolean
  A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.
• rateGeoCostGroupGid: string
  The rate detail cost group identifier that was used in calculating this cost value.
• rateGeoCostSeq: number (int64)
  The rate detail cost sequence that was used in calculating this cost value.
• specialServiceGid: string
  The special service identifier associated to the cost record if it was calculated from a special service.

{
    "properties":{
        "detailSeqno":{
            "description":"The detail sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "costType":{
            "description":"The cost type for this shipment cost record.",
            "type":"string"
        },
        "cost":{
            "description":"The cost value. Examples are base and accessorial.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "accessorialCostGid":{
            "description":"The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "rateGeoCostGroupGid":{
            "description":"The rate detail cost group identifier that was used in calculating this cost value.",
            "type":"string"
        },
        "rateGeoCostSeq":{
            "description":"The rate detail cost sequence that was used in calculating this cost value.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service identifier associated to the cost record if it was calculated from a special service.",
            "type":"string"
        },
        "isCostFixed":{
            "description":"A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"An adjustment reason code GID  that categorizes the cost element as an adjustment and the type.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"The general ledger GID associated with the cost element and sent to financial systems.",
            "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

The cost value. Examples are base and accessorial.

Match All

Show Source

• object currencyType

{
    "description":"The cost value. Examples are base and accessorial.",
    "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 shipmentNoSSUs.informationalCosts.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.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 : shipmentNoSSUs.informationalCosts.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 identifier defining the remark code.
• remarkSeq: number (int64)
  The remark sequence number (key).
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSeq":{
            "description":"The remark sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "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

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• cost: cost
  The cost amount.
• detail: string
  Generated text that details the calculation of the cost.
• details: details
• domainName: string
  Database domain where this data is stored.
• infCostType: string
  Type of informational cost. O = Original, D = Display
• links: array links
  Read Only: true
• remarks: remarks
• shipmentInfCostQualGid: string
  The shipment informational cost qualifier GID for this cost.
• shipmentInfCostSeqno: number (int64)
  The shipment informational cost sequence number.

{
    "properties":{
        "shipmentInfCostSeqno":{
            "description":"The shipment informational cost sequence number.",
            "type":"number",
            "format":"int64"
        },
        "cost":{
            "description":"The cost amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "detail":{
            "description":"Generated text that details the calculation of the cost.",
            "type":"string"
        },
        "infCostType":{
            "description":"Type of informational cost.  O = Original, D = Display",
            "type":"string"
        },
        "shipmentInfCostQualGid":{
            "description":"The shipment informational cost qualifier GID for this cost.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "details":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "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 : details

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
            }
        },
        "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 : remarks

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "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 : items

Type: array

Show Source

• Array of: object shipmentNoSSUs.informationalCosts.details

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.details"
    }
}

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 : shipmentNoSSUs.informationalCosts.details

Type: object

Show Source

• accessorialCodeGid: string
  The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.
• accessorialCostGid: string
  The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.
• adjustmentReasonGid: string
  An adjustment reason code GID that categorizes the cost element as an adjustment and the type.
• cost: cost
  The cost value. Examples are base and accessorial.
• costType: string
  The cost type for this shipment cost record.
• detailSeqno: number (int64)
  The detail sequence number (key).
• domainName: string
  Database domain where this data is stored.
• generalLedgerGid: string
  The general ledger GID associated with the cost element and sent to financial systems.
• isCostFixed: boolean
  A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.
• links: array links
  Read Only: true
• processAsFlowThru: boolean
  A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.
• rateGeoCostGroupGid: string
  The rate detail cost group identifier that was used in calculating this cost value.
• rateGeoCostSeq: number (int64)
  The rate detail cost sequence that was used in calculating this cost value.
• specialServiceGid: string
  The special service identifier associated to the cost record if it was calculated from a special service.

{
    "properties":{
        "detailSeqno":{
            "description":"The detail sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "costType":{
            "description":"The cost type for this shipment cost record.",
            "type":"string"
        },
        "cost":{
            "description":"The cost value. Examples are base and accessorial.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"The accessorial code identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "accessorialCostGid":{
            "description":"The accessorial cost identifier associated to the cost record if it was calculated from the rate accessorial.",
            "type":"string"
        },
        "rateGeoCostGroupGid":{
            "description":"The rate detail cost group identifier that was used in calculating this cost value.",
            "type":"string"
        },
        "rateGeoCostSeq":{
            "description":"The rate detail cost sequence that was used in calculating this cost value.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service identifier associated to the cost record if it was calculated from a special service.",
            "type":"string"
        },
        "isCostFixed":{
            "description":"A Y/N indicator defining the cost element as permanent and not to recalculate it based on shipment modifications.",
            "type":"boolean"
        },
        "processAsFlowThru":{
            "description":"A Y/N indicator defining the cost element as a flow through cost when sent to the financial systems.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"An adjustment reason code GID  that categorizes the cost element as an adjustment and the type.",
            "type":"string"
        },
        "generalLedgerGid":{
            "description":"The general ledger GID associated with the cost element and sent to financial systems.",
            "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

The cost value. Examples are base and accessorial.

Match All

Show Source

• object currencyType

{
    "description":"The cost value. Examples are base and accessorial.",
    "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 shipmentNoSSUs.informationalCosts.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.informationalCosts.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 : shipmentNoSSUs.informationalCosts.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 identifier defining the remark code.
• remarkSeq: number (int64)
  The remark sequence number (key).
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSeq":{
            "description":"The remark sequence number (key).",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier identifier defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "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