Jump to

• Request
• Response

Get all tax documents

get

/fscmRestApi/resources/11.13.18.05/taxDocumentSetups

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the tax document that matches the primary key criteria specified.
    Finder Variables
    • TaxDocumentSetupId; integer; The unique identifier of the tax document.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AllowElectronicFlag; boolean; Indicates whether electronic delivery of the tax document is allowed. The default is false.
  • BusinessUnitId; integer; Identifier of the academic business unit.
  • BusinessUnitName; string; Name of the academic business unit.
  • ConsentMessage; string; User-entered message that displays when consent for electronic delivery is required.
  • DocumentTypeCode; string; Unique tax document type code.
  • DocumentTypeMeaning; string; Name of the tax document type.
  • IdentificationNumber; string; User-entered identification number of the tax reporting institution.
  • LastUpdateDate; string; Date and time of the last update to the row.
  • LinkDisplayName; string; User-entered display name for hyperlink that can be displayed on the student tax document page.
  • LinkDisplayURL; string; User-entered hyperlink URL that can be displayed on the student tax document page.
  • NotificationMessage; string; User-entered message that can be displayed on the student tax document page.
  • RequireConsentFlag; boolean; Indicates whether individual consent to electronic deliver of the tax document is required. The default is false.
  • TaxDocumentSetupCode; string; Unique, user-defined code for the tax document.
  • TaxDocumentSetupId; integer; Unique identifier for a tax document.
  • TaxDocumentSetupName; string; Name of the tax document.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSetups-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object taxDocumentSetups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/taxDocumentSetups-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 : taxDocumentSetups-item-response

Type: object

Show Source

• AllowElectronicFlag: boolean
  Title: Allow electronic delivery

  Maximum Length: 1

  Default Value: false

  Indicates whether electronic delivery of the tax document is allowed. The default is false.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Identifier of the academic business unit.
• BusinessUnitName: string
  Title: Business Unit Name

  Maximum Length: 240

  Name of the academic business unit.
• ConsentMessage: string
  Title: Acknowledgment Message

  Maximum Length: 1000

  Default Value: -

  User-entered message that displays when consent for electronic delivery is required.
• DocumentTypeCode: string
  Title: Document Type Code

  Maximum Length: 30

  Unique tax document type code.
• DocumentTypeMeaning: string
  Title: Document Type

  Read Only: true

  Maximum Length: 80

  Name of the tax document type.
• IdentificationNumber: string
  Title: Tax Identification Number

  Maximum Length: 100

  User-entered identification number of the tax reporting institution.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time of the last update to the row.
• LinkDisplayName: string
  Title: Link Display Name

  Maximum Length: 100

  Default Value: -

  User-entered display name for hyperlink that can be displayed on the student tax document page.
• LinkDisplayURL: string
  Title: Link URL

  Maximum Length: 100

  Default Value: -

  User-entered hyperlink URL that can be displayed on the student tax document page.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationMessage: string
  Title: Tax Document Notification Message

  Maximum Length: 1000

  Default Value: -

  User-entered message that can be displayed on the student tax document page.
• RequireConsentFlag: boolean
  Title: Require consent for electronic delivery

  Maximum Length: 1

  Default Value: false

  Indicates whether individual consent to electronic deliver of the tax document is required. The default is false.
• TaxDocumentSetupCode: string
  Title: Document Code

  Maximum Length: 30

  Unique, user-defined code for the tax document.
• TaxDocumentSetupId: integer (int64)
  Title: Tax Document

  Read Only: true

  Unique identifier for a tax document.
• TaxDocumentSetupName: string
  Title: Document Name

  Maximum Length: 50

  Name of the tax document.
• taxPeriods: array Tax Periods
  Title: Tax Periods

  The tax periods associated with a tax document. Tax periods are the ranges of time for which a tax document reports financial information.

