1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Tax Exemptions

Get all tax exemptions

get

/fscmRestApi/resources/11.13.18.05/taxExemptions

Request

Query Parameters
  • 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).
  • 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
  • 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:

    • ManageTaxExemptionsRF: Finds all tax exemptions that match the specified party number, party name, party type code, and country.
      Finder Variables:
      • country; string; The country associated with a tax exemption.
      • partyName; string; The party name associated with a tax exemption.
      • partyNumber; string; The party number associated with a tax exemption.
      • partyTypeCode; string; The party type code associated with a tax exemption.
    • PrimaryKey: Finds all tax exemptions that match the specified exemption identifier.
      Finder Variables:
      • TaxExemptionId; integer; The unique identifier of the tax exemption.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ApplyToLowerLevelsFlag; boolean; The action to apply a tax exemption to all taxes that use this tax as the tax exemptions source. For example, if a STATE tax is configured as the tax exemption source for both the COUNTY and CITY tax, then checking this box applies the tax exemption at both of the COUNTY and CITY tax levels.
    • ClauseReference; string; The legal tax clause on the basis of which the Letter of Intent applies to suppliers or customers.
    • ContentOwner; string; The configuration owner associated with a tax exemption.
    • ContentOwnerId; integer; The unique identifier of the content owner associated with a tax exemption.
    • Country; string; The country in the party address for which the tax exemption applies.
    • CustomChargeFlag; boolean; Indicates whether a Letter of Intent should be addressed to the local customs office.
    • CustomerAccountId; integer; The unique identifier of the customer account associated with a tax exemption.
    • DetFactorTemplCode; string; The determining factor template code associated with a tax exemption.
    • EffectiveFrom; string; The date when the tax exemptions start being effective.
    • EffectiveTo; string; The date when the tax exemptions stop being effective.
    • ExemptCertificateNumber; string; The exemption certificate number associated with a tax exemption granted by a tax authority.
    • ExemptReasonCode; string; The exemption reason code associated with a tax exemption.
    • ExemptionStatusCode; string; The exemption status code indicates the approval status of an exemption. The valid values are PRIMARY, MANUAL, DISCONTINUED, REJECTED, and UNAPPROVED.
    • ExemptionTypeCode; string; The lookup code that indicates the exemption type. Possible values are DISCOUNT, SURCHARGE, and SPECIAL RATE. The exemption rate type attribute represents the method of calculating the tax exemption percentage.
    • ExemptionUsageCode; string; The exemption usage code that identifies the activity for which a tax exemption is granted by a tax authority.
    • InventoryOrgId; integer; The unique identifier of the inventory organization associated with an item referenced in a tax exemption.
    • IssueDate; string; The date when a tax exemption is issued.
    • IssueFlag; boolean; Indicates whether to create or register the Letter of Intent based on the party type chosen. The Letter of Intent is issued to indicate the VAT exemption limit applicable to a supplier or customer.
    • IssuingTaxAuthority; string; The tax authority that issued an exemption.
    • IssuingTaxAuthorityId; integer; The unique identifier of the issuing tax authority that has granted a tax exemption.
    • ItemNumber; string; The inventory item number for which a tax exemption applies.
    • LimitAmount; number; The dollar amount limit for a granted tax exemption.
    • Organization; string; The name of the corresponding inventory organization for an item that is eligible for a tax exemption. This is applicable for product-specific tax exemptions.
    • PartyName; string; The party name associated with a tax exemption.
    • PartyNumber; string; The party number associated with a tax exemption.
    • PartySiteNumber; string; The party site number associated with a tax exemption.
    • PartyTaxAllowOffsetTaxFlag; boolean; Indicates whether the party tax profile has been configured to allow offset tax calculation. The default value is NO.
    • PartyTaxClassificationCode; string; The tax classification code for the party tax profile associated with a tax exemption.
    • PartyTaxInclusiveTaxFlag; boolean; Indicates whether the party tax profile has been configured to allow inclusive tax calculation.
    • PartyTaxProcessForApplicabilityFlag; boolean; Indicates whether the party tax profile definition is applied as part of the tax determination process.
    • PartyTaxProfileId; integer; The unique identifier of the party tax profile associated with a tax exemption.
    • PartyTaxRoundingLevelCode; string; The value that specifies the rounding to be applied to party tax amounts on a transaction.
    • PartyTaxRoundingRuleCode; string; The rounding rule code for the party tax profile associated with a tax exemption.
    • PartyType; string; The party type associated with a tax exemption.
    • PartyTypeCode; string; The party type code associated with a tax exemption.
    • PartyTypeFlag; boolean; Indicates whether a tax exemption party type is a customer or a supplier. The default value is CUSTOMER.
    • PartyUsage; string; Indicates whether a third-party tax exemption is applicable to a customer or supplier.
    • PrintFlag; boolean; Indicates whether a tax exemption letter of intent is ready to print. The default value is NO.
    • ProductId; integer; The unique identifier of the product for which a tax exemption applies.
    • RateModifier; number; The exemption percentage associated with a tax exemption.
    • RecordTypeCode; string; The record type code of a tax exemption.
    • RecordingDate; string; The date when a tax exemption is recorded.
    • ReportingCodeName; string; The name of the reporting code associated with a tax exemption.
    • ReportingTypeName; string; The name of the reporting type associated with a tax exemption.
    • SiteUseId; integer; The unique identifier of the site use associated with a tax exemption.
    • SuspendFromDate; string; The date from which the status of an existing tax exemption is set to REJECTED.
    • SuspendToDate; string; The date to which the status of an existing tax exemption is set to either REJECTED or DISCONTINUED.
    • Tax; string; A specific tax for which an existing tax exemption is applied.
    • TaxExemptionId; integer; The unique identifier of the system-generated primary key column.
    • TaxJurisdictionCode; string; The tax jurisdiction code that identifies the location for which a tax exemption has been granted by a tax authority.
    • TaxJurisdictionId; integer; The unique identifier of the tax jurisdiction for which the tax exemption applies.
    • TaxRateCode; string; A specific tax rate for which an existing tax exemption is applied.
    • TaxRegimeCode; string; A specific tax regime for which an existing tax exemption is applied.
    • TaxStatusCode; string; A specific tax status for which an existing tax exemption is applied.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : taxExemptions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : taxExemptions-item-response
