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 turned on in Accounts Receivable. See Enable functionality for more information.

List account labels

get/objects/accounts-receivable/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": "9",
      • "id": "Retail Sales",
      • "href": "/objects/accounts-receivable/account-label/9"
      },
    • {
      • "key": "41",
      • "id": "Retail Sales 2",
      • "href": "/objects/accounts-receivable/account-label/41"
      },
    • {
      • "key": "10",
      • "id": "Sales",
      • "href": "/objects/accounts-receivable/account-label/10"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an account label
post/objects/accounts-receivable/account-label
Creates a new AR account label.


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


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


 
 Example:  "Software sales"
required
object
General ledger account this AR account label is assigned to.


 
id
string
General ledger account number.


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


 
 Example:  "356"
isTaxable
boolean
 Default:  false
Set to true to enable Advanced Tax to calculate the sales tax automatically.


 
 Example:  false
isSubtotal
boolean
 Default:  false
Set to true if the account label is for a subtotal type. This field is applicable only for entities that use the Avalara AvaTax solution. By default, Accounts Receivable is automatically configured to display tax and subtotal fields for invoices.


 
 Example:  false
isTax
boolean
 Default:  false
Set to true only if the account label is for a subtotal and the subtotal is for a tax, such as sales tax or excise tax. Do not enable for other subtotals, such as discounts, shipping, or handling charges. This field is applicable only for entities that use the Avalara AvaTax.


 
 Example:  true
object
Tax group to which the label is assigned. Account label tax groups organize taxable account labels under one tax category. Relevant only for companies configured to use Advanced Tax, and only if this account label is not a subtotal.


 
key
string or null
System-assigned key for the tax group.


 
 Example:  "23"
id
string or null
Unique identifier for the tax group.


 
 Example:  "Goods Exempt Rate - CA"
taxCode
string or null
AR account labels Tax Code.


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


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


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


 
 Example:  "1215--EquipmentOffset"
object
 
key
string or null
System-assigned key for the revenue recognition template.


 
 Example:  "1"
id
string or null
Unique identifier for the revenue recognition template.


 
 Example:  "Straight Line"
object
 
key
string or null
System-assigned key for the revenue gl account.


 
 Example:  "1"
id
string or null
Unique identifier for the revenue gl account.


 
 Example:  "1001"
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"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Wholesale Sales",
  • "description": "Wholesale sales north america",
  • "glAccount": {
    • "id": "2050"
    },
  • "status": "active",
  • "offsetGLAccount": {
    • "id": "1200.01"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "110",
    • "id": "Wholesale Sales",
    • "href": "/objects/accounts-receivable/account-label/110"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an account label
get/objects/accounts-receivable/account-label/{key}
Returns detailed information for a specified AR account label.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "68",
    • "id": "Wholesale Sales",
    • "description": "Wholesale Sales north America",
    • "glAccount": {
      • "id": "000007.10.90--Check_Petty Cash",
      • "key": "445",
      • "href": "/objects/general-ledger/account/445"
      },
    • "status": "active",
    • "offsetGLAccount": {
      • "id": "000007.10.90--Check_Petty Cash",
      • "key": "445",
      • "href": "/objects/general-ledger/account/445"
      },
    • "isTaxable": false,
    • "isTax": true,
    • "isSubtotal": true,
    • "taxGroup": {
      • "id": "Auto Account Label Tax",
      • "key": "14",
      • "href": "/objects/tax/account-label-tax-group/14"
      },
    • "taxCode": "CST",
    • "deferredRevenueGLAccount": {
      • "id": "000007.10.90",
      • "key": "445",
      • "href": "/objects/general-ledger/account/445"
      },
    • "revenueRecognitionTemplate": {
      • "id": "Straight Line",
      • "templateTitle": "Straight Line",
      • "key": "28",
      • "href": "/objects/accounts-receivable/revenue-recognition-template/28"
      },
    • "audit": {
      • "modifiedDateTime": "2024-08-02T00:00:00Z",
      • "createdDateTime": "2024-08-02T00:00:00Z",
      • "modifiedBy": "1",
      • "createdBy": "1"
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "href": "/objects/accounts-receivable/account-label/68"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an account label
patch/objects/accounts-receivable/account-label/{key}
Updates an existing AR account label by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
integer
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:  "Software sales"
isTaxable
boolean
 Default:  false
Set to true to enable Advanced Tax to calculate the sales tax automatically.


 
 Example:  false
isSubtotal
boolean
 Default:  false
Set to true if the account label is for a subtotal type. This field is applicable only for entities that use the Avalara AvaTax solution. By default, Accounts Receivable is automatically configured to display tax and subtotal fields for invoices.


 
 Example:  false
isTax
boolean
 Default:  false
Set to true only if the account label is for a subtotal and the subtotal is for a tax, such as sales tax or excise tax. Do not enable for other subtotals, such as discounts, shipping, or handling charges. This field is applicable only for entities that use the Avalara AvaTax.


 
 Example:  true
object
Tax group to which the label is assigned. Account label tax groups organize taxable account labels under one tax category. Relevant only for companies configured to use Advanced Tax, and only if this account label is not a subtotal.


 
key
string or null
System-assigned key for the tax group.


 
 Example:  "23"
id
string or null
Unique identifier for the tax group.


 
 Example:  "Goods Exempt Rate - CA"
taxCode
string or null
AR account labels Tax Code.


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


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


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


 
 Example:  "1215--EquipmentOffset"
object
General ledger account this AR account label is assigned to.


 
id
string
General ledger account number.


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


 
 Example:  "356"
object
 
key
string or null
System-assigned key for the revenue recognition template.


 
 Example:  "1"
id
string or null
Unique identifier for the revenue recognition template.


 
 Example:  "Straight Line"
object
 
key
string or null
System-assigned key for the revenue gl account.


 
 Example:  "1"
id
string or null
Unique identifier for the revenue gl account.


 
 Example:  "1001"
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"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "inactive"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "68",
    • "id": "Wholesale Sales",
    • "href": "/objects/accounts-receivable/account-label/68"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an account label
delete/objects/accounts-receivable/account-label/{key}
Deletes an AR account label.


SecurityOAuth2 
Request 
path Parameters
key
required
integer
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
    }
}