Jump to

• Request
• Response

Get all tax document snapshots

get

/fscmRestApi/resources/11.13.18.05/taxDocumentSnapshots

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
  
  

  • ByTaxSnapshotIdFinder Finds the tax document snapshot that matches the identifier provided.
    Finder Variables
    • TaxSnapshotId; integer; The unique identifier of the tax document snapshot.
  • PrimaryKey Finds the tax document snapshot that matches the primary key criteria specified.
    Finder Variables
    • TaxSnapshotId; integer; The unique identifier of the tax document snapshot.
• 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 or not. The default is false.
  • BusinessUnitId; integer; The unique identifier of the academic business unit.
  • BusinessUnitName; string; The name of the academic business unit.
  • ConsentMessage; string; User-entered message that displays when consent for electronic delivery is required.
  • CreationDate; string; The date when the tax document snapshot was created.
  • CurrencyCode; string; The currency code associated with the academic business unit of the tax document.
  • CurrencySymbol; string; The currency symbol associated with the currency code.
  • IdentificationNumber; string; User-entered identification number of the tax reporting institution.
  • LastModifiedDate; string; The date and time of the last modification.
  • 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.
  • PartyId; integer; The unique identifier of the student party.
  • PartyName; string; The name of the student party.
  • PeriodEndDate; string; The end date of the tax period.
  • PeriodName; string; The name of the tax period.
  • PeriodStartDate; string; The start date of the tax period.
  • PrimaryEmailAddress; string; The primary email address of the student.
  • StatusCode; string; The status code of the version of the tax document snapshot.
  • StatusMeaning; string; The status name of the version of the tax document snapshot.
  • TaxDocumentSetupCode; string; The code associated with the tax document setup.
  • TaxDocumentSetupId; integer; The unique identifier of the tax document setup.
  • TaxDocumentSetupName; string; The name associated with the tax document setup.
  • TaxPeriodId; integer; The unique identifier of the tax period.
  • TaxSnapshotId; integer; The unique identifier of the tax document snapshot.
  • VersionDescription; string; The description of the version of the tax document snapshot.
  • VersionName; string; The name of the tax document snapshot version.
  • VersionNumber; integer; The number of the tax document snapshot version.
• 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 : taxDocumentSnapshots

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSnapshots-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object taxDocumentSnapshots-item-response

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

Type: object

Show Source

• AllowElectronicFlag: boolean
  Title: Allow electronic delivery

  Read Only: true

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  The unique identifier of the academic business unit.
• BusinessUnitName: string
  Title: Business Unit Name

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 1000

  Default Value: -

  User-entered message that displays when consent for electronic delivery is required.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the tax document snapshot was created.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  The currency code associated with the academic business unit of the tax document.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  Maximum Length: 12

  The currency symbol associated with the currency code.
• IdentificationNumber: string
  Title: Tax Identification Number

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  The date and time of the last modification.
• LinkDisplayName: string
  Title: Link Display Name

  Read Only: true

  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

  Read Only: true

  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

  Read Only: true

  Maximum Length: 1000

  Default Value: -

  User-entered message that can be displayed on the student tax document page.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the student party.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the student party.
• PeriodEndDate: string (date-time)
  Title: Tax Period End Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  The start date of the tax period.
• PrimaryEmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The primary email address of the student.
• snapshotDetails: array Tax Document Snapshot Details
  Title: Tax Document Snapshot Details

  The calculated values that you can associate with a tax document snapshot. You can view calculated values by a tax attribute such as received payments or received financial aid.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The status code of the version of the tax document snapshot.
• StatusMeaning: string
  Title: Status Name

  Read Only: true

  Maximum Length: 80

  The status name of the version of the tax document snapshot.
• TaxDocumentSetupCode: string
  Title: Document Code

  Maximum Length: 30

  The code associated with the tax document setup.
• TaxDocumentSetupId: integer
  Title: Tax Document

  The unique identifier of the tax document setup.
• TaxDocumentSetupName: string
  Title: Document Name

  Read Only: true

  Maximum Length: 50

  The name associated with the tax document setup.
• taxPeriodAttributes: array Tax Period Attributes
  Title: Tax Period Attributes

  Tax period attributes represent the attribute logic used to generate a tax document for a tax period.
• TaxPeriodId: integer (int64)
  Title: Tax Period

  The unique identifier of the tax period.
• TaxSnapshotId: integer
  Title: Tax Snapshot

  Read Only: true

  The unique identifier of the tax document snapshot.
