Create a party tax profile
post
/fscmRestApi/resources/11.13.18.05/partyTaxProfiles
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
-
AllowOffsetTaxFlag: boolean
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. -
AllowZeroAmountWhtInvoiceFlag: boolean
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. -
CountryCode: string
Title:
Country Code
Maximum Length:2
The country in the party address for which the party tax profile is defined. -
CustomerFlag: boolean
Maximum Length:
1
Indicates 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 Date
The date when the party tax profile starts being effective. -
InclusiveTaxFlag: boolean
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. -
PartyId: integer
(int64)
Unique identifier of the party for which the party tax profile is defined.
-
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. -
PartyTaxProfileId: integer
(int64)
The system-generated unique identifier of the party tax profile.
-
PartyTypeCode: string
Title:
Party Type
Maximum Length:30
The party type code of the party tax profile. -
ProcessForApplicabilityFlag: boolean
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. -
RegistrationTypeCode: string
Title:
Tax Registration Type Code
Maximum Length:30
The registration type code associated with a party tax profile. -
RepresentativeRegistrationNumber: string
Title:
Tax Registration Number
Maximum Length:50
The registration number associated with a party tax profile. -
RoundingLevelCode: string
Title:
Rounding Level
Maximum Length:30
The rounding level code associated with a party tax profile. -
RoundingRuleCode: string
Title:
Rounding Rule
Maximum Length:30
The rounding rule code associated with a party tax profile. -
SiteFlag: boolean
Maximum Length:
1
Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N. -
SupplierFlag: boolean
Maximum Length:
1
Indicates whether this party tax profile is for a supplier. Valid values are Y or N. -
TaxClassificationCode: string
Title:
Tax Classification Code
Maximum Length:30
The tax classification code associated with a party tax profile. -
TaxGrossNetFlagCode: string
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. -
UseLeAsSubscriberFlag: boolean
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. -
WhtDateBasis: string
Title:
Withholding Tax Determination Basis
Maximum Length:30
The date when the withholding tax basis determination begins. -
WhtRoundingLevelCode: string
Title:
Withholding Rounding Level
Maximum Length:30
The withholding rounding level code associated with a party tax profile. -
WhtRoundingRuleCode: string
Title:
Withholding Rounding Rule
Maximum Length:30
The withholding rounding rule code associated with a party tax profile. -
WhtUseLeAsSubscriberFlag: boolean
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.
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 calculation
Maximum Length:1
Indicates 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 invoices
Maximum Length:1
Indicates if a party tax profile has been configured to allow offset tax calculation. The default value is NO. -
CountryCode: string
Title:
Country Code
Maximum Length:2
The country in the party address for which the party tax profile is defined. -
CustomerFlag: boolean
Maximum Length:
1
Indicates 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 Date
The date when the party tax profile starts being effective. -
InclusiveTaxFlag: boolean
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: array
Links
Title:
Links
The 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 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. -
PartyTaxProfileId: integer
(int64)
The system-generated unique identifier of the party tax profile.
-
PartyTypeCode: string
Title:
Party Type
Maximum Length:30
The party type code of the party tax profile. -
ProcessForApplicabilityFlag: boolean
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. -
RegistrationTypeCode: string
Title:
Tax Registration Type Code
Maximum Length:30
The registration type code associated with a party tax profile. -
RepresentativeRegistrationNumber: string
Title:
Tax Registration Number
Maximum Length:50
The registration number associated with a party tax profile. -
RoundingLevelCode: string
Title:
Rounding Level
Maximum Length:30
The rounding level code associated with a party tax profile. -
RoundingRuleCode: string
Title:
Rounding Rule
Maximum Length:30
The rounding rule code associated with a party tax profile. -
SiteFlag: boolean
Maximum Length:
1
Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N. -
SupplierFlag: boolean
Maximum Length:
1
Indicates whether this party tax profile is for a supplier. Valid values are Y or N. -
TaxClassificationCode: string
Title:
Tax Classification Code
Maximum Length:30
The tax classification code associated with a party tax profile. -
TaxGrossNetFlagCode: string
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. -
UseLeAsSubscriberFlag: boolean
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. -
WhtDateBasis: string
Title:
Withholding Tax Determination Basis
Maximum Length:30
The date when the withholding tax basis determination begins. -
WhtRoundingLevelCode: string
Title:
Withholding Rounding Level
Maximum Length:30
The withholding rounding level code associated with a party tax profile. -
WhtRoundingRuleCode: string
Title:
Withholding Rounding Rule
Maximum Length:30
The withholding rounding rule code associated with a party tax profile. -
WhtUseLeAsSubscriberFlag: boolean
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.
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
- 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