TAG LINE
TAG LINE
SMALL TITLE

Payment

(API Version v6)


Represents a Payment that has been made on an account.


What can you do with Payment?

  • DELETE Payment/{id}
    Delete an instance of the Payment object.

  • GET Payment/
    Retrieve all of the Payment objects.

  • GET Payment/Paged
    Retrieve all of the Payment objects in a paged fashion.

  • GET Payment/Paged/Detail
    Retrieve all of the Payment objects in a paged fashion with all object details.

  • GET Payment/{id}
    Retrieve an instance of the Payment object by its ID.

  • GET Payment/{id}/Detail
    Retrieve deep detail of the Payment object by its ID.

  • PATCH Payment/{id}
    Update or Add the Payment object and optionally make changes to any child objects.

  • POST Payment/
    Create a new instance of the Payment object.

  • POST Payment/Reverse
    Reverse an existing Payment. Payment details provided in body of POST request.

  • POST Payment/Reverse/Vendor
    Reverse an existing Payment. Payment details provided in body of POST request.

  • POST Payment/Vendor
    Create a Payment to be processed by a specified Payment gateway vendor. Payment details provided in body of POST request.

  • PUT Payment/{id}
    Update an existing instance of the Payment object.


Properties

Property Details
identity
READ-ONLY
"identity": 8
Type: Number
This is the unique numeric identifier for the Payment
date
"date": "2021-04-26T15:25:27.587Z"
Type: Date
Date the payment was made.

Date and time values are specified in the ISO 8601 format.
amount
"amount": 1235.89
Type: Number
The amount paid in the Account's currency.
accountId
"accountId": 10
Type: Number
Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId property.
disbursed
"disbursed": true
Type: Boolean
Whether or not this payment has been disbursed to an invoice.
paymentTypeId
"paymentTypeId": 3
Type: Number
Unique identifier for the associated PaymentType object.
paymentTypeName
"paymentTypeName": "Sample Name"
Type: String
The name of the object associated with the paymentTypeId property.
detail
"detail": "Payment Recieved"
Type: String
Description of payment to show on an invoice.
cardTypeId
"cardTypeId": 14
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.
checkNumber
"checkNumber": "1236-9658"
Type: String
If the payment was received as a check, this is the check number.
automaticDisburse
"automaticDisburse": true
Type: Boolean
Whether or not this payment has was automatically disbursed.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
invoiceId
"invoiceId": 7
Type: Number
Unique identifier for the associated Invoice object.
invoiceName
"invoiceName": "Sample Name"
Type: String
The name of the object associated with the invoiceId property.
posting
"posting": "2021-04-26T15:25:27.587Z"
Type: Date
Date the payment should be shown as posted.

Date and time values are specified in the ISO 8601 format.
baseAmount
"baseAmount": 1345.89
Type: Number
The payment amount in the system/owner currency.
invoiceAmount
"invoiceAmount": 17
Type: Number
currencyExchangeDetailId
"currencyExchangeDetailId": 24
Type: Number
Unique identifier for the associated CurrencyExchangeDetail object.
currencyExchangeDetailName
"currencyExchangeDetailName": "Sample Name"
Type: String
The name of the object associated with the currencyExchangeDetailId property.
billRunHistoryId
"billRunHistoryId": 16
Type: Number
Unique identifier for the associated BillRunHistory object.
billRunHistoryName
"billRunHistoryName": "Sample Name"
Type: String
The name of the object associated with the billRunHistoryId property.
isManual
"isManual": true
Type: Boolean
Whether or not this payment was a manual payment and not run through a payment processor.
reversePaymentId
"reversePaymentId": 11
Type: Number
Unique identifier for the associated Payment object.
reversePaymentName
"reversePaymentName": "Sample Name"
Type: String
The name of the object associated with the reversePaymentId property.
createdByUserId
"createdByUserId": 8
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
paymentMethodId
"paymentMethodId": 10
Type: Number
Unique identifier for the associated PaymentMethod object.
paymentMethodName
"paymentMethodName": "Sample Name"
Type: String
The name of the object associated with the paymentMethodId property.
paymentPreAuthorizeId
"paymentPreAuthorizeId": 26
Type: Number
Unique identifier for the associated PaymentPreAuthorize object.
paymentPreAuthorizeName
"paymentPreAuthorizeName": "Sample Name"
Type: String
The name of the object associated with the paymentPreAuthorizeId property.
paymentTransactionId
"paymentTransactionId": 16
Type: Number
Unique identifier for the associated PaymentTransaction object.
paymentTransactionName
"paymentTransactionName": "Sample Name"
Type: String
The name of the object associated with the paymentTransactionId property.
createdByPortalUserId
"createdByPortalUserId": 5
Type: Number
Unique identifier for the associated PortalUser object.
createdByPortalUserName
"createdByPortalUserName": "Sample Name"
Type: String
The name of the object associated with the createdByPortalUserId property.


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the Payment object.

