TAG LINE
SMALL TITLE

Credit / Item

(API Version v3)


This entity represents a Credit on an Account.


What can you do with CreditItem?


Properties

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


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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:

  • invoiceItemId
  • showOnInvoice
  • showOnCreditNote
  • creditNoteId
  • automaticDisburse

End Points

GETapi/v3/Credit/Item/
Retrieve all of the CreditItem objects.
Retrieve all of the CreditItem objects.
GET api/v3/Credit/Item/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "invoiceItemId": 6,
            "invoiceItemName": "Sample Text Data",
            "showOnInvoice": true,
            "showOnCreditNote": true,
            "creditNoteId": 1,
            "creditNoteName": "Sample Text Data",
            "automaticDisburse": true,
            "disbursed": true
        }
    ]
}
GETapi/v3/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/v3/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": 8,
                "invoiceItemName": "Sample Text Data",
                "showOnInvoice": true,
                "showOnCreditNote": true,
                "creditNoteId": 18,
                "creditNoteName": "Sample Text Data",
                "automaticDisburse": true,
                "disbursed": true
            }
        ]
    }
}
GETapi/v3/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/v3/Credit/Item/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "invoiceItemId": 23,
        "invoiceItemName": "Sample Text Data",
        "showOnInvoice": true,
        "showOnCreditNote": true,
        "creditNoteId": 10,
        "creditNoteName": "Sample Text Data",
        "automaticDisburse": true,
        "disbursed": true
    }
}