Jump to

• Request
• Response
• Examples

Update a tax exemption

patch

/fscmRestApi/resources/11.13.18.05/taxExemptions/{TaxExemptionId}

Request

Path Parameters

• TaxExemptionId(required): integer(int64)
  The unique identifier of the system-generated primary key column.

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApplyToLowerLevelsFlag: boolean
  Title: Apply to lower levels

  Maximum Length: 1

  Default Value: false

  The action to apply a tax exemption to all taxes that use this tax as the tax exemptions source. For example, if a STATE tax is configured as the tax exemption source for both the COUNTY and CITY tax, then checking this box applies the tax exemption at both of the COUNTY and CITY tax levels.
• ClauseReference: string
  Title: Clause

  Maximum Length: 30

  The legal tax clause on the basis of which the Letter of Intent applies to suppliers or customers.
• CustomChargeFlag: boolean
  Title: Address to customs office

  Maximum Length: 1

  Indicates whether a Letter of Intent should be addressed to the local customs office.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account associated with a tax exemption.
• DetFactorTemplCode: string
  Title: Determining Factor Set Code

  Maximum Length: 30

  The determining factor template code associated with a tax exemption.
• EffectiveTo: string (date)
  Title: End Date

  The date when the tax exemptions stop being effective.
• ExemptCertificateNumber: string
  Title: Certificate Number

  Maximum Length: 80

  The exemption certificate number associated with a tax exemption granted by a tax authority.
• ExemptionStatusCode: string
  Title: Exempt Status

  Maximum Length: 30

  Default Value: PRIMARY

  The exemption status code indicates the approval status of an exemption. The valid values are PRIMARY, MANUAL, DISCONTINUED, REJECTED, and UNAPPROVED.
• ExemptReasonCode: string
  Title: Exempt Reason

  Maximum Length: 30

  The exemption reason code associated with a tax exemption.
• SiteUseId: integer (int64)
  The unique identifier of the site use associated with a tax exemption.
• SuspendFromDate: string (date)
  Title: Suspension or Revocation From Date

  The date from which the status of an existing tax exemption is set to REJECTED.
• SuspendToDate: string (date)
  Title: Suspension To Date

  The date to which the status of an existing tax exemption is set to either REJECTED or DISCONTINUED.

