Get a taxpayer identifier
get
/fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers/{PartyTaxpayerIdntfsId}
Request
Path Parameters
-
PartyTaxpayerIdntfsId(required): integer(int64)
The unique identifier of the system-generated primary key column.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : taxPayerIdentifiers-item-response
Type:
Show Source
object
-
CountryCode: string
Title:
Country Code
Maximum Length:2
The country code used to validate the tax registration number for a party tax profile. -
CountryName: string
Title:
Country
Maximum Length:80
The name of the country where tax is registered. -
EffectiveFrom: string
(date)
Title:
Start Date
The date at the beginning of the date range when the taxpayer identifier for a period is effective. -
EffectiveTo: string
(date)
Title:
End Date
The date at the end of the date range when the taxpayer identifier for a period is effective. -
EntityId: integer
(int64)
The unique identifier of the entity associated with a taxpayer identifier.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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. -
PartyTaxAllowOffsetTaxFlag: boolean
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. -
PartyTaxClassificationCode: string
Title:
Tax Classification Code
Maximum Length:255
The tax classification code for the party tax profile associated with a taxpayer identifier. -
PartyTaxInclusiveTaxFlag: boolean
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. -
PartyTaxpayerIdntfsId: integer
(int64)
The unique identifier of the system-generated primary key column.
-
PartyTaxProcessForApplicabilityFlag: boolean
Title:
Tax Applicability
Maximum Length:255
Indicates whether the existing party tax profile is applied as part of the tax determination process. -
PartyTaxRoundingLevelCode: string
Title:
Rounding Level
Maximum Length:255
The value that specifies the rounding to be applied to party tax amounts on a transaction. -
PartyTaxRoundingRuleCode: string
Title:
Rounding Rule
Maximum Length:255
The rounding rule code for the party tax profile associated with a taxpayer identifier. -
PartyTypeCode: string
Title:
Party Type
Maximum Length:255
The party type code of the party tax profile. -
RegistrationTypeCode: string
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. -
ReportingTypeCode: string
Title:
Tax Reporting Type Code
Maximum Length:30
The reporting type code associated with a taxpayer identifier. -
TaxpayerCountry: string
Title:
Country
Maximum Length:255
The country where the taxpayer is registered. -
TaxPayerNumber: string
Title:
Taxpayer ID
Maximum Length:50
The taxpayer number used for tax compliance and reporting. -
UniquenessValidationLevel: string
Title:
Duplicate Validation Level
Maximum Length:30
The unique level at which the application generates validations to identify duplicate registration numbers. -
ValidationDigit: string
Title:
Validation Digit
Maximum Length:10
The validation digit associated with taxpayer identifiers. -
ValidationLevel: string
Title:
Validation Level
Maximum Length:30
The level at which the application generates validations for duplicate registration numbers to users. -
ValidationType: string
Title:
Validation Type
Maximum Length:255
The type of validation associated with a taxpayer identifier.
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 a taxpayer identifier by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers/300100059951348
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "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" } ] }