Create a taxpayer identifier
post
/fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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.
-
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.
Response
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 create a taxpayer identifier by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "PartyTypeCode": "THIRD_PARTY_SITE", "PartyName": "ACSYS Consultoria e Sistemas Ltda", "PartyNumber": "22133", "PartySiteNumber": "22744", "TaxPayerNumber": "01234567000195", "EffectiveFrom": "2001-01-01", "ReportingTypeCode": "ORA_BR_CNPJ", "ValidationLevel": "ERROR", "UniquenessValidationLevel": "ALL_THIRD_PARTIES", "CountryName": "Brazil", "EntityId": 810370, "PartyTaxpayerIdntfsId": 300100059951348, }
Example of Response Header
The following shows an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json application/json
Example of 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" } ] }