{
    "type":"object",
    "properties":{
        "SiteUseId":{
            "type":"integer",
            "description":"The unique identifier of the site use associated with a tax exemption.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ApplyToLowerLevelsFlag":{
            "title":"Apply to lower levels",
            "maxLength":1,
            "type":"boolean",
            "description":"The action to apply a tax exemption to all taxes that use this tax as the tax exemptions source. For example, if a STATE tax is configured as the tax exemption source for both the COUNTY and CITY tax, then checking this box applies the tax exemption at both of the COUNTY and CITY tax levels.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_YES_NO"
            }
        },
        "SuspendFromDate":{
            "title":"Suspension or Revocation From Date",
            "type":"string",
            "description":"The date from which the status of an existing tax exemption is set to REJECTED.",
            "format":"date",
            "nullable":true
        },
        "SuspendToDate":{
            "title":"Suspension To Date",
            "type":"string",
            "description":"The date to which the status of an existing tax exemption is set to either REJECTED or DISCONTINUED.",
            "format":"date",
            "nullable":true
        },
        "ClauseReference":{
            "title":"Clause",
            "maxLength":30,
            "type":"string",
            "description":"The legal tax clause on the basis of which the Letter of Intent applies to suppliers or customers.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExemptCertificateNumber":{
            "title":"Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The exemption certificate number associated with a tax exemption granted by a tax authority.",
            "nullable":true
        },
        "ExemptionStatusCode":{
            "title":"Exempt Status",
            "maxLength":30,
            "type":"string",
            "description":"The exemption status code indicates the approval status of an exemption. The valid values are PRIMARY, MANUAL, DISCONTINUED, REJECTED, and UNAPPROVED.",
            "nullable":false,
            "default":"PRIMARY",
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "controlType":"choice",
                "APPCORE_LOOKUP_TYPE":"ZX_EXEMPTION_STATUS"
            }
        },
        "DetFactorTemplCode":{
            "title":"Determining Factor Set Code",
            "maxLength":30,
            "type":"string",
            "description":"The determining factor template code associated with a tax exemption.",
            "nullable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account associated with a tax exemption.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExemptReasonCode":{
            "title":"Exempt Reason",
            "maxLength":30,
            "type":"string",
            "description":"The exemption reason code associated with a tax exemption.",
            "nullable":true,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "controlType":"choice",
                "APPCORE_LOOKUP_TYPE":"ZX_EXEMPTION_REASON_CODE"
            }
        },
        "CustomChargeFlag":{
            "title":"Address to customs office",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a Letter of Intent should be addressed to the local customs office.",
            "nullable":true
        },
        "EffectiveTo":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the tax exemptions stop being effective.",
            "format":"date",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : taxExemptions-item-response

Type: object

Show Source

• ApplyToLowerLevelsFlag: boolean
  Title: Apply to lower levels

  Maximum Length: 1

  Default Value: false

  The action to apply a tax exemption to all taxes that use this tax as the tax exemptions source. For example, if a STATE tax is configured as the tax exemption source for both the COUNTY and CITY tax, then checking this box applies the tax exemption at both of the COUNTY and CITY tax levels.
• ClauseReference: string
  Title: Clause

  Maximum Length: 30

  The legal tax clause on the basis of which the Letter of Intent applies to suppliers or customers.
• ContentOwner: string
  Title: Configuration Owner

  Maximum Length: 240

  The configuration owner associated with a tax exemption.
• ContentOwnerId: integer (int64)
  The unique identifier of the content owner associated with a tax exemption.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 80

  The country in the party address for which the tax exemption applies.
• CustomChargeFlag: boolean
  Title: Address to customs office

  Maximum Length: 1

  Indicates whether a Letter of Intent should be addressed to the local customs office.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account associated with a tax exemption.
• DetFactorTemplCode: string
  Title: Determining Factor Set Code

  Maximum Length: 30

  The determining factor template code associated with a tax exemption.
• EffectiveFrom: string (date)
  Title: Start Date

  The date when the tax exemptions start being effective.
• EffectiveTo: string (date)
  Title: End Date

  The date when the tax exemptions stop being effective.
• ExemptCertificateNumber: string
  Title: Certificate Number

  Maximum Length: 80

  The exemption certificate number associated with a tax exemption granted by a tax authority.
• ExemptionStatusCode: string
  Title: Exempt Status

  Maximum Length: 30

  Default Value: PRIMARY

  The exemption status code indicates the approval status of an exemption. The valid values are PRIMARY, MANUAL, DISCONTINUED, REJECTED, and UNAPPROVED.
• ExemptionTypeCode: string
  Title: Exemption Rate Type

  Maximum Length: 30

  Default Value: DISCOUNT

  The lookup code that indicates the exemption type. Possible values are DISCOUNT, SURCHARGE, and SPECIAL RATE. The exemption rate type attribute represents the method of calculating the tax exemption percentage.
• ExemptionUsageCode: string
  Title: Code

  Maximum Length: 30

  The exemption usage code that identifies the activity for which a tax exemption is granted by a tax authority.
• ExemptReasonCode: string
  Title: Exempt Reason

  Maximum Length: 30

  The exemption reason code associated with a tax exemption.
• InventoryOrgId: integer
  The unique identifier of the inventory organization associated with an item referenced in a tax exemption.
• IssueDate: string (date)
  Title: Letter Date

  The date when a tax exemption is issued.
• IssueFlag: boolean
  Title: Prepare Letter of Intent

  Maximum Length: 1

  Indicates whether to create or register the Letter of Intent based on the party type chosen. The Letter of Intent is issued to indicate the VAT exemption limit applicable to a supplier or customer.
• IssuingTaxAuthority: string
  Title: Issuing Tax Authority

  The tax authority that issued an exemption.
• IssuingTaxAuthorityId: integer (int64)
  The unique identifier of the issuing tax authority that has granted a tax exemption.
• ItemNumber: string
  Title: Item Number

  The inventory item number for which a tax exemption applies.
• LimitAmount: number
  Title: Exemption Amount

  The dollar amount limit for a granted tax exemption.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Organization: string
  Title: Inventory Organization

  The name of the corresponding inventory organization for an item that is eligible for a tax exemption. This is applicable for product-specific tax exemptions.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The party name associated with a tax exemption.
• PartyNumber: string
  Title: Party Number

  Maximum Length: 30

  The party number associated with a tax exemption.
• PartySiteNumber: string
  Title: Party Site Number

  Maximum Length: 30

  The party site number associated with a tax exemption.
• PartyTaxAllowOffsetTaxFlag: boolean
  Title: Allow offset tax calculation

  Indicates whether the party tax profile has been configured to allow offset tax calculation. The default value is NO.
• PartyTaxClassificationCode: string
  Title: Tax Classification Code

  The tax classification code for the party tax profile associated with a tax exemption.
• PartyTaxInclusiveTaxFlag: boolean
  Title: Set Invoice Values as Tax Inclusive

  Indicates whether the party tax profile has been configured to allow inclusive tax calculation.
• PartyTaxProcessForApplicabilityFlag: boolean
  Title: Tax Applicability

  Indicates whether the party tax profile definition is applied as part of the tax determination process.
• PartyTaxProfileId: integer (int64)
  The unique identifier of the party tax profile associated with a tax exemption.
• PartyTaxRoundingLevelCode: string
  Title: Rounding Level

  The value that specifies the rounding to be applied to party tax amounts on a transaction.
• PartyTaxRoundingRuleCode: string
  Title: Rounding Rule

  The rounding rule code for the party tax profile associated with a tax exemption.
• PartyType: string
  Title: Party Type

  The party type associated with a tax exemption.
• PartyTypeCode: string
  Title: Party Type

  Maximum Length: 30

  The party type code associated with a tax exemption.
• PartyTypeFlag: boolean
  Title: Party Type

  Maximum Length: 1

  Indicates whether a tax exemption party type is a customer or a supplier. The default value is CUSTOMER.
• PartyUsage: string
  Title: Party Usage

  Read Only: true

  Maximum Length: 17

  Indicates whether a third-party tax exemption is applicable to a customer or supplier.
• PrintFlag: boolean
  Title: Letter of Intent ready to print

  Maximum Length: 1

  Indicates whether a tax exemption letter of intent is ready to print. The default value is NO.
• ProductId: integer
  The unique identifier of the product for which a tax exemption applies.
• RateModifier: number
  Title: Exemption Percentage

  The exemption percentage associated with a tax exemption.
• RecordingDate: string (date)
  Title: Recording Date

  The date when a tax exemption is recorded.
• RecordTypeCode: string
  Title: Party Type

  Maximum Length: 30

  The record type code of a tax exemption.
• ReportingCodeChar: string
  Title: Tax Reporting Code

  The value of the reporting code associated with a tax exemption.
• ReportingCodeId: integer
  The unique identifier of the reporting code associated with a tax exemption.
• ReportingCodeName: string
  Title: Tax Reporting Code

  The name of the reporting code associated with a tax exemption.
• ReportingTypeId: integer
  The unique identifier of the reporting type associated with a tax exemption.
• ReportingTypeName: string
  Title: Tax Reporting Type Name

  The name of the reporting type associated with a tax exemption.
• SiteUseId: integer (int64)
  The unique identifier of the site use associated with a tax exemption.
• SuspendFromDate: string (date)
  Title: Suspension or Revocation From Date

  The date from which the status of an existing tax exemption is set to REJECTED.
• SuspendToDate: string (date)
  Title: Suspension To Date

  The date to which the status of an existing tax exemption is set to either REJECTED or DISCONTINUED.
• Tax: string
  Title: Tax

  Maximum Length: 30

  A specific tax for which an existing tax exemption is applied.
• TaxExemptionId: integer (int64)
  The unique identifier of the system-generated primary key column.
• TaxJurisdictionCode: string
  Title: Tax Jurisdiction Code

  The tax jurisdiction code that identifies the location for which a tax exemption has been granted by a tax authority.
• TaxJurisdictionId: integer (int64)
  The unique identifier of the tax jurisdiction for which the tax exemption applies.
• TaxRateCode: string
  Title: Rate Code

  Maximum Length: 50

  A specific tax rate for which an existing tax exemption is applied.
• TaxRegimeCode: string
  Title: Tax Regime Code

  Maximum Length: 30

  A specific tax regime for which an existing tax exemption is applied.
• TaxStatusCode: string
  Title: Status Code

  Maximum Length: 30

  A specific tax status for which an existing tax exemption is applied.

{
    "type":"object",
    "properties":{
        "ContentOwnerId":{
            "type":"integer",
            "description":"The unique identifier of the content owner associated with a tax exemption.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TaxRegimeCode"
                ]
            },
            "x-queryable":true
        },
        "SuspendFromDate":{
            "title":"Suspension or Revocation From Date",
            "type":"string",
            "description":"The date from which the status of an existing tax exemption is set to REJECTED.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The party name associated with a tax exemption.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Tax":{
            "title":"Tax",
            "maxLength":30,
            "type":"string",
            "description":"A specific tax for which an existing tax exemption is applied.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "TaxRegimeCode"
                ]
            },
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"The unique identifier of the product for which a tax exemption applies.",
            "nullable":true,
            "x-queryable":true
        },
        "ExemptionStatusCode":{
            "title":"Exempt Status",
            "maxLength":30,
            "type":"string",
            "description":"The exemption status code indicates the approval status of an exemption. The valid values are PRIMARY, MANUAL, DISCONTINUED, REJECTED, and UNAPPROVED.",
            "nullable":false,
            "default":"PRIMARY",
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "controlType":"choice",
                "APPCORE_LOOKUP_TYPE":"ZX_EXEMPTION_STATUS"
            },
            "x-queryable":true
        },
        "PartyTypeFlag":{
            "title":"Party Type",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a tax exemption party type is a customer or a supplier. The default value is CUSTOMER.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTypeCode":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"The party type code associated with a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExemptionTypeCode":{
            "title":"Exemption Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the exemption type. Possible values are DISCOUNT, SURCHARGE, and SPECIAL RATE. The exemption rate type attribute represents the method of calculating the tax exemption percentage.",
            "nullable":false,
            "default":"DISCOUNT",
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "controlType":"choice",
                "APPCORE_LOOKUP_TYPE":"ZX_EXEMPTION_TYPE"
            },
            "x-queryable":true
        },
        "TaxRegimeCode":{
            "title":"Tax Regime Code",
            "maxLength":30,
            "type":"string",
            "description":"A specific tax regime for which an existing tax exemption is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "ExemptReasonCode":{
            "title":"Exempt Reason",
            "maxLength":30,
            "type":"string",
            "description":"The exemption reason code associated with a tax exemption.",
            "nullable":true,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "controlType":"choice",
                "APPCORE_LOOKUP_TYPE":"ZX_EXEMPTION_REASON_CODE"
            },
            "x-queryable":true
        },
        "CustomChargeFlag":{
            "title":"Address to customs office",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a Letter of Intent should be addressed to the local customs office.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveTo":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the tax exemptions stop being effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartyUsage":{
            "title":"Party Usage",
            "maxLength":17,
            "type":"string",
            "description":"Indicates whether a third-party tax exemption is applicable to a customer or supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyTaxClassificationCode":{
            "title":"Tax Classification Code",
            "type":"string",
            "description":"The tax classification code for the party tax profile associated with a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "LimitAmount":{
            "title":"Exemption Amount",
            "type":"number",
            "description":"The dollar amount limit for a granted tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization associated with an item referenced in a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxJurisdictionId":{
            "type":"integer",
            "description":"The unique identifier of the tax jurisdiction for which the tax exemption applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "Tax",
                    "TaxRegimeCode"
                ]
            },
            "x-queryable":true
        },
        "RecordingDate":{
            "title":"Recording Date",
            "type":"string",
            "description":"The date when a tax exemption is recorded.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IssueFlag":{
            "title":"Prepare Letter of Intent",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to create or register the Letter of Intent based on the party type chosen. The Letter of Intent is issued to indicate the VAT exemption limit applicable to a supplier or customer.",
            "nullable":true,
            "x-queryable":true
        },
        "ClauseReference":{
            "title":"Clause",
            "maxLength":30,
            "type":"string",
            "description":"The legal tax clause on the basis of which the Letter of Intent applies to suppliers or customers.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReportingCodeName":{
            "title":"Tax Reporting Code",
            "type":"string",
            "description":"The name of the reporting code associated with a tax exemption.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TaxJurisdictionCode":{
            "title":"Tax Jurisdiction Code",
            "type":"string",
            "description":"The tax jurisdiction code that identifies the location for which a tax exemption has been granted by a tax authority.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":80,
            "type":"string",
            "description":"The country in the party address for which the tax exemption applies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssuingTaxAuthorityId":{
            "type":"integer",
            "description":"The unique identifier of the issuing tax authority that has granted a tax exemption.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SiteUseId":{
            "type":"integer",
            "description":"The unique identifier of the site use associated with a tax exemption.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Organization":{
            "title":"Inventory Organization",
            "type":"string",
            "description":"The name of the corresponding inventory organization for an item that is eligible for a tax exemption. This is applicable for product-specific tax exemptions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReportingCodeId":{
            "type":"integer",
            "description":"The unique identifier of the reporting code associated with a tax exemption.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyTaxInclusiveTaxFlag":{
            "title":"Set Invoice Values as Tax Inclusive",
            "type":"boolean",
            "description":"Indicates whether the party tax profile has been configured to allow inclusive tax calculation.",
            "nullable":true,
            "x-queryable":true
        },
        "SuspendToDate":{
            "title":"Suspension To Date",
            "type":"string",
            "description":"The date to which the status of an existing tax exemption is set to either REJECTED or DISCONTINUED.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PrintFlag":{
            "title":"Letter of Intent ready to print",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a tax exemption letter of intent is ready to print. The default value is NO.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportingTypeId":{
            "type":"integer",
            "description":"The unique identifier of the reporting type associated with a tax exemption.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySiteNumber":{
            "title":"Party Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The party site number associated with a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "DetFactorTemplCode":{
            "title":"Determining Factor Set Code",
            "maxLength":30,
            "type":"string",
            "description":"The determining factor template code associated with a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "type":"string",
            "description":"The inventory item number for which a tax exemption applies.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecordTypeCode":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"The record type code of a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account associated with a tax exemption.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyTaxRoundingLevelCode":{
            "title":"Rounding Level",
            "type":"string",
            "description":"The value that specifies the rounding to be applied to party tax amounts on a transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentOwner":{
            "title":"Configuration Owner",
            "maxLength":240,
            "type":"string",
            "description":"The configuration owner associated with a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyTaxAllowOffsetTaxFlag":{
            "title":"Allow offset tax calculation",
            "type":"boolean",
            "description":"Indicates whether the party tax profile has been configured to allow offset tax calculation. The default value is NO.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "type":"string",
            "description":"The party type associated with a tax exemption.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReportingCodeChar":{
            "title":"Tax Reporting Code",
            "type":"string",
            "description":"The value of the reporting code associated with a tax exemption.",
            "nullable":true,
            "x-queryable":false
        },
        "ApplyToLowerLevelsFlag":{
            "title":"Apply to lower levels",
            "maxLength":1,
            "type":"boolean",
            "description":"The action to apply a tax exemption to all taxes that use this tax as the tax exemptions source. For example, if a STATE tax is configured as the tax exemption source for both the COUNTY and CITY tax, then checking this box applies the tax exemption at both of the COUNTY and CITY tax levels.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "APPCORE_VIEW_APPLICATION_ID":"0",
                "APPCORE_LOOKUP_TYPE":"ZX_YES_NO"
            },
            "x-queryable":true
        },
        "PartyTaxProcessForApplicabilityFlag":{
            "title":"Tax Applicability",
            "type":"boolean",
            "description":"Indicates whether the party tax profile definition is applied as part of the tax determination process.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxRateCode":{
            "title":"Rate Code",
            "maxLength":50,
            "type":"string",
            "description":"A specific tax rate for which an existing tax exemption is applied.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Tax",
                    "TaxRegimeCode",
                    "TaxStatusCode"
                ]
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Letter Date",
            "type":"string",
            "description":"The date when a tax exemption is issued.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExemptCertificateNumber":{
            "title":"Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"The exemption certificate number associated with a tax exemption granted by a tax authority.",
            "nullable":true,
            "x-queryable":true
        },
        "ExemptionUsageCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The exemption usage code that identifies the activity for which a tax exemption is granted by a tax authority.",
            "nullable":true,
            "x-queryable":true
        },
        "IssuingTaxAuthority":{
            "title":"Issuing Tax Authority",
            "type":"string",
            "description":"The tax authority that issued an exemption.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReportingTypeName":{
            "title":"Tax Reporting Type Name",
            "type":"string",
            "description":"The name of the reporting type associated with a tax exemption.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number associated with a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxExemptionId":{
            "type":"integer",
            "description":"The unique identifier of the system-generated primary key column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartyTaxRoundingRuleCode":{
            "title":"Rounding Rule",
            "type":"string",
            "description":"The rounding rule code for the party tax profile associated with a tax exemption.",
            "nullable":true,
            "x-queryable":true
        },
        "RateModifier":{
            "title":"Exemption Percentage",
            "type":"number",
            "description":"The exemption percentage associated with a tax exemption.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveFrom":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the tax exemptions start being effective.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TaxStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"A specific tax status for which an existing tax exemption is applied.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Tax",
                    "TaxRegimeCode"
                ]
            },
            "x-queryable":true
        },
        "PartyTaxProfileId":{
            "type":"integer",
            "description":"The unique identifier of the party tax profile associated with a tax exemption.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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

taxAuthorityProfiles

Operation: /fscmRestApi/resources/11.13.18.05/taxAuthorityProfiles

The list of values for issuing tax authority for the tax exemption.

The following properties are defined on the LOV link relation:

• Source Attribute: IssuingTaxAuthority; Target Attribute: PartyName
• Display Attribute: PartyName, PartyTaxProfileId

Back to Top

Examples

The following example shows how to update a tax exemption 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/taxExemptions/300100059769632

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
 "TaxJurisdictionCode": "FL"
}

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": "REL11FSCMCMN_ORG2",
    "PartyNumber": "CDRM_110738",
    "PartySiteNumber": "CDRM_105458",
    "PartyType": null,
    "ExemptionUsageCode": "N",
    "TaxRegimeCode": "ES IGIC",
    "ContentOwner": "AB Investment Services",
    "Tax": "ES IGIC",
    "TaxStatusCode": "ES IGIC EXEMPT",
    "TaxRateCode": "ES IGIC EXEMPT",
    "TaxJurisdictionCode": "FL",
    "ItemNumber": null,
    "Organization": null,
    "EffectiveFrom": "2015-03-22",
    "EffectiveTo": "2019-03-22",
    "ExemptCertificateNumber": "8888",
    "RecordingDate": null,
    "IssueDate": null,
    "ExemptionTypeCode": "SPECIAL_RATE",
    "RateModifier": 10,
    "ExemptionStatusCode": "PRIMARY",
    "IssuingTaxAuthority": null,
    "ApplyToLowerLevelsFlag": false,
    "SuspendFromDate": null,
    "SuspendToDate": null,
    "LimitAmount": null,
    "ExemptReasonCode": "Research",
    "ClauseReference": null,
    "IssueFlag": null,
    "PartyTypeFlag": false,
    "PrintFlag": null,
    "PartyUsage": "CUSTOMER",
    "Country": null,
    "ContentOwnerId": 300100036750370,
    "CustomerAccountId": null,
    "CustomChargeFlag": null,
    "DetFactorTemplCode": null,
    "InventoryOrgId": 300100051148316,
    "IssuingTaxAuthorityId": 300100002767831,
    "PartyTaxProfileId": 300100059769624,
    "ProductId": null,
    "RecordTypeCode": "USER_DEFINED",
    "SiteUseId": null,
    "TaxJurisdictionId": 100000012508262,
    "TaxExemptionId": 300100059769632,
    "ReportingTypeId": null,
    "ReportingCodeId": null,
    "ReportingTypeName": null,
    "ReportingCodeName": null,
    "ReportingCodeChar": null,
    "PartyTaxAllowOffsetTaxFlag": null,
    "PartyTaxRoundingLevelCode": null,
    "PartyTaxInclusiveTaxFlag": null,
    "PartyTaxClassificationCode": null,
    "PartyTaxRoundingRuleCode": null,
    "PartyTaxProcessForApplicabilityFlag": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632",
            "name": "taxExemptions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632",
            "name": "taxExemptions",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/clauseRefs",
            "name": "clauseRefs",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/inventoryOrgs",
            "name": "inventoryOrgs",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/exemptionTypeLookups",
            "name": "exemptionTypeLookups",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/partyTypeLookups",
            "name": "partyTypeLookups",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxJurisdictions",
            "name": "taxJurisdictions",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxReportingCodes",
            "name": "taxReportingCodes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/items",
            "name": "items",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxReportingTypes",
            "name": "taxReportingTypes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxLookupforExemptionReasonCodes",
            "name": "taxLookupforExemptionReasonCodes",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/exemptionStatusLookups",
            "name": "exemptionStatusLookups",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/taxExemptions/300100059769632/lov/taxAuthorityProfiles",
            "name": "taxAuthorityProfiles",
            "kind": "collection"
        }
    ]
}

Back to Top