Credit / Note

What can you do with CreditNote?


Properties

Property Details
id
"id": 36
Type: Number
This is the unique numeric identifier for the CreditNote
accountId
"accountId": 855
Type: Number
Unique identifier for the associated Account object.
created
"created": "2005-04-11T14:56:24"
Type: Date
createdByUserId
"createdByUserId": 758
Type: Number
Unique identifier for the associated User object.
templateId
"templateId": 959
Type: Number
Unique identifier for the associated Template object.
sent
"sent": "2005-04-11T14:56:24"
Type: Date
name
"name": "Hello World"
Type: String
date
"date": "2005-04-11T14:56:24"
Type: Date
invoiceDeliveryTypeId
"invoiceDeliveryTypeId": 472
Type: Number
Unique identifier for the associated InvoiceDeliveryType 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:

  • accountId
  • created
  • createdByUserId
  • templateId
  • sent
  • name
  • date
  • invoiceDeliveryTypeId

DataFlow PATCH objects:


End Points

DELETEapi/v1/Credit/Note/{id:int}
Delete an instance of the CreditNote object.
GETapi/v1/Credit/Note
Retrieve all of the CreditNote objects.
GETapi/v1/Credit/Note/AvailableTokens
Retrieve all of the CreditNote objects.
GETapi/v1/Credit/Note/Metadata
Retrieve all of the meta data details of the CreditNote object.
GETapi/v1/Credit/Note/Metadata/{option}
Retrieve all the meta data details of the CreditNote object based on provided options.
{option}Metadata options for the CreditNote object.
GETapi/v1/Credit/Note/Paged
Retreive all of the CreditNote objects in a paged fashion.
GETapi/v1/Credit/Note/Paged/Detail
Retreive all of the CreditNote objects in a paged fashion with all object details.
GETapi/v1/Credit/Note/{id:int}
Retrieve an instance of the CreditNote object by it's ID.
{id:int}Unique identifier for the CreditNote object.
GETapi/v1/Credit/Note/{id:int}/Detail
Retreive all of the Detail objects for the specified CreditNote.
{id:int}Unique identifier for the CreditNote object.
GETapi/v1/Credit/Note/{id:int}/Render
Retreive all of the Render objects for the specified CreditNote.
{id:int}Unique identifier for the CreditNote object.
POSTapi/v1/Credit/Note/OnDemandRender
Create a new instance of the CreditNote object.
UNKNOWNapi/v1/Credit/Note/Send