TAG LINE
SMALL TITLE

Payment Type

(API Version v3)


User defined Payment Type that is a derivative of a Payment Base Type.


What can you do with PaymentType?


Properties

Property Details
identity
READ-ONLY
"identity": 5
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": 20
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": 7
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": 25
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": 1
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": 23
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": 22
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.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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

End Points

DELETEapi/v3/PaymentType/{id}
Delete an instance of the PaymentType object. Upon successful delete, this API will return a record of all of the reelated 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 api/v3/PaymentType/{id}
View Sample Response
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"
            }
        ]
    }
}
GETapi/v3/PaymentType/
Retrieve all of the PaymentType objects.
Retrieve all of the PaymentType objects.
GET api/v3/PaymentType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Bank Draft",
            "ownerId": 21,
            "ownerName": "Sample Text Data",
            "generalLedgerId": 11,
            "generalLedgerName": "Sample Text Data",
            "paymentBaseTypeId": 19,
            "paymentBaseTypeName": "Sample Text Data",
            "paymentTypeDisbursementTypeId": 9,
            "paymentTypeDisbursementTypeName": "Sample Text Data",
            "description": "Direct deposit of a Bank Draft",
            "isActive": true,
            "paymentGatewayId": 19,
            "paymentGatewayName": "Sample Text Data",
            "cardTypeId": 0,
            "cardTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v3/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 api/v3/PaymentType/Paged
View Sample Response
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": 21,
                "ownerName": "Sample Text Data",
                "generalLedgerId": 4,
                "generalLedgerName": "Sample Text Data",
                "paymentBaseTypeId": 0,
                "paymentBaseTypeName": "Sample Text Data",
                "paymentTypeDisbursementTypeId": 22,
                "paymentTypeDisbursementTypeName": "Sample Text Data",
                "description": "Direct deposit of a Bank Draft",
                "isActive": true,
                "paymentGatewayId": 0,
                "paymentGatewayName": "Sample Text Data",
                "cardTypeId": 25,
                "cardTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/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 api/v3/PaymentType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Bank Draft",
        "ownerId": 5,
        "ownerName": "Sample Text Data",
        "generalLedgerId": 4,
        "generalLedgerName": "Sample Text Data",
        "paymentBaseTypeId": 22,
        "paymentBaseTypeName": "Sample Text Data",
        "paymentTypeDisbursementTypeId": 10,
        "paymentTypeDisbursementTypeName": "Sample Text Data",
        "description": "Direct deposit of a Bank Draft",
        "isActive": true,
        "paymentGatewayId": 13,
        "paymentGatewayName": "Sample Text Data",
        "cardTypeId": 4,
        "cardTypeName": "Sample Text Data"
    }
}
POSTapi/v3/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 api/v3/PaymentType/Record

{
    "name": "Bank Draft",
    "generalLedgerId": 14,
    "paymentBaseTypeId": 6,
    "paymentTypeDisbursementTypeId": 2,
    "description": "Direct deposit of a Bank Draft",
    "isActive": true,
    "paymentGatewayId": 8,
    "cardTypeId": 22
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Bank Draft",
                "ownerId": 5,
                "ownerName": "Sample Text Data",
                "generalLedgerId": 10,
                "generalLedgerName": "Sample Text Data",
                "paymentBaseTypeId": 17,
                "paymentBaseTypeName": "Sample Text Data",
                "paymentTypeDisbursementTypeId": 7,
                "paymentTypeDisbursementTypeName": "Sample Text Data",
                "description": "Direct deposit of a Bank Draft",
                "isActive": true,
                "paymentGatewayId": 27,
                "paymentGatewayName": "Sample Text Data",
                "cardTypeId": 16,
                "cardTypeName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v3/PaymentType/Record/{id}
Update the PaymentType record based on the record id
PUTapi/v3/PaymentType/{id}
Update an existing instance of the PaymentType object.
Update an existing instance of the PaymentType object.
PUT api/v3/PaymentType/{id}

{
    "identity": 1,
    "name": "Bank Draft",
    "generalLedgerId": 13,
    "paymentBaseTypeId": 27,
    "paymentTypeDisbursementTypeId": 7,
    "description": "Direct deposit of a Bank Draft",
    "isActive": true,
    "paymentGatewayId": 13,
    "cardTypeId": 26
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Bank Draft",
                "ownerId": 6,
                "ownerName": "Sample Text Data",
                "generalLedgerId": 22,
                "generalLedgerName": "Sample Text Data",
                "paymentBaseTypeId": 19,
                "paymentBaseTypeName": "Sample Text Data",
                "paymentTypeDisbursementTypeId": 0,
                "paymentTypeDisbursementTypeName": "Sample Text Data",
                "description": "Direct deposit of a Bank Draft",
                "isActive": true,
                "paymentGatewayId": 20,
                "paymentGatewayName": "Sample Text Data",
                "cardTypeId": 7,
                "cardTypeName": "Sample Text Data"
            }
        ]
    }
}