TAG LINE
SMALL TITLE

Credit / Item

(API Version v3)


What can you do with CreditItem?


Properties

Property Details
id
"id": 5
Type: Number
This is the unique numeric identifier for the CreditItem
invoiceItemId
"invoiceItemId": 4
Type: Number
Unique identifier for the associated InvoiceItem object.
showOnInvoice
"showOnInvoice": true
Type: Boolean
showOnCreditNote
"showOnCreditNote": true
Type: Boolean
creditNoteId
"creditNoteId": 16
Type: Number
Unique identifier for the associated CreditNote object.
automaticDisburse
"automaticDisburse": true
Type: Boolean
disbursed
"disbursed": true
Type: Boolean


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:

  • invoiceItemId
  • showOnInvoice
  • showOnCreditNote
  • creditNoteId
  • automaticDisburse

DataFlow PATCH objects:


End Points

GETapi/v3/Credit/Item
Retrieve all of the CreditItem objects.
GETapi/v3/Credit/Item/Paged
Retreive all of the CreditItem objects in a paged fashion.
GETapi/v3/Credit/Item/{id:int}
Retrieve an instance of the CreditItem object by it's ID.
{id:int}Unique identifier for the CreditItem object.