Jump to

• Request
• Response

Get a Corporation

get

/corporations/{corporationGid}

Request

Path Parameters

• corporationGid(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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• corporationGid: string
  Contains the GID for the corporation.
• corporationName: string
  Contains the name of the corporation.
• corporationXid: string
  Contains the XID for the corporation.
• domainName: string
  Database domain where this data is stored.
• dropoffRoutingSequenceGid: string
  The GID for the dropoff routing sequence. The Dropoff Routing Sequence controls the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedParties: involvedParties
• isAllowHouseCollect: boolean
  The Allow House Collect check box field is used to indicate whether or not a shipping agent is allowed to handle shipments with COLLECT payment terms. Note: This check box is used for visibility and is not currently enforced within the base application i.e., this is for information only.
• isDomainMaster: boolean
  Check box field to identify a corporation record as the domain master. The domain master corporation determines the default involved parties for an order, given the domain of the order. When a shipment is built, it grabs the LOGISTICS involved party from the master corporation for the domain and adds it to the shipment. It also does the same for the order for BILL-TO, LOGISTICS, ORDEROWNER, ORDERSUPPLIER, SHIPPER, CONSIGNEE when the order is created. Also, when trying to get the primary contact for a shipment tender, Oracle Transportation Management looks for a contact that is associated to the master corporation for the domain and the service provider.
• isShippingAgentsActive: boolean
  Indicates if corporation is active. Used with agents.
• links: array links
  Read Only: true
• maxHouseCollectAmt: maxHouseCollectAmt
  If house collection is allowed, the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.
• pickupRoutingSequenceGid: string
  The GID for the pickup routing sequence. The Pickup Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.
• updateDate: updateDate
  Read Only: true

  update date
• vatProvincialRegistrations: vatProvincialRegistrations
• vatRegistrations: vatRegistrations

{
    "properties":{
        "corporationGid":{
            "description":"Contains the GID for the corporation.",
            "type":"string"
        },
        "corporationXid":{
            "description":"Contains the XID for the corporation.",
            "type":"string"
        },
        "corporationName":{
            "description":"Contains the name of the corporation.",
            "type":"string"
        },
        "isDomainMaster":{
            "description":"Check box field to identify a corporation record as the domain master.  The domain master corporation determines the default involved parties for an order, given the domain of the order. When a shipment is built, it grabs the LOGISTICS involved party from the master corporation for the domain and adds it to the shipment. It also does the same for the order for BILL-TO, LOGISTICS, ORDEROWNER, ORDERSUPPLIER, SHIPPER, CONSIGNEE when the order is created. Also, when trying to get the primary contact for a shipment tender, Oracle Transportation Management looks for a contact that is associated to the master corporation for the domain and the service provider.",
            "type":"boolean"
        },
        "isShippingAgentsActive":{
            "description":"Indicates if corporation is active. Used with agents.",
            "type":"boolean"
        },
        "isAllowHouseCollect":{
            "description":"The Allow House Collect check box field is used to indicate whether or not a shipping agent is allowed to handle shipments with COLLECT payment terms.  Note: This check box is used for visibility and is not currently enforced within the base application i.e., this is for information only.",
            "type":"boolean"
        },
        "maxHouseCollectAmt":{
            "description":"If house collection is allowed,  the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pickupRoutingSequenceGid":{
            "description":"The GID for the pickup routing sequence. The Pickup Routing Sequence control the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.",
            "type":"string"
        },
        "dropoffRoutingSequenceGid":{
            "description":"The GID for the dropoff routing sequence. The Dropoff Routing Sequence controls the routing sequence; how the system plans the sequence of shipment stops that are built from an order base.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "vatProvincialRegistrations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.vatProvincialRegistrations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vatRegistrations":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.vatRegistrations"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/corporations.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

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

Nested Schema : involvedParties

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/corporations.involvedParties"
            }
        },
        "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 : maxHouseCollectAmt

If house collection is allowed, the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.

Match All

Show Source

• object currencyType

{
    "description":"If house collection is allowed,  the Max House Collect Amount is used to specify the maximum amount of freight charges that can be collected from the internal bill.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

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

Nested Schema : vatProvincialRegistrations

Type: object

Show Source

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

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

Nested Schema : vatRegistrations

Type: object

Show Source

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

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

Nested Schema : dateType

Type: object

Show Source

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

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

Nested Schema : items

Type: array

Show Source

• Array of: object corporations.involvedParties

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : corporations.involvedParties

Type: object

Show Source

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

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

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 corporations.vatProvincialRegistrations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/corporations.vatProvincialRegistrations"
    }
}

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 : corporations.vatProvincialRegistrations

Type: object

Show Source

• countryCode3Gid: string
  The country code for the provincial VAT registration.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• provinceCode: string
  The province code of the registration.
• vatProvincialRegGid: string
  The provincial VAT registration ID.
• vatProvincialRegXid: string
  The XID for the provincial VAT registration.

{
    "properties":{
        "vatProvincialRegGid":{
            "description":"The provincial VAT registration ID.",
            "type":"string"
        },
        "vatProvincialRegXid":{
            "description":"The XID for the provincial VAT registration.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code for the provincial VAT registration.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code of the registration.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Nested Schema : items

Type: array

Show Source

• Array of: object corporations.vatRegistrations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/corporations.vatRegistrations"
    }
}

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 : corporations.vatRegistrations

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• vatRegNoGid: string
  VAT registration linked to the corporation indicated by the corporation GID.

{
    "properties":{
        "vatRegNoGid":{
            "description":"VAT registration linked to the corporation indicated by the corporation GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Back to Top