Standard PATCH objects:

  • paymentInvoiceDisbursement - create, update, delete

DataFlow PATCH objects:

  • payment - create, update, delete
  • paymentInvoiceDisbursement - create, update, delete

End Points

DELETEPayment/{id}
Delete an instance of the Payment 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 Payment object.
Delete an instance of the Payment object.
DELETE Payment/{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": "payment"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETPayment/
Retrieve all of the Payment objects.
Retrieve all of the Payment objects.
GET Payment/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "date": "2021-04-26T15:25:27.587Z",
            "amount": 1235.89,
            "accountId": 13,
            "accountName": "Sample Text Data",
            "disbursed": true,
            "paymentTypeId": 21,
            "paymentTypeName": "Sample Text Data",
            "detail": "Payment Recieved",
            "cardTypeId": 1,
            "cardTypeName": "Sample Text Data",
            "checkNumber": "1236-9658",
            "automaticDisburse": true,
            "created": "2021-04-26T15:25:27.587Z",
            "invoiceId": 6,
            "invoiceName": "Sample Text Data",
            "posting": "2021-04-26T15:25:27.587Z",
            "baseAmount": 1345.89,
            "invoiceAmount": 24,
            "currencyExchangeDetailId": 23,
            "currencyExchangeDetailName": "Sample Text Data",
            "billRunHistoryId": 19,
            "billRunHistoryName": "Sample Text Data",
            "isManual": true,
            "reversePaymentId": 5,
            "reversePaymentName": "Sample Text Data",
            "createdByUserId": 25,
            "createdByUserName": "Sample Text Data",
            "paymentMethodId": 2,
            "paymentMethodName": "Sample Text Data",
            "paymentPreAuthorizeId": 26,
            "paymentPreAuthorizeName": "Sample Text Data",
            "paymentTransactionId": 18,
            "paymentTransactionName": "Sample Text Data",
            "createdByPortalUserId": 15,
            "createdByPortalUserName": "Sample Text Data"
        }
    ]
}
GETPayment/Paged
Retrieve all of the Payment 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 Payment objects in a paged fashion.
GET Payment/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,
                "date": "2021-04-26T15:25:27.587Z",
                "amount": 1235.89,
                "accountId": 6,
                "accountName": "Sample Text Data",
                "disbursed": true,
                "paymentTypeId": 18,
                "paymentTypeName": "Sample Text Data",
                "detail": "Payment Recieved",
                "cardTypeId": 1,
                "cardTypeName": "Sample Text Data",
                "checkNumber": "1236-9658",
                "automaticDisburse": true,
                "created": "2021-04-26T15:25:27.587Z",
                "invoiceId": 24,
                "invoiceName": "Sample Text Data",
                "posting": "2021-04-26T15:25:27.587Z",
                "baseAmount": 1345.89,
                "invoiceAmount": 7,
                "currencyExchangeDetailId": 23,
                "currencyExchangeDetailName": "Sample Text Data",
                "billRunHistoryId": 9,
                "billRunHistoryName": "Sample Text Data",
                "isManual": true,
                "reversePaymentId": 10,
                "reversePaymentName": "Sample Text Data",
                "createdByUserId": 9,
                "createdByUserName": "Sample Text Data",
                "paymentMethodId": 16,
                "paymentMethodName": "Sample Text Data",
                "paymentPreAuthorizeId": 14,
                "paymentPreAuthorizeName": "Sample Text Data",
                "paymentTransactionId": 8,
                "paymentTransactionName": "Sample Text Data",
                "createdByPortalUserId": 23,
                "createdByPortalUserName": "Sample Text Data"
            }
        ]
    }
}
GETPayment/Paged/Detail
Retrieve all of the Payment objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the Payment objects in a paged fashion with all object details.
GET Payment/Paged/Detail
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,
                "date": "2021-04-26T15:25:27.587Z",
                "amount": 1235.89,
                "accountId": 12,
                "accountName": "Sample Text Data",
                "disbursed": true,
                "paymentTypeId": 24,
                "paymentTypeName": "Sample Text Data",
                "detail": "Payment Recieved",
                "cardTypeId": 23,
                "cardTypeName": "Sample Text Data",
                "checkNumber": "1236-9658",
                "automaticDisburse": true,
                "created": "2021-04-26T15:25:27.587Z",
                "invoiceId": 27,
                "invoiceName": "Sample Text Data",
                "posting": "2021-04-26T15:25:27.587Z",
                "baseAmount": 1345.89,
                "invoiceAmount": 24,
                "currencyExchangeDetailId": 27,
                "currencyExchangeDetailName": "Sample Text Data",
                "billRunHistoryId": 19,
                "billRunHistoryName": "Sample Text Data",
                "isManual": true,
                "reversePaymentId": 12,
                "reversePaymentName": "Sample Text Data",
                "createdByUserId": 5,
                "createdByUserName": "Sample Text Data",
                "paymentMethodId": 2,
                "paymentMethodName": "Sample Text Data",
                "paymentPreAuthorizeId": 24,
                "paymentPreAuthorizeName": "Sample Text Data",
                "paymentTransactionId": 13,
                "paymentTransactionName": "Sample Text Data",
                "createdByPortalUserId": 15,
                "createdByPortalUserName": "Sample Text Data",
                "details": {
                    "invoiceDisbursements": [
                        {
                            "identity": 63,
                            "invoiceId": 35,
                            "invoiceName": "Sample Text Data",
                            "paymentId": 56,
                            "amount": 75.53,
                            "baseAmount": 92.93,
                            "invoiceAmount": 26.85,
                            "automaticDisburse": true
                        }
                    ],
                    "paymentReversals": [
                        {
                            "identity": 23,
                            "date": "2021-04-26T15:25:27.587Z",
                            "amount": 36.61,
                            "accountId": 5,
                            "accountName": "Sample Text Data",
                            "disbursed": true,
                            "paymentTypeId": 42,
                            "paymentTypeName": "Sample Text Data",
                            "detail": "Sample Text Data",
                            "cardTypeId": 2,
                            "cardTypeName": "Sample Text Data",
                            "checkNumber": "Sample Text Data",
                            "automaticDisburse": true,
                            "created": "2021-04-26T15:25:27.587Z",
                            "invoiceId": 22,
                            "invoiceName": "Sample Text Data",
                            "posting": "2021-04-26T15:25:27.587Z",
                            "baseAmount": 60.42,
                            "invoiceAmount": 31.16,
                            "currencyExchangeDetailId": 73,
                            "billRunHistoryId": 27,
                            "billRunHistoryName": "Sample Text Data",
                            "isManual": true,
                            "reversePaymentId": 78,
                            "createdByUserId": 80,
                            "createdByUserName": "Sample Text Data",
                            "paymentMethodId": 5,
                            "paymentMethodName": "Sample Text Data",
                            "paymentPreAuthorizeId": 53,
                            "paymentTransactionId": 81,
                            "createdByPortalUserId": 88,
                            "createdByPortalUserName": "Sample Text Data"
                        }
                    ]
                }
            }
        ]
    }
}
GETPayment/{id}
Retrieve an instance of the Payment object by its ID.
{id}Unique identifier for the Payment object.
Retrieve an instance of the Payment object by its ID.
GET Payment/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "date": "2021-04-26T15:25:27.587Z",
        "amount": 1235.89,
        "accountId": 24,
        "accountName": "Sample Text Data",
        "disbursed": true,
        "paymentTypeId": 3,
        "paymentTypeName": "Sample Text Data",
        "detail": "Payment Recieved",
        "cardTypeId": 15,
        "cardTypeName": "Sample Text Data",
        "checkNumber": "1236-9658",
        "automaticDisburse": true,
        "created": "2021-04-26T15:25:27.587Z",
        "invoiceId": 2,
        "invoiceName": "Sample Text Data",
        "posting": "2021-04-26T15:25:27.587Z",
        "baseAmount": 1345.89,
        "invoiceAmount": 22,
        "currencyExchangeDetailId": 11,
        "currencyExchangeDetailName": "Sample Text Data",
        "billRunHistoryId": 25,
        "billRunHistoryName": "Sample Text Data",
        "isManual": true,
        "reversePaymentId": 15,
        "reversePaymentName": "Sample Text Data",
        "createdByUserId": 7,
        "createdByUserName": "Sample Text Data",
        "paymentMethodId": 12,
        "paymentMethodName": "Sample Text Data",
        "paymentPreAuthorizeId": 17,
        "paymentPreAuthorizeName": "Sample Text Data",
        "paymentTransactionId": 10,
        "paymentTransactionName": "Sample Text Data",
        "createdByPortalUserId": 22,
        "createdByPortalUserName": "Sample Text Data"
    }
}
GETPayment/{id}/Detail
Retrieve deep detail of the Payment object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the Payment object.
Retrieve deep detail of the Payment object by its ID.
GET Payment/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "date": "2021-04-26T15:25:27.587Z",
        "amount": 1235.89,
        "accountId": 21,
        "accountName": "Sample Text Data",
        "disbursed": true,
        "paymentTypeId": 26,
        "paymentTypeName": "Sample Text Data",
        "detail": "Payment Recieved",
        "cardTypeId": 20,
        "cardTypeName": "Sample Text Data",
        "checkNumber": "1236-9658",
        "automaticDisburse": true,
        "created": "2021-04-26T15:25:27.587Z",
        "invoiceId": 18,
        "invoiceName": "Sample Text Data",
        "posting": "2021-04-26T15:25:27.587Z",
        "baseAmount": 1345.89,
        "invoiceAmount": 4,
        "currencyExchangeDetailId": 21,
        "currencyExchangeDetailName": "Sample Text Data",
        "billRunHistoryId": 17,
        "billRunHistoryName": "Sample Text Data",
        "isManual": true,
        "reversePaymentId": 2,
        "reversePaymentName": "Sample Text Data",
        "createdByUserId": 21,
        "createdByUserName": "Sample Text Data",
        "paymentMethodId": 27,
        "paymentMethodName": "Sample Text Data",
        "paymentPreAuthorizeId": 16,
        "paymentPreAuthorizeName": "Sample Text Data",
        "paymentTransactionId": 10,
        "paymentTransactionName": "Sample Text Data",
        "createdByPortalUserId": 6,
        "createdByPortalUserName": "Sample Text Data",
        "details": {
            "invoiceDisbursements": [
                {
                    "identity": 63,
                    "invoiceId": 35,
                    "invoiceName": "Sample Text Data",
                    "paymentId": 56,
                    "amount": 75.53,
                    "baseAmount": 92.93,
                    "invoiceAmount": 26.85,
                    "automaticDisburse": true
                }
            ],
            "paymentReversals": [
                {
                    "identity": 23,
                    "date": "2021-04-26T15:25:27.587Z",
                    "amount": 36.61,
                    "accountId": 5,
                    "accountName": "Sample Text Data",
                    "disbursed": true,
                    "paymentTypeId": 42,
                    "paymentTypeName": "Sample Text Data",
                    "detail": "Sample Text Data",
                    "cardTypeId": 2,
                    "cardTypeName": "Sample Text Data",
                    "checkNumber": "Sample Text Data",
                    "automaticDisburse": true,
                    "created": "2021-04-26T15:25:27.587Z",
                    "invoiceId": 22,
                    "invoiceName": "Sample Text Data",
                    "posting": "2021-04-26T15:25:27.587Z",
                    "baseAmount": 60.42,
                    "invoiceAmount": 31.16,
                    "currencyExchangeDetailId": 73,
                    "billRunHistoryId": 27,
                    "billRunHistoryName": "Sample Text Data",
                    "isManual": true,
                    "reversePaymentId": 78,
                    "createdByUserId": 80,
                    "createdByUserName": "Sample Text Data",
                    "paymentMethodId": 5,
                    "paymentMethodName": "Sample Text Data",
                    "paymentPreAuthorizeId": 53,
                    "paymentTransactionId": 81,
                    "createdByPortalUserId": 88,
                    "createdByPortalUserName": "Sample Text Data"
                }
            ]
        }
    }
}
PATCHPayment/{id}
Update or Add the Payment object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the Payment object.
Update or Add the Payment object and optionally make changes to any child objects.
PATCH Payment/{id}

