List Transaction Methods

Beta

GET/v1/finance/transaction-methods

This endpoint is idempotent. Learn more

Returns the payment methods that can be recorded on a transaction, such as cash, check, and ACH.

The set is fixed by the platform and identical for every account, so the results come back in one page; supplying a pagination cursor returns a validation error. Free-text search matches the 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.

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 transaction_method

Resources in this page.

idstring

Transaction method ID.

objectstringenumValues:transaction_method

Resource type identifier.

namestring

Display name.

codestringenumValues:cashcheckcredit_card

Machine-readable code identifying how the transaction was made.

Responses

200

Successful response for List Transaction Methods

List Transaction Methods

import OpenMRP from '@openmrp/sdk';

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

const listTransactionMethod = await client.finance.retrieveTransactionMethods();

console.log(listTransactionMethod.data);

import OpenMRP from '@openmrp/sdk';

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

const listTransactionMethod = await client.finance.retrieveTransactionMethods();

console.log(listTransactionMethod.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/finance/transaction-methods?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidHhtZF9odm04NnRhbzN6YngiLCJkIjoiZiJ9.WtZENJ7hHYmgSPRFAAVHDpw08GsqWs5QC9fRXj9p7Hs",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "txmd_hvm86tao3zbx",
      "object": "transaction_method",
      "name": "Credit Card",
      "code": "credit_card"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/finance/transaction-methods?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidHhtZF9odm04NnRhbzN6YngiLCJkIjoiZiJ9.WtZENJ7hHYmgSPRFAAVHDpw08GsqWs5QC9fRXj9p7Hs",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "txmd_hvm86tao3zbx",
      "object": "transaction_method",
      "name": "Credit Card",
      "code": "credit_card"
    }
  ]
}

List Transaction Methods

Query Parameters

Returns

Responses