Payment

What can you do with Payment?


Properties

Property Details
id
"id": 788
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": 190
Type: Number
Unique identifier for the associated Account object.
disbursed
"disbursed": true
Type: Boolean
paidByAccountId
"paidByAccountId": 159
Type: Number
Unique identifier for the associated Account object.
paymentTypeId
"paymentTypeId": 135
Type: Number
Unique identifier for the associated PaymentType object.
detail
"detail": "Hello World"
Type: String
cardTypeId
"cardTypeId": 569
Type: Number
Unique identifier for the associated CardType object.
checkNumber
"checkNumber": "Hello World"
Type: String
automaticDisburse
"automaticDisburse": true
Type: Boolean
credit
"credit": true
Type: Boolean
void
"void": true
Type: Boolean
batchNumber
"batchNumber": "Hello World"
Type: String
deposit
"deposit": true
Type: Boolean
created
"created": "2005-04-11T14:56:24"
Type: Date
invoiceId
"invoiceId": 325
Type: Number
Unique identifier for the associated Invoice object.
addedByAccountId
"addedByAccountId": 542
Type: Number
Unique identifier for the associated Account object.
posting
"posting": "2005-04-11T14:56:24"
Type: Date
last4CCDigits
"last4CCDigits": "Hello World"
Type: String
accountingExportStagingId
"accountingExportStagingId": 444
Type: Number
Unique identifier for the associated AccountingExportStaging object.
baseAmount
"baseAmount": "Hello World"
Type: String
invoiceAmount
"invoiceAmount": "Hello World"
Type: String
currencyExchangeDetailId
"currencyExchangeDetailId": 113
Type: Number
Unique identifier for the associated CurrencyExchangeDetail object.
billRunHistoryId
"billRunHistoryId": 812
Type: Number
Unique identifier for the associated BillRunHistory 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
  • paidByAccountId
  • paymentTypeId
  • detail
  • cardTypeId
  • checkNumber
  • automaticDisburse
  • credit
  • void
  • batchNumber
  • deposit
  • created
  • invoiceId
  • addedByAccountId
  • posting
  • last4CCDigits
  • accountingExportStagingId
  • baseAmount
  • invoiceAmount
  • currencyExchangeDetailId
  • billRunHistoryId

DataFlow PATCH objects:


End Points

DELETEapi/v1/Payment/{id:int}
Delete an instance of the Payment object.
GETapi/v1/Payment
Retrieve all of the Payment objects.
GETapi/v1/Payment/Metadata
Retrieve all of the meta data details of the Payment object.
GETapi/v1/Payment/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/Paged
Retreive all of the Payment objects in a paged fashion.
GETapi/v1/Payment/Paged/Detail
Retreive all of the Payment objects in a paged fashion with all object details.
GETapi/v1/Payment/{id:int}
Retrieve an instance of the Payment object by it's ID.
{id:int}Unique identifier for the Payment object.
GETapi/v1/Payment/{id:int}/Detail
Retreive all of the Detail objects for the specified Payment.
{id:int}Unique identifier for the Payment object.
PATCHapi/v1/Payment/{id:int}
Update the Payment object and optionally make changes to any child objects.
POSTapi/v1/Payment
Create a new instance of the Payment object.
PUTapi/v1/Payment/{id:int}
Update an existing instance of the Payment object.