Jump to

• Request
• Response

Update a tax document snapshot detail

patch

/fscmRestApi/resources/11.13.18.05/taxDocumentSnapshots/{TaxSnapshotId}/child/snapshotDetails/{TaxSnapshotDetailId}

Request

Path Parameters

• TaxSnapshotDetailId(required): integer
  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=
• TaxSnapshotId(required): integer
  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:
  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

• TaxDocumentAttributeValue: string
  Title: Attribute Value

  Maximum Length: 100

  The calculated, numeric value associated with the tax document attribute.

{
    "type":"object",
    "properties":{
        "TaxDocumentAttributeValue":{
            "title":"Attribute Value",
            "maxLength":"100",
            "type":"string",
            "description":"The calculated, numeric value associated with the tax document attribute.",
            "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 : taxDocumentSnapshots-snapshotDetails-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TaxDocumentAttributeId: integer
  Title: Tax Document Attribute

  Read Only: true

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

  Read Only: true

  Maximum Length: 150

  The name of the tax document attribute.
• TaxDocumentAttributeValue: string
  Title: Attribute Value

  Maximum Length: 100

  The calculated, numeric value associated with the tax document attribute.
• TaxDocumentAttributeValueTypeCode: string
  Title: Tax Document Attribute Type Code

  Read Only: true

  Maximum Length: 30

  The code associated with the tax document attribute.
• TaxDocumentAttributeValueTypeMeaning: string
  Title: Tax Document Attribute Type Name

  Read Only: true

  Maximum Length: 80

  The name of the tax document attribute type.
• TaxPeriodAttributeValue: string
  Title: Tax Value Attribute

  Read Only: true

  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.
• TaxSnapshotDetailId: integer
  Title: Tax Snapshot Details

  Read Only: true

  The unique identifier of the tax snapshot detail.

{
    "type":"object",
    "properties":{
        "TaxDocumentAttributeValue":{
            "title":"Attribute Value",
            "maxLength":"100",
            "type":"string",
            "description":"The calculated, numeric value associated with the tax document attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxSnapshotDetailId":{
            "title":"Tax Snapshot Details",
            "type":"integer",
            "description":"The unique identifier of the tax snapshot detail.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TaxDocumentAttributeValueTypeMeaning":{
            "title":"Tax Document Attribute Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the tax document attribute type.",
            "nullable":false,
            "readOnly":true,
            "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",
            "type":"integer",
            "description":"The unique identifier of the tax document attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxDocumentAttributeValueTypeCode":{
            "title":"Tax Document Attribute Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with the tax document attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxPeriodAttributeValue":{
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxDocumentAttributeName":{
            "title":"Tax Document Attribute Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the tax document attribute.",
            "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."
        }
    }
}

Back to Top