Search

savePaymentType

Create or update a payment type.

To retrieve existing payment types, see getPaymentTypes.

Input parameters

Parameter nameDescriptionPossible valueRequired
paymentTypeIDSet this field to edit an existing payment type. Omit to add a new type.Integer
typeA code name for this payment type.

In savePayment and getPayments API calls, you can refer to a payment type either by ID or by code name. Code name may be more convenient when working with standard payment types (CASH, CARD etc.). However, you can give code names to your own custom types, too.

Standard types that ERPLY recognizes (there may be standard functionality attached to payments of these type) are: CASH, CARD, CREDIT, GIFTCARD, CHECK, TRANSFER, TIP.
String(10)
namePayment type name. Use either general parameter "name" or one or more of the following parameters if you need to set the names in specific languages.String
nameESTString
nameENGString
nameLATString
nameRUSString
nameFINString
print_nameName on receipt. Use either general parameter "print_name" or one or more of the following parameters if you need to set the names in specific languages.String
print_nameESTString
print_nameENGString
print_nameLATString
print_nameRUSString
print_nameFINString
quickBooksDebitAccountQuick Books debit accountString

Response

Field nameTypeDescription
paymentTypeIDIntegerID of the newly-created or updated item