Vendor types

Vendor types organize vendors into categories that are used for reporting. To share vendor types across entities, create vendor types at the top level. Creating vendor types in an entity restricts them to that entity. For more information, see Vendor types.

List vendor types

get/objects/accounts-payable/vendor-type

Returns a collection with a key, ID, and link for each vendor type. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "14",
      • "id": "WholeSale",
      • "href": "/objects/accounts-payable/vendor-type/14"
      },
    • {
      • "key": "2",
      • "id": "Supplier",
      • "href": "/objects/accounts-payable/vendor-type/2"
      },
    • {
      • "key": "4",
      • "id": "VType-1099INT",
      • "href": "/objects/accounts-payable/vendor-type/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Create a vendor type
post/objects/accounts-payable/vendor-type
Creates a new vendor type.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name or other unique identifier for the vendor type.


 
 Example:  "Retail"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Form 1099 information for the vendor type. If vendors require 1099 forms, save time by creating a vendor type for 1099 contractors and assigning a default 1099 form and box to that vendor type.


 
type
string
Type of 1099 form.


 
 Example:  "DIV"
box
string
Box number for form 1099.


 
 Example:  "1B"
object
Assign a parent to make this vendor type subordinate to another vendor type.


 
key
string
System-assigned key for the parent vendor type.


 
 Example:  "1"
id
string
Name or other unique identifier for the parent vendor type.


 
 Example:  "Wholesaler"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "WholeSaleDistributor",
  • "form1099": {
    • "type": "DIV",
    • "box": "1B"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "23",
    • "id": "WholeSaleDistributor",
    • "href": "/objects/accounts-payable/vendor-type/23"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a vendor type
get/objects/accounts-payable/vendor-type/{key}
Returns detailed information for a specified vendor type.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the vendor type.


 
 Example:  4
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "Wholesaler",
    • "parent": {
      • "id": "WholeSaleDistributor",
      • "key": "23",
      • "href": "/objects/accounts-payable/vendor-type/23"
      },
    • "status": "active",
    • "form1099": {
      • "type": "DIV",
      • "box": "1B"
      },
    • "key": "5",
    • "audit": {
      • "createdDateTime": "2018-07-28T19:29:46Z",
      • "modifiedDateTime": "2023-04-11T06:53:27Z",
      • "createdBy": "68",
      • "modifiedBy": "68"
      },
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "href": "/objects/accounts-payable/vendor-type/5"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a vendor type
patch/objects/accounts-payable/vendor-type/{key}
Updates an existing vendor type by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the vendor type.


 
 Example:  4
Request Body schema: application/json
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Form 1099 information for the vendor type. If vendors require 1099 forms, save time by creating a vendor type for 1099 contractors and assigning a default 1099 form and box to that vendor type.


 
type
string
Type of 1099 form.


 
 Example:  "DIV"
box
string
Box number for form 1099.


 
 Example:  "1B"
object
Assign a parent to make this vendor type subordinate to another vendor type.


 
key
string
System-assigned key for the parent vendor type.


 
 Example:  "1"
id
string
Name or other unique identifier for the parent vendor type.


 
 Example:  "Wholesaler"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "inactive"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "Wholesaler",
    • "href": "/objects/accounts-payable/vendor-type/5"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a vendor type
delete/objects/accounts-payable/vendor-type/{key}
Deletes a vendor type.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the vendor type.


 
 Example:  4
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}