List Account Statuses

Beta

GET/v1/sales/account-statuses

This endpoint is idempotent. Learn more

Returns a paginated list of account statuses.

Account statuses are system-provided lookup values shared across all accounts, used to set a customer's status (for example, placing a customer on a credit hold). The list is fixed — statuses cannot be created, edited, or deleted — so use it to populate a status picker or to resolve a code to its display name.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:owner

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of account_status

Resources in this page.

idstring

Account status ID.

objectstringenumValues:account_status

Resource type identifier.

codestringenumValues:normalpreferredhold_shipment

Machine-readable status code.

normal: standard account with no restrictions.
preferred: account flagged for prioritized handling.
hold_shipment: the account's shipments should be held, typically over a credit problem, while orders can still be placed.
hold_all: all activity for the account should be held.

The hold statuses are advisory: they are surfaced as credit-hold warnings on the customer's orders, but they do not by themselves cause order or shipment requests to be rejected.

namestring

Human-readable label for the status.

ownerownerExpandablenullable

Owner of this resource.

Account statuses are platform-provided and shared across all accounts, so the owner is always the OpenMRP system owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Account Statuses

List Account Statuses

import OpenMRP from '@openmrp/sdk';

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

const listAccountStatus = await client.sales.accountStatuses.list();

console.log(listAccountStatus.data);

import OpenMRP from '@openmrp/sdk';

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

const listAccountStatus = await client.sales.accountStatuses.list();

console.log(listAccountStatus.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/account-statuses?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWNzc19zdDV6eWptem0zMGsiLCJkIjoiZiJ9.LougrfoUgithA-Fxhd3e2virqA9mp9iGvNW7PiELry0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "acss_st5zyjmzm30k",
      "object": "account_status",
      "code": "normal",
      "name": "Normal",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/account-statuses?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWNzc19zdDV6eWptem0zMGsiLCJkIjoiZiJ9.LougrfoUgithA-Fxhd3e2virqA9mp9iGvNW7PiELry0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "acss_st5zyjmzm30k",
      "object": "account_status",
      "code": "normal",
      "name": "Normal",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Account Statuses

Query Parameters

Returns

Responses