Jump to

• Request
• Response

Update a tax period

patch

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

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=
• 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:
  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

• CalendarItemId: integer (int64)
  Unique identifier of the system calendar item.
• ContactId: integer (int64)
  Unique identifier of the external organization contact.
• ExternalOrgId: integer (int64)
  Unique identifier for an external organization.
• ExternalOrgName: string
  Title: External Organizations

  Maximum Length: 360

  Name of the external organization.
• PeriodEndDate: string (date-time)
  Title: Tax Period End Date

  The end date of the tax period.
• PeriodName: string
  Title: Tax Period Name

  Maximum Length: 240

  Name of the tax period.
• PeriodStartDate: string (date-time)
  Title: Tax Period Start Date

  The start date of the tax period.
• taxPeriodAttributes: array Tax Period Attributes
  Title: Tax Period Attributes

  The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.
• taxPeriodCriteria: array Tax Period Criteria
  Title: Tax Period Criteria

  The calculation logic used to generate a tax document for a period.
• TaxPeriodId: integer (int64)
  Unique identifier for a tax period.

{
    "type":"object",
    "properties":{
        "ExternalOrgName":{
            "title":"External Organizations",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the external organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "taxPeriodCriteria":{
            "title":"Tax Period Criteria",
            "type":"array",
            "description":"The calculation logic used to generate a tax document for a period.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-taxPeriodCriteria-item-patch-request"
            }
        },
        "ExternalOrgId":{
            "type":"integer",
            "description":"Unique identifier for an external organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"Unique identifier of the external organization contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PeriodName":{
            "title":"Tax Period Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the tax period.",
            "nullable":false
        },
        "TaxPeriodId":{
            "type":"integer",
            "description":"Unique identifier for a tax period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PeriodEndDate":{
            "title":"Tax Period End Date",
            "type":"string",
            "description":"The end date of the tax period.",
            "format":"date-time",
            "nullable":true
        },
        "taxPeriodAttributes":{
            "title":"Tax Period Attributes",
            "type":"array",
            "description":"The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-taxPeriodAttributes-item-patch-request"
            }
        },
        "PeriodStartDate":{
            "title":"Tax Period Start Date",
            "type":"string",
            "description":"The start date of the tax period.",
            "format":"date-time",
            "nullable":false
        },
        "CalendarItemId":{
            "type":"integer",
            "description":"Unique identifier of the system calendar item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Tax Period Attributes

Type: array

Title: Tax Period Attributes

The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.

Show Source

• Array of: object schema

{
    "title":"Tax Period Attributes",
    "type":"array",
    "description":"The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.",
    "items":{
        "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-taxPeriodAttributes-item-patch-request"
    }
}

Nested Schema : Tax Period Criteria

Type: array

Title: Tax Period Criteria

The calculation logic used to generate a tax document for a period.

Show Source

• Array of: object taxDocumentSetups-taxPeriods-taxPeriodCriteria-item-patch-request

{
    "title":"Tax Period Criteria",
    "type":"array",
    "description":"The calculation logic used to generate a tax document for a period.",
    "items":{
        "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-taxPeriodCriteria-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Description: string
  Maximum Length: 1000

  Description of the tax period document attribute.
• TaxDocumentAttributeCode: string
  Maximum Length: 30

  Code of the tax document setup.
• TaxDocumentAttributeId: integer (int64)
  Unique identifier of the tax document attribute.
• Value: string
  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":{
            "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":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the tax document setup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the tax period document attribute.",
            "nullable":false
        },
        "TaxDocumentAttributeId":{
            "type":"integer",
            "description":"Unique identifier of the tax document attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : taxDocumentSetups-taxPeriods-taxPeriodCriteria-item-patch-request

Type: object

Show Source

• CriteriaTypeCode: string
  Maximum Length: 30

  Code of the calculation criteria associated with the tax period.
• ValueNumeric: number
  Number indicating the tax period attribute being seeded.
• ValueString: string
  Maximum Length: 100

  Description of the tax period attribute being seeded.

{
    "type":"object",
    "properties":{
        "CriteriaTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the calculation criteria associated with the tax period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "ValueString":{
            "maxLength":"100",
            "type":"string",
            "description":"Description of the tax period attribute being seeded.",
            "nullable":true
        },
        "ValueNumeric":{
            "type":"number",
            "description":"Number indicating the tax period attribute being seeded.",
            "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 : taxDocumentSetups-taxPeriods-item-response

Type: object

Show Source

• CalendarItemId: integer (int64)
  Unique identifier of the system calendar item.
• ContactEmail: string
  Read Only: true

  Maximum Length: 1000

  Primary email address of the external organization contact.
• ContactId: integer (int64)
  Unique identifier of the external organization contact.
• ContactName: string
  Title: Contact Name

  Read Only: true

  Maximum Length: 450

  Name of the external organization contact.
• ContactPhone: string
  Read Only: true

  Maximum Length: 40

  Phone number of the external organization contact.
• ExternalOrgId: integer (int64)
  Unique identifier for an external organization.
• ExternalOrgName: string
  Title: External Organizations

  Maximum Length: 360

  Name of the external organization.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time of the last update to the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodCode: string
  Title: Tax Period Code

  Maximum Length: 30

  Unique, user-defined code for the tax period.
• PeriodEndDate: string (date-time)
  Title: Tax Period End Date

  The end date of the tax period.
• PeriodName: string
  Title: Tax Period Name

  Maximum Length: 240

  Name of the tax period.
• PeriodStartDate: string (date-time)
  Title: Tax Period Start Date

  The start date of the tax period.
• taxPeriodAttributes: array Tax Period Attributes
  Title: Tax Period Attributes

  The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.
• taxPeriodCriteria: array Tax Period Criteria
  Title: Tax Period Criteria

  The calculation logic used to generate a tax document for a period.
• TaxPeriodId: integer (int64)
  Unique identifier for a tax period.

{
    "type":"object",
    "properties":{
        "ExternalOrgName":{
            "title":"External Organizations",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the external organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "taxPeriodCriteria":{
            "title":"Tax Period Criteria",
            "type":"array",
            "description":"The calculation logic used to generate a tax document for a period.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-taxPeriodCriteria-item-response"
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"Unique identifier of the external organization contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaxPeriodId":{
            "type":"integer",
            "description":"Unique identifier for a tax period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"Tax Period End Date",
            "type":"string",
            "description":"The end date of the tax period.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Tax Period Start Date",
            "type":"string",
            "description":"The start date of the tax period.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarItemId":{
            "type":"integer",
            "description":"Unique identifier of the system calendar item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPhone":{
            "maxLength":"40",
            "type":"string",
            "description":"Phone number of the external organization contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalOrgId":{
            "type":"integer",
            "description":"Unique identifier for an external organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactEmail":{
            "maxLength":"1000",
            "type":"string",
            "description":"Primary email address of the external organization contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PeriodName":{
            "title":"Tax Period Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the tax period.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodCode":{
            "title":"Tax Period Code",
            "maxLength":"30",
            "type":"string",
            "description":"Unique, user-defined code for the tax period.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Contact Name",
            "maxLength":"450",
            "type":"string",
            "description":"Name of the external organization contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "taxPeriodAttributes":{
            "title":"Tax Period Attributes",
            "type":"array",
            "description":"The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-taxPeriodAttributes-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time of the last update to the row.",
            "format":"date-time",
            "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 : Tax Period Attributes

Type: array

Title: Tax Period Attributes

The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.

Show Source

• Array of: object taxDocumentSetups-taxPeriods-taxPeriodAttributes-item-response

{
    "title":"Tax Period Attributes",
    "type":"array",
    "description":"The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.",
    "items":{
        "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-taxPeriodAttributes-item-response"
    }
}

Nested Schema : Tax Period Criteria

Type: array

Title: Tax Period Criteria

The calculation logic used to generate a tax document for a period.

Show Source

• Array of: object taxDocumentSetups-taxPeriods-taxPeriodCriteria-item-response

{
    "title":"Tax Period Criteria",
    "type":"array",
    "description":"The calculation logic used to generate a tax document for a period.",
    "items":{
        "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-taxPeriodCriteria-item-response"
    }
}

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

Nested Schema : taxDocumentSetups-taxPeriods-taxPeriodAttributes-item-response

Type: object

Show Source

• Description: string
  Maximum Length: 1000

  Description of the tax period document attribute.
• DocumentAttributeTypeCode: string
  Read Only: true

  Maximum Length: 150

  Code of the tax document attribute type.
• DocumentAttributeTypeMeaning: string
  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
  Maximum Length: 30

  Code of the tax document setup.
• TaxDocumentAttributeId: integer (int64)
  Unique identifier of the tax document attribute.
• TaxDocumentAttributeName: string
  Read Only: true

  Maximum Length: 150

  Name of the tax document setup.
• TaxPeriodAttributeId: integer (int64)
  Read Only: true

  Unique identifier of the tax period attribute.
• Value: string
  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":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the tax period document attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxPeriodAttributeId":{
            "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":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the tax document attribute type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentAttributeTypeCode":{
            "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":{
            "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":{
            "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":{
            "type":"integer",
            "description":"Unique identifier of the tax document attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaxDocumentAttributeName":{
            "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 : taxDocumentSetups-taxPeriods-taxPeriodCriteria-item-response

Type: object

Show Source

• CriteriaTypeCode: string
  Maximum Length: 30

  Code of the calculation criteria associated with the tax period.
• CriteriaTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The name of the criteria type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TaxPeriodCriteriaId: integer (int64)
  Read Only: true

  Identifier of the calculation criteria associated with the tax period.
• ValueNumeric: number
  Number indicating the tax period attribute being seeded.
• ValueString: string
  Maximum Length: 100

  Description of the tax period attribute being seeded.

{
    "type":"object",
    "properties":{
        "CriteriaTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the calculation criteria associated with the tax period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TaxPeriodCriteriaId":{
            "type":"integer",
            "description":"Identifier of the calculation criteria associated with the tax period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CriteriaTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the criteria type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueString":{
            "maxLength":"100",
            "type":"string",
            "description":"Description of the tax period attribute being seeded.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueNumeric":{
            "type":"number",
            "description":"Number indicating the tax period attribute being seeded.",
            "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"
    }
}

Links

externalOrganizationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/externalOrganizations

The following properties are defined on the LOV link relation:

• Source Attribute: ExternalOrgName; Target Attribute: OrganizationName
• Display Attribute: OrganizationName

taxPeriodAttributes

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

Parameters:

• TaxDocumentSetupId: $request.path.TaxDocumentSetupId
• TaxPeriodId: $request.path.TaxPeriodId

The financial attributes used to generate a tax document for a tax period. Financial attributes include fees, payments, and credits.

taxPeriodCriteria

Operation: /fscmRestApi/resources/11.13.18.05/taxDocumentSetups/{TaxDocumentSetupId}/child/taxPeriods/{TaxPeriodId}/child/taxPeriodCriteria

Parameters:

• TaxDocumentSetupId: $request.path.TaxDocumentSetupId
• TaxPeriodId: $request.path.TaxPeriodId

The calculation logic used to generate a tax document for a period.

Back to Top