Maxpanda API V1 API Reference

The Maxpanda API documentation for version 1

API Endpoint
http://app.maxpanda.com
Terms of Service: Documented Online
Schemes: http
Version: v1

Authentication

Authorization

API Key Authentication

type
apiKey
name
Authorization
in
header

Asset Status

Get a paged list of Asset Status

GET /api/v1/Company/AssetStatuses

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "AssetStatusId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Asset Status record

GET /api/v1/Company/AssetStatuses/id
id: integer (int32)
in query

The Asset Status id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Asset Status was found

404 Not Found

the Asset Status was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "AssetStatusId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Assets

Get a list of Assets

GET /api/v1/Assets

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetId": "integer (int32)",
      "Name": "string",
      "Model": "string",
      "AssetTypeRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetStatusRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetTag": "string",
      "SerialNumber": "string",
      "Manufacture": "string",
      "ManufactureInfo": "string",
      "PreferredSupplier": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "VendorInfo": "string",
      "InstallationDate": "string (date-time)",
      "WarrantyDate": "string (date-time)",
      "WarrantyNotesLabor": "string",
      "WarrantyNotesParts": "string",
      "Notes": "string",
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "UserRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PartRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "MeteringTypeRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetAuditsRef": [
        {
          "AssetAuditId": "integer (int32)",
          "AssignedTo": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "AssignedBy": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "ReleasedBy": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "AllocatedOn": "string (date-time)",
          "ReleasedOn": "string (date-time)"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Asset

GET /api/v1/Asset/id
id: integer (int32)
in query

The asset id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the asset was found

404 Not Found

the asset was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetId": "integer (int32)",
      "Name": "string",
      "Model": "string",
      "AssetTypeRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetStatusRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetTag": "string",
      "SerialNumber": "string",
      "Manufacture": "string",
      "ManufactureInfo": "string",
      "PreferredSupplier": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "VendorInfo": "string",
      "InstallationDate": "string (date-time)",
      "WarrantyDate": "string (date-time)",
      "WarrantyNotesLabor": "string",
      "WarrantyNotesParts": "string",
      "Notes": "string",
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "UserRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PartRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "MeteringTypeRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetAuditsRef": [
        {
          "AssetAuditId": "integer (int32)",
          "AssignedTo": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "AssignedBy": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "ReleasedBy": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "AllocatedOn": "string (date-time)",
          "ReleasedOn": "string (date-time)"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update an Asset

PUT /api/v1/Asset

Details of the Asset

Request Content-Types: application/json, text/json
Request Example
{
  "siteId": "integer (int32)",
  "AssetId": "integer (int32)",
  "Name": "string",
  "Description": "string",
  "Model": "string",
  "AssetTypeId": "integer (int32)",
  "AssetStatusId": "integer (int32)",
  "AssetTag": "string",
  "SerialNumber": "string",
  "Manufacturer": "string",
  "ManufacturerInfo": "string",
  "PreferredVendorId": "integer (int32)",
  "VendorInfo": "string",
  "InstallationDate": "string (date-time)",
  "WarrantyDate": "string (date-time)",
  "WarrantyNotesParts": "string",
  "WarrantyNotesLabor": "string",
  "AddCC": "string",
  "Notes": "string",
  "IsMobileAsset": "boolean",
  "BuildingGroupId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "LocationId": "integer (int32)",
  "AssignedUserId": "integer (int32)",
  "PurchaseCost": "number (double)",
  "SalvageCost": "number (double)",
  "UsefulLifeInYears": "number (double)",
  "DepreciationRate": "number (double)",
  "PartsIds": [
    "integer (int32)"
  ],
  "MeteringIds": [
    "integer (int32)"
  ]
}

the asset was updated

404 Not Found

the asset was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "AssetId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create an Asset

POST /api/v1/Asset

Details of the new Asset

Request Content-Types: application/json, text/json
Request Example
{
  "siteId": "integer (int32)",
  "Name": "string",
  "Description": "string",
  "Model": "string",
  "AssetTypeId": "integer (int32)",
  "AssetStatusId": "integer (int32)",
  "AssetTag": "string",
  "SerialNumber": "string",
  "Manufacturer": "string",
  "ManufacturerInfo": "string",
  "PreferredVendorId": "integer (int32)",
  "VendorInfo": "string",
  "InstallationDate": "string (date-time)",
  "WarrantyDate": "string (date-time)",
  "WarrantyNotesParts": "string",
  "WarrantyNotesLabor": "string",
  "AddCC": "string",
  "Notes": "string",
  "IsMobileAsset": "boolean",
  "BuildingGroupId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "LocationId": "integer (int32)",
  "AssignedUserId": "integer (int32)",
  "PurchaseCost": "number (double)",
  "SalvageCost": "number (double)",
  "UsefulLifeInYears": "number (double)",
  "DepreciationRate": "number (double)",
  "PartsIds": [
    "integer (int32)"
  ],
  "MeteringIds": [
    "integer (int32)"
  ]
}

the asset was found

404 Not Found

the asset was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "AssetId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Asset Type

Get a paged list of Asset Types

GET /api/v1/Company/AssetTypes

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "AssetTypeId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "WOThresholdPeriod": "integer (int32)",
      "WOThresholdLimit": "integer (int32)"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Asset Type type record

GET /api/v1/Company/AssetTypes/id
id: integer (int32)
in query

TheAsset Type id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the asset type was found

404 Not Found

the asset type was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "AssetTypeId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "WOThresholdPeriod": "integer (int32)",
      "WOThresholdLimit": "integer (int32)"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Bins

Get list of Bins

GET /api/v1/Bins

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BinId": "integer (int32)",
      "Name": "string",
      "BinNumber": "string",
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PartsRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "Notes": "string",
      "Description": "string"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update a Bin

PUT /api/v1/Bins

Details of the Bin

Request Content-Types: application/json, text/json
Request Example
{
  "BinId": "integer (int32)",
  "Name": "string",
  "BinNumber": "string",
  "Sites": [
    "integer (int32)"
  ],
  "BuildingId": "integer (int32)",
  "LocationId": "integer (int32)",
  "Notes": "string",
  "Description": "string",
  "PartsId": [
    "integer (int32)"
  ],
  "SendReorderEmail": "boolean"
}

the bin was updated

404 Not Found

some thing went wrong

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "BinId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create a Bin

POST /api/v1/Bins

Details of the new Bin

Request Content-Types: application/json, text/json
Request Example
{
  "Name": "string",
  "BinNumber": "string",
  "Sites": [
    "integer (int32)"
  ],
  "BuildingId": "integer (int32)",
  "LocationId": "integer (int32)",
  "Notes": "string",
  "Description": "string",
  "SendReorderEmail": "boolean"
}

the bin was created

404 Not Found

some thing went wrong

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "BinId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Get a specific Bin

GET /api/v1/Bins/id
id: integer (int32)
in query

The Bin id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Bin was found

404 Not Found

the Bin was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BinId": "integer (int32)",
      "Name": "string",
      "BinNumber": "string",
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PartsRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "Notes": "string",
      "Description": "string"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Buildings

Get a paged list of buildings

GET /api/v1/Buildings

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingId": "string",
      "Name": "string",
      "Description": "string",
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Building

GET /api/v1/Building/id
id: integer (int32)
in query

The building id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the building was found

404 Not Found

the building was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingId": "string",
      "Name": "string",
      "Description": "string",
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Create a new Building

POST /api/v1/Building

Details of the new Building

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "Name": "string",
  "Description": "string",
  "BuildingGroupId": "integer (int32)",
  "BuildingAddress": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "LocationsId": [
    "integer (int32)"
  ],
  "Archived": "boolean"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "BuildingId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Update specific attributes of a given building

PATCH /api/v1/Building

Building details can be found in Building API

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "Name": "string",
  "Description": "string",
  "BuildingGroupId": "integer (int32)",
  "BuildingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "LocationsId": [
    "integer (int32)"
  ],
  "Archived": "boolean"
}

the building was patched

404 Not Found

the building was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "BuildingId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Customer

Update an existing customer.

PUT /api/v1/Customer

The customer to be updated

Request Content-Types: application/json, text/json
Request Example
{
  "SitesId": [
    "integer (int32)"
  ],
  "CustomerId": "integer (int32)",
  "FirstName": "string",
  "LastName": "string",
  "Email": "string",
  "CompanyName": "string",
  "PhoneNumber": "string",
  "MobileNumber": "string",
  "Fax": "string",
  "Other": "string",
  "WebSite": "string",
  "Notes": "string",
  "BillingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "ShippingAddressSameAsBilling": "boolean",
  "ShippingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  }
}

The customer was updated

404 Not Found

The customer was not found, update failed

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "CustomerId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create a new customer

POST /api/v1/Customer

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

The Customer to be added

Request Content-Types: application/json, text/json
Request Example
{
  "SitesId": [
    "integer (int32)"
  ],
  "FirstName": "string",
  "LastName": "string",
  "Email": "string",
  "CompanyName": "string",
  "PhoneNumber": "string",
  "MobileNumber": "string",
  "Fax": "string",
  "Other": "string",
  "WebSite": "string",
  "Notes": "string",
  "BillingAddress": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "ShippingAddressSameAsBilling": "boolean",
  "ShippingAddress": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  }
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "CustomerId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Get a paged list of Customers

GET /api/v1/Customers

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CustomerId": "integer (int32)",
      "FirstName": "string",
      "LastName": "string",
      "CompanyName": "string",
      "Email": "string",
      "Phone": "string",
      "Mobile": "string",
      "Notes": "string",
      "BillingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "ShippingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "ShippingAddressSameAsBilling": "boolean"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific

