TAG LINE
SMALL TITLE

Credit / Item

(API Version v4)


This entity represents a Credit on an Account.


What can you do with CreditItem?


Properties

Property Details
identity
READ-ONLY
"identity": 4
Type: Number
This is the unique numeric identifier for the CreditItem
invoiceItemId
"invoiceItemId": 13
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": 10
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.


End Points

GETapi/v4/Credit/Item/
Retrieve all of the CreditItem objects.
Retrieve all of the CreditItem objects.
GET api/v4/Credit/Item/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "invoiceItemId": 8,
            "invoiceItemName": "Sample Text Data",
            "showOnInvoice": true,
            "showOnCreditNote": true,
            "creditNoteId": 26,
            "creditNoteName": "Sample Text Data",
            "automaticDisburse": true,
            "disbursed": true
        }
    ]
}
GETapi/v4/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 api/v4/Credit/Item/Paged
View Sample Response
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": 27,
                "creditNoteName": "Sample Text Data",
                "automaticDisburse": true,
                "disbursed": true
            }
        ]
    }
}
GETapi/v4/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 api/v4/Credit/Item/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "invoiceItemId": 13,
        "invoiceItemName": "Sample Text Data",
        "showOnInvoice": true,
        "showOnCreditNote": true,
        "creditNoteId": 23,
        "creditNoteName": "Sample Text Data",
        "automaticDisburse": true,
        "disbursed": true
    }
}
POSTapi/v4/Credit/Item/Search
Retreive a list of CreditItem objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of CreditItem objects based on search criteria.
POST api/v4/Credit/Item/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "invoiceItemId": 9,
            "invoiceItemName": "Sample Text Data",
            "showOnInvoice": true,
            "showOnCreditNote": true,
            "creditNoteId": 26,
            "creditNoteName": "Sample Text Data",
            "automaticDisburse": true,
            "disbursed": true
        }
    ]
}