1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Party Fiscal Classifications

Get all party fiscal classifications

get

/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • ManagePartyClassificationsRF: Finds all party fiscal classifications that match the specified class category, class type code, and class type name.
      Finder Variables:
      • classCategory; string; The party fiscal classification class category.
      • classTypeCode; string; The party fiscal classification class type code.
      • classTypeName; string; The party fiscal classification class type name.
    • PrimaryKey: Finds all party fiscal classifications that match the specified classification type identifier.
      Finder Variables:
      • ClassificationTypeId; integer; Unique identifier of the party fiscal classification.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ClassificationCategoryMeaning; string; The name of the classification category associated with a party fiscal classification.
    • ClassificationCode; string; The classification code associated with a party fiscal classification.
    • ClassificationMeaning; string; The fiscal classification name associated with a party fiscal classification.
    • ClassificationTypeCategCode; string; The classification type category code associated with a party fiscal classification.
    • ClassificationTypeCode; string; The classification type code associated with a party fiscal classification.
    • ClassificationTypeId; integer; Unique identifier of the party fiscal classification.
    • ClassificationTypeLevelCode; string; The classification type level code associated with a party fiscal classification.
    • ClassificationTypeName; string; The name of the classification type associated with a party fiscal classification.
    • EffectiveFrom; string; The date when the party fiscal classification starts being effective.
    • EffectiveTo; string; The date when the party fiscal classification stops being effective.
    • Levels; string; The level associated with a party fiscal classification for purposes of defining a tax rule.
    • OwnerIdChar; string; The classification category code associated with a party fiscal classification.
    • OwnerTableCode; string; The owner table code associated with a party fiscal classification.
    • PartyClassification; string; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : partyFiscalClassifications
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : partyFiscalClassifications-item-response
Type: object
Show Source
  • Title: Classification Type Name
    The name of the classification category associated with a party fiscal classification.
  • Title: Classification Code
    The classification code associated with a party fiscal classification.
  • Title: Fiscal Classification Name
    The fiscal classification name associated with a party fiscal classification.
  • Title: Classification Type Category Code
    Maximum Length: 30
    Default Value: PARTY_FISCAL_CLASS
    The classification type category code associated with a party fiscal classification.
  • Title: Fiscal Classification Type Code
    Maximum Length: 30
    The classification type code associated with a party fiscal classification.
  • Unique identifier of the party fiscal classification.
  • Title: Number of Levels
    Maximum Length: 30
    The classification type level code associated with a party fiscal classification.
  • Title: Type Name
    Maximum Length: 240
    The name of the classification type associated with a party fiscal classification.
  • Title: Start Date
    The date when the party fiscal classification starts being effective.
  • Title: End Date
    The date when the party fiscal classification stops being effective.
  • 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.
  • Title: Levels
    Maximum Length: 255
    The level associated with a party fiscal classification for purposes of defining a tax rule.
  • Links
  • Title: Party Classification
    Maximum Length: 30
    The classification category code associated with a party fiscal classification.
  • Title: Intended Use Classification Source
    Maximum Length: 30
    Default Value: HZ_CLASS_CATEGORY
    The owner table code associated with a party fiscal classification.
  • 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 : partyFiscalClassifications-fiscalClassificationTypeTaxRegimeAssociations-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the party fiscal classifications by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "ClassificationTypeCategCode": "PARTY_FISCAL_CLASS",
            "Levels": "1",
            "ClassificationTypeCode": "PARTYFC_561123",
            "ClassificationTypeName": "PARTYFC_561123",
            "EffectiveFrom": "2001-01-01",
            "EffectiveTo": null,
            "OwnerIdChar": "BANK_BRANCH_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/300100006792847",
                    "name": "partyFiscalClassifications",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100006792847",
                    "name": "partyFiscalClassifications",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100006792847/lov/classificationLevels",
                    "name": "classificationLevels",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100006792847/child/fiscalClassificationTypeTaxRegimeAssociations",
                    "name": "fiscalClassificationTypeTaxRegimeAssociations",
                    "kind": "collection"
                }
            ]
        },
        ...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications",
            "name": "partyFiscalClassifications",
            "kind": "collection"
        }
    ]
}
Back to Top