PIpismo
Transaction types

List transaction types

List transaction types that match the search parameters. If no search parameters are given, then all transaction types are returned.

get/v1/transaction-types

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/transaction-types
  • Auth
    none declared

Query parameters

transactionTypeIdinteger

Transaction type ID filter.

descriptionstring

Wildcard filter used to search transaction types by description.

creditboolean

Filters transaction types by credit (true) or debit (false).

pageSizeinteger

Maximum number of transactions per page.

orderBy'transactionId' | 'description'

Transaction type sort parameter

pageOffsetinteger

Page offset. Indicates which page to start with when returning the results. For example, value 2 returns the third page. Defaults to 0, which returns the first page.

Response

OK

has_nextboolean

Indicates whether there are more pages after the current page

Example response

{
  "items": [
    [
      {
        "transaction_type_id": 7001,
        "description": "Purchase",
        "credit": false,
        "posted_transaction": true
      },
      {
        "transaction_type_id": 7002,
        "description": "Purchase reversal",
        "credit": true,
        "posted_transaction": true
      }
    ]
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.