Get a party fiscal classification
get
/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}
Request
Path Parameters
-
ClassificationTypeId(required): integer(int64)
Unique identifier of the party fiscal classification.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : partyFiscalClassifications-item-response
Type:
Show Source
object
-
ClassificationCategoryMeaning: string
Title:
Classification Type Name
The name of the classification category associated with a party fiscal classification. -
ClassificationCode: string
Title:
Classification Code
The classification code associated with a party fiscal classification. -
ClassificationMeaning: string
Title:
Fiscal Classification Name
The fiscal classification name associated with a party fiscal classification. -
ClassificationTypeCategCode: string
Title:
Classification Type Category Code
Maximum Length:30
Default Value:PARTY_FISCAL_CLASS
The classification type category code associated with a party fiscal classification. -
ClassificationTypeCode: string
Title:
Fiscal Classification Type Code
Maximum Length:30
The classification type code associated with a party fiscal classification. -
ClassificationTypeId: integer
(int64)
Unique identifier of the party fiscal classification.
-
ClassificationTypeLevelCode: string
Title:
Number of Levels
Maximum Length:30
The classification type level code associated with a party fiscal classification. -
ClassificationTypeName: string
Title:
Type Name
Maximum Length:240
The name of the classification type associated with a party fiscal classification. -
EffectiveFrom: string
(date)
Title:
Start Date
The date when the party fiscal classification starts being effective. -
EffectiveTo: string
(date)
Title:
End Date
The date when the party fiscal classification stops being effective. -
fiscalClassificationTypeTaxRegimeAssociations: array
Tax Regime Associations
Title:
Tax Regime Associations
The fiscal classification type tax regime association resource is used to query, update, and create party fiscal classifications for purposes of assigning the appropriate tax regime to a specific party fiscal classification. -
Levels: string
Title:
Levels
Maximum Length:255
The level associated with a party fiscal classification for purposes of defining a tax rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerIdChar: string
Title:
Party Classification
Maximum Length:30
The classification category code associated with a party fiscal classification. -
OwnerTableCode: string
Title:
Intended Use Classification Source
Maximum Length:30
Default Value:HZ_CLASS_CATEGORY
The owner table code associated with a party fiscal classification. -
PartyClassification: string
Title:
Party Classification
The classification used by a tax authority to categorize a party for tax determination. Use party classifications to classify your customers, suppliers, first-party legal entities, and first-party legal reporting units for tax determination and tax reporting.
Nested Schema : Tax Regime Associations
Type:
array
Title:
Tax Regime Associations
The fiscal classification type tax regime association resource is used to query, update, and create party fiscal classifications for purposes of assigning the appropriate tax regime to a specific party fiscal classification.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partyFiscalClassifications-fiscalClassificationTypeTaxRegimeAssociations-item-response
Type:
Show Source
object
-
ClassificationTypeCode: string
Title:
Fiscal Classification Type Code
Maximum Length:30
The classification type code associated with a party fiscal classification. -
EffectiveFrom: string
(date)
Title:
Start Date
The date when the tax regime association starts being effective. -
EffectiveTo: string
(date)
Title:
End Date
The date when the tax regime association stops being effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TaxRegimeCode: string
Title:
Tax Regime Code
Maximum Length:30
The tax regime code associated with a party fiscal classification.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- fiscalClassificationTypeTaxRegimeAssociations
-
Parameters:
- ClassificationTypeId:
$request.path.ClassificationTypeId
The fiscal classification type tax regime association resource is used to query, update, and create party fiscal classifications for purposes of assigning the appropriate tax regime to a specific party fiscal classification. - ClassificationTypeId:
Examples
The following example shows how to retrieve a party fiscal classification by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100009987991
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "ClassificationTypeCategCode": "PARTY_FISCAL_CLASS", "Levels": "1", "ClassificationTypeCode": "AP_PARTY FC_1", "ClassificationTypeName": "AP_PARTY FC_1", "EffectiveFrom": "2001-01-01", "EffectiveTo": null, "OwnerIdChar": "BANK_INSTITUTION_TYPE", "ClassificationTypeLevelCode": "1", "OwnerTableCode": "HZ_CLASS_CATEGORY", "PartyClassification": null, "ClassificationCategoryMeaning": null, "ClassificationCode": null, "ClassificationMeaning": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100009987991", "name": "partyFiscalClassifications", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100009987991", "name": "partyFiscalClassifications", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100009987991/lov/classificationLevels", "name": "classificationLevels", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100009987991/child/fiscalClassificationTypeTaxRegimeAssociations", "name": "fiscalClassificationTypeTaxRegimeAssociations", "kind": "collection" } ] }