Payment / ReversePayment

What can you do with Payment?


Properties

Property Details
id
"id": 797
Type: Number
This is the unique numeric identifier for the Payment
date
"date": "2005-04-11T14:56:24"
Type: Date
amount
"amount": "Hello World"
Type: String
accountId
"accountId": 942
Type: Number
Unique identifier for the associated Account object.
disbursed
"disbursed": true
Type: Boolean
paymentTypeId
"paymentTypeId": 955
Type: Number
Unique identifier for the associated PaymentType object.
detail
"detail": "Hello World"
Type: String
cardTypeId
"cardTypeId": 171
Type: Number
Unique identifier for the associated CardType object.
checkNumber
"checkNumber": "Hello World"
Type: String
automaticDisburse
"automaticDisburse": true
Type: Boolean
created
"created": "2005-04-11T14:56:24"
Type: Date
invoiceId
"invoiceId": 503
Type: Number
Unique identifier for the associated Invoice object.
posting
"posting": "2005-04-11T14:56:24"
Type: Date
baseAmount
"baseAmount": "Hello World"
Type: String
invoiceAmount
"invoiceAmount": "Hello World"
Type: String
currencyExchangeDetailId
"currencyExchangeDetailId": 185
Type: Number
Unique identifier for the associated CurrencyExchangeDetail object.
billRunHistoryId
"billRunHistoryId": 673
Type: Number
Unique identifier for the associated BillRunHistory object.
isManual
"isManual": true
Type: Boolean
reversePaymentId
"reversePaymentId": 52
Type: Number
Unique identifier for the associated Payment object.
createdByUserId
"createdByUserId": 187
Type: Number
Unique identifier for the associated User object.


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:

  • date
  • amount
  • accountId
  • disbursed
  • paymentTypeId
  • detail
  • cardTypeId
  • checkNumber
  • automaticDisburse
  • created
  • invoiceId
  • posting
  • baseAmount
  • invoiceAmount
  • currencyExchangeDetailId
  • billRunHistoryId
  • isManual
  • reversePaymentId
  • createdByUserId

DataFlow PATCH objects:


End Points

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