1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Tax Exempt Controls

Get all tax exempt controls

get

/crmRestApi/resources/11.13.18.05/taxExemptControls

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

    • LookupTypeActiveEnabledOrBindCodeFinder Finds the tax exempt controls by active enabled or lookup code finder.
      Finder Variables
      • BindCurrentDate; string; The current date of the tax exempt control used to find it.
      • BindLookupCode; string; The lookup code of the tax exempt control used to find it.
      • BindLookupType; string; The lookup type of the tax exempt control used to find it.
      • Bind_ParentLookupCode; string; The lookup code of the tax exempt control used to find it.
      • Bind_ParentSetidDetermType; string; The parent set identifier and determinant type of the tax exempt control used to find it.
      • Bind_ParentSetidDetermValue; string; The parent set identifier and determinant value of the tax exempt control used to find it.
      • Bind_RelationshipId; integer; The relationship identifier of the tax exempt control used to find it.
    • LookupTypeFinder Finds the tax exempt control by lookup type.
      Finder Variables
      • BindLookupType; string; The lookup type of the tax exempt control used to find it.
      • Bind_ParentLookupCode; string; The lookup code of the tax exempt control used to find it.
      • Bind_ParentSetidDetermType; string; The parent set identifier and determinant type of the tax exempt control used to find it.
      • Bind_ParentSetidDetermValue; string; The parent set identifier and determinant value of the tax exempt control used to find it.
      • Bind_RelationshipId; integer; The relationship identifier of the tax exempt control used to find it.
    • LookupTypeIsActiveEnabledFinder Finds the tax exempt control by active enabled lookup type.
      Finder Variables
      • BindCurrentDate; string; The current date of the tax exempt control used to find it.
      • BindLookupType; string; The lookup type of the tax exempt control used to find it.
      • Bind_ParentLookupCode; string; The lookup code of the tax exempt control used to find it.
      • Bind_ParentSetidDetermType; string; The parent set identifier and determinant type of the tax exempt control used to find it.
      • Bind_ParentSetidDetermValue; string; The parent set identifier and determinant value of the tax exempt control used to find it.
      • Bind_RelationshipId; integer; The relationship identifier of the tax exempt control used to find it.
    • LookupTypeIsActiveFinder Finds the tax exempt control by active lookup type.
      Finder Variables
      • BindCurrentDate; string; The current date of the tax exempt control used to find it.
      • BindLookupType; string; The lookup type of the tax exempt control used to find it.
      • Bind_ParentLookupCode; string; The lookup code of the tax exempt control used to find it.
      • Bind_ParentSetidDetermType; string; The parent set identifier and determinant type of the tax exempt control used to find it.
      • Bind_ParentSetidDetermValue; string; The parent set identifier and determinant value of the tax exempt control used to find it.
      • Bind_RelationshipId; integer; The relationship identifier of the tax exempt control used to find it.
    • LookupTypeIsEnabledFinder Finds the tax exempt control by enabled lookup type.
      Finder Variables
      • BindLookupType; string; The lookup type of the tax exempt control used to find it.
      • Bind_ParentLookupCode; string; The lookup code of the tax exempt control used to find it.
      • Bind_ParentSetidDetermType; string; The parent set identifier and determinant type of the tax exempt control used to find it.
      • Bind_ParentSetidDetermValue; string; The parent set identifier and determinant value of the tax exempt control used to find it.
      • Bind_RelationshipId; integer; The relationship identifier of the tax exempt control used to find it.
    • PrimaryKey Finds the tax exempt controls with the specified primary key.
      Finder Variables
      • LookupCode; string; The lookup code of the tax exempt control used to find it.
      • LookupType; string; The lookup type of the tax exempt control used to find it.
    • TaxExemptControlByLookupTypeAndExemptionHandlingFinder Finds the tax exempt controls by lookup type and exemption handling finder.
      Finder Variables
      • BindLookupType; string; The lookup type of the tax exempt control used to find it.
  • 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:
    • CreatedBy; string; The user who created the tax exempt control.
    • CreationDate; string; The creation date of the tax exempt control.
    • Description; string; The description of the tax exempt control.
    • DisplaySequence; integer; The display sequence of the tax exempt control.
    • EnabledFlag; string; The enabled indicator of the tax exempt control.
    • EndDateActive; string; The end date active of the tax exempt control.
    • LastUpdateDate; string; The last update date of the tax exempt control.
    • LastUpdateLogin; string; The last update login of the tax exempt control.
    • LastUpdatedBy; string; The user who last updated the tax exempt control.
    • LookupCode; string; The lookup code of the tax exempt control.
    • LookupType; string; The lookup type of the tax exempt control.
    • Meaning; string; The meaning of the tax exempt control.
    • StartDateActive; string; The start date active of the tax exempt control.
    • Tag; string; The tag of the tax exempt control.
  • 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 : taxExemptControls
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : taxExemptControls-item-response
Type: object
Show Source
Back to Top