Get all transaction tax lines
get
/fscmRestApi/resources/11.13.18.05/transactionTaxLines
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 all transaction tax lines that matches with the specified tax line identifier.
Finder Variables:- TaxLineId; integer; Unique tax line identifier.
- findByTransactionFinder: Finds all transaction tax lines that match with the specified transaction identifier, transaction line identifier, cancel flag, tax inclusive flag, self -assessed flag, transaction level type, application ID, entity code, and event class code.
Finder Variables:- ApplicationId; integer; Application identifier of the transaction.
- Cancelled; string; Indicates whether this tax line is cancelled by the user. Valid values are Y or N.
- EntityCode; string; Entity code of the transaction.
- EventClassCode; string; Event class code of the transaction.
- SelfAssessed; string; Indicates whether this is a self-assessed tax line. Valid values are Y or N.
- TaxAmountIncluded; string; Indicates whether this tax line is inclusive. Valid values are Y or N.
- TrxId; integer; Transaction identifier of the tax line.
- TrxLevelType; string; Internal organization identifier of the transaction.
- TrxLineId; string; Transaction line identifier of the tax line.
- PrimaryKey: Finds all transaction tax lines that matches with the specified tax line identifier.
-
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:- ApplicationId; integer; The unique identifier of the application associated with the transaction.
- Cancelled; string; Indicates whether this tax line is cancelled by the user. Valid values are Y or N.
- ContentOwnerId; integer; The unique identifier of the party tax profile of the first-party organization associated with the transaction.
- EntityCode; string; The code of entity associated with the transaction.
- EventClassCode; string; The code of the event class code associated with the transaction.
- ExemptCertificateNumber; string; The number of the tax exemption certificate.
- InternalOrganizationId; integer; The unique identifier of the internal organization associated with the transaction.
- LineAmount; number; The transaction line amount for this tax line.
- PlaceOfSupplyTypeCode; string; The lookup code for place of supply of this tax line.
- SelfAssessed; string; Indicates whether this is a self-assessed tax line. Valid values are Y or N.
- SummaryTaxLineId; integer; The unique identifier of the summary line associated with the tax line.
- Tax; string; The code of the tax associated with the tax rate.
- TaxAmount; number; The tax amount for this tax line.
- TaxAmountIncluded; string; Indicates whether this tax line is inclusive. Valid values are Y or N.
- TaxDate; string; The date when the applicable tax rates and rules are determined for the current transaction.
- TaxDetermineDate; string; The date when the applicable tax rates and rules are determined. If the adjusted document is present, then this is the tax date of the adjusted document. If not, then it is the tax date of this tax line.
- TaxId; integer; The unique identifier of the tax associated with the tax rate.
- TaxJurisdictionCode; string; The code of the tax jurisdiction associated with the tax rate.
- TaxJurisdictionId; integer; The unique identifier of the tax jurisdiction associated with the tax rate.
- TaxJurisdictionName; string; The name of the tax jurisdiction associated with the tax rate.
- TaxLineId; integer; The unique identifier of the tax line.
- TaxLineNumber; integer; The unique number of a tax line within a transaction line.
- TaxOnlyLine; string; Indicates whether this is a tax only line. Valid values are Y or N.
- TaxPointBasis; string; The tax point basis for the tax line.
- TaxPointDate; string; The date when the taxpayer becomes liable for paying the tax to the tax authority. It can be the delivery date, the invoice date, or the pickup date.
- TaxRate; number; The rate of the tax associated with the tax line.
- TaxRateCode; string; The code of the tax rate associated with the tax line.
- TaxRateId; integer; The unique identifier of a tax rate associated with the tax line.
- TaxRateName; string; The name of the tax rate associated with the tax line.
- TaxRateType; string; The lookup code that indicates type of the tax rate. Possible values include PERCENTAGE, QUANTITY, and RECOVERY.
- TaxRegimeCode; string; The code of the tax regime associated with the tax rate.
- TaxRegimeId; integer; The unique identifier of the tax regime associated with the tax rate.
- TaxRegimeName; string; The name of the tax regime associated with the tax rate.
- TaxStatusCode; string; The code of the tax status associated with the tax rate.
- TaxStatusId; integer; The unique identifier of the tax status associated with the tax rate.
- TaxStatusName; string; The name of the tax status associated with the tax rate.
- TaxableAmount; number; The taxable amount for this tax line.
- TrxId; integer; The unique identifier of a transaction associated with the tax line.
- TrxLevelType; string; The level at which the transaction line identifier is stored. Possible values are LINE, SHIPMENT, and FREIGHT.
- TrxLineId; integer; The unique identifier of a transaction line associated with the tax line.
- TrxLineNumber; integer; The number of a transaction line associated with the tax line.
- TrxNumber; string; The number of the transaction associated with the tax line.
- UnroundedTaxAmount; number; The unrounded tax amount for this tax line.
- UnroundedTaxableAmount; number; The unrounded taxable amount for this tax line.
- WhtGroupId; integer; The unique identifier of the withholding tax group associated with the tax line.
- WhtTaxClassificationCode; string; The unique identifier/code of the withholding tax group associated with the tax line.
-
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:
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : transactionTaxLines
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transactionTaxLines-item-response
Type:
Show Source
object
-
ApplicationId: integer
The unique identifier of the application associated with the transaction.
-
Cancelled: string
Maximum Length:
1
Indicates whether this tax line is cancelled by the user. Valid values are Y or N. -
ContentOwnerId: integer
(int64)
The unique identifier of the party tax profile of the first-party organization associated with the transaction.
-
EntityCode: string
Maximum Length:
30
The code of entity associated with the transaction. -
EventClassCode: string
Maximum Length:
30
The code of the event class code associated with the transaction. -
ExemptCertificateNumber: string
Maximum Length:
80
The number of the tax exemption certificate. -
InternalOrganizationId: integer
The unique identifier of the internal organization associated with the transaction.
-
LineAmount: number
The transaction line amount for this tax line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlaceOfSupplyTypeCode: string
Maximum Length:
30
The lookup code for place of supply of this tax line. -
SelfAssessed: string
Maximum Length:
1
Indicates whether this is a self-assessed tax line. Valid values are Y or N. -
SummaryTaxLineId: integer
(int64)
The unique identifier of the summary line associated with the tax line.
-
Tax: string
Maximum Length:
30
The code of the tax associated with the tax rate. -
TaxableAmount: number
The taxable amount for this tax line.
-
TaxAmount: number
The tax amount for this tax line.
-
TaxAmountIncluded: string
Maximum Length:
1
Indicates whether this tax line is inclusive. Valid values are Y or N. -
TaxDate: string
(date)
The date when the applicable tax rates and rules are determined for the current transaction.
-
TaxDetermineDate: string
(date)
The date when the applicable tax rates and rules are determined. If the adjusted document is present, then this is the tax date of the adjusted document. If not, then it is the tax date of this tax line.
-
TaxId: integer
(int64)
The unique identifier of the tax associated with the tax rate.
-
TaxJurisdictionCode: string
Maximum Length:
30
The code of the tax jurisdiction associated with the tax rate. -
TaxJurisdictionId: integer
(int64)
The unique identifier of the tax jurisdiction associated with the tax rate.
-
TaxJurisdictionName: string
Maximum Length:
255
The name of the tax jurisdiction associated with the tax rate. -
TaxLineId: integer
(int64)
The unique identifier of the tax line.
-
TaxLineNumber: integer
The unique number of a tax line within a transaction line.
-
TaxOnlyLine: string
Maximum Length:
1
Indicates whether this is a tax only line. Valid values are Y or N. -
TaxPointBasis: string
Maximum Length:
30
The tax point basis for the tax line. -
TaxPointDate: string
(date)
The date when the taxpayer becomes liable for paying the tax to the tax authority. It can be the delivery date, the invoice date, or the pickup date.
-
TaxRate: number
The rate of the tax associated with the tax line.
-
TaxRateCode: string
Maximum Length:
150
The code of the tax rate associated with the tax line. -
TaxRateId: integer
(int64)
The unique identifier of a tax rate associated with the tax line.
-
TaxRateName: string
Maximum Length:
255
The name of the tax rate associated with the tax line. -
TaxRateType: string
Maximum Length:
30
The lookup code that indicates type of the tax rate. Possible values include PERCENTAGE, QUANTITY, and RECOVERY. -
TaxRegimeCode: string
Maximum Length:
30
The code of the tax regime associated with the tax rate. -
TaxRegimeId: integer
(int64)
The unique identifier of the tax regime associated with the tax rate.
-
TaxRegimeName: string
Maximum Length:
255
The name of the tax regime associated with the tax rate. -
TaxStatusCode: string
Maximum Length:
30
The code of the tax status associated with the tax rate. -
TaxStatusId: integer
(int64)
The unique identifier of the tax status associated with the tax rate.
-
TaxStatusName: string
Maximum Length:
255
The name of the tax status associated with the tax rate. -
TrxId: integer
The unique identifier of a transaction associated with the tax line.
-
TrxLevelType: string
Maximum Length:
30
The level at which the transaction line identifier is stored. Possible values are LINE, SHIPMENT, and FREIGHT. -
TrxLineId: integer
The unique identifier of a transaction line associated with the tax line.
-
TrxLineNumber: integer
The number of a transaction line associated with the tax line.
-
TrxNumber: string
Maximum Length:
150
The number of the transaction associated with the tax line. -
UnroundedTaxableAmount: number
The unrounded taxable amount for this tax line.
-
UnroundedTaxAmount: number
The unrounded tax amount for this tax line.
-
WhtGroupId: integer
(int64)
The unique identifier of the withholding tax group associated with the tax line.
-
WhtTaxClassificationCode: string
Maximum Length:
30
The unique identifier/code of the withholding tax group associated with the tax line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.