๐ชPayment types
This page provides a description of the available API routes for managing payment types.
Each purchase has to be paid using various methods, including cash, payment cards, vouchers, and more. These payment methods are collectively referred to as "payment types" and are represented by the PaymentType
class.
API methods
Get payment types
GET
http://{server-address}/paymenttypes
Returns all payment types that matches query parameters. Result is of type QueryResult<PaymentType>
.
Query Parameters
Name | Type | Description |
---|---|---|
number | int | Supports NData syntax. |
isActive | bool | Supports NData syntax. |
$skip | int | Pagination property. Describing number of records to skip from beginning of result collection. |
$take | int | Pagination property. Maximum count of items to be returned. |
$sort | string[] | Comma separated list of property names. Please see NData syntax. |
$count | bool | If set to |
category | PaymentTypeCategory | Supports NData syntax. |
isChangeable | bool | Supports NData syntax. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Get payment type by number
GET
http://{server-address}/paymenttypes/{number}
Result is of type PaymentType.
Path Parameters
Name | Type | Description |
---|---|---|
number* | int | Unique payment type number. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Create payment type
POST
http://{server-address}/paymenttypes
Creates new payment type. Result is of type PaymentType.
Required rights
Authorized user must have PaymentTypeCreate
right assigned.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Request Body
Name | Type | Description |
---|---|---|
(body)* | PaymentType | Model to create |
Create or update payment type
PUT
http://{server-address}/paymenttypes/{number}
Updates existing or creates new payment type. Result is of type PaymentType.
Required rights
Authorized user must have assigned PaymentTypeCreate
or PaymentTypeUpdate
right.
Path Parameters
Name | Type | Description |
---|---|---|
number* | int | Unique payment type number. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Request Body
Name | Type | Description |
---|---|---|
(body)* | PaymentType | The model to create or update. |
Delete payment type by number
DELETE
http://{server-address}/paymenttypes/{number}
Required rights
Authorized user must have PaymentTypeDelete
right assigned.
Path Parameters
Name | Type | Description |
---|---|---|
number* | int | Unique payment type number. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Last updated