GET /api/v1/Customer/id
id: integer (int32)
in query

The customer id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the User was found

404 Not Found

the User was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CustomerId": "integer (int32)",
      "FirstName": "string",
      "LastName": "string",
      "CompanyName": "string",
      "Email": "string",
      "Phone": "string",
      "Mobile": "string",
      "Notes": "string",
      "BillingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "ShippingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "ShippingAddressSameAsBilling": "boolean"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Customer Invoices

Get list of Customer Invoices

GET /api/v1/GetCustomerInvoices
requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "InvoiceId": "integer (int32)",
      "InvoiceNumber": "string",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "InvoiceDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "TotalAmount": "number (double)",
      "Description": "string",
      "InvoiceTypeRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "ItemId": "integer (int32)",
          "Quantity": "number (double)",
          "UnitPrice": "number (double)"
        }
      ],
      "InvoiceTaxRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "WorkorderRef": [
        {
          "Id": "integer (int32)",
          "Title": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Customer Invoice

GET /api/v1/GetCustomerInvoice/id
id: integer (int32)
in query

Invoice ID can be found in your Maxpanda Customer Invoice index or Customer Invoice API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the invoice was found

404 Not Found

the invoice was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "InvoiceId": "integer (int32)",
      "InvoiceNumber": "string",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "InvoiceDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "TotalAmount": "number (double)",
      "Description": "string",
      "InvoiceTypeRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "ItemId": "integer (int32)",
          "Quantity": "number (double)",
          "UnitPrice": "number (double)"
        }
      ],
      "InvoiceTaxRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "WorkorderRef": [
        {
          "Id": "integer (int32)",
          "Title": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update Customer Invoice

PUT /api/v1/CustomerInvoice
Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "CustomerInvoiceId": "integer (int32)",
  "CustomerId": "integer (int32)",
  "InvoiceNumber": "string",
  "Archived": "boolean",
  "InvoiceDate": "string (date-time)",
  "DueDate": "string (date-time)",
  "InvoiceItems": [
    {
      "InvoiceItemTypeId": "integer (int32)",
      "InvoiceItemTypeName": "string",
      "Description": "string",
      "UnitPrice": "number (double)",
      "Quantity": "number (double)"
    }
  ],
  "InvoiceTaxes": [
    {
      "InvoiceTaxId": "integer (int32)",
      "TaxRate": "number (double)"
    }
  ]
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "InvoiceId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create a new customer invoice.

POST /api/v1/CustomerInvoice

The Customer invoice to be added

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "CustomerId": "integer (int32)",
  "InvoiceNumber": "string",
  "Archived": "boolean",
  "InvoiceDate": "string (date-time)",
  "DueDate": "string (date-time)",
  "InvoiceItems": [
    {
      "InvoiceItemTypeId": "integer (int32)",
      "InvoiceItemTypeName": "string",
      "Description": "string",
      "UnitPrice": "number (double)",
      "Quantity": "number (double)"
    }
  ],
  "InvoiceTaxes": [
    {
      "InvoiceTaxId": "integer (int32)",
      "TaxRate": "number (double)"
    }
  ]
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "InvoiceId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Department

Get a paged list of departments

GET /api/v1/Company/Departments

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "BuildingGroupId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Department type record

GET /api/v1/Company/Department/id
id: integer (int32)
in query

Id of the Building Group to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the department was found

404 Not Found

the department was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "BuildingGroupId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Invoice Item Type

Get a paged list of Invoice Item Types

GET /api/v1/Company/InvoiceItemTypes

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "InvoiceItemTypeId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Invoice Item Type record

GET /api/v1/Company/InvoiceItemType/id
id: integer (int32)
in query

TheInvoice Item Type id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Invoice Item Type was found

404 Not Found

the Invoice Item Type was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "InvoiceItemTypeId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Invoice Item Tax

Get a paged list of Invoice Taxes

GET /api/v1/Company/InvoiceTaxes

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "InvoiceTaxPreferenceId": "integer (int32)",
      "TaxName": "string",
      "TaxRate": "number (double)",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Invoice Tax record

GET /api/v1/Company/InvoiceTax/id
id: integer (int32)
in query

The Invoice Tax Id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Invoice Tax was found

404 Not Found

the Invoice Tax Type was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "InvoiceTaxPreferenceId": "integer (int32)",
      "TaxName": "string",
      "TaxRate": "number (double)",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Location

Get a list of locations

GET /api/v1/Locations

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteId": "integer (int32)",
      "Name": "string",
      "LocationTypeId": "integer (int32)",
      "BuildingId": "integer (int32)",
      "Description": "string",
      "VendorsId": [
        "integer (int32)"
      ],
      "ContactName": "string",
      "PhoneNumber": "string",
      "ContactEmail": "string",
      "ExternalEmail": "string",
      "Archive": "boolean",
      "CompanyAddress": {
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      }
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific location

GET /api/v1/Location/id
id: integer (int32)
in query

The location id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the location was found

404 Not Found

the location was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteId": "integer (int32)",
      "Name": "string",
      "LocationTypeId": "integer (int32)",
      "BuildingId": "integer (int32)",
      "Description": "string",
      "VendorsId": [
        "integer (int32)"
      ],
      "ContactName": "string",
      "PhoneNumber": "string",
      "ContactEmail": "string",
      "ExternalEmail": "string",
      "Archive": "boolean",
      "CompanyAddress": {
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      }
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update a location

PUT /api/v1/Location

Details of the new location

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "LocationId": "integer (int32)",
  "Name": "string",
  "LocationTypeId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "Description": "string",
  "VendorsId": [
    "integer (int32)"
  ],
  "ContactName": "string",
  "PhoneNumber": "string",
  "ContactEmail": "string",
  "ExternalEmail": "string",
  "Archive": "boolean",
  "CompanyAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  }
}

The new location was created

404 Not Found

Failed to create new location

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "LocationId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create a location

POST /api/v1/Location

Details of the new location

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "Name": "string",
  "LocationTypeId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "Description": "string",
  "VendorsId": [
    "integer (int32)"
  ],
  "ContactName": "string",
  "PhoneNumber": "string",
  "ContactEmail": "string",
  "ExternalEmail": "string",
  "Archive": "boolean",
  "CompanyAddress": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  }
}

The new location was created

404 Not Found

Failed to create new location

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "LocationId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Location Type

Get a paged list of Location Types

GET /api/v1/Company/LocationTypes

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "LocationTypeId": "integer (int32)",
      "Name": "string",
      "WOThresholdPeriod": "integer (int32)",
      "WOThresholdLimit": "integer (int32)",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific location type record

GET /api/v1/Company/LocationTypes/id
id: integer (int32)
in query

The location type id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the location type was found

404 Not Found

the location type was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "LocationTypeId": "integer (int32)",
      "Name": "string",
      "WOThresholdPeriod": "integer (int32)",
      "WOThresholdLimit": "integer (int32)",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Metering Type

Get a paged list of Metering Types

GET /api/v1/Company/MeteringTypes

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "MeteringTypeId": "integer (int32)",
      "Name": "string",
      "Description": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "TaskRefs": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Metering Type record

GET /api/v1/Company/MeteringTypes/id
id: integer (int32)
in query

The Metering Types id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Metering Type was found

404 Not Found

the Metering Type was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "MeteringTypeId": "integer (int32)",
      "Name": "string",
      "Description": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "TaskRefs": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Parts

GET /api/v1/PartTypes

page: integer (int32)
in query

(no description)

pageSize: integer (int32)
in query

(no description)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "PartTypeValue": "integer (int32)",
      "Name": "string"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a list of parts

GET /api/v1/Parts

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PartId": "integer (int32)",
      "Name": "string",
      "PartNumber": "string",
      "PartStatusRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PatTypeRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "Manufacture": "string",
      "UPC": "string",
      "PreferredSupplierRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "UnitPrice": "number (double)",
      "CurrentPartCost": "number (double)",
      "LastPartCost": "number (double)",
      "AveragePartCost": "number (double)",
      "OEM": "string",
      "OEM1": "string",
      "OEM2": "string",
      "OEM3": "string",
      "OEMSupplier1Ref": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "OEMSupplier2Ref": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "OEMSupplier3Ref": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "QtyInBins": "number (double)",
      "QtyInInventory": "number (double)",
      "QtyAllocated": "number (double)",
      "QtyInTransit": "number (double)",
      "MinimumLevel": "string",
      "MaximumLevel": "string",
      "QtyOnOrder": "number (double)",
      "InstallationDate": "string (date-time)",
      "WarrantyDate": "string (date-time)",
      "WarrantyNotesParts": "string",
      "WarrantyNotesLabor": "string",
      "Notes": "string",
      "StorageLocationRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "POTemplateRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BinsRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "DecreaseQty": "number (double)",
          "PartsInBin": "number (double)",
          "MinimumLevel": "number (double)",
          "IncreaseQty": "number (double)",
          "ClosedWorkorderQty": "number (double)"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Part

GET /api/v1/Part/id
id: integer (int32)
in query

The Part id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Part was found

404 Not Found

