Jump to

• Request
• Response

Get Values

get

/customsDeclarations/{gtmTransactionGid}/lines/{gtmTransactionLineGid}/values

Request

Path Parameters

• gtmTransactionGid(required): string
  Resource ID
• gtmTransactionLineGid(required): string
  Resource ID

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

Nested Schema : items

Type: array

Show Source

• Array of: object customsDeclarations.lines.values

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : customsDeclarations.lines.values

Type: object

Show Source

• currencyValue: currencyValue
  The currency value of the trade transaction line.
• domainName: string
  Database domain where this data is stored.
• gtmFormulaExpressionGid: string
  Formula(If any) associated with the value qualifier.
• gtmValueQualifierGid: string
  The GID for the value qualifier on the trade transaction line.
• isFixed: boolean
  If this is set to false, the currency values can be overridden with the values calculated from formula or any other process.
• links: array links
  Read Only: true
• methodOfCalculation: string
  Shows how the currency value should be calculated either manually or by using a formula.
• paymentMethodCodeGid: string
  The payment method. It is a foreign key to PAYMENT_METHOD_CODE table.
• rcValue: number (double)
  The reporting currency value.
• rcValueCurrencyGid: string
  The reporting currency. It is a foreign key to CURRENCY table.
• valueDetails: valueDetails
• valueFormulaCompRuleGrpId: string
  Compliance rule group ID used to assign formula to the value qualifiers on the transaction line.
• valueNote: string
  A note that shows how the value qualifier is calculated.
• valueSetCompRuleGrpId: string
  Compliance rule group ID used to assign value set to the transaction line.

{
    "properties":{
        "gtmValueQualifierGid":{
            "description":"The GID for the value qualifier on the trade transaction line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "currencyValue":{
            "description":"The currency value of the trade transaction line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "gtmFormulaExpressionGid":{
            "description":"Formula(If any) associated with the value qualifier.",
            "type":"string"
        },
        "valueNote":{
            "description":"A note that shows how the value qualifier is calculated.",
            "type":"string"
        },
        "methodOfCalculation":{
            "description":"Shows how the currency value should be calculated either manually or by using a formula.",
            "type":"string"
        },
        "isFixed":{
            "description":"If this is set to false, the currency values can be overridden with the values calculated from formula or any other process.",
            "type":"boolean"
        },
        "valueSetCompRuleGrpId":{
            "description":"Compliance rule group ID used to assign value set to the transaction line.",
            "type":"string"
        },
        "valueFormulaCompRuleGrpId":{
            "description":"Compliance rule group ID used to assign formula to the value qualifiers on the transaction line.",
            "type":"string"
        },
        "paymentMethodCodeGid":{
            "description":"The payment method. It is a foreign key to PAYMENT_METHOD_CODE table.",
            "type":"string"
        },
        "rcValue":{
            "description":"The reporting currency value.",
            "type":"number",
            "format":"double"
        },
        "rcValueCurrencyGid":{
            "description":"The reporting currency. It is a foreign key to CURRENCY table.",
            "type":"string"
        },
        "valueDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/customsDeclarations.lines.values.valueDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : currencyValue

The currency value of the trade transaction line.

Match All

The currency value of the trade transaction line.

Show Source

• object currencyType

{
    "description":"The currency value of the trade transaction line.",
    "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 : valueDetails

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/customsDeclarations.lines.values.valueDetails"
            }
        },
        "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 : 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 customsDeclarations.lines.values.valueDetails

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

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 : customsDeclarations.lines.values.valueDetails

Type: object

Show Source

• domainName: string
  No description.
• gtmTransactionLineGid: string
  The GID for the GTM Trade Transaction Line.
• gtmValueQualifierGid: string
  Value Qualifier Gid
• links: array links
  Read Only: true
• referenceValueAttribute: string
  Reference value attribute column shows which other value attribute this belongs to.
• sequenceNo: number (int64)
  Sequence Number
• value: value
  The currency value of the value attribute.
• valueAttribute: string
  Value attribute shows the attribute type of the value qualifier.
• valueNote: string
  A note that shows how the value attribute is calculated.

{
    "properties":{
        "gtmTransactionLineGid":{
            "description":"The GID for the GTM Trade Transaction Line.",
            "type":"string"
        },
        "gtmValueQualifierGid":{
            "description":"Value Qualifier Gid ",
            "type":"string"
        },
        "sequenceNo":{
            "description":"Sequence Number",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "valueAttribute":{
            "description":"Value attribute shows the attribute type of the value qualifier.",
            "type":"string"
        },
        "value":{
            "description":"The currency value of the value attribute.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "valueNote":{
            "description":"A note that shows how the value attribute is calculated.",
            "type":"string"
        },
        "referenceValueAttribute":{
            "description":"Reference value attribute column shows which other value attribute this belongs to.",
            "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 : value

The currency value of the value attribute.

Match All

The currency value of the value attribute.

Show Source

• object currencyType

{
    "description":"The currency value of the value attribute.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Back to Top