1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Taxpayer Identifiers

Get all taxpayer identifiers

get

/fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers

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:

    • ManageTaxPartyIdentifiersRF: Finds all taxpayer identifiers that match the specified party number, party name, party type code and country.
      Finder Variables:
      • country; string; The country associated with the taxpayer identifier.
      • partyName; string; The party name associated with the taxpayer identifier.
      • partyNumber; string; The party number associated with the taxpayer identifier.
      • partyTypeCode; string; The party type code associated with the taxpayer identifier.
    • PrimaryKey: Finds all taxpayer identifiers that match the specified taxpayer identifier.
      Finder Variables:
      • PartyTaxpayerIdntfsId; integer; The unique identifier of the taxpayer of the resource.
  • 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:
    • CountryCode; string; The country code used to validate the tax registration number for a party tax profile.
    • CountryName; string; The name of the country where tax is registered.
    • EffectiveFrom; string; The date at the beginning of the date range when the taxpayer identifier for a period is effective.
    • EffectiveTo; string; The date at the end of the date range when the taxpayer identifier for a period is effective.
    • EntityId; integer; The unique identifier of the entity associated with a taxpayer identifier.
    • 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.
    • 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 taxpayer identifier.
    • PartyTaxInclusiveTaxFlag; boolean; Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO.
    • PartyTaxProcessForApplicabilityFlag; boolean; Indicates whether the existing party tax profile is applied as part of the tax determination process.
    • 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 taxpayer identifier.
    • PartyTaxpayerIdntfsId; integer; The unique identifier of the system-generated primary key column.
    • PartyTypeCode; string; The party type code of the party tax profile.
    • RegistrationTypeCode; string; The classification for a tax registration that is specified by a tax authority for purposes of reporting.
    • ReportingTypeCode; string; The reporting type code associated with a taxpayer identifier.
    • TaxPayerNumber; string; The taxpayer number used for tax compliance and reporting.
    • TaxpayerCountry; string; The country where the taxpayer is registered.
    • UniquenessValidationLevel; string; The unique level at which the application generates validations to identify duplicate registration numbers.
    • ValidationDigit; string; The validation digit associated with taxpayer identifiers.
    • ValidationLevel; string; The level at which the application generates validations for duplicate registration numbers to users.
    • ValidationType; string; The type of validation associated with a taxpayer identifier.
  • 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 : taxPayerIdentifiers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : taxPayerIdentifiers-item-response
Type: object
Show Source
  • Title: Country Code
    Maximum Length: 2
    The country code used to validate the tax registration number for a party tax profile.
  • Title: Country
    Maximum Length: 80
    The name of the country where tax is registered.
  • Title: Start Date
    The date at the beginning of the date range when the taxpayer identifier for a period is effective.
  • Title: End Date
    The date at the end of the date range when the taxpayer identifier for a period is effective.
  • The unique identifier of the entity associated with a taxpayer identifier.
  • Links
  • Title: Party Name
    Maximum Length: 360
    The party name for which the party tax profile is defined.
  • Title: Party Number
    Maximum Length: 30
    The party number for which the party tax profile is defined.
  • Title: Party Site Number
    Maximum Length: 30
    The party site number for which the party tax profile is defined.
  • Title: Allow offset tax calculation
    Maximum Length: 255
    Indicates whether the party tax profile has been configured to allow offset tax calculation. The default value is NO.
  • Title: Tax Classification Code
    Maximum Length: 255
    The tax classification code for the party tax profile associated with a taxpayer identifier.
  • Title: Set Invoice Values as Tax Inclusive
    Maximum Length: 255
    Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO.
  • The unique identifier of the system-generated primary key column.
  • Title: Tax Applicability
    Maximum Length: 255
    Indicates whether the existing party tax profile is applied as part of the tax determination process.
  • Title: Rounding Level
    Maximum Length: 255
    The value that specifies the rounding to be applied to party tax amounts on a transaction.
  • Title: Rounding Rule
    Maximum Length: 255
    The rounding rule code for the party tax profile associated with a taxpayer identifier.
  • Title: Party Type
    Maximum Length: 255
    The party type code of the party tax profile.
  • Title: Tax Registration Type Code
    Maximum Length: 30
    The classification for a tax registration that is specified by a tax authority for purposes of reporting.
  • Title: Tax Reporting Type Code
    Maximum Length: 30
    The reporting type code associated with a taxpayer identifier.
  • Title: Country
    Maximum Length: 255
    The country where the taxpayer is registered.
  • Title: Taxpayer ID
    Maximum Length: 50
    The taxpayer number used for tax compliance and reporting.
  • Title: Duplicate Validation Level
    Maximum Length: 30
    The unique level at which the application generates validations to identify duplicate registration numbers.
  • Title: Validation Digit
    Maximum Length: 10
    The validation digit associated with taxpayer identifiers.
  • Title: Validation Level
    Maximum Length: 30
    The level at which the application generates validations for duplicate registration numbers to users.
  • Title: Validation Type
    Maximum Length: 255
    The type of validation associated with a taxpayer identifier.
Back to Top

Examples

The following example shows how to retrieve all the taxpayer identifiers 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/taxPayerIdentifiers

Example Response Body

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

{
    "items": [
        {
            "PartyTypeCode": "THIRD_PARTY_SITE",
            "PartyName": "ACSYS Consultoria e Sistemas Ltda",
            "PartyNumber": "22133",
            "PartySiteNumber": "22744",
            "ValidationType": null,
            "TaxPayerNumber": "01234567000195",
            "ValidationDigit": null,
            "EffectiveFrom": "2001-01-01",
            "EffectiveTo": null,
            "ReportingTypeCode": "ORA_BR_CNPJ",
            "CountryCode": null,
            "ValidationLevel": "ERROR",
            "UniquenessValidationLevel": "ALL_THIRD_PARTIES",
            "RegistrationTypeCode": null,
            "CountryName": "Brazil",
            "EntityId": 810370,
            "PartyTaxpayerIdntfsId": 300100059951348,
            "TaxpayerCountry": 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/taxPayerIdentifiers/300100059951348",
                    "name": "taxPayerIdentifiers",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers/300100059951348",
                    "name": "taxPayerIdentifiers",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers/300100059951348/lov/taxReportingTypes",
                    "name": "taxReportingTypes",
                    "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/taxPayerIdentifiers",
            "name": "taxPayerIdentifiers",
            "kind": "collection"
        }
    ]
}
Back to Top