TAG LINE
SMALL TITLE

Payment

(API Version v3)


What can you do with Payment?


Properties

Property Details
id
"id": 15
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": 10
Type: Number
Unique identifier for the associated Account object.
disbursed
"disbursed": true
Type: Boolean
paymentTypeId
"paymentTypeId": 24
Type: Number
Unique identifier for the associated PaymentType object.
detail
"detail": "Hello World"
Type: String
cardTypeId
"cardTypeId": 21
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": 12
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": 18
Type: Number
Unique identifier for the associated CurrencyExchangeDetail object.
billRunHistoryId
"billRunHistoryId": 27
Type: Number
Unique identifier for the associated BillRunHistory object.
isManual
"isManual": true
Type: Boolean
reversePaymentId
"reversePaymentId": 2
Type: Number
Unique identifier for the associated Payment object.
createdByUserId
"createdByUserId": 16
Type: Number
Unique identifier for the associated User object.
paymentMethodId
"paymentMethodId": 18
Type: Number
Unique identifier for the associated PaymentMethod object.
paymentPreAuthorizeId
"paymentPreAuthorizeId": 17
Type: Number
Unique identifier for the associated PaymentPreAuthorize object.
paymentTransactionId
"paymentTransactionId": 21
Type: Number
Unique identifier for the associated PaymentTransaction 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
  • paymentMethodId
  • paymentPreAuthorizeId
  • paymentTransactionId

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 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:


End Points

DELETEapi/v3/Payment/{id:int}
Delete an instance of the Payment object.
GETapi/v3/Payment
Retrieve all of the Payment objects.
GETapi/v3/Payment/Paged
Retreive all of the Payment objects in a paged fashion.
GETapi/v3/Payment/Paged/Detail
Retreive all of the Payment objects in a paged fashion with all object details.
GETapi/v3/Payment/Reverse
Retrieve all of the Payment objects.
GETapi/v3/Payment/Reverse/Paged
Retreive all of the Payment objects in a paged fashion.
GETapi/v3/Payment/Reverse/{id:int}
Retrieve an instance of the Payment object by it's ID.
{id:int}Unique identifier for the Payment object.
GETapi/v3/Payment/VendorConfiguration
Retrieve all of the Payment objects.
GETapi/v3/Payment/{id:int}
Retrieve an instance of the Payment object by it's ID.
{id:int}Unique identifier for the Payment object.
GETapi/v3/Payment/{id:int}/Detail
Retreive all of the Detail objects for the specified Payment.
{id:int}Unique identifier for the Payment object.
PATCHapi/v3/Payment/{id:int}
Update the Payment object and optionally make changes to any child objects.
POSTapi/v3/Payment
Create a new instance of the Payment object.
POSTapi/v3/Payment
Create a new instance of the Payment object.
POSTapi/v3/Payment/Onetime/BankAccount
Create a new instance of the Payment object.
POSTapi/v3/Payment/Onetime/CreditCard
Create a new instance of the Payment object.
POSTapi/v3/Payment/Reverse
Create a new instance of the Payment object.
POSTapi/v3/Payment/Reverse/Vendor
Create a new instance of the Payment object.
POSTapi/v3/Payment/Vendor
Create a new instance of the Payment object.
PUTapi/v3/Payment/Reverse/{id:int}
Update an existing instance of the Payment object.
PUTapi/v3/Payment/{id:int}
Update an existing instance of the Payment object.