Create or update an array of tax service providers
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/taxServiceProviders
Request
There are no request parameters for this operation.
- application/json
array
1
50
-
Array of:
object TaxServiceProviderOracle
Title:
TaxServiceProviderOracle
The tax service provider name and list of taxcodes supported.
object
TaxServiceProviderOracle
-
@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
object
ProjectRef
-
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
array
-
Array of:
object TaxCodeGLRelationship
Title:
TaxCodeGLRelationship
TaxCodeGLRelationship object.
object
TimePeriod
-
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
object
TaxCodeGLRelationship
-
@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
- application/json
200 Response
array
-
Array of:
object TaxServiceProviderOracle
Title:
TaxServiceProviderOracle
The tax service provider name and list of taxcodes supported.
object
TaxServiceProviderOracle
-
@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
object
ProjectRef
-
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
array
-
Array of:
object TaxCodeGLRelationship
Title:
TaxCodeGLRelationship
TaxCodeGLRelationship object.
object
TimePeriod
-
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
object
TaxCodeGLRelationship
-
@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
array
-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
401 Response
object
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
object
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
object
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
object
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 create or update an array of tax service provider by submitting a put request on the REST resource using cURL.
cURL Command
curl -u username:password -X PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/taxServiceProviders/ -H 'Content-Type: application/json' -D @put_taxserviceproviders.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
[ { "id": "TaxServiceProvider_001", "name": "TaxServiceProvider_001", "description": "Service Provider description", "@type": "TaxServiceProviderOracle", "@baseType": "TaxServiceProvider", "validFor": { "startDateTime": "2020-06-19T16:42:23.0Z", "endDateTime": "2020-08-19T16:42:23.0Z" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project" }, "taxCodes": [ { "taxCode": "Code123", "description": "tax code description update ", "glid": "id test ", "@type": "TaxCodeGLRelationshipOracle" }, { "taxCode": "Code234", "description": "tax code description ", "glid": "id test", "@type": "TaxCodeGLRelationshipOracle" } ] }, { "id": "TaxServiceProvider_002", "name": "TaxServiceProvider_002", "description": "Service Provider description", "@type": "TaxServiceProviderOracle", "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/TaxServiceProviderOracle.yml", "@baseType": "TaxServiceProvider", "validFor": { "startDateTime": "2020-06-19T16:42:23.0Z", "endDateTime": "2020-08-19T16:42:23.0Z" }, "project": { "id": "BulkDocProject", "name": "Bulk Doc Project" }, "taxCodes": [ { "taxCode": "Code123", "description": "tax code description update ", "glid": "id test 001", "@type": "TaxCodeGLRelationshipOracle" }, { "taxCode": "Code234", "description": "tax code description ", "glid": "id test 002", "@type": "TaxCodeGLRelationshipOracle" } ] } ]
Example of Response Body
The following shows an example of the response body in JSON format.
[ { "@type": "TaxServiceProviderOracle", "@baseType": "TaxServiceProvider", "taxCodes": [ { "@type": "TaxCodeGLRelationshipOracle", "taxCode": "Code123", "glid": "id test ", "description": "tax code description update " }, { "@type": "TaxCodeGLRelationshipOracle", "taxCode": "Code234", "glid": "id test", "description": "tax code description " } ], "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/taxServiceProviders/TaxServiceProvider_001", "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject" }, "validFor": { "startDateTime": "2020-06-19T16:42:23.0Z", "endDateTime": "2020-08-19T16:42:23.0Z" }, "description": "Service Provider description", "name": "TaxServiceProvider_001", "id": "TaxServiceProvider_001" }, { "@type": "TaxServiceProviderOracle", "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/TaxServiceProviderOracle.yml", "@baseType": "TaxServiceProvider", "taxCodes": [ { "@type": "TaxCodeGLRelationshipOracle", "taxCode": "Code123", "glid": "id test 001", "description": "tax code description update " }, { "@type": "TaxCodeGLRelationshipOracle", "taxCode": "Code234", "glid": "id test 002", "description": "tax code description " } ], "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/taxServiceProviders/TaxServiceProvider_002", "project": { "id": "BulkDocProject", "name": "Bulk Doc Project", "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject" }, "validFor": { "startDateTime": "2020-06-19T16:42:23.0Z", "endDateTime": "2020-08-19T16:42:23.0Z" }, "description": "Service Provider description", "name": "TaxServiceProvider_002", "id": "TaxServiceProvider_002", "lifecycleStatus": "In design" } ]