Type: object
Show Source
  • Title: Apply to lower levels
    Maximum Length: 1
    Default Value: false
    The action to apply a tax exemption to all taxes that use this tax as the tax exemptions source. For example, if a STATE tax is configured as the tax exemption source for both the COUNTY and CITY tax, then checking this box applies the tax exemption at both of the COUNTY and CITY tax levels.
  • Title: Clause
    Maximum Length: 30
    The legal tax clause on the basis of which the Letter of Intent applies to suppliers or customers.
  • Title: Configuration Owner
    Maximum Length: 240
    The configuration owner associated with a tax exemption.
  • The unique identifier of the content owner associated with a tax exemption.
  • Title: Country
    Read Only: true
    Maximum Length: 80
    The country in the party address for which the tax exemption applies.
  • Title: Address to customs office
    Maximum Length: 1
    Indicates whether a Letter of Intent should be addressed to the local customs office.
  • The unique identifier of the customer account associated with a tax exemption.
  • Title: Determining Factor Set Code
    Maximum Length: 30
    The determining factor template code associated with a tax exemption.
  • Title: Start Date
    The date when the tax exemptions start being effective.
  • Title: End Date
    The date when the tax exemptions stop being effective.
  • Title: Certificate Number
    Maximum Length: 80
    The exemption certificate number associated with a tax exemption granted by a tax authority.
  • Title: Exempt Status
    Maximum Length: 30
    Default Value: PRIMARY
    The exemption status code indicates the approval status of an exemption. The valid values are PRIMARY, MANUAL, DISCONTINUED, REJECTED, and UNAPPROVED.
  • Title: Exemption Rate Type
    Maximum Length: 30
    Default Value: DISCOUNT
    The lookup code that indicates the exemption type. Possible values are DISCOUNT, SURCHARGE, and SPECIAL RATE. The exemption rate type attribute represents the method of calculating the tax exemption percentage.
  • Title: Code
    Maximum Length: 30
    The exemption usage code that identifies the activity for which a tax exemption is granted by a tax authority.
  • Title: Exempt Reason
    Maximum Length: 30
    The exemption reason code associated with a tax exemption.
  • The unique identifier of the inventory organization associated with an item referenced in a tax exemption.
  • Title: Letter Date
    The date when a tax exemption is issued.
  • Title: Prepare Letter of Intent
    Maximum Length: 1
    Indicates whether to create or register the Letter of Intent based on the party type chosen. The Letter of Intent is issued to indicate the VAT exemption limit applicable to a supplier or customer.
  • Title: Issuing Tax Authority
    The tax authority that issued an exemption.
  • The unique identifier of the issuing tax authority that has granted a tax exemption.
  • Title: Item Number
    The inventory item number for which a tax exemption applies.
  • Title: Exemption Amount
    The dollar amount limit for a granted tax exemption.
  • Links
  • Title: Inventory Organization
    The name of the corresponding inventory organization for an item that is eligible for a tax exemption. This is applicable for product-specific tax exemptions.
  • Title: Party Name
    Read Only: true
    Maximum Length: 360
    The party name associated with a tax exemption.
  • Title: Party Number
    Maximum Length: 30
    The party number associated with a tax exemption.
  • Title: Party Site Number
    Maximum Length: 30
    The party site number associated with a tax exemption.
  • Title: Allow offset tax calculation
    Indicates whether the party tax profile has been configured to allow offset tax calculation. The default value is NO.
  • Title: Tax Classification Code
    The tax classification code for the party tax profile associated with a tax exemption.
  • Title: Set Invoice Values as Tax Inclusive
    Indicates whether the party tax profile has been configured to allow inclusive tax calculation.
  • Title: Tax Applicability
    Indicates whether the party tax profile definition is applied as part of the tax determination process.
  • The unique identifier of the party tax profile associated with a tax exemption.
  • Title: Rounding Level
    The value that specifies the rounding to be applied to party tax amounts on a transaction.
  • Title: Rounding Rule
    The rounding rule code for the party tax profile associated with a tax exemption.
  • Title: Party Type
    The party type associated with a tax exemption.
  • Title: Party Type
    Maximum Length: 30
    The party type code associated with a tax exemption.
  • Title: Party Type
    Maximum Length: 1
    Indicates whether a tax exemption party type is a customer or a supplier. The default value is CUSTOMER.
  • Title: Party Usage
    Read Only: true
    Maximum Length: 17
    Indicates whether a third-party tax exemption is applicable to a customer or supplier.
  • Title: Letter of Intent ready to print
    Maximum Length: 1
    Indicates whether a tax exemption letter of intent is ready to print. The default value is NO.
  • The unique identifier of the product for which a tax exemption applies.
  • Title: Exemption Percentage
    The exemption percentage associated with a tax exemption.
  • Title: Recording Date
    The date when a tax exemption is recorded.
  • Title: Party Type
    Maximum Length: 30
    The record type code of a tax exemption.
  • Title: Tax Reporting Code
    The value of the reporting code associated with a tax exemption.
  • The unique identifier of the reporting code associated with a tax exemption.
  • Title: Tax Reporting Code
    The name of the reporting code associated with a tax exemption.
  • The unique identifier of the reporting type associated with a tax exemption.
  • Title: Tax Reporting Type Name
    The name of the reporting type associated with a tax exemption.
  • The unique identifier of the site use associated with a tax exemption.
  • Title: Suspension or Revocation From Date
    The date from which the status of an existing tax exemption is set to REJECTED.
  • Title: Suspension To Date
    The date to which the status of an existing tax exemption is set to either REJECTED or DISCONTINUED.
  • Title: Tax
    Maximum Length: 30
    A specific tax for which an existing tax exemption is applied.
  • The unique identifier of the system-generated primary key column.
  • Title: Tax Jurisdiction Code
    The tax jurisdiction code that identifies the location for which a tax exemption has been granted by a tax authority.
  • The unique identifier of the tax jurisdiction for which the tax exemption applies.
  • Title: Rate Code
    Maximum Length: 50
    A specific tax rate for which an existing tax exemption is applied.
  • Title: Tax Regime Code
    Maximum Length: 30
    A specific tax regime for which an existing tax exemption is applied.
  • Title: Status Code
    Maximum Length: 30
    A specific tax status for which an existing tax exemption is applied.
