Jump to

• Request
• Response
• Examples

Create a party fiscal classification

post

/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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(required): 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(required): 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.
• 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.

{
    "required":[
        "ClassificationTypeCode",
        "EffectiveFrom"
    ],
    "type":"object",
    "properties":{
        "ClassificationTypeLevelCode":{
            "title":"Number of Levels",
            "maxLength":30,
            "type":"string",
            "description":"The classification type level code associated with a party fiscal classification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ClassificationTypeCode":{
            "title":"Fiscal Classification Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The classification type code associated with a party fiscal classification.",
            "nullable":false
        },
        "PartyClassification":{
            "title":"Party Classification",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerTableCode":{
            "title":"Intended Use Classification Source",
            "maxLength":30,
            "type":"string",
            "description":"The owner table code associated with a party fiscal classification.",
            "nullable":true,
            "default":"HZ_CLASS_CATEGORY"
        },
        "OwnerIdChar":{
            "title":"Party Classification",
            "maxLength":30,
            "type":"string",
            "description":"The classification category code associated with a party fiscal classification.",
            "nullable":true
        },
        "ClassificationMeaning":{
            "title":"Fiscal Classification Name",
            "type":"string",
            "description":"The fiscal classification name associated with a party fiscal classification.",
            "nullable":true
        },
        "ClassificationTypeId":{
            "type":"integer",
            "description":"Unique identifier of the party fiscal classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "fiscalClassificationTypeTaxRegimeAssociations":{
            "title":"Tax Regime Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/partyFiscalClassifications-fiscalClassificationTypeTaxRegimeAssociations-item-post-request"
            }
        },
        "ClassificationTypeCategCode":{
            "title":"Classification Type Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The classification type category code associated with a party fiscal classification.",
            "nullable":false,
            "default":"PARTY_FISCAL_CLASS"
        },
        "ClassificationCategoryMeaning":{
            "title":"Classification Type Name",
            "type":"string",
            "description":"The name of the classification category associated with a party fiscal classification.",
            "nullable":true
        },
        "ClassificationCode":{
            "title":"Classification Code",
            "type":"string",
            "description":"The classification code associated with a party fiscal classification.",
            "nullable":true
        },
        "ClassificationTypeName":{
            "title":"Type Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the classification type associated with a party fiscal classification.",
            "nullable":true
        },
        "Levels":{
            "title":"Levels",
            "maxLength":255,
            "type":"string",
            "description":"The level associated with a party fiscal classification for purposes of defining a tax rule.",
            "nullable":true
        },
        "EffectiveFrom":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the party fiscal classification starts being effective.",
            "format":"date",
            "nullable":false
        },
        "EffectiveTo":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the party fiscal classification stops being effective.",
            "format":"date",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Tax Regime Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/partyFiscalClassifications-fiscalClassificationTypeTaxRegimeAssociations-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• TaxRegimeCode: string
  Title: Tax Regime Code

  Maximum Length: 30

  The tax regime code associated with a party fiscal classification.

{
    "type":"object",
    "properties":{
        "EffectiveFrom":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the tax regime association starts being effective.",
            "format":"date",
            "nullable":false
        },
        "ClassificationTypeCode":{
            "title":"Fiscal Classification Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The classification type code associated with a party fiscal classification.",
            "nullable":false
        },
        "TaxRegimeCode":{
            "title":"Tax Regime Code",
            "maxLength":30,
            "type":"string",
            "description":"The tax regime code associated with a party fiscal classification.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveTo":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the tax regime association stops being effective.",
            "format":"date",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

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

{
    "type":"object",
    "properties":{
        "ClassificationTypeLevelCode":{
            "title":"Number of Levels",
            "maxLength":30,
            "type":"string",
            "description":"The classification type level code associated with a party fiscal classification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClassificationTypeCode":{
            "title":"Fiscal Classification Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The classification type code associated with a party fiscal classification.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyClassification":{
            "title":"Party Classification",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerTableCode":{
            "title":"Intended Use Classification Source",
            "maxLength":30,
            "type":"string",
            "description":"The owner table code associated with a party fiscal classification.",
            "nullable":true,
            "default":"HZ_CLASS_CATEGORY",
            "x-queryable":true
        },
        "OwnerIdChar":{
            "title":"Party Classification",
            "maxLength":30,
            "type":"string",
            "description":"The classification category code associated with a party fiscal classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationMeaning":{
            "title":"Fiscal Classification Name",
            "type":"string",
            "description":"The fiscal classification name associated with a party fiscal classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationTypeId":{
            "type":"integer",
            "description":"Unique identifier of the party fiscal classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "fiscalClassificationTypeTaxRegimeAssociations":{
            "title":"Tax Regime Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/partyFiscalClassifications-fiscalClassificationTypeTaxRegimeAssociations-item-response"
            }
        },
        "ClassificationTypeCategCode":{
            "title":"Classification Type Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The classification type category code associated with a party fiscal classification.",
            "nullable":false,
            "default":"PARTY_FISCAL_CLASS",
            "x-queryable":true
        },
        "ClassificationCategoryMeaning":{
            "title":"Classification Type Name",
            "type":"string",
            "description":"The name of the classification category associated with a party fiscal classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationCode":{
            "title":"Classification Code",
            "type":"string",
            "description":"The classification code associated with a party fiscal classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationTypeName":{
            "title":"Type Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the classification type associated with a party fiscal classification.",
            "nullable":true,
            "x-queryable":true
        },
        "Levels":{
            "title":"Levels",
            "maxLength":255,
            "type":"string",
            "description":"The level associated with a party fiscal classification for purposes of defining a tax rule.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveFrom":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the party fiscal classification starts being effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveTo":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the party fiscal classification stops being effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object partyFiscalClassifications-fiscalClassificationTypeTaxRegimeAssociations-item-response

{
    "title":"Tax Regime Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/partyFiscalClassifications-fiscalClassificationTypeTaxRegimeAssociations-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : partyFiscalClassifications-fiscalClassificationTypeTaxRegimeAssociations-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveFrom":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the tax regime association starts being effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ClassificationTypeCode":{
            "title":"Fiscal Classification Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The classification type code associated with a party fiscal classification.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxRegimeCode":{
            "title":"Tax Regime Code",
            "maxLength":30,
            "type":"string",
            "description":"The tax regime code associated with a party fiscal classification.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EffectiveTo":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the tax regime association stops being effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

fiscalClassificationTypeTaxRegimeAssociations

Operation: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}/child/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.

Back to Top

Examples

The following example shows how to create a party fiscal classification by submitting a POST request on the REST resource using cURL.

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

Example Request Payload

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

{
	"ClassificationTypeCategCode": "PARTY_FISCAL_CLASS",
	"Levels": "1",
	"ClassificationTypeCode": "PARTYFC_561123",
	"ClassificationTypeName": "PARTYFC_561123",
	"EffectiveFrom": "2001-01-01",
	"EffectiveTo": "2025-01-01",
	"OwnerIdChar": "BANK_BRANCH_TYPE",
	"ClassificationTypeLevelCode": "1",
	"OwnerTableCode": "HZ_CLASS_CATEGORY"
}

Example of Response Body

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

{
    "ClassificationTypeCategCode": "PARTY_FISCAL_CLASS",
    "Levels": "1",
    "ClassificationTypeCode": "PARTYFC_561123",
    "ClassificationTypeName": "PARTYFC_561123",
    "EffectiveFrom": "2001-01-01",
    "EffectiveTo": "2025-01-01",
    "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
            }
        },
        {
            "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"
        }
    ]
}

Back to Top