logo
API docs by Redocly

Point of Rental API (2025.05.00)

Download OpenAPI specification:Download

Point of Rental Software: [email protected] URL: https://point-of-rental.com/ License: Proprietary

The Point of Rental API is intended for both customer and 3rd party usage. As our API grows, we will do our best to enrich this documentation. Please check back often.

Getting Access to Global API

In order to make calls through the Global API, you will need to have a few things in place. These steps vary by product. Make sure you read over the parts that call out your flavor of Point of Rental.

1. You must have an active Point of Rental license.

This means you must first be an active and paying customer of the Elite, Syrinx 365, or Essentials platforms.

2. You will need the SQS Listener running (Elite & Syrinx only).

If you are Elite/Syrinx based, you will need to have what we call the “SQS Listener” running on the machine that serves your database and current Elite/Syrinx API. This should be setup by Point of Rental, so feel free to ask us if you suspect it may not be live. Once this service is running, we will be able to talk between the Global API and your local server through a secure channel. This is what will allow us to continue setting up users and licenses through our Global Admin tool. This also enables your server to talk to our POR One mobile application, among other things.

3. You will need to have a “Global Login”-enabled account.

This means your user account inside of our product must have an email address for the username and a password that fits the minimum requirements. Additionally, your company must have the “Global Login” feature turned on and synced up. This is done a little bit differently depending on your product, but we can help you with that.

4. You will need to obtain an API Key.

You will need to obtain an API Key from Point of Rental that can then be used to authenticate the calls you will make against the Global API. This Key is sacred and will need to be protected, as it allows access to your data. We can change them over time if you wish, so feel free to reach out to us on that.

5. After these 4 steps, you should be ready to start making calls against the global API.

Feel free to test out the API now with your API Key. Otherwise, happy API'ing!

Your First API Call

There are two types of URLs you can hit.

  1. In the first type, you will not need to make any changes to the URL.
    Example: https://api.pointofrental.com/v1/apikey/contacts
  2. In the second type, you will need to include the ID of the entity you are requesting.
    Example: If you have a contact with ID 12345,
    https://api.pointofrental.com/v1/apikey/contacts/{ContactId} could resolve to
    https://api.pointofrental.com/v1/apikey/contacts/12345

Your API Key should be included in the request by placing it in the X-API-Key header. Here is a sample request:

GET /apikey/customers
X-API-Key: <YOUR API KEY GOES HERE>

Filtering

Supported by Elite and Syrinx:

  • =, ==
  • <
  • <=
  • >
  • >=
  • AND
  • OR
  • IS NULL, ISNULL
  • NOT NULL, NOTNULL
  • IN
  • NOT IN
  • NOT, <>, !=
  • LIKE
  • RLIKE
  • LLIKE

Only supported per-endpoint where noted:

  • Search

Additional comparaters supported by Elite:

  • !LIKE
  • !RLIKE
  • !LLIKE

Filters are of the form:

{
    "field": "The field from the model to compare.",
    "type": "The type of comparator (from above list).",
    "value": "The value to compare the field to."
}

Example:

GET /apikey/customers
X-Filter: [
    {
    "type": "AND",
    "value": [
        {
        "field": "Name",
        "type": "LIKE",
        "value": "John Doe"
        },
        {
        "field": "CompanyName",
        "type": "LIKE",
        "value": "XYZ Company"
        }
    ]
    }
]

Search filter example:

GET /apikey/contacts
X-Filter: [
    {
    "field": "Search",
    "type": "==",
    "value": "some search query"
    }
]

Paging

Note: 100 is the upper limit on page size requests.

Paging example:

GET /apikey/contracts
X-Paging: {
    "page": 1,
    "pageSize": 25
}

Response Codes

2xx Responses:
    Create:
    201 - Record created.
    Get All:
    200 - Record(s) found.
    Get by Id:
    200 - Record found.
    Update:
    200 - Record updated.
    Delete:
    200 - Record deleted.
    204 - No record found to delete.

4xx Responses:
    Bad Request:
    400 - The request is malformed in some way. See the response message for details.
    Unauthorized:
    403 - Resource exists but you do not have access.
    Not Found:
    404 - Resource does not exist.

Categories

Overview

Categories allow you to organize your rental inventory into logical groups. These can be used for reporting, filtering, and organization of your rental items.

Key Capabilities

  • Create, retrieve, update, and delete categories
  • Organize items hierarchically with parent/child relationships
  • Filter items by category in other API endpoints
  • Hide categories without deleting them

Get all categories

Returns a list of all categories in the system. Results can be filtered and sorted.

Authorizations:
API Key
query Parameters
hidden
boolean

Filter to only return hidden or visible categories

sort
string
Default: "name"
Enum: "name" "id"

Field to sort results by

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Category"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

Identifiers
object or null
Default: {}

Identifying items for Category.

DepartmentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The department id for this category

DepartmentName
string or null
Default: "Example Name"

(Elite Only) The department name for this category

Description
string or null
Default: "This is an example description for the API documentation."

This should describe the category. Likely a single sentence, but could be small paragraph.

Elite: This field is not supported.

DisplayOrder
number or null >= 1
Default: 42.5

By default, we might sort by A -> Z, but in some cases, stores may want to manually set an items display order within a category. This is the internal products display order and may not be optimal for customer facing usages.

Elite: This field is not supported.

Division
string or null
Default: "example value"

The division of a company.

Array of objects
Default: []

An array of publicly accessible URLs or URI's that resolve to images of the item. Also, supports some metadata. We will assume they are in order so that the first one in the list is the default image for the item.

Elite: This field is not supported.

ParentCategoryId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CategoryId.

Elite: This field is not supported.

Tags
Array of strings
Default: ["example item 1","example item 2"]

This is an array of tags or keywords. Generally expected to be like a subcategory.

Elite: This field is not supported.

AdditionalFields
object or null
Default: {}

Additional fields for Category.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted.

Elite: This is always 0.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single category by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
CategoryId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Category"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

Identifiers
object or null
Default: {}

Identifying items for Category.

DepartmentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The department id for this category

DepartmentName
string or null
Default: "Example Name"

(Elite Only) The department name for this category

Description
string or null
Default: "This is an example description for the API documentation."

This should describe the category. Likely a single sentence, but could be small paragraph.

Elite: This field is not supported.

DisplayOrder
number or null >= 1
Default: 42.5

By default, we might sort by A -> Z, but in some cases, stores may want to manually set an items display order within a category. This is the internal products display order and may not be optimal for customer facing usages.

Elite: This field is not supported.

Division
string or null
Default: "example value"

The division of a company.

Array of objects
Default: []

An array of publicly accessible URLs or URI's that resolve to images of the item. Also, supports some metadata. We will assume they are in order so that the first one in the list is the default image for the item.

Elite: This field is not supported.

Array
Uri
string

This must be a publicly accessible URL on the internet. That would infer the image is hosted in the cloud. Alternatively, you can pass in a Data URI. See wiki for Data URI

AltText
string or null

Text found in Alt image field

ParentCategoryId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CategoryId.

Elite: This field is not supported.

Tags
Array of strings
Default: ["example item 1","example item 2"]

This is an array of tags or keywords. Generally expected to be like a subcategory.

Elite: This field is not supported.

AdditionalFields
object or null
Default: {}

Additional fields for Category.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted.

Elite: This is always 0.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": { },
  • "DepartmentId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DepartmentName": "Example Name",
  • "Description": "This is an example description for the API documentation.",
  • "DisplayOrder": 42.5,
  • "Division": "example value",
  • "Images": [ ],
  • "ParentCategoryId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Tags": [
    ],
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Enum Lookup for categories

Supported by: Elite

With this endpoint, you can look up enums related to categories. Currently, the only enum used is "departmentid".

Authorizations:
API Key
path Parameters
field
required
string

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Lookup"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

Description
string or null
Default: "This is an example description for the API documentation."
Field
string
Default: "example value"
Value
string
Default: "example value"

Response samples

Content type
application/json
[
  • {
    }
]

Contacts

Overview

Contacts represent individuals associated with customers, vendors, or your own organization. They store contact information including phone numbers, email addresses, and roles.

Key Capabilities

  • Create, retrieve, update, and delete contacts
  • Associate contacts with customers or vendors
  • Store multiple phone numbers and email addresses
  • Track contact roles and departments

Create a new Contact

Supported by: Elite

Required fields:

  • Name
  • Identifiers.ParentId (Elite)
Authorizations:
API Key
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "Example Name"

The display name for the contact.

