TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 25 Type: Number This is the unique numeric identifier for the Payment |
date | "date": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
amount | "amount": 12 Type: Number |
accountId | "accountId": 24 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 |
paymentTypeId | "paymentTypeId": 27 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": "Hello World" Type: String |
cardTypeId | "cardTypeId": 27 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": "Hello World" Type: String |
automaticDisburse | "automaticDisburse": true Type: Boolean |
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": 4 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 and time values are specified in the ISO 8601 format. |
baseAmount | "baseAmount": 21 Type: Number |
invoiceAmount | "invoiceAmount": 24 Type: Number |
currencyExchangeDetailId | "currencyExchangeDetailId": 9 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": 18 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 |
reversePaymentId | "reversePaymentId": 8 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": 27 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": 0 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": 26 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": 11 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. |
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:
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 or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Payment object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v2/Payment/{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 api/v2/Payment/{id}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"
}
]
}
} | |
| GET | api/v2/Payment/ |
| Retrieve all of the Payment objects. | |
Retrieve all of the Payment objects. GET api/v2/Payment/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"date": "2021-04-26T15:25:27.587Z",
"amount": 20,
"accountId": 6,
"accountName": "Sample Text Data",
"disbursed": true,
"paymentTypeId": 16,
"paymentTypeName": "Sample Text Data",
"detail": "Sample Text Data",
"cardTypeId": 7,
"cardTypeName": "Sample Text Data",
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"created": "2021-04-26T15:25:27.587Z",
"invoiceId": 24,
"invoiceName": "Sample Text Data",
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 14,
"invoiceAmount": 3,
"currencyExchangeDetailId": 13,
"currencyExchangeDetailName": "Sample Text Data",
"billRunHistoryId": 7,
"billRunHistoryName": "Sample Text Data",
"isManual": true,
"reversePaymentId": 27,
"reversePaymentName": "Sample Text Data",
"createdByUserId": 18,
"createdByUserName": "Sample Text Data",
"paymentMethodId": 10,
"paymentMethodName": "Sample Text Data",
"paymentPreAuthorizeId": 21,
"paymentPreAuthorizeName": "Sample Text Data",
"paymentTransactionId": 26,
"paymentTransactionName": "Sample Text Data",
"createdByPortalUserId": 12,
"createdByPortalUserName": "Sample Text Data"
}
]
} | |
| GET | api/v2/Payment/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 api/v2/Payment/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,
"date": "2021-04-26T15:25:27.587Z",
"amount": 13,
"accountId": 13,
"accountName": "Sample Text Data",
"disbursed": true,
"paymentTypeId": 24,
"paymentTypeName": "Sample Text Data",
"detail": "Sample Text Data",
"cardTypeId": 7,
"cardTypeName": "Sample Text Data",
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"created": "2021-04-26T15:25:27.587Z",
"invoiceId": 8,
"invoiceName": "Sample Text Data",
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 17,
"invoiceAmount": 16,
"currencyExchangeDetailId": 10,
"currencyExchangeDetailName": "Sample Text Data",
"billRunHistoryId": 3,
"billRunHistoryName": "Sample Text Data",
"isManual": true,
"reversePaymentId": 9,
"reversePaymentName": "Sample Text Data",
"createdByUserId": 26,
"createdByUserName": "Sample Text Data",
"paymentMethodId": 18,
"paymentMethodName": "Sample Text Data",
"paymentPreAuthorizeId": 0,
"paymentPreAuthorizeName": "Sample Text Data",
"paymentTransactionId": 2,
"paymentTransactionName": "Sample Text Data",
"createdByPortalUserId": 5,
"createdByPortalUserName": "Sample Text Data"
}
]
}
} | |
| GET | api/v2/Payment/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 api/v2/Payment/Paged/Detail 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": 21,
"accountId": 13,
"accountName": "Sample Text Data",
"disbursed": true,
"paymentTypeId": 15,
"paymentTypeName": "Sample Text Data",
"detail": "Sample Text Data",
"cardTypeId": 17,
"cardTypeName": "Sample Text Data",
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"created": "2021-04-26T15:25:27.587Z",
"invoiceId": 14,
"invoiceName": "Sample Text Data",
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 10,
"invoiceAmount": 24,
"currencyExchangeDetailId": 13,
"currencyExchangeDetailName": "Sample Text Data",
"billRunHistoryId": 16,
"billRunHistoryName": "Sample Text Data",
"isManual": true,
"reversePaymentId": 22,
"reversePaymentName": "Sample Text Data",
"createdByUserId": 18,
"createdByUserName": "Sample Text Data",
"paymentMethodId": 9,
"paymentMethodName": "Sample Text Data",
"paymentPreAuthorizeId": 6,
"paymentPreAuthorizeName": "Sample Text Data",
"paymentTransactionId": 13,
"paymentTransactionName": "Sample Text Data",
"createdByPortalUserId": 14,
"createdByPortalUserName": "Sample Text Data",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v2/Payment/{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 api/v2/Payment/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"date": "2021-04-26T15:25:27.587Z",
"amount": 16,
"accountId": 23,
"accountName": "Sample Text Data",
"disbursed": true,
"paymentTypeId": 6,
"paymentTypeName": "Sample Text Data",
"detail": "Sample Text Data",
"cardTypeId": 25,
"cardTypeName": "Sample Text Data",
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"created": "2021-04-26T15:25:27.587Z",
"invoiceId": 10,
"invoiceName": "Sample Text Data",
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 24,
"invoiceAmount": 10,
"currencyExchangeDetailId": 0,
"currencyExchangeDetailName": "Sample Text Data",
"billRunHistoryId": 7,
"billRunHistoryName": "Sample Text Data",
"isManual": true,
"reversePaymentId": 0,
"reversePaymentName": "Sample Text Data",
"createdByUserId": 21,
"createdByUserName": "Sample Text Data",
"paymentMethodId": 22,
"paymentMethodName": "Sample Text Data",
"paymentPreAuthorizeId": 5,
"paymentPreAuthorizeName": "Sample Text Data",
"paymentTransactionId": 25,
"paymentTransactionName": "Sample Text Data",
"createdByPortalUserId": 8,
"createdByPortalUserName": "Sample Text Data"
}
} | |
| GET | api/v2/Payment/{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 api/v2/Payment/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"date": "2021-04-26T15:25:27.587Z",
"amount": 11,
"accountId": 21,
"accountName": "Sample Text Data",
"disbursed": true,
"paymentTypeId": 15,
"paymentTypeName": "Sample Text Data",
"detail": "Sample Text Data",
"cardTypeId": 17,
"cardTypeName": "Sample Text Data",
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"created": "2021-04-26T15:25:27.587Z",
"invoiceId": 25,
"invoiceName": "Sample Text Data",
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 8,
"invoiceAmount": 6,
"currencyExchangeDetailId": 7,
"currencyExchangeDetailName": "Sample Text Data",
"billRunHistoryId": 23,
"billRunHistoryName": "Sample Text Data",
"isManual": true,
"reversePaymentId": 17,
"reversePaymentName": "Sample Text Data",
"createdByUserId": 1,
"createdByUserName": "Sample Text Data",
"paymentMethodId": 23,
"paymentMethodName": "Sample Text Data",
"paymentPreAuthorizeId": 13,
"paymentPreAuthorizeName": "Sample Text Data",
"paymentTransactionId": 6,
"paymentTransactionName": "Sample Text Data",
"createdByPortalUserId": 17,
"createdByPortalUserName": "Sample Text Data",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| PATCH | api/v2/Payment/{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 api/v2/Payment/{id}
{
"details": {},
"payments": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"date": "2021-04-26T15:25:27.587Z",
"amount": 22,
"accountId": 1,
"disbursed": true,
"paymentTypeId": 25,
"detail": "Sample Text Data",
"cardTypeId": 0,
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"invoiceId": 5,
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 4,
"invoiceAmount": 9,
"currencyExchangeDetailId": 10,
"billRunHistoryId": 18,
"isManual": true,
"reversePaymentId": 17,
"createdByUserId": 21,
"paymentMethodId": 8,
"paymentPreAuthorizeId": 20,
"paymentTransactionId": 3,
"createdByPortalUserId": 16
}
]
}
}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": 12,
"accountId": 18,
"accountName": "Sample Text Data",
"disbursed": true,
"paymentTypeId": 20,
"paymentTypeName": "Sample Text Data",
"detail": "Sample Text Data",
"cardTypeId": 0,
"cardTypeName": "Sample Text Data",
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"created": "2021-04-26T15:25:27.587Z",
"invoiceId": 26,
"invoiceName": "Sample Text Data",
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 16,
"invoiceAmount": 11,
"currencyExchangeDetailId": 10,
"currencyExchangeDetailName": "Sample Text Data",
"billRunHistoryId": 0,
"billRunHistoryName": "Sample Text Data",
"isManual": true,
"reversePaymentId": 22,
"reversePaymentName": "Sample Text Data",
"createdByUserId": 6,
"createdByUserName": "Sample Text Data",
"paymentMethodId": 15,
"paymentMethodName": "Sample Text Data",
"paymentPreAuthorizeId": 9,
"paymentPreAuthorizeName": "Sample Text Data",
"paymentTransactionId": 6,
"paymentTransactionName": "Sample Text Data",
"createdByPortalUserId": 20,
"createdByPortalUserName": "Sample Text Data"
}
}
]
}
} | |
| POST | api/v2/Payment/ |
| Create a new instance of the Payment object. | |
Create a new instance of the Payment object. POST api/v2/Payment/
{
"date": "2021-04-26T15:25:27.587Z",
"amount": 17,
"accountId": 5,
"disbursed": true,
"paymentTypeId": 20,
"detail": "Sample Text Data",
"cardTypeId": 22,
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"invoiceId": 11,
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 7,
"invoiceAmount": 3,
"currencyExchangeDetailId": 21,
"billRunHistoryId": 21,
"isManual": true,
"reversePaymentId": 24,
"createdByUserId": 26,
"paymentMethodId": 18,
"paymentPreAuthorizeId": 13,
"paymentTransactionId": 23,
"createdByPortalUserId": 12
}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": 24,
"accountId": 15,
"accountName": "Sample Text Data",
"disbursed": true,
"paymentTypeId": 10,
"paymentTypeName": "Sample Text Data",
"detail": "Sample Text Data",
"cardTypeId": 15,
"cardTypeName": "Sample Text Data",
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"created": "2021-04-26T15:25:27.587Z",
"invoiceId": 19,
"invoiceName": "Sample Text Data",
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 14,
"invoiceAmount": 15,
"currencyExchangeDetailId": 6,
"currencyExchangeDetailName": "Sample Text Data",
"billRunHistoryId": 4,
"billRunHistoryName": "Sample Text Data",
"isManual": true,
"reversePaymentId": 16,
"reversePaymentName": "Sample Text Data",
"createdByUserId": 8,
"createdByUserName": "Sample Text Data",
"paymentMethodId": 8,
"paymentMethodName": "Sample Text Data",
"paymentPreAuthorizeId": 21,
"paymentPreAuthorizeName": "Sample Text Data",
"paymentTransactionId": 0,
"paymentTransactionName": "Sample Text Data",
"createdByPortalUserId": 8,
"createdByPortalUserName": "Sample Text Data"
}
]
}
} | |
| POST | api/v2/Payment/Reverse |
| Reverse an existing Payment. Payment details provided in body of POST request. | |
| POST | api/v2/Payment/Reverse/Vendor |
| Reverse an existing Payment. Payment details provided in body of POST request. | |
| POST | api/v2/Payment/Vendor |
| Create a Payment to be processed by a specified Payment gateway vendor. Payment details provided in body of POST request. | |
| PUT | api/v2/Payment/{id} |
| Update an existing instance of the Payment object. | |
Update an existing instance of the Payment object. PUT api/v2/Payment/{id}
{
"identity": 1,
"date": "2021-04-26T15:25:27.587Z",
"amount": 5,
"accountId": 14,
"disbursed": true,
"paymentTypeId": 12,
"detail": "Sample Text Data",
"cardTypeId": 5,
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"invoiceId": 19,
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 4,
"invoiceAmount": 25,
"currencyExchangeDetailId": 4,
"billRunHistoryId": 24,
"isManual": true,
"reversePaymentId": 0,
"createdByUserId": 8,
"paymentMethodId": 20,
"paymentPreAuthorizeId": 8,
"paymentTransactionId": 0,
"createdByPortalUserId": 1
}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": 23,
"accountId": 9,
"accountName": "Sample Text Data",
"disbursed": true,
"paymentTypeId": 4,
"paymentTypeName": "Sample Text Data",
"detail": "Sample Text Data",
"cardTypeId": 12,
"cardTypeName": "Sample Text Data",
"checkNumber": "Sample Text Data",
"automaticDisburse": true,
"created": "2021-04-26T15:25:27.587Z",
"invoiceId": 13,
"invoiceName": "Sample Text Data",
"posting": "2021-04-26T15:25:27.587Z",
"baseAmount": 23,
"invoiceAmount": 14,
"currencyExchangeDetailId": 24,
"currencyExchangeDetailName": "Sample Text Data",
"billRunHistoryId": 27,
"billRunHistoryName": "Sample Text Data",
"isManual": true,
"reversePaymentId": 12,
"reversePaymentName": "Sample Text Data",
"createdByUserId": 0,
"createdByUserName": "Sample Text Data",
"paymentMethodId": 19,
"paymentMethodName": "Sample Text Data",
"paymentPreAuthorizeId": 23,
"paymentPreAuthorizeName": "Sample Text Data",
"paymentTransactionId": 9,
"paymentTransactionName": "Sample Text Data",
"createdByPortalUserId": 6,
"createdByPortalUserName": "Sample Text Data"
}
]
}
} | |