1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Tax Service Provider

Create or update a tax service provider

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/taxServiceProvider/{id}

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root 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

OK
Body ()
Root 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 : Error
Type: object
Title: Error
Show Source

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 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 PUT \ 
'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/catalogManagement/v1/taxServiceProvider/Tax_3243' -D @put_taxservprovider.json | json_pp

Example of Request Body

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

{
    "taxCodes": [
        {
            "taxCode": "Tax_3223",
            "description": "The code is used to tax perquisites..",
            "glid": "pin_tax_3223",
            "@type": "TaxCodeGLRelationshipOracle"
        }
    ]
   project": {
     "id": "Tax_6437",
   "name": "India_Tax_2020_2021"
    }
}

Example of Response Body

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

{
    "id": "Tax_3243",
    "name": "Pinnacle Financials",
    "description": "Pinnacle financials provides tax services for APAC region.",
    "@type": "TaxServiceProviderOracle",
    "@baseType": "TaxServiceProvider",
    "validFor": {
        "startDateTime": "2020-06-19T16:42:23.0Z",
        "endDateTime": "2021-08-19T16:42:23.0Z"
    },
    "taxCodes": [
        {
            "taxCode": "Tax_1323",
            "description": "The code is used to tax capital gains.",
            "glid": "pin_tax_1323",
            "@type": "TaxCodeGLRelationshipOracle"
        },
        {
            "taxCode": "Tax_1424",
            "description": "The code is used to tax income from additional sources.",
            "glid": "pin_tax_1424",
            "@type": "TaxCodeGLRelationshipOracle"
        },
			{
            "taxCode": "Tax_3223",
            "description": "The code is used to tax perquisites..",
            "glid": "pin_tax_3223",
            "@type": "TaxCodeGLRelationshipOracle"
        }
    ],
"project": {
     "id": "Tax_5532",
   "name": "Australia_Tax_2020_2021"
    },
	{
     "id": "Tax_6437",
   "name": "India_Tax_2020_2021",
   "lifecycleStatus": "In design"
    }
}
Back to Top