object or null
Default: {"DriversLicense":"example value","EmployeeId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Contact.

DriversLicense
string or null
Default: "example value"

The contact's drivers license number.

EmployeeId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The contact's employee id.

ParentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Required by Elite.

Department
string or null <= 50 characters
Default: "example value"

Department of the company.

Disabled
boolean or null
Default: true

This is the state of the Contact record. By default, this state is FALSE. Setting a Contact Disabled property to TRUE temporarily deactivates the Contact until it is updated to FALSE.

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null
Default: []

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

Array
Type
required
string
Value: "Default"

Supported types.

Email
required
string or null <= 50 characters

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null
Default: "Example Name"

First Name (if it's an individual).

Elite: Read-Only

LastName
string or null
Default: "Example Name"

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null
Default: []

Can support multiple phone numbers for a contacts.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Mobile" "Secondary"

Supported phone types. "Default" is the default phone number for the contact.

Elite: Only supports one of each value, "Default" and "Mobile".

Essentials: Only supports "Default" and "Secondary".

Number
required
string or null <= 50 characters

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

Title
string or null <= 255 characters
Default: "example value"

The contact's title.

object or null
Default: {"InactiveDateTime":"2023-08-15"}

Additional fields for Contact.

InactiveDateTime
string or null <date-time>
Default: "2023-08-15"

This is the date that a contact is no longer authorized to be associated with the customer account.

Elite: Supported.
Syrinx: Not supported.

Responses

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "CompanyName": "Example Name",
  • "Department": "example value",
  • "Disabled": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "LastName": "Example Name",
  • "Phones": [ ],
  • "Title": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "CompanyName": "Example Name",
  • "Department": "example value",
  • "Disabled": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "LastName": "Example Name",
  • "Phones": [ ],
  • "Title": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Retrieve a list of Contacts

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Emails.Email
  • Phones.Number
Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Enum: "Contact" "CustomerContact" "VendorContact" "ContractContact"

These are the different types of contact models we can use. Only CustomerContacts are postable. The contact models may be

  • Contact
  • CustomerContact
  • VendorContact
  • ContractContact
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The display name for the contact.

object or null
Default: {"DriversLicense":"example value","EmployeeId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Contact.

Array of objects
Default: []

Can support multiple addresses for a contact.

Elite: This field is not supported.

CompanyName
string or null
Default: "Example Name"

Name of the company.

Elite: This field is not supported.

Department
string or null
Default: "example value"

Department of the company.

Disabled
boolean or null
Default: true

This is the state of the Contact record. By default, this state is FALSE. Setting a Contact Disabled property to TRUE temporarily deactivates the Contact until it is updated to FALSE.

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null
Default: []

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

FirstName
string or null
Default: "Example Name"

First Name (if it's an individual).

Elite: Read-Only

LastName
string or null
Default: "Example Name"

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null
Default: []

Can support multiple phone numbers for a contacts.

Title
string or null
Default: "example value"

The contact's title.

object or null
Default: {"InactiveDateTime":"2023-08-15"}

Additional fields for Contact.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Contact by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
ContactId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Enum: "Contact" "CustomerContact" "VendorContact" "ContractContact"

These are the different types of contact models we can use. Only CustomerContacts are postable. The contact models may be

  • Contact
  • CustomerContact
  • VendorContact
  • ContractContact
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The display name for the contact.

object or null
Default: {"DriversLicense":"example value","EmployeeId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Contact.

DriversLicense
string or null
Default: "example value"

The contact's drivers license number.

EmployeeId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The contact's employee id.

ParentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

In Elite, ParentId is the same as CustomerId.

Array of objects
Default: []

Can support multiple addresses for a contact.

Elite: This field is not supported.

Array
Type
required
string
Default: "Default"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Name
string or null

Optional name for Address

Line1
string or null

Address Number and Street.

Line2
string or null

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

City Address is located in.

GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null

May be State, Province or Division depending on the country.

PostalCode
string or null

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

CompanyName
string or null
Default: "Example Name"

Name of the company.

Elite: This field is not supported.

Department
string or null
Default: "example value"

Department of the company.

Disabled
boolean or null
Default: true

This is the state of the Contact record. By default, this state is FALSE. Setting a Contact Disabled property to TRUE temporarily deactivates the Contact until it is updated to FALSE.

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null
Default: []

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

Array
Type
required
string
Value: "Default"

Supported types.

Email
required
string or null

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null
Default: "Example Name"

First Name (if it's an individual).

Elite: Read-Only

LastName
string or null
Default: "Example Name"

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null
Default: []

Can support multiple phone numbers for a contacts.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Mobile" "Secondary"

Supported phone types. "Default" is the default phone number for the contact.

Elite: Only supports one of each value, "Default" and "Mobile".

Essentials: Only supports "Default" and "Secondary".

Number
required
string or null

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null

Is there an extension associated with this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Title
string or null
Default: "example value"

The contact's title.

object or null
Default: {"InactiveDateTime":"2023-08-15"}

Additional fields for Contact.

InactiveDateTime
string or null <date-time>
Default: "2023-08-15"

This is the date that a contact is no longer authorized to be associated with the customer account.

Elite: Supported.
Syrinx: Not supported.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "CompanyName": "Example Name",
  • "Department": "example value",
  • "Disabled": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "LastName": "Example Name",
  • "Phones": [ ],
  • "Title": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Update a single Contact by Id

Supported by: Elite

Required fields:

  • Id
Authorizations:
API Key
path Parameters
ContactId
required
string
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "Example Name"

The display name for the contact.

object or null
Default: {"DriversLicense":"example value","EmployeeId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Contact.

DriversLicense
string or null
Default: "example value"

The contact's drivers license number.

EmployeeId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The contact's employee id.

ParentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Required by Elite.

Department
string or null <= 50 characters
Default: "example value"

Department of the company.

Disabled
boolean or null
Default: true

This is the state of the Contact record. By default, this state is FALSE. Setting a Contact Disabled property to TRUE temporarily deactivates the Contact until it is updated to FALSE.

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null
Default: []

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

Array
Type
required
string
Value: "Default"

Supported types.

Email
required
string or null <= 50 characters

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null
Default: "Example Name"

First Name (if it's an individual).

Elite: Read-Only

LastName
string or null
Default: "Example Name"

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null
Default: []

Can support multiple phone numbers for a contacts.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Mobile" "Secondary"

Supported phone types. "Default" is the default phone number for the contact.

Elite: Only supports one of each value, "Default" and "Mobile".

Essentials: Only supports "Default" and "Secondary".

Number
required
string or null <= 50 characters

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

Title
string or null <= 255 characters
Default: "example value"

The contact's title.

object or null
Default: {"InactiveDateTime":"2023-08-15"}

Additional fields for Contact.

InactiveDateTime
string or null <date-time>
Default: "2023-08-15"

This is the date that a contact is no longer authorized to be associated with the customer account.

Elite: Supported.
Syrinx: Not supported.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Enum: "Contact" "CustomerContact" "VendorContact" "ContractContact"

These are the different types of contact models we can use. Only CustomerContacts are postable. The contact models may be

  • Contact
  • CustomerContact
  • VendorContact
  • ContractContact
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The display name for the contact.

object or null
Default: {"DriversLicense":"example value","EmployeeId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Contact.

DriversLicense
string or null
Default: "example value"

The contact's drivers license number.

EmployeeId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The contact's employee id.

ParentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

In Elite, ParentId is the same as CustomerId.

Array of objects
Default: []

Can support multiple addresses for a contact.

Elite: This field is not supported.

Array
Type
required
string
Default: "Default"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Name
string or null

Optional name for Address

Line1
string or null

Address Number and Street.

Line2
string or null

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

City Address is located in.

GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null

May be State, Province or Division depending on the country.

PostalCode
string or null

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

CompanyName
string or null
Default: "Example Name"

Name of the company.

Elite: This field is not supported.

Department
string or null
Default: "example value"

Department of the company.

Disabled
boolean or null
Default: true

This is the state of the Contact record. By default, this state is FALSE. Setting a Contact Disabled property to TRUE temporarily deactivates the Contact until it is updated to FALSE.

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null
Default: []

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

Array
Type
required
string
Value: "Default"

Supported types.

Email
required
string or null

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null
Default: "Example Name"

First Name (if it's an individual).

Elite: Read-Only

LastName
string or null
Default: "Example Name"

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null
Default: []

Can support multiple phone numbers for a contacts.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Mobile" "Secondary"

Supported phone types. "Default" is the default phone number for the contact.

Elite: Only supports one of each value, "Default" and "Mobile".

Essentials: Only supports "Default" and "Secondary".

Number
required
string or null

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null

Is there an extension associated with this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Title
string or null
Default: "example value"

The contact's title.

object or null
Default: {"InactiveDateTime":"2023-08-15"}

Additional fields for Contact.

InactiveDateTime
string or null <date-time>
Default: "2023-08-15"

This is the date that a contact is no longer authorized to be associated with the customer account.

Elite: Supported.
Syrinx: Not supported.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "CompanyName": "Example Name",
  • "Department": "example value",
  • "Disabled": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "LastName": "Example Name",
  • "Phones": [ ],
  • "Title": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "CompanyName": "Example Name",
  • "Department": "example value",
  • "Disabled": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "LastName": "Example Name",
  • "Phones": [ ],
  • "Title": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Contract Actions

Call a Contract Off Rent

Supported by: Elite

Authorizations:
API Key
Request Body schema: application/json
required
ContractId
required
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique id for the contract

CalledOffDateTime
required
string <date-time>
Default: "2023-08-15"

What date and time to call off the line item. UTC time zone. e.g. 2023-01-01T06:00:00Z

PersonCallingOff
string
Default: "example value"

Name of the person who is calling the contract off rent.

Memo
string
Default: "example value"

Additional textual information for calling a contract off rent.

RemoteUserId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

An identifier on the remote server for the user's account. Can be User ID, Username, anything to match the Relationship to a user.

Responses

Request samples

Content type
application/json
{
  • "ContractId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "CalledOffDateTime": "2023-08-15",
  • "PersonCallingOff": "example value",
  • "Memo": "example value",
  • "RemoteUserId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "AmountDue": 99.99,
  • "AmountPaid": 99.99,
  • "Contacts": [ ],
  • "ContractInformation": "example value",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "CustomerName": "Example Name",
  • "CustomerPickup": {
    },
  • "DriverDelivery": {
    },
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DriverPickup": {
    },
  • "EndDateTime": "2023-08-15",
  • "EsignState": "example value",
  • "EsignUrl": "https://example.com",
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "LaborTracking": {
    },
  • "LineItems": [ ],
  • "LocationId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Notes": [ ],
  • "Precheck": true,
  • "PONumber": "example value",
  • "StartDateTime": "2023-08-15",
  • "Status": "active",
  • "Totals": [ ],
  • "Workflows": [ ],
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "ContractStatus": "active",
  • "IsDelivery": true,
  • "IsPickup": true,
  • "Revision": 42
}

Contracts

Retrieve a list of Contracts

Supported by: Elite, Syrinx

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Contract"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"InvoiceNumber":"example value","Barcode":"ABC123","Alias":"example value","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Contract.

Array of objects
Default: []

Site addresses. Address type should be default.

AmountDue
number
Default: 99.99

The amount due on this contract as of the queried date. If additional payments are made or costs are added, this field will reflect the updated amount in the next request.

AmountPaid
number
Default: 99.99

The total amount paid on this contract as of the queried date. If additional payments are made, this field will reflect the updated total in the next request

Array of objects
Default: []

Contact records and their corresponding types.

ContractInformation
string or null
Default: "example value"

Text field for additional details to be added to a Contract that would make it easier to identify based on the context entered.

Supported by: Elite, Essentials

CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CustomerId that should be responsible for this Contract.

CustomerName
string or null
Default: "Example Name"

The Customer Name (usually will include first and last name).

object or null
Default: {"LocationName":"Example Name","Address":null,"Instructions":"example value","DateTime":"2023-08-15"}
object or null
Default: {"LocationName":"Example Name","Address":{},"Instructions":"example value","DateTime":"2023-08-15"}

For Internal Use. Location, address, special instructions and data/time of Delivery

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

object or null
Default: {"LocationName":"Example Name","Address":null,"Instructions":"example value","DateTime":"2023-08-15"}
EndDateTime
string or null <date-time>
Default: "2023-08-15"

UTC When does the customer intend to return the items?

EsignState
string
Default: "None"
Enum: "None" "Requested" "Signed" "Rejected"

This represents the status of a document, indicating whether it has been signed or not.

EsignUrl
string or null
Default: "https://example.com"

Reference to Esign URL for this contract. This can be used to pull up a copy of the Esignature or for the mobile app to prompt for one.

GrandTaxTotal
number or null
Default: 42.5

This is the final projected tax for this contract.

GrandTotal
number or null
Default: 42.5

This is the final projected total price for this contract accounting for qty, discounts, duration, tax, etc..

object or null
Default: {"LaborTypes":[]}

Labor tracking details.

Array of objects (ContractLineItem)
Default: []

The Line Items associated with this contract.

LocationId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Location. (see the Location endpoints)

Array of objects
Default: []

Any comments or notes.

Precheck
boolean
Default: true

Has a contract been prechecked. This is only available if the user passes in this explicitly in the precheck x-columns

PONumber
string or null
Default: "example value"

A number associated to a Contract. Thi is user definable and associated by a POR user and their customer.

StartDateTime
string or null <date-time>
Default: "2023-08-15"

UTC When does the customer want the items?

Status
string
Default: "active"
Enum: "Quote" "Reservation" "Open" "Returned" "Off Rent" "Closed" "Voided" null

What is the current status of the contract?

  • Quote:
  • Reservation
  • Open
  • Returned: All inventory has reached its final spot. Accounted for.
  • Off Rent: All inventory assets are awaiting collection prior to finalization of the contract values.
  • Closed: No further activity available for this contract. Fully Paid.
  • Voided
Array of objects or null
Default: []

Lines which should appear in the totals section for the contract

Array of objects
Default: []

For Internal Use.

object or null
Default: {"ClassId":42.5,"ClassName":"Example Name","CurrencyCode":"USD","CustomerJobNumber":"example value","CustomerPurchaseOrder":"example value","OrderedBy":"example value","PrecheckCompletedDateTime":"2023-08-15","ReceivedBy":"example value"}

Additional fields for Contract.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC When was the contract created? Should be the time the Quote / Contract was created / inserted into the DB.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC When was the contract updated?

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

ContractStatus
string
Deprecated
Default: "active"
Enum: "Quote" "Reservation" "Open" "Returned" "Closed" "Voided" null

Deprecated: Use Status field instead.

What is the current status of the contract?

  • Quote:
  • Reservation
  • Open
  • Returned: All inventory has reached its final spot. Accounted for.
  • Closed: No further activity available for this contract. Fully Paid.
  • Voided
IsDelivery
boolean
Default: true

True when the contract is marked for delivery.

IsPickup
boolean
Default: true

True when the contract is marked for customer pickup.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Contract by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Contract"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"InvoiceNumber":"example value","Barcode":"ABC123","Alias":"example value","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Contract.

InvoiceNumber
string or null
Default: "example value"

The Sequential Invoice Number associated with the Contract.

On Elite systems enabled for sequential Invoicing, this value (read only) represents the ID of the Invoice.

Barcode
string or null
Default: "ABC123"

The barcode identifier assigned to this particular Line Item.

Elite: This field is not supported.

Alias
string or null
Default: "example value"

The alias identifier assigned to this particular Line Item.

Elite: This field is not supported.

ParentId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The parent ContractId for this contract. Will be this contract's Id if no parent contract exists

Array of objects
Default: []

Site addresses. Address type should be default.

Array
Type
required
string
Default: "Default"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Name
string or null

Optional name for Address

Line1
string or null

Address Number and Street.

Line2
string or null

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported. and will always return null. There are no plans to support this in Elite.

City
string or null

City Address is located in.

GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null

May be State, Province or Division depending on the country.

PostalCode
string or null

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported. and will always return null. There are no plans to support this in Elite.

AmountDue
number
Default: 99.99

The amount due on this contract as of the queried date. If additional payments are made or costs are added, this field will reflect the updated amount in the next request.

AmountPaid
number
Default: 99.99

The total amount paid on this contract as of the queried date. If additional payments are made, this field will reflect the updated total in the next request

Array of objects
Default: []

Contact records and their corresponding types.

Array
Type
string
Enum: "Default" "Customer" "Delivery" "Pickup" "Order" "Billing" null

This property describes the role or relationship a contact has with this contract.

  • Default: Contacts related to the customer on the contract that aren’t related to the contacts below.
  • Customer: The customer's information. This data should be the same querying the customers endpoint with the CustomerId field. This is not supported in Elite
  • Pickup: Pickup contact information
  • Delivery: Delivery contact information
  • Order: Not implemented
  • Billing: Not implemented
object
ContractInformation
string or null
Default: "example value"

Text field for additional details to be added to a Contract that would make it easier to identify based on the context entered.

Supported by: Elite, Essentials

CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CustomerId that should be responsible for this Contract.

CustomerName
string or null
Default: "Example Name"

The Customer Name (usually will include first and last name).

object or null
Default: {"LocationName":"Example Name","Address":null,"Instructions":"example value","DateTime":"2023-08-15"}
LocationName
string or null
Default: "Example Name"
(object or null) or (any or null)
Default: null
Instructions
string or null
Default: "example value"
DateTime
string or null <date-time>
Default: "2023-08-15"

Day and time delivery is expected to be completed.

object or null
Default: {"LocationName":"Example Name","Address":{},"Instructions":"example value","DateTime":"2023-08-15"}

For Internal Use. Location, address, special instructions and data/time of Delivery

LocationName
string or null
Default: "Example Name"
(object or null) or (object or null)
Default: {}
Instructions
string or null
Default: "example value"
DateTime
string or null <date-time>
Default: "2023-08-15"

Day and time delivery is expected to be completed.

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

object or null
Default: {"LocationName":"Example Name","Address":null,"Instructions":"example value","DateTime":"2023-08-15"}
LocationName
string or null
Default: "Example Name"
object or (any or null)
Default: null

Customer or vendor addresses. Not all address fields may be filled depending on someone's location.

Elite: Only "Default" is supported.

Instructions
string or null
Default: "example value"
DateTime
string or null <date-time>
Default: "2023-08-15"

Day and time delivery is expected to be completed.

EndDateTime
string or null <date-time>
Default: "2023-08-15"

UTC When does the customer intend to return the items?

EsignState
string
Default: "None"
Enum: "None" "Requested" "Signed" "Rejected"

This represents the status of a document, indicating whether it has been signed or not.

EsignUrl
string or null
Default: "https://example.com"

Reference to Esign URL for this contract. This can be used to pull up a copy of the Esignature or for the mobile app to prompt for one.

GrandTaxTotal
number or null
Default: 42.5

This is the final projected tax for this contract.

GrandTotal
number or null
Default: 42.5

This is the final projected total price for this contract accounting for qty, discounts, duration, tax, etc..

object or null
Default: {"LaborTypes":[]}

Labor tracking details.

Array of objects or null
Default: []
Array of objects (ContractLineItem)
Default: []

The Line Items associated with this contract.

Array
ModelType
string
Value: "LineItem"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null

A display name for this record. Often used as a summary for lookups.

object or null

Identifying items for LineItem.

Classification
string
Enum: "Rental" "Sale" null

This product is either meant for sale or rental. The internal classification does not apply to lineitems.

FuelCapacity
number or null

If this item has a fuel, this is the total amount of fuel this line item can have. No units are provided. If the value returned is “0” that means that a fuel capacity has been provided, and it doesn’t have any. If “null” is provided, then no fuel capacity has been recorded. This field should only show up if the isFuel field is true.

HasFuel
boolean or null

If this is related to an item that uses fuel, this field will be set. If not it will be false.

IsSerialized
boolean or null

Do we expect this Line Item to have a unique Serial Number or is it a bulk item? NOTE - Some bulk items may still have serial numbers in some systems.

IsBulk
boolean or null

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ItemId
string or null
Deprecated

Kept for legacy support, will eventually only need StockId and ProductId.

LineTaxTotal
number or null

This is the final projected tax for this line.

LineTotal
number or null

This is the final projected price for this line accounting for qty, discounts, duration, tax, etc..

Array of objects or null

Meter readings of this inventory. Multiple readings allowed for different types.

Notes
string or null

Notes attached to a line item. Not an array of notes like its similarly name fields.

ProductId
string or null

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

Quantity
number

How many of this Line Item are there? NOTE - there can be multiple Line Items that have the same inventory item associated with them for various reasons so this does not mean that ALL of the [some inventory] will show up under this Line Item.

Rates
Array of strings or null

The rates that have been associated to this line item as shown on the Contract. The Rental Management Software may apply these from default, or special rates.

SerialNumber
string or null

The serial number or unique identifier assigned to this particular Line Item.

ShowOnContract
boolean
Default: true

Is it a component/unincluded/optional item to display on contract. If false this item should generally not be shown to the consumer.

SortOrder
number or null

The SortOrder value corresponds to the sequenceId in the line items for a Contract.

Status
string or null
Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved".

  • Reserved
  • Out
  • Off Rent
  • Returned
  • Sold
StockId
string or null

This is likely to replace ItemId as the reference to which "Item" or "Inventory" this record is related to. (This field is still a work in progres from the API standpoint so we may end up going another direction. Use with caution.)

Array of objects

For Internal Use Only.

object or null

Additional fields for this LineItem.

Array of objects

All rates for this product or stock whether relevant or not. In most cases, you will want to use applicable rates.

CreatedDateTime
string or null <date-time>

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Enum: null 1

0 = false, 1 = true | This basically means Deleted

LocationId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Location. (see the Location endpoints)

Array of objects
Default: []

Any comments or notes.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Delivery" "Pickup"

Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.

Value
required
string or null

The note text.

Precheck
boolean
Default: true

Has a contract been prechecked. This is only available if the user passes in this explicitly in the precheck x-columns

PONumber
string or null
Default: "example value"

A number associated to a Contract. Thi is user definable and associated by a POR user and their customer.

StartDateTime
string or null <date-time>
Default: "2023-08-15"

UTC When does the customer want the items?

Status
string
Default: "active"
Enum: "Quote" "Reservation" "Open" "Returned" "Off Rent" "Closed" "Voided" null

What is the current status of the contract?

  • Quote:
  • Reservation
  • Open
  • Returned: All inventory has reached its final spot. Accounted for.
  • Off Rent: All inventory assets are awaiting collection prior to finalization of the contract values.
  • Closed: No further activity available for this contract. Fully Paid.
  • Voided
Array of objects or null
Default: []

Lines which should appear in the totals section for the contract

Array
Label
string

the full label which may have embedded within it a tax rate or partial tax rate etc. with separator e.g. 'Grand Prairie 8.25' or 'Damage Waiver' NOT 'Damage Waiver:'

Value
number

the amount in the appropriate currency with no currency symbol and us-style decimal, e.g. 1030.59

Array of objects
Default: []

For Internal Use.

Array
Creatable
boolean or null

Can the workflow be created?

TemplateId
string or null
PhotoPickerType
string
Enum: "Default" "Image360" "None" null

Options are None, Generic, 360

RequiredPhotos
number or null
object or null
Default: {"ClassId":42.5,"ClassName":"Example Name","CurrencyCode":"USD","CustomerJobNumber":"example value","CustomerPurchaseOrder":"example value","OrderedBy":"example value","PrecheckCompletedDateTime":"2023-08-15","ReceivedBy":"example value"}

Additional fields for Contract.

ClassId
number or null
Default: 42.5
Enum: -1 null 1 2 3 4 5 6 7 8 9 10 11 12 13 14

(Elite Only) Identifies what kind of contract this is:

  • NotSet: -1
  • StandardContract: 0
  • ContinuationContract: 1
  • InternalRepair: 2
  • InternalMaintenance: 3
  • InternalService: 4
  • WorkOrder: 5
  • Transfer: 6
  • RoundTripTransfer: 7
  • LogisticsTicket: 8
  • Subrental: 9
  • FinanceCharges: 10
  • Credit: 11
  • EventContract: 12
  • DelayContract: 13
  • HistoricalContract: 14
ClassName
string or null
Default: "Example Name"

The name of the given ClassId on this contract. A string version of ClassId provided for convenience

CurrencyCode
string or null
Default: "USD"

(Syrinx Only) Country-specific currency code for the contract. For example: USD, AUD, EUR, etc.

CustomerJobNumber
string or null
Default: "example value"

(Elite Only) Rental customer supplied identifier for this contract.

CustomerPurchaseOrder
string or null
Default: "example value"

(Elite Only) Rental customer supplied purchase order for this contract.

OrderedBy
string or null
Default: "example value"

(Elite Only) The name of the person who requested this contract.

PrecheckCompletedDateTime
string or null <date-time>
Default: "2023-08-15"

Elite Only: When was a contract prechecked. All date times are expected to be in UTC & ISO-8601 format.

ReceivedBy
string or null
Default: "example value"

(Elite Only) The name of the person who received the items for this contract.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC When was the contract created? Should be the time the Quote / Contract was created / inserted into the DB.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC When was the contract updated?

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

ContractStatus
string
Deprecated
Default: "active"
Enum: "Quote" "Reservation" "Open" "Returned" "Closed" "Voided" null

Deprecated: Use Status field instead.

What is the current status of the contract?

  • Quote:
  • Reservation
  • Open
  • Returned: All inventory has reached its final spot. Accounted for.
  • Closed: No further activity available for this contract. Fully Paid.
  • Voided
IsDelivery
boolean
Default: true

True when the contract is marked for delivery.

IsPickup
boolean
Default: true

True when the contract is marked for customer pickup.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

One of
number
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "AmountDue": 99.99,
  • "AmountPaid": 99.99,
  • "Contacts": [ ],
  • "ContractInformation": "example value",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "CustomerName": "Example Name",
  • "CustomerPickup": {
    },
  • "DriverDelivery": {
    },
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DriverPickup": {
    },
  • "EndDateTime": "2023-08-15",
  • "EsignState": "example value",
  • "EsignUrl": "https://example.com",
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "LaborTracking": {
    },
  • "LineItems": [ ],
  • "LocationId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Notes": [ ],
  • "Precheck": true,
  • "PONumber": "example value",
  • "StartDateTime": "2023-08-15",
  • "Status": "active",
  • "Totals": [ ],
  • "Workflows": [ ],
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "ContractStatus": "active",
  • "IsDelivery": true,
  • "IsPickup": true,
  • "Revision": 42
}

Retrieve files for a single Contract by Id.

Supported by: Elite

Authorizations:
API Key
path Parameters
ContractId
required
string
tagKey
required
string

pdfs or instructions or photos

Responses

Response Schema: application/json
Array
FileName
string
Default: "Example Name"

Original local filename.

FileClass
string
Default: "example value"
Enum: "misc" "image" "video"

Defines the type of stored file.

PublicURL
string
Default: "https://example.com"

Web URL where the stored file can be downloaded.

URLDateTime
string <date-time>
Default: "https://example.com"

The date/time the URL was retrieved/created.

URLExpires
integer
Default: 42

Number of seconds from URLDateTime until URL expires.

TagMapKey
string
Default: "example value"
Enum: "pdfs" "instructions" "photos"

Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).

ObjectPrimaryKey
string
Default: "example value"

Primary key of the object this file is associated with (same as in the URL for single object get).

ObjectType
string
Default: "standard"

Type of object: One of Products, stock, or contract.

Tags
Array of strings
Default: ["example item 1","example item 2"]

List of all the tag names associated with each file (ONLY the TagName).

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Tax Details for a single Contract by Id.

Supported by: Elite

Authorizations:
API Key
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
Array of objects
Default: []

An array of tax details for the contract

Array
JurisdictionName
required
string

The name of the jurisdiction imposing the tax

TaxName
required
string

The official name of the tax

TaxAmount
required
number

The total tax amount applied.

TaxableRevenue
required
number

The amount of revenue subject to tax.

TaxRate
required
number

The percentage rate at which the tax is applied.

AliasName
string or null

The user-defined alias for the tax

Response samples

Content type
application/json
{
  • "TaxDetails": [ ]
}

Payment Boundaries

Authorizations:
API Key
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
Array
Array of objects
Default: []

Response samples

Content type
application/json
[
  • {
    }
]

Customers

Overview

Customers are the businesses or individuals who rent equipment from your company. This API allows you to manage customer data including addresses, contacts, and account settings.

Key Capabilities

  • Create, retrieve, update, and delete customers
  • Manage customer addresses and contacts
  • Set credit limits and tax exemption status
  • Track customer activity and preferences

Create a new Customer

Supported by: Elite

Required fields:

  • If RecordType is "Business", then:
    • FirstName
    • LastName
  • Otherwise:
    • Name
Authorizations:
API Key
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "Example Name"

Can be a company or individual name.

object or null
Default: {"AccountNumber":"example value","CustomerKey":"example value","DriversLicense":"example value","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FederalId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InsuranceNumber":"example value","OtherId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","RegistrationNumber":"example value","TaxNumber":"example value","VatNumber":"example value"}

These are unique properties that are specific to certain products (Elite, Essentials, Syrinx).

Supported List

All

  • TaxNumber

Elite Only

  • CustomerKey
  • DriversLicense
  • FederalId
  • InsuranceNumber
  • OtherId

Syrinx Only

  • AccountNumber
  • RegistrationNumber
  • VatNumber

Not all properties are valid across all products.

CustomerKey
string or null
Default: "example value"

(Elite Only) Unique user defined customer identifier.

If no value is provided, this will be set to the same value as Id.

DriversLicense
string or null
Default: "example value"

(Elite Only) Drivers license for individual type customers.

ExternalCustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The value from a 3rd party system that identifies the Customer record

FederalId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) FederalId of Customer.

InsuranceNumber
string or null
Default: "example value"

(Elite Only) Insurance Number of Customer.

OtherId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) Addtional Id's of Customer.

TaxNumber
string or null
Default: "example value"

(Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite.

Array of objects
Default: []

Supported types will depend on the product.

Elite:

  • Supported: "Customer"
  • Coming Soon: "Default", "Billing"
Array
Type
required
string
Default: "Default"
Enum: "Customer" "Billing"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Line1
string or null <= 150 characters

Address Number and Street.

Line2
string or null <= 150 characters

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148.
GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null >= 2 characters

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148.
PostalCode
string or null <= 50 characters

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

BillingName
string or null <= 50 characters
Default: "Example Name"

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type.

Classification
string or null
Default: "example value"

What kind of customer is this? Examples: Plumber, Homeowner, Soletrader. This could also be the customers Job Title.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Classification" to receive a list of acceptable values for this field.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Supported.

Array
Type
required
string
Default: "Default"
Value: "Default"
required
object
CreditLimit
integer or null <= 2147483647
Default: 42

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

DoNotEmail
boolean or null
Default: true

Prevents the software from sending 'marketing' emails.

Array of objects
Default: []
Array
Type
required
string
Value: "Primary"

Supported types.

Email
required
string <= 50 characters

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null [ 1 .. 50 ] characters
Default: "Example Name"

First Name of Customer (individual only).

HeardAboutUs
string or null
Default: "example value"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "HeardAboutUs" to receive a list of acceptable values for this field.

LastName
string or null [ 1 .. 50 ] characters
Default: "Example Name"

Last Name of Customer (individual only).

Locale
string or null
Default: "en-US"

Defaults to "en-US". Code is ISO 639 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Locale" to receive a list of acceptable values for this field.

Nontaxable
boolean or null
Default: true

Means no tax is calculated for this customer on any contracts

Array of objects
Default: []
Array
Type
required
string
Default: "Default"

Supported phone types. "Default" is the default phone number for the contact. Elite uses "Mobile" as a secondary number whereas Essentials uses "Secondary".

Number
required
string or null <= 50 characters

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

RecordType
string
Default: "Business"
Enum: "Business" "Individual"

Denotes if this record is a business or an individual.

object or null
Default: {"ModelType":"standard","Id":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","Name":"Example Name","Email":{"Type":"standard","Email":"[email protected]"},"FirstName":"Example Name","LastName":"Example Name"}

Data related to the sales person associated with the Customer.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object
Default: {"Type":"standard","Email":"[email protected]"}

See the Type description for what types are supported on each product.

Status
string
Default: "Lead"
Enum: "Lead" "Prospect" "Cash" "Account"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Status" to receive a list of acceptable values for this field.

ExternalReceivableBalance
number
Default: 42.5

(Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization.

object or null
Default: {"CustomerWebPortal":true,"ExternalTaxClass":"example value","ExternalTaxCode":"ABC123","ForceContractInfo":true,"ForceJobId":true,"ForcePickedUp":true,"ForcePurchaseOrder":true,"InvoiceSendBy":"example value","Restrictions":"example value","StatementSendBy":"example value","Terms":"example value","UserDefined1":"example value","UserDefined2":"example value"}

Additional fields for Customer.

CustomerWebPortal
boolean or null
Default: true

(Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature.

ExternalTaxClass
string or null
Default: "example value"

(Elite Only) A user definable field for an External Tax Service.

ExternalTaxCode
string or null
Default: "ABC123"

(Elite Only) A user definable field for an External Tax Service.

ForceContractInfo
boolean or null
Default: true

(Elite Only) Requires the employee to collect a text value to identify the contract's purpose.

ForceJobId
boolean or null
Default: true

(Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs.

ForcePickedUp
boolean or null
Default: true

(Elite Only) Requires the employee to collect the name of the person picking up the items.

ForcePurchaseOrder
boolean or null
Default: true

(Elite Only) Flag to force purchase orders.

InvoiceSendBy
string
Default: "example value"
Enum: "Email" "Fax" "No Statement" "Printer" null

(Elite Only) Determines how a customer will receive contracts.

Restrictions
string or null
Default: "example value"

What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions

StatementSendBy
string
Default: "example value"
Enum: "Email" "Fax" "No Statement" "Printer" null

(Elite Only) Determines how a customer will receive statements.

Terms
string or null <= 50 characters
Default: "example value"

(Elite Only) Terms for the customer.

UserDefined1
string or null <= 50 characters
Default: "example value"

Placeholder field.

UserDefined2
string or null <= 50 characters
Default: "example value"

Placeholder field.

Responses

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "BillingName": "Example Name",
  • "Classification": "example value",
  • "CompanyName": "Example Name",
  • "Contacts": [ ],
  • "CreditLimit": 42,
  • "CurrencyCode": "USD",
  • "DoNotEmail": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "HeardAboutUs": "example value",
  • "LastName": "Example Name",
  • "Locale": "example value",
  • "Nontaxable": true,
  • "PaymentTerms": "example value",
  • "Phones": [ ],
  • "RecordType": "standard",
  • "SalesPerson": {
    },
  • "Status": "active",
  • "ExternalReceivableBalance": 42.5,
  • "AdditionalFields": {
    },
  • "Revision": 42,
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "BillingName": "Example Name",
  • "Classification": "example value",
  • "CompanyName": "Example Name",
  • "Contacts": [ ],
  • "CreditLimit": 42,
  • "CurrencyCode": "USD",
  • "DoNotEmail": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "HeardAboutUs": "example value",
  • "LastName": "Example Name",
  • "Locale": "example value",
  • "Nontaxable": true,
  • "PaymentTerms": "example value",
  • "Phones": [ ],
  • "RecordType": "standard",
  • "SalesPerson": {
    },
  • "Status": "active",
  • "ExternalReceivableBalance": 42.5,
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Retrieve a list of Customers

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Identifiers.CustomerKey
  • Addresses.Line1
  • Addresses.City
  • Addresses.State
  • Addresses.PostalCode
  • Phones.Number
Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Customer"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

Can be a company or individual name.

object or null
Default: {"AccountNumber":"example value","CustomerKey":"example value","DriversLicense":"example value","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FederalId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InsuranceNumber":"example value","OtherId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","RegistrationNumber":"example value","TaxNumber":"example value","VatNumber":"example value"}

These are unique properties that are specific to certain products (Elite, Essentials, Syrinx).

Supported List

All

  • TaxNumber

Elite Only

  • CustomerKey
  • DriversLicense
  • FederalId
  • InsuranceNumber
  • OtherId

Syrinx Only

  • AccountNumber
  • RegistrationNumber
  • VatNumber

Not all properties are valid across all products.

Array of objects
Default: []

Supported types will depend on the product.

Elite: only supports one "Customer" and one "Billing" address.

BillingName
string or null
Default: "Example Name"

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type.

Classification
string or null
Default: "example value"

What kind of customer is this? Examples: Plumber, Homeowner, Soletrader. This could also be the customers Job Title.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Classification" to receive a list of acceptable values for this field.

CompanyName
string or null
Default: "Example Name"

Name of the Company.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Supported.

CreditLimit
integer or null
Default: 42

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

DoNotEmail
boolean or null
Default: true

Prevents the software from sending 'marketing' emails.

Array of objects
Default: []
FirstName
string or null
Default: "Example Name"

First Name of Customer (individual only).

HeardAboutUs
string or null
Default: "example value"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "HeardAboutUs" to receive a list of acceptable values for this field.

LastName
string or null
Default: "Example Name"

Last Name of Customer (individual only).

Locale
string or null
Default: "en-US"

Defaults to "en-US". Code is ISO 639 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Locale" to receive a list of acceptable values for this field.

Nontaxable
boolean or null
Default: true

Means no tax is calculated for this customer on any contracts

PaymentTerms
string or null
Default: "example value"

(Currently not supported)

Array of objects
Default: []
RecordType
string
Default: "Business"
Enum: "Business" "Individual"

Denotes if this record is a business or an individual.

object or null
Default: {"ModelType":"standard","Id":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","Name":"Example Name","Email":{"Type":"standard","Email":"[email protected]"},"FirstName":"Example Name","LastName":"Example Name"}

Data related to the sales person associated with the Customer.

Status
string
Default: "Lead"
Enum: "Lead" "Prospect" "Cash" "Account"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Status" to receive a list of acceptable values for this field.

ExternalReceivableBalance
number
Default: 42.5

(Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization.

object or null
Default: {"CustomerWebPortal":true,"ExternalTaxClass":"example value","ExternalTaxCode":"ABC123","ForceContractInfo":true,"ForceJobId":true,"ForcePickedUp":true,"ForcePurchaseOrder":true,"InvoiceSendBy":"example value","Restrictions":"example value","StatementSendBy":"example value","Terms":"example value","UserDefined1":"example value","UserDefined2":"example value"}

Additional fields for Customer.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Customer by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
CustomerId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Customer"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

Can be a company or individual name.

object or null
Default: {"AccountNumber":"example value","CustomerKey":"example value","DriversLicense":"example value","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FederalId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InsuranceNumber":"example value","OtherId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","RegistrationNumber":"example value","TaxNumber":"example value","VatNumber":"example value"}

These are unique properties that are specific to certain products (Elite, Essentials, Syrinx).

Supported List

All

  • TaxNumber

Elite Only

  • CustomerKey
  • DriversLicense
  • FederalId
  • InsuranceNumber
  • OtherId

Syrinx Only

  • AccountNumber
  • RegistrationNumber
  • VatNumber

Not all properties are valid across all products.

AccountNumber
string or null
Default: "example value"

(Syrinx Only) Unique user defined customer identifier.

CustomerKey
string or null
Default: "example value"

(Elite Only) Unique user defined customer identifier.

If no value is provided, this will be set to the same value as Id.

DriversLicense
string or null
Default: "example value"

(Elite Only) Drivers license for individual type customers.

ExternalCustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The value from a 3rd party system that identifies the Customer record

FederalId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) FederalId of Customer.

InsuranceNumber
string or null
Default: "example value"

(Elite Only) Insurance Number of Customer.

OtherId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) Addtional Id's of Customer.

RegistrationNumber
string or null
Default: "example value"

(Syrinx Only) Registration Number of Customer.

TaxNumber
string or null
Default: "example value"

(Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite.

VatNumber
string or null
Default: "example value"

(Syrinx Only) Vat Number of Customer.

Array of objects
Default: []

Supported types will depend on the product.

Elite: only supports one "Customer" and one "Billing" address.

Array
Type
required
string
Default: "Default"
Enum: "Customer" "Billing"

Examples include "Customer", "Billing", etc. Supported types depend on the context of the address.

Name
string or null

Optional name for Address

Elite: Not supported.

Line1
string or null

Address Number and Street.

Line2
string or null

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148.
GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148.
PostalCode
string or null

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

BillingName
string or null
Default: "Example Name"

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type.

Classification
string or null
Default: "example value"

What kind of customer is this? Examples: Plumber, Homeowner, Soletrader. This could also be the customers Job Title.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Classification" to receive a list of acceptable values for this field.

CompanyName
string or null
Default: "Example Name"

Name of the Company.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Supported.

Array
Type
required
string
Default: "Default"
Value: "Default"
required
object
CreditLimit
integer or null
Default: 42

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

DoNotEmail
boolean or null
Default: true

Prevents the software from sending 'marketing' emails.

Array of objects
Default: []
Array
Type
required
string
Value: "Primary"

Supported types.

Email
required
string or null <= 50 characters

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null
Default: "Example Name"

First Name of Customer (individual only).

HeardAboutUs
string or null
Default: "example value"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "HeardAboutUs" to receive a list of acceptable values for this field.

LastName
string or null
Default: "Example Name"

Last Name of Customer (individual only).

Locale
string or null
Default: "en-US"

Defaults to "en-US". Code is ISO 639 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Locale" to receive a list of acceptable values for this field.

Nontaxable
boolean or null
Default: true

Means no tax is calculated for this customer on any contracts

PaymentTerms
string or null
Default: "example value"

(Currently not supported)

Array of objects
Default: []
Array
Type
required
string
Default: "Default"

Supported phone types.

Number
required
string or null <= 50 characters

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null

Is there an extension associated with this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

RecordType
string
Default: "Business"
Enum: "Business" "Individual"

Denotes if this record is a business or an individual.

object or null
Default: {"ModelType":"standard","Id":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","Name":"Example Name","Email":{"Type":"standard","Email":"[email protected]"},"FirstName":"Example Name","LastName":"Example Name"}

Data related to the sales person associated with the Customer.

ModelType
string
Default: "standard"
Value: "SalesPerson"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "0"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object
Default: {"Type":"standard","Email":"[email protected]"}

See the Type description for what types are supported on each product.

FirstName
string or null
Default: "Example Name"

First name of the sales person.

Elite: This field is not supported.

LastName
string or null
Default: "Example Name"

Last name of the sales person.

Elite: This field is not supported.

Status
string
Default: "Lead"
Enum: "Lead" "Prospect" "Cash" "Account"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Status" to receive a list of acceptable values for this field.

ExternalReceivableBalance
number
Default: 42.5

(Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization.

object or null
Default: {"CustomerWebPortal":true,"ExternalTaxClass":"example value","ExternalTaxCode":"ABC123","ForceContractInfo":true,"ForceJobId":true,"ForcePickedUp":true,"ForcePurchaseOrder":true,"InvoiceSendBy":"example value","Restrictions":"example value","StatementSendBy":"example value","Terms":"example value","UserDefined1":"example value","UserDefined2":"example value"}

Additional fields for Customer.

CustomerWebPortal
boolean or null
Default: true

(Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature.

ExternalTaxClass
string or null
Default: "example value"

(Elite Only) A user definable field for an External Tax Service.

ExternalTaxCode
string or null
Default: "ABC123"

(Elite Only) A user definable field for an External Tax Service.

ForceContractInfo
boolean or null
Default: true

(Elite Only) Requires the employee to collect a text value to identify the contract's purpose.

ForceJobId
boolean or null
Default: true

(Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs.

ForcePickedUp
boolean or null
Default: true

(Elite Only) Requires the employee to collect the name of the person picking up the items.

ForcePurchaseOrder
boolean or null
Default: true

(Elite Only) Flag to force purchase orders.

InvoiceSendBy
string or null
Default: "example value"
Enum: "Email" "Fax" "No Statement" "Printer" "None"

(Elite Only) Determines how a customer will receive contracts.

Restrictions
string or null
Default: "example value"

What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions

StatementSendBy
string or null
Default: "example value"
Enum: "Email" "Fax" "No Statement" "Printer" "None"

(Elite Only) Determines how a customer will receive statements.

Terms
string or null <= 50 characters
Default: "example value"

(Elite Only) Terms for the customer.

UserDefined1
string or null <= 50 characters
Default: "example value"

Placeholder field.

UserDefined2
string or null <= 50 characters
Default: "example value"

Placeholder field.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "BillingName": "Example Name",
  • "Classification": "example value",
  • "CompanyName": "Example Name",
  • "Contacts": [ ],
  • "CreditLimit": 42,
  • "CurrencyCode": "USD",
  • "DoNotEmail": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "HeardAboutUs": "example value",
  • "LastName": "Example Name",
  • "Locale": "example value",
  • "Nontaxable": true,
  • "PaymentTerms": "example value",
  • "Phones": [ ],
  • "RecordType": "standard",
  • "SalesPerson": {
    },
  • "Status": "active",
  • "ExternalReceivableBalance": 42.5,
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Update a single Customer by Id

Supported by: Elite

Required fields:

  • Id
Authorizations:
API Key
path Parameters
CustomerId
required
string
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "Example Name"

Can be a company or individual name.

object or null
Default: {"AccountNumber":"example value","CustomerKey":"example value","DriversLicense":"example value","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FederalId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InsuranceNumber":"example value","OtherId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","RegistrationNumber":"example value","TaxNumber":"example value","VatNumber":"example value"}

These are unique properties that are specific to certain products (Elite, Essentials, Syrinx).

Supported List

All

  • TaxNumber

Elite Only

  • CustomerKey
  • DriversLicense
  • FederalId
  • InsuranceNumber
  • OtherId

Syrinx Only

  • AccountNumber
  • RegistrationNumber
  • VatNumber

Not all properties are valid across all products.

CustomerKey
string or null
Default: "example value"

(Elite Only) Unique user defined customer identifier.

If no value is provided, this will be set to the same value as Id.

DriversLicense
string or null
Default: "example value"

(Elite Only) Drivers license for individual type customers.

ExternalCustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The value from a 3rd party system that identifies the Customer record

FederalId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) FederalId of Customer.

InsuranceNumber
string or null
Default: "example value"

(Elite Only) Insurance Number of Customer.

OtherId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) Addtional Id's of Customer.

TaxNumber
string or null
Default: "example value"

(Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite.

Array of objects
Default: []

Supported types will depend on the product.

Elite:

  • Supported: "Customer"
  • Coming Soon: "Default", "Billing"
Array
Type
required
string
Default: "Default"
Enum: "Customer" "Billing"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Line1
string or null <= 150 characters

Address Number and Street.

Line2
string or null <= 150 characters

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148.
GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null >= 2 characters

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148.
PostalCode
string or null <= 50 characters

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

BillingName
string or null <= 50 characters
Default: "Example Name"

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type.

Classification
string or null
Default: "example value"

What kind of customer is this? Examples: Plumber, Homeowner, Soletrader. This could also be the customers Job Title.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Classification" to receive a list of acceptable values for this field.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Supported.

Array
Type
required
string
Default: "Default"
Value: "Default"
required
object
CreditLimit
integer or null <= 2147483647
Default: 42

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

DoNotEmail
boolean or null
Default: true

Prevents the software from sending 'marketing' emails.

Array of objects
Default: []
Array
Type
required
string
Value: "Primary"

Supported types.

Email
required
string <= 50 characters

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null [ 1 .. 50 ] characters
Default: "Example Name"

First Name of Customer (individual only).

HeardAboutUs
string or null
Default: "example value"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "HeardAboutUs" to receive a list of acceptable values for this field.

LastName
string or null [ 1 .. 50 ] characters
Default: "Example Name"

Last Name of Customer (individual only).

Locale
string or null
Default: "en-US"

Defaults to "en-US". Code is ISO 639 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Locale" to receive a list of acceptable values for this field.

Nontaxable
boolean or null
Default: true

Means no tax is calculated for this customer on any contracts

Array of objects
Default: []
Array
Type
required
string
Default: "Default"

Supported phone types. "Default" is the default phone number for the contact. Elite uses "Mobile" as a secondary number whereas Essentials uses "Secondary".

Number
required
string or null <= 50 characters

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

RecordType
string
Default: "Business"
Enum: "Business" "Individual"

Denotes if this record is a business or an individual.

object or null
Default: {"ModelType":"standard","Id":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","Name":"Example Name","Email":{"Type":"standard","Email":"[email protected]"},"FirstName":"Example Name","LastName":"Example Name"}

Data related to the sales person associated with the Customer.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object
Default: {"Type":"standard","Email":"[email protected]"}

See the Type description for what types are supported on each product.

Status
string
Default: "Lead"
Enum: "Lead" "Prospect" "Cash" "Account"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Status" to receive a list of acceptable values for this field.

ExternalReceivableBalance
number
Default: 42.5

(Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization.

object or null
Default: {"CustomerWebPortal":true,"ExternalTaxClass":"example value","ExternalTaxCode":"ABC123","ForceContractInfo":true,"ForceJobId":true,"ForcePickedUp":true,"ForcePurchaseOrder":true,"InvoiceSendBy":"example value","Restrictions":"example value","StatementSendBy":"example value","Terms":"example value","UserDefined1":"example value","UserDefined2":"example value"}

Additional fields for Customer.

CustomerWebPortal
boolean or null
Default: true

(Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature.

ExternalTaxClass
string or null
Default: "example value"

(Elite Only) A user definable field for an External Tax Service.

ExternalTaxCode
string or null
Default: "ABC123"

(Elite Only) A user definable field for an External Tax Service.

ForceContractInfo
boolean or null
Default: true

(Elite Only) Requires the employee to collect a text value to identify the contract's purpose.

ForceJobId
boolean or null
Default: true

(Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs.

ForcePickedUp
boolean or null
Default: true

(Elite Only) Requires the employee to collect the name of the person picking up the items.

ForcePurchaseOrder
boolean or null
Default: true

(Elite Only) Flag to force purchase orders.

InvoiceSendBy
string
Default: "example value"
Enum: "Email" "Fax" "No Statement" "Printer" null

(Elite Only) Determines how a customer will receive contracts.

Restrictions
string or null
Default: "example value"

What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions

StatementSendBy
string
Default: "example value"
Enum: "Email" "Fax" "No Statement" "Printer" null

(Elite Only) Determines how a customer will receive statements.

Terms
string or null <= 50 characters
Default: "example value"

(Elite Only) Terms for the customer.

UserDefined1
string or null <= 50 characters
Default: "example value"

Placeholder field.

UserDefined2
string or null <= 50 characters
Default: "example value"

Placeholder field.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Customer"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

Can be a company or individual name.

object or null
Default: {"AccountNumber":"example value","CustomerKey":"example value","DriversLicense":"example value","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FederalId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InsuranceNumber":"example value","OtherId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","RegistrationNumber":"example value","TaxNumber":"example value","VatNumber":"example value"}

These are unique properties that are specific to certain products (Elite, Essentials, Syrinx).

Supported List

All

  • TaxNumber

Elite Only

  • CustomerKey
  • DriversLicense
  • FederalId
  • InsuranceNumber
  • OtherId

Syrinx Only

  • AccountNumber
  • RegistrationNumber
  • VatNumber

Not all properties are valid across all products.

AccountNumber
string or null
Default: "example value"

(Syrinx Only) Unique user defined customer identifier.

CustomerKey
string or null
Default: "example value"

(Elite Only) Unique user defined customer identifier.

If no value is provided, this will be set to the same value as Id.

DriversLicense
string or null
Default: "example value"

(Elite Only) Drivers license for individual type customers.

ExternalCustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The value from a 3rd party system that identifies the Customer record

FederalId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) FederalId of Customer.

InsuranceNumber
string or null
Default: "example value"

(Elite Only) Insurance Number of Customer.

OtherId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) Addtional Id's of Customer.

RegistrationNumber
string or null
Default: "example value"

(Syrinx Only) Registration Number of Customer.

TaxNumber
string or null
Default: "example value"

(Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite.

VatNumber
string or null
Default: "example value"

(Syrinx Only) Vat Number of Customer.

Array of objects
Default: []

Supported types will depend on the product.

Elite: only supports one "Customer" and one "Billing" address.

Array
Type
required
string
Default: "Default"
Enum: "Customer" "Billing"

Examples include "Customer", "Billing", etc. Supported types depend on the context of the address.

Name
string or null

Optional name for Address

Elite: Not supported.

Line1
string or null

Address Number and Street.

Line2
string or null

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148.
GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148.
PostalCode
string or null

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

BillingName
string or null
Default: "Example Name"

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type.

Classification
string or null
Default: "example value"

What kind of customer is this? Examples: Plumber, Homeowner, Soletrader. This could also be the customers Job Title.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Classification" to receive a list of acceptable values for this field.

CompanyName
string or null
Default: "Example Name"

Name of the Company.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Supported.

Array
Type
required
string
Default: "Default"
Value: "Default"
required
object
CreditLimit
integer or null
Default: 42

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

DoNotEmail
boolean or null
Default: true

Prevents the software from sending 'marketing' emails.

Array of objects
Default: []
Array
Type
required
string
Value: "Primary"

Supported types.

Email
required
string or null <= 50 characters

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null
Default: "Example Name"

First Name of Customer (individual only).

HeardAboutUs
string or null
Default: "example value"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "HeardAboutUs" to receive a list of acceptable values for this field.

LastName
string or null
Default: "Example Name"

Last Name of Customer (individual only).

Locale
string or null
Default: "en-US"

Defaults to "en-US". Code is ISO 639 format.

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Locale" to receive a list of acceptable values for this field.

Nontaxable
boolean or null
Default: true

Means no tax is calculated for this customer on any contracts

PaymentTerms
string or null
Default: "example value"

(Currently not supported)

Array of objects
Default: []
Array
Type
required
string
Default: "Default"

Supported phone types.

Number
required
string or null <= 50 characters

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null

Is there an extension associated with this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

RecordType
string
Default: "Business"
Enum: "Business" "Individual"

Denotes if this record is a business or an individual.

object or null
Default: {"ModelType":"standard","Id":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","Name":"Example Name","Email":{"Type":"standard","Email":"[email protected]"},"FirstName":"Example Name","LastName":"Example Name"}

Data related to the sales person associated with the Customer.

ModelType
string
Default: "standard"
Value: "SalesPerson"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "0"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object
Default: {"Type":"standard","Email":"[email protected]"}

See the Type description for what types are supported on each product.

FirstName
string or null
Default: "Example Name"

First name of the sales person.

Elite: This field is not supported.

LastName
string or null
Default: "Example Name"

Last name of the sales person.

Elite: This field is not supported.

Status
string
Default: "Lead"
Enum: "Lead" "Prospect" "Cash" "Account"

You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Status" to receive a list of acceptable values for this field.

ExternalReceivableBalance
number
Default: 42.5

(Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization.

object or null
Default: {"CustomerWebPortal":true,"ExternalTaxClass":"example value","ExternalTaxCode":"ABC123","ForceContractInfo":true,"ForceJobId":true,"ForcePickedUp":true,"ForcePurchaseOrder":true,"InvoiceSendBy":"example value","Restrictions":"example value","StatementSendBy":"example value","Terms":"example value","UserDefined1":"example value","UserDefined2":"example value"}

Additional fields for Customer.

CustomerWebPortal
boolean or null
Default: true

(Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature.

ExternalTaxClass
string or null
Default: "example value"

(Elite Only) A user definable field for an External Tax Service.

ExternalTaxCode
string or null
Default: "ABC123"

(Elite Only) A user definable field for an External Tax Service.

ForceContractInfo
boolean or null
Default: true

(Elite Only) Requires the employee to collect a text value to identify the contract's purpose.

ForceJobId
boolean or null
Default: true

(Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs.

ForcePickedUp
boolean or null
Default: true

(Elite Only) Requires the employee to collect the name of the person picking up the items.

ForcePurchaseOrder
boolean or null
Default: true

(Elite Only) Flag to force purchase orders.

InvoiceSendBy
string or null
Default: "example value"
Enum: "Email" "Fax" "No Statement" "Printer" "None"

(Elite Only) Determines how a customer will receive contracts.

Restrictions
string or null
Default: "example value"

What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions

StatementSendBy
string or null
Default: "example value"
Enum: "Email" "Fax" "No Statement" "Printer" "None"

(Elite Only) Determines how a customer will receive statements.

Terms
string or null <= 50 characters
Default: "example value"

(Elite Only) Terms for the customer.

UserDefined1
string or null <= 50 characters
Default: "example value"

Placeholder field.

UserDefined2
string or null <= 50 characters
Default: "example value"

Placeholder field.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "BillingName": "Example Name",
  • "Classification": "example value",
  • "CompanyName": "Example Name",
  • "Contacts": [ ],
  • "CreditLimit": 42,
  • "CurrencyCode": "USD",
  • "DoNotEmail": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "HeardAboutUs": "example value",
  • "LastName": "Example Name",
  • "Locale": "example value",
  • "Nontaxable": true,
  • "PaymentTerms": "example value",
  • "Phones": [ ],
  • "RecordType": "standard",
  • "SalesPerson": {
    },
  • "Status": "active",
  • "ExternalReceivableBalance": 42.5,
  • "AdditionalFields": {
    },
  • "Revision": 42,
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "BillingName": "Example Name",
  • "Classification": "example value",
  • "CompanyName": "Example Name",
  • "Contacts": [ ],
  • "CreditLimit": 42,
  • "CurrencyCode": "USD",
  • "DoNotEmail": true,
  • "Emails": [ ],
  • "FirstName": "Example Name",
  • "HeardAboutUs": "example value",
  • "LastName": "Example Name",
  • "Locale": "example value",
  • "Nontaxable": true,
  • "PaymentTerms": "example value",
  • "Phones": [ ],
  • "RecordType": "standard",
  • "SalesPerson": {
    },
  • "Status": "active",
  • "ExternalReceivableBalance": 42.5,
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Enum Lookup for Customer

Supported by: Elite

With this endpoint, you can look up dynamic enum values for Customer fields. The description on a particular field will indicate if it supports a lookup.

Authorizations:
API Key
path Parameters
field
required
string

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Lookup"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

Description
string or null
Default: "This is an example description for the API documentation."
Field
string
Default: "example value"
Value
string
Default: "example value"

Response samples

Content type
application/json
[
  • {
    }
]

Depots

Retrieve a list of Depots

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Identifiers.Key
Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

Identifiers
object or null
Default: {}

Identifying items for Depot.

Array of objects (Address)
Default: []
DefaultDepot
boolean or null
Default: true

This is this user's current default store/depot. One and only one store/depot may have this column set to 1(true) in any specific call to the depot endpoint for any user.

Array of objects (Email)
Default: []
Array of objects (Phone)
Default: []
AdditionalFields
object or null
Default: {}

Additional fields for this record.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

ItemId
string or null
Deprecated
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Kept for legacy support, will eventually only need StockId and ProductId.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Depot by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
DepotId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

Identifiers
object or null
Default: {}

Identifying items for Depot.

Array of objects (Address)
Default: []
Array
City
string or null <= 128 characters

City of the address

Country
string or null <= 128 characters

Country of the address

GeoRegion2
string or null <= 64 characters

Geographical region 2 of the address

GeoRegion3
string or null <= 64 characters

Geographical region 3 of the address

Latitude
string or null <= 64 characters

Latitude of the address

Line1
string or null <= 256 characters

Line 1 of the address

Line2
string or null <= 256 characters

Line 2 of the address

Line3
string or null <= 256 characters

Line 3 of the address

Longitude
string or null <= 64 characters

Longitude of the address

Name
string or null <= 128 characters

An optional name for the address

PostalCode
string or null <= 32 characters

Postal code of the address

Province
string or null <= 128 characters

Province of the address

Type
string or null <= 32 characters

The type of this address (e.g. business)

DefaultDepot
boolean or null
Default: true

This is this user's current default store/depot. One and only one store/depot may have this column set to 1(true) in any specific call to the depot endpoint for any user.

Array of objects (Email)
Default: []
Array
Email
string

The email address.

Type
string

The type of this email.

Array of objects (Phone)
Default: []
Array
CountryCode
string or null <= 16 characters

The phone number's ountry code prefix.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null <= 32 characters

An extension associated with the phone number.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Number
string or null <= 32 characters

A phone number without the country code.

NumberE164
string or null <= 32 characters

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Type
string or null <= 32 characters

The type of this phone (e.g. mobile)

AdditionalFields
object or null
Default: {}

Additional fields for this record.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

ItemId
string or null
Deprecated
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Kept for legacy support, will eventually only need StockId and ProductId.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": { },
  • "Addresses": [ ],
  • "DefaultDepot": true,
  • "Emails": [ ],
  • "Phones": [ ],
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "ItemId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
}

Invoices

Retrieve a list of Invoices

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Invoice"

These are the different types of invoice models we can use.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The display name for the invoice

object or null
Default: {"ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for invoice

CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The customer id associated with the invoice.

InvoiceDate
string or null <date-time>
Default: "2023-08-15"

The date the invoice was created

InvoiceNumber
string or null
Default: "example value"

The invoice number

GrandTaxTotal
number or null
Default: 42.5

Amount of Tax/VAT on the invoice

GrandTotal
number or null
Default: 42.5

Value of the invoice including taxes

AmountDue
number or null
Default: 99.99

Amount of money owed toward the invoice total

AdditionalFields
object or null
Default: {}

Additional fields for invoice

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Invoice by Id

Authorizations:
API Key
path Parameters
InvoiceId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Invoice"

These are the different types of invoice models we can use.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The display name for the invoice

object or null
Default: {"ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for invoice

ContractId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite-Only) The contract id associated with the invoice.

CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The customer id associated with the invoice.

InvoiceDate
string or null <date-time>
Default: "2023-08-15"

The date the invoice was created

InvoiceNumber
string or null
Default: "example value"

The invoice number

GrandTaxTotal
number or null
Default: 42.5

Amount of Tax/VAT on the invoice

GrandTotal
number or null
Default: 42.5

Value of the invoice including taxes

AmountDue
number or null
Default: 99.99

Amount of money owed toward the invoice total

AdditionalFields
object or null
Default: {}

Additional fields for invoice

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "InvoiceDate": "2023-08-15",
  • "InvoiceNumber": "example value",
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "AmountDue": 99.99,
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15"
}

Retrieve files for a single Invoice by Id.

Supported by: Elite

Authorizations:
API Key
path Parameters
InvoiceId
required
string
tagKey
required
string

pdfs or instructions or photos

Responses

Response Schema: application/json
Array
FileName
string
Default: "Example Name"

Original local filename.

FileClass
string
Default: "example value"
Enum: "misc" "image" "video"

Defines the type of stored file.

PublicURL
string
Default: "https://example.com"

Web URL where the stored file can be downloaded.

URLDateTime
string <date-time>
Default: "https://example.com"

The date/time the URL was retrieved/created.

URLExpires
integer
Default: 42

Number of seconds from URLDateTime until URL expires.

TagMapKey
string
Default: "example value"
Enum: "pdfs" "instructions" "photos"

Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).

ObjectPrimaryKey
string
Default: "example value"

Primary key of the object this file is associated with (same as in the URL for single object get).

ObjectType
string
Default: "standard"

Type of object: One of Products, stock, or contract.

Tags
Array of strings
Default: ["example item 1","example item 2"]

List of all the tag names associated with each file (ONLY the TagName).

Response samples

Content type
application/json
[
  • {
    }
]

Line Item Actions

Call Line Items Off Rent

Supported by: Elite

Authorizations:
API Key
Request Body schema: application/json
required
LineItemIds
required
Array of strings
Default: ["example item 1","example item 2"]

The unique line items ids

CalledOffDateTime
required
string <date-time>
Default: "2023-08-15"

What date and time to call off the line items. UTC time zone. e.g. 2023-01-01T06:00:00Z

PersonCallingOff
string
Default: "example value"

Name of the person who is calling the line items off rent.

Memo
string
Default: "example value"

Additional textual information for calling the line items off rent.

RemoteUserId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

An identifier on the remote server for the user's account. Can be User ID, Username, anything to match the Relationship to a user.

Responses

Request samples

Content type
application/json
{
  • "LineItemIds": [
    ],
  • "CalledOffDateTime": "2023-08-15",
  • "PersonCallingOff": "example value",
  • "Memo": "example value",
  • "RemoteUserId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "AmountDue": 99.99,
  • "AmountPaid": 99.99,
  • "Contacts": [ ],
  • "ContractInformation": "example value",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "CustomerName": "Example Name",
  • "CustomerPickup": {
    },
  • "DriverDelivery": {
    },
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DriverPickup": {
    },
  • "EndDateTime": "2023-08-15",
  • "EsignState": "example value",
  • "EsignUrl": "https://example.com",
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "LaborTracking": {
    },
  • "LineItems": [ ],
  • "LocationId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Notes": [ ],
  • "Precheck": true,
  • "PONumber": "example value",
  • "StartDateTime": "2023-08-15",
  • "Status": "active",
  • "Totals": [ ],
  • "Workflows": [ ],
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "ContractStatus": "active",
  • "IsDelivery": true,
  • "IsPickup": true,
  • "Revision": 42
}

Line Items

Retrieve a list of line items

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

object or null
Default: {"Key":"example value","Model":"example value","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","PartNumber":"example value"}

Identifying items for LineItem.

Classification
string
Default: "example value"
Enum: "Rental" "Sale" null

This product is either meant for sale or rental. The internal classification does not apply to lineitems.

EndDateTime
string or null <date-time>
Default: "2023-08-15"

UTC - When does the customer intend to return the items?

FuelCapacity
number or null
Default: 42.5

If this item has a fuel, this is the total amount of fuel this line item can have. No units are provided. If the value returned is “0” that means that a fuel capacity has been provided, and it doesn’t have any. If “null” is provided, then no fuel capacity has been recorded. This field should only show up if the isFuel field is true.

HasFuel
boolean or null
Default: true

If this is related to an item that uses fuel, this field will be set. If not it will be false.

IsSerialized
boolean or null
Default: true

Do we expect this Line Item to have a unique Serial Number or is it a bulk item? NOTE - Some bulk items may still have serial numbers in some systems.

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

LineTaxTotal
number or null
Default: 42.5

This is the final projected tax for this line.

LineTotal
number or null
Default: 42.5

This is the final projected price for this line accounting for qty, discounts, duration, tax, etc..

LocationId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Location. (see the Location endpoints)

Array of objects or null
Default: []

Meter readings of this inventory. Multiple readings allowed for different types.

Notes
string or null
Default: "example value"

Notes attached to a line item. Not an array of notes like its similarly name fields.

PONumber
string or null
Default: "example value"

A number associated to a contract. Thi is user definable and associated by a POR user and their customer.

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

Quantity
number
Default: 5

How many of this Line Item are there? NOTE - there can be multiple Line Items that have the same inventory item associated with them for various reasons so this does not mean that ALL of the [some inventory] will show up under this Line Item.

Rates
Array of strings or null
Default: ["example item 1","example item 2"]

The rates that have been associated to this line item as shown on the Contract. The Rental Management Software may apply these from default, or special rates.

ShowOnContract
boolean
Default: true

Is it a component/unincluded/optional item to display on contract. If false this item should generally not be shown to the consumer.

SerialNumber
string or null
Default: "example value"

The serial number or unique identifier assigned to this particular Line Item.

StartDateTime
string or null <date-time>
Default: "2023-08-15"

UTC - When does the customer want the items?

Status
string or null
Default: "active"
Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved".

  • Reserved
  • Out
  • Off Rent
  • Returned
  • Sold
StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

This is likely to replace ItemId as the reference to which "Item" or "Inventory" this record is related to. (This field is still a work in progres from the API standpoint so we may end up going another direction. Use with caution.)

Array of objects (Workflow)
Default: []

For Internal Use Only.

Array of objects
Default: []

All rates for this product or stock whether relevant or not. In most cases, you will want to use applicable rates.

object or null
Default: {"ContractId":"example option","FuelStockName":"Example Name","FuelStockId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Additional fields for this record.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

ItemId
string or null
Deprecated
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Kept for legacy support, will eventually only need StockId and ProductId.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single line item by its id

Authorizations:
API Key
path Parameters
LineItemId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

object or null
Default: {"Key":"example value","Model":"example value","ParentId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","PartNumber":"example value"}

Identifying items for LineItem.

Key
string or null
Default: "example value"

(Elite Only) This value is a secondary unique inventory identifier (similar and additional to a serial number) and can be the same as the Primary ID. Must be a unique numeric or alpha-numeric value.

Model
string or null
Default: "example value"

(Elite Only) The model name associated with a specific instance of an item.

ParentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite and Essentials Only.

PartNumber
string or null
Default: "example value"

(Elite Only) The part number associated with a specific instance of an item.

Classification
string
Default: "example value"
Enum: "Rental" "Sale" null

This product is either meant for sale or rental. The internal classification does not apply to lineitems.

EndDateTime
string or null <date-time>
Default: "2023-08-15"

UTC - When does the customer intend to return the items?

FuelCapacity
number or null
Default: 42.5

If this item has a fuel, this is the total amount of fuel this line item can have. No units are provided. If the value returned is “0” that means that a fuel capacity has been provided, and it doesn’t have any. If “null” is provided, then no fuel capacity has been recorded. This field should only show up if the isFuel field is true.

HasFuel
boolean or null
Default: true

If this is related to an item that uses fuel, this field will be set. If not it will be false.

IsSerialized
boolean or null
Default: true

Do we expect this Line Item to have a unique Serial Number or is it a bulk item? NOTE - Some bulk items may still have serial numbers in some systems.

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

LineTaxTotal
number or null
Default: 42.5

This is the final projected tax for this line.

LineTotal
number or null
Default: 42.5

This is the final projected price for this line accounting for qty, discounts, duration, tax, etc..

LocationId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Location. (see the Location endpoints)

Array of objects or null
Default: []

Meter readings of this inventory. Multiple readings allowed for different types.

Array
MeterReading
number

The last known meter reading of this inventory.

MeterType
string

The type of meter for this reading.

Notes
string or null
Default: "example value"

Notes attached to a line item. Not an array of notes like its similarly name fields.

PONumber
string or null
Default: "example value"

A number associated to a contract. Thi is user definable and associated by a POR user and their customer.

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

Quantity
number
Default: 5

How many of this Line Item are there? NOTE - there can be multiple Line Items that have the same inventory item associated with them for various reasons so this does not mean that ALL of the [some inventory] will show up under this Line Item.

Rates
Array of strings or null
Default: ["example item 1","example item 2"]

The rates that have been associated to this line item as shown on the Contract. The Rental Management Software may apply these from default, or special rates.

ShowOnContract
boolean
Default: true

Is it a component/unincluded/optional item to display on contract. If false this item should generally not be shown to the consumer.

SerialNumber
string or null
Default: "example value"

The serial number or unique identifier assigned to this particular Line Item.

StartDateTime
string or null <date-time>
Default: "2023-08-15"

UTC - When does the customer want the items?

Status
string or null
Default: "active"
Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved".

  • Reserved
  • Out
  • Off Rent
  • Returned
  • Sold
StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

This is likely to replace ItemId as the reference to which "Item" or "Inventory" this record is related to. (This field is still a work in progres from the API standpoint so we may end up going another direction. Use with caution.)

Array of objects (Workflow)
Default: []

For Internal Use Only.

Array
Creatable
boolean or null

Can the workflow be created?

TemplateId
string or null
PhotoPickerType
string
Enum: "Default" "Image360" "None" null

Options are None, Generic, 360

RequiredPhotos
number or null
Array of objects
Default: []

All rates for this product or stock whether relevant or not. In most cases, you will want to use applicable rates.

Array
PeriodName
string

Example: "daily rate", "1 week rate"

Rate
string or null

Example: "20.00"

CurrencyType
string

Example: "USD"

object or null
Default: {"ContractId":"example option","FuelStockName":"Example Name","FuelStockId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Additional fields for this record.

(string or null) or (number or null)
Default: "example option"

The id of the associated contract.

FuelStockName
string or null
Default: "Example Name"

(Elite Only) The name of the fuel stock associated with this line item and ios only used for debugging purposes. This field should only show up if the isFuel field is true.

FuelStockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The id of the fuel stock associated with this line item and ios only used for debugging purposes. This field should only show up if the isFuel field is true.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

ItemId
string or null
Deprecated
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Kept for legacy support, will eventually only need StockId and ProductId.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Classification": "example value",
  • "EndDateTime": "2023-08-15",
  • "FuelCapacity": 42.5,
  • "HasFuel": true,
  • "IsSerialized": true,
  • "IsBulk": true,
  • "LineTaxTotal": 42.5,
  • "LineTotal": 42.5,
  • "LocationId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "MeterReadings": [ ],
  • "Notes": "example value",
  • "PONumber": "example value",
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Quantity": 5,
  • "Rates": [
    ],
  • "ShowOnContract": true,
  • "SerialNumber": "example value",
  • "StartDateTime": "2023-08-15",
  • "Status": "active",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Workflows": [ ],
  • "AllRates": [ ],
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "ItemId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
}

Locations

Create a new Location

Supported by: Elite

Required fields:

  • Name
Authorizations:
API Key
Request Body schema: application/json
required
Name
string or null [ 1 .. 255 ] characters
Default: "Example Name"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

object or null
Default: {"Type":"standard","Name":"Example Name","Line1":"example value","Line2":"example value","Line3":"example value","City":"example value","GeoRegion2":"example value","GeoRegion3":"example value","Province":"example value","PostalCode":"ABC123","Latitude":"example value","Longitude":"example value","Country":"example value"}

Location address.

Type
required
string
Default: "Customer"
Value: "Customer"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Line1
string or null <= 50 characters
Default: "example value"

Address Number and Street.

Line3
string or null
Default: "example value"

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null
Default: "example value"

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2
string or null
Default: "example value"

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null
Default: "example value"

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null >= 2 characters
Default: "example value"

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode
string or null <= 50 characters
Default: "ABC123"

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null
Default: "example value"

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null
Default: "example value"

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null
Default: "example value"

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Not supported.

Array
required
object
EndDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects
Default: []

Currently we only support the following types of notes

  • SiteDeliveryInstructions.
Array
Type
required
string
Default: "SiteDeliveryInstructions"
Value: "SiteDeliveryInstructions"

Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.

Value
required
string or null

The note text.

OwnerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects
Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

Array
Type
required
string
Default: "Default"
Value: "Default"

Supported phone types.

Number
required
string or null

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

StartDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

AdditionalFields
object or null
Default: {}

Additional fields for Location.

Responses

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": { },
  • "Address": {
    },
  • "Contacts": [ ],
  • "Emails": [ ],
  • "EndDate": "2023-08-15",
  • "Notes": [ ],
  • "OwnerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Phones": [ ],
  • "StartDate": "2023-08-15",
  • "Type": "standard",
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": { },
  • "Address": {
    },
  • "Contacts": [ ],
  • "Emails": [ ],
  • "EndDate": "2023-08-15",
  • "Notes": [ ],
  • "OwnerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Phones": [ ],
  • "StartDate": "2023-08-15",
  • "Type": "standard",
  • "AdditionalFields": { },
  • "Revision": 42,
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Retrieve a list of Locations

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Address.Line1
  • Address.City
  • Address.Province
  • Address.PostalCode
  • Phones.Number
  • Contacts.Contact.Name
Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Location"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

Identifiers
object or null
Default: {}

Location does not have any identifiers at this time.

object or null
Default: {"Type":"standard","Name":"Example Name","Line1":"example value","Line2":"example value","Line3":"example value","City":"example value","GeoRegion2":"example value","GeoRegion3":"example value","Province":"example value","PostalCode":"ABC123","Latitude":"example value","Longitude":"example value","Country":"example value"}

Location address.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Not supported.

Array of objects
Default: []

Type can == "Customer" or "Billing" for now. This supports multiple email addresses.

EndDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects
Default: []

Currently we only support the following types of notes

  • SiteDeliveryInstructions.
OwnerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects
Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

StartDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

Type
string
Default: "standard"
Enum: "Global" "Customer" "Supplier"

Location type may be one of the following.

  • Global
  • Customer
  • Supplier
AdditionalFields
object or null
Default: {}

Additional fields for Location.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is always 0.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Location by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
LocationId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Location"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

Identifiers
object or null
Default: {}

Location does not have any identifiers at this time.

object or null
Default: {"Type":"standard","Name":"Example Name","Line1":"example value","Line2":"example value","Line3":"example value","City":"example value","GeoRegion2":"example value","GeoRegion3":"example value","Province":"example value","PostalCode":"ABC123","Latitude":"example value","Longitude":"example value","Country":"example value"}

Location address.

Type
required
string
Default: "Customer"
Value: "Customer"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Name
string or null
Default: "Example Name"

Optional name for Address

Line1
string or null
Default: "example value"

Address Number and Street.

Line2
string or null
Default: "example value"

May be apartment, building, suite.

Line3
string or null
Default: "example value"

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null
Default: "example value"

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2
string or null
Default: "example value"

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null
Default: "example value"

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null
Default: "example value"

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode
string or null
Default: "ABC123"

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null
Default: "example value"

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null
Default: "example value"

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null
Default: "example value"

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Not supported.

Array
Type
required
string
Default: "Default"

Currently there arent any specific types related to location

required
object
Array of objects
Default: []

Type can == "Customer" or "Billing" for now. This supports multiple email addresses.

Array
Type
required
string

Supported types.

Email
required
string or null

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

EndDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects
Default: []

Currently we only support the following types of notes

  • SiteDeliveryInstructions.
Array
Type
required
string
Default: "SiteDeliveryInstructions"
Value: "SiteDeliveryInstructions"

Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.

Value
required
string or null

The note text.

OwnerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects
Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

Array
Type
required
string
Default: "Default"
Value: "Default"

Supported phone types.

Number
required
string or null

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null

Is there an extension associated with this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

StartDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

Type
string
Default: "standard"
Enum: "Global" "Customer" "Supplier"

Location type may be one of the following.

  • Global
  • Customer
  • Supplier
AdditionalFields
object or null
Default: {}

Additional fields for Location.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

One of
number
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is always 0.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": { },
  • "Address": {
    },
  • "Contacts": [ ],
  • "Emails": [ ],
  • "EndDate": "2023-08-15",
  • "Notes": [ ],
  • "OwnerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Phones": [ ],
  • "StartDate": "2023-08-15",
  • "Type": "standard",
  • "AdditionalFields": { },
  • "Revision": 42,
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Update a single Location by Id

Supported by: Elite

Required fields:

  • Id
Authorizations:
API Key
path Parameters
LocationId
required
string
Request Body schema: application/json
required
Name
string or null [ 1 .. 255 ] characters
Default: "Example Name"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

object or null
Default: {"Type":"standard","Name":"Example Name","Line1":"example value","Line2":"example value","Line3":"example value","City":"example value","GeoRegion2":"example value","GeoRegion3":"example value","Province":"example value","PostalCode":"ABC123","Latitude":"example value","Longitude":"example value","Country":"example value"}

Location address.

Type
required
string
Default: "Customer"
Value: "Customer"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Line1
string or null <= 50 characters
Default: "example value"

Address Number and Street.

Line3
string or null
Default: "example value"

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null
Default: "example value"

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2
string or null
Default: "example value"

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null
Default: "example value"

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null >= 2 characters
Default: "example value"

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode
string or null <= 50 characters
Default: "ABC123"

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null
Default: "example value"

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null
Default: "example value"

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null
Default: "example value"

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Not supported.

Array
required
object
EndDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects
Default: []

Currently we only support the following types of notes

  • SiteDeliveryInstructions.
Array
Type
required
string
Default: "SiteDeliveryInstructions"
Value: "SiteDeliveryInstructions"

Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.

Value
required
string or null

The note text.

OwnerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects
Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

Array
Type
required
string
Default: "Default"
Value: "Default"

Supported phone types.

Number
required
string or null

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

StartDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

AdditionalFields
object or null
Default: {}

Additional fields for Location.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Location"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

Identifiers
object or null
Default: {}

Location does not have any identifiers at this time.

object or null
Default: {"Type":"standard","Name":"Example Name","Line1":"example value","Line2":"example value","Line3":"example value","City":"example value","GeoRegion2":"example value","GeoRegion3":"example value","Province":"example value","PostalCode":"ABC123","Latitude":"example value","Longitude":"example value","Country":"example value"}

Location address.

Type
required
string
Default: "Customer"
Value: "Customer"

Examples include "Default", "Billing", etc. Supported types depend on the context of the address.

Name
string or null
Default: "Example Name"

Optional name for Address

Line1
string or null
Default: "example value"

Address Number and Street.

Line2
string or null
Default: "example value"

May be apartment, building, suite.

Line3
string or null
Default: "example value"

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null
Default: "example value"

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2
string or null
Default: "example value"

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null
Default: "example value"

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null
Default: "example value"

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode
string or null
Default: "ABC123"

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null
Default: "example value"

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null
Default: "example value"

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null
Default: "example value"

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects
Default: []

If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location.

Elite: Supported.
Syrinx: Not supported.

Array
Type
required
string
Default: "Default"

Currently there arent any specific types related to location

required
object
Array of objects
Default: []

Type can == "Customer" or "Billing" for now. This supports multiple email addresses.

Array
Type
required
string

Supported types.

Email
required
string or null

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

EndDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects
Default: []

Currently we only support the following types of notes

  • SiteDeliveryInstructions.
Array
Type
required
string
Default: "SiteDeliveryInstructions"
Value: "SiteDeliveryInstructions"

Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.

Value
required
string or null

The note text.

OwnerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects
Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

Array
Type
required
string
Default: "Default"
Value: "Default"

Supported phone types.

Number
required
string or null

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null

Is there an extension associated with this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

StartDate
string or null <date-time>
Default: "2023-08-15"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

Type
string
Default: "standard"
Enum: "Global" "Customer" "Supplier"

Location type may be one of the following.

  • Global
  • Customer
  • Supplier
AdditionalFields
object or null
Default: {}

Additional fields for Location.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

One of
number
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is always 0.

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": { },
  • "Address": {
    },
  • "Contacts": [ ],
  • "Emails": [ ],
  • "EndDate": "2023-08-15",
  • "Notes": [ ],
  • "OwnerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Phones": [ ],
  • "StartDate": "2023-08-15",
  • "Type": "standard",
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": { },
  • "Address": {
    },
  • "Contacts": [ ],
  • "Emails": [ ],
  • "EndDate": "2023-08-15",
  • "Notes": [ ],
  • "OwnerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Phones": [ ],
  • "StartDate": "2023-08-15",
  • "Type": "standard",
  • "AdditionalFields": { },
  • "Revision": 42,
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Products

Retrieve availability for a single Product by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
ProductId
required
string
query Parameters
startdate
required
string
enddate
required
string
returnSingleRecord
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Cannot be used for patching or lookups

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

Identifiers
object or null
Default: {}

ProductAvailability does not have any identifiers at this time.

ProductId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of product

ProductName
string
Default: "Example Name"

Name of product

Array of objects or null
Default: []

The available stock for this product.

Array
ModelType
string

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string

Cannot be used for patching or lookups

Name
string or null

A display name for this record. Often used as a summary for lookups.

object or null

Identifying items for Stock Availability.

StockId
string

Id of stock

StockName
string

Name of stock

SerialNumber
string or null

The serial number associated with a specific instance of an item.

DepotId
string

The company id, store id, or depot id depending on which system you are using.

StartDateTime
string <date-time>

Start date of availability

EndDateTime
string <date-time>

End date of availability

AvailableQuantity
number

The current quantity available for rent or sale.

ExpectedQuantity
number

The quantity expected to be on premise. This is how many you would expect to find when doing an inventory count. This includes available and unavailable inventory.

TotalQuantity
number

Total quantity owned regardless of availability.

QtyExpected
number
Deprecated

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

DepotId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The company id, store id, or depot id depending on which system you are using.

StartDateTime
string <date-time>
Default: "2023-08-15"

Start date of availability

EndDateTime
string <date-time>
Default: "2023-08-15"

End date of availability

AvailableQuantity
number
Default: 5

The current quantity available for rent or sale.

ExpectedQuantity
number
Default: 5

The quantity expected to be on premise. This is how many you would expect to find when doing an inventory count. This includes available and unavailable inventory.

TotalQuantity
number
Default: 5

Total quantity owned regardless of availability.

QtyExpected
number
Deprecated
Default: 42.5

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": { },
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "ProductName": "Example Name",
  • "AvailableStock": [ ],
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StartDateTime": "2023-08-15",
  • "EndDateTime": "2023-08-15",
  • "AvailableQuantity": 5,
  • "ExpectedQuantity": 5,
  • "TotalQuantity": 5,
  • "QtyExpected": 42.5
}

Create a Product

Authorizations:
API Key
Request Body schema: application/json
required
Name
required
string or null
Default: "Example Name"

The display name for the item.

Classification
required
string
Default: "example value"
Enum: "Rental" "Sale"

This Product is either meant for sale, rental or internal. Only Rental and Sale supported for POST.

Description
required
string or null
Default: "This is an example description for the API documentation."

This should describe the category. Likely a single sentence, but could be small paragraph.

DepotId
required
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

required
object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentDepotId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InternalClassificationType":"standard","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","TaxCode":42.5,"ExternalTaxCode":"ABC123"}

Additional fields for Product.

CaseQuantity
number or null
Default: "null"

The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.

CriticalLevel
number or null
Default: "null"

When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.

CurrentDepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only - Required) The id of the current store/depot.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

ReorderMaximum
number or null
Default: "null"

The maximum for reordering the item.

ReorderMinimum
number or null
Default: "null"

The minimum for reordering the item.

TaxCode
number or null
Default: 42.5

The tax code for the item. POST and GET only. This value can't be updated/patched from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.

ExternalTaxCode
string or null
Default: "ABC123"

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

required
object or null
Default: {"Key":"example value","PartNumber":"example value","Alias":"example value","Barcode":"ABC123"}

Identifying items for Product.

Key
string or null
Default: "example value"

(Required) A customer defined Id for this item.

PartNumber
string or null
Default: "example value"

The part number associated to a specific instance of a part.

Alias
string or null
Default: "example value"

(Elite Only) Lookup field in Elite.

Barcode
string or null
Default: "ABC123"

(Elite Only) Barcode field in Elite.

CategoryName
string or null
Default: "Example Name"

Denormalized name of the Category.

Elite: Only supports one name.

IsPart
boolean or null
Default: true

Used to determine if product is a part (Sales

Responses

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Description": "This is an example description for the API documentation.",
  • "DisplayOrder": 42.5,
  • "InstructionsUrl": "https://example.com",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "Images": [ ],
  • "OtherUrls": [
    ],
  • "Tags": [
    ],
  • "IsPart": true,
  • "AdditionalFields": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepartmentId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DepartmentName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Description": "This is an example description for the API documentation.",
  • "DisplayOrder": 42.5,
  • "InstructionsUrl": "https://example.com",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "Key": "example value",
  • "Images": [ ],
  • "OtherUrls": [
    ],
  • "Tags": [
    ],
  • "IsPart": true,
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "Alias": "example value",
  • "Barcode": "ABC123",
  • "DisplayOnStorefront": true,
  • "Revision": 42
}

Retrieve a list of Products

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Identifiers.Key
Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Product"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The display name for the item.

object or null
Default: {"Key":"example value","Alias":"example value","Barcode":"ABC123","PartNumber":"example value"}

Identifying items for Product.

CategoryIds
Array of strings
Default: ["example item 1","example item 2"]

Reference a CategoryId

CategoryName
string or null
Default: "Example Name"

Denormalized name of the Category.

Elite: Only supports one name.

Classification
string
Default: "example value"
Enum: "Rental" "Sale" "Internal" null

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The department id for this product

DepartmentName
string or null
Default: "Example Name"

(Elite Only) The department name for this product

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

Description
string or null
Default: "This is an example description for the API documentation."

This should describe the category. Likely a single sentence, but could be small paragraph.

DisplayOrder
number or null >= 1
Default: 42.5

OPTIONAL. By default, we might sort by A -> Z, but in some cases, stores may want to manually set an items display order within a category.

Elite: This field is not supported.

InstructionsUrl
string or null
Default: "https://example.com"

A publicly accessible link to any instructions associated with this item.

ModelName
string or null
Default: "Example Name"

OPTIONAL. This also exists on Stock. The model name associated with a specific instance of an item.

Elite: This field is not supported.

ModelNumber
string or null
Default: "example value"

OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "example value"

OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.

Key
string or null
Deprecated
Default: "example value"

A customer defined Id for this item.

Deprecated: This field is being moved to Identifiers.Key.

Array of objects
Default: []

An array of publicly accessible URLs or URI's that resolve to images of the item. Also, supports some metadata. We will assume they are in order so that the first one in the list is the default image for the item.

OtherUrls
Array of strings
Default: ["example item 1","example item 2"]

An array of publicly accessible URLs that can be used for anything.

Elite: This field is not supported.

Tags
Array of strings
Default: ["example item 1","example item 2"]

This should be an array of tags. Generally expected to be like a subcategory.

Elite: This field is not supported.

IsPart
boolean or null
Default: true

Used to determine if product is a part

object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentDepotId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InternalClassificationType":"standard","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","SpecDescription":"This is an example description for the API documentation.","TaxCode":42.5,"TaxCodeName":"Example Name","ExternalTaxCode":"ABC123"}

Additional fields for Product.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is not supported.

Alias
string or null
Deprecated
Default: "example value"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated
Default: "ABC123"

Deprecated: Use Identifiers.Barcode

Elite: This field is not supported.

DisplayOnStorefront
boolean
Default: true

Whether or not this particular product should display on the storefront.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a list of associations between products

Supported by: Elite

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "ProductAssociation"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

ParentProductId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Product to which the association belongs to ie. the parent.

ChildProductId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Product that is being associated ie. the child.

AssociationType
string
Default: "standard"
Enum: "Optional" "Automatic" "KitComponent"

Enum field denoting the nature of the association. 'KitComponent' should be used if item is included as part of a kit, which has its own section and kit pricing instead of line item pricing. 'Automatic' are required to be added with parent item, while 'Optional' gives the user the option to add the item to the cart.

Group
string or null
Default: "example value"

Optional grouping for this relationship

GroupSelectionType
string
Default: "ChooseMany"
Enum: "ChooseOne" "ChooseMany" "ChooseQty"

Defines how selection should be treated amongst associations of the same group. CHOOSE_ONE allows user to select only one option, while CHOOSE_MANY allows user to select 0 or more.

IsSelected
boolean
Default: true

Whether or not this item, which is a part of a group, should be pre-selected

DisplayOrder
number
Default: 42.5

Defines a sort order for associated products. Lowest value will appear first in the list

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is not supported.

Disabled
boolean or null
Default: true

Whether or not the record is disabled

Quantity
number or null
Default: 5

Quantity of the referenced product that is allocated to this association

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Product by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
ProductId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Product"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The display name for the item.

object or null
Default: {"Key":"example value","Alias":"example value","Barcode":"ABC123","PartNumber":"example value"}

Identifying items for Product.

Key
string or null
Default: "example value"

A customer defined Id for this item.

Alias
string or null
Default: "example value"

(Elite Only) Lookup field in Elite.

Barcode
string or null
Default: "ABC123"

(Elite Only) Barcode field in Elite.

PartNumber
string or null
Default: "example value"

The part number associated to a specific instance of a part.

CategoryIds
Array of strings
Default: ["example item 1","example item 2"]

Reference a CategoryId

CategoryName
string or null
Default: "Example Name"

Denormalized name of the Category.

Elite: Only supports one name.

Classification
string
Default: "example value"
Enum: "Rental" "Sale" "Internal" null

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The department id for this product

DepartmentName
string or null
Default: "Example Name"

(Elite Only) The department name for this product

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

Description
string or null
Default: "This is an example description for the API documentation."

This should describe the category. Likely a single sentence, but could be small paragraph.

DisplayOrder
number or null >= 1
Default: 42.5

OPTIONAL. By default, we might sort by A -> Z, but in some cases, stores may want to manually set an items display order within a category.

Elite: This field is not supported.

InstructionsUrl
string or null
Default: "https://example.com"

A publicly accessible link to any instructions associated with this item.

ModelName
string or null
Default: "Example Name"

OPTIONAL. This also exists on Stock. The model name associated with a specific instance of an item.

Elite: This field is not supported.

ModelNumber
string or null
Default: "example value"

OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "example value"

OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.

Key
string or null
Deprecated
Default: "example value"

A customer defined Id for this item.

Deprecated: This field is being moved to Identifiers.Key.

Array of objects
Default: []

An array of publicly accessible URLs or URI's that resolve to images of the item. Also, supports some metadata. We will assume they are in order so that the first one in the list is the default image for the item.

Array
Uri
string

This must be a publicly accessible URL on the internet. That would infer the image is hosted in the cloud. Alternatively, you can pass in a Data URI. See wiki for Data URI

AltText
string or null

Text found in Alt image field

OtherUrls
Array of strings
Default: ["example item 1","example item 2"]

An array of publicly accessible URLs that can be used for anything.

Elite: This field is not supported.

Tags
Array of strings
Default: ["example item 1","example item 2"]

This should be an array of tags. Generally expected to be like a subcategory.

Elite: This field is not supported.

IsPart
boolean or null
Default: true

Used to determine if product is a part

object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentDepotId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InternalClassificationType":"standard","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","SpecDescription":"This is an example description for the API documentation.","TaxCode":42.5,"TaxCodeName":"Example Name","ExternalTaxCode":"ABC123"}

Additional fields for Product.

CaseQuantity
number or null
Default: "null"

The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.

CriticalLevel
number or null
Default: "null"

When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.

CurrentDepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The id of the current store/depot.

InternalClassificationType
string or null
Default: "standard"
Enum: "Non-rental Asset" "Work Order item"

(Elite Only) If the classification field is set as "Internal" this further specifies the type. If this is not set, this defaults to "null".

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

RentalType
string or null
Default: "standard"
Value: "Rental - Header"

(Elite Only) If the classification field is set as "Rental" this further specifies the type. If this is not set, this defaults to "null"

ReorderMaximum
number or null
Default: "null"

The maximum for reordering the item.

ReorderMinimum
number or null
Default: "null"

The minimum for reordering the item.

SalesType
string or null
Default: "standard"
Value: "Sales - Header"

(Elite Only) If the classification field is set as "Sales" this further specifies the type. If this is not set, this defaults to "null"

SpecDescription
string or null
Default: "This is an example description for the API documentation."

(Elite only) This is the text field currently present on rentalhosting as additional information/info

TaxCode
number or null
Default: 42.5

The tax code for the item. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.

TaxCodeName
string or null
Default: "Example Name"

The name of the tax code.

ExternalTaxCode
string or null
Default: "ABC123"

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is not supported.

Alias
string or null
Deprecated
Default: "example value"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated
Default: "ABC123"

Deprecated: Use Identifiers.Barcode

Elite: This field is not supported.

DisplayOnStorefront
boolean
Default: true

Whether or not this particular product should display on the storefront.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

One of
number
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepartmentId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DepartmentName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Description": "This is an example description for the API documentation.",
  • "DisplayOrder": 42.5,
  • "InstructionsUrl": "https://example.com",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "Key": "example value",
  • "Images": [ ],
  • "OtherUrls": [
    ],
  • "Tags": [
    ],
  • "IsPart": true,
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "Alias": "example value",
  • "Barcode": "ABC123",
  • "DisplayOnStorefront": true,
  • "Revision": 42
}

Update a Product

Authorizations:
API Key
path Parameters
ProductId
required
string
Request Body schema: application/json
required
Name
required
string or null
Default: "Example Name"

The display name for the item.

Classification
required
string
Default: "example value"
Enum: "Rental" "Sale"

This Product is either meant for sale, rental or internal. Only Rental and Sale supported for POST.

Description
required
string or null
Default: "This is an example description for the API documentation."

This should describe the category. Likely a single sentence, but could be small paragraph.

DepotId
required
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

required
object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentDepotId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InternalClassificationType":"standard","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","TaxCode":42.5,"ExternalTaxCode":"ABC123"}

Additional fields for Product.

CaseQuantity
number or null
Default: "null"

The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.

CriticalLevel
number or null
Default: "null"

When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.

CurrentDepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only - Required) The id of the current store/depot.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

ReorderMaximum
number or null
Default: "null"

The maximum for reordering the item.

ReorderMinimum
number or null
Default: "null"

The minimum for reordering the item.

TaxCode
number or null
Default: 42.5

The tax code for the item. POST and GET only. This value can't be updated/patched from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.

ExternalTaxCode
string or null
Default: "ABC123"

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

required
object or null
Default: {"Key":"example value","PartNumber":"example value","Alias":"example value","Barcode":"ABC123"}

Identifying items for Product.

Key
string or null
Default: "example value"

(Required) A customer defined Id for this item.

PartNumber
string or null
Default: "example value"

The part number associated to a specific instance of a part.

Alias
string or null
Default: "example value"

(Elite Only) Lookup field in Elite.

Barcode
string or null
Default: "ABC123"

(Elite Only) Barcode field in Elite.

CategoryName
string or null
Default: "Example Name"

Denormalized name of the Category.

Elite: Only supports one name.

IsPart
boolean or null
Default: true

Used to determine if product is a part (Sales

Responses

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Description": "This is an example description for the API documentation.",
  • "DisplayOrder": 42.5,
  • "InstructionsUrl": "https://example.com",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "Images": [ ],
  • "OtherUrls": [
    ],
  • "Tags": [
    ],
  • "IsPart": true,
  • "AdditionalFields": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepartmentId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DepartmentName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Description": "This is an example description for the API documentation.",
  • "DisplayOrder": 42.5,
  • "InstructionsUrl": "https://example.com",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "Key": "example value",
  • "Images": [ ],
  • "OtherUrls": [
    ],
  • "Tags": [
    ],
  • "IsPart": true,
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "Alias": "example value",
  • "Barcode": "ABC123",
  • "DisplayOnStorefront": true,
  • "Revision": 42
}

Retrieve rates for a single Product by Id.

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
ProductId
required
string
query Parameters
depotId
required
string
locationId
required
string
customerId
required
string
startDate
required
string
endDate
required
string

Responses

Response Schema: application/json
ApplicableRates
string
Default: "example value"

Applicable rates are the most relevant rates, passed back as a single string with line breaks (\n).

Example #1 (raw):
"Daily Rate: $20.00 \n Weekly Rate: $65.00 \n Monthly Rate: $240.00”:

Example #1 (displayed):

  • DailyRate: $20.00
  • Weekly Rate: $65.00
  • Monthly Rate: $240.00

Example #2 (raw):
“Daily: $20.00 \n (there is a single day surcharge of $15.00) \n Weekly: $60.00”

Example #2 (displayed):

  • Daily: $20.00
  • (there is a single day surcharge of $15.00)
  • Weekly: $60.00
Array of objects
Default: []

All rates for this product whether relevant or not. In most cases, you will want to use applicable rates.

Array
PeriodName
string

Example: "daily rate", "1 week rate"

Rate
string or null

Example: "20.00"

CurrencyType
string

Example: "USD"

Response samples

Content type
application/json
{
  • "ApplicableRates": "example value",
  • "AllRates": [ ]
}

Retrieve files for a single Product by Id.

Supported by: Elite

Authorizations:
API Key
path Parameters
ProductId
required
string
tagKey
required
string

pdfs or instructions or photos

Responses

Response Schema: application/json
Array
FileName
string
Default: "Example Name"

Original local filename.

FileClass
string
Default: "example value"
Enum: "misc" "image" "video"

Defines the type of stored file.

PublicURL
string
Default: "https://example.com"

Web URL where the stored file can be downloaded.

URLDateTime
string <date-time>
Default: "https://example.com"

The date/time the URL was retrieved/created.

URLExpires
integer
Default: 42

Number of seconds from URLDateTime until URL expires.

TagMapKey
string
Default: "example value"
Enum: "pdfs" "instructions" "photos"

Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).

ObjectPrimaryKey
string
Default: "example value"

Primary key of the object this file is associated with (same as in the URL for single object get).

ObjectType
string
Default: "standard"

Type of object: One of Products, stock, or contract.

Tags
Array of strings
Default: ["example item 1","example item 2"]

List of all the tag names associated with each file (ONLY the TagName).

Response samples

Content type
application/json
[
  • {
    }
]

Sales Persons

Overview

Sales Persons represent your company's sales staff who can be assigned to customers and contracts. Tracking sales person assignments helps with commission calculations and customer relationship management.

Key Capabilities

  • Retrieve sales person information
  • Assign sales persons to customers and contracts
  • Track sales performance and commissions

Retrieve a list of SalesPersons

Supported by: Elite

Elite supports the following fields for the Search filter:

  • Name
  • Email.Email
Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "SalesPerson"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object
Default: {"Type":"standard","Email":"[email protected]"}

See the Type description for what types are supported on each product.

FirstName
string or null
Default: "Example Name"

First name of the sales person.

Elite: This field is not supported.

LastName
string or null
Default: "Example Name"

Last name of the sales person.

Elite: This field is not supported.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single SalesPerson by ID

Supported by: Elite

Authorizations:
API Key
path Parameters
SalesPersonId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "SalesPerson"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object
Default: {"Type":"standard","Email":"[email protected]"}

See the Type description for what types are supported on each product.

Type
required
string
Default: "standard"
Value: "Primary"

Supported types.

Email
required
string or null
Default: "[email protected]"

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName
string or null
Default: "Example Name"

First name of the sales person.

Elite: This field is not supported.

LastName
string or null
Default: "Example Name"

Last name of the sales person.

Elite: This field is not supported.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Email": {},
  • "FirstName": "Example Name",
  • "LastName": "Example Name"
}

Stock

Create a new Stock record (serialized)

Supported by: Elite

Only serialized stock is supported for POST at this time.

Required fields:

  • Name
  • Classification
  • ProductId
  • DepotId
Authorizations:
API Key
Request Body schema: application/json
required
Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"Alias":"example value","Barcode":"ABC123","InventoryNumber":"example value","Key":"example value","PartNumber":"example value"}

Identifying items for Stock.

InventoryNumber
string or null
Default: "example value"

A secondary number, possibly a barcode string, associated with an item or specific instance of an item.

Elite: This field is not supported.

PartNumber
string or null
Default: "example value"

The part number associated to a specific instance of a part (Sales Only).

Classification
string
Default: "example value"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepotId
string or null <= 3 characters
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

LoadingRatio
integer or null
Default: 42

A number that represents the ability for a stock item to fit on a vehicle.

Elite: This field is not supported.

Manufacturer
string or null <= 50 characters
Default: "example value"

The manufacturer associated with a specific instance of an item.

ModelName
string or null <= 30 characters
Default: "Example Name"

OPTIONAL. This also exists on Product. The model name associated with a specific instance of an item.

Elite: This field is not supported.

ModelNumber
string or null <= 30 characters
Default: "example value"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string <= 16 characters
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Product this Stock belongs to (see Product endpoint).

PurchaseDateTime
string or null <date-time>
Default: "2023-08-15"

Date stock was purchased.

Elite: On serialized items, it is the date and time the item was purchased. On bulk items, it is the last date and time the items were purchased.

PurchasePrice
number or null
Default: 99.99

Price stock was purchased.

Elite: On serialized items, it is the purchase price for the item. On bulk items, it is the most recent purchase price of the item.

Quantity
string or null
Default: "example value"

Field only required for bulk stock endpoints

SerialNumber
string or null <= 50 characters
Default: "example value"

The serial number associated with a specific instance of an item.

object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","GlNumber":"example value","InternalClassificationType":"standard","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","UserDefined1":"example value","UserDefined2":"example value","TaxCode":42.5,"ExternalTaxCode":"ABC123"}
CaseQuantity
number or null
Default: "null"

The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.

CriticalLevel
number or null
Default: "null"

When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.

CurrentStoreId
string or null <= 3 characters
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.

GlNumber
string or null
Default: "null"

The gl number for the stock item.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

ReorderMaximum
number or null
Default: "null"

The maximum for reordering the item.

ReorderMinimum
number or null
Default: "null"

The minimum for reordering the item.

UserDefined1
string or null <= 50 characters
Default: "example value"

(Elite Only) Free field for customer use

UserDefined2
string or null <= 50 characters
Default: "example value"

(Elite Only) Free field for customer use

TaxCode
number or null
Default: 42.5

The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.

ExternalTaxCode
string or null
Default: "ABC123"

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023,"TotalDepreciation":42.5}

Depreciation fields for Stock

DepreciationMethodCode
string or null
Default: "ABC123"

The Value which defines the method (i.e. Straight-Line, MACRS, etc).

Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.

DepreciationYears
integer or null
Default: 2023

The amount of years for which the stock depreciates.

CurrentValue
number or null
Default: 42.5

The current netbook value of the stock item.

SalvageValue
number or null
Default: 2023

The Salvageable value in terms of Depreciation.

TotalDepreciation
number or null
Default: "null"

The total depreciation for the stock item.

object or null
Deprecated
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023}

Depreciation fields for Stock

DepreciationMethodCode
string or null
Default: "ABC123"

The Value which defines the method (i.e. Straight-Line, MACRS, etc).

Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.

DepreciationYears
integer or null
Default: 2023

The amount of years for which the stock depreciates.

CurrentValue
number or null
Default: 42.5

The Current Value in terms of depreciation.

SalvageValue
number or null
Default: 2023

The Salvageable value in terms of Depreciation.

Responses

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "IsAsset": true,
  • "LoadingRatio": 42,
  • "Manufacturer": "example value",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseDateTime": "2023-08-15",
  • "PurchasePrice": 99.99,
  • "Quantity": "example value",
  • "SerialNumber": "example value",
  • "IsPart": true,
  • "AdditionalFields": {
    },
  • "Depreciation": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "DepreciationFields": {
    },
  • "Alias": "example value",
  • "Barcode": "ABC123"
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepartmentId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DepartmentName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "HasFuel": true,
  • "FuelCapacity": 42.5,
  • "IsAsset": true,
  • "IsBulk": true,
  • "IsSerialized": true,
  • "IsCustomerWorkOrderItem": true,
  • "IsGenericWorkOrderItem": true,
  • "IsPart": true,
  • "LoadingRatio": 42,
  • "Manufacturer": "example value",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseDateTime": "2023-08-15",
  • "PurchasePrice": 99.99,
  • "Quantity": 5,
  • "SerialNumber": "example value",
  • "Status": "active",
  • "AdditionalFields": {
    },
  • "Depreciation": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "Revision": 42,
  • "DepreciationFields": {
    },
  • "Alias": "example value",
  • "Barcode": "ABC123"
}

Retrieve a list of Stock records

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Identifiers.Key
Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Stock"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"Alias":"example value","Barcode":"ABC123","InventoryNumber":"example value","Key":"example value","PartNumber":"example value"}

Identifying items for Stock.

CategoryIds
Array of strings
Default: ["example item 1","example item 2"]

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName
string or null
Default: "Example Name"

Denormalized name of the Category.

Classification
string
Default: "example value"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The department id for this stock item

DepartmentName
string or null
Default: "Example Name"

(Elite Only) The department name for this stock item

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

HasFuel
boolean or null
Default: true

Item is eligible for add fuel

FuelCapacity
number or null
Default: 42.5

Fuel capacity of the item

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null
Default: true

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsCustomerWorkOrderItem
boolean or null
Default: true

Item is eligible for creating customer work orders

IsGenericWorkOrderItem
boolean or null
Default: true

Item is eligible for creating work orders

IsPart
boolean or null
Default: true

Used to determine if stock item is a part (Sales Only).

LoadingRatio
integer or null
Default: 42

A number that represents the ability for a stock item to fit on a vehicle.

Elite: This field is not supported.

Manufacturer
string or null
Default: "example value"

The manufacturer associated with a specific instance of an item.

ModelName
string or null
Default: "Example Name"

OPTIONAL. This also exists on Product. The model name associated with a specific instance of an item.

Elite: This field is not supported.

ModelNumber
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity
number or null
Default: 5

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber
string or null
Default: "example value"

The serial number associated with a specific instance of an item.

Status
string or null
Default: "active"
Enum: "NotReady" "NoStock" "Unavailable" "Available" "OnRent" "OffRent" "Transfer" "Repair" "Maintenance" "ServiceOrder" "Reserved"

Status of an item. Because this is a computed property, GAPI CAN NOT SORT OR FILTER BY THIS FIELD. For elite, see https://wiki.pointofrental.com/en/Departments/Engineering/Elite-&-Expert/Applications/Elite---Browser/Items---Item-File/ItemStatusDescription

  • NotReady: State from Ready API. Not available in Syrinx yet
  • NoStock: Not available in Essentials or Syrinx.
  • Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A.
  • Available: Essentials: Item is in Stock. Syrinx: Item is available.
  • OnRent: Essentials: Is on contract in order status. Syrinx: N/A
  • OffRent: Not available in Essentials or Syrinx.
  • Transfer: Not available in Essentials or Syrinx.
  • Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair
  • Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair
  • ServiceOrder: Essentials: In maintenance of type service call.
  • Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A
object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","GlNumber":"example value","InternalClassificationType":"standard","ReadyStatus":"active","ReadyStatusChangeDateTime":"2023-08-15","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","UserDefined1":"example value","UserDefined2":"example value","TaxCode":42.5,"ExternalTaxCode":"ABC123"}
object or null
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023,"TotalDepreciation":42.5}

Depreciation fields for Stock

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is always 0.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

object or null
Deprecated
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023}

Depreciation fields for Stock

Alias
string or null
Deprecated
Default: "example value"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated
Default: "ABC123"

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Response samples

Content type
application/json
[
  • {
    }
]

Add fuel to a contract line item

Supported by: Elite

Add fuel to a contract line itemitem. Returns empty object on success. User can determine if it is successful by checking the response status code. 20X = success, 40X or 50X status codes are failures.

Required fields:

  • ContractLineItemId
  • FuelStockId
  • QuantitySold
Authorizations:
API Key
Request Body schema: application/json
required
ContractLineItemId
required
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The line item id of the contract that this stock item is associated with.

FuelStockId
required
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The id of the fuel type added. Found either on the line item additional fields, or the fuel info response.

QuantitySold
required
number
Default: 5

Amount of fuel added.

Responses

Request samples

Content type
application/json
{
  • "ContractLineItemId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "FuelStockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "QuantitySold": 5
}

Response samples

Content type
application/json
null

Update an existing Stock record

Supported by: Elite

Authorizations:
API Key
path Parameters
StockId
required
string
Request Body schema: application/json
required
SerialNumber
string or null
Default: "null"

The serial number of the stock item.

object or null
Default: {"Alias":"example value","Barcode":"ABC123"}

Identifying items for Stock.

object
Default: {"TotalDepreciation":42.5,"CurrentValue":42.5}
TotalDepreciation
number or null
Default: "null"

The total depreciation for the stock item.

CurrentValue
number or null
Default: "null"

The current netbook value of the stock item.

object
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"GlNumber":"example value","RentalCaseQuantity":5,"ReorderMaximum":42.5,"ReorderMinimum":42.5,"TaxCode":42.5,"ExternalTaxCode":"ABC123"}
CaseQuantity
number or null
Default: "null"

The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.

CriticalLevel
number or null
Default: "null"

When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.

GlNumber
string or null
Default: "null"

The gl number for the stock item.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

ReorderMaximum
number or null
Default: "null"

The maximum for reordering the item.

ReorderMinimum
number or null
Default: "null"

The minimum for reordering the item.

TaxCode
number or null
Default: 42.5

The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.

ExternalTaxCode
string or null
Default: "ABC123"

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Stock"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"Alias":"example value","Barcode":"ABC123","InventoryNumber":"example value","Key":"example value","PartNumber":"example value"}

Identifying items for Stock.

Alias
string or null
Default: "example value"

(Elite Only) Lookup field in Elite.

Barcode
string or null
Default: "ABC123"

(Elite Only) Barcode field in Elite.

InventoryNumber
string or null
Default: "example value"

A secondary number, possibly a barcode string, associated with an item or specific instance of an item.

Elite: This field is not supported.

Key
string or null
Default: "example value"

(Elite Only) A "human readable" form of id.

PartNumber
string or null
Default: "example value"

The part number associated to a specific instance of a part (Sales Only).

CategoryIds
Array of strings
Default: ["example item 1","example item 2"]

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName
string or null
Default: "Example Name"

Denormalized name of the Category.

Classification
string
Default: "example value"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The department id for this stock item

DepartmentName
string or null
Default: "Example Name"

(Elite Only) The department name for this stock item

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

HasFuel
boolean or null
Default: true

Item is eligible for add fuel

FuelCapacity
number or null
Default: 42.5

Fuel capacity of the item

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null
Default: true

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsCustomerWorkOrderItem
boolean or null
Default: true

Item is eligible for creating customer work orders

IsGenericWorkOrderItem
boolean or null
Default: true

Item is eligible for creating work orders

IsPart
boolean or null
Default: true

Used to determine if stock item is a part (Sales Only).

LoadingRatio
integer or null
Default: 42

A number that represents the ability for a stock item to fit on a vehicle.

Elite: This field is not supported.

Manufacturer
string or null
Default: "example value"

The manufacturer associated with a specific instance of an item.

ModelName
string or null
Default: "Example Name"

OPTIONAL. This also exists on Product. The model name associated with a specific instance of an item.

Elite: This field is not supported.

ModelNumber
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity
number or null
Default: 5

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber
string or null
Default: "example value"

The serial number associated with a specific instance of an item.

Status
string or null
Default: "active"
Enum: "NotReady" "NoStock" "Unavailable" "Available" "OnRent" "OffRent" "Transfer" "Repair" "Maintenance" "ServiceOrder" "Reserved"

Status of an item. Because this is a computed property, GAPI CAN NOT SORT OR FILTER BY THIS FIELD. For elite, see https://wiki.pointofrental.com/en/Departments/Engineering/Elite-&-Expert/Applications/Elite---Browser/Items---Item-File/ItemStatusDescription

  • NotReady: State from Ready API. Not available in Syrinx yet
  • NoStock: Not available in Essentials or Syrinx.
  • Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A.
  • Available: Essentials: Item is in Stock. Syrinx: Item is available.
  • OnRent: Essentials: Is on contract in order status. Syrinx: N/A
  • OffRent: Not available in Essentials or Syrinx.
  • Transfer: Not available in Essentials or Syrinx.
  • Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair
  • Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair
  • ServiceOrder: Essentials: In maintenance of type service call.
  • Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A
object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","GlNumber":"example value","InternalClassificationType":"standard","ReadyStatus":"active","ReadyStatusChangeDateTime":"2023-08-15","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","UserDefined1":"example value","UserDefined2":"example value","TaxCode":42.5,"ExternalTaxCode":"ABC123"}
CaseQuantity
number or null
Default: "null"

The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.

CriticalLevel
number or null
Default: "null"

When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.

CurrentStoreId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.

GlNumber
string or null
Default: "null"

The gl number for the stock item.

InternalClassificationType
string or null
Default: "standard"
Enum: "Non-rental Asset" "Work Order item"

(Elite Only) If the classification field is set as "Internal" this further specifies the type. If this is not set, this defaults to "null".

ReadyStatus
string or null <= 255 characters
Default: "active"
Enum: "Ready" "NotReady" "NotSet"

(Elite Only): The ready status of the item. Describes whether the item is Ready, Not Ready, or has not yet been evaluated as being ready or not ready.

ReadyStatusChangeDateTime
string or null <date-time>
Default: "2023-08-15"

(Elite Only): The date-time in which the ready status changed. May not be a future date/time. Should only be provided if entering historical records. Passing null will cause this field to default to the current date/time.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

RentalType
string or null
Default: "standard"
Enum: "Rental - Accessory" "Rental - Coupon" "Rental - Dynamic Qty" "Rental - Hour meter" "Rental - Miscellaneous" "Rental - No sale" "Rental - Normal" "Rental - Package" "Rental - Usage item"

(Elite Only) If the classification field is set as "Rental" this further specifies the type. If this is not set, this defaults to "null"

ReorderMaximum
number or null
Default: "null"

The maximum for reordering the item.

ReorderMinimum
number or null
Default: "null"

The minimum for reordering the item.

SalesType
string or null
Default: "standard"
Enum: "Sales - Fractional Qty" "Sales - Labor item" "Sales - Miscellaneous" "Sales - Normal" "Sales - Percent of Rental"

(Elite Only) If the classification field is set as "Sales" this further specifies the type. If this is not set, this defaults to "null"

UserDefined1
string or null
Default: "example value"

(Elite Only) Free field for customer use

UserDefined2
string or null
Default: "example value"

(Elite Only) Free field for customer use

TaxCode
number or null
Default: 42.5

The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.

ExternalTaxCode
string or null
Default: "ABC123"

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023,"TotalDepreciation":42.5}

Depreciation fields for Stock

DepreciationMethodCode
string or null
Default: "ABC123"

The Value which defines the method (i.e. Straight-Line, MACRS, etc).

Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.

CurrentValue
number or null
Default: 42.5

The current netbook value of the stock item.

SalvageValue
number or null
Default: 2023

The Salvageable value in terms of Depreciation.

TotalDepreciation
number or null
Default: "null"

The total depreciation for the stock item.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is always 0.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

One of
number
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

object or null
Deprecated
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023}

Depreciation fields for Stock

DepreciationMethodCode
string or null
Default: "ABC123"

The Value which defines the method (i.e. Straight-Line, MACRS, etc).

Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.

CurrentValue
number or null
Default: 42.5

The Current Value in terms of depreciation.

SalvageValue
number or null
Default: 2023

The Salvageable value in terms of Depreciation.

Alias
string or null
Deprecated
Default: "example value"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated
Default: "ABC123"

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Request samples

Content type
application/json
{
  • "SerialNumber": "example value",
  • "Identifiers": {
    },
  • "Depreciation": {
    },
  • "AdditionalFields": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepartmentId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DepartmentName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "HasFuel": true,
  • "FuelCapacity": 42.5,
  • "IsAsset": true,
  • "IsBulk": true,
  • "IsSerialized": true,
  • "IsCustomerWorkOrderItem": true,
  • "IsGenericWorkOrderItem": true,
  • "IsPart": true,
  • "LoadingRatio": 42,
  • "Manufacturer": "example value",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseDateTime": "2023-08-15",
  • "PurchasePrice": 99.99,
  • "Quantity": 5,
  • "SerialNumber": "example value",
  • "Status": "active",
  • "AdditionalFields": {
    },
  • "Depreciation": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "Revision": 42,
  • "DepreciationFields": {
    },
  • "Alias": "example value",
  • "Barcode": "ABC123"
}

Retrieve a single Stock record by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
StockId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Stock"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"Alias":"example value","Barcode":"ABC123","InventoryNumber":"example value","Key":"example value","PartNumber":"example value"}

Identifying items for Stock.

Alias
string or null
Default: "example value"

(Elite Only) Lookup field in Elite.

Barcode
string or null
Default: "ABC123"

(Elite Only) Barcode field in Elite.

InventoryNumber
string or null
Default: "example value"

A secondary number, possibly a barcode string, associated with an item or specific instance of an item.

Elite: This field is not supported.

Key
string or null
Default: "example value"

(Elite Only) A "human readable" form of id.

PartNumber
string or null
Default: "example value"

The part number associated to a specific instance of a part (Sales Only).

CategoryIds
Array of strings
Default: ["example item 1","example item 2"]

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName
string or null
Default: "Example Name"

Denormalized name of the Category.

Classification
string
Default: "example value"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The department id for this stock item

DepartmentName
string or null
Default: "Example Name"

(Elite Only) The department name for this stock item

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

HasFuel
boolean or null
Default: true

Item is eligible for add fuel

FuelCapacity
number or null
Default: 42.5

Fuel capacity of the item

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null
Default: true

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsCustomerWorkOrderItem
boolean or null
Default: true

Item is eligible for creating customer work orders

IsGenericWorkOrderItem
boolean or null
Default: true

Item is eligible for creating work orders

IsPart
boolean or null
Default: true

Used to determine if stock item is a part (Sales Only).

LoadingRatio
integer or null
Default: 42

A number that represents the ability for a stock item to fit on a vehicle.

Elite: This field is not supported.

Manufacturer
string or null
Default: "example value"

The manufacturer associated with a specific instance of an item.

ModelName
string or null
Default: "Example Name"

OPTIONAL. This also exists on Product. The model name associated with a specific instance of an item.

Elite: This field is not supported.

ModelNumber
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity
number or null
Default: 5

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber
string or null
Default: "example value"

The serial number associated with a specific instance of an item.

Status
string or null
Default: "active"
Enum: "NotReady" "NoStock" "Unavailable" "Available" "OnRent" "OffRent" "Transfer" "Repair" "Maintenance" "ServiceOrder" "Reserved"

Status of an item. Because this is a computed property, GAPI CAN NOT SORT OR FILTER BY THIS FIELD. For elite, see https://wiki.pointofrental.com/en/Departments/Engineering/Elite-&-Expert/Applications/Elite---Browser/Items---Item-File/ItemStatusDescription

  • NotReady: State from Ready API. Not available in Syrinx yet
  • NoStock: Not available in Essentials or Syrinx.
  • Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A.
  • Available: Essentials: Item is in Stock. Syrinx: Item is available.
  • OnRent: Essentials: Is on contract in order status. Syrinx: N/A
  • OffRent: Not available in Essentials or Syrinx.
  • Transfer: Not available in Essentials or Syrinx.
  • Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair
  • Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair
  • ServiceOrder: Essentials: In maintenance of type service call.
  • Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A
object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","GlNumber":"example value","InternalClassificationType":"standard","ReadyStatus":"active","ReadyStatusChangeDateTime":"2023-08-15","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","UserDefined1":"example value","UserDefined2":"example value","TaxCode":42.5,"ExternalTaxCode":"ABC123"}
CaseQuantity
number or null
Default: "null"

The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.

CriticalLevel
number or null
Default: "null"

When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.

CurrentStoreId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.

GlNumber
string or null
Default: "null"

The gl number for the stock item.

InternalClassificationType
string or null
Default: "standard"
Enum: "Non-rental Asset" "Work Order item"

(Elite Only) If the classification field is set as "Internal" this further specifies the type. If this is not set, this defaults to "null".

ReadyStatus
string or null <= 255 characters
Default: "active"
Enum: "Ready" "NotReady" "NotSet"

(Elite Only): The ready status of the item. Describes whether the item is Ready, Not Ready, or has not yet been evaluated as being ready or not ready.

ReadyStatusChangeDateTime
string or null <date-time>
Default: "2023-08-15"

(Elite Only): The date-time in which the ready status changed. May not be a future date/time. Should only be provided if entering historical records. Passing null will cause this field to default to the current date/time.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

RentalType
string or null
Default: "standard"
Enum: "Rental - Accessory" "Rental - Coupon" "Rental - Dynamic Qty" "Rental - Hour meter" "Rental - Miscellaneous" "Rental - No sale" "Rental - Normal" "Rental - Package" "Rental - Usage item"

(Elite Only) If the classification field is set as "Rental" this further specifies the type. If this is not set, this defaults to "null"

ReorderMaximum
number or null
Default: "null"

The maximum for reordering the item.

ReorderMinimum
number or null
Default: "null"

The minimum for reordering the item.

SalesType
string or null
Default: "standard"
Enum: "Sales - Fractional Qty" "Sales - Labor item" "Sales - Miscellaneous" "Sales - Normal" "Sales - Percent of Rental"

(Elite Only) If the classification field is set as "Sales" this further specifies the type. If this is not set, this defaults to "null"

UserDefined1
string or null
Default: "example value"

(Elite Only) Free field for customer use

UserDefined2
string or null
Default: "example value"

(Elite Only) Free field for customer use

TaxCode
number or null
Default: 42.5

The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.

ExternalTaxCode
string or null
Default: "ABC123"

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023,"TotalDepreciation":42.5}

Depreciation fields for Stock

DepreciationMethodCode
string or null
Default: "ABC123"

The Value which defines the method (i.e. Straight-Line, MACRS, etc).

Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.

CurrentValue
number or null
Default: 42.5

The current netbook value of the stock item.

SalvageValue
number or null
Default: 2023

The Salvageable value in terms of Depreciation.

TotalDepreciation
number or null
Default: "null"

The total depreciation for the stock item.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is always 0.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

One of
number
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

object or null
Deprecated
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023}

Depreciation fields for Stock

DepreciationMethodCode
string or null
Default: "ABC123"

The Value which defines the method (i.e. Straight-Line, MACRS, etc).

Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.

CurrentValue
number or null
Default: 42.5

The Current Value in terms of depreciation.

SalvageValue
number or null
Default: 2023

The Salvageable value in terms of Depreciation.

Alias
string or null
Deprecated
Default: "example value"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated
Default: "ABC123"

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepartmentId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DepartmentName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "HasFuel": true,
  • "FuelCapacity": 42.5,
  • "IsAsset": true,
  • "IsBulk": true,
  • "IsSerialized": true,
  • "IsCustomerWorkOrderItem": true,
  • "IsGenericWorkOrderItem": true,
  • "IsPart": true,
  • "LoadingRatio": 42,
  • "Manufacturer": "example value",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseDateTime": "2023-08-15",
  • "PurchasePrice": 99.99,
  • "Quantity": 5,
  • "SerialNumber": "example value",
  • "Status": "active",
  • "AdditionalFields": {
    },
  • "Depreciation": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "Revision": 42,
  • "DepreciationFields": {
    },
  • "Alias": "example value",
  • "Barcode": "ABC123"
}