{
    "type":"object",
    "properties":{
        "AllowElectronicFlag":{
            "title":"Allow electronic delivery",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether electronic delivery of the tax document is allowed. The default is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Identifier of the academic business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the academic business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConsentMessage":{
            "title":"Acknowledgment Message",
            "maxLength":1000,
            "type":"string",
            "description":"User-entered message that displays when consent for electronic delivery is required.",
            "nullable":false,
            "default":"-",
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "title":"Document Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique tax document type code.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DocumentTypeMeaning":{
            "title":"Document Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the tax document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentificationNumber":{
            "title":"Tax Identification Number",
            "maxLength":100,
            "type":"string",
            "description":"User-entered identification number of the tax reporting institution.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time of the last update to the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkDisplayName":{
            "title":"Link Display Name",
            "maxLength":100,
            "type":"string",
            "description":"User-entered display name for hyperlink that can be displayed on the student tax document page.",
            "nullable":false,
            "default":"-",
            "x-queryable":true
        },
        "LinkDisplayURL":{
            "title":"Link URL",
            "maxLength":100,
            "type":"string",
            "description":"User-entered hyperlink URL that can be displayed on the student tax document page.",
            "nullable":false,
            "default":"-",
            "x-queryable":true
        },
        "NotificationMessage":{
            "title":"Tax Document Notification Message",
            "maxLength":1000,
            "type":"string",
            "description":"User-entered message that can be displayed on the student tax document page.",
            "nullable":false,
            "default":"-",
            "x-queryable":true
        },
        "RequireConsentFlag":{
            "title":"Require consent for electronic delivery",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether individual consent to electronic deliver of the tax document is required. The default is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "TaxDocumentSetupCode":{
            "title":"Document Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique, user-defined code for the tax document.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxDocumentSetupId":{
            "title":"Tax Document",
            "type":"integer",
            "description":"Unique identifier for a tax document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TaxDocumentSetupName":{
            "title":"Document Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the tax document.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "taxPeriods":{
            "title":"Tax Periods",
            "type":"array",
            "description":"The tax periods associated with a tax document. Tax periods are the ranges of time for which a tax document reports financial information.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-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 : Tax Periods

Type: array

Title: Tax Periods

The tax periods associated with a tax document. Tax periods are the ranges of time for which a tax document reports financial information.

Show Source

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

{
    "title":"Tax Periods",
    "type":"array",
    "description":"The tax periods associated with a tax document. Tax periods are the ranges of time for which a tax document reports financial information.",
    "items":{
        "$ref":"#/components/schemas/taxDocumentSetups-taxPeriods-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-item-response

Type: object

Show Source

• CalendarItemId: integer (int64)
  Title: Calendar Item ID

  Read Only: true

  Unique identifier of the system calendar item.
• ContactEmail: string
  Title: Email

  Read Only: true

  Maximum Length: 1000

  Primary email address of the external organization contact.
• ContactId: integer (int64)
  Title: Contact ID

  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
  Title: Phone Number

  Read Only: true

  Maximum Length: 40

  Phone number of the external organization contact.
• ExternalOrgId: integer (int64)
  Title: External Organization ID

  Unique identifier for an external organization.
• ExternalOrgName: string
  Title: External Organizations

  Maximum Length: 360

  Name of the external organization.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  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)
  Title: Tax Period

  Read Only: true

  Unique identifier for a tax period.

{
    "type":"object",
    "properties":{
        "CalendarItemId":{
            "title":"Calendar Item ID",
            "type":"integer",
            "description":"Unique identifier of the system calendar item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactEmail":{
            "title":"Email",
            "maxLength":1000,
            "type":"string",
            "description":"Primary email address of the external organization contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"Unique identifier of the external organization contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "ContactPhone":{
            "title":"Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"Phone number of the external organization contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalOrgId":{
            "title":"External Organization ID",
            "type":"integer",
            "description":"Unique identifier for an external organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time of the last update to the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "PeriodEndDate":{
            "title":"Tax Period End Date",
            "type":"string",
            "description":"The end date of the tax period.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Tax Period Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the tax period.",
            "nullable":false,
            "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
        },
        "TaxPeriodId":{
            "title":"Tax Period",
            "type":"integer",
            "description":"Unique identifier for a tax period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

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 : 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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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
  Title: Criteria Type Code

  Maximum Length: 30

  Code of the calculation criteria associated with the tax period.
• CriteriaTypeMeaning: string
  Title: Criteria Type Name

  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)
  Title: Tax Period Criteria ID

  Read Only: true

  Identifier of the calculation criteria associated with the tax period.
• ValueNumeric: number
  Title: Tax Attribute Numeric Value

  Number indicating the tax period attribute being seeded.
• ValueString: string
  Title: Tax Attribute String Value

  Maximum Length: 100

  Description of the tax period attribute being seeded.

{
    "type":"object",
    "properties":{
        "CriteriaTypeCode":{
            "title":"Criteria Type Code",
            "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
        },
        "CriteriaTypeMeaning":{
            "title":"Criteria Type Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the criteria type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxPeriodCriteriaId":{
            "title":"Tax Period Criteria ID",
            "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
        },
        "ValueNumeric":{
            "title":"Tax Attribute Numeric Value",
            "type":"number",
            "description":"Number indicating the tax period attribute being seeded.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueString":{
            "title":"Tax Attribute String Value",
            "maxLength":100,
            "type":"string",
            "description":"Description of the tax period attribute being seeded.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Back to Top