Update a party tax profile

patch

/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/{PartyTaxProfileId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Allow offset tax calculation
    Maximum Length: 1
    Indicates if a party tax profile has been configured to allow withholding tax calculation. The default value is NO.
  • Title: Create zero amount tax authority invoices
    Maximum Length: 1
    Indicates if a party tax profile has been configured to allow offset tax calculation. The default value is NO.
  • Title: Country Code
    Maximum Length: 2
    The country in the party address for which the party tax profile is defined.
  • Maximum Length: 1
    Indicates whether this party tax profile is for a customer. Valid values are Y or N.
  • Title: Set Invoice Values as Tax Inclusive
    Maximum Length: 1
    Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO.
  • 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: Tax Applicability
    Maximum Length: 1
    Indicates whether the party tax profile definition is taken into account during tax applicability determination. The default value is YES.
  • Title: Tax Registration Type Code
    Maximum Length: 30
    The registration type code associated with a party tax profile.
  • Title: Tax Registration Number
    Maximum Length: 50
    The registration number associated with a party tax profile.
  • Title: Rounding Level
    Maximum Length: 30
    The rounding level code associated with a party tax profile.
  • Title: Rounding Rule
    Maximum Length: 30
    The rounding rule code associated with a party tax profile.
  • Maximum Length: 1
    Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N.
  • Maximum Length: 1
    Indicates whether this party tax profile is for a supplier. Valid values are Y or N.
  • Title: Tax Classification Code
    Maximum Length: 30
    The tax classification code associated with a party tax profile.
  • Maximum Length: 1
    Indicates 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.
  • Title: Withholding Rounding Level
    Maximum Length: 30
    The withholding rounding level code associated with a party tax profile.
  • Title: Withholding Rounding Rule
    Maximum Length: 30
    The withholding rounding rule code associated with a party tax profile.
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 : partyTaxProfiles-item-response
Type: object
Show Source
  • Title: Allow offset tax calculation
    Maximum Length: 1
    Indicates if a party tax profile has been configured to allow withholding tax calculation. The default value is NO.
  • Title: Create zero amount tax authority invoices
    Maximum Length: 1
    Indicates if a party tax profile has been configured to allow offset tax calculation. The default value is NO.
  • Title: Country Code
    Maximum Length: 2
    The country in the party address for which the party tax profile is defined.
  • Maximum Length: 1
    Indicates whether this party tax profile is for a customer. Valid values are Y or N.
  • Title: Use Subscription of the Legal Entity Start Date
    The date when the party tax profile starts being effective.
  • Title: Set Invoice Values as Tax Inclusive
    Maximum Length: 1
    Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO.
  • Links
  • Unique identifier of the party for which the party tax profile is defined.
  • 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.
  • The system-generated unique identifier of the party tax profile.
  • Title: Party Type
    Maximum Length: 30
    The party type code of the party tax profile.
  • Title: Tax Applicability
    Maximum Length: 1
    Indicates whether the party tax profile definition is taken into account during tax applicability determination. The default value is YES.
  • Title: Tax Registration Type Code
    Maximum Length: 30
    The registration type code associated with a party tax profile.
  • Title: Tax Registration Number
    Maximum Length: 50
    The registration number associated with a party tax profile.
  • Title: Rounding Level
    Maximum Length: 30
    The rounding level code associated with a party tax profile.
  • Title: Rounding Rule
    Maximum Length: 30
    The rounding rule code associated with a party tax profile.
  • Maximum Length: 1
    Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N.
  • Maximum Length: 1
    Indicates whether this party tax profile is for a supplier. Valid values are Y or N.
  • Title: Tax Classification Code
    Maximum Length: 30
    The tax classification code associated with a party tax profile.
  • Maximum Length: 1
    Indicates 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.
  • Title: Use legal entity tax subscription
    Maximum Length: 1
    Indicates 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.
  • Title: Withholding Tax Determination Basis
    Maximum Length: 30
    The date when the withholding tax basis determination begins.
  • Title: Withholding Rounding Level
    Maximum Length: 30
    The withholding rounding level code associated with a party tax profile.
  • Title: Withholding Rounding Rule
    Maximum Length: 30
    The withholding rounding rule code associated with a party tax profile.
  • Title: Uses Legal Entity Withholding Tax Subscription
    Maximum Length: 1
    Indicates 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.
Back to Top

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"
        },
        ...
    ]
}
Back to Top