Point of Rental Global API Reference (2026.07.00)

Download OpenAPI specification:

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

Point of Rental Global API

The Global API provides a standardized interface for integrating with Point of Rental's rental management systems, including Elite, Essentials, and Syrinx.

Common Status Codes

Operation Success Code Description
Create 201 Resource successfully created
Get All 200 Resources successfully retrieved
Get By Id 200 Resource successfully retrieved
Update 200 Resource successfully updated
Delete 200 / 204 Resource deleted / No resource found to delete

Common Error Codes

Code Meaning Possible Cause
400 Bad Request Missing required fields or invalid data format
401 Unauthorized Missing or invalid authentication credentials
403 Forbidden Authenticated user doesn't have permission to access the resource
404 Not Found Resource doesn't exist or endpoint not found
409 Conflict Request conflicts with the current state of the resource
429 Too Many Requests Rate limit exceeded - please reduce request frequency
500 Internal Server Error Unexpected server error - please contact support if persistent

Filtering

Filters are passed via the X-Filter request header. 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 comparators 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

Results are paged via the X-Paging request header. Note: 100 is the upper limit on page size requests. We recommend iterating through pages rather than requesting very large page sizes at once, since larger responses can create performance or response-size issues on some endpoints.

Paging example:

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

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

Retrieve a list of categories

Supported by: Elite, Syrinx

Retrieve a list of categories

Authorizations:
ApiKey

Responses

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

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.

Identifiers
object or null

Identifying items for Category.

DepartmentId
string or null

(Elite Only) The department id for this category

DepartmentName
string or null

(Elite Only) The department name for this category

Description
string or null

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

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

The division of a company.

Array of objects
Default: [{"Uri":"https://hateful-illusion.net/","AltText":"permafrost"}]

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

Reference a CategoryId.

Elite: This field is not supported.

Tags
Array of strings
Default: ["Keyboard","Shoes"]

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

Additional fields for Category.

CreatedDateTime
string or null <date-time>

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>

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 or null
Value: 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

Retrieve a single category by Id

Authorizations:
ApiKey
path Parameters
CategoryId
required
string

Responses

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

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.

Identifiers
object or null

Identifying items for Category.

DepartmentId
string or null

(Elite Only) The department id for this category

DepartmentName
string or null

(Elite Only) The department name for this category

Description
string or null

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

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

The division of a company.

Array of objects
Default: [{"Uri":"https://hateful-illusion.net/","AltText":"permafrost"}]

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

Reference a CategoryId.

Elite: This field is not supported.

Tags
Array of strings
Default: ["Keyboard","Shoes"]

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

Additional fields for Category.

CreatedDateTime
string or null <date-time>

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>

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 or null
Value: 1

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

Elite: This is always 0.

Response samples

Content type
application/json
{}

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:
ApiKey
path Parameters
field
required
string

Responses

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

Indicates the type of lookup being performed. While most endpoints return a single type, some specialized endpoints may support multiple lookup types for different reference data categories.

Id
string
Default: "LU-2024-001-ABC"

The unique identifier for this lookup record. System-generated and immutable, though it can be referenced in bulk update operations. Used for maintaining referential integrity across the system.

Name
string or null
Default: "Aerial Work Platform - Scissor Lift"

A human-readable display name for this lookup value. Commonly used in dropdowns and selection interfaces. Examples include equipment categories, status types, or payment terms.

Description
string or null
Default: "Self-propelled elevating work platform with extending platform for heights up to 40ft"

Additional details about the lookup value that provide context or clarification. May include usage guidelines or business rules associated with this value.

Field
string
Default: "EquipmentCategory"

The system field or attribute this lookup value is associated with. Used to categorize and organize lookup values by their functional area or purpose.

Value
string
Default: "AWP-SCSR"

The actual stored value or code used in the system. While the Name field is for display, this is the underlying value used in database operations and API calls.

Response samples

Content type
application/json
[
  • {
    }
]

Call Logs

[Call Log] Post

Creates a call log record

Authorizations:
ApiKey
Request Body schema: application/json
required
Name
string or null
Default: "Customer Follow-up - Equipment Return"

Brief title or subject line describing the call or interaction

object or null

Collection of related entity identifiers associated with this call log

ContractId
string or null

Associated rental contract identifier

CustomerId
string or null

Associated customer identifier

RelationshipId
string or null

Identifier linking related entities (e.g., parent company relationship)

RemoteUserId
string or null

External system user identifier (e.g., portal user, API client)

Body
string or null
Default: "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."

Detailed notes about the interaction, including discussion points, decisions, and action items

ContactName
string or null

Name of the person contacted or who initiated the communication

ForceAcknowledge
boolean or null

Flag indicating if this call log requires acknowledgment by other staff members

Type
string or null

Category or type of communication (e.g., Customer Service, Sales, Technical Support, Payment)

AdditionalFields
object or null

Custom fields for storing additional information specific to the business needs

Responses

Request samples

