Jump to

• Request
• Response

Get Tip Inventories

get

/tipInventories

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/tipInventories"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object tipInventories

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : tipInventories

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)
• 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
• attributeDate11: attributeDate11
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate12: attributeDate12
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate13: attributeDate13
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate14: attributeDate14
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate15: attributeDate15
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate16: attributeDate16
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate17: attributeDate17
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate18: attributeDate18
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
• attributeDate19: attributeDate19
  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
• attributeDate20: attributeDate20
  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
• attributeNumber11: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber12: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber13: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber14: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber15: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber16: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber17: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber18: number (double)
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
• attributeNumber19: 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
• attributeNumber20: 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
• balanceQuantity: number (double)
  Balance Quantity
• balanceQuantityUomCode: string
  Balance Quantity Unit of Measurement
• classificationCode: string
  Classification Code
• countryOfOrigin: string
  The country of origin of the goods.
• customStatus: string
  Custom Status
• dischargePeriodEndDate: dischargePeriodEndDate
  Date upto which this inventory is valid in its Trade Incentive Program
• domainName: string
  No description.
• entryDate: entryDate
  Entry Date
• gtmDeclarationTypeGid: string
  GTM Declaration Type GID
• gtmDeclSTypeGid: string
  GTM Declaration Sub Type
• gtmProcedureGid: string
  Procedure
• gtmProdClassTypeGid: string
  Product Class Type GID
• gtmTipInventoryGid: string
  Trade Incentive Program Inventroy GID
• gtmTipInventoryXid: string
  Trade Incentive Program Inventroy XID
• gtmTipZoneStatusGid: string
  Trade Incentive Program Zone Status GID
• gtmTradeIncentivePgmGid: string
  Trade Incentive Program
• insertDate: insertDate
  Read Only: true

  insert date
• inventoryOrganizationGid: string
  Inventory Organization
• inventoryStatus: string
  Inventory Status - Open (no withdrawl from the inventory has happened so far), Partially Reconciled (some amount of inventory has been withdrawn), Closed (inventory has been fully reconciled)
• itemGid: string
  Item
• links: array links
  Read Only: true
• locationGid: string
  Location of the inventory
• movements: movements
• quantity: number (double)
  Quantity
• quantityUomCode: string
  Quantity Unit of Measurement
• referenceNumber: string
  Refrence Number
• referenceType: string
  Reference Type
• refnums: refnums
• reservedQuantity: number (double)
  Reserved Quantity
• reservedQuantityUom: string
  Reserved Quantity Unit of Measurement
• updateDate: updateDate
  Read Only: true

  update date
• values: values

