TAG LINE
SMALL TITLE

Payment / Term Type

(API Version v4)


System defined types of payment terms such as Day of Month, Net or on Due Date.


What can you do with PaymentTermType?


Properties

Property Details
identity
READ-ONLY
"identity": 1
Type: Number
This is the unique numeric identifier for the PaymentTermType
name
READ-ONLY
"name": "Net"
Type: String
System defined name for the Payment Term Type.
sortOrder
READ-ONLY
"sortOrder": 14
Type: Number
Unused


End Points

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