List Transaction Types

Beta

GET/v1/finance/transaction-types

This endpoint is idempotent. Learn more

Returns a paginated list of transaction types.

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.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of transaction_type

Resources in this page.

idstring

Transaction type ID.

objectstringenumValues:transaction_type

Resource type identifier.

namestring

Display name.

codestringenumValues:paymentcredit_memoadjustment

Machine-readable code identifying the kind of transaction.

payment: money received from the customer.
credit_memo: a credit issued to the customer.
adjustment: a manual correction (see the transaction's adjustment_type).
rebate: a rebate granted to the customer.

Responses

200

Successful response for List Transaction Types

List Transaction Types

import Augno from '@augno/sdk';

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

const listTransactionType = await client.finance.retrieveTransactionTypes();

console.log(listTransactionType.data);

import Augno from '@augno/sdk';

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

const listTransactionType = await client.finance.retrieveTransactionTypes();

console.log(listTransactionType.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/finance/transaction-types?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidHh0cF8wMTU1Mjk3NGMzOTUyZWQ4MTc4YWQ2NzFiOCIsImQiOiJmIn0.pkZ5kgJV1DvzSRZ4j1bIRO9e_GSC-Kmc1mrlNODKDKc",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "txtp_01552974c3952ed8178ad671b8",
      "object": "transaction_type",
      "name": "Payment",
      "code": "payment"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/finance/transaction-types?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidHh0cF8wMTU1Mjk3NGMzOTUyZWQ4MTc4YWQ2NzFiOCIsImQiOiJmIn0.pkZ5kgJV1DvzSRZ4j1bIRO9e_GSC-Kmc1mrlNODKDKc",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "txtp_01552974c3952ed8178ad671b8",
      "object": "transaction_type",
      "name": "Payment",
      "code": "payment"
    }
  ]
}

List Transaction Types

Query Parameters

Returns

Responses