TAG LINE
SMALL TITLE
Version 4 APIs
APIs based on the latest platform version 10.3.X
Version 3 APIs
APIs based on platform version 10.2.1
Version 2 APIs
APIs based on platform version 10.2.0

Tax / Vendor

(API Version v4)

Represents a list of tax vendors including LogiSense or a 3rd party integration.

What can you do with TaxVendor?

Properties

Property Details
identity
READ-ONLY
"identity": 4
Type: Number
This is the unique numeric identifier for the TaxVendor
ownerId
READ-ONLY
"ownerId": 15
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": "AvaTax"
Type: String
User defined name for the Vendor
companyIdentifier
"companyIdentifier": "logisense_co"
Type: String
Vendor supplied identifier that represents the 3rd party identifier for the integration.
uRL
"uRL": "https://mytaxintegrator.com/integrate"
Type: String
Path to integration endpoint
userName
"userName": "myUser"
Type: String
Username for integration to tax Vendor
password
"password": "myPassword"
Type: String
Password for integration to tax Vendor
clientId
"clientId": "12313-13123-3123"
Type: String
Integration identifier for integration
clientProfileId
"clientProfileId": "12313-13123-3123"
Type: String
Integration profile identifier for integration
isActive
"isActive": true
Type: Boolean
Whether or not this Tax Vendor can actively be used.
taxVendorServiceClassId
"taxVendorServiceClassId": 27
Type: Number
Unique identifier for the associated TaxVendorServiceClass object.
taxVendorServiceClassName
"taxVendorServiceClassName": "Sample Name"
Type: String
The name of the object associated with the taxVendorServiceClassId property.
taxVendorBusinessClassId
"taxVendorBusinessClassId": 18
Type: Number
Unique identifier for the associated TaxVendorBusinessClass object.
taxVendorBusinessClassName
"taxVendorBusinessClassName": "Sample Name"
Type: String
The name of the object associated with the taxVendorBusinessClassId property.
taxVendorTypeId
"taxVendorTypeId": 8
Type: Number
Unique identifier for the associated TaxVendorType object.
taxVendorTypeName
"taxVendorTypeName": "Sample Name"
Type: String
The name of the object associated with the taxVendorTypeId property.
defaultAccountTaxCategoryId
"defaultAccountTaxCategoryId": 13
Type: Number
Unique identifier for the associated AccountTaxCategory object.
defaultAccountTaxCategoryName
"defaultAccountTaxCategoryName": "Sample Name"
Type: String
The name of the object associated with the defaultAccountTaxCategoryId property.
defaultServiceTaxCategoryId
"defaultServiceTaxCategoryId": 26
Type: Number
Unique identifier for the associated ServiceTaxCategory object.
defaultServiceTaxCategoryName
"defaultServiceTaxCategoryName": "Sample Name"
Type: String
The name of the object associated with the defaultServiceTaxCategoryId property.

End Points

DELETEapi/v4/Tax/Vendor/{id}
Delete an instance of the TaxVendor 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 TaxVendor object.
Delete an instance of the TaxVendor object.
DELETE api/v4/Tax/Vendor/{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": "taxVendor"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Tax/Vendor/
Retrieve all of the TaxVendor objects.
Retrieve all of the TaxVendor objects.
GET api/v4/Tax/Vendor/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 7,
            "ownerName": "Sample Text Data",
            "name": "AvaTax",
            "companyIdentifier": "logisense_co",
            "uRL": "https://mytaxintegrator.com/integrate",
            "userName": "myUser",
            "password": "myPassword",
            "clientId": "12313-13123-3123",
            "clientProfileId": "12313-13123-3123",
            "isActive": true,
            "taxVendorServiceClassId": 7,
            "taxVendorServiceClassName": "Sample Text Data",
            "taxVendorBusinessClassId": 6,
            "taxVendorBusinessClassName": "Sample Text Data",
            "taxVendorTypeId": 16,
            "taxVendorTypeName": "Sample Text Data",
            "defaultAccountTaxCategoryId": 24,
            "defaultAccountTaxCategoryName": "Sample Text Data",
            "defaultServiceTaxCategoryId": 3,
            "defaultServiceTaxCategoryName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Tax/Vendor/Paged
Retrieve all of the TaxVendor 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 TaxVendor objects in a paged fashion.
GET api/v4/Tax/Vendor/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": 23,
                "ownerName": "Sample Text Data",
                "name": "AvaTax",
                "companyIdentifier": "logisense_co",
                "uRL": "https://mytaxintegrator.com/integrate",
                "userName": "myUser",
                "password": "myPassword",
                "clientId": "12313-13123-3123",
                "clientProfileId": "12313-13123-3123",
                "isActive": true,
                "taxVendorServiceClassId": 0,
                "taxVendorServiceClassName": "Sample Text Data",
                "taxVendorBusinessClassId": 3,
                "taxVendorBusinessClassName": "Sample Text Data",
                "taxVendorTypeId": 6,
                "taxVendorTypeName": "Sample Text Data",
                "defaultAccountTaxCategoryId": 4,
                "defaultAccountTaxCategoryName": "Sample Text Data",
                "defaultServiceTaxCategoryId": 17,
                "defaultServiceTaxCategoryName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Tax/Vendor/{id}
Retrieve an instance of the TaxVendor object by its ID.
{id}Unique identifier for the TaxVendor object.
Retrieve an instance of the TaxVendor object by its ID.
GET api/v4/Tax/Vendor/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 1,
        "ownerName": "Sample Text Data",
        "name": "AvaTax",
        "companyIdentifier": "logisense_co",
        "uRL": "https://mytaxintegrator.com/integrate",
        "userName": "myUser",
        "password": "myPassword",
        "clientId": "12313-13123-3123",
        "clientProfileId": "12313-13123-3123",
        "isActive": true,
        "taxVendorServiceClassId": 9,
        "taxVendorServiceClassName": "Sample Text Data",
        "taxVendorBusinessClassId": 21,
        "taxVendorBusinessClassName": "Sample Text Data",
        "taxVendorTypeId": 10,
        "taxVendorTypeName": "Sample Text Data",
        "defaultAccountTaxCategoryId": 19,
        "defaultAccountTaxCategoryName": "Sample Text Data",
        "defaultServiceTaxCategoryId": 4,
        "defaultServiceTaxCategoryName": "Sample Text Data"
    }
}
POSTapi/v4/Tax/Vendor/
Create a new instance of the TaxVendor object.
Create a new instance of the TaxVendor object.
POST api/v4/Tax/Vendor/

