Update a tax service provider
patch
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/taxServiceProvider/{id}
Request
Path Parameters
-
id(required): string
The unique identifier of the resource item.
Supported Media Types
- application/json
Root Schema : TaxServiceProviderOracle
Type:
object
Title:
TaxServiceProviderOracle
The tax service provider name and list of taxcodes supported.
Show Source
-
@baseType: string
Immediate base (class) type of the tax service provider.
-
@schemaLocation: string
A link to the schema describing this tax service provider.
-
@type: string
Class type of the tax service provider.
-
applicationName: string
name of the external application
-
created: string
(date-time)
Date and time of creation
-
createdBy: string
name of the person who created
-
description: string
A string. A narrative that explains in detail what the tax service provider is.
-
externalId: string
id of the external application
-
href: string
A string. Reference of the tax service provider.
-
id: string
Maximum Length:
30
A string. Unique identifier of the tax service provider -
lastUpdate: string
(date-time)
A date time (DateTime). Date and time of the last update of the tax service provider.
-
lastUpdatedBy: string
name of the person who updated
-
lifecycleStatus: string
Status of the lifecycle to be exported
-
name(required): string
A string. Name of the tax service provider.
-
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
taxCodes: array
taxCodes
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
Tax Service Provider version
-
versionState: number
Version state of the Tax Service Provider
Nested Schema : ProjectRef
Type:
object
Title:
ProjectRef
Project Reference
Show Source
-
href: string
Unique reference of the project
-
id(required): string
Unique identifier of the project
-
name: string
Name of the project
-
version: string
Version of the project
Nested Schema : taxCodes
Type:
Show Source
array
-
Array of:
object TaxCodeGLRelationship
Title:
TaxCodeGLRelationship
TaxCodeGLRelationship object.
Nested Schema : TimePeriod
Type:
object
Title:
TimePeriod
The period for which the productOffering is valid
Show Source
-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime(required): string
(date-time)
An instant of time, starting at the TimePeriod
Nested Schema : TaxCodeGLRelationship
Type:
object
Title:
TaxCodeGLRelationship
TaxCodeGLRelationship object.
Show Source
-
@baseType: string
base class type (immediate parent) of the ServiceSpecCharacteristicRelationship
-
@schemaLocation: string
hyperlink reference to schema describing this object
-
@type: string
Class type of target Service specification Characteristic Relationship
-
description: string
Description of the tax code.
-
glid: string
glid value.
-
taxCode(required): string
tax code value.
-
taxPercentage: number
tax percentage value.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : TaxServiceProviderOracle
Type:
object
Title:
TaxServiceProviderOracle
The tax service provider name and list of taxcodes supported.
Show Source
-
@baseType: string
Immediate base (class) type of the tax service provider.
-
@schemaLocation: string
A link to the schema describing this tax service provider.
-
@type: string
Class type of the tax service provider.
-
applicationName: string
name of the external application
-
created: string
(date-time)
Date and time of creation
-
createdBy: string
name of the person who created
-
description: string
A string. A narrative that explains in detail what the tax service provider is.
-
externalId: string
id of the external application
-
href: string
A string. Reference of the tax service provider.
-
id: string
Maximum Length:
30
A string. Unique identifier of the tax service provider -
lastUpdate: string
(date-time)
A date time (DateTime). Date and time of the last update of the tax service provider.
-
lastUpdatedBy: string
name of the person who updated
-
lifecycleStatus: string
Status of the lifecycle to be exported
-
name(required): string
A string. Name of the tax service provider.
-
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
taxCodes: array
taxCodes
-
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
Tax Service Provider version
-
versionState: number
Version state of the Tax Service Provider
Nested Schema : ProjectRef
Type:
object
Title:
ProjectRef
Project Reference
Show Source
-
href: string
Unique reference of the project
-
id(required): string
Unique identifier of the project
-
name: string
Name of the project
-
version: string
Version of the project
Nested Schema : taxCodes
Type:
Show Source
array
-
Array of:
object TaxCodeGLRelationship
Title:
TaxCodeGLRelationship
TaxCodeGLRelationship object.
Nested Schema : TimePeriod
Type:
object
Title:
TimePeriod
The period for which the productOffering is valid
Show Source
-
endDateTime: string
(date-time)
An instant of time, ending at the TimePeriod.
-
startDateTime(required): string
(date-time)
An instant of time, starting at the TimePeriod
Nested Schema : TaxCodeGLRelationship
Type:
object
Title:
TaxCodeGLRelationship
TaxCodeGLRelationship object.
Show Source
-
@baseType: string
base class type (immediate parent) of the ServiceSpecCharacteristicRelationship
-
@schemaLocation: string
hyperlink reference to schema describing this object
-
@type: string
Class type of target Service specification Characteristic Relationship
-
description: string
Description of the tax code.
-
glid: string
glid value.
-
taxCode(required): string
tax code value.
-
taxPercentage: number
tax percentage value.
400 Response
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
404 Response
Your request includes a resource URI that doesn't exist.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list)
-
message: string
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
Examples
The following example shows how to update a tax service provider details by submitting a PATCH request on the REST resource using cURL. In this example, we will be updating the name of a project for the tax service provider.
Command: curl -u username:password -X PATCH \ 'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/catalogManagement/v1/taxServiceProvider/24A_ProductModel_PSP
Example of Request Body
The following example shows the contents of the request body in JSON format:
{ "description": "This is a new tax service provider based out of the Americas", "project": { "id": "24A_ProductModel_PSP", "name": "24A - DX4C Product Model for PSP", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/24A_ProductModel_PSP", "versionState": 0 } }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "lastUpdate": "2023-10-04T09:38:40.363Z", "lastUpdatedBy": "booth", "created": "2023-10-03T05:26:48.000Z", "createdBy": "booth", "id": "TAXSP001", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/taxServiceProvider/Avalara/TAXSP001", "name": "Tax Service Provider 001", "description": "This is a new tax service provider based out of the Americas", "@type": "TaxServiceProviderOracle", "project": { "id": "24A_ProductModel_PSP", "name": "24A - DX4C Product Model for PSP", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/24A_ProductModel_PSP", "versionState": 0 }, "@baseType": "TaxServiceProvider", "validFor": { "startDateTime": "2020-09-29T03:50:48.000Z" }, "taxCodes": [ { "taxCode": "TC100", "description": "Description for TC100", "glid": "ID_TC100", "@type": "TaxCodeGLRelationshipOracle" }, { "taxCode": "TC200", "description": "Description for TC200", "glid": "ID_TC200", "@type": "TaxCodeGLRelationshipOracle" }, { "taxCode": "TC300", "description": "Description for TC300", "glid": "ID_TC300", "@type": "TaxCodeGLRelationshipOracle" } ], "externalId": "eid", "applicationName": "LaunchX", "lifecycleStatus": "In design", "version": "1.0" } }