the Part was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PartId": "integer (int32)",
      "Name": "string",
      "PartNumber": "string",
      "PartStatusRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PatTypeRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "Manufacture": "string",
      "UPC": "string",
      "PreferredSupplierRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "UnitPrice": "number (double)",
      "CurrentPartCost": "number (double)",
      "LastPartCost": "number (double)",
      "AveragePartCost": "number (double)",
      "OEM": "string",
      "OEM1": "string",
      "OEM2": "string",
      "OEM3": "string",
      "OEMSupplier1Ref": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "OEMSupplier2Ref": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "OEMSupplier3Ref": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "QtyInBins": "number (double)",
      "QtyInInventory": "number (double)",
      "QtyAllocated": "number (double)",
      "QtyInTransit": "number (double)",
      "MinimumLevel": "string",
      "MaximumLevel": "string",
      "QtyOnOrder": "number (double)",
      "InstallationDate": "string (date-time)",
      "WarrantyDate": "string (date-time)",
      "WarrantyNotesParts": "string",
      "WarrantyNotesLabor": "string",
      "Notes": "string",
      "StorageLocationRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "POTemplateRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BinsRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "DecreaseQty": "number (double)",
          "PartsInBin": "number (double)",
          "MinimumLevel": "number (double)",
          "IncreaseQty": "number (double)",
          "ClosedWorkorderQty": "number (double)"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update a Part

PUT /api/v1/Part

Details of Part

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "PartId": "integer (int32)",
  "PartName": "string",
  "PartNumber": "string",
  "PartStatusId": "integer (int32)",
  "PartTypeId": "integer (int32)",
  "Manufracturer": "string",
  "UPC": "string",
  "PreferredSupplierId": "integer (int32)",
  "OEM1": "string",
  "OEM2": "string",
  "OEM3": "string",
  "PreferredOEM1SupplierId": "integer (int32)",
  "PreferredOEM2SupplierId": "integer (int32)",
  "PreferredOEM3SupplierId": "integer (int32)",
  "SupplierInfo": "string",
  "IncreaseQty": "number (double)",
  "DecreaseQty": "number (double)",
  "PartCost": "number (double)",
  "SalesPrice": "number (double)",
  "MinimumLevel": "number (double)",
  "MaximumLevel": "number (double)",
  "Notes": "string",
  "InstallationDate": "string (date-time)",
  "WarrantyDate": "string (date-time)",
  "WarrantyNotesLabour": "string",
  "WarrantyNotesParts": "string",
  "StorageLocation": "integer (int32)",
  "AssignedAsset": [
    "integer (int32)"
  ],
  "BinPartsRef": [
    {
      "BinId": "integer (int32)",
      "IncreaseQty": "number (double)",
      "DecreaseQty": "number (double)",
      "MinimumLevel": "number (double)"
    }
  ],
  "PurchaseOrderTemplateId": "integer (int32)"
}

the part is updated

404 Not Found

some thing went wrong

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "PartId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create a new Part

POST /api/v1/Part

Details of new Part

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "PartName": "string",
  "PartNumber": "string",
  "PartStatusId": "integer (int32)",
  "PartTypeId": "integer (int32)",
  "Manufracturer": "string",
  "UPC": "string",
  "PreferredSupplierId": "integer (int32)",
  "OEM1": "string",
  "OEM2": "string",
  "OEM3": "string",
  "PreferredOEM1SupplierId": "integer (int32)",
  "PreferredOEM2SupplierId": "integer (int32)",
  "PreferredOEM3SupplierId": "integer (int32)",
  "SupplierInfo": "string",
  "IncreaseQty": "number (double)",
  "DecreaseQty": "number (double)",
  "PartCost": "number (double)",
  "SalesPrice": "number (double)",
  "MinimumLevel": "number (double)",
  "MaximumLevel": "number (double)",
  "Notes": "string",
  "InstallationDate": "string (date-time)",
  "WarrantyDate": "string (date-time)",
  "WarrantyNotesLabour": "string",
  "WarrantyNotesParts": "string",
  "StorageLocation": "integer (int32)",
  "AssignedAsset": [
    "integer (int32)"
  ]
}

the part is created

404 Not Found

some thing went wrong

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "PartId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Part Status

Get a paged list of Parts Status

GET /api/v1/Company/PartStatuses

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "PartStatusId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Part Status record

GET /api/v1/Company/PartStatuses/{id}
id: integer (int32)
in path

The Part Status id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Part Status was found

404 Not Found

the Part Status was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "PartStatusId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

PO Address

GET /api/v1/Company/POAddress

siteId: integer (int32)
in query

(no description)

requestCompleteInformation: boolean
in query

(no description)

page: integer (int32)
in query

(no description)

pageSize: integer (int32)
in query

(no description)

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "AddressId": "integer (int32)",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Region": "string",
  "PostalCode": "string",
  "Country": "string"
}

PO Templates

Get a paged list of Purchase Order Template

