Credit / Item

What can you do with CreditItem?

GET api/v1/Credit/Item
GET api/v1/Credit/Item/Metadata
GET api/v1/Credit/Item/Metadata/{option}
GET api/v1/Credit/Item/Paged
GET api/v1/Credit/Item/{id:int}

Properties

Property Details

id	"id": 979 Type: Number This is the unique numeric identifier for the CreditItem
invoiceItemId	"invoiceItemId": 751 Type: Number Unique identifier for the associated InvoiceItem object.
showOnInvoice	"showOnInvoice": true Type: Boolean
showOnCreditNote	"showOnCreditNote": true Type: Boolean
creditNoteId	"creditNoteId": 883 Type: Number Unique identifier for the associated CreditNote 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:

invoiceItemId
showOnInvoice
showOnCreditNote
creditNoteId

DataFlow PATCH objects:

creditItem - create, update, delete

End Points

GET	api/v1/Credit/Item
Retrieve all of the CreditItem objects.

GET	api/v1/Credit/Item/Metadata
Retrieve all of the meta data details of the CreditItem object.

GET	api/v1/Credit/Item/Metadata/{option}
Retrieve all the meta data details of the CreditItem object based on provided options.
{option}	Metadata options for the CreditItem object.

GET	api/v1/Credit/Item/Paged
Retreive all of the CreditItem objects in a paged fashion.

GET	api/v1/Credit/Item/{id:int}
Retrieve an instance of the CreditItem object by it's ID.
{id:int}	Unique identifier for the CreditItem object.