Download OpenAPI specification:
The Global API provides a standardized interface for integrating with Point of Rental's rental management systems, including Elite, Essentials, and Syrinx.
| 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 |
| 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 |
Filters are passed via the X-Filter request header. Supported by Elite and Syrinx:
Only supported per-endpoint where noted:
Additional comparators supported by Elite:
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"
}
]
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 allow you to organize your rental inventory into logical groups. These can be used for reporting, filtering, and organization of your rental items.
Supported by: Elite, Syrinx
Retrieve a list of categories
| 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. |
[- {
- "ModelType": "Category",
- "Tags": [
- "Keyboard",
- "Shoes"
]
}
]Supported by: Elite, Syrinx
Retrieve a single category by Id
| CategoryId required | string |
| 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
| |||||
| 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. | ||||
{- "ModelType": "Category",
- "Tags": [
- "Keyboard",
- "Shoes"
]
}Supported by: Elite
With this endpoint, you can look up enums related to categories. Currently, the only enum used is "departmentid".
| field required | string |
| 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. |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Creates a call log record
| 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 | ||||||||
| 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 | ||||||||
{- "ModelType": "CallLog",
- "Name": "Customer Follow-up - Equipment Return",
- "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}{- "ModelType": "CallLog",
- "Name": "Customer Follow-up - Equipment Return",
- "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}All call logs for your organization, use query parameters to filter
| 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 |
[- {
- "ModelType": "CallLog",
- "Name": "Customer Follow-up - Equipment Return",
- "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}
]Single call log record by call log Id
| CallLogId required | string |
| 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 | ||||||||
{- "ModelType": "CallLog",
- "Name": "Customer Follow-up - Equipment Return",
- "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}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.
| field required | string |
| 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. |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Contacts represent individuals associated with customers, vendors, or your own organization. They store contact information including phone numbers, email addresses, and roles.
Supported by: Elite
Create a new Contact
Required fields:
| 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. | |||||||||
| |||||||||
| 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
| |||||||||
| 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
| |||||||||
| Title | string or null <= 255 characters The contact's title. Example: 'Project Manager' or 'Equipment Supervisor' | ||||||||
object or null Additional fields for Contact. | |||||||||
| |||||||||
{- "FirstName": "John",
- "LastName": "Doe",
- "Name": "55365DR2",
- "Identifiers": {
- "ParentId": "103559"
},
}{- "ModelType": "Contact",
- "Addresses": [
- {
- "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"
}
]
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
| 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
|
| 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 |
[- {
- "ModelType": "Contact",
- "Addresses": [
- {
- "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"
}
]
}
]Supported by: Elite, Syrinx
Retrieve a single Contact by Id
| ContactId required | string |
| 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
| ||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||
{- "ModelType": "Contact",
- "Addresses": [
- {
- "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"
}
]
}Supported by: Elite
Update a single Contact by Id
Required fields:
| ContactId required | string |
| 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. | |||||||||
| |||||||||
| 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
| |||||||||
| 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
| |||||||||
| Title | string or null <= 255 characters The contact's title. Example: 'Project Manager' or 'Equipment Supervisor' | ||||||||
object or null Additional fields for Contact. | |||||||||
| |||||||||
| 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
| ||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||
{- "FirstName": "John",
- "LastName": "Doe",
- "Name": "55365DR2",
- "Identifiers": {
- "ParentId": "103559"
},
}{- "ModelType": "Contact",
- "Addresses": [
- {
- "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"
}
]
}Supported by: Elite
Call a Contract Off Rent
| 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. |
{- "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."
}{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "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"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "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"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite, Syrinx
Retrieve a list of Contracts
| 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?
|
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?
|
| 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. |
[- {
- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "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"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "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"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}
]Supported by: Elite, Syrinx
Retrieve a single Contract by Id
| ContractId required | string |
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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?
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects For Internal Use. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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?
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "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"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "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"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite
Update an existing Contract record by ContractId. Only fields defined below in swagger can be modified. Additional changes will be ignored
| ContractId required | string |
| 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 | |||||||||
| |||||||||
object or null Location, address, special instructions and date/time for driver actions, delivery, or customer pickup | |||||||||
| |||||||||
Array of objects or null Updatable line items: Id (required), Comments; Quantity requires PatchLineItemQty license. | |||||||||
Array
| |||||||||
| 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
| |||||||||
| 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. | ||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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?
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects For Internal Use. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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?
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "Notes": [
- {
- "Type": "Pickup",
- "Value": "charlatan"
}, - {
- "Type": "Pickup",
- "Value": "tune-up"
}
], - "IsDelivery": true,
- "IsPickup": true
}{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "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"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "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"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite
Retrieve files for a single Contract by Id.
| ContractId required | string |
| tagKey required | string
|
| 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. |
[- {
- "Id": "FILE-2024-001",
- "Name": "equipment-manual.pdf",
- "ContentType": "application/pdf",
}
]Supported by: Elite
Retrieve Tax Details for a single Contract by Id.
| ContractId required | string |
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
| |||||||||||||
{- "SubTotal": 1000,
- "TaxableAmount": 1000,
- "TaxAmount": 82.5,
- "TotalAmount": 1082.5,
- "TaxDetails": [
- {
- "TaxType": "State Sales Tax",
- "Rate": 0.0625,
- "Amount": 62.5
}, - {
- "TaxType": "Local Sales Tax",
- "Rate": 0.02,
- "Amount": 20
}
]
}Retrieve payment boundaries for a single Contract by Id.
| ContractId required | string |
Array of objects List of payment collection rules that define how payments can be collected for different scenarios |
[- {
- "PaymentType": "Recurring",
- "Frequency": "Monthly",
- "DayOfMonth": 1,
- "PaymentTerms": "NET30",
- "MinimumPayment": 500,
- "LateFeePercentage": 0.015,
- "GracePeriodDays": 5
}
]Supported by: Elite
Cancels a contract by changing its status to cancelled. The contract record is not deleted
| ContractId required | string |
| 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 |
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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?
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects For Internal Use. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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?
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ }{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "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"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "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"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}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.
| ContractId required | string |
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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?
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects For Internal Use. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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?
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "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"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "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"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite
Check if a Contract quote is eligible to be converted into a reservation.
| ContractId required | string |
| 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
| |||||||
{- "Success": true,
- "Issues": [ ]
}Supported by: Elite
Organizations with S3 storage only. Retrieves the most recent contract PDF for one or more contracts by ID.
| ContractIds required | string The contract id. Supports multiple contract ids separated by comma (e.g., id1,id2,id3). |
| 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. |
[- {
- "Id": "string",
- "ModelType": "ContractPdf",
- "Name": "string",
- "ContractId": "string",
- "CreatedDateTime": "2019-08-24T14:15:22Z",
- "CreatedBy": "string"
}
]Supported by: Elite
Elite users can look up enums related to contracts. Currently lookup/cancelReasonId is the only field this returns a value
| field required | string |
| 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. |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]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.
Supported by: Elite
Create a new Customer
Required fields:
| 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
Elite Only
Syrinx Only
Not all properties are valid across all products. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Array of objects Supported types will depend on the product. Elite:
Example: [ { "Type": "Customer", "Line1": "1234 Construction Way", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ] | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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:
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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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:
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
| |||||||||||||||||||||||||||
| FirstName | string or null [ 1 .. 50 ] characters First Name of Customer (individual only). Example: "John" | ||||||||||||||||||||||||||
| HeardAboutUs | string or null Common Examples:
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
| |||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| Status | string Default: "Lead" Enum: "Lead" "Prospect" "Cash" "Account" Examples:
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" } | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "Name": "ABC Construction Co"
}{- "ModelType": "Customer",
- "Id": "CUST-12345",
- "Name": "ABC Construction Co",
- "Identifiers": {
- "CustomerKey": "ABC123",
- "TaxNumber": "123-45-6789"
}, - "Addresses": [
- {
- "Type": "Customer",
- "Line1": "123 Construction Ave",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201"
}
], - "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
| 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
Elite Only
Syrinx Only
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. | |
| 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:
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:
| |
| 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 |
[- {
- "ModelType": "Customer",
- "Id": "CUST-12345",
- "Name": "ABC Construction Co",
- "Identifiers": {
- "CustomerKey": "ABC123",
- "TaxNumber": "123-45-6789"
}, - "Addresses": [
- {
- "Type": "Customer",
- "Line1": "123 Construction Ave",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201"
}
], - "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}
]Supported by: Elite, Syrinx
Retrieve a single Customer by Id
| CustomerId required | string |
| 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
Elite Only
Syrinx Only
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" } ] | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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:
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:
| |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||
{- "ModelType": "Customer",
- "Id": "CUST-12345",
- "Name": "ABC Construction Co",
- "Identifiers": {
- "CustomerKey": "ABC123",
- "TaxNumber": "123-45-6789"
}, - "Addresses": [
- {
- "Type": "Customer",
- "Line1": "123 Construction Ave",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201"
}
], - "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite
Update a single Customer by Id
Required fields:
| CustomerId required | string |
| 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
Elite Only
Syrinx Only
Not all properties are valid across all products. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Array of objects Supported types will depend on the product. Elite:
Example: [ { "Type": "Customer", "Line1": "1234 Construction Way", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ] | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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:
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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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:
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
| |||||||||||||||||||||||||||
| FirstName | string or null [ 1 .. 50 ] characters First Name of Customer (individual only). Example: "John" | ||||||||||||||||||||||||||
| HeardAboutUs | string or null Common Examples:
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
| |||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| Status | string Default: "Lead" Enum: "Lead" "Prospect" "Cash" "Account" Examples:
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" } | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| 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
Elite Only
Syrinx Only
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" } ] | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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:
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:
| |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||
{- "Name": "ABC Construction Co"
}{- "ModelType": "Customer",
- "Id": "CUST-12345",
- "Name": "ABC Construction Co",
- "Identifiers": {
- "CustomerKey": "ABC123",
- "TaxNumber": "123-45-6789"
}, - "Addresses": [
- {
- "Type": "Customer",
- "Line1": "123 Construction Ave",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201"
}
], - "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}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.
| field required | string |
| 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. |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
| 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. |
[- {
- "ModelType": "Depot",
- "Id": "DEP-001",
- "Name": "Main Equipment Yard",
- "Address": {
- "Line1": "1000 Industrial Blvd",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "ContactName": "Yard Manager",
- "ContactPhone": "214-555-7890",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}
]Supported by: Elite
Retrieve blocked-day details for depots. See query parameter descriptions.
| 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. |
required | Array of objects Per-depot blocked calendar dates within the requested range. | ||||
Array
| |||||
| 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. | ||||
{- "StartDate": "2019-08-24T14:15:22Z",
- "EndDate": "2019-08-24T14:15:22Z",
- "BlockedDays": [
- {
- "DepotId": "string",
- "Dates": [
- {
- "Date": "2019-08-24T14:15:22Z",
- "DeliveriesAllowed": 0,
- "PickupsAllowed": 0,
- "StoreClosed": 0
}
]
}
]
}Supported by: Elite, Syrinx
Retrieve a single Depot by Id
| DepotId required | string |
| 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
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
Array of objects (Phone) List of phone numbers associated with this depot | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||
{- "ModelType": "Depot",
- "Id": "DEP-001",
- "Name": "Main Equipment Yard",
- "Address": {
- "Line1": "1000 Industrial Blvd",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "ContactName": "Yard Manager",
- "ContactPhone": "214-555-7890",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Retrieve a list of Invoices
| 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. |
[- {
- "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 a single Invoice by Id
| InvoiceId required | string |
| 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. | ||
{- "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"
}Supported by: Elite
Retrieve files for a single Invoice by Id.
| InvoiceId required | string |
| tagKey required | string
|
| 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. |
[- {
- "Id": "FILE-2024-001",
- "Name": "equipment-manual.pdf",
- "ContentType": "application/pdf",
}
]Supported by: Elite
Call Line Items Off Rent
| 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. |
{- "LineItemIds": [
- "687122~@!^$1"
], - "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
}{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "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"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "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"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Retrieve a list of line items
| 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".
|
| 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. |
[- {
- "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
}
]Retrieve a single line item by its id
| LineItemId required | string |
| 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. | |||||||||
Array
| |||||||||
| 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".
| ||||||||
| 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
| |||||||||
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
| |||||||||
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. | ||||||||
{- "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
}Supported by: Elite
Create a new Location
Required fields:
| Name | string or null [ 1 .. 255 ] characters Default: "Downtown Construction Site" This would map to the jobsite description in Elite. Examples:
| ||||||||||||||||||||||
object or null Location address with specific delivery instructions. Examples:
| |||||||||||||||||||||||
| |||||||||||||||||||||||
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. | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| 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:
Elite: This field is not supported. | ||||||||||||||||||||||
Array of objects Currently we only support SiteDeliveryInstructions for special delivery requirements and site access information. | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| 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:
| ||||||||||||||||||||||
Array of objects Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Examples:
| |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| 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:
Elite: Not supported. | ||||||||||||||||||||||
| AdditionalFields | object or null Additional fields for Location. Example: Custom fields for site-specific requirements or certifications. | ||||||||||||||||||||||
{- "Name": "Downtown Construction Site"
}{- "ModelType": "Location",
- "Id": "LOC-2024-001",
- "Name": "Downtown Construction Site",
- "CustomerId": "CUST-12345",
- "Address": {
- "Line1": "456 Project Site",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75202"
}, - "ContactName": "Site Manager",
- "ContactPhone": "214-555-5678",
- "Status": "Active",
- "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
| 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. | |
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. |
Array of objects Currently we only support the following types of notes
| |
| 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. |
| Type | string Enum: "Global" "Customer" "Supplier" Location type may be one of the following.
|
| 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. |
[- {
- "ModelType": "Location",
- "Id": "LOC-2024-001",
- "Name": "Downtown Construction Site",
- "CustomerId": "CUST-12345",
- "Address": {
- "Line1": "456 Project Site",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75202"
}, - "ContactName": "Site Manager",
- "ContactPhone": "214-555-5678",
- "Status": "Active",
- "CreatedDateTime": "2024-03-15T00:00:00Z"
}
]Supported by: Elite, Syrinx
Retrieve a single Location by Id
| LocationId required | string |
| 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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
Array of objects Type can == "Customer" or "Billing" for now. This supports multiple email addresses. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||
Array of objects Currently we only support the following types of notes
| |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||
| Type | string Enum: "Global" "Customer" "Supplier" Location type may be one of the following.
| ||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||
{- "ModelType": "Location",
- "Id": "LOC-2024-001",
- "Name": "Downtown Construction Site",
- "CustomerId": "CUST-12345",
- "Address": {
- "Line1": "456 Project Site",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75202"
}, - "ContactName": "Site Manager",
- "ContactPhone": "214-555-5678",
- "Status": "Active",
- "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite
Update a single Location by Id
Required fields:
| LocationId required | string |
| Name | string or null [ 1 .. 255 ] characters Default: "Downtown Construction Site" This would map to the jobsite description in Elite. Examples:
| ||||||||||||||||||||||
object or null Location address with specific delivery instructions. Examples:
| |||||||||||||||||||||||
| |||||||||||||||||||||||
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. | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| 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:
Elite: This field is not supported. | ||||||||||||||||||||||
Array of objects Currently we only support SiteDeliveryInstructions for special delivery requirements and site access information. | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| 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:
| ||||||||||||||||||||||
Array of objects Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Examples:
| |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| 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:
Elite: Not supported. | ||||||||||||||||||||||
| AdditionalFields | object or null Additional fields for Location. Example: Custom fields for site-specific requirements or certifications. | ||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
Array of objects Type can == "Customer" or "Billing" for now. This supports multiple email addresses. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||
Array of objects Currently we only support the following types of notes
| |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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
| |||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||
| Type | string Enum: "Global" "Customer" "Supplier" Location type may be one of the following.
| ||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||
{- "Name": "Downtown Construction Site"
}{- "ModelType": "Location",
- "Id": "LOC-2024-001",
- "Name": "Downtown Construction Site",
- "CustomerId": "CUST-12345",
- "Address": {
- "Line1": "456 Project Site",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75202"
}, - "ContactName": "Site Manager",
- "ContactPhone": "214-555-5678",
- "Status": "Active",
- "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite, Syrinx
Retrieve availability for a single Product by Id
| ProductId required | string |
| startdate required | string |
| enddate required | string |
| returnSingleRecord required | string |
| 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
| |||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||
{- "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 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.
| 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. | ||||||||||||||||
| |||||||||||||||||
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. | ||||||||||||||||
| |||||||||||||||||
| 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. | ||||||||||||||||
{- "ModelType": "Product",
- "Name": "Test MOdel ",
- "Identifiers": {
- "Key": "12435",
- "Barcode": "123",
- "Alias": "smith"
}, - "CategoryIds": [
- "63"
], - "CategoryName": "Audio - Video - Lighting",
- "Classification": "Rental",
- "Description": "Nodescription",
- "Images": [ ],
- "Key": ".ACPLUG",
- "ModelNumber": "23",
- "ModelYear": "2025",
- "OtherUrls": [ ],
- "Tags": [ ],
- "DepotId": "000",
- "AdditionalFields": {
- "ExternalTaxCode": "12AS",
- "RentalType": "Rental - Header",
- "CurrentDepotId": "000",
- "ReorderMinimum": "2",
- "ReorderMaximum": "3",
- "CaseQuantity": 5,
- "RentalCaseQuantity": 2,
- "CriticalLevel": 1,
- "TaxCode": 14
}
}{- "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": [
- {
- "RateType": "Daily",
- "Amount": 450
}
], - "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
| 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. |
[- {
- "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": [
- {
- "RateType": "Daily",
- "Amount": 450
}
], - "CreatedDateTime": "2024-03-15T00:00:00Z"
}
]Supported by: Elite
| 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 |
[- {
- "ModelType": "ProductAssociation",
- "ParentProductId": 482,
- "ChildProductId": 62,
- "AssociationType": "Automatic",
- "GroupSelectionType": "ChooseMany",
- "IsSelected": false,
- "DisplayOrder": 221.06
}
]Supported by: Elite, Syrinx
Retrieve a single Product by Id
| ProductId required | string |
| 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. | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||
One of number For elite, only a number. It is a monotomic that can be used to detect changes. | |||||||||||||||||||||||||||
{- "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": [
- {
- "RateType": "Daily",
- "Amount": 450
}
], - "CreatedDateTime": "2024-03-15T00:00:00Z"
}Update a Product
| ProductId required | string |
| 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. | ||||||||||||||||
| |||||||||||||||||
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. | ||||||||||||||||
| |||||||||||||||||
| 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. | ||||||||||||||||
{- "ModelType": "Product",
- "Name": "Test MOdel ",
- "Identifiers": {
- "Key": "12435",
- "Barcode": "123",
- "Alias": "smith"
}, - "CategoryIds": [
- "63"
], - "CategoryName": "Audio - Video - Lighting",
- "Classification": "Rental",
- "Description": "Nodescription",
- "Images": [ ],
- "Key": ".ACPLUG",
- "ModelNumber": "23",
- "ModelYear": "2025",
- "OtherUrls": [ ],
- "Tags": [ ],
- "DepotId": "000",
- "AdditionalFields": {
- "ExternalTaxCode": "12AS",
- "RentalType": "Rental - Header",
- "CurrentDepotId": "000",
- "ReorderMinimum": "2",
- "ReorderMaximum": "3",
- "CaseQuantity": 5,
- "RentalCaseQuantity": 2,
- "CriticalLevel": 1,
- "TaxCode": 14
}
}{- "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": [
- {
- "RateType": "Daily",
- "Amount": 450
}
], - "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite, Syrinx
Retrieve rates for a single Product by Id.
| ProductId required | string |
| depotId required | string |
| locationId required | string |
| customerId required | string |
| startDate required | string |
| endDate required | string |
| ApplicableRates | string Applicable rates are the most relevant rates, passed back as a single string with line breaks (\n). Example #1 (Scissor Lift - raw): Example #1 (displayed):
Example #2 (Skid Steer - raw): Example #2 (displayed):
| ||||||
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
| |||||||
{- "ProductId": "PROD-123",
- "Name": "20T Excavator",
- "Rates": [
- {
- "RateType": "Daily",
- "Amount": 450,
- "MinimumDays": 1
}, - {
- "RateType": "Weekly",
- "Amount": 2250,
- "MinimumDays": 7
}, - {
- "RateType": "Monthly",
- "Amount": 8000,
- "MinimumDays": 28
}
]
}Supported by: Elite
Retrieve files for a single Product by Id.
| ProductId required | string |
| tagKey required | string
|
| 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. |
[- {
- "Id": "FILE-2024-001",
- "Name": "equipment-manual.pdf",
- "ContentType": "application/pdf",
}
]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.
Supported by: Elite
Elite supports the following fields for the Search filter:
| 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. |
[- {
- "ModelType": "SalesPerson",
- "Id": "SP-001",
- "Name": "Jane Smith",
- "Phone": "214-555-9876",
- "Status": "Active",
- "Territory": "North Texas",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}
]Supported by: Elite
Retrieve a single SalesPerson by ID
| SalesPersonId required | string |
| 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. | ||||
{- "ModelType": "SalesPerson",
- "Id": "SP-001",
- "Name": "Jane Smith",
- "Phone": "214-555-9876",
- "Status": "Active",
- "Territory": "North Texas",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite
Only serialized stock is supported for POST at this time.
Required fields:
| 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. | |||||||||||||||||||||||
| |||||||||||||||||||||||
| 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"} | |||||||||||||||||||||||
| |||||||||||||||||||||||
object or null Depreciation fields for Stock | |||||||||||||||||||||||
| |||||||||||||||||||||||
object or null Deprecated Depreciation fields for Stock | |||||||||||||||||||||||
| |||||||||||||||||||||||
{- "Name": "20T Excavator",
- "DepotId": "001",
- "ProductId": "158",
- "Classification": "Sale",
- "ModelNumber": "1234",
- "ModelYear": "2020",
- "Identifiers": {
- "PartNumber": "12345",
- "ReorderMinimum": "2",
- "Alias": "CAT320-123456",
- "Barcode": "1234567890123"
}, - "AdditionalFields": {
- "ReorderMinimum": 2,
- "ReorderMaximum": 3,
- "CaseQuantity": 5,
- "RentalCaseQuantity": 2,
- "CriticalLevel": 1,
- "GlNumber": "1234"
}, - "IsPart": true
}{- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "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"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
| 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
|
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. |
[- {
- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "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"
}
]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 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. |
{- "ContractLineItemId": "CLI-2024-0472891",
- "FuelStockId": "FUEL-DSL-RED-001",
- "QuantitySold": 25.5
}nullSupported by: Elite
Update an existing Stock record by StockId
| StockId required | string |
| 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} | |||||||||||||||||
| |||||||||||||||||
object Default: {"CaseQuantity":12,"CriticalLevel":5,"GlNumber":"15200","RentalCaseQuantity":1,"ReorderMaximum":50,"ReorderMinimum":24,"TaxCode":1,"ExternalTaxCode":"PC040100"} | |||||||||||||||||
| |||||||||||||||||
| 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
| ||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||
{- "SerialNumber": "CAT0123456789",
- "Identifiers": {
- "Alias": "MINI-EX-35",
- "Barcode": "EQ-123456"
}, - "Depreciation": {
- "TotalDepreciation": 15000,
- "CurrentValue": 30000
}, - "AdditionalFields": {
- "CaseQuantity": 12,
- "CriticalLevel": 5,
- "GlNumber": "15200",
- "RentalCaseQuantity": 1,
- "ReorderMaximum": 50,
- "ReorderMinimum": 24,
- "TaxCode": 1,
- "ExternalTaxCode": "PC040100"
}
}{- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "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"
}Supported by: Elite, Syrinx
| StockId required | string |
| 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
| ||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||
{- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "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"
}Supported by: Elite, Syrinx
Retrieve realtime Availability for a single Stock record by Id
| StockId required | string |
| 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. | |||
| |||
| 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. | ||
{- "ModelType": "StockAvailability",
- "Id": "SA-12345678-90AB-CDEF",
- "Name": "CAT 305E2 #SN12345",
- "Identifiers": {
- "Key": "MINI-EX-305E2-12345"
}, - "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
}Supported by: Elite
Retrieve fuel info for a single Stock record by Id
| StockId required | string |
| 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. | |||
| |||
| 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. | ||
{- "ModelType": "StockAvailability",
- "Id": "SA-12345678-90AB-CDEF",
- "Name": "CAT 305E2 #SN12345",
- "Identifiers": {
- "Key": "MINI-EX-305E2-12345"
}, - "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
}Supported by: Elite
Retrieve files for a single Stock by Id.
| StockId required | string |
| tagKey required | string
|
| 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. |
[- {
- "Id": "FILE-2024-001",
- "Name": "equipment-manual.pdf",
- "ContentType": "application/pdf",
}
]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.
| StockId required | string |
| 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. |
| 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
| ||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||
{- "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
}{- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "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"
}Gets all the work orders for a stock item
| StockId required | string |
| 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
| |||||||||||||||||||||||||
| 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) | ||||||||||||||||||||||||
{- "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": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "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": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}Supported by: Elite
Create a new Vendor
Required fields:
| 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:
| ||||||||||||||||||||||||||
object or null Identifying items for Vendor. Examples:
| |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Array of objects Supported types will depend on the product. Examples:
Elite:
| |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
Array of objects Name and Types of Contacts related to the Vendor. Examples:
| |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| CurrencyCode | string or null Default: "USD" Defaults to "USD". Code is ISO 4217 format. Examples:
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:
| ||||||||||||||||||||||||||
Array of objects Any comments or notes. Examples:
| |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| Terms | string or null <= 50 characters Billing terms for the vendor. Examples:
| ||||||||||||||||||||||||||
object or null Additional fields specific to each vendor. Examples include:
| |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30"
}{- "ModelType": "Vendor",
- "Id": "VEN-001",
- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
| 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:
|
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:
|
| Inactive | boolean or null Indicates if the vendor is currently active in your system. Examples:
|
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:
|
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:
|
| UpdatedDateTime | string or null <date-time> UTC timestamp of the last update to the vendor record. Examples:
|
| Hidden | integer or null Value: 1 Indicates if the vendor record is hidden/deleted (1) or visible/active (0). Examples:
|
[- {
- "ModelType": "Vendor",
- "Id": "VEN-001",
- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}
]Supported by: Elite, Syrinx
| VendorId required | string |
| 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:
| ||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
| CurrencyCode | string or null Default: "USD" The currency used for transactions with this vendor. Uses ISO 4217 format. Common Examples:
| ||||||||||||||||||||||||||
| Inactive | boolean or null Indicates if the vendor is currently active in your system. Examples:
| ||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
| Terms | string or null Payment terms agreed with the vendor. Common Examples:
| ||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||
| UpdatedDateTime | string or null <date-time> UTC timestamp of the last update to the vendor record. Examples:
| ||||||||||||||||||||||||||
| Hidden | integer or null Value: 1 Indicates if the vendor record is hidden/deleted (1) or visible/active (0). Examples:
| ||||||||||||||||||||||||||
{- "ModelType": "Vendor",
- "Id": "VEN-001",
- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite
Update a single Vendor by Id
Required fields:
| VendorId required | string |
| 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:
| ||||||||||||||||||||||||||
object or null Identifying items for Vendor. Examples:
| |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Array of objects Supported types will depend on the product. Examples:
Elite:
| |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
Array of objects Name and Types of Contacts related to the Vendor. Examples:
| |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| CurrencyCode | string or null Default: "USD" Defaults to "USD". Code is ISO 4217 format. Examples:
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:
| ||||||||||||||||||||||||||
Array of objects Any comments or notes. Examples:
| |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| Terms | string or null <= 50 characters Billing terms for the vendor. Examples:
| ||||||||||||||||||||||||||
object or null Additional fields specific to each vendor. Examples include:
| |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
| 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:
| ||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
| CurrencyCode | string or null Default: "USD" The currency used for transactions with this vendor. Uses ISO 4217 format. Common Examples:
| ||||||||||||||||||||||||||
| Inactive | boolean or null Indicates if the vendor is currently active in your system. Examples:
| ||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||
| Terms | string or null Payment terms agreed with the vendor. Common Examples:
| ||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||
| UpdatedDateTime | string or null <date-time> UTC timestamp of the last update to the vendor record. Examples:
| ||||||||||||||||||||||||||
| Hidden | integer or null Value: 1 Indicates if the vendor record is hidden/deleted (1) or visible/active (0). Examples:
| ||||||||||||||||||||||||||
{- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30"
}{- "ModelType": "Vendor",
- "Id": "VEN-001",
- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}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.
| field required | string |
| 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. |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Create a work order
| 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
| |||||||||||||||||||
| 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 | ||||||||||||||||||
{- "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": {
- "LaborTypes": [ ]
}, - "AdditionalFields": { },
- "CreatedDateTime": "2017-11-29T21:50:11.377Z",
- "UpdatedDateTime": "2017-11-30T18:00:01.813Z"
}{- "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": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "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": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}Retrieve a list of work orders
| 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) |
[- {
- "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": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "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": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}
]Retrieve a single work order by its id
| WorkOrderId required | string |
| 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
| |||||||||||||||||||||||||
| 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) | ||||||||||||||||||||||||
{- "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": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "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": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}Update a single work order by its id
| WorkOrderId required | string |
| 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
| |||||||||||||||||||
| 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 | ||||||||||||||||||
| 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
| |||||||||||||||||||||||||
| 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) | ||||||||||||||||||||||||
{- "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": {
- "LaborTypes": [ ]
}, - "AdditionalFields": { },
- "CreatedDateTime": "2017-11-29T21:50:11.377Z",
- "UpdatedDateTime": "2017-11-30T18:00:01.813Z"
}{- "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": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "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": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}Retrieve a list of work order parts
| WorkOrderId required | string |
| 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:
|
| 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. |
[- {
- "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"
}
]Create a work order part
| WorkOrderId required | string |
| 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' |
{- "Name": "Orville Friesen-Pfannerstill",
- "Comments": "sport"
}{- "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"
}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.
| 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. |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]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.
| 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. |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]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.
| 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 |
| ErrorDescription | string or null Error description value whenever payable invoice |
| 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. |
[- {
- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2025-05-31T19:17:12.655Z",
- "FreightTotal": 358.16,
- "GrandTaxTotal": 892.3,
- "GrandTotal": 778.82,
- "Identifiers": {
- "BatchId": 149,
- "ContractStoreId": 918,
- "ExternalLocationId": 734,
- "ExternalPayableId": 789,
- "ExternalVendorId": 668,
- "FreightAccountId": 963,
- "MiscellaneousAccountId": 429,
- "PayableAccountId": 539,
- "TaxAccountId": 10
}, - "LineItems": [
- {
- "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
}
], - "MiscellaneousTotal": 462.72,
- "PurchaseOrderNumber": "sediment",
- "PurchaseOrderSequenceNumber": "beret",
- "PurchaseTotal": 295.29,
- "ShippingMethod": "adult",
- "State": "Pending",
- "TermsCode": "sunbeam",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 109,
- "Name": "Tammy Howe",
- "InvoiceNumber": "postbox",
- "InvoiceDateTime": "2025-03-13T11:52:51.462Z",
- "InvoiceDueDateTime": "2025-12-29T15:05:26.124Z"
}
}
]Supported by: Elite
This is a single account payable invoice retrieved by the given payable invoice id.
| InvoiceId required | string |
| 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 | ||||||||||||||||||||||||||||||||||
| ErrorDescription | string or null Error description value whenever payable invoice | ||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
| 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": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2025-05-31T19:17:12.655Z",
- "FreightTotal": 358.16,
- "GrandTaxTotal": 892.3,
- "GrandTotal": 778.82,
- "Identifiers": {
- "BatchId": 149,
- "ContractStoreId": 918,
- "ExternalLocationId": 734,
- "ExternalPayableId": 789,
- "ExternalVendorId": 668,
- "FreightAccountId": 963,
- "MiscellaneousAccountId": 429,
- "PayableAccountId": 539,
- "TaxAccountId": 10
}, - "LineItems": [
- {
- "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
}
], - "MiscellaneousTotal": 462.72,
- "PurchaseOrderNumber": "sediment",
- "PurchaseOrderSequenceNumber": "beret",
- "PurchaseTotal": 295.29,
- "ShippingMethod": "adult",
- "State": "Pending",
- "TermsCode": "sunbeam",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 109,
- "Name": "Tammy Howe",
- "InvoiceNumber": "postbox",
- "InvoiceDateTime": "2025-03-13T11:52:51.462Z",
- "InvoiceDueDateTime": "2025-12-29T15:05:26.124Z"
}
}Supported by: Elite
Update an existing Account Payable Invoice
| InvoiceId required | string |
| ErrorCode | string or null Error code value whenever the payable invoice | ||
| ErrorDescription | string or null Error description value whenever payable invoice | ||
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. | |||
| |||
| 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. | ||
| 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 | ||||||||||||||||||||||||||||||||||
| ErrorDescription | string or null Error description value whenever payable invoice | ||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
| 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": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2026-06-26T19:35:33.411Z",
- "FreightTotal": 958.81,
- "GrandTaxTotal": 994.64,
- "GrandTotal": 388.32,
- "Identifiers": {
- "BatchId": 135,
- "ContractStoreId": 308,
- "ExternalLocationId": 156,
- "ExternalPayableId": 531,
- "ExternalVendorId": 307,
- "FreightAccountId": 16,
- "MiscellaneousAccountId": 644,
- "PayableAccountId": 755,
- "TaxAccountId": 202
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 391,
- "ExtendedUnitTotal": 870.49,
- "FreightTotal": 10.72,
- "GrandTaxTotal": 608.2,
- "GrandTotal": 612.74,
- "Identifiers": {
- "AccountNumberId": 241,
- "ExternalPayableId": 720,
- "InvoiceId": 864
}, - "Item": {
- "ModelType": "Item",
- "Id": 282,
- "Description": "SAMPLE: testimonial cafe grade even instead purple which clueless closely unnaturally",
- "Key": "beret"
}, - "LineNumber": 829,
- "MiscellaneousTotal": "antelope",
- "PurchaseOrderNumber": "tributary",
- "PurchaseOrderPartNumber": "unibody",
- "PurchaseOrderSequenceNumber": "sunbeam",
- "QuantityOrdered": 469.49,
- "QuantityReceived": 826.24,
- "ReceivedDateTime": "2026-03-01T16:37:36.438Z",
- "UnitTotal": 86
}, - {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 948,
- "ExtendedUnitTotal": 918.92,
- "FreightTotal": 37.93,
- "GrandTaxTotal": 710.33,
- "GrandTotal": 114.55,
- "Identifiers": {
- "AccountNumberId": 605,
- "ExternalPayableId": 418,
- "InvoiceId": 348
}, - "Item": {
- "ModelType": "Item",
- "Id": 333,
- "Description": "SAMPLE: adaptation round phew ew blah upward thongs up mouser spirit",
- "Key": "inspection"
}, - "LineNumber": 841,
- "MiscellaneousTotal": "sailor",
- "PurchaseOrderNumber": "adviser",
- "PurchaseOrderPartNumber": "unibody",
- "PurchaseOrderSequenceNumber": "march",
- "QuantityOrdered": 670.74,
- "QuantityReceived": 930.28,
- "ReceivedDateTime": "2025-01-05T20:58:31.426Z",
- "UnitTotal": 732.06
}, - {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 95,
- "ExtendedUnitTotal": 419.17,
- "FreightTotal": 318.67,
- "GrandTaxTotal": 320.6,
- "GrandTotal": 591.84,
- "Identifiers": {
- "AccountNumberId": 889,
- "ExternalPayableId": 858,
- "InvoiceId": 358
}, - "Item": {
- "ModelType": "Item",
- "Id": 348,
- "Description": "SAMPLE: save likewise kookily whether pecan acquaintance too between near bleach",
- "Key": "simple"
}, - "LineNumber": 916,
- "MiscellaneousTotal": "bungalow",
- "PurchaseOrderNumber": "mythology",
- "PurchaseOrderPartNumber": "nephew",
- "PurchaseOrderSequenceNumber": "tabletop",
- "QuantityOrdered": 671.82,
- "QuantityReceived": 544.61,
- "ReceivedDateTime": "2026-07-28T03:59:25.803Z",
- "UnitTotal": 641.15
}
], - "MiscellaneousTotal": 816.65,
- "PurchaseOrderNumber": "elevation",
- "PurchaseOrderSequenceNumber": "hose",
- "PurchaseTotal": 818.44,
- "ShippingMethod": "knickers",
- "State": "Posted",
- "TermsCode": "longboat",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 441,
- "Name": "Violet Purdy",
- "InvoiceNumber": "council",
- "InvoiceDateTime": "2026-01-26T14:10:16.093Z",
- "InvoiceDueDateTime": "2025-05-13T11:57:41.470Z"
}
}{- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2025-05-31T19:17:12.655Z",
- "FreightTotal": 358.16,
- "GrandTaxTotal": 892.3,
- "GrandTotal": 778.82,
- "Identifiers": {
- "BatchId": 149,
- "ContractStoreId": 918,
- "ExternalLocationId": 734,
- "ExternalPayableId": 789,
- "ExternalVendorId": 668,
- "FreightAccountId": 963,
- "MiscellaneousAccountId": 429,
- "PayableAccountId": 539,
- "TaxAccountId": 10
}, - "LineItems": [
- {
- "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
}
], - "MiscellaneousTotal": 462.72,
- "PurchaseOrderNumber": "sediment",
- "PurchaseOrderSequenceNumber": "beret",
- "PurchaseTotal": 295.29,
- "ShippingMethod": "adult",
- "State": "Pending",
- "TermsCode": "sunbeam",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 109,
- "Name": "Tammy Howe",
- "InvoiceNumber": "postbox",
- "InvoiceDateTime": "2025-03-13T11:52:51.462Z",
- "InvoiceDueDateTime": "2025-12-29T15:05:26.124Z"
}
}All Elite account receivable invoices, use query parameters to filter
| 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 |
| ErrorDescription | string or null Error description value whenever invoice |
| 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. |
[- {
- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 912.13,
- "ContractType": "Invoice",
- "DamageWaiverTotal": 231.38,
- "Delivery": {
- "Type": "Default",
- "City": "Port Malindamouth",
- "Line1": "432 Skiles Mews",
- "PostalCode": "35306-0982",
- "Province": "Nebraska"
}, - "GrandTaxTotal": 76.93,
- "GrandTotal": 785.17,
- "Identifiers": {
- "ContractId": 148,
- "BatchId": 949,
- "ContractStoreId": 324,
- "CustomerId": 680,
- "ExternalLocationId": 700,
- "ExternalInvoiceId": 827,
- "ExternalCustomerId": 368,
- "ParentContractId": 134
}, - "LineItems": [
- {
- "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"
}
], - "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
}
]Single Elite account receivable invoice by Id
| InvoiceId required | string |
| 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ErrorDescription | string or null Error description value whenever invoice | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 912.13,
- "ContractType": "Invoice",
- "DamageWaiverTotal": 231.38,
- "Delivery": {
- "Type": "Default",
- "City": "Port Malindamouth",
- "Line1": "432 Skiles Mews",
- "PostalCode": "35306-0982",
- "Province": "Nebraska"
}, - "GrandTaxTotal": 76.93,
- "GrandTotal": 785.17,
- "Identifiers": {
- "ContractId": 148,
- "BatchId": 949,
- "ContractStoreId": 324,
- "CustomerId": 680,
- "ExternalLocationId": 700,
- "ExternalInvoiceId": 827,
- "ExternalCustomerId": 368,
- "ParentContractId": 134
}, - "LineItems": [
- {
- "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"
}
], - "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
}Update a single Elite account receivable invoice
| InvoiceId required | string |
| Id | string Unique identifier for the model type. | ||
| ErrorCode | string or null Error code value whenever the invoice | ||
| ErrorDescription | string or null Error description value whenever invoice | ||
object Default: {"ContractId":559,"BatchId":985,"ContractStoreId":241,"CustomerId":192,"ExternalLocationId":427,"ExternalInvoiceId":404,"ExternalCustomerId":241} Collection of unique ids related to this invoice. | |||
| |||
| 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. | ||
| 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ErrorDescription | string or null Error description value whenever invoice | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 297.86,
- "ContractType": "Cash",
- "DamageWaiverTotal": 429.02,
- "Delivery": {
- "Type": "Default",
- "City": "Alexandreworth",
- "Line1": "753 E 5th Street",
- "PostalCode": "77205-7819",
- "Province": "Connecticut"
}, - "GrandTaxTotal": 113.59,
- "GrandTotal": 629.17,
- "Identifiers": {
- "ContractId": 559,
- "BatchId": 985,
- "ContractStoreId": 241,
- "CustomerId": 192,
- "ExternalLocationId": 427,
- "ExternalInvoiceId": 404,
- "ExternalCustomerId": 241
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 835,
- "AccountingClass": "folklore",
- "DamageWaiverPercent": 272.16,
- "DiscountPercent": 17,
- "DiscountTotal": 60,
- "DueDateTime": "2025-06-30T18:42:55.194Z",
- "ExtendedPriceTotal": 399.15,
- "GrandTaxTotal": 388.21,
- "GrandTotal": 947.2,
- "HoursCharged": 190.29,
- "Identifiers": {
- "InvoiceId": 807,
- "ContractId": 940,
- "GeneralLedgerAccountId": 560,
- "GeneralLedgerOffsetAccountId": 72
}, - "Item": {
- "ModelType": "Item",
- "Id": 646,
- "Name": "Joan Fritsch",
- "Key": "handful",
- "CategoryId": 818,
- "CategoryName": "Lynn Little III",
- "Description": "SAMPLE: when gladly poorly thoroughly up oblong times yahoo yuck wire",
- "IsAsset": true,
- "Manufacturer": "extent",
- "Model": "Volkswagen Fiesta",
- "ModelYear": "netsuke",
- "SerialNumber": "fax",
- "Type": "Rental"
}, - "ItemPercent": "Computer",
- "LineNumber": 8,
- "Memo": "vol",
- "MeterIn": 161.43,
- "MeterOut": 457.97,
- "NonTaxable": true,
- "OutDateTime": "2026-05-17T08:46:04.282Z",
- "Quantity": 36,
- "TypeId": 566,
- "TypeName": "OtherIncome"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 36,
- "AccountingClass": "pronoun",
- "DamageWaiverPercent": 357.59,
- "DiscountPercent": 30,
- "DiscountTotal": 74,
- "DueDateTime": "2025-11-19T22:42:15.932Z",
- "ExtendedPriceTotal": 672.45,
- "GrandTaxTotal": 742.54,
- "GrandTotal": 686.02,
- "HoursCharged": 340.25,
- "Identifiers": {
- "InvoiceId": 948,
- "ContractId": 937,
- "GeneralLedgerAccountId": 92,
- "GeneralLedgerOffsetAccountId": 7
}, - "Item": {
- "ModelType": "Item",
- "Id": 669,
- "Name": "Lloyd Champlin",
- "Key": "decryption",
- "CategoryId": 100,
- "CategoryName": "Inez Simonis",
- "Description": "SAMPLE: hidden angrily if aw issue noon vet tarry tectonics suckle",
- "IsAsset": false,
- "Manufacturer": "gallery",
- "Model": "Rivian PT Cruiser",
- "ModelYear": "willow",
- "SerialNumber": "status",
- "Type": "Rental"
}, - "ItemPercent": "Keyboard",
- "LineNumber": 824,
- "Memo": "jury",
- "MeterIn": 684.57,
- "MeterOut": 763.53,
- "NonTaxable": false,
- "OutDateTime": "2026-07-23T11:01:34.794Z",
- "Quantity": 86,
- "TypeId": 312,
- "TypeName": "OtherIncome"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 73,
- "AccountingClass": "begonia",
- "DamageWaiverPercent": 356.95,
- "DiscountPercent": 29,
- "DiscountTotal": 94,
- "DueDateTime": "2025-10-04T23:51:58.136Z",
- "ExtendedPriceTotal": 788.09,
- "GrandTaxTotal": 59.99,
- "GrandTotal": 247.74,
- "HoursCharged": 616.14,
- "Identifiers": {
- "InvoiceId": 230,
- "ContractId": 15,
- "GeneralLedgerAccountId": 303,
- "GeneralLedgerOffsetAccountId": 325
}, - "Item": {
- "ModelType": "Item",
- "Id": 347,
- "Name": "Derek Wehner",
- "Key": "subsidy",
- "CategoryId": 277,
- "CategoryName": "Charlotte Funk-Parker",
- "Description": "SAMPLE: continually among outside bowed intermesh yahoo since armoire institutionalize crystallize",
- "IsAsset": false,
- "Manufacturer": "cannon",
- "Model": "Maserati 2",
- "ModelYear": "barracks",
- "SerialNumber": "meatloaf",
- "Type": "Retail"
}, - "ItemPercent": "Fish",
- "LineNumber": 89,
- "Memo": "swanling",
- "MeterIn": 258.89,
- "MeterOut": 19.1,
- "NonTaxable": false,
- "OutDateTime": "2026-09-13T14:27:19.342Z",
- "Quantity": 4,
- "TypeId": 559,
- "TypeName": "ItemPercentage"
}
], - "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
}{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 912.13,
- "ContractType": "Invoice",
- "DamageWaiverTotal": 231.38,
- "Delivery": {
- "Type": "Default",
- "City": "Port Malindamouth",
- "Line1": "432 Skiles Mews",
- "PostalCode": "35306-0982",
- "Province": "Nebraska"
}, - "GrandTaxTotal": 76.93,
- "GrandTotal": 785.17,
- "Identifiers": {
- "ContractId": 148,
- "BatchId": 949,
- "ContractStoreId": 324,
- "CustomerId": 680,
- "ExternalLocationId": 700,
- "ExternalInvoiceId": 827,
- "ExternalCustomerId": 368,
- "ParentContractId": 134
}, - "LineItems": [
- {
- "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"
}
], - "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
}All Elite account receivable payments, use query parameters to filter
| 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 |
| ErrorDescription | string or null Error description value whenever payment |
| 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. |
[- {
- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}
]Create a single Elite account receivable payment
| 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 RequestsFor every request, ONE from each of the bullet points below is REQUIRED:
Credit Requests Require an Additional
| ||||||||||||||||||
| |||||||||||||||||||
| 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 | ||||||||||||||||||
| TransactionDate | string <date-time> Default: "2025-01-10T14:15:22Z" Date and time when the payment was posted. | ||||||||||||||||||
{- "ContractCodeName": "Payment",
- "GrandTotal": 100,
- "Memo": "test",
- "Method": "Cash",
- "TransactionDate": "2025-01-10T14:15:22Z",
- "Identifiers": {
- "ContractId": "775511",
- "CustomerId": "8",
- "ExternalContractId": "775511"
}
}{- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}Single Elite account receivable payment by Id
| PaymentId required | string |
| 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 | ||||||||||||||||||
| ErrorDescription | string or null Error description value whenever payment | ||||||||||||||||||
| 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. | ||||||||||||||||||
{- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}Supported by: Elite
The Fulfillment endpoints provide functionality for tracking and managing the fulfillment of rental contracts in Elite.
Fulfillment tracking allows rental companies to monitor the progress of contract fulfillment, including:
Supported by: Elite
Adds a serialized line item
| 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 |
{- "LineItemId": 809,
- "ActionId": 314,
- "QuantityActioned": 564.06,
- "StockId": 844,
- "Eyeballed": true,
- "Notes": "fencing"
}{- "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
}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.
| field required | string |
| 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. |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Supported by: Elite
| ContractId required | string |
| 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 |
[- {
- "ContractId": 3,
- "LineItemId": 87,
- "StockId": 791,
- "Actions": [
- {
- "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"
}
]
}
]Supported by: Elite
| LineItemId required | string |
| 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
| |||||||||||||||
{- "ContractId": 3,
- "LineItemId": 87,
- "StockId": 791,
- "Actions": [
- {
- "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"
}
]
}Supported by: Elite
| LineItemId required | string |
| 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 |
[- {
- "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
}
]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.
| 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 |
| ErrorDescription | string or null Error description value whenever invoice |
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. |
[- {
- "ModelType": "JournalEntry",
- "Dimensions": {
- "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"
}, - "Identifiers": {
- "BatchId": 421,
- "ExternalJournalEntryId": 675
}, - "LineItems": [
- {
- "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"
}
], - "State": "Pending"
}
]Supported by: Elite
This is a single general ledger journal entries retrieved by a given journal entry id.
| JournalEntryId required | string |
| 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 | ||||||||||||||||||||||
| ErrorDescription | string or null Error description value whenever invoice | ||||||||||||||||||||||
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. | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| 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. | ||||||||||||||||||||||
{- "ModelType": "JournalEntry",
- "Dimensions": {
- "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"
}, - "Identifiers": {
- "BatchId": 421,
- "ExternalJournalEntryId": 675
}, - "LineItems": [
- {
- "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"
}
], - "State": "Pending"
}Supported by: Elite
Update an existing General Ledger Journal Entry
| JournalEntryId required | string |
| Id | string Unique identifier for the model type. | ||
| ErrorCode | string or null Error code value whenever the invoice | ||
| ErrorDescription | string or null Error description value whenever invoice | ||
object Default: {"BatchId":43,"ExternalJournalEntryId":894} Collection of unique ids related to this invoice line item. | |||
| |||
| 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. | ||
| 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 | ||||||||||||||||||||||
| ErrorDescription | string or null Error description value whenever invoice | ||||||||||||||||||||||
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. | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| 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. | ||||||||||||||||||||||
{- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "hierarchy",
- "Contract": "patroller",
- "Customer": "angle",
- "Department": "Sports",
- "Employee": "wilderness",
- "Item": "Bike",
- "JobSite": "cop-out",
- "Location": "30979 N Union Street",
- "Project": "quit",
- "SalesPerson": "Chicken",
- "Vendor": "teriyaki"
}, - "Identifiers": {
- "BatchId": 43,
- "ExternalJournalEntryId": 894
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 684,
- "GrandTotal": 881.45,
- "Identifiers": {
- "ContractId": 778,
- "CustomerId": 378,
- "ExternalContractId": 519,
- "ExternalCustomerId": 495,
- "JournalEntryAccountId": 455,
- "JournalEntryId": 106
}, - "Memo": "paintwork"
}
], - "State": "Posted"
}{- "ModelType": "JournalEntry",
- "Dimensions": {
- "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"
}, - "Identifiers": {
- "BatchId": 421,
- "ExternalJournalEntryId": 675
}, - "LineItems": [
- {
- "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"
}
], - "State": "Pending"
}Supported by: Elite
Elite supports the following fields for the Search filter:
| 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" |
[- {
- "ProductId": "17254",
- "Quantity": "1",
- "ProductAssociation": {
- "ProductAssociationId": "21068",
- "ProductAssociationType": "Automatic"
}
}
]Supported by: Elite
| 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. |
{- "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
}Supported by: Elite
Retrieve a single WebProduct by Id
| Id required | string |
| 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. | |||
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" | ||
{- "ProductId": "17254",
- "Quantity": "1",
- "ProductAssociation": {
- "ProductAssociationId": "21068",
- "ProductAssociationType": "Automatic"
}
}Supported by: Elite
Get an Estimate
| 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
| |||||||
| 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 | ||||||
{- "DepotId": "001",
- "StartDateTime": "2025-04-29T00:00:00Z",
- "EndDateTime": "2025-04-29T04:00:00Z",
- "Products": [
- {
- "Quantity": "1",
- "ProductId": "17254",
- "ProductAssociation": {
- "ProductAssociationId": "21068",
- "ProductAssociationType": "Automatic"
}
}
]
}{- "CustomerId": "227179",
- "DepotId": "002",
- "StartDateTime": "2025-08-01T12:00:00Z",
- "EndDateTime": "2025-08-05T12:00:00Z",
- "Notes": "Notes mine"
}Supported by: Syrinx
| 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. |
[- {
- "description": "Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.",
- "type": "object",
- "properties": {
- "ModelType": {
- "type": "string",
- "enum": [
- "HireRate"
]
}, - "Id": {
- "type": "string"
}, - "Name": {
- "type": "string"
}, - "CategoryName": {
- "description": "The category that the hire rate belongs to.",
- "type": "string"
}, - "DayRate": {
- "description": "The flat rate to charge for a single day.",
- "type": "number"
}, - "HourRate": {
- "description": "The rate to charge per hour.",
- "type": "number"
}, - "WeekRate": {
- "description": "The rate to charge per week.",
- "type": "number"
}, - "WeekRateHalfDay": {
- "description": "The rate to charge for half a week day.",
- "type": "number"
}, - "WeekRate1Day": {
- "description": "The rate to charge for a week day.",
- "type": "number"
}, - "WeekRate2Day": {
- "description": "The rate to charge for 2 week days.",
- "type": "number"
}, - "WeekRate3Day": {
- "description": "The rate to charge for 3 week days.",
- "type": "number"
}, - "WeekRate4Day": {
- "description": "The rate to charge for 4 week days.",
- "type": "number"
}, - "WeekendRate": {
- "description": "The rate to charge over a weekend.",
- "type": "number"
}, - "MonthRate": {
- "description": "The rate to charge per month.",
- "type": "number"
}
}
}
]Supported by: Syrinx
| HireRateId required | string |
| 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. |
[- {
- "description": "Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.",
- "type": "object",
- "properties": {
- "ModelType": {
- "type": "string",
- "enum": [
- "HireRate"
]
}, - "Id": {
- "type": "string"
}, - "Name": {
- "type": "string"
}, - "CategoryName": {
- "description": "The category that the hire rate belongs to.",
- "type": "string"
}, - "DayRate": {
- "description": "The flat rate to charge for a single day.",
- "type": "number"
}, - "HourRate": {
- "description": "The rate to charge per hour.",
- "type": "number"
}, - "WeekRate": {
- "description": "The rate to charge per week.",
- "type": "number"
}, - "WeekRateHalfDay": {
- "description": "The rate to charge for half a week day.",
- "type": "number"
}, - "WeekRate1Day": {
- "description": "The rate to charge for a week day.",
- "type": "number"
}, - "WeekRate2Day": {
- "description": "The rate to charge for 2 week days.",
- "type": "number"
}, - "WeekRate3Day": {
- "description": "The rate to charge for 3 week days.",
- "type": "number"
}, - "WeekRate4Day": {
- "description": "The rate to charge for 4 week days.",
- "type": "number"
}, - "WeekendRate": {
- "description": "The rate to charge over a weekend.",
- "type": "number"
}, - "MonthRate": {
- "description": "The rate to charge per month.",
- "type": "number"
}
}
}
]