Jump to

• Request
• Response

Update a tax period's attributes

patch

/fscmRestApi/resources/11.13.18.05/taxDocumentSetups/{TaxDocumentSetupId}/child/taxPeriods/{TaxPeriodId}/child/taxPeriodAttributes/{TaxPeriodAttributeId}

Request

Path Parameters

• TaxDocumentSetupId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• TaxPeriodAttributeId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• TaxPeriodId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

• Description: string
  Title: Tax Period Attribute Description

  Maximum Length: 1000

  Description of the tax period document attribute.
• TaxDocumentAttributeCode: string
  Title: Tax Document Attribute Code

  Maximum Length: 30

  Code of the tax document setup.
• TaxDocumentAttributeId: integer (int64)
  Title: Tax Document Attribute ID

  Unique identifier of the tax document attribute.
• Value: string
  Title: Tax Value Attribute

  Maximum Length: 100

  Indicates the value of the tax period document attribute. This can either be the box number during template creation or can indicate the true or false option of the tax document option attributes.

{
    "type":"object",
    "properties":{
        "Value":{
            "title":"Tax Value Attribute",
            "maxLength":100,
            "type":"string",
            "description":"Indicates the value of the tax period document attribute. This can either be the box number during template creation or can indicate the true or false option of the tax document option attributes.",
            "nullable":true
        },
        "TaxDocumentAttributeCode":{
            "title":"Tax Document Attribute Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the tax document setup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Tax Period Attribute Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the tax period document attribute.",
            "nullable":false
        },
        "TaxDocumentAttributeId":{
            "title":"Tax Document Attribute ID",
            "type":"integer",
            "description":"Unique identifier of the tax document attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : taxDocumentSetups-taxPeriods-taxPeriodAttributes-item-response

Type: object

Show Source

• Description: string
  Title: Tax Period Attribute Description

  Maximum Length: 1000

  Description of the tax period document attribute.
• DocumentAttributeTypeCode: string
  Title: Tax Document Attribute Type Code

  Read Only: true

  Maximum Length: 150

  Code of the tax document attribute type.
• DocumentAttributeTypeMeaning: string
  Title: Tax Document Attribute Type Name

  Read Only: true

  Maximum Length: 80

  Name of the tax document attribute type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TaxDocumentAttributeCode: string
  Title: Tax Document Attribute Code

  Maximum Length: 30

  Code of the tax document setup.
• TaxDocumentAttributeId: integer (int64)
  Title: Tax Document Attribute ID

  Unique identifier of the tax document attribute.
• TaxDocumentAttributeName: string
  Title: Tax Document Attribute Name

  Read Only: true

  Maximum Length: 150

  Name of the tax document setup.
• TaxPeriodAttributeId: integer (int64)
  Title: Tax Period Attribute

  Read Only: true

  Unique identifier of the tax period attribute.
• Value: string
  Title: Tax Value Attribute

  Maximum Length: 100

  Indicates the value of the tax period document attribute. This can either be the box number during template creation or can indicate the true or false option of the tax document option attributes.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Tax Period Attribute Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the tax period document attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxPeriodAttributeId":{
            "title":"Tax Period Attribute",
            "type":"integer",
            "description":"Unique identifier of the tax period attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentAttributeTypeMeaning":{
            "title":"Tax Document Attribute Type Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the tax document attribute type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentAttributeTypeCode":{
            "title":"Tax Document Attribute Type Code",
            "maxLength":150,
            "type":"string",
            "description":"Code of the tax document attribute type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Tax Value Attribute",
            "maxLength":100,
            "type":"string",
            "description":"Indicates the value of the tax period document attribute. This can either be the box number during template creation or can indicate the true or false option of the tax document option attributes.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxDocumentAttributeCode":{
            "title":"Tax Document Attribute Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the tax document setup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaxDocumentAttributeId":{
            "title":"Tax Document Attribute ID",
            "type":"integer",
            "description":"Unique identifier of the tax document attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxDocumentAttributeName":{
            "title":"Tax Document Attribute Name",
            "maxLength":150,
            "type":"string",
            "description":"Name of the tax document setup.",
            "nullable":false,
            "readOnly":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

documentAttributeTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_DOCUMENT_ATTR_TYPE%2CApplicationCode%3DHES%2CLookupCode%3D{DocumentAttributeTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: DocumentAttributeTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

taxDocumentAttributeTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/taxDocumentAttributesLOV

Parameters:

• finder: FindByDocumentTypeAndDocumentAttributeType%3BDocumentAttributeTypeCode%3D{DocumentAttributeTypeCode}%2CDocumentTypeCode%3D{DocumentTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: TaxDocumentAttributeCode; Target Attribute: TaxDocumentAttributeCode
• Display Attribute: TaxDocumentAttributeName

Back to Top