{
    "details": {},
    "payments": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "date": "2021-04-26T15:25:27.587Z",
                "amount": 1235.89,
                "accountId": 25,
                "disbursed": true,
                "paymentTypeId": 16,
                "detail": "Payment Recieved",
                "cardTypeId": 1,
                "checkNumber": "1236-9658",
                "automaticDisburse": true,
                "invoiceId": 6,
                "posting": "2021-04-26T15:25:27.587Z",
                "baseAmount": 1345.89,
                "invoiceAmount": 5,
                "currencyExchangeDetailId": 10,
                "billRunHistoryId": 8,
                "isManual": true,
                "reversePaymentId": 3,
                "createdByUserId": 2,
                "paymentMethodId": 13,
                "paymentPreAuthorizeId": 7,
                "paymentTransactionId": 13,
                "createdByPortalUserId": 2
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "payment",
                "instance": {
                    "identity": 1,
                    "date": "2021-04-26T15:25:27.587Z",
                    "amount": 1235.89,
                    "accountId": 1,
                    "accountName": "Sample Text Data",
                    "disbursed": true,
                    "paymentTypeId": 1,
                    "paymentTypeName": "Sample Text Data",
                    "detail": "Payment Recieved",
                    "cardTypeId": 22,
                    "cardTypeName": "Sample Text Data",
                    "checkNumber": "1236-9658",
                    "automaticDisburse": true,
                    "created": "2021-04-26T15:25:27.587Z",
                    "invoiceId": 22,
                    "invoiceName": "Sample Text Data",
                    "posting": "2021-04-26T15:25:27.587Z",
                    "baseAmount": 1345.89,
                    "invoiceAmount": 21,
                    "currencyExchangeDetailId": 3,
                    "currencyExchangeDetailName": "Sample Text Data",
                    "billRunHistoryId": 6,
                    "billRunHistoryName": "Sample Text Data",
                    "isManual": true,
                    "reversePaymentId": 12,
                    "reversePaymentName": "Sample Text Data",
                    "createdByUserId": 24,
                    "createdByUserName": "Sample Text Data",
                    "paymentMethodId": 27,
                    "paymentMethodName": "Sample Text Data",
                    "paymentPreAuthorizeId": 6,
                    "paymentPreAuthorizeName": "Sample Text Data",
                    "paymentTransactionId": 6,
                    "paymentTransactionName": "Sample Text Data",
                    "createdByPortalUserId": 27,
                    "createdByPortalUserName": "Sample Text Data"
                }
            }
        ]
    }
}
POSTPayment/
Create a new instance of the Payment object.
Create a new instance of the Payment object.
POST Payment/

