Vendor account numbers

The account number a vendor assigns to you. For example, a telephone company might assign your phone number as your vendor account number. This helps the vendor to match the payment information with the bill being paid.

List vendor account numbers

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

Returns up to 100 object references from the collection with a key, ID, and link for each vendor account number. This operation is mostly for use in testing; use query 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.


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


 
key
string
System-assigned key for the vendor.


 
 Example:  "1"
id
string
Unique identifier for the vendor.


 
 Example:  "1"
required
object
Location associated with the vendor account number.


 
key
string
System-assigned unique key for the location.


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


 
 Example:  "1"
vendorAccountNumber
required
string
Account number for the vendor.


 
 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:  "1"
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/1"
    },
  • "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 key for the vendor account number.


 
 Example:  1
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/1"
      },
    • "vendorAccountNumber": "VAN-5134986722",
    • "href": "/objects/accounts-payable/vendor-account-number/1",
    • "vendor": {
      • "key": "33",
      • "id": "33",
      • "href": "/objects/accounts-payable/vendor/1"
      }
    },
  • "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 key for the vendor account number.


 
 Example:  1
Request Body schema: application/json
object
Location associated with the vendor account number.


 
key
string
System-assigned unique key for the location.


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


 
 Example:  "1"
vendorAccountNumber
string
Account number for the vendor.


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


 
key
string
System-assigned key for the vendor.


 
 Example:  "1"
id
string
Unique identifier for the vendor.


 
 Example:  "1"
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 key for the vendor account number.


 
 Example:  1
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
    }
}
Query vendor account numbers
post/services/core/query
Use the query service to find vendor account numbers that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}