Vendor account numbers

The account number that a vendor assigns to an entity in a multi-entity company. For example, a telephone company might assign a phone number as a vendor account number. Account numbers help match payment information to bills being paid.

List vendor account numbers

get/objects/accounts-payable/vendor-account-number

Returns a collection with a key, ID, and link for each vendor account number. 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": "1",
      • "id": "1",
      • "href": "/objects/accounts-payable/vendor-account-number/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/accounts-payable/vendor-account-number/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/accounts-payable/vendor-account-number/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a vendor account number
post/objects/accounts-payable/vendor-account-number
Creates a new vendor account number. Associate an entity's location with a vendor and assign an account number for that vendor and entity location pair.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
required
object
Vendor the account number is associated with.


 
key
string
Unique key for the vendor.


 
 Example:  "9"
id
string
Unique ID for the vendor.


 
 Example:  "9"
required
object
Location associated with the entity.


 
key
string
Unique key for the location.


 
 Example:  "1"
id
string
Unique ID for the location.


 
 Example:  "1"
vendorAccountNumber
required
string
Vendor account number for the associated entity.


 
 Example:  "VAN-5134986722"
id
string
Unique identifier for the vendor account number. This value is the same as the key value for this object.


 
 Example:  "12"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "location": {
    • "key": "2"
    },
  • "vendor": {
    • "key": "127"
    },
  • "vendorAccountNumber": "1234567555"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "id": "7",
    • "href": "/objects/accounts-payable/vendor-account-number/7"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a vendor account number
get/objects/accounts-payable/vendor-account-number/{key}
Returns detailed information for a specified vendor account number.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the vendor account number.


 
 Example:  17
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "id": "7",
    • "location": {
      • "key": "11",
      • "id": "11",
      • "name": "United States of America",
      • "href": "/objects/company-config/location/11"
      },
    • "vendor": {
      • "key": "33",
      • "id": "33",
      • "href": "/objects/accounts-payable/vendor/33"
      },
    • "vendorAccountNumber": "VAN-5134986722",
    • "href": "/objects/accounts-payable/vendor-account-number/7"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a vendor account number
patch/objects/accounts-payable/vendor-account-number/{key}
Updates an existing vendor account number by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the vendor account number.


 
 Example:  17
Request Body schema: application/json
object
Location associated with the entity.


 
key
string
Unique key for the location.


 
 Example:  "1"
id
string
Unique ID for the location.


 
 Example:  "1"
vendorAccountNumber
string
Vendor account number for the associated entity.


 
 Example:  "VAN-5134986722"
object
Vendor the account number is associated with.


 
key
string
Unique key for the vendor.


 
 Example:  "9"
id
string
Unique ID for the vendor.


 
 Example:  "9"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "vendorAccountNumber": "1234567888"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "id": "2",
    • "href": "/objects/accounts-payable/vendor-account-number/2"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a vendor account number
delete/objects/accounts-payable/vendor-account-number/{key}
Deletes a vendor account number.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the vendor account number.


 
 Example:  17
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
    }
}