TAG LINE
TAG LINE
SMALL TITLE
User defined Payment Type that is a derivative of a Payment Base Type.
identity READ-ONLY | "identity": 6 Type: Number This is the unique numeric identifier for the PaymentType |
name | "name": "Bank Draft" Type: String User defined name for the Payment Type. |
ownerId READ-ONLY | "ownerId": 6 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
generalLedgerId | "generalLedgerId": 12 Type: Number Unique identifier for the associated GeneralLedger object. |
generalLedgerName | "generalLedgerName": "Sample Name" Type: String The name of the object associated with the generalLedgerId property. |
paymentBaseTypeId | "paymentBaseTypeId": 14 Type: Number Unique identifier for the associated PaymentBaseType object. |
paymentBaseTypeName | "paymentBaseTypeName": "Sample Name" Type: String The name of the object associated with the paymentBaseTypeId property. |
paymentTypeDisbursementTypeId | "paymentTypeDisbursementTypeId": 20 Type: Number Unique identifier for the associated PaymentTypeDisbursementType object. |
paymentTypeDisbursementTypeName | "paymentTypeDisbursementTypeName": "Sample Name" Type: String The name of the object associated with the paymentTypeDisbursementTypeId property. |
description | "description": "Direct deposit of a Bank Draft" Type: String User defined description for the Payment Type. |
isActive | "isActive": true Type: Boolean Whether or not this Payment Type is active. |
paymentGatewayId | "paymentGatewayId": 27 Type: Number Unique identifier for the associated PaymentGateway object. |
paymentGatewayName | "paymentGatewayName": "Sample Name" Type: String The name of the object associated with the paymentGatewayId property. |
cardTypeId | "cardTypeId": 24 Type: Number Unique identifier for the associated CardType object. |
cardTypeName | "cardTypeName": "Sample Name" Type: String The name of the object associated with the cardTypeId property. |
paymentProviderId | "paymentProviderId": 22 Type: Number Unique identifier for the associated PaymentProvider object. |
paymentProviderName | "paymentProviderName": "Sample Name" Type: String The name of the object associated with the paymentProviderId property. |
| DELETE | PaymentType/{id} |
| Delete an instance of the PaymentType object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the PaymentType object. |
Delete an instance of the PaymentType object. DELETE PaymentType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "paymentType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | PaymentType/ |
| Retrieve all of the PaymentType objects. | |
Retrieve all of the PaymentType objects. GET PaymentType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Bank Draft",
"ownerId": 5,
"ownerName": "Sample Text Data",
"generalLedgerId": 12,
"generalLedgerName": "Sample Text Data",
"paymentBaseTypeId": 1,
"paymentBaseTypeName": "Sample Text Data",
"paymentTypeDisbursementTypeId": 14,
"paymentTypeDisbursementTypeName": "Sample Text Data",
"description": "Direct deposit of a Bank Draft",
"isActive": true,
"paymentGatewayId": 14,
"paymentGatewayName": "Sample Text Data",
"cardTypeId": 7,
"cardTypeName": "Sample Text Data",
"paymentProviderId": 23,
"paymentProviderName": "Sample Text Data"
}
]
} | |
| GET | PaymentType/Paged |
| Retrieve all of the PaymentType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the PaymentType objects in a paged fashion. GET PaymentType/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Bank Draft",
"ownerId": 20,
"ownerName": "Sample Text Data",
"generalLedgerId": 3,
"generalLedgerName": "Sample Text Data",
"paymentBaseTypeId": 9,
"paymentBaseTypeName": "Sample Text Data",
"paymentTypeDisbursementTypeId": 1,
"paymentTypeDisbursementTypeName": "Sample Text Data",
"description": "Direct deposit of a Bank Draft",
"isActive": true,
"paymentGatewayId": 20,
"paymentGatewayName": "Sample Text Data",
"cardTypeId": 18,
"cardTypeName": "Sample Text Data",
"paymentProviderId": 5,
"paymentProviderName": "Sample Text Data"
}
]
}
} | |
| GET | PaymentType/{id} |
| Retrieve an instance of the PaymentType object by its ID. | |
| {id} | Unique identifier for the PaymentType object. |
Retrieve an instance of the PaymentType object by its ID. GET PaymentType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Bank Draft",
"ownerId": 7,
"ownerName": "Sample Text Data",
"generalLedgerId": 19,
"generalLedgerName": "Sample Text Data",
"paymentBaseTypeId": 9,
"paymentBaseTypeName": "Sample Text Data",
"paymentTypeDisbursementTypeId": 26,
"paymentTypeDisbursementTypeName": "Sample Text Data",
"description": "Direct deposit of a Bank Draft",
"isActive": true,
"paymentGatewayId": 3,
"paymentGatewayName": "Sample Text Data",
"cardTypeId": 21,
"cardTypeName": "Sample Text Data",
"paymentProviderId": 16,
"paymentProviderName": "Sample Text Data"
}
} | |
| POST | PaymentType/Record |
| Create a PaymentType that is not associated with a Payment Gateway. PaymentTypes are generally 'auto' created when a payment gateway is configured in the system. This API can be used to create a PaymentType for non-gateway transactions. This would be used when LogiSense Billing is not used to collect the payment, but instead log a record of the payment to reflect the account balances. | |
Create a PaymentType that is not associated with a Payment Gateway. POST PaymentType/Record
{
"name": "Bank Draft",
"generalLedgerId": 22,
"paymentBaseTypeId": 4,
"paymentTypeDisbursementTypeId": 24,
"description": "Direct deposit of a Bank Draft",
"isActive": true,
"paymentGatewayId": 11,
"cardTypeId": 12,
"paymentProviderId": 4
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Bank Draft",
"ownerId": 3,
"ownerName": "Sample Text Data",
"generalLedgerId": 12,
"generalLedgerName": "Sample Text Data",
"paymentBaseTypeId": 16,
"paymentBaseTypeName": "Sample Text Data",
"paymentTypeDisbursementTypeId": 12,
"paymentTypeDisbursementTypeName": "Sample Text Data",
"description": "Direct deposit of a Bank Draft",
"isActive": true,
"paymentGatewayId": 19,
"paymentGatewayName": "Sample Text Data",
"cardTypeId": 25,
"cardTypeName": "Sample Text Data",
"paymentProviderId": 9,
"paymentProviderName": "Sample Text Data"
}
]
}
} | |
| PUT | PaymentType/Record/{id} |
| Update the PaymentType record based on the record id | |
| PUT | PaymentType/{id} |
| Update an existing instance of the PaymentType object. | |
Update an existing instance of the PaymentType object. PUT PaymentType/{id}
{
"identity": 1,
"name": "Bank Draft",
"generalLedgerId": 25,
"paymentBaseTypeId": 7,
"paymentTypeDisbursementTypeId": 24,
"description": "Direct deposit of a Bank Draft",
"isActive": true,
"paymentGatewayId": 12,
"cardTypeId": 25,
"paymentProviderId": 11
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Bank Draft",
"ownerId": 21,
"ownerName": "Sample Text Data",
"generalLedgerId": 14,
"generalLedgerName": "Sample Text Data",
"paymentBaseTypeId": 3,
"paymentBaseTypeName": "Sample Text Data",
"paymentTypeDisbursementTypeId": 21,
"paymentTypeDisbursementTypeName": "Sample Text Data",
"description": "Direct deposit of a Bank Draft",
"isActive": true,
"paymentGatewayId": 19,
"paymentGatewayName": "Sample Text Data",
"cardTypeId": 26,
"cardTypeName": "Sample Text Data",
"paymentProviderId": 17,
"paymentProviderName": "Sample Text Data"
}
]
}
} | |