GET api/GetConnote?query={query}

Request Information

URI Parameters

Name	Description	Type	Additional information
query		string	Required

Body Parameters

None.

Response Information

Resource Description

ConnoteDto

Name	Type	Additional information
ConsignmentID	integer	Required
ClientID	integer	Required
ConsignmentItems	Collection of ItemDto	None.
InvoiceID	integer	None.
ViperID	integer	None.
ConsignmentNo	string	String length: inclusive between 0 and 15
Shipper	SiteDto	None.
Customer	SiteDto	Required
Receiver	SiteDto	None.
FromDepot	SiteDto	None.
ToDepot	SiteDto	None.
Pickup	SiteDto	None.
Deliver	SiteDto	None.
CustomerReferences	Collection of ReferenceDto	None.
ShipperReferences	Collection of ReferenceDto	None.
ReceiverReferences	Collection of ReferenceDto	None.
WarehouseReferences	Collection of ReferenceDto	None.
LoadReference	string	String length: inclusive between 0 and 15
Status	string	String length: inclusive between 0 and 10
FinancialStatus	string	String length: inclusive between 0 and 10
PalletTransferNo	string	String length: inclusive between 0 and 25
TransferTo	string	String length: inclusive between 0 and 25
DepartDate	date	Required
DepartTime	date	None.
DueDate	date	Required
DueTime	date	None.
DateDeparted	date	None.
DateReceived	date	None.
AllocatorNotes	string	String length: inclusive between 0 and 255
TenderPriceExGST	decimal number	None.
TenderPriceIncGST	decimal number	None.
TenderDate	date	None.
TenderLoadId	string	String length: inclusive between 0 and 15
TotalValueIncGST	decimal number	None.
TotalValueExGST	decimal number	None.
Notes	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ConsignmentID": 1,
  "ClientID": 2,
  "ConsignmentItems": [
    {
      "Quantity": 1,
      "Description": "sample string 1",
      "Containers": 1,
      "ContainerType": "sample string 2",
      "Container": {
        "ID": 1,
        "Description": "sample string 1"
      },
      "Net": 1.1,
      "Gross": 1.1,
      "Size": 1.1,
      "ClassId": 1,
      "Class": {
        "ID": 1,
        "Description": "sample string 1"
      },
      "Unit": {
        "ID": 1,
        "Description": "sample string 1"
      },
      "UseByDate": "2025-12-06T15:59:34.2182774+10:30",
      "BatchNo": "sample string 3",
      "Temperature": 1.1,
      "PalletDocket": "sample string 4",
      "Spaces": 1.1,
      "Length": 1.0,
      "Width": 1.0,
      "Height": 1.0,
      "Volume": 1.0,
      "CubicFactor": 1,
      "CubicKg": 1,
      "ID": 1
    },
    {
      "Quantity": 1,
      "Description": "sample string 1",
      "Containers": 1,
      "ContainerType": "sample string 2",
      "Container": {
        "ID": 1,
        "Description": "sample string 1"
      },
      "Net": 1.1,
      "Gross": 1.1,
      "Size": 1.1,
      "ClassId": 1,
      "Class": {
        "ID": 1,
        "Description": "sample string 1"
      },
      "Unit": {
        "ID": 1,
        "Description": "sample string 1"
      },
      "UseByDate": "2025-12-06T15:59:34.2182774+10:30",
      "BatchNo": "sample string 3",
      "Temperature": 1.1,
      "PalletDocket": "sample string 4",
      "Spaces": 1.1,
      "Length": 1.0,
      "Width": 1.0,
      "Height": 1.0,
      "Volume": 1.0,
      "CubicFactor": 1,
      "CubicKg": 1,
      "ID": 1
    }
  ],
  "InvoiceID": 1,
  "ViperID": 3,
  "ConsignmentNo": "sample string 4",
  "Shipper": {
    "ClientID": 1,
    "Description": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Contact": "sample string 5",
    "Phone": "sample string 6",
    "Fax": "sample string 7",
    "Mobile": "sample string 8",
    "Notes": "sample string 9",
    "Email": "sample string 10",
    "Suburb": "sample string 11",
    "Postcode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "CarrierSiteID": "sample string 15",
    "LocationID": 1,
    "ViperSiteID": 16,
    "PickupAllowBefore": 1.0,
    "PickupAllowAfter": 1.0,
    "DeliverAllowBefore": 1.0,
    "DeliverAllowAfter": 1.0
  },
  "Customer": {
    "ClientID": 1,
    "Description": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Contact": "sample string 5",
    "Phone": "sample string 6",
    "Fax": "sample string 7",
    "Mobile": "sample string 8",
    "Notes": "sample string 9",
    "Email": "sample string 10",
    "Suburb": "sample string 11",
    "Postcode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "CarrierSiteID": "sample string 15",
    "LocationID": 1,
    "ViperSiteID": 16,
    "PickupAllowBefore": 1.0,
    "PickupAllowAfter": 1.0,
    "DeliverAllowBefore": 1.0,
    "DeliverAllowAfter": 1.0
  },
  "Receiver": {
    "ClientID": 1,
    "Description": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Contact": "sample string 5",
    "Phone": "sample string 6",
    "Fax": "sample string 7",
    "Mobile": "sample string 8",
    "Notes": "sample string 9",
    "Email": "sample string 10",
    "Suburb": "sample string 11",
    "Postcode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "CarrierSiteID": "sample string 15",
    "LocationID": 1,
    "ViperSiteID": 16,
    "PickupAllowBefore": 1.0,
    "PickupAllowAfter": 1.0,
    "DeliverAllowBefore": 1.0,
    "DeliverAllowAfter": 1.0
  },
  "FromDepot": {
    "ClientID": 1,
    "Description": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Contact": "sample string 5",
    "Phone": "sample string 6",
    "Fax": "sample string 7",
    "Mobile": "sample string 8",
    "Notes": "sample string 9",
    "Email": "sample string 10",
    "Suburb": "sample string 11",
    "Postcode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "CarrierSiteID": "sample string 15",
    "LocationID": 1,
    "ViperSiteID": 16,
    "PickupAllowBefore": 1.0,
    "PickupAllowAfter": 1.0,
    "DeliverAllowBefore": 1.0,
    "DeliverAllowAfter": 1.0
  },
  "ToDepot": {
    "ClientID": 1,
    "Description": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Contact": "sample string 5",
    "Phone": "sample string 6",
    "Fax": "sample string 7",
    "Mobile": "sample string 8",
    "Notes": "sample string 9",
    "Email": "sample string 10",
    "Suburb": "sample string 11",
    "Postcode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "CarrierSiteID": "sample string 15",
    "LocationID": 1,
    "ViperSiteID": 16,
    "PickupAllowBefore": 1.0,
    "PickupAllowAfter": 1.0,
    "DeliverAllowBefore": 1.0,
    "DeliverAllowAfter": 1.0
  },
  "Pickup": {
    "ClientID": 1,
    "Description": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Contact": "sample string 5",
    "Phone": "sample string 6",
    "Fax": "sample string 7",
    "Mobile": "sample string 8",
    "Notes": "sample string 9",
    "Email": "sample string 10",
    "Suburb": "sample string 11",
    "Postcode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "CarrierSiteID": "sample string 15",
    "LocationID": 1,
    "ViperSiteID": 16,
    "PickupAllowBefore": 1.0,
    "PickupAllowAfter": 1.0,
    "DeliverAllowBefore": 1.0,
    "DeliverAllowAfter": 1.0
  },
  "Deliver": {
    "ClientID": 1,
    "Description": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Contact": "sample string 5",
    "Phone": "sample string 6",
    "Fax": "sample string 7",
    "Mobile": "sample string 8",
    "Notes": "sample string 9",
    "Email": "sample string 10",
    "Suburb": "sample string 11",
    "Postcode": "sample string 12",
    "State": "sample string 13",
    "Country": "sample string 14",
    "CarrierSiteID": "sample string 15",
    "LocationID": 1,
    "ViperSiteID": 16,
    "PickupAllowBefore": 1.0,
    "PickupAllowAfter": 1.0,
    "DeliverAllowBefore": 1.0,
    "DeliverAllowAfter": 1.0
  },
  "CustomerReferences": [
    {
      "Reference": "sample string 1",
      "DocumentRequired": true,
      "ID": 1
    },
    {
      "Reference": "sample string 1",
      "DocumentRequired": true,
      "ID": 1
    }
  ],
  "ShipperReferences": [
    {
      "Reference": "sample string 1",
      "DocumentRequired": true,
      "ID": 1
    },
    {
      "Reference": "sample string 1",
      "DocumentRequired": true,
      "ID": 1
    }
  ],
  "ReceiverReferences": [
    {
      "Reference": "sample string 1",
      "DocumentRequired": true,
      "ID": 1
    },
    {
      "Reference": "sample string 1",
      "DocumentRequired": true,
      "ID": 1
    }
  ],
  "WarehouseReferences": [
    {
      "Reference": "sample string 1",
      "DocumentRequired": true,
      "ID": 1
    },
    {
      "Reference": "sample string 1",
      "DocumentRequired": true,
      "ID": 1
    }
  ],
  "LoadReference": "sample string 5",
  "Status": "sample string 6",
  "FinancialStatus": "sample string 7",
  "PalletTransferNo": "sample string 8",
  "TransferTo": "sample string 9",
  "DepartDate": "2025-12-06T15:59:34.2222813+10:30",
  "DepartTime": "2025-12-06T15:59:34.2222813+10:30",
  "DueDate": "2025-12-06T15:59:34.2222813+10:30",
  "DueTime": "2025-12-06T15:59:34.2222813+10:30",
  "DateDeparted": "2025-12-06T15:59:34.2222813+10:30",
  "DateReceived": "2025-12-06T15:59:34.2222813+10:30",
  "AllocatorNotes": "sample string 10",
  "TenderPriceExGST": 1.0,
  "TenderPriceIncGST": 1.0,
  "TenderDate": "2025-12-06T15:59:34.2222813+10:30",
  "TenderLoadId": "sample string 11",
  "TotalValueIncGST": 1.0,
  "TotalValueExGST": 1.0,
  "Notes": "sample string 12"
}

GET api/GetConnote?query={query}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

URI parameters

Headers | Add header

Body

Status

Headers

Body