Retrieve Account Group

Beta

GET/v1/sales/account-groups/{id}

This endpoint is idempotent. Learn more

Returns an account group by ID.

Permissions requiredValues:customer_groups:read

The role behind your API key or agent must grant every one of these permissions.

idstring

Account group ID.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
type_group: used to categorize accounts, such as "Consumers" or "Distributors".

A group's type is fixed when it is created and cannot be changed afterwards.

namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

commission_applied: sales commission is calculated on orders from accounts in this group.
commission_exempt: orders from accounts in this group are exempt from commission.

freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

free_freight: customers within this group will not have to pay for freight.
billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Retrieve Account Group

Retrieve Account Group

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountGroup = await client.sales.accountGroups.retrieve('acgp_6p4z57e9alaf');

console.log(accountGroup.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountGroup = await client.sales.accountGroups.retrieve('acgp_6p4z57e9alaf');

console.log(accountGroup.id);

200 example

{
  "id": "acgp_6p4z57e9alaf",
  "object": "account_group",
  "type": "type_group",
  "name": "Wholesale Customers",
  "description": null,
  "commission_policy": "commission_applied",
  "freight_policy": "billed_freight",
  "default_lead_time_days": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acgp_6p4z57e9alaf",
  "object": "account_group",
  "type": "type_group",
  "name": "Wholesale Customers",
  "description": null,
  "commission_policy": "commission_applied",
  "freight_policy": "billed_freight",
  "default_lead_time_days": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Account Group

Authorization

Path Parameters

Returns

Responses