TAG LINE
SMALL TITLE
This entity represents a Credit Note on an Account with related details.
identity READ-ONLY | "identity": 18 Type: Number This is the unique numeric identifier for the CreditNote |
accountId | "accountId": 18 Type: Number Unique identifier for the associated Account object. |
accountName | "accountName": "Sample Name" Type: String The name of the object associated with the accountId property. |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
createdByUserId | "createdByUserId": 1 Type: Number Unique identifier for the associated User object. |
createdByUserName | "createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property. |
templateId | "templateId": 15 Type: Number |
templateName | "templateName": "Sample Name" Type: String The name of the object associated with the templateId property. |
sent | "sent": "2021-04-26T15:25:27.587Z" Type: Date The Date Time stamp for when this Credit Note was sent to the Account Contact. Date and time values are specified in the ISO 8601 format. |
name | "name": "Hello World" Type: String A user defined/friendly name for the Credit Note |
date | "date": "2021-04-26T15:25:27.587Z" Type: Date The date stamp to appear on the Credit Note. Date and time values are specified in the ISO 8601 format. |
invoiceDeliveryTypeId | "invoiceDeliveryTypeId": 23 Type: Number Unique identifier for the associated InvoiceDeliveryType object. |
invoiceDeliveryTypeName | "invoiceDeliveryTypeName": "Sample Name" Type: String The name of the object associated with the invoiceDeliveryTypeId property. |
description | "description": "Hello World" Type: String A user defined/friendly description for the Credit Note |
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:
| DELETE | api/v2/Credit/Note/{id} |
| Delete an instance of the CreditNote object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the CreditNote object. |
Delete an instance of the CreditNote object. DELETE api/v2/Credit/Note/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "creditNote"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v2/Credit/Note/ |
| Retrieve all of the CreditNote objects. | |
Retrieve all of the CreditNote objects. GET api/v2/Credit/Note/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"accountId": 13,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 16,
"createdByUserName": "Sample Text Data",
"templateId": 25,
"templateName": "Sample Text Data",
"sent": "2021-04-26T15:25:27.587Z",
"name": "Sample Text Data",
"date": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryTypeId": 10,
"invoiceDeliveryTypeName": "Sample Text Data",
"description": "Sample Text Data"
}
]
} | |
| GET | api/v2/Credit/Note/Paged |
| Retrieve all of the CreditNote objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the CreditNote objects in a paged fashion. GET api/v2/Credit/Note/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"accountId": 10,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 5,
"createdByUserName": "Sample Text Data",
"templateId": 22,
"templateName": "Sample Text Data",
"sent": "2021-04-26T15:25:27.587Z",
"name": "Sample Text Data",
"date": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryTypeId": 21,
"invoiceDeliveryTypeName": "Sample Text Data",
"description": "Sample Text Data"
}
]
}
} | |
| GET | api/v2/Credit/Note/Paged/Detail |
| Retrieve all of the CreditNote objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the CreditNote objects in a paged fashion with all object details. GET api/v2/Credit/Note/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"accountId": 13,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 9,
"createdByUserName": "Sample Text Data",
"templateId": 20,
"templateName": "Sample Text Data",
"sent": "2021-04-26T15:25:27.587Z",
"name": "Sample Text Data",
"date": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryTypeId": 21,
"invoiceDeliveryTypeName": "Sample Text Data",
"description": "Sample Text Data",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v2/Credit/Note/{id} |
| Retrieve an instance of the CreditNote object by its ID. | |
| {id} | Unique identifier for the CreditNote object. |
Retrieve an instance of the CreditNote object by its ID. GET api/v2/Credit/Note/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"accountId": 15,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 24,
"createdByUserName": "Sample Text Data",
"templateId": 10,
"templateName": "Sample Text Data",
"sent": "2021-04-26T15:25:27.587Z",
"name": "Sample Text Data",
"date": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryTypeId": 25,
"invoiceDeliveryTypeName": "Sample Text Data",
"description": "Sample Text Data"
}
} | |
| GET | api/v2/Credit/Note/{id}/Detail |
| Retrieve deep detail of the CreditNote object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the CreditNote object. |
Retrieve deep detail of the CreditNote object by its ID. GET api/v2/Credit/Note/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"accountId": 17,
"accountName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 18,
"createdByUserName": "Sample Text Data",
"templateId": 11,
"templateName": "Sample Text Data",
"sent": "2021-04-26T15:25:27.587Z",
"name": "Sample Text Data",
"date": "2021-04-26T15:25:27.587Z",
"invoiceDeliveryTypeId": 9,
"invoiceDeliveryTypeName": "Sample Text Data",
"description": "Sample Text Data",
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| GET | api/v2/Credit/Note/{id}/Render |
| Returns the byte array of the PDF version of the specified CreditNote | |
| {id} | Unique identifier for the CreditNote object. |
| POST | api/v2/Credit/Note/OnDemandRender |
| Imediately initiates the rendering of a specified CreditNote. | |
| POST | api/v2/Credit/Note/Send |
| Delivers the specified CreditNote to the proper recipient. | |