{
    "name": "AvaTax",
    "companyIdentifier": "logisense_co",
    "uRL": "https://mytaxintegrator.com/integrate",
    "userName": "myUser",
    "password": "myPassword",
    "clientId": "12313-13123-3123",
    "clientProfileId": "12313-13123-3123",
    "isActive": true,
    "taxVendorServiceClassId": 13,
    "taxVendorBusinessClassId": 11,
    "taxVendorTypeId": 10,
    "defaultAccountTaxCategoryId": 5,
    "defaultServiceTaxCategoryId": 7
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 21,
                "ownerName": "Sample Text Data",
                "name": "AvaTax",
                "companyIdentifier": "logisense_co",
                "uRL": "https://mytaxintegrator.com/integrate",
                "userName": "myUser",
                "password": "myPassword",
                "clientId": "12313-13123-3123",
                "clientProfileId": "12313-13123-3123",
                "isActive": true,
                "taxVendorServiceClassId": 17,
                "taxVendorServiceClassName": "Sample Text Data",
                "taxVendorBusinessClassId": 8,
                "taxVendorBusinessClassName": "Sample Text Data",
                "taxVendorTypeId": 21,
                "taxVendorTypeName": "Sample Text Data",
                "defaultAccountTaxCategoryId": 19,
                "defaultAccountTaxCategoryName": "Sample Text Data",
                "defaultServiceTaxCategoryId": 10,
                "defaultServiceTaxCategoryName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/Tax/Vendor/Search
Retreive a list of TaxVendor objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of TaxVendor objects based on search criteria.
POST api/v4/Tax/Vendor/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 3,
            "ownerName": "Sample Text Data",
            "name": "AvaTax",
            "companyIdentifier": "logisense_co",
            "uRL": "https://mytaxintegrator.com/integrate",
            "userName": "myUser",
            "password": "myPassword",
            "clientId": "12313-13123-3123",
            "clientProfileId": "12313-13123-3123",
            "isActive": true,
            "taxVendorServiceClassId": 12,
            "taxVendorServiceClassName": "Sample Text Data",
            "taxVendorBusinessClassId": 9,
            "taxVendorBusinessClassName": "Sample Text Data",
            "taxVendorTypeId": 19,
            "taxVendorTypeName": "Sample Text Data",
            "defaultAccountTaxCategoryId": 16,
            "defaultAccountTaxCategoryName": "Sample Text Data",
            "defaultServiceTaxCategoryId": 2,
            "defaultServiceTaxCategoryName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/Tax/Vendor/{id}
Update an existing instance of the TaxVendor object.
Update an existing instance of the TaxVendor object.
PUT api/v4/Tax/Vendor/{id}

{
    "identity": 1,
    "name": "AvaTax",
    "companyIdentifier": "logisense_co",
    "uRL": "https://mytaxintegrator.com/integrate",
    "userName": "myUser",
    "password": "myPassword",
    "clientId": "12313-13123-3123",
    "clientProfileId": "12313-13123-3123",
    "isActive": true,
    "taxVendorServiceClassId": 0,
    "taxVendorBusinessClassId": 5,
    "taxVendorTypeId": 20,
    "defaultAccountTaxCategoryId": 10,
    "defaultServiceTaxCategoryId": 23
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "name": "AvaTax",
                "companyIdentifier": "logisense_co",
                "uRL": "https://mytaxintegrator.com/integrate",
                "userName": "myUser",
                "password": "myPassword",
                "clientId": "12313-13123-3123",
                "clientProfileId": "12313-13123-3123",
                "isActive": true,
                "taxVendorServiceClassId": 1,
                "taxVendorServiceClassName": "Sample Text Data",
                "taxVendorBusinessClassId": 25,
                "taxVendorBusinessClassName": "Sample Text Data",
                "taxVendorTypeId": 2,
                "taxVendorTypeName": "Sample Text Data",
                "defaultAccountTaxCategoryId": 15,
                "defaultAccountTaxCategoryName": "Sample Text Data",
                "defaultServiceTaxCategoryId": 4,
                "defaultServiceTaxCategoryName": "Sample Text Data"
            }
        ]
    }
}