Back to Top

Examples

The following example shows how to retrieve all the tax exemptions 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/taxExemptions

Example Response Body

The following example shows the contents of the response body in JSON format:

    "items": [
        {
            "PartyTypeCode": "THIRD_PARTY_SITE",
            "PartyName": "REL11FSCMCMN_ORG2",
            "PartyNumber": "CDRM_110738",
            "PartySiteNumber": "CDRM_105458",
            "PartyType": null,
            "ExemptionUsageCode": "N",
            "TaxRegimeCode": "ES IGIC",
            "ContentOwner": "AB Investment Services",
            "Tax": "ES IGIC",
            "TaxStatusCode": "ES IGIC EXEMPT",
            "TaxRateCode": "ES IGIC EXEMPT",
            "TaxJurisdictionCode": null,
            "ItemNumber": null,
            "Organization": null,
            "EffectiveFrom": "2015-03-22",
            "EffectiveTo": "2019-03-22",
            "ExemptCertificateNumber": "8888",
            "RecordingDate": null,
            "IssueDate": null,
            "ExemptionTypeCode": "SPECIAL_RATE",
            "RateModifier": 10,
            "ExemptionStatusCode": "PRIMARY",
            "IssuingTaxAuthority": null,
            "ApplyToLowerLevelsFlag": false,
            "SuspendFromDate": null,
            "SuspendToDate": null,
            "LimitAmount": null,
            "ExemptReasonCode": "Research",
            "ClauseReference": null,
            "IssueFlag": null,
            "PartyTypeFlag": false,
            "PrintFlag": null,
            "PartyUsage": "CUSTOMER",
            "Country": null,
            "ContentOwnerId": 300100036750370,
            "CustomerAccountId": null,
            "CustomChargeFlag": null,
            "DetFactorTemplCode": null,
            "InventoryOrgId": 300100051148316,
            "IssuingTaxAuthorityId": 300100002767831,
            "PartyTaxProfileId": 300100059769624,
            "ProductId": null,
            "RecordTypeCode": "USER_DEFINED",
            "SiteUseId": null,
            "TaxJurisdictionId": 100000012508262,
            "TaxExemptionId": 300100059769632,
            "ReportingTypeId": null,
            "ReportingCodeId": null,
            "ReportingTypeName": null,
            "ReportingCodeName": null,
            "ReportingCodeChar": null,
            "PartyTaxAllowOffsetTaxFlag": null,
            "PartyTaxRoundingLevelCode": null,
            "PartyTaxInclusiveTaxFlag": null,
            "PartyTaxClassificationCode": null,
            "PartyTaxRoundingRuleCode": null,
            "PartyTaxProcessForApplicabilityFlag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632",
                    "name": "taxExemptions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632",
                    "name": "taxExemptions",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/clauseRefs",
                    "name": "clauseRefs",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/inventoryOrgs",
                    "name": "inventoryOrgs",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/exemptionTypeLookups",
                    "name": "exemptionTypeLookups",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/partyTypeLookups",
                    "name": "partyTypeLookups",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxJurisdictions",
                    "name": "taxJurisdictions",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxReportingCodes",
                    "name": "taxReportingCodes",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/items",
                    "name": "items",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxReportingTypes",
                    "name": "taxReportingTypes",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxLookupforExemptionReasonCodes",
                    "name": "taxLookupforExemptionReasonCodes",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/exemptionStatusLookups",
                    "name": "exemptionStatusLookups",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxAuthorityProfiles",
                    "name": "taxAuthorityProfiles",
                    "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/taxExemptions",
            "name": "taxExemptions",
            "kind": "collection"
        }
    ]
}
Back to Top