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
array150-
Array of:
object TaxServiceProviderOracle
Title:
TaxServiceProviderOracleThe tax service provider name and list of taxcodes supported.
objectTaxServiceProviderOracle-
@baseType: string
The base type of the tax service provider.
-
@schemaLocation: string
A link to the schema describing this tax service provider.
-
@type(required): string
The class type of the tax service provider.
-
applicationName: string
The name of the application associated with the tax service provider.
-
created: string
(date-time)
The date and time of creation.
-
createdBy: string
The name of the person who created.
-
description: string
A string. A narrative that explains in detail what the tax service provider is.
-
externalId: string
The ID of the external associated with the tax service provider.
-
href: string
A string. Reference of the tax service provider.
-
id: string
Maximum Length:
30The ID 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
The name of the person who updated.
-
lifecycleStatus: string
The status of the tax service provider.
-
name(required): string
A string. Name of the tax service provider.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
taxCodes: array
taxCodes
A list of tax codes associated with the tax service provider.
-
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The tax service provider version.
-
versionState: number
The version state of the Tax Service Provider.
objectProjectRef-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
array-
Array of:
object TaxCodeGLRelationship
Title:
TaxCodeGLRelationshipThe taxCodeGLRelationship object.
objectTimePeriod-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
objectTaxCodeGLRelationship-
@baseType: string
The base class type (immediate parent) of the ServiceSpecCharacteristicRelationship.
-
@schemaLocation: string
The URI of the schema that defines the tax code gl relationship.
-
@type(required): string
The class type of the tax code gl relationship.
-
description: string
The description of the tax code.
-
glid: string
The glid value.
-
taxCode(required): string
The tax code associated with the tax code gl relationship.
-
taxPercentage: number
The tax percentage value.
Response
- application/json
200 Response
array-
Array of:
object TaxServiceProviderOracle
Title:
TaxServiceProviderOracleThe tax service provider name and list of taxcodes supported.
objectTaxServiceProviderOracle-
@baseType: string
The base type of the tax service provider.
-
@schemaLocation: string
A link to the schema describing this tax service provider.
-
@type(required): string
The class type of the tax service provider.
-
applicationName: string
The name of the application associated with the tax service provider.
-
created: string
(date-time)
The date and time of creation.
-
createdBy: string
The name of the person who created.
-
description: string
A string. A narrative that explains in detail what the tax service provider is.
-
externalId: string
The ID of the external associated with the tax service provider.
-
href: string
A string. Reference of the tax service provider.
-
id: string
Maximum Length:
30The ID 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
The name of the person who updated.
-
lifecycleStatus: string
The status of the tax service provider.
-
name(required): string
A string. Name of the tax service provider.
-
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
taxCodes: array
taxCodes
A list of tax codes associated with the tax service provider.
-
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The tax service provider version.
-
versionState: number
The version state of the Tax Service Provider.
objectProjectRef-
href: string
The hyperlink reference to the project reference.
-
id(required): string
The ID of the project reference.
-
name: string
The name of the project reference.
-
version: string
The version of the project.
array-
Array of:
object TaxCodeGLRelationship
Title:
TaxCodeGLRelationshipThe taxCodeGLRelationship object.
objectTimePeriod-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
objectTaxCodeGLRelationship-
@baseType: string
The base class type (immediate parent) of the ServiceSpecCharacteristicRelationship.
-
@schemaLocation: string
The URI of the schema that defines the tax code gl relationship.
-
@type(required): string
The class type of the tax code gl relationship.
-
description: string
The description of the tax code.
-
glid: string
The glid value.
-
taxCode(required): string
The tax code associated with the tax code gl relationship.
-
taxPercentage: number
The 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
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@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
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@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
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@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
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@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
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
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"
}
]