TAG LINE
TAG LINE
SMALL TITLE

Invoice Delivery Type

(API Version v4)


System defined delivery type such as "email" or "offline".


What can you do with InvoiceDeliveryType?


Properties

Property Details
identity
READ-ONLY
"identity": 24
Type: Number
This is the unique numeric identifier for the InvoiceDeliveryType
name
READ-ONLY
"name": "Hello World"
Type: String
System defined name for this Delivery Type.
sortOrder
READ-ONLY
"sortOrder": 3
Type: Number
Unused


End Points

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