TAG LINE
SMALL TITLE

Tax / Rate

(API Version v3)


Represents an individual tax rate within the system.


What can you do with TaxRate?


Properties

Property Details
identity
READ-ONLY
"identity": 0
Type: Number
This is the unique numeric identifier for the TaxRate
rate
"rate": 1.13
Type: Number
The multiplier to be used to generate the taxable amount.
name
"name": "VAT"
Type: String
User defined name for the Tax Rate.
ownerId
READ-ONLY
"ownerId": 12
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.
generalLedgerId
"generalLedgerId": 23
Type: Number
Unique identifier for the associated GeneralLedger object.
generalLedgerName
"generalLedgerName": "Sample Name"
Type: String
The name of the object associated with the generalLedgerId property.
displayName
"displayName": "VAT"
Type: String
User defined friendly name for the Tax Rate.
taxOnTax
"taxOnTax": true
Type: Boolean
Unused
systemGenerated
"systemGenerated": true
Type: Boolean
Whether or not this tax was imported by the system typically in an integration with a 3rd party tax vendor.
taxCategoryId
"taxCategoryId": 13
Type: Number
Unique identifier for the associated TaxCategory object.
taxCategoryName
"taxCategoryName": "Sample Name"
Type: String
The name of the object associated with the taxCategoryId property.


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:

  • rate
  • name
  • generalLedgerId
  • displayName
  • taxOnTax
  • systemGenerated
  • taxCategoryId

End Points

DELETEapi/v3/Tax/Rate/{id}
Delete an instance of the TaxRate 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 TaxRate object.
Delete an instance of the TaxRate object.
DELETE api/v3/Tax/Rate/{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": "taxRate"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/Tax/Rate/
Retrieve all of the TaxRate objects.
Retrieve all of the TaxRate objects.
GET api/v3/Tax/Rate/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "rate": 1.13,
            "name": "VAT",
            "ownerId": 23,
            "ownerName": "Sample Text Data",
            "generalLedgerId": 3,
            "generalLedgerName": "Sample Text Data",
            "displayName": "VAT",
            "taxOnTax": true,
            "systemGenerated": true,
            "taxCategoryId": 13,
            "taxCategoryName": "Sample Text Data"
        }
    ]
}
GETapi/v3/Tax/Rate/Paged
Retrieve all of the TaxRate 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 TaxRate objects in a paged fashion.
GET api/v3/Tax/Rate/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,
                "rate": 1.13,
                "name": "VAT",
                "ownerId": 15,
                "ownerName": "Sample Text Data",
                "generalLedgerId": 0,
                "generalLedgerName": "Sample Text Data",
                "displayName": "VAT",
                "taxOnTax": true,
                "systemGenerated": true,
                "taxCategoryId": 1,
                "taxCategoryName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/Tax/Rate/{id}
Retrieve an instance of the TaxRate object by its ID.
{id}Unique identifier for the TaxRate object.
Retrieve an instance of the TaxRate object by its ID.
GET api/v3/Tax/Rate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "rate": 1.13,
        "name": "VAT",
        "ownerId": 8,
        "ownerName": "Sample Text Data",
        "generalLedgerId": 17,
        "generalLedgerName": "Sample Text Data",
        "displayName": "VAT",
        "taxOnTax": true,
        "systemGenerated": true,
        "taxCategoryId": 2,
        "taxCategoryName": "Sample Text Data"
    }
}
POSTapi/v3/Tax/Rate/
Create a new instance of the TaxRate object.
Create a new instance of the TaxRate object.
POST api/v3/Tax/Rate/

{
    "rate": 1.13,
    "name": "VAT",
    "generalLedgerId": 26,
    "displayName": "VAT",
    "taxOnTax": true,
    "systemGenerated": true,
    "taxCategoryId": 19
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "rate": 1.13,
                "name": "VAT",
                "ownerId": 17,
                "ownerName": "Sample Text Data",
                "generalLedgerId": 15,
                "generalLedgerName": "Sample Text Data",
                "displayName": "VAT",
                "taxOnTax": true,
                "systemGenerated": true,
                "taxCategoryId": 9,
                "taxCategoryName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v3/Tax/Rate/{id}
Update an existing instance of the TaxRate object.
Update an existing instance of the TaxRate object.
PUT api/v3/Tax/Rate/{id}

{
    "identity": 1,
    "rate": 1.13,
    "name": "VAT",
    "generalLedgerId": 24,
    "displayName": "VAT",
    "taxOnTax": true,
    "systemGenerated": true,
    "taxCategoryId": 21
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "rate": 1.13,
                "name": "VAT",
                "ownerId": 20,
                "ownerName": "Sample Text Data",
                "generalLedgerId": 18,
                "generalLedgerName": "Sample Text Data",
                "displayName": "VAT",
                "taxOnTax": true,
                "systemGenerated": true,
                "taxCategoryId": 23,
                "taxCategoryName": "Sample Text Data"
            }
        ]
    }
}