Update a party tax profile
patch
/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/{PartyTaxProfileId}
Request
Path Parameters
-
PartyTaxProfileId(required): integer(int64)
The system-generated unique identifier of the party tax profile.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AllowOffsetTaxFlag: boolean
Title:
Allow offset tax calculationMaximum Length:1Indicates if a party tax profile has been configured to allow withholding tax calculation. The default value is NO. -
AllowZeroAmountWhtInvoiceFlag: boolean
Title:
Create zero amount tax authority invoicesMaximum Length:1Indicates if a party tax profile has been configured to allow offset tax calculation. The default value is NO. -
CountryCode: string
Title:
Country CodeMaximum Length:2The country in the party address for which the party tax profile is defined. -
CustomerFlag: boolean
Maximum Length:
1Indicates whether this party tax profile is for a customer. Valid values are Y or N. -
InclusiveTaxFlag: boolean
Title:
Set Invoice Values as Tax InclusiveMaximum Length:1Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO. -
PartyName: string
Title:
Party NameMaximum Length:360The party name for which the party tax profile is defined. -
PartyNumber: string
Title:
Party NumberMaximum Length:30The party number for which the party tax profile is defined. -
PartySiteNumber: string
Title:
Party Site NumberMaximum Length:30The party site number for which the party tax profile is defined. -
ProcessForApplicabilityFlag: boolean
Title:
Tax ApplicabilityMaximum Length:1Indicates whether the party tax profile definition is taken into account during tax applicability determination. The default value is YES. -
RegistrationTypeCode: string
Title:
Tax Registration Type CodeMaximum Length:30The registration type code associated with a party tax profile. -
RepresentativeRegistrationNumber: string
Title:
Tax Registration NumberMaximum Length:50The registration number associated with a party tax profile. -
RoundingLevelCode: string
Title:
Rounding LevelMaximum Length:30The rounding level code associated with a party tax profile. -
RoundingRuleCode: string
Title:
Rounding RuleMaximum Length:30The rounding rule code associated with a party tax profile. -
SiteFlag: boolean
Maximum Length:
1Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N. -
SupplierFlag: boolean
Maximum Length:
1Indicates whether this party tax profile is for a supplier. Valid values are Y or N. -
TaxClassificationCode: string
Title:
Tax Classification CodeMaximum Length:30The tax classification code associated with a party tax profile. -
TaxGrossNetFlagCode: string
Maximum Length:
1Indicates whether the tax and withholding are calculated on the net amount or the gross amount (that is, without deducting the retainage amount from the line amount) for Payables retainage invoices. The default value is Net. -
WhtRoundingLevelCode: string
Title:
Withholding Rounding LevelMaximum Length:30The withholding rounding level code associated with a party tax profile. -
WhtRoundingRuleCode: string
Title:
Withholding Rounding RuleMaximum Length:30The withholding rounding rule code associated with a party tax profile.
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 : partyTaxProfiles-item-response
Type:
Show Source
object-
AllowOffsetTaxFlag: boolean
Title:
Allow offset tax calculationMaximum Length:1Indicates if a party tax profile has been configured to allow withholding tax calculation. The default value is NO. -
AllowZeroAmountWhtInvoiceFlag: boolean
Title:
Create zero amount tax authority invoicesMaximum Length:1Indicates if a party tax profile has been configured to allow offset tax calculation. The default value is NO. -
CountryCode: string
Title:
Country CodeMaximum Length:2The country in the party address for which the party tax profile is defined. -
CustomerFlag: boolean
Maximum Length:
1Indicates whether this party tax profile is for a customer. Valid values are Y or N. -
EffectiveFromUseLe: string
(date)
Title:
Use Subscription of the Legal Entity Start DateThe date when the party tax profile starts being effective. -
InclusiveTaxFlag: boolean
Title:
Set Invoice Values as Tax InclusiveMaximum Length:1Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartyId: integer
(int64)
Unique identifier of the party for which the party tax profile is defined.
-
PartyName: string
Title:
Party NameMaximum Length:360The party name for which the party tax profile is defined. -
PartyNumber: string
Title:
Party NumberMaximum Length:30The party number for which the party tax profile is defined. -
PartySiteNumber: string
Title:
Party Site NumberMaximum Length:30The party site number for which the party tax profile is defined. -
PartyTaxProfileId: integer
(int64)
The system-generated unique identifier of the party tax profile.
-
PartyTypeCode: string
Title:
Party TypeMaximum Length:30The party type code of the party tax profile. -
ProcessForApplicabilityFlag: boolean
Title:
Tax ApplicabilityMaximum Length:1Indicates whether the party tax profile definition is taken into account during tax applicability determination. The default value is YES. -
RegistrationTypeCode: string
Title:
Tax Registration Type CodeMaximum Length:30The registration type code associated with a party tax profile. -
RepresentativeRegistrationNumber: string
Title:
Tax Registration NumberMaximum Length:50The registration number associated with a party tax profile. -
RoundingLevelCode: string
Title:
Rounding LevelMaximum Length:30The rounding level code associated with a party tax profile. -
RoundingRuleCode: string
Title:
Rounding RuleMaximum Length:30The rounding rule code associated with a party tax profile. -
SiteFlag: boolean
Maximum Length:
1Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N. -
SupplierFlag: boolean
Maximum Length:
1Indicates whether this party tax profile is for a supplier. Valid values are Y or N. -
TaxClassificationCode: string
Title:
Tax Classification CodeMaximum Length:30The tax classification code associated with a party tax profile. -
TaxGrossNetFlagCode: string
Maximum Length:
1Indicates whether the tax and withholding are calculated on the net amount or the gross amount (that is, without deducting the retainage amount from the line amount) for Payables retainage invoices. The default value is Net. -
UseLeAsSubscriberFlag: boolean
Title:
Use legal entity tax subscriptionMaximum Length:1Indicates whether a business unit party tax profile will be configured to use the subscription of the associated legal entity for transaction tax determination purposes. The default value is NO. -
WhtDateBasis: string
Title:
Withholding Tax Determination BasisMaximum Length:30The date when the withholding tax basis determination begins. -
WhtRoundingLevelCode: string
Title:
Withholding Rounding LevelMaximum Length:30The withholding rounding level code associated with a party tax profile. -
WhtRoundingRuleCode: string
Title:
Withholding Rounding RuleMaximum Length:30The withholding rounding rule code associated with a party tax profile. -
WhtUseLeAsSubscriberFlag: boolean
Title:
Uses Legal Entity Withholding Tax SubscriptionMaximum Length:1Indicates whether a business unit party tax profile will be configured to use the subscription of the associated legal entity for transaction tax determination purposes. The default value is NO.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
- taxClassifications
-
The list of values for tax classification code of the party tax profile.
The following properties are defined on the LOV link relation:- Source Attribute: TaxClassificationCode; Target Attribute: LookupCode
- Display Attribute: LookupCode
Examples
The following example shows how to update a party tax profile by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531
Example Request Payload
The following example shows the contents of the request body in JSON format:
{
"RepresentativeRegistrationNumber": "67794246-AL"
}Example Response Body
The following example shows the contents of the response body in JSON format:
{
"PartyTypeCode": "THIRD_PARTY_SITE",
"PartyName": "Vision",
"PartyNumber": "50620",
"PartySiteNumber": "21905",
"RoundingLevelCode": "LINE",
"RoundingRuleCode": "UP",
"InclusiveTaxFlag": true,
"TaxClassificationCode": "25% svensk moms",
"AllowOffsetTaxFlag": false,
"AllowZeroAmountWhtInvoiceFlag": null,
"CountryCode": null,
"EffectiveFromUseLe": null,
"ProcessForApplicabilityFlag": true,
"RegistrationTypeCode": null,
"RepresentativeRegistrationNumber": "67794246-AL",
"UseLeAsSubscriberFlag": false,
"WhtDateBasis": null,
"WhtRoundingLevelCode": null,
"WhtRoundingRuleCode": null,
"WhtUseLeAsSubscriberFlag": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531",
"name": "partyTaxProfiles",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531",
"name": "partyTaxProfiles",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531/lov/taxRoundingLevelLookups",
"name": "taxRoundingLevelLookups",
"kind": "collection"
},
...
]
}