TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 3 Type: Number This is the unique numeric identifier for the TaxVendor |
ownerId READ-ONLY | "ownerId": 24 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": "Hello World" Type: String |
companyIdentifier | "companyIdentifier": "Hello World" Type: String |
uRL | "uRL": "Hello World" Type: String |
userName | "userName": "Hello World" Type: String |
password | "password": "Hello World" Type: String |
clientId | "clientId": "Hello World" Type: String |
clientProfileId | "clientProfileId": "Hello World" Type: String |
isActive | "isActive": true Type: Boolean |
taxVendorServiceClassId | "taxVendorServiceClassId": 16 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": 1 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": 3 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": 18 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": 1 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. |
| DELETE | api/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}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"
}
]
}
} | |
| GET | api/v4/Tax/Vendor/ |
| Retrieve all of the TaxVendor objects. | |
Retrieve all of the TaxVendor objects. GET api/v4/Tax/Vendor/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 11,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"companyIdentifier": "Sample Text Data",
"uRL": "Sample Text Data",
"userName": "Sample Text Data",
"password": "Sample Text Data",
"clientId": "Sample Text Data",
"clientProfileId": "Sample Text Data",
"isActive": true,
"taxVendorServiceClassId": 6,
"taxVendorServiceClassName": "Sample Text Data",
"taxVendorBusinessClassId": 13,
"taxVendorBusinessClassName": "Sample Text Data",
"taxVendorTypeId": 15,
"taxVendorTypeName": "Sample Text Data",
"defaultAccountTaxCategoryId": 17,
"defaultAccountTaxCategoryName": "Sample Text Data",
"defaultServiceTaxCategoryId": 2,
"defaultServiceTaxCategoryName": "Sample Text Data"
}
]
} | |
| GET | api/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 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": 3,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"companyIdentifier": "Sample Text Data",
"uRL": "Sample Text Data",
"userName": "Sample Text Data",
"password": "Sample Text Data",
"clientId": "Sample Text Data",
"clientProfileId": "Sample Text Data",
"isActive": true,
"taxVendorServiceClassId": 14,
"taxVendorServiceClassName": "Sample Text Data",
"taxVendorBusinessClassId": 15,
"taxVendorBusinessClassName": "Sample Text Data",
"taxVendorTypeId": 21,
"taxVendorTypeName": "Sample Text Data",
"defaultAccountTaxCategoryId": 4,
"defaultAccountTaxCategoryName": "Sample Text Data",
"defaultServiceTaxCategoryId": 27,
"defaultServiceTaxCategoryName": "Sample Text Data"
}
]
}
} | |
| GET | api/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}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 27,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"companyIdentifier": "Sample Text Data",
"uRL": "Sample Text Data",
"userName": "Sample Text Data",
"password": "Sample Text Data",
"clientId": "Sample Text Data",
"clientProfileId": "Sample Text Data",
"isActive": true,
"taxVendorServiceClassId": 27,
"taxVendorServiceClassName": "Sample Text Data",
"taxVendorBusinessClassId": 3,
"taxVendorBusinessClassName": "Sample Text Data",
"taxVendorTypeId": 6,
"taxVendorTypeName": "Sample Text Data",
"defaultAccountTaxCategoryId": 19,
"defaultAccountTaxCategoryName": "Sample Text Data",
"defaultServiceTaxCategoryId": 12,
"defaultServiceTaxCategoryName": "Sample Text Data"
}
} | |
| POST | api/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": "Sample Text Data",
"companyIdentifier": "Sample Text Data",
"uRL": "Sample Text Data",
"userName": "Sample Text Data",
"password": "Sample Text Data",
"clientId": "Sample Text Data",
"clientProfileId": "Sample Text Data",
"isActive": true,
"taxVendorServiceClassId": 12,
"taxVendorBusinessClassId": 26,
"taxVendorTypeId": 3,
"defaultAccountTaxCategoryId": 21,
"defaultServiceTaxCategoryId": 16
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 1,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"companyIdentifier": "Sample Text Data",
"uRL": "Sample Text Data",
"userName": "Sample Text Data",
"password": "Sample Text Data",
"clientId": "Sample Text Data",
"clientProfileId": "Sample Text Data",
"isActive": true,
"taxVendorServiceClassId": 15,
"taxVendorServiceClassName": "Sample Text Data",
"taxVendorBusinessClassId": 23,
"taxVendorBusinessClassName": "Sample Text Data",
"taxVendorTypeId": 20,
"taxVendorTypeName": "Sample Text Data",
"defaultAccountTaxCategoryId": 1,
"defaultAccountTaxCategoryName": "Sample Text Data",
"defaultServiceTaxCategoryId": 1,
"defaultServiceTaxCategoryName": "Sample Text Data"
}
]
}
} | |
| POST | api/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"
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"itemCount": 1,
"items": [
{
"identity": 1,
"ownerId": 6,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"companyIdentifier": "Sample Text Data",
"uRL": "Sample Text Data",
"userName": "Sample Text Data",
"password": "Sample Text Data",
"clientId": "Sample Text Data",
"clientProfileId": "Sample Text Data",
"isActive": true,
"taxVendorServiceClassId": 18,
"taxVendorServiceClassName": "Sample Text Data",
"taxVendorBusinessClassId": 10,
"taxVendorBusinessClassName": "Sample Text Data",
"taxVendorTypeId": 24,
"taxVendorTypeName": "Sample Text Data",
"defaultAccountTaxCategoryId": 22,
"defaultAccountTaxCategoryName": "Sample Text Data",
"defaultServiceTaxCategoryId": 11,
"defaultServiceTaxCategoryName": "Sample Text Data"
}
]
} | |
| PUT | api/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": "Sample Text Data",
"companyIdentifier": "Sample Text Data",
"uRL": "Sample Text Data",
"userName": "Sample Text Data",
"password": "Sample Text Data",
"clientId": "Sample Text Data",
"clientProfileId": "Sample Text Data",
"isActive": true,
"taxVendorServiceClassId": 1,
"taxVendorBusinessClassId": 18,
"taxVendorTypeId": 3,
"defaultAccountTaxCategoryId": 0,
"defaultServiceTaxCategoryId": 23
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 12,
"ownerName": "Sample Text Data",
"name": "Sample Text Data",
"companyIdentifier": "Sample Text Data",
"uRL": "Sample Text Data",
"userName": "Sample Text Data",
"password": "Sample Text Data",
"clientId": "Sample Text Data",
"clientProfileId": "Sample Text Data",
"isActive": true,
"taxVendorServiceClassId": 17,
"taxVendorServiceClassName": "Sample Text Data",
"taxVendorBusinessClassId": 17,
"taxVendorBusinessClassName": "Sample Text Data",
"taxVendorTypeId": 20,
"taxVendorTypeName": "Sample Text Data",
"defaultAccountTaxCategoryId": 5,
"defaultAccountTaxCategoryName": "Sample Text Data",
"defaultServiceTaxCategoryId": 8,
"defaultServiceTaxCategoryName": "Sample Text Data"
}
]
}
} | |