TAG LINE
SMALL TITLE

Payment Type

(API Version v2)


What can you do with PaymentType?


Properties

Property Details
id
"id": 2
Type: Number
This is the unique numeric identifier for the PaymentType
name
"name": "Hello World"
Type: String
ownerId
"ownerId": 0
Type: Number
Unique identifier for the associated Owner object.
generalLedgerId
"generalLedgerId": 25
Type: Number
Unique identifier for the associated GeneralLedger object.
paymentBaseTypeId
"paymentBaseTypeId": 14
Type: Number
Unique identifier for the associated PaymentBaseType object.
paymentTypeDisbursementTypeId
"paymentTypeDisbursementTypeId": 23
Type: Number
Unique identifier for the associated PaymentTypeDisbursementType object.
description
"description": "Hello World"
Type: String
isActive
"isActive": true
Type: Boolean
paymentGatewayId
"paymentGatewayId": 0
Type: Number
Unique identifier for the associated PaymentGateway object.
cardTypeId
"cardTypeId": 11
Type: Number
Unique identifier for the associated CardType object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • generalLedgerId
  • paymentBaseTypeId
  • paymentTypeDisbursementTypeId
  • paymentGatewayId
  • cardTypeId
  • isActive
  • description

DataFlow PATCH objects:


End Points

DELETEapi/v2/PaymentType/{id:int}
Delete an instance of the PaymentType object.
GETapi/v2/PaymentType
Retrieve all of the PaymentType objects.
GETapi/v2/PaymentType/Paged
Retreive all of the PaymentType objects in a paged fashion.
GETapi/v2/PaymentType/{id:int}
Retrieve an instance of the PaymentType object by it's ID.
{id:int}Unique identifier for the PaymentType object.
POSTapi/v2/PaymentType/Record
Create a new instance of the PaymentType object.
PUTapi/v2/PaymentType/Record/{id:int}
Update an existing instance of the PaymentType object.
PUTapi/v2/PaymentType/{id:int}
Update an existing instance of the PaymentType object.