GET /api/v1/PurchaseOrderTemplate

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PurchaseOrderTemplateId": "integer (int32)",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "Title": "string",
      "Account": "string",
      "ShippingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "RequestApproverRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PrivateNotes": "string",
      "Comment": "string",
      "PurchaseOrderItemRef": [
        {
          "Id": "integer (int32)",
          "PartId": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Purchase Order Template

GET /api/v1/PurchaseOrderTemplate/id
id: integer (int32)
in query

The Purchase Order Template id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Purchase Order Template was found

404 Not Found

the Purchase Order Template was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PurchaseOrderTemplateId": "integer (int32)",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "Title": "string",
      "Account": "string",
      "ShippingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "RequestApproverRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PrivateNotes": "string",
      "Comment": "string",
      "PurchaseOrderItemRef": [
        {
          "Id": "integer (int32)",
          "PartId": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Purchase Orders

Get a paged list of Purchase Orders

GET /api/v1/PurchaseOrder

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "Title": "string",
      "PurchaseOrderId": "integer (int32)",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "StatusRef": {
        "StatusValue": "integer (int32)",
        "StatusName": "string"
      },
      "Account": "string",
      "ShippingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "RequestApproverRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CreatedByUserRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "UpdatedByUserRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "CreatedOn": "string (date-time)",
      "Ordered": "string (date-time)",
      "Received": "string (date-time)",
      "AllItemPaid": "string",
      "VendorConfirmed": "string",
      "Notes": "string",
      "PrivateNotes": "string",
      "Comment": "string"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update a Purchase Order

PUT /api/v1/PurchaseOrder

Details of Purchase Order

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "PurchaseOrderId": "integer (int32)",
  "VendorId": "integer (int32)",
  "Title": "string",
  "Account": "string",
  "ShippingAddressId": "integer (int32)",
  "RequestApproversId": [
    "integer (int32)"
  ],
  "Received": "string (date-time)",
  "Ordered": "string (date-time)",
  "Notes": "string",
  "PrivateNotes": "string",
  "Comment": "string",
  "Status": "integer (int32)",
  "SortOrder": "integer (int32)",
  "PurchaseOrderItems": [
    {
      "PartId": "integer (int32)",
      "BinId": "integer (int32)",
      "UnitPrice": "number (double)",
      "OrderedQty": "number (double)",
      "ReceivedQty": "number (double)"
    }
  ],
  "AllItemsPaid": "boolean"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "PurchaseOrderId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create a new Purchase Order

POST /api/v1/PurchaseOrder

Details of new Purchase Order

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "VendorId": "integer (int32)",
  "Title": "string",
  "Account": "string",
  "ShippingAddressId": "integer (int32)",
  "RequestApproversId": [
    "integer (int32)"
  ],
  "Received": "string (date-time)",
  "Ordered": "string (date-time)",
  "Notes": "string",
  "Comment": "string",
  "Items": [
    {
      "PartId": "integer (int32)",
      "BinId": "integer (int32)",
      "UnitPrice": "number (double)",
      "OrderedQty": "number (double)",
      "ReceivedQty": "number (double)"
    }
  ]
}

the purchase order is created

404 Not Found

something went wrong

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "PurchaseOrderId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Get a specific Purchase Order

GET /api/v1/PurchaseOrder/id
id: integer (int32)
in query

The Purchase Order id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Purchase Order was found

404 Not Found

the Purchase Order was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "Title": "string",
      "PurchaseOrderId": "integer (int32)",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "StatusRef": {
        "StatusValue": "integer (int32)",
        "StatusName": "string"
      },
      "Account": "string",
      "ShippingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "RequestApproverRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CreatedByUserRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "UpdatedByUserRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "CreatedOn": "string (date-time)",
      "Ordered": "string (date-time)",
      "Received": "string (date-time)",
      "AllItemPaid": "string",
      "VendorConfirmed": "string",
      "Notes": "string",
      "PrivateNotes": "string",
      "Comment": "string"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update Status of Purchase Order

PUT /api/v1/UpdatePurchaseOrderStatus
PurchaseOrderId: integer (int32)
in query

Purchase Order Id

SiteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

NewStatus: integer (int32)
in query

Status ID can be found in Purchase Order Status API

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "PurchaseOrderId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Get Purchase Order Statuses

GET /api/v1/PurchaseOrderStatus
200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "Results": "object"
}

Sites

Get a list of sites

GET /api/v1/Sites

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteId": "integer (int32)",
      "Name": "string",
      "DepartmantRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BuildingRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific site

GET /api/v1/Sites/id
id: integer (int32)
in query

The site id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the site was found

404 Not Found

the site was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteId": "integer (int32)",
      "Name": "string",
      "DepartmantRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BuildingRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Tasks

Get a paged list of Task Statuses

GET /api/v1/Tasks

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "TaskTemplateId": "integer (int32)",
      "Name": "string",
      "PriorityRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "Description": "string",
      "TaskFieldRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Task

GET /api/v1/Tasks/id
id: integer (int32)
in query

The task id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the task was found

404 Not Found

the task was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "TaskTemplateId": "integer (int32)",
      "Name": "string",
      "PriorityRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "Description": "string",
      "TaskFieldRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update an existing Task

PUT /api/v1/Task
Request Content-Types: application/json, text/json
Request Example
{
  "TaskId": "integer (int32)",
  "Name": "string",
  "TaskPriorityId": "integer (int32)",
  "SitesId": [
    "integer (int32)"
  ],
  "Description": "string",
  "Fields": [
    {
      "TaskFieldId": "integer (int32)",
      "FieldName": "string",
      "FieldType": "integer (int32)",
      "FieldValue": "string",
      "SortOrder": "integer (int32)",
      "IsRequired": "boolean"
    }
  ]
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "TaskId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create a new Task

POST /api/v1/Task
Request Content-Types: application/json, text/json
Request Example
{
  "Name": "string",
  "TaskPriorityId": "integer (int32)",
  "SitesId": [
    "integer (int32)"
  ],
  "Description": "string",
  "Fields": [
    {
      "FieldName": "string",
      "FieldType": "integer (int32)",
      "SortOrder": "integer (int32)",
      "IsRequired": "boolean"
    }
  ]
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "TaskId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Task Fields

Get Fields associated with a Task

GET /api/v1/TaskField
taskId: integer (int32)
in query

Task Id can be from Task Index or Task API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": {
    "TaskTemplateFieldId": "integer (int32)",
    "FieldName": "string",
    "FieldType": "integer (int32)",
    "FieldValue": "string",
    "SortOrder": "integer (int32)",
    "IsRequired": "boolean"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update Task Field

PUT /api/v1/TaskField

Details of Task Field

Request Content-Types: application/json, text/json
Request Example
{
  "TaskFieldId": "integer (int32)",
  "FieldName": "string",
  "FieldType": "integer (int32)",
  "FieldValue": "string",
  "SortOrder": "integer (int32)",
  "IsRequired": "boolean",
  "TaskId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "TaskId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create new Field for a Task

POST /api/v1/TaskField

Details of Field

Request Content-Types: application/json, text/json
Request Example
{
  "FieldName": "string",
  "FieldType": "integer (int32)",
  "FieldValue": "string",
  "SortOrder": "integer (int32)",
  "IsRequired": "boolean",
  "TaskId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "TaskId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Get Field associated with a Task

GET /api/v1/TaskField/Id
taskFieldId: integer (int32)
in query

Field Id of Task

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": {
    "TaskTemplateFieldId": "integer (int32)",
    "FieldName": "string",
    "FieldType": "integer (int32)",
    "FieldValue": "string",
    "SortOrder": "integer (int32)",
    "IsRequired": "boolean"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Task Priority

Get a paged list of Task Priority

GET /api/v1/TaskPriorities

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "TaskPriorityId": "integer (int32)",
      "Name": "string"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Task Status

Get a paged list of Task Statuses

GET /api/v1/TaskStatuses

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "TaskStatusId": "integer (int32)",
      "Name": "string"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Users

Get list of Users

GET /api/v1/Users

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "UserId": "integer (int32)",
      "UserName": "string",
      "FirstName": "string",
      "LastName": "string",
      "WeeklyCeilingWorkingHours": "number (double)",
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ]
}

Get a specific User

GET /api/v1/UserById/id
id: integer (int32)
in query

The User id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the User was found

404 Not Found

the User was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "UserId": "integer (int32)",
      "UserName": "string",
      "FirstName": "string",
      "LastName": "string",
      "WeeklyCeilingWorkingHours": "number (double)",
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ]
}

Vendor

Get list of Vendors

GET /api/v1/Vendors

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "VendorId": "integer (int32)",
      "Name": "string",
      "Phone": "string",
      "Email": "string",
      "Invited": "string",
      "BuildingRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "Notes": "string",
      "ContractStartDate": "string (date-time)",
      "ContractEndDate": "string (date-time)",
      "VendorAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      }
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Vendor

GET /api/v1/Vendors/id
id: integer (int32)
in query

Vendor ID can be found in your Maxpanda Vendor index or Vendor API

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the location was found

404 Not Found

the location was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "VendorId": "integer (int32)",
      "Name": "string",
      "Phone": "string",
      "Email": "string",
      "Invited": "string",
      "BuildingRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "Notes": "string",
      "ContractStartDate": "string (date-time)",
      "ContractEndDate": "string (date-time)",
      "VendorAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      }
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update an existing vendor.

PUT /api/v1/Vendor

The Vendor to be updated

Request Content-Types: application/json, text/json
Request Example
{
  "Name": "string",
  "VendorId": "integer (int32)",
  "Phone": "string",
  "Email": "string",
  "SitesId": [
    "integer (int32)"
  ],
  "Notes": "string",
  "ContractStartDate": "string (date-time)",
  "ContractEndDate": "string (date-time)",
  "Address": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  }
}

The vendor was updated

404 Not Found

The vendor was not found, update failed

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "VendorId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create a new Vendor

POST /api/v1/Vendor

The Vendor to be added

Request Content-Types: application/json, text/json
Request Example
{
  "Name": "string",
  "Phone": "string",
  "Email": "string",
  "Sites": [
    "integer (int32)"
  ],
  "Notes": "string",
  "ContractStartDate": "string (date-time)",
  "ContractEndDate": "string (date-time)",
  "Address": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  }
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "VendorId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Vendor Invoices

Get a paged list of Vendor Invoice

GET /api/v1/VendorInvoices

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "InvoiceId": "integer (int32)",
      "InvoiceNumber": "string",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "InvoiceDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "TotalAmount": "number (double)",
      "Description": "string",
      "InvoiceTypeRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "ItemId": "integer (int32)",
          "Quantity": "number (double)",
          "UnitPrice": "number (double)"
        }
      ],
      "InvoiceTaxRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "WorkorderRef": [
        {
          "Id": "integer (int32)",
          "Title": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Vendor Invoice

GET /api/v1/VendorInvoice/id
id: integer (int32)
in query

The Vendor Invoice id to retrieve

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Vendor Invoice was found

404 Not Found

the Vendor Invoice was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "InvoiceId": "integer (int32)",
      "InvoiceNumber": "string",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "InvoiceDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "TotalAmount": "number (double)",
      "Description": "string",
      "InvoiceTypeRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "ItemId": "integer (int32)",
          "Quantity": "number (double)",
          "UnitPrice": "number (double)"
        }
      ],
      "InvoiceTaxRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "WorkorderRef": [
        {
          "Id": "integer (int32)",
          "Title": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Update an Invoice

PUT /api/v1/VendorInvoice

Details of the Invoice

Request Content-Types: application/json, text/json
Request Example
{
  "VendorId": "integer (int32)",
  "InvoiceId": "integer (int32)",
  "Sites": [
    "integer (int32)"
  ],
  "InvoiceNumber": "string",
  "InvoiceDate": "string (date-time)",
  "DueDate": "string (date-time)",
  "Description": "string",
  "InvoiceItems": [
    {
      "InvoiceItemId": "integer (int32)",
      "InvoiceItemTypeId": "integer (int32)",
      "Description": "string",
      "UnitPrice": "number (double)",
      "Quantity": "number (double)"
    }
  ],
  "InvoiceTaxes": [
    {
      "InvoiceTaxId": "integer (int32)",
      "TaxRate": "number (double)"
    }
  ],
  "CurrentSite": "integer (int32)"
}

the Vendor Invoice was created

404 Not Found

some thing went wrong

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "InvoiceId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Create an Invoice

POST /api/v1/VendorInvoice

Details of the new invoice

Request Content-Types: application/json, text/json
Request Example
{
  "VendorId": "integer (int32)",
  "Sites": [
    "integer (int32)"
  ],
  "InvoiceNumber": "string",
  "InvoiceDate": "string (date-time)",
  "DueDate": "string (date-time)",
  "Description": "string",
  "InvoiceItems": [
    {
      "InvoiceItemTypeId": "integer (int32)",
      "InvoiceItemTypeName": "string",
      "Description": "string",
      "UnitPrice": "number (double)",
      "Quantity": "number (double)"
    }
  ],
  "InvoiceTaxes": [
    {
      "InvoiceTaxId": "integer (int32)",
      "TaxRate": "number (double)"
    }
  ],
  "CurrentSite": "integer (int32)"
}

the Vendor Invoice was created

404 Not Found

some thing went wrong

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "InvoiceId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Work Order Category

Get a paged list of Workorder Categories

GET /api/v1/Company/WorkorderCategories

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "WorkOrderCategoryId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific Workorder Category record

GET /api/v1/Company/WorkorderCategory/id
id: integer (int32)
in query

The Workorder Category id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Workorder Category was found

404 Not Found

the Workorder Category was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "WorkOrderCategoryId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Work Order Priority

Get a paged list of WorkOrder Priorities

GET /api/v1/Company/WorkOrderPriorities

The default list will return the first 25 records. The NextPageUrl property will return the next page of records.

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "WorkOrderCategoryId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Get a specific WorkOrder Priority record

GET /api/v1/Company/WorkOrderPriority/id
id: integer (int32)
in query

The WorkOrder Priority id to retrieve

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the Workorder Priority was found

404 Not Found

the Workorder Priority was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "WorkOrderCategoryId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Work Orders

Get a list of work orders

GET /api/v1/WorkOrders

The default list will return the first 25 records. The NextPageUrl property will return the next page of records

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "WorkorderId": "integer (int32)",
      "Title": "string",
      "ReferenceID": "string",
      "CategoryRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PriorityRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "StatusRef": {
        "StatusValue": "integer (int32)",
        "Name": "string"
      },
      "WorkorderTypeRef": {
        "TypeValue": "integer (int32)",
        "Name": "string"
      },
      "ShortDescription": "string",
      "Notes": "string",
      "PrivateNotes": "string",
      "Comments": "string",
      "PrimaryContact": "string",
      "PrimaryPhone": "string",
      "AlternateContact": "string",
      "AlternatePhone": "string",
      "ExternalEmails": "string",
      "StartDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "PlannedDueDate": "string (date-time)",
      "CompletedDate": "string (date-time)",
      "ClosedDate": "string (date-time)",
      "CustomerRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "VendorRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "TaskRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PartRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "StaffRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CustomerInvoiceRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "InvoiceNumber": "string",
          "InvoiceAmount": "number (double)",
          "InvoiceDate": "string (date-time)"
        }
      ],
      "VendorInvoiceRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "InvoiceNumber": "string",
          "InvoiceAmount": "number (double)"
        }
      ]
    }
  ]
}

