Update a party fiscal classification

patch

/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : schema
Type: object
Show Source
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-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 update a party fiscal classification by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/300100009987991

Example Request Payload

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

{
"PartyClassification": "FORPROFIT"
}

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" : "FORPROFIT",
  "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"
  } ]
}
Back to Top