TAG LINE
SMALL TITLE
id | "id": 7 Type: Number This is the unique numeric identifier for the CreditNote |
accountId | "accountId": 2 Type: Number Unique identifier for the associated Account object. |
created | "created": "2005-04-11T14:56:24" Type: Date |
createdByUserId | "createdByUserId": 12 Type: Number Unique identifier for the associated User object. |
templateId | "templateId": 5 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": 2 Type: Number Unique identifier for the associated InvoiceDeliveryType object. |
description | "description": "Hello World" Type: String |
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:
DataFlow PATCH objects:
DELETE | api/v2/Credit/Note/{id:int} |
Delete an instance of the CreditNote object. |
GET | api/v2/Credit/Note |
Retrieve all of the CreditNote objects. |
GET | api/v2/Credit/Note/AvailableTokens |
Retrieve all of the CreditNote objects. |
GET | api/v2/Credit/Note/Paged |
Retreive all of the CreditNote objects in a paged fashion. |
GET | api/v2/Credit/Note/Paged/Detail |
Retreive all of the CreditNote objects in a paged fashion with all object details. |
GET | api/v2/Credit/Note/{id:int} |
Retrieve an instance of the CreditNote object by it's ID. | |
{id:int} | Unique identifier for the CreditNote object. |
GET | api/v2/Credit/Note/{id:int}/Detail |
Retreive all of the Detail objects for the specified CreditNote. | |
{id:int} | Unique identifier for the CreditNote object. |
GET | api/v2/Credit/Note/{id:int}/Render |
Retreive all of the Render objects for the specified CreditNote. | |
{id:int} | Unique identifier for the CreditNote object. |
POST | api/v2/Credit/Note/OnDemandRender |
Create a new instance of the CreditNote object. |
POST | api/v2/Credit/Note/Send |
Create a new instance of the CreditNote object. |