REST API Reference for Launch Cloud Service

Get all tax service providers

get

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

Request

Query Parameters

description: string

The description of the resource.
eligibleForProject: string

Project Id
fields: string

The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
id: string

The unique identifier of the resource item.
limit: integer

The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
name: string

The name of the resource.
offset: string

The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
taxCodes.taxCode: string

tax code value.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: array

Show Source

Array of: object TaxServiceProviderOracle

Title: TaxServiceProviderOracle

The tax service provider name and list of taxcodes supported.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TaxServiceProviderOracle"
    }
}

Nested 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

{
    "title":"TaxServiceProviderOracle",
    "type":"object",
    "description":"The tax service provider name and list of taxcodes supported.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"A string. Unique identifier of the tax service provider"
        },
        "href":{
            "type":"string",
            "description":"A string. Reference of the tax service provider."
        },
        "name":{
            "type":"string",
            "description":"A string. Name of the tax service provider."
        },
        "description":{
            "type":"string",
            "description":"A string. A narrative that explains in detail what the tax service provider is."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the tax service provider."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the tax service provider."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this tax service provider."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"A date time (DateTime). Date and time of the last update of the tax service provider."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "taxCodes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxCodeGLRelationship"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Tax Service Provider"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of the lifecycle to be exported"
        },
        "version":{
            "type":"string",
            "description":"Tax Service Provider version"
        }
    },
    "required":[
        "name"
    ]
}

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

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : taxCodes

Type: array

Show Source

Array of: object TaxCodeGLRelationship

Title: TaxCodeGLRelationship

TaxCodeGLRelationship object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TaxCodeGLRelationship"
    }
}

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

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    },
    "required":[
        "startDateTime"
    ]
}

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.

{
    "title":"TaxCodeGLRelationship",
    "type":"object",
    "description":"TaxCodeGLRelationship object.",
    "properties":{
        "taxCode":{
            "type":"string",
            "description":"tax code value."
        },
        "taxPercentage":{
            "type":"number",
            "description":"tax percentage value."
        },
        "description":{
            "type":"string",
            "description":"Description of the tax code."
        },
        "glid":{
            "type":"string",
            "description":"glid value."
        },
        "@type":{
            "type":"string",
            "description":"Class type of target Service specification Characteristic Relationship"
        },
        "@baseType":{
            "type":"string",
            "description":"base class type  (immediate parent) of the ServiceSpecCharacteristicRelationship"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"hyperlink reference to schema describing this object"
        }
    },
    "required":[
        "taxCode"
    ]
}

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: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Examples

The following example shows how to get tax service provides by submitting a GET request on the REST resource using cURL.

Command: curl -u username:password -X PUT \ 
'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/catalogManagement/v1/taxServiceProvider'

Example of Response Body

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

[
    {
        "lastUpdate": "2023-10-03T05:26:48.175Z",
        "lastUpdatedBy": "booth",
        "created": "2023-10-03T05:26:48.000Z",
        "createdBy": "booth",
        "versionState": 0,
        "id": "TAXSP001",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/taxServiceProvider/TAXSP001",
        "name": "Tax Service Provider 001",
        "description": "Description for TAXSP001",
        "@type": "TaxServiceProviderOracle",
        "project": {
            "id": "AutomationProject",
            "name": "AutomationProject",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/AutomationProject"
        },
        "@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"
    },
    {
        "lastUpdate": "2023-10-04T06:12:31.184Z",
        "lastUpdatedBy": "booth",
        "created": "2023-07-24T05:34:22.000Z",
        "createdBy": "booth",
        "versionState": 0,
        "id": "Avalara",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/taxServiceProvider/Avalara",
        "name": "Avalara",
        "description": "string",
        "@type": "TaxServiceProviderOracle",
        "project": {
            "id": "24A_ProductModel_PSP",
            "name": "24A - DX4C Product Model",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/24A_ProductModel_PSP",
            "versionState": 0
        },
        "validFor": {
            "startDateTime": "2021-01-01T00:00:00.000Z"
        },
        "taxCodes": [
            {
                "taxCode": "13/6",
                "taxPercentage": 0.1,
                "description": "Cellular/Access Charge"
            },
            {
                "taxCode": "4/11",
                "taxPercentage": 0.1,
                "description": "Non-recurring/Activation"
            },
            {
                "taxCode": "13/622",
                "taxPercentage": 0.1,
                "description": "Cellular/Text Message"
            },
            {
                "taxCode": "13/30",
                "taxPercentage": 0.1,
                "description": "Cellular/Feature Charge"
            },
            {
                "taxCode": "13/33",
                "taxPercentage": 0.1,
                "description": "Cellular/Roaming Charge"
            },
            {
                "taxCode": "10/15",
                "taxPercentage": 0.15,
                "description": "Sales/Product"
            },
            {
                "taxCode": "3/632",
                "taxPercentage": 0.2,
                "description": "Other/Service Contracts"
            },
            {
                "taxCode": "57/609",
                "taxPercentage": 0.12,
                "description": "Digital Goods/Streaming Video"
            },
            {
                "taxCode": "16/35",
                "taxPercentage": 0.12,
                "description": "Cable Television/Premium Service"
            },
            {
                "taxCode": "16/37",
                "taxPercentage": 0.12,
                "description": "Cable Television/Equipment Rental"
            },
            {
                "taxCode": "16/584",
                "taxPercentage": 0.12,
                "description": "Cable Television/Digital Channel Tier"
            },
            {
                "taxCode": "13/49",
                "taxPercentage": 0.12,
                "description": "Cable Television/Digital Channel Tier"
            },
            {
                "taxCode": "57/673",
                "taxPercentage": 0.12,
                "description": "Digital Goods/Streaming Video - On-Net - On Demand"
            },
            {
                "taxCode": "25/62",
                "taxPercentage": 0.12,
                "description": "Timesharing/Information Retrieval"
            }
        ],
        "lifecycleStatus": "In design",
        "version": "1.0"
    },
...
]