Jump to

• Request
• Response
• Examples

Get a party tax profile

get

/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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• 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.

{
    "type":"object",
    "properties":{
        "TaxGrossNetFlagCode":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveFromUseLe":{
            "title":"Use Subscription of the Legal Entity Start Date",
            "type":"string",
            "description":"The date when the party tax profile starts being effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "WhtDateBasis":{
            "title":"Withholding Tax Determination Basis",
            "maxLength":30,
            "type":"string",
            "description":"The date when the withholding tax basis determination begins.",
            "nullable":true,
            "x-queryable":true
        },
        "WhtRoundingRuleCode":{
            "title":"Withholding Rounding Rule",
            "maxLength":30,
            "type":"string",
            "description":"The withholding rounding rule code associated with a party tax profile.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The party name for which the party tax profile is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteNumber":{
            "title":"Party Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The party site number for which the party tax profile is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTypeCode":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"The party type code of the party tax profile.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowOffsetTaxFlag":{
            "title":"Allow offset tax calculation",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if a party tax profile has been configured to allow withholding tax calculation. The default value is NO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RegistrationTypeCode":{
            "title":"Tax Registration Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The registration type code associated with a party tax profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"The country in the party address for which the party tax profile is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SiteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this party tax profile is for a customer site or supplier site. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this party tax profile is for a customer. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this party tax profile is for a supplier. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "WhtRoundingLevelCode":{
            "title":"Withholding Rounding Level",
            "maxLength":30,
            "type":"string",
            "description":"The withholding rounding level code associated with a party tax profile.",
            "nullable":true,
            "x-queryable":true
        },
        "UseLeAsSubscriberFlag":{
            "title":"Use legal entity tax subscription",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "InclusiveTaxFlag":{
            "title":"Set Invoice Values as Tax Inclusive",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the party tax profile has been configured to allow inclusive tax calculation. The default value is NO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowZeroAmountWhtInvoiceFlag":{
            "title":"Create zero amount tax authority invoices",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if a party tax profile has been configured to allow offset tax calculation. The default value is NO.",
            "nullable":true,
            "x-queryable":true
        },
        "WhtUseLeAsSubscriberFlag":{
            "title":"Uses Legal Entity Withholding Tax Subscription",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number for which the party tax profile is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Unique identifier of the party for which the party tax profile is defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RepresentativeRegistrationNumber":{
            "title":"Tax Registration Number",
            "maxLength":50,
            "type":"string",
            "description":"The registration number associated with a party tax profile.",
            "nullable":true,
            "x-queryable":true
        },
        "RoundingLevelCode":{
            "title":"Rounding Level",
            "maxLength":30,
            "type":"string",
            "description":"The rounding level code associated with a party tax profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaxClassificationCode":{
            "title":"Tax Classification Code",
            "maxLength":30,
            "type":"string",
            "description":"The tax classification code associated with a party tax profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcessForApplicabilityFlag":{
            "title":"Tax Applicability",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the party tax profile definition is taken into account during tax applicability determination. The default value is YES.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTaxProfileId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the party tax profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RoundingRuleCode":{
            "title":"Rounding Rule",
            "maxLength":30,
            "type":"string",
            "description":"The rounding rule code associated with a party tax profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

taxClassifications

Operation: /fscmRestApi/resources/11.13.18.05/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

Back to Top

Examples

The following example shows how to retrieve a party tax profile by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/partyTaxProfiles/809531

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": "12345678912",
    "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "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