Upsert Sales Target

Beta

PUT/v1/sales/account-users/{id}/sales-targets/{target_id}

This endpoint is idempotent. Learn more

Creates or updates a sales rep's revenue goal at an ID you choose.

If no target with the given ID exists, one is created with the supplied dates, amount, and unit. If it already exists, only the amount value is updated — the dates and unit are left unchanged, so raising or lowering a goal mid-period is the intended use. The sales rep must be an active account user in your account, and the target ID must belong to that account, otherwise the request returns a not-found error.

Permissions requiredValues:sales_targets:update

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

idstring

The account user (sales rep) the target is for.

Must be an active account user in your account. Only applied when creating a new target; the rep on an existing target is not changed.

target_idstring

The sales target to create or update.

If no target with this ID exists, a new one is created and keeps the ID you supplied, which lets you retry the same request safely.

starts_atstring (date-time)

Start of the period the target applies to (inclusive).

Only applied when creating a new target; the dates on an existing target are not changed.

ends_atstring (date-time)

End of the period the target applies to.

Only applied when creating a new target; the dates on an existing target are not changed.

amount_valuestring

The revenue goal for the period, as a decimal string (e.g. 75000.00).

This is the only value an existing target accepts; everything else on it stays as it was.

amount_unit_idstring

The unit the goal is denominated in, typically a currency unit.

Only applied when creating a new target; the unit on an existing target is not changed.

idstring

Sales target ID.

objectstringenumValues:sales_target

Resource type identifier.

start_atstring (date-time)

Start of the period this target applies to (inclusive).

end_atstring (date-time)

End of the period this target applies to (e.g. the close of a quarter).

sales_repentitynullable

The sales rep this target is assigned to, referencing the account-user record the /v1/identity/account-users endpoints return.

A reference rather than the full record: it was tagged expandable but no include ever resolved it, so callers received an account user whose every field except the id was empty.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

amountquantitynullable

The revenue goal for the period, as a monetary quantity.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

The dimension this unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

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.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

The address billed by default on orders for this account.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

The most specific link in the receiving chain: set it when one of a customer's sites keeps different days from the rest. Null falls through to the customer, then their group, then the account default.

geolocationgeolocationnullable

Street-level location details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

geolocationgeolocationnullable

Street-level location details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

The email address customers are directed to for support.

phone_numberstringnullable

The account's public contact phone number.

logo_urlstringnullable

Stored location of the account's logo image.

Logos uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Logo URL endpoint to obtain a short-lived download URL.

favicon_urlstringnullable

Stored location of the account's customer-portal favicon.

Favicons uploaded through the API are stored as an object key rather than a fetchable link, so use the Get Account Favicon URL endpoint to obtain a short-lived download URL.

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

The account's public website.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

URL slug that identifies the account's customer portal.

Unique across all accounts.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Upsert Sales Target

Upsert Sales Target

import OpenMRP from '@openmrp/sdk';

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

const salesTarget = await client.sales.accountUsers.salesTargets.update('example', {
  id: 'acus_e5zu8bde0z3h',
  amount_unit_id: 'un_82bd37dae5po',
  amount_value: '75000.00',
  ends_at: '2026-06-30T00:00:00Z',
  starts_at: '2026-04-01T00:00:00Z',
});

console.log(salesTarget.id);

import OpenMRP from '@openmrp/sdk';

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

const salesTarget = await client.sales.accountUsers.salesTargets.update('example', {
  id: 'acus_e5zu8bde0z3h',
  amount_unit_id: 'un_82bd37dae5po',
  amount_value: '75000.00',
  ends_at: '2026-06-30T00:00:00Z',
  starts_at: '2026-04-01T00:00:00Z',
});

console.log(salesTarget.id);

200 example

{
  "id": "ta_n5b6sbefrmii",
  "object": "sales_target",
  "start_at": "2026-05-10T00:00:00Z",
  "end_at": "2026-06-10T00:00:00Z",
  "sales_rep": {
    "id": "acus_e5zu8bde0z3h",
    "object": "entity",
    "type": "account_user",
    "name": null,
    "handle": null
  },
  "amount": {
    "id": "qty_8hnxbigf0bod",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ta_n5b6sbefrmii",
  "object": "sales_target",
  "start_at": "2026-05-10T00:00:00Z",
  "end_at": "2026-06-10T00:00:00Z",
  "sales_rep": {
    "id": "acus_e5zu8bde0z3h",
    "object": "entity",
    "type": "account_user",
    "name": null,
    "handle": null
  },
  "amount": {
    "id": "qty_8hnxbigf0bod",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Upsert Sales Target

Authorization

Path Parameters

Request Body

Returns

Responses