Get all party tax profiles
get
/fscmRestApi/resources/11.13.18.05/partyTaxProfiles
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 party tax profiles that match the specified party tax profile identifier.
Finder Variables:- PartyTaxProfileId; integer; Unique identifier of the party tax profile.
- PrimaryKey: Finds all party tax profiles that match the specified party tax profile 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:- AllowOffsetTaxFlag; boolean; Indicates if a party tax profile has been configured to allow withholding tax calculation. The default value is NO.
- AllowZeroAmountWhtInvoiceFlag; boolean; Indicates if a party tax profile has been configured to allow offset tax calculation. The default value is NO.
- CountryCode; string; The country in the party address for which the party tax profile is defined.
- CustomerFlag; boolean; Indicates whether this party tax profile is for a customer. Valid values are Y or N.
- EffectiveFromUseLe; string; The date when the party tax profile starts being effective.
- InclusiveTaxFlag; boolean; Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO.
- PartyId; integer; Unique identifier of the party for which the party tax profile is defined.
- PartyName; string; The party name for which the party tax profile is defined.
- PartyNumber; string; The party number for which the party tax profile is defined.
- PartySiteNumber; string; The party site number for which the party tax profile is defined.
- PartyTaxProfileId; integer; The system-generated unique identifier of the party tax profile.
- PartyTypeCode; string; The party type code of the party tax profile.
- ProcessForApplicabilityFlag; boolean; Indicates whether the party tax profile definition is taken into account during tax applicability determination. The default value is YES.
- RegistrationTypeCode; string; The registration type code associated with a party tax profile.
- RepresentativeRegistrationNumber; string; The registration number associated with a party tax profile.
- RoundingLevelCode; string; The rounding level code associated with a party tax profile.
- RoundingRuleCode; string; The rounding rule code associated with a party tax profile.
- SiteFlag; boolean; Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N.
- SupplierFlag; boolean; Indicates whether this party tax profile is for a supplier. Valid values are Y or N.
- TaxClassificationCode; string; The tax classification code associated with a party tax profile.
- TaxGrossNetFlagCode; string; Indicates whether the tax and withholding are calculated on the net amount or the gross amount (that is, without deducting the retainage amount from the line amount) for Payables retainage invoices. The default value is Net.
- UseLeAsSubscriberFlag; boolean; Indicates whether a business unit party tax profile will be configured to use the subscription of the associated legal entity for transaction tax determination purposes. The default value is NO.
- WhtDateBasis; string; The date when the withholding tax basis determination begins.
- WhtRoundingLevelCode; string; The withholding rounding level code associated with a party tax profile.
- WhtRoundingRuleCode; string; The withholding rounding rule code associated with a party tax profile.
- WhtUseLeAsSubscriberFlag; boolean; Indicates whether a business unit party tax profile will be configured to use the subscription of the associated legal entity for transaction tax determination purposes. The default value is NO.
-
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 : partyTaxProfiles
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 : partyTaxProfiles-item-response
Type:
Show Source
object
-
AllowOffsetTaxFlag: boolean
Title:
Allow offset tax calculation
Maximum Length:1
Indicates if a party tax profile has been configured to allow withholding tax calculation. The default value is NO. -
AllowZeroAmountWhtInvoiceFlag: boolean
Title:
Create zero amount tax authority invoices
Maximum Length:1
Indicates if a party tax profile has been configured to allow offset tax calculation. The default value is NO. -
CountryCode: string
Title:
Country Code
Maximum Length:2
The country in the party address for which the party tax profile is defined. -
CustomerFlag: boolean
Maximum Length:
1
Indicates whether this party tax profile is for a customer. Valid values are Y or N. -
EffectiveFromUseLe: string
(date)
Title:
Use Subscription of the Legal Entity Start Date
The date when the party tax profile starts being effective. -
InclusiveTaxFlag: boolean
Title:
Set Invoice Values as Tax Inclusive
Maximum Length:1
Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Unique identifier of the party for which the party tax profile is defined.
-
PartyName: string
Title:
Party Name
Maximum Length:360
The party name for which the party tax profile is defined. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The party number for which the party tax profile is defined. -
PartySiteNumber: string
Title:
Party Site Number
Maximum Length:30
The party site number for which the party tax profile is defined. -
PartyTaxProfileId: integer
(int64)
The system-generated unique identifier of the party tax profile.
-
PartyTypeCode: string
Title:
Party Type
Maximum Length:30
The party type code of the party tax profile. -
ProcessForApplicabilityFlag: boolean
Title:
Tax Applicability
Maximum Length:1
Indicates whether the party tax profile definition is taken into account during tax applicability determination. The default value is YES. -
RegistrationTypeCode: string
Title:
Tax Registration Type Code
Maximum Length:30
The registration type code associated with a party tax profile. -
RepresentativeRegistrationNumber: string
Title:
Tax Registration Number
Maximum Length:50
The registration number associated with a party tax profile. -
RoundingLevelCode: string
Title:
Rounding Level
Maximum Length:30
The rounding level code associated with a party tax profile. -
RoundingRuleCode: string
Title:
Rounding Rule
Maximum Length:30
The rounding rule code associated with a party tax profile. -
SiteFlag: boolean
Maximum Length:
1
Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N. -
SupplierFlag: boolean
Maximum Length:
1
Indicates whether this party tax profile is for a supplier. Valid values are Y or N. -
TaxClassificationCode: string
Title:
Tax Classification Code
Maximum Length:30
The tax classification code associated with a party tax profile. -
TaxGrossNetFlagCode: string
Maximum Length:
1
Indicates whether the tax and withholding are calculated on the net amount or the gross amount (that is, without deducting the retainage amount from the line amount) for Payables retainage invoices. The default value is Net. -
UseLeAsSubscriberFlag: boolean
Title:
Use legal entity tax subscription
Maximum Length:1
Indicates whether a business unit party tax profile will be configured to use the subscription of the associated legal entity for transaction tax determination purposes. The default value is NO. -
WhtDateBasis: string
Title:
Withholding Tax Determination Basis
Maximum Length:30
The date when the withholding tax basis determination begins. -
WhtRoundingLevelCode: string
Title:
Withholding Rounding Level
Maximum Length:30
The withholding rounding level code associated with a party tax profile. -
WhtRoundingRuleCode: string
Title:
Withholding Rounding Rule
Maximum Length:30
The withholding rounding rule code associated with a party tax profile. -
WhtUseLeAsSubscriberFlag: boolean
Title:
Uses Legal Entity Withholding Tax Subscription
Maximum Length:1
Indicates whether a business unit party tax profile will be configured to use the subscription of the associated legal entity for transaction tax determination purposes. The default value is NO.
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.
Examples
The following example shows how to retrieve all the party tax profiles by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "PartyTypeCode": "THIRD_PARTY_SITE", "PartyName": "Vision", "PartyNumber": "50620", "PartySiteNumber": "21905", "RoundingLevelCode": "LINE", "RoundingRuleCode": "UP", "InclusiveTaxFlag": true, "TaxClassificationCode": "25% svensk moms", "AllowOffsetTaxFlag": false, "AllowZeroAmountWhtInvoiceFlag": null, "CountryCode": null, "EffectiveFromUseLe": null, "ProcessForApplicabilityFlag": true, "RegistrationTypeCode": null, "RepresentativeRegistrationNumber": "12345678912", "UseLeAsSubscriberFlag": false, "WhtDateBasis": null, "WhtRoundingLevelCode": null, "WhtRoundingRuleCode": null, "WhtUseLeAsSubscriberFlag": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531", "name": "partyTaxProfiles", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531", "name": "partyTaxProfiles", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531/lov/taxRoundingLevelLookups", "name": "taxRoundingLevelLookups", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531/lov/registrationTypeLookups", "name": "registrationTypeLookups", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531/lov/territories", "name": "territories", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531/lov/yesNoLookups", "name": "yesNoLookups", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531/lov/taxClassifications", "name": "taxClassifications", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531/lov/taxRoundingRuleLookups", "name": "taxRoundingRuleLookups", "kind": "collection" } ] }, ... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles", "name": "partyTaxProfiles", "kind": "collection" } ] }