Get a specific work order

GET /api/v1/WorkOrders/id
id: integer (int32)
in query

Workorder Id

siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

the work order was found

404 Not Found

the work order was not found

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "WorkorderId": "integer (int32)",
      "Title": "string",
      "ReferenceID": "string",
      "CategoryRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PriorityRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "StatusRef": {
        "StatusValue": "integer (int32)",
        "Name": "string"
      },
      "WorkorderTypeRef": {
        "TypeValue": "integer (int32)",
        "Name": "string"
      },
      "ShortDescription": "string",
      "Notes": "string",
      "PrivateNotes": "string",
      "Comments": "string",
      "PrimaryContact": "string",
      "PrimaryPhone": "string",
      "AlternateContact": "string",
      "AlternatePhone": "string",
      "ExternalEmails": "string",
      "StartDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "PlannedDueDate": "string (date-time)",
      "CompletedDate": "string (date-time)",
      "ClosedDate": "string (date-time)",
      "CustomerRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "VendorRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "TaskRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PartRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "StaffRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CustomerInvoiceRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "InvoiceNumber": "string",
          "InvoiceAmount": "number (double)",
          "InvoiceDate": "string (date-time)"
        }
      ],
      "VendorInvoiceRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "InvoiceNumber": "string",
          "InvoiceAmount": "number (double)"
        }
      ]
    }
  ]
}

GET /api/v1/WorkOrderStatuses

page: integer (int32)
in query

(no description)

pageSize: integer (int32)
in query

(no description)

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string",
  "Results": "object"
}

Submit a workorder

POST /api/v1/WorkOrder

Workorder details to be submitted

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "Title": "string",
  "ReferencedId": "string",
  "WorkorderCategoryId": "integer (int32)",
  "WorkorderPriorityId": "integer (int32)",
  "ShortDescription": "string",
  "Notes": "string",
  "PrivateNotes": "string",
  "Comments": "string",
  "PrimaryContact": "string",
  "AlternateContact": "string",
  "AddCC": "string",
  "EnterWorkArea": "boolean",
  "AllDayEvent": "boolean",
  "StartDate": "string (date-time)",
  "DueDate": "string (date-time)",
  "CompletedDate": "string (date-time)",
  "ClosedDate": "string (date-time)",
  "CustomerId": "integer (int32)",
  "BuildingGroupId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "LocationsId": [
    "integer (int32)"
  ],
  "AssetsId": [
    "integer (int32)"
  ],
  "VendorId": [
    "integer (int32)"
  ],
  "TasksId": [
    "integer (int32)"
  ],
  "StaffsId": [
    "integer (int32)"
  ],
  "CustomerInvoicesId": [
    "integer (int32)"
  ],
  "VendorInvoicesId": [
    "integer (int32)"
  ],
  "WorkOrderPartRefs": [
    {
      "PartId": "integer (int32)",
      "allocated": "number (double)",
      "Comment": "string"
    }
  ]
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "WorkOrderId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Update a workorder

PUT /api/v1/WorkOrder/id

Workorder details to be updated

Request Content-Types: application/json, text/json
Request Example
{
  "SiteId": "integer (int32)",
  "WorkorderId": "integer (int32)",
  "Title": "string",
  "ReferencedId": "string",
  "WorkorderCategoryId": "integer (int32)",
  "WorkorderPriorityId": "integer (int32)",
  "ShortDescription": "string",
  "Notes": "string",
  "PrivateNotes": "string",
  "Comments": "string",
  "PrimaryContact": "string",
  "AlternateContact": "string",
  "AddCC": "string",
  "EnterWorkArea": "string",
  "AllDayEvent": "boolean",
  "StartDate": "string (date-time)",
  "DueDate": "string (date-time)",
  "CompletedDate": "string (date-time)",
  "ClosedDate": "string (date-time)",
  "CustomerId": "integer (int32)",
  "BuildingGroupId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "LocationsId": [
    "integer (int32)"
  ],
  "AssetsId": [
    "integer (int32)"
  ],
  "VendorId": [
    "integer (int32)"
  ],
  "TasksId": [
    "integer (int32)"
  ],
  "WorkorderStaffsRef": [
    {
      "UserId": "integer (int32)",
      "ActiveLabourHours": "string"
    }
  ],
  "CustomerInvoicesId": [
    "integer (int32)"
  ],
  "VendorInvoicesId": [
    "integer (int32)"
  ],
  "workOrderPartRefs": [
    {
      "PartId": "integer (int32)",
      "allocated": "number (double)",
      "Comment": "string"
    }
  ],
  "WorkorderStatus": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Result": {
    "WorkOrderId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

Change status of workorder

POST /api/v1/ChangeWorkOrderStatus
SiteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

WorkorderId: integer (int32)
in query

Id of workorder

NewStatus: integer (int32)
in query

New status of workorder

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "Results": "object"
}

Get list of workorders created by an User

GET /api/v1/WorkordersByUser
SiteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

UserId: integer (int32)
in query

User ID can be found in your Maxpanda Users index or User API

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string",
  "Results": "object"
}

Delete Task of Workorder

DELETE /api/v1/DeleteWorkOrdertask
WorkOrderId: integer (int32)
in query

Id of workorder

WorkOrderTaskId: integer (int32)
in query

Task Id of workorder

IdCompany: integer (int32)
in query

Company Id

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "Results": "object"
}

get Workorders by Status

GET /api/v1/WorkOrdersByWorkOrderStatus
siteId: integer (int32)
in query

Site ID can be found in your Maxpanda Site index or Sites API

requestCompleteInformation: boolean
in query

True option provides all the data fields. False will only return required fields

Status: integer (int32)
in query

Status ID can be found in your WorkOrderStatuses API

page: integer (int32)
in query

Page number to start retrieving data (similar to List View pagification)

pageSize: integer (int32)
in query

Number of records per page (max=100)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "WorkorderId": "integer (int32)",
      "Title": "string",
      "ReferenceID": "string",
      "CategoryRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PriorityRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "StatusRef": {
        "StatusValue": "integer (int32)",
        "Name": "string"
      },
      "WorkorderTypeRef": {
        "TypeValue": "integer (int32)",
        "Name": "string"
      },
      "ShortDescription": "string",
      "Notes": "string",
      "PrivateNotes": "string",
      "Comments": "string",
      "PrimaryContact": "string",
      "PrimaryPhone": "string",
      "AlternateContact": "string",
      "AlternatePhone": "string",
      "ExternalEmails": "string",
      "StartDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "PlannedDueDate": "string (date-time)",
      "CompletedDate": "string (date-time)",
      "ClosedDate": "string (date-time)",
      "CustomerRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "VendorRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "TaskRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PartRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "StaffRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CustomerInvoiceRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "InvoiceNumber": "string",
          "InvoiceAmount": "number (double)",
          "InvoiceDate": "string (date-time)"
        }
      ],
      "VendorInvoiceRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "InvoiceNumber": "string",
          "InvoiceAmount": "number (double)"
        }
      ]
    }
  ]
}

GET /api/v1/ToDo

siteId: integer (int32)
in query

(no description)

requestCompleteInformation: boolean
in query

(no description)

page: integer (int32)
in query

(no description)

pageSize: integer (int32)
in query

(no description)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "WorkorderId": "integer (int32)",
      "Title": "string",
      "ReferenceID": "string",
      "CategoryRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PriorityRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "StatusRef": {
        "StatusValue": "integer (int32)",
        "Name": "string"
      },
      "WorkorderTypeRef": {
        "TypeValue": "integer (int32)",
        "Name": "string"
      },
      "ShortDescription": "string",
      "Notes": "string",
      "PrivateNotes": "string",
      "Comments": "string",
      "PrimaryContact": "string",
      "PrimaryPhone": "string",
      "AlternateContact": "string",
      "AlternatePhone": "string",
      "ExternalEmails": "string",
      "StartDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "PlannedDueDate": "string (date-time)",
      "CompletedDate": "string (date-time)",
      "ClosedDate": "string (date-time)",
      "CustomerRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "VendorRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "TaskRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PartRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "StaffRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CustomerInvoiceRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "InvoiceNumber": "string",
          "InvoiceAmount": "number (double)",
          "InvoiceDate": "string (date-time)"
        }
      ],
      "VendorInvoiceRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "InvoiceNumber": "string",
          "InvoiceAmount": "number (double)"
        }
      ]
    }
  ]
}

GET /api/v1/FutureWorkOrder

siteId: integer (int32)
in query

(no description)

requestCompleteInformation: boolean
in query

(no description)

page: integer (int32)
in query

(no description)

pageSize: integer (int32)
in query

(no description)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "Id": "integer (int32)",
  "Title": "string",
  "WorkOrderPriorityDetail": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "WorkOrderCategoryDetail": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "StartDate": "string (date-time)",
  "DueDate": "string (date-time)",
  "AssignedStaffs": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "LocationRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "WOType": "string",
  "Status": "integer (int32)",
  "StatusDesc": "string",
  "StatusCSS": "string",
  "SiteRef": {
    "Id": "integer (int32)",
    "Name": "string"
  }
}

Schema Definitions

AssetStatusResponseModel: object

Results: AssetStatus
AssetStatus
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

PageNumber: integer (int32)

The page number this page represents.

PageSize: integer (int32)

The number of records returned in a page.

TotalNumberOfPages: integer (int32)

The total number of pages available.

TotalNumberOfRecords: integer (int32)

The total number of records available.

NextPageUrl: string

The URL to the next page - if null, there are no more pages.

Example
{
  "Results": [
    {
      "AssetStatusId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

AssetStatus: object

AssetStatusId: integer (int32)
Name: string (up to 45 chars)
SiteRef: SiteRef
SiteRef
Example
{
  "AssetStatusId": "integer (int32)",
  "Name": "string",
  "SiteRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ]
}

SiteRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

AssetResponseModel: object

Results: AssetList
AssetList
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

PageNumber: integer (int32)

The page number this page represents.

PageSize: integer (int32)

The number of records returned in a page.

TotalNumberOfPages: integer (int32)

The total number of pages available.

TotalNumberOfRecords: integer (int32)

The total number of records available.

NextPageUrl: string

The URL to the next page - if null, there are no more pages.

Example
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetId": "integer (int32)",
      "Name": "string",
      "Model": "string",
      "AssetTypeRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetStatusRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssetTag": "string",
      "SerialNumber": "string",
      "Manufacture": "string",
      "ManufactureInfo": "string",
      "PreferredSupplier": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "VendorInfo": "string",
      "InstallationDate": "string (date-time)",
      "WarrantyDate": "string (date-time)",
      "WarrantyNotesLabor": "string",
      "WarrantyNotesParts": "string",
      "Notes": "string",
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "UserRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "PartRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "MeteringTypeRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "AssetAuditsRef": [
        {
          "AssetAuditId": "integer (int32)",
          "AssignedTo": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "AssignedBy": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "ReleasedBy": {
            "Id": "integer (int32)",
            "Name": "string"
          },
          "AllocatedOn": "string (date-time)",
          "ReleasedOn": "string (date-time)"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

AssetList: object

SiteRef: SiteRef
AssetId: integer (int32)
Name: string
Model: string
AssetTypeRef: AssetTypeRef
AssetStatusRef: AssetStatusRef
AssetTag: string
SerialNumber: string
Manufacture: string
ManufactureInfo: string
PreferredSupplier: VendorRef
VendorInfo: string
InstallationDate: string (date-time)
WarrantyDate: string (date-time)
WarrantyNotesLabor: string
WarrantyNotesParts: string
Notes: string
BuildingGroupRef: DepartmentRef
BuildingRef: BuildingRef
LocationRef: LocationRef
UserRef: AssetStaffRef
AssetStaffRef
PartRef: PartRef
PartRef
MeteringTypeRef: MerteringRef
MerteringRef
AssetAuditsRef: AssetAuditModel
AssetAuditModel
Example
{
  "SiteRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "AssetId": "integer (int32)",
  "Name": "string",
  "Model": "string",
  "AssetTypeRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "AssetStatusRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "AssetTag": "string",
  "SerialNumber": "string",
  "Manufacture": "string",
  "ManufactureInfo": "string",
  "PreferredSupplier": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "VendorInfo": "string",
  "InstallationDate": "string (date-time)",
  "WarrantyDate": "string (date-time)",
  "WarrantyNotesLabor": "string",
  "WarrantyNotesParts": "string",
  "Notes": "string",
  "BuildingGroupRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "BuildingRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "LocationRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "UserRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "PartRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "MeteringTypeRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "AssetAuditsRef": [
    {
      "AssetAuditId": "integer (int32)",
      "AssignedTo": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AssignedBy": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "ReleasedBy": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "AllocatedOn": "string (date-time)",
      "ReleasedOn": "string (date-time)"
    }
  ]
}

AssetTypeRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

AssetStatusRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

VendorRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

DepartmentRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

BuildingRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

LocationRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

AssetStaffRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

PartRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

MerteringRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

AssetAuditModel: object

AssetAuditId: integer (int32)
AssignedTo: UserRef
AssignedBy: UserRef
ReleasedBy: UserRef
AllocatedOn: string (date-time)
ReleasedOn: string (date-time)
Example
{
  "AssetAuditId": "integer (int32)",
  "AssignedTo": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "AssignedBy": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "ReleasedBy": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "AllocatedOn": "string (date-time)",
  "ReleasedOn": "string (date-time)"
}

UserRef: object

Id: integer (int32)
Name: string
Example
{
  "Id": "integer (int32)",
  "Name": "string"
}

Asset: object

siteId: integer (int32)

Site Id of the Asset. Site Id can be found in your Maxpanda Site Index or Site API

Name: string (up to 100 chars)

Name of the Asset.

Description: string (up to 250 chars)

Description of Asset.

Model: string (up to 100 chars)

Model details of Asset

AssetTypeId: integer (int32)

Asset Type Id of the Asset. Asset Type Id can be found in your Maxpanda Company Asset Type Index or Asset Type Api

AssetStatusId: integer (int32)

Asset Status Id of the Asset. Asset Status Id can be found in your Maxpanda Company Asset Status Index or Asset Status Api

AssetTag: string (up to 45 chars)

Tag details of the Asset.

SerialNumber: string (up to 45 chars)

Serial Number of the Asset

Manufacturer: string (up to 100 chars)

Manufacturer details of the Asset.

ManufacturerInfo: string (up to 1000 chars)

Information of Manufacturer.

PreferredVendorId: integer (int32)

Id of Preferred Vendor for the Asset. Preferred Vendor Id can be found in your Maxpanda Vendor Index or Vendor Api

VendorInfo: string (up to 1000 chars)

Information about the vendor.

InstallationDate: string (date-time)

Installation date of Asset

WarrantyDate: string (date-time)

Warrenty date of Asset

WarrantyNotesParts: string (up to 1000 chars)

Warranty Notes for Parts

WarrantyNotesLabor: string (up to 1000 chars)

Warranty Notes for Labor

AddCC: string (up to 200 chars)

Addition Email recievers

Notes: string (up to 2000 chars)

Notes of the Asset

IsMobileAsset: boolean

Assets which are movable or can be moved from one location to another are called Mobile Assets

BuildingGroupId: integer (int32)

Building group of the Asset. Building Group Id can be found in your Maxpanda company Building Group or Department Api

BuildingId: integer (int32)

Building of the Asset. Building Id can be found in your Maxpanda Building index or Building Api

LocationId: integer (int32)

Location of the Asset. Location Id can be found in your Maxpanda Location index or Location Api

AssignedUserId: integer (int32)

Currently assigned user of the Asset. User Id can be found in your Maxpanda User index or User Api

PurchaseCost: number (double)

Purchase cost of the Asset

SalvageCost: number (double)

Salvage cost of the Asset

UsefulLifeInYears: number (double)

Number of years this Asset can be used

DepreciationRate: number (double)

Rate of Deprecation of the Asset

PartsIds: integer[]

Parts of the Asset. Parts Id can be found in your Maxpanda Inventory Part Index or Parts Api

integer (int32)
MeteringIds: integer[]

Metering type of the Asset. Metering Type Id can be found in your Maxpanda Company MeteringType or Metering Types Api

integer (int32)
Example
{
  "siteId": "integer (int32)",
  "Name": "string",
  "Description": "string",
  "Model": "string",
  "AssetTypeId": "integer (int32)",
  "AssetStatusId": "integer (int32)",
  "AssetTag": "string",
  "SerialNumber": "string",
  "Manufacturer": "string",
  "ManufacturerInfo": "string",
  "PreferredVendorId": "integer (int32)",
  "VendorInfo": "string",
  "InstallationDate": "string (date-time)",
  "WarrantyDate": "string (date-time)",
  "WarrantyNotesParts": "string",
  "WarrantyNotesLabor": "string",
  "AddCC": "string",
  "Notes": "string",
  "IsMobileAsset": "boolean",
  "BuildingGroupId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "LocationId": "integer (int32)",
  "AssignedUserId": "integer (int32)",
  "PurchaseCost": "number (double)",
  "SalvageCost": "number (double)",
  "UsefulLifeInYears": "number (double)",
  "DepreciationRate": "number (double)",
  "PartsIds": [
    "integer (int32)"
  ],
  "MeteringIds": [
    "integer (int32)"
  ]
}

AssetCreateUpdateResponseModel: object

Result: CreateUpdateAssetModel
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

Example
{
  "Result": {
    "AssetId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

CreateUpdateAssetModel: object

AssetId: integer (int32)
Example
{
  "AssetId": "integer (int32)"
}

UpdateAsset: object

siteId: integer (int32)

Site Id of the Asset. Site Id can be found in your Maxpanda Site Index or Site API

AssetId: integer (int32)

Id of the Asset. Asset Id can be found in your Maxpanda Asset Index or Assets API

Name: string (up to 100 chars)

Name of the Asset.

Description: string (up to 250 chars)

Description of Asset.

Model: string (up to 100 chars)

Model details of Asset

AssetTypeId: integer (int32)

Asset Type Id of the Asset. Asset Type Id can be found in your Maxpanda Company Asset Type Index or Asset Type Api

AssetStatusId: integer (int32)

Asset Status Id of the Asset. Asset Status Id can be found in your Maxpanda Company Asset Status Index or Asset Status Api

AssetTag: string (up to 45 chars)

Tag details of the Asset.

SerialNumber: string (up to 45 chars)

Serial Number of the Asset

Manufacturer: string (up to 100 chars)

Manufacturer details of the Asset.

ManufacturerInfo: string (up to 1000 chars)

Information of Manufacturer.

PreferredVendorId: integer (int32)

Id of Preferred Vendor for the Asset. Preferred Vendor Id can be found in your Maxpanda Vendor Index or Vendor Api

VendorInfo: string (up to 1000 chars)

Information of Vendor.

InstallationDate: string (date-time)

Installation date of Asset

WarrantyDate: string (date-time)

Warrenty date of Asset

WarrantyNotesParts: string (up to 1000 chars)

Warranty Notes for Parts

WarrantyNotesLabor: string (up to 1000 chars)

Warranty Notes for Labor

AddCC: string (up to 200 chars)

Addition Email recievers

Notes: string (up to 2000 chars)

Notes of the Asset

IsMobileAsset: boolean

Assets which are movable or can be moved from one location to another are called Mobile Assets

BuildingGroupId: integer (int32)

Building group of the Asset. Building Group Id can be found in your Maxpanda company Building Group or Department Api

BuildingId: integer (int32)

Building of the Asset. Building Id can be found in your Maxpanda Building index or Building Api

LocationId: integer (int32)

Location of the Asset. Location Id can be found in your Maxpanda Location index or Location Api

AssignedUserId: integer (int32)

Currently assigned user of the Asset. User Id can be found in your Maxpanda User index or User Api

PurchaseCost: number (double)

Purchase cost of the Asset

SalvageCost: number (double)

Salvage cost of the Asset

UsefulLifeInYears: number (double)

Number of years this Asset can be used

DepreciationRate: number (double)

Rate of Deprecation of the Asset

PartsIds: integer[]

Parts of the Asset. Parts Id can be found in your Maxpanda Inventory Part Index or Parts Api

integer (int32)
MeteringIds: integer[]

Metering type of the Asset. Metering Type Id can be found in your Maxpanda Company MeteringType or Metering Types Api

integer (int32)
Example
{
  "siteId": "integer (int32)",
  "AssetId": "integer (int32)",
  "Name": "string",
  "Description": "string",
  "Model": "string",
  "AssetTypeId": "integer (int32)",
  "AssetStatusId": "integer (int32)",
  "AssetTag": "string",
  "SerialNumber": "string",
  "Manufacturer": "string",
  "ManufacturerInfo": "string",
  "PreferredVendorId": "integer (int32)",
  "VendorInfo": "string",
  "InstallationDate": "string (date-time)",
  "WarrantyDate": "string (date-time)",
  "WarrantyNotesParts": "string",
  "WarrantyNotesLabor": "string",
  "AddCC": "string",
  "Notes": "string",
  "IsMobileAsset": "boolean",
  "BuildingGroupId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "LocationId": "integer (int32)",
  "AssignedUserId": "integer (int32)",
  "PurchaseCost": "number (double)",
  "SalvageCost": "number (double)",
  "UsefulLifeInYears": "number (double)",
  "DepreciationRate": "number (double)",
  "PartsIds": [
    "integer (int32)"
  ],
  "MeteringIds": [
    "integer (int32)"
  ]
}

AssetTypeResponseModel: object

Results: AssetType
AssetType
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

PageNumber: integer (int32)

The page number this page represents.

PageSize: integer (int32)

The number of records returned in a page.

TotalNumberOfPages: integer (int32)

The total number of pages available.

TotalNumberOfRecords: integer (int32)

The total number of records available.

NextPageUrl: string

The URL to the next page - if null, there are no more pages.

Example
{
  "Results": [
    {
      "AssetTypeId": "integer (int32)",
      "Name": "string",
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "WOThresholdPeriod": "integer (int32)",
      "WOThresholdLimit": "integer (int32)"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

AssetType: object

AssetTypeId: integer (int32)
Name: string (up to 100 chars)
SiteRef: SiteRef
SiteRef
WOThresholdPeriod: integer (int32)
WOThresholdLimit: integer (int32)
Example
{
  "AssetTypeId": "integer (int32)",
  "Name": "string",
  "SiteRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "WOThresholdPeriod": "integer (int32)",
  "WOThresholdLimit": "integer (int32)"
}

BinResponseModel: object

Results: Bin
Bin
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

PageNumber: integer (int32)

The page number this page represents.

PageSize: integer (int32)

The number of records returned in a page.

TotalNumberOfPages: integer (int32)

The total number of pages available.

TotalNumberOfRecords: integer (int32)

The total number of records available.

NextPageUrl: string

The URL to the next page - if null, there are no more pages.

Example
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "BinId": "integer (int32)",
      "Name": "string",
      "BinNumber": "string",
      "BuildingRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "LocationRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "PartsRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "Notes": "string",
      "Description": "string"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Bin: object

SiteRef: SiteRef
SiteRef
BinId: integer (int32)
Name: string
BinNumber: string
BuildingRef: BuildingRef
LocationRef: LocationRef
PartsRef: PartRef
PartRef
Notes: string
Description: string
Example
{
  "SiteRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "BinId": "integer (int32)",
  "Name": "string",
  "BinNumber": "string",
  "BuildingRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "LocationRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "PartsRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "Notes": "string",
  "Description": "string"
}

CreateBinModel: object

Name: string (up to 45 chars)

Name of the Bin

BinNumber: string (up to 45 chars)

Number associated with Bin

Sites: integer[]

Site Id of the Bin. Site Id can be found in your Maxpanda Site Index or Site API

integer (int32)
BuildingId: integer (int32)

Building of the Bin. Building Id can be found in your Maxpanda Building index or Building Api

LocationId: integer (int32)

Location of the Bin. Location Id can be found in your Maxpanda Location index or Location Api

Notes: string (up to 1000 chars)

Notes of the Asset

Description: string (up to 1000 chars)

Description of Asset.

SendReorderEmail: boolean
Example
{
  "Name": "string",
  "BinNumber": "string",
  "Sites": [
    "integer (int32)"
  ],
  "BuildingId": "integer (int32)",
  "LocationId": "integer (int32)",
  "Notes": "string",
  "Description": "string",
  "SendReorderEmail": "boolean"
}

BinCreateUpdateResponseModel: object

Result: CreateUpdateBinModel
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

Example
{
  "Result": {
    "BinId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

CreateUpdateBinModel: object

BinId: integer (int32)
Example
{
  "BinId": "integer (int32)"
}

UpdateBinModel: object

BinId: integer (int32)

Id of the Bin. Bin Id can be found in your Maxpanda Bin index or Bin Api

Name: string (up to 45 chars)

Name of the Bin

BinNumber: string (up to 45 chars)

Number associated with Bin

Sites: integer[]

Site Id of the Bin. Site Id can be found in your Maxpanda Site Index or Site API

integer (int32)
BuildingId: integer (int32)

Building of the Bin. Building Id can be found in your Maxpanda Building index or Building Api

LocationId: integer (int32)

Location of the Bin. Location Id can be found in your Maxpanda Location index or Location Api

Notes: string (up to 1000 chars)

Notes of the Asset

Description: string (up to 1000 chars)

Description of Asset.

PartsId: integer[]

Parts of the Bin. Part Id can be found in your Maxpanda Part index or Part Api

integer (int32)
SendReorderEmail: boolean
Example
{
  "BinId": "integer (int32)",
  "Name": "string",
  "BinNumber": "string",
  "Sites": [
    "integer (int32)"
  ],
  "BuildingId": "integer (int32)",
  "LocationId": "integer (int32)",
  "Notes": "string",
  "Description": "string",
  "PartsId": [
    "integer (int32)"
  ],
  "SendReorderEmail": "boolean"
}

BuildingResponseModel: object

Results: BuildingList
BuildingList
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

PageNumber: integer (int32)

The page number this page represents.

PageSize: integer (int32)

The number of records returned in a page.

TotalNumberOfPages: integer (int32)

The total number of pages available.

TotalNumberOfRecords: integer (int32)

The total number of records available.

NextPageUrl: string

The URL to the next page - if null, there are no more pages.

Example
{
  "Results": [
    {
      "SiteRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingId": "string",
      "Name": "string",
      "Description": "string",
      "BuildingGroupRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "BuildingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "LocationRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

BuildingList: object

SiteRef: SiteRef
BuildingId: string
Name: string
Description: string
BuildingGroupRef: DepartmentRef
BuildingAddress: Address
LocationRef: LocationRef
LocationRef
Example
{
  "SiteRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "BuildingId": "string",
  "Name": "string",
  "Description": "string",
  "BuildingGroupRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "BuildingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "LocationRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ]
}

Address: object

AddressId: integer (int32)
AddressLine1: string (up to 100 chars)
AddressLine2: string (up to 100 chars)
City: string (up to 45 chars)
Region: string (up to 45 chars)
PostalCode: string (up to 45 chars)
Country: string (up to 45 chars)
Example
{
  "AddressId": "integer (int32)",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Region": "string",
  "PostalCode": "string",
  "Country": "string"
}

BuildingUpdateModel: object

SiteId: integer (int32)

Site Id of the Building. Site Id can be found in your Maxpanda Site Index or Site API

BuildingId: integer (int32)

Id of the Building. Site Id can be found in your Maxpanda Site Index or Site API

Name: string

Name of the Building

Description: string (up to 500 chars)

Description about the Building

BuildingGroupId: integer (int32)

Building group of the Building. Building Group Id can be found in your Maxpanda company Building Group or Department Api

BuildingAddress: Address

Address of the Building

LocationsId: integer[]

Locations of the Building. Location Id can be found in your Maxpanda Location index or Location Api

integer (int32)
Archived: boolean
Example
{
  "SiteId": "integer (int32)",
  "BuildingId": "integer (int32)",
  "Name": "string",
  "Description": "string",
  "BuildingGroupId": "integer (int32)",
  "BuildingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "LocationsId": [
    "integer (int32)"
  ],
  "Archived": "boolean"
}

BuildingCreateUpdateResponseModel: object

Result: CreateUpdateBuildingModel
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

Example
{
  "Result": {
    "BuildingId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

CreateUpdateBuildingModel: object

BuildingId: integer (int32)
Example
{
  "BuildingId": "integer (int32)"
}

BuildingCreateModel: object

SiteId: integer (int32)

Site Id of the Asset. Site Id can be found in your Maxpanda Site Index or Site API

Name: string

Name of the Building

Description: string (up to 500 chars)

Description about the Building

BuildingGroupId: integer (int32)

Building group of the Building. Building Group Id can be found in your Maxpanda company Building Group or Department Api

BuildingAddress: APIAddressModel

Address of the Building

LocationsId: integer[]

Locations of the Building. Location Id can be found in your Maxpanda Location index or Location Api

integer (int32)
Archived: boolean
Example
{
  "SiteId": "integer (int32)",
  "Name": "string",
  "Description": "string",
  "BuildingGroupId": "integer (int32)",
  "BuildingAddress": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "LocationsId": [
    "integer (int32)"
  ],
  "Archived": "boolean"
}

APIAddressModel: object

AddressLine1: string (up to 100 chars)
AddressLine2: string (up to 100 chars)
City: string (up to 45 chars)
Region: string (up to 45 chars)
PostalCode: string (up to 45 chars)
Country: string (up to 45 chars)
Example
{
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Region": "string",
  "PostalCode": "string",
  "Country": "string"
}

CreateCustomerModel: object

SitesId: integer[]

Site Ids of the Customer. Site Id can be found in your Maxpanda Site Index or Site API

integer (int32)
FirstName: string

First Name of the Customer

LastName: string

Last Name of the Customer

Email: string

Email address of the Customer

CompanyName: string

Name of Customers company

PhoneNumber: string

Phone Number of the Customer

MobileNumber: string

Mobile Number of the Customer

Fax: string

Fax Number of the Customer

Other: string

Othe details of the Customer

WebSite: string

Website address of the Customer

Notes: string

Notes about the Customer

BillingAddress: APIAddressModel

Customers Address of Billing

ShippingAddressSameAsBilling: boolean

Use Customers Billing address as Shipping Address

ShippingAddress: APIAddressModel

Customers Address of Shipping

Example
{
  "SitesId": [
    "integer (int32)"
  ],
  "FirstName": "string",
  "LastName": "string",
  "Email": "string",
  "CompanyName": "string",
  "PhoneNumber": "string",
  "MobileNumber": "string",
  "Fax": "string",
  "Other": "string",
  "WebSite": "string",
  "Notes": "string",
  "BillingAddress": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "ShippingAddressSameAsBilling": "boolean",
  "ShippingAddress": {
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  }
}

CustomerCreateUpdateResponseModel: object

Result: CreateUpdateCustomerModel
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

Example
{
  "Result": {
    "CustomerId": "integer (int32)"
  },
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)"
}

CreateUpdateCustomerModel: object

CustomerId: integer (int32)
Example
{
  "CustomerId": "integer (int32)"
}

UpdateCustomerModel: object

SitesId: integer[]

Site Ids of the Customer. Site Id can be found in your Maxpanda Site Index or Site API

integer (int32)
CustomerId: integer (int32)

Id of the Customer. Customer Id can be found in your Maxpanda Customer Index or Customer API

FirstName: string

First Name of the Customer

LastName: string

Last Name of the Customer

Email: string

Email address of the Customer

CompanyName: string

Name of Customers company

PhoneNumber: string

Phone number of the Customer

MobileNumber: string

Mobile number of the Customer

Fax: string

Fax number of the Customer

Other: string

Othe details of the Customer

WebSite: string

Website address of the Customer

Notes: string

Notes about the Customer

BillingAddress: Address

Customers Address of Billing

ShippingAddressSameAsBilling: boolean

Use Customers Billing address as Shipping Address

ShippingAddress: Address

Customers Address of Shipping

Example
{
  "SitesId": [
    "integer (int32)"
  ],
  "CustomerId": "integer (int32)",
  "FirstName": "string",
  "LastName": "string",
  "Email": "string",
  "CompanyName": "string",
  "PhoneNumber": "string",
  "MobileNumber": "string",
  "Fax": "string",
  "Other": "string",
  "WebSite": "string",
  "Notes": "string",
  "BillingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "ShippingAddressSameAsBilling": "boolean",
  "ShippingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  }
}

CustomerResponseModel: object

Results: Customer
Customer
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

PageNumber: integer (int32)

The page number this page represents.

PageSize: integer (int32)

The number of records returned in a page.

TotalNumberOfPages: integer (int32)

The total number of pages available.

TotalNumberOfRecords: integer (int32)

The total number of records available.

NextPageUrl: string

The URL to the next page - if null, there are no more pages.

Example
{
  "Results": [
    {
      "SiteRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "CustomerId": "integer (int32)",
      "FirstName": "string",
      "LastName": "string",
      "CompanyName": "string",
      "Email": "string",
      "Phone": "string",
      "Mobile": "string",
      "Notes": "string",
      "BillingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "ShippingAddress": {
        "AddressId": "integer (int32)",
        "AddressLine1": "string",
        "AddressLine2": "string",
        "City": "string",
        "Region": "string",
        "PostalCode": "string",
        "Country": "string"
      },
      "ShippingAddressSameAsBilling": "boolean"
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Customer: object

SiteRef: SiteRef

Site to which access is allowed for customer.

SiteRef
CustomerId: integer (int32)

Customer's id.

FirstName: string

First Name of the customer.

LastName: string

Last Name of the customer.

CompanyName: string

Name of the company to which customer belongs to.

Email: string

Email address of customer.

Phone: string

Phone number of customer.

Mobile: string

Mobile number of customer.

Notes: string

Notes.

BillingAddress: Address

Address on which the Bill's will be sent.

ShippingAddress: Address

Address on which the any product will be sent.

ShippingAddressSameAsBilling: boolean

If customer wants to have same address for Billing as well as Shipping.

Example
{
  "SiteRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "CustomerId": "integer (int32)",
  "FirstName": "string",
  "LastName": "string",
  "CompanyName": "string",
  "Email": "string",
  "Phone": "string",
  "Mobile": "string",
  "Notes": "string",
  "BillingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "ShippingAddress": {
    "AddressId": "integer (int32)",
    "AddressLine1": "string",
    "AddressLine2": "string",
    "City": "string",
    "Region": "string",
    "PostalCode": "string",
    "Country": "string"
  },
  "ShippingAddressSameAsBilling": "boolean"
}

InvoiceResponseModel: object

Results: Invoice
Invoice
IsSuccess: boolean

It represents Success of an API request.

Message: string

The Response represents the Response Message of API

Status: string

The Status represents the response status of API

StatusCode: integer (int32)

The Response represents the ResponseCode of API

PageNumber: integer (int32)

The page number this page represents.

PageSize: integer (int32)

The number of records returned in a page.

TotalNumberOfPages: integer (int32)

The total number of pages available.

TotalNumberOfRecords: integer (int32)

The total number of records available.

NextPageUrl: string

The URL to the next page - if null, there are no more pages.

Example
{
  "Results": [
    {
      "InvoiceId": "integer (int32)",
      "InvoiceNumber": "string",
      "VendorRef": {
        "Id": "integer (int32)",
        "Name": "string"
      },
      "InvoiceDate": "string (date-time)",
      "DueDate": "string (date-time)",
      "TotalAmount": "number (double)",
      "Description": "string",
      "InvoiceTypeRef": [
        {
          "Id": "integer (int32)",
          "Name": "string",
          "ItemId": "integer (int32)",
          "Quantity": "number (double)",
          "UnitPrice": "number (double)"
        }
      ],
      "InvoiceTaxRef": [
        {
          "Id": "integer (int32)",
          "Name": "string"
        }
      ],
      "WorkorderRef": [
        {
          "Id": "integer (int32)",
          "Title": "string"
        }
      ]
    }
  ],
  "IsSuccess": "boolean",
  "Message": "string",
  "Status": "string",
  "StatusCode": "integer (int32)",
  "PageNumber": "integer (int32)",
  "PageSize": "integer (int32)",
  "TotalNumberOfPages": "integer (int32)",
  "TotalNumberOfRecords": "integer (int32)",
  "NextPageUrl": "string"
}

Invoice: object

InvoiceId: integer (int32)
InvoiceNumber: string
VendorRef: VendorRef
InvoiceDate: string (date-time)
DueDate: string (date-time)
TotalAmount: number (double)
Description: string
InvoiceTypeRef: InvoiceItemTypeRef
InvoiceItemTypeRef
InvoiceTaxRef: InvoiceTaxRef
InvoiceTaxRef
WorkorderRef: WorkorderRef
WorkorderRef
Example
{
  "InvoiceId": "integer (int32)",
  "InvoiceNumber": "string",
  "VendorRef": {
    "Id": "integer (int32)",
    "Name": "string"
  },
  "InvoiceDate": "string (date-time)",
  "DueDate": "string (date-time)",
  "TotalAmount": "number (double)",
  "Description": "string",
  "InvoiceTypeRef": [
    {
      "Id": "integer (int32)",
      "Name": "string",
      "ItemId": "integer (int32)",
      "Quantity": "number (double)",
      "UnitPrice": "number (double)"
    }
  ],
  "InvoiceTaxRef": [
    {
      "Id": "integer (int32)",
      "Name": "string"
    }
  ],
  "WorkorderRef": [
    {
      "Id": "integer (int32)",
      "Title": "string"
    }
  ]
}

InvoiceItemTypeRef: object

Id: integer (int32)
Name: string
ItemId: integer (int32)