Jump to

• Request
• Response

Update a tax regime for a party fiscal classification

patch

/fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}/child/fiscalClassificationTypeTaxRegimeAssociations/{fiscalClassificationTypeTaxRegimeAssociationsUniqID}

Request

Path Parameters

• ClassificationTypeId(required): integer(int64)
  Unique identifier of the party fiscal classification.
• fiscalClassificationTypeTaxRegimeAssociationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Tax Regime Associations resource and used to uniquely identify an instance of Tax Regime Associations. The client should not generate the hash key value. Instead, the client should query on the Tax Regime Associations collection resource in order to navigate to a specific instance of Tax Regime Associations to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "EffectiveFrom":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the tax regime association starts being effective.",
            "format":"date",
            "nullable":false
        },
        "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:
  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.

Body ()

Root 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."
        }
    }
}

Back to Top