• VersionDescription: string
  Title: Version Description

  Maximum Length: 240

  The description of the version of the tax document snapshot.
• VersionName: string
  Title: Version Name

  Maximum Length: 50

  The name of the tax document snapshot version.
• VersionNumber: integer (int32)
  Title: Version Number

  The number of the tax document snapshot version.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the tax document snapshot was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastModifiedDate":{
            "title":"Last Modified Date",
            "type":"string",
            "description":"The date and time of the last modification.",
            "format":"date-time",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxSnapshotId":{
            "title":"Tax Snapshot",
            "type":"integer",
            "description":"The unique identifier of the tax document snapshot.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the student party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowElectronicFlag":{
            "title":"Allow electronic delivery",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether electronic delivery of the tax document is allowed or not. The default is false.",
            "nullable":true,
            "readOnly":true,
            "default":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,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxPeriodId":{
            "title":"Tax Period",
            "type":"integer",
            "description":"The unique identifier of the tax period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the version of the tax document snapshot.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "snapshotDetails":{
            "title":"Tax Document Snapshot Details",
            "type":"array",
            "description":"The calculated values that you can associate with a tax document snapshot. You can view calculated values by a tax attribute such as received payments or received financial aid.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSnapshots-snapshotDetails-item-response"
            }
        },
        "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,
            "readOnly":true,
            "default":"-",
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":12,
            "type":"string",
            "description":"The currency symbol associated with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the academic business unit of the tax document.",
            "nullable":false,
            "readOnly":true,
            "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,
            "readOnly":true,
            "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,
            "readOnly":true,
            "default":"-",
            "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,
            "readOnly":true,
            "default":"-",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the tax document snapshot version.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the academic business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "taxPeriodAttributes":{
            "title":"Tax Period Attributes",
            "type":"array",
            "description":"Tax period attributes represent the attribute logic used to generate a tax document for a tax period.",
            "items":{
                "$ref":"#/components/schemas/taxDocumentSnapshots-taxPeriodAttributes-item-response"
            }
        },
        "TaxDocumentSetupName":{
            "title":"Document Name",
            "maxLength":50,
            "type":"string",
            "description":"The name associated with the tax document setup.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxDocumentSetupId":{
            "title":"Tax Document",
            "type":"integer",
            "description":"The unique identifier of the tax document setup.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "TaxDocumentSetupCode"
                ]
            },
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Version Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the version of the tax document snapshot.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the academic business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Tax Period Start Date",
            "type":"string",
            "description":"The start date of the tax period.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version Number",
            "type":"integer",
            "description":"The number of the tax document snapshot version.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status Name",
            "maxLength":80,
            "type":"string",
            "description":"The status name of the version of the tax document snapshot.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryEmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The primary email address of the student.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "TaxDocumentSetupCode":{
            "title":"Document Code",
            "maxLength":30,
            "type":"string",
            "description":"The code associated with the tax document setup.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the student party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Tax Period Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the tax period.",
            "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 Document Snapshot Details

Type: array

Title: Tax Document Snapshot Details

The calculated values that you can associate with a tax document snapshot. You can view calculated values by a tax attribute such as received payments or received financial aid.

Show Source

• Array of: object taxDocumentSnapshots-snapshotDetails-item-response

{
    "title":"Tax Document Snapshot Details",
    "type":"array",
    "description":"The calculated values that you can associate with a tax document snapshot. You can view calculated values by a tax attribute such as received payments or received financial aid.",
    "items":{
        "$ref":"#/components/schemas/taxDocumentSnapshots-snapshotDetails-item-response"
    }
}

Nested Schema : Tax Period Attributes

Type: array

Title: Tax Period Attributes

Tax period attributes represent the attribute logic used to generate a tax document for a tax period.

Show Source

• Array of: object taxDocumentSnapshots-taxPeriodAttributes-item-response

{
    "title":"Tax Period Attributes",
    "type":"array",
    "description":"Tax period attributes represent the attribute logic used to generate a tax document for a tax period.",
    "items":{
        "$ref":"#/components/schemas/taxDocumentSnapshots-taxPeriodAttributes-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 : 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 : taxDocumentSnapshots-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

  Read Only: true

  Maximum Length: 30

  Code of the tax document setup.
• TaxDocumentAttributeId: integer (int64)
  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

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

  Read Only: true

  The 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":"The 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-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,
            "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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Links

createPreview

Operation: /fscmRestApi/resources/11.13.18.05/taxDocumentSnapshots/action/createPreview

Retrieves all tax snapshot previews for a student by tax document type and tax period.

Back to Top