Create a tax registration
post
/fscmRestApi/resources/11.13.18.05/taxRegistrations
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
-
BankAccountNumber: string
Title:
Account Number
Maximum Length:30
The bank account number associated with a tax registration. -
BankBranchId: integer
(int64)
The unique identifier for the bank branch associated with a tax registration.
-
BankId: integer
(int64)
The unique identifier for the bank associated with a tax registration.
-
CollTaxAuthorityId: integer
(int64)
The unique identifier for the collecting tax authority.
-
CountryCode: string
Title:
Country Code
The country code used to validate the tax registration number for a party tax profile. -
DefaultRegistrationFlag: boolean
Title:
Set as default registration
Maximum Length:1
Default Value:false
Indicates whether a tax registration is set as default registration. The default value is FALSE. -
EffectiveFrom: string
(date)
Title:
Start Date
The date when the tax registration for a period starts being effective. -
EffectiveTo: string
(date)
Title:
End Date
The date when the tax registration for a period stops being effective. -
InclusiveTaxFlag: boolean
Title:
Set Invoice Values as Tax Inclusive
Maximum Length:1
Default Value:false
Indicates whether a tax registration is tax inclusive. The default value is FALSE. -
IssuingTaxAuthority: string
Title:
Issuing Tax Authority
The issuing tax authority for a tax registration. -
LegalLocationId: integer
(int64)
The unique identifier of the legal location for a tax registration.
-
LegalRegistrationAddress: string
Title:
Legal Registration Address
The address of the legal tax registration that is defined. -
PartyName: string
Title:
Party Name
Maximum Length:255
The name of the party for which the party tax profile is defined. -
PartyNumber: string
Title:
Party Number
Maximum Length:255
The party number for which the party tax profile is defined. -
PartySiteNumber: string
Title:
Party Site Number
Maximum Length:255
The party site number for which the party tax profile is defined. -
PartyTaxAllowOffsetTaxFlag: boolean
Title:
Allow offset tax calculation
Indicates whether the party tax profile is set up to allow offset tax. The default value is FALSE. -
PartyTaxClassificationCode: string
Title:
Tax Classification Code
The tax classification code for the party tax profile associated with a tax registration. -
PartyTaxInclusiveTaxFlag: boolean
Title:
Set Invoice Values as Tax Inclusive
Indicates whether a party tax profile supports inclusive taxes. The default value is FALSE. -
PartyTaxProcessForApplicabilityFlag: boolean
Title:
Tax Applicability
Indicates whether the party tax profile is applied during the tax determination process. -
PartyTaxProfileId: integer
(int64)
The unique identifier for the party tax profile.
-
PartyTaxRoundingLevelCode: string
Title:
Rounding Level
The rounding level code defined for a tax registration associated with a party tax profile. -
PartyTaxRoundingRuleCode: string
Title:
Rounding Rule
The rounding rule code for the party tax profile associated with a tax registration. -
PartyTypeCode: string
Title:
Party Type
Maximum Length:255
The party type code of the party tax profile. -
RegistrationId: integer
(int64)
The unique identifier of the system-generated primary key column.
-
RegistrationNumber: string
Title:
Registration Number
Maximum Length:50
The company tax registration number assigned by a tax authority. -
RegistrationReasonCode: string
Title:
Tax Registration Reason
Maximum Length:30
The registration reason code for tax registrations. -
RegistrationSourceCode: string
Title:
Source
Maximum Length:30
The registration source code for tax registrations. -
RegistrationStatusCode: string
Title:
Tax Registration Status
Maximum Length:30
The registration status code for tax registrations. -
RegistrationTypeCode: string
Title:
Tax Registration Type
Maximum Length:30
The tax registration type represents the legal type of tax for which a tax registration is issued, such as VAT. -
RepresentativePartyTaxName: string
Title:
Reporting Party Tax Name
Maximum Length:80
The name of the reporting party for tax registrations. -
RoundingLevelCode: string
Title:
Rounding Level
Maximum Length:30
The value that specifies the rounding to apply to tax amounts on a transaction. The valid values are HEADER and LINE. -
RoundingRuleCode: string
Title:
Rounding Rule
Maximum Length:30
The rule that defines how the rounding must be performed on a value involved in a taxable transaction. Possible values range from the next highest value to the next lowest or nearest value. -
Tax: string
Title:
Tax
Maximum Length:30
The tax code associated with a tax registration. -
TaxAuthorityId: integer
(int64)
The unique identifier of the tax authority associated with an existing tax registration.
-
TaxClassificationCode: string
Title:
Tax Classification Code
Maximum Length:30
The tax classification code associated with a tax registration. -
TaxJurisdictionCode: string
Title:
Tax Jurisdiction Code
Maximum Length:30
The location for which a tax registration is defined. -
TaxPointBasis: string
Title:
Tax Point Basis
Maximum Length:30
The point in the receipt transaction process where taxes are accounted and reported to the tax authorities. Tax points can be classified into delivery-based and invoice-based categories. -
TaxRegimeCode: string
Title:
Tax Regime Code
Maximum Length:30
The tax regime code associated with a tax registration. -
UniquenessValidationLevel: string
Title:
Duplicate Validation Level
Maximum Length:30
The types of parties to be checked for duplicate tax registration numbers entered on a tax registration record. -
ValidationLevel: string
Title:
Validation Level
Maximum Length:30
The level at which validation for duplicate registration numbers are raised to users. Possible values are ERROR and WARNING. -
ValidationRule: string
Title:
Validation Level
Maximum Length:30
The code for the validation that is to be applied to tax registration numbers for a tax regime. -
ValidationType: string
Title:
Validation Type
Maximum Length:30
The validation type for tax registrations.
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 : taxRegistrations-item-response
Type:
Show Source
object
-
BankAccountNumber: string
Title:
Account Number
Maximum Length:30
The bank account number associated with a tax registration. -
BankBranchId: integer
(int64)
The unique identifier for the bank branch associated with a tax registration.
-
BankId: integer
(int64)
The unique identifier for the bank associated with a tax registration.
-
CollTaxAuthorityId: integer
(int64)
The unique identifier for the collecting tax authority.
-
Country: string
Title:
Country
Read Only:true
Maximum Length:255
The name of the country where tax is registered. -
CountryCode: string
Title:
Country Code
The country code used to validate the tax registration number for a party tax profile. -
DefaultRegistrationFlag: boolean
Title:
Set as default registration
Maximum Length:1
Default Value:false
Indicates whether a tax registration is set as default registration. The default value is FALSE. -
EffectiveFrom: string
(date)
Title:
Start Date
The date when the tax registration for a period starts being effective. -
EffectiveTo: string
(date)
Title:
End Date
The date when the tax registration for a period stops being effective. -
InclusiveTaxFlag: boolean
Title:
Set Invoice Values as Tax Inclusive
Maximum Length:1
Default Value:false
Indicates whether a tax registration is tax inclusive. The default value is FALSE. -
IssuingTaxAuthority: string
Title:
Issuing Tax Authority
The issuing tax authority for a tax registration. -
LegalLocationId: integer
(int64)
The unique identifier of the legal location for a tax registration.
-
LegalRegistrationAddress: string
Title:
Legal Registration Address
The address of the legal tax registration that is defined. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyCountryCode: string
Title:
Country Code
Read Only:true
Maximum Length:255
The country of the party for which a tax registration is defined. -
PartyName: string
Title:
Party Name
Maximum Length:255
The name of the party for which the party tax profile is defined. -
PartyNumber: string
Title:
Party Number
Maximum Length:255
The party number for which the party tax profile is defined. -
PartySiteNumber: string
Title:
Party Site Number
Maximum Length:255
The party site number for which the party tax profile is defined. -
PartyTaxAllowOffsetTaxFlag: boolean
Title:
Allow offset tax calculation
Indicates whether the party tax profile is set up to allow offset tax. The default value is FALSE. -
PartyTaxClassificationCode: string
Title:
Tax Classification Code
The tax classification code for the party tax profile associated with a tax registration. -
PartyTaxInclusiveTaxFlag: boolean
Title:
Set Invoice Values as Tax Inclusive
Indicates whether a party tax profile supports inclusive taxes. The default value is FALSE. -
PartyTaxProcessForApplicabilityFlag: boolean
Title:
Tax Applicability
Indicates whether the party tax profile is applied during the tax determination process. -
PartyTaxProfileId: integer
(int64)
The unique identifier for the party tax profile.
-
PartyTaxRoundingLevelCode: string
Title:
Rounding Level
The rounding level code defined for a tax registration associated with a party tax profile. -
PartyTaxRoundingRuleCode: string
Title:
Rounding Rule
The rounding rule code for the party tax profile associated with a tax registration. -
PartyTypeCode: string
Title:
Party Type
Maximum Length:255
The party type code of the party tax profile. -
RegistrationId: integer
(int64)
The unique identifier of the system-generated primary key column.
-
RegistrationNumber: string
Title:
Registration Number
Maximum Length:50
The company tax registration number assigned by a tax authority. -
RegistrationReasonCode: string
Title:
Tax Registration Reason
Maximum Length:30
The registration reason code for tax registrations. -
RegistrationSourceCode: string
Title:
Source
Maximum Length:30
The registration source code for tax registrations. -
RegistrationStatusCode: string
Title:
Tax Registration Status
Maximum Length:30
The registration status code for tax registrations. -
RegistrationTypeCode: string
Title:
Tax Registration Type
Maximum Length:30
The tax registration type represents the legal type of tax for which a tax registration is issued, such as VAT. -
RepresentativePartyTaxName: string
Title:
Reporting Party Tax Name
Maximum Length:80
The name of the reporting party for tax registrations. -
RoundingLevelCode: string
Title:
Rounding Level
Maximum Length:30
The value that specifies the rounding to apply to tax amounts on a transaction. The valid values are HEADER and LINE. -
RoundingRuleCode: string
Title:
Rounding Rule
Maximum Length:30
The rule that defines how the rounding must be performed on a value involved in a taxable transaction. Possible values range from the next highest value to the next lowest or nearest value. -
Tax: string
Title:
Tax
Maximum Length:30
The tax code associated with a tax registration. -
TaxAuthorityId: integer
(int64)
The unique identifier of the tax authority associated with an existing tax registration.
-
TaxClassificationCode: string
Title:
Tax Classification Code
Maximum Length:30
The tax classification code associated with a tax registration. -
TaxJurisdictionCode: string
Title:
Tax Jurisdiction Code
Maximum Length:30
The location for which a tax registration is defined. -
TaxPointBasis: string
Title:
Tax Point Basis
Maximum Length:30
The point in the receipt transaction process where taxes are accounted and reported to the tax authorities. Tax points can be classified into delivery-based and invoice-based categories. -
TaxRegimeCode: string
Title:
Tax Regime Code
Maximum Length:30
The tax regime code associated with a tax registration. -
UniquenessValidationLevel: string
Title:
Duplicate Validation Level
Maximum Length:30
The types of parties to be checked for duplicate tax registration numbers entered on a tax registration record. -
ValidationLevel: string
Title:
Validation Level
Maximum Length:30
The level at which validation for duplicate registration numbers are raised to users. Possible values are ERROR and WARNING. -
ValidationRule: string
Title:
Validation Level
Maximum Length:30
The code for the validation that is to be applied to tax registration numbers for a tax regime. -
ValidationType: string
Title:
Validation Type
Maximum Length:30
The validation type for tax registrations.
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.
Links
- taxAuthorityProfiles
-
The list of values to indicate the issuing tax authority associated with the tax registration.
The following properties are defined on the LOV link relation:- Source Attribute: IssuingTaxAuthority; Target Attribute: PartyName
- Display Attribute: PartyName, PartyTaxProfileId
- taxClassifications
-
The code of the party tax classification associated with the tax registration.
The following properties are defined on the LOV link relation:- Source Attribute: PartyTaxClassificationCode; Target Attribute: LookupCode
- Display Attribute: LookupCode
Examples
The following example shows how to create a tax registration 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/taxRegistrations
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "PartyTypeCode": "THIRD_PARTY_SITE", "PartyName": "AT&T Universal Card", "PartyNumber": "1005", "PartySiteNumber": "4643", "TaxRegimeCode": "IT VAT", "Tax": "IT VAT", "RegistrationTypeCode": "VAT", "RegistrationStatusCode": "REGISTERED", "EffectiveFrom": "1973-01-01", "RegistrationNumber": "01098766759", "DefaultRegistrationFlag": false, "RoundingRuleCode": "NEAREST", "InclusiveTaxFlag": false, "Country": "Italy", "PartyCountryCode": "IT", "PartyTaxProfileId": 847064, "RegistrationId": 100000011813021 }
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": "AT&T Universal Card", "PartyNumber": "1005", "PartySiteNumber": "4643", "TaxRegimeCode": "IT VAT", "Tax": "IT VAT", "TaxJurisdictionCode": null, "TaxPointBasis": null, "RegistrationTypeCode": "VAT", "RegistrationStatusCode": "REGISTERED", "RepresentativePartyTaxName": null, "RegistrationReasonCode": null, "EffectiveFrom": "1973-01-01", "EffectiveTo": null, "LegalRegistrationAddress": null, "ValidationType": null, "ValidationLevel": null, "ValidationRule": null, "RegistrationNumber": "01098766759", "RegistrationSourceCode": null, "IssuingTaxAuthority": null, "DefaultRegistrationFlag": false, "RoundingRuleCode": "NEAREST", "InclusiveTaxFlag": false, "BankAccountNumber": null, "TaxClassificationCode": null, "UniquenessValidationLevel": null, "Country": "Italy", "PartyCountryCode": "IT", "BankBranchId": null, "BankId": null, "CollTaxAuthorityId": null, "LegalLocationId": null, "PartyTaxProfileId": 847064, "RoundingLevelCode": null, "TaxAuthorityId": null, "RegistrationId": 100000011813021, "PartyTaxAllowOffsetTaxFlag": null, "PartyTaxRoundingLevelCode": null, "PartyTaxInclusiveTaxFlag": null, "PartyTaxClassificationCode": null, "PartyTaxRoundingRuleCode": null, "PartyTaxProcessForApplicabilityFlag": null, "CountryCode": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021", "name": "taxRegistrations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021", "name": "taxRegistrations", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021/lov/roundingRules", "name": "roundingRules", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021/lov/taxClassifications", "name": "taxClassifications", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021/lov/legalLocations", "name": "legalLocations", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxRegistrations/100000011813021/lov/taxAuthorityProfiles", "name": "taxAuthorityProfiles", "kind": "collection" } ] }