TAG LINE
TAG LINE
SMALL TITLE
This entity represents a Credit on an Account.
identity READ-ONLY | "identity": 21 Type: Number This is the unique numeric identifier for the CreditItem |
invoiceItemId | "invoiceItemId": 24 Type: Number Unique identifier for the associated InvoiceItem object. |
invoiceItemName | "invoiceItemName": "Sample Name" Type: String The name of the object associated with the invoiceItemId property. |
showOnInvoice | "showOnInvoice": true Type: Boolean Whether or not this Credit should appear on an Invoice. |
showOnCreditNote | "showOnCreditNote": true Type: Boolean Whether or not this Credit should appear on a Credit Note. |
creditNoteId | "creditNoteId": 22 Type: Number Unique identifier for the associated CreditNote object. |
creditNoteName | "creditNoteName": "Sample Name" Type: String The name of the object associated with the creditNoteId property. |
automaticDisburse | "automaticDisburse": true Type: Boolean Whether or not this Credit should automatically be disbursed to the Account. |
disbursed | "disbursed": true Type: Boolean Whether or not this Credit has been disbursed to the Account. |
GET | Credit/Item/ |
Retrieve all of the CreditItem objects. | |
Retrieve all of the CreditItem objects. GET Credit/Item/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "invoiceItemId": 5, "invoiceItemName": "Sample Text Data", "showOnInvoice": true, "showOnCreditNote": true, "creditNoteId": 11, "creditNoteName": "Sample Text Data", "automaticDisburse": true, "disbursed": true } ] } |
GET | Credit/Item/Paged |
Retrieve all of the CreditItem 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 CreditItem objects in a paged fashion. GET Credit/Item/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, "invoiceItemId": 27, "invoiceItemName": "Sample Text Data", "showOnInvoice": true, "showOnCreditNote": true, "creditNoteId": 9, "creditNoteName": "Sample Text Data", "automaticDisburse": true, "disbursed": true } ] } } |
GET | Credit/Item/{id} |
Retrieve an instance of the CreditItem object by its ID. | |
{id} | Unique identifier for the CreditItem object. |
Retrieve an instance of the CreditItem object by its ID. GET Credit/Item/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "invoiceItemId": 0, "invoiceItemName": "Sample Text Data", "showOnInvoice": true, "showOnCreditNote": true, "creditNoteId": 2, "creditNoteName": "Sample Text Data", "automaticDisburse": true, "disbursed": true } } |