Retrieve Account Status

Beta

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

This endpoint is idempotent. Learn more

Returns a single account status, looked up by either its ID or its code.

idstring

Account status ID or code.

A code such as hold_shipment resolves to the same status as that status's ID.

include[]optional arrayenumValues:owner

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

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 Retrieve Account Status

Retrieve Account Status

import OpenMRP from '@openmrp/sdk';

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

const accountStatus = await client.sales.accountStatuses.retrieve('acss_st5zyjmzm30k');

console.log(accountStatus.id);

import OpenMRP from '@openmrp/sdk';

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

const accountStatus = await client.sales.accountStatuses.retrieve('acss_st5zyjmzm30k');

console.log(accountStatus.id);

200 example

{
  "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"
}

{
  "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"
}

Retrieve Account Status

Path Parameters

Query Parameters

Returns

Responses