{
    "date": "2021-04-26T15:25:27.587Z",
    "amount": 1235.89,
    "accountId": 24,
    "disbursed": true,
    "paymentTypeId": 22,
    "detail": "Payment Recieved",
    "cardTypeId": 22,
    "checkNumber": "1236-9658",
    "automaticDisburse": true,
    "invoiceId": 16,
    "posting": "2021-04-26T15:25:27.587Z",
    "baseAmount": 1345.89,
    "invoiceAmount": 27,
    "currencyExchangeDetailId": 25,
    "billRunHistoryId": 25,
    "isManual": true,
    "reversePaymentId": 20,
    "createdByUserId": 3,
    "paymentMethodId": 13,
    "paymentPreAuthorizeId": 6,
    "paymentTransactionId": 5,
    "createdByPortalUserId": 8
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "date": "2021-04-26T15:25:27.587Z",
                "amount": 1235.89,
                "accountId": 19,
                "accountName": "Sample Text Data",
                "disbursed": true,
                "paymentTypeId": 27,
                "paymentTypeName": "Sample Text Data",
                "detail": "Payment Recieved",
                "cardTypeId": 8,
                "cardTypeName": "Sample Text Data",
                "checkNumber": "1236-9658",
                "automaticDisburse": true,
                "created": "2021-04-26T15:25:27.587Z",
                "invoiceId": 16,
                "invoiceName": "Sample Text Data",
                "posting": "2021-04-26T15:25:27.587Z",
                "baseAmount": 1345.89,
                "invoiceAmount": 4,
                "currencyExchangeDetailId": 15,
                "currencyExchangeDetailName": "Sample Text Data",
                "billRunHistoryId": 24,
                "billRunHistoryName": "Sample Text Data",
                "isManual": true,
                "reversePaymentId": 24,
                "reversePaymentName": "Sample Text Data",
                "createdByUserId": 21,
                "createdByUserName": "Sample Text Data",
                "paymentMethodId": 23,
                "paymentMethodName": "Sample Text Data",
                "paymentPreAuthorizeId": 24,
                "paymentPreAuthorizeName": "Sample Text Data",
                "paymentTransactionId": 27,
                "paymentTransactionName": "Sample Text Data",
                "createdByPortalUserId": 1,
                "createdByPortalUserName": "Sample Text Data"
            }
        ]
    }
}
POSTPayment/Reverse
Reverse an existing Payment. Payment details provided in body of POST request.
POSTPayment/Reverse/Vendor
Reverse an existing Payment. Payment details provided in body of POST request.
POSTPayment/Vendor
Create a Payment to be processed by a specified Payment gateway vendor. Payment details provided in body of POST request.
PUTPayment/{id}
Update an existing instance of the Payment object.
Update an existing instance of the Payment object.
PUT Payment/{id}

