Path: api/v1/quotes
This API is JSON:API compliant.
This endpoint supports the following methods:
GET PATCH
The resource type for this endpoint is Quote
The identifier is quoteno
Supported inclusions are comments,customer,from,ship,stock
The Quote resource type attributes are as follows:
Path: api/v1/quotes?filter[DateIn][-gt]2000-01-01T00%3A00%3A00%2B00%3A00&filter[Status][-eq]Web%20Quote&filter[Current]=T
Supported Filters:
| AccMngNo | Lookup | Attn | Lookup | Branch | Lookup | CardGroups | Group | ||
| Company | Lookup | Contract | Lookup | CurrencyNo | Lookup | Current | Bool | CustNo | Lookup |
| CustRefNo | Text | CustType | Lookup | DateIn | DateRange | DateInEnd | Date | DateInStart | Date |
| DateReq | DateRange | DateReqEnd | Date | DateReqStart | Date | DateValid | DateRange | DateValidEnd | Date |
| DateValidStart | Date | Finish | Bool | FromNo | Lookup | GLDept | Lookup | ItemGroup | Group |
| ItemNo | Lookup | kHasUnreadEmail | Bool | LastModified | DateRange | LastModifiedEnd | Date | LastModifiedStart | Date |
| Make | Text | Model | Text | Name | Lookup | Priority | Text | Probability | Text |
| ProbAction | Text | ProjectGroup | Group | ProjectMaster | Lookup | ProjectNo | Lookup | ProjectType | Lookup |
| QuoteNo | Int | RejectionReasonNo | Lookup | ShipNo | Lookup | Source | Lookup | SourceValue | Text |
| Status | Text | StockGroup | Group | StockNo | Lookup | SubBranch | Lookup | TaxPaid | Bool |
| Type | Text | ValidEnd | Date | ValidStart | Date |
Operators:
| = | Equals |
| [-gte] | GreaterThanOrEqual |
| [-lte] | LessThanOrEqual |
| [-ne] | NotEqual |
| [-lt] | LessThan |
| [-gt] | GreaterThan |
| [-eq] | Equal |
| [-like] | Like |
Response:
{
"data": [
{
"attributes": {
"Status": "Web Quote"
},
"id": "12",
"relationships": {
"comments": {
"data": [
{
"id": "12-7",
"type": "QuoteComment"
},
{
"id": "12-6",
"type": "QuoteComment"
},
{
"id": "12-5",
"type": "QuoteComment"
},
{
"id": "12-4",
"type": "QuoteComment"
},
{
"id": "12-3",
"type": "QuoteComment"
},
{
"id": "12-2",
"type": "QuoteComment"
},
{
"id": "12-1",
"type": "QuoteComment"
}
]
},
"customer": {
"data": {
"id": "3",
"type": "CardFile"
}
},
"from": {
"data": {
"id": "3",
"type": "CardFile"
}
},
"ship": {
"data": {
"id": "28",
"type": "CardFile"
}
},
"stock": {
"data": [
{
"id": "12-3",
"type": "QuoteStock"
},
{
"id": "12-4",
"type": "QuoteStock"
},
{
"id": "12-5",
"type": "QuoteStock"
},
{
"id": "12-6",
"type": "QuoteStock"
},
{
"id": "12-7",
"type": "QuoteStock"
},
{
"id": "12-8",
"type": "QuoteStock"
},
{
"id": "12-9",
"type": "QuoteStock"
},
{
"id": "12-11",
"type": "QuoteStock"
},
{
"id": "12-13",
"type": "QuoteStock"
},
{
"id": "12-15",
"type": "QuoteStock"
},
{
"id": "12-17",
"type": "QuoteStock"
},
{
"id": "12-19",
"type": "QuoteStock"
},
{
"id": "12-21",
"type": "QuoteStock"
},
{
"id": "12-23",
"type": "QuoteStock"
},
{
"id": "12-25",
"type": "QuoteStock"
},
{
"id": "12-27",
"type": "QuoteStock"
}
]
}
},
"type": "Quote"
},
{
"attributes": {
"Status": "Web Quote"
},
"id": "15",
"relationships": {
"comments": {
"data": [
{
"id": "15--1",
"type": "QuoteComment"
},
{
"id": "15-11",
"type": "QuoteComment"
},
{
"id": "15-10",
"type": "QuoteComment"
},
{
"id": "15-9",
"type": "QuoteComment"
},
{
"id": "15-7",
"type": "QuoteComment"
},
{
"id": "15-6",
"type": "QuoteComment"
},
{
"id": "15-5",
"type": "QuoteComment"
},
{
"id": "15-4",
"type": "QuoteComment"
},
{
"id": "15-2",
"type": "QuoteComment"
},
{
"id": "15-1",
"type": "QuoteComment"
}
]
},
"customer": {
"data": {
"id": "12",
"type": "CardFile"
}
},
"from": {
"data": {
"id": "25",
"type": "CardFile"
}
},
"ship": {
"data": {
"id": "12",
"type": "CardFile"
}
},
"stock": {
"data": [
{
"id": "15-5",
"type": "QuoteStock"
},
{
"id": "15-6",
"type": "QuoteStock"
},
{
"id": "15-7",
"type": "QuoteStock"
},
{
"id": "15-8",
"type": "QuoteStock"
}
]
}
},
"type": "Quote"
}
]
}
Path: api/v1/quotes/10?include=stock,comments
Response:
{
"data": {
"id": "10",
"type": "Quote",
"attributes": {
"Status": "Booked"
},
"relationships": {
"customer": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"from": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"ship": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"comments": {
"data": [
{
"type": "QuoteComment",
"id": "1-2"
},
{
"type": "QuoteComment",
"id": "10-1"
}
]
},
"stock": {
"data": [
{
"type": "QuoteStock",
"id": "10-3"
}
]
}
},
"links": {
"self": "/api/v1/quotes/10"
}
},
"included": [
{
"id": "10-3",
"type": "QuoteStock",
"attributes": {
"qty": 1.0,
"suppliedQty": 0.0,
"backorderQty": 0.0,
"unitPrice": 0.0,
"unitPriceTF": 0.0,
"unitPriceTP": 0.0,
"locationCode": "NSW",
"configNo": null,
"addinit": "SYS",
"adddate": "2024-09-02T16:16:00",
"stockId": 6,
"stockCode": "KEYBOARD",
"unit": "EACH",
"description": "Keyboard",
"modifyinit": "SYS",
"modifydate": "2024-09-02T16:17:13"
},
"relationships": {
"stock": {
"data": {
"type": "QuoteStock",
"id": "6"
}
}
}
},
{
"id": "1-2",
"type": "QuoteComment",
"attributes": {
"include": false,
"status": "CANCEL",
"comment": "",
"modifyInit": "API",
"modifyDate": "2025-03-27T13:56:32+11:00"
}
},
{
"id": "1-1",
"type": "QuoteComment",
"attributes": {
"include": false,
"status": "Booked",
"comment": "",
"modifyInit": "SYS",
"modifyDate": "2024-09-02T16:16:21+10:00"
}
}
]
}
Path: api/v1/quotes/10
Request:
{
"data": {
"id": "10",
"type": "Quote",
"attributes": {
"Status": "CANCEL"
}
}
}
Response:
{
"data": {
"id": "10",
"type": "Quote",
"attributes": {
"Status": "CANCEL"
},
"relationships": {
"customer": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"from": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"ship": {
"data": {
"type": "CardFile",
"id": "3"
}
},
"comments": {
"data": [
{
"type": "QuoteComment",
"id": "10-2"
},
{
"type": "QuoteComment",
"id": "10-1"
}
]
},
"stock": {
"data": [
{
"type": "QuoteStock",
"id": "10-3"
}
]
}
},
"links": {
"self": "/api/v1/quotes/10"
}
}
}