Credit / Invoice Disbursement

What can you do with CreditInvoiceDisbursement?


Properties

Property Details
id
"id": 963
Type: Number
This is the unique numeric identifier for the CreditInvoiceDisbursement
invoiceId
"invoiceId": 601
Type: Number
Unique identifier for the associated Invoice object.
amount
"amount": "Hello World"
Type: String
invoiceItemId
"invoiceItemId": 794
Type: Number
Unique identifier for the associated InvoiceItem object.
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
  • amount
  • invoiceItemId
  • baseAmount
  • invoiceAmount

DataFlow PATCH objects:


End Points

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