Content type
application/json
{
  • "ModelType": "CallLog",
  • "Name": "Customer Follow-up - Equipment Return",
  • "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}

Response samples

Content type
application/json
{
  • "ModelType": "CallLog",
  • "Name": "Customer Follow-up - Equipment Return",
  • "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}

[Call Log] Get All

All call logs for your organization, use query parameters to filter

Authorizations:
ApiKey

Responses

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

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

Id
string

Unique identifier for the call log entry

Name
string or null
Default: "Customer Follow-up - Equipment Return"

Brief title or subject line describing the call or interaction

object or null

Collection of related entity identifiers associated with this call log

Body
string or null
Default: "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."

Detailed notes about the interaction, including discussion points, decisions, and action items

CreatedBy
string or null

Username or identifier of the person who created the call log entry

ContactName
string or null

Name of the person contacted or who initiated the communication

ForceAcknowledge
boolean or null

Flag indicating if this call log requires acknowledgment by other staff members

Type
string or null

Category or type of communication (e.g., Customer Service, Sales, Technical Support, Payment)

AdditionalFields
object or null

Custom fields for storing additional information specific to the business needs

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 or null
Value: 1

Soft delete flag: 0 = active record, 1 = deleted/hidden record

Response samples

Content type
application/json
[
  • {
    }
]

[Call Log] Get by Id

Single call log record by call log Id

Authorizations:
ApiKey
path Parameters
CallLogId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "CallLog"
Value: "CallLog"

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

Id
string

Unique identifier for the call log entry

Name
string or null
Default: "Customer Follow-up - Equipment Return"

Brief title or subject line describing the call or interaction

object or null

Collection of related entity identifiers associated with this call log

ContractId
string or null

Associated rental contract identifier

CustomerId
string or null

Associated customer identifier

RelationshipId
string or null

Identifier linking related entities (e.g., parent company relationship)

RemoteUserId
string or null

External system user identifier (e.g., portal user, API client)

Body
string or null
Default: "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."

Detailed notes about the interaction, including discussion points, decisions, and action items

CreatedBy
string or null

Username or identifier of the person who created the call log entry

ContactName
string or null

Name of the person contacted or who initiated the communication

ForceAcknowledge
boolean or null

Flag indicating if this call log requires acknowledgment by other staff members

Type
string or null

Category or type of communication (e.g., Customer Service, Sales, Technical Support, Payment)

AdditionalFields
object or null

Custom fields for storing additional information specific to the business needs

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 or null
Value: 1

Soft delete flag: 0 = active record, 1 = deleted/hidden record

Response samples

Content type
application/json
{
  • "ModelType": "CallLog",
  • "Name": "Customer Follow-up - Equipment Return",
  • "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}

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:
ApiKey
path Parameters
field
required
string

Responses

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

Indicates the type of lookup being performed. While most endpoints return a single type, some specialized endpoints may support multiple lookup types for different reference data categories.

Id
string
Default: "LU-2024-001-ABC"

The unique identifier for this lookup record. System-generated and immutable, though it can be referenced in bulk update operations. Used for maintaining referential integrity across the system.

Name
string or null
Default: "Aerial Work Platform - Scissor Lift"

A human-readable display name for this lookup value. Commonly used in dropdowns and selection interfaces. Examples include equipment categories, status types, or payment terms.

Description
string or null
Default: "Self-propelled elevating work platform with extending platform for heights up to 40ft"

Additional details about the lookup value that provide context or clarification. May include usage guidelines or business rules associated with this value.

Field
string
Default: "EquipmentCategory"

The system field or attribute this lookup value is associated with. Used to categorize and organize lookup values by their functional area or purpose.

Value
string
Default: "AWP-SCSR"

The actual stored value or code used in the system. While the Name field is for display, this is the underlying value used in database operations and API calls.

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

Create a new Contact

Required fields:

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

The display name for the contact. Example: 'John Smith' or 'Smith, John - Project Manager'

object or null
Default: {"ParentId":"103559"}

Identifying items for Contact.

DriversLicense
string or null

The contact's drivers license number. Example: 'D1234567' or 'FL-789456123'

EmployeeId
string or null

The contact's employee id. Example: 'EMP-789' or 'ABC-123-456'

ParentId
string or null
Default: "103559"

Required by Elite. Links to parent customer or vendor. Example: 'CUST-456' or 'VEND-789'

Department
string or null <= 50 characters

Department of the company. Example: 'Field Operations' or 'Equipment Management'

Disabled
boolean or null

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. Example: Set to TRUE when an employee leaves the company or is no longer authorized to rent equipment.

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null
Default: [{"Type":"Default","Email":"[email protected]"}]

Can support multiple email addresses for a contact. Example: Work email and personal email for notifications.

Elite: This array will only have a single element.

Array
Type
required
string
Value: "Default"

Supported types. Currently only 'Default' is supported.

Email
required
string or null <= 50 characters
FirstName
string or null
Default: "John"

First Name (if it's an individual). Example: 'John' or 'Maria'

Elite: Read-Only

LastName
string or null
Default: "Doe"

Last Name (if it's an individual). Example: 'Smith' or 'Garcia'

Elite: Read-Only

Array of objects or null

Can support multiple phone numbers for a contact. Example: Office phone, mobile phone for urgent notifications.

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

Supported phone types. "Default" is the default phone number for the contact (typically office phone).

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. Example: '713-555-0123' or '(281) 555-0123'

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. Example: 'TWILIO-123456' or 'SMS-789' This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix. Example: '+1' for US/Canada or '+44' for UK

Elite: Currently not supported

Title
string or null <= 255 characters

The contact's title. Example: 'Project Manager' or 'Equipment Supervisor'

object or null

Additional fields for Contact.

InactiveDateTime
string or null <date-time>

This is the date that a contact is no longer authorized to be associated with the customer account. Example: When an employee's last day is scheduled or contract term ends.

Elite: Supported.
Syrinx: Not supported.

Responses

Request samples

Content type
application/json
{
  • "FirstName": "John",
  • "LastName": "Doe",
  • "Name": "55365DR2",
  • "Identifiers": {
    },
  • "Emails": []
}

Response samples

Content type
application/json
{
  • "ModelType": "Contact",
  • "Addresses": [
    ]
}

Retrieve a list of Contacts

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Emails.Email
  • Phones.Number
Authorizations:
ApiKey

Responses

Response Schema: application/json
Array
ModelType
string
Default: "Contact"
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

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

The display name for the contact.

object or null

Identifying items for Contact.

Array of objects
Default: [{"Type":"payment","Name":"Wilbur Robel","Line1":"4650 Zulauf Forks","Line2":"Suite 577","Line3":"grouper","City":"Fort Justyn","GeoRegion2":"5648 Castle Street","GeoRegion3":"3682 Field Close","Province":"Rhode Island","PostalCode":"51912","Latitude":9.159,"Longitude":82.444,"Country":"Tokelau"},{"Type":"shipping","Name":"Tina Koss","Line1":"91088 Zemlak Summit","Line2":"Apt. 877","Line3":"coliseum","City":"Daughertyburgh","GeoRegion2":"86611 Jaunita Motorway","GeoRegion3":"1418 1st Avenue","Province":"Rhode Island","PostalCode":"28570","Latitude":25.9554,"Longitude":159.8034,"Country":"Cyprus"}]

Can support multiple addresses for a contact.

Elite: This field is not supported.

CompanyName
string or null

Name of the company.

Elite: This field is not supported.

Department
string or null

Department of the company.

Disabled
boolean or null

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

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

FirstName
string or null

First Name (if it's an individual).

Elite: Read-Only

LastName
string or null

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null

Can support multiple phone numbers for a contacts.

Title
string or null

The contact's title.

object or null

Additional fields for Contact.

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 or null
Value: 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

Retrieve a single Contact by Id

Authorizations:
ApiKey
path Parameters
ContactId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "Contact"
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

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

The display name for the contact.

object or null

Identifying items for Contact.

DriversLicense
string or null

The contact's drivers license number.

EmployeeId
string or null

The contact's employee id.

ParentId
string or null

In Elite, ParentId is the same as CustomerId.

Array of objects
Default: [{"Type":"payment","Name":"Wilbur Robel","Line1":"4650 Zulauf Forks","Line2":"Suite 577","Line3":"grouper","City":"Fort Justyn","GeoRegion2":"5648 Castle Street","GeoRegion3":"3682 Field Close","Province":"Rhode Island","PostalCode":"51912","Latitude":9.159,"Longitude":82.444,"Country":"Tokelau"},{"Type":"shipping","Name":"Tina Koss","Line1":"91088 Zemlak Summit","Line2":"Apt. 877","Line3":"coliseum","City":"Daughertyburgh","GeoRegion2":"86611 Jaunita Motorway","GeoRegion3":"1418 1st Avenue","Province":"Rhode Island","PostalCode":"28570","Latitude":25.9554,"Longitude":159.8034,"Country":"Cyprus"}]

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

Name of the company.

Elite: This field is not supported.

Department
string or null

Department of the company.

Disabled
boolean or null

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

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

First Name (if it's an individual).

Elite: Read-Only

LastName
string or null

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null

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

The contact's title.

object or null

Additional fields for Contact.

InactiveDateTime
string or null <date-time>

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>

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 or null
Value: 1

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

Response samples

Content type
application/json
{
  • "ModelType": "Contact",
  • "Addresses": [
    ]
}

Update a single Contact by Id

Supported by: Elite

Update a single Contact by Id

Required fields:

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

The display name for the contact. Example: 'John Smith' or 'Smith, John - Project Manager'

object or null
Default: {"ParentId":"103559"}

Identifying items for Contact.

DriversLicense
string or null

The contact's drivers license number. Example: 'D1234567' or 'FL-789456123'

EmployeeId
string or null

The contact's employee id. Example: 'EMP-789' or 'ABC-123-456'

ParentId
string or null
Default: "103559"

Required by Elite. Links to parent customer or vendor. Example: 'CUST-456' or 'VEND-789'

Department
string or null <= 50 characters

Department of the company. Example: 'Field Operations' or 'Equipment Management'

Disabled
boolean or null

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. Example: Set to TRUE when an employee leaves the company or is no longer authorized to rent equipment.

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null
Default: [{"Type":"Default","Email":"[email protected]"}]

Can support multiple email addresses for a contact. Example: Work email and personal email for notifications.

Elite: This array will only have a single element.

Array
Type
required
string
Value: "Default"

Supported types. Currently only 'Default' is supported.

Email
required
string or null <= 50 characters
FirstName
string or null
Default: "John"

First Name (if it's an individual). Example: 'John' or 'Maria'

Elite: Read-Only

LastName
string or null
Default: "Doe"

Last Name (if it's an individual). Example: 'Smith' or 'Garcia'

Elite: Read-Only

Array of objects or null

Can support multiple phone numbers for a contact. Example: Office phone, mobile phone for urgent notifications.

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

Supported phone types. "Default" is the default phone number for the contact (typically office phone).

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. Example: '713-555-0123' or '(281) 555-0123'

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. Example: 'TWILIO-123456' or 'SMS-789' This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix. Example: '+1' for US/Canada or '+44' for UK

Elite: Currently not supported

Title
string or null <= 255 characters

The contact's title. Example: 'Project Manager' or 'Equipment Supervisor'

object or null

Additional fields for Contact.

InactiveDateTime
string or null <date-time>

This is the date that a contact is no longer authorized to be associated with the customer account. Example: When an employee's last day is scheduled or contract term ends.

Elite: Supported.
Syrinx: Not supported.

Responses

Response Schema: application/json
ModelType
string
Default: "Contact"
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

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

The display name for the contact.

object or null

Identifying items for Contact.

DriversLicense
string or null

The contact's drivers license number.

EmployeeId
string or null

The contact's employee id.

ParentId
string or null

In Elite, ParentId is the same as CustomerId.

Array of objects
Default: [{"Type":"payment","Name":"Wilbur Robel","Line1":"4650 Zulauf Forks","Line2":"Suite 577","Line3":"grouper","City":"Fort Justyn","GeoRegion2":"5648 Castle Street","GeoRegion3":"3682 Field Close","Province":"Rhode Island","PostalCode":"51912","Latitude":9.159,"Longitude":82.444,"Country":"Tokelau"},{"Type":"shipping","Name":"Tina Koss","Line1":"91088 Zemlak Summit","Line2":"Apt. 877","Line3":"coliseum","City":"Daughertyburgh","GeoRegion2":"86611 Jaunita Motorway","GeoRegion3":"1418 1st Avenue","Province":"Rhode Island","PostalCode":"28570","Latitude":25.9554,"Longitude":159.8034,"Country":"Cyprus"}]

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

Name of the company.

Elite: This field is not supported.

Department
string or null

Department of the company.

Disabled
boolean or null

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

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

First Name (if it's an individual).

Elite: Read-Only

LastName
string or null

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null

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

The contact's title.

object or null

Additional fields for Contact.

InactiveDateTime
string or null <date-time>

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>

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 or null
Value: 1

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

Request samples

Content type
application/json
{
  • "FirstName": "John",
  • "LastName": "Doe",
  • "Name": "55365DR2",
  • "Identifiers": {
    },
  • "Emails": []
}

Response samples

Content type
application/json
{
  • "ModelType": "Contact",
  • "Addresses": [
    ]
}

Contracts

Call a Contract Off Rent

Supported by: Elite

Call a Contract Off Rent

Authorizations:
ApiKey
Request Body schema: application/json
required
ContractId
required
string
Default: "123"

The unique id for the contract

CalledOffDateTime
required
string <date-time>
Default: "2025-05-27T00:00:00Z"

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

PersonCallingOff
string
Default: "John Doe"

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

Memo
string
Default: "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."

Additional textual information for calling a contract off rent.

RemoteUserId
string

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": "123",
  • "CalledOffDateTime": "2025-05-27T00:00:00Z",
  • "PersonCallingOff": "John Doe",
  • "Memo": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}

Response samples

Content type
application/json
{
  • "ModelType": "Contract",
  • "Id": "CNT-2024-0012345",
  • "Name": "Excavator Rental - ABC Construction",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "AmountDue": 2450.75,
  • "AmountPaid": 1000,
  • "Contacts": [
    ],
  • "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
  • "CustomerId": "CUST-ABC-001",
  • "CustomerName": "ABC Construction",
  • "CustomerPickup": {
    },
  • "DepotId": "DPT-DAL-001",
  • "EndDateTime": "2024-03-22T17:00:00Z",
  • "EsignState": "Signed",
  • "GrandTaxTotal": 202.19,
  • "GrandTotal": 2652.94,
  • "LineItems": [
    ],
  • "LocationId": "LOC-DAL-001",
  • "Notes": [
    ],
  • "PONumber": "ABC-PO-98765",
  • "StartDateTime": "2024-03-15T08:00:00Z",
  • "Status": "Open",
  • "Totals": [
    ],
  • "CreatedDateTime": "2024-03-14T15:30:00Z",
  • "UpdatedDateTime": "2024-03-15T08:15:00Z",
  • "IsPickup": true,
  • "Revision": 2,
  • "AdditionalFields": {
    }
}

Retrieve a list of Contracts

Supported by: Elite, Syrinx

Retrieve a list of Contracts

Authorizations:
ApiKey

Responses

Response Schema: application/json
Array
ModelType
string
Default: "Contract"
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: "CNT-2024-0012345"

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: "Excavator Rental - ABC Construction"

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

object or null
Default: {"InvoiceNumber":"INV-2024-987654","Barcode":"EQ-CAT320-789","Alias":"CAT 320 Excavator #12","ParentId":"CNT-2024-0012345"}

Identifying items for Contract.

Array of objects
Default: [{"Type":"Default","Name":"Construction Site","Line1":"123 Construction Way","Line2":"Building A","City":"Dallas","Province":"TX","PostalCode":"75201","Latitude":"32.7767","Longitude":"-96.7970"}]

Site addresses. Address type should be default.

AmountDue
number
Default: 2450.75

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: 1000

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: [{"Type":"Customer","Contact":{"ModelType":"CustomerContact","Name":"John Smith","FirstName":"John","LastName":"Smith","CompanyName":"ABC Construction","Department":"Operations","Emails":[{"Type":"Default","Email":"[email protected]"}],"Phones":[{"Type":"Default","Number":"214-555-0123","CountryCode":"+1"},{"Type":"Mobile","Number":"214-555-0124","CountryCode":"+1"}]}}]

Contact records and their corresponding types.

ContractInformation
string or null
Default: "Weekly rental of CAT 320 Excavator for Downtown Dallas project"

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: "CUST-ABC-001"

Reference a CustomerId that should be responsible for this Contract.

CustomerName
string or null
Default: "ABC Construction"

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

object or null
Default: {"LocationName":"Dallas Equipment Yard","Address":{"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"},"Instructions":"Please check in at main office","DateTime":"2024-03-15T08:00:00Z"}

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

DepotId
string or null
Default: "DPT-DAL-001"

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

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

EndDateTime
string or null <date-time>
Default: "2024-03-22T17:00:00Z"

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://esign.pointofrentals.com/contracts/CNT-2024-0012345"

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: 202.19

This is the final projected tax for this contract.

GrandTotal
number or null
Default: 2652.94

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

object or null

Labor tracking details.

Array of objects (ContractLineItem)
Default: [{"ModelType":"LineItem","Id":"LI-2024-001234501","Name":"CAT 320 Excavator","Classification":"Rental","SerialNumber":"CAT320-789XYZ","IsSerialized":true,"Quantity":1,"LineTaxTotal":202.19,"LineTotal":2652.94,"Status":"Out","MeterReadings":[{"MeterType":"Hours","MeterReading":1250.5},{"MeterType":"Fuel","MeterReading":75}],"Rates":["Weekly Rate: $2450.75","Hourly Rate: $125.00"]}]

The Line Items associated with this contract.

LocationId
string or null
Default: "LOC-DAL-001"

Id of the Location. (see the Location endpoints)

Array of objects
Default: [{"Type":"Default","Value":"Customer requested delivery to site by 8 AM"}]

Any comments or notes.

Precheck
boolean

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: "ABC-PO-98765"

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: "2024-03-15T08:00:00Z"

UTC When does the customer want the items?

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

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: [{"Label":"Equipment Rental","Value":2450.75},{"Label":"Tax (8.25%)","Value":202.19},{"Label":"Grand Total","Value":2652.94}]

Lines which should appear in the totals section for the contract

Array of objects

For Internal Use.

object or null
Default: {"ClassName":"StandardContract","CurrencyCode":"USD","CustomerJobNumber":"ABC-2024-456","CustomerPurchaseOrder":"PO-98765","OrderedBy":"John Smith","PrecheckCompletedDateTime":"2024-03-14T16:00:00Z","ReceivedBy":"Jane Doe"}

Additional fields for Contract.

CreatedDateTime
string or null <date-time>
Default: "2024-03-14T15:30:00Z"

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: "2024-03-15T08:15:00Z"

UTC When was the contract updated?

Hidden
integer or null
Value: 1

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

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

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

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: 2

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

Retrieve a single Contract by Id

Authorizations:
ApiKey
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "Contract"
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: "CNT-2024-0012345"

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: "Excavator Rental - ABC Construction"

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

object or null
Default: {"InvoiceNumber":"INV-2024-987654","Barcode":"EQ-CAT320-789","Alias":"CAT 320 Excavator #12","ParentId":"CNT-2024-0012345"}

Identifying items for Contract.

InvoiceNumber
string or null
Default: "INV-2024-987654"

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: "EQ-CAT320-789"

The barcode identifier assigned to this particular Line Item.

Elite: This field is not supported.

Alias
string or null
Default: "CAT 320 Excavator #12"

The alias identifier assigned to this particular Line Item.

Elite: This field is not supported.

ParentId
string
Default: "CNT-2024-0012345"

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

Array of objects
Default: [{"Type":"Default","Name":"Construction Site","Line1":"123 Construction Way","Line2":"Building A","City":"Dallas","Province":"TX","PostalCode":"75201","Latitude":"32.7767","Longitude":"-96.7970"}]

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: 2450.75

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: 1000

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: [{"Type":"Customer","Contact":{"ModelType":"CustomerContact","Name":"John Smith","FirstName":"John","LastName":"Smith","CompanyName":"ABC Construction","Department":"Operations","Emails":[{"Type":"Default","Email":"[email protected]"}],"Phones":[{"Type":"Default","Number":"214-555-0123","CountryCode":"+1"},{"Type":"Mobile","Number":"214-555-0124","CountryCode":"+1"}]}}]

Contact records and their corresponding types.

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

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: "Weekly rental of CAT 320 Excavator for Downtown Dallas project"

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: "CUST-ABC-001"

Reference a CustomerId that should be responsible for this Contract.

CustomerName
string or null
Default: "ABC Construction"

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

object or null
Default: {"LocationName":"Dallas Equipment Yard","Address":{"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"},"Instructions":"Please check in at main office","DateTime":"2024-03-15T08:00:00Z"}

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null
Default: "Dallas Equipment Yard"

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null
Default: {"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"}

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

Instructions
string or null
Default: "Please check in at main office"

Special instructions for the driver or customer

DateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

Day and time the action is expected to be completed.

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

DepotId
string or null
Default: "DPT-DAL-001"

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

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

EndDateTime
string or null <date-time>
Default: "2024-03-22T17:00:00Z"

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://esign.pointofrentals.com/contracts/CNT-2024-0012345"

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: 202.19

This is the final projected tax for this contract.

GrandTotal
number or null
Default: 2652.94

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

object or null

Labor tracking details.

Array of objects or null
Array of objects (ContractLineItem)
Default: [{"ModelType":"LineItem","Id":"LI-2024-001234501","Name":"CAT 320 Excavator","Classification":"Rental","SerialNumber":"CAT320-789XYZ","IsSerialized":true,"Quantity":1,"LineTaxTotal":202.19,"LineTotal":2652.94,"Status":"Out","MeterReadings":[{"MeterType":"Hours","MeterReading":1250.5},{"MeterType":"Fuel","MeterReading":75}],"Rates":["Weekly Rate: $2450.75","Hourly Rate: $125.00"]}]

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.

ParentLineItemId
string or null

If this LineItem record has a parent, this field designates the Id of that record.

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 or null
Enum: "Rental" "Sale"

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 or null
Value: 1

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

LocationId
string or null
Default: "LOC-DAL-001"

Id of the Location. (see the Location endpoints)

Array of objects
Default: [{"Type":"Default","Value":"Customer requested delivery to site by 8 AM"}]

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

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: "ABC-PO-98765"

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: "2024-03-15T08:00:00Z"

UTC When does the customer want the items?

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

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: [{"Label":"Equipment Rental","Value":2450.75},{"Label":"Tax (8.25%)","Value":202.19},{"Label":"Grand Total","Value":2652.94}]

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

For Internal Use.

Array
Creatable
boolean or null

Can the workflow be created?

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

Options are None, Generic, 360

RequiredPhotos
number or null
object or null
Default: {"ClassName":"StandardContract","CurrencyCode":"USD","CustomerJobNumber":"ABC-2024-456","CustomerPurchaseOrder":"PO-98765","OrderedBy":"John Smith","PrecheckCompletedDateTime":"2024-03-14T16:00:00Z","ReceivedBy":"Jane Doe"}

Additional fields for Contract.

ClassId
number or null
Enum: -1 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: "StandardContract"

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: "ABC-2024-456"

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

CustomerPurchaseOrder
string or null
Default: "PO-98765"

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

OrderedBy
string or null
Default: "John Smith"

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

PrecheckCompletedDateTime
string or null <date-time>
Default: "2024-03-14T16:00:00Z"

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

ReceivedBy
string or null
Default: "Jane Doe"

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

CreatedDateTime
string or null <date-time>
Default: "2024-03-14T15:30:00Z"

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: "2024-03-15T08:15:00Z"

UTC When was the contract updated?

Hidden
integer or null
Value: 1

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

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

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

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: 2

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

One of
number
Default: 2

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

Response samples

Content type
application/json
{
  • "ModelType": "Contract",
  • "Id": "CNT-2024-0012345",
  • "Name": "Excavator Rental - ABC Construction",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "AmountDue": 2450.75,
  • "AmountPaid": 1000,
  • "Contacts": [
    ],
  • "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
  • "CustomerId": "CUST-ABC-001",
  • "CustomerName": "ABC Construction",
  • "CustomerPickup": {
    },
  • "DepotId": "DPT-DAL-001",
  • "EndDateTime": "2024-03-22T17:00:00Z",
  • "EsignState": "Signed",
  • "GrandTaxTotal": 202.19,
  • "GrandTotal": 2652.94,
  • "LineItems": [
    ],
  • "LocationId": "LOC-DAL-001",
  • "Notes": [
    ],
  • "PONumber": "ABC-PO-98765",
  • "StartDateTime": "2024-03-15T08:00:00Z",
  • "Status": "Open",
  • "Totals": [
    ],
  • "CreatedDateTime": "2024-03-14T15:30:00Z",
  • "UpdatedDateTime": "2024-03-15T08:15:00Z",
  • "IsPickup": true,
  • "Revision": 2,
  • "AdditionalFields": {
    }
}

Update an existing Contract record

Supported by: Elite

Update an existing Contract record by ContractId. Only fields defined below in swagger can be modified. Additional changes will be ignored

Authorizations:
ApiKey
path Parameters
ContractId
required
string
Request Body schema: application/json
required
ContractInformation
string or null

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

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

Array of objects or null

Updatable line items: Id (required), Comments; Quantity requires PatchLineItemQty license.

Array
Id
required
string non-empty

The unique Id for this line item.

Comments
string or null
Quantity
number or null

Requires PatchLineItemQty license

LocationId
string or null

Id of the Location. (see the Location endpoints)

Array of objects
Default: [{"Type":"Pickup","Value":"charlatan"},{"Type":"Pickup","Value":"tune-up"}]

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.

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.

Responses

Response Schema: application/json
ModelType
string
Default: "Contract"
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: "CNT-2024-0012345"

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: "Excavator Rental - ABC Construction"

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

object or null
Default: {"InvoiceNumber":"INV-2024-987654","Barcode":"EQ-CAT320-789","Alias":"CAT 320 Excavator #12","ParentId":"CNT-2024-0012345"}

Identifying items for Contract.

InvoiceNumber
string or null
Default: "INV-2024-987654"

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: "EQ-CAT320-789"

The barcode identifier assigned to this particular Line Item.

Elite: This field is not supported.

Alias
string or null
Default: "CAT 320 Excavator #12"

The alias identifier assigned to this particular Line Item.

Elite: This field is not supported.

ParentId
string
Default: "CNT-2024-0012345"

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

Array of objects
Default: [{"Type":"Default","Name":"Construction Site","Line1":"123 Construction Way","Line2":"Building A","City":"Dallas","Province":"TX","PostalCode":"75201","Latitude":"32.7767","Longitude":"-96.7970"}]

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: 2450.75

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: 1000

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: [{"Type":"Customer","Contact":{"ModelType":"CustomerContact","Name":"John Smith","FirstName":"John","LastName":"Smith","CompanyName":"ABC Construction","Department":"Operations","Emails":[{"Type":"Default","Email":"[email protected]"}],"Phones":[{"Type":"Default","Number":"214-555-0123","CountryCode":"+1"},{"Type":"Mobile","Number":"214-555-0124","CountryCode":"+1"}]}}]

Contact records and their corresponding types.

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

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: "Weekly rental of CAT 320 Excavator for Downtown Dallas project"

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: "CUST-ABC-001"

Reference a CustomerId that should be responsible for this Contract.

CustomerName
string or null
Default: "ABC Construction"

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

object or null
Default: {"LocationName":"Dallas Equipment Yard","Address":{"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"},"Instructions":"Please check in at main office","DateTime":"2024-03-15T08:00:00Z"}

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null
Default: "Dallas Equipment Yard"

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null
Default: {"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"}

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

Instructions
string or null
Default: "Please check in at main office"

Special instructions for the driver or customer

DateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

Day and time the action is expected to be completed.

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

DepotId
string or null
Default: "DPT-DAL-001"

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

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

EndDateTime
string or null <date-time>
Default: "2024-03-22T17:00:00Z"

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://esign.pointofrentals.com/contracts/CNT-2024-0012345"

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: 202.19

This is the final projected tax for this contract.

GrandTotal
number or null
Default: 2652.94

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

object or null

Labor tracking details.

Array of objects or null
Array of objects (ContractLineItem)
Default: [{"ModelType":"LineItem","Id":"LI-2024-001234501","Name":"CAT 320 Excavator","Classification":"Rental","SerialNumber":"CAT320-789XYZ","IsSerialized":true,"Quantity":1,"LineTaxTotal":202.19,"LineTotal":2652.94,"Status":"Out","MeterReadings":[{"MeterType":"Hours","MeterReading":1250.5},{"MeterType":"Fuel","MeterReading":75}],"Rates":["Weekly Rate: $2450.75","Hourly Rate: $125.00"]}]

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.

ParentLineItemId
string or null

If this LineItem record has a parent, this field designates the Id of that record.

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 or null
Enum: "Rental" "Sale"

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 or null
Value: 1

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

LocationId
string or null
Default: "LOC-DAL-001"

Id of the Location. (see the Location endpoints)

Array of objects
Default: [{"Type":"Default","Value":"Customer requested delivery to site by 8 AM"}]

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

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: "ABC-PO-98765"

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: "2024-03-15T08:00:00Z"

UTC When does the customer want the items?

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

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: [{"Label":"Equipment Rental","Value":2450.75},{"Label":"Tax (8.25%)","Value":202.19},{"Label":"Grand Total","Value":2652.94}]

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

For Internal Use.

Array
Creatable
boolean or null

Can the workflow be created?

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

Options are None, Generic, 360

RequiredPhotos
number or null
object or null
Default: {"ClassName":"StandardContract","CurrencyCode":"USD","CustomerJobNumber":"ABC-2024-456","CustomerPurchaseOrder":"PO-98765","OrderedBy":"John Smith","PrecheckCompletedDateTime":"2024-03-14T16:00:00Z","ReceivedBy":"Jane Doe"}

Additional fields for Contract.

ClassId
number or null
Enum: -1 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: "StandardContract"

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: "ABC-2024-456"

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

CustomerPurchaseOrder
string or null
Default: "PO-98765"

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

OrderedBy
string or null
Default: "John Smith"

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

PrecheckCompletedDateTime
string or null <date-time>
Default: "2024-03-14T16:00:00Z"

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

ReceivedBy
string or null
Default: "Jane Doe"

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

CreatedDateTime
string or null <date-time>
Default: "2024-03-14T15:30:00Z"

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: "2024-03-15T08:15:00Z"

UTC When was the contract updated?

Hidden
integer or null
Value: 1

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

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

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

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: 2

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

One of
number
Default: 2

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

Request samples

Content type
application/json
{
  • "Notes": [
    ],
  • "IsDelivery": true,
  • "IsPickup": true
}

Response samples

Content type
application/json
{
  • "ModelType": "Contract",
  • "Id": "CNT-2024-0012345",
  • "Name": "Excavator Rental - ABC Construction",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "AmountDue": 2450.75,
  • "AmountPaid": 1000,
  • "Contacts": [
    ],
  • "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
  • "CustomerId": "CUST-ABC-001",
  • "CustomerName": "ABC Construction",
  • "CustomerPickup": {
    },
  • "DepotId": "DPT-DAL-001",
  • "EndDateTime": "2024-03-22T17:00:00Z",
  • "EsignState": "Signed",
  • "GrandTaxTotal": 202.19,
  • "GrandTotal": 2652.94,
  • "LineItems": [
    ],
  • "LocationId": "LOC-DAL-001",
  • "Notes": [
    ],
  • "PONumber": "ABC-PO-98765",
  • "StartDateTime": "2024-03-15T08:00:00Z",
  • "Status": "Open",
  • "Totals": [
    ],
  • "CreatedDateTime": "2024-03-14T15:30:00Z",
  • "UpdatedDateTime": "2024-03-15T08:15:00Z",
  • "IsPickup": true,
  • "Revision": 2,
  • "AdditionalFields": {
    }
}

Retrieve files for a single Contract by Id.

Supported by: Elite

Retrieve files for a single Contract by Id.

Authorizations:
ApiKey
path Parameters
ContractId
required
string
tagKey
required
string

pdfs or instructions or photos

Responses

Response Schema: application/json
Array
FileName
string

Original local filename including extension. Common formats include PDFs for manuals and documents, JPG/PNG for photos, and MP4 for videos.

FileClass
string
Enum: "misc" "image" "video"

Defines the type of stored file: 'misc' for documents (PDFs, contracts, manuals), 'image' for equipment photos and inspection documentation, 'video' for training materials and equipment operation demonstrations.

PublicURL
string

Web URL where the stored file can be downloaded. For secure files (like signed contracts or damage reports), this is a time-limited pre-signed URL. For public files (like equipment catalogs), this may be a permanent URL.

URLDateTime
string <date-time>

The date/time when the URL was generated. Critical for secure documents where URL expiration is enforced. Used with URLExpires to calculate the exact expiration time of pre-signed URLs.

URLExpires
integer

Number of seconds from URLDateTime until URL expires. Common values: 3600 (1 hour) for sensitive documents like contracts and damage reports, 86400 (24 hours) for inspection photos, and 604800 (1 week) for public equipment manuals.

TagMapKey
string
Enum: "pdfs" "instructions" "photos"

Categorizes the file purpose: 'pdfs' for equipment manuals, safety documentation, and signed contracts; 'instructions' for safety guides, operating procedures, and maintenance checklists; 'photos' for equipment condition documentation, damage reports, and marketing images.

ObjectPrimaryKey
string

Unique identifier for the associated object. Examples: Stock numbers (STOCK-12345) for equipment units, contract numbers (RENT-789456) for rental agreements, serial numbers (CAT-336-ABC123) for specific machines, or damage report IDs (DR-456789).

ObjectType
string

Classifies the associated object: 'Products' for equipment catalog/specifications, 'stock' for specific rental fleet units, 'contract' for rental/lease agreements, 'damage' for incident reports, or 'inspection' for equipment condition reports.

Tags
Array of strings

Categorization tags for the file. Common combinations: ['inspection-photo', 'pre-rental', 'exterior'] for pre-rental documentation, ['damage-report', 'insurance', 'claim-photos'] for incident documentation, ['equipment-manual', 'safety', 'maintenance'] for technical documentation.

Response samples

Content type
application/json
[]

Retrieve Tax Details for a single Contract by Id.

Supported by: Elite

Retrieve Tax Details for a single Contract by Id.

Authorizations:
ApiKey
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
Array of objects
Default: [{"TaxType":"State Sales Tax","Rate":0.0625,"Amount":62.5},{"TaxType":"Local Sales Tax","Rate":0.02,"Amount":20}]

An array of tax details for the rental contract, containing all applicable taxes including state, county, city, and special district taxes that apply to the equipment rental transaction

Array
JurisdictionName
required
string

The name of the jurisdiction imposing the tax. This could be a state (e.g., 'California'), county (e.g., 'Maricopa County'), city (e.g., 'Phoenix'), or special tax district (e.g., 'Metro Transportation District')

TaxName
required
string

The official name of the tax as defined by the jurisdiction. Common examples include 'Sales and Use Tax', 'Equipment Rental Tax', 'Special District Tax', or 'Heavy Equipment Rental Tax'

TaxAmount
required
number

The calculated tax amount for this specific jurisdiction. For example, on a $2,500 weekly excavator rental with an 8.6% tax rate, the tax amount would be $215.00

TaxableRevenue
required
number

The base amount subject to tax. This typically includes the equipment rental rate plus any taxable fees or charges. For example, a weekly rate of $2,500 for a 320 Excavator plus $150 for delivery and $100 for fuel would total $2,750 taxable revenue

TaxRate
required
number

The tax rate percentage expressed as a decimal. Common equipment rental tax rates vary by jurisdiction - e.g., 0.086 (8.6%) for Maricopa County Heavy Equipment Tax, 0.0925 (9.25%) for Tennessee State and Local Tax, or 0.0635 (6.35%) for Connecticut Sales Tax

AliasName
string or null

A user-defined alias for the tax used for internal reporting or identification. Examples: 'AZ-MAR-HERT' (Arizona Maricopa Heavy Equipment Rental Tax), 'PHX-CityTax' (Phoenix City Tax), or 'CA-SUT' (California Sales and Use Tax)

Response samples

Content type
application/json
{
  • "SubTotal": 1000,
  • "TaxableAmount": 1000,
  • "TaxAmount": 82.5,
  • "TotalAmount": 1082.5,
  • "TaxDetails": [
    ]
}

Payment Boundaries

Retrieve payment boundaries for a single Contract by Id.

Authorizations:
ApiKey
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
Array
Array of objects

List of payment collection rules that define how payments can be collected for different scenarios

Response samples

Content type
application/json
[
  • {
    }
]

Cancel a Contract

Supported by: Elite

Cancels a contract by changing its status to cancelled. The contract record is not deleted

Authorizations:
ApiKey
path Parameters
ContractId
required
string
Request Body schema: application/json
required
CancelReasonId
string or null

Use the contracts/lookup/CancelReasonId to get the list of options.

Reason
string or null

The reason why they are canceling/voiding the contract

Responses

Response Schema: application/json
ModelType
string
Default: "Contract"
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: "CNT-2024-0012345"

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: "Excavator Rental - ABC Construction"

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

object or null
Default: {"InvoiceNumber":"INV-2024-987654","Barcode":"EQ-CAT320-789","Alias":"CAT 320 Excavator #12","ParentId":"CNT-2024-0012345"}

Identifying items for Contract.

InvoiceNumber
string or null
Default: "INV-2024-987654"

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: "EQ-CAT320-789"

The barcode identifier assigned to this particular Line Item.

Elite: This field is not supported.

Alias
string or null
Default: "CAT 320 Excavator #12"

The alias identifier assigned to this particular Line Item.

Elite: This field is not supported.

ParentId
string
Default: "CNT-2024-0012345"

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

Array of objects
Default: [{"Type":"Default","Name":"Construction Site","Line1":"123 Construction Way","Line2":"Building A","City":"Dallas","Province":"TX","PostalCode":"75201","Latitude":"32.7767","Longitude":"-96.7970"}]

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: 2450.75

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: 1000

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: [{"Type":"Customer","Contact":{"ModelType":"CustomerContact","Name":"John Smith","FirstName":"John","LastName":"Smith","CompanyName":"ABC Construction","Department":"Operations","Emails":[{"Type":"Default","Email":"[email protected]"}],"Phones":[{"Type":"Default","Number":"214-555-0123","CountryCode":"+1"},{"Type":"Mobile","Number":"214-555-0124","CountryCode":"+1"}]}}]

Contact records and their corresponding types.

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

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: "Weekly rental of CAT 320 Excavator for Downtown Dallas project"

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: "CUST-ABC-001"

Reference a CustomerId that should be responsible for this Contract.

CustomerName
string or null
Default: "ABC Construction"

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

object or null
Default: {"LocationName":"Dallas Equipment Yard","Address":{"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"},"Instructions":"Please check in at main office","DateTime":"2024-03-15T08:00:00Z"}

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null
Default: "Dallas Equipment Yard"

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null
Default: {"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"}

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

Instructions
string or null
Default: "Please check in at main office"

Special instructions for the driver or customer

DateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

Day and time the action is expected to be completed.

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

DepotId
string or null
Default: "DPT-DAL-001"

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

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

EndDateTime
string or null <date-time>
Default: "2024-03-22T17:00:00Z"

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://esign.pointofrentals.com/contracts/CNT-2024-0012345"

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: 202.19

This is the final projected tax for this contract.

GrandTotal
number or null
Default: 2652.94

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

object or null

Labor tracking details.

Array of objects or null
Array of objects (ContractLineItem)
Default: [{"ModelType":"LineItem","Id":"LI-2024-001234501","Name":"CAT 320 Excavator","Classification":"Rental","SerialNumber":"CAT320-789XYZ","IsSerialized":true,"Quantity":1,"LineTaxTotal":202.19,"LineTotal":2652.94,"Status":"Out","MeterReadings":[{"MeterType":"Hours","MeterReading":1250.5},{"MeterType":"Fuel","MeterReading":75}],"Rates":["Weekly Rate: $2450.75","Hourly Rate: $125.00"]}]

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.

ParentLineItemId
string or null

If this LineItem record has a parent, this field designates the Id of that record.

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 or null
Enum: "Rental" "Sale"

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 or null
Value: 1

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

LocationId
string or null
Default: "LOC-DAL-001"

Id of the Location. (see the Location endpoints)

Array of objects
Default: [{"Type":"Default","Value":"Customer requested delivery to site by 8 AM"}]

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

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: "ABC-PO-98765"

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: "2024-03-15T08:00:00Z"

UTC When does the customer want the items?

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

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: [{"Label":"Equipment Rental","Value":2450.75},{"Label":"Tax (8.25%)","Value":202.19},{"Label":"Grand Total","Value":2652.94}]

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

For Internal Use.

Array
Creatable
boolean or null

Can the workflow be created?

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

Options are None, Generic, 360

RequiredPhotos
number or null
object or null
Default: {"ClassName":"StandardContract","CurrencyCode":"USD","CustomerJobNumber":"ABC-2024-456","CustomerPurchaseOrder":"PO-98765","OrderedBy":"John Smith","PrecheckCompletedDateTime":"2024-03-14T16:00:00Z","ReceivedBy":"Jane Doe"}

Additional fields for Contract.

ClassId
number or null
Enum: -1 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: "StandardContract"

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: "ABC-2024-456"

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

CustomerPurchaseOrder
string or null
Default: "PO-98765"

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

OrderedBy
string or null
Default: "John Smith"

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

PrecheckCompletedDateTime
string or null <date-time>
Default: "2024-03-14T16:00:00Z"

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

ReceivedBy
string or null
Default: "Jane Doe"

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

CreatedDateTime
string or null <date-time>
Default: "2024-03-14T15:30:00Z"

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: "2024-03-15T08:15:00Z"

UTC When was the contract updated?

Hidden
integer or null
Value: 1

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

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

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

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: 2

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

One of
number
Default: 2

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

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "ModelType": "Contract",
  • "Id": "CNT-2024-0012345",
  • "Name": "Excavator Rental - ABC Construction",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "AmountDue": 2450.75,
  • "AmountPaid": 1000,
  • "Contacts": [
    ],
  • "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
  • "CustomerId": "CUST-ABC-001",
  • "CustomerName": "ABC Construction",
  • "CustomerPickup": {
    },
  • "DepotId": "DPT-DAL-001",
  • "EndDateTime": "2024-03-22T17:00:00Z",
  • "EsignState": "Signed",
  • "GrandTaxTotal": 202.19,
  • "GrandTotal": 2652.94,
  • "LineItems": [
    ],
  • "LocationId": "LOC-DAL-001",
  • "Notes": [
    ],
  • "PONumber": "ABC-PO-98765",
  • "StartDateTime": "2024-03-15T08:00:00Z",
  • "Status": "Open",
  • "Totals": [
    ],
  • "CreatedDateTime": "2024-03-14T15:30:00Z",
  • "UpdatedDateTime": "2024-03-15T08:15:00Z",
  • "IsPickup": true,
  • "Revision": 2,
  • "AdditionalFields": {
    }
}

Quote to Reservation

Supported by: Elite

Changes a contract quote into a reservation. See quoteToReservationEligible to check if a quote is eligible to be converted into a reservation.

Authorizations:
ApiKey
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "Contract"
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: "CNT-2024-0012345"

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: "Excavator Rental - ABC Construction"

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

object or null
Default: {"InvoiceNumber":"INV-2024-987654","Barcode":"EQ-CAT320-789","Alias":"CAT 320 Excavator #12","ParentId":"CNT-2024-0012345"}

Identifying items for Contract.

InvoiceNumber
string or null
Default: "INV-2024-987654"

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: "EQ-CAT320-789"

The barcode identifier assigned to this particular Line Item.

Elite: This field is not supported.

Alias
string or null
Default: "CAT 320 Excavator #12"

The alias identifier assigned to this particular Line Item.

Elite: This field is not supported.

ParentId
string
Default: "CNT-2024-0012345"

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

Array of objects
Default: [{"Type":"Default","Name":"Construction Site","Line1":"123 Construction Way","Line2":"Building A","City":"Dallas","Province":"TX","PostalCode":"75201","Latitude":"32.7767","Longitude":"-96.7970"}]

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: 2450.75

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: 1000

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: [{"Type":"Customer","Contact":{"ModelType":"CustomerContact","Name":"John Smith","FirstName":"John","LastName":"Smith","CompanyName":"ABC Construction","Department":"Operations","Emails":[{"Type":"Default","Email":"[email protected]"}],"Phones":[{"Type":"Default","Number":"214-555-0123","CountryCode":"+1"},{"Type":"Mobile","Number":"214-555-0124","CountryCode":"+1"}]}}]

Contact records and their corresponding types.

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

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: "Weekly rental of CAT 320 Excavator for Downtown Dallas project"

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: "CUST-ABC-001"

Reference a CustomerId that should be responsible for this Contract.

CustomerName
string or null
Default: "ABC Construction"

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

object or null
Default: {"LocationName":"Dallas Equipment Yard","Address":{"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"},"Instructions":"Please check in at main office","DateTime":"2024-03-15T08:00:00Z"}

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null
Default: "Dallas Equipment Yard"

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null
Default: {"Type":"Default","Line1":"456 Equipment Drive","City":"Dallas","Province":"TX","PostalCode":"75207"}

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

Instructions
string or null
Default: "Please check in at main office"

Special instructions for the driver or customer

DateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

Day and time the action is expected to be completed.

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

DepotId
string or null
Default: "DPT-DAL-001"

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

object or null

Location, address, special instructions and date/time for driver actions, delivery, or customer pickup

LocationName
string or null

Display name of the location (response only)

LocationId
string or null

Id of the Location. (see the Location endpoints)

object or null

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

Instructions
string or null

Special instructions for the driver or customer

DateTime
string or null <date-time>

Day and time the action is expected to be completed.

EndDateTime
string or null <date-time>
Default: "2024-03-22T17:00:00Z"

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://esign.pointofrentals.com/contracts/CNT-2024-0012345"

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: 202.19

This is the final projected tax for this contract.

GrandTotal
number or null
Default: 2652.94

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

object or null

Labor tracking details.

Array of objects or null
Array of objects (ContractLineItem)
Default: [{"ModelType":"LineItem","Id":"LI-2024-001234501","Name":"CAT 320 Excavator","Classification":"Rental","SerialNumber":"CAT320-789XYZ","IsSerialized":true,"Quantity":1,"LineTaxTotal":202.19,"LineTotal":2652.94,"Status":"Out","MeterReadings":[{"MeterType":"Hours","MeterReading":1250.5},{"MeterType":"Fuel","MeterReading":75}],"Rates":["Weekly Rate: $2450.75","Hourly Rate: $125.00"]}]

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.

ParentLineItemId
string or null

If this LineItem record has a parent, this field designates the Id of that record.

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 or null
Enum: "Rental" "Sale"

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 or null
Value: 1

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

LocationId
string or null
Default: "LOC-DAL-001"

Id of the Location. (see the Location endpoints)

Array of objects
Default: [{"Type":"Default","Value":"Customer requested delivery to site by 8 AM"}]

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

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: "ABC-PO-98765"

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: "2024-03-15T08:00:00Z"

UTC When does the customer want the items?

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

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: [{"Label":"Equipment Rental","Value":2450.75},{"Label":"Tax (8.25%)","Value":202.19},{"Label":"Grand Total","Value":2652.94}]

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

For Internal Use.

Array
Creatable
boolean or null

Can the workflow be created?

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

Options are None, Generic, 360

RequiredPhotos
number or null
object or null
Default: {"ClassName":"StandardContract","CurrencyCode":"USD","CustomerJobNumber":"ABC-2024-456","CustomerPurchaseOrder":"PO-98765","OrderedBy":"John Smith","PrecheckCompletedDateTime":"2024-03-14T16:00:00Z","ReceivedBy":"Jane Doe"}

Additional fields for Contract.

ClassId
number or null
Enum: -1 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: "StandardContract"

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: "ABC-2024-456"

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

CustomerPurchaseOrder
string or null
Default: "PO-98765"

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

OrderedBy
string or null
Default: "John Smith"

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

PrecheckCompletedDateTime
string or null <date-time>
Default: "2024-03-14T16:00:00Z"

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

ReceivedBy
string or null
Default: "Jane Doe"

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

CreatedDateTime
string or null <date-time>
Default: "2024-03-14T15:30:00Z"

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: "2024-03-15T08:15:00Z"

UTC When was the contract updated?

Hidden
integer or null
Value: 1

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

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

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

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: 2

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

One of
number
Default: 2

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

Response samples

Content type
application/json
{
  • "ModelType": "Contract",
  • "Id": "CNT-2024-0012345",
  • "Name": "Excavator Rental - ABC Construction",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "AmountDue": 2450.75,
  • "AmountPaid": 1000,
  • "Contacts": [
    ],
  • "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
  • "CustomerId": "CUST-ABC-001",
  • "CustomerName": "ABC Construction",
  • "CustomerPickup": {
    },
  • "DepotId": "DPT-DAL-001",
  • "EndDateTime": "2024-03-22T17:00:00Z",
  • "EsignState": "Signed",
  • "GrandTaxTotal": 202.19,
  • "GrandTotal": 2652.94,
  • "LineItems": [
    ],
  • "LocationId": "LOC-DAL-001",
  • "Notes": [
    ],
  • "PONumber": "ABC-PO-98765",
  • "StartDateTime": "2024-03-15T08:00:00Z",
  • "Status": "Open",
  • "Totals": [
    ],
  • "CreatedDateTime": "2024-03-14T15:30:00Z",
  • "UpdatedDateTime": "2024-03-15T08:15:00Z",
  • "IsPickup": true,
  • "Revision": 2,
  • "AdditionalFields": {
    }
}

Quote to Reservation Eligible

Supported by: Elite

Check if a Contract quote is eligible to be converted into a reservation.

Authorizations:
ApiKey
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
Success
required
boolean
Default: true

Whether the quote is eligible to convert to reservation.

required
Array of objects
Default: []

If not eligible, the fatal issues explaining why.

Array
Type
required
string

Error type identifier. Known values may include these, but others can appear.

Message
required
string

A descriptive message explaining the issue.

property name*
additional property
any

Response samples

Content type
application/json
{
  • "Success": true,
  • "Issues": [ ]
}

Retrieve Latest Modified Contract PDF

Supported by: Elite

Organizations with S3 storage only. Retrieves the most recent contract PDF for one or more contracts by ID.

Authorizations:
ApiKey
path Parameters
ContractIds
required
string

The contract id. Supports multiple contract ids separated by comma (e.g., id1,id2,id3).

Responses

Response Schema: application/json
Array
Id
required
string

Unique identifier for this contract PDF record.

Name
required
string

Human-readable name for this contract PDF.

ContractId
required
string

Identifier of the contract this PDF belongs to.

Url
required
string <uri>

Temporary URL to download the contract PDF. Valid for 1 hour.

CreatedDateTime
required
string <date-time>

UTC date and time when this contract PDF record was created.

CreatedBy
required
string

Identifier of the user who created this contract PDF record.

ModelType
string
Value: "ContractPdf"

Record type indicator. Always 'ContractPdf' for this model.

Response samples

Content type
application/json
[
  • {
    }
]

Enum Lookup for Contracts

Supported by: Elite

Elite users can look up enums related to contracts. Currently lookup/cancelReasonId is the only field this returns a value

Authorizations:
ApiKey
path Parameters
field
required
string

Responses

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

Indicates the type of lookup being performed. While most endpoints return a single type, some specialized endpoints may support multiple lookup types for different reference data categories.

Id
string
Default: "LU-2024-001-ABC"

The unique identifier for this lookup record. System-generated and immutable, though it can be referenced in bulk update operations. Used for maintaining referential integrity across the system.

Name
string or null
Default: "Aerial Work Platform - Scissor Lift"

A human-readable display name for this lookup value. Commonly used in dropdowns and selection interfaces. Examples include equipment categories, status types, or payment terms.

Description
string or null
Default: "Self-propelled elevating work platform with extending platform for heights up to 40ft"

Additional details about the lookup value that provide context or clarification. May include usage guidelines or business rules associated with this value.

Field
string
Default: "EquipmentCategory"

The system field or attribute this lookup value is associated with. Used to categorize and organize lookup values by their functional area or purpose.

Value
string
Default: "AWP-SCSR"

The actual stored value or code used in the system. While the Name field is for display, this is the underlying value used in database operations and API calls.

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

Create a new Customer

Required fields:

  • If RecordType is "Individual", then:
    • FirstName
    • LastName
  • Otherwise:
    • Name
Authorizations:
ApiKey
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "ABC Construction Co"

Can be a company or individual name. Example Business: "ABC Construction Services LLC" Example Individual: "John Smith"

object or null

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

Supported List

All

  • TaxNumber - Example: "47-1234567"

Elite Only

  • CustomerKey - Example: "ABC123"
  • DriversLicense - Example: "D1234567"
  • FederalId - Example: "84-1234567"
  • InsuranceNumber - Example: "POL-987654321"
  • OtherId - Example: "DUNS-456789"

Syrinx Only

  • AccountNumber - Example: "ACC10012345"
  • RegistrationNumber - Example: "REG2024-001"
  • VatNumber - Example: "GB123456789"

Not all properties are valid across all products.

CustomerKey
string or null

(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

(Elite Only) Drivers license for individual type customers.

ExternalCustomerId
string or null

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

FederalId
string or null

(Elite Only) FederalId of Customer.

InsuranceNumber
string or null

(Elite Only) Insurance Number of Customer.

OtherId
string or null

(Elite Only) Addtional Id's of Customer.

TaxNumber
string or null

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

Array of objects

Supported types will depend on the product.

Elite:

  • Supported: "Customer"
  • Coming Soon: "Default", "Billing"

Example: [ { "Type": "Customer", "Line1": "1234 Construction Way", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ]

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

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type. Example: "Sarah Johnson, Accounts Payable"

Classification
string or null

What kind of customer is this? Examples include:

  • "General Contractor"
  • "Plumbing Contractor"
  • "Homeowner"
  • "Event Planner"
  • "Landscaper"
  • "Demolition Contractor"
  • "HVAC Contractor"

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

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

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager. Example: 25000 (represents $25,000 credit limit)

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format. Common Examples:

  • "USD" (US Dollar)
  • "CAD" (Canadian Dollar)
  • "GBP" (British Pound)
  • "EUR" (Euro)
  • "AUD" (Australian Dollar)

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

Prevents the software from sending 'marketing' emails.

Array of objects

Example: [ { "Type": "Primary", "Email": "contracts@abcconstruction.com" } ]

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

First Name of Customer (individual only). Example: "John"

HeardAboutUs
string or null

Common Examples:

  • "Google Search"
  • "Referral"
  • "Trade Show"
  • "Social Media"
  • "Industry Publication"
  • "Local Advertisement"

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

Last Name of Customer (individual only). Example: "Smith"

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

Means no tax is calculated for this customer on any contracts

Array of objects

Example: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123" }, { "Type": "Mobile", "CountryCode": "1", "Number": "214-555-0124" } ]

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. Example Business: Construction company renting heavy equipment Example Individual: Homeowner renting tools

object or null

Data related to the sales person associated with the Customer.

Name
string or null

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

object

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

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

Examples:

  • "Lead": Initial contact, no rentals yet
  • "Prospect": Actively discussing rental needs
  • "Cash": Pay-as-you-go customer
  • "Account": Established customer with credit terms

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

(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

Additional fields for Customer. Example: { "CustomerWebPortal": true, "ExternalTaxClass": "CONST", "ExternalTaxCode": "TX-CONST-01", "ForceContractInfo": true, "ForceJobId": true, "ForcePurchaseOrder": true, "InvoiceSendBy": "Email", "StatementSendBy": "Email", "Terms": "Net 30", "UserDefined1": "VIP Customer", "UserDefined2": "Annual Revenue >$5M" }

CustomerWebPortal
boolean or null

(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

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

ExternalTaxCode
string or null

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

ForceContractInfo
boolean or null

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

ForceJobId
boolean or null

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

ForcePickedUp
boolean or null

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

ForcePurchaseOrder
boolean or null

(Elite Only) Flag to force purchase orders.

InvoiceSendBy
string or null
Enum: "Email" "Fax" "No Statement" "Printer"

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

Restrictions
string or null

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

StatementSendBy
string or null
Enum: "Email" "Fax" "No Statement" "Printer"

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

Terms
string or null <= 50 characters

(Elite Only) Terms for the customer.

UserDefined1
string or null <= 50 characters

Placeholder field.

UserDefined2
string or null <= 50 characters

Placeholder field.

Responses

Request samples

Content type
application/json
{
  • "Name": "ABC Construction Co"
}

Response samples

Content type
application/json
{
  • "ModelType": "Customer",
  • "Id": "CUST-12345",
  • "Name": "ABC Construction Co",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "Status": "Active",
  • "CreatedDateTime": "2024-01-01T00:00:00Z"
}

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:
ApiKey

Responses

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

Standard field that denotes the record type. Useful for bulk ingesting different record types. Example: "Customer"

Id
string
Default: "CUST-12345"

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. Example: "CUST-12345"

Name
string or null
Default: "ABC Construction Co"

Can be a company or individual name. Example: "ABC Construction Co" or "John Smith"

object or null
Default: {"CustomerKey":"ABC123","TaxNumber":"123-45-6789"}

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

Supported List

All

  • TaxNumber - Example: "123-45-6789"

Elite Only

  • CustomerKey - Example: "ABC123"
  • DriversLicense - Example: "DL123456789"
  • FederalId - Example: "12-3456789"
  • InsuranceNumber - Example: "INS987654321"
  • OtherId - Example: "MISC123"

Syrinx Only

  • AccountNumber - Example: "ACC001"
  • RegistrationNumber - Example: "REG789"
  • VatNumber - Example: "GB123456789"

Not all properties are valid across all products.

Array of objects
Default: [{"Type":"Customer","Line1":"123 Construction Ave","City":"Dallas","Province":"TX","PostalCode":"75201"}]

Supported types will depend on the product.

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

Example: [ { "Type": "Customer", "Line1": "123 Construction Ave", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ]

BillingName
string or null

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type. Example: "Jane Smith - Accounts Payable"

Classification
string or null

What kind of customer is this? Examples: "General Contractor", "Homeowner", "Plumbing Contractor", "Event Planner", "Landscaper". 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

Name of the Company. Example: "ABC Construction Co" or "Smith's Plumbing Services"

Array of objects

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

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager. Example: 5000 (represents $5,000 credit limit)

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format. Examples: "USD", "CAD", "GBP", "EUR", "AUD"

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

Prevents the software from sending 'marketing' emails.

Array of objects

Example: [ { "Type": "Primary", "Email": "accounting@abcconstruction.com" } ]

FirstName
string or null

First Name of Customer (individual only). Example: "John"

HeardAboutUs
string or null

Examples: "Google Search", "Referral", "Trade Show", "Social Media", "Industry Publication"

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

Last Name of Customer (individual only). Example: "Smith"

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

Means no tax is calculated for this customer on any contracts

PaymentTerms
string or null

(Currently not supported)

Array of objects

Example: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123", "Extension": "101" } ]

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

Denotes if this record is a business or an individual. Example: "Business" for ABC Construction, "Individual" for John Smith

object or null

Data related to the sales person associated with the Customer.

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

Examples:

  • Lead: Initial contact, no rentals yet
  • Prospect: Actively discussing rental needs
  • Cash: Pay-as-you-go customer
  • Account: Established customer with payment terms

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

(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

Additional fields for Customer with examples:

  • CustomerWebPortal: true (allows customer to access online portal)
  • ExternalTaxClass: "CONSTRUCTION"
  • ExternalTaxCode: "TX-CONST"
  • ForceContractInfo: true (requires job/project description)
  • ForceJobId: true (requires job number)
  • ForcePickedUp: true (requires signature)
  • ForcePurchaseOrder: true (requires PO number)
  • InvoiceSendBy: "Email"
  • StatementSendBy: "Email"
  • Terms: "Net 30"
  • UserDefined1: "VIP Customer"
  • UserDefined2: "Annual Revenue > $5M"
CreatedDateTime
string or null <date-time>
Default: "2024-01-01T00:00:00Z"

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 or null
Value: 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

Retrieve a single Customer by Id

Authorizations:
ApiKey
path Parameters
CustomerId
required
string

Responses

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

Standard field that denotes the record type. Useful for bulk ingesting different record types. Example: "Customer"

Id
string
Default: "CUST-12345"

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. Example: "CUST-12345"

Name
string or null
Default: "ABC Construction Co"

Can be a company or individual name. Example: "ABC Construction Co" or "John Smith"

object or null
Default: {"CustomerKey":"ABC123","TaxNumber":"123-45-6789"}

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

Supported List

All

  • TaxNumber - Example: "123-45-6789"

Elite Only

  • CustomerKey - Example: "ABC123"
  • DriversLicense - Example: "DL123456789"
  • FederalId - Example: "12-3456789"
  • InsuranceNumber - Example: "INS987654321"
  • OtherId - Example: "MISC123"

Syrinx Only

  • AccountNumber - Example: "ACC001"
  • RegistrationNumber - Example: "REG789"
  • VatNumber - Example: "GB123456789"

Not all properties are valid across all products.

AccountNumber
string or null

(Syrinx Only) Unique user defined customer identifier.

CustomerKey
string or null
Default: "ABC123"

(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

(Elite Only) Drivers license for individual type customers.

ExternalCustomerId
string or null

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

FederalId
string or null

(Elite Only) FederalId of Customer.

InsuranceNumber
string or null

(Elite Only) Insurance Number of Customer.

OtherId
string or null

(Elite Only) Addtional Id's of Customer.

RegistrationNumber
string or null

(Syrinx Only) Registration Number of Customer.

TaxNumber
string or null
Default: "123-45-6789"

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

VatNumber
string or null

(Syrinx Only) Vat Number of Customer.

Array of objects
Default: [{"Type":"Customer","Line1":"123 Construction Ave","City":"Dallas","Province":"TX","PostalCode":"75201"}]

Supported types will depend on the product.

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

Example: [ { "Type": "Customer", "Line1": "123 Construction Ave", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ]

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

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type. Example: "Jane Smith - Accounts Payable"

Classification
string or null

What kind of customer is this? Examples: "General Contractor", "Homeowner", "Plumbing Contractor", "Event Planner", "Landscaper". 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

Name of the Company. Example: "ABC Construction Co" or "Smith's Plumbing Services"

Array of objects

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

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager. Example: 5000 (represents $5,000 credit limit)

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format. Examples: "USD", "CAD", "GBP", "EUR", "AUD"

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

Prevents the software from sending 'marketing' emails.

Array of objects

Example: [ { "Type": "Primary", "Email": "accounting@abcconstruction.com" } ]

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

First Name of Customer (individual only). Example: "John"

HeardAboutUs
string or null

Examples: "Google Search", "Referral", "Trade Show", "Social Media", "Industry Publication"

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

Last Name of Customer (individual only). Example: "Smith"

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

Means no tax is calculated for this customer on any contracts

PaymentTerms
string or null

(Currently not supported)

Array of objects

Example: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123", "Extension": "101" } ]

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. Example: "Business" for ABC Construction, "Individual" for John Smith

object or null

Data related to the sales person associated with the Customer.

ModelType
string
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

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

object

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

FirstName
string or null

First name of the sales person.

Elite: This field is not supported.

LastName
string or null

Last name of the sales person.

Elite: This field is not supported.

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

Examples:

  • Lead: Initial contact, no rentals yet
  • Prospect: Actively discussing rental needs
  • Cash: Pay-as-you-go customer
  • Account: Established customer with payment terms

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

(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

Additional fields for Customer with examples:

  • CustomerWebPortal: true (allows customer to access online portal)
  • ExternalTaxClass: "CONSTRUCTION"
  • ExternalTaxCode: "TX-CONST"
  • ForceContractInfo: true (requires job/project description)
  • ForceJobId: true (requires job number)
  • ForcePickedUp: true (requires signature)
  • ForcePurchaseOrder: true (requires PO number)
  • InvoiceSendBy: "Email"
  • StatementSendBy: "Email"
  • Terms: "Net 30"
  • UserDefined1: "VIP Customer"
  • UserDefined2: "Annual Revenue > $5M"
CustomerWebPortal
boolean or null

(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

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

ExternalTaxCode
string or null

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

ForceContractInfo
boolean or null

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

ForceJobId
boolean or null

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

ForcePickedUp
boolean or null

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

ForcePurchaseOrder
boolean or null

(Elite Only) Flag to force purchase orders.

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

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

Restrictions
string or null

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

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

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

Terms
string or null <= 50 characters

(Elite Only) Terms for the customer.

UserDefined1
string or null <= 50 characters

Placeholder field.

UserDefined2
string or null <= 50 characters

Placeholder field.

CreatedDateTime
string or null <date-time>
Default: "2024-01-01T00:00:00Z"

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 or null
Value: 1

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

Response samples

Content type
application/json
{
  • "ModelType": "Customer",
  • "Id": "CUST-12345",
  • "Name": "ABC Construction Co",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "Status": "Active",
  • "CreatedDateTime": "2024-01-01T00:00:00Z"
}

Update a single Customer by Id

Supported by: Elite

Update a single Customer by Id

Required fields:

  • Id
Authorizations:
ApiKey
path Parameters
CustomerId
required
string
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "ABC Construction Co"

Can be a company or individual name. Example Business: "ABC Construction Services LLC" Example Individual: "John Smith"

object or null

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

Supported List

All

  • TaxNumber - Example: "47-1234567"

Elite Only

  • CustomerKey - Example: "ABC123"
  • DriversLicense - Example: "D1234567"
  • FederalId - Example: "84-1234567"
  • InsuranceNumber - Example: "POL-987654321"
  • OtherId - Example: "DUNS-456789"

Syrinx Only

  • AccountNumber - Example: "ACC10012345"
  • RegistrationNumber - Example: "REG2024-001"
  • VatNumber - Example: "GB123456789"

Not all properties are valid across all products.

CustomerKey
string or null

(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

(Elite Only) Drivers license for individual type customers.

ExternalCustomerId
string or null

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

FederalId
string or null

(Elite Only) FederalId of Customer.

InsuranceNumber
string or null

(Elite Only) Insurance Number of Customer.

OtherId
string or null

(Elite Only) Addtional Id's of Customer.

TaxNumber
string or null

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

Array of objects

Supported types will depend on the product.

Elite:

  • Supported: "Customer"
  • Coming Soon: "Default", "Billing"

Example: [ { "Type": "Customer", "Line1": "1234 Construction Way", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ]

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

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type. Example: "Sarah Johnson, Accounts Payable"

Classification
string or null

What kind of customer is this? Examples include:

  • "General Contractor"
  • "Plumbing Contractor"
  • "Homeowner"
  • "Event Planner"
  • "Landscaper"
  • "Demolition Contractor"
  • "HVAC Contractor"

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

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

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager. Example: 25000 (represents $25,000 credit limit)

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format. Common Examples:

  • "USD" (US Dollar)
  • "CAD" (Canadian Dollar)
  • "GBP" (British Pound)
  • "EUR" (Euro)
  • "AUD" (Australian Dollar)

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

Prevents the software from sending 'marketing' emails.

Array of objects

Example: [ { "Type": "Primary", "Email": "contracts@abcconstruction.com" } ]

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

First Name of Customer (individual only). Example: "John"

HeardAboutUs
string or null

Common Examples:

  • "Google Search"
  • "Referral"
  • "Trade Show"
  • "Social Media"
  • "Industry Publication"
  • "Local Advertisement"

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

Last Name of Customer (individual only). Example: "Smith"

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

Means no tax is calculated for this customer on any contracts

Array of objects

Example: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123" }, { "Type": "Mobile", "CountryCode": "1", "Number": "214-555-0124" } ]

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. Example Business: Construction company renting heavy equipment Example Individual: Homeowner renting tools

object or null

Data related to the sales person associated with the Customer.

Name
string or null

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

object

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

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

Examples:

  • "Lead": Initial contact, no rentals yet
  • "Prospect": Actively discussing rental needs
  • "Cash": Pay-as-you-go customer
  • "Account": Established customer with credit terms

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

(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

Additional fields for Customer. Example: { "CustomerWebPortal": true, "ExternalTaxClass": "CONST", "ExternalTaxCode": "TX-CONST-01", "ForceContractInfo": true, "ForceJobId": true, "ForcePurchaseOrder": true, "InvoiceSendBy": "Email", "StatementSendBy": "Email", "Terms": "Net 30", "UserDefined1": "VIP Customer", "UserDefined2": "Annual Revenue >$5M" }

CustomerWebPortal
boolean or null

(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

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

ExternalTaxCode
string or null

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

ForceContractInfo
boolean or null

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

ForceJobId
boolean or null

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

ForcePickedUp
boolean or null

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

ForcePurchaseOrder
boolean or null

(Elite Only) Flag to force purchase orders.

InvoiceSendBy
string or null
Enum: "Email" "Fax" "No Statement" "Printer"

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

Restrictions
string or null

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

StatementSendBy
string or null
Enum: "Email" "Fax" "No Statement" "Printer"

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

Terms
string or null <= 50 characters

(Elite Only) Terms for the customer.

UserDefined1
string or null <= 50 characters

Placeholder field.

UserDefined2
string or null <= 50 characters

Placeholder field.

Responses

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

Standard field that denotes the record type. Useful for bulk ingesting different record types. Example: "Customer"

Id
string
Default: "CUST-12345"

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. Example: "CUST-12345"

Name
string or null
Default: "ABC Construction Co"

Can be a company or individual name. Example: "ABC Construction Co" or "John Smith"

object or null
Default: {"CustomerKey":"ABC123","TaxNumber":"123-45-6789"}

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

Supported List

All

  • TaxNumber - Example: "123-45-6789"

Elite Only

  • CustomerKey - Example: "ABC123"
  • DriversLicense - Example: "DL123456789"
  • FederalId - Example: "12-3456789"
  • InsuranceNumber - Example: "INS987654321"
  • OtherId - Example: "MISC123"

Syrinx Only

  • AccountNumber - Example: "ACC001"
  • RegistrationNumber - Example: "REG789"
  • VatNumber - Example: "GB123456789"

Not all properties are valid across all products.

AccountNumber
string or null

(Syrinx Only) Unique user defined customer identifier.

CustomerKey
string or null
Default: "ABC123"

(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

(Elite Only) Drivers license for individual type customers.

ExternalCustomerId
string or null

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

FederalId
string or null

(Elite Only) FederalId of Customer.

InsuranceNumber
string or null

(Elite Only) Insurance Number of Customer.

OtherId
string or null

(Elite Only) Addtional Id's of Customer.

RegistrationNumber
string or null

(Syrinx Only) Registration Number of Customer.

TaxNumber
string or null
Default: "123-45-6789"

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

VatNumber
string or null

(Syrinx Only) Vat Number of Customer.

Array of objects
Default: [{"Type":"Customer","Line1":"123 Construction Ave","City":"Dallas","Province":"TX","PostalCode":"75201"}]

Supported types will depend on the product.

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

Example: [ { "Type": "Customer", "Line1": "123 Construction Ave", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ]

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

Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type. Example: "Jane Smith - Accounts Payable"

Classification
string or null

What kind of customer is this? Examples: "General Contractor", "Homeowner", "Plumbing Contractor", "Event Planner", "Landscaper". 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

Name of the Company. Example: "ABC Construction Co" or "Smith's Plumbing Services"

Array of objects

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

The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager. Example: 5000 (represents $5,000 credit limit)

CurrencyCode
string or null
Default: "USD"

Defaults to "USD". Code is ISO 4217 format. Examples: "USD", "CAD", "GBP", "EUR", "AUD"

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

Prevents the software from sending 'marketing' emails.

Array of objects

Example: [ { "Type": "Primary", "Email": "accounting@abcconstruction.com" } ]

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

First Name of Customer (individual only). Example: "John"

HeardAboutUs
string or null

Examples: "Google Search", "Referral", "Trade Show", "Social Media", "Industry Publication"

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

Last Name of Customer (individual only). Example: "Smith"

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

Means no tax is calculated for this customer on any contracts

PaymentTerms
string or null

(Currently not supported)

Array of objects

Example: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123", "Extension": "101" } ]

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. Example: "Business" for ABC Construction, "Individual" for John Smith

object or null

Data related to the sales person associated with the Customer.

ModelType
string
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

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

object

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

FirstName
string or null

First name of the sales person.

Elite: This field is not supported.

LastName
string or null

Last name of the sales person.

Elite: This field is not supported.

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

Examples:

  • Lead: Initial contact, no rentals yet
  • Prospect: Actively discussing rental needs
  • Cash: Pay-as-you-go customer
  • Account: Established customer with payment terms

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

(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

Additional fields for Customer with examples:

  • CustomerWebPortal: true (allows customer to access online portal)
  • ExternalTaxClass: "CONSTRUCTION"
  • ExternalTaxCode: "TX-CONST"
  • ForceContractInfo: true (requires job/project description)
  • ForceJobId: true (requires job number)
  • ForcePickedUp: true (requires signature)
  • ForcePurchaseOrder: true (requires PO number)
  • InvoiceSendBy: "Email"
  • StatementSendBy: "Email"
  • Terms: "Net 30"
  • UserDefined1: "VIP Customer"
  • UserDefined2: "Annual Revenue > $5M"
CustomerWebPortal
boolean or null

(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

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

ExternalTaxCode
string or null

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

ForceContractInfo
boolean or null

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

ForceJobId
boolean or null

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

ForcePickedUp
boolean or null

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

ForcePurchaseOrder
boolean or null

(Elite Only) Flag to force purchase orders.

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

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

Restrictions
string or null

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

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

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

Terms
string or null <= 50 characters

(Elite Only) Terms for the customer.

UserDefined1
string or null <= 50 characters

Placeholder field.

UserDefined2
string or null <= 50 characters

Placeholder field.

CreatedDateTime
string or null <date-time>
Default: "2024-01-01T00:00:00Z"

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 or null
Value: 1

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

Request samples

Content type
application/json
{
  • "Name": "ABC Construction Co"
}

Response samples

Content type
application/json
{
  • "ModelType": "Customer",
  • "Id": "CUST-12345",
  • "Name": "ABC Construction Co",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "Status": "Active",
  • "CreatedDateTime": "2024-01-01T00:00:00Z"
}

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:
ApiKey
path Parameters
field
required
string

Responses

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

Indicates the type of lookup being performed. While most endpoints return a single type, some specialized endpoints may support multiple lookup types for different reference data categories.

Id
string
Default: "LU-2024-001-ABC"

The unique identifier for this lookup record. System-generated and immutable, though it can be referenced in bulk update operations. Used for maintaining referential integrity across the system.

Name
string or null
Default: "Aerial Work Platform - Scissor Lift"

A human-readable display name for this lookup value. Commonly used in dropdowns and selection interfaces. Examples include equipment categories, status types, or payment terms.

Description
string or null
Default: "Self-propelled elevating work platform with extending platform for heights up to 40ft"

Additional details about the lookup value that provide context or clarification. May include usage guidelines or business rules associated with this value.

Field
string
Default: "EquipmentCategory"

The system field or attribute this lookup value is associated with. Used to categorize and organize lookup values by their functional area or purpose.

Value
string
Default: "AWP-SCSR"

The actual stored value or code used in the system. While the Name field is for display, this is the underlying value used in database operations and API calls.

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:
ApiKey

Responses

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

Standard field that denotes the record type. For depots, this will always be 'Depot'. This is used for type discrimination in polymorphic queries.

Id
string
Default: "DEP-001"

The unique identifier for this record. Usually a UUID or system-generated ID. In Elite systems, this often starts with 'DEP-' followed by a numeric sequence.

Name
string
Default: "Main Equipment Yard"

The display name for this record, typically the store/branch name. This should be unique within a region and clearly identify the location. Often includes city and area/direction qualifiers.

Identifiers
object or null

Identifying items for Depot such as store number, branch code, or regional identifiers. Store numbers often align with accounting systems, while branch codes are used for operational grouping.

Array of objects (Address)

Physical and mailing addresses associated with this depot

DefaultDepot
boolean or null

Indicates if this is the user's primary or home depot. Critical for multi-store operations where staff may work across locations but have a primary assignment. Affects default views, reporting, and inventory transfers.

Array of objects (Email)

List of email addresses associated with this depot

Array of objects (Phone)

List of phone numbers associated with this depot

AdditionalFields
object or null

Custom fields specific to this depot that capture operational capabilities and business rules

CreatedDateTime
string or null <date-time>
Default: "2024-01-01T00:00:00Z"

UTC timestamp when the depot record was created in the system. Used for audit trails and historical tracking.

UpdatedDateTime
string or null <date-time>

UTC timestamp of the last update to this depot record. Important for synchronization and change tracking across systems.

Hidden
integer or null
Value: 1

Flag indicating if this depot should be hidden from normal views (0=visible, 1=hidden). Used for temporarily inactive locations, seasonal locations, or depots being prepared for closure/relocation.

Disabled
boolean or null

Indicates if the depot is active or closed | 0 = active, 1 = closed

ItemId
string or null
Deprecated

Legacy identifier for the depot, typically from older systems like AS400 or mainframe systems. Maintained for historical reporting and data migration purposes.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve blocked days for depots

Supported by: Elite

Retrieve blocked-day details for depots. See query parameter descriptions.

Authorizations:
ApiKey
query Parameters
DepotId
string

Limit blocked days search to a specific store, set by Id. Defaults to showing all stores.

StartDate
string

Optional UTC start date to limit retrieved blocked days. Defaults to today.

EndDate
string

Optional UTC end date to limit retrieved blocked days. Defaults to 30 days in the future.

Responses

Response Schema: application/json
required
Array of objects

Per-depot blocked calendar dates within the requested range.

Array
DepotId
required
string

Depot/store identifier.

required
Array of objects

Blocked dates for this depot (UTC).

StartDate
string <date-time>

Start of the requested date range (inclusive), in UTC.

EndDate
string <date-time>

End of the requested date range (inclusive), in UTC.

Response samples

Content type
application/json
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "BlockedDays": [
    ]
}

Retrieve a single Depot by Id

Supported by: Elite, Syrinx

Retrieve a single Depot by Id

Authorizations:
ApiKey
path Parameters
DepotId
required
string

Responses

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

Standard field that denotes the record type. For depots, this will always be 'Depot'. This is used for type discrimination in polymorphic queries.

Id
string
Default: "DEP-001"

The unique identifier for this record. Usually a UUID or system-generated ID. In Elite systems, this often starts with 'DEP-' followed by a numeric sequence.

Name
string
Default: "Main Equipment Yard"

The display name for this record, typically the store/branch name. This should be unique within a region and clearly identify the location. Often includes city and area/direction qualifiers.

Identifiers
object or null

Identifying items for Depot such as store number, branch code, or regional identifiers. Store numbers often align with accounting systems, while branch codes are used for operational grouping.

Array of objects (Address)

Physical and mailing addresses associated with this depot

Array
City
string or null <= 128 characters

City name where the depot is located. For multi-city areas, use the official city name rather than the metropolitan area name.

Country
string or null <= 128 characters

Country code using ISO 3166-1 alpha-3 format. Required for international operations and tax compliance.

GeoRegion2
string or null <= 64 characters

County or district name. Important for tax jurisdictions and service territory mapping.

GeoRegion3
string or null <= 64 characters

Specific business district or zone designation. Used for delivery zone calculations and territory management.

Latitude
string or null <= 64 characters

Precise latitude for depot location. Critical for delivery routing and equipment tracking systems.

Line1
string or null <= 256 characters

Street address of the depot. Should be verified for truck accessibility and delivery routing.

Line2
string or null <= 256 characters

Additional address details such as suite numbers or building identifiers. Important for large industrial parks or airport locations.

Line3
string or null <= 256 characters

Special delivery instructions or landmark references. Helpful for locations with complex access requirements.

Longitude
string or null <= 64 characters

Precise longitude for depot location. Used with latitude for geofencing and territory management.

Name
string or null <= 128 characters

Descriptive name for this address record. Helpful when a depot has multiple addresses for different purposes.

PostalCode
string or null <= 32 characters

ZIP or postal code. Critical for delivery zone pricing and tax calculations.

Province
string or null <= 128 characters

State or province code. Use standard two-letter codes for US states and Canadian provinces.

Type
string or null <= 32 characters

Address type classification. Common values include 'physical' (yard location), 'mailing' (office), 'billing' (accounting), or 'shipping' (delivery hub).

DefaultDepot
boolean or null

Indicates if this is the user's primary or home depot. Critical for multi-store operations where staff may work across locations but have a primary assignment. Affects default views, reporting, and inventory transfers.

Array of objects (Email)

List of email addresses associated with this depot

Array
Email
string

Email address for specific depot functions. Should follow company email conventions and include role or department identifiers.

Type
string

Purpose of the email address. Common types include 'general', 'service', 'parts', 'accounts', or 'manager'.

Array of objects (Phone)

List of phone numbers associated with this depot

Array
CountryCode
string or null <= 16 characters

International dialing code. Required for multi-country operations and SMS notifications.

Extension
string or null <= 32 characters

Internal extension number for direct department access. Common in larger depots with multiple departments.

Number
string or null <= 32 characters

Main phone number formatted for local display. Should be formatted consistently for customer-facing displays.

NumberE164
string or null <= 32 characters

Standardized E.164 format phone number for system use. Required for SMS notifications and automated calling systems.

SmsCapable
boolean or null

Indicates if this number can receive SMS messages. Used for delivery notifications and customer communications.

Type
string or null <= 32 characters

Categorizes the phone line's purpose. Common types include 'main', 'service', 'parts', 'emergency', 'dispatch', or 'sales'.

AdditionalFields
object or null

Custom fields specific to this depot that capture operational capabilities and business rules

CreatedDateTime
string or null <date-time>
Default: "2024-01-01T00:00:00Z"

UTC timestamp when the depot record was created in the system. Used for audit trails and historical tracking.

UpdatedDateTime
string or null <date-time>

UTC timestamp of the last update to this depot record. Important for synchronization and change tracking across systems.

Hidden
integer or null
Value: 1

Flag indicating if this depot should be hidden from normal views (0=visible, 1=hidden). Used for temporarily inactive locations, seasonal locations, or depots being prepared for closure/relocation.

Disabled
boolean or null

Indicates if the depot is active or closed | 0 = active, 1 = closed

ItemId
string or null
Deprecated

Legacy identifier for the depot, typically from older systems like AS400 or mainframe systems. Maintained for historical reporting and data migration purposes.

Response samples

Content type
application/json
{
  • "ModelType": "Depot",
  • "Id": "DEP-001",
  • "Name": "Main Equipment Yard",
  • "Address": {
    },
  • "ContactName": "Yard Manager",
  • "ContactPhone": "214-555-7890",
  • "Status": "Active",
  • "CreatedDateTime": "2024-01-01T00:00:00Z"
}

Invoices

Retrieve a list of Invoices

Retrieve a list of Invoices

Authorizations:
ApiKey

Responses

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

These are the different types of invoice models we can use. For rental equipment invoices, this will always be 'Invoice' to distinguish from other document types like quotes or contracts.

Id
string
Default: "INV-2024-001"

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. Format follows UUID v4 standard.

Name
string or null

The display name for the invoice. Typically includes customer name and invoice number for easy reference.

object or null

Identifying items for invoice that link it to other system entities like contracts or work orders.

CustomerId
string or null
Default: "CUST-12345"

The customer id associated with the invoice. Links to the customer record in the system.

InvoiceDate
string or null <date-time>
Default: "2024-03-15T00:00:00Z"

The date the invoice was created. For rental equipment, this is typically when the rental period ends or when periodic billing occurs.

InvoiceNumber
string or null
Default: "24001"

The invoice number. Usually follows a company-specific format, often including year and sequential numbering.

GrandTaxTotal
number or null

Amount of Tax/VAT on the invoice. Sum of all applicable taxes including state/provincial, local, and special equipment rental taxes.

GrandTotal
number or null

Value of the invoice including taxes. For rental equipment, this includes rental charges, damage protection fees, delivery fees, and applicable taxes.

AmountDue
number or null

Amount of money owed toward the invoice total. May be less than GrandTotal if partial payments have been made or deposits applied.

AdditionalFields
object or null

Additional fields for invoice such as custom terms, special instructions, or customer-specific references.

ContractType
string or null
Enum: "Cash" "Account"

Indicates whether the invoice was generated from a cash sale or an account/credit contract. Distinct from the AR-invoice ContractType enum used elsewhere; values here are sourced from the rental contract behind the invoice.

ARRepresentative
string or null

The accounts-receivable representative code assigned to the invoice on the source system. Identifies the staff member or representative responsible for collections.

PaymentDueDate
string or null <date-time>

When payment for this invoice is due. Computed by the source RMS from the invoice billed date plus the customer's terms in days. UTC, ISO-8601.

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T14:30:00Z"

When was the record created? All date times are expected to be in UTC & ISO-8601 format. This timestamp is automatically set when the invoice is first generated.

UpdatedDateTime
string or null <date-time>

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. Updates when any field is modified, payments are applied, or the invoice is adjusted.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Invoice by Id

Retrieve a single Invoice by Id

Authorizations:
ApiKey
path Parameters
InvoiceId
required
string

Responses

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

These are the different types of invoice models we can use. For rental equipment invoices, this will always be 'Invoice' to distinguish from other document types like quotes or contracts.

Id
string
Default: "INV-2024-001"

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. Format follows UUID v4 standard.

Name
string or null

The display name for the invoice. Typically includes customer name and invoice number for easy reference.

object or null

Identifying items for invoice that link it to other system entities like contracts or work orders.

ContractId
string or null

(Elite-Only) The contract id associated with the invoice. References the rental agreement or service contract.

CustomerId
string or null
Default: "CUST-12345"

The customer id associated with the invoice. Links to the customer record in the system.

InvoiceDate
string or null <date-time>
Default: "2024-03-15T00:00:00Z"

The date the invoice was created. For rental equipment, this is typically when the rental period ends or when periodic billing occurs.

InvoiceNumber
string or null
Default: "24001"

The invoice number. Usually follows a company-specific format, often including year and sequential numbering.

GrandTaxTotal
number or null

Amount of Tax/VAT on the invoice. Sum of all applicable taxes including state/provincial, local, and special equipment rental taxes.

GrandTotal
number or null

Value of the invoice including taxes. For rental equipment, this includes rental charges, damage protection fees, delivery fees, and applicable taxes.

AmountDue
number or null

Amount of money owed toward the invoice total. May be less than GrandTotal if partial payments have been made or deposits applied.

AdditionalFields
object or null

Additional fields for invoice such as custom terms, special instructions, or customer-specific references.

ContractType
string or null
Enum: "Cash" "Account"

Indicates whether the invoice was generated from a cash sale or an account/credit contract. Distinct from the AR-invoice ContractType enum used elsewhere; values here are sourced from the rental contract behind the invoice.

ARRepresentative
string or null

The accounts-receivable representative code assigned to the invoice on the source system. Identifies the staff member or representative responsible for collections.

PaymentDueDate
string or null <date-time>

When payment for this invoice is due. Computed by the source RMS from the invoice billed date plus the customer's terms in days. UTC, ISO-8601.

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T14:30:00Z"

When was the record created? All date times are expected to be in UTC & ISO-8601 format. This timestamp is automatically set when the invoice is first generated.

UpdatedDateTime
string or null <date-time>

When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. Updates when any field is modified, payments are applied, or the invoice is adjusted.

Response samples

Content type
application/json
{
  • "ModelType": "Invoice",
  • "Id": "INV-2024-001",
  • "InvoiceNumber": "24001",
  • "CustomerId": "CUST-12345",
  • "InvoiceDate": "2024-03-15T00:00:00Z",
  • "DueDate": "2024-04-14T00:00:00Z",
  • "SubTotal": 1500,
  • "TaxAmount": 123.75,
  • "TotalAmount": 1623.75,
  • "Status": "Open",
  • "CreatedDateTime": "2024-03-15T14:30:00Z"
}

Retrieve files for a single Invoice by Id.

Supported by: Elite

Retrieve files for a single Invoice by Id.

Authorizations:
ApiKey
path Parameters
InvoiceId
required
string
tagKey
required
string

pdfs or instructions or photos

Responses

Response Schema: application/json
Array
FileName
string

Original local filename including extension. Common formats include PDFs for manuals and documents, JPG/PNG for photos, and MP4 for videos.

FileClass
string
Enum: "misc" "image" "video"

Defines the type of stored file: 'misc' for documents (PDFs, contracts, manuals), 'image' for equipment photos and inspection documentation, 'video' for training materials and equipment operation demonstrations.

PublicURL
string

Web URL where the stored file can be downloaded. For secure files (like signed contracts or damage reports), this is a time-limited pre-signed URL. For public files (like equipment catalogs), this may be a permanent URL.

URLDateTime
string <date-time>

The date/time when the URL was generated. Critical for secure documents where URL expiration is enforced. Used with URLExpires to calculate the exact expiration time of pre-signed URLs.

URLExpires
integer

Number of seconds from URLDateTime until URL expires. Common values: 3600 (1 hour) for sensitive documents like contracts and damage reports, 86400 (24 hours) for inspection photos, and 604800 (1 week) for public equipment manuals.

TagMapKey
string
Enum: "pdfs" "instructions" "photos"

Categorizes the file purpose: 'pdfs' for equipment manuals, safety documentation, and signed contracts; 'instructions' for safety guides, operating procedures, and maintenance checklists; 'photos' for equipment condition documentation, damage reports, and marketing images.

ObjectPrimaryKey
string

Unique identifier for the associated object. Examples: Stock numbers (STOCK-12345) for equipment units, contract numbers (RENT-789456) for rental agreements, serial numbers (CAT-336-ABC123) for specific machines, or damage report IDs (DR-456789).

ObjectType
string

Classifies the associated object: 'Products' for equipment catalog/specifications, 'stock' for specific rental fleet units, 'contract' for rental/lease agreements, 'damage' for incident reports, or 'inspection' for equipment condition reports.

Tags
Array of strings

Categorization tags for the file. Common combinations: ['inspection-photo', 'pre-rental', 'exterior'] for pre-rental documentation, ['damage-report', 'insurance', 'claim-photos'] for incident documentation, ['equipment-manual', 'safety', 'maintenance'] for technical documentation.

Response samples

Content type
application/json
[]

Line Items

Call Line Items Off Rent

Supported by: Elite

Call Line Items Off Rent

Authorizations:
ApiKey
Request Body schema: application/json
required
LineItemIds
required
Array of strings
Default: ["687122~@!^$1"]

Array of unique line item IDs to be called off rent. Each ID represents a piece of equipment being returned.

CalledOffDateTime
required
string <date-time>
Default: "2024-04-15T00:00:00"

The exact date and time when the equipment will be called off rent (returned). Must be in UTC timezone.

PersonCallingOff
string

Full name of the customer representative who is authorizing the return of the equipment. This person should be authorized to make rental decisions.

Memo
string

Additional notes about the return, such as equipment condition, reason for return, or special handling instructions

RemoteUserId
string

The identifier for the user account on the remote system making this request. Could be an email, username, or internal ID that maps to the user in the remote system.

Responses

Request samples

Content type
application/json
{
  • "LineItemIds": [
    ],
  • "ContractId": "CNT-2024-001",
  • "ReturnDate": "2024-04-15T00:00:00Z",
  • "CalledOffDateTime": "2024-04-15T00:00:00",
  • "Condition": "Good",
  • "Notes": "Equipment returned in clean condition, no damage",
  • "MeterReading": 150.5,
  • "FuelLevel": 0.75
}

Response samples

Content type
application/json
{
  • "ModelType": "Contract",
  • "Id": "CNT-2024-0012345",
  • "Name": "Excavator Rental - ABC Construction",
  • "Identifiers": {
    },
  • "Addresses": [
    ],
  • "AmountDue": 2450.75,
  • "AmountPaid": 1000,
  • "Contacts": [
    ],
  • "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
  • "CustomerId": "CUST-ABC-001",
  • "CustomerName": "ABC Construction",
  • "CustomerPickup": {
    },
  • "DepotId": "DPT-DAL-001",
  • "EndDateTime": "2024-03-22T17:00:00Z",
  • "EsignState": "Signed",
  • "GrandTaxTotal": 202.19,
  • "GrandTotal": 2652.94,
  • "LineItems": [
    ],
  • "LocationId": "LOC-DAL-001",
  • "Notes": [
    ],
  • "PONumber": "ABC-PO-98765",
  • "StartDateTime": "2024-03-15T08:00:00Z",
  • "Status": "Open",
  • "Totals": [
    ],
  • "CreatedDateTime": "2024-03-14T15:30:00Z",
  • "UpdatedDateTime": "2024-03-15T08:15:00Z",
  • "IsPickup": true,
  • "Revision": 2,
  • "AdditionalFields": {
    }
}

Retrieve a list of line items

Retrieve a list of line items

Authorizations:
ApiKey

Responses

Response Schema: application/json
Array
ModelType
string

Standard field that denotes the record type.

Id
string
Default: "LI-001"

The unique identifier for this record.

Name
string
Default: "20T Excavator"

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

object or null

Identifying items for LineItem.

Classification
string or null
Enum: "Rental" "Sale"

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

EndDateTime
string or null <date-time>

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

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.

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..

LocationId
string or null

Id of the Location. (see the Location endpoints)

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.

PONumber
string or null

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

ProductId
string or null
Default: "PROD-123"

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: 1

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.

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

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

StartDateTime
string or null <date-time>

UTC - When does the customer want the items?

Status
string or null
Default: "OnRent"
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 (Workflow)

For Internal Use Only.

Array of objects

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

object or null

Additional fields for this record.

CreatedDateTime
string or null <date-time>

UTC when the record was created.

UpdatedDateTime
string or null <date-time>

UTC when the record was updated.

Hidden
integer or null
Value: 1

Hidden

ItemId
string or null
Deprecated

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

Retrieve a single line item by its id

Authorizations:
ApiKey
path Parameters
LineItemId
required
string

Responses

Response Schema: application/json
ModelType
string

Standard field that denotes the record type.

Id
string
Default: "LI-001"

The unique identifier for this record.

Name
string
Default: "20T Excavator"

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

object or null

Identifying items for LineItem.

Key
string or null

(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

(Elite Only) The model name associated with a specific instance of an item.

ParentId
string or null

Elite and Essentials Only.

PartNumber
string or null

(Elite Only) The part number associated with a specific instance of an item.

Classification
string or null
Enum: "Rental" "Sale"

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

EndDateTime
string or null <date-time>

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

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.

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..

LocationId
string or null

Id of the Location. (see the Location endpoints)

Array of objects or null

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

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

PONumber
string or null

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

ProductId
string or null
Default: "PROD-123"

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: 1

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.

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

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

StartDateTime
string or null <date-time>

UTC - When does the customer want the items?

Status
string or null
Default: "OnRent"
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 (Workflow)

For Internal Use Only.

Array
Creatable
boolean or null

Can the workflow be created?

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

Options are None, Generic, 360

RequiredPhotos
number or null
Array of objects

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

Additional fields for this record.

string or number

The id of the associated contract.

FuelStockName
string or null

(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

(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>

UTC when the record was created.

UpdatedDateTime
string or null <date-time>

UTC when the record was updated.

Hidden
integer or null
Value: 1

Hidden

ItemId
string or null
Deprecated

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

Response samples

Content type
application/json
{
  • "Id": "LI-001",
  • "ContractId": "CNT-2024-001",
  • "ProductId": "PROD-123",
  • "Name": "20T Excavator",
  • "Quantity": 1,
  • "RateAmount": 450,
  • "RateType": "Daily",
  • "StartDate": "2024-03-15T00:00:00Z",
  • "EndDate": "2024-04-15T00:00:00Z",
  • "Status": "OnRent",
  • "SubTotal": 13500,
  • "TaxAmount": 1113.75,
  • "TotalAmount": 14613.75
}

Locations

Create a new Location

Supported by: Elite

Create a new Location

Required fields:

  • Name
Authorizations:
ApiKey
Request Body schema: application/json
required
Name
string or null [ 1 .. 255 ] characters
Default: "Downtown Construction Site"

This would map to the jobsite description in Elite. Examples:

  • 'Downtown High-Rise Project - 123 Main St'
  • 'Smith Wedding Venue - Central Park'
  • 'Airport Terminal 3 Expansion Project'
  • 'Annual Home & Garden Show - Convention Center'
  • 'Johnson Construction - Highway 40 Bridge Project'
object or null

Location address with specific delivery instructions. Examples:

  • Construction site with security checkpoint
  • Event venue with loading dock access
  • Warehouse with specific bay numbers
Type
required
string
Default: "Customer"
Value: "Customer"

Examples:

  • 'Customer' for construction site delivery location
  • 'Customer' for event venue setup location
  • 'Customer' for equipment pickup location
Line1
string or null <= 50 characters

Address Number and Street. Examples:

  • '123 Construction Way'
  • '456 Convention Center Blvd'
  • '789 Industrial Park Road'
  • '321 Event Plaza Drive'
  • '555 Development Avenue'
Line3
string or null

May be apartment, building, suite. Example: 'North Construction Zone', 'Phase 2 Area'. 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. Example: 'Los Angeles', 'New York', 'Chicago'
GeoRegion2
string or null

Example: 'South Region', 'Western Division'. 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

Example: 'Downtown District', 'Industrial Zone'. 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. Example: 'CA', 'NY', 'TX'
PostalCode
string or null <= 50 characters

May be postcode, post code, PIN or ZIP Code depending on the country. Example: '90210', 'M5V 2T6', 'SW1A 1AA'

Latitude
string or null

Latitude in decimal format. Example: '34.052235'. 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:34.052235,-118.243683

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. Example: '-118.243683'. 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:34.052235,-118.243683

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. Example: 'US', 'CA', 'GB'. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

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>

This is the date from which the location is no longer valid to be used. A location cannot be used after this date. Examples:

  • '2024-12-31T23:59:59Z' for construction project completion
  • '2024-06-30T23:59:59Z' for event venue teardown deadline
  • '2024-09-30T23:59:59Z' for temporary storage facility closure

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Currently we only support SiteDeliveryInstructions for special delivery requirements and site access information.

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. Example: 'SiteDeliveryInstructions' for specific delivery requirements and site access protocols.

Value
required
string or null

The note text. Examples:

  • 'Deliver to loading dock B between 7am-3pm only. Security check-in required at North Gate. Contact site supervisor John Smith (555-0123) upon arrival. Hard hat and safety vest required.'
  • 'Event setup must be completed by 6am. Use service elevator #2. Contact event coordinator Sarah Johnson (555-0456) for access card.'
  • 'Fork lift required for unloading. Staging area marked in yellow. Site requires proof of insurance and worker safety certification.'
  • 'No deliveries during rush hour 7-9am and 4-6pm. Weekend delivery preferred. Call security desk (555-0789) 30 minutes before arrival.'
OwnerId
string or null

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc. Examples:

  • 'CUST_12345' for ABC Construction's project site
  • 'CUST_67890' for Metropolitan Events' venue
  • 'SUPP_34567' for Equipment Manufacturing Co's facility
Array of objects

Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Examples:

  • Site office main line
  • Security desk 24/7 contact
  • Project manager's direct line
  • Loading dock coordinator
  • After-hours emergency contact
Array
Type
required
string
Default: "Default"
Value: "Default"

Supported phone types. Examples:

  • 'Default' for site office main number
  • 'Default' for security desk contact
  • 'Default' for delivery coordinator's line
Number
required
string or null

A phone number without the country code embedded. Examples:

  • '555-123-4567' for site office
  • '555-234-5678' for security desk
  • '555-345-6789' for project manager
  • '555-456-7890' for loading dock
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>

This is the date from which the location is valid to be used. A location cannot be used before this date. Examples:

  • '2024-03-15T00:00:00Z' for construction project mobilization
  • '2024-06-01T00:00:00Z' for event venue setup start
  • '2024-04-01T00:00:00Z' for warehouse opening date

Elite: Not supported.
Syrinx: Supported.

AdditionalFields
object or null

Additional fields for Location. Example: Custom fields for site-specific requirements or certifications.

Responses

Request samples

Content type
application/json
{
  • "Name": "Downtown Construction Site"
}

Response samples

Content type
application/json
{
  • "ModelType": "Location",
  • "Id": "LOC-2024-001",
  • "Name": "Downtown Construction Site",
  • "CustomerId": "CUST-12345",
  • "Address": {
    },
  • "ContactName": "Site Manager",
  • "ContactPhone": "214-555-5678",
  • "Status": "Active",
  • "CreatedDateTime": "2024-03-15T00:00:00Z"
}

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:
ApiKey

Responses

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

Standard field that denotes the record type. Useful for bulk ingesting different record types. Example: 'Location'

Id
string
Default: "LOC-2024-001"

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. Example: 'LOC-12345'

Name
string or null
Default: "Downtown Construction Site"

This would map to the jobsite description in Elite. Examples: 'Madison Square Garden', 'Downtown High-Rise Project', 'Smith Wedding Venue'

Identifiers
object or null

Location does not have any identifiers at this time. Future examples might include site codes or project reference numbers.

object or null
Default: {"Line1":"456 Project Site","City":"Dallas","Province":"TX","PostalCode":"75202"}

Location address. Example: A construction site address with specific delivery instructions.

Array of objects

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

Type can == "Customer" or "Billing" for now. This supports multiple email addresses.

EndDate
string or null <date-time>

This is the date from which the location is no longer valid to be used. Example: '2024-12-31T23:59:59Z' for a construction project ending December 31st, 2024. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Currently we only support the following types of notes

  • SiteDeliveryInstructions. Example: Special delivery instructions for a construction site.
OwnerId
string or null

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer (Example: 'CUST-12345'), SupplierId if Type is Supplier (Example: 'SUPP-789'), etc.

Array of objects

Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Example: Site supervisor's phone, security office phone, etc.

StartDate
string or null <date-time>

This is the date from which the location is valid to be used. Example: '2024-03-01T00:00:00Z' for a construction project starting March 1st, 2024. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

Type
string
Enum: "Global" "Customer" "Supplier"

Location type may be one of the following.

  • Global (Example: Company warehouse)
  • Customer (Example: Construction site)
  • Supplier (Example: Manufacturer facility)
AdditionalFields
object or null

Additional fields for Location. Example: Custom fields like 'SecurityClearanceRequired: true' or 'SiteAccessHours: 24/7'

number or string

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

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T00:00:00Z"

When was the record created? Example: '2024-01-15T09:30:00Z'. All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>

When was the record last updated? Example: '2024-02-01T14:45:00Z'. All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer or null
Value: 1

0 = false (Example: Active location), 1 = true (Example: Demolished construction site) | 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

Retrieve a single Location by Id

Authorizations:
ApiKey
path Parameters
LocationId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "Location"
Value: "Location"

Standard field that denotes the record type. Useful for bulk ingesting different record types. Example: 'Location'

Id
string
Default: "LOC-2024-001"

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. Example: 'LOC-12345'

Name
string or null
Default: "Downtown Construction Site"

This would map to the jobsite description in Elite. Examples: 'Madison Square Garden', 'Downtown High-Rise Project', 'Smith Wedding Venue'

Identifiers
object or null

Location does not have any identifiers at this time. Future examples might include site codes or project reference numbers.

object or null
Default: {"Line1":"456 Project Site","City":"Dallas","Province":"TX","PostalCode":"75202"}

Location address. Example: A construction site address with specific delivery instructions.

Type
required
string
Default: "Customer"
Value: "Customer"

Examples include "Default", "Billing", etc. For locations, typically 'Customer' for job sites.

Name
string or null

Optional name for Address. Example: 'North Tower Entrance', 'Loading Dock B'

Line1
string or null
Default: "456 Project Site"

Address Number and Street. Example: '123 Construction Ave'

Line2
string or null

May be apartment, building, suite. Example: 'Building 4, Loading Dock'

Line3
string or null

May be apartment, building, suite. Example: 'Gate Code: #1234'. 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: "Dallas"

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. Example: 'Dallas'
GeoRegion2
string or null

Example: 'North Region'. 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

Example: 'Southwest District'. 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: "TX"

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. Example: 'TX' for Texas
PostalCode
string or null
Default: "75202"

May be postcode, post code, PIN or ZIP Code depending on the country. Example: '75201' for Dallas downtown area

Latitude
string or null

Latitude in decimal format. Example: '32.7767' for Dallas. 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:32.7767,-96.7970

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. Example: '-96.7970' for Dallas. 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:32.7767,-96.7970

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. Example: 'US' for United States, 'CA' for Canada. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

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

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>

This is the date from which the location is no longer valid to be used. Example: '2024-12-31T23:59:59Z' for a construction project ending December 31st, 2024. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Currently we only support the following types of notes

  • SiteDeliveryInstructions. Example: Special delivery instructions for a construction site.
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. Example: 'SiteDeliveryInstructions' for delivery notes.

Value
required
string or null

The note text. Example: 'Deliver to loading dock between 7am-3pm only. Contact site supervisor John at 555-0123 upon arrival.'

OwnerId
string or null

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer (Example: 'CUST-12345'), SupplierId if Type is Supplier (Example: 'SUPP-789'), etc.

Array of objects

Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Example: Site supervisor's phone, security office phone, etc.

Array
Type
required
string
Default: "Default"
Value: "Default"

Supported phone types. Example: 'Default' for primary contact number

Number
required
string or null

A phone number without the country code embedded. Example: '555-123-4567'

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. Example: 'EXT-PHONE-789'. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix. Example: '+1' for US/Canada numbers.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format. Example: '+15551234567'. 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? Example: '123' for ext. 123. 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? Example: true for mobile numbers that can receive texts. 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>

This is the date from which the location is valid to be used. Example: '2024-03-01T00:00:00Z' for a construction project starting March 1st, 2024. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

Type
string
Enum: "Global" "Customer" "Supplier"

Location type may be one of the following.

  • Global (Example: Company warehouse)
  • Customer (Example: Construction site)
  • Supplier (Example: Manufacturer facility)
AdditionalFields
object or null

Additional fields for Location. Example: Custom fields like 'SecurityClearanceRequired: true' or 'SiteAccessHours: 24/7'

number or string

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

One of
number

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

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T00:00:00Z"

When was the record created? Example: '2024-01-15T09:30:00Z'. All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>

When was the record last updated? Example: '2024-02-01T14:45:00Z'. All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer or null
Value: 1

0 = false (Example: Active location), 1 = true (Example: Demolished construction site) | This means Deleted.

Elite: This field is always 0.

Response samples

Content type
application/json
{
  • "ModelType": "Location",
  • "Id": "LOC-2024-001",
  • "Name": "Downtown Construction Site",
  • "CustomerId": "CUST-12345",
  • "Address": {
    },
  • "ContactName": "Site Manager",
  • "ContactPhone": "214-555-5678",
  • "Status": "Active",
  • "CreatedDateTime": "2024-03-15T00:00:00Z"
}

Update a single Location by Id

Supported by: Elite

Update a single Location by Id

Required fields:

  • Id
Authorizations:
ApiKey
path Parameters
LocationId
required
string
Request Body schema: application/json
required
Name
string or null [ 1 .. 255 ] characters
Default: "Downtown Construction Site"

This would map to the jobsite description in Elite. Examples:

  • 'Downtown High-Rise Project - 123 Main St'
  • 'Smith Wedding Venue - Central Park'
  • 'Airport Terminal 3 Expansion Project'
  • 'Annual Home & Garden Show - Convention Center'
  • 'Johnson Construction - Highway 40 Bridge Project'
object or null

Location address with specific delivery instructions. Examples:

  • Construction site with security checkpoint
  • Event venue with loading dock access
  • Warehouse with specific bay numbers
Type
required
string
Default: "Customer"
Value: "Customer"

Examples:

  • 'Customer' for construction site delivery location
  • 'Customer' for event venue setup location
  • 'Customer' for equipment pickup location
Line1
string or null <= 50 characters

Address Number and Street. Examples:

  • '123 Construction Way'
  • '456 Convention Center Blvd'
  • '789 Industrial Park Road'
  • '321 Event Plaza Drive'
  • '555 Development Avenue'
Line3
string or null

May be apartment, building, suite. Example: 'North Construction Zone', 'Phase 2 Area'. 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. Example: 'Los Angeles', 'New York', 'Chicago'
GeoRegion2
string or null

Example: 'South Region', 'Western Division'. 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

Example: 'Downtown District', 'Industrial Zone'. 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. Example: 'CA', 'NY', 'TX'
PostalCode
string or null <= 50 characters

May be postcode, post code, PIN or ZIP Code depending on the country. Example: '90210', 'M5V 2T6', 'SW1A 1AA'

Latitude
string or null

Latitude in decimal format. Example: '34.052235'. 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:34.052235,-118.243683

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. Example: '-118.243683'. 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:34.052235,-118.243683

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. Example: 'US', 'CA', 'GB'. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

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>

This is the date from which the location is no longer valid to be used. A location cannot be used after this date. Examples:

  • '2024-12-31T23:59:59Z' for construction project completion
  • '2024-06-30T23:59:59Z' for event venue teardown deadline
  • '2024-09-30T23:59:59Z' for temporary storage facility closure

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Currently we only support SiteDeliveryInstructions for special delivery requirements and site access information.

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. Example: 'SiteDeliveryInstructions' for specific delivery requirements and site access protocols.

Value
required
string or null

The note text. Examples:

  • 'Deliver to loading dock B between 7am-3pm only. Security check-in required at North Gate. Contact site supervisor John Smith (555-0123) upon arrival. Hard hat and safety vest required.'
  • 'Event setup must be completed by 6am. Use service elevator #2. Contact event coordinator Sarah Johnson (555-0456) for access card.'
  • 'Fork lift required for unloading. Staging area marked in yellow. Site requires proof of insurance and worker safety certification.'
  • 'No deliveries during rush hour 7-9am and 4-6pm. Weekend delivery preferred. Call security desk (555-0789) 30 minutes before arrival.'
OwnerId
string or null

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc. Examples:

  • 'CUST_12345' for ABC Construction's project site
  • 'CUST_67890' for Metropolitan Events' venue
  • 'SUPP_34567' for Equipment Manufacturing Co's facility
Array of objects

Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Examples:

  • Site office main line
  • Security desk 24/7 contact
  • Project manager's direct line
  • Loading dock coordinator
  • After-hours emergency contact
Array
Type
required
string
Default: "Default"
Value: "Default"

Supported phone types. Examples:

  • 'Default' for site office main number
  • 'Default' for security desk contact
  • 'Default' for delivery coordinator's line
Number
required
string or null

A phone number without the country code embedded. Examples:

  • '555-123-4567' for site office
  • '555-234-5678' for security desk
  • '555-345-6789' for project manager
  • '555-456-7890' for loading dock
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>

This is the date from which the location is valid to be used. A location cannot be used before this date. Examples:

  • '2024-03-15T00:00:00Z' for construction project mobilization
  • '2024-06-01T00:00:00Z' for event venue setup start
  • '2024-04-01T00:00:00Z' for warehouse opening date

Elite: Not supported.
Syrinx: Supported.

AdditionalFields
object or null

Additional fields for Location. Example: Custom fields for site-specific requirements or certifications.

Responses

Response Schema: application/json
ModelType
string
Default: "Location"
Value: "Location"

Standard field that denotes the record type. Useful for bulk ingesting different record types. Example: 'Location'

Id
string
Default: "LOC-2024-001"

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. Example: 'LOC-12345'

Name
string or null
Default: "Downtown Construction Site"

This would map to the jobsite description in Elite. Examples: 'Madison Square Garden', 'Downtown High-Rise Project', 'Smith Wedding Venue'

Identifiers
object or null

Location does not have any identifiers at this time. Future examples might include site codes or project reference numbers.

object or null
Default: {"Line1":"456 Project Site","City":"Dallas","Province":"TX","PostalCode":"75202"}

Location address. Example: A construction site address with specific delivery instructions.

Type
required
string
Default: "Customer"
Value: "Customer"

Examples include "Default", "Billing", etc. For locations, typically 'Customer' for job sites.

Name
string or null

Optional name for Address. Example: 'North Tower Entrance', 'Loading Dock B'

Line1
string or null
Default: "456 Project Site"

Address Number and Street. Example: '123 Construction Ave'

Line2
string or null

May be apartment, building, suite. Example: 'Building 4, Loading Dock'

Line3
string or null

May be apartment, building, suite. Example: 'Gate Code: #1234'. 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: "Dallas"

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. Example: 'Dallas'
GeoRegion2
string or null

Example: 'North Region'. 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

Example: 'Southwest District'. 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: "TX"

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. Example: 'TX' for Texas
PostalCode
string or null
Default: "75202"

May be postcode, post code, PIN or ZIP Code depending on the country. Example: '75201' for Dallas downtown area

Latitude
string or null

Latitude in decimal format. Example: '32.7767' for Dallas. 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:32.7767,-96.7970

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. Example: '-96.7970' for Dallas. 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:32.7767,-96.7970

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. Example: 'US' for United States, 'CA' for Canada. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

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

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>

This is the date from which the location is no longer valid to be used. Example: '2024-12-31T23:59:59Z' for a construction project ending December 31st, 2024. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Currently we only support the following types of notes

  • SiteDeliveryInstructions. Example: Special delivery instructions for a construction site.
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. Example: 'SiteDeliveryInstructions' for delivery notes.

Value
required
string or null

The note text. Example: 'Deliver to loading dock between 7am-3pm only. Contact site supervisor John at 555-0123 upon arrival.'

OwnerId
string or null

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer (Example: 'CUST-12345'), SupplierId if Type is Supplier (Example: 'SUPP-789'), etc.

Array of objects

Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Example: Site supervisor's phone, security office phone, etc.

Array
Type
required
string
Default: "Default"
Value: "Default"

Supported phone types. Example: 'Default' for primary contact number

Number
required
string or null

A phone number without the country code embedded. Example: '555-123-4567'

RemoteId
string or null
Deprecated

A 3rd party ID can be supplied here if it exists. Example: 'EXT-PHONE-789'. This is not the Point of Rental Id.

CountryCode
string or null

Country code prefix. Example: '+1' for US/Canada numbers.

Elite: Currently not supported

NumberE164
string or null

A phone number must be supplied and validated according to the E.164 format. Example: '+15551234567'. 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? Example: '123' for ext. 123. 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? Example: true for mobile numbers that can receive texts. 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>

This is the date from which the location is valid to be used. Example: '2024-03-01T00:00:00Z' for a construction project starting March 1st, 2024. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

Type
string
Enum: "Global" "Customer" "Supplier"

Location type may be one of the following.

  • Global (Example: Company warehouse)
  • Customer (Example: Construction site)
  • Supplier (Example: Manufacturer facility)
AdditionalFields
object or null

Additional fields for Location. Example: Custom fields like 'SecurityClearanceRequired: true' or 'SiteAccessHours: 24/7'

number or string

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

One of
number

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

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T00:00:00Z"

When was the record created? Example: '2024-01-15T09:30:00Z'. All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

UpdatedDateTime
string or null <date-time>

When was the record last updated? Example: '2024-02-01T14:45:00Z'. All date times are expected to be in UTC & ISO-8601 format.

Elite: This field is not supported.

Hidden
integer or null
Value: 1

0 = false (Example: Active location), 1 = true (Example: Demolished construction site) | This means Deleted.

Elite: This field is always 0.

Request samples

Content type
application/json
{
  • "Name": "Downtown Construction Site"
}

Response samples

Content type
application/json
{
  • "ModelType": "Location",
  • "Id": "LOC-2024-001",
  • "Name": "Downtown Construction Site",
  • "CustomerId": "CUST-12345",
  • "Address": {
    },
  • "ContactName": "Site Manager",
  • "ContactPhone": "214-555-5678",
  • "Status": "Active",
  • "CreatedDateTime": "2024-03-15T00:00:00Z"
}

Products

Retrieve availability for a single Product by Id

Supported by: Elite, Syrinx

Retrieve availability for a single Product by Id

Authorizations:
ApiKey
path Parameters
ProductId
required
string
query Parameters
startdate
required
string
enddate
required
string
returnSingleRecord
required
string

Responses

Response Schema: application/json
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
Default: "20T Excavator"

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

Identifiers
object or null

ProductAvailability does not have any identifiers at this time.

ProductId
string
Default: "PROD-123"

Id of product - typically includes manufacturer code and model number

ProductName
string

Name of product - typically includes brand, model, and category

Array of objects or null

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 - unique identifier for this specific unit

StockName
string

Name of stock - typically includes model and unit number

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 - when the unit becomes available

EndDateTime
string <date-time>

End date of availability - when the unit is next reserved or unavailable

AvailableQuantity
number

The current quantity available for rent or sale - for serialized equipment like excavators, typically 1 or 0

ExpectedQuantity
number

The quantity expected to be on premise including both available and unavailable units (e.g. in maintenance)

TotalQuantity
number

Total quantity owned regardless of availability - includes units in transit or at other locations

QtyExpected
number
Deprecated

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

DepotId
string
Default: "DEP-001"

The company id, store id, or depot id depending on which system you are using.

StartDateTime
string <date-time>

Start date of availability - earliest date any unit is available

EndDateTime
string <date-time>

End date of availability - latest date any unit remains available

AvailableQuantity
number
Default: 3

The current quantity available for rent or sale - sum of all available units at this depot

ExpectedQuantity
number

The quantity expected to be on premise including both available and unavailable units (e.g. in maintenance) at this depot

TotalQuantity
number
Default: 5

Total quantity owned regardless of availability - includes units in transit or at other locations

QtyExpected
number
Deprecated

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

Response samples

Content type
application/json
{
  • "ProductId": "PROD-123",
  • "Name": "20T Excavator",
  • "TotalQuantity": 5,
  • "AvailableQuantity": 3,
  • "ReservedQuantity": 1,
  • "RentedQuantity": 1,
  • "NextAvailableDate": "2024-03-20T00:00:00Z",
  • "DepotId": "DEP-001"
}

Create a Product

Create a new product in the system. This endpoint is used to create a new product in the system. The product will be created with the default values for the product type. The product will be created with the default values for the product type.

Authorizations:
ApiKey
Request Body schema: application/json
required
Name
required
string or null
Default: "Test MOdel "

The display name for the item. Should be clear and descriptive, including key specifications when relevant.

Classification
required
string
Default: "Rental"
Enum: "Rental" "Sale"

Specifies if the product is available for rental or sale. Only Rental and Sale supported for POST.

Description
required
string or null
Default: "Nodescription"

Detailed description of the product including key features, specifications, and use cases.

DepotId
required
string or null
Default: "000"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) where the equipment is located.

required
object or null
Default: {"ExternalTaxCode":"12AS","RentalType":"Rental - Header","CurrentDepotId":"000","ReorderMinimum":"2","ReorderMaximum":"3","CaseQuantity":5,"RentalCaseQuantity":2,"CriticalLevel":1,"TaxCode":14}

Additional fields for inventory management and ordering.

CaseQuantity
number or null
Default: "null"

Number of items per case for parts and consumables. Ensures orders are made in complete case quantities.

CriticalLevel
number or null
Default: "null"

Minimum stock level before reordering is required. Triggers low inventory alerts.

CurrentDepotId
string or null
Default: "000"

(Elite Only - Required) Current location/store ID where the item is stocked.

RentalCaseQuantity
number or null
Default: "null"

For rental items that come in sets (e.g., scaffold components), specifies the standard rental quantity.

ReorderMaximum
number or null
Default: "null"

Maximum quantity to stock. Prevents over-ordering of inventory.

ReorderMinimum
number or null
Default: "null"

Minimum quantity to order when restocking. Often matches supplier MOQ (Minimum Order Quantity).

TaxCode
number or null
Default: 14

Internal tax classification code. Use enumblookup/stock/TaxCode to get valid codes.

ExternalTaxCode
string or null
Default: "12AS"

Tax code for external tax service integration (e.g., Avalara, Vertex).

required
object or null
Default: {"Key":"12435","Barcode":"123","Alias":"smith"}

Identifying items for Product. Contains various codes and numbers used to track and identify the product across systems.

Key
string or null
Default: "12435"

(Required) A customer defined Id for this item. Often matches internal inventory systems.

PartNumber
string or null

The manufacturer's part number associated with this specific model.

Alias
string or null
Default: "smith"

(Elite Only) Alternative lookup field in Elite, often used for quick searches or legacy system compatibility.

Barcode
string or null
Default: "123"

(Elite Only) Barcode field in Elite, used for scanning and inventory management.

CategoryName
string or null
Default: "Audio - Video - Lighting"

Denormalized name of the Category. Elite only supports one category name. Used for display and filtering.

IsPart
boolean or null

Indicates if this is a spare part or consumable item rather than rental equipment.

Responses

Request samples

Content type
application/json
{
  • "ModelType": "Product",
  • "Name": "Test MOdel ",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Audio - Video - Lighting",
  • "Classification": "Rental",
  • "Description": "Nodescription",
  • "Images": [ ],
  • "Key": ".ACPLUG",
  • "ModelNumber": "23",
  • "ModelYear": "2025",
  • "OtherUrls": [ ],
  • "Tags": [ ],
  • "DepotId": "000",
  • "AdditionalFields": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "Product",
  • "Id": "PROD-123",
  • "Name": "20T Excavator",
  • "Description": "20-ton tracked excavator suitable for large construction projects",
  • "Category": "Heavy Equipment",
  • "Manufacturer": "CAT",
  • "Model": "320",
  • "SerialNumber": "CAT320-123456",
  • "Status": "Available",
  • "DepotId": "DEP-001",
  • "Rates": [
    ],
  • "CreatedDateTime": "2024-03-15T00:00:00Z"
}

Retrieve a list of Products

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Identifiers.Key
Authorizations:
ApiKey

Responses

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

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

Id
string
Default: "PROD-123"

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: "20T Excavator"

The display name for the item.

object or null

Identifying items for Product.

CategoryIds
Array of strings

Reference a CategoryId

CategoryName
string or null

Denormalized name of the Category.

Elite: Only supports one name.

Classification
string or null
Enum: "Rental" "Sale" "Internal"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null

(Elite Only) The department id for this product

DepartmentName
string or null

(Elite Only) The department name for this product

DepotId
string or null
Default: "DEP-001"

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

Description
string or null
Default: "20-ton tracked excavator suitable for large construction projects"

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

DisplayOrder
number or null >= 1

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

A publicly accessible link to any instructions associated with this item.

ModelName
string or null

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

OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.

ModelYear
string or null

OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.

Key
string or null
Deprecated

A customer defined Id for this item.

Deprecated: This field is being moved to Identifiers.Key.

Array of objects

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

An array of publicly accessible URLs that can be used for anything.

Elite: This field is not supported.

Tags
Array of strings

This should be an array of tags. Generally expected to be like a subcategory.

Elite: This field is not supported.

IsPart
boolean or null

Used to determine if product is a part

object or null

Additional fields for Product.

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T00:00:00Z"

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 or null
Value: 1

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

Elite: This field is not supported.

Alias
string or null
Deprecated

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated

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

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:
ApiKey

Responses

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

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.

ParentProductId
string
Default: 482

Product to which the association belongs to ie. the parent.

ChildProductId
string
Default: 62

Product that is being associated ie. the child.

AssociationType
string
Default: "Automatic"
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

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: false

Whether or not this item, which is a part of a group, should be pre-selected

DisplayOrder
number
Default: 221.06

Defines a sort order for associated products. Lowest value will appear first in the list

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 or null
Value: 1

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

Elite: This field is not supported.

Disabled
boolean or null

Whether or not the record is disabled

Quantity
number or null

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

Retrieve a single Product by Id

Authorizations:
ApiKey
path Parameters
ProductId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "Product"
Value: "Product"

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

Id
string
Default: "PROD-123"

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: "20T Excavator"

The display name for the item.

object or null

Identifying items for Product.

Key
string or null

A customer defined Id for this item.

Alias
string or null

(Elite Only) Lookup field in Elite.

Barcode
string or null

(Elite Only) Barcode field in Elite.

PartNumber
string or null

The part number associated to a specific instance of a part.

CategoryIds
Array of strings

Reference a CategoryId

CategoryName
string or null

Denormalized name of the Category.

Elite: Only supports one name.

Classification
string or null
Enum: "Rental" "Sale" "Internal"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null

(Elite Only) The department id for this product

DepartmentName
string or null

(Elite Only) The department name for this product

DepotId
string or null
Default: "DEP-001"

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

Description
string or null
Default: "20-ton tracked excavator suitable for large construction projects"

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

DisplayOrder
number or null >= 1

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

A publicly accessible link to any instructions associated with this item.

ModelName
string or null

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

OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.

ModelYear
string or null

OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.

Key
string or null
Deprecated

A customer defined Id for this item.

Deprecated: This field is being moved to Identifiers.Key.

Array of objects

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

An array of publicly accessible URLs that can be used for anything.

Elite: This field is not supported.

Tags
Array of strings

This should be an array of tags. Generally expected to be like a subcategory.

Elite: This field is not supported.

IsPart
boolean or null

Used to determine if product is a part

object or null

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

(Elite Only) The id of the current store/depot.

InternalClassificationType
string or null
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
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
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

(Elite only) This is the text field currently present on rentalhosting as additional information/info

TaxCode
number or null

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

The name of the tax code.

ExternalTaxCode
string or null

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: "2024-03-15T00:00:00Z"

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 or null
Value: 1

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

Elite: This field is not supported.

Alias
string or null
Deprecated

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated

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

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

One of
number

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

Response samples

Content type
application/json
{
  • "ModelType": "Product",
  • "Id": "PROD-123",
  • "Name": "20T Excavator",
  • "Description": "20-ton tracked excavator suitable for large construction projects",
  • "Category": "Heavy Equipment",
  • "Manufacturer": "CAT",
  • "Model": "320",
  • "SerialNumber": "CAT320-123456",
  • "Status": "Available",
  • "DepotId": "DEP-001",
  • "Rates": [
    ],
  • "CreatedDateTime": "2024-03-15T00:00:00Z"
}

Update a Product

Update a Product

Authorizations:
ApiKey
path Parameters
ProductId
required
string
Request Body schema: application/json
required
Name
required
string or null
Default: "Test MOdel "

The display name for the item. Should be clear and descriptive, including key specifications when relevant.

Classification
required
string
Default: "Rental"
Enum: "Rental" "Sale"

Specifies if the product is available for rental or sale. Only Rental and Sale supported for POST.

Description
required
string or null
Default: "Nodescription"

Detailed description of the product including key features, specifications, and use cases.

DepotId
required
string or null
Default: "000"

Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) where the equipment is located.

required
object or null
Default: {"ExternalTaxCode":"12AS","RentalType":"Rental - Header","CurrentDepotId":"000","ReorderMinimum":"2","ReorderMaximum":"3","CaseQuantity":5,"RentalCaseQuantity":2,"CriticalLevel":1,"TaxCode":14}

Additional fields for inventory management and ordering.

CaseQuantity
number or null
Default: "null"

Number of items per case for parts and consumables. Ensures orders are made in complete case quantities.

CriticalLevel
number or null
Default: "null"

Minimum stock level before reordering is required. Triggers low inventory alerts.

CurrentDepotId
string or null
Default: "000"

(Elite Only - Required) Current location/store ID where the item is stocked.

RentalCaseQuantity
number or null
Default: "null"

For rental items that come in sets (e.g., scaffold components), specifies the standard rental quantity.

ReorderMaximum
number or null
Default: "null"

Maximum quantity to stock. Prevents over-ordering of inventory.

ReorderMinimum
number or null
Default: "null"

Minimum quantity to order when restocking. Often matches supplier MOQ (Minimum Order Quantity).

TaxCode
number or null
Default: 14

Internal tax classification code. Use enumblookup/stock/TaxCode to get valid codes.

ExternalTaxCode
string or null
Default: "12AS"

Tax code for external tax service integration (e.g., Avalara, Vertex).

required
object or null
Default: {"Key":"12435","Barcode":"123","Alias":"smith"}

Identifying items for Product. Contains various codes and numbers used to track and identify the product across systems.

Key
string or null
Default: "12435"

(Required) A customer defined Id for this item. Often matches internal inventory systems.

PartNumber
string or null

The manufacturer's part number associated with this specific model.

Alias
string or null
Default: "smith"

(Elite Only) Alternative lookup field in Elite, often used for quick searches or legacy system compatibility.

Barcode
string or null
Default: "123"

(Elite Only) Barcode field in Elite, used for scanning and inventory management.

CategoryName
string or null
Default: "Audio - Video - Lighting"

Denormalized name of the Category. Elite only supports one category name. Used for display and filtering.

IsPart
boolean or null

Indicates if this is a spare part or consumable item rather than rental equipment.

Responses

Request samples

Content type
application/json
{
  • "ModelType": "Product",
  • "Name": "Test MOdel ",
  • "Identifiers": {
    },
  • "CategoryIds": [
    ],
  • "CategoryName": "Audio - Video - Lighting",
  • "Classification": "Rental",
  • "Description": "Nodescription",
  • "Images": [ ],
  • "Key": ".ACPLUG",
  • "ModelNumber": "23",
  • "ModelYear": "2025",
  • "OtherUrls": [ ],
  • "Tags": [ ],
  • "DepotId": "000",
  • "AdditionalFields": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "Product",
  • "Id": "PROD-123",
  • "Name": "20T Excavator",
  • "Description": "20-ton tracked excavator suitable for large construction projects",
  • "Category": "Heavy Equipment",
  • "Manufacturer": "CAT",
  • "Model": "320",
  • "SerialNumber": "CAT320-123456",
  • "Status": "Available",
  • "DepotId": "DEP-001",
  • "Rates": [
    ],
  • "CreatedDateTime": "2024-03-15T00:00:00Z"
}

Retrieve rates for a single Product by Id.

Supported by: Elite, Syrinx

Retrieve rates for a single Product by Id.

Authorizations:
ApiKey
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

Applicable rates are the most relevant rates, passed back as a single string with line breaks (\n).

Example #1 (Scissor Lift - raw):
"Daily Rate: $225.00 \n Weekly Rate: $675.00 \n Monthly Rate: $2025.00 \n (Includes damage waiver and environmental fees)"

Example #1 (displayed):

  • Daily Rate: $225.00
  • Weekly Rate: $675.00
  • Monthly Rate: $2025.00
  • (Includes damage waiver and environmental fees)

Example #2 (Skid Steer - raw):
"Daily: $350.00 \n (Requires additional insurance for residential use) \n Weekly: $1050.00 \n Monthly: $3150.00 \n (Delivery fees not included)"

Example #2 (displayed):

  • Daily: $350.00
  • (Requires additional insurance for residential use)
  • Weekly: $1050.00
  • Monthly: $3150.00
  • (Delivery fees not included)
Array of objects

All rates for this product whether relevant or not. This includes standard rates, special rates, and promotional rates. In most cases, you will want to use applicable rates instead. Example use cases include showing all available rate options to customers or for detailed rate comparison.

Array
PeriodName
string

The rental period name. Examples:

  • "4 Hour Rate"
  • "Daily Rate"
  • "Weekend Rate (Fri-Mon)"
  • "Weekly Rate"
  • "4 Week Rate"
  • "Monthly Rate"
  • "Long Term Rate (3+ Months)"
Rate
string or null

The rate amount as a string. Examples:

  • "89.99" (for a pressure washer daily rate)
  • "450.00" (for a mini excavator daily rate)
  • "1350.00" (for a boom lift weekly rate)
  • "4500.00" (for a large generator monthly rate)
CurrencyType
string

The three-letter ISO currency code. Examples:

  • "USD" (United States Dollar)
  • "CAD" (Canadian Dollar)
  • "GBP" (British Pound Sterling)
  • "EUR" (Euro)

Response samples

Content type
application/json
{
  • "ProductId": "PROD-123",
  • "Name": "20T Excavator",
  • "Rates": [
    ]
}

Retrieve files for a single Product by Id.

Supported by: Elite

Retrieve files for a single Product by Id.

Authorizations:
ApiKey
path Parameters
ProductId
required
string
tagKey
required
string

pdfs or instructions or photos

Responses

Response Schema: application/json
Array
FileName
string

Original local filename including extension. Common formats include PDFs for manuals and documents, JPG/PNG for photos, and MP4 for videos.

FileClass
string
Enum: "misc" "image" "video"

Defines the type of stored file: 'misc' for documents (PDFs, contracts, manuals), 'image' for equipment photos and inspection documentation, 'video' for training materials and equipment operation demonstrations.

PublicURL
string

Web URL where the stored file can be downloaded. For secure files (like signed contracts or damage reports), this is a time-limited pre-signed URL. For public files (like equipment catalogs), this may be a permanent URL.

URLDateTime
string <date-time>

The date/time when the URL was generated. Critical for secure documents where URL expiration is enforced. Used with URLExpires to calculate the exact expiration time of pre-signed URLs.

URLExpires
integer

Number of seconds from URLDateTime until URL expires. Common values: 3600 (1 hour) for sensitive documents like contracts and damage reports, 86400 (24 hours) for inspection photos, and 604800 (1 week) for public equipment manuals.

TagMapKey
string
Enum: "pdfs" "instructions" "photos"

Categorizes the file purpose: 'pdfs' for equipment manuals, safety documentation, and signed contracts; 'instructions' for safety guides, operating procedures, and maintenance checklists; 'photos' for equipment condition documentation, damage reports, and marketing images.

ObjectPrimaryKey
string

Unique identifier for the associated object. Examples: Stock numbers (STOCK-12345) for equipment units, contract numbers (RENT-789456) for rental agreements, serial numbers (CAT-336-ABC123) for specific machines, or damage report IDs (DR-456789).

ObjectType
string

Classifies the associated object: 'Products' for equipment catalog/specifications, 'stock' for specific rental fleet units, 'contract' for rental/lease agreements, 'damage' for incident reports, or 'inspection' for equipment condition reports.

Tags
Array of strings

Categorization tags for the file. Common combinations: ['inspection-photo', 'pre-rental', 'exterior'] for pre-rental documentation, ['damage-report', 'insurance', 'claim-photos'] for incident documentation, ['equipment-manual', 'safety', 'maintenance'] for technical documentation.

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:
ApiKey

Responses

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

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

Id
string
Default: "SP-001"

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. Format typically follows a UUID pattern.

Name
string or null
Default: "Jane Smith"

A display name for this record, typically combining first and last name. Often used as a summary for lookups and in dropdown menus.

object
Default: "[email protected]"

Email contact information for the sales person. The Type field indicates the primary email used for communications.

FirstName
string or null

First name of the sales person. Used for personalization in communications and internal systems.

Elite: This field is not supported.

LastName
string or null

Last name of the sales person. Used for sorting and organizing sales team members.

Elite: This field is not supported.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single SalesPerson by ID

Supported by: Elite

Retrieve a single SalesPerson by ID

Authorizations:
ApiKey
path Parameters
SalesPersonId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "SalesPerson"
Value: "SalesPerson"

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

Id
string
Default: "SP-001"

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. Format typically follows a UUID pattern.

Name
string or null
Default: "Jane Smith"

A display name for this record, typically combining first and last name. Often used as a summary for lookups and in dropdown menus.

object
Default: "[email protected]"

Email contact information for the sales person. The Type field indicates the primary email used for communications.

Type
required
string
Value: "Primary"

Indicates this is the primary email address used for all official communications, quotes, and rental agreements.

Email
required
string or null

The email address where the sales person can be contacted. Used for sending quotes, contracts, and customer communications.

FirstName
string or null

First name of the sales person. Used for personalization in communications and internal systems.

Elite: This field is not supported.

LastName
string or null

Last name of the sales person. Used for sorting and organizing sales team members.

Elite: This field is not supported.

Response samples

Content type
application/json
{
  • "ModelType": "SalesPerson",
  • "Id": "SP-001",
  • "Name": "Jane Smith",
  • "Email": "[email protected]",
  • "Phone": "214-555-9876",
  • "Status": "Active",
  • "Territory": "North Texas",
  • "CreatedDateTime": "2024-01-01T00:00:00Z"
}

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:
ApiKey
Request Body schema: application/json
required
Name
string or null
Default: "20T Excavator"

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

object or null
Default: {"PartNumber":"12345","ReorderMinimum":"2","Alias":"CAT320-123456","Barcode":"1234567890123"}

Identifying items for Stock.

InventoryNumber
string or null

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: "12345"

The part number associated to a specific instance of a part (Sales Only).

Classification
string
Default: "Sale"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepotId
string or null <= 3 characters
Default: "001"

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

IsAsset
boolean or null

Item is eligible for depreciation

LoadingRatio
integer or null

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

The manufacturer associated with a specific instance of an item.

ModelName
string or null <= 30 characters

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: "1234"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "2020"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string <= 16 characters
Default: "158"

Id of the Product this Stock belongs to (see Product endpoint).

PurchaseDateTime
string or null <date-time>

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

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

Field only required for bulk stock endpoints

SerialNumber
string or null <= 50 characters

The serial number associated with a specific instance of an item.

object or null
Default: {"ReorderMinimum":2,"ReorderMaximum":3,"CaseQuantity":5,"RentalCaseQuantity":2,"CriticalLevel":1,"GlNumber":"1234"}
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

(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

(Elite Only) Free field for customer use

UserDefined2
string or null <= 50 characters

(Elite Only) Free field for customer use

TaxCode
number or null

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

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null

Depreciation fields for Stock

DepreciationMethodCode
string or null

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

The amount of years for which the stock depreciates.

CurrentValue
number or null

The current netbook value of the stock item.

SalvageValue
number or null

The Salvageable value in terms of Depreciation.

TotalDepreciation
number or null
Default: "null"

The total depreciation for the stock item.

object or null
Deprecated

Depreciation fields for Stock

DepreciationMethodCode
string or null

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

The amount of years for which the stock depreciates.

CurrentValue
number or null

The Current Value in terms of depreciation.

SalvageValue
number or null

The Salvageable value in terms of Depreciation.

Responses

Request samples

Content type
application/json
{
  • "Name": "20T Excavator",
  • "DepotId": "001",
  • "ProductId": "158",
  • "Classification": "Sale",
  • "ModelNumber": "1234",
  • "ModelYear": "2020",
  • "Identifiers": {
    },
  • "AdditionalFields": {
    },
  • "IsPart": true
}

Response samples

Content type
application/json
{
  • "ModelType": "Stock",
  • "Id": "STK-12345",
  • "Name": "CAT 305E2 Mini Excavator #123",
  • "CategoryIds": [
    ],
  • "CategoryName": "Mini Excavators",
  • "Classification": "Rental",
  • "DepartmentId": "DEPT-EARTHMOVING",
  • "DepartmentName": "Earthmoving Equipment",
  • "DepotId": "DEPOT-DALLAS",
  • "HasFuel": true,
  • "FuelCapacity": 15.5,
  • "IsAsset": true,
  • "IsSerialized": true,
  • "IsCustomerWorkOrderItem": true,
  • "IsGenericWorkOrderItem": true,
  • "LoadingRatio": 100,
  • "Manufacturer": "Caterpillar",
  • "ModelName": "305E2",
  • "ModelNumber": "CAT305E2-2023",
  • "ModelYear": "2023",
  • "ProductId": "PROD-CAT305E2",
  • "PurchaseDateTime": "2023-01-15T08:30:00Z",
  • "PurchasePrice": 65000,
  • "Quantity": 1,
  • "SerialNumber": "CAT305E2ABC123456",
  • "Status": "Available",
  • "CreatedDateTime": "2023-01-15T08:30:00Z",
  • "UpdatedDateTime": "2023-06-15T14:30:00Z"
}

Retrieve a list of Stock records

Supported by: Elite, Syrinx

Elite supports the following fields for the Search filter:

  • Name
  • Identifiers.Key
Authorizations:
ApiKey

Responses

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

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

Id
string
Default: "STK-12345"

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: "CAT 305E2 Mini Excavator #123"

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

object or null

Identifying items for Stock.

CategoryIds
Array of strings
Default: ["CAT-EXCAVATOR-MINI"]

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName
string or null
Default: "Mini Excavators"

Denormalized name of the Category.

Classification
string
Default: "Rental"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "DEPT-EARTHMOVING"

(Elite Only) The department id for this stock item

DepartmentName
string or null
Default: "Earthmoving Equipment"

(Elite Only) The department name for this stock item

DepotId
string or null
Default: "DEPOT-DALLAS"

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: 15.5

Fuel capacity of the item

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

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
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

Used to determine if stock item is a part (Sales Only).

LoadingRatio
integer or null
Default: 100

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: "Caterpillar"

The manufacturer associated with a specific instance of an item.

ModelName
string or null
Default: "305E2"

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: "CAT305E2-2023"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "2023"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string or null
Default: "PROD-CAT305E2"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity
number or null
Default: 1

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber
string or null
Default: "CAT305E2ABC123456"

The serial number associated with a specific instance of an item.

Status
string or null
Default: "Available"
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
object or null

Depreciation fields for Stock

CreatedDateTime
string or null <date-time>
Default: "2023-01-15T08:30:00Z"

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-06-15T14:30:00Z"

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

Hidden
integer or null
Value: 1

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

Elite: This field is always 0.

number or string

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

object or null
Deprecated

Depreciation fields for Stock

Alias
string or null
Deprecated

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated

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:
ApiKey
Request Body schema: application/json
required
ContractLineItemId
required
string
Default: "CLI-2024-0472891"

The line item id of the contract that this stock item is associated with. This links the fuel to a specific piece of equipment on a rental contract.

FuelStockId
required
string
Default: "FUEL-DSL-RED-001"

The id of the fuel type added. Found either on the line item additional fields, or the fuel info response. Common types include diesel (red or clear) and gasoline.

QuantitySold
required
number
Default: 25.5

Amount of fuel added in gallons/liters (depending on region settings). For example, adding 25.5 gallons of diesel to a mini excavator.

Responses

Request samples

Content type
application/json
{
  • "ContractLineItemId": "CLI-2024-0472891",
  • "FuelStockId": "FUEL-DSL-RED-001",
  • "QuantitySold": 25.5
}

Response samples

Content type
application/json
null

Update an existing Stock record

Supported by: Elite

Update an existing Stock record by StockId

Authorizations:
ApiKey
path Parameters
StockId
required
string
Request Body schema: application/json
required
SerialNumber
string or null
Default: "null"

The unique serial number of the stock item. For equipment, this is typically the manufacturer's serial number (e.g., 'CAT0123456789' for a Caterpillar excavator). For parts or consumables without a manufacturer serial, use your internal tracking number.

object or null
Default: {"Alias":"MINI-EX-35","Barcode":"EQ-123456"}

Additional identifying information for tracking the stock item in the system

object
Default: {"TotalDepreciation":15000,"CurrentValue":30000}
TotalDepreciation
number or null
Default: "null"

The total accumulated depreciation for the stock item in your base currency. For example, if a skid steer was purchased for $45,000 and has depreciated $15,000 over 3 years, this value would be 15000.00.

CurrentValue
number or null
Default: "null"

The current book value of the stock item after depreciation (Purchase Price - Total Depreciation). For example, if a skid steer was purchased for $45,000 and has $15,000 in total depreciation, this value would be 30000.00.

object
Default: {"CaseQuantity":12,"CriticalLevel":5,"GlNumber":"15200","RentalCaseQuantity":1,"ReorderMaximum":50,"ReorderMinimum":24,"TaxCode":1,"ExternalTaxCode":"PC040100"}
CaseQuantity
number or null
Default: "null"

For parts and consumables, specifies how many items come in a standard case/box for ordering purposes. Example: If air filters come in boxes of 12, this would be 12. This prevents ordering partial cases which often have higher per-unit costs.

CriticalLevel
number or null
Default: "null"

The minimum quantity threshold that triggers a reorder alert. For example, if you need to maintain at least 5 air filters in stock to service equipment, set this to 5. When inventory drops below this number, the system will alert for reordering.

GlNumber
string or null
Default: "null"

The General Ledger account number for accounting purposes. Format typically matches your accounting system, e.g., '15200' for Equipment Assets or '12100' for Parts Inventory.

RentalCaseQuantity
number or null
Default: "null"

For rental items that are rented in sets/cases, specifies the standard rental quantity. Example: If scaffold planks are rented in bundles of 10, this would be 10.

ReorderMaximum
number or null
Default: "null"

The maximum quantity to stock. For example, if you don't want to keep more than 50 air filters in inventory due to storage space or capital constraints, set this to 50.

ReorderMinimum
number or null
Default: "null"

The minimum quantity to order when restocking. For example, if your supplier has a minimum order of 24 air filters or it's cost-effective to order at least 24 at a time, set this to 24.

TaxCode
number or null
Default: 1

The internal tax classification code. Example: 1 for standard rate, 2 for reduced rate, 0 for zero-rated items. Use enumblookup/stock/TaxCode to get valid codes.

ExternalTaxCode
string or null
Default: "PC040100"

External tax service classification code (e.g., Avalara or Vertex tax codes). Examples: 'PC040100' for construction equipment rental, 'PC040200' for tool rental, 'PC040300' for party/event equipment rental.

Responses

Response Schema: application/json
ModelType
string
Default: "Stock"
Value: "Stock"

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

Id
string
Default: "STK-12345"

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: "CAT 305E2 Mini Excavator #123"

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

object or null

Identifying items for Stock.

Alias
string or null

(Elite Only) Lookup field in Elite.

Barcode
string or null

(Elite Only) Barcode field in Elite.

InventoryNumber
string or null

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

(Elite Only) A "human readable" form of id.

PartNumber
string or null

The part number associated to a specific instance of a part (Sales Only).

CategoryIds
Array of strings
Default: ["CAT-EXCAVATOR-MINI"]

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName
string or null
Default: "Mini Excavators"

Denormalized name of the Category.

Classification
string
Default: "Rental"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "DEPT-EARTHMOVING"

(Elite Only) The department id for this stock item

DepartmentName
string or null
Default: "Earthmoving Equipment"

(Elite Only) The department name for this stock item

DepotId
string or null
Default: "DEPOT-DALLAS"

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: 15.5

Fuel capacity of the item

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

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
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

Used to determine if stock item is a part (Sales Only).

LoadingRatio
integer or null
Default: 100

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: "Caterpillar"

The manufacturer associated with a specific instance of an item.

ModelName
string or null
Default: "305E2"

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: "CAT305E2-2023"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "2023"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string or null
Default: "PROD-CAT305E2"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity
number or null
Default: 1

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber
string or null
Default: "CAT305E2ABC123456"

The serial number associated with a specific instance of an item.

Status
string or null
Default: "Available"
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
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

(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
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
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>

(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
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
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

(Elite Only) Free field for customer use

UserDefined2
string or null

(Elite Only) Free field for customer use

TaxCode
number or null

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

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null

Depreciation fields for Stock

DepreciationMethodCode
string or null

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

The current netbook value of the stock item.

SalvageValue
number or null

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-01-15T08:30:00Z"

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-06-15T14:30:00Z"

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

Hidden
integer or null
Value: 1

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

Elite: This field is always 0.

number or string

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

One of
number

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

object or null
Deprecated

Depreciation fields for Stock

DepreciationMethodCode
string or null

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

The Current Value in terms of depreciation.

SalvageValue
number or null

The Salvageable value in terms of Depreciation.

Alias
string or null
Deprecated

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Request samples

Content type
application/json
{
  • "SerialNumber": "CAT0123456789",
  • "Identifiers": {
    },
  • "Depreciation": {
    },
  • "AdditionalFields": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "Stock",
  • "Id": "STK-12345",
  • "Name": "CAT 305E2 Mini Excavator #123",
  • "CategoryIds": [
    ],
  • "CategoryName": "Mini Excavators",
  • "Classification": "Rental",
  • "DepartmentId": "DEPT-EARTHMOVING",
  • "DepartmentName": "Earthmoving Equipment",
  • "DepotId": "DEPOT-DALLAS",
  • "HasFuel": true,
  • "FuelCapacity": 15.5,
  • "IsAsset": true,
  • "IsSerialized": true,
  • "IsCustomerWorkOrderItem": true,
  • "IsGenericWorkOrderItem": true,
  • "LoadingRatio": 100,
  • "Manufacturer": "Caterpillar",
  • "ModelName": "305E2",
  • "ModelNumber": "CAT305E2-2023",
  • "ModelYear": "2023",
  • "ProductId": "PROD-CAT305E2",
  • "PurchaseDateTime": "2023-01-15T08:30:00Z",
  • "PurchasePrice": 65000,
  • "Quantity": 1,
  • "SerialNumber": "CAT305E2ABC123456",
  • "Status": "Available",
  • "CreatedDateTime": "2023-01-15T08:30:00Z",
  • "UpdatedDateTime": "2023-06-15T14:30:00Z"
}

Retrieve a single Stock record by Id

Supported by: Elite, Syrinx

Authorizations:
ApiKey
path Parameters
StockId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "Stock"
Value: "Stock"

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

Id
string
Default: "STK-12345"

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: "CAT 305E2 Mini Excavator #123"

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

object or null

Identifying items for Stock.

Alias
string or null

(Elite Only) Lookup field in Elite.

Barcode
string or null

(Elite Only) Barcode field in Elite.

InventoryNumber
string or null

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

(Elite Only) A "human readable" form of id.

PartNumber
string or null

The part number associated to a specific instance of a part (Sales Only).

CategoryIds
Array of strings
Default: ["CAT-EXCAVATOR-MINI"]

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName
string or null
Default: "Mini Excavators"

Denormalized name of the Category.

Classification
string
Default: "Rental"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "DEPT-EARTHMOVING"

(Elite Only) The department id for this stock item

DepartmentName
string or null
Default: "Earthmoving Equipment"

(Elite Only) The department name for this stock item

DepotId
string or null
Default: "DEPOT-DALLAS"

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: 15.5

Fuel capacity of the item

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

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
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

Used to determine if stock item is a part (Sales Only).

LoadingRatio
integer or null
Default: 100

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: "Caterpillar"

The manufacturer associated with a specific instance of an item.

ModelName
string or null
Default: "305E2"

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: "CAT305E2-2023"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "2023"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string or null
Default: "PROD-CAT305E2"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity
number or null
Default: 1

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber
string or null
Default: "CAT305E2ABC123456"

The serial number associated with a specific instance of an item.

Status
string or null
Default: "Available"
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
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

(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
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
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>

(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
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
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

(Elite Only) Free field for customer use

UserDefined2
string or null

(Elite Only) Free field for customer use

TaxCode
number or null

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

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null

Depreciation fields for Stock

DepreciationMethodCode
string or null

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

The current netbook value of the stock item.

SalvageValue
number or null

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-01-15T08:30:00Z"

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-06-15T14:30:00Z"

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

Hidden
integer or null
Value: 1

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

Elite: This field is always 0.

number or string

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

One of
number

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

object or null
Deprecated

Depreciation fields for Stock

DepreciationMethodCode
string or null

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

The Current Value in terms of depreciation.

SalvageValue
number or null

The Salvageable value in terms of Depreciation.

Alias
string or null
Deprecated

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Response samples

Content type
application/json
{
  • "ModelType": "Stock",
  • "Id": "STK-12345",
  • "Name": "CAT 305E2 Mini Excavator #123",
  • "CategoryIds": [
    ],
  • "CategoryName": "Mini Excavators",
  • "Classification": "Rental",
  • "DepartmentId": "DEPT-EARTHMOVING",
  • "DepartmentName": "Earthmoving Equipment",
  • "DepotId": "DEPOT-DALLAS",
  • "HasFuel": true,
  • "FuelCapacity": 15.5,
  • "IsAsset": true,
  • "IsSerialized": true,
  • "IsCustomerWorkOrderItem": true,
  • "IsGenericWorkOrderItem": true,
  • "LoadingRatio": 100,
  • "Manufacturer": "Caterpillar",
  • "ModelName": "305E2",
  • "ModelNumber": "CAT305E2-2023",
  • "ModelYear": "2023",
  • "ProductId": "PROD-CAT305E2",
  • "PurchaseDateTime": "2023-01-15T08:30:00Z",
  • "PurchasePrice": 65000,
  • "Quantity": 1,
  • "SerialNumber": "CAT305E2ABC123456",
  • "Status": "Available",
  • "CreatedDateTime": "2023-01-15T08:30:00Z",
  • "UpdatedDateTime": "2023-06-15T14:30:00Z"
}

Retrieve realtime Availability for a single Stock record by Id

Supported by: Elite, Syrinx

Retrieve realtime Availability for a single Stock record by Id

Authorizations:
ApiKey
path Parameters
StockId
required
string

Responses

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

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: "SA-12345678-90AB-CDEF"

Cannot be used for patching or lookups. A unique identifier for this availability record.

Name
string or null
Default: "CAT 305E2 #SN12345"

A display name for this record, typically combining stock name and serial number for unique items. Often used as a summary for lookups.

object or null
Default: {"Key":"MINI-EX-305E2-12345"}

Identifying items for Stock Availability, including human-readable keys used in Elite systems.

Key
string or null
Default: "MINI-EX-305E2-12345"

(Elite Only) A "human readable" form of id, often used for quick reference.

StockId
string
Default: "STK-98765432-10FE-DCBA"

Id of stock item in the inventory system. References the master stock record.

StockName
string
Default: "Caterpillar 305E2 Mini Excavator"

Name of stock item as it appears in the inventory system, typically including manufacturer and model.

SerialNumber
string or null
Default: "CAT0305E2ABCD12345"

The serial number associated with a specific instance of an item. Used for uniquely identifying serialized equipment.

DepotId
string
Default: "DEPOT-001-CHICAGO"

The company id, store id, or depot id depending on which system you are using. Identifies the physical location where the stock is held.

StartDateTime
string <date-time>
Default: "2024-03-15T08:00:00Z"

Start date of availability period. For rental equipment, this is when the item becomes available for the next rental.

EndDateTime
string <date-time>
Default: "2024-03-22T17:00:00Z"

End date of availability period. For rental equipment, this might be when the item is reserved for another rental or scheduled maintenance.

AvailableQuantity
number
Default: 1

The current quantity available for rent or sale. For serialized equipment like excavators this is typically 0 or 1. For non-serialized items like safety helmets might be larger numbers.

ExpectedQuantity
number
Default: 3

The quantity expected to be on premise for inventory counts. Includes both available and unavailable items (e.g., items needing maintenance or already reserved).

TotalQuantity
number
Default: 5

Total quantity owned regardless of availability status. Includes items in transit, at other locations, or out for repair.

QtyExpected
number
Deprecated
Default: 3

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

Response samples

Content type
application/json
{
  • "ModelType": "StockAvailability",
  • "Id": "SA-12345678-90AB-CDEF",
  • "Name": "CAT 305E2 #SN12345",
  • "Identifiers": {
    },
  • "StockId": "STK-98765432-10FE-DCBA",
  • "StockName": "Caterpillar 305E2 Mini Excavator",
  • "SerialNumber": "CAT0305E2ABCD12345",
  • "DepotId": "DEPOT-001-CHICAGO",
  • "StartDateTime": "2024-03-15T08:00:00Z",
  • "EndDateTime": "2024-03-22T17:00:00Z",
  • "AvailableQuantity": 1,
  • "ExpectedQuantity": 3,
  • "TotalQuantity": 5,
  • "QtyExpected": 3
}

Retrieve fuel info for a single Stock record by Id

Supported by: Elite

Retrieve fuel info for a single Stock record by Id

Authorizations:
ApiKey
path Parameters
StockId
required
string

Responses

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

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: "SA-12345678-90AB-CDEF"

Cannot be used for patching or lookups. A unique identifier for this availability record.

Name
string or null
Default: "CAT 305E2 #SN12345"

A display name for this record, typically combining stock name and serial number for unique items. Often used as a summary for lookups.

object or null
Default: {"Key":"MINI-EX-305E2-12345"}

Identifying items for Stock Availability, including human-readable keys used in Elite systems.

Key
string or null
Default: "MINI-EX-305E2-12345"

(Elite Only) A "human readable" form of id, often used for quick reference.

StockId
string
Default: "STK-98765432-10FE-DCBA"

Id of stock item in the inventory system. References the master stock record.

StockName
string
Default: "Caterpillar 305E2 Mini Excavator"

Name of stock item as it appears in the inventory system, typically including manufacturer and model.

SerialNumber
string or null
Default: "CAT0305E2ABCD12345"

The serial number associated with a specific instance of an item. Used for uniquely identifying serialized equipment.

DepotId
string
Default: "DEPOT-001-CHICAGO"

The company id, store id, or depot id depending on which system you are using. Identifies the physical location where the stock is held.

StartDateTime
string <date-time>
Default: "2024-03-15T08:00:00Z"

Start date of availability period. For rental equipment, this is when the item becomes available for the next rental.

EndDateTime
string <date-time>
Default: "2024-03-22T17:00:00Z"

End date of availability period. For rental equipment, this might be when the item is reserved for another rental or scheduled maintenance.

AvailableQuantity
number
Default: 1

The current quantity available for rent or sale. For serialized equipment like excavators this is typically 0 or 1. For non-serialized items like safety helmets might be larger numbers.

ExpectedQuantity
number
Default: 3

The quantity expected to be on premise for inventory counts. Includes both available and unavailable items (e.g., items needing maintenance or already reserved).

TotalQuantity
number
Default: 5

Total quantity owned regardless of availability status. Includes items in transit, at other locations, or out for repair.

QtyExpected
number
Deprecated
Default: 3

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

Response samples

Content type
application/json
{
  • "ModelType": "StockAvailability",
  • "Id": "SA-12345678-90AB-CDEF",
  • "Name": "CAT 305E2 #SN12345",
  • "Identifiers": {
    },
  • "StockId": "STK-98765432-10FE-DCBA",
  • "StockName": "Caterpillar 305E2 Mini Excavator",
  • "SerialNumber": "CAT0305E2ABCD12345",
  • "DepotId": "DEPOT-001-CHICAGO",
  • "StartDateTime": "2024-03-15T08:00:00Z",
  • "EndDateTime": "2024-03-22T17:00:00Z",
  • "AvailableQuantity": 1,
  • "ExpectedQuantity": 3,
  • "TotalQuantity": 5,
  • "QtyExpected": 3
}

Retrieve files for a single Stock by Id.

Supported by: Elite

Retrieve files for a single Stock by Id.

Authorizations:
ApiKey
path Parameters
StockId
required
string
tagKey
required
string

pdfs or instructions or photos

Responses

Response Schema: application/json
Array
FileName
string

Original local filename including extension. Common formats include PDFs for manuals and documents, JPG/PNG for photos, and MP4 for videos.

FileClass
string
Enum: "misc" "image" "video"

Defines the type of stored file: 'misc' for documents (PDFs, contracts, manuals), 'image' for equipment photos and inspection documentation, 'video' for training materials and equipment operation demonstrations.

PublicURL
string

Web URL where the stored file can be downloaded. For secure files (like signed contracts or damage reports), this is a time-limited pre-signed URL. For public files (like equipment catalogs), this may be a permanent URL.

URLDateTime
string <date-time>

The date/time when the URL was generated. Critical for secure documents where URL expiration is enforced. Used with URLExpires to calculate the exact expiration time of pre-signed URLs.

URLExpires
integer

Number of seconds from URLDateTime until URL expires. Common values: 3600 (1 hour) for sensitive documents like contracts and damage reports, 86400 (24 hours) for inspection photos, and 604800 (1 week) for public equipment manuals.

TagMapKey
string
Enum: "pdfs" "instructions" "photos"

Categorizes the file purpose: 'pdfs' for equipment manuals, safety documentation, and signed contracts; 'instructions' for safety guides, operating procedures, and maintenance checklists; 'photos' for equipment condition documentation, damage reports, and marketing images.

ObjectPrimaryKey
string

Unique identifier for the associated object. Examples: Stock numbers (STOCK-12345) for equipment units, contract numbers (RENT-789456) for rental agreements, serial numbers (CAT-336-ABC123) for specific machines, or damage report IDs (DR-456789).

ObjectType
string

Classifies the associated object: 'Products' for equipment catalog/specifications, 'stock' for specific rental fleet units, 'contract' for rental/lease agreements, 'damage' for incident reports, or 'inspection' for equipment condition reports.

Tags
Array of strings

Categorization tags for the file. Common combinations: ['inspection-photo', 'pre-rental', 'exterior'] for pre-rental documentation, ['damage-report', 'insurance', 'claim-photos'] for incident documentation, ['equipment-manual', 'safety', 'maintenance'] for technical documentation.

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:
ApiKey
path Parameters
StockId
required
string
Request Body schema: application/json
required
QuantityAdjustment
required
number
Default: 5

The quantity change to apply to the stock level. Use positive numbers for additions (e.g., +5 for receiving new units) and negative numbers for reductions (e.g., -2 for damaged units). Common scenarios: receiving new inventory (+), cycle count adjustments (+/-), damage write-offs (-), theft (-)

StockId
string
Default: "STK-12345"

The unique identifier of the Stock record being adjusted. For example: 'STK-12345' for a specific excavator's stock record or 'STK-78901' for a particular generator's stock entry.

AdjustmentReason
string or null
Default: "New shipment received - PO#45678"

Brief explanation for the stock adjustment. Examples: 'New shipment received', 'Cycle count adjustment', 'Damaged in transit', 'Annual inventory reconciliation', 'Write-off due to theft'

DepotId
string or null
Default: "DEP-001"

Location identifier where the stock adjustment is occurring. Examples: 'DEP-001' (Main Warehouse), 'STO-789' (Downtown Rental Center), 'COM-456' (West Coast Branch)

ProductId
string or null
Default: "PRD-5566"

Product identifier for the item being adjusted. Examples: 'PRD-5566' (CAT 305E2 Mini Excavator), 'PRD-7788' (Honda EU2200i Generator), 'PRD-9900' (Genie S-65 Boom Lift)

PurchaseDateTime
string or null <date-time>
Default: "2024-03-15T14:30:00Z"

The date and time when the stock was purchased. Important for depreciation calculations and warranty tracking. Format: ISO 8601 datetime

PurchasePrice
number or null
Default: 50000

The purchase price per unit in the system's base currency. Examples: 50000.00 for a mini excavator, 1200.00 for a generator, 75000.00 for a boom lift. Used for asset valuation and depreciation calculations.

Responses

Response Schema: application/json
ModelType
string
Default: "Stock"
Value: "Stock"

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

Id
string
Default: "STK-12345"

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: "CAT 305E2 Mini Excavator #123"

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

object or null

Identifying items for Stock.

Alias
string or null

(Elite Only) Lookup field in Elite.

Barcode
string or null

(Elite Only) Barcode field in Elite.

InventoryNumber
string or null

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

(Elite Only) A "human readable" form of id.

PartNumber
string or null

The part number associated to a specific instance of a part (Sales Only).

CategoryIds
Array of strings
Default: ["CAT-EXCAVATOR-MINI"]

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName
string or null
Default: "Mini Excavators"

Denormalized name of the Category.

Classification
string
Default: "Rental"
Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepartmentId
string or null
Default: "DEPT-EARTHMOVING"

(Elite Only) The department id for this stock item

DepartmentName
string or null
Default: "Earthmoving Equipment"

(Elite Only) The department name for this stock item

DepotId
string or null
Default: "DEPOT-DALLAS"

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: 15.5

Fuel capacity of the item

IsAsset
boolean or null
Default: true

Item is eligible for depreciation

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
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

Used to determine if stock item is a part (Sales Only).

LoadingRatio
integer or null
Default: 100

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: "Caterpillar"

The manufacturer associated with a specific instance of an item.

ModelName
string or null
Default: "305E2"

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: "CAT305E2-2023"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear
string or null
Default: "2023"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId
string or null
Default: "PROD-CAT305E2"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity
number or null
Default: 1

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber
string or null
Default: "CAT305E2ABC123456"

The serial number associated with a specific instance of an item.

Status
string or null
Default: "Available"
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
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

(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
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
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>

(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
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
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

(Elite Only) Free field for customer use

UserDefined2
string or null

(Elite Only) Free field for customer use

TaxCode
number or null

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

The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null

Depreciation fields for Stock

DepreciationMethodCode
string or null

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

The current netbook value of the stock item.

SalvageValue
number or null

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-01-15T08:30:00Z"

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-06-15T14:30:00Z"

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

Hidden
integer or null
Value: 1

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

Elite: This field is always 0.

number or string

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

One of
number

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

object or null
Deprecated

Depreciation fields for Stock

DepreciationMethodCode
string or null

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

The Current Value in terms of depreciation.

SalvageValue
number or null

The Salvageable value in terms of Depreciation.

Alias
string or null
Deprecated

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode
string or null
Deprecated

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Request samples

Content type
application/json
{
  • "StockId": "STK-12345",
  • "QuantityAdjustment": 5,
  • "AdjustmentReason": "New shipment received - PO#45678",
  • "DepotId": "DEP-001",
  • "ProductId": "PRD-5566",
  • "PurchaseDateTime": "2024-03-15T14:30:00Z",
  • "PurchasePrice": 50000
}

Response samples

Content type
application/json
{
  • "ModelType": "Stock",
  • "Id": "STK-12345",
  • "Name": "CAT 305E2 Mini Excavator #123",
  • "CategoryIds": [
    ],
  • "CategoryName": "Mini Excavators",
  • "Classification": "Rental",
  • "DepartmentId": "DEPT-EARTHMOVING",
  • "DepartmentName": "Earthmoving Equipment",
  • "DepotId": "DEPOT-DALLAS",
  • "HasFuel": true,
  • "FuelCapacity": 15.5,
  • "IsAsset": true,
  • "IsSerialized": true,
  • "IsCustomerWorkOrderItem": true,
  • "IsGenericWorkOrderItem": true,
  • "LoadingRatio": 100,
  • "Manufacturer": "Caterpillar",
  • "ModelName": "305E2",
  • "ModelNumber": "CAT305E2-2023",
  • "ModelYear": "2023",
  • "ProductId": "PROD-CAT305E2",
  • "PurchaseDateTime": "2023-01-15T08:30:00Z",
  • "PurchasePrice": 65000,
  • "Quantity": 1,
  • "SerialNumber": "CAT305E2ABC123456",
  • "Status": "Available",
  • "CreatedDateTime": "2023-01-15T08:30:00Z",
  • "UpdatedDateTime": "2023-06-15T14:30:00Z"
}

Retrieve work orders for a Stock record by Id

Gets all the work orders for a stock item

Authorizations:
ApiKey
path Parameters
StockId
required
string

Responses

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

Standard field that denotes the record type.

Id
string
Default: "WO-20240315-1234"

The unique identifier for this record. Format typically follows WO-YYYYMMDD-XXXX pattern.

Name
string
Default: "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service"

The display name for this record, typically combining key identifiers like work order number, customer name, and equipment. Used in lookups and displays.

StockId
string or null
Default: "STOCK-CAT320-789"

Unique identifier for the equipment/stock item being serviced

StockName
string or null
Default: "2022 CAT 320 Excavator"

Descriptive name of the equipment being serviced, including make, model, and year if applicable

DepotId
string or null
Default: "DEPOT-DALLAS-001"

Identifier for the service location or branch handling the work order

OpenDateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

UTC timestamp when work order was created/opened

CloseDateTime
string or null <date-time>
Default: "2024-03-15T16:30:00Z"

UTC timestamp when work order was completed and closed

CustomerId
string or null
Default: "CUST-ACME-001"

Reference to the customer account responsible for this work order

Status
string
Default: "Open"
Enum: "Quote" "Open" "Closed"

Current status of the work order. Quote for estimates, Open for in-progress work, Closed for completed work

Type
string or null
Default: "PM Service"

Primary classification of the work order (e.g., PM Service, Repair, Inspection)

SubType
string or null
Default: "250-Hour Service"

Secondary classification providing more detail about the type of work (e.g., 250-Hour Service, Hydraulic Repair)

Array of objects or strings or null
Array
One of
Classification
string or null
Enum: "Rental" "Sale"

Indicates if the part is for rental or sale. Internal classification doesn't apply to line items

Name
string

Descriptive name of the part including manufacturer and part number when applicable

IsBulk
boolean or null

Indicates if item is tracked in bulk quantities rather than individual units (e.g., oil, grease)

IsSerialized
boolean or null

Indicates if part requires unique serial number tracking (e.g., engines, transmissions)

ProductId
string or null

Reference to the master inventory or catalog item

PullFromStock
boolean or null

Indicates if part should be automatically deducted from inventory when added to work order

PurchasePrice
number or null

The cost price of the part to the company

Quantity
string or null

Quantity of parts used on the work order

SerialNumber
string or null

Unique identifier for serialized parts like engines or major components

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

Current status of the part in relation to the work order or rental/sale process

StockId
string or null

Reference to specific inventory item if pulled from stock

Comments
string

Additional notes about the part usage or condition

IsCustomerWO
boolean
Default: true

Indicates if this is a customer-facing work order versus internal maintenance

object or null
Default: {"LaborTypes":[{"Description":"Mechanical Labor","Value":"4.5"},{"Description":"Diagnostic Time","Value":"1.0"}]}

Details of labor hours and types performed on the work order

LaborTypes
object or null
Default: [{"Description":"Mechanical Labor","Value":"4.5"},{"Description":"Diagnostic Time","Value":"1.0"}]
Complaint
string
Default: "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump"

Detailed description of the issue identified by the technician during inspection

Cause
string
Default: "Failed seal in main hydraulic pump allowing air infiltration and internal wear"

Technical explanation of what caused the issue, updated after diagnosis

Correction
string
Default: "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions"

Detailed description of repairs performed to resolve the issue

ReportedIssue
string
Default: "Customer reports loud noise from hydraulic system and oil spots under machine"

Initial problem description as reported by customer or internal staff

OtherComments
string
Default: "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday."

Additional notes about the work order, special instructions, or follow-up requirements

Operation
string
Default: "250 Hour Preventive Maintenance Service"

Specific maintenance or repair operation to be performed. Use the "Name" field from the operations lookup endpoint (workorders/lookup/operations or workorders/lookup/consumerOperations) to display the operation to the user.

DueDateTime
string <date-time>
Default: "2024-03-17T17:00:00Z"

Deadline for completing the work order, considering customer needs and shop capacity

AssignedRemoteUserId
string
Default: "TECH-JOHN-001"

ID of the technician assigned to the work order, set by the Rental Management System

AdditionalFields
object or null
Default: {"purchaseOrderNumber":"PO-4567","warrantyCase":"WC-789","mileageReading":"1234.5"}

Custom fields for tracking additional work order information

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

UTC timestamp when the work order was initially created in the system

UpdatedDateTime
string or null <date-time>
Default: "2024-03-15T16:30:00Z"

UTC timestamp of the last modification to the work order

Hidden
integer or null
Value: 1

Flag indicating if the work order should be hidden from normal views (0=visible, 1=hidden)

Response samples

Content type
application/json
{
  • "ModelType": "WorkOrder",
  • "Id": "WO-20240315-1234",
  • "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
  • "StockId": "STOCK-CAT320-789",
  • "StockName": "2022 CAT 320 Excavator",
  • "DepotId": "DEPOT-DALLAS-001",
  • "OpenDateTime": "2024-03-15T08:00:00Z",
  • "CloseDateTime": "2024-03-15T16:30:00Z",
  • "CustomerId": "CUST-ACME-001",
  • "Status": "Open",
  • "Type": "PM Service",
  • "SubType": "250-Hour Service",
  • "IsCustomerWO": true,
  • "LaborTracking": {
    },
  • "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
  • "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
  • "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
  • "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
  • "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
  • "Operation": "250 Hour Preventive Maintenance Service",
  • "DueDateTime": "2024-03-17T17:00:00Z",
  • "AssignedRemoteUserId": "TECH-JOHN-001",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2024-03-15T08:00:00Z",
  • "UpdatedDateTime": "2024-03-15T16:30:00Z"
}

Vendors

Create a new Vendor

Supported by: Elite

Create a new Vendor

Required fields:

  • Name
Authorizations:
ApiKey
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "Equipment Supply Co"

The full name of the vendor. Could be a company or an individual. Examples:

  • 'JLG Industries' - Equipment manufacturer
  • 'Genie Lifts' - Aerial lift manufacturer
  • 'Smith's Equipment Repair' - Service provider
  • 'HD Supply' - Parts supplier
  • 'Bob Johnson' - Independent contractor
object or null

Identifying items for Vendor. Examples:

  • AccountNumber: 'CAT-12345' for Caterpillar vendor account
  • AccountNumber: 'JLG-789' for JLG Industries account
  • ExternalVendorId: 'SUP-789' for parts supplier in third-party system
  • ExternalVendorId: 'REP-456' for repair vendor in external system
AccountNumber
string or null <= 50 characters

Vendor Account Number. Examples:

  • 'V-1001' - Standard vendor account
  • 'BOBCAT-456' - Bobcat manufacturer account
  • 'HD-789' - Home Depot supplier account
  • 'GEN-234' - Genie manufacturer account
  • 'NAPA-567' - NAPA Auto Parts account
ExternalVendorId
string or null <= 100 characters

External identification related to the vendor. Examples:

  • 'SAP-V789' - SAP system reference
  • 'QB-V456' - QuickBooks reference
  • 'NS-V123' - NetSuite reference
  • 'SF-V890' - Salesforce reference

Elite: 2021.16.0+

Array of objects

Supported types will depend on the product. Examples:

  • Default address for Caterpillar's parts distribution center
  • Billing address for JLG's accounts receivable department
  • Shipping address for Genie's main warehouse
  • Service center address for local repair vendor

Elite:

  • Supported: "Default"
  • Coming soon: "Billing", "Shipping"
Array
Type
required
string
Default: "Default"
Value: "Default"

Type of address. Examples:

  • 'Default' for primary business address
  • 'Billing' for accounts payable office
  • 'Shipping' for receiving warehouse
Name
string or null

Optional name for Address. Examples:

  • 'Main Warehouse'
  • 'Corporate HQ'
  • 'Distribution Center'
  • 'West Coast Service Center'
  • 'Parts Department'
Line1
string or null <= 50 characters

Address Number and Street. Examples:

  • '100 Main Street'
  • '1234 Industrial Parkway'
  • '567 Commerce Drive'
  • '789 Equipment Lane'
  • '321 Service Road'
Line2
string or null <= 50 characters

May be apartment, building, suite. Examples:

  • 'Suite 200' - Corporate office
  • 'Building B' - Warehouse complex
  • 'Unit 45' - Industrial park
  • 'Bay 12' - Service center
  • 'Floor 3' - Parts department
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. Examples:
  • 'Houston' - Major industrial hub
  • 'Los Angeles' - West coast distribution center
  • 'Chicago' - Midwest headquarters
  • 'Atlanta' - Southeast service center
  • 'Dallas' - Regional office
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. Examples:
  • 'TX' - Texas locations
  • 'CA' - California branches
  • 'IL' - Illinois facilities
  • 'ON' - Ontario, Canada operations
  • 'BC' - British Columbia warehouses
PostalCode
string or null <= 10 characters

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

  • '77002' - Houston, TX industrial area
  • '90012' - Los Angeles, CA downtown
  • 'M5V 2L7' - Toronto, ON business district
  • 'SW1A 1AA' - London, UK office
  • '100-0005' - Tokyo, Japan location
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

Name and Types of Contacts related to the Vendor. Examples:

  • Primary purchasing contact at Caterpillar
  • Accounts payable contact at JLG
  • Service coordinator at local repair shop
  • Parts department manager
  • Regional sales representative
Array
Type
required
string
Default: "Default"
Enum: "Default" "Secondary"

Relationship of the contact to the vendor. Example: 'Default' for primary contact, 'Secondary' for backup contact

required
object
CurrencyCode
string or null
Default: "USD"

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

  • 'USD' - US Dollar for domestic vendors
  • 'CAD' - Canadian Dollar for Canadian suppliers
  • 'EUR' - Euro for European manufacturers
  • 'GBP' - British Pound for UK vendors
  • 'JPY' - Japanese Yen for Japanese suppliers

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

Used to denote whether a vendor is considered active. Examples:

  • true - Vendor no longer in business
  • true - Contract terminated
  • false - Current active supplier
  • false - Regular service provider
  • true - Seasonal vendor during off-season
Array of objects

Any comments or notes. Examples:

  • Preferred shipping instructions
  • Special payment terms
  • Quality control requirements
  • Service level agreements
  • Warranty information
Array
Value
required
string or null

The note text.

Array of objects
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

Billing terms for the vendor. Examples:

  • 'Net 30' - Standard 30-day payment terms
  • 'Net 60' - Extended payment period
  • '2% 10 Net 30' - 2% discount if paid within 10 days
  • 'COD' - Cash on delivery
  • 'Due Upon Receipt' - Immediate payment required
object or null

Additional fields specific to each vendor. Examples include:

  • Payment methods (ACH, check, credit card)
  • Term days for billing
  • Preferred delivery days
  • Quality rating
  • Vendor category
PaymentMethod
string or null

(Elite Only) Payment methods for this vendor. Examples:

  • 'ACH' - Direct bank transfer
  • 'Check' - Paper check payment
  • 'Credit Card' - Corporate card payment
  • 'Wire Transfer' - International payment
  • 'PayPal' - Digital payment

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

(Elite Only) Billing term days for the vendor. Examples:

  • 30 - Standard Net 30 terms
  • 60 - Extended Net 60 terms
  • 15 - Quick payment terms
  • 45 - Custom payment period
  • 90 - Long-term payment arrangement

Elite: 2021.16.0+
Syrinx: Not supported.

Responses

Request samples

Content type
application/json
{
  • "Name": "Equipment Supply Co",
  • "VendorNumber": "V1234",
  • "TaxId": "12-3456789",
  • "Address": {
    },
  • "ContactName": "Bob Johnson",
  • "ContactEmail": "[email protected]",
  • "ContactPhone": "214-555-4321",
  • "PaymentTerms": "NET30"
}

Response samples

Content type
application/json
{
  • "ModelType": "Vendor",
  • "Id": "VEN-001",
  • "Name": "Equipment Supply Co",
  • "VendorNumber": "V1234",
  • "TaxId": "12-3456789",
  • "Address": {
    },
  • "ContactName": "Bob Johnson",
  • "ContactEmail": "[email protected]",
  • "ContactPhone": "214-555-4321",
  • "PaymentTerms": "NET30",
  • "Status": "Active",
  • "CreatedDateTime": "2024-01-01T00:00:00Z"
}

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:
ApiKey

Responses

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

Standard field that denotes the record type. Always set to "Vendor" for vendor records. Example: "Vendor"

Id
string
Default: "VEN-001"

The unique identifier for this vendor record. Format is typically 'VEN-' followed by numbers. Examples: "VEN-12345", "VEN-98765", "VEN-10001"

Name
string or null
Default: "Equipment Supply Co"

The full legal name of the vendor. Could be a company or an individual. Examples:

  • "Caterpillar Equipment Supply Co."
  • "John's Parts & Service LLC"
  • "United Rentals"
  • "Bob Smith Equipment Repair"
  • "JLG Industries, Inc."
object or null

Identifying items for Vendor.

Examples: { "AccountNumber": "CAT-001", "ExternalVendorId": "SUPPLIER-123" }

{ "AccountNumber": "JLG-2023", "ExternalVendorId": "JLG-DIST-456" }

{ "AccountNumber": "PARTS-789", "ExternalVendorId": "VENDOR-789"

Array of objects

Physical locations associated with the vendor. Each vendor must have at least one Default address.

Example for a major equipment manufacturer: [ { "Type": "Default", "Name": "Corporate Headquarters", "Line1": "100 Main Street", "Line2": "Suite 500", "City": "Irving", "Province": "TX", "PostalCode": "75014" } ]

Example for a local repair shop: [ { "Type": "Default", "Name": "Shop Location", "Line1": "1234 Industrial Blvd", "City": "Fort Worth", "Province": "TX", "PostalCode": "76106" } ]

Array of objects

Key personnel associated with the vendor.

Example for a parts supplier: [ { "Type": "Default", "Contact": { "ModelType": "VendorContact", "Name": "John Smith", "FirstName": "John", "LastName": "Smith", "Title": "Parts Manager", "Emails": [{ "Type": "Default", "Email": "john.smith@partsupplier.com" }], "Phones": [{ "Type": "Default", "Number": "214-555-0123", "Extension": "101" }] } }, { "Type": "Secondary", "Contact": { "ModelType": "VendorContact", "Name": "Sarah Johnson", "FirstName": "Sarah", "LastName": "Johnson", "Title": "Account Representative", "Emails": [{ "Type": "Default", "Email": "sarah.johnson@partsupplier.com" }], "Phones": [{ "Type": "Default", "Number": "214-555-0124" }] } } ]

CurrencyCode
string or null
Default: "USD"

The currency used for transactions with this vendor. Uses ISO 4217 format. Common Examples:

  • "USD" (United States Dollar)
  • "CAD" (Canadian Dollar)
  • "GBP" (British Pound)
  • "EUR" (Euro)
  • "AUD" (Australian Dollar)
Inactive
boolean or null

Indicates if the vendor is currently active in your system. Examples:

  • false (Active vendors like current suppliers)
  • true (Inactive vendors like discontinued suppliers or closed businesses)
Array of objects

Important information about the vendor relationship.

Examples: [ { "Type": "Default", "Value": "Preferred vendor for Caterpillar parts. Net 30 payment terms approved. Provides 24/7 emergency service." }, { "Type": "Default", "Value": "Bulk order discounts available for orders over $5000. Contact Sarah for special pricing." } ]

Array of objects

Contact numbers for the vendor organization.

Example for a major supplier: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123", "Extension": "101", "NumberE164": "+12145550123" }, { "Type": "Mobile", "CountryCode": "1", "Number": "214-555-0124", "NumberE164": "+12145550124" }, { "Type": "Secondary", "CountryCode": "1", "Number": "800-555-0125", "NumberE164": "+18005550125", "Extension": "200" } ]

Terms
string or null

Payment terms agreed with the vendor. Common Examples:

  • "Net 30" (Payment due within 30 days)
  • "Net 60" (Payment due within 60 days)
  • "2% 10 Net 30" (2% discount if paid within 10 days, otherwise full payment due in 30 days)
  • "Due on Receipt" (Immediate payment required)
  • "COD" (Cash on Delivery)
object or null

Additional vendor-specific information.

Examples: { "PaymentMethod": "ACH", "TermDays": 30 }

{ "PaymentMethod": "Credit Card", "TermDays": 0 }

{ "PaymentMethod": "Check", "TermDays": 60 }

CreatedDateTime
string or null <date-time>
Default: "2024-01-01T00:00:00Z"

UTC timestamp when the vendor record was created. Examples:

  • "2023-01-15T14:30:00Z" (Created January 15, 2023 at 2:30 PM UTC)
  • "2023-06-30T09:15:30Z" (Created June 30, 2023 at 9:15 AM UTC)
  • "2023-12-01T00:00:00Z" (Created December 1, 2023 at midnight UTC)
UpdatedDateTime
string or null <date-time>

UTC timestamp of the last update to the vendor record. Examples:

  • "2023-07-15T16:45:00Z" (Updated July 15, 2023 at 4:45 PM UTC)
  • "2023-08-22T11:30:15Z" (Updated August 22, 2023 at 11:30 AM UTC)
  • "2023-09-01T08:00:00Z" (Updated September 1, 2023 at 8:00 AM UTC)
Hidden
integer or null
Value: 1

Indicates if the vendor record is hidden/deleted (1) or visible/active (0). Examples:

  • 0 (Active vendor record)
  • 1 (Deleted or archived vendor record)

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single Vendor by Id

Supported by: Elite, Syrinx

Authorizations:
ApiKey
path Parameters
VendorId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "Vendor"
Value: "Vendor"

Standard field that denotes the record type. Always set to "Vendor" for vendor records. Example: "Vendor"

Id
string
Default: "VEN-001"

The unique identifier for this vendor record. Format is typically 'VEN-' followed by numbers. Examples: "VEN-12345", "VEN-98765", "VEN-10001"

Name
string or null
Default: "Equipment Supply Co"

The full legal name of the vendor. Could be a company or an individual. Examples:

  • "Caterpillar Equipment Supply Co."
  • "John's Parts & Service LLC"
  • "United Rentals"
  • "Bob Smith Equipment Repair"
  • "JLG Industries, Inc."
object or null

Identifying items for Vendor.

Examples: { "AccountNumber": "CAT-001", "ExternalVendorId": "SUPPLIER-123" }

{ "AccountNumber": "JLG-2023", "ExternalVendorId": "JLG-DIST-456" }

{ "AccountNumber": "PARTS-789", "ExternalVendorId": "VENDOR-789"

AccountNumber
string or null

Vendor Account Number - typically used for accounting and vendor management. Examples:

  • "CAT-001" (Caterpillar vendor)
  • "JLG-2023" (JLG distributor)
  • "PARTS-789" (Parts supplier)
  • "REPAIR-456" (Repair service vendor)
ExternalVendorId
string or null

External identification related to the vendor, often used for integration with other systems. Examples:

  • "SUPPLIER-123" (General supplier ID)
  • "JLG-DIST-456" (JLG distributor ID)
  • "CAT-DEALER-789" (Caterpillar dealer ID)
  • "REPAIR-TECH-101" (Repair technician ID)
Array of objects

Physical locations associated with the vendor. Each vendor must have at least one Default address.

Example for a major equipment manufacturer: [ { "Type": "Default", "Name": "Corporate Headquarters", "Line1": "100 Main Street", "Line2": "Suite 500", "City": "Irving", "Province": "TX", "PostalCode": "75014" } ]

Example for a local repair shop: [ { "Type": "Default", "Name": "Shop Location", "Line1": "1234 Industrial Blvd", "City": "Fort Worth", "Province": "TX", "PostalCode": "76106" } ]

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

Key personnel associated with the vendor.

Example for a parts supplier: [ { "Type": "Default", "Contact": { "ModelType": "VendorContact", "Name": "John Smith", "FirstName": "John", "LastName": "Smith", "Title": "Parts Manager", "Emails": [{ "Type": "Default", "Email": "john.smith@partsupplier.com" }], "Phones": [{ "Type": "Default", "Number": "214-555-0123", "Extension": "101" }] } }, { "Type": "Secondary", "Contact": { "ModelType": "VendorContact", "Name": "Sarah Johnson", "FirstName": "Sarah", "LastName": "Johnson", "Title": "Account Representative", "Emails": [{ "Type": "Default", "Email": "sarah.johnson@partsupplier.com" }], "Phones": [{ "Type": "Default", "Number": "214-555-0124" }] } } ]

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

Relationship of the contact to the vendor.

required
object
CurrencyCode
string or null
Default: "USD"

The currency used for transactions with this vendor. Uses ISO 4217 format. Common Examples:

  • "USD" (United States Dollar)
  • "CAD" (Canadian Dollar)
  • "GBP" (British Pound)
  • "EUR" (Euro)
  • "AUD" (Australian Dollar)
Inactive
boolean or null

Indicates if the vendor is currently active in your system. Examples:

  • false (Active vendors like current suppliers)
  • true (Inactive vendors like discontinued suppliers or closed businesses)
Array of objects

Important information about the vendor relationship.

Examples: [ { "Type": "Default", "Value": "Preferred vendor for Caterpillar parts. Net 30 payment terms approved. Provides 24/7 emergency service." }, { "Type": "Default", "Value": "Bulk order discounts available for orders over $5000. Contact Sarah for special pricing." } ]

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

Contact numbers for the vendor organization.

Example for a major supplier: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123", "Extension": "101", "NumberE164": "+12145550123" }, { "Type": "Mobile", "CountryCode": "1", "Number": "214-555-0124", "NumberE164": "+12145550124" }, { "Type": "Secondary", "CountryCode": "1", "Number": "800-555-0125", "NumberE164": "+18005550125", "Extension": "200" } ]

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

Payment terms agreed with the vendor. Common Examples:

  • "Net 30" (Payment due within 30 days)
  • "Net 60" (Payment due within 60 days)
  • "2% 10 Net 30" (2% discount if paid within 10 days, otherwise full payment due in 30 days)
  • "Due on Receipt" (Immediate payment required)
  • "COD" (Cash on Delivery)
object or null

Additional vendor-specific information.

Examples: { "PaymentMethod": "ACH", "TermDays": 30 }

{ "PaymentMethod": "Credit Card", "TermDays": 0 }

{ "PaymentMethod": "Check", "TermDays": 60 }

PaymentMethod
string or null

Preferred payment method for this vendor. Common Examples:

  • "ACH" (Direct bank transfer)
  • "Check" (Paper check)
  • "Credit Card" (Corporate credit card)
  • "Wire Transfer" (International wire)
  • "EFT" (Electronic Funds Transfer)
TermDays
integer or null

Number of days until payment is due. Common Examples:

  • 0 (Due immediately)
  • 30 (Net 30 terms)
  • 60 (Net 60 terms)
  • 90 (Net 90 terms)
  • 15 (Net 15 terms)
CreatedDateTime
string or null <date-time>
Default: "2024-01-01T00:00:00Z"

UTC timestamp when the vendor record was created. Examples:

  • "2023-01-15T14:30:00Z" (Created January 15, 2023 at 2:30 PM UTC)
  • "2023-06-30T09:15:30Z" (Created June 30, 2023 at 9:15 AM UTC)
  • "2023-12-01T00:00:00Z" (Created December 1, 2023 at midnight UTC)
UpdatedDateTime
string or null <date-time>

UTC timestamp of the last update to the vendor record. Examples:

  • "2023-07-15T16:45:00Z" (Updated July 15, 2023 at 4:45 PM UTC)
  • "2023-08-22T11:30:15Z" (Updated August 22, 2023 at 11:30 AM UTC)
  • "2023-09-01T08:00:00Z" (Updated September 1, 2023 at 8:00 AM UTC)
Hidden
integer or null
Value: 1

Indicates if the vendor record is hidden/deleted (1) or visible/active (0). Examples:

  • 0 (Active vendor record)
  • 1 (Deleted or archived vendor record)

Response samples

Content type
application/json
{
  • "ModelType": "Vendor",
  • "Id": "VEN-001",
  • "Name": "Equipment Supply Co",
  • "VendorNumber": "V1234",
  • "TaxId": "12-3456789",
  • "Address": {
    },
  • "ContactName": "Bob Johnson",
  • "ContactEmail": "[email protected]",
  • "ContactPhone": "214-555-4321",
  • "PaymentTerms": "NET30",
  • "Status": "Active",
  • "CreatedDateTime": "2024-01-01T00:00:00Z"
}

Update a single Vendor by Id

Supported by: Elite

Update a single Vendor by Id

Required fields:

  • Id
Authorizations:
ApiKey
path Parameters
VendorId
required
string
Request Body schema: application/json
required
Name
string or null [ 1 .. 50 ] characters
Default: "Equipment Supply Co"

The full name of the vendor. Could be a company or an individual. Examples:

  • 'JLG Industries' - Equipment manufacturer
  • 'Genie Lifts' - Aerial lift manufacturer
  • 'Smith's Equipment Repair' - Service provider
  • 'HD Supply' - Parts supplier
  • 'Bob Johnson' - Independent contractor
object or null

Identifying items for Vendor. Examples:

  • AccountNumber: 'CAT-12345' for Caterpillar vendor account
  • AccountNumber: 'JLG-789' for JLG Industries account
  • ExternalVendorId: 'SUP-789' for parts supplier in third-party system
  • ExternalVendorId: 'REP-456' for repair vendor in external system
AccountNumber
string or null <= 50 characters

Vendor Account Number. Examples:

  • 'V-1001' - Standard vendor account
  • 'BOBCAT-456' - Bobcat manufacturer account
  • 'HD-789' - Home Depot supplier account
  • 'GEN-234' - Genie manufacturer account
  • 'NAPA-567' - NAPA Auto Parts account
ExternalVendorId
string or null <= 100 characters

External identification related to the vendor. Examples:

  • 'SAP-V789' - SAP system reference
  • 'QB-V456' - QuickBooks reference
  • 'NS-V123' - NetSuite reference
  • 'SF-V890' - Salesforce reference

Elite: 2021.16.0+

Array of objects

Supported types will depend on the product. Examples:

  • Default address for Caterpillar's parts distribution center
  • Billing address for JLG's accounts receivable department
  • Shipping address for Genie's main warehouse
  • Service center address for local repair vendor

Elite:

  • Supported: "Default"
  • Coming soon: "Billing", "Shipping"
Array
Type
required
string
Default: "Default"
Value: "Default"

Type of address. Examples:

  • 'Default' for primary business address
  • 'Billing' for accounts payable office
  • 'Shipping' for receiving warehouse
Name
string or null

Optional name for Address. Examples:

  • 'Main Warehouse'
  • 'Corporate HQ'
  • 'Distribution Center'
  • 'West Coast Service Center'
  • 'Parts Department'
Line1
string or null <= 50 characters

Address Number and Street. Examples:

  • '100 Main Street'
  • '1234 Industrial Parkway'
  • '567 Commerce Drive'
  • '789 Equipment Lane'
  • '321 Service Road'
Line2
string or null <= 50 characters

May be apartment, building, suite. Examples:

  • 'Suite 200' - Corporate office
  • 'Building B' - Warehouse complex
  • 'Unit 45' - Industrial park
  • 'Bay 12' - Service center
  • 'Floor 3' - Parts department
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. Examples:
  • 'Houston' - Major industrial hub
  • 'Los Angeles' - West coast distribution center
  • 'Chicago' - Midwest headquarters
  • 'Atlanta' - Southeast service center
  • 'Dallas' - Regional office
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. Examples:
  • 'TX' - Texas locations
  • 'CA' - California branches
  • 'IL' - Illinois facilities
  • 'ON' - Ontario, Canada operations
  • 'BC' - British Columbia warehouses
PostalCode
string or null <= 10 characters

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

  • '77002' - Houston, TX industrial area
  • '90012' - Los Angeles, CA downtown
  • 'M5V 2L7' - Toronto, ON business district
  • 'SW1A 1AA' - London, UK office
  • '100-0005' - Tokyo, Japan location
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

Name and Types of Contacts related to the Vendor. Examples:

  • Primary purchasing contact at Caterpillar
  • Accounts payable contact at JLG
  • Service coordinator at local repair shop
  • Parts department manager
  • Regional sales representative
Array
Type
required
string
Default: "Default"
Enum: "Default" "Secondary"

Relationship of the contact to the vendor. Example: 'Default' for primary contact, 'Secondary' for backup contact

required
object
CurrencyCode
string or null
Default: "USD"

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

  • 'USD' - US Dollar for domestic vendors
  • 'CAD' - Canadian Dollar for Canadian suppliers
  • 'EUR' - Euro for European manufacturers
  • 'GBP' - British Pound for UK vendors
  • 'JPY' - Japanese Yen for Japanese suppliers

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

Used to denote whether a vendor is considered active. Examples:

  • true - Vendor no longer in business
  • true - Contract terminated
  • false - Current active supplier
  • false - Regular service provider
  • true - Seasonal vendor during off-season
Array of objects

Any comments or notes. Examples:

  • Preferred shipping instructions
  • Special payment terms
  • Quality control requirements
  • Service level agreements
  • Warranty information
Array
Value
required
string or null

The note text.

Array of objects
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

Billing terms for the vendor. Examples:

  • 'Net 30' - Standard 30-day payment terms
  • 'Net 60' - Extended payment period
  • '2% 10 Net 30' - 2% discount if paid within 10 days
  • 'COD' - Cash on delivery
  • 'Due Upon Receipt' - Immediate payment required
object or null

Additional fields specific to each vendor. Examples include:

  • Payment methods (ACH, check, credit card)
  • Term days for billing
  • Preferred delivery days
  • Quality rating
  • Vendor category
PaymentMethod
string or null

(Elite Only) Payment methods for this vendor. Examples:

  • 'ACH' - Direct bank transfer
  • 'Check' - Paper check payment
  • 'Credit Card' - Corporate card payment
  • 'Wire Transfer' - International payment
  • 'PayPal' - Digital payment

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

(Elite Only) Billing term days for the vendor. Examples:

  • 30 - Standard Net 30 terms
  • 60 - Extended Net 60 terms
  • 15 - Quick payment terms
  • 45 - Custom payment period
  • 90 - Long-term payment arrangement

Elite: 2021.16.0+
Syrinx: Not supported.

Responses

Response Schema: application/json
ModelType
string
Default: "Vendor"
Value: "Vendor"

Standard field that denotes the record type. Always set to "Vendor" for vendor records. Example: "Vendor"

Id
string
Default: "VEN-001"

The unique identifier for this vendor record. Format is typically 'VEN-' followed by numbers. Examples: "VEN-12345", "VEN-98765", "VEN-10001"

Name
string or null
Default: "Equipment Supply Co"

The full legal name of the vendor. Could be a company or an individual. Examples:

  • "Caterpillar Equipment Supply Co."
  • "John's Parts & Service LLC"
  • "United Rentals"
  • "Bob Smith Equipment Repair"
  • "JLG Industries, Inc."
object or null

Identifying items for Vendor.

Examples: { "AccountNumber": "CAT-001", "ExternalVendorId": "SUPPLIER-123" }

{ "AccountNumber": "JLG-2023", "ExternalVendorId": "JLG-DIST-456" }

{ "AccountNumber": "PARTS-789", "ExternalVendorId": "VENDOR-789"

AccountNumber
string or null

Vendor Account Number - typically used for accounting and vendor management. Examples:

  • "CAT-001" (Caterpillar vendor)
  • "JLG-2023" (JLG distributor)
  • "PARTS-789" (Parts supplier)
  • "REPAIR-456" (Repair service vendor)
ExternalVendorId
string or null

External identification related to the vendor, often used for integration with other systems. Examples:

  • "SUPPLIER-123" (General supplier ID)
  • "JLG-DIST-456" (JLG distributor ID)
  • "CAT-DEALER-789" (Caterpillar dealer ID)
  • "REPAIR-TECH-101" (Repair technician ID)
Array of objects

Physical locations associated with the vendor. Each vendor must have at least one Default address.

Example for a major equipment manufacturer: [ { "Type": "Default", "Name": "Corporate Headquarters", "Line1": "100 Main Street", "Line2": "Suite 500", "City": "Irving", "Province": "TX", "PostalCode": "75014" } ]

Example for a local repair shop: [ { "Type": "Default", "Name": "Shop Location", "Line1": "1234 Industrial Blvd", "City": "Fort Worth", "Province": "TX", "PostalCode": "76106" } ]

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

Key personnel associated with the vendor.

Example for a parts supplier: [ { "Type": "Default", "Contact": { "ModelType": "VendorContact", "Name": "John Smith", "FirstName": "John", "LastName": "Smith", "Title": "Parts Manager", "Emails": [{ "Type": "Default", "Email": "john.smith@partsupplier.com" }], "Phones": [{ "Type": "Default", "Number": "214-555-0123", "Extension": "101" }] } }, { "Type": "Secondary", "Contact": { "ModelType": "VendorContact", "Name": "Sarah Johnson", "FirstName": "Sarah", "LastName": "Johnson", "Title": "Account Representative", "Emails": [{ "Type": "Default", "Email": "sarah.johnson@partsupplier.com" }], "Phones": [{ "Type": "Default", "Number": "214-555-0124" }] } } ]

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

Relationship of the contact to the vendor.

required
object
CurrencyCode
string or null
Default: "USD"

The currency used for transactions with this vendor. Uses ISO 4217 format. Common Examples:

  • "USD" (United States Dollar)
  • "CAD" (Canadian Dollar)
  • "GBP" (British Pound)
  • "EUR" (Euro)
  • "AUD" (Australian Dollar)
Inactive
boolean or null

Indicates if the vendor is currently active in your system. Examples:

  • false (Active vendors like current suppliers)
  • true (Inactive vendors like discontinued suppliers or closed businesses)
Array of objects

Important information about the vendor relationship.

Examples: [ { "Type": "Default", "Value": "Preferred vendor for Caterpillar parts. Net 30 payment terms approved. Provides 24/7 emergency service." }, { "Type": "Default", "Value": "Bulk order discounts available for orders over $5000. Contact Sarah for special pricing." } ]

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

Contact numbers for the vendor organization.

Example for a major supplier: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123", "Extension": "101", "NumberE164": "+12145550123" }, { "Type": "Mobile", "CountryCode": "1", "Number": "214-555-0124", "NumberE164": "+12145550124" }, { "Type": "Secondary", "CountryCode": "1", "Number": "800-555-0125", "NumberE164": "+18005550125", "Extension": "200" } ]

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

Payment terms agreed with the vendor. Common Examples:

  • "Net 30" (Payment due within 30 days)
  • "Net 60" (Payment due within 60 days)
  • "2% 10 Net 30" (2% discount if paid within 10 days, otherwise full payment due in 30 days)
  • "Due on Receipt" (Immediate payment required)
  • "COD" (Cash on Delivery)
object or null

Additional vendor-specific information.

Examples: { "PaymentMethod": "ACH", "TermDays": 30 }

{ "PaymentMethod": "Credit Card", "TermDays": 0 }

{ "PaymentMethod": "Check", "TermDays": 60 }

PaymentMethod
string or null

Preferred payment method for this vendor. Common Examples:

  • "ACH" (Direct bank transfer)
  • "Check" (Paper check)
  • "Credit Card" (Corporate credit card)
  • "Wire Transfer" (International wire)
  • "EFT" (Electronic Funds Transfer)
TermDays
integer or null

Number of days until payment is due. Common Examples:

  • 0 (Due immediately)
  • 30 (Net 30 terms)
  • 60 (Net 60 terms)
  • 90 (Net 90 terms)
  • 15 (Net 15 terms)
CreatedDateTime
string or null <date-time>
Default: "2024-01-01T00:00:00Z"

UTC timestamp when the vendor record was created. Examples:

  • "2023-01-15T14:30:00Z" (Created January 15, 2023 at 2:30 PM UTC)
  • "2023-06-30T09:15:30Z" (Created June 30, 2023 at 9:15 AM UTC)
  • "2023-12-01T00:00:00Z" (Created December 1, 2023 at midnight UTC)
UpdatedDateTime
string or null <date-time>

UTC timestamp of the last update to the vendor record. Examples:

  • "2023-07-15T16:45:00Z" (Updated July 15, 2023 at 4:45 PM UTC)
  • "2023-08-22T11:30:15Z" (Updated August 22, 2023 at 11:30 AM UTC)
  • "2023-09-01T08:00:00Z" (Updated September 1, 2023 at 8:00 AM UTC)
Hidden
integer or null
Value: 1

Indicates if the vendor record is hidden/deleted (1) or visible/active (0). Examples:

  • 0 (Active vendor record)
  • 1 (Deleted or archived vendor record)

Request samples

Content type
application/json
{
  • "Name": "Equipment Supply Co",
  • "VendorNumber": "V1234",
  • "TaxId": "12-3456789",
  • "Address": {
    },
  • "ContactName": "Bob Johnson",
  • "ContactEmail": "[email protected]",
  • "ContactPhone": "214-555-4321",
  • "PaymentTerms": "NET30"
}

Response samples

Content type
application/json
{
  • "ModelType": "Vendor",
  • "Id": "VEN-001",
  • "Name": "Equipment Supply Co",
  • "VendorNumber": "V1234",
  • "TaxId": "12-3456789",
  • "Address": {
    },
  • "ContactName": "Bob Johnson",
  • "ContactEmail": "[email protected]",
  • "ContactPhone": "214-555-4321",
  • "PaymentTerms": "NET30",
  • "Status": "Active",
  • "CreatedDateTime": "2024-01-01T00:00:00Z"
}

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:
ApiKey
path Parameters
field
required
string

Responses

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

Indicates the type of lookup being performed. While most endpoints return a single type, some specialized endpoints may support multiple lookup types for different reference data categories.

Id
string
Default: "LU-2024-001-ABC"

The unique identifier for this lookup record. System-generated and immutable, though it can be referenced in bulk update operations. Used for maintaining referential integrity across the system.

Name
string or null
Default: "Aerial Work Platform - Scissor Lift"

A human-readable display name for this lookup value. Commonly used in dropdowns and selection interfaces. Examples include equipment categories, status types, or payment terms.

Description
string or null
Default: "Self-propelled elevating work platform with extending platform for heights up to 40ft"

Additional details about the lookup value that provide context or clarification. May include usage guidelines or business rules associated with this value.

Field
string
Default: "EquipmentCategory"

The system field or attribute this lookup value is associated with. Used to categorize and organize lookup values by their functional area or purpose.

Value
string
Default: "AWP-SCSR"

The actual stored value or code used in the system. While the Name field is for display, this is the underlying value used in database operations and API calls.

Response samples

Content type
application/json
[
  • {
    }
]

Work Orders

Create a work order

Create a work order

Authorizations:
ApiKey
Request Body schema: application/json
required
StockId
string or null
Default: "25266"

Unique identifier of the equipment being serviced. Example: 'STOCK-JD320D-123'

StockName
string or null
Default: "SOD CUTTER, 18\""

Descriptive name of the equipment being serviced. Example: '2019 John Deere 320D Excavator'

DepotId
string or null
Default: "002"

Identifier of the service location or branch. Example: 'DEPOT-CHICAGO-001'

OpenDateTime
string or null <date-time>
Default: "2017-11-29T21:48:00Z"

When the work order was opened. Example: '2024-03-15T09:00:00Z'

CloseDateTime
string or null <date-time>
Default: "2017-11-30T17:59:00Z"

When the work order was completed. Example: '2024-03-15T16:30:00Z'

CustomerId
string or null
Default: "51963"

Reference to the customer responsible for this Work Order. Example: 'CUST-ACME-001'

Status
string
Default: "Closed"
Enum: "Quote" "Open" "Closed"

Current status of the work order. 'Quote' for estimates, 'Open' for active work, 'Closed' for completed work.

Type
string or null
Default: "Internal Repair"

Primary classification of the work order. Example: 'Preventive Maintenance', 'Repair', 'Inspection'

SubType
string or null

Secondary classification of the work order. Example: '500 Hour Service', 'Hydraulic System', 'Annual DOT'

Array of objects or strings or null
Default: []
Array
One of
Name
string

The display name for this part or component. Example: 'Hydraulic Filter - P550148'

IsBulk
boolean or null

Items with this field do not have unique serial numbers. Example: true for oil, false for engines

IsSerialized
boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. Example: true for engines, false for filters

ProductId
string or null

Reference to the inventory item. Example: 'PART-HYD-P550148'

PullFromStock
boolean or null

Indicates if the items should be pulled from stock. Example: true for stocked filters, false for special order parts

PurchasePrice
number or null

The purchase price of the part. Example: 45.99 for a filter

Quantity
string or null

The quantity of this part needed. Example: '2' for two filters

StockId
string or null

Stock ID for inventory tracking. Example: 'STK-HYD-001'

Comments
string

Additional notes about the part. Example: 'Replace if pressure exceeds 50 PSI'

IsCustomerWO
boolean

Indicates if this is a customer-facing work order. Example: true for customer repairs, false for internal maintenance

Complaint
string

The issue detected by the technician. Example: 'Hydraulic system losing pressure during operation'

Cause
string

The identified root cause of the issue. Example: 'Worn hydraulic pump seals causing internal leakage'

Correction
string

The repair actions taken. Example: 'Replaced hydraulic pump seals and tested system pressure'

ReportedIssue
string
Default: "Broken blade drive belt"

The initial problem reported by the customer. Example: 'Machine is slow to lift'

OtherComments
string

Additional notes about the work order. Example: 'Customer requested completion by end of week'

Operation
string
Default: "Repair complete"

Specific maintenance or repair operation to be performed. Use the "Name" field from the operations lookup endpoint (workorders/lookup/operations or workorders/lookup/consumerOperations) to display the operation to the user.

DueDateTime
string <date-time>
Default: "2017-11-30T17:59:00Z"

When the work order needs to be completed. Example: '2024-03-20T17:00:00Z'

Hidden
integer or null
Value: 1

Flag to hide work order from normal views. 0 = visible, 1 = hidden

Responses

Request samples

Content type
application/json
{
  • "ModelType": "WorkOrder",
  • "Id": "r962692",
  • "Name": "r962692",
  • "ReportedIssue": "Broken blade drive belt",
  • "Identifiers": { },
  • "CloseDateTime": "2017-11-30T17:59:00Z",
  • "CustomerId": "51963",
  • "DepotId": "002",
  • "OpenDateTime": "2017-11-29T21:48:00Z",
  • "DueDateTime": "2017-11-30T17:59:00Z",
  • "Parts": [ ],
  • "Status": "Closed",
  • "StockId": "25266",
  • "StockName": "SOD CUTTER, 18\"",
  • "Type": "Internal Repair",
  • "Operation": "Repair complete",
  • "LaborTracking": {
    },
  • "AdditionalFields": { },
  • "CreatedDateTime": "2017-11-29T21:50:11.377Z",
  • "UpdatedDateTime": "2017-11-30T18:00:01.813Z"
}

Response samples

Content type
application/json
{
  • "ModelType": "WorkOrder",
  • "Id": "WO-20240315-1234",
  • "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
  • "StockId": "STOCK-CAT320-789",
  • "StockName": "2022 CAT 320 Excavator",
  • "DepotId": "DEPOT-DALLAS-001",
  • "OpenDateTime": "2024-03-15T08:00:00Z",
  • "CloseDateTime": "2024-03-15T16:30:00Z",
  • "CustomerId": "CUST-ACME-001",
  • "Status": "Open",
  • "Type": "PM Service",
  • "SubType": "250-Hour Service",
  • "IsCustomerWO": true,
  • "LaborTracking": {
    },
  • "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
  • "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
  • "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
  • "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
  • "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
  • "Operation": "250 Hour Preventive Maintenance Service",
  • "DueDateTime": "2024-03-17T17:00:00Z",
  • "AssignedRemoteUserId": "TECH-JOHN-001",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2024-03-15T08:00:00Z",
  • "UpdatedDateTime": "2024-03-15T16:30:00Z"
}

Retrieve a list of work orders

Retrieve a list of work orders

Authorizations:
ApiKey

Responses

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

Standard field that denotes the record type.

Id
string
Default: "WO-20240315-1234"

The unique identifier for this record. Format typically follows WO-YYYYMMDD-XXXX pattern.

Name
string
Default: "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service"

The display name for this record, typically combining key identifiers like work order number, customer name, and equipment. Used in lookups and displays.

StockId
string or null
Default: "STOCK-CAT320-789"

Unique identifier for the equipment/stock item being serviced

StockName
string or null
Default: "2022 CAT 320 Excavator"

Descriptive name of the equipment being serviced, including make, model, and year if applicable

DepotId
string or null
Default: "DEPOT-DALLAS-001"

Identifier for the service location or branch handling the work order

OpenDateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

UTC timestamp when work order was created/opened

CloseDateTime
string or null <date-time>
Default: "2024-03-15T16:30:00Z"

UTC timestamp when work order was completed and closed

CustomerId
string or null
Default: "CUST-ACME-001"

Reference to the customer account responsible for this work order

Status
string
Default: "Open"
Enum: "Quote" "Open" "Closed"

Current status of the work order. Quote for estimates, Open for in-progress work, Closed for completed work

Type
string or null
Default: "PM Service"

Primary classification of the work order (e.g., PM Service, Repair, Inspection)

SubType
string or null
Default: "250-Hour Service"

Secondary classification providing more detail about the type of work (e.g., 250-Hour Service, Hydraulic Repair)

Array of objects or strings or null
IsCustomerWO
boolean
Default: true

Indicates if this is a customer-facing work order versus internal maintenance

object or null
Default: {"LaborTypes":[{"Description":"Mechanical Labor","Value":"4.5"},{"Description":"Diagnostic Time","Value":"1.0"}]}

Details of labor hours and types performed on the work order

Complaint
string
Default: "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump"

Detailed description of the issue identified by the technician during inspection

Cause
string
Default: "Failed seal in main hydraulic pump allowing air infiltration and internal wear"

Technical explanation of what caused the issue, updated after diagnosis

Correction
string
Default: "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions"

Detailed description of repairs performed to resolve the issue

ReportedIssue
string
Default: "Customer reports loud noise from hydraulic system and oil spots under machine"

Initial problem description as reported by customer or internal staff

OtherComments
string
Default: "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday."

Additional notes about the work order, special instructions, or follow-up requirements

Operation
string
Default: "250 Hour Preventive Maintenance Service"

Specific maintenance or repair operation to be performed. Use the "Name" field from the operations lookup endpoint (workorders/lookup/operations or workorders/lookup/consumerOperations) to display the operation to the user.

DueDateTime
string <date-time>
Default: "2024-03-17T17:00:00Z"

Deadline for completing the work order, considering customer needs and shop capacity

AssignedRemoteUserId
string
Default: "TECH-JOHN-001"

ID of the technician assigned to the work order, set by the Rental Management System

AdditionalFields
object or null
Default: {"purchaseOrderNumber":"PO-4567","warrantyCase":"WC-789","mileageReading":"1234.5"}

Custom fields for tracking additional work order information

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

UTC timestamp when the work order was initially created in the system

UpdatedDateTime
string or null <date-time>
Default: "2024-03-15T16:30:00Z"

UTC timestamp of the last modification to the work order

Hidden
integer or null
Value: 1

Flag indicating if the work order should be hidden from normal views (0=visible, 1=hidden)

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a single work order by its id

Retrieve a single work order by its id

Authorizations:
ApiKey
path Parameters
WorkOrderId
required
string

Responses

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

Standard field that denotes the record type.

Id
string
Default: "WO-20240315-1234"

The unique identifier for this record. Format typically follows WO-YYYYMMDD-XXXX pattern.

Name
string
Default: "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service"

The display name for this record, typically combining key identifiers like work order number, customer name, and equipment. Used in lookups and displays.

StockId
string or null
Default: "STOCK-CAT320-789"

Unique identifier for the equipment/stock item being serviced

StockName
string or null
Default: "2022 CAT 320 Excavator"

Descriptive name of the equipment being serviced, including make, model, and year if applicable

DepotId
string or null
Default: "DEPOT-DALLAS-001"

Identifier for the service location or branch handling the work order

OpenDateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

UTC timestamp when work order was created/opened

CloseDateTime
string or null <date-time>
Default: "2024-03-15T16:30:00Z"

UTC timestamp when work order was completed and closed

CustomerId
string or null
Default: "CUST-ACME-001"

Reference to the customer account responsible for this work order

Status
string
Default: "Open"
Enum: "Quote" "Open" "Closed"

Current status of the work order. Quote for estimates, Open for in-progress work, Closed for completed work

Type
string or null
Default: "PM Service"

Primary classification of the work order (e.g., PM Service, Repair, Inspection)

SubType
string or null
Default: "250-Hour Service"

Secondary classification providing more detail about the type of work (e.g., 250-Hour Service, Hydraulic Repair)

Array of objects or strings or null
Array
One of
Classification
string or null
Enum: "Rental" "Sale"

Indicates if the part is for rental or sale. Internal classification doesn't apply to line items

Name
string

Descriptive name of the part including manufacturer and part number when applicable

IsBulk
boolean or null

Indicates if item is tracked in bulk quantities rather than individual units (e.g., oil, grease)

IsSerialized
boolean or null

Indicates if part requires unique serial number tracking (e.g., engines, transmissions)

ProductId
string or null

Reference to the master inventory or catalog item

PullFromStock
boolean or null

Indicates if part should be automatically deducted from inventory when added to work order

PurchasePrice
number or null

The cost price of the part to the company

Quantity
string or null

Quantity of parts used on the work order

SerialNumber
string or null

Unique identifier for serialized parts like engines or major components

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

Current status of the part in relation to the work order or rental/sale process

StockId
string or null

Reference to specific inventory item if pulled from stock

Comments
string

Additional notes about the part usage or condition

IsCustomerWO
boolean
Default: true

Indicates if this is a customer-facing work order versus internal maintenance

object or null
Default: {"LaborTypes":[{"Description":"Mechanical Labor","Value":"4.5"},{"Description":"Diagnostic Time","Value":"1.0"}]}

Details of labor hours and types performed on the work order

LaborTypes
object or null
Default: [{"Description":"Mechanical Labor","Value":"4.5"},{"Description":"Diagnostic Time","Value":"1.0"}]
Complaint
string
Default: "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump"

Detailed description of the issue identified by the technician during inspection

Cause
string
Default: "Failed seal in main hydraulic pump allowing air infiltration and internal wear"

Technical explanation of what caused the issue, updated after diagnosis

Correction
string
Default: "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions"

Detailed description of repairs performed to resolve the issue

ReportedIssue
string
Default: "Customer reports loud noise from hydraulic system and oil spots under machine"

Initial problem description as reported by customer or internal staff

OtherComments
string
Default: "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday."

Additional notes about the work order, special instructions, or follow-up requirements

Operation
string
Default: "250 Hour Preventive Maintenance Service"

Specific maintenance or repair operation to be performed. Use the "Name" field from the operations lookup endpoint (workorders/lookup/operations or workorders/lookup/consumerOperations) to display the operation to the user.

DueDateTime
string <date-time>
Default: "2024-03-17T17:00:00Z"

Deadline for completing the work order, considering customer needs and shop capacity

AssignedRemoteUserId
string
Default: "TECH-JOHN-001"

ID of the technician assigned to the work order, set by the Rental Management System

AdditionalFields
object or null
Default: {"purchaseOrderNumber":"PO-4567","warrantyCase":"WC-789","mileageReading":"1234.5"}

Custom fields for tracking additional work order information

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

UTC timestamp when the work order was initially created in the system

UpdatedDateTime
string or null <date-time>
Default: "2024-03-15T16:30:00Z"

UTC timestamp of the last modification to the work order

Hidden
integer or null
Value: 1

Flag indicating if the work order should be hidden from normal views (0=visible, 1=hidden)

Response samples

Content type
application/json
{
  • "ModelType": "WorkOrder",
  • "Id": "WO-20240315-1234",
  • "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
  • "StockId": "STOCK-CAT320-789",
  • "StockName": "2022 CAT 320 Excavator",
  • "DepotId": "DEPOT-DALLAS-001",
  • "OpenDateTime": "2024-03-15T08:00:00Z",
  • "CloseDateTime": "2024-03-15T16:30:00Z",
  • "CustomerId": "CUST-ACME-001",
  • "Status": "Open",
  • "Type": "PM Service",
  • "SubType": "250-Hour Service",
  • "IsCustomerWO": true,
  • "LaborTracking": {
    },
  • "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
  • "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
  • "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
  • "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
  • "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
  • "Operation": "250 Hour Preventive Maintenance Service",
  • "DueDateTime": "2024-03-17T17:00:00Z",
  • "AssignedRemoteUserId": "TECH-JOHN-001",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2024-03-15T08:00:00Z",
  • "UpdatedDateTime": "2024-03-15T16:30:00Z"
}

Update a single work order by its id

Update a single work order by its id

Authorizations:
ApiKey
path Parameters
WorkOrderId
required
string
Request Body schema: application/json
required
StockId
string or null
Default: "25266"

Unique identifier of the equipment being serviced. Example: 'STOCK-JD320D-123'

StockName
string or null
Default: "SOD CUTTER, 18\""

Descriptive name of the equipment being serviced. Example: '2019 John Deere 320D Excavator'

DepotId
string or null
Default: "002"

Identifier of the service location or branch. Example: 'DEPOT-CHICAGO-001'

OpenDateTime
string or null <date-time>
Default: "2017-11-29T21:48:00Z"

When the work order was opened. Example: '2024-03-15T09:00:00Z'

CloseDateTime
string or null <date-time>
Default: "2017-11-30T17:59:00Z"

When the work order was completed. Example: '2024-03-15T16:30:00Z'

CustomerId
string or null
Default: "51963"

Reference to the customer responsible for this Work Order. Example: 'CUST-ACME-001'

Status
string
Default: "Closed"
Enum: "Quote" "Open" "Closed"

Current status of the work order. 'Quote' for estimates, 'Open' for active work, 'Closed' for completed work.

Type
string or null
Default: "Internal Repair"

Primary classification of the work order. Example: 'Preventive Maintenance', 'Repair', 'Inspection'

SubType
string or null

Secondary classification of the work order. Example: '500 Hour Service', 'Hydraulic System', 'Annual DOT'

Array of objects or strings or null
Default: []
Array
One of
Name
string

The display name for this part or component. Example: 'Hydraulic Filter - P550148'

IsBulk
boolean or null

Items with this field do not have unique serial numbers. Example: true for oil, false for engines

IsSerialized
boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. Example: true for engines, false for filters

ProductId
string or null

Reference to the inventory item. Example: 'PART-HYD-P550148'

PullFromStock
boolean or null

Indicates if the items should be pulled from stock. Example: true for stocked filters, false for special order parts

PurchasePrice
number or null

The purchase price of the part. Example: 45.99 for a filter

Quantity
string or null

The quantity of this part needed. Example: '2' for two filters

StockId
string or null

Stock ID for inventory tracking. Example: 'STK-HYD-001'

Comments
string

Additional notes about the part. Example: 'Replace if pressure exceeds 50 PSI'

IsCustomerWO
boolean

Indicates if this is a customer-facing work order. Example: true for customer repairs, false for internal maintenance

Complaint
string

The issue detected by the technician. Example: 'Hydraulic system losing pressure during operation'

Cause
string

The identified root cause of the issue. Example: 'Worn hydraulic pump seals causing internal leakage'

Correction
string

The repair actions taken. Example: 'Replaced hydraulic pump seals and tested system pressure'

ReportedIssue
string
Default: "Broken blade drive belt"

The initial problem reported by the customer. Example: 'Machine is slow to lift'

OtherComments
string

Additional notes about the work order. Example: 'Customer requested completion by end of week'

Operation
string
Default: "Repair complete"

Specific maintenance or repair operation to be performed. Use the "Name" field from the operations lookup endpoint (workorders/lookup/operations or workorders/lookup/consumerOperations) to display the operation to the user.

DueDateTime
string <date-time>
Default: "2017-11-30T17:59:00Z"

When the work order needs to be completed. Example: '2024-03-20T17:00:00Z'

Hidden
integer or null
Value: 1

Flag to hide work order from normal views. 0 = visible, 1 = hidden

Responses

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

Standard field that denotes the record type.

Id
string
Default: "WO-20240315-1234"

The unique identifier for this record. Format typically follows WO-YYYYMMDD-XXXX pattern.

Name
string
Default: "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service"

The display name for this record, typically combining key identifiers like work order number, customer name, and equipment. Used in lookups and displays.

StockId
string or null
Default: "STOCK-CAT320-789"

Unique identifier for the equipment/stock item being serviced

StockName
string or null
Default: "2022 CAT 320 Excavator"

Descriptive name of the equipment being serviced, including make, model, and year if applicable

DepotId
string or null
Default: "DEPOT-DALLAS-001"

Identifier for the service location or branch handling the work order

OpenDateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

UTC timestamp when work order was created/opened

CloseDateTime
string or null <date-time>
Default: "2024-03-15T16:30:00Z"

UTC timestamp when work order was completed and closed

CustomerId
string or null
Default: "CUST-ACME-001"

Reference to the customer account responsible for this work order

Status
string
Default: "Open"
Enum: "Quote" "Open" "Closed"

Current status of the work order. Quote for estimates, Open for in-progress work, Closed for completed work

Type
string or null
Default: "PM Service"

Primary classification of the work order (e.g., PM Service, Repair, Inspection)

SubType
string or null
Default: "250-Hour Service"

Secondary classification providing more detail about the type of work (e.g., 250-Hour Service, Hydraulic Repair)

Array of objects or strings or null
Array
One of
Classification
string or null
Enum: "Rental" "Sale"

Indicates if the part is for rental or sale. Internal classification doesn't apply to line items

Name
string

Descriptive name of the part including manufacturer and part number when applicable

IsBulk
boolean or null

Indicates if item is tracked in bulk quantities rather than individual units (e.g., oil, grease)

IsSerialized
boolean or null

Indicates if part requires unique serial number tracking (e.g., engines, transmissions)

ProductId
string or null

Reference to the master inventory or catalog item

PullFromStock
boolean or null

Indicates if part should be automatically deducted from inventory when added to work order

PurchasePrice
number or null

The cost price of the part to the company

Quantity
string or null

Quantity of parts used on the work order

SerialNumber
string or null

Unique identifier for serialized parts like engines or major components

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

Current status of the part in relation to the work order or rental/sale process

StockId
string or null

Reference to specific inventory item if pulled from stock

Comments
string

Additional notes about the part usage or condition

IsCustomerWO
boolean
Default: true

Indicates if this is a customer-facing work order versus internal maintenance

object or null
Default: {"LaborTypes":[{"Description":"Mechanical Labor","Value":"4.5"},{"Description":"Diagnostic Time","Value":"1.0"}]}

Details of labor hours and types performed on the work order

LaborTypes
object or null
Default: [{"Description":"Mechanical Labor","Value":"4.5"},{"Description":"Diagnostic Time","Value":"1.0"}]
Complaint
string
Default: "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump"

Detailed description of the issue identified by the technician during inspection

Cause
string
Default: "Failed seal in main hydraulic pump allowing air infiltration and internal wear"

Technical explanation of what caused the issue, updated after diagnosis

Correction
string
Default: "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions"

Detailed description of repairs performed to resolve the issue

ReportedIssue
string
Default: "Customer reports loud noise from hydraulic system and oil spots under machine"

Initial problem description as reported by customer or internal staff

OtherComments
string
Default: "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday."

Additional notes about the work order, special instructions, or follow-up requirements

Operation
string
Default: "250 Hour Preventive Maintenance Service"

Specific maintenance or repair operation to be performed. Use the "Name" field from the operations lookup endpoint (workorders/lookup/operations or workorders/lookup/consumerOperations) to display the operation to the user.

DueDateTime
string <date-time>
Default: "2024-03-17T17:00:00Z"

Deadline for completing the work order, considering customer needs and shop capacity

AssignedRemoteUserId
string
Default: "TECH-JOHN-001"

ID of the technician assigned to the work order, set by the Rental Management System

AdditionalFields
object or null
Default: {"purchaseOrderNumber":"PO-4567","warrantyCase":"WC-789","mileageReading":"1234.5"}

Custom fields for tracking additional work order information

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T08:00:00Z"

UTC timestamp when the work order was initially created in the system

UpdatedDateTime
string or null <date-time>
Default: "2024-03-15T16:30:00Z"

UTC timestamp of the last modification to the work order

Hidden
integer or null
Value: 1

Flag indicating if the work order should be hidden from normal views (0=visible, 1=hidden)

Request samples

Content type
application/json
{
  • "ModelType": "WorkOrder",
  • "Id": "r962692",
  • "Name": "r962692",
  • "ReportedIssue": "Broken blade drive belt",
  • "Identifiers": { },
  • "CloseDateTime": "2017-11-30T17:59:00Z",
  • "CustomerId": "51963",
  • "DepotId": "002",
  • "OpenDateTime": "2017-11-29T21:48:00Z",
  • "DueDateTime": "2017-11-30T17:59:00Z",
  • "Parts": [ ],
  • "Status": "Closed",
  • "StockId": "25266",
  • "StockName": "SOD CUTTER, 18\"",
  • "Type": "Internal Repair",
  • "Operation": "Repair complete",
  • "LaborTracking": {
    },
  • "AdditionalFields": { },
  • "CreatedDateTime": "2017-11-29T21:50:11.377Z",
  • "UpdatedDateTime": "2017-11-30T18:00:01.813Z"
}

Response samples

Content type
application/json
{
  • "ModelType": "WorkOrder",
  • "Id": "WO-20240315-1234",
  • "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
  • "StockId": "STOCK-CAT320-789",
  • "StockName": "2022 CAT 320 Excavator",
  • "DepotId": "DEPOT-DALLAS-001",
  • "OpenDateTime": "2024-03-15T08:00:00Z",
  • "CloseDateTime": "2024-03-15T16:30:00Z",
  • "CustomerId": "CUST-ACME-001",
  • "Status": "Open",
  • "Type": "PM Service",
  • "SubType": "250-Hour Service",
  • "IsCustomerWO": true,
  • "LaborTracking": {
    },
  • "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
  • "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
  • "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
  • "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
  • "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
  • "Operation": "250 Hour Preventive Maintenance Service",
  • "DueDateTime": "2024-03-17T17:00:00Z",
  • "AssignedRemoteUserId": "TECH-JOHN-001",
  • "AdditionalFields": {
    },
  • "CreatedDateTime": "2024-03-15T08:00:00Z",
  • "UpdatedDateTime": "2024-03-15T16:30:00Z"
}

Retrieve a list of work order parts

Retrieve a list of work order parts

Authorizations:
ApiKey
path Parameters
WorkOrderId
required
string

Responses

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

Standard field that denotes the record type. For parts, this is typically 'WorkOrderPart' or 'Part'.

Id
string
Default: "WOP-12345-6789"

The unique identifier for this record, typically a UUID or system-generated ID.

Classification
string or null
Default: "Sale"
Enum: "Rental" "Sale"

This product is either meant for sale or rental. For example, oil filters would be 'Sale' while an attachment might be 'Rental'. The internal classification does not apply to lineitems.

Name
string
Default: "Oil Filter 10 Micron"

The display name for this record, typically the part name or description. Examples: 'Oil Filter 10 Micron', 'Hydraulic Hose 3/8" x 24"'.

IsBulk
boolean or null
Default: true

Items with this field do not have unique serial numbers. Example: true for items like oil, filters, or nuts/bolts. False for serialized items like engines or transmissions. If isSerialized and isBulk are both true, then an alternate serialization method is being used (like batch numbers).

IsSerialized
boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. Example: true for major components like engines, transmissions, or electronics. False for consumables like filters or fluids. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

ProductId
string or null
Default: "FILTER-10M"

If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". Example: 'FILTER-10M' for a filter product category, or 'ENG-CAT-C15' for a specific engine model. (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. Example: true for stocked items like filters or common parts, false for special order items or non-inventory items.

PurchasePrice
number or null
Default: 45.99

The purchase price of the part. Example: 45.99 for a filter, 2500.00 for a hydraulic pump.

Quantity
string or null
Default: "2"

The quantity of this part on the work order. Example: '2' for two filters, '1' for a single pump.

SerialNumber
string or null
Default: "CAT123456"

The serial number or unique identifier assigned to this particular Line Item. Example: 'CAT123456' for an engine, 'HYD789012' for a hydraulic component.

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

The displayable status of a lineitem. Examples:

  • Reserved - Part is allocated but not yet used
  • Out - Part has been issued to the work order
  • Off Rent - Rental part has been removed from service
  • Returned - Part has been returned to inventory
  • Sold - Part has been sold and invoiced
StockId
string or null
Default: "BIN-A123"

Id of stock location or bin where the part is stored. Example: 'BIN-A123' for a specific storage location, 'WHSE-MAIN' for main warehouse.

Comments
string
Default: "Customer requested OEM parts only"

Any comments for this part. Example: 'Customer requested OEM parts only' or 'Special order - 2 week lead time'.

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T14:30:00Z"

UTC when the record was created. Example: '2024-03-15T14:30:00Z' for March 15, 2024 at 2:30 PM UTC.

UpdatedDateTime
string or null <date-time>
Default: "2024-03-16T09:15:00Z"

UTC when the record was updated. Example: '2024-03-16T09:15:00Z' for March 16, 2024 at 9:15 AM UTC.

Hidden
integer or null
Value: 1

Hidden status where 0 = visible and 1 = hidden. Used to soft-delete or hide parts from normal views while maintaining history.

Response samples

Content type
application/json
[
  • {
    }
]

Create a work order part

Create a work order part

Authorizations:
ApiKey
path Parameters
WorkOrderId
required
string
Request Body schema: application/json
required
Name
string
Default: "Orville Friesen-Pfannerstill"

The display name for this record, typically including the part name and any relevant specifications. For example: '1/2" Hydraulic Hose - 10ft' or 'Air Filter - CAT 259D3'

IsBulk
boolean or null

Items with this field do not have unique serial numbers. For example, nuts, bolts, and fluids are bulk items (true), while engines and transmissions are not bulk items (false). 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. For example, major components like engines (true) vs consumables like oil filters (false). 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". For example: 'HYD-HOSE-12' for hydraulic hose category or 'ENG-CAT-3126' for a specific engine model.

PullFromStock
boolean or null

Indicates if the items should be pulled from stock when added to a work order. For example, common parts like filters and fluids (true) vs special order items (false).

PurchasePrice
number or null

The purchase price of the part. For example: 45.99 for a standard air filter or 2500.00 for a hydraulic pump.

Quantity
string or null

The quantity of this part on the work order. For example: '2' for two air filters or '10.5' for 10.5 feet of hydraulic hose.

StockId
string or null

Id of stock item in inventory. For example: 'STK-HYD-001' for a specific hydraulic component or 'STK-FIL-002' for a specific filter in inventory.

Comments
string
Default: "sport"

Any comments for this part, such as installation notes, condition observations, or special handling instructions. For example: 'Replace gasket during installation' or 'Customer requested OEM parts only'

Responses

Request samples

Content type
application/json
{
  • "Name": "Orville Friesen-Pfannerstill",
  • "Comments": "sport"
}

Response samples

Content type
application/json
{
  • "ModelType": "WorkOrderPart",
  • "Id": "WOP-12345-6789",
  • "Classification": "Sale",
  • "Name": "Oil Filter 10 Micron",
  • "IsBulk": true,
  • "ProductId": "FILTER-10M",
  • "PullFromStock": true,
  • "PurchasePrice": 45.99,
  • "Quantity": "2",
  • "SerialNumber": "CAT123456",
  • "Status": "Out",
  • "StockId": "BIN-A123",
  • "Comments": "Customer requested OEM parts only",
  • "CreatedDateTime": "2024-03-15T14:30:00Z",
  • "UpdatedDateTime": "2024-03-16T09:15:00Z"
}

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:
ApiKey

Responses

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

Indicates the type of lookup being performed. While most endpoints return a single type, some specialized endpoints may support multiple lookup types for different reference data categories.

Id
string
Default: "LU-2024-001-ABC"

The unique identifier for this lookup record. System-generated and immutable, though it can be referenced in bulk update operations. Used for maintaining referential integrity across the system.

Name
string or null
Default: "Aerial Work Platform - Scissor Lift"

A human-readable display name for this lookup value. Commonly used in dropdowns and selection interfaces. Examples include equipment categories, status types, or payment terms.

Description
string or null
Default: "Self-propelled elevating work platform with extending platform for heights up to 40ft"

Additional details about the lookup value that provide context or clarification. May include usage guidelines or business rules associated with this value.

Field
string
Default: "EquipmentCategory"

The system field or attribute this lookup value is associated with. Used to categorize and organize lookup values by their functional area or purpose.

Value
string
Default: "AWP-SCSR"

The actual stored value or code used in the system. While the Name field is for display, this is the underlying value used in database operations and API calls.

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:
ApiKey

Responses

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

Indicates the type of lookup being performed. While most endpoints return a single type, some specialized endpoints may support multiple lookup types for different reference data categories.

Id
string
Default: "LU-2024-001-ABC"

The unique identifier for this lookup record. System-generated and immutable, though it can be referenced in bulk update operations. Used for maintaining referential integrity across the system.

Name
string or null
Default: "Aerial Work Platform - Scissor Lift"

A human-readable display name for this lookup value. Commonly used in dropdowns and selection interfaces. Examples include equipment categories, status types, or payment terms.

Description
string or null
Default: "Self-propelled elevating work platform with extending platform for heights up to 40ft"

Additional details about the lookup value that provide context or clarification. May include usage guidelines or business rules associated with this value.

Field
string
Default: "EquipmentCategory"

The system field or attribute this lookup value is associated with. Used to categorize and organize lookup values by their functional area or purpose.

Value
string
Default: "AWP-SCSR"

The actual stored value or code used in the system. While the Name field is for display, this is the underlying value used in database operations and API calls.

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:
ApiKey

Responses

Response Schema: application/json
Array
ModelType
string
Default: "AccountPayableInvoice"
Value: "AccountPayableInvoice"
Id
string

Unique identifier for the model type.

PurchaseOrderDateTime
string <date-time>
Default: "2025-05-31T19:17:12.655Z"

The purchase order date on the PO that resulted in the payable.

CurrencyCode
string or null

Currency code value set in the accounting system.

ErrorCode
string or null

Error code value whenever the payable invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever payable invoice State is set to 'Error'.

ExchangeRate
number or null

Exchange rate on the payable invoice.

FreightTotal
number
Default: 358.16

Total price of the freight.

GrandTaxTotal
number
Default: 892.3

Total amount of sales tax.

GrandTotal
number
Default: 778.82

Total amount that is payable.

object
Default: {"BatchId":149,"ContractStoreId":918,"ExternalLocationId":734,"ExternalPayableId":789,"ExternalVendorId":668,"FreightAccountId":963,"MiscellaneousAccountId":429,"PayableAccountId":539,"TaxAccountId":10}

Collection of unique ids related to this payable invoice.

Array of objects
Default: [{"ModelType":"AccountPayableInvoiceLineItem","Id":681,"ExtendedUnitTotal":787.66,"FreightTotal":485.52,"GrandTaxTotal":662.67,"GrandTotal":618.79,"Identifiers":{"AccountNumberId":153,"ExternalPayableId":801,"InvoiceId":100},"Item":{"ModelType":"Item","Id":907,"Description":"SAMPLE: boo silky instead culminate valley frantically rebuff out gleefully blowgun","Key":"corporation"},"LineNumber":287,"MiscellaneousTotal":"wafer","PurchaseOrderNumber":"heartache","PurchaseOrderPartNumber":"atrium","PurchaseOrderSequenceNumber":"spork","QuantityOrdered":34.05,"QuantityReceived":112.13,"ReceivedDateTime":"2025-09-17T10:03:11.009Z","UnitTotal":625.18},{"ModelType":"AccountPayableInvoiceLineItem","Id":440,"ExtendedUnitTotal":862.92,"FreightTotal":64.1,"GrandTaxTotal":372.19,"GrandTotal":465.27,"Identifiers":{"AccountNumberId":265,"ExternalPayableId":446,"InvoiceId":435},"Item":{"ModelType":"Item","Id":654,"Description":"SAMPLE: stale sans haunting since babyish whose mmm mousse powerfully responsible","Key":"swim"},"LineNumber":142,"MiscellaneousTotal":"e-mail","PurchaseOrderNumber":"deck","PurchaseOrderPartNumber":"saw","PurchaseOrderSequenceNumber":"cross-contamination","QuantityOrdered":701.27,"QuantityReceived":505.51,"ReceivedDateTime":"2026-06-25T13:44:06.720Z","UnitTotal":416.43},{"ModelType":"AccountPayableInvoiceLineItem","Id":154,"ExtendedUnitTotal":20.13,"FreightTotal":168.07,"GrandTaxTotal":592.31,"GrandTotal":141.72,"Identifiers":{"AccountNumberId":824,"ExternalPayableId":138,"InvoiceId":66},"Item":{"ModelType":"Item","Id":836,"Description":"SAMPLE: softly notwithstanding low nor unto violently boohoo snowplow typify ick","Key":"majority"},"LineNumber":821,"MiscellaneousTotal":"bog","PurchaseOrderNumber":"reservation","PurchaseOrderPartNumber":"elver","PurchaseOrderSequenceNumber":"runway","QuantityOrdered":791.28,"QuantityReceived":79.13,"ReceivedDateTime":"2025-01-02T19:39:35.506Z","UnitTotal":742.54}]

A collection of line items related to the contract Id.

Memo
string or null

Memo associated to the payable invoice.

MiscellaneousTotal
number
Default: 462.72

Total price of miscellaneous costs.

PurchaseOrderNumber
string
Default: "sediment"

Purchase order number associated to the payable invoice.

PurchaseOrderSequenceNumber
string
Default: "beret"

Purchase order sequence number associated to the payable invoice.

PurchaseTotal
number
Default: 295.29

Total price of the purchases.

ShippingMethod
string
Default: "adult"

Shipping method on the payable invoice.

State
string
Default: "Pending"
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: "sunbeam"

Payment terms code in the accounting system.

object
Default: {"ModelType":"Vendor","Id":109,"Name":"Tammy Howe","InvoiceNumber":"postbox","InvoiceDateTime":"2025-03-13T11:52:51.462Z","InvoiceDueDateTime":"2025-12-29T15:05:26.124Z"}

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:
ApiKey
path Parameters
InvoiceId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "AccountPayableInvoice"
Value: "AccountPayableInvoice"
Id
string

Unique identifier for the model type.

PurchaseOrderDateTime
string <date-time>
Default: "2025-05-31T19:17:12.655Z"

The purchase order date on the PO that resulted in the payable.

CurrencyCode
string or null

Currency code value set in the accounting system.

ErrorCode
string or null

Error code value whenever the payable invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever payable invoice State is set to 'Error'.

ExchangeRate
number or null

Exchange rate on the payable invoice.

FreightTotal
number
Default: 358.16

Total price of the freight.

GrandTaxTotal
number
Default: 892.3

Total amount of sales tax.

GrandTotal
number
Default: 778.82

Total amount that is payable.

object
Default: {"BatchId":149,"ContractStoreId":918,"ExternalLocationId":734,"ExternalPayableId":789,"ExternalVendorId":668,"FreightAccountId":963,"MiscellaneousAccountId":429,"PayableAccountId":539,"TaxAccountId":10}

Collection of unique ids related to this payable invoice.

BatchId
string
Default: 149

Elite accounting batch Id associated with the payable.

ContractStoreId
string
Default: 918

Store Id associated with the payable invoice.

ExternalLocationId
string
Default: 734

External store/location Id in the accounting system.

ExternalPayableId
string
Default: 789

External payable Id in the accounting system.

ExternalVendorId
string
Default: 668

External vendor Id in the accounting system.

FreightAccountId
string
Default: 963

General ledger freight account Id (Freight on purchases).

MiscellaneousAccountId
string
Default: 429

General ledger miscellaneous account Id (Miscellaneous cost on purchases).

PayableAccountId
string
Default: 539

General ledger payable account Id.

TaxAccountId
string
Default: 10

General ledger tax account Id (Tax on purchases).

Array of objects
Default: [{"ModelType":"AccountPayableInvoiceLineItem","Id":681,"ExtendedUnitTotal":787.66,"FreightTotal":485.52,"GrandTaxTotal":662.67,"GrandTotal":618.79,"Identifiers":{"AccountNumberId":153,"ExternalPayableId":801,"InvoiceId":100},"Item":{"ModelType":"Item","Id":907,"Description":"SAMPLE: boo silky instead culminate valley frantically rebuff out gleefully blowgun","Key":"corporation"},"LineNumber":287,"MiscellaneousTotal":"wafer","PurchaseOrderNumber":"heartache","PurchaseOrderPartNumber":"atrium","PurchaseOrderSequenceNumber":"spork","QuantityOrdered":34.05,"QuantityReceived":112.13,"ReceivedDateTime":"2025-09-17T10:03:11.009Z","UnitTotal":625.18},{"ModelType":"AccountPayableInvoiceLineItem","Id":440,"ExtendedUnitTotal":862.92,"FreightTotal":64.1,"GrandTaxTotal":372.19,"GrandTotal":465.27,"Identifiers":{"AccountNumberId":265,"ExternalPayableId":446,"InvoiceId":435},"Item":{"ModelType":"Item","Id":654,"Description":"SAMPLE: stale sans haunting since babyish whose mmm mousse powerfully responsible","Key":"swim"},"LineNumber":142,"MiscellaneousTotal":"e-mail","PurchaseOrderNumber":"deck","PurchaseOrderPartNumber":"saw","PurchaseOrderSequenceNumber":"cross-contamination","QuantityOrdered":701.27,"QuantityReceived":505.51,"ReceivedDateTime":"2026-06-25T13:44:06.720Z","UnitTotal":416.43},{"ModelType":"AccountPayableInvoiceLineItem","Id":154,"ExtendedUnitTotal":20.13,"FreightTotal":168.07,"GrandTaxTotal":592.31,"GrandTotal":141.72,"Identifiers":{"AccountNumberId":824,"ExternalPayableId":138,"InvoiceId":66},"Item":{"ModelType":"Item","Id":836,"Description":"SAMPLE: softly notwithstanding low nor unto violently boohoo snowplow typify ick","Key":"majority"},"LineNumber":821,"MiscellaneousTotal":"bog","PurchaseOrderNumber":"reservation","PurchaseOrderPartNumber":"elver","PurchaseOrderSequenceNumber":"runway","QuantityOrdered":791.28,"QuantityReceived":79.13,"ReceivedDateTime":"2025-01-02T19:39:35.506Z","UnitTotal":742.54}]

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

Memo associated to the payable invoice.

MiscellaneousTotal
number
Default: 462.72

Total price of miscellaneous costs.

PurchaseOrderNumber
string
Default: "sediment"

Purchase order number associated to the payable invoice.

PurchaseOrderSequenceNumber
string
Default: "beret"

Purchase order sequence number associated to the payable invoice.

PurchaseTotal
number
Default: 295.29

Total price of the purchases.

ShippingMethod
string
Default: "adult"

Shipping method on the payable invoice.

State
string
Default: "Pending"
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: "sunbeam"

Payment terms code in the accounting system.

object
Default: {"ModelType":"Vendor","Id":109,"Name":"Tammy Howe","InvoiceNumber":"postbox","InvoiceDateTime":"2025-03-13T11:52:51.462Z","InvoiceDueDateTime":"2025-12-29T15:05:26.124Z"}

Elite vendor associated to this payable invoice.

ModelType
string
Default: "Vendor"
Value: "Vendor"
Id
string
Default: 109

Unique identifier for the vendor model type.

Name
string
Default: "Tammy Howe"

Name of the vendor.

InvoiceNumber
string
Default: "postbox"

Vendor's invoice number associated with the payable.

InvoiceDateTime
string <date-time>
Default: "2025-03-13T11:52:51.462Z"

Date of vendor's invoice.

InvoiceDueDateTime
string <date-time>
Default: "2025-12-29T15:05:26.124Z"

Due date of vendor's invoice.

Response samples

Content type
application/json
{
  • "ModelType": "AccountPayableInvoice",
  • "PurchaseOrderDateTime": "2025-05-31T19:17:12.655Z",
  • "FreightTotal": 358.16,
  • "GrandTaxTotal": 892.3,
  • "GrandTotal": 778.82,
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "MiscellaneousTotal": 462.72,
  • "PurchaseOrderNumber": "sediment",
  • "PurchaseOrderSequenceNumber": "beret",
  • "PurchaseTotal": 295.29,
  • "ShippingMethod": "adult",
  • "State": "Pending",
  • "TermsCode": "sunbeam",
  • "Vendor": {
    }
}

Update an existing Account Payable Invoice

Supported by: Elite

Update an existing Account Payable Invoice

Authorizations:
ApiKey
path Parameters
InvoiceId
required
string
Request Body schema: application/json
required
ErrorCode
string or null

Error code value whenever the payable invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever payable invoice State is set to 'Error'.

object
Default: {"BatchId":135,"ContractStoreId":308,"ExternalLocationId":156,"ExternalPayableId":531,"ExternalVendorId":307,"FreightAccountId":16,"MiscellaneousAccountId":644,"PayableAccountId":755,"TaxAccountId":202}

Collection of unique ids related to this payable invoice.

ExternalPayableId
string
Default: 531

External payable Id in the accounting system.

State
string
Default: "Posted"
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: "AccountPayableInvoice"
Value: "AccountPayableInvoice"
Id
string

Unique identifier for the model type.

PurchaseOrderDateTime
string <date-time>
Default: "2025-05-31T19:17:12.655Z"

The purchase order date on the PO that resulted in the payable.

CurrencyCode
string or null

Currency code value set in the accounting system.

ErrorCode
string or null

Error code value whenever the payable invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever payable invoice State is set to 'Error'.

ExchangeRate
number or null

Exchange rate on the payable invoice.

FreightTotal
number
Default: 358.16

Total price of the freight.

GrandTaxTotal
number
Default: 892.3

Total amount of sales tax.

GrandTotal
number
Default: 778.82

Total amount that is payable.

object
Default: {"BatchId":149,"ContractStoreId":918,"ExternalLocationId":734,"ExternalPayableId":789,"ExternalVendorId":668,"FreightAccountId":963,"MiscellaneousAccountId":429,"PayableAccountId":539,"TaxAccountId":10}

Collection of unique ids related to this payable invoice.

BatchId
string
Default: 149

Elite accounting batch Id associated with the payable.

ContractStoreId
string
Default: 918

Store Id associated with the payable invoice.

ExternalLocationId
string
Default: 734

External store/location Id in the accounting system.

ExternalPayableId
string
Default: 789

External payable Id in the accounting system.

ExternalVendorId
string
Default: 668

External vendor Id in the accounting system.

FreightAccountId
string
Default: 963

General ledger freight account Id (Freight on purchases).

MiscellaneousAccountId
string
Default: 429

General ledger miscellaneous account Id (Miscellaneous cost on purchases).

PayableAccountId
string
Default: 539

General ledger payable account Id.

TaxAccountId
string
Default: 10

General ledger tax account Id (Tax on purchases).

Array of objects
Default: [{"ModelType":"AccountPayableInvoiceLineItem","Id":681,"ExtendedUnitTotal":787.66,"FreightTotal":485.52,"GrandTaxTotal":662.67,"GrandTotal":618.79,"Identifiers":{"AccountNumberId":153,"ExternalPayableId":801,"InvoiceId":100},"Item":{"ModelType":"Item","Id":907,"Description":"SAMPLE: boo silky instead culminate valley frantically rebuff out gleefully blowgun","Key":"corporation"},"LineNumber":287,"MiscellaneousTotal":"wafer","PurchaseOrderNumber":"heartache","PurchaseOrderPartNumber":"atrium","PurchaseOrderSequenceNumber":"spork","QuantityOrdered":34.05,"QuantityReceived":112.13,"ReceivedDateTime":"2025-09-17T10:03:11.009Z","UnitTotal":625.18},{"ModelType":"AccountPayableInvoiceLineItem","Id":440,"ExtendedUnitTotal":862.92,"FreightTotal":64.1,"GrandTaxTotal":372.19,"GrandTotal":465.27,"Identifiers":{"AccountNumberId":265,"ExternalPayableId":446,"InvoiceId":435},"Item":{"ModelType":"Item","Id":654,"Description":"SAMPLE: stale sans haunting since babyish whose mmm mousse powerfully responsible","Key":"swim"},"LineNumber":142,"MiscellaneousTotal":"e-mail","PurchaseOrderNumber":"deck","PurchaseOrderPartNumber":"saw","PurchaseOrderSequenceNumber":"cross-contamination","QuantityOrdered":701.27,"QuantityReceived":505.51,"ReceivedDateTime":"2026-06-25T13:44:06.720Z","UnitTotal":416.43},{"ModelType":"AccountPayableInvoiceLineItem","Id":154,"ExtendedUnitTotal":20.13,"FreightTotal":168.07,"GrandTaxTotal":592.31,"GrandTotal":141.72,"Identifiers":{"AccountNumberId":824,"ExternalPayableId":138,"InvoiceId":66},"Item":{"ModelType":"Item","Id":836,"Description":"SAMPLE: softly notwithstanding low nor unto violently boohoo snowplow typify ick","Key":"majority"},"LineNumber":821,"MiscellaneousTotal":"bog","PurchaseOrderNumber":"reservation","PurchaseOrderPartNumber":"elver","PurchaseOrderSequenceNumber":"runway","QuantityOrdered":791.28,"QuantityReceived":79.13,"ReceivedDateTime":"2025-01-02T19:39:35.506Z","UnitTotal":742.54}]

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

Memo associated to the payable invoice.

MiscellaneousTotal
number
Default: 462.72

Total price of miscellaneous costs.

PurchaseOrderNumber
string
Default: "sediment"

Purchase order number associated to the payable invoice.

PurchaseOrderSequenceNumber
string
Default: "beret"

Purchase order sequence number associated to the payable invoice.

PurchaseTotal
number
Default: 295.29

Total price of the purchases.

ShippingMethod
string
Default: "adult"

Shipping method on the payable invoice.

State
string
Default: "Pending"
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: "sunbeam"

Payment terms code in the accounting system.

object
Default: {"ModelType":"Vendor","Id":109,"Name":"Tammy Howe","InvoiceNumber":"postbox","InvoiceDateTime":"2025-03-13T11:52:51.462Z","InvoiceDueDateTime":"2025-12-29T15:05:26.124Z"}

Elite vendor associated to this payable invoice.

ModelType
string
Default: "Vendor"
Value: "Vendor"
Id
string
Default: 109

Unique identifier for the vendor model type.

Name
string
Default: "Tammy Howe"

Name of the vendor.

InvoiceNumber
string
Default: "postbox"

Vendor's invoice number associated with the payable.

InvoiceDateTime
string <date-time>
Default: "2025-03-13T11:52:51.462Z"

Date of vendor's invoice.

InvoiceDueDateTime
string <date-time>
Default: "2025-12-29T15:05:26.124Z"

Due date of vendor's invoice.

Request samples

Content type
application/json
{
  • "ModelType": "AccountPayableInvoice",
  • "PurchaseOrderDateTime": "2026-06-26T19:35:33.411Z",
  • "FreightTotal": 958.81,
  • "GrandTaxTotal": 994.64,
  • "GrandTotal": 388.32,
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "MiscellaneousTotal": 816.65,
  • "PurchaseOrderNumber": "elevation",
  • "PurchaseOrderSequenceNumber": "hose",
  • "PurchaseTotal": 818.44,
  • "ShippingMethod": "knickers",
  • "State": "Posted",
  • "TermsCode": "longboat",
  • "Vendor": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "AccountPayableInvoice",
  • "PurchaseOrderDateTime": "2025-05-31T19:17:12.655Z",
  • "FreightTotal": 358.16,
  • "GrandTaxTotal": 892.3,
  • "GrandTotal": 778.82,
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "MiscellaneousTotal": 462.72,
  • "PurchaseOrderNumber": "sediment",
  • "PurchaseOrderSequenceNumber": "beret",
  • "PurchaseTotal": 295.29,
  • "ShippingMethod": "adult",
  • "State": "Pending",
  • "TermsCode": "sunbeam",
  • "Vendor": {
    }
}

Accounts Receivable

[Elite Account Receivable Invoices] Get All

All Elite account receivable invoices, use query parameters to filter

Authorizations:
ApiKey

Responses

Response Schema: application/json
Array
ModelType
string
Default: "AccountReceivableInvoice"
Value: "AccountReceivableInvoice"
Id
string

Unique identifier for the model type.

ContractTotal
number
Default: 912.13

Total price of the contract excluding sales tax total.

ContractType
string
Default: "Invoice"
Enum: "Cash" "Credit" "Invoice"

Type of contract.

CurrencyCode
string or null

Currency code value set in the accounting system.

CustomerPurchaseOrderNumber
string or null

Customer purchase order number associated to the invoice.

DamageWaiverTotal
number
Default: 231.38

Total price of the damage waiver.

object
Default: {"Type":"Default","City":"Port Malindamouth","Line1":"432 Skiles Mews","PostalCode":"35306-0982","Province":"Nebraska"}

Ship to / delivery details associated to the contract on the invoice.

EndDateTime
string or null <date-time>

Date and time when the contract was closed.

ErrorCode
string or null

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever invoice State is set to 'Error'.

ExchangeRate
number or null

Exchange rate of the contract on the invoice.

GrandTaxTotal
number
Default: 76.93

Total amount of sales tax invoiced.

GrandTotal
number
Default: 785.17

Total price of the contract including sales tax.

object
Default: {"ContractId":148,"BatchId":949,"ContractStoreId":324,"CustomerId":680,"ExternalLocationId":700,"ExternalInvoiceId":827,"ExternalCustomerId":368,"ParentContractId":134}

Collection of unique ids related to this invoice.

InvoiceNumber
string or null

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

Total value of item percentage on the contract.

Array of objects
Default: [{"ModelType":"AccountReceivableInvoiceLineItem","Id":502,"AccountingClass":"casement","DamageWaiverPercent":329.55,"DiscountPercent":65,"DiscountTotal":96,"DueDateTime":"2026-06-09T21:31:57.404Z","ExtendedPriceTotal":727.25,"GrandTaxTotal":94.5,"GrandTotal":109.44,"HoursCharged":346.45,"Identifiers":{"InvoiceId":609,"ContractId":473,"GeneralLedgerAccountId":781,"GeneralLedgerOffsetAccountId":689},"Item":{"ModelType":"Item","Id":302,"Name":"Lorena Franecki","Key":"atrium","CategoryId":133,"CategoryName":"Ella Lakin","Description":"SAMPLE: whether which unless fake around aha secret along where majestically","IsAsset":true,"Manufacturer":"character","Model":"Nissan Model 3","ModelYear":"futon","SerialNumber":"conservative","Type":"Retail"},"ItemPercent":"Cheese","LineNumber":835,"Memo":"requirement","MeterIn":485.14,"MeterOut":3.59,"NonTaxable":true,"OutDateTime":"2025-01-18T04:51:10.706Z","Quantity":12,"TypeId":522,"TypeName":"DamageWaiver"},{"ModelType":"AccountReceivableInvoiceLineItem","Id":387,"AccountingClass":"distinction","DamageWaiverPercent":734.84,"DiscountPercent":41,"DiscountTotal":88,"DueDateTime":"2025-12-08T11:07:04.905Z","ExtendedPriceTotal":445.15,"GrandTaxTotal":637.61,"GrandTotal":408.77,"HoursCharged":710.78,"Identifiers":{"InvoiceId":670,"ContractId":835,"GeneralLedgerAccountId":51,"GeneralLedgerOffsetAccountId":449},"Item":{"ModelType":"Item","Id":899,"Name":"Colin Morissette","Key":"hydrolyze","CategoryId":197,"CategoryName":"Valerie Muller","Description":"SAMPLE: overplay wobbly wherever engender along dereference youthfully lamp yet never","IsAsset":false,"Manufacturer":"making","Model":"Ford Cruze","ModelYear":"muscat","SerialNumber":"cappelletti","Type":"Retail"},"ItemPercent":"Pizza","LineNumber":490,"Memo":"status","MeterIn":75.4,"MeterOut":996.05,"NonTaxable":true,"OutDateTime":"2025-05-15T03:49:55.395Z","Quantity":35,"TypeId":585},{"ModelType":"AccountReceivableInvoiceLineItem","Id":558,"AccountingClass":"pine","DamageWaiverPercent":970.72,"DiscountPercent":39,"DiscountTotal":22,"DueDateTime":"2026-04-27T03:09:47.573Z","ExtendedPriceTotal":706.99,"GrandTaxTotal":738.28,"GrandTotal":178.3,"HoursCharged":250.2,"Identifiers":{"InvoiceId":713,"ContractId":720,"GeneralLedgerAccountId":707,"GeneralLedgerOffsetAccountId":736},"Item":{"ModelType":"Item","Id":242,"Name":"Mrs. Kim Lockman","Key":"beret","CategoryId":126,"CategoryName":"Willie Wolf Sr.","Description":"SAMPLE: how trouser frank pish failing commonly own gee but drat","IsAsset":true,"Manufacturer":"stranger","Model":"Volkswagen Camry","ModelYear":"sundae","SerialNumber":"premeditation","Type":"Retail"},"ItemPercent":"Table","LineNumber":607,"Memo":"nephew","MeterIn":843.04,"MeterOut":170.17,"NonTaxable":true,"OutDateTime":"2025-12-06T20:16:48.802Z","Quantity":41,"TypeId":756,"TypeName":"OtherIncome"}]

A collection of line items related to the contract Id.

OtherTotal
number
Default: 87.32

Total price of other/miscellaneous items on the contract.

OrderedBy
string or null

Customer representative who originated the contract.

PaidTotal
number
Default: 836.14

Total amount paid prior to the contract being closed.

PickedUpBy
string or null

Customer representative who picked up the items.

RentTotal
number
Default: 732.26

Total price of rental items on the contract.

RevenueDateTime
string <date-time>
Default: "2025-08-28T08:47:37.225Z"

Date and time of the revenue posting.

SaleTotal
number
Default: "Shirt"

Total price of sale items on the contract.

StartDateTime
string <date-time>
Default: "2026-06-28T07:50:56.684Z"

Date and time of when the contract opened.

State
string
Default: "Error"
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: 345.83

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:
ApiKey
path Parameters
InvoiceId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "AccountReceivableInvoice"
Value: "AccountReceivableInvoice"
Id
string

Unique identifier for the model type.

ContractTotal
number
Default: 912.13

Total price of the contract excluding sales tax total.

ContractType
string
Default: "Invoice"
Enum: "Cash" "Credit" "Invoice"

Type of contract.

CurrencyCode
string or null

Currency code value set in the accounting system.

CustomerPurchaseOrderNumber
string or null

Customer purchase order number associated to the invoice.

DamageWaiverTotal
number
Default: 231.38

Total price of the damage waiver.

object
Default: {"Type":"Default","City":"Port Malindamouth","Line1":"432 Skiles Mews","PostalCode":"35306-0982","Province":"Nebraska"}

Ship to / delivery details associated to the contract on the invoice.

Type
string
Default: "Default"
Value: "Default"
City
string
Default: "Port Malindamouth"
Line1
string
Default: "432 Skiles Mews"
PostalCode
string
Default: "35306-0982"
Province
string
Default: "Nebraska"
EndDateTime
string or null <date-time>

Date and time when the contract was closed.

ErrorCode
string or null

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever invoice State is set to 'Error'.

ExchangeRate
number or null

Exchange rate of the contract on the invoice.

GrandTaxTotal
number
Default: 76.93

Total amount of sales tax invoiced.

GrandTotal
number
Default: 785.17

Total price of the contract including sales tax.

object
Default: {"ContractId":148,"BatchId":949,"ContractStoreId":324,"CustomerId":680,"ExternalLocationId":700,"ExternalInvoiceId":827,"ExternalCustomerId":368,"ParentContractId":134}

Collection of unique ids related to this invoice.

ContractId
string
Default: 148

Contract Id associated to the invoice which maps to the /Invoices Id property.

BatchId
string or null
Default: 949

Elite accounting batch id associated with the invoice.

ContractStoreId
string
Default: 324

Store Id associated to the contract on the invoice.

CustomerId
string or null
Default: 680

Elite customer id associated with the invoice.

ExternalLocationId
string or null
Default: 700

External location Id associated to the invoice.

ExternalInvoiceId
string or null
Default: 827

External invoice Id associated to the invoice.

*Only required if State is being set to 'Posted'

ExternalCustomerId
string or null
Default: 368

The value from a 3rd party system that identifies the Customer record for integrations.

ParentContractId
string or null
Default: 134

Parent contract id associated with the invoice.

InvoiceNumber
string or null

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

Total value of item percentage on the contract.

Array of objects
Default: [{"ModelType":"AccountReceivableInvoiceLineItem","Id":502,"AccountingClass":"casement","DamageWaiverPercent":329.55,"DiscountPercent":65,"DiscountTotal":96,"DueDateTime":"2026-06-09T21:31:57.404Z","ExtendedPriceTotal":727.25,"GrandTaxTotal":94.5,"GrandTotal":109.44,"HoursCharged":346.45,"Identifiers":{"InvoiceId":609,"ContractId":473,"GeneralLedgerAccountId":781,"GeneralLedgerOffsetAccountId":689},"Item":{"ModelType":"Item","Id":302,"Name":"Lorena Franecki","Key":"atrium","CategoryId":133,"CategoryName":"Ella Lakin","Description":"SAMPLE: whether which unless fake around aha secret along where majestically","IsAsset":true,"Manufacturer":"character","Model":"Nissan Model 3","ModelYear":"futon","SerialNumber":"conservative","Type":"Retail"},"ItemPercent":"Cheese","LineNumber":835,"Memo":"requirement","MeterIn":485.14,"MeterOut":3.59,"NonTaxable":true,"OutDateTime":"2025-01-18T04:51:10.706Z","Quantity":12,"TypeId":522,"TypeName":"DamageWaiver"},{"ModelType":"AccountReceivableInvoiceLineItem","Id":387,"AccountingClass":"distinction","DamageWaiverPercent":734.84,"DiscountPercent":41,"DiscountTotal":88,"DueDateTime":"2025-12-08T11:07:04.905Z","ExtendedPriceTotal":445.15,"GrandTaxTotal":637.61,"GrandTotal":408.77,"HoursCharged":710.78,"Identifiers":{"InvoiceId":670,"ContractId":835,"GeneralLedgerAccountId":51,"GeneralLedgerOffsetAccountId":449},"Item":{"ModelType":"Item","Id":899,"Name":"Colin Morissette","Key":"hydrolyze","CategoryId":197,"CategoryName":"Valerie Muller","Description":"SAMPLE: overplay wobbly wherever engender along dereference youthfully lamp yet never","IsAsset":false,"Manufacturer":"making","Model":"Ford Cruze","ModelYear":"muscat","SerialNumber":"cappelletti","Type":"Retail"},"ItemPercent":"Pizza","LineNumber":490,"Memo":"status","MeterIn":75.4,"MeterOut":996.05,"NonTaxable":true,"OutDateTime":"2025-05-15T03:49:55.395Z","Quantity":35,"TypeId":585},{"ModelType":"AccountReceivableInvoiceLineItem","Id":558,"AccountingClass":"pine","DamageWaiverPercent":970.72,"DiscountPercent":39,"DiscountTotal":22,"DueDateTime":"2026-04-27T03:09:47.573Z","ExtendedPriceTotal":706.99,"GrandTaxTotal":738.28,"GrandTotal":178.3,"HoursCharged":250.2,"Identifiers":{"InvoiceId":713,"ContractId":720,"GeneralLedgerAccountId":707,"GeneralLedgerOffsetAccountId":736},"Item":{"ModelType":"Item","Id":242,"Name":"Mrs. Kim Lockman","Key":"beret","CategoryId":126,"CategoryName":"Willie Wolf Sr.","Description":"SAMPLE: how trouser frank pish failing commonly own gee but drat","IsAsset":true,"Manufacturer":"stranger","Model":"Volkswagen Camry","ModelYear":"sundae","SerialNumber":"premeditation","Type":"Retail"},"ItemPercent":"Table","LineNumber":607,"Memo":"nephew","MeterIn":843.04,"MeterOut":170.17,"NonTaxable":true,"OutDateTime":"2025-12-06T20:16:48.802Z","Quantity":41,"TypeId":756,"TypeName":"OtherIncome"}]

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 or null
Enum: "TransItem" "SalesTax" "DamageWaiver" "ItemPercentage" "OtherIncome" "PaidPriorToClose" "Credit" "Disbursement"

Invoice line item type name

OtherTotal
number
Default: 87.32

Total price of other/miscellaneous items on the contract.

OrderedBy
string or null

Customer representative who originated the contract.

PaidTotal
number
Default: 836.14

Total amount paid prior to the contract being closed.

PickedUpBy
string or null

Customer representative who picked up the items.

RentTotal
number
Default: 732.26

Total price of rental items on the contract.

RevenueDateTime
string <date-time>
Default: "2025-08-28T08:47:37.225Z"

Date and time of the revenue posting.

SaleTotal
number
Default: "Shirt"

Total price of sale items on the contract.

StartDateTime
string <date-time>
Default: "2026-06-28T07:50:56.684Z"

Date and time of when the contract opened.

State
string
Default: "Error"
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: 345.83

Total taxable price of the contract.

Response samples

Content type
application/json
{
  • "ModelType": "AccountReceivableInvoice",
  • "ContractTotal": 912.13,
  • "ContractType": "Invoice",
  • "DamageWaiverTotal": 231.38,
  • "Delivery": {
    },
  • "GrandTaxTotal": 76.93,
  • "GrandTotal": 785.17,
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "OtherTotal": 87.32,
  • "PaidTotal": 836.14,
  • "RentTotal": 732.26,
  • "RevenueDateTime": "2025-08-28T08:47:37.225Z",
  • "SaleTotal": "Shirt",
  • "StartDateTime": "2026-06-28T07:50:56.684Z",
  • "State": "Error",
  • "TaxableTotal": 345.83
}

[Elite Account Receivable Invoices] Update

Update a single Elite account receivable invoice

Authorizations:
ApiKey
path Parameters
InvoiceId
required
string
Request Body schema: application/json
required
Id
string

Unique identifier for the model type.

ErrorCode
string or null

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever invoice State is set to 'Error'.

object
Default: {"ContractId":559,"BatchId":985,"ContractStoreId":241,"CustomerId":192,"ExternalLocationId":427,"ExternalInvoiceId":404,"ExternalCustomerId":241}

Collection of unique ids related to this invoice.

ExternalInvoiceId
string or null
Default: 404

External invoice Id associated to the invoice.

*Only required if State is being set to 'Posted'

State
string
Default: "Error"
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: "AccountReceivableInvoice"
Value: "AccountReceivableInvoice"
Id
string

Unique identifier for the model type.

ContractTotal
number
Default: 912.13

Total price of the contract excluding sales tax total.

ContractType
string
Default: "Invoice"
Enum: "Cash" "Credit" "Invoice"

Type of contract.

CurrencyCode
string or null

Currency code value set in the accounting system.

CustomerPurchaseOrderNumber
string or null

Customer purchase order number associated to the invoice.

DamageWaiverTotal
number
Default: 231.38

Total price of the damage waiver.

object
Default: {"Type":"Default","City":"Port Malindamouth","Line1":"432 Skiles Mews","PostalCode":"35306-0982","Province":"Nebraska"}

Ship to / delivery details associated to the contract on the invoice.

Type
string
Default: "Default"
Value: "Default"
City
string
Default: "Port Malindamouth"
Line1
string
Default: "432 Skiles Mews"
PostalCode
string
Default: "35306-0982"
Province
string
Default: "Nebraska"
EndDateTime
string or null <date-time>

Date and time when the contract was closed.

ErrorCode
string or null

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever invoice State is set to 'Error'.

ExchangeRate
number or null

Exchange rate of the contract on the invoice.

GrandTaxTotal
number
Default: 76.93

Total amount of sales tax invoiced.

GrandTotal
number
Default: 785.17

Total price of the contract including sales tax.

object
Default: {"ContractId":148,"BatchId":949,"ContractStoreId":324,"CustomerId":680,"ExternalLocationId":700,"ExternalInvoiceId":827,"ExternalCustomerId":368,"ParentContractId":134}

Collection of unique ids related to this invoice.

ContractId
string
Default: 148

Contract Id associated to the invoice which maps to the /Invoices Id property.

BatchId
string or null
Default: 949

Elite accounting batch id associated with the invoice.

ContractStoreId
string
Default: 324

Store Id associated to the contract on the invoice.

CustomerId
string or null
Default: 680

Elite customer id associated with the invoice.

ExternalLocationId
string or null
Default: 700

External location Id associated to the invoice.

ExternalInvoiceId
string or null
Default: 827

External invoice Id associated to the invoice.

*Only required if State is being set to 'Posted'

ExternalCustomerId
string or null
Default: 368

The value from a 3rd party system that identifies the Customer record for integrations.

ParentContractId
string or null
Default: 134

Parent contract id associated with the invoice.

InvoiceNumber
string or null

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

Total value of item percentage on the contract.

Array of objects
Default: [{"ModelType":"AccountReceivableInvoiceLineItem","Id":502,"AccountingClass":"casement","DamageWaiverPercent":329.55,"DiscountPercent":65,"DiscountTotal":96,"DueDateTime":"2026-06-09T21:31:57.404Z","ExtendedPriceTotal":727.25,"GrandTaxTotal":94.5,"GrandTotal":109.44,"HoursCharged":346.45,"Identifiers":{"InvoiceId":609,"ContractId":473,"GeneralLedgerAccountId":781,"GeneralLedgerOffsetAccountId":689},"Item":{"ModelType":"Item","Id":302,"Name":"Lorena Franecki","Key":"atrium","CategoryId":133,"CategoryName":"Ella Lakin","Description":"SAMPLE: whether which unless fake around aha secret along where majestically","IsAsset":true,"Manufacturer":"character","Model":"Nissan Model 3","ModelYear":"futon","SerialNumber":"conservative","Type":"Retail"},"ItemPercent":"Cheese","LineNumber":835,"Memo":"requirement","MeterIn":485.14,"MeterOut":3.59,"NonTaxable":true,"OutDateTime":"2025-01-18T04:51:10.706Z","Quantity":12,"TypeId":522,"TypeName":"DamageWaiver"},{"ModelType":"AccountReceivableInvoiceLineItem","Id":387,"AccountingClass":"distinction","DamageWaiverPercent":734.84,"DiscountPercent":41,"DiscountTotal":88,"DueDateTime":"2025-12-08T11:07:04.905Z","ExtendedPriceTotal":445.15,"GrandTaxTotal":637.61,"GrandTotal":408.77,"HoursCharged":710.78,"Identifiers":{"InvoiceId":670,"ContractId":835,"GeneralLedgerAccountId":51,"GeneralLedgerOffsetAccountId":449},"Item":{"ModelType":"Item","Id":899,"Name":"Colin Morissette","Key":"hydrolyze","CategoryId":197,"CategoryName":"Valerie Muller","Description":"SAMPLE: overplay wobbly wherever engender along dereference youthfully lamp yet never","IsAsset":false,"Manufacturer":"making","Model":"Ford Cruze","ModelYear":"muscat","SerialNumber":"cappelletti","Type":"Retail"},"ItemPercent":"Pizza","LineNumber":490,"Memo":"status","MeterIn":75.4,"MeterOut":996.05,"NonTaxable":true,"OutDateTime":"2025-05-15T03:49:55.395Z","Quantity":35,"TypeId":585},{"ModelType":"AccountReceivableInvoiceLineItem","Id":558,"AccountingClass":"pine","DamageWaiverPercent":970.72,"DiscountPercent":39,"DiscountTotal":22,"DueDateTime":"2026-04-27T03:09:47.573Z","ExtendedPriceTotal":706.99,"GrandTaxTotal":738.28,"GrandTotal":178.3,"HoursCharged":250.2,"Identifiers":{"InvoiceId":713,"ContractId":720,"GeneralLedgerAccountId":707,"GeneralLedgerOffsetAccountId":736},"Item":{"ModelType":"Item","Id":242,"Name":"Mrs. Kim Lockman","Key":"beret","CategoryId":126,"CategoryName":"Willie Wolf Sr.","Description":"SAMPLE: how trouser frank pish failing commonly own gee but drat","IsAsset":true,"Manufacturer":"stranger","Model":"Volkswagen Camry","ModelYear":"sundae","SerialNumber":"premeditation","Type":"Retail"},"ItemPercent":"Table","LineNumber":607,"Memo":"nephew","MeterIn":843.04,"MeterOut":170.17,"NonTaxable":true,"OutDateTime":"2025-12-06T20:16:48.802Z","Quantity":41,"TypeId":756,"TypeName":"OtherIncome"}]

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 or null
Enum: "TransItem" "SalesTax" "DamageWaiver" "ItemPercentage" "OtherIncome" "PaidPriorToClose" "Credit" "Disbursement"

Invoice line item type name

OtherTotal
number
Default: 87.32

Total price of other/miscellaneous items on the contract.

OrderedBy
string or null

Customer representative who originated the contract.

PaidTotal
number
Default: 836.14

Total amount paid prior to the contract being closed.

PickedUpBy
string or null

Customer representative who picked up the items.

RentTotal
number
Default: 732.26

Total price of rental items on the contract.

RevenueDateTime
string <date-time>
Default: "2025-08-28T08:47:37.225Z"

Date and time of the revenue posting.

SaleTotal
number
Default: "Shirt"

Total price of sale items on the contract.

StartDateTime
string <date-time>
Default: "2026-06-28T07:50:56.684Z"

Date and time of when the contract opened.

State
string
Default: "Error"
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: 345.83

Total taxable price of the contract.

Request samples

Content type
application/json
{
  • "ModelType": "AccountReceivableInvoice",
  • "ContractTotal": 297.86,
  • "ContractType": "Cash",
  • "DamageWaiverTotal": 429.02,
  • "Delivery": {
    },
  • "GrandTaxTotal": 113.59,
  • "GrandTotal": 629.17,
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "OtherTotal": 816.31,
  • "PaidTotal": 404.32,
  • "RentTotal": 490.23,
  • "RevenueDateTime": "2025-08-05T04:03:00.350Z",
  • "SaleTotal": "Towels",
  • "StartDateTime": "2025-02-26T08:38:45.911Z",
  • "State": "Error",
  • "TaxableTotal": 301.46
}

Response samples

Content type
application/json
{
  • "ModelType": "AccountReceivableInvoice",
  • "ContractTotal": 912.13,
  • "ContractType": "Invoice",
  • "DamageWaiverTotal": 231.38,
  • "Delivery": {
    },
  • "GrandTaxTotal": 76.93,
  • "GrandTotal": 785.17,
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "OtherTotal": 87.32,
  • "PaidTotal": 836.14,
  • "RentTotal": 732.26,
  • "RevenueDateTime": "2025-08-28T08:47:37.225Z",
  • "SaleTotal": "Shirt",
  • "StartDateTime": "2026-06-28T07:50:56.684Z",
  • "State": "Error",
  • "TaxableTotal": 345.83
}

[Elite Account Receivable Payments] Get All

All Elite account receivable payments, use query parameters to filter

Authorizations:
ApiKey

Responses

Response Schema: application/json
Array
ModelType
string
Default: "AccountReceivablePayment"
Value: "AccountReceivablePayment"
Id
string
Default: "34"

Unique identifier for the model type.

ContractCodeName
string
Default: "Payment"
Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment.

ErrorCode
string or null

Error code value whenever the payment State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever payment State is set to 'Error'.

GrandTotal
number
Default: 100.25

Total amount credited to the customer invoice.

object
Default: {"ContractId":"7755090","ExternalContractId":"CO-0000001","CustomerId":"12"}
Memo
string
Default: "Payment being processed through the front counter terminal."

Note, reference or description related to the payment.

Method
string
Default: "Card"
Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

TransactionDate
string <date-time>
Default: "2024-12-01T20:00:00.000Z"

Date and time when the payment was posted.

State
string
Default: "Posted"
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>

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:
ApiKey
Request Body schema: application/json
required
ContractCodeName
required
string
Default: "Payment"
Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment.

required
object
Default: {"ContractId":"775511","CustomerId":"8","ExternalContractId":"775511"}

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: "775511"

External contract Id in the accounting system.

One of the following is REQUIRED to be set: ContractId, ExternalContractId, ExternalInvoiceId, or InvoiceNumber.

ContractId
string
Default: "775511"

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

The Sequential Invoice Number associated with the Contract.

One of the following is REQUIRED to be set: ContractId, ExternalContractId, ExternalInvoiceId, or InvoiceNumber.

ExternalInvoiceId
string

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

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

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

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: "8"

Elite Customer Id associated with the payment.

One of the following is REQUIRED to be set: CustomerId or ExternalCustomerId.

ExternalCustomerId
string

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: 100

Total amount credited to the customer invoice.

Memo
string
Default: "test"

Note, reference or description related to the payment.

Method
string
Default: "Cash"
Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

REQUIRED if ContractCodeName = 'Payment'.

TransactionDate
string <date-time>
Default: "2025-01-10T14:15:22Z"

Date and time when the payment was posted.

Responses

Request samples

Content type
application/json
{
  • "ContractCodeName": "Payment",
  • "GrandTotal": 100,
  • "Memo": "test",
  • "Method": "Cash",
  • "TransactionDate": "2025-01-10T14:15:22Z",
  • "Identifiers": {
    }
}

Response samples

Content type
application/json
{
  • "ModelType": "AccountReceivablePayment",
  • "Id": "34",
  • "ContractCodeName": "Payment",
  • "GrandTotal": 100.25,
  • "Identifiers": {
    },
  • "Memo": "Payment being processed through the front counter terminal.",
  • "Method": "Card",
  • "TransactionDate": "2024-12-01T20:00:00.000Z",
  • "State": "Posted"
}

[Elite Account Receivable Payments] Get By Id

Single Elite account receivable payment by Id

Authorizations:
ApiKey
path Parameters
PaymentId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "AccountReceivablePayment"
Value: "AccountReceivablePayment"
Id
string
Default: "34"

Unique identifier for the model type.

ContractCodeName
string
Default: "Payment"
Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment.

ErrorCode
string or null

Error code value whenever the payment State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever payment State is set to 'Error'.

GrandTotal
number
Default: 100.25

Total amount credited to the customer invoice.

object
Default: {"ContractId":"7755090","ExternalContractId":"CO-0000001","CustomerId":"12"}
ContractId
string
Default: "7755090"

Contract Id associated to the payment. Contract that has credit or payment applied.

InvoiceNumber
string

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

External invoice Id in the accounting system. It must be associated with an Elite contract accounting link.

ExternalContractId
string
Default: "CO-0000001"

External contract Id in the accounting system.

CreditSourceContractId
string

Contract Id sourcing the credit amount. This is the credit contract that sourced the credit being applied.

CreditSourceInvoiceNumber
string

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

External credit memo Id in the accounting system. Credit Id must be associated to a contract accounting link.

CustomerId
string
Default: "12"

Elite Customer Id associated with the payment.

ExternalCustomerId
string

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: "Payment being processed through the front counter terminal."

Note, reference or description related to the payment.

Method
string
Default: "Card"
Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

TransactionDate
string <date-time>
Default: "2024-12-01T20:00:00.000Z"

Date and time when the payment was posted.

State
string
Default: "Posted"
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>

Date and time when the payment was added to the queue.

Response samples

Content type
application/json
{
  • "ModelType": "AccountReceivablePayment",
  • "Id": "34",
  • "ContractCodeName": "Payment",
  • "GrandTotal": 100.25,
  • "Identifiers": {
    },
  • "Memo": "Payment being processed through the front counter terminal.",
  • "Method": "Card",
  • "TransactionDate": "2024-12-01T20:00:00.000Z",
  • "State": "Posted"
}

Fulfillment

Supported by: Elite

The Fulfillment endpoints provide functionality for tracking and managing the fulfillment of rental contracts in Elite.

Overview

Fulfillment tracking allows rental companies to monitor the progress of contract fulfillment, including:

  • Adding fulfillment actions for specific line items
  • Tracking quantities fulfilled vs. ordered
  • Recording visual inspections (eyeballed items)
  • Maintaining a history of fulfillment actions
  • Looking up available fulfillment action types

Key Concepts

  • Fulfillment Actions: Specific actions taken during the fulfillment process (e.g., "Picked", "Loaded", "Delivered")
  • Serialized Line Items: Individual stock items that are being fulfilled
  • Eyeballed: A flag indicating that the quantity was estimated through visual inspection rather than precise measurement
  • Contract Fulfillment: The overall process of fulfilling all line items within a rental contract

Workflow

  1. Use the lookup endpoint to get available fulfillment action IDs
  2. Add fulfillment actions for specific line items as they are processed
  3. Track progress by retrieving fulfillment status for contracts or individual line items
  4. Review fulfillment history to understand the complete fulfillment timeline

Common Use Cases

  • Warehouse Operations: Track items as they are picked and prepared for delivery
  • Delivery Management: Record when items are loaded onto delivery vehicles
  • Customer Service: Provide real-time updates on fulfillment status
  • Inventory Management: Monitor stock movement during the fulfillment process

[Fulfillment] Add Fulfillment Serialized Line Item

Supported by: Elite

Adds a serialized line item

Authorizations:
ApiKey
Request Body schema: application/json
required
QuantityActioned
required
number
Default: 564.06

Quantity of the item being actioned. (can be negative)

StockId
required
string
Default: 844

The item id being fulfilled.

ActionId
required
string
Default: 314

The id for the fulfillment action being taken. The id must exist in enumlookup/fulfillment/actionid

LineItemId
string
Default: 809

The line item id associated with the fulfillment line item

Eyeballed
boolean
Default: true

Indicator if the item has been visually inspected during fulfillment. Generally used to indicate if the quantity has been estimated.

Notes
string
Default: "fencing"

The note associated with the fulfillment serialized line item

Responses

Request samples

Content type
application/json
{
  • "LineItemId": 809,
  • "ActionId": 314,
  • "QuantityActioned": 564.06,
  • "StockId": 844,
  • "Eyeballed": true,
  • "Notes": "fencing"
}

Response samples

Content type
application/json
{
  • "ContractId": 844,
  • "LineItemId": 774,
  • "StockId": 30,
  • "ActionId": 999,
  • "ActionName": "Ms. Ernestine Reilly",
  • "ActionSourceId": 145,
  • "ActionSourceName": "Wanda Bechtelar",
  • "QuantityActioned": 751.6,
  • "Eyeballed": true,
  • "Notes": "mythology",
  • "RemoteUserId": 281
}

Enum Lookup for Fulfillment Routes

Supported by: Elite

With this endpoint, you can look up the fulfillment action id. These will be used with the actionid field in the fulfillment endpoints.

Authorizations:
ApiKey
path Parameters
field
required
string

Responses

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

Indicates the type of lookup being performed. While most endpoints return a single type, some specialized endpoints may support multiple lookup types for different reference data categories.

Id
string
Default: "LU-2024-001-ABC"

The unique identifier for this lookup record. System-generated and immutable, though it can be referenced in bulk update operations. Used for maintaining referential integrity across the system.

Name
string or null
Default: "Aerial Work Platform - Scissor Lift"

A human-readable display name for this lookup value. Commonly used in dropdowns and selection interfaces. Examples include equipment categories, status types, or payment terms.

Description
string or null
Default: "Self-propelled elevating work platform with extending platform for heights up to 40ft"

Additional details about the lookup value that provide context or clarification. May include usage guidelines or business rules associated with this value.

Field
string
Default: "EquipmentCategory"

The system field or attribute this lookup value is associated with. Used to categorize and organize lookup values by their functional area or purpose.

Value
string
Default: "AWP-SCSR"

The actual stored value or code used in the system. While the Name field is for display, this is the underlying value used in database operations and API calls.

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Fulfillment Line Items for a Contract

Supported by: Elite

Authorizations:
ApiKey
path Parameters
ContractId
required
string

Responses

Response Schema: application/json
Array
ContractId
string
Default: 3

The contract id associated with the fulfillment serialized line item

LineItemId
string
Default: 87

The line item id associated with the fulfillment serialized line item

StockId
string
Default: 791

The id of the stock item of the line item

StockName
string or null

The name of the stock of the line item

ProductId
string or null

The id of the product item of the line item

ProductName
string or null

The name of the product item of the line item

ItemDepartmentId
string or null

The id of the department that the item is under

ItemDepartmentName
string or null

The name of the department that the item is under

Array of objects
Default: [{"Id":117,"Name":"Adrienne Ankunding","QuantityFulfilled":958.1,"QuantityRemaining":383.66,"AreAnyEyeballed":false,"LastFulfillmentDateTime":"2025-03-28T06:52:32.605Z","FirstFulfillmentDateTime":"2026-09-28T01:12:20.764Z"},{"Id":332,"Name":"Antonio Williamson Sr.","QuantityFulfilled":371.92,"QuantityRemaining":216.54,"AreAnyEyeballed":false,"LastFulfillmentDateTime":"2026-09-29T09:52:23.199Z","FirstFulfillmentDateTime":"2026-01-06T15:04:20.937Z"},{"Id":835,"Name":"Casey Roberts","QuantityFulfilled":344.72,"QuantityRemaining":906.52,"AreAnyEyeballed":true,"LastFulfillmentDateTime":"2024-11-27T16:57:46.212Z","FirstFulfillmentDateTime":"2026-03-25T11:42:06.886Z"}]

The list of fulfillment actions

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve Fulfillment Line Items by Id

Supported by: Elite

Authorizations:
ApiKey
path Parameters
LineItemId
required
string

Responses

Response Schema: application/json
ContractId
string
Default: 3

The contract id associated with the fulfillment serialized line item

LineItemId
string
Default: 87

The line item id associated with the fulfillment serialized line item

StockId
string
Default: 791

The id of the stock item of the line item

StockName
string or null

The name of the stock of the line item

ProductId
string or null

The id of the product item of the line item

ProductName
string or null

The name of the product item of the line item

ItemDepartmentId
string or null

The id of the department that the item is under

ItemDepartmentName
string or null

The name of the department that the item is under

Array of objects
Default: [{"Id":117,"Name":"Adrienne Ankunding","QuantityFulfilled":958.1,"QuantityRemaining":383.66,"AreAnyEyeballed":false,"LastFulfillmentDateTime":"2025-03-28T06:52:32.605Z","FirstFulfillmentDateTime":"2026-09-28T01:12:20.764Z"},{"Id":332,"Name":"Antonio Williamson Sr.","QuantityFulfilled":371.92,"QuantityRemaining":216.54,"AreAnyEyeballed":false,"LastFulfillmentDateTime":"2026-09-29T09:52:23.199Z","FirstFulfillmentDateTime":"2026-01-06T15:04:20.937Z"},{"Id":835,"Name":"Casey Roberts","QuantityFulfilled":344.72,"QuantityRemaining":906.52,"AreAnyEyeballed":true,"LastFulfillmentDateTime":"2024-11-27T16:57:46.212Z","FirstFulfillmentDateTime":"2026-03-25T11:42:06.886Z"}]

The list of fulfillment actions

Array
Id
string

The action Id

Name
string

The action name

QuantityFulfilled
number

The accumulation of quantities actioned against the line item

QuantityRemaining
number

The quantity to still be actioned

AreAnyEyeballed
boolean

True if any of the fulfillment serialized line items have been eyeballed

LastFulfillmentDateTime
string or null <date-time>

When the last action was taken against the line item

FirstFulfillmentDateTime
string or null <date-time>

When the first action was taken against the line item

Response samples

Content type
application/json
{
  • "ContractId": 3,
  • "LineItemId": 87,
  • "StockId": 791,
  • "Actions": [
    ]
}

Retrieve Fulfillment Serialized Line Item History

Supported by: Elite

Authorizations:
ApiKey
path Parameters
LineItemId
required
string

Responses

Response Schema: application/json
Array
ContractId
string
Default: 844

The contract id associated with the fulfillment serialized line item

LineItemId
string
Default: 774

The line item id associated with the fulfillment serialized line item

StockId
string
Default: 30

The id of the stock item of the line item

StockName
string or null

The name of the stock of the line item

ProductId
string or null

The id of the product item of the line item

ProductName
string or null

The name of the product item of the line item

ItemDepartmentId
string or null

The id of the department that the item is under

ItemDepartmentName
string or null

The name of the department that the item is under

ActionId
string
Default: 999

The id for the fulfillment action being taken. The id must exist in enumlookup/fulfillment/actionid

ActionName
string
Default: "Ms. Ernestine Reilly"

The name for the fulfillment action

ActionSourceId
string
Default: 145

The id of the action source, 1- Core, 2- WorkForce, 3-RFID, 4. POROne

ActionSourceName
string
Default: "Wanda Bechtelar"

The name of the action source

QuantityActioned
number
Default: 751.6

The quantity that was processed during this fulfillment action

CreatedDateTime
string <date-time>

The date and time when the fulfillment serialized line item was added

Eyeballed
boolean
Default: true

Indicator if the item has been visually inspected during fulfillment. Generally used to indicate if the quantity has been estimated.

Notes
string
Default: "mythology"

The note associated with the fulfillment request

RemoteUserId
string
Default: 281

The operator id who added the fulfillment serialized line item

Response samples

Content type
application/json
[
  • {
    }
]

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:
ApiKey

Responses

Response Schema: application/json
Array
ModelType
string
Default: "JournalEntry"
Value: "JournalEntry"
Id
string

Unique identifier for the model type.

object
Default: {"Class":"duster","Contract":"widow","Customer":"completion","Department":"Jewelry","Employee":"airmail","Item":"Shirt","JobSite":"pupil","Location":"5652 W 14th Street","Project":"gloom","SalesPerson":"Cheese","Vendor":"supplier"}

Collection of dimensions related to a specific type.

EntryDateTime
string or null

Date and time when the journal entry was created.

ErrorCode
string or null

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever invoice State is set to 'Error'.

object
Default: {"BatchId":421,"ExternalJournalEntryId":675}

Collection of unique ids related to this invoice line item.

Array of objects
Default: [{"ModelType":"JournalEntryLineItem","Id":742,"GrandTotal":14.97,"Identifiers":{"ContractId":479,"CustomerId":911,"ExternalContractId":159,"ExternalCustomerId":262,"JournalEntryAccountId":508,"JournalEntryId":783},"Memo":"oil"},{"ModelType":"JournalEntryLineItem","Id":865,"GrandTotal":751.8,"Identifiers":{"ContractId":172,"CustomerId":930,"ExternalContractId":151,"ExternalCustomerId":21,"JournalEntryAccountId":464,"JournalEntryId":375},"Memo":"charlatan"},{"ModelType":"JournalEntryLineItem","Id":156,"GrandTotal":690.79,"Identifiers":{"ContractId":307,"CustomerId":75,"ExternalContractId":410,"ExternalCustomerId":151,"JournalEntryAccountId":411,"JournalEntryId":436},"Memo":"hovel"}]

A collection of line items related to the contract Id.

Memo
string or null

Memo associated to the journal entry.

State
string
Default: "Pending"
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:
ApiKey
path Parameters
JournalEntryId
required
string

Responses

Response Schema: application/json
ModelType
string
Default: "JournalEntry"
Value: "JournalEntry"
Id
string

Unique identifier for the model type.

object
Default: {"Class":"duster","Contract":"widow","Customer":"completion","Department":"Jewelry","Employee":"airmail","Item":"Shirt","JobSite":"pupil","Location":"5652 W 14th Street","Project":"gloom","SalesPerson":"Cheese","Vendor":"supplier"}

Collection of dimensions related to a specific type.

Class
string
Default: "duster"

Class dimension.

Contract
string
Default: "widow"

Contract dimension.

Customer
string
Default: "completion"

Customer dimension.

Department
string
Default: "Jewelry"

Department dimension.

Employee
string
Default: "airmail"

Employee dimension.

Item
string
Default: "Shirt"

Item dimension.

JobSite
string
Default: "pupil"

JobSite dimension.

Location
string
Default: "5652 W 14th Street"

Location dimension.

Project
string
Default: "gloom"

Project dimension.

SalesPerson
string
Default: "Cheese"

SalesPerson dimension.

Vendor
string
Default: "supplier"

Vendor dimension.

EntryDateTime
string or null

Date and time when the journal entry was created.

ErrorCode
string or null

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever invoice State is set to 'Error'.

object
Default: {"BatchId":421,"ExternalJournalEntryId":675}

Collection of unique ids related to this invoice line item.

BatchId
string or null
Default: 421

Elite accounting batch Id associated with the journal entry.

ExternalJournalEntryId
string or null
Default: 675

External journal entry Id in the accounting system.

Array of objects
Default: [{"ModelType":"JournalEntryLineItem","Id":742,"GrandTotal":14.97,"Identifiers":{"ContractId":479,"CustomerId":911,"ExternalContractId":159,"ExternalCustomerId":262,"JournalEntryAccountId":508,"JournalEntryId":783},"Memo":"oil"},{"ModelType":"JournalEntryLineItem","Id":865,"GrandTotal":751.8,"Identifiers":{"ContractId":172,"CustomerId":930,"ExternalContractId":151,"ExternalCustomerId":21,"JournalEntryAccountId":464,"JournalEntryId":375},"Memo":"charlatan"},{"ModelType":"JournalEntryLineItem","Id":156,"GrandTotal":690.79,"Identifiers":{"ContractId":307,"CustomerId":75,"ExternalContractId":410,"ExternalCustomerId":151,"JournalEntryAccountId":411,"JournalEntryId":436},"Memo":"hovel"}]

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

Memo associated to the journal entry.

State
string
Default: "Pending"
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": "JournalEntry",
  • "Dimensions": {
    },
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "State": "Pending"
}

Update an existing General Ledger Journal Entry

Supported by: Elite

Update an existing General Ledger Journal Entry

Authorizations:
ApiKey
path Parameters
JournalEntryId
required
string
Request Body schema: application/json
required
Id
string

Unique identifier for the model type.

ErrorCode
string or null

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever invoice State is set to 'Error'.

object
Default: {"BatchId":43,"ExternalJournalEntryId":894}

Collection of unique ids related to this invoice line item.

ExternalJournalEntryId
string or null
Default: 894

External journal entry Id in the accounting system.

State
string
Default: "Posted"
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: "JournalEntry"
Value: "JournalEntry"
Id
string

Unique identifier for the model type.

object
Default: {"Class":"duster","Contract":"widow","Customer":"completion","Department":"Jewelry","Employee":"airmail","Item":"Shirt","JobSite":"pupil","Location":"5652 W 14th Street","Project":"gloom","SalesPerson":"Cheese","Vendor":"supplier"}

Collection of dimensions related to a specific type.

Class
string
Default: "duster"

Class dimension.

Contract
string
Default: "widow"

Contract dimension.

Customer
string
Default: "completion"

Customer dimension.

Department
string
Default: "Jewelry"

Department dimension.

Employee
string
Default: "airmail"

Employee dimension.

Item
string
Default: "Shirt"

Item dimension.

JobSite
string
Default: "pupil"

JobSite dimension.

Location
string
Default: "5652 W 14th Street"

Location dimension.

Project
string
Default: "gloom"

Project dimension.

SalesPerson
string
Default: "Cheese"

SalesPerson dimension.

Vendor
string
Default: "supplier"

Vendor dimension.

EntryDateTime
string or null

Date and time when the journal entry was created.

ErrorCode
string or null

Error code value whenever the invoice State is set to 'Error'.

ErrorDescription
string or null

Error description value whenever invoice State is set to 'Error'.

object
Default: {"BatchId":421,"ExternalJournalEntryId":675}

Collection of unique ids related to this invoice line item.

BatchId
string or null
Default: 421

Elite accounting batch Id associated with the journal entry.

ExternalJournalEntryId
string or null
Default: 675

External journal entry Id in the accounting system.

Array of objects
Default: [{"ModelType":"JournalEntryLineItem","Id":742,"GrandTotal":14.97,"Identifiers":{"ContractId":479,"CustomerId":911,"ExternalContractId":159,"ExternalCustomerId":262,"JournalEntryAccountId":508,"JournalEntryId":783},"Memo":"oil"},{"ModelType":"JournalEntryLineItem","Id":865,"GrandTotal":751.8,"Identifiers":{"ContractId":172,"CustomerId":930,"ExternalContractId":151,"ExternalCustomerId":21,"JournalEntryAccountId":464,"JournalEntryId":375},"Memo":"charlatan"},{"ModelType":"JournalEntryLineItem","Id":156,"GrandTotal":690.79,"Identifiers":{"ContractId":307,"CustomerId":75,"ExternalContractId":410,"ExternalCustomerId":151,"JournalEntryAccountId":411,"JournalEntryId":436},"Memo":"hovel"}]

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

Memo associated to the journal entry.

State
string
Default: "Pending"
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": "JournalEntry",
  • "Dimensions": {
    },
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "State": "Posted"
}

Response samples

Content type
application/json
{
  • "ModelType": "JournalEntry",
  • "Dimensions": {
    },
  • "Identifiers": {
    },
  • "LineItems": [
    ],
  • "State": "Pending"
}

Web Products

Supported by: Elite

Retrieve a list of WebProducts

Supported by: Elite

Elite supports the following fields for the Search filter:

  • Name
  • Identifiers.Key
Authorizations:
ApiKey

Responses

Response Schema: application/json
Array
ModelType
string
Value: "WebProduct"

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

object or null

Identifying items for WebProduct.

ProductId
string or null
Default: "17254"

The ProductId, if available, for this record. ProductId and StockId are mutually exclusive, but one or the other is guaranteed to exist.

StockId
string or null

The StockId, if available, for this record. ProductId and StockId are mutually exclusive, but one or the other is guaranteed to exist.

Name
string or null

The display name for the item.

Classification
string
Enum: "Rental" "Sale"

Whether this WebProduct is meant for sale or rental.

DepotId
string or null

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

DisplayOnStorefront
boolean

This determines if the WebProduct will have its own product display page on the storefront.

DisplayOrder
number or null >= 1

By default, we might sort by A to 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

A publicly accessible link to any instructions associated with this item.

IsPart
boolean or null

Used to determine if WebProduct is a part

Hidden
integer or null
Value: 1

Hidden - 0 for visible, 1 for hidden

CreatedDateTime
string <date-time>

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

UpdatedDateTime
string <date-time>

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

WebDescription
string or null

(Elite only) This is the text field currently present on rentalhosting as additional information/info

ModelName
string or null

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

OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.

CategoryName
string or null

Denormalized name of the Category.

Elite: Only supports one name.

Alias
string or null

(Elite Only) Lookup field in Elite.

number or string

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

ForSale
boolean or null

Indicates whether the stock item is designated for sale as used equipment. When true, the item is available for purchase as decommissioned rental equipment.

IsBulk
boolean or null

Indicates whether the used equipment item is sold in bulk quantities rather than individual (serialized) units.

WebGroup
string or null

(Elite only) Indicates the WebGroup of product. This is primarily a tool for sorting products within the display

PartNumber
string or null

The part number associated to a specific instance of a part.

Manufacturer
string or null

The manufacturer associated with a specific instance of an item.

ModelYear
string or null

OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.

MeteredHoursIn
number or null

OPTIONAL. Metered usage in number of hours.

SerialNumber
string or null

The serial number associated with a specific instance of an item.

WebLink
string or null

Multipurpose website URL, commonly used to link to manufacturer website.

Style1
string or null

(Elite only). Input for style 1, commonly used for linens

Style2
string or null

(Elite only) Input for style 2, commonly used for linens

Style3
string or null

(Elite only) Input for style 3, commonly used for linens

Height
number or null

OPTIONAL. Numeric representation of height dimensions of this web product. No unit of measurement is specified.

Width
number or null

OPTIONAL. Numeric representation of width dimensions of this web product. No unit of measurement is specified.

Length
number or null

OPTIONAL. Numeric representation of width dimensions of this web product. No unit of measurement is specified.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

RentalType
string or null
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"

SalesType
string or null
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"

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve a list of associations between WebProducts

Supported by: Elite

Authorizations:
ApiKey

Responses

Response Schema: application/json
ModelType
required
string
Default: "WebProductAssociation"
Value: "WebProductAssociation"

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

Id
required
string
Default: "WPA-2024-03-15-001"

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.

AssociationType
required
string
Default: "Optional"
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 (e.g., Concrete Kit with mixer, wheelbarrow, and tools). 'Automatic' items are required (e.g., safety equipment), while 'Optional' gives the user choice (e.g., additional attachments).

DisplayOrder
required
number
Default: 1

Defines a sort order for associated products. Lowest value will appear first in the list. Used to show most popular attachments first or organize kit components logically.

Hidden
required
boolean

0 = false, 1 = true | This basically means Deleted. Used to hide discontinued attachments or seasonal kit offerings without deleting the association.

ParentProductId
string
Default: "SKU-SKIDSTEER-S650"

Product Id of the parent in this relationship. For example, a Skid Steer would be the parent product that can have multiple attachments as children.

ParentStockId
string
Default: "STOCK-S650-123456"

Stock Id of the parent in this relationship. Represents a specific unit of the parent product, like a specific Skid Steer with serial number.

ChildProductId
string
Default: "SKU-ATTACHMENT-BUCKET-72"

Product Id of the child in this relationship. For example, a Bucket Attachment that can be added to the Skid Steer.

ChildStockId
string
Default: "STOCK-BUCKET-987654"

Stock Id of the child in this relationship. Represents a specific unit of the child product, like a specific 72-inch Bucket with serial number.

Group
string or null
Default: "Skid Steer Attachments"

Optional grouping for this relationship. For example, 'Skid Steer Attachments' or 'Safety Equipment' to group related items together.

GroupSelectionType
string
Default: "ChooseMany"
Enum: "ChooseOne" "ChooseMany" "ChooseQty"

Defines how selection should be treated amongst associations of the same group. CHOOSE_ONE for mutually exclusive options (e.g., only one bucket size), CHOOSE_MANY for multiple selections (e.g., multiple safety items), CHOOSE_QTY for quantity-based selections.

IsSelected
boolean
Default: true

Whether or not this item should be pre-selected. For example, pre-selecting required safety equipment or most popular attachment options.

CreatedDateTime
string or null <date-time>
Default: "2024-03-15T14:30:00Z"

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: "2024-03-15T15:45:00Z"

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

Elite: This field is not supported.

Disabled
boolean or null

Whether or not the record is disabled. Used to temporarily disable associations, such as when an attachment is under maintenance or a kit component is out of stock.

Quantity
number or null
Default: 4

Quantity of the referenced product that is allocated to this association. For example, 4 safety cones included with a light tower rental, or 2 batteries included with a cordless tool kit.

Response samples

Content type
application/json
{
  • "ModelType": "WebProductAssociation",
  • "Id": "WPA-2024-03-15-001",
  • "ParentProductId": "SKU-SKIDSTEER-S650",
  • "ParentStockId": "STOCK-S650-123456",
  • "ChildProductId": "SKU-ATTACHMENT-BUCKET-72",
  • "ChildStockId": "STOCK-BUCKET-987654",
  • "AssociationType": "Optional",
  • "Group": "Skid Steer Attachments",
  • "GroupSelectionType": "ChooseOne",
  • "IsSelected": true,
  • "DisplayOrder": 1,
  • "CreatedDateTime": "2024-03-15T14:30:00Z",
  • "UpdatedDateTime": "2024-03-15T15:45:00Z",
  • "Quantity": 4
}

Retrieve a single WebProduct by Id

Supported by: Elite

Retrieve a single WebProduct by Id

Authorizations:
ApiKey
path Parameters
Id
required
string

Responses

Response Schema: application/json
ModelType
string
Value: "WebProduct"

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

object or null

Identifying items for WebProduct.

Key
string or null

A customer defined Id for this item.

ProductId
string or null
Default: "17254"

The ProductId, if available, for this record. ProductId and StockId are mutually exclusive, but one or the other is guaranteed to exist.

StockId
string or null

The StockId, if available, for this record. ProductId and StockId are mutually exclusive, but one or the other is guaranteed to exist.

Name
string or null

The display name for the item.

Classification
string
Enum: "Rental" "Sale"

Whether this WebProduct is meant for sale or rental.

DepotId
string or null

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

DisplayOnStorefront
boolean

This determines if the WebProduct will have its own product display page on the storefront.

DisplayOrder
number or null >= 1

By default, we might sort by A to 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

A publicly accessible link to any instructions associated with this item.

IsPart
boolean or null

Used to determine if WebProduct is a part

Hidden
integer or null
Value: 1

Hidden - 0 for visible, 1 for hidden

CreatedDateTime
string <date-time>

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

UpdatedDateTime
string <date-time>

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

WebDescription
string or null

(Elite only) This is the text field currently present on rentalhosting as additional information/info

ModelName
string or null

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

OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.

CategoryName
string or null

Denormalized name of the Category.

Elite: Only supports one name.

Alias
string or null

(Elite Only) Lookup field in Elite.

number or string

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

One of
number

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

ForSale
boolean or null

Indicates whether the stock item is designated for sale as used equipment. When true, the item is available for purchase as decommissioned rental equipment.

IsBulk
boolean or null

Indicates whether the used equipment item is sold in bulk quantities rather than individual (serialized) units.

WebGroup
string or null

(Elite only) Indicates the WebGroup of product. This is primarily a tool for sorting products within the display

PartNumber
string or null

The part number associated to a specific instance of a part.

Manufacturer
string or null

The manufacturer associated with a specific instance of an item.

ModelYear
string or null

OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.

MeteredHoursIn
number or null

OPTIONAL. Metered usage in number of hours.

SerialNumber
string or null

The serial number associated with a specific instance of an item.

WebLink
string or null

Multipurpose website URL, commonly used to link to manufacturer website.

Style1
string or null

(Elite only). Input for style 1, commonly used for linens

Style2
string or null

(Elite only) Input for style 2, commonly used for linens

Style3
string or null

(Elite only) Input for style 3, commonly used for linens

Height
number or null

OPTIONAL. Numeric representation of height dimensions of this web product. No unit of measurement is specified.

Width
number or null

OPTIONAL. Numeric representation of width dimensions of this web product. No unit of measurement is specified.

Length
number or null

OPTIONAL. Numeric representation of width dimensions of this web product. No unit of measurement is specified.

RentalCaseQuantity
number or null
Default: "null"

The amount in a case for a rental.

RentalType
string or null
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"

SalesType
string or null
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"

Response samples

Content type
application/json
{
  • "ProductId": "17254",
  • "Quantity": "1",
  • "ProductAssociation": {
    }
}

Get an Estimate

Supported by: Elite

Get an Estimate

Authorizations:
ApiKey
Request Body schema: application/json
required
DepotId
required
string
Default: "001"

The unique identifier of the rental depot/branch location where the equipment will be rented from

EndDateTime
required
string <date-time>
Default: "2025-04-29T04:00:00Z"

The date and time when the rental period ends (in ISO 8601 format)

StartDateTime
required
string <date-time>
Default: "2025-04-29T00:00:00Z"

The date and time when the rental period begins (in ISO 8601 format)

required
Array of objects
Default: [{"Quantity":"1","ProductId":"17254","ProductAssociation":{"ProductAssociationId":"21068","ProductAssociationType":"Automatic"}}]

List of products to be included in the rental estimate

Array
ProductId
required
string

The unique identifier of the rental product

Quantity
required
number

The number of units of this product to be rented

object or null

If this item is being included by another item, this object designates the association that caused the inclusion.

CustomerId
string

The unique identifier of the customer requesting the estimate

LocationId
string or null

Optional identifier for the specific delivery location within the customer's account

Responses

Request samples

Content type
application/json
{
  • "DepotId": "001",
  • "StartDateTime": "2025-04-29T00:00:00Z",
  • "EndDateTime": "2025-04-29T04:00:00Z",
  • "Products": [
    ]
}

Response samples

Content type
application/json
{
  • "CustomerId": "227179",
  • "DepotId": "002",
  • "StartDateTime": "2025-08-01T12:00:00Z",
  • "EndDateTime": "2025-08-05T12:00:00Z",
  • "Notes": "Notes mine"
}

Hire Rates

Get all hire rates.

Supported by: Syrinx

Authorizations:
ApiKey

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 a hire rate.

Supported by: Syrinx

Authorizations:
ApiKey
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
[
  • {
    }
]