Payment Type

What can you do with PaymentType?


Properties

Property Details
id
"id": 826
Type: Number
This is the unique numeric identifier for the PaymentType
name
"name": "Hello World"
Type: String
ownerId
"ownerId": 454
Type: Number
Unique identifier for the associated Owner object.
generalLedgerId
"generalLedgerId": 539
Type: Number
Unique identifier for the associated GeneralLedger object.
paymentCodeId
"paymentCodeId": 912
Type: Number
Unique identifier for the associated PaymentCode object.
paymentTypeTypeId
"paymentTypeTypeId": 475
Type: Number
Unique identifier for the associated PaymentTypeType object.
paymentTypeDisbursementTypeId
"paymentTypeDisbursementTypeId": 697
Type: Number
Unique identifier for the associated PaymentTypeDisbursementType object.
eCheckProcessorId
"eCheckProcessorId": 899
Type: Number
Unique identifier for the associated ECheckProcessor object.
creditCardTokenProcessorId
"creditCardTokenProcessorId": 263
Type: Number
Unique identifier for the associated CreditCardTokenProcessor object.
eCheckTokenProcessorId
"eCheckTokenProcessorId": 174
Type: Number
Unique identifier for the associated ECheckTokenProcessor object.
defaultDetailMessage
"defaultDetailMessage": "Hello World"
Type: String


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
  • paymentCodeId
  • paymentTypeTypeId
  • paymentTypeDisbursementTypeId
  • eCheckProcessorId
  • creditCardTokenProcessorId
  • eCheckTokenProcessorId
  • defaultDetailMessage

DataFlow PATCH objects:


End Points

DELETEapi/v1/PaymentType/{id:int}
Delete an instance of the PaymentType object.
GETapi/v1/PaymentType
Retrieve all of the PaymentType objects.
GETapi/v1/PaymentType/Metadata
Retrieve all of the meta data details of the PaymentType object.
GETapi/v1/PaymentType/Metadata/{option}
Retrieve all the meta data details of the PaymentType object based on provided options.
{option}Metadata options for the PaymentType object.
GETapi/v1/PaymentType/Paged
Retreive all of the PaymentType objects in a paged fashion.
GETapi/v1/PaymentType/{id:int}
Retrieve an instance of the PaymentType object by it's ID.
{id:int}Unique identifier for the PaymentType object.
POSTapi/v1/PaymentType
Create a new instance of the PaymentType object.
PUTapi/v1/PaymentType/{id:int}
Update an existing instance of the PaymentType object.