Payment / Invoice Disbursement

What can you do with PaymentInvoiceDisbursement?


Properties

Property Details
id
"id": 809
Type: Number
This is the unique numeric identifier for the PaymentInvoiceDisbursement
invoiceId
"invoiceId": 263
Type: Number
Unique identifier for the associated Invoice object.
paymentId
"paymentId": 434
Type: Number
Unique identifier for the associated Payment object.
amount
"amount": "Hello World"
Type: String
baseAmount
"baseAmount": "Hello World"
Type: String
invoiceAmount
"invoiceAmount": "Hello World"
Type: String


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:

  • invoiceId
  • paymentId
  • amount
  • baseAmount
  • invoiceAmount

DataFlow PATCH objects:


End Points

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