{
    "identity": 1,
    "date": "2021-04-26T15:25:27.587Z",
    "amount": 1235.89,
    "accountId": 22,
    "disbursed": true,
    "paymentTypeId": 27,
    "detail": "Payment Recieved",
    "cardTypeId": 4,
    "checkNumber": "1236-9658",
    "automaticDisburse": true,
    "invoiceId": 15,
    "posting": "2021-04-26T15:25:27.587Z",
    "baseAmount": 1345.89,
    "invoiceAmount": 5,
    "currencyExchangeDetailId": 7,
    "billRunHistoryId": 17,
    "isManual": true,
    "reversePaymentId": 14,
    "createdByUserId": 16,
    "paymentMethodId": 10,
    "paymentPreAuthorizeId": 17,
    "paymentTransactionId": 10,
    "createdByPortalUserId": 1
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "date": "2021-04-26T15:25:27.587Z",
                "amount": 1235.89,
                "accountId": 12,
                "accountName": "Sample Text Data",
                "disbursed": true,
                "paymentTypeId": 27,
                "paymentTypeName": "Sample Text Data",
                "detail": "Payment Recieved",
                "cardTypeId": 26,
                "cardTypeName": "Sample Text Data",
                "checkNumber": "1236-9658",
                "automaticDisburse": true,
                "created": "2021-04-26T15:25:27.587Z",
                "invoiceId": 11,
                "invoiceName": "Sample Text Data",
                "posting": "2021-04-26T15:25:27.587Z",
                "baseAmount": 1345.89,
                "invoiceAmount": 27,
                "currencyExchangeDetailId": 2,
                "currencyExchangeDetailName": "Sample Text Data",
                "billRunHistoryId": 14,
                "billRunHistoryName": "Sample Text Data",
                "isManual": true,
                "reversePaymentId": 10,
                "reversePaymentName": "Sample Text Data",
                "createdByUserId": 1,
                "createdByUserName": "Sample Text Data",
                "paymentMethodId": 18,
                "paymentMethodName": "Sample Text Data",
                "paymentPreAuthorizeId": 5,
                "paymentPreAuthorizeName": "Sample Text Data",
                "paymentTransactionId": 0,
                "paymentTransactionName": "Sample Text Data",
                "createdByPortalUserId": 15,
                "createdByPortalUserName": "Sample Text Data"
            }
        ]
    }
}