TAG LINE
TAG LINE
SMALL TITLE
System statuses of an Invoice Item through the billing pipeline. Examples are: taxes, posted, delivered, rendered, voided etc.
identity READ-ONLY | "identity": 19 Type: Number This is the unique numeric identifier for the InvoiceStatusType |
name | "name": "Hello World" Type: String System defined name for this Invoice Status Type. |
| GET | Invoice/StatusType/ |
| Retrieve all of the InvoiceStatusType objects. | |
Retrieve all of the InvoiceStatusType objects. GET Invoice/StatusType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Sample Text Data"
}
]
} | |
| GET | Invoice/StatusType/Paged |
| Retrieve all of the InvoiceStatusType 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 InvoiceStatusType objects in a paged fashion. GET Invoice/StatusType/Paged 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"
}
]
}
} | |
| GET | Invoice/StatusType/{id} |
| Retrieve an instance of the InvoiceStatusType object by its ID. | |
| {id} | Unique identifier for the InvoiceStatusType object. |
Retrieve an instance of the InvoiceStatusType object by its ID. GET Invoice/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Sample Text Data"
}
} | |