{
    "properties":{
        "gtmTipInventoryGid":{
            "description":"Trade Incentive Program Inventroy GID",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "gtmTipInventoryXid":{
            "description":"Trade Incentive Program Inventroy XID",
            "type":"string"
        },
        "inventoryOrganizationGid":{
            "description":"Inventory Organization",
            "type":"string"
        },
        "itemGid":{
            "description":"Item",
            "type":"string"
        },
        "locationGid":{
            "description":"Location of the inventory",
            "type":"string"
        },
        "gtmTradeIncentivePgmGid":{
            "description":"Trade Incentive Program",
            "type":"string"
        },
        "gtmProcedureGid":{
            "description":"Procedure",
            "type":"string"
        },
        "referenceType":{
            "description":"Reference Type",
            "type":"string"
        },
        "referenceNumber":{
            "description":"Refrence Number",
            "type":"string"
        },
        "quantity":{
            "description":"Quantity",
            "type":"number",
            "format":"double"
        },
        "quantityUomCode":{
            "description":"Quantity Unit of Measurement",
            "type":"string"
        },
        "balanceQuantity":{
            "description":"Balance Quantity",
            "type":"number",
            "format":"double"
        },
        "balanceQuantityUomCode":{
            "description":"Balance Quantity Unit of Measurement",
            "type":"string"
        },
        "customStatus":{
            "description":"Custom Status",
            "type":"string"
        },
        "inventoryStatus":{
            "description":"Inventory Status - Open (no withdrawl from the inventory has happened so far), Partially Reconciled (some amount of inventory has been withdrawn), Closed (inventory has been fully reconciled)",
            "type":"string"
        },
        "dischargePeriodEndDate":{
            "description":"Date upto which this inventory is valid in its Trade Incentive Program",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "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"
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER ",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "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"
                }
            ]
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "gtmProdClassTypeGid":{
            "description":"Product Class Type GID",
            "type":"string"
        },
        "classificationCode":{
            "description":"Classification Code",
            "type":"string"
        },
        "entryDate":{
            "description":"Entry Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "gtmDeclarationTypeGid":{
            "description":"GTM Declaration Type GID",
            "type":"string"
        },
        "gtmDeclSTypeGid":{
            "description":"GTM Declaration Sub Type",
            "type":"string"
        },
        "gtmTipZoneStatusGid":{
            "description":"Trade Incentive Program Zone Status GID",
            "type":"string"
        },
        "reservedQuantity":{
            "description":"Reserved Quantity",
            "type":"number",
            "format":"double"
        },
        "reservedQuantityUom":{
            "description":"Reserved Quantity Unit of Measurement",
            "type":"string"
        },
        "countryOfOrigin":{
            "description":"The country of origin of the goods.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tipInventories.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "values":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tipInventories.values"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "movements":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tipInventories.movements"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeDate1

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

Match All

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

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

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

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 : attributeDate11

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

Match All

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

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 : attributeDate12

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

Match All

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

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 : attributeDate13

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

Match All

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

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 : attributeDate14

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

Match All

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

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 : attributeDate15

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

Match All

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

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 : attributeDate16

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

Match All

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

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 : attributeDate17

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

Match All

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

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 : attributeDate18

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

Match All

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

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 : attributeDate19

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

Match All

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

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

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

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 : attributeDate20

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

Match All

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 : dischargePeriodEndDate

Date upto which this inventory is valid in its Trade Incentive Program

Match All

Date upto which this inventory is valid in its Trade Incentive Program

Show Source

• object dateType

{
    "description":"Date upto which this inventory is valid in its Trade Incentive Program",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : entryDate

Entry Date

Match All

Entry Date

Show Source

• object dateType

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : movements

Type: object

Show Source

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

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

Nested Schema : refnums

Type: object

Show Source

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

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

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

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

Nested Schema : values

Type: object

Show Source

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

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

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 : 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 : 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 tipInventories.movements

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tipInventories.movements"
    }
}

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 : tipInventories.movements

Type: object

Show Source

• domainName: string
  No description.
• gtmTipInvMovementGid: string
  Trade Incentive Program Inventory Movement GID
• links: array links
  Read Only: true

{
    "properties":{
        "gtmTipInvMovementGid":{
            "description":"Trade Incentive Program Inventory Movement GID",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 tipInventories.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tipInventories.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 : tipInventories.refnums

Type: object

Show Source

• domainName: string
  No description.
• gtmTipRefnumQualGid: string
  Trade Incentive Program Reference Number Qualifier GID
• links: array links
  Read Only: true
• refnumValue: string
  Reference Number Value

{
    "properties":{
        "gtmTipRefnumQualGid":{
            "description":"Trade Incentive Program Reference Number Qualifier GID",
            "type":"string"
        },
        "refnumValue":{
            "description":"Reference Number Value",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "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 tipInventories.values

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tipInventories.values"
    }
}

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 : tipInventories.values

Type: object

Show Source

• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  Indicates the date to be used for any currency converions; if null, the latest conversion should be used.
• exchangeRateGid: string
  Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
• gtmValueQualifierGid: string
  The GID of the value qualifier on the GTM Trade Incentive Program
• links: array links
  Read Only: true
• value: value
  Currency value of the GTM Trade Incentive Program
• valueNote: string
  A note that shows how the value qualifier is calculated.

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID of the value qualifier on the GTM Trade Incentive Program",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "value":{
            "description":"Currency value of the GTM Trade Incentive Program",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency converions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "valueNote":{
            "description":"A note that shows how the value qualifier is calculated.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : exchangeRateDate

Indicates the date to be used for any currency converions; if null, the latest conversion should be used.

Match All

Indicates the date to be used for any currency converions; if null, the latest conversion should be used.

Show Source

• object dateType

{
    "description":"Indicates the date to be used for any currency converions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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 : value

Currency value of the GTM Trade Incentive Program

Match All

Currency value of the GTM Trade Incentive Program

Show Source

• object currencyType

{
    "description":"Currency value of the GTM Trade Incentive Program",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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"
        }
    }
}

Back to Top