Retrieve realtime Availability for a single Stock record by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
StockId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Cannot be used for patching or lookups

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"Key":"example value"}

Identifying items for Stock Availability.

Key
string or null
Default: "example value"

(Elite Only) A "human readable" form of id.

StockId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of stock

StockName
string
Default: "Example Name"

Name of stock

SerialNumber
string or null
Default: "example value"

The serial number associated with a specific instance of an item.

DepotId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The company id, store id, or depot id depending on which system you are using.

StartDateTime
string <date-time>
Default: "2023-08-15"

Start date of availability

EndDateTime
string <date-time>
Default: "2023-08-15"

End date of availability

AvailableQuantity
number
Default: 5

The current quantity available for rent or sale.

ExpectedQuantity
number
Default: 5

The quantity expected to be on premise. This is how many you would expect to find when doing an inventory count. This includes available and unavailable inventory.

TotalQuantity
number
Default: 5

Total quantity owned regardless of availability.

QtyExpected
number
Deprecated
Default: 42.5

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StockName": "Example Name",
  • "SerialNumber": "example value",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StartDateTime": "2023-08-15",
  • "EndDateTime": "2023-08-15",
  • "AvailableQuantity": 5,
  • "ExpectedQuantity": 5,
  • "TotalQuantity": 5,
  • "QtyExpected": 42.5
}

