Get a payment mode

GET

/api/v1/transaction/paymodes/{id}

Returns one payment mode (such as cash or card) by numeric id, directly without the status/message envelope, or not found if it does not exist.

Authorization

BearerAuth

headerAuthorizationBearer <JWT>

id*integer

ID of the record.

Formatint64

*/*

id?|

Numeric payment mode ID. Set by the server.

Formatint64

name*string

Payment mode code, e.g. CASH or CARD. Required, unique and not blank.

displayName?|

Name shown to staff and on receipts.

sequence?|

Display order; lower numbers are shown first.

Formatint32

status*string

ACTIVE, INACTIVE, ARCHIVED or DELETED. Defaults to ACTIVE.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"

modifiedTime*string

Timestamp stored when the payment mode was created (ISO 8601). Updates do not change it.

Formatdate-time

Example Request

curl -X GET 'https://beta.iotoms.com/api/v1/transaction/paymodes/0'

Example ResponseSchema

{  "id": 0,  "name": "string",  "displayName": "string",  "sequence": 0,  "status": "ACTIVE",  "modifiedTime": "2019-08-24T14:15:22Z"}