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 query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View AR Account Labels
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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness


PermissionsList, View, Add AR Account Labels







SecurityOAuth2 
Request 
Request Body schema: application/json
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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness


PermissionsList, View AR Account Labels







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


 
 Example:  110
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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness


PermissionsList, View, Edit AR Account Labels







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


 
 Example:  110
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.



Permissions and other requirements



SubscriptionAccounts Receivable


User typeBusiness


PermissionsList, View, Delete AR Account Labels







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


 
 Example:  110
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 account labels
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "accounts-receivable/account-label"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-receivable/account-label",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "description",
    • "glAccount.id",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "11",
      • "id": "AR Account Label 1",
      • "description": "Widgets",
      • "glAccount.id": "4035",
      • "href": "/objects/accounts-receivable/account-label/11"
      },
    • {
      • "key": "8",
      • "id": "AvaTax Account Label",
      • "description": "AvaTax account label",
      • "glAccount.id": "4100",
      • "href": "/objects/accounts-receivable/account-label/8"
      },
    • {
      • "key": "14",
      • "id": "Cash",
      • "description": "Government-issued currency",
      • "glAccount.id": "1020",
      • "href": "/objects/accounts-receivable/account-label/14"
      },
    • {
      • "key": "1",
      • "id": "InterCompany Sales",
      • "description": "InterCompany Sales",
      • "glAccount.id": "4800",
      • "href": "/objects/accounts-receivable/account-label/1"
      },
    • {
      • "key": "5",
      • "id": "Sales Revenue",
      • "description": "Sales Revenue",
      • "glAccount.id": "4000",
      • "href": "/objects/accounts-receivable/account-label/5"
      },
    • {
      • "key": "12",
      • "id": "Tax label 1",
      • "description": "Tax item",
      • "glAccount.id": "6700",
      • "href": "/objects/accounts-receivable/account-label/12"
      }
    ],
  • "ia::meta": {
    • "totalCount": 6,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}