Update Payment Term

Beta

PATCH/v1/finance/payment-terms/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates a payment term.

Only payment terms created by your account can be updated; system-owned default terms cannot be.

Permissions requiredValues:payment_terms:update

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

idstring

Payment term ID.

include[]optional arrayenumValues:ownerowner.account

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

nameoptional string

New display name for the payment term.

Must be unique among the payment terms visible to your account, including system defaults.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30), unique among the payment terms visible to your account.

statusstringenumValues:activeinactive

Whether this payment term is still in active use.

Payment terms created through the API are always active, and no endpoint changes a term's status. List Payment Terms returns inactive terms alongside active ones, so filter them out yourself if you only want the ones still on offer.

ownerownerExpandablenullable

Provenance of this payment term.

System-owned payment terms are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned payment terms are custom to your account.

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.

accountaccountExpandablenullable

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.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

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

Always returned as null in this endpoint.

brandingaccount_brandingnullable

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

Always returned as null in this endpoint.

portalaccount_portalnullable

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

Always returned as null in this endpoint.

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.

Responses

200

Successful response for Update Payment Term

Update Payment Term

import OpenMRP from '@openmrp/sdk';

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

const paymentTerm = await client.finance.paymentTerms.update('pytm_skssmsy21lem', {
  name: 'Net 60',
});

console.log(paymentTerm.id);

import OpenMRP from '@openmrp/sdk';

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

const paymentTerm = await client.finance.paymentTerms.update('pytm_skssmsy21lem', {
  name: 'Net 60',
});

console.log(paymentTerm.id);

200 example

{
  "id": "pytm_skssmsy21lem",
  "object": "payment_term",
  "name": "Net 30",
  "status": "active",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "pytm_skssmsy21lem",
  "object": "payment_term",
  "name": "Net 30",
  "status": "active",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Payment Term

Authorization

Path Parameters

Query Parameters

Request Body

Returns

Responses