Account labels

Account labels give accounts more descriptive names that are displayed anywhere the accounts are referenced in the product and in reports. Account labels is an optional feature that must be enabled when configuring Accounts Payable.

List account labels

get/objects/accounts-payable/account-label

Returns up to 100 object references from the collection with a key, ID, and link for each label. 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": "32",
      • "id": "Ref Matls",
      • "href": "/objects/accounts-payable/account-label/32"
      },
    • {
      • "key": "33",
      • "id": "Rent",
      • "href": "/objects/accounts-payable/account-label/33"
      },
    • {
      • "key": "34",
      • "id": "Repairs and Maintenance",
      • "href": "/objects/accounts-payable/account-label/34"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an account label
post/objects/accounts-payable/account-label
Creates a new account label.


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


 
 Example:  "Benefits: Health"
description
required
string
A note about the purpose and use of the account label.


 
 Example:  "Account for health benefit costs"
status
required
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
The general ledger account to assign to the label. This is typically a revenue account.


 
id
required
string
General ledger account number.


 
 Example:  "1210--Equipment"
key
string
System-assigned key for the general ledger account.


 
 Example:  "19"
object
The general ledger account where the system posts offsets to items posted to this label. This is typically a receivables account.


 
key
string
System-assigned key for the offset general ledger account.


 
 Example:  "2"
id
string
Account number for the offset general ledger account.


 
 Example:  "1215--EquipmentOffset"
object
Form 1099 information.


 
type
string or null
Form 1099 type.


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


 
 Example:  "1B"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Sales",
  • "description": "Sales team expenses",
  • "status": "active",
  • "glAccount": {
    • "id": "4000--Sales"
    },
  • "offsetGLAccount": {
    • "id": "4001--Miscellaneous - Sales"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "37",
    • "id": "Sales",
    • "href": "/objects/accounts-payable/account-label/37"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an account label
get/objects/accounts-payable/account-label/{key}
Returns detailed information for a specified account label.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account label.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "8",
    • "id": "Accounting Fees",
    • "description": "Accounting Fees",
    • "glAccount": {
      • "id": "6600.01--Accounting Fees",
      • "key": "318",
      • "href": "/objects/general-ledger/account/318"
      },
    • "status": "active",
    • "offsetGLAccount": {
      • "id": null,
      • "key": null
      },
    • "form1099Type": "DIV",
    • "form1099Box": "1B",
    • "href": "/objects/accounts-payable/account-label/8"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an account label
patch/objects/accounts-payable/account-label/{key}
Updates an existing account label by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account label.


 
 Example:  99
Request Body schema: application/json
description
string
A note about the purpose and use of the account label.


 
 Example:  "Account for health benefit costs"
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
The general ledger account to assign to the label. This is typically a revenue account.


 
key
string
System-assigned key for the general ledger account.


 
 Example:  "19"
id
string
General ledger account number.


 
 Example:  "1210--Equipment"
object
The general ledger account where the system posts offsets to items posted to this label. This is typically a receivables account.


 
key
string
System-assigned key for the offset general ledger account.


 
 Example:  "2"
id
string
Account number for the offset general ledger account.


 
 Example:  "1215--EquipmentOffset"
object
Form 1099 information.


 
type
string or null
Form 1099 type.


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


 
 Example:  "1B"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "This is Sales Account label",
  • "status": "active",
  • "offsetGLAccount": {
    • "id": "4000.03--Sales-Others"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "37",
    • "id": "Sales",
    • "href": "/objects/accounts-payable/account-label/37"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an account label
delete/objects/accounts-payable/account-label/{key}
Deletes an account label.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account label.


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