Retrieve fuel info for a single Stock record by Id

Supported by: Elite

Authorizations:
API Key
path Parameters
StockId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Cannot be used for patching or lookups

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"Key":"example value"}

Identifying items for Stock Availability.

Key
string or null
Default: "example value"

(Elite Only) A "human readable" form of id.

StockId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of stock

StockName
string
Default: "Example Name"

Name of stock

SerialNumber
string or null
Default: "example value"

The serial number associated with a specific instance of an item.

DepotId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The company id, store id, or depot id depending on which system you are using.

StartDateTime
string <date-time>
Default: "2023-08-15"

Start date of availability

EndDateTime
string <date-time>
Default: "2023-08-15"

End date of availability

AvailableQuantity
number
Default: 5

The current quantity available for rent or sale.

ExpectedQuantity
number
Default: 5

The quantity expected to be on premise. This is how many you would expect to find when doing an inventory count. This includes available and unavailable inventory.

TotalQuantity
number
Default: 5

Total quantity owned regardless of availability.

QtyExpected
number
Deprecated
Default: 42.5

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StockName": "Example Name",
  • "SerialNumber": "example value",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StartDateTime": "2023-08-15",
  • "EndDateTime": "2023-08-15",
  • "AvailableQuantity": 5,
  • "ExpectedQuantity": 5,
  • "TotalQuantity": 5,
  • "QtyExpected": 42.5
}

Retrieve files for a single Stock by Id.

Supported by: Elite

Authorizations:
API Key
path Parameters
StockId
required
string
tagKey
required
string

pdfs or instructions or photos

Responses

Response Schema: application/json
Array
FileName
string
Default: "Example Name"

Original local filename.

FileClass
string
Default: "example value"
Enum: "misc" "image" "video"

Defines the type of stored file.

PublicURL
string
Default: "https://example.com"

Web URL where the stored file can be downloaded.

URLDateTime
string <date-time>
Default: "https://example.com"

The date/time the URL was retrieved/created.

URLExpires
integer
Default: 42

Number of seconds from URLDateTime until URL expires.

TagMapKey
string
Default: "example value"
Enum: "pdfs" "instructions" "photos"

Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).

ObjectPrimaryKey
string
Default: "example value"

Primary key of the object this file is associated with (same as in the URL for single object get).

ObjectType
string
Default: "standard"

Type of object: One of Products, stock, or contract.

Tags
Array of strings
Default: ["example item 1","example item 2"]

List of all the tag names associated with each file (ONLY the TagName).

Response samples

Content type
application/json
[
  • {
    }
]

Adjust a single bulk Stock record

Supported by: Elite

Add or remove quantity of bulk Stock records. Quantity IS modifiable here, whereas it is not modifiable on the PATCH /apikey/stock/{StockId} endpoint.

Authorizations:
API Key
path Parameters
StockId
required
string
Request Body schema: application/json
required
QuantityAdjustment
required
number
Default: 5

How much stock are you adding?

StockId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Which Stock record are you adjusting

AdjustmentReason
string or null
Default: "example value"

Short note about why the Stock record is being modified

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the Stock. (See Depot endpoints)

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Product Id of the Stock record being modified.

PurchaseDateTime
string or null <date-time>
Default: "2023-08-15"

Date the Stock was purchased.

PurchasePrice
number or null
Default: 99.99

Price for which the Stock was purchased.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Stock"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

object or null
Default: {"Alias":"example value","Barcode":"ABC123","InventoryNumber":"example value","Key":"example value","PartNumber":"example value"}

Identifying items for Stock.

Alias
string or null
Default: "example value"

(Elite Only) Lookup field in Elite.

Barcode
string or null
Default: "ABC123"

(Elite Only) Barcode field in Elite.

InventoryNumber
string or null
Default: "example value"

A secondary number, possibly a barcode string, associated with an item or specific instance of an item.

Elite: This field is not supported.

Key
string or null
Default: "example value"

(Elite Only) A "human readable" form of id.

PartNumber
string or null
Default: "example value"

The part number associated to a specific instance of a part (Sales Only).

CategoryIds
Array of strings
Default: ["example item 1","example item 2"]

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName
string or null
Default: "Example Name"

Denormalized name of the Category.

Classification
string
Default: "example value"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The department id for this stock item

DepartmentName
string or null
Default: "Example Name"

(Elite Only) The department name for this stock item

DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)

HasFuel
boolean or null
Default: true

Item is eligible for add fuel

FuelCapacity
number or null
Default: 42.5

Fuel capacity of the item

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null
Default: true

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsCustomerWorkOrderItem
boolean or null
Default: true

Item is eligible for creating customer work orders

IsGenericWorkOrderItem
boolean or null
Default: true

Item is eligible for creating work orders

IsPart
boolean or null
Default: true

Used to determine if stock item is a part (Sales Only).

LoadingRatio
integer or null
Default: 42

A number that represents the ability for a stock item to fit on a vehicle.

Elite: This field is not supported.

Manufacturer
string or null
Default: "example value"

The manufacturer associated with a specific instance of an item.

ModelName
string or null
Default: "Example Name"

OPTIONAL. This also exists on Product. The model name associated with a specific instance of an item.

Elite: This field is not supported.

ModelNumber
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "example value"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity
number or null
Default: 5

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber
string or null
Default: "example value"

The serial number associated with a specific instance of an item.

Status
string or null
Default: "active"
Enum: "NotReady" "NoStock" "Unavailable" "Available" "OnRent" "OffRent" "Transfer" "Repair" "Maintenance" "ServiceOrder" "Reserved"

Status of an item. Because this is a computed property, GAPI CAN NOT SORT OR FILTER BY THIS FIELD. For elite, see https://wiki.pointofrental.com/en/Departments/Engineering/Elite-&-Expert/Applications/Elite---Browser/Items---Item-File/ItemStatusDescription

  • NotReady: State from Ready API. Not available in Syrinx yet
  • NoStock: Not available in Essentials or Syrinx.
  • Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A.
  • Available: Essentials: Item is in Stock. Syrinx: Item is available.
  • OnRent: Essentials: Is on contract in order status. Syrinx: N/A
  • OffRent: Not available in Essentials or Syrinx.
  • Transfer: Not available in Essentials or Syrinx.
  • Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair
  • Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair
  • ServiceOrder: Essentials: In maintenance of type service call.
  • Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A
object or null
Default: {"CaseQuantity":5,"CriticalLevel":42.5,"CurrentStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","GlNumber":"example value","InternalClassificationType":"standard","ReadyStatus":"active","ReadyStatusChangeDateTime":"2023-08-15","RentalCaseQuantity":5,"RentalType":"standard","ReorderMaximum":42.5,"ReorderMinimum":42.5,"SalesType":"standard","UserDefined1":"example value","UserDefined2":"example value","TaxCode":42.5,"ExternalTaxCode":"ABC123"}
CaseQuantity
number or null
Default: "null"

The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.

CriticalLevel
number or null
Default: "null"

When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.

CurrentStoreId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

(Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.

GlNumber
string or null
Default: "null"

The gl number for the stock item.

InternalClassificationType
string or null
Default: "standard"
Enum: "Non-rental Asset" "Work Order item"

(Elite Only) If the classification field is set as "Internal" this further specifies the type. If this is not set, this defaults to "null".

ReadyStatus
string or null <= 255 characters
Default: "active"
Enum: "Ready" "NotReady" "NotSet"

(Elite Only): The ready status of the item. Describes whether the item is Ready, Not Ready, or has not yet been evaluated as being ready or not ready.

ReadyStatusChangeDateTime
string or null <date-time>
Default: "2023-08-15"

(Elite Only): The date-time in which the ready status changed. May not be a future date/time. Should only be provided if entering historical records. Passing null will cause this field to default to the current date/time.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

RentalType
string or null
Default: "standard"
Enum: "Rental - Accessory" "Rental - Coupon" "Rental - Dynamic Qty" "Rental - Hour meter" "Rental - Miscellaneous" "Rental - No sale" "Rental - Normal" "Rental - Package" "Rental - Usage item"

(Elite Only) If the classification field is set as "Rental" this further specifies the type. If this is not set, this defaults to "null"

ReorderMaximum
number or null
Default: "null"

The maximum for reordering the item.

ReorderMinimum
number or null
Default: "null"

The minimum for reordering the item.

SalesType
string or null
Default: "standard"
Enum: "Sales - Fractional Qty" "Sales - Labor item" "Sales - Miscellaneous" "Sales - Normal" "Sales - Percent of Rental"

(Elite Only) If the classification field is set as "Sales" this further specifies the type. If this is not set, this defaults to "null"

UserDefined1
string or null
Default: "example value"

(Elite Only) Free field for customer use

UserDefined2
string or null
Default: "example value"

(Elite Only) Free field for customer use

TaxCode
number or null
Default: 42.5

The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.

ExternalTaxCode
string or null
Default: "ABC123"

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023,"TotalDepreciation":42.5}

Depreciation fields for Stock

DepreciationMethodCode
string or null
Default: "ABC123"

The Value which defines the method (i.e. Straight-Line, MACRS, etc).

Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.

CurrentValue
number or null
Default: 42.5

The current netbook value of the stock item.

SalvageValue
number or null
Default: 2023

The Salvageable value in terms of Depreciation.

TotalDepreciation
number or null
Default: "null"

The total depreciation for the stock item.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This means Deleted.

Elite: This field is always 0.

number or string
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

One of
number
Default: 42

For elite, only a number. It is a monotomic that can be used to detect changes.

object or null
Deprecated
Default: {"DepreciationMethodCode":"ABC123","DepreciationYears":2023,"CurrentValue":42.5,"SalvageValue":2023}

Depreciation fields for Stock

DepreciationMethodCode
string or null
Default: "ABC123"

The Value which defines the method (i.e. Straight-Line, MACRS, etc).

Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.

CurrentValue
number or null
Default: 42.5

The Current Value in terms of depreciation.

SalvageValue
number or null
Default: 2023

The Salvageable value in terms of Depreciation.

Alias
string or null
Deprecated
Default: "example value"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated
Default: "ABC123"

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Request samples

Content type
application/json
{
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "QuantityAdjustment": 5,
  • "AdjustmentReason": "example value",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseDateTime": "2023-08-15",
  • "PurchasePrice": 99.99
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Example Name",
  • "Classification": "example value",
  • "DepartmentId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "DepartmentName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "HasFuel": true,
  • "FuelCapacity": 42.5,
  • "IsAsset": true,
  • "IsBulk": true,
  • "IsSerialized": true,
  • "IsCustomerWorkOrderItem": true,
  • "IsGenericWorkOrderItem": true,
  • "IsPart": true,
  • "LoadingRatio": 42,
  • "Manufacturer": "example value",
  • "ModelName": "Example Name",
  • "ModelNumber": "example value",
  • "ModelYear": "example value",
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseDateTime": "2023-08-15",
  • "PurchasePrice": 99.99,
  • "Quantity": 5,
  • "SerialNumber": "example value",
  • "Status": "active",
  • "AdditionalFields": {
    },
  • "Depreciation": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42,
  • "Revision": 42,
  • "DepreciationFields": {
    },
  • "Alias": "example value",
  • "Barcode": "ABC123"
}

Retrieve work orders for a Stock record by Id

Gets all the work orders for a stock item

Authorizations:
API Key
path Parameters
StockId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
StockName
string or null
Default: "Example Name"
DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
OpenDateTime
string or null <date-time>
Default: "2023-08-15"
CloseDateTime
string or null <date-time>
Default: "2023-08-15"
CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CustomerId that should be responsible for this Work Order.

Status
string
Default: "active"
Enum: "Quote" "Open" "Closed"
Type
string or null
Default: "standard"
SubType
string or null
Default: "standard"
Array of objects or strings or null
Default: []
Array
One of
Classification
string or null
Enum: "Rental" "Sale" null

This product is either meant for sale or rental. The internal classification does not apply to lineitems.

Name
string

The display name for this record. This is often used as a summary for lookups.

IsBulk
boolean or null

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ProductId
string or null

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

PullFromStock
boolean or null

Indicates if the items should be pulled from stock when added to a work order.

PurchasePrice
number or null

The purchase price of the part.

Quantity
string or null

The quantity of this part on the work order

SerialNumber
string or null

The serial number or unique identifier assigned to this particular Line Item.

Status
string or null
Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved".

  • Reserved
  • Out
  • Off Rent
  • Returned
  • Sold
StockId
string or null

Id of stock

Comments
string

Any comments for this part.

IsCustomerWO
boolean
Default: true

Flag to telling whether the WO is consumer facing or not.

object or null
Default: {}

Labor tracking details.

LaborTypes
any or null
Complaint
string
Default: "example value"

The issue detected by the technician.

Cause
string
Default: "example value"

The cause of the issue, to be updated if needed.

Correction
string
Default: "example value"

The steps taken to correct the issue.

ReportedIssue
string
Default: "example value"

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

OtherComments
string
Default: "example value"

Any additional comments for this work order.

Operation
string
Default: "example value"

The operation that needs to be performed.

DueDateTime
string <date-time>
Default: "2023-08-15"

The due date for this work order.

AssignedRemoteUserId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The remote user assigned to this work order. This currently can only set by the RMS and not through the API

AdditionalFields
object or null
Default: {}

Additional fields for this record.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StockName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "OpenDateTime": "2023-08-15",
  • "CloseDateTime": "2023-08-15",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Status": "active",
  • "Type": "standard",
  • "SubType": "standard",
  • "Parts": [ ],
  • "IsCustomerWO": true,
  • "LaborTracking": { },
  • "Complaint": "example value",
  • "Cause": "example value",
  • "Correction": "example value",
  • "ReportedIssue": "example value",
  • "OtherComments": "example value",
  • "Operation": "example value",
  • "DueDateTime": "2023-08-15",
  • "AssignedRemoteUserId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Vendors

Create a new Vendor

Supported by: Elite

Required fields:

  • Name
Authorizations:
API Key
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "Example Name"

The full name of the vendor. Could be a company or an individual.

object or null
Default: {"AccountNumber":"example value","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Vendor.

We currently only support

  • AccountNumber
AccountNumber
string or null <= 50 characters
Default: "example value"

Vendor Account Number.

ExternalVendorId
string or null <= 100 characters
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External identification related to the vendor.

Elite: 2021.16.0+

Array of objects
Default: []

Supported types will depend on the product.

Elite:

  • Supported: "Default"
  • Coming soon: "Billing", "Shipping" .
Array
Type
required
string
Default: "Default"
Value: "Default"

Type of address "Default", "Billing", etc. Supported types depend on the context of the address.

For Vendor, this is only "Default".

Name
string or null

Optional name for Address

Line1
string or null <= 50 characters

Address Number and Street.

Line2
string or null <= 50 characters

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null >= 2 characters

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode
string or null <= 10 characters

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects
Default: []

Name and Types of Contacts related to the Vendor.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Secondary"

Relationship of the contact to the vendor.

required
object
CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

Inactive
boolean or null
Default: true

Used to denote whether a vendor is considered active.

Array of objects
Default: []

Any comments or notes.

Array
Value
required
string or null

The note text.

Array of objects
Default: []
Array
Type
required
string
Default: "Default"
Enum: "Default" "Mobile" "Secondary"

Supported phone types. "Default" is the default phone number for the contact.

Elite: Only supports "Default".

Number
required
string or null <= 50 characters

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

Terms
string or null <= 50 characters
Default: "example value"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null
Default: {"PaymentMethod":"example value","TermDays":42}

Additional fields specific to each vendor.

PaymentMethod
string or null
Default: "example value"

(Elite Only) Payment methods for this vendor.

Coming soon: You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "PaymentMethod" to receive a list of acceptable values for this field.

Elite: 2021.16.0+
Syrinx: Not supported.

TermDays
integer or null <= 2147483647
Default: 42

(Elite Only) Billing term days for the vendor.

Elite: 2021.16.0+
Syrinx: Not supported.

Responses

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "Contacts": [ ],
  • "CurrencyCode": "USD",
  • "Inactive": true,
  • "Notes": [ ],
  • "Phones": [ ],
  • "Terms": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "Contacts": [ ],
  • "CurrencyCode": "USD",
  • "Inactive": true,
  • "Notes": [ ],
  • "Phones": [ ],
  • "Terms": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Retrieve a list of Vendors

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Identifiers.AccountNumber
  • Addresses.Line1
  • Addresses.City
  • Addresses.Provice
  • Addresses.PostalCode
Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Vendor"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The full name of the vendor. Could be a company or an individual.

object or null
Default: {"AccountNumber":"example value","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Vendor.

We currently only support

  • AccountNumber
Array of objects
Default: []

Supported types will depend on the product.

Elite:

  • Supported: "Default"
  • Coming soon: "Billing", "Shipping"
Array of objects
Default: []

Name and Types of Contacts related to the Vendor.

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

Inactive
boolean or null
Default: true

Used to denote whether a vendor is considered active.

Array of objects
Default: []

Any comments or notes.

Array of objects
Default: []
Terms
string or null
Default: "example value"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null
Default: {"PaymentMethod":"example value","TermDays":42}

Additional fields specific to each vendor.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Vendor by Id

Supported by: Elite, Syrinx

Authorizations:
API Key
path Parameters
VendorId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Vendor"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The full name of the vendor. Could be a company or an individual.

object or null
Default: {"AccountNumber":"example value","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Vendor.

We currently only support

  • AccountNumber
AccountNumber
string or null
Default: "example value"

Vendor Account Number.

ExternalVendorId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External identification related to the vendor.

Elite: 2021.16.0+

Array of objects
Default: []

Supported types will depend on the product.

Elite:

  • Supported: "Default"
  • Coming soon: "Billing", "Shipping"
Array
Type
required
string
Default: "Default"
Value: "Default"

Type of address "Default", "Billing", etc. Supported types depend on the context of the address.

For Vendor, this is only "Default".

Name
string or null

Optional name for Address

Line1
string or null

Address Number and Street.

Line2
string or null

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode
string or null

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects
Default: []

Name and Types of Contacts related to the Vendor.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Secondary"

Relationship of the contact to the vendor.

required
object
CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

Inactive
boolean or null
Default: true

Used to denote whether a vendor is considered active.

Array of objects
Default: []

Any comments or notes.

Array
Type
required
string
Default: "Default"
Value: "Default"

Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.

Elite: There will only be one type of note, "Default".

Value
required
string or null

The note text.

Array of objects
Default: []
Array
Type
required
string
Default: "Default"
Enum: "Default" "Mobile" "Secondary"

Supported phone types. "Default" is the default phone number for the contact.

Elite: Only supports "Default".

Number
required
string or null

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null

Is there an extension associated with this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Terms
string or null
Default: "example value"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null
Default: {"PaymentMethod":"example value","TermDays":42}

Additional fields specific to each vendor.

PaymentMethod
string or null
Default: "example value"

(Elite Only) Payment methods for this vendor.

Coming soon: You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "PaymentMethod" to receive a list of acceptable values for this field.

Elite: 2021.16.0+
Syrinx: Not supported.

TermDays
integer or null
Default: 42

(Elite Only) Billing term days for the vendor.

Elite: 2021.16.0+
Syrinx: Not supported.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "Contacts": [ ],
  • "CurrencyCode": "USD",
  • "Inactive": true,
  • "Notes": [ ],
  • "Phones": [ ],
  • "Terms": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Update a single Vendor by Id

Supported by: Elite

Required fields:

  • Id
Authorizations:
API Key
path Parameters
VendorId
required
string
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "Example Name"

The full name of the vendor. Could be a company or an individual.

object or null
Default: {"AccountNumber":"example value","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Vendor.

We currently only support

  • AccountNumber
AccountNumber
string or null <= 50 characters
Default: "example value"

Vendor Account Number.

ExternalVendorId
string or null <= 100 characters
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External identification related to the vendor.

Elite: 2021.16.0+

Array of objects
Default: []

Supported types will depend on the product.

Elite:

  • Supported: "Default"
  • Coming soon: "Billing", "Shipping" .
Array
Type
required
string
Default: "Default"
Value: "Default"

Type of address "Default", "Billing", etc. Supported types depend on the context of the address.

For Vendor, this is only "Default".

Name
string or null

Optional name for Address

Line1
string or null <= 50 characters

Address Number and Street.

Line2
string or null <= 50 characters

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null >= 2 characters

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode
string or null <= 10 characters

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects
Default: []

Name and Types of Contacts related to the Vendor.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Secondary"

Relationship of the contact to the vendor.

required
object
CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

Inactive
boolean or null
Default: true

Used to denote whether a vendor is considered active.

Array of objects
Default: []

Any comments or notes.

Array
Value
required
string or null

The note text.

Array of objects
Default: []
Array
Type
required
string
Default: "Default"
Enum: "Default" "Mobile" "Secondary"

Supported phone types. "Default" is the default phone number for the contact.

Elite: Only supports "Default".

Number
required
string or null <= 50 characters

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

Terms
string or null <= 50 characters
Default: "example value"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null
Default: {"PaymentMethod":"example value","TermDays":42}

Additional fields specific to each vendor.

PaymentMethod
string or null
Default: "example value"

(Elite Only) Payment methods for this vendor.

Coming soon: You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "PaymentMethod" to receive a list of acceptable values for this field.

Elite: 2021.16.0+
Syrinx: Not supported.

TermDays
integer or null <= 2147483647
Default: 42

(Elite Only) Billing term days for the vendor.

Elite: 2021.16.0+
Syrinx: Not supported.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "Vendor"

Standard field that denotes the record type. Useful for bulk ingesting different record types.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

The full name of the vendor. Could be a company or an individual.

object or null
Default: {"AccountNumber":"example value","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Identifying items for Vendor.

We currently only support

  • AccountNumber
AccountNumber
string or null
Default: "example value"

Vendor Account Number.

ExternalVendorId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External identification related to the vendor.

Elite: 2021.16.0+

Array of objects
Default: []

Supported types will depend on the product.

Elite:

  • Supported: "Default"
  • Coming soon: "Billing", "Shipping"
Array
Type
required
string
Default: "Default"
Value: "Default"

Type of address "Default", "Billing", etc. Supported types depend on the context of the address.

For Vendor, this is only "Default".

Name
string or null

Optional name for Address

Line1
string or null

Address Number and Street.

Line2
string or null

May be apartment, building, suite.

Line3
string or null

May be apartment, building, suite.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

City
string or null

Usage Notes

  • MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

GeoRegion3
string or null

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Province
string or null

Usage Notes

  • MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode
string or null

May be postcode, post code, PIN or ZIP Code depending on the country.

Latitude
string or null

Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Longitude
string or null

Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.

  • LOC:LAT, LON
  • Loc:XX.123456789,-YY.123456789

Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.

Country
string or null

Two letter country code in ISO 3166-1 alpha-2 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects
Default: []

Name and Types of Contacts related to the Vendor.

Array
Type
required
string
Default: "Default"
Enum: "Default" "Secondary"

Relationship of the contact to the vendor.

required
object
CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format.

You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.

Inactive
boolean or null
Default: true

Used to denote whether a vendor is considered active.

Array of objects
Default: []

Any comments or notes.

Array
Type
required
string
Default: "Default"
Value: "Default"

Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.

Elite: There will only be one type of note, "Default".

Value
required
string or null

The note text.

Array of objects
Default: []
Array
Type
required
string
Default: "Default"
Enum: "Default" "Mobile" "Secondary"

Supported phone types. "Default" is the default phone number for the contact.

Elite: Only supports "Default".

Number
required
string or null

A phone number without the country code embedded.

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format.

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Extension
string or null

Is there an extension associated with this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

SmsCapable
boolean or null

Can an SMS be sent to this phone number?

Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Terms
string or null
Default: "example value"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null
Default: {"PaymentMethod":"example value","TermDays":42}

Additional fields specific to each vendor.

PaymentMethod
string or null
Default: "example value"

(Elite Only) Payment methods for this vendor.

Coming soon: You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "PaymentMethod" to receive a list of acceptable values for this field.

Elite: 2021.16.0+
Syrinx: Not supported.

TermDays
integer or null
Default: 42

(Elite Only) Billing term days for the vendor.

Elite: 2021.16.0+
Syrinx: Not supported.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record created? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer
Default: 42
Enum: null 1

0 = false, 1 = true | This basically means Deleted

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "Contacts": [ ],
  • "CurrencyCode": "USD",
  • "Inactive": true,
  • "Notes": [ ],
  • "Phones": [ ],
  • "Terms": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "Identifiers": {
    },
  • "Addresses": [ ],
  • "Contacts": [ ],
  • "CurrencyCode": "USD",
  • "Inactive": true,
  • "Notes": [ ],
  • "Phones": [ ],
  • "Terms": "example value",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Enum Lookup for Vendor

Supported by: Elite

With this endpoint, you can look up dynamic enum values for Vendor fields. The description on a particular field will indicate if it supports a lookup.

Authorizations:
API Key
path Parameters
field
required
string

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Lookup"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

Description
string or null
Default: "This is an example description for the API documentation."
Field
string
Default: "example value"
Value
string
Default: "example value"

Response samples

Content type
application/json
[
  • {
    }
]

Work Orders

Create a work order

Authorizations:
API Key
Request Body schema: application/json
required
StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
StockName
string or null
Default: "Example Name"
DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
OpenDateTime
string or null <date-time>
Default: "2023-08-15"
CloseDateTime
string or null <date-time>
Default: "2023-08-15"
CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CustomerId that should be responsible for this Work Order.

Status
string
Default: "active"
Enum: "Quote" "Open" "Closed"
Type
string or null
Default: "standard"
SubType
string or null
Default: "standard"
Array of objects or strings or null
Default: []
Array
One of
Name
string

The display name for this record. This is often used as a summary for lookups.

IsBulk
boolean or null

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ProductId
string or null

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

PullFromStock
boolean or null

Indicates if the items should be pulled from stock when added to a work order.

PurchasePrice
number or null

The purchase price of the part.

Quantity
string or null

The quantity of this part on the work order

StockId
string or null

Id of stock

Comments
string

Any comments for this part.

IsCustomerWO
boolean
Default: true

Flag to telling whether the WO is consumer facing or not.

Complaint
string
Default: "example value"

The issue detected by the technician.

Cause
string
Default: "example value"

The cause of the issue, to be updated if needed.

Correction
string
Default: "example value"

The steps taken to correct the issue.

ReportedIssue
string
Default: "example value"

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

OtherComments
string
Default: "example value"

Any additional comments for this work order.

Operation
string
Default: "example value"

The operation that needs to be performed.

DueDateTime
string <date-time>
Default: "2023-08-15"

The due date for this work order.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

Responses

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StockName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "OpenDateTime": "2023-08-15",
  • "CloseDateTime": "2023-08-15",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Status": "active",
  • "Type": "standard",
  • "SubType": "standard",
  • "Parts": [ ],
  • "IsCustomerWO": true,
  • "LaborTracking": { },
  • "Complaint": "example value",
  • "Cause": "example value",
  • "Correction": "example value",
  • "ReportedIssue": "example value",
  • "OtherComments": "example value",
  • "Operation": "example value",
  • "DueDateTime": "2023-08-15",
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StockName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "OpenDateTime": "2023-08-15",
  • "CloseDateTime": "2023-08-15",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Status": "active",
  • "Type": "standard",
  • "SubType": "standard",
  • "Parts": [ ],
  • "IsCustomerWO": true,
  • "LaborTracking": { },
  • "Complaint": "example value",
  • "Cause": "example value",
  • "Correction": "example value",
  • "ReportedIssue": "example value",
  • "OtherComments": "example value",
  • "Operation": "example value",
  • "DueDateTime": "2023-08-15",
  • "AssignedRemoteUserId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Retrieve a list of work orders

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
StockName
string or null
Default: "Example Name"
DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
OpenDateTime
string or null <date-time>
Default: "2023-08-15"
CloseDateTime
string or null <date-time>
Default: "2023-08-15"
CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CustomerId that should be responsible for this Work Order.

Status
string
Default: "active"
Enum: "Quote" "Open" "Closed"
Type
string or null
Default: "standard"
SubType
string or null
Default: "standard"
Array of objects or strings or null
Default: []
IsCustomerWO
boolean
Default: true

Flag to telling whether the WO is consumer facing or not.

object or null
Default: {}

Labor tracking details.

Complaint
string
Default: "example value"

The issue detected by the technician.

Cause
string
Default: "example value"

The cause of the issue, to be updated if needed.

Correction
string
Default: "example value"

The steps taken to correct the issue.

ReportedIssue
string
Default: "example value"

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

OtherComments
string
Default: "example value"

Any additional comments for this work order.

Operation
string
Default: "example value"

The operation that needs to be performed.

DueDateTime
string <date-time>
Default: "2023-08-15"

The due date for this work order.

AssignedRemoteUserId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The remote user assigned to this work order. This currently can only set by the RMS and not through the API

AdditionalFields
object or null
Default: {}

Additional fields for this record.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single work order by its id

Authorizations:
API Key
path Parameters
WorkOrderId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
StockName
string or null
Default: "Example Name"
DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
OpenDateTime
string or null <date-time>
Default: "2023-08-15"
CloseDateTime
string or null <date-time>
Default: "2023-08-15"
CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CustomerId that should be responsible for this Work Order.

Status
string
Default: "active"
Enum: "Quote" "Open" "Closed"
Type
string or null
Default: "standard"
SubType
string or null
Default: "standard"
Array of objects or strings or null
Default: []
Array
One of
Classification
string or null
Enum: "Rental" "Sale" null

This product is either meant for sale or rental. The internal classification does not apply to lineitems.

Name
string

The display name for this record. This is often used as a summary for lookups.

IsBulk
boolean or null

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ProductId
string or null

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

PullFromStock
boolean or null

Indicates if the items should be pulled from stock when added to a work order.

PurchasePrice
number or null

The purchase price of the part.

Quantity
string or null

The quantity of this part on the work order

SerialNumber
string or null

The serial number or unique identifier assigned to this particular Line Item.

Status
string or null
Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved".

  • Reserved
  • Out
  • Off Rent
  • Returned
  • Sold
StockId
string or null

Id of stock

Comments
string

Any comments for this part.

IsCustomerWO
boolean
Default: true

Flag to telling whether the WO is consumer facing or not.

object or null
Default: {}

Labor tracking details.

LaborTypes
any or null
Complaint
string
Default: "example value"

The issue detected by the technician.

Cause
string
Default: "example value"

The cause of the issue, to be updated if needed.

Correction
string
Default: "example value"

The steps taken to correct the issue.

ReportedIssue
string
Default: "example value"

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

OtherComments
string
Default: "example value"

Any additional comments for this work order.

Operation
string
Default: "example value"

The operation that needs to be performed.

DueDateTime
string <date-time>
Default: "2023-08-15"

The due date for this work order.

AssignedRemoteUserId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The remote user assigned to this work order. This currently can only set by the RMS and not through the API

AdditionalFields
object or null
Default: {}

Additional fields for this record.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StockName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "OpenDateTime": "2023-08-15",
  • "CloseDateTime": "2023-08-15",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Status": "active",
  • "Type": "standard",
  • "SubType": "standard",
  • "Parts": [ ],
  • "IsCustomerWO": true,
  • "LaborTracking": { },
  • "Complaint": "example value",
  • "Cause": "example value",
  • "Correction": "example value",
  • "ReportedIssue": "example value",
  • "OtherComments": "example value",
  • "Operation": "example value",
  • "DueDateTime": "2023-08-15",
  • "AssignedRemoteUserId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Update a single work order by its id

Authorizations:
API Key
path Parameters
WorkOrderId
required
string
Request Body schema: application/json
required
StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
StockName
string or null
Default: "Example Name"
DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
OpenDateTime
string or null <date-time>
Default: "2023-08-15"
CloseDateTime
string or null <date-time>
Default: "2023-08-15"
CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CustomerId that should be responsible for this Work Order.

Status
string
Default: "active"
Enum: "Quote" "Open" "Closed"
Type
string or null
Default: "standard"
SubType
string or null
Default: "standard"
Array of objects or strings or null
Default: []
Array
One of
Name
string

The display name for this record. This is often used as a summary for lookups.

IsBulk
boolean or null

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ProductId
string or null

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

PullFromStock
boolean or null

Indicates if the items should be pulled from stock when added to a work order.

PurchasePrice
number or null

The purchase price of the part.

Quantity
string or null

The quantity of this part on the work order

StockId
string or null

Id of stock

Comments
string

Any comments for this part.

IsCustomerWO
boolean
Default: true

Flag to telling whether the WO is consumer facing or not.

Complaint
string
Default: "example value"

The issue detected by the technician.

Cause
string
Default: "example value"

The cause of the issue, to be updated if needed.

Correction
string
Default: "example value"

The steps taken to correct the issue.

ReportedIssue
string
Default: "example value"

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

OtherComments
string
Default: "example value"

Any additional comments for this work order.

Operation
string
Default: "example value"

The operation that needs to be performed.

DueDateTime
string <date-time>
Default: "2023-08-15"

The due date for this work order.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

Responses

Response Schema: application/json
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
StockName
string or null
Default: "Example Name"
DepotId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"
OpenDateTime
string or null <date-time>
Default: "2023-08-15"
CloseDateTime
string or null <date-time>
Default: "2023-08-15"
CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Reference a CustomerId that should be responsible for this Work Order.

Status
string
Default: "active"
Enum: "Quote" "Open" "Closed"
Type
string or null
Default: "standard"
SubType
string or null
Default: "standard"
Array of objects or strings or null
Default: []
Array
One of
Classification
string or null
Enum: "Rental" "Sale" null

This product is either meant for sale or rental. The internal classification does not apply to lineitems.

Name
string

The display name for this record. This is often used as a summary for lookups.

IsBulk
boolean or null

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ProductId
string or null

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

PullFromStock
boolean or null

Indicates if the items should be pulled from stock when added to a work order.

PurchasePrice
number or null

The purchase price of the part.

Quantity
string or null

The quantity of this part on the work order

SerialNumber
string or null

The serial number or unique identifier assigned to this particular Line Item.

Status
string or null
Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved".

  • Reserved
  • Out
  • Off Rent
  • Returned
  • Sold
StockId
string or null

Id of stock

Comments
string

Any comments for this part.

IsCustomerWO
boolean
Default: true

Flag to telling whether the WO is consumer facing or not.

object or null
Default: {}

Labor tracking details.

LaborTypes
any or null
Complaint
string
Default: "example value"

The issue detected by the technician.

Cause
string
Default: "example value"

The cause of the issue, to be updated if needed.

Correction
string
Default: "example value"

The steps taken to correct the issue.

ReportedIssue
string
Default: "example value"

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

OtherComments
string
Default: "example value"

Any additional comments for this work order.

Operation
string
Default: "example value"

The operation that needs to be performed.

DueDateTime
string <date-time>
Default: "2023-08-15"

The due date for this work order.

AssignedRemoteUserId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The remote user assigned to this work order. This currently can only set by the RMS and not through the API

AdditionalFields
object or null
Default: {}

Additional fields for this record.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StockName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "OpenDateTime": "2023-08-15",
  • "CloseDateTime": "2023-08-15",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Status": "active",
  • "Type": "standard",
  • "SubType": "standard",
  • "Parts": [ ],
  • "IsCustomerWO": true,
  • "LaborTracking": { },
  • "Complaint": "example value",
  • "Cause": "example value",
  • "Correction": "example value",
  • "ReportedIssue": "example value",
  • "OtherComments": "example value",
  • "Operation": "example value",
  • "DueDateTime": "2023-08-15",
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Name": "Example Name",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "StockName": "Example Name",
  • "DepotId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "OpenDateTime": "2023-08-15",
  • "CloseDateTime": "2023-08-15",
  • "CustomerId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Status": "active",
  • "Type": "standard",
  • "SubType": "standard",
  • "Parts": [ ],
  • "IsCustomerWO": true,
  • "LaborTracking": { },
  • "Complaint": "example value",
  • "Cause": "example value",
  • "Correction": "example value",
  • "ReportedIssue": "example value",
  • "OtherComments": "example value",
  • "Operation": "example value",
  • "DueDateTime": "2023-08-15",
  • "AssignedRemoteUserId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "AdditionalFields": { },
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Retrieve a list of work order parts

Authorizations:
API Key
path Parameters
WorkOrderId
required
string

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"

Standard field that denotes the record type.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique identifier for this record.

Classification
string or null
Default: "example value"
Enum: "Rental" "Sale" null

This product is either meant for sale or rental. The internal classification does not apply to lineitems.

Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null
Default: true

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

PullFromStock
boolean or null
Default: true

Indicates if the items should be pulled from stock when added to a work order.

PurchasePrice
number or null
Default: 99.99

The purchase price of the part.

Quantity
string or null
Default: "example value"

The quantity of this part on the work order

SerialNumber
string or null
Default: "example value"

The serial number or unique identifier assigned to this particular Line Item.

Status
string or null
Default: "active"
Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved".

  • Reserved
  • Out
  • Off Rent
  • Returned
  • Sold
StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of stock

Comments
string
Default: "example value"

Any comments for this part.

CreatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was created.

UpdatedDateTime
string or null <date-time>
Default: "2023-08-15"

UTC when the record was updated.

Hidden
integer or null
Default: 42
Enum: null 1

Hidden

Response samples

Content type
application/json
[
  • {
    }
]

Create a work order part

Authorizations:
API Key
path Parameters
WorkOrderId
required
string
Request Body schema: application/json
required
Name
string
Default: "Example Name"

The display name for this record. This is often used as a summary for lookups.

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.

IsSerialized
boolean or null
Default: true

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ProductId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)

PullFromStock
boolean or null
Default: true

Indicates if the items should be pulled from stock when added to a work order.

PurchasePrice
number or null
Default: 99.99

The purchase price of the part.

Quantity
string or null
Default: "example value"

The quantity of this part on the work order

StockId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Id of stock

Comments
string
Default: "example value"

Any comments for this part.

Responses

Request samples

Content type
application/json
{
  • "Classification": "example value",
  • "Name": "Example Name",
  • "IsBulk": true,
  • "IsSerialized": true,
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PullFromStock": true,
  • "PurchasePrice": 99.99,
  • "Quantity": "example value",
  • "SerialNumber": "example value",
  • "Status": "active",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Comments": "example value"
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Classification": "example value",
  • "Name": "Example Name",
  • "IsBulk": true,
  • "IsSerialized": true,
  • "ProductId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PullFromStock": true,
  • "PurchasePrice": 99.99,
  • "Quantity": "example value",
  • "SerialNumber": "example value",
  • "Status": "active",
  • "StockId": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Comments": "example value",
  • "CreatedDateTime": "2023-08-15",
  • "UpdatedDateTime": "2023-08-15",
  • "Hidden": 42
}

Enum Lookup for Operations

Supported by: Elite

With this endpoint, you receive an array of contract operations supported by the current organization for the internal Work Order. This response is similar to the other EnumLookup responses.

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Lookup"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

Description
string or null
Default: "This is an example description for the API documentation."
Field
string
Default: "example value"
Value
string
Default: "example value"

Response samples

Content type
application/json
[
  • {
    }
]

Enum Lookup for Consumer Operations

Supported by: Elite

With this endpoint, you receive an array of consumer operations supported by the current organization for the customer. This response is similar to the other EnumLookup responses.

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "Lookup"

This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.

Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.

Name
string or null
Default: "Example Name"

A display name for this record. Often used as a summary for lookups.

Description
string or null
Default: "This is an example description for the API documentation."
Field
string
Default: "example value"
Value
string
Default: "example value"

Response samples

Content type
application/json
[
  • {
    }
]

Accounts Payable

Retrieve a list of Account Payable Invoices

Supported by: Elite

This is a list of account payable invoices. By default you can retrieve a list of payable invoices where State property is equal to 'Pending'. Apply an additional filter to the the State property in order to receive other payable invoices states.

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "AccountPayableInvoice"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

PurchaseOrderDateTime
string <date-time>
Default: "2023-08-15"

The purchase order date on the PO that resulted in the payable.

CurrencyCode
string or null
Default: "USD"

Currency code value set in the accounting system.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the payable invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever payable invoice State is set to 'Error'.

ExchangeRate
number or null
Default: 0.15

Exchange rate on the payable invoice.

FreightTotal
number
Default: 42.5

Total price of the freight.

GrandTaxTotal
number
Default: 42.5

Total amount of sales tax.

GrandTotal
number
Default: 42.5

Total amount that is payable.

object
Default: {"BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalLocationId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalPayableId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FreightAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","MiscellaneousAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","PayableAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","TaxAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this payable invoice.

Array of objects
Default: []

A collection of line items related to the contract Id.

Memo
string or null
Default: "example value"

Memo associated to the payable invoice.

MiscellaneousTotal
number
Default: 42.5

Total price of miscellaneous costs.

PurchaseOrderNumber
string
Default: "example value"

Purchase order number associated to the payable invoice.

PurchaseOrderSequenceNumber
string
Default: "example value"

Purchase order sequence number associated to the payable invoice.

PurchaseTotal
number
Default: 42.5

Total price of the purchases.

ShippingMethod
string
Default: "example value"

Shipping method on the payable invoice.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

TermsCode
string
Default: "ABC123"

Payment terms code in the accounting system.

object
Default: {"ModelType":"standard","Id":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","Name":"Example Name","InvoiceNumber":"example value","InvoiceDateTime":"2023-08-15","InvoiceDueDateTime":"2023-08-15"}

Elite vendor associated to this payable invoice.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Account Payable Invoice

Supported by: Elite

This is a single account payable invoice retrieved by the given payable invoice id.

Authorizations:
API Key
path Parameters
InvoiceId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "AccountPayableInvoice"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

PurchaseOrderDateTime
string <date-time>
Default: "2023-08-15"

The purchase order date on the PO that resulted in the payable.

CurrencyCode
string or null
Default: "USD"

Currency code value set in the accounting system.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the payable invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever payable invoice State is set to 'Error'.

ExchangeRate
number or null
Default: 0.15

Exchange rate on the payable invoice.

FreightTotal
number
Default: 42.5

Total price of the freight.

GrandTaxTotal
number
Default: 42.5

Total amount of sales tax.

GrandTotal
number
Default: 42.5

Total amount that is payable.

object
Default: {"BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalLocationId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalPayableId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FreightAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","MiscellaneousAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","PayableAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","TaxAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this payable invoice.

BatchId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite accounting batch Id associated with the payable.

ContractStoreId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Store Id associated with the payable invoice.

ExternalLocationId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External store/location Id in the accounting system.

ExternalPayableId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External payable Id in the accounting system.

ExternalVendorId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External vendor Id in the accounting system.

FreightAccountId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

General ledger freight account Id (Freight on purchases).

MiscellaneousAccountId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

General ledger miscellaneous account Id (Miscellaneous cost on purchases).

PayableAccountId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

General ledger payable account Id.

TaxAccountId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

General ledger tax account Id (Tax on purchases).

Array of objects
Default: []

A collection of line items related to the contract Id.

Array
ModelType
string
Value: "AccountPayableInvoiceLineItem"
Id
string

Unique identifier for the model type.

ExtendedUnitTotal
number

Total price of the quantity on the invoice multiplied by unit total.

FreightTotal
number

Total price of the freight.

GrandTaxTotal
number

Total price of the tax.

GrandTotal
number

Total price that is payable.

object

Collection of unique ids related to this payable invoice line item.

object

Elite item associated to this payable invoice line item.

LineNumber
integer

The line number in which this item was added onto the purchase order.

MiscellaneousTotal
string

Total price of miscellaneous costs.

PurchaseOrderNumber
string

Purchase order number associated to the line item.

PurchaseOrderPartNumber
string

Purchase order part number associated to the line item.

PurchaseOrderSequenceNumber
string

Purchase order sequence number associated to the line item.

QuantityOrdered
number

Quantity ordered on the purchase order.

QuantityReceived
number

Quantity received on the purchase order.

ReceivedDateTime
string <date-time>

Date and time when the line item was received.

UnitTotal
number

Total price of each individual unit.

Memo
string or null
Default: "example value"

Memo associated to the payable invoice.

MiscellaneousTotal
number
Default: 42.5

Total price of miscellaneous costs.

PurchaseOrderNumber
string
Default: "example value"

Purchase order number associated to the payable invoice.

PurchaseOrderSequenceNumber
string
Default: "example value"

Purchase order sequence number associated to the payable invoice.

PurchaseTotal
number
Default: 42.5

Total price of the purchases.

ShippingMethod
string
Default: "example value"

Shipping method on the payable invoice.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

TermsCode
string
Default: "ABC123"

Payment terms code in the accounting system.

object
Default: {"ModelType":"standard","Id":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","Name":"Example Name","InvoiceNumber":"example value","InvoiceDateTime":"2023-08-15","InvoiceDueDateTime":"2023-08-15"}

Elite vendor associated to this payable invoice.

ModelType
string
Default: "standard"
Value: "Vendor"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the vendor model type.

Name
string
Default: "Example Name"

Name of the vendor.

InvoiceNumber
string
Default: "example value"

Vendor's invoice number associated with the payable.

InvoiceDateTime
string <date-time>
Default: "2023-08-15"

Date of vendor's invoice.

InvoiceDueDateTime
string <date-time>
Default: "2023-08-15"

Due date of vendor's invoice.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseOrderDateTime": "2023-08-15",
  • "CurrencyCode": "USD",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "ExchangeRate": 0.15,
  • "FreightTotal": 42.5,
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "LineItems": [ ],
  • "Memo": "example value",
  • "MiscellaneousTotal": 42.5,
  • "PurchaseOrderNumber": "example value",
  • "PurchaseOrderSequenceNumber": "example value",
  • "PurchaseTotal": 42.5,
  • "ShippingMethod": "example value",
  • "State": "example value",
  • "TermsCode": "ABC123",
  • "Vendor": {
    }
}

Update an existing Account Payable Invoice

Supported by: Elite

Authorizations:
API Key
path Parameters
InvoiceId
required
string
Request Body schema: application/json
required
ErrorCode
string or null
Default: "ABC123"

Error code value whenever the payable invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever payable invoice State is set to 'Error'.

object
Default: {"BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalLocationId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalPayableId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FreightAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","MiscellaneousAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","PayableAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","TaxAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this payable invoice.

ExternalPayableId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External payable Id in the accounting system.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "AccountPayableInvoice"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

PurchaseOrderDateTime
string <date-time>
Default: "2023-08-15"

The purchase order date on the PO that resulted in the payable.

CurrencyCode
string or null
Default: "USD"

Currency code value set in the accounting system.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the payable invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever payable invoice State is set to 'Error'.

ExchangeRate
number or null
Default: 0.15

Exchange rate on the payable invoice.

FreightTotal
number
Default: 42.5

Total price of the freight.

GrandTaxTotal
number
Default: 42.5

Total amount of sales tax.

GrandTotal
number
Default: 42.5

Total amount that is payable.

object
Default: {"BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalLocationId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalPayableId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalVendorId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","FreightAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","MiscellaneousAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","PayableAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","TaxAccountId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this payable invoice.

BatchId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite accounting batch Id associated with the payable.

ContractStoreId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Store Id associated with the payable invoice.

ExternalLocationId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External store/location Id in the accounting system.

ExternalPayableId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External payable Id in the accounting system.

ExternalVendorId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External vendor Id in the accounting system.

FreightAccountId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

General ledger freight account Id (Freight on purchases).

MiscellaneousAccountId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

General ledger miscellaneous account Id (Miscellaneous cost on purchases).

PayableAccountId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

General ledger payable account Id.

TaxAccountId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

General ledger tax account Id (Tax on purchases).

Array of objects
Default: []

A collection of line items related to the contract Id.

Array
ModelType
string
Value: "AccountPayableInvoiceLineItem"
Id
string

Unique identifier for the model type.

ExtendedUnitTotal
number

Total price of the quantity on the invoice multiplied by unit total.

FreightTotal
number

Total price of the freight.

GrandTaxTotal
number

Total price of the tax.

GrandTotal
number

Total price that is payable.

object

Collection of unique ids related to this payable invoice line item.

object

Elite item associated to this payable invoice line item.

LineNumber
integer

The line number in which this item was added onto the purchase order.

MiscellaneousTotal
string

Total price of miscellaneous costs.

PurchaseOrderNumber
string

Purchase order number associated to the line item.

PurchaseOrderPartNumber
string

Purchase order part number associated to the line item.

PurchaseOrderSequenceNumber
string

Purchase order sequence number associated to the line item.

QuantityOrdered
number

Quantity ordered on the purchase order.

QuantityReceived
number

Quantity received on the purchase order.

ReceivedDateTime
string <date-time>

Date and time when the line item was received.

UnitTotal
number

Total price of each individual unit.

Memo
string or null
Default: "example value"

Memo associated to the payable invoice.

MiscellaneousTotal
number
Default: 42.5

Total price of miscellaneous costs.

PurchaseOrderNumber
string
Default: "example value"

Purchase order number associated to the payable invoice.

PurchaseOrderSequenceNumber
string
Default: "example value"

Purchase order sequence number associated to the payable invoice.

PurchaseTotal
number
Default: 42.5

Total price of the purchases.

ShippingMethod
string
Default: "example value"

Shipping method on the payable invoice.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

TermsCode
string
Default: "ABC123"

Payment terms code in the accounting system.

object
Default: {"ModelType":"standard","Id":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","Name":"Example Name","InvoiceNumber":"example value","InvoiceDateTime":"2023-08-15","InvoiceDueDateTime":"2023-08-15"}

Elite vendor associated to this payable invoice.

ModelType
string
Default: "standard"
Value: "Vendor"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the vendor model type.

Name
string
Default: "Example Name"

Name of the vendor.

InvoiceNumber
string
Default: "example value"

Vendor's invoice number associated with the payable.

InvoiceDateTime
string <date-time>
Default: "2023-08-15"

Date of vendor's invoice.

InvoiceDueDateTime
string <date-time>
Default: "2023-08-15"

Due date of vendor's invoice.

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseOrderDateTime": "2023-08-15",
  • "CurrencyCode": "USD",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "ExchangeRate": 0.15,
  • "FreightTotal": 42.5,
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "LineItems": [ ],
  • "Memo": "example value",
  • "MiscellaneousTotal": 42.5,
  • "PurchaseOrderNumber": "example value",
  • "PurchaseOrderSequenceNumber": "example value",
  • "PurchaseTotal": 42.5,
  • "ShippingMethod": "example value",
  • "State": "example value",
  • "TermsCode": "ABC123",
  • "Vendor": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "PurchaseOrderDateTime": "2023-08-15",
  • "CurrencyCode": "USD",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "ExchangeRate": 0.15,
  • "FreightTotal": 42.5,
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "LineItems": [ ],
  • "Memo": "example value",
  • "MiscellaneousTotal": 42.5,
  • "PurchaseOrderNumber": "example value",
  • "PurchaseOrderSequenceNumber": "example value",
  • "PurchaseTotal": 42.5,
  • "ShippingMethod": "example value",
  • "State": "example value",
  • "TermsCode": "ABC123",
  • "Vendor": {
    }
}

Accounts Receivable

[Elite Account Receivable Invoices] Get All

All Elite account receivable invoices, use query parameters to filter

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "AccountReceivableInvoice"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

ContractTotal
number
Default: 42.5

Total price of the contract excluding sales tax total.

ContractType
string
Default: "standard"
Enum: "Cash" "Credit" "Invoice"

Type of contract.

CurrencyCode
string or null
Default: "USD"

Currency code value set in the accounting system.

CustomerPurchaseOrderNumber
string or null
Default: "example value"

Customer purchase order number associated to the invoice.

DamageWaiverTotal
number
Default: 2023

Total price of the damage waiver.

object
Default: {"Type":"standard","City":"example value","Line1":"example value","PostalCode":"ABC123","Province":"example value"}

Ship to / delivery details associated to the contract on the invoice.

EndDateTime
string or null <date-time>
Default: "2023-08-15"

Date and time when the contract was closed.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever invoice State is set to 'Error'.

ExchangeRate
number or null
Default: 0.15

Exchange rate of the contract on the invoice.

GrandTaxTotal
number
Default: 42.5

Total amount of sales tax invoiced.

GrandTotal
number
Default: 42.5

Total price of the contract including sales tax.

object
Default: {"ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalLocationId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalInvoiceId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ParentContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this invoice.

InvoiceNumber
string or null
Default: "example value"

The Sequential Invoice Number associated with the Contract.

On Elite systems enabled for sequential Invoicing, this value (read only) represents the ID of the Invoice.

ItemPercentageTotal
number or null
Default: 0.15

Total value of item percentage on the contract.

Array of objects
Default: []

A collection of line items related to the contract Id.

OtherTotal
number
Default: 42.5

Total price of other/miscellaneous items on the contract.

OrderedBy
string or null
Default: "example value"

Customer representative who originated the contract.

PaidTotal
number
Default: 42.5

Total amount paid prior to the contract being closed.

PickedUpBy
string or null
Default: "example value"

Customer representative who picked up the items.

RentTotal
number
Default: 42.5

Total price of rental items on the contract.

RevenueDateTime
string <date-time>
Default: "2023-08-15"

Date and time of the revenue posting.

SaleTotal
number
Default: 42.5

Total price of sale items on the contract.

StartDateTime
string <date-time>
Default: "2023-08-15"

Date and time of when the contract opened.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

TaxableTotal
number
Default: 42.5

Total taxable price of the contract.

Response samples

Content type
application/json
[
  • {
    }
]

[Elite Account Receivable Invoices] Get By Id

Single Elite account receivable invoice by Id

Authorizations:
API Key
path Parameters
InvoiceId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "AccountReceivableInvoice"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

ContractTotal
number
Default: 42.5

Total price of the contract excluding sales tax total.

ContractType
string
Default: "standard"
Enum: "Cash" "Credit" "Invoice"

Type of contract.

CurrencyCode
string or null
Default: "USD"

Currency code value set in the accounting system.

CustomerPurchaseOrderNumber
string or null
Default: "example value"

Customer purchase order number associated to the invoice.

DamageWaiverTotal
number
Default: 2023

Total price of the damage waiver.

object
Default: {"Type":"standard","City":"example value","Line1":"example value","PostalCode":"ABC123","Province":"example value"}

Ship to / delivery details associated to the contract on the invoice.

Type
string
Default: "standard"
Value: "Default"
City
string
Default: "example value"
Line1
string
Default: "example value"
PostalCode
string
Default: "ABC123"
Province
string
Default: "example value"
EndDateTime
string or null <date-time>
Default: "2023-08-15"

Date and time when the contract was closed.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever invoice State is set to 'Error'.

ExchangeRate
number or null
Default: 0.15

Exchange rate of the contract on the invoice.

GrandTaxTotal
number
Default: 42.5

Total amount of sales tax invoiced.

GrandTotal
number
Default: 42.5

Total price of the contract including sales tax.

object
Default: {"ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalLocationId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalInvoiceId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ParentContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this invoice.

ContractId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Contract Id associated to the invoice which maps to the /Invoices Id property.

BatchId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite accounting batch id associated with the invoice.

ContractStoreId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Store Id associated to the contract on the invoice.

CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite customer id associated with the invoice.

ExternalLocationId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External location Id associated to the invoice.

ExternalInvoiceId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External invoice Id associated to the invoice.

*Only required if State is being set to 'Posted'

ExternalCustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The value from a 3rd party system that identifies the Customer record for integrations.

ParentContractId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Parent contract id associated with the invoice.

InvoiceNumber
string or null
Default: "example value"

The Sequential Invoice Number associated with the Contract.

On Elite systems enabled for sequential Invoicing, this value (read only) represents the ID of the Invoice.

ItemPercentageTotal
number or null
Default: 0.15

Total value of item percentage on the contract.

Array of objects
Default: []

A collection of line items related to the contract Id.

Array
ModelType
string
Value: "AccountReceivableInvoiceLineItem"
Id
string

Unique identifier for the model type.

AccountingClass
string or null

Class / Category in the accounting system.

DamageWaiverPercent
number or null

Percentage used in the damage waiver calculation on the line item.

DiscountPercent
number or null

Percentage discount applied to the line item.

DiscountTotal
number or null

Discount amount applied to the line item.

DueDateTime
string <date-time>

The date the item was returned.

ExtendedPriceTotal
number or null

Extended line item price.

GrandTaxTotal
number

Total sales tax amount for the line item.

GrandTotal
number

Total price charged on the line item, before adjustments from DiscountTotal.

HoursCharged
number or null

Total value of the hours charged.

object

Collection of unique ids related to this invoice line item.

object

Elite item associated to this invoice line item.

ItemPercent
number or null

Percentage used in the Item Percentage calculation for the item.

LineNumber
integer

The line number in which this item was added onto the contract.

Memo
string or null

Memo associated to the line item.

MeterIn
number or null

Meter reading on the line item when it was returned.

MeterOut
number or null

Meter reading on the line item when it was sent out.

NonTaxable
boolean

Flag denoting if the item is non taxable.

OutDateTime
string <date-time>

Date representing when the line item was sent out.

Quantity
number or null

Quantity associated to the line item. Number of units recorded on the contract for this line item.

TypeId
integer or null

Invoice line item type identifier.

Table of available type Ids

Type Id Type Name
1 TransItem
2 SalesTax
3 DamageWaiver
4 ItemPercentage
5 OtherIncome
6 PaidPriorToClose
7 Credit
8 Disbursement
TypeName
string
Enum: "TransItem" "SalesTax" "DamageWaiver" "ItemPercentage" "OtherIncome" "PaidPriorToClose" "Credit" "Disbursement" null

Invoice line item type name

OtherTotal
number
Default: 42.5

Total price of other/miscellaneous items on the contract.

OrderedBy
string or null
Default: "example value"

Customer representative who originated the contract.

PaidTotal
number
Default: 42.5

Total amount paid prior to the contract being closed.

PickedUpBy
string or null
Default: "example value"

Customer representative who picked up the items.

RentTotal
number
Default: 42.5

Total price of rental items on the contract.

RevenueDateTime
string <date-time>
Default: "2023-08-15"

Date and time of the revenue posting.

SaleTotal
number
Default: 42.5

Total price of sale items on the contract.

StartDateTime
string <date-time>
Default: "2023-08-15"

Date and time of when the contract opened.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

TaxableTotal
number
Default: 42.5

Total taxable price of the contract.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "ContractTotal": 42.5,
  • "ContractType": "standard",
  • "CurrencyCode": "USD",
  • "CustomerPurchaseOrderNumber": "example value",
  • "DamageWaiverTotal": 2023,
  • "Delivery": {
    },
  • "EndDateTime": "2023-08-15",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "ExchangeRate": 0.15,
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "InvoiceNumber": "example value",
  • "ItemPercentageTotal": 0.15,
  • "LineItems": [ ],
  • "OtherTotal": 42.5,
  • "OrderedBy": "example value",
  • "PaidTotal": 42.5,
  • "PickedUpBy": "example value",
  • "RentTotal": 42.5,
  • "RevenueDateTime": "2023-08-15",
  • "SaleTotal": 42.5,
  • "StartDateTime": "2023-08-15",
  • "State": "example value",
  • "TaxableTotal": 42.5
}

[Elite Account Receivable Invoices] Update

Update a single Elite account receivable invoice

Authorizations:
API Key
path Parameters
InvoiceId
required
string
Request Body schema: application/json
required
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever invoice State is set to 'Error'.

object
Default: {"ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalLocationId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalInvoiceId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this invoice.

ExternalInvoiceId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External invoice Id associated to the invoice.

*Only required if State is being set to 'Posted'

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "AccountReceivableInvoice"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

ContractTotal
number
Default: 42.5

Total price of the contract excluding sales tax total.

ContractType
string
Default: "standard"
Enum: "Cash" "Credit" "Invoice"

Type of contract.

CurrencyCode
string or null
Default: "USD"

Currency code value set in the accounting system.

CustomerPurchaseOrderNumber
string or null
Default: "example value"

Customer purchase order number associated to the invoice.

DamageWaiverTotal
number
Default: 2023

Total price of the damage waiver.

object
Default: {"Type":"standard","City":"example value","Line1":"example value","PostalCode":"ABC123","Province":"example value"}

Ship to / delivery details associated to the contract on the invoice.

Type
string
Default: "standard"
Value: "Default"
City
string
Default: "example value"
Line1
string
Default: "example value"
PostalCode
string
Default: "ABC123"
Province
string
Default: "example value"
EndDateTime
string or null <date-time>
Default: "2023-08-15"

Date and time when the contract was closed.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever invoice State is set to 'Error'.

ExchangeRate
number or null
Default: 0.15

Exchange rate of the contract on the invoice.

GrandTaxTotal
number
Default: 42.5

Total amount of sales tax invoiced.

GrandTotal
number
Default: 42.5

Total price of the contract including sales tax.

object
Default: {"ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractStoreId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalLocationId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalInvoiceId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ParentContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this invoice.

ContractId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Contract Id associated to the invoice which maps to the /Invoices Id property.

BatchId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite accounting batch id associated with the invoice.

ContractStoreId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Store Id associated to the contract on the invoice.

CustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite customer id associated with the invoice.

ExternalLocationId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External location Id associated to the invoice.

ExternalInvoiceId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External invoice Id associated to the invoice.

*Only required if State is being set to 'Posted'

ExternalCustomerId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The value from a 3rd party system that identifies the Customer record for integrations.

ParentContractId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Parent contract id associated with the invoice.

InvoiceNumber
string or null
Default: "example value"

The Sequential Invoice Number associated with the Contract.

On Elite systems enabled for sequential Invoicing, this value (read only) represents the ID of the Invoice.

ItemPercentageTotal
number or null
Default: 0.15

Total value of item percentage on the contract.

Array of objects
Default: []

A collection of line items related to the contract Id.

Array
ModelType
string
Value: "AccountReceivableInvoiceLineItem"
Id
string

Unique identifier for the model type.

AccountingClass
string or null

Class / Category in the accounting system.

DamageWaiverPercent
number or null

Percentage used in the damage waiver calculation on the line item.

DiscountPercent
number or null

Percentage discount applied to the line item.

DiscountTotal
number or null

Discount amount applied to the line item.

DueDateTime
string <date-time>

The date the item was returned.

ExtendedPriceTotal
number or null

Extended line item price.

GrandTaxTotal
number

Total sales tax amount for the line item.

GrandTotal
number

Total price charged on the line item, before adjustments from DiscountTotal.

HoursCharged
number or null

Total value of the hours charged.

object

Collection of unique ids related to this invoice line item.

object

Elite item associated to this invoice line item.

ItemPercent
number or null

Percentage used in the Item Percentage calculation for the item.

LineNumber
integer

The line number in which this item was added onto the contract.

Memo
string or null

Memo associated to the line item.

MeterIn
number or null

Meter reading on the line item when it was returned.

MeterOut
number or null

Meter reading on the line item when it was sent out.

NonTaxable
boolean

Flag denoting if the item is non taxable.

OutDateTime
string <date-time>

Date representing when the line item was sent out.

Quantity
number or null

Quantity associated to the line item. Number of units recorded on the contract for this line item.

TypeId
integer or null

Invoice line item type identifier.

Table of available type Ids

Type Id Type Name
1 TransItem
2 SalesTax
3 DamageWaiver
4 ItemPercentage
5 OtherIncome
6 PaidPriorToClose
7 Credit
8 Disbursement
TypeName
string
Enum: "TransItem" "SalesTax" "DamageWaiver" "ItemPercentage" "OtherIncome" "PaidPriorToClose" "Credit" "Disbursement" null

Invoice line item type name

OtherTotal
number
Default: 42.5

Total price of other/miscellaneous items on the contract.

OrderedBy
string or null
Default: "example value"

Customer representative who originated the contract.

PaidTotal
number
Default: 42.5

Total amount paid prior to the contract being closed.

PickedUpBy
string or null
Default: "example value"

Customer representative who picked up the items.

RentTotal
number
Default: 42.5

Total price of rental items on the contract.

RevenueDateTime
string <date-time>
Default: "2023-08-15"

Date and time of the revenue posting.

SaleTotal
number
Default: 42.5

Total price of sale items on the contract.

StartDateTime
string <date-time>
Default: "2023-08-15"

Date and time of when the contract opened.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

TaxableTotal
number
Default: 42.5

Total taxable price of the contract.

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "ContractTotal": 42.5,
  • "ContractType": "standard",
  • "CurrencyCode": "USD",
  • "CustomerPurchaseOrderNumber": "example value",
  • "DamageWaiverTotal": 2023,
  • "Delivery": {
    },
  • "EndDateTime": "2023-08-15",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "ExchangeRate": 0.15,
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "ItemPercentageTotal": 0.15,
  • "LineItems": [ ],
  • "OtherTotal": 42.5,
  • "OrderedBy": "example value",
  • "PaidTotal": 42.5,
  • "PickedUpBy": "example value",
  • "RentTotal": 42.5,
  • "RevenueDateTime": "2023-08-15",
  • "SaleTotal": 42.5,
  • "StartDateTime": "2023-08-15",
  • "State": "example value",
  • "TaxableTotal": 42.5
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "ContractTotal": 42.5,
  • "ContractType": "standard",
  • "CurrencyCode": "USD",
  • "CustomerPurchaseOrderNumber": "example value",
  • "DamageWaiverTotal": 2023,
  • "Delivery": {
    },
  • "EndDateTime": "2023-08-15",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "ExchangeRate": 0.15,
  • "GrandTaxTotal": 42.5,
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "InvoiceNumber": "example value",
  • "ItemPercentageTotal": 0.15,
  • "LineItems": [ ],
  • "OtherTotal": 42.5,
  • "OrderedBy": "example value",
  • "PaidTotal": 42.5,
  • "PickedUpBy": "example value",
  • "RentTotal": 42.5,
  • "RevenueDateTime": "2023-08-15",
  • "SaleTotal": 42.5,
  • "StartDateTime": "2023-08-15",
  • "State": "example value",
  • "TaxableTotal": 42.5
}

[Elite Account Receivable Payments] Get All

All Elite account receivable payments, use query parameters to filter

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "AccountReceivablePayment"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

ContractCodeName
string
Default: "Example Name"
Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the payment State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever payment State is set to 'Error'.

GrandTotal
number
Default: 42.5

Total amount credited to the customer invoice.

object
Default: {"ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InvoiceNumber":"example value","ExternalInvoiceId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CreditSourceContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CreditSourceInvoiceNumber":"example value","ExternalCreditId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}
Memo
string
Default: "example value"

Note, reference or description related to the payment.

Method
string
Default: "example value"
Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

PostedDateTime
string <date-time>
Default: "2023-08-15"

Date and time when the payment was posted.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the payment. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

CreatedDateTime
string <date-time>
Default: "2023-08-15"

Date and time when the payment was added to the queue.

Response samples

Content type
application/json
[
  • {
    }
]

[Elite Account Receivable Payments] Create

Create a single Elite account receivable payment

Authorizations:
API Key
Request Body schema: application/json
required
ContractCodeName
required
string
Default: "Example Name"
Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment.

required
object
Default: {"ExternalContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InvoiceNumber":"example value","ExternalInvoiceId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CreditSourceContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CreditSourceInvoiceNumber":"example value","ExternalCreditId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

All Requests

For every request, ONE from each of the bullet points below is REQUIRED:

  • ContractId, ExternalContractId, ExternalInvoiceId, or InvoiceNumber
  • CustomerId or ExternalCustomerId

Credit Requests Require an Additional Identifiers Field

  • When posting a credit with the parameter that ContractCodeName = 'Credit', ONE of the following is REQUIRED to be set IN ADDITION TO THE ABOVE: CreditSourceContractId, ExternalCreditId, or CreditSourceInvoiceNumber.
ExternalContractId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External contract Id in the accounting system.

One of the following is REQUIRED to be set: ContractId, ExternalContractId, ExternalInvoiceId, or InvoiceNumber.

ContractId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Contract Id associated to the payment. Contract that has credit or payment applied.

One of the following is REQUIRED to be set: ContractId, ExternalContractId, ExternalInvoiceId, or InvoiceNumber.

InvoiceNumber
string
Default: "example value"

The Sequential Invoice Number associated with the Contract.

One of the following is REQUIRED to be set: ContractId, ExternalContractId, ExternalInvoiceId, or InvoiceNumber.

ExternalInvoiceId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External invoice Id in the accounting system. It must be associated with an Elite contract accounting link.

One of the following is REQUIRED to be set: ContractId, ExternalContractId, ExternalInvoiceId, or InvoiceNumber.

CreditSourceContractId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Contract Id sourcing the credit amount. This is the credit contract that sourced the credit being applied.

When posting a credit with the parameter that ContractCodeName = 'Credit', one of the following is REQUIRED to be set: CreditSourceContractId, ExternalCreditId, or CreditSourceInvoiceNumber.

CreditSourceInvoiceNumber
string
Default: "example value"

The Sequential Invoice Number associated with the Credit Source Contract.

When posting a credit with the parameter that ContractCodeName = 'Credit', one of the following is REQUIRED to be set: CreditSourceContractId, ExternalCreditId, or CreditSourceInvoiceNumber.

ExternalCreditId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External credit memo Id in the accounting system. Credit Id must be associated to a contract accounting link.

When posting a credit with the parameter that ContractCodeName = 'Credit', one of the following is REQUIRED to be set: CreditSourceContractId, ExternalCreditId, or CreditSourceInvoiceNumber.

CustomerId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite Customer Id associated with the payment.

One of the following is REQUIRED to be set: CustomerId or ExternalCustomerId.

ExternalCustomerId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The value from a 3rd party system that identifies the Customer record for integrations. It must be associated with an Elite customer's accounting link.

One of the following is REQUIRED to be set: CustomerId or ExternalCustomerId.

GrandTotal
number
Default: 42.5

Total amount credited to the customer invoice.

Memo
string
Default: "example value"

Note, reference or description related to the payment.

Method
string
Default: "example value"
Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

REQUIRED if ContractCodeName = 'Payment'.

PostedDateTime
string <date-time>
Default: "2023-08-15"

Date and time when the payment was posted.

Responses

Request samples

Content type
application/json
{
  • "ContractCodeName": "Example Name",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "Memo": "example value",
  • "Method": "example value",
  • "PostedDateTime": "2023-08-15",
  • "State": "example value"
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "ContractCodeName": "Example Name",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "Memo": "example value",
  • "Method": "example value",
  • "PostedDateTime": "2023-08-15",
  • "State": "example value",
  • "CreatedDateTime": "2023-08-15"
}

[Elite Account Receivable Payments] Get By Id

Single Elite account receivable payment by Id

Authorizations:
API Key
path Parameters
PaymentId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "AccountReceivablePayment"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

ContractCodeName
string
Default: "Example Name"
Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the payment State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever payment State is set to 'Error'.

GrandTotal
number
Default: 42.5

Total amount credited to the customer invoice.

object
Default: {"ContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","InvoiceNumber":"example value","ExternalInvoiceId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CreditSourceContractId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CreditSourceInvoiceNumber":"example value","ExternalCreditId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","CustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalCustomerId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}
ContractId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Contract Id associated to the payment. Contract that has credit or payment applied.

InvoiceNumber
string
Default: "example value"

The Sequential Invoice Number associated with the Contract.

On Elite systems enabled for sequential Invoicing, this value (read only) represents the ID of the Invoice.

ExternalInvoiceId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External invoice Id in the accounting system. It must be associated with an Elite contract accounting link.

ExternalContractId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External contract Id in the accounting system.

CreditSourceContractId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Contract Id sourcing the credit amount. This is the credit contract that sourced the credit being applied.

CreditSourceInvoiceNumber
string
Default: "example value"

The Sequential Invoice Number associated with the Credit Source Contract.

On Elite systems enabled for sequential Invoicing, this value (read only) represents the ID of the Invoice.

ExternalCreditId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External credit memo Id in the accounting system. Credit Id must be associated to a contract accounting link.

CustomerId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite Customer Id associated with the payment.

ExternalCustomerId
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

The value from a 3rd party system that identifies the Customer record for integrations. It must be associated with an Elite customer's accounting link.

Memo
string
Default: "example value"

Note, reference or description related to the payment.

Method
string
Default: "example value"
Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

PostedDateTime
string <date-time>
Default: "2023-08-15"

Date and time when the payment was posted.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the payment. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state.

CreatedDateTime
string <date-time>
Default: "2023-08-15"

Date and time when the payment was added to the queue.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "ContractCodeName": "Example Name",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "GrandTotal": 42.5,
  • "Identifiers": {
    },
  • "Memo": "example value",
  • "Method": "example value",
  • "PostedDateTime": "2023-08-15",
  • "State": "example value",
  • "CreatedDateTime": "2023-08-15"
}

Journal Entries

Retrieve a list of General Ledger Journal Entries

Supported by: Elite

This is a list of general ledger journal entries. By default you can retrieve a list of journal entries where State property is equal to 'Pending'. Apply an additional filter to the the State property in order to receive other journal entries states.

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Default: "standard"
Value: "JournalEntry"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

object
Default: {"Class":"example value","Contract":"example value","Customer":"example value","Department":"example value","Employee":"example value","Item":"example value","JobSite":"example value","Location":"example value","Project":"example value","SalesPerson":"example value","Vendor":"example value"}

Collection of dimensions related to a specific type.

EntryDateTime
string or null
Default: "2023-08-15"

Date and time when the journal entry was created.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever invoice State is set to 'Error'.

object
Default: {"BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalJournalEntryId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this invoice line item.

Array of objects
Default: []

A collection of line items related to the contract Id.

Memo
string or null
Default: "example value"

Memo associated to the journal entry.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the journal entry. Initial value of an journal entry is 'Pending'. If the value is 'Posted' you can not update to another state.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single General Ledger Journal Entry

Supported by: Elite

This is a single general ledger journal entries retrieved by a given journal entry id.

Authorizations:
API Key
path Parameters
JournalEntryId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "JournalEntry"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

object
Default: {"Class":"example value","Contract":"example value","Customer":"example value","Department":"example value","Employee":"example value","Item":"example value","JobSite":"example value","Location":"example value","Project":"example value","SalesPerson":"example value","Vendor":"example value"}

Collection of dimensions related to a specific type.

Class
string
Default: "example value"

Class dimension.

Contract
string
Default: "example value"

Contract dimension.

Customer
string
Default: "example value"

Customer dimension.

Department
string
Default: "example value"

Department dimension.

Employee
string
Default: "example value"

Employee dimension.

Item
string
Default: "example value"

Item dimension.

JobSite
string
Default: "example value"

JobSite dimension.

Location
string
Default: "example value"

Location dimension.

Project
string
Default: "example value"

Project dimension.

SalesPerson
string
Default: "example value"

SalesPerson dimension.

Vendor
string
Default: "example value"

Vendor dimension.

EntryDateTime
string or null
Default: "2023-08-15"

Date and time when the journal entry was created.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever invoice State is set to 'Error'.

object
Default: {"BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalJournalEntryId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this invoice line item.

BatchId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite accounting batch Id associated with the journal entry.

ExternalJournalEntryId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External journal entry Id in the accounting system.

Array of objects
Default: []

A collection of line items related to the contract Id.

Array
ModelType
string
Value: "JournalEntryLineItem"
Id
string

Unique identifier for the model type.

GrandTotal
number

Line item amount.

Positive values are debits.

Negative values are credits.

object

Collection of unique ids related to the journal entry line item.

Memo
string or null

Memo associated to the line item.

Memo
string or null
Default: "example value"

Memo associated to the journal entry.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the journal entry. Initial value of an journal entry is 'Pending'. If the value is 'Posted' you can not update to another state.

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Dimensions": {
    },
  • "EntryDateTime": "2023-08-15",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "Identifiers": {
    },
  • "LineItems": [ ],
  • "Memo": "example value",
  • "State": "example value"
}

Update an existing General Ledger Journal Entry

Supported by: Elite

Authorizations:
API Key
path Parameters
JournalEntryId
required
string
Request Body schema: application/json
required
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever invoice State is set to 'Error'.

object
Default: {"BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalJournalEntryId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this invoice line item.

ExternalJournalEntryId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External journal entry Id in the accounting system.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the journal entry. Initial value of an journal entry is 'Pending'. If the value is 'Posted' you can not update to another state.

Responses

Response Schema: application/json
ModelType
string
Default: "standard"
Value: "JournalEntry"
Id
string
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Unique identifier for the model type.

object
Default: {"Class":"example value","Contract":"example value","Customer":"example value","Department":"example value","Employee":"example value","Item":"example value","JobSite":"example value","Location":"example value","Project":"example value","SalesPerson":"example value","Vendor":"example value"}

Collection of dimensions related to a specific type.

Class
string
Default: "example value"

Class dimension.

Contract
string
Default: "example value"

Contract dimension.

Customer
string
Default: "example value"

Customer dimension.

Department
string
Default: "example value"

Department dimension.

Employee
string
Default: "example value"

Employee dimension.

Item
string
Default: "example value"

Item dimension.

JobSite
string
Default: "example value"

JobSite dimension.

Location
string
Default: "example value"

Location dimension.

Project
string
Default: "example value"

Project dimension.

SalesPerson
string
Default: "example value"

SalesPerson dimension.

Vendor
string
Default: "example value"

Vendor dimension.

EntryDateTime
string or null
Default: "2023-08-15"

Date and time when the journal entry was created.

ErrorCode
string or null
Default: "ABC123"

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null
Default: "This is an example description for the API documentation."

Error description value whenever invoice State is set to 'Error'.

object
Default: {"BatchId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454","ExternalJournalEntryId":"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"}

Collection of unique ids related to this invoice line item.

BatchId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

Elite accounting batch Id associated with the journal entry.

ExternalJournalEntryId
string or null
Default: "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454"

External journal entry Id in the accounting system.

Array of objects
Default: []

A collection of line items related to the contract Id.

Array
ModelType
string
Value: "JournalEntryLineItem"
Id
string

Unique identifier for the model type.

GrandTotal
number

Line item amount.

Positive values are debits.

Negative values are credits.

object

Collection of unique ids related to the journal entry line item.

Memo
string or null

Memo associated to the line item.

Memo
string or null
Default: "example value"

Memo associated to the journal entry.

State
string
Default: "example value"
Enum: "Pending" "Posted" "Error"

Defines the state of the journal entry. Initial value of an journal entry is 'Pending'. If the value is 'Posted' you can not update to another state.

Request samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Dimensions": {
    },
  • "EntryDateTime": "2023-08-15",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "Identifiers": {
    },
  • "LineItems": [ ],
  • "Memo": "example value",
  • "State": "example value"
}

Response samples

Content type
application/json
{
  • "ModelType": "standard",
  • "Id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  • "Dimensions": {
    },
  • "EntryDateTime": "2023-08-15",
  • "ErrorCode": "ABC123",
  • "ErrorDescription": "This is an example description for the API documentation.",
  • "Identifiers": {
    },
  • "LineItems": [ ],
  • "Memo": "example value",
  • "State": "example value"
}

Hire Rates

Get all hire rates.

Supported by: Syrinx

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Value: "HireRate"
Id
string
Name
string
CategoryName
string

The category that the hire rate belongs to.

DayRate
number

The flat rate to charge for a single day.

HourRate
number

The rate to charge per hour.

WeekRate
number

The rate to charge per week.

WeekRateHalfDay
number

The rate to charge for half a week day.

WeekRate1Day
number

The rate to charge for a week day.

WeekRate2Day
number

The rate to charge for 2 week days.

WeekRate3Day
number

The rate to charge for 3 week days.

WeekRate4Day
number

The rate to charge for 4 week days.

WeekendRate
number

The rate to charge over a weekend.

MonthRate
number

The rate to charge per month.

Response samples

Content type
application/json
[
  • {
    }
]

Get all hire rates.

Supported by: Syrinx

Authorizations:
API Key

Responses

Response Schema: application/json
Array
ModelType
string
Value: "HireRate"
Id
string
Name
string
CategoryName
string

The category that the hire rate belongs to.

DayRate
number

The flat rate to charge for a single day.

HourRate
number

The rate to charge per hour.

WeekRate
number

The rate to charge per week.

WeekRateHalfDay
number

The rate to charge for half a week day.

WeekRate1Day
number

The rate to charge for a week day.

WeekRate2Day
number

The rate to charge for 2 week days.

WeekRate3Day
number

The rate to charge for 3 week days.

WeekRate4Day
number

The rate to charge for 4 week days.

WeekendRate
number

The rate to charge over a weekend.

MonthRate
number

The rate to charge per month.

Response samples

Content type
application/json
[
  • {
    }
]

Get all hire rates.

Supported by: Syrinx

Authorizations:
API Key
path Parameters
HireRateId
required
string

Responses

Response Schema: application/json
Array
ModelType
string
Value: "HireRate"
Id
string
Name
string
CategoryName
string

The category that the hire rate belongs to.

DayRate
number

The flat rate to charge for a single day.

HourRate
number

The rate to charge per hour.

WeekRate
number

The rate to charge per week.

WeekRateHalfDay
number

The rate to charge for half a week day.

WeekRate1Day
number

The rate to charge for a week day.

WeekRate2Day
number

The rate to charge for 2 week days.

WeekRate3Day
number

The rate to charge for 3 week days.

WeekRate4Day
number

The rate to charge for 4 week days.

WeekendRate
number

The rate to charge over a weekend.

MonthRate
number

The rate to charge per month.

Response samples

Content type
application/json
[
  • {
    }
]

Get all hire rates.

Supported by: Syrinx

Authorizations:
API Key
path Parameters
HireRateId
required
string

Responses

Response Schema: application/json
Array
ModelType
string
Value: "HireRate"
Id
string
Name
string
CategoryName
string

The category that the hire rate belongs to.

DayRate
number

The flat rate to charge for a single day.

HourRate
number

The rate to charge per hour.

WeekRate
number

The rate to charge per week.

WeekRateHalfDay
number

The rate to charge for half a week day.

WeekRate1Day
number

The rate to charge for a week day.

WeekRate2Day
number

The rate to charge for 2 week days.

WeekRate3Day
number

The rate to charge for 3 week days.

WeekRate4Day
number

The rate to charge for 4 week days.

WeekendRate
number

The rate to charge over a weekend.

MonthRate
number

The rate to charge per month.

Response samples

Content type
application/json
[
  • {
    }
]