TAG LINE
SMALL TITLE

Invoice / Item / Type

(API Version v4)


A system categorization of different types of Invoice Items. Examples are: recurring, non-recurring, one-time etc.


What can you do with InvoiceItemType?


Properties

Property Details
identity
READ-ONLY
"identity": 21
Type: Number
This is the unique numeric identifier for the InvoiceItemType
name
"name": "Hello World"
Type: String
System defined name for this Invoice Item Type.
baseInvoiceItemTypeId
"baseInvoiceItemTypeId": 3
Type: Number
Unique identifier for the associated BaseInvoiceItemType object.
baseInvoiceItemTypeName
"baseInvoiceItemTypeName": "Sample Name"
Type: String
The name of the object associated with the baseInvoiceItemTypeId property.
invoiceDetail
"invoiceDetail": "Hello World"
Type: String


End Points

GETapi/v4/InvoiceItemType/
Retrieve all of the InvoiceItemType objects.
Retrieve all of the InvoiceItemType objects.
GET api/v4/InvoiceItemType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "baseInvoiceItemTypeId": 20,
            "baseInvoiceItemTypeName": "Sample Text Data",
            "invoiceDetail": "Sample Text Data"
        }
    ]
}
GETapi/v4/InvoiceItemType/Paged
Retrieve all of the InvoiceItemType 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 InvoiceItemType objects in a paged fashion.
GET api/v4/InvoiceItemType/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,
                "name": "Sample Text Data",
                "baseInvoiceItemTypeId": 15,
                "baseInvoiceItemTypeName": "Sample Text Data",
                "invoiceDetail": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/InvoiceItemType/{id}
Retrieve an instance of the InvoiceItemType object by its ID.
{id}Unique identifier for the InvoiceItemType object.
Retrieve an instance of the InvoiceItemType object by its ID.
GET api/v4/InvoiceItemType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Sample Text Data",
        "baseInvoiceItemTypeId": 23,
        "baseInvoiceItemTypeName": "Sample Text Data",
        "invoiceDetail": "Sample Text Data"
    }
}
POSTapi/v4/InvoiceItemType/Search
Retreive a list of InvoiceItemType 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 InvoiceItemType objects based on search criteria.
POST api/v4/InvoiceItemType/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,
            "name": "Sample Text Data",
            "baseInvoiceItemTypeId": 13,
            "baseInvoiceItemTypeName": "Sample Text Data",
            "invoiceDetail": "Sample Text Data"
        }
    ]
}