REST API Reference for Launch Cloud Service

Get all tax service providers

get

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

Returns a list of tax service providers that match the search criteria.

Request

Query Parameters

description: string

The description of the resource.
eligibleForProject: string

The 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 ID of the resource item.
lastUpdate: string

Filters resources by their last update date and time.
lifecycleStatus: string

The current lifecycle status of the resource.
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.
project.id: string

The ID of the project for filtering resource results.
project.version: string

The project version for filtering entities.
taxCodes.taxCode: string

The tax code associated with the resource.
validFor.endDateTime: string

The valid for end date time for filtering entities.
validFor.startDateTime: string

The valid for start date time for filtering entities.
version: string

The current version of the resource.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The list of tax service providers was returned successfully.

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

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

The 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: ProjectRef

The project reference resource.
taxCodes: array taxCodes

A list of tax codes associated with the tax service provider.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The tax service provider version.
versionState: number

The 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":"The ID 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",
            "description":"The period for which the tax service provider is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the tax service provider."
        },
        "@baseType":{
            "type":"string",
            "description":"The base 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":"The date and time of creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated."
        },
        "taxCodes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TaxCodeGLRelationship"
            },
            "description":"A list of tax codes associated with the tax service provider."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The tax service provider."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the tax service provider."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the tax service provider."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the Tax Service Provider."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the tax service provider."
        },
        "version":{
            "type":"string",
            "description":"The tax service provider version."
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

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.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : taxCodes

Type: array

A list of tax codes associated with the tax service provider.

Show Source

Array of: object TaxCodeGLRelationship

Title: TaxCodeGLRelationship

The taxCodeGLRelationship object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TaxCodeGLRelationship"
    },
    "description":"A list of tax codes associated with the tax service provider."
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid.

Show Source

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.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Nested Schema : TaxCodeGLRelationship

Type: object

Title: TaxCodeGLRelationship

The taxCodeGLRelationship object.

Show Source

@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.

{
    "title":"TaxCodeGLRelationship",
    "type":"object",
    "description":"The taxCodeGLRelationship object.",
    "properties":{
        "taxCode":{
            "type":"string",
            "description":"The tax code associated with the tax code gl relationship."
        },
        "taxPercentage":{
            "type":"number",
            "description":"The tax percentage value."
        },
        "description":{
            "type":"string",
            "description":"The description of the tax code."
        },
        "glid":{
            "type":"string",
            "description":"The glid value."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the tax code gl relationship."
        },
        "@baseType":{
            "type":"string",
            "description":"The base class type (immediate parent) of the ServiceSpecCharacteristicRelationship."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the tax code gl relationship."
        }
    },
    "required":[
        "taxCode",
        "@type"
    ]
}

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

The error resource.

Show Source

@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.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@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.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@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.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@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.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

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

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@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.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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": "2025-02-17T13:20:07.013Z",
    "lastUpdatedBy": "booth",
    "created": "2025-01-08T07:29:50.000Z",
    "createdBy": "booth",
    "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/productCatalogManagement/v1/project/AutomationProject",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "@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": "2025-02-17T13:20:07.013Z",
    "lastUpdatedBy": "booth",
    "created": "2025-01-08T07:29:50.000Z",
    "createdBy": "booth",
    "id": "TAXSP002",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/taxServiceProvider/TAXSP002",
    "name": "Tax Service Provider 002",
    "description": "Description for TAXSP002",
    "@type": "TaxServiceProviderOracle",
    "project": {
        "id": "AutomationProject",
        "name": "AutomationProject",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/AutomationProject",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "@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"
}
]