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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
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
Nested Schema : vatProvincialRegistrations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : vatRegistrations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : corporations.involvedParties
Type:
Show Source
object
-
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
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : corporations.vatProvincialRegistrations
Type:
Show Source
object
-
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.
Nested Schema : corporations.vatRegistrations
Type:
Show Source
object
-
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.