TAG LINE
SMALL TITLE

Service / Tax Category

(API Version v2)


User defined Tax Category to be assigned to a Tax Codes.


What can you do with ServiceTaxCategory?


Properties

Property Details
identity
READ-ONLY
"identity": 22
Type: Number
This is the unique numeric identifier for the ServiceTaxCategory
ownerId
READ-ONLY
"ownerId": 17
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Land Line Taxable"
Type: String
User defined name for the Tax Category.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name

End Points

DELETEapi/v2/Service/TaxCategory/{id}
Delete an instance of the ServiceTaxCategory object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the ServiceTaxCategory object.
Delete an instance of the ServiceTaxCategory object.
DELETE api/v2/Service/TaxCategory/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "serviceTaxCategory"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/Service/TaxCategory/
Retrieve all of the ServiceTaxCategory objects.
Retrieve all of the ServiceTaxCategory objects.
GET api/v2/Service/TaxCategory/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 23,
            "ownerName": "Sample Text Data",
            "name": "Land Line Taxable"
        }
    ]
}
GETapi/v2/Service/TaxCategory/Paged
Retrieve all of the ServiceTaxCategory objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the ServiceTaxCategory objects in a paged fashion.
GET api/v2/Service/TaxCategory/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 19,
                "ownerName": "Sample Text Data",
                "name": "Land Line Taxable"
            }
        ]
    }
}
GETapi/v2/Service/TaxCategory/{id}
Retrieve an instance of the ServiceTaxCategory object by its ID.
{id}Unique identifier for the ServiceTaxCategory object.
Retrieve an instance of the ServiceTaxCategory object by its ID.
GET api/v2/Service/TaxCategory/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 4,
        "ownerName": "Sample Text Data",
        "name": "Land Line Taxable"
    }
}
POSTapi/v2/Service/TaxCategory/
Create a new instance of the ServiceTaxCategory object.
Create a new instance of the ServiceTaxCategory object.
POST api/v2/Service/TaxCategory/

{
    "name": "Land Line Taxable"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 4,
                "ownerName": "Sample Text Data",
                "name": "Land Line Taxable"
            }
        ]
    }
}
PUTapi/v2/Service/TaxCategory/{id}
Update an existing instance of the ServiceTaxCategory object.
Update an existing instance of the ServiceTaxCategory object.
PUT api/v2/Service/TaxCategory/{id}

{
    "identity": 1,
    "name": "Land Line Taxable"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "name": "Land Line Taxable"
            }
        ]
    }
}