Create or update an array of tax service providers

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/taxServiceProviders

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 50
Show Source
Nested Schema : TaxServiceProviderOracle
Type: object
Title: TaxServiceProviderOracle
The tax service provider name and list of taxcodes supported.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : taxCodes
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : TaxCodeGLRelationship
Type: object
Title: TaxCodeGLRelationship
TaxCodeGLRelationship object.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Your request is successful and the resources have been created or updated.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : TaxServiceProviderOracle
Type: object
Title: TaxServiceProviderOracle
The tax service provider name and list of taxcodes supported.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : taxCodes
Type: array
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid
Show Source
Nested Schema : TaxCodeGLRelationship
Type: object
Title: TaxCodeGLRelationship
TaxCodeGLRelationship object.
Show Source

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.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

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"
    }
]
Back to Top