Point of Rental API (2024.17.00)

Download OpenAPI specification:Download

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

The Point of Rental (POR) API is intended for both customer and third-party usage. As our API grows, we will strive to enhance this documentation. Please check back often.

If you need assistance with our APIs or have questions regarding our documentation, CONTACT US at [email protected].

Gaining Access

In order to make calls through the Global API, you will need to have several things in place. These steps vary by product. Be sure to review the sections relevant to your flavor of Point of Rental.

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

This means you need to be an active and paying customer of the Elite, Syrinx, or Essentials platforms.

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

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

This means your user account within our product must have an email address for the username and a password that meets the minimum requirements. Additionally, your company must have the 'Global Login' feature turned on and synced up. This setup step varies depending on your product, but we can assist you with this.

4. You will need to obtain an API Key.

Obtain an API Key from Point of Rental by contacting support. This Key will then be used to authenticate the calls against the Global API. This Key is sensitive and should be protected as it allows access to your data. We can change them over time if you wish, so feel free to contact us about this.

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

Feel free to test out the API now with your API Key. Happy API'ing!

Future-proofing

The Point of Rental Global API is constantly expanding. You should code your interactions with it accordingly. It is expected that only breaking changes to the API will result in a version change. Additions of fields and endpoints may happen in any release and without notice. Therefore, you should not rely on an api response matching exactly what you have previously received. You should ignore fields you do not need. Further, the order of fields in a json object is indeterminate, and you should not rely on field order within the response.

Warning: The field list and field order of api responses are subject to non-breaking additions and changes. Please code flexibly to allow for future expansion. (Do not validate to exact type at the object level)

Max Request Size

The maximum size of a single API request is 6MB. For large data sets, we recommend using your application's Export functionality for initial data loads and using the API to maintain data integrity over time.

Filtering

Filters are used to narrow down the results returned by an API endpoint based on specific criteria. Here is a detailed explanation of how filters work within the context of POR’s endpoints: Filters can use various comparators to define their conditions. Here is a list of comparators supported based on RMS:

Supported Filters

Supported by Elite, Essentials, and Syrinx:

`=`, `==` : Equal to
`<` : Less than
`<=` : Less than or equal to
`>` : Greater than
`>=` : Greater than or equal to
`ISNULL` : Field is null
`NOTNULL` : Field is not null
`<>`, `!=` : Not equal to
`LIKE` : Field contains string (e.g. LIKE 'obc' matches 'Bobcat' but not 'Tacocat')
`RLIKE` : Field starts with string (e.g. RLIKE 'Bob' matches 'Bobcat' but not 'Tacocat')
`LLIKE` : Field ends with string (e.g. LLIKE 'cat' matches 'Bobcat' AND 'Tacocat')
`AND` : Logical AND
`OR` : Logical OR

Only Supported by Elite and Essentials:

`IN` : Field is within a set of values
`NOT IN` : Field is not within a set of values

Only supported by Elite:

`!LIKE` : Field does not contain string
`!RLIKE` : Field does not start with string
`!LLIKE` : Field does not end with string

Filter Structure and Examples

Filters are defined using a JSON structure that specifies the field, comparator, and value. Here is a general structure of a filter:

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

Basic Filter Below is a general example of a filter that would retrieve customers with the name of ‘John Doe’:

GET /apikey/customers
X-Filter: [
  {
    'field': 'Name',
    'type': '==',
    'value': 'John Doe'
  }
]

Nested Filter Filters can be combined to further narrow the search results. For example, you could look for customers with an email address who have been created since the beginning of 2024:

GET /apikey/customers
X-Filter: [
  {
    'type': 'AND',
    'value': [
      {
        'field': 'Emails.Email',
        'type': 'NOTNULL',
      },
      {
        'field': 'CreatedDateTime',
        'type': '>',
        'value': '2024-01-01T00:00:00Z'
      }
    ]
  }
]

The above example of an “AND” filter will return only those records which match all of the individual, internal filters.

Your First API Call

There are two types of URLs you can hit.
1. In the first type, you will not need to make any changes to the URL.
Example: https://api.pointofrental.com/v1/apikey/contacts
2. In the second type, you will need to include the ID of the entity you are requesting.
Example: If you have a contact with ID 12345, https://api.pointofrental.com/v1/apikey/contacts/{ContactId} could resolve to https://api.pointofrental.com/v1/apikey/contacts/12345
Your API Key should be included in the request by placing it in the X-API-Key header. Here is a sample request:

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

Paging

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

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

Response Codes

## 2xx Responses:
200 OK:
--  Get All - Record(s) found.
--  Get By Id - Record found.
--  Update - Record updated.
--  Delete - Record deleted.

201 Created - Record created.

204 No Content - No record found.

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

Select the Correct ID Across API Endpoints

To use our API effectively, it’s important to know which ID to reference for specific operations, especially when navigating between multiple endpoints.

ID Naming Conventions

Our API follows a consistent naming standard. Here’s how it works:

Model-Specific IDs:
- When you are interacting within a specific model, the ID field is simply called `Id`.
  - Example: In the Line Item model, the ID field referring to the Line Item ID will simply be called `Id`.
Cross-Model References:
- When one endpoint references an ID from another model, the ID field name is prefixed with the model name.
  - Example: The Invoice endpoint references the Customer ID inside the invoice model by naming it `CustomerId`.
Embedded Models:
- If a model is included or embedded directly within a response, the ID inside that model will still be named `Id` to match the internal structure.
  - Example: The Contact model is embedded in the Customers model. A user can tell the difference between the Contact Id and Customer Id because the Contact Id is nested inside the Contact object.

Additional Resources

Where relevant, we’ll link this guide to key sections in our API documentation to further clarify ID usage and reduce potential confusion.

For further questions about ID usage, contact our support team. We welcome your feedback!.

Utilize Elite Accounting APIs

POR’s Elite product offers seamless direct integrations with leading accounting platforms such as MS Dynamics GP, Intacct, Xero, Sage 50 UK, and QuickBooks Online. These integrations work in the background to synchronize essential data—like general ledger entries, invoices, payments, purchase orders, and customer or vendor records—between Elite and your accounting system.

Direct vs. Custom Integrations

Direct Integrations (No Customer Developers Required)

Customers using our direct integrations do not need to interact with or understand APIs. These integrations are built into the Elite system and automatically handle the communication between Elite and your accounting platform, saving you time and effort. For example:

Payments, purchase orders, and invoices are automatically synced.

Vendor records are created if missing in the accounting system, ensuring smooth data posting. In short, you don’t need to be a developer or know how to use APIs—we handle that for you. Everything happens seamlessly in the background, so you can focus on running your business, not worrying about data transfers. Custom Integrations (Developers Required)
For customers who wish to integrate Elite with custom or accounting systems that aren't supported for direct integration, we provide API licenses to our Elite accounting endpoints. In these cases, understanding how our APIs function can be helpful to developers building the integration. To support this, we offer a detailed overview of how the APIs are structured, along with different modes of integration.

Modes

How the Various Direct Integration Modes Function

Elite provides three distinct accounting modes of direct integration to fit each company's accounting workflow. Each mode offers varying levels of detail and timing for data synchronization between Elite and your accounting system.

Batch GL Mode: Data is transmitted once daily from Elite to the accounting system.
Real-Time GL Mode: Real-time updates of summary GL entries as contracts are processed.
Transaction Mode: Real-time updates with detailed line-item entries. (Unavailable for MS Dynamics.)

Each mode has unique advantages. The table below outlines the key differences between them:

Mode	Key Differences
Batch GL Mode	General Ledger: A daily batch GL summary is sent to the accounting system, including the same line items as seen on the Batch GL Report. Accounts Receivable: Managed in POR. This cannot be managed in the accounting system. Transaction Level Detail is Sent?: No, only GL summaries sent. Customers: No functionality. Payments: All payments must be handled in POR. *Vendors: If payable is posted and vendor does not exist, the vendor will be created to allow posting the payable. Purchase Orders:** Purchase Orders are posted as a payable in the accounting system.
Real-Time GL Mode	General Ledger: As contracts are processed, summary GL entries are sent to the accounting system in real-time. Non-contract-related GL data is sent daily. Accounts Receivable: Managed in POR. This cannot be managed in the accounting system. Transaction Level Detail is Sent?: Yes, summary GL detail at the contract level are sent. Customers: No functionality. Payments: All payments must be handled in POR. *Vendors: If payable is posted and vendor does not exist, the vendor will be created to allow posting the payable. Purchase Orders:** Purchase Orders are posted as a payable in the accounting system.
Transaction Mode**	General Ledger: As contracts are processed, detailed line-level GL entries are sent to the accounting system in real-time. Non-contract-related GL data is sent daily. Accounts Receivable: Managed in the accounting system. This cannot be managed in POR. Transaction Level Detail is Sent?: Yes, transaction-level details for individual invoices are sent to the external accounting system. Customers: If the customer does not exist when posting an invoice to the accounting system, the customer will be created to allow posting the AR transaction details. Payments: Payments on reservations and open contracts can be made in POR. Payments on closed contracts must be done in the accounting system and synchronized with POR. *Vendors: If payable is posted and vendor does not exist, the vendor will be created to allow posting the payable. Purchase Orders:** Purchase Orders are posted as a payable in the accounting system.

Mode

Key Differences

Batch GL Mode

General Ledger: A daily batch GL summary is sent to the accounting system, including the same line items as seen on the Batch GL Report.

Accounts Receivable: Managed in POR. This cannot be managed in the accounting system.

Transaction Level Detail is Sent?: No, only GL summaries sent.

Customers: No functionality.

Payments: All payments must be handled in POR.

Vendors*: If payable is posted and vendor does not exist, the vendor will be created to allow posting the payable.

Purchase Orders: Purchase Orders are posted as a payable in the accounting system.

Real-Time GL Mode

General Ledger: As contracts are processed, summary GL entries are sent to the accounting system in real-time. Non-contract-related GL data is sent daily.

Accounts Receivable: Managed in POR. This cannot be managed in the accounting system.

Transaction Level Detail is Sent?: Yes, summary GL detail at the contract level are sent.

Customers: No functionality.

Payments: All payments must be handled in POR.

Vendors*: If payable is posted and vendor does not exist, the vendor will be created to allow posting the payable.

Purchase Orders: Purchase Orders are posted as a payable in the accounting system.

Transaction Mode**

General Ledger: As contracts are processed, detailed line-level GL entries are sent to the accounting system in real-time. Non-contract-related GL data is sent daily.

Accounts Receivable: Managed in the accounting system. This cannot be managed in POR.

Transaction Level Detail is Sent?: Yes, transaction-level details for individual invoices are sent to the external accounting system.

Customers: If the customer does not exist when posting an invoice to the accounting system, the customer will be created to allow posting the AR transaction details.

Payments: Payments on reservations and open contracts can be made in POR. Payments on closed contracts must be done in the accounting system and synchronized with POR.

Vendors*: If payable is posted and vendor does not exist, the vendor will be created to allow posting the payable.

Purchase Orders: Purchase Orders are posted as a payable in the accounting system.

*Note about Vendors: Specific data synced will vary by accounting system

**Note about Transaction Mode: It is not available for the MS Dynamics integration.

Design

How the APIs Design Power Our Integrations

While direct integrations don't require any customer interaction with APIs, developers building custom integrations can use our Elite Accounting API models. Below is an overview of which API models are relevant for each direct mode of integration.
Available API Requests by Object: See the table below for additional information on the requests available for each object.

Object Requests

AP Bill - Purchase Order / Accounts Payable Bill

GET (BY ID): Retrieve a single Account Payable Invoice

GET (ALL): Retrieve a list of Account Payable Invoices

PATCH: Update an existing Account Payable Invoice

General Ledger (GL) Journal Entry

GET (BY ID): Retrieve a single General Ledger Journal Entry

GET (ALL): Retrieve a list of General Ledger Journal Entries

PATCH: Update an existing General Ledger Journal Entry

Accounts Receivable (AR) Invoice and Payment

GET (BY ID): Retrieve a single Account Receivable Invoice

GET (ALL): Retrieve a list of Account Receivable Invoices

PATCH: Update an existing Account Receivable Invoice

GET (BY ID): Retrieve a single Account Receivable Payment

GET (ALL): Retrieve a list of Account Receivable Payments

POST: Create an Account Receivable Payment

The selected mode determines which API objects and requests are utilized:

Object	Requests
AP Bill - Purchase Order / Accounts Payable Bill	GET (BY ID): Retrieve a single Account Payable Invoice GET (ALL): Retrieve a list of Account Payable Invoices PATCH: Update an existing Account Payable Invoice
General Ledger (GL) Journal Entry	GET (BY ID): Retrieve a single General Ledger Journal Entry GET (ALL): Retrieve a list of General Ledger Journal Entries PATCH: Update an existing General Ledger Journal Entry
Accounts Receivable (AR) Invoice and Payment	GET (BY ID): Retrieve a single Account Receivable Invoice GET (ALL): Retrieve a list of Account Receivable Invoices PATCH: Update an existing Account Receivable Invoice GET (BY ID): Retrieve a single Account Receivable Payment GET (ALL): Retrieve a list of Account Receivable Payments POST: Create an Account Receivable Payment

Batch Mode: Utilizes the GL Journal Entries endpoints.
Real-time GL Mode: Utilizes the Accounts Payable and GL Journal Entries endpoint.
Transactions Mode: Utilizes the Accounts Payable and Accounts Receivable endpoint.

Flow

How the Data Flows and Synchronizes

For direct integrations, all transactions originate in Elite and are synced to the external accounting systems automatically, except for Accounts Receivable (AR) payments, which can originate in either system.

SQL

Example Data Flow: SQL Views and Synchronization

Data is stored in SQL Views inside Elite, accessible under the Accounting tab. (Navigating to the left sidebar, selecting the Accounting tab, clicking on `Re-Print GL Entries`, and then select `View` to see data.) Each object has a corresponding 'parent' SQL view, and each parent row is linked to one or more 'child' rows in a separate view. For example, a contract with three line items will have one parent row and three child rows. The 'parent' view serves as a queue of data waiting to be synchronized with the external accounting system. Each row is processed sequentially, with a pass or fail result as detailed in the table below. The parent view will be updated with the result.

Pass	Update State with the word ‘Posted’
Fail	Update State with the word ‘Error’ Update ErrorDescription with error message (reason for failing)

AP Bill
Parent Row: vwAPI_AP_Invoice
Child Row(s): vwAPI_AP_InvoiceLines where InvoiceId = vwAPI_AP_Invoice.Id

GL Entry
Parent Row: vwAPI_AR_CustomerInvoice
Child Row(s): vwAPI_AR_CustomerInvoiceLines where InvoiceId = vwAPI_AR_CustomerInvoice.Id

AR Invoice
Parent Row: vwAPI_GL_JournalEntry
Child Row(s): vwAPI_GL_JournalEntryLines where JournalEntryId = vwAPI_GL_JournalEntry.Id

AR Payment
Parent Row Only: vwAPI_AR_Payment

AR Payments

How Transaction Mode Utilizes AR Payments

In Transaction Mode, AR (Accounts Receivable) payments can be initiated in either Elite or the accounting system. However, once an AR invoice is sent to the accounting system, all subsequent payments must be made there and then synced back to Elite.

In POR before the invoice is closed and sent with the AR Invoice when it flows to the external accounting system

AND/OR

In the external accounting system after the AR Invoice is sent to the external accounting system and synced back to POR.

The following fields will be required to be filled out for it to successfully post to POR:

ContractNumber: The Contract Number associated with the AR Invoice.
CustomerNumber: The Customer Number on the AR Invoice.
ExternalPaymentId: The ID of the payment in the external accounting system.
Credit Memos Only: If the payment is a Credit Memo being applied, the `CreditSourceContract` will need to be populated with the Credit Memo Contract Number so that we can mark that Credit Memo as used in POR.

Summary

Whether you use our out-of-the-box direct integrations or need custom API-based integrations, Elite ensures smooth data exchange. Direct integrations require minimal technical knowledge, as everything happens behind the scenes. For those building custom integrations, we offer API documentation and support to ensure a successful implementation.

Retrieve a list of Categories

Supported by: Elite, Essentials, and Syrinx

Returns an array containing all Categories, with support for filtering as indicated below.

Authorizations:

APIKey

Responses

Results returned as shown below.

Response Schema: application/json

Array

ModelType

string

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 upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Category	ItemCategory.Category
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CW_PRODUCT_CATEGORIES.CWC_ID

Name

string or null

The display name for this Category record.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Description	ItemCategory.Name
Essentials	Yes	Yes	Category	N/A
Syrinx	Yes	Yes	Category Name	CW_PRODUCT_CATEGORIES.CWC_NAME

Identifiers

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	No, always `null`	--	--	--	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	No, always `null`	--	--	--	--

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	No, always `null`	--	--	--	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	No, always `null`	--	--	--	--

Hidden

integer or null

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database	AdditionalInfo
Elite	Yes	N/A	N/A	N/A	Always returns 0.
Essentials	Yes	N/A	N/A	N/A	N/A
Syrinx	Yes	N/A	N/A	N/A	Always returns 0.

Description

string or null

An optional phrase, single sentence, or short paragraph describing the Category.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Description	N/A
Syrinx	Yes	Yes	Category Name	CW_PRODUCT_CATEGORIES.CWC_NAME

DisplayOrder

number or null >= 0

This is the internal products display order and may not be optimal for customer facing usages.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Category List Order	N/A
Syrinx	Yes	Yes	Display Sequence	CW_PRODUCT_CATEGORIES.CWC_DISPLAY_SEQUENCE

Division

string or null

This is a parent grouping for Categories.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Division	ItemCategory.DivisionName
Essentials	No, always `null`	--	--	--
Syrinx	No	--	--	--

Array of objects

An array of publicly accessible URLs represented images for the Category, as well as any alternate text associated with each image.

Software	Supported	Filterable	UI	Database	AdditionalInfo
Elite	No, returns empty array	--	--	--	--
Essentials	Yes	Yes	Category Photo	N/A	Only supports a single image per Category.
Syrinx	No	--	--	--	--

ParentCategoryId

string or null

The Category Id of this Category's parent.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	Yes	Parent Category	CW_PRODUCT_CATEGORIES.CWC_PARENT_ID

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "Category",
"Id": "12",
"Name": "Power Tools",
"Identifiers": { },
"Description": null,
"DisplayOrder": null,
"Division": "Construction",
"Images": [ ],
"ParentCategoryId": null,
"Tags": [ ],
"AdditionalFields": { },
"CreatedDateTime": null,
"UpdatedDateTime": null,
"Hidden": 0
}

Retrieve a single Category by Id

Supported by: Elite, Essentials, and Syrinx

Retrieves a single Category specified by its ID.

Authorizations:

APIKey

path Parameters

CategoryId

required

string

Example: 12

Provide the unique ID of the Category record you want to retrieve.

Responses

Results returned as shown below.

Response Schema: application/json

ModelType

string

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 upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Category	ItemCategory.Category
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CW_PRODUCT_CATEGORIES.CWC_ID

Name

string or null

The display name for this Category record.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Description	ItemCategory.Name
Essentials	Yes	Yes	Category	N/A
Syrinx	Yes	Yes	Category Name	CW_PRODUCT_CATEGORIES.CWC_NAME

Identifiers

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	No, always `null`	--	--	--	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	No, always `null`	--	--	--	--

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	No, always `null`	--	--	--	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	No, always `null`	--	--	--	--

Hidden

integer or null

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database	AdditionalInfo
Elite	Yes	N/A	N/A	N/A	Always returns 0.
Essentials	Yes	N/A	N/A	N/A	N/A
Syrinx	Yes	N/A	N/A	N/A	Always returns 0.

Description

string or null

An optional phrase, single sentence, or short paragraph describing the Category.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Description	N/A
Syrinx	Yes	Yes	Category Name	CW_PRODUCT_CATEGORIES.CWC_NAME

DisplayOrder

number or null >= 0

This is the internal products display order and may not be optimal for customer facing usages.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Category List Order	N/A
Syrinx	Yes	Yes	Display Sequence	CW_PRODUCT_CATEGORIES.CWC_DISPLAY_SEQUENCE

Division

string or null

This is a parent grouping for Categories.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Division	ItemCategory.DivisionName
Essentials	No, always `null`	--	--	--
Syrinx	No	--	--	--

Array of objects

An array of publicly accessible URLs represented images for the Category, as well as any alternate text associated with each image.

Software	Supported	Filterable	UI	Database	AdditionalInfo
Elite	No, returns empty array	--	--	--	--
Essentials	Yes	Yes	Category Photo	N/A	Only supports a single image per Category.
Syrinx	No	--	--	--	--

Array

Uri	string Essentials Only: Public URL for the image.
AltText	string or null Essentials Only: Currently returns the 'Name' of the Category.

ParentCategoryId

string or null

The Category Id of this Category's parent.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	Yes	Parent Category	CW_PRODUCT_CATEGORIES.CWC_PARENT_ID

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "Category",
"Id": "12",
"Name": "Power Tools",
"Identifiers": { },
"Description": null,
"DisplayOrder": null,
"Division": "Construction",
"Images": [ ],
"ParentCategoryId": null,
"Tags": [ ],
"AdditionalFields": { },
"CreatedDateTime": null,
"UpdatedDateTime": null,
"Hidden": 0
}

Contacts

Supported by: Elite, Essentials, and Syrinx

Contacts are often individuals who work for a person or company that has a Customer record. Contacts may be allowed to rent on behalf of the related Customer record. In each RMS product, this concept is implemented with slight differences as noted below:

In Elite: Contacts can be linked to one or more Customer records. Contacts can be used to lookup related Customers and vice versa. For additional information, read this article.
In Essentials: There could be zero to many related contacts for each Customer record. If an individual is a contact for a company's Customer record, the individual will provide their information, and the UI will prompt whether they are renting as an individual or on behalf of their company. Here is a video about how Contacts work in Essentials.
In Syrinx: There could be zero to many related contacts for each Customer or Supplier record. If a Contact record is associated with multiple Customer or Supplier records, it will need to have a separate entry in each Customer/Supplier record. Besides renting, Contacts are used for deliveries, collections, and the accounts department.

Retrieve a list of Contacts

Supported by: Elite, Essentials, and Syrinx

Returns an array containing all Contacts, with support for filtering as indicated below.

Authorizations:

APIKey

Responses

Results returned as shown below.

Response Schema: application/json

Array

ModelType

string

Enum: "Contact" "CustomerContact" "VendorContact"

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

Software	Supported	Additional Info
Elite	Yes	Supports `Contact`
Essentials	Yes	Supports `CustomerContact`
Syrinx	Yes	Supports `CustomerContact` and `VendorContact`

Id

string

The unique Id for this record. This is system-generated upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	Authorized.Number
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CCT_ID

Name

string or null

The display name for this Contact record.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	Authorized.Name
Essentials	Yes	Yes	'First Name' + 'Last Name'	N/A
Syrinx	Yes	Yes	Name	CCT_FIRST_NAME + CCT_LAST_NAME

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint. Expand to see nested fields.

Array of objects

Only supported by Essentials and Syrinx with details described below.

An array of addresses associated with the Contact. These could include customer, company, or vendor addresses. Not all address fields may be filled out depending on someone's location.

As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

CompanyName

string or null

In Essentials, if this Contact represents a company, the company's name is returned in this field. In Syrinx, this field returns the name of the customer or supplier.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Company	N/A
Syrinx	Yes	Yes	Customer or Supplier	CST_NAME or SUP_NAME

Department

string or null

A freeform field that is intended to return a department associated with the Contact. Ex: Sales, Events, etc.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Department	Authorized.Department
Essentials	No, always `null`	--	--	--
Syrinx	No	--	--	--

Disabled

boolean or null

This is the state of the Contact record. TRUE means the Contact is temporarily deactivated. FALSE means the Contact is active. By default, this state is FALSE.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Inactive Date	Authorized.InactiveDate
Essentials	No	--	--	--
Syrinx	No	--	--	--

Array of objects or null

An array of emails associated with this record. As a reminder, arrays may return as empty, with one result, or multiple results. Expand to see nested fields.

FirstName

string or null

If the Contact represents an individual, this field returns the person's first name.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	First Name	N/A
Syrinx	No	--	--	--

LastName

string or null

If the Contact represents an individual, this field returns the person's last name.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Last Name	N/A
Syrinx	No	--	--	--

Array of objects or null

An array of phone number associated with this record. As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

Title

string or null

The Contact's job title.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Title	Authorized.Title
Essentials	Yes	Yes	Job Title	N/A
Syrinx	No	--	--	--

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	N/A	Authorized.DateCreated	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	Yes	No	N/A	CCT_DATE_ADDED	--

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	N/A	Authorized.DateChanged	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	No, always `null`	--	--	--	--

Hidden

integer or null

Enum: 0 1 null

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database	AdditionalInfo
Elite	Yes	N/A	N/A	N/A	If `AdditionalFields.InactiveDateTime` is set, this field will return `1`; otherwise, it will return `0`.
Essentials	Yes	N/A	N/A	N/A	N/A
Syrinx	Yes	N/A	N/A	N/A	Always returns `0`

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "Contact",
"Id": "2",
"Name": "Joe Bloggs",
"Identifiers": {"ParentId": "54321",
"DriversLicense": "11223344",
"EmployeeId": "22"
},
"Addresses": [ ],
"CompanyName": null,
"Emails": [{"Type": "Default",
"Email": "[email protected]"
}
],
"FirstName": null,
"LastName": null,
"Phones": [{"Type": "Default",
"CountryCode": null,
"Number": "5551231234",
"NumberE164": null,
"Extension": "",
"SmsCapable": false
}
],
"AdditionalFields": {"InactiveDateTime": null
},
"CreatedDateTime": null,
"UpdatedDateTime": "2022-01-01T17:35:10.457z",
"Hidden": 0,
"Department": "Implementation",
"Title": "Support Technician",
"Disabled": false
}

Create a new Contact

Supported by: Elite

Required fields:

Name
Identifiers.ParentId (Elite)

Authorizations:

API Key

Request Body schema: application/json
required

Name

string or null [ 1 .. 50 ] characters

Default: "string"

The display name for the contact.

object or null

Default: {}

Identifying items for Contact.

DriversLicense	string or null The contact's drivers license number.
EmployeeId	string or null The contact's employee id.
ParentId	string or null Required by Elite.

Department

string or null <= 50 characters

Default: "string"

Department of the company.

Disabled

boolean or null

Default: false

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

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null

Default: []

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

Array

Type required	string Value: "Default" Supported types.
Email required	string or null <= 50 characters A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName

string or null

Default: "string"

First Name (if it's an individual).

Elite: Read-Only

LastName

string or null

Default: "string"

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null

Default: []

Can support multiple phone numbers for a contacts.

Array

Type required	string Default: "Default" Enum: "Default" "Mobile" "Secondary" Supported phone types. "Default" is the default phone number for the contact. Elite: Only supports one of each value, "Default" and "Mobile". Essentials: Only supports "Default" and "Secondary".
Number required	string or null <= 50 characters A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported

Title

string or null <= 255 characters

Default: "string"

The contact's title.

object or null

Default: {}

Additional fields for Contact.

InactiveDateTime

string or null <date-time>

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

Elite: Supported.
Syrinx: Not supported.

Responses

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"CompanyName": "string",
"Department": "string",
"Disabled": false,
"Emails": [ ],
"FirstName": "string",
"LastName": "string",
"Phones": [ ],
"Title": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Response samples

201
4XX

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"CompanyName": "string",
"Department": "string",
"Disabled": false,
"Emails": [ ],
"FirstName": "string",
"LastName": "string",
"Phones": [ ],
"Title": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Retrieve a single Contact by Id

Supported by: Elite, Essentials, and Syrinx

Retrieve a singles Contact by its Id.

Authorizations:

APIKey

path Parameters

ContactId

required

string

Example: 24

Provide the unique ID of the Contact you want to retrieve.

Responses

Results returned as shown below.

Response Schema: application/json

ModelType

string

Enum: "Contact" "CustomerContact" "VendorContact"

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

Software	Supported	Additional Info
Elite	Yes	Supports `Contact`
Essentials	Yes	Supports `CustomerContact`
Syrinx	Yes	Supports `CustomerContact` and `VendorContact`

Id

string

The unique Id for this record. This is system-generated upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	Authorized.Number
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CCT_ID

Name

string or null

The display name for this Contact record.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	Authorized.Name
Essentials	Yes	Yes	'First Name' + 'Last Name'	N/A
Syrinx	Yes	Yes	Name	CCT_FIRST_NAME + CCT_LAST_NAME

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint. Expand to see nested fields.

DriversLicense

string or null

The driver's license number associated with the Contact.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	DL Number	Authorized.DlNo
Essentials	No, always returns `Not Available`	--	--	--
Syrinx	No	--	--	--

EmployeeId

string or null

In Elite, this is a freeform field labeled 'Employee Id' that could contain varied data. In Essentials, this field returns the Customer Contact Id, which will match the Contacts.Id field.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Employee Id	Authorized.EmployeeId
Essentials	Yes	No	Customer Contact Id	N/A
Syrinx	No	--	--	--

ParentId

string or null

In Elite, this field returns an associated Company’s Customer number if applicable. In Essentials, this field returns an associated Customer Id. In Syrinx, this will match Contacts.Id.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	Authorized.CNUM
Essentials	Yes	No	N/A	N/A
Syrinx	Yes	Yes	N/A	CCT_CUSTOMER_ID or CCT_SUPPLIER_ID

Array of objects

Only supported by Essentials and Syrinx with details described below.

An array of addresses associated with the Contact. These could include customer, company, or vendor addresses. Not all address fields may be filled out depending on someone's location.

As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

Array

Type

string

Enum: "Billing" "Shipping" "Default"

A general label that could be used to help define the type of address being returned.

Software	Supported	Additional Info
Essentials	Yes	Always `Default`
Syrinx	Yes	Always `Default`

Name

string or null

Optional freeform field used to name the address.

Software	Supported	Filterable	UI	Database
Essentials	No	--	--	--
Syrinx	Yes	Yes	Name	CUST.NAME

Line1

string or null

First line of the address field. Typically, this contains address number and street.

Software	Supported	Filterable	UI	Database
Essentials	Yes	Yes	Street Address	N/A
Syrinx	Yes	Yes	Address	ADR_LINE1

Line2

string or null

Second line of the address field. Often includes apartment, building, or suite number if applicable.

Software	Supported	Filterable	UI	Database
Essentials	Yes	Yes	Suite	N/A
Syrinx	Yes	Yes	Address	ADR_LINE2

Line3

string or null

Third line of the address field. Additional information if needed.

Software	Supported	Filterable	UI	Database
Essentials	No	--	--	--
Syrinx	Yes	Yes	Address	ADR_LINE3

City

string or null

City or Town for this address.

Software	Supported	Filterable	UI	Database
Essentials	Yes	Yes	City	N/A
Syrinx	Yes	Yes	Town	ADR_TOWN

GeoRegion2

string or null

Municipality or County for this address.

Software	Supported	Filterable	UI	Database
Essentials	Yes	No	'Municipality'; hidden in default UI setup	N/A
Syrinx	Yes	No	County	ADR_COUNTY

GeoRegion3

string or null

In Essentials, this represents the 'Town' if this field is turned on. By default, this field is not present on the UI.

Software	Supported	Filterable	UI	Database
Essentials	Yes	No	'Town'; hidden in default UI setup	N/A
Syrinx	No, always `null`	--	--	--

Province

string or null

This is the geographical State for this Address.

Software	Supported	Filterable	UI	Database
Essentials	Yes	Yes	State	N/A
Syrinx	No, always `null`	--	--	--

PostalCode

string or null

May be postal code, postcode, PIN, ZIP Code, etc. depending on the country.

Software	Supported	Filterable	UI	Database
Essentials	Yes	Yes	Postal Code	N/A
Syrinx	Yes	Yes	Postcode	ADR_POSTCODE

Latitude

string or null

Latitude coordinate in (DD) Decimal Degree format. When the address is entered, the latitude can include up to 9 decimals places based on the 30 character length of the delivery address field in transactions. - LOC:LAT, LON - Loc: XX.123456789, -YY.123456789

Software	Supported	Filterable	UI	Database
Essentials	No	--	--	--
Syrinx	Yes	Yes	Latitude	ADR_LATITUTDE

Longitude

string or null

Longitude coordinate in (DD) Degree Decimal format. When the address is entered, the longitude cna include up to 9 decimals places based on the 30 character length of the delivery address field in transactions. - LOC:LAT, LON - Loc: XX.123456789, -YY.123456789

Software	Supported	Filterable	UI	Database
Essentials	No	--	--	--
Syrinx	Yes	Yes	Longitude	ADR_LONGITUDE

Country

string or null

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

Software	Supported	Filterable	UI	Database
Essentials	Yes	No	Country	N/A
Syrinx	No, matches `Addresses.GeoRegion2`	--	--	--

CompanyName

string or null

In Essentials, if this Contact represents a company, the company's name is returned in this field. In Syrinx, this field returns the name of the customer or supplier.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Company	N/A
Syrinx	Yes	Yes	Customer or Supplier	CST_NAME or SUP_NAME

Department

string or null

A freeform field that is intended to return a department associated with the Contact. Ex: Sales, Events, etc.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Department	Authorized.Department
Essentials	No, always `null`	--	--	--
Syrinx	No	--	--	--

Disabled

boolean or null

This is the state of the Contact record. TRUE means the Contact is temporarily deactivated. FALSE means the Contact is active. By default, this state is FALSE.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Inactive Date	Authorized.InactiveDate
Essentials	No	--	--	--
Syrinx	No	--	--	--

Array of objects or null

An array of emails associated with this record. As a reminder, arrays may return as empty, with one result, or multiple results. Expand to see nested fields.

Array

Type

string

Enum: "Default" "Billing"

A general label to help define the type of email being returned. Might provide context about the type of email address provided.

Software	Supported	Additional Info
Elite	Yes	Always `Default`
Essentials	Yes	Always `Default`
Syrinx	Yes	Always `Billing`

Email

string

Email associated with this contact.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Email	Authorized.Email
Essentials	Yes	Yes	Email	N/A
Syrinx	Yes	Yes	EMail	CCT_EMAIL_ID

FirstName

string or null

If the Contact represents an individual, this field returns the person's first name.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	First Name	N/A
Syrinx	No	--	--	--

LastName

string or null

If the Contact represents an individual, this field returns the person's last name.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Last Name	N/A
Syrinx	No	--	--	--

Array of objects or null

An array of phone number associated with this record. As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

Array

Type

string

Enum: "Default" "Mobile" "Primary" "Secondary"

In POR products that support multiple phone numbers, the phone type is often identified by the field in the UI where the number is entered.

Software	Supported	Additional Info
Elite	Yes	Supports `Default` or `Mobile`
Essentials	Yes	Supports `Default`, `Primary`, and `Secondary`
Syrinx	Yes	Only supports `Default`

RemoteId

string or null

Deprecated

This field is deprecated and will completely lose support in the future. A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode

string or null

Country code prefix to phone number. List of country code prefixes found here.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	No	Chosen as part of phone selector	N/A
Syrinx	Yes	No	Regex from phone number	CCT_TELEPHONE_NUMBER or CCT_MOBILE_NUMBER

Number

string or null

A phone number associated with this record.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	Phone or Mobile	Authorized.Phone or Authorized.Mobile
Essentials	Yes	Yes	Primary Phone Number or Secondary Phone Number	N/A
Syrinx	Yes	No	Telephone Number or Mobile	CCT_TELEPHONE_NUMBER or CCT_MOBILE_NUMBER

NumberE164

string or null

A supplied phone number will return here if it has been validated according to the E.164 format.

Software	Supported	Filterable
Elite	No, always `null`	--
Essentials	Yes	Yes
Syrinx	Yes	Yes

Extension

string or null

Extension associated with the provided number.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx	No, always `null`	--	--	--

SmsCapable

boolean or null

Answers whether the phone can be sent SMS messages. Included for future growth.

Software	Supported
Elite	No, always `false`
Essentials	No
Syrinx	No, always `false`

Title

string or null

The Contact's job title.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Title	Authorized.Title
Essentials	Yes	Yes	Job Title	N/A
Syrinx	No	--	--	--

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

InactiveDateTime

string or null <date-time>

This is the date that this Contact is no longer authorized to be associated with the customer account.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Inactive Date	Authorized.InactiveDate
Essentials	No	--	--	--
Syrinx	No	--	--	--

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	N/A	Authorized.DateCreated	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	Yes	No	N/A	CCT_DATE_ADDED	--

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	N/A	Authorized.DateChanged	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	No, always `null`	--	--	--	--

Hidden

integer or null

Enum: 0 1 null

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database	AdditionalInfo
Elite	Yes	N/A	N/A	N/A	If `AdditionalFields.InactiveDateTime` is set, this field will return `1`; otherwise, it will return `0`.
Essentials	Yes	N/A	N/A	N/A	N/A
Syrinx	Yes	N/A	N/A	N/A	Always returns `0`

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "Contact",
"Id": "2",
"Name": "Joe Bloggs",
"Identifiers": {"ParentId": "54321",
"DriversLicense": "11223344",
"EmployeeId": "22"
},
"Addresses": [ ],
"CompanyName": null,
"Emails": [{"Type": "Default",
"Email": "[email protected]"
}
],
"FirstName": null,
"LastName": null,
"Phones": [{"Type": "Default",
"CountryCode": null,
"Number": "5551231234",
"NumberE164": null,
"Extension": "",
"SmsCapable": false
}
],
"AdditionalFields": {"InactiveDateTime": null
},
"CreatedDateTime": null,
"UpdatedDateTime": "2022-01-01T17:35:10.457z",
"Hidden": 0,
"Department": "Implementation",
"Title": "Support Technician",
"Disabled": false
}

Update a single Contact by Id

Supported by: Elite

Required fields:

Id

Authorizations:

API Key

path Parameters

ContactId

required

string

Request Body schema: application/json
required

Name

string or null [ 1 .. 50 ] characters

Default: "string"

The display name for the contact.

object or null

Default: {}

Identifying items for Contact.

DriversLicense	string or null The contact's drivers license number.
EmployeeId	string or null The contact's employee id.
ParentId	string or null Required by Elite.

Department

string or null <= 50 characters

Default: "string"

Department of the company.

Disabled

boolean or null

Default: false

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

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null

Default: []

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

Array

Type required	string Value: "Default" Supported types.
Email required	string or null <= 50 characters A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName

string or null

Default: "string"

First Name (if it's an individual).

Elite: Read-Only

LastName

string or null

Default: "string"

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null

Default: []

Can support multiple phone numbers for a contacts.

Array

Type required	string Default: "Default" Enum: "Default" "Mobile" "Secondary" Supported phone types. "Default" is the default phone number for the contact. Elite: Only supports one of each value, "Default" and "Mobile". Essentials: Only supports "Default" and "Secondary".
Number required	string or null <= 50 characters A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported

Title

string or null <= 255 characters

Default: "string"

The contact's title.

object or null

Default: {}

Additional fields for Contact.

InactiveDateTime

string or null <date-time>

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

Elite: Supported.
Syrinx: Not supported.

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Enum: "Contact" "CustomerContact" "VendorContact" "ContractContact"

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

Contact
CustomerContact
VendorContact
ContractContact

Id

string

Default: "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

Default: "string"

The display name for the contact.

object or null

Default: {}

Identifying items for Contact.

DriversLicense	string or null The contact's drivers license number.
EmployeeId	string or null The contact's employee id.
ParentId	string or null In Elite, ParentId is the same as CustomerId.

Array of objects

Default: []

Can support multiple addresses for a contact.

Elite: This field is not supported.

Array

Type required	string Default: "Default" Examples include "Default", "Billing", etc. Supported types depend on the context of the address.
Name	string or null Optional name for Address
Line1	string or null Address Number and Street.
Line2	string or null May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null City Address is located in.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null May be State, Province or Division depending on the country.
PostalCode	string or null May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

CompanyName

string or null

Default: "string"

Name of the company.

Elite: This field is not supported.

Department

string or null

Default: "string"

Department of the company.

Disabled

boolean or null

Default: false

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

Elite: Supported

Essentials: Supported

Syrinx: Not Supported

Array of objects or null

Default: []

Can support multiple email addresses for a contact.

Elite: This array will only have a single element.

Array

Type required	string Value: "Default" Supported types.
Email required	string or null A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName

string or null

Default: "string"

First Name (if it's an individual).

Elite: Read-Only

LastName

string or null

Default: "string"

Last Name (if it's an individual).

Elite: Read-Only

Array of objects or null

Default: []

Can support multiple phone numbers for a contacts.

Array

Type required	string Default: "Default" Enum: "Default" "Mobile" "Secondary" Supported phone types. "Default" is the default phone number for the contact. Elite: Only supports one of each value, "Default" and "Mobile". Essentials: Only supports "Default" and "Secondary".
Number required	string or null A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported
NumberE164	string or null A phone number must be supplied and validated according to the E.164 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
Extension	string or null Is there an extension associated with this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
SmsCapable	boolean or null Can an SMS be sent to this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Title

string or null

Default: "string"

The contact's title.

object or null

Default: {}

Additional fields for Contact.

InactiveDateTime

string or null <date-time>

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

Elite: Supported.
Syrinx: Not supported.

CreatedDateTime

string or null <date-time>

Default: "string"

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

UpdatedDateTime

string or null <date-time>

Default: "string"

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

Hidden

integer

Default: 0

Enum: null 1

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

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"CompanyName": "string",
"Department": "string",
"Disabled": false,
"Emails": [ ],
"FirstName": "string",
"LastName": "string",
"Phones": [ ],
"Title": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Response samples

200
4XX

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"CompanyName": "string",
"Department": "string",
"Disabled": false,
"Emails": [ ],
"FirstName": "string",
"LastName": "string",
"Phones": [ ],
"Title": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Contract Actions

Call a Contract Off Rent

Supported by: Elite

Authorizations:

API Key

Request Body schema: application/json
required

ContractId required	string Default: "string" The unique id for the contract
CalledOffDateTime required	string <date-time> Default: "string" What date and time to call off the line item. UTC time zone. e.g. 2023-01-01T06:00:00Z
PersonCallingOff	string Default: "string" Name of the person who is calling the contract off rent.
Memo	string Default: "string" Additional textual information for calling a contract off rent.
RemoteUserId	string Default: "string" An identifier on the remote server for the user's account. Can be User ID, Username, anything to match the Relationship to a user.

Responses

Request samples

Payload

Content type

application/json

{"ContractId": "string",
"CalledOffDateTime": "string",
"PersonCallingOff": "string",
"Memo": "string",
"RemoteUserId": "string"
}

Response samples

201

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"AmountDue": 0,
"AmountPaid": 0,
"Contacts": [ ],
"ContractInformation": "string",
"CustomerId": "string",
"CustomerName": "string",
"CustomerPickup": { },
"DriverDelivery": { },
"DepotId": "string",
"DriverPickup": { },
"EndDateTime": "string",
"EsignState": "string",
"EsignUrl": "string",
"GrandTaxTotal": 0,
"GrandTotal": 0,
"LaborTracking": { },
"LineItems": [ ],
"LocationId": "string",
"Notes": [ ],
"PONumber": "string",
"StartDateTime": "string",
"Status": "string",
"Totals": [ ],
"Workflows": [ ],
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"ContractStatus": "string",
"IsDelivery": false,
"IsPickup": false
}

Contracts

Retrieve a list of Contracts

Supported by: Elite, Syrinx

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" 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: "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 Default: "string" A display name for this record. Often used as a summary for lookups.
	object or null Default: {} Identifying items for Contract.
	Array of objects Default: [] Site addresses. Address type should be default.
AmountDue	number Default: 0 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: 0 The total amount paid on this contract as of the queried date. If additional payments are made, this field will reflect the updated total in the next request
	Array of objects Default: [] Contact records and their corresponding types.
ContractInformation	string or null Default: "string" 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: "string" Reference a CustomerId that should be responsible for this Contract.
CustomerName	string or null Default: "string" The Customer Name (usually will include first and last name).
	object or null Default: {}
	object or null Default: {} For Internal Use. Location, address, special instructions and data/time of Delivery
DepotId	string or null Default: "string" Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)
	object or null Default: {}
EndDateTime	string or null <date-time> Default: "string" 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: "string" 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: 0 This is the final projected tax for this contract.
GrandTotal	number or null Default: 0 This is the final projected total price for this contract accounting for qty, discounts, duration, tax, etc..
	object or null Default: {} Labor tracking details.
	Array of objects Default: [] The Line Items associated with this contract.
LocationId	string or null Default: "string" Id of the Location. (see the Location endpoints)
	Array of objects Default: [] Any comments or notes.
PONumber	string or null Default: "string" 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: "string" UTC When does the customer want the items?
Status	string Default: "string" Enum: "Quote" "Reservation" "Open" "Off Rent" "Returned" "Closed" "Voided" null What is the current status of the contract? Quote: Reservation Open Returned: All inventory has reached its final spot. Accounted for. Off Rent: All inventory assets are awaiting collection prior to finalization of the contract values. Closed: No further activity available for this contract. Fully Paid. Voided
	Array of objects or null Default: [] Lines which should appear in the totals section for the contract
	Array of objects Default: [] For Internal Use.
	object or null Default: {} Additional fields for Contract.
CreatedDateTime	string or null <date-time> Default: "string" 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: "string" UTC When was the contract updated?
Hidden	integer Default: 0 Enum: null 1 0 = false, 1 = true \| This basically means Deleted
ContractStatus	string Deprecated Default: "string" Enum: "Quote" "Reservation" "Open" "Returned" "Closed" "Voided" null Deprecated: Use Status field instead. What is the current status of the contract? Quote: Reservation Open Returned: All inventory has reached its final spot. Accounted for. Closed: No further activity available for this contract. Fully Paid. Voided
IsDelivery	boolean Default: false True when the contract is marked for delivery.
IsPickup	boolean Default: false True when the contract is marked for customer pickup.
	number or string For elite, only a number. It is a monotomic that can be used to detect changes.

Response samples

200

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"AmountDue": 0,
"AmountPaid": 0,
"Contacts": [ ],
"ContractInformation": "string",
"CustomerId": "string",
"CustomerName": "string",
"CustomerPickup": { },
"DriverDelivery": { },
"DepotId": "string",
"DriverPickup": { },
"EndDateTime": "string",
"EsignState": "string",
"EsignUrl": "string",
"GrandTaxTotal": 0,
"GrandTotal": 0,
"LaborTracking": { },
"LineItems": [ ],
"LocationId": "string",
"Notes": [ ],
"PONumber": "string",
"StartDateTime": "string",
"Status": "string",
"Totals": [ ],
"Workflows": [ ],
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"ContractStatus": "string",
"IsDelivery": false,
"IsPickup": false
}
]

Retrieve a single Contract by Id

Supported by: Elite, Syrinx

Authorizations:

API Key

path Parameters

ContractId

required

string

Responses

Response Schema: application/json

ModelType

string

Default: "string"

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

Default: "string"

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

object or null

Default: {}

Identifying items for Contract.

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.
Barcode	string or null The barcode identifier assigned to this particular Line Item. Elite: This field is not supported.
Alias	string or null The alias identifier assigned to this particular Line Item. Elite: This field is not supported.

Array of objects

Default: []

Site addresses. Address type should be default.

Array

Type required	string Default: "Default" Examples include "Default", "Billing", etc. Supported types depend on the context of the address.
Name	string or null Optional name for Address
Line1	string or null Address Number and Street.
Line2	string or null May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported. and will always return null. There are no plans to support this in Elite.
City	string or null City Address is located in.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null May be State, Province or Division depending on the country.
PostalCode	string or null May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported. and will always return null. There are no plans to support this in Elite.

AmountDue

number

Default: 0

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

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

Array of objects

Default: []

Contact records and their corresponding types.

Array

Type

string

Enum: "Default" "Customer" "Delivery" "Pickup" "Order" "Billing" null

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

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

object

ContractInformation

string or null

Default: "string"

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: "string"

Reference a CustomerId that should be responsible for this Contract.

CustomerName

string or null

Default: "string"

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

object or null

Default: {}

LocationName	string or null
	(object or null) or (any or null)
Instructions	string or null
DateTime	string or null <date-time> Day and time delivery is expected to be completed.

object or null

Default: {}

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

LocationName	string or null
	(object or null) or (object or null)
Instructions	string or null
DateTime	string or null <date-time> Day and time delivery is expected to be completed.

DepotId

string or null

Default: "string"

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

object or null

Default: {}

LocationName	string or null
	object or (any or null) Customer or vendor addresses. Not all address fields may be filled depending on someone's location. Elite: Only "Default" is supported.
Instructions	string or null
DateTime	string or null <date-time> Day and time delivery is expected to be completed.

EndDateTime

string or null <date-time>

Default: "string"

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: "string"

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

This is the final projected tax for this contract.

GrandTotal

number or null

Default: 0

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

object or null

Default: {}

Labor tracking details.

Array of objects or null

Array of objects

Default: []

The Line Items associated with this contract.

Array

ModelType	string Value: "LineItem" Standard field that denotes the record type. Useful for bulk ingesting different record types.
Id	string The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.
Name	string or null A display name for this record. Often used as a summary for lookups.
	object or null Identifying items for LineItem.
Classification	string Enum: "Rental" "Sale" null This product is either meant for sale or rental. The internal classification does not apply to lineitems.
FuelCapacity	number or null If this item has a fuel, this is the total amount of fuel this line item can have. No units are provided. If the value returned is “0” that means that a fuel capacity has been provided, and it doesn’t have any. If “null” is provided, then no fuel capacity has been recorded. This field should only show up if the isFuel field is true.
HasFuel	boolean or null If this is related to an item that uses fuel, this field will be set. If not it will be false.
IsSerialized	boolean or null Do we expect this Line Item to have a unique Serial Number or is it a bulk item? NOTE - Some bulk items may still have serial numbers in some systems.
IsBulk	boolean or null Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.
ItemId	string or null Deprecated Kept for legacy support, will eventually only need StockId and ProductId.
LineTaxTotal	number or null This is the final projected tax for this line.
LineTotal	number or null This is the final projected price for this line accounting for qty, discounts, duration, tax, etc..
	Array of objects or null Meter readings of this inventory. Multiple readings allowed for different types.
Notes	string or null Notes attached to a line item. Not an array of notes like its similarly name fields.
ProductId	string or null If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)
Quantity	number How many of this Line Item are there? NOTE - there can be multiple Line Items that have the same inventory item associated with them for various reasons so this does not mean that ALL of the [some inventory] will show up under this Line Item.
Rates	Array of strings or null The rates that have been associated to this line item as shown on the Contract. The Rental Management Software may apply these from default, or special rates.
SerialNumber	string or null The serial number or unique identifier assigned to this particular Line Item.
ShowOnContract	boolean Default: true Is it a component/unincluded/optional item to display on contract. If false this item should generally not be shown to the consumer.
Status	string or null Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold" The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved". Reserved Out Off Rent Returned Sold
StockId	string or null This is likely to replace ItemId as the reference to which "Item" or "Inventory" this record is related to. (This field is still a work in progres from the API standpoint so we may end up going another direction. Use with caution.)
	Array of objects For Internal Use Only.
	object or null Additional fields for this LineItem.
	Array of objects All rates for this product or stock whether relevant or not. In most cases, you will want to use applicable rates.
CreatedDateTime	string or null <date-time> When was the record created? All date times are expected to be in UTC & ISO-8601 format.
UpdatedDateTime	string or null <date-time> When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.
Hidden	integer Enum: null 1 0 = false, 1 = true \| This basically means Deleted

LocationId

string or null

Default: "string"

Id of the Location. (see the Location endpoints)

Array of objects

Default: []

Any comments or notes.

Array

Type required	string Default: "Default" Enum: "Default" "Delivery" "Pickup" Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.
Value required	string or null The note text.

PONumber

string or null

Default: "string"

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: "string"

UTC When does the customer want the items?

Status

string

Default: "string"

Enum: "Quote" "Reservation" "Open" "Off Rent" "Returned" "Closed" "Voided" null

What is the current status of the contract?

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

Array of objects or null

Default: []

Lines which should appear in the totals section for the contract

Array

Label	string the full label which may have embedded within it a tax rate or partial tax rate etc. with separator e.g. 'Grand Prairie 8.25' or 'Damage Waiver' NOT 'Damage Waiver:'
Value	number the amount in the appropriate currency with no currency symbol and us-style decimal, e.g. 1030.59

Array of objects

Default: []

For Internal Use.

Array

Creatable	boolean or null Can the workflow be created?
TemplateId	string or null
PhotoPickerType	string Enum: "Default" "Image360" "None" null Options are None, Generic, 360
RequiredPhotos	number or null

object or null

Default: {}

Additional fields for Contract.

CurrencyCode	string or null (Syrinx Only) Country-specific currency code for the contract. For example: USD, AUD, EUR, etc.
CustomerJobNumber	string or null (Elite Only) Rental customer supplied identifier for this contract.
CustomerPurchaseOrder	string or null (Elite Only) Rental customer supplied purchase order for this contract.
OrderedBy	string or null (Elite Only) The name of the person who requested this contract.
ReceivedBy	string or null (Elite Only) The name of the person who received the items for this contract.

CreatedDateTime

string or null <date-time>

Default: "string"

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: "string"

UTC When was the contract updated?

Hidden

integer

Default: 0

Enum: null 1

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

ContractStatus

string

Deprecated

Default: "string"

Enum: "Quote" "Reservation" "Open" "Returned" "Closed" "Voided" null

Deprecated: Use Status field instead.

What is the current status of the contract?

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

IsDelivery

boolean

Default: false

True when the contract is marked for delivery.

IsPickup

boolean

Default: false

True when the contract is marked for customer pickup.

number or string

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

One of

number

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

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"AmountDue": 0,
"AmountPaid": 0,
"Contacts": [ ],
"ContractInformation": "string",
"CustomerId": "string",
"CustomerName": "string",
"CustomerPickup": { },
"DriverDelivery": { },
"DepotId": "string",
"DriverPickup": { },
"EndDateTime": "string",
"EsignState": "string",
"EsignUrl": "string",
"GrandTaxTotal": 0,
"GrandTotal": 0,
"LaborTracking": { },
"LineItems": [ ],
"LocationId": "string",
"Notes": [ ],
"PONumber": "string",
"StartDateTime": "string",
"Status": "string",
"Totals": [ ],
"Workflows": [ ],
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"ContractStatus": "string",
"IsDelivery": false,
"IsPickup": false
}

Retrieve files for a single Contract by Id.

Supported by: Elite

Authorizations:

API Key

path Parameters

ContractId required	string
tagKey required	string `pdfs` or `instructions` or `photos`

Responses

Response Schema: application/json

Array

FileName	string Default: "string" Original local filename.
FileClass	string Default: "string" Enum: "misc" "image" "video" Defines the type of stored file.
PublicURL	string Default: "string" Web URL where the stored file can be downloaded.
URLDateTime	string <date-time> Default: "string" The date/time the URL was retrieved/created.
URLExpires	integer Default: 0 Number of seconds from URLDateTime until URL expires.
TagMapKey	string Default: "string" Enum: "pdfs" "instructions" "photos" Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).
ObjectPrimaryKey	string Default: "string" Primary key of the object this file is associated with (same as in the URL for single object get).
ObjectType	string Default: "string" Type of object: One of Products, stock, or contract.
Tags	Array of strings Default: [] List of all the tag names associated with each file (ONLY the TagName).

Response samples

200

Content type

application/json

[{"FileName": "string",
"FileClass": "string",
"PublicURL": "string",
"URLDateTime": "string",
"URLExpires": 0,
"TagMapKey": "string",
"ObjectPrimaryKey": "string",
"ObjectType": "string",
"Tags": [ ]
}
]

Payment Boundaries

Authorizations:

API Key

path Parameters

ContractId

required

string

Responses

Response Schema: application/json

Array

Array of objects

Response samples

200
4XX

Content type

application/json

[{"PaymentCollectionBoundaries": [{"BoundaryTypeEnum": "RentalSaleCollectionBoundary",
"PaymentMethodEnum": "Credit Card",
"MaximumCollectionAmount": 0,
"MinimumCollectionAmount": 0,
"CollectAmountFee": [{"FeeCalculationEnum": "Fixed",
"Value": 0
}
],
"CollectAmountFeeTax": [{"FeeCalculationEnum": "Fixed",
"Value": 0
}
]
}
]
}
]

Customers

Supported by: Elite, Essentials, and Syrinx

The Customer endpoint will return information stored from each Customer record, including both business and individual consumers.

In Elite: When creating a new customer, the user will choose either Individual or Business in the dropdown field titled Record Type. This distinction is stored and returned in the customers.recordType field. Records can be intentionally saved as incomplete. For more information on Elite customer creation, visit this article.
In Essentials: A stored customer record could contain a personal name, company name, or both. The type may be inferred based on the fields returned; however, there is no programmatic distinction. To save a new record, either the first and last name or the company name must be filled out. For additional information on how to create a new customer record in Essentials, here is a detailed article. In Essentials, there is no distinction between company and individual in the customers.recordType field; instead, Individual is always the returned value.
In Syrinx: There are three types of customers: accounts, cash, and prospect. By default, account and prospect customer records are returned as business in the Customer.recordType field, while cash customer records are returned as Individuals. It's important to note that this default can be changed in the UI. To learn more about new account customers in Syrinx, read this article.

Retrieve a list of Customers

Supported by: Elite, Essentials, and Syrinx

Returns an array containing all Customers, with support for filtering as indicated below.

Authorizations:

APIKey

Responses

Results returned as shown below.

Response Schema: application/json

Array

ModelType

string

Value: "Customer"

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 upon Customer creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Customer No	CustomerFile.CNUM
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	No	N/A	CST_ID

Name

string or null

A Customer record will represent either a company or an individual. Due to this, this field will return either a company’s or individual’s name.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	CustomerFile.NAME
Essentials	Yes	Yes	Company Name or FirstName + LastName	N/A
Syrinx	Yes	Yes	Name	CUST_NAME

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

Array of objects

Customer or vendor mailing addresses. Not all address fields may be filled out depending on someone's location. Supported by Elite, Essentials, and Syrinx with details described below. Elite will often return both a Billing and Customer address. As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

BillingName

string or null

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Bill Contact	CustomerFile.BillContact
Essentials	Yes	Yes	First Name + Last Name	N/A
Syrinx	Yes	Yes	Name	CCT_FIRST_NAMES + CCT_SURNAME

Classification

string or null

Specifies the type of customer, such as Plumber, Homeowner, or Sole Trader. Might also include the Customer's Job Title. For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Type	CustomerType.Description
Essentials	Yes	Yes	Job Title	N/A
Syrinx	Yes	Yes	Company Type	CST_COMPANY_TYPE_ID

CompanyName

string or null

Name of the Company.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	Matches `Customers.Name`; CustomerFile.NAME
Essentials	Yes	Yes	Company	N/A
Syrinx	Yes	Yes	Name	CUST_NAME

Array of objects (GetAll-3)

If there are any Contact records associated with this Customer, then they will be returned here. Expand to see nested fields.

CreditLimit

integer or null

The highest outstanding balance (sum of all open, closed, etc.) that a non-elevated rental employee can create or modify a contract without override from a manager.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	Credit Limit	CustomerFile.CreditLimit	--
Essentials	Yes	Yes	Credit Limit	N/A	May be entered as a decimal in the UI, but returns results rounded to nearest dollar.
Syrinx	Yes	No	Customer Liability → Credit Limit	CST_CREDIT_LIMIT	--

CurrencyCode

string or null

'USD' is the default. Code is ISO 4217 format. This is part of the Company's configuration and not found in the Customer's UI. For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	ParameterFileCompany.DefaultCurrencyCode
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CUST_CURRENCY_ID

DoNotEmail

boolean or null

Prevents the software from sending 'marketing' emails.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	No Email or Don’t send marketing emails	CustomerFile.NoEmail
Essentials	Yes	Yes	Box unchecked after 'Customer has agreed to receive marketing info.'	N/A
Syrinx	Yes	No	--	CST_EXCLUDE_FROM_MARKETING

Array of objects

An array of emails associated with this record. As a reminder, arrays may return as empty, with one result, or multiple results. Expand to see nested fields.

FirstName

string or null

If the Customer represents an individual, this field returns the person's first name.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	First Name	CustomerFile.FirstName
Essentials	Yes	Yes	First Name	N/A
Syrinx	Yes	No	Name	CCT_FIRST_NAMES or part before split space of CST_NAME

LastName

string or null

If the Customer represents an individual, this field returns the person's last name.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Last Name	CustomerFile.LastName
Essentials	Yes	Yes	Last Name	N/A
Syrinx	Yes	No	Name	CST_SURNAME or part after the split space in CST_NAME

HeardAboutUs

string or null

Information about what led the customer to this company. For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Heard About Us	CustomerFile.HeardAboutUs
Essentials	Yes	Yes	Customer Source	N/A
Syrinx	Yes	Yes	How Heard?	CST_MKT_HOW_HEARD_OF_US

Locale

string or null

For Elite and Essentials, this defaults to 'en-US'. For Syrinx, this defaults to 'en-GB'. Code is ISO 639 format. For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	TranslationNames.LanguageCode
Essentials	Yes	Yes	Storefront user’s chosen (or default) language	N/A
Syrinx	Yes, always `en-GB`	--	--	--

Nontaxable

boolean or null

TRUE means that no tax is calculated for this customer on any contracts.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CustomerFile.Nontaxable
Essentials	Yes	Yes	Tax Free?	N/A
Syrinx	No, always `false`	--	--	--

PaymentTerms

string or null

Configurable text field that typically holds information such as the invoice due date or bank account details.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No, always `null`	--	--	--
Syrinx	Yes	No	Payment Terms	CST_INVOICE_FOOTER_ID

Array of objects

An array of phone number associated with the Contact. May return an empty array, an array with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

RecordType

string

Enum: "Business" "Individual"

Denotes if this record is a business or an individual

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Customer Record Type	CustomerFile.EntityType
Essentials	Yes, always `Individual`	No	N/A	N/A
Syrinx	Yes	Yes	N/A	By default, 'Cash' customers return 'Individual' and everything else returns 'Business'

object or null (GetById-4)

Data related to the SalesPerson record associated with the Customer. Only supported by Elite and Essentials. Expand to see nested fields.

Status

string

Enum: "Lead" "Prospect" "Cash" "Account"

For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Status	CustomerStatus.Description
Essentials	Yes	Yes	Derived from if CreditLimit > 0, then this returns 'Account' otherwise 'Cash'	N/A
Syrinx	Yes	No	N/A	CST_CTYPE

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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CustomerFile.ExternalReceivableBalance
Essentials	No	--	--	--
Syrinx	No	--	--	--

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

number or string

A monotomic that can be used to detect changes. Each time a record is added or altered, its Revision value is guaranteed to be greater than all earlier revisions to all other Customers.

CreatedDateTime

string or null

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CustomerFile.OpenDate
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CST_DATE_CREATED

UpdatedDateTime

string or null

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CustomerFile.DateChanged
Essentials	Yes	Yes	N/A	N/A
Syrinx	No	--	--	--

Hidden

integer

Enum: 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	No	N/A	N/A
Syrinx	Yes	No	N/A	CST_CURRENT_FLAG

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "Customer",
"Id": "1995",
"Name": "Moe Nielson",
"Identifiers": {"CustomerKey": "1995",
"ExternalCustomerId": null,
"FederalId": "",
"InsuranceNumber": "",
"OtherId": "TAX EXEMPT",
"Tax Number": "",
"AccountNumber": ""
},
"Addresses": {"Type": "Customer",
"Line1": "42 Wallaby Way",
"Line2": "Suite 101",
"Line3": null,
"City": "Nowhere",
"Province": "TX",
"PostalCode": "10000",
"Latitude": null,
"Longitude": null,
"Country": null,
"GeoRegion2": null,
"GeoRegion3": null
},
"BillingName": "",
"Classification": "Target Customer",
"CompanyName": "Moe Nielson",
"Contacts": [{"Type": "Default",
"Contact": [{"ModelType": "Contact",
"Id": "2",
"Name": "Joe Bloggs",
"Identifiers": {"ParentId": "54321",
"DriversLicense": "11223344",
"EmployeeId": "22"
},
"Addresses": [ ],
"CompanyName": null,
"Emails": [{"Type": "Default",
"Email": "[email protected]"
}
],
"FirstName": null,
"LastName": null,
"Phones": [{"Type": "Default",
"CountryCode": null,
"Number": "5551231234",
"NumberE164": null,
"Extension": "",
"SmsCapable": false
}
],
"AdditionalFields": {"InactiveDateTime": null
},
"CreatedDateTime": null,
"UpdatedDateTime": "2022-01-01T17:35:10.457z",
"Hidden": 0,
"Department": "Implementation",
"Title": "Support Technician",
"Disabled": false
}
]
}
],
"CreditLimit": 5000,
"CurrencyCode": "USD",
"DoNotEmail": false,
"Emails": [{"Type": "Primary",
"Email": "[email protected]"
}
],
"ExternalReceivableBalance": 0,
"FirstName": null,
"HeardAboutUs": null,
"LastName": null,
"Locale": "en-US",
"Nontaxable": true,
"PaymentTerms": null,
"Phones": [{"Type": "Default",
"CountryCode": "1",
"Number": "5554443333",
"NumberE164": "+15554443333",
"Extension": null,
"SmsCapable": false
}
],
"RecordType": "Business",
"SalesPerson": {"ModelType": "SalesPerson",
"Id": "30",
"Name": "Wayne Harris",
"Email": {"Type": "Primary",
"Email": "[email protected]"
}
},
"Status": "Account",
"AdditionalFields": {"CustomerWebPortal": false,
"ForceContractInfo": false,
"ForceJobId": false,
"ForcePickedUp": false,
"ForcePurchaseOrder": false,
"InvoiceSendBy": "Printer",
"StatementSendBy": "Printer",
"Terms": "",
"UserDefined1": "",
"UserDefined2": "",
"Restrictions": "None",
"ExternalTaxCode": null,
"ExternalTaxClass": null
},
"CreatedDateTime": null,
"UpdatedDateTime": "2024-07-30T18:18:18Z",
"Hidden": 0
}

Create a new Customer

Supported by: Elite

Required fields:

If RecordType is "Business", then:
- FirstName
- LastName
Otherwise:
- Name

Authorizations:

API Key

Request Body schema: application/json
required

Name

string or null [ 1 .. 50 ] characters

Default: "string"

Can be a company or individual name.

object or null

Default: {}

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

Supported List

All

TaxNumber

Elite Only

CustomerKey
DriversLicense
FederalId
InsuranceNumber
OtherId

Syrinx Only

AccountNumber
RegistrationNumber
VatNumber

Not all properties are valid across all products.

CustomerKey	string or null (Elite Only) Unique user defined customer identifier. If no value is provided, this will be set to the same value as Id.
DriversLicense	string or null (Elite Only) Drivers license for individual type customers.
ExternalCustomerId	string or null (Elite Only) The value from a 3rd party system that identifies the Customer record
FederalId	string or null (Elite Only) FederalId of Customer.
InsuranceNumber	string or null (Elite Only) Insurance Number of Customer.
OtherId	string or null (Elite Only) Addtional Id's of Customer.
TaxNumber	string or null (Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite.

Array of objects

Default: []

Supported types will depend on the product.

Elite:

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

Array

Type required	string Default: "Default" Enum: "Customer" "Billing" Examples include "Default", "Billing", etc. Supported types depend on the context of the address.
Line1	string or null <= 150 characters Address Number and Street.
Line2	string or null <= 150 characters May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null >= 2 characters Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148.
PostalCode	string or null <= 50 characters May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

BillingName

string or null <= 50 characters

Default: "string"

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

Classification

string or null

Default: "string"

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

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

Array of objects

Default: []

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

Elite: Supported.
Syrinx: Supported.

Array

Type required	string Default: "Default" Value: "Default"
required	object

CreditLimit

integer or null <= 2147483647

Default: 0

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

CurrencyCode

string or null

Default: "USD"

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

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

DoNotEmail

boolean or null

Default: false

Prevents the software from sending 'marketing' emails.

Array of objects

Default: []

Array

Type required	string Value: "Primary" Supported types.
Email required	string <= 50 characters A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName

string or null [ 1 .. 50 ] characters

Default: "string"

First Name of Customer (individual only).

HeardAboutUs

string or null

Default: "string"

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

LastName

string or null [ 1 .. 50 ] characters

Default: "string"

Last Name of Customer (individual only).

Locale

string or null

Default: "en-US"

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

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

Nontaxable

boolean or null

Default: false

Means no tax is calculated for this customer on any contracts

Array of objects

Default: []

Array

Type required	string Default: "Default" Supported phone types. "Default" is the default phone number for the contact. Elite uses "Mobile" as a secondary number whereas Essentials uses "Secondary".
Number required	string or null <= 50 characters A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported

RecordType

string

Default: "Business"

Enum: "Business" "Individual"

Denotes if this record is a business or an individual.

object or null

Default: {}

Data related to the sales person associated with the Customer.

Id	string Default: "0" The unique Id for this Salesperson record. This is a system generated ID that can be included to reference a Salesperson in a customer record.

Status

string

Default: "Lead"

Enum: "Lead" "Prospect" "Cash" "Account"

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

ExternalReceivableBalance

number

Default: 0

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

object or null

Default: {}

Additional fields for Customer.

CustomerWebPortal	boolean or null (Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature.
ExternalTaxClass	string or null (Elite Only) A user definable field for an External Tax Service.
ExternalTaxCode	string or null (Elite Only) A user definable field for an External Tax Service.
ForceContractInfo	boolean or null (Elite Only) Requires the employee to collect a text value to identify the contract's purpose.
ForceJobId	boolean or null (Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs.
ForcePickedUp	boolean or null (Elite Only) Requires the employee to collect the name of the person picking up the items.
ForcePurchaseOrder	boolean or null (Elite Only) Flag to force purchase orders.
InvoiceSendBy	string Enum: "Email" "Fax" "No Statement" "Printer" null (Elite Only) Determines how a customer will receive contracts.
Restrictions	string or null What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions
StatementSendBy	string Enum: "Email" "Fax" "No Statement" "Printer" null (Elite Only) Determines how a customer will receive statements.
Terms	string or null <= 50 characters (Elite Only) Terms for the customer.
UserDefined1	string or null <= 50 characters Placeholder field.
UserDefined2	string or null <= 50 characters Placeholder field.

Responses

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"BillingName": "string",
"Classification": "string",
"CompanyName": "string",
"Contacts": [ ],
"CreditLimit": 0,
"CurrencyCode": "string",
"DoNotEmail": false,
"Emails": [ ],
"FirstName": "string",
"HeardAboutUs": "string",
"LastName": "string",
"Locale": "string",
"Nontaxable": false,
"PaymentTerms": "string",
"Phones": [ ],
"RecordType": "string",
"SalesPerson": { },
"Status": "string",
"ExternalReceivableBalance": 0,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Response samples

201

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"BillingName": "string",
"Classification": "string",
"CompanyName": "string",
"Contacts": [ ],
"CreditLimit": 0,
"CurrencyCode": "string",
"DoNotEmail": false,
"Emails": [ ],
"FirstName": "string",
"HeardAboutUs": "string",
"LastName": "string",
"Locale": "string",
"Nontaxable": false,
"PaymentTerms": "string",
"Phones": [ ],
"RecordType": "string",
"SalesPerson": { },
"Status": "string",
"ExternalReceivableBalance": 0,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Retrieve a single Customer by id

Supported by: Elite, Essentials, and Syrinx

Retrieves a single Customer specified by its ID.

Authorizations:

APIKey

path Parameters

CustomerId

required

string

Example: 42

Provide the unique ID of the Customer you want to retrieve.

Responses

Results returned as shown below.

Response Schema: application/json

ModelType

string

Value: "Customer"

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 upon Customer creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Customer No	CustomerFile.CNUM
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	No	N/A	CST_ID

Name

string or null

A Customer record will represent either a company or an individual. Due to this, this field will return either a company’s or individual’s name.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	CustomerFile.NAME
Essentials	Yes	Yes	Company Name or FirstName + LastName	N/A
Syrinx	Yes	Yes	Name	CUST_NAME

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

AccountNumber

string or null

Identifies the Customer's account.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	Key	CustomerFile.KEY	N/A
Essentials	Yes	No	N/A	N/A	Returns same as `Customer.Id`
Syrinx	Yes	Yes	Account No	CST_ACCOUNT_NUMBER	N/A

CustomerKey

string

In Elite, this field always returns the same value as Identifiers.AccountNumber.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Key	CustomerFile.KEY
Essentials	No	--	--	--
Syrinx	No	--	--	--

DriversLicense

string or null

The driver's license number is intended for Individual Customer records, but may also be found on Company records.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	DL Number or dl no	CustomerFile.DriversLicense
Essentials	Yes	No	Drivers License Number	N/A
Syrinx	No	--	--	--

ExternalCustomerId

string or null

Value from a third-party system that identifies the Customer.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	API Link	CustomerFile.APILink
Essentials	No	--	--	--
Syrinx	No	--	--	--

FederalId

string

Federal Id of the Customer.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Federal Id	CustomerFile.FederalId
Essentials	No	--	--	--
Syrinx	No	--	--	--

InsuranceNumber

string or null

Insurance Number of Customer.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Insurance Number	CustomerFile.InsuranceNumber
Essentials	No	--	--	--
Syrinx	No	--	--	--

OtherId

string or null

Additional Id for Customer.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Other Id	CustomerFile.OTHERID
Essentials	No	--	--	--
Syrinx	No	--	--	--

RegistrationNumber

string or null

Registration Number of Customer.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	Yes	Reg No	CST_COMPANY_REG_NO

TaxNumber

string or null

Tax Number of Customer. In Elite, this was formerly called Tax Exempt Number.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Tax Exempt Number	CustomerFile.TaxExemptNumber
Essentials	Yes	No	National Id	N/A
Syrinx	No	--	--	--

VatNumber

string or null

VAT Number for the Customer.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	Yes	VAT No	CST_VAT_NUMBER

Array of objects

Customer or vendor mailing addresses. Not all address fields may be filled out depending on someone's location. Supported by Elite, Essentials, and Syrinx with details described below. Elite will often return both a Billing and Customer address. As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

Array

Type

string

Enum: "Billing" "Customer" "Default"

A general label that could be used to help define the type of address being returned.

Software	Supported	Filterable	Additional Info
Elite	Yes	No	Supports `Customer` and `Billing`
Essentials	Yes	No	Supports `Customer`
Syrinx	Yes	No	Supports `Default`

Name

string or null

Optional freeform field used to name the address.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	Name	ADR_NAME

Line1

string or null

First line of the address field. Typically, this contains address number and street.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	Address	CustomerFile.Address
Essentials	Yes	Yes	Address	N/A
Syrinx	Yes	No	Address	ADR_LINE1

Line2

string or null

Second line of the address field. Often includes apartment, building, or suite number if applicable.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	Address	CustomerFile.Address2
Essentials	Yes	No	Address	N/A
Syrinx	Yes	No	Address	ADR_LINE2

Line3

string or null

Third line of the address field. Additional information if needed.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	Address	ADR_LINE3

City

string or null

City or Town for this address.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	City, ST	CustomerFile.CITY
Essentials	Yes	Yes	City	N/A
Syrinx	Yes	No	Town	ADR_TOWN

GeoRegion2

string or null

Municipality or County for this address.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	No	Municipality	N/A
Syrinx	Yes	No	County	ADR_COUNTY

GeoRegion3

string or null

In Essentials, this represents the 'Town' if this field is turned on. By default, this field is not present on the UI.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	No	Town	N/A
Syrinx	No, always `null`	--	--	--

Province

string or null

This is the geographical State for this Address.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	City, ST	CustomerFile.City
Essentials	Yes	No	Town	N/A
Syrinx	No, always `null`	--	--	--

PostalCode

string or null

May be postal code, postcode, PIN, ZIP Code, etc. depending on the country.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	Zip	CustomerFile.ZIP
Essentials	Yes	Yes	Postal Code	N/A
Syrinx	Yes	No	Postcode	ADR_POSTCODE

Latitude

string or null

Latitude coordinate in (DD) Decimal Degree format. When the address is entered, the latitude can include up to 9 decimals places based on the 30 character length of the delivery address field in transactions. - LOC:LAT, LON - Loc: XX.123456789, -YY.123456789

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	Latitude	ADR_LATITUDE

Longitude

string or null

Longitude coordinate in (DD) Degree Decimal format. When the address is entered, the longitude cna include up to 9 decimals places based on the 30 character length of the delivery address field in transactions. - LOC:LAT, LON - Loc: XX.123456789, -YY.123456789

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	Longitude	ADR_LONGITUDE

Country

string or null

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

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	No	Country	N/A
Syrinx	No, matches `Addresses.GeoRegion2`	--	--	--

BillingName

string or null

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Bill Contact	CustomerFile.BillContact
Essentials	Yes	Yes	First Name + Last Name	N/A
Syrinx	Yes	Yes	Name	CCT_FIRST_NAMES + CCT_SURNAME

Classification

string or null

Specifies the type of customer, such as Plumber, Homeowner, or Sole Trader. Might also include the Customer's Job Title. For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Type	CustomerType.Description
Essentials	Yes	Yes	Job Title	N/A
Syrinx	Yes	Yes	Company Type	CST_COMPANY_TYPE_ID

CompanyName

string or null

Name of the Company.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	Matches `Customers.Name`; CustomerFile.NAME
Essentials	Yes	Yes	Company	N/A
Syrinx	Yes	Yes	Name	CUST_NAME

Array of objects (GetAll-3)

If there are any Contact records associated with this Customer, then they will be returned here. Expand to see nested fields.

Array

ModelType

string

Enum: "Contact" "CustomerContact" "VendorContact"

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

Software	Supported	Additional Info
Elite	Yes	Supports `Contact`
Essentials	Yes	Supports `CustomerContact`
Syrinx	Yes	Supports `CustomerContact` and `VendorContact`

Id

string

The unique Id for this record. This is system-generated upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	Authorized.Number
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CCT_ID

Name

string or null

The display name for this Contact record.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	Authorized.Name
Essentials	Yes	Yes	'First Name' + 'Last Name'	N/A
Syrinx	Yes	Yes	Name	CCT_FIRST_NAME + CCT_LAST_NAME

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint. Expand to see nested fields.

Array of objects

Only supported by Essentials and Syrinx with details described below.

An array of addresses associated with the Contact. These could include customer, company, or vendor addresses. Not all address fields may be filled out depending on someone's location.

As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

CompanyName

string or null

In Essentials, if this Contact represents a company, the company's name is returned in this field. In Syrinx, this field returns the name of the customer or supplier.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Company	N/A
Syrinx	Yes	Yes	Customer or Supplier	CST_NAME or SUP_NAME

Department

string or null

A freeform field that is intended to return a department associated with the Contact. Ex: Sales, Events, etc.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Department	Authorized.Department
Essentials	No, always `null`	--	--	--
Syrinx	No	--	--	--

Disabled

boolean or null

This is the state of the Contact record. TRUE means the Contact is temporarily deactivated. FALSE means the Contact is active. By default, this state is FALSE.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Inactive Date	Authorized.InactiveDate
Essentials	No	--	--	--
Syrinx	No	--	--	--

Array of objects or null

An array of emails associated with this record. As a reminder, arrays may return as empty, with one result, or multiple results. Expand to see nested fields.

FirstName

string or null

If the Contact represents an individual, this field returns the person's first name.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	First Name	N/A
Syrinx	No	--	--	--

LastName

string or null

If the Contact represents an individual, this field returns the person's last name.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	Yes	Last Name	N/A
Syrinx	No	--	--	--

Array of objects or null

An array of phone number associated with this record. As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

Title

string or null

The Contact's job title.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Title	Authorized.Title
Essentials	Yes	Yes	Job Title	N/A
Syrinx	No	--	--	--

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	N/A	Authorized.DateCreated	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	Yes	No	N/A	CCT_DATE_ADDED	--

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	N/A	Authorized.DateChanged	--
Essentials	Yes	Yes	N/A	N/A	Returns UTC time offset from store time.
Syrinx	No, always `null`	--	--	--	--

Hidden

integer or null

Enum: 0 1 null

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database	AdditionalInfo
Elite	Yes	N/A	N/A	N/A	If `AdditionalFields.InactiveDateTime` is set, this field will return `1`; otherwise, it will return `0`.
Essentials	Yes	N/A	N/A	N/A	N/A
Syrinx	Yes	N/A	N/A	N/A	Always returns `0`

CreditLimit

integer or null

The highest outstanding balance (sum of all open, closed, etc.) that a non-elevated rental employee can create or modify a contract without override from a manager.

Software	Supported	Filterable	UI	Database	Additional Info
Elite	Yes	Yes	Credit Limit	CustomerFile.CreditLimit	--
Essentials	Yes	Yes	Credit Limit	N/A	May be entered as a decimal in the UI, but returns results rounded to nearest dollar.
Syrinx	Yes	No	Customer Liability → Credit Limit	CST_CREDIT_LIMIT	--

CurrencyCode

string or null

'USD' is the default. Code is ISO 4217 format. This is part of the Company's configuration and not found in the Customer's UI. For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	ParameterFileCompany.DefaultCurrencyCode
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CUST_CURRENCY_ID

DoNotEmail

boolean or null

Prevents the software from sending 'marketing' emails.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	No Email or Don’t send marketing emails	CustomerFile.NoEmail
Essentials	Yes	Yes	Box unchecked after 'Customer has agreed to receive marketing info.'	N/A
Syrinx	Yes	No	--	CST_EXCLUDE_FROM_MARKETING

Array of objects

An array of emails associated with this record. As a reminder, arrays may return as empty, with one result, or multiple results. Expand to see nested fields.

Array

Type

string

Value: "Primary"

A general label to help define the type of email being returned. Might provide context about the type of email address provided.

Software	Supported
Elite	Yes
Essentials	Yes
Syrinx	Yes

Email

string or null

Email associated with this contact.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	Email	CustomerFile.Email
Essentials	Yes	Yes	Email	N/A
Syrinx	Yes	Yes	Email	CST_EMAIL_ID

FirstName

string or null

If the Customer represents an individual, this field returns the person's first name.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	First Name	CustomerFile.FirstName
Essentials	Yes	Yes	First Name	N/A
Syrinx	Yes	No	Name	CCT_FIRST_NAMES or part before split space of CST_NAME

LastName

string or null

If the Customer represents an individual, this field returns the person's last name.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Last Name	CustomerFile.LastName
Essentials	Yes	Yes	Last Name	N/A
Syrinx	Yes	No	Name	CST_SURNAME or part after the split space in CST_NAME

HeardAboutUs

string or null

Information about what led the customer to this company. For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Heard About Us	CustomerFile.HeardAboutUs
Essentials	Yes	Yes	Customer Source	N/A
Syrinx	Yes	Yes	How Heard?	CST_MKT_HOW_HEARD_OF_US

Locale

string or null

For Elite and Essentials, this defaults to 'en-US'. For Syrinx, this defaults to 'en-GB'. Code is ISO 639 format. For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	TranslationNames.LanguageCode
Essentials	Yes	Yes	Storefront user’s chosen (or default) language	N/A
Syrinx	Yes, always `en-GB`	--	--	--

Nontaxable

boolean or null

TRUE means that no tax is calculated for this customer on any contracts.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CustomerFile.Nontaxable
Essentials	Yes	Yes	Tax Free?	N/A
Syrinx	No, always `false`	--	--	--

PaymentTerms

string or null

Configurable text field that typically holds information such as the invoice due date or bank account details.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No, always `null`	--	--	--
Syrinx	Yes	No	Payment Terms	CST_INVOICE_FOOTER_ID

Array of objects

An array of phone number associated with the Contact. May return an empty array, an array with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

Array

Type

string

Enum: "Default" "Primary" "Secondary"

Phone type often defined by where the number was entered into the UI of the Contact form. Only applies if the software supports more than one phone number.

RemoteId

string or null

Deprecated

This field is deprecated and will completely lose support in the future. A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

CountryCode

string or null

Country code prefix to phone number. List of country code prefixes found here.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	N/A	CustomerFile.CallingCode
Essentials	Yes	No	Part of Primary Phone Number	N/A
Syrinx	Yes	No	--	Regex to determine country code, otherwise null

Number

string or null

A phone number associated with the Customer.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	Phone or Mobile	CustomerFile.Phone or CustomerFile.MOBILE
Essentials	Yes	Yes	Part of Primary Phone Number	N/A
Syrinx	Yes	No	Phone	ADR_TELEPHONE

NumberE164

string or null

A supplied phone number will return here if it has been validated according to the E.164 format.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	--	--
Essentials	Yes	No	Primary Phone Number	N/A
Syrinx	Yes	No	Phone	ADR_TELEPHONE

Extension

string or null

Extension associated with the provided number.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	N/A	N/A
Essentials	No, always ''	--	N/A	N/A
Syrinx	No, always `null`	--	N/A	N/A

SmsCapable

boolean or null

Answers whether the phone can be sent SMS messages based on the field phones.type.

Software	Supported
Elite	Yes, `true` for `mobile` and `false` for `default`
Essentials	No, always 'false'
Syrinx	No, always `false`

RecordType

string

Enum: "Business" "Individual"

Denotes if this record is a business or an individual

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Customer Record Type	CustomerFile.EntityType
Essentials	Yes, always `Individual`	No	N/A	N/A
Syrinx	Yes	Yes	N/A	By default, 'Cash' customers return 'Individual' and everything else returns 'Business'

object or null (GetById-4)

Data related to the SalesPerson record associated with the Customer. Only supported by Elite and Essentials. Expand to see nested fields.

ModelType

string

Value: "SalesPerson"

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 upon creation and not updatable.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Number	Salesman.Number
Essentials	Yes	Yes	N/A	N/A

Name

string or null

The display name for this Salesperson record.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Name	Salesman.Name
Essentials	Yes	Yes	Generated from ‘First Name’ and ‘Last Name’ in UI.	N/A

object

An email associated with this record. Expand to see nested fields.

FirstName

string or null

First name of the Salesperson.

Software	Supported	Filterable	UI	DB
Elite	No	–	–-	–-
Essentials	Yes	Yes	First Name	N/A

LastName

string or null

Last name of the Salesperson.

Software	Supported	Filterable	UI	DB
Elite	No	–	–-	–-
Essentials	Yes	Yes	Last Name	N/A

Status

string

Enum: "Lead" "Prospect" "Cash" "Account"

For Elite, 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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Status	CustomerStatus.Description
Essentials	Yes	Yes	Derived from if CreditLimit > 0, then this returns 'Account' otherwise 'Cash'	N/A
Syrinx	Yes	No	N/A	CST_CTYPE

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.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CustomerFile.ExternalReceivableBalance
Essentials	No	--	--	--
Syrinx	No	--	--	--

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CustomerWebPortal

boolean or null

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Website Portal or Customer web portal	CustomerFile.WebsitePortal

ExternalTaxClass

string or null

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	External Sales Tax Class	CustomerFile.SalesTaxClass

ExternalTaxCode

string or null

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	External Sales Tax Code	CustomerFile.SalesTaxCode

ForceContractInfo

boolean or null

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Force Info or Contract Information	CustomerFile.ForceInfo

ForceJobId

boolean or null

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Force Job Id or Job Identification	CustomerFile.ForceJobId

ForcePickedUp

boolean or null

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Force Picked Up	CustomerFile.ForcePickedUp

ForcePurchaseOrder

boolean or null

(Elite Only) Flag to force purchase orders.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Force PO or Purchase Order Number	CustomerFile.ForcePO

InvoiceSendBy

string or null

Enum: "Email" "Fax" "No Statement" "Printer" "None"

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Invoice Send By	PrintSendOption.Description

Restrictions

string or null

Describes what customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions for possible values.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Restrictions	CustomerRestriction.Description

StatementSendBy

string or null

Enum: "Email" "Fax" "No Statement" "Printer" "None"

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Statement Print To or Statement Send By	PrintSendOption.Description

Terms

string or null

(Elite Only) Terms for the customer.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Terms	CustomerFile.Terms

UserDefined1

string or null

(Elite Only) This field can hold arbitrary, free-form data about a Customer.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	User Defined 1	CustomerFile.UserDefined1

UserDefined2

string or null

(Elite Only) This field can hold arbitrary, free-form data about a Customer.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	User Defined 2	CustomerFile.UserDefined2

InsuranceExpirationDate

string or null <date-time>

The date the customer's insurance expires.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes

number or string

A monotomic that can be used to detect changes. Each time a record is added or altered, its Revision value is guaranteed to be greater than all earlier revisions to all other Customers.

One of

number

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	--	--
Essentials	No	--	--	--
Syrinx	No	--	--	--

CreatedDateTime

string or null

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CustomerFile.OpenDate
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	Yes	N/A	CST_DATE_CREATED

UpdatedDateTime

string or null

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CustomerFile.DateChanged
Essentials	Yes	Yes	N/A	N/A
Syrinx	No	--	--	--

Hidden

integer

Enum: 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	No	N/A	N/A
Syrinx	Yes	No	N/A	CST_CURRENT_FLAG

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "Customer",
"Id": "1995",
"Name": "Moe Nielson",
"Identifiers": {"CustomerKey": "1995",
"ExternalCustomerId": null,
"FederalId": "",
"InsuranceNumber": "",
"OtherId": "TAX EXEMPT",
"Tax Number": "",
"AccountNumber": ""
},
"Addresses": {"Type": "Customer",
"Line1": "42 Wallaby Way",
"Line2": "Suite 101",
"Line3": null,
"City": "Nowhere",
"Province": "TX",
"PostalCode": "10000",
"Latitude": null,
"Longitude": null,
"Country": null,
"GeoRegion2": null,
"GeoRegion3": null
},
"BillingName": "",
"Classification": "Target Customer",
"CompanyName": "Moe Nielson",
"Contacts": [{"Type": "Default",
"Contact": [{"ModelType": "Contact",
"Id": "2",
"Name": "Joe Bloggs",
"Identifiers": {"ParentId": "54321",
"DriversLicense": "11223344",
"EmployeeId": "22"
},
"Addresses": [ ],
"CompanyName": null,
"Emails": [{"Type": "Default",
"Email": "[email protected]"
}
],
"FirstName": null,
"LastName": null,
"Phones": [{"Type": "Default",
"CountryCode": null,
"Number": "5551231234",
"NumberE164": null,
"Extension": "",
"SmsCapable": false
}
],
"AdditionalFields": {"InactiveDateTime": null
},
"CreatedDateTime": null,
"UpdatedDateTime": "2022-01-01T17:35:10.457z",
"Hidden": 0,
"Department": "Implementation",
"Title": "Support Technician",
"Disabled": false
}
]
}
],
"CreditLimit": 5000,
"CurrencyCode": "USD",
"DoNotEmail": false,
"Emails": [{"Type": "Primary",
"Email": "[email protected]"
}
],
"ExternalReceivableBalance": 0,
"FirstName": null,
"HeardAboutUs": null,
"LastName": null,
"Locale": "en-US",
"Nontaxable": true,
"PaymentTerms": null,
"Phones": [{"Type": "Default",
"CountryCode": "1",
"Number": "5554443333",
"NumberE164": "+15554443333",
"Extension": null,
"SmsCapable": false
}
],
"RecordType": "Business",
"SalesPerson": {"ModelType": "SalesPerson",
"Id": "30",
"Name": "Wayne Harris",
"Email": {"Type": "Primary",
"Email": "[email protected]"
}
},
"Status": "Account",
"AdditionalFields": {"CustomerWebPortal": false,
"ForceContractInfo": false,
"ForceJobId": false,
"ForcePickedUp": false,
"ForcePurchaseOrder": false,
"InvoiceSendBy": "Printer",
"StatementSendBy": "Printer",
"Terms": "",
"UserDefined1": "",
"UserDefined2": "",
"Restrictions": "None",
"ExternalTaxCode": null,
"ExternalTaxClass": null
},
"CreatedDateTime": null,
"UpdatedDateTime": "2024-07-30T18:18:18Z",
"Hidden": 0
}

Update a single Customer by Id

Supported by: Elite

Required fields:

Id

Authorizations:

API Key

path Parameters

CustomerId

required

string

Request Body schema: application/json
required

Name

string or null [ 1 .. 50 ] characters

Default: "string"

Can be a company or individual name.

object or null

Default: {}

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

Supported List

All

TaxNumber

Elite Only

CustomerKey
DriversLicense
FederalId
InsuranceNumber
OtherId

Syrinx Only

AccountNumber
RegistrationNumber
VatNumber

Not all properties are valid across all products.

CustomerKey	string or null (Elite Only) Unique user defined customer identifier. If no value is provided, this will be set to the same value as Id.
DriversLicense	string or null (Elite Only) Drivers license for individual type customers.
ExternalCustomerId	string or null (Elite Only) The value from a 3rd party system that identifies the Customer record
FederalId	string or null (Elite Only) FederalId of Customer.
InsuranceNumber	string or null (Elite Only) Insurance Number of Customer.
OtherId	string or null (Elite Only) Addtional Id's of Customer.
TaxNumber	string or null (Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite.

Array of objects

Default: []

Supported types will depend on the product.

Elite:

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

Array

Type required	string Default: "Default" Enum: "Customer" "Billing" Examples include "Default", "Billing", etc. Supported types depend on the context of the address.
Line1	string or null <= 150 characters Address Number and Street.
Line2	string or null <= 150 characters May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null >= 2 characters Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148.
PostalCode	string or null <= 50 characters May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

BillingName

string or null <= 50 characters

Default: "string"

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

Classification

string or null

Default: "string"

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

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

Array of objects

Default: []

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

Elite: Supported.
Syrinx: Supported.

Array

Type required	string Default: "Default" Value: "Default"
required	object

CreditLimit

integer or null <= 2147483647

Default: 0

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

CurrencyCode

string or null

Default: "USD"

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

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

DoNotEmail

boolean or null

Default: false

Prevents the software from sending 'marketing' emails.

Array of objects

Default: []

Array

Type required	string Value: "Primary" Supported types.
Email required	string <= 50 characters A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName

string or null [ 1 .. 50 ] characters

Default: "string"

First Name of Customer (individual only).

HeardAboutUs

string or null

Default: "string"

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

LastName

string or null [ 1 .. 50 ] characters

Default: "string"

Last Name of Customer (individual only).

Locale

string or null

Default: "en-US"

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

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

Nontaxable

boolean or null

Default: false

Means no tax is calculated for this customer on any contracts

Array of objects

Default: []

Array

Type required	string Default: "Default" Supported phone types. "Default" is the default phone number for the contact. Elite uses "Mobile" as a secondary number whereas Essentials uses "Secondary".
Number required	string or null <= 50 characters A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported

RecordType

string

Default: "Business"

Enum: "Business" "Individual"

Denotes if this record is a business or an individual.

object or null

Default: {}

Data related to the sales person associated with the Customer.

Id	string Default: "0" The unique Id for this Salesperson record. This is a system generated ID that can be included to reference a Salesperson in a customer record.

Status

string

Default: "Lead"

Enum: "Lead" "Prospect" "Cash" "Account"

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

ExternalReceivableBalance

number

Default: 0

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

object or null

Default: {}

Additional fields for Customer.

CustomerWebPortal	boolean or null (Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature.
ExternalTaxClass	string or null (Elite Only) A user definable field for an External Tax Service.
ExternalTaxCode	string or null (Elite Only) A user definable field for an External Tax Service.
ForceContractInfo	boolean or null (Elite Only) Requires the employee to collect a text value to identify the contract's purpose.
ForceJobId	boolean or null (Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs.
ForcePickedUp	boolean or null (Elite Only) Requires the employee to collect the name of the person picking up the items.
ForcePurchaseOrder	boolean or null (Elite Only) Flag to force purchase orders.
InvoiceSendBy	string Enum: "Email" "Fax" "No Statement" "Printer" null (Elite Only) Determines how a customer will receive contracts.
Restrictions	string or null What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions
StatementSendBy	string Enum: "Email" "Fax" "No Statement" "Printer" null (Elite Only) Determines how a customer will receive statements.
Terms	string or null <= 50 characters (Elite Only) Terms for the customer.
UserDefined1	string or null <= 50 characters Placeholder field.
UserDefined2	string or null <= 50 characters Placeholder field.

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Customer"

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

Id

string

Default: "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

Default: "string"

Can be a company or individual name.

object or null

Default: {}

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

Supported List

All

TaxNumber

Elite Only

CustomerKey
DriversLicense
FederalId
InsuranceNumber
OtherId

Syrinx Only

AccountNumber
RegistrationNumber
VatNumber

Not all properties are valid across all products.

AccountNumber	string or null (Syrinx Only) Unique user defined customer identifier.
CustomerKey	string or null (Elite Only) Unique user defined customer identifier. If no value is provided, this will be set to the same value as Id.
DriversLicense	string or null (Elite Only) Drivers license for individual type customers.
ExternalCustomerId	string or null (Elite Only) The value from a 3rd party system that identifies the Customer record
FederalId	string or null (Elite Only) FederalId of Customer.
InsuranceNumber	string or null (Elite Only) Insurance Number of Customer.
OtherId	string or null (Elite Only) Addtional Id's of Customer.
RegistrationNumber	string or null (Syrinx Only) Registration Number of Customer.
TaxNumber	string or null (Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite.
VatNumber	string or null (Syrinx Only) Vat Number of Customer.

Array of objects

Default: []

Supported types will depend on the product.

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

Array

Type required	string Default: "Default" Enum: "Customer" "Billing" Examples include "Customer", "Billing", etc. Supported types depend on the context of the address.
Name	string or null Optional name for Address Elite: Not supported.
Line1	string or null Address Number and Street.
Line2	string or null May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148.
PostalCode	string or null May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

BillingName

string or null

Default: "string"

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

Classification

string or null

Default: "string"

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

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

CompanyName

string or null

Default: "string"

Name of the Company.

Array of objects

Default: []

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

Elite: Supported.
Syrinx: Supported.

Array

Type required	string Default: "Default" Value: "Default"
required	object

CreditLimit

integer or null

Default: 0

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

CurrencyCode

string or null

Default: "USD"

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

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

DoNotEmail

boolean or null

Default: false

Prevents the software from sending 'marketing' emails.

Array of objects

Default: []

Array

Type required	string Value: "Primary" Supported types.
Email required	string or null <= 50 characters A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

FirstName

string or null

Default: "string"

First Name of Customer (individual only).

HeardAboutUs

string or null

Default: "string"

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

LastName

string or null

Default: "string"

Last Name of Customer (individual only).

Locale

string or null

Default: "en-US"

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

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

Nontaxable

boolean or null

Default: false

Means no tax is calculated for this customer on any contracts

PaymentTerms

string or null

Default: "string"

(Currently not supported)

Array of objects

Default: []

Array

Type required	string Default: "Default" Supported phone types.
Number required	string or null <= 50 characters A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported
NumberE164	string or null A phone number must be supplied and validated according to the E.164 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
Extension	string or null Is there an extension associated with this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
SmsCapable	boolean or null Can an SMS be sent to this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

RecordType

string

Default: "Business"

Enum: "Business" "Individual"

Denotes if this record is a business or an individual.

object or null

Default: {}

Data related to the sales person associated with the Customer.

ModelType	string Value: "SalesPerson" Standard field that denotes the record type. Useful for bulk ingesting different record types.
Id	string Default: "0" The unique Id for this record. This is system generated on POST and not updatable, but can be included in a Patch for updating bulk records.
Name	string or null A display name for this record. Often used as a summary for lookups.
	object See the Type description for what types are supported on each product.
FirstName	string or null First name of the sales person. Elite: This field is not supported.
LastName	string or null Last name of the sales person. Elite: This field is not supported.

Status

string

Default: "Lead"

Enum: "Lead" "Prospect" "Cash" "Account"

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

ExternalReceivableBalance

number

Default: 0

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

object or null

Default: {}

Additional fields for Customer.

CustomerWebPortal	boolean or null (Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature.
ExternalTaxClass	string or null (Elite Only) A user definable field for an External Tax Service.
ExternalTaxCode	string or null (Elite Only) A user definable field for an External Tax Service.
ForceContractInfo	boolean or null (Elite Only) Requires the employee to collect a text value to identify the contract's purpose.
ForceJobId	boolean or null (Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs.
ForcePickedUp	boolean or null (Elite Only) Requires the employee to collect the name of the person picking up the items.
ForcePurchaseOrder	boolean or null (Elite Only) Flag to force purchase orders.
InvoiceSendBy	string or null Enum: "Email" "Fax" "No Statement" "Printer" "None" (Elite Only) Determines how a customer will receive contracts.
Restrictions	string or null What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions
StatementSendBy	string or null Enum: "Email" "Fax" "No Statement" "Printer" "None" (Elite Only) Determines how a customer will receive statements.
Terms	string or null <= 50 characters (Elite Only) Terms for the customer.
UserDefined1	string or null <= 50 characters Placeholder field.
UserDefined2	string or null <= 50 characters Placeholder field.

CreatedDateTime

string or null <date-time>

Default: "string"

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

UpdatedDateTime

string or null <date-time>

Default: "string"

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

Hidden

integer

Default: 0

Enum: null 1

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

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"BillingName": "string",
"Classification": "string",
"CompanyName": "string",
"Contacts": [ ],
"CreditLimit": 0,
"CurrencyCode": "string",
"DoNotEmail": false,
"Emails": [ ],
"FirstName": "string",
"HeardAboutUs": "string",
"LastName": "string",
"Locale": "string",
"Nontaxable": false,
"PaymentTerms": "string",
"Phones": [ ],
"RecordType": "string",
"SalesPerson": { },
"Status": "string",
"ExternalReceivableBalance": 0,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"BillingName": "string",
"Classification": "string",
"CompanyName": "string",
"Contacts": [ ],
"CreditLimit": 0,
"CurrencyCode": "string",
"DoNotEmail": false,
"Emails": [ ],
"FirstName": "string",
"HeardAboutUs": "string",
"LastName": "string",
"Locale": "string",
"Nontaxable": false,
"PaymentTerms": "string",
"Phones": [ ],
"RecordType": "string",
"SalesPerson": { },
"Status": "string",
"ExternalReceivableBalance": 0,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Enum Lookup for Customer

Supported by: Elite

This endpoint allows you to retrieve dynamic enum values for specific fields in our Customers model. These values are configured in the Elite settings. Below is a list of fields that support dynamic lookups. Also the descriptions for these fields indicated that they are lookup fields.

Supported Lookup Fields:

Customers.Classification
Customers.CurrencyCode
Customers.HeardAboutUs
Customers.Locale
Customers.Status.

Authorizations:

API Key

path Parameters

field

required

string

Enum: "Classification" "CurrencyCode" "HeardAboutUs" "Locale" "Status"

Using one of the listed values will allow you to see all of the dynamic configured options set up for the company.

Responses

Response Schema: application/json

Array

ModelType

string

Value: "Lookup"

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 upon creation and not updatable.

Name

string or null

Currently this field returns null.

Description

string or null

Contains additional context for the dynamic value. Used when the listed value is not self-explanatory.

Value

string

This field contains the dynamic values that is set by this customer. Some examples of what migth be returned for each lookup is shown below.

Lookup Field	Supported
Classification	N/A
CurrencyCode	USD, CAD, GBP, etc.
HeardAboutUs	Mobile App, Drive By, Internet Search, etc.
Locale	en-US, fr, es, etc.
Status	Prospect, Cash Only, Lead, etc.

Response samples

200

Content type

application/json

[{"ModelType": "Lookup",
"Value": "en-US",
"Description": "English",
"Id": "1",
"Name": null
},
{"ModelType": "Lookup",
"Value": "es",
"Description": "Spanish",
"Id": "2",
"Name": null
},
{"ModelType": "Lookup",
"Value": "fr",
"Description": "French",
"Id": "3",
"Name": null
}
]

Depots

Supported by: Elite, Essentials, and Syrinx

Depots endpoint will return physical location of the rental/hire storefront or inventory. Contracts are associated with a Depot. Equipment is owned and stored by Depots.

In Elite's UI, Depots are typically referred to as Stores.
In Essentials' UI, Depots are called Companies.
In Syrinx's UI Depots is used in the UI as well. This RMS is where this endpoint's namesake originated.

Retrieve a list of Depots

Supported by: Elite, Essentials, and Syrinx.

Returns an array containing all Depots, with support for filtering as indicated below.

Authorizations:

APIKey

Responses

Response Schema: application/json

Array

ModelType

string

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 upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	ParameterFile.Store
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes			DPT_ID

Name

string

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	ParameterFile.STORE_NAME
Essentials	Yes	Yes	Company Details → Company Name	N/A
Syrinx	Yes			DPT_NAME

Identifiers

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

Array of objects (Address)

This returns the Depot's physical address. Not all address fields may be filled out depending on location. Expand to see nested fields.

DefaultDepot

boolean or null

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

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx

Array of objects (Email)

An array of emails associated with this record. As a reminder, arrays may return as empty, with one result, or multiple results. Expand to see nested fields.

Array of objects (Phone)

An array of phone number associated with this record. As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	Yes	N/A	N/A
Syrinx	No	--	--	--

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	Yes	N/A	N/A
Syrinx	No	--	--	--

Hidden

integer or null

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	No	N/A	DPT_CURRENT_FLAG

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "Depot",
"Id": "15",
"Name": "Dallas Rentals",
"Identifiers": { },
"Addresses": [{"Type": "Default",
"Line1": "123 Anywhere St.",
"Line2": null,
"Line3": null,
"City": null,
"Province": "TX",
"PostalCode": "75000",
"Latitude": null,
"Longitude": null,
"Country": null,
"GeoRegion2": null,
"GeoRegion3": null
}
],
"Emails": [ ],
"Phones": [{"Type": "Default",
"CountryCode": null,
"Number": "1231231234",
"NumberE164": null,
"Extension": "",
"SmsCapable": false
}
],
"AdditionalFields": { },
"CreatedDateTime": null,
"UpdatedDateTime": null,
"Hidden": 0,
"DefaultDepot": null
}

Retrieve a single Depot by Id

Supported by: Elite, Essentials, and Syrinx.

Retrieves a single Depot specified by its ID.

Authorizations:

APIKey

path Parameters

DepotId

required

string

Provide the unique ID of the Depot you want to retrieve.

Responses

Response Schema: application/json

ModelType

string

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 upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	ParameterFile.Store
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes			DPT_ID

Name

string

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

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Name	ParameterFile.STORE_NAME
Essentials	Yes	Yes	Company Details → Company Name	N/A
Syrinx	Yes			DPT_NAME

Identifiers

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

Array of objects (Address)

This returns the Depot's physical address. Not all address fields may be filled out depending on location. Expand to see nested fields.

Array

City

string or null <= 128 characters

City or Town for this address.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	City, State Zip or City, State	ParameterFile.STORE_CITY
Essentials	Yes	Yes	City	N/A
Syrinx	Yes	No	Town	ADR_TOWN

Country

string or null <= 128 characters

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

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	No	Country	N/A
Syrinx	No, matches `Addresses.GeoRegion2`	--	--	--

GeoRegion2

string or null <= 64 characters

Municipality or County for this address.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	No	Municipality	N/A
Syrinx	Yes	No	County	ADR_COUNTY

GeoRegion3

string or null <= 64 characters

In Essentials, this represents the 'Town' if this field is turned on. By default, this field is not present on the UI.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	No	Town	N/A
Syrinx	No, always `null`	--	--	--

Latitude

string or null <= 64 characters

Latitude coordinate in (DD) Decimal Degree format. When the address is entered, the latitude can include up to 9 decimals places based on the 30 character length of the delivery address field in transactions. - LOC:LAT, LON - Loc: XX.123456789, -YY.123456789

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	Latitude	ADR_LATITUDE

Line1

string or null <= 256 characters

First line of the address field. Typically, this contains address number and street.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	Address or Street	ParameterFile.STORE_STRT
Essentials	Yes	Yes	Address	N/A
Syrinx	Yes	No	Address	ADR_LINE1

Line2

string or null <= 256 characters

Second line of the address field. Often includes apartment, building, or suite number if applicable.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	Yes	No	Address	N/A
Syrinx	Yes	No	Address	ADR_LINE2

Line3

string or null <= 256 characters

Third line of the address field. Additional information if needed.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	Address	ADR_LINE3

Longitude

string or null <= 64 characters

Longitude coordinate in (DD) Degree Decimal format. When the address is entered, the longitude cna include up to 9 decimals places based on the 30 character length of the delivery address field in transactions. - LOC:LAT, LON - Loc: XX.123456789, -YY.123456789

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	Longitude	ADR_LONGITUDE

Name

string or null <= 128 characters

Optional freeform field used to name the address.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	Name	ADR_NAME

PostalCode

string or null <= 32 characters

May be postal code, postcode, PIN, ZIP Code, etc. depending on the country.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	City, State Zip or Zip	ParameterFile.STORE_ZIP
Essentials	Yes	Yes	Postal Code	N/A
Syrinx	Yes	No	Postcode	ADR_POSTCODE

Province

string or null <= 128 characters

This is the geographical State for this Address.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	City, State Zip or City, State	ParameterFile.STORE_CITY
Essentials	Yes	No	Town	N/A
Syrinx	No, always `null`	--	--	--

Type

string or null <= 32 characters

A general label that could be used to help define the type of address being returned.

Software	Supported	Filterable
Elite	Yes	--
Essentials	Yes, always 'Default'	No
Syrinx	No	--

DefaultDepot

boolean or null

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

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx

Array of objects (Email)

An array of emails associated with this record. As a reminder, arrays may return as empty, with one result, or multiple results. Expand to see nested fields.

Array

Email

string

Email associated with this record.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	Yes	N/A	N/A
Syrinx	No	--	--	--

Type

string

A general label to help define the type of email being returned. Might provide context about the type of email address provided.

Software	Supported
Elite	No
Essentials	Yes, always 'Default'
Syrinx	No

Array of objects (Phone)

An array of phone number associated with this record. As a reminder, arrays may return an empty, with a single phone number object, or an array with multiple phone numbers objects. Expand to see nested fields.

Array

CountryCode

string or null <= 16 characters

Country code prefix to phone number. List of country code prefixes found here.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No	--	GAPIPhone

Extension

string or null <= 32 characters

Extension associated with the provided number.

Software	Supported	Filterable	UI	Database
Elite	No, always `null`	--	--	--
Essentials	No	--	--	--
Syrinx	No, always `null`	--	--	--

Number

string or null <= 32 characters

A phone number associated with this record.

Software	Supported	Filterable	UI	Database
Elite	Yes	No	Phone	ParameterFile.STORE_PHONE
Essentials	Yes	Yes	Part of Primary Phone Number	N/A
Syrinx	Yes	No		GAPIPhone

NumberE164

string or null <= 32 characters

A supplied phone number will return here if it has been validated according to the E.164 format.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	No	--	--	--
Syrinx	Yes	No		GAPIPhone

SmsCapable

boolean or null

Can an SMS be sent to this phone number?

Software	Supported
Elite	No
Essentials	No
Syrinx	No

Type

string or null <= 32 characters

In POR products that support multiple phone numbers, the phone type is often identified by the field in the UI where the number is entered.

Software	Supported	Filterable
Elite	Yes	No
Essentials	Yes, always 'Default'	No
Syrinx	No	--

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	Yes	N/A	N/A
Syrinx	No	--	--	--

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	Yes	N/A	N/A
Syrinx	No	--	--	--

Hidden

integer or null

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--
Essentials	Yes	Yes	N/A	N/A
Syrinx	Yes	No	N/A	DPT_CURRENT_FLAG

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "Depot",
"Id": "15",
"Name": "Dallas Rentals",
"Identifiers": { },
"Addresses": [{"Type": "Default",
"Line1": "123 Anywhere St.",
"Line2": null,
"Line3": null,
"City": null,
"Province": "TX",
"PostalCode": "75000",
"Latitude": null,
"Longitude": null,
"Country": null,
"GeoRegion2": null,
"GeoRegion3": null
}
],
"Emails": [ ],
"Phones": [{"Type": "Default",
"CountryCode": null,
"Number": "1231231234",
"NumberE164": null,
"Extension": "",
"SmsCapable": false
}
],
"AdditionalFields": { },
"CreatedDateTime": null,
"UpdatedDateTime": null,
"Hidden": 0,
"DefaultDepot": null
}

Invoices

Retrieve a list of Invoices

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" Value: "Invoice" These are the different types of invoice models we can use.
Id	string Default: "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 Default: "string" The display name for the invoice
	object or null Default: {} Identifying items for invoice
CustomerId	string or null Default: "string" The customer id associated with the invoice.
InvoiceDate	string or null <date-time> Default: "string" The date the invoice was created
InvoiceNumber	string or null Default: "string" The invoice number
GrandTaxTotal	number or null Default: 0 Amount of Tax/VAT on the invoice
GrandTotal	number or null Default: 0 Value of the invoice including taxes
AmountDue	number or null Default: 0 Amount of money owed toward the invoice total
AdditionalFields	object or null Default: {} Additional fields for invoice
CreatedDateTime	string or null <date-time> Default: "string" When was the record created? All date times are expected to be in UTC & ISO-8601 format.
UpdatedDateTime	string or null <date-time> Default: "string" When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.

Response samples

200

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CustomerId": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"GrandTaxTotal": 0,
"GrandTotal": 0,
"AmountDue": 0,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string"
}
]

Retrieve a single Invoice by Id

Authorizations:

API Key

path Parameters

InvoiceId

required

string

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Invoice"

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

Id

string

Default: "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

Default: "string"

The display name for the invoice

object or null

Default: {}

Identifying items for invoice

ContractId

string or null

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

CustomerId

string or null

Default: "string"

The customer id associated with the invoice.

InvoiceDate

string or null <date-time>

Default: "string"

The date the invoice was created

InvoiceNumber

string or null

Default: "string"

The invoice number

GrandTaxTotal

number or null

Default: 0

Amount of Tax/VAT on the invoice

GrandTotal

number or null

Default: 0

Value of the invoice including taxes

AmountDue

number or null

Default: 0

Amount of money owed toward the invoice total

AdditionalFields

object or null

Default: {}

Additional fields for invoice

CreatedDateTime

string or null <date-time>

Default: "string"

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

UpdatedDateTime

string or null <date-time>

Default: "string"

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

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CustomerId": "string",
"InvoiceDate": "string",
"InvoiceNumber": "string",
"GrandTaxTotal": 0,
"GrandTotal": 0,
"AmountDue": 0,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string"
}

Retrieve files for a single Invoice by Id.

Supported by: Elite

Authorizations:

API Key

path Parameters

InvoiceId required	string
tagKey required	string `pdfs` or `instructions` or `photos`

Responses

Response Schema: application/json

Array

FileName	string Default: "string" Original local filename.
FileClass	string Default: "string" Enum: "misc" "image" "video" Defines the type of stored file.
PublicURL	string Default: "string" Web URL where the stored file can be downloaded.
URLDateTime	string <date-time> Default: "string" The date/time the URL was retrieved/created.
URLExpires	integer Default: 0 Number of seconds from URLDateTime until URL expires.
TagMapKey	string Default: "string" Enum: "pdfs" "instructions" "photos" Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).
ObjectPrimaryKey	string Default: "string" Primary key of the object this file is associated with (same as in the URL for single object get).
ObjectType	string Default: "string" Type of object: One of Products, stock, or contract.
Tags	Array of strings Default: [] List of all the tag names associated with each file (ONLY the TagName).

Response samples

200

Content type

application/json

[{"FileName": "string",
"FileClass": "string",
"PublicURL": "string",
"URLDateTime": "string",
"URLExpires": 0,
"TagMapKey": "string",
"ObjectPrimaryKey": "string",
"ObjectType": "string",
"Tags": [ ]
}
]

Line Items

Retrieve a list of line items

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" Standard field that denotes the record type.
Id	string Default: "string" The unique identifier for this record.
Name	string Default: "string" The display name for this record. This is often used as a summary for lookups.
	object or null Default: {} Identifying items for LineItem.
Classification	string Default: "string" Enum: "Rental" "Sale" null This product is either meant for sale or rental. The internal classification does not apply to lineitems.
EndDateTime	string or null <date-time> Default: "string" UTC - When does the customer intend to return the items?
FuelCapacity	number or null Default: 0 If this item has a fuel, this is the total amount of fuel this line item can have. No units are provided. If the value returned is “0” that means that a fuel capacity has been provided, and it doesn’t have any. If “null” is provided, then no fuel capacity has been recorded. This field should only show up if the isFuel field is true.
HasFuel	boolean or null Default: false If this is related to an item that uses fuel, this field will be set. If not it will be false.
IsSerialized	boolean or null Default: false Do we expect this Line Item to have a unique Serial Number or is it a bulk item? NOTE - Some bulk items may still have serial numbers in some systems.
IsBulk	boolean or null Default: false Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.
LineTaxTotal	number or null Default: 0 This is the final projected tax for this line.
LineTotal	number or null Default: 0 This is the final projected price for this line accounting for qty, discounts, duration, tax, etc..
LocationId	string or null Default: "string" Id of the Location. (see the Location endpoints)
	Array of objects or null Default: [] Meter readings of this inventory. Multiple readings allowed for different types.
Notes	string or null Default: "string" Notes attached to a line item. Not an array of notes like its similarly name fields.
PONumber	string or null Default: "string" A number associated to a contract. Thi is user definable and associated by a POR user and their customer.
ProductId	string or null Default: "string" 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: 0 How many of this Line Item are there? NOTE - there can be multiple Line Items that have the same inventory item associated with them for various reasons so this does not mean that ALL of the [some inventory] will show up under this Line Item.
Rates	Array of strings or null Default: [] 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. This is currently not supported in Elite.
SerialNumber	string or null Default: "string" The serial number or unique identifier assigned to this particular Line Item.
ShowOnContract	boolean Default: true Is it a component/unincluded/optional item to display on contract. If false this item should generally not be shown to the consumer.
StartDateTime	string or null <date-time> Default: "string" UTC - When does the customer want the items?
Status	string or null Default: "string" Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold" The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved". Reserved Out Off Rent Returned Sold
StockId	string or null Default: "string" This is likely to replace ItemId as the reference to which "Item" or "Inventory" this record is related to. (This field is still a work in progres from the API standpoint so we may end up going another direction. Use with caution.)
	Array of objects (Workflow) Default: [] For Internal Use Only.
	Array of objects Default: [] All rates for this product or stock whether relevant or not. In most cases, you will want to use applicable rates.
	object or null Default: {} Additional fields for this record.
CreatedDateTime	string or null <date-time> Default: "string" UTC when the record was created.
UpdatedDateTime	string or null <date-time> Default: "string" UTC when the record was updated.
Hidden	integer or null Default: 0 Enum: null 1 Hidden
ItemId	string or null Deprecated Default: "string" Kept for legacy support, will eventually only need StockId and ProductId.

Response samples

200
4XX

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Classification": "string",
"EndDateTime": "string",
"FuelCapacity": 0,
"HasFuel": false,
"IsSerialized": false,
"IsBulk": false,
"LineTaxTotal": 0,
"LineTotal": 0,
"LocationId": "string",
"MeterReadings": [ ],
"Notes": "string",
"PONumber": "string",
"ProductId": "string",
"Quantity": 0,
"Rates": [ ],
"SerialNumber": "string",
"ShowOnContract": false,
"StartDateTime": "string",
"Status": "string",
"StockId": "string",
"Workflows": [ ],
"AllRates": [ ],
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"ItemId": "string"
}
]

Retrieve a single line item by its id

Authorizations:

API Key

path Parameters

LineItemId

required

string

Responses

Response Schema: application/json

LineItemIds required	Array of strings Default: [] The unique line items ids
CalledOffDateTime required	string <date-time> Default: "string" What date and time to call off the line items. UTC time zone. e.g. 2023-01-01T06:00:00Z
PersonCallingOff	string Default: "string" Name of the person who is calling the line items off rent.
Memo	string Default: "string" Additional textual information for calling the line items off rent.
RemoteUserId	string Default: "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.

Response samples

200
4XX

Content type

application/json

{"LineItemIds": [ ],
"CalledOffDateTime": "string",
"PersonCallingOff": "string",
"Memo": "string",
"RemoteUserId": "string"
}

Line Item Actions

Call Line Items Off Rent

Supported by: Elite

Authorizations:

API Key

Request Body schema: application/json
required

LineItemIds required	Array of strings Default: [] The unique line items ids
CalledOffDateTime required	string <date-time> Default: "string" What date and time to call off the line items. UTC time zone. e.g. 2023-01-01T06:00:00Z
PersonCallingOff	string Default: "string" Name of the person who is calling the line items off rent.
Memo	string Default: "string" Additional textual information for calling the line items off rent.
RemoteUserId	string Default: "string" An identifier on the remote server for the user's account. Can be User ID, Username, anything to match the Relationship to a user.

Responses

Request samples

Payload

Content type

application/json

{"LineItemIds": [ ],
"CalledOffDateTime": "string",
"PersonCallingOff": "string",
"Memo": "string",
"RemoteUserId": "string"
}

Response samples

201
4XX

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"AmountDue": 0,
"AmountPaid": 0,
"Contacts": [ ],
"ContractInformation": "string",
"CustomerId": "string",
"CustomerName": "string",
"CustomerPickup": { },
"DriverDelivery": { },
"DepotId": "string",
"DriverPickup": { },
"EndDateTime": "string",
"EsignState": "string",
"EsignUrl": "string",
"GrandTaxTotal": 0,
"GrandTotal": 0,
"LaborTracking": { },
"LineItems": [ ],
"LocationId": "string",
"Notes": [ ],
"PONumber": "string",
"StartDateTime": "string",
"Status": "string",
"Totals": [ ],
"Workflows": [ ],
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"ContractStatus": "string",
"IsDelivery": false,
"IsPickup": false
}

Locations

Create a new Location

Supported by: Elite

Required fields:

Name

Authorizations:

API Key

Request Body schema: application/json
required

Name

string or null [ 1 .. 255 ] characters

Default: "string"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

object or null

Default: {}

Location address.

Type required	string Default: "Customer" Value: "Customer" Examples include "Default", "Billing", etc. Supported types depend on the context of the address.
Line1	string or null <= 50 characters Address Number and Street.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null >= 2 characters Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode	string or null <= 50 characters May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

Default: []

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

Elite: Supported.
Syrinx: Not supported.

Array

required

object

EndDate

string or null <date-time>

Default: "string"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Default: []

Currently we only support the following types of notes

SiteDeliveryInstructions.

Array

Type required	string Default: "SiteDeliveryInstructions" Value: "SiteDeliveryInstructions" Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.
Value required	string or null The note text.

OwnerId

string or null

Default: "string"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects

Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

Array

Type required	string Default: "Default" Value: "Default" Supported phone types.
Number required	string or null A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported

StartDate

string or null <date-time>

Default: "string"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

AdditionalFields

object or null

Default: {}

Additional fields for Location.

Responses

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Address": { },
"Contacts": [ ],
"Emails": [ ],
"EndDate": "string",
"Notes": [ ],
"OwnerId": "string",
"Phones": [ ],
"StartDate": "string",
"Type": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Response samples

201
4XX

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Address": { },
"Contacts": [ ],
"Emails": [ ],
"EndDate": "string",
"Notes": [ ],
"OwnerId": "string",
"Phones": [ ],
"StartDate": "string",
"Type": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Retrieve a list of Locations

Supported by: Elite, Syrinx

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" Value: "Location" Standard field that denotes the record type. Useful for bulk ingesting different record types.
Id	string Default: "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 Default: "string" This would map to the jobsite description in Elite. Example being Madison Square Garden.
Identifiers	object or null Default: {} Location does not have any identifiers at this time.
	object or null Default: {} Location address.
	Array of objects Default: [] If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location. Elite: Supported. Syrinx: Not supported.
	Array of objects Default: [] Type can == "Customer" or "Billing" for now. This supports multiple email addresses.
EndDate	string or null <date-time> Default: "string" This is the date from which the location is no longer valid to be used. A location cannot be used after this date. Elite: This field is not supported. Syrinx: Supported.
	Array of objects Default: [] Currently we only support the following types of notes SiteDeliveryInstructions.
OwnerId	string or null Default: "string" Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..
	Array of objects Default: [] Type can == "Customer" or "Billing" for now. This supports multiple phone
StartDate	string or null <date-time> Default: "string" This is the date from which the location is valid to be used. A location cannot be used before this date. Elite: Not supported. Syrinx: Supported.
Type	string Default: "string" Enum: "Global" "Customer" "Supplier" Location type may be one of the following. Global Customer Supplier
AdditionalFields	object or null Default: {} Additional fields for Location.
CreatedDateTime	string or null <date-time> Default: "string" 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: "string" When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. Elite: This field is not supported.
Hidden	integer Default: 0 Enum: null 1 0 = false, 1 = true \| This means Deleted. Elite: This field is always 0.

Response samples

200
4XX

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Address": { },
"Contacts": [ ],
"Emails": [ ],
"EndDate": "string",
"Notes": [ ],
"OwnerId": "string",
"Phones": [ ],
"StartDate": "string",
"Type": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}
]

Retrieve a single Location by Id

Supported by: Elite, Syrinx

Authorizations:

API Key

path Parameters

LocationId

required

string

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Location"

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

Id

string

Default: "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

Default: "string"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

Identifiers

object or null

Default: {}

Location does not have any identifiers at this time.

object or null

Default: {}

Location address.

Type required	string Default: "Customer" Value: "Customer" Examples include "Default", "Billing", etc. Supported types depend on the context of the address.
Name	string or null Optional name for Address
Line1	string or null Address Number and Street.
Line2	string or null May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode	string or null May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

Default: []

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

Elite: Supported.
Syrinx: Not supported.

Array

Type required	string Default: "Default" Currently there arent any specific types related to location
required	object

Array of objects

Default: []

Type can == "Customer" or "Billing" for now. This supports multiple email addresses.

Array

Type required	string Supported types.
Email required	string or null A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

EndDate

string or null <date-time>

Default: "string"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Default: []

Currently we only support the following types of notes

SiteDeliveryInstructions.

Array

Type required	string Default: "SiteDeliveryInstructions" Value: "SiteDeliveryInstructions" Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.
Value required	string or null The note text.

OwnerId

string or null

Default: "string"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects

Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

Array

Type required	string Default: "Default" Value: "Default" Supported phone types.
Number required	string or null A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported
NumberE164	string or null A phone number must be supplied and validated according to the E.164 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
Extension	string or null Is there an extension associated with this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
SmsCapable	boolean or null Can an SMS be sent to this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

StartDate

string or null <date-time>

Default: "string"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

Type

string

Default: "string"

Enum: "Global" "Customer" "Supplier"

Location type may be one of the following.

Global
Customer
Supplier

AdditionalFields

object or null

Default: {}

Additional fields for Location.

CreatedDateTime

string or null <date-time>

Default: "string"

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: "string"

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

Elite: This field is not supported.

Hidden

integer

Default: 0

Enum: null 1

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

Elite: This field is always 0.

Response samples

200
4XX

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Address": { },
"Contacts": [ ],
"Emails": [ ],
"EndDate": "string",
"Notes": [ ],
"OwnerId": "string",
"Phones": [ ],
"StartDate": "string",
"Type": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Update a single Location by Id

Supported by: Elite

Required fields:

Id

Authorizations:

API Key

path Parameters

LocationId

required

string

Request Body schema: application/json
required

Name

string or null [ 1 .. 255 ] characters

Default: "string"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

object or null

Default: {}

Location address.

Type required	string Default: "Customer" Value: "Customer" Examples include "Default", "Billing", etc. Supported types depend on the context of the address.
Line1	string or null <= 50 characters Address Number and Street.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null >= 2 characters Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode	string or null <= 50 characters May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

Default: []

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

Elite: Supported.
Syrinx: Not supported.

Array

required

object

EndDate

string or null <date-time>

Default: "string"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Default: []

Currently we only support the following types of notes

SiteDeliveryInstructions.

Array

Type required	string Default: "SiteDeliveryInstructions" Value: "SiteDeliveryInstructions" Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.
Value required	string or null The note text.

OwnerId

string or null

Default: "string"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects

Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

Array

Type required	string Default: "Default" Value: "Default" Supported phone types.
Number required	string or null A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported

StartDate

string or null <date-time>

Default: "string"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

AdditionalFields

object or null

Default: {}

Additional fields for Location.

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Location"

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

Id

string

Default: "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

Default: "string"

This would map to the jobsite description in Elite. Example being Madison Square Garden.

Identifiers

object or null

Default: {}

Location does not have any identifiers at this time.

object or null

Default: {}

Location address.

Type required	string Default: "Customer" Value: "Customer" Examples include "Default", "Billing", etc. Supported types depend on the context of the address.
Name	string or null Optional name for Address
Line1	string or null Address Number and Street.
Line2	string or null May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode	string or null May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

Default: []

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

Elite: Supported.
Syrinx: Not supported.

Array

Type required	string Default: "Default" Currently there arent any specific types related to location
required	object

Array of objects

Default: []

Type can == "Customer" or "Billing" for now. This supports multiple email addresses.

Array

Type required	string Supported types.
Email required	string or null A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.

EndDate

string or null <date-time>

Default: "string"

This is the date from which the location is no longer valid to be used. A location cannot be used after this date.

Elite: This field is not supported.
Syrinx: Supported.

Array of objects

Default: []

Currently we only support the following types of notes

SiteDeliveryInstructions.

Array

Type required	string Default: "SiteDeliveryInstructions" Value: "SiteDeliveryInstructions" Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type.
Value required	string or null The note text.

OwnerId

string or null

Default: "string"

Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc..

Array of objects

Default: []

Type can == "Customer" or "Billing" for now. This supports multiple phone

Array

Type required	string Default: "Default" Value: "Default" Supported phone types.
Number required	string or null A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported
NumberE164	string or null A phone number must be supplied and validated according to the E.164 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
Extension	string or null Is there an extension associated with this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
SmsCapable	boolean or null Can an SMS be sent to this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

StartDate

string or null <date-time>

Default: "string"

This is the date from which the location is valid to be used. A location cannot be used before this date.

Elite: Not supported.
Syrinx: Supported.

Type

string

Default: "string"

Enum: "Global" "Customer" "Supplier"

Location type may be one of the following.

Global
Customer
Supplier

AdditionalFields

object or null

Default: {}

Additional fields for Location.

CreatedDateTime

string or null <date-time>

Default: "string"

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: "string"

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

Elite: This field is not supported.

Hidden

integer

Default: 0

Enum: null 1

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

Elite: This field is always 0.

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Address": { },
"Contacts": [ ],
"Emails": [ ],
"EndDate": "string",
"Notes": [ ],
"OwnerId": "string",
"Phones": [ ],
"StartDate": "string",
"Type": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Response samples

200
4XX

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Address": { },
"Contacts": [ ],
"Emails": [ ],
"EndDate": "string",
"Notes": [ ],
"OwnerId": "string",
"Phones": [ ],
"StartDate": "string",
"Type": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Products

Retrieve availability for a single Product by Id

Supported by: Elite, Syrinx

Authorizations:

API Key

path Parameters

ProductId

required

string

query Parameters

startdate required	string
enddate required	string

Responses

Response Schema: application/json

ModelType

string

Default: "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

Default: "string"

Cannot be used for patching or lookups

Name

string or null

Default: "string"

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

Identifiers

object or null

Default: {}

ProductAvailability does not have any identifiers at this time.

ProductId

string

Default: "string"

Id of product

ProductName

string

Default: "string"

Name of product

Array of objects or null

Default: []

The available stock for this product.

Array

ModelType	string This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.
Id	string Cannot be used for patching or lookups
Name	string or null A display name for this record. Often used as a summary for lookups.
	object or null Identifying items for Stock Availability.
StockId	string Id of stock
StockName	string Name of stock
SerialNumber	string or null The serial number associated with a specific instance of an item.
DepotId	string The company id, store id, or depot id depending on which system you are using.
StartDateTime	string <date-time> Start date of availability
EndDateTime	string <date-time> End date of availability
AvailableQuantity	number The current quantity available for rent or sale.
ExpectedQuantity	number The quantity expected to be on premise. This is how many you would expect to find when doing an inventory count. This includes available and unavailable inventory.
TotalQuantity	number Total quantity owned regardless of availability.
QtyExpected	number Deprecated Expected quantity Deprecated: Please use ExpectedQuantity instead.

DepotId

string

Default: "string"

The company id, store id, or depot id depending on which system you are using.

StartDateTime

string <date-time>

Default: "string"

Start date of availability

EndDateTime

string <date-time>

Default: "string"

End date of availability

AvailableQuantity

number

Default: 0

The current quantity available for rent or sale.

ExpectedQuantity

number

Default: 0

The quantity expected to be on premise. This is how many you would expect to find when doing an inventory count. This includes available and unavailable inventory.

TotalQuantity

number

Default: 0

Total quantity owned regardless of availability.

QtyExpected

number

Deprecated

Default: 0

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"ProductId": "string",
"ProductName": "string",
"AvailableStock": [ ],
"DepotId": "string",
"StartDateTime": "string",
"EndDateTime": "string",
"AvailableQuantity": 0,
"ExpectedQuantity": 0,
"TotalQuantity": 0,
"QtyExpected": 0
}

Create a Product

Authorizations:

API Key

Request Body schema: application/json
required

Name

required

string or null

Default: "string"

The display name for the item.

Classification

required

string

Default: "string"

Enum: "Rental" "Sale"

This Product is either meant for sale, rental or internal. Only Rental and Sale supported for POST.

Description

required

string or null

Default: "string"

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

DepotId

required

string or null

Default: "string"

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

required

object or null

Default: {}

Additional fields for Product.

CaseQuantity	number or null Default: "null" The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.
CriticalLevel	number or null Default: "null" When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.
CurrentDepotId	string or null (Elite Only - Required) The id of the current store/depot.
RentalCaseQuantity	number or null Default: "null" The amount in a case for a rental.
ReorderMaximum	number or null Default: "null" The maximum for reordering the item.
ReorderMinimum	number or null Default: "null" The minimum for reordering the item.
TaxCode	number or null The tax code for the item. POST and GET only. This value can't be updated/patched from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.
ExternalTaxCode	string or null The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

required

object or null

Default: {}

Identifying items for Product.

Key	string or null (Required) A customer defined Id for this item.
PartNumber	string or null The part number associated to a specific instance of a part.
Alias	string or null (Elite Only) Lookup field in Elite.
Barcode	string or null (Elite Only) Barcode field in Elite.

CategoryName

string or null

Default: "string"

Denormalized name of the Category.

Elite: Only supports one name.

IsPart

boolean or null

Default: false

Used to determine if product is a part (Sales

Responses

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"Description": "string",
"DisplayOrder": 0,
"InstructionsUrl": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"Images": [ ],
"OtherUrls": [ ],
"Tags": [ ],
"IsPart": false,
"AdditionalFields": { }
}

Response samples

201

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"Description": "string",
"DisplayOrder": 0,
"InstructionsUrl": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"Key": "string",
"Images": [ ],
"OtherUrls": [ ],
"Tags": [ ],
"IsPart": false,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"Alias": "string",
"Barcode": "string",
"DisplayOnStorefront": false
}

Retrieve a list of Products

Supported by: Elite, Syrinx

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" Value: "Product" Standard field that denotes the record type. Useful for bulk ingesting different record types.
Id	string Default: "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 Default: "string" The display name for the item.
	object or null Default: {} Identifying items for Product.
CategoryIds	Array of strings Default: [] Reference a CategoryId
CategoryName	string or null Default: "string" Denormalized name of the Category. Elite: Only supports one name.
Classification	string Default: "string" Enum: "Rental" "Sale" "Internal" null This Product is either meant for sale, rental or internal.
DepotId	string or null Default: "string" Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)
Description	string or null Default: "string" This should describe the category. Likely a single sentence, but could be small paragraph.
DisplayOrder	number or null >= 1 Default: 0 OPTIONAL. By default, we might sort by A -> Z, but in some cases, stores may want to manually set an items display order within a category. Elite: This field is not supported.
InstructionsUrl	string or null Default: "string" A publicly accessible link to any instructions associated with this item.
ModelName	string or null Default: "string" OPTIONAL. This also exists on Stock. The model name associated with a specific instance of an item. Elite: This field is not supported.
ModelNumber	string or null Default: "string" OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.
ModelYear	string or null Default: "string" OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.
Key	string or null Deprecated Default: "string" A customer defined Id for this item. Deprecated: This field is being moved to Identifiers.Key.
	Array of objects Default: [] An array of publicly accessible URLs or URI's that resolve to images of the item. Also, supports some metadata. We will assume they are in order so that the first one in the list is the default image for the item.
OtherUrls	Array of strings Default: [] An array of publicly accessible URLs that can be used for anything. Elite: This field is not supported.
Tags	Array of strings Default: [] This should be an array of tags. Generally expected to be like a subcategory. Elite: This field is not supported.
IsPart	boolean or null Default: false Used to determine if product is a part
	object or null Default: {} Additional fields for Product.
CreatedDateTime	string or null <date-time> Default: "string" When was the record created? All date times are expected to be in UTC & ISO-8601 format.
UpdatedDateTime	string or null <date-time> Default: "string" When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.
Hidden	integer Default: 0 Enum: null 1 0 = false, 1 = true \| This means Deleted. Elite: This field is not supported.
Alias	string or null Deprecated Default: "string" Deprecated: Use Identifiers.Alias (Elite Only) Lookup field in Elite.
Barcode	string or null Deprecated Default: "string" Deprecated: Use Identifiers.Barcode Elite: This field is not supported.
DisplayOnStorefront	boolean Default: true Whether or not this particular product should display on the storefront.
	number or string For elite, only a number. It is a monotomic that can be used to detect changes.

Response samples

200

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"Description": "string",
"DisplayOrder": 0,
"InstructionsUrl": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"Key": "string",
"Images": [ ],
"OtherUrls": [ ],
"Tags": [ ],
"IsPart": false,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"Alias": "string",
"Barcode": "string",
"DisplayOnStorefront": false
}
]

Retrieve a list of associations between products

Supported by: Elite

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" Value: "ProductAssociation" Standard field that denotes the record type. Useful for bulk ingesting different record types.
Id	string Default: "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: "string" Product to which the association belongs to ie. the parent.
ChildProductId	string Default: "string" Product that is being associated ie. the child.
AssociationType	string Default: "string" Enum: "Optional" "Automatic" "KitComponent" Enum field denoting the nature of the association. 'KitComponent' should be used if item is included as part of a kit, which has its own section and kit pricing instead of line item pricing. 'Automatic' are required to be added with parent item, while 'Optional' gives the user the option to add the item to the cart.
Group	string or null Default: "string" 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: 0 Defines a sort order for associated products. Lowest value will appear first in the list
CreatedDateTime	string or null <date-time> Default: "string" When was the record created? All date times are expected to be in UTC & ISO-8601 format.
UpdatedDateTime	string or null <date-time> Default: "string" When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.
Hidden	integer Default: 0 Enum: null 1 0 = false, 1 = true \| This means Deleted. Elite: This field is not supported.
Disabled	boolean or null Default: false Whether or not the record is disabled
Quantity	number or null Default: 0 Quantity of the referenced product that is allocated to this association

Response samples

200

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"ParentProductId": "string",
"ChildProductId": "string",
"AssociationType": "string",
"Group": "string",
"GroupSelectionType": "string",
"IsSelected": false,
"DisplayOrder": 0,
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"Disabled": false,
"Quantity": 0
}
]

Retrieve a single Product by Id

Supported by: Elite, Syrinx

Authorizations:

API Key

path Parameters

ProductId

required

string

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Product"

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

Id

string

Default: "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

Default: "string"

The display name for the item.

object or null

Default: {}

Identifying items for Product.

Key	string or null A customer defined Id for this item.
Alias	string or null (Elite Only) Lookup field in Elite.
Barcode	string or null (Elite Only) Barcode field in Elite.
PartNumber	string or null The part number associated to a specific instance of a part.

CategoryIds

Array of strings

Default: []

Reference a CategoryId

CategoryName

string or null

Default: "string"

Denormalized name of the Category.

Elite: Only supports one name.

Classification

string

Default: "string"

Enum: "Rental" "Sale" "Internal" null

This Product is either meant for sale, rental or internal.

DepotId

string or null

Default: "string"

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

Description

string or null

Default: "string"

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

DisplayOrder

number or null >= 1

Default: 0

OPTIONAL. By default, we might sort by A -> Z, but in some cases, stores may want to manually set an items display order within a category.

Elite: This field is not supported.

InstructionsUrl

string or null

Default: "string"

A publicly accessible link to any instructions associated with this item.

ModelName

string or null

Default: "string"

OPTIONAL. This also exists on Stock. The model name associated with a specific instance of an item.

Elite: This field is not supported.

ModelNumber

string or null

Default: "string"

OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.

ModelYear

string or null

Default: "string"

OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.

Key

string or null

Deprecated

Default: "string"

A customer defined Id for this item.

Deprecated: This field is being moved to Identifiers.Key.

Array of objects

Default: []

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

Array

Uri	string This must be a publicly accessible URL on the internet. That would infer the image is hosted in the cloud. Alternatively, you can pass in a Data URI. See wiki for Data URI
AltText	string or null Text found in Alt image field

OtherUrls

Array of strings

Default: []

An array of publicly accessible URLs that can be used for anything.

Elite: This field is not supported.

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"Description": "string",
"DisplayOrder": 0,
"InstructionsUrl": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"Key": "string",
"Images": [ ],
"OtherUrls": [ ],
"Tags": [ ],
"IsPart": false,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"Alias": "string",
"Barcode": "string",
"DisplayOnStorefront": false
}

Update a Product

Authorizations:

API Key

path Parameters

ProductId

required

string

Request Body schema: application/json
required

Name

required

string or null

Default: "string"

The display name for the item.

Classification

required

string

Default: "string"

Enum: "Rental" "Sale"

This Product is either meant for sale, rental or internal. Only Rental and Sale supported for POST.

Description

required

string or null

Default: "string"

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

DepotId

required

string or null

Default: "string"

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

required

object or null

Default: {}

Additional fields for Product.

CaseQuantity	number or null Default: "null" The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.
CriticalLevel	number or null Default: "null" When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.
CurrentDepotId	string or null (Elite Only - Required) The id of the current store/depot.
RentalCaseQuantity	number or null Default: "null" The amount in a case for a rental.
ReorderMaximum	number or null Default: "null" The maximum for reordering the item.
ReorderMinimum	number or null Default: "null" The minimum for reordering the item.
TaxCode	number or null The tax code for the item. POST and GET only. This value can't be updated/patched from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.
ExternalTaxCode	string or null The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

required

object or null

Default: {}

Identifying items for Product.

Key	string or null (Required) A customer defined Id for this item.
PartNumber	string or null The part number associated to a specific instance of a part.
Alias	string or null (Elite Only) Lookup field in Elite.
Barcode	string or null (Elite Only) Barcode field in Elite.

CategoryName

string or null

Default: "string"

Denormalized name of the Category.

Elite: Only supports one name.

IsPart

boolean or null

Default: false

Used to determine if product is a part (Sales

Responses

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"Description": "string",
"DisplayOrder": 0,
"InstructionsUrl": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"Images": [ ],
"OtherUrls": [ ],
"Tags": [ ],
"IsPart": false,
"AdditionalFields": { }
}

Response samples

201

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"Description": "string",
"DisplayOrder": 0,
"InstructionsUrl": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"Key": "string",
"Images": [ ],
"OtherUrls": [ ],
"Tags": [ ],
"IsPart": false,
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"Alias": "string",
"Barcode": "string",
"DisplayOnStorefront": false
}

Retrieve rates for a single Product by Id.

Supported by: Elite, Syrinx

Authorizations:

API Key

path Parameters

ProductId

required

string

query Parameters

depotId required	string
locationId required	string
customerId required	string
startDate required	string
endDate required	string

Responses

Response Schema: application/json

ApplicableRates

string

Default: "string"

Applicable rates are the most relevant rates, passed back as a single string with line breaks (\n).

Example #1 (raw):
"Daily Rate: $20.00 \n Weekly Rate: $65.00 \n Monthly Rate: $240.00”:

Example #1 (displayed):

DailyRate: $20.00
Weekly Rate: $65.00
Monthly Rate: $240.00

Example #2 (raw):
“Daily: $20.00 \n (there is a single day surcharge of $15.00) \n Weekly: $60.00”

Example #2 (displayed):

Daily: $20.00
(there is a single day surcharge of $15.00)
Weekly: $60.00

Array of objects

Default: []

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

Array

PeriodName	string Example: "daily rate", "1 week rate"
Rate	string or null Example: "20.00"
CurrencyType	string Example: "USD"

Response samples

200

Content type

application/json

{"ApplicableRates": "string",
"AllRates": [ ]
}

Retrieve files for a single Product by Id.

Supported by: Elite

Authorizations:

API Key

path Parameters

ProductId required	string
tagKey required	string `pdfs` or `instructions` or `photos`

Responses

Response Schema: application/json

Array

FileName	string Default: "string" Original local filename.
FileClass	string Default: "string" Enum: "misc" "image" "video" Defines the type of stored file.
PublicURL	string Default: "string" Web URL where the stored file can be downloaded.
URLDateTime	string <date-time> Default: "string" The date/time the URL was retrieved/created.
URLExpires	integer Default: 0 Number of seconds from URLDateTime until URL expires.
TagMapKey	string Default: "string" Enum: "pdfs" "instructions" "photos" Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).
ObjectPrimaryKey	string Default: "string" Primary key of the object this file is associated with (same as in the URL for single object get).
ObjectType	string Default: "string" Type of object: One of Products, stock, or contract.
Tags	Array of strings Default: [] List of all the tag names associated with each file (ONLY the TagName).

Response samples

200

Content type

application/json

[{"FileName": "string",
"FileClass": "string",
"PublicURL": "string",
"URLDateTime": "string",
"URLExpires": 0,
"TagMapKey": "string",
"ObjectPrimaryKey": "string",
"ObjectType": "string",
"Tags": [ ]
}
]

SalesPersons

Supported by: Elite and Essentials

In Elite, a Salesperson is derived from a Sales Rep record configured within System Configurations.
In Essentials, a Salesperson is identified by an employee record with the Salesperson checkbox enabled.

Retrieve a list of SalesPersons

Supported by: Elite and Essentials

Returns an array containing all Salespersons, with support for filtering as indicated below.

Authorizations:

APIKey

Responses

Results returned as shown below.

Response Schema: application/json

Array

ModelType

string

Value: "SalesPerson"

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 upon creation and not updatable.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Number	Salesman.Number
Essentials	Yes	Yes	N/A	N/A

Name

string or null

The display name for this Salesperson record.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Name	Salesman.Name
Essentials	Yes	Yes	Generated from ‘First Name’ and ‘Last Name’ in UI.	N/A

object

An email associated with this record. Expand to see nested fields.

FirstName

string or null

First name of the Salesperson.

Software	Supported	Filterable	UI	DB
Elite	No	–	–-	–-
Essentials	Yes	Yes	First Name	N/A

LastName

string or null

Last name of the Salesperson.

Software	Supported	Filterable	UI	DB
Elite	No	–	–-	–-
Essentials	Yes	Yes	Last Name	N/A

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "SalesPerson",
"Id": "30",
"Name": "Wayne Harris",
"Email": {"Type": "Primary",
"Email": "[email protected]"
}
}

Retrieve a single SalesPerson by Id

Supported by: Elite and Essentials

Retrieve a singles Salesperson by its Id.

Authorizations:

APIKey

path Parameters

SalespersonId

required

string

Example: 142

Provide the unique ID of the SalesPerson you want to retrieve.

Responses

Results returned as shown below.

Response Schema: application/json

ModelType

string

Value: "SalesPerson"

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 upon creation and not updatable.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Number	Salesman.Number
Essentials	Yes	Yes	N/A	N/A

Name

string or null

The display name for this Salesperson record.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Name	Salesman.Name
Essentials	Yes	Yes	Generated from ‘First Name’ and ‘Last Name’ in UI.	N/A

object

An email associated with this record. Expand to see nested fields.

Type

string

Enum: "Primary" "Default"

A general label to help define the type of email being returned. Might provide context about the type of email address provided.

Software	Supported	Filterable	UI	DB	Additional Info
Elite	Yes	No	N/A	N/A	Only value is ‘primary.’
Essentials	Yes	No	N/A	N/A	Only value is ‘default.’

Email

string

Email associated with this record.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Email	Salesman.Email
Essentials	Yes	Yes	Email	N/A

FirstName

string or null

First name of the Salesperson.

Software	Supported	Filterable	UI	DB
Elite	No	–	–-	–-
Essentials	Yes	Yes	First Name	N/A

LastName

string or null

Last name of the Salesperson.

Software	Supported	Filterable	UI	DB
Elite	No	–	–-	–-
Essentials	Yes	Yes	Last Name	N/A

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "SalesPerson",
"Id": "30",
"Name": "Wayne Harris",
"Email": {"Type": "Primary",
"Email": "[email protected]"
}
}

Stock

Create a new Stock record (serialized)

Supported by: Elite

Only serialized stock is supported for POST at this time.

Required fields:

Name
Classification
ProductId
DepotId

Authorizations:

API Key

Request Body schema: application/json
required

Name

string or null

Default: "string"

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

object or null

Default: {}

Identifying items for Stock.

InventoryNumber	string or null A secondary number, possibly a barcode string, associated with an item or specific instance of an item. Elite: This field is not supported.
PartNumber	string or null The part number associated to a specific instance of a part (Sales Only).

Classification

string

Default: "string"

Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepotId

string or null <= 3 characters

Default: "string"

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

IsAsset

boolean or null

Default: false

Item is eligible for depreciation

LoadingRatio

integer or null

Default: 0

A number that represents the ability for a stock item to fit on a vehicle.

Elite: This field is not supported.

Manufacturer

string or null <= 50 characters

Default: "string"

The manufacturer associated with a specific instance of an item.

ModelName

string or null <= 30 characters

Default: "string"

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: "string"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear

string or null

Default: "string"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId

string <= 16 characters

Default: "string"

Id of the Product this Stock belongs to (see Product endpoint).

PurchaseDateTime

string or null <date-time>

Default: "string"

Date stock was purchased.

Elite: On serialized items, it is the date and time the item was purchased. On bulk items, it is the last date and time the items were purchased.

PurchasePrice

number or null

Default: 0

Price stock was purchased.

Elite: On serialized items, it is the purchase price for the item. On bulk items, it is the most recent purchase price of the item.

Quantity

string or null

Default: "string"

Field only required for bulk stock endpoints

SerialNumber

string or null <= 50 characters

Default: "string"

The serial number associated with a specific instance of an item.

object or null

Default: {}

CaseQuantity	number or null Default: "null" The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.
CriticalLevel	number or null Default: "null" When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.
CurrentStoreId	string or null <= 3 characters (Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.
GlNumber	string or null Default: "null" The gl number for the stock item.
RentalCaseQuantity	number or null Default: "null" The amount in a case for a rental.
ReorderMaximum	number or null Default: "null" The maximum for reordering the item.
ReorderMinimum	number or null Default: "null" The minimum for reordering the item.
UserDefined1	string or null <= 50 characters (Elite Only) Free field for customer use
UserDefined2	string or null <= 50 characters (Elite Only) Free field for customer use
TaxCode	number or null The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.
ExternalTaxCode	string or null The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null

Default: {}

Depreciation fields for Stock

DepreciationMethodCode	string or null The Value which defines the method (i.e. Straight-Line, MACRS, etc). Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.
DepreciationYears	integer or null The amount of years for which the stock depreciates.
CurrentValue	number or null The current netbook value of the stock item.
SalvageValue	number or null The Salvageable value in terms of Depreciation.
TotalDepreciation	number or null Default: "null" The total depreciation for the stock item.

object or null

Deprecated

Default: {}

Depreciation fields for Stock

DepreciationMethodCode	string or null The Value which defines the method (i.e. Straight-Line, MACRS, etc). Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.
DepreciationYears	integer or null The amount of years for which the stock depreciates.
CurrentValue	number or null The Current Value in terms of depreciation.
SalvageValue	number or null The Salvageable value in terms of Depreciation.

Responses

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"IsAsset": false,
"LoadingRatio": 0,
"Manufacturer": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"ProductId": "string",
"PurchaseDateTime": "string",
"PurchasePrice": 0,
"Quantity": "string",
"SerialNumber": "string",
"IsPart": false,
"AdditionalFields": { },
"Depreciation": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"DepreciationFields": { },
"Alias": "string",
"Barcode": "string"
}

Response samples

201

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"IsAsset": false,
"IsBulk": false,
"IsSerialized": false,
"IsCustomerWorkOrderItem": false,
"IsGenericWorkOrderItem": false,
"IsPart": false,
"LoadingRatio": 0,
"Manufacturer": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"ProductId": "string",
"PurchaseDateTime": "string",
"PurchasePrice": 0,
"Quantity": 0,
"SerialNumber": "string",
"Status": "string",
"AdditionalFields": { },
"Depreciation": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"DepreciationFields": { },
"Alias": "string",
"Barcode": "string"
}

Retrieve a list of Stock records

Supported by: Elite, Syrinx

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" Value: "Stock" Standard field that denotes the record type. Useful for bulk ingesting different record types.
Id	string Default: "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 Default: "string" A display name for this record. Often used as a summary for lookups.
	object or null Default: {} Identifying items for Stock.
CategoryIds	Array of strings Default: [] Reference a CategoryId. Elite: This will only have a single element.
CategoryName	string or null Default: "string" Denormalized name of the Category.
Classification	string Default: "string" Enum: "Internal" "Rental" "Sale" This Product is either meant for sale, rental or internal.
DepotId	string or null Default: "string" Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)
IsAsset	boolean or null Default: false Item is eligible for depreciation
IsBulk	boolean or null Default: false 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: false 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: false Item is eligible for creating customer work orders
IsGenericWorkOrderItem	boolean or null Default: false Item is eligible for creating work orders
IsPart	boolean or null Default: false Used to determine if stock item is a part (Sales Only).
LoadingRatio	integer or null Default: 0 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: "string" The manufacturer associated with a specific instance of an item.
ModelName	string or null Default: "string" 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: "string" OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.
ModelYear	string or null Default: "string" OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.
ProductId	string or null Default: "string" Id of the Product this Stock belongs to (see Product endpoint).
Quantity	number or null Default: 0 The total amount of a particular Stock owned. Only used for bulk Stock records.
SerialNumber	string or null Default: "string" The serial number associated with a specific instance of an item.
Status	string or null Default: "string" Enum: "NotReady" "NoStock" "Unavailable" "Available" "OnRent" "OffRent" "Transfer" "Repair" "Maintenance" "ServiceOrder" "Reserved" Status of an item. Because this is a computed property, GAPI CAN NOT SORT OR FILTER BY THIS FIELD. For elite, see https://wiki.pointofrental.com/en/Departments/Engineering/Elite-&-Expert/Applications/Elite---Browser/Items---Item-File/ItemStatusDescription NotReady: State from Ready API. Not available in Syrinx yet NoStock: Not available in Essentials or Syrinx. Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A. Available: Essentials: Item is in Stock. Syrinx: Item is available. OnRent: Essentials: Is on contract in order status. Syrinx: N/A OffRent: Not available in Essentials or Syrinx. Transfer: Not available in Essentials or Syrinx. Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair ServiceOrder: Essentials: In maintenance of type service call. Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A
	object or null Default: {}
	object or null Default: {} Depreciation fields for Stock
CreatedDateTime	string or null <date-time> Default: "string" When was the record created? All date times are expected to be in UTC & ISO-8601 format.
UpdatedDateTime	string or null <date-time> Default: "string" When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.
Hidden	integer Default: 0 Enum: null 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 Default: {} Depreciation fields for Stock
Alias	string or null Deprecated Default: "string" Deprecated: Use Identifiers.Alias (Elite Only) Lookup field in Elite.
Barcode	string or null Deprecated Default: "string" Deprecated: Use Identifiers.Barcode (Elite Only) Barcode field in Elite.

Response samples

200

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"IsAsset": false,
"IsBulk": false,
"IsSerialized": false,
"IsCustomerWorkOrderItem": false,
"IsGenericWorkOrderItem": false,
"IsPart": false,
"LoadingRatio": 0,
"Manufacturer": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"ProductId": "string",
"PurchaseDateTime": "string",
"PurchasePrice": 0,
"Quantity": 0,
"SerialNumber": "string",
"Status": "string",
"AdditionalFields": { },
"Depreciation": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"DepreciationFields": { },
"Alias": "string",
"Barcode": "string"
}
]

Update an existing Stock record

Supported by: Elite

Authorizations:

API Key

path Parameters

StockId

required

string

Request Body schema: application/json
required

SerialNumber

string or null

Default: "null"

The serial number of the stock item.

object or null

Default: {}

Identifying items for Stock.

object

Default: {}

TotalDepreciation	number or null Default: "null" The total depreciation for the stock item.
CurrentValue	number or null Default: "null" The current netbook value of the stock item.

object

Default: {}

CaseQuantity	number or null Default: "null" The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.
CriticalLevel	number or null Default: "null" When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.
GlNumber	string or null Default: "null" The gl number for the stock item.
RentalCaseQuantity	number or null Default: "null" The amount in a case for a rental.
ReorderMaximum	number or null Default: "null" The maximum for reordering the item.
ReorderMinimum	number or null Default: "null" The minimum for reordering the item.
TaxCode	number or null The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.
ExternalTaxCode	string or null The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Stock"

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

Id

string

Default: "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

Default: "string"

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

object or null

Default: {}

Identifying items for Stock.

Alias	string or null (Elite Only) Lookup field in Elite.
Barcode	string or null (Elite Only) Barcode field in Elite.
InventoryNumber	string or null A secondary number, possibly a barcode string, associated with an item or specific instance of an item. Elite: This field is not supported.
Key	string or null (Elite Only) A "human readable" form of id.
PartNumber	string or null The part number associated to a specific instance of a part (Sales Only).

CategoryIds

Array of strings

Default: []

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName

string or null

Default: "string"

Denormalized name of the Category.

Classification

string

Default: "string"

Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepotId

string or null

Default: "string"

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

IsAsset

boolean or null

Default: false

Item is eligible for depreciation

IsBulk

boolean or null

Default: false

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

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

Item is eligible for creating customer work orders

IsGenericWorkOrderItem

boolean or null

Default: false

Item is eligible for creating work orders

IsPart

boolean or null

Default: false

Used to determine if stock item is a part (Sales Only).

LoadingRatio

integer or null

Default: 0

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: "string"

The manufacturer associated with a specific instance of an item.

ModelName

string or null

Default: "string"

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: "string"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear

string or null

Default: "string"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId

string or null

Default: "string"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity

number or null

Default: 0

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber

string or null

Default: "string"

The serial number associated with a specific instance of an item.

Status

string or null

Default: "string"

Enum: "NotReady" "NoStock" "Unavailable" "Available" "OnRent" "OffRent" "Transfer" "Repair" "Maintenance" "ServiceOrder" "Reserved"

Status of an item. Because this is a computed property, GAPI CAN NOT SORT OR FILTER BY THIS FIELD. For elite, see https://wiki.pointofrental.com/en/Departments/Engineering/Elite-&-Expert/Applications/Elite---Browser/Items---Item-File/ItemStatusDescription

NotReady: State from Ready API. Not available in Syrinx yet
NoStock: Not available in Essentials or Syrinx.
Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A.
Available: Essentials: Item is in Stock. Syrinx: Item is available.
OnRent: Essentials: Is on contract in order status. Syrinx: N/A
OffRent: Not available in Essentials or Syrinx.
Transfer: Not available in Essentials or Syrinx.
Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair
Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair
ServiceOrder: Essentials: In maintenance of type service call.
Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A

object or null

Default: {}

CaseQuantity	number or null Default: "null" The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.
CriticalLevel	number or null Default: "null" When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.
CurrentStoreId	string or null (Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.
GlNumber	string or null Default: "null" The gl number for the stock item.
InternalClassificationType	string or null Enum: "Non-rental Asset" "Work Order item" (Elite Only) If the classification field is set as "Internal" this further specifies the type. If this is not set, this defaults to "null".
ReadyStatus	string or null <= 255 characters Enum: "Ready" "NotReady" "NotSet" (Elite Only): The ready status of the item. Describes whether the item is Ready, Not Ready, or has not yet been evaluated as being ready or not ready.
ReadyStatusChangeDateTime	string or null <date-time> (Elite Only): The date-time in which the ready status changed. May not be a future date/time. Should only be provided if entering historical records. Passing null will cause this field to default to the current date/time.
RentalCaseQuantity	number or null Default: "null" The amount in a case for a rental.
RentalType	string or null Enum: "Rental - Accessory" "Rental - Coupon" "Rental - Dynamic Qty" "Rental - Hour meter" "Rental - Miscellaneous" "Rental - No sale" "Rental - Normal" "Rental - Package" "Rental - Usage item" (Elite Only) If the classification field is set as "Rental" this further specifies the type. If this is not set, this defaults to "null"
ReorderMaximum	number or null Default: "null" The maximum for reordering the item.
ReorderMinimum	number or null Default: "null" The minimum for reordering the item.
SalesType	string or null Enum: "Sales - Fractional Qty" "Sales - Labor item" "Sales - Miscellaneous" "Sales - Normal" "Sales - Percent of Rental" (Elite Only) If the classification field is set as "Sales" this further specifies the type. If this is not set, this defaults to "null"
UserDefined1	string or null (Elite Only) Free field for customer use
UserDefined2	string or null (Elite Only) Free field for customer use
TaxCode	number or null The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.
ExternalTaxCode	string or null The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null

Default: {}

Depreciation fields for Stock

DepreciationMethodCode	string or null The Value which defines the method (i.e. Straight-Line, MACRS, etc). Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.
CurrentValue	number or null The current netbook value of the stock item.
SalvageValue	number or null The Salvageable value in terms of Depreciation.
TotalDepreciation	number or null Default: "null" The total depreciation for the stock item.

CreatedDateTime

string or null <date-time>

Default: "string"

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

UpdatedDateTime

string or null <date-time>

Default: "string"

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

Hidden

integer

Default: 0

Enum: null 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

Default: {}

Depreciation fields for Stock

DepreciationMethodCode	string or null The Value which defines the method (i.e. Straight-Line, MACRS, etc). Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.
CurrentValue	number or null The Current Value in terms of depreciation.
SalvageValue	number or null The Salvageable value in terms of Depreciation.

Alias

string or null

Deprecated

Default: "string"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode

string or null

Deprecated

Default: "string"

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Request samples

Payload

Content type

application/json

{"SerialNumber": "SN123456789",
"Depreciation": {"TotalDepreciation": 10.5,
"CurrentValue": 120.5
},
"AdditionalFields": {"CaseQuantity": 45,
"CriticalLevel": 5,
"GlNumber": "123456",
"RentalCaseQuantity": 35,
"ReorderMaximum": 450,
"ReorderMinimum": 45
}
}

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"IsAsset": false,
"IsBulk": false,
"IsSerialized": false,
"IsCustomerWorkOrderItem": false,
"IsGenericWorkOrderItem": false,
"IsPart": false,
"LoadingRatio": 0,
"Manufacturer": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"ProductId": "string",
"PurchaseDateTime": "string",
"PurchasePrice": 0,
"Quantity": 0,
"SerialNumber": "string",
"Status": "string",
"AdditionalFields": { },
"Depreciation": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"DepreciationFields": { },
"Alias": "string",
"Barcode": "string"
}

Retrieve a single Stock record by Id

Supported by: Elite, Syrinx

Authorizations:

API Key

path Parameters

StockId

required

string

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Stock"

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

Id

string

Default: "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

Default: "string"

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

object or null

Default: {}

Identifying items for Stock.

Alias	string or null (Elite Only) Lookup field in Elite.
Barcode	string or null (Elite Only) Barcode field in Elite.
InventoryNumber	string or null A secondary number, possibly a barcode string, associated with an item or specific instance of an item. Elite: This field is not supported.
Key	string or null (Elite Only) A "human readable" form of id.
PartNumber	string or null The part number associated to a specific instance of a part (Sales Only).

CategoryIds

Array of strings

Default: []

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName

string or null

Default: "string"

Denormalized name of the Category.

Classification

string

Default: "string"

Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepotId

string or null

Default: "string"

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

IsAsset

boolean or null

Default: false

Item is eligible for depreciation

IsBulk

boolean or null

Default: false

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

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

Item is eligible for creating customer work orders

IsGenericWorkOrderItem

boolean or null

Default: false

Item is eligible for creating work orders

IsPart

boolean or null

Default: false

Used to determine if stock item is a part (Sales Only).

LoadingRatio

integer or null

Default: 0

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: "string"

The manufacturer associated with a specific instance of an item.

ModelName

string or null

Default: "string"

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: "string"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear

string or null

Default: "string"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId

string or null

Default: "string"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity

number or null

Default: 0

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber

string or null

Default: "string"

The serial number associated with a specific instance of an item.

Status

string or null

Default: "string"

Enum: "NotReady" "NoStock" "Unavailable" "Available" "OnRent" "OffRent" "Transfer" "Repair" "Maintenance" "ServiceOrder" "Reserved"

Status of an item. Because this is a computed property, GAPI CAN NOT SORT OR FILTER BY THIS FIELD. For elite, see https://wiki.pointofrental.com/en/Departments/Engineering/Elite-&-Expert/Applications/Elite---Browser/Items---Item-File/ItemStatusDescription

NotReady: State from Ready API. Not available in Syrinx yet
NoStock: Not available in Essentials or Syrinx.
Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A.
Available: Essentials: Item is in Stock. Syrinx: Item is available.
OnRent: Essentials: Is on contract in order status. Syrinx: N/A
OffRent: Not available in Essentials or Syrinx.
Transfer: Not available in Essentials or Syrinx.
Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair
Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair
ServiceOrder: Essentials: In maintenance of type service call.
Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A

object or null

Default: {}

CaseQuantity	number or null Default: "null" The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.
CriticalLevel	number or null Default: "null" When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.
CurrentStoreId	string or null (Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.
GlNumber	string or null Default: "null" The gl number for the stock item.
InternalClassificationType	string or null Enum: "Non-rental Asset" "Work Order item" (Elite Only) If the classification field is set as "Internal" this further specifies the type. If this is not set, this defaults to "null".
ReadyStatus	string or null <= 255 characters Enum: "Ready" "NotReady" "NotSet" (Elite Only): The ready status of the item. Describes whether the item is Ready, Not Ready, or has not yet been evaluated as being ready or not ready.
ReadyStatusChangeDateTime	string or null <date-time> (Elite Only): The date-time in which the ready status changed. May not be a future date/time. Should only be provided if entering historical records. Passing null will cause this field to default to the current date/time.
RentalCaseQuantity	number or null Default: "null" The amount in a case for a rental.
RentalType	string or null Enum: "Rental - Accessory" "Rental - Coupon" "Rental - Dynamic Qty" "Rental - Hour meter" "Rental - Miscellaneous" "Rental - No sale" "Rental - Normal" "Rental - Package" "Rental - Usage item" (Elite Only) If the classification field is set as "Rental" this further specifies the type. If this is not set, this defaults to "null"
ReorderMaximum	number or null Default: "null" The maximum for reordering the item.
ReorderMinimum	number or null Default: "null" The minimum for reordering the item.
SalesType	string or null Enum: "Sales - Fractional Qty" "Sales - Labor item" "Sales - Miscellaneous" "Sales - Normal" "Sales - Percent of Rental" (Elite Only) If the classification field is set as "Sales" this further specifies the type. If this is not set, this defaults to "null"
UserDefined1	string or null (Elite Only) Free field for customer use
UserDefined2	string or null (Elite Only) Free field for customer use
TaxCode	number or null The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.
ExternalTaxCode	string or null The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null

Default: {}

Depreciation fields for Stock

DepreciationMethodCode	string or null The Value which defines the method (i.e. Straight-Line, MACRS, etc). Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.
CurrentValue	number or null The current netbook value of the stock item.
SalvageValue	number or null The Salvageable value in terms of Depreciation.
TotalDepreciation	number or null Default: "null" The total depreciation for the stock item.

CreatedDateTime

string or null <date-time>

Default: "string"

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

UpdatedDateTime

string or null <date-time>

Default: "string"

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

Hidden

integer

Default: 0

Enum: null 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

Default: {}

Depreciation fields for Stock

DepreciationMethodCode	string or null The Value which defines the method (i.e. Straight-Line, MACRS, etc). Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.
CurrentValue	number or null The Current Value in terms of depreciation.
SalvageValue	number or null The Salvageable value in terms of Depreciation.

Alias

string or null

Deprecated

Default: "string"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode

string or null

Deprecated

Default: "string"

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"IsAsset": false,
"IsBulk": false,
"IsSerialized": false,
"IsCustomerWorkOrderItem": false,
"IsGenericWorkOrderItem": false,
"IsPart": false,
"LoadingRatio": 0,
"Manufacturer": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"ProductId": "string",
"PurchaseDateTime": "string",
"PurchasePrice": 0,
"Quantity": 0,
"SerialNumber": "string",
"Status": "string",
"AdditionalFields": { },
"Depreciation": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"DepreciationFields": { },
"Alias": "string",
"Barcode": "string"
}

Retrieve realtime Availability for a single Stock record by Id

Supported by: Elite, Syrinx

Authorizations:

API Key

path Parameters

StockId

required

string

Responses

Response Schema: application/json

ModelType

string

Default: "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

Default: "string"

Cannot be used for patching or lookups

Name

string or null

Default: "string"

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

object or null

Default: {}

Identifying items for Stock Availability.

Key	string or null (Elite Only) A "human readable" form of id.

StockId

string

Default: "string"

Id of stock

StockName

string

Default: "string"

Name of stock

SerialNumber

string or null

Default: "string"

The serial number associated with a specific instance of an item.

DepotId

string

Default: "string"

The company id, store id, or depot id depending on which system you are using.

StartDateTime

string <date-time>

Default: "string"

Start date of availability

EndDateTime

string <date-time>

Default: "string"

End date of availability

AvailableQuantity

number

Default: 0

The current quantity available for rent or sale.

ExpectedQuantity

number

Default: 0

The quantity expected to be on premise. This is how many you would expect to find when doing an inventory count. This includes available and unavailable inventory.

TotalQuantity

number

Default: 0

Total quantity owned regardless of availability.

QtyExpected

number

Deprecated

Default: 0

Expected quantity

Deprecated: Please use ExpectedQuantity instead.

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"StockId": "string",
"StockName": "string",
"SerialNumber": "string",
"DepotId": "string",
"StartDateTime": "string",
"EndDateTime": "string",
"AvailableQuantity": 0,
"ExpectedQuantity": 0,
"TotalQuantity": 0,
"QtyExpected": 0
}

Retrieve files for a single Stock by Id.

Supported by: Elite

Authorizations:

API Key

path Parameters

StockId required	string
tagKey required	string `pdfs` or `instructions` or `photos`

Responses

Response Schema: application/json

Array

FileName	string Default: "string" Original local filename.
FileClass	string Default: "string" Enum: "misc" "image" "video" Defines the type of stored file.
PublicURL	string Default: "string" Web URL where the stored file can be downloaded.
URLDateTime	string <date-time> Default: "string" The date/time the URL was retrieved/created.
URLExpires	integer Default: 0 Number of seconds from URLDateTime until URL expires.
TagMapKey	string Default: "string" Enum: "pdfs" "instructions" "photos" Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).
ObjectPrimaryKey	string Default: "string" Primary key of the object this file is associated with (same as in the URL for single object get).
ObjectType	string Default: "string" Type of object: One of Products, stock, or contract.
Tags	Array of strings Default: [] List of all the tag names associated with each file (ONLY the TagName).

Response samples

200

Content type

application/json

[{"FileName": "string",
"FileClass": "string",
"PublicURL": "string",
"URLDateTime": "string",
"URLExpires": 0,
"TagMapKey": "string",
"ObjectPrimaryKey": "string",
"ObjectType": "string",
"Tags": [ ]
}
]

Adjust a single bulk Stock record

Supported by: Elite

Add or remove quantity of bulk Stock records. Quantity IS modifiable here, whereas it is not modifiable on the PATCH /apikey/stock/{StockId} endpoint.

Authorizations:

API Key

path Parameters

StockId

required

string

Request Body schema: application/json
required

QuantityAdjustment required	number Default: 0 How much stock are you adding?
StockId	string Default: "string" Which Stock record are you adjusting
AdjustmentReason	string or null Default: "string" Short note about why the Stock record is being modified
DepotId	string or null Default: "string" Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the Stock. (See Depot endpoints)
ProductId	string or null Default: "string" Product Id of the Stock record being modified.
PurchaseDateTime	string or null <date-time> Default: "string" Date the Stock was purchased.
PurchasePrice	number or null Default: 0 Price for which the Stock was purchased.

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Stock"

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

Id

string

Default: "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

Default: "string"

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

object or null

Default: {}

Identifying items for Stock.

Alias	string or null (Elite Only) Lookup field in Elite.
Barcode	string or null (Elite Only) Barcode field in Elite.
InventoryNumber	string or null A secondary number, possibly a barcode string, associated with an item or specific instance of an item. Elite: This field is not supported.
Key	string or null (Elite Only) A "human readable" form of id.
PartNumber	string or null The part number associated to a specific instance of a part (Sales Only).

CategoryIds

Array of strings

Default: []

Reference a CategoryId.

Elite: This will only have a single element.

CategoryName

string or null

Default: "string"

Denormalized name of the Category.

Classification

string

Default: "string"

Enum: "Internal" "Rental" "Sale"

This Product is either meant for sale, rental or internal.

DepotId

string or null

Default: "string"

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

IsAsset

boolean or null

Default: false

Item is eligible for depreciation

IsBulk

boolean or null

Default: false

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

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

Item is eligible for creating customer work orders

IsGenericWorkOrderItem

boolean or null

Default: false

Item is eligible for creating work orders

IsPart

boolean or null

Default: false

Used to determine if stock item is a part (Sales Only).

LoadingRatio

integer or null

Default: 0

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: "string"

The manufacturer associated with a specific instance of an item.

ModelName

string or null

Default: "string"

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: "string"

OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.

ModelYear

string or null

Default: "string"

OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item.

ProductId

string or null

Default: "string"

Id of the Product this Stock belongs to (see Product endpoint).

Quantity

number or null

Default: 0

The total amount of a particular Stock owned. Only used for bulk Stock records.

SerialNumber

string or null

Default: "string"

The serial number associated with a specific instance of an item.

Status

string or null

Default: "string"

Enum: "NotReady" "NoStock" "Unavailable" "Available" "OnRent" "OffRent" "Transfer" "Repair" "Maintenance" "ServiceOrder" "Reserved"

Status of an item. Because this is a computed property, GAPI CAN NOT SORT OR FILTER BY THIS FIELD. For elite, see https://wiki.pointofrental.com/en/Departments/Engineering/Elite-&-Expert/Applications/Elite---Browser/Items---Item-File/ItemStatusDescription

NotReady: State from Ready API. Not available in Syrinx yet
NoStock: Not available in Essentials or Syrinx.
Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A.
Available: Essentials: Item is in Stock. Syrinx: Item is available.
OnRent: Essentials: Is on contract in order status. Syrinx: N/A
OffRent: Not available in Essentials or Syrinx.
Transfer: Not available in Essentials or Syrinx.
Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair
Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair
ServiceOrder: Essentials: In maintenance of type service call.
Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A

object or null

Default: {}

CaseQuantity	number or null Default: "null" The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.
CriticalLevel	number or null Default: "null" When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.
CurrentStoreId	string or null (Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.
GlNumber	string or null Default: "null" The gl number for the stock item.
InternalClassificationType	string or null Enum: "Non-rental Asset" "Work Order item" (Elite Only) If the classification field is set as "Internal" this further specifies the type. If this is not set, this defaults to "null".
ReadyStatus	string or null <= 255 characters Enum: "Ready" "NotReady" "NotSet" (Elite Only): The ready status of the item. Describes whether the item is Ready, Not Ready, or has not yet been evaluated as being ready or not ready.
ReadyStatusChangeDateTime	string or null <date-time> (Elite Only): The date-time in which the ready status changed. May not be a future date/time. Should only be provided if entering historical records. Passing null will cause this field to default to the current date/time.
RentalCaseQuantity	number or null Default: "null" The amount in a case for a rental.
RentalType	string or null Enum: "Rental - Accessory" "Rental - Coupon" "Rental - Dynamic Qty" "Rental - Hour meter" "Rental - Miscellaneous" "Rental - No sale" "Rental - Normal" "Rental - Package" "Rental - Usage item" (Elite Only) If the classification field is set as "Rental" this further specifies the type. If this is not set, this defaults to "null"
ReorderMaximum	number or null Default: "null" The maximum for reordering the item.
ReorderMinimum	number or null Default: "null" The minimum for reordering the item.
SalesType	string or null Enum: "Sales - Fractional Qty" "Sales - Labor item" "Sales - Miscellaneous" "Sales - Normal" "Sales - Percent of Rental" (Elite Only) If the classification field is set as "Sales" this further specifies the type. If this is not set, this defaults to "null"
UserDefined1	string or null (Elite Only) Free field for customer use
UserDefined2	string or null (Elite Only) Free field for customer use
TaxCode	number or null The tax code for the item. POST and Get only. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.
ExternalTaxCode	string or null The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.

object or null

Default: {}

Depreciation fields for Stock

DepreciationMethodCode	string or null The Value which defines the method (i.e. Straight-Line, MACRS, etc). Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.
CurrentValue	number or null The current netbook value of the stock item.
SalvageValue	number or null The Salvageable value in terms of Depreciation.
TotalDepreciation	number or null Default: "null" The total depreciation for the stock item.

CreatedDateTime

string or null <date-time>

Default: "string"

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

UpdatedDateTime

string or null <date-time>

Default: "string"

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

Hidden

integer

Default: 0

Enum: null 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

Default: {}

Depreciation fields for Stock

DepreciationMethodCode	string or null The Value which defines the method (i.e. Straight-Line, MACRS, etc). Coming soon: You can hit the /stock/lookup/{Field} endpoint and pass in the query parameter "Field" --> "DepreciationMethodCode" to receive a list of acceptable values for this field.
CurrentValue	number or null The Current Value in terms of depreciation.
SalvageValue	number or null The Salvageable value in terms of Depreciation.

Alias

string or null

Deprecated

Default: "string"

Deprecated: Use Identifiers.Alias

(Elite Only) Lookup field in Elite.

Barcode

string or null

Deprecated

Default: "string"

Deprecated: Use Identifiers.Barcode

(Elite Only) Barcode field in Elite.

Request samples

Payload

Content type

application/json

{"StockId": "string",
"QuantityAdjustment": 0,
"AdjustmentReason": "string",
"DepotId": "string",
"ProductId": "string",
"PurchaseDateTime": "string",
"PurchasePrice": 0
}

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"CategoryIds": [ ],
"CategoryName": "string",
"Classification": "string",
"DepotId": "string",
"IsAsset": false,
"IsBulk": false,
"IsSerialized": false,
"IsCustomerWorkOrderItem": false,
"IsGenericWorkOrderItem": false,
"IsPart": false,
"LoadingRatio": 0,
"Manufacturer": "string",
"ModelName": "string",
"ModelNumber": "string",
"ModelYear": "string",
"ProductId": "string",
"PurchaseDateTime": "string",
"PurchasePrice": 0,
"Quantity": 0,
"SerialNumber": "string",
"Status": "string",
"AdditionalFields": { },
"Depreciation": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0,
"DepreciationFields": { },
"Alias": "string",
"Barcode": "string"
}

Retrieve work orders for a Stock record by Id

Gets all the work orders for a stock item

Authorizations:

API Key

path Parameters

StockId

required

string

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Standard field that denotes the record type.

Id

string

Default: "string"

The unique identifier for this record.

Name

string

Default: "string"

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

StockId

string or null

Default: "string"

StockName

string or null

Default: "string"

DepotId

string or null

Default: "string"

OpenDateTime

string or null <date-time>

Default: "string"

CloseDateTime

string or null <date-time>

Default: "string"

CustomerId

string or null

Default: "string"

Reference a CustomerId that should be responsible for this Work Order.

Status

string

Default: "string"

Enum: "Quote" "Open" "Closed"

Type

string or null

Default: "string"

SubType

string or null

Default: "string"

Array of objects or strings or null

Default: []

Array

One of

Classification	string or null Enum: "Rental" "Sale" null This product is either meant for sale or rental. The internal classification does not apply to lineitems.
Name	string The display name for this record. This is often used as a summary for lookups.
IsBulk	boolean or null Items with this field do not have unique serial numbers. If isSerialized and isBulk are both true, then an alternate serialization method is being used.
IsSerialized	boolean or null Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.
ProductId	string or null If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". (This field is still a work in progress. Use with caution.)
PullFromStock	boolean or null Indicates if the items should be pulled from stock when added to a work order.
PurchasePrice	number or null The purchase price of the part.
Quantity	string or null The quantity of this part on the work order
SerialNumber	string or null The serial number or unique identifier assigned to this particular Line Item.
Status	string or null Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold" The displayable status of a lineitem. Sales lineitems might say "sold". Rental items might say "reserved". Reserved Out Off Rent Returned Sold
StockId	string or null Id of stock
Comments	string Any comments for this part.

IsCustomerWO

boolean

Default: false

Flag to telling whether the WO is consumer facing or not.

object or null

Default: {}

Labor tracking details.

LaborTypes

any or null

Complaint

string

Default: "string"

The issue detected by the technician.

Cause

string

Default: "string"

The cause of the issue, to be updated if needed.

Correction

string

Default: "string"

The steps taken to correct the issue.

ReportedIssue

string

Default: "string"

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

OtherComments

string

Default: "string"

Any additional comments for this work order.

Operation

string

Default: "string"

The operation that needs to be performed.

DueDateTime

string <date-time>

Default: "string"

The due date for this work order.

AdditionalFields

object or null

Default: {}

Additional fields for this record.

CreatedDateTime

string or null <date-time>

Default: "string"

UTC when the record was created.

UpdatedDateTime

string or null <date-time>

Default: "string"

UTC when the record was updated.

Hidden

integer or null

Default: 0

Enum: null 1

Hidden

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"StockId": "string",
"StockName": "string",
"DepotId": "string",
"OpenDateTime": "string",
"CloseDateTime": "string",
"CustomerId": "string",
"Status": "string",
"Type": "string",
"SubType": "string",
"Parts": [ ],
"IsCustomerWO": false,
"LaborTracking": { },
"Complaint": "string",
"Cause": "string",
"Correction": "string",
"ReportedIssue": "string",
"OtherComments": "string",
"Operation": "string",
"DueDateTime": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Vendors

Create a new Vendor

Supported by: Elite

Required fields:

Name

Authorizations:

API Key

Request Body schema: application/json
required

Name

string or null [ 1 .. 50 ] characters

Default: "string"

The full name of the vendor. Could be a company or an individual.

object or null

Default: {}

Identifying items for Vendor.

We currently only support

AccountNumber

AccountNumber	string or null <= 50 characters Vendor Account Number.
ExternalVendorId	string or null <= 100 characters External identification related to the vendor. Elite: 2021.16.0+

Array of objects

Default: []

Supported types will depend on the product.

Elite:

Supported: "Default"
Coming soon: "Billing", "Shipping" .

Array

Type required	string Default: "Default" Value: "Default" Type of address "Default", "Billing", etc. Supported types depend on the context of the address. For Vendor, this is only "Default".
Name	string or null Optional name for Address
Line1	string or null <= 50 characters Address Number and Street.
Line2	string or null <= 50 characters May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null >= 2 characters Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode	string or null <= 10 characters May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

Default: []

Name and Types of Contacts related to the Vendor.

Array

Type required	string Default: "Default" Enum: "Default" "Secondary" Relationship of the contact to the vendor.
required	object

CurrencyCode

string or null

Default: "USD"

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

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

Inactive

boolean or null

Default: false

Used to denote whether a vendor is considered active.

Array of objects

Default: []

Any comments or notes.

Array

Value

required

string or null

The note text.

Array of objects

Default: []

Array

Type required	string Default: "Default" Enum: "Default" "Mobile" "Secondary" Supported phone types. "Default" is the default phone number for the contact. Elite: Only supports "Default".
Number required	string or null <= 50 characters A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported

Terms

string or null <= 50 characters

Default: "string"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null

Default: {}

Additional fields specific to each vendor.

PaymentMethod	string or null (Elite Only) Payment methods for this vendor. Coming soon: You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "PaymentMethod" to receive a list of acceptable values for this field. Elite: 2021.16.0+ Syrinx: Not supported.
TermDays	integer or null <= 2147483647 (Elite Only) Billing term days for the vendor. Elite: 2021.16.0+ Syrinx: Not supported.

Responses

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"Contacts": [ ],
"CurrencyCode": "string",
"Inactive": false,
"Notes": [ ],
"Phones": [ ],
"Terms": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Response samples

201

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"Contacts": [ ],
"CurrencyCode": "string",
"Inactive": false,
"Notes": [ ],
"Phones": [ ],
"Terms": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Retrieve a list of Vendors

Supported by: Elite, Syrinx

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" Value: "Vendor" Standard field that denotes the record type. Useful for bulk ingesting different record types.
Id	string Default: "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 Default: "string" The full name of the vendor. Could be a company or an individual.
	object or null Default: {} Identifying items for Vendor. We currently only support AccountNumber
	Array of objects Default: [] Supported types will depend on the product. Elite: Supported: "Default" Coming soon: "Billing", "Shipping"
	Array of objects Default: [] Name and Types of Contacts related to the Vendor.
CurrencyCode	string or null Default: "USD" Defaults to "USD". Code is ISO 4217 format. You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field.
Inactive	boolean or null Default: false Used to denote whether a vendor is considered active.
	Array of objects Default: [] Any comments or notes.
	Array of objects Default: []
Terms	string or null Default: "string" Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)
	object or null Default: {} Additional fields specific to each vendor.
CreatedDateTime	string or null <date-time> Default: "string" 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: "string" When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. Elite: This field is not supported.
Hidden	integer Default: 0 Enum: null 1 0 = false, 1 = true \| This basically means Deleted

Response samples

200

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"Contacts": [ ],
"CurrencyCode": "string",
"Inactive": false,
"Notes": [ ],
"Phones": [ ],
"Terms": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}
]

Retrieve a single Vendor by Id

Supported by: Elite, Syrinx

Authorizations:

API Key

path Parameters

VendorId

required

string

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Vendor"

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

Id

string

Default: "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

Default: "string"

The full name of the vendor. Could be a company or an individual.

object or null

Default: {}

Identifying items for Vendor.

We currently only support

AccountNumber

AccountNumber	string or null Vendor Account Number.
ExternalVendorId	string or null External identification related to the vendor. Elite: 2021.16.0+

Array of objects

Default: []

Supported types will depend on the product.

Elite:

Supported: "Default"
Coming soon: "Billing", "Shipping"

Array

Type required	string Default: "Default" Value: "Default" Type of address "Default", "Billing", etc. Supported types depend on the context of the address. For Vendor, this is only "Default".
Name	string or null Optional name for Address
Line1	string or null Address Number and Street.
Line2	string or null May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode	string or null May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

Default: []

Name and Types of Contacts related to the Vendor.

Array

Type required	string Default: "Default" Enum: "Default" "Secondary" Relationship of the contact to the vendor.
required	object

CurrencyCode

string or null

Default: "USD"

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

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

Inactive

boolean or null

Default: false

Used to denote whether a vendor is considered active.

Array of objects

Default: []

Any comments or notes.

Array

Type required	string Default: "Default" Value: "Default" Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type. Elite: There will only be one type of note, "Default".
Value required	string or null The note text.

Array of objects

Default: []

Array

Type required	string Default: "Default" Enum: "Default" "Mobile" "Secondary" Supported phone types. "Default" is the default phone number for the contact. Elite: Only supports "Default".
Number required	string or null A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported
NumberE164	string or null A phone number must be supplied and validated according to the E.164 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
Extension	string or null Is there an extension associated with this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
SmsCapable	boolean or null Can an SMS be sent to this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Terms

string or null

Default: "string"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null

Default: {}

Additional fields specific to each vendor.

PaymentMethod	string or null (Elite Only) Payment methods for this vendor. Coming soon: You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "PaymentMethod" to receive a list of acceptable values for this field. Elite: 2021.16.0+ Syrinx: Not supported.
TermDays	integer or null (Elite Only) Billing term days for the vendor. Elite: 2021.16.0+ Syrinx: Not supported.

CreatedDateTime

string or null <date-time>

Default: "string"

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: "string"

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

Elite: This field is not supported.

Hidden

integer

Default: 0

Enum: null 1

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

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"Contacts": [ ],
"CurrencyCode": "string",
"Inactive": false,
"Notes": [ ],
"Phones": [ ],
"Terms": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Update a single Vendor by Id

Supported by: Elite

Required fields:

Id

Authorizations:

API Key

path Parameters

VendorId

required

string

Request Body schema: application/json
required

Name

string or null [ 1 .. 50 ] characters

Default: "string"

The full name of the vendor. Could be a company or an individual.

object or null

Default: {}

Identifying items for Vendor.

We currently only support

AccountNumber

AccountNumber	string or null <= 50 characters Vendor Account Number.
ExternalVendorId	string or null <= 100 characters External identification related to the vendor. Elite: 2021.16.0+

Array of objects

Default: []

Supported types will depend on the product.

Elite:

Supported: "Default"
Coming soon: "Billing", "Shipping" .

Array

Type required	string Default: "Default" Value: "Default" Type of address "Default", "Billing", etc. Supported types depend on the context of the address. For Vendor, this is only "Default".
Name	string or null Optional name for Address
Line1	string or null <= 50 characters Address Number and Street.
Line2	string or null <= 50 characters May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null >= 2 characters Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode	string or null <= 10 characters May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

Default: []

Name and Types of Contacts related to the Vendor.

Array

Type required	string Default: "Default" Enum: "Default" "Secondary" Relationship of the contact to the vendor.
required	object

CurrencyCode

string or null

Default: "USD"

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

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

Inactive

boolean or null

Default: false

Used to denote whether a vendor is considered active.

Array of objects

Default: []

Any comments or notes.

Array

Value

required

string or null

The note text.

Array of objects

Default: []

Array

Type required	string Default: "Default" Enum: "Default" "Mobile" "Secondary" Supported phone types. "Default" is the default phone number for the contact. Elite: Only supports "Default".
Number required	string or null <= 50 characters A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported

Terms

string or null <= 50 characters

Default: "string"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null

Default: {}

Additional fields specific to each vendor.

PaymentMethod	string or null (Elite Only) Payment methods for this vendor. Coming soon: You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "PaymentMethod" to receive a list of acceptable values for this field. Elite: 2021.16.0+ Syrinx: Not supported.
TermDays	integer or null <= 2147483647 (Elite Only) Billing term days for the vendor. Elite: 2021.16.0+ Syrinx: Not supported.

Responses

Response Schema: application/json

ModelType

string

Default: "string"

Value: "Vendor"

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

Id

string

Default: "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

Default: "string"

The full name of the vendor. Could be a company or an individual.

object or null

Default: {}

Identifying items for Vendor.

We currently only support

AccountNumber

AccountNumber	string or null Vendor Account Number.
ExternalVendorId	string or null External identification related to the vendor. Elite: 2021.16.0+

Array of objects

Default: []

Supported types will depend on the product.

Elite:

Supported: "Default"
Coming soon: "Billing", "Shipping"

Array

Type required	string Default: "Default" Value: "Default" Type of address "Default", "Billing", etc. Supported types depend on the context of the address. For Vendor, this is only "Default".
Name	string or null Optional name for Address
Line1	string or null Address Number and Street.
Line2	string or null May be apartment, building, suite.
Line3	string or null May be apartment, building, suite. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
City	string or null Usage Notes MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48.
GeoRegion2	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
GeoRegion3	string or null Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Province	string or null Usage Notes MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.
PostalCode	string or null May be postcode, post code, PIN or ZIP Code depending on the country.
Latitude	string or null Latitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Longitude	string or null Longitude in decimal format. Can enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions. LOC:LAT, LON Loc:XX.123456789,-YY.123456789 Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.
Country	string or null Two letter country code in ISO 3166-1 alpha-2 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Array of objects

Default: []

Name and Types of Contacts related to the Vendor.

Array

Type required	string Default: "Default" Enum: "Default" "Secondary" Relationship of the contact to the vendor.
required	object

CurrencyCode

string or null

Default: "USD"

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

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

Inactive

boolean or null

Default: false

Used to denote whether a vendor is considered active.

Array of objects

Default: []

Any comments or notes.

Array

Type required	string Default: "Default" Value: "Default" Since there can multiple types of notes associated with a record, we need to know which type of note we are referring to. Otherwise, use "Default" as the type. Elite: There will only be one type of note, "Default".
Value required	string or null The note text.

Array of objects

Default: []

Array

Type required	string Default: "Default" Enum: "Default" "Mobile" "Secondary" Supported phone types. "Default" is the default phone number for the contact. Elite: Only supports "Default".
Number required	string or null A phone number without the country code embedded.
RemoteId	string or null Deprecated A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.
CountryCode	string or null Country code prefix. Elite: Currently not supported
NumberE164	string or null A phone number must be supplied and validated according to the E.164 format. Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
Extension	string or null Is there an extension associated with this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.
SmsCapable	boolean or null Can an SMS be sent to this phone number? Elite: This field is not supported and will always return null. There are no plans to support this in Elite.

Terms

string or null

Default: "string"

Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)

object or null

Default: {}

Additional fields specific to each vendor.

PaymentMethod	string or null (Elite Only) Payment methods for this vendor. Coming soon: You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "PaymentMethod" to receive a list of acceptable values for this field. Elite: 2021.16.0+ Syrinx: Not supported.
TermDays	integer or null (Elite Only) Billing term days for the vendor. Elite: 2021.16.0+ Syrinx: Not supported.

CreatedDateTime

string or null <date-time>

Default: "string"

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: "string"

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

Elite: This field is not supported.

Hidden

integer

Default: 0

Enum: null 1

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

Request samples

Payload

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"Contacts": [ ],
"CurrencyCode": "string",
"Inactive": false,
"Notes": [ ],
"Phones": [ ],
"Terms": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Response samples

200

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"Identifiers": { },
"Addresses": [ ],
"Contacts": [ ],
"CurrencyCode": "string",
"Inactive": false,
"Notes": [ ],
"Phones": [ ],
"Terms": "string",
"AdditionalFields": { },
"CreatedDateTime": "string",
"UpdatedDateTime": "string",
"Hidden": 0
}

Enum Lookup for Vendor

Supported by: Elite

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

Authorizations:

API Key

path Parameters

field

required

string

Responses

Response Schema: application/json

Array

ModelType	string Default: "string" Value: "Lookup" This field exists on most endpoints and will generally only have 1 option. However, some endpoints do have the option to specify multiple types so be sure to look at the enum to choose the right value.
Id	string Default: "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 Default: "string" A display name for this record. Often used as a summary for lookups.
Description	string or null Default: "string"
Field	string Default: "string"
Value	string Default: "string"

Response samples

200

Content type

application/json

[{"ModelType": "string",
"Id": "string",
"Name": "string",
"Description": "string",
"Field": "string",
"Value": "string"
}
]

Work Orders

Supported by: Elite and Essentials

The Work Orders endpoint returns information related to the repair and maintenance of stock items for both Elite and Essentials.

In Elite:
- Work Orders are a type of contract. They are used to track the repair of stock items.
- The stock items can be owned by the rental company (internal) or a consumer (external).
- Each Work Order represents only a single item being repaired, which will be on Line One.
- Subsequent lines may represent Parts or Sales items which reflect the cost of the repair. Labor could be included as a Sales item.
- External work orders must include a work-order type item, while internal work orders will contain only non-work-order type items.
- For external Work Orders, the `Customer` will reflect a customer that can be returned from the `Customers` endpoint
- There are three types of internal work orders:
  - IRO (Internal Repair Order): Typically represents stock that is down and can't be rented. Affects availability. Prefixed with "repair".
  - IMO (Internal Maintenance Order): Typically encompasses routine tasks like oil changes or inspections. Does not affect availability. Prefixed with "maint".
  - ISO (Internal Service Order): Typically describes a field repair, where an item is repaired in the field for the customer. Does not affect availability. Prefixed with "service".
- The line items include a duration/period-of-time that the item will be down.
- Multiple IROs can be opened for a single serialized item without negatively impacting availability.
In Essentials:
- The Work Orders endpoint returns maintenance records specifically from the Maintenance page under Inventory.
- For a Maintenance to be included on this endpoint, the following conditions must be met:
  - The Maintenance must be for a Serialized item.
  - Maintenance Type must be set to "Maintenance" (other Maintenance Types, such as Repair or Service Call, will not be returned).
  - Billing Type must be set to Billed (other Billing Types, such as Unbilled or Warranty, will not be returned).
  - The Maintenance must have an associated Billing Transaction.

Create a work order

Supported by: Elite

Creates a new work order in the RMS. Returns a 201 and the complete object upon successful creation.

Authorizations:

APIKey

Request Body schema: application/json
required

CustomerId

required

string or null

Reference a CustomerId that should be responsible for this Work Order.

Validation

Required
Must be the customer ID for a customer that already exists.

DepotId

required

string

This is the store location where the work order is being completed. Must be the ID of a current valid Depot.

Validation

Required
Must be a depot/store ID that already exists.

StockId

required

string

The piece of Stock being worked on.

Validation

Required
Must be a stock ID that already exists.

OpenDateTime

required

string <date-time>

The open date for this work. This date must be prior to the DueDateTime.

Validation

Required
Date/Time must be prior to the DueDateTime.
Format in this ISO-8601 format: YYYY-MM-DDTHH:MM:SSZ

DateTime must be in this specific ISO-8601 format. Here is an example: 2024-09-17T11:15:05Z.

DueDateTime

required

string <date-time>

The due date for this work order. Must be after the open date.

Validation

Required
Date/Time must be after the OpenDateTime.
Format in this ISO-8601 format: YYYY-MM-DDTHH:MM:SSZ

DateTime must be in this specific ISO-8601 format. Here is an example: 2024-09-17T11:15:05Z.

Type

string or null

Field used to specify which type of internal work order this contract represents.

Validation

Conditionally Required
Required when IsCustomerWO is set to false.
Value posted must be a listed value from the enumlookup/workorders/Type lookup.

If IsConsumerWO is set to FALSE, then this field IS REQUIRED.

Cause

string

The cause of the work order.

Validation

Cause, Complaint, Correction, and Other Comments all share the same DB field with a maximum character length of 2^31-1.

Complaint

string

The issue detected by the technician.

Validation

Cause, Complaint, Correction, and Other Comments all share the same DB field with a maximum character length of 2^31-1.

Correction

string

The steps taken to correct the issue.

Validation

Cause, Complaint, Correction, and Other Comments all share the same DB field with a maximum character length of 2^31-1.

Hidden

integer or null

Default: 0

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Validation

Must be one of the listed values.

IsCustomerWO

boolean

Default: false

Work Orders can be either internal or external. This field is TRUE when the Work Order is external/consumer facing. If FALSE, then Type becomes a required field.

Validation

Only inputs accepted: true and false.
Must be set to false if customerid is set to a internal repair customer.

Operation

string

The operation that needs to be performed.

Validation

Maximum length is 2^31-1 characters.

OtherComments

string

Any additional comments for this work order.

Validation

Cause, Complaint, Correction, and Other Comments all share the same DB field with a maximum character length of 2^31-1.

Array of objects or null

For posting a work order, only Parts.Comments may be updated.

To make a request to POST 'Parts' fields other than 'Parts.Comments', please POST a request to the endpoint found here: workOrders/{WorkOrderId}/parts

Array

Comments

string

Any comments related to the Parts on this work order.

Validation

Maximum length is 2^31-1 characters.

Status

string

Default: "Open"

Enum: "Quote" "Open" "Closed"

Represents the status of the work order contract.

Validation

Must be one of the listed values.

Responses

Request samples

Payload

Content type

application/json

{"Status": "Open",
"OpenDateTime": "2019-07-01T20:48:00Z",
"DueDateTime": "2019-07-02T16:59:00Z",
"CustomerId": "51963",
"DepotId": "002",
"StockId": "25266",
"Type": "Internal Repair",
"IsCustomerWO": false
}

Response samples

201
4XX

Content type

application/json

{"ModelType": "WorkOrder",
"Id": "r962692",
"Name": "r962692",
"Complaint": "Inoperable",
"Cause": null,
"Correction": null,
"ReportedIssue": "Broken blade drive belt",
"OtherComments": null,
"Identifiers": { },
"CloseDateTime": "2019-07-02T16:59:00Z",
"CustomerId": "51963",
"DepotId": "002",
"OpenDateTime": "2019-07-01T20:48:00Z",
"DueDateTime": "2019-07-02T16:59:00Z",
"Parts": [ ],
"Status": "Closed",
"StockId": "25266",
"StockName": "SOD CUTTER, 18\"",
"SubType": null,
"Type": "Internal Repair",
"Operation": "Repair complete",
"LaborTracking": {"LaborTypes": [ ]
},
"AdditionalFields": { },
"CreatedDateTime": "2019-07-01T20:50:11.377Z",
"UpdatedDateTime": "2019-07-02T17:00:01.813Z",
"Hidden": 0,
"IsCustomerWO": false,
"AssignedRemoteUserId": null
}

Retrieve a list of Work Orders

Supported by: Elite and Essentials.

Returns an array containing all Work Orders, with support for filtering as indicated below.

Authorizations:

APIKey

Responses

Response Schema: application/json

Array

ModelType

string

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 upon creation and not updatable.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Contract #'	Transactions.CNTR
Essentials	Yes	Yes	N/A	N/A

Name

string

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

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Contract #'	Transactions.CNTR
Essentials	Yes	Yes	N/A	N/A

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

Cause

string

The cause of the issue.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Cause'	Transactions.Notes
Essentials	No	--	--	--

CloseDateTime

string or null <date-time>

A date and time stamp of when the Work Order contract is closed. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.PickupDate OR Transactions.EventEndDate OR TransactionItems.DDT
Essentials	Yes	Yes	Back in Stock	N/A

Complaint

string

The issue detected by the technician.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Complaint'	Transactions.Notes
Essentials	No	--	--	--

Correction

string

The steps taken to correct the issue.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Correction'	Transactions.Notes
Essentials	No	--	--	--

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.CreatedDate
Essentials	Yes	Yes	N/A	N/A

CustomerId

string or null

References a CustomerId that should be responsible for this Work Order.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Customer Number'	CustomerFile.CNUM
Essentials	No	--	--	--

DepotId

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Select Job Site' tab	Transactions.Str
Essentials	Yes	Yes	N/A	N/A

DueDateTime

string <date-time>

The due date for this work order.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → 'Due Date' column	TransactionItems.DueDate
Essentials	No	--	--	--

Hidden

integer or null

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.Archived
Essentials	Yes	No	N/A	N/A

IsCustomerWO

boolean

Flag to telling whether the WO is consumer facing or not.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.ClassId
Essentials	No	--	--	--

object or null

Labor tracking details.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	N/A
Essentials	No, always `null`	--		--

OtherComments

string

Any additional comments for this work order.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Other Comments'	Transactions.Notes
Essentials	No	--	--	--

OpenDateTime

string or null <date-time>

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Enter Date' screen	Transactions.Date
Essentials	Yes	Yes	In Maintenance	N/A

Operation

string

The operation that needs to be performed.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → dropdown on far right	TransactionOperation.OperationName
Essentials	No	--	--	--

Array of objects or strings or null

In Elite, an array of Parts. In Essentials, an array of strings. Expand to see nested fields.

ReportedIssue

string

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Information' tab → 'Contract Info'	--
Essentials	No	--	--	--

StockId

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → Line 1 → 'Numb' column	ItemFile.NUM
Essentials	Yes	Yes	N/A	N/A

Status

string

Enum: "Quote" "Open" "Closed"

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Based on Contract Status	Transactions.Status, Transactions.SecondaryStatus
Essentials	Yes	Yes	Status of attached Billing Transaction	N/A

StockName

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → Line 1 → 'Numb' column	ItemFile.Name
Essentials	Yes	Yes	Maintenance Page Title	N/A

SubType

string or null

Software	Supported	Filterable	UI	DB
Elite	No	--	--	--
Essentials	Yes	Yes	Billing Type	--

Type

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Based on Contract Type Created	TransactionClassification.Name
Essentials	Yes	Yes	Maintenance Type	N/A

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.UpdatedDateTime
Essentials	Yes	Yes	--	N/A

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "WorkOrder",
"Id": "r962692",
"Name": "r962692",
"Complaint": "Inoperable",
"Cause": null,
"Correction": null,
"ReportedIssue": "Broken blade drive belt",
"OtherComments": null,
"Identifiers": { },
"CloseDateTime": "2019-07-02T16:59:00Z",
"CustomerId": "51963",
"DepotId": "002",
"OpenDateTime": "2019-07-01T20:48:00Z",
"DueDateTime": "2019-07-02T16:59:00Z",
"Parts": [ ],
"Status": "Closed",
"StockId": "25266",
"StockName": "SOD CUTTER, 18\"",
"SubType": null,
"Type": "Internal Repair",
"Operation": "Repair complete",
"LaborTracking": {"LaborTypes": [ ]
},
"AdditionalFields": { },
"CreatedDateTime": "2019-07-01T20:50:11.377Z",
"UpdatedDateTime": "2019-07-02T17:00:01.813Z",
"Hidden": 0,
"IsCustomerWO": false,
"AssignedRemoteUserId": null
}

Retrieve a single Work Order by its id

Supported by: Elite and Essentials

Retrieves a single Work Order specified by its ID.

Authorizations:

APIKey

path Parameters

WorkOrderId

required

string

Provide the unique ID of the WorkOrder you want to retrieve.

Responses

Response Schema: application/json

ModelType

string

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 upon creation and not updatable.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Contract #'	Transactions.CNTR
Essentials	Yes	Yes	N/A	N/A

Name

string

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

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Contract #'	Transactions.CNTR
Essentials	Yes	Yes	N/A	N/A

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

Cause

string

The cause of the issue.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Cause'	Transactions.Notes
Essentials	No	--	--	--

CloseDateTime

string or null <date-time>

A date and time stamp of when the Work Order contract is closed. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.PickupDate OR Transactions.EventEndDate OR TransactionItems.DDT
Essentials	Yes	Yes	Back in Stock	N/A

Complaint

string

The issue detected by the technician.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Complaint'	Transactions.Notes
Essentials	No	--	--	--

Correction

string

The steps taken to correct the issue.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Correction'	Transactions.Notes
Essentials	No	--	--	--

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.CreatedDate
Essentials	Yes	Yes	N/A	N/A

CustomerId

string or null

References a CustomerId that should be responsible for this Work Order.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Customer Number'	CustomerFile.CNUM
Essentials	No	--	--	--

DepotId

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Select Job Site' tab	Transactions.Str
Essentials	Yes	Yes	N/A	N/A

DueDateTime

string <date-time>

The due date for this work order.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → 'Due Date' column	TransactionItems.DueDate
Essentials	No	--	--	--

Hidden

integer or null

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.Archived
Essentials	Yes	No	N/A	N/A

IsCustomerWO

boolean

Flag to telling whether the WO is consumer facing or not.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.ClassId
Essentials	No	--	--	--

object or null

Labor tracking details.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	N/A
Essentials	No, always `null`	--		--

Array of objects or null

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	N/A
Essentials	No	--	--	--

OtherComments

string

Any additional comments for this work order.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Other Comments'	Transactions.Notes
Essentials	No	--	--	--

OpenDateTime

string or null <date-time>

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Enter Date' screen	Transactions.Date
Essentials	Yes	Yes	In Maintenance	N/A

Operation

string

The operation that needs to be performed.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → dropdown on far right	TransactionOperation.OperationName
Essentials	No	--	--	--

Array of objects or strings or null

In Elite, an array of Parts. In Essentials, an array of strings. Expand to see nested fields.

Array

One of

Classification

string or null

Enum: null "Rental" "Sale"

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	TransactionItems

Comments

string

Any comments for this part.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Line Item Comments' column	TransactionItems.Comments

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.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.BulkItem

IsSerialized

boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	rule

Name

string

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Name' column	TransactionItems.Description

ProductId

string or null

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.Num

PullFromStock

boolean or null

Indicates if the items should be pulled from stock when added to a work order.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.BulkItem

PurchasePrice

number or null

The purchase price of the part.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Price' column	Transactions.Price

Quantity

string or null

The quantity of this part on the work order.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Qty' column	TransactionItems.QTY

SerialNumber

string or null

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.SerialNumber

Status

string or null

Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.TXTY

StockId

string or null

Id of stock

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Numb' column	TransactionItems.Item

ReportedIssue

string

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Information' tab → 'Contract Info'	--
Essentials	No	--	--	--

StockId

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → Line 1 → 'Numb' column	ItemFile.NUM
Essentials	Yes	Yes	N/A	N/A

Status

string

Enum: "Quote" "Open" "Closed"

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Based on Contract Status	Transactions.Status, Transactions.SecondaryStatus
Essentials	Yes	Yes	Status of attached Billing Transaction	N/A

StockName

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → Line 1 → 'Numb' column	ItemFile.Name
Essentials	Yes	Yes	Maintenance Page Title	N/A

SubType

string or null

Software	Supported	Filterable	UI	DB
Elite	No	--	--	--
Essentials	Yes	Yes	Billing Type	--

Type

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Based on Contract Type Created	TransactionClassification.Name
Essentials	Yes	Yes	Maintenance Type	N/A

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.UpdatedDateTime
Essentials	Yes	Yes	--	N/A

Response samples

200
4XX

Content type

application/json

Example

Elite Example

{"ModelType": "WorkOrder",
"Id": "r962692",
"Name": "r962692",
"Complaint": "Inoperable",
"Cause": null,
"Correction": null,
"ReportedIssue": "Broken blade drive belt",
"OtherComments": null,
"Identifiers": { },
"CloseDateTime": "2019-07-02T16:59:00Z",
"CustomerId": "51963",
"DepotId": "002",
"OpenDateTime": "2019-07-01T20:48:00Z",
"DueDateTime": "2019-07-02T16:59:00Z",
"Parts": [ ],
"Status": "Closed",
"StockId": "25266",
"StockName": "SOD CUTTER, 18\"",
"SubType": null,
"Type": "Internal Repair",
"Operation": "Repair complete",
"LaborTracking": {"LaborTypes": [ ]
},
"AdditionalFields": { },
"CreatedDateTime": "2019-07-01T20:50:11.377Z",
"UpdatedDateTime": "2019-07-02T17:00:01.813Z",
"Hidden": 0,
"IsCustomerWO": false,
"AssignedRemoteUserId": null
}

Update a single work order by its id

Supported by: Elite

Not all fields are updatable. Review information below for support. Returns 200 on success.

Authorizations:

API Key

path Parameters

WorkOrderId

required

string

Provide the unique ID of the WorkOrder you want to retrieve.

Request Body schema: application/json
required

Cause

string

The cause of the work order.

Validation

Cause, Complaint, Correction, and Other Comments all share the same DB field with a maximum character length of 2^31-1.

Complaint

string

The issue detected by the technician.

Validation

Cause, Complaint, Correction, and Other Comments all share the same DB field with a maximum character length of 2^31-1.

Correction

string

The steps taken to correct the issue.

Validation

Cause, Complaint, Correction, and Other Comments all share the same DB field with a maximum character length of 2^31-1.

Operation

string

The operation that needs to be performed.

Validation

Maximum length is 2^31-1 characters.

OtherComments

string

Any additional comments for this work order.

Validation

Cause, Complaint, Correction, and Other Comments all share the same DB field with a maximum character length of 2^31-1.

Array of objects or null

For patching a work order, only Parts.Comments may be updated.

To make a request to POST 'Parts' fields other than 'Parts.Comments', please POST a request to the endpoint found here: workOrders/{WorkOrderId}/parts

Array

Id	string Id of the record. Needed to be able to update comments. Validation Required if updating Parts.Comments
Comments	string Any comments related to the Parts on this work order. Validation Maximum length is 2^31-1 characters.

Responses

Response Schema:
application/json

ModelType

string

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 upon creation and not updatable.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Contract #'	Transactions.CNTR
Essentials	Yes	Yes	N/A	N/A

Name

string

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

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Contract #'	Transactions.CNTR
Essentials	Yes	Yes	N/A	N/A

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

Cause

string

The cause of the issue.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Cause'	Transactions.Notes
Essentials	No	--	--	--

CloseDateTime

string or null <date-time>

A date and time stamp of when the Work Order contract is closed. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.PickupDate OR Transactions.EventEndDate OR TransactionItems.DDT
Essentials	Yes	Yes	Back in Stock	N/A

Complaint

string

The issue detected by the technician.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Complaint'	Transactions.Notes
Essentials	No	--	--	--

Correction

string

The steps taken to correct the issue.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Correction'	Transactions.Notes
Essentials	No	--	--	--

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.CreatedDate
Essentials	Yes	Yes	N/A	N/A

CustomerId

string or null

References a CustomerId that should be responsible for this Work Order.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Contract Information' section → 'Customer Number'	CustomerFile.CNUM
Essentials	No	--	--	--

DepotId

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Select Job Site' tab	Transactions.Str
Essentials	Yes	Yes	N/A	N/A

DueDateTime

string <date-time>

The due date for this work order.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → 'Due Date' column	TransactionItems.DueDate
Essentials	No	--	--	--

Hidden

integer or null

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.Archived
Essentials	Yes	No	N/A	N/A

IsCustomerWO

boolean

Flag to telling whether the WO is consumer facing or not.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.ClassId
Essentials	No	--	--	--

object or null

Labor tracking details.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	N/A
Essentials	No, always `null`	--		--

Array of objects or null

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	N/A
Essentials	No	--	--	--

OtherComments

string

Any additional comments for this work order.

Cause, Complaint, Correction, and Other Comments all share the same DB field with a max character length of 2^31-1.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Add Comments' tab → 'Other Comments'	Transactions.Notes
Essentials	No	--	--	--

OpenDateTime

string or null <date-time>

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Enter Date' screen	Transactions.Date
Essentials	Yes	Yes	In Maintenance	N/A

Operation

string

The operation that needs to be performed.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → dropdown on far right	TransactionOperation.OperationName
Essentials	No	--	--	--

Array of objects or strings or null

In Elite, an array of Parts. In Essentials, an array of strings. Expand to see nested fields.

Array

One of

Classification

string or null

Enum: null "Rental" "Sale"

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	TransactionItems

Comments

string

Any comments for this part.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Line Item Comments' column	TransactionItems.Comments

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.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.BulkItem

IsSerialized

boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	rule

Name

string

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Name' column	TransactionItems.Description

ProductId

string or null

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.Num

PullFromStock

boolean or null

Indicates if the items should be pulled from stock when added to a work order.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.BulkItem

PurchasePrice

number or null

The purchase price of the part.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Price' column	Transactions.Price

Quantity

string or null

The quantity of this part on the work order.

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Qty' column	TransactionItems.QTY

SerialNumber

string or null

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.SerialNumber

Status

string or null

Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

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

Software	Supported	Filterable	UI	DB
Elite	Yes	No	N/A	ItemFile.TXTY

StockId

string or null

Id of stock

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Items' tab → 'Numb' column	TransactionItems.Item

ReportedIssue

string

The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)

Software	Supported	Filterable	UI	DB
Elite	Yes	No	'Information' tab → 'Contract Info'	--
Essentials	No	--	--	--

StockId

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → Line 1 → 'Numb' column	ItemFile.NUM
Essentials	Yes	Yes	N/A	N/A

Status

string

Enum: "Quote" "Open" "Closed"

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Based on Contract Status	Transactions.Status, Transactions.SecondaryStatus
Essentials	Yes	Yes	Status of attached Billing Transaction	N/A

StockName

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	'Items' tab → Line 1 → 'Numb' column	ItemFile.Name
Essentials	Yes	Yes	Maintenance Page Title	N/A

SubType

string or null

Software	Supported	Filterable	UI	DB
Elite	No	--	--	--
Essentials	Yes	Yes	Billing Type	--

Type

string or null

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	Based on Contract Type Created	TransactionClassification.Name
Essentials	Yes	Yes	Maintenance Type	N/A

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	Filterable	UI	DB
Elite	Yes	Yes	N/A	Transactions.UpdatedDateTime
Essentials	Yes	Yes	--	N/A

Request samples

Payload

Content type

application/json

{"Operation": "Repair complete",
"Complaint": "Inoperable"
}

Response samples

200
4XX

Content type

application/json

{"ModelType": "string",
"Id": "string",
"Name": "string",
"AdditionalFields": { },
"Cause": "string",
"CloseDateTime": "2019-08-24T14:15:22Z",
"Complaint": "string",
"Correction": "string",
"CreatedDateTime": "2019-08-24T14:15:22Z",
"CustomerId": "string",
"DepotId": "string",
"DueDateTime": "2019-08-24T14:15:22Z",
"Hidden": null,
"IsCustomerWO": true,
"LaborTracking": {"LaborTypes": [{"Description": "string",
"Value": "string"
}
]
},
"OtherComments": "string",
"OpenDateTime": "2019-08-24T14:15:22Z",
"Operation": "string",
"Parts": [{"Classification": null,
"Comments": "string",
"IsBulk": true,
"IsSerialized": true,
"Name": "string",
"ProductId": "string",
"PullFromStock": true,
"PurchasePrice": 0,
"Quantity": "string",
"SerialNumber": "string",
"Status": "Reserved",
"StockId": "string"
}
],
"ReportedIssue": "string",
"StockId": "string",
"Status": "Quote",
"StockName": "string",
"SubType": "string",
"Type": "string",
"UpdatedDateTime": "2019-08-24T14:15:22Z"
}

Retrieve a list of work order parts

Supported by: Elite

Returns an array containing all Parts associated with the WorkOrderId.

Authorizations:

API Key

path Parameters

WorkOrderId

required

string

Provide the unique ID of the WorkOrder you want to retrieve.

Responses

Response Schema: application/json

Array

ModelType

string

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 upon creation and not updatable.

Software	Supported	UI	DB
Elite	Yes		TransactionItems.ID

Classification

string or null

Enum: "Rental" "Sale" null

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

Software	Supported	UI	DB
Elite	Yes		ItemFile.Type

Name

string

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

Software	Supported	UI	DB
Elite	Yes		TransactionItems.Description

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.

Software	Supported	UI	DB
Elite	Yes		ItemFile.BulkItem

IsSerialized

boolean or null

Indicates whether we expect this Line Item to have a unique Serial Number. NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used.

Software	Supported	UI	DB
Elite	Yes		Rule-based

ProductId

string or null

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

Software	Supported	UI	DB
Elite	Yes		ItemFile.Num

PullFromStock

boolean or null

Indicates if the items should be pulled from stock when added to a work order.

Software	Supported	UI	DB
Elite	Yes		Derived from ItemFile.Type, TransactionItems.Qty, and ItemFile.BulkItem

PurchasePrice

number or null

The purchase price of the part.

Software	Supported	UI	DB
Elite	Yes		Transactions.Price

Quantity

string or null

The quantity of this part on the work order.

Software	Supported	UI	DB
Elite	Yes		TransactionItems.QTY

SerialNumber

string or null

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

Software	Supported	UI	DB
Elite	Yes		ItemFile.SerialNumber

Status

string or null

Enum: "Reserved" "Out" "Off Rent" "Returned" "Sold"

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

Software	Supported	UI	DB
Elite	Yes		ItemFile.TXTY

StockId

string or null

Id of stock

Software	Supported	UI	DB
Elite	Yes		TransactionItems.Item

Comments

string

Any comments for this part.

Software	Supported	UI	DB
Elite	Yes		TransactionItems.Comments

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	UI	Database
Elite	Yes		Transactions.CreatedDate

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00.

Software	Supported	UI	Database
Elite	No	--	--

Hidden

integer or null

Enum: null 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	UI	DB
Elite	Yes		Transactions.Archived

Response samples

200
4XX

Content type

application/json

{"ModelType": "PublicPart",
"Id": "101",
"Classification": "Sale",
"Name": "Drive Belt",
"IsBulk": false,
"IsSerialized": false,
"ProductId": null,
"PullFromStock": true,
"PurchasePrice": 50,
"Quantity": "1",
"SerialNumber": null,
"Status": "Sold",
"StockId": "3359",
"Comments": "",
"CreatedDateTime": "2019-08-24T14:15:22Z",
"UpdatedDateTime": "2019-08-24T14:15:22Z",
"Hidden": 0
}

Create a work order part

Supported by: Elite

Creates a new Part associated with a work order in the RMS. Returns a 201 and the complete object upon successful creation.

Authorizations:

API Key

path Parameters

WorkOrderId

required

string

Provide the unique ID of the WorkOrder you want to retrieve.

Request Body schema: application/json
required

Quantity required	string or null Default: "string" The quantity of this part on the work order. Validation Required Must be a positive, numeric value. May include a decimal.
StockId required	string or null Id of stock Validation Required Must be the stock ID for a piece of stock that already exists.
Name	string Default: null The display name for this record. This is often used as a summary for lookups. Validation Maximum length is 150 characters.
IsBulk	boolean or null Default: false 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. Validation Only inputs accepted: `true`,`false`,`null`
IsSerialized	boolean or null Default: false 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. Validation Only inputs accepted: `true`,`false`,`null`
PullFromStock	boolean or null Default: false Indicates if the items should be pulled from stock when added to a work order. Validation Only inputs accepted: `true`,`false`,`null`
PurchasePrice	number or null Default: null The purchase price of the part. Validation Must be a numeric value. May include a decimal. Valid values are within ±(2^63-1) x 10^-4
Comments	string Default: null Any comments for this part. Validation Maximum length is 255 characters.

Responses

Request samples

Payload

Content type

application/json

{"Name": "V-Belt",
"ProductId": "9",
"IsBulk": true,
"Quantity": 1
}

Response samples

201
4XX

Content type

application/json

{"ModelType": "PublicPart",
"Id": 42,
"Name": "V-belt",
"Quantity": "1",
"Comments": null,
"Classification": null,
"ProductId": "9",
"SerialNumber": null,
"Status": null,
"StockId": null,
"PurchasePrice": null,
"PullFromStock": false,
"IsSerialized": false,
"IsBulk": true
}

Enum Lookup for Operations

Supported by: Elite

This endpoint allows you to retrieve dynamic enumerated values for the Operations field in the Work Orders model. These values are configured within Elite settings.

How does this differ from Enum Lookup for Consumer Operations?

Enum Lookup for Operations:Returns operations values for internal work orders (IROs).
Enum Lookup for Consumer Operations: Retrieves operation values for external work orders, which are associated with a customer. You can retrieve details about the associated customer using the Customers endpoint.

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Value: "Lookup" 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 upon creation and not updatable.
Name	string A display name for this record. This should be a self-explanatory word or phrase describing the operation occurring for this work order. For this lookup, Name, Description, and Value will all match. Some common examples include "Waiting on diagnosis," "Waiting on parts," "In Repair," and "Repair Complete."
Description	string For this lookup, Name, Description, and Value will all match. Some common examples include "Waiting on diagnosis," "Waiting on parts," "In Repair," and "Repair Complete."
Value	string For this lookup, Name, Description, and Value will all match. Some common examples include "Waiting on diagnosis," "Waiting on parts," "In Repair," and "Repair Complete."

Response samples

200
4XX

Content type

application/json

[{"ModelType": "Lookup",
"Value": "Waiting on diagnosis",
"Description": "Waiting on diagnosis",
"Id": "6",
"Name": "Waiting on diagnosis"
},
{"ModelType": "Lookup",
"Value": "Waiting on parts",
"Description": "Waiting on parts",
"Id": "7",
"Name": "Waiting on parts"
},
{"ModelType": "Lookup",
"Value": "In repair",
"Description": "In repair",
"Id": "8",
"Name": "In repair"
}
]

Enum Lookup for Consumer Operations

Supported by: Elite

This endpoint allows you to retrieve dynamic enumerated values for the Operations field in the Work Orders model. These values are configured within Elite settings.

How does this differ from Enum Lookup for Operations?

Enum Lookup for Operations:Returns operations values for internal work orders (IROs).
Enum Lookup for Consumer Operations: Retrieves operation values for external work orders, which are associated with a customer. You can retrieve details about the associated customer using the Customers endpoint.

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType	string Value: "Lookup" 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 upon creation and not updatable.
Name	string A display name for this record. This should be a self-explanatory word or phrase describing the operation occurring for this work order. For this lookup, Name, Description, and Value will all match. Some common examples include "Waiting on diagnosis," "Waiting on parts," "In Repair," and "Repair Complete."
Description	string For this lookup, Name, Description, and Value will all match. Some common examples include "Waiting on diagnosis," "Waiting on parts," "In Repair," and "Repair Complete."
Value	string For this lookup, Name, Description, and Value will all match. Some common examples include "Waiting on diagnosis," "Waiting on parts," "In Repair," and "Repair Complete."

Response samples

200
4XX

Content type

application/json

[{"ModelType": "Lookup",
"Value": "Waiting on diagnosis",
"Description": "Waiting on diagnosis",
"Id": "6",
"Name": "Waiting on diagnosis"
},
{"ModelType": "Lookup",
"Value": "Waiting on parts",
"Description": "Waiting on parts",
"Id": "7",
"Name": "Waiting on parts"
},
{"ModelType": "Lookup",
"Value": "In repair",
"Description": "In repair",
"Id": "8",
"Name": "In repair"
}
]

Accounts Payable

Retrieve a list of Account Payable Invoices

Supported by: Elite

This is a list of account payable invoices. By default you can retrieve a list of payable invoices where State property is equal to 'Pending'. Apply an additional filter to the the State property in order to receive other payable invoices states.

Several of these fields map to the UI in the Accounting Queue. The Accounting Queue is found from the Left Navigation bar in Elite, go to Accounting → Re-Print GL Entries → View.

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType

string

Value: "AccountPayableInvoice"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueuePO.AccountingAPIQueuePOId

PurchaseOrderDateTime

string <date-time>

The purchase order date on the PO that resulted in the payable. All dates are in ISO-8601 format and times are in UTC. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → 'order date'	AccountingAPIQueuePO.PODate

CurrencyCode

string or null

Currency code value set in the accounting system. Code is ISO 4217 format. This is part of the Company's configuration.

Software	UI	Database
Elite	N/A	CurrencyExchange.AccountingLink

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' column	AccountingAPIQueuePO.ErrorMsg

ExchangeRate

number or null

Exchange rate on the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → next to currency dropdown	AccountingAPIQueuePO.ExchangeRate

FreightTotal

number

Total price of the freight. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Freight'	AccountingAPIQueuePO.ShippingCost

GrandTaxTotal

number

Total amount of sales tax. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Tax'	AccountingAPIQueuePO.Tax

GrandTotal

number

Total amount that is payable. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Total'	AccountingAPIQueuePO.TotalAmount

object

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

Array of objects

A collection of line items related to the contract Id.

Memo

string or null

Memo associated to the payable invoice.

Software	Support Note	UI	Database
Elite	Returns empty string	N/A	--

MiscellaneousTotal

number

Total price of miscellaneous costs. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Misc'	AccountingAPIQueuePO.Miscellaneous

PurchaseOrderNumber

string

Purchase order number associated to the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → 'PO #'	AccountingAPIQueuePO.PONumber

PurchaseOrderSequenceNumber

string

Purchase order sequence number associated to the payable invoice.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.Sequence

PurchaseTotal

number

Total price of the purchases. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Subtotal'	AccountingAPIQueuePO.PurchaseAmount

ShippingMethod

string

Shipping method on the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Shipping' section → 'ship method'	PurchaseOrder.ShipMethod

State

string

Enum: "Pending" "Posted" "Error"

Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted', then it can't be updated to another state. Found in the Accounting Queue. Toggle the 'Status' dropdown in the UI to reveal which journal entries are in which state.

Possible Enum Values

Pending: All payments will initially have a Pending state. Payment will not reflect on the AmountDue of the contract until a Get inquiry of this payment has a Posted value under State. The duration until the status is updated is dependent on system cycle settings.
Posted: Once the value is set to Posted, the AmountDue will be updated. Once the value is shown as Posted, it can not update to another state.
Error: An error occurred in the process. Please check ErrorCode and ErrorDescription.

Software	Filterable	UI	Database
Elite	Yes	'Status' dropdown	AccountingAPIQueuePO.DatePosted / AccountingAPIQueuePO.DateError

TermsCode

string

Payment terms code in the accounting system. This field references information found in the Vendor Record Detail screen.

Software	Support Note	UI	Database
Elite	Returns an empty string	'Account' section → 'terms'	--

object

Elite vendor associated to this payable invoice. Found on the Purchase Order details screen.

Response samples

200
4XX

Content type

application/json

{"ModelType": "AccountPayableInvoice",
"Id": "42",
"PurchaseOrderDateTime": "2024-06-28T05:00:00Z",
"CurrencyCode": "",
"ErrorCode": null,
"ErrorDescription": null,
"ExchangeRate": 1,
"FreightTotal": 1.58,
"GrandTaxTotal": 0,
"GrandTotal": 83.47,
"Identifiers": {"BatchId": 7756,
"ContractStoreId": "001",
"ExternalLocationId": null,
"ExternalPayableId": null,
"ExternalVendorId": "",
"FreightAccountId": "000-6402-33",
"MiscellaneousAccountId": "000-6005-00",
"PayableAccountId": "020-2301-00",
"TaxAccountId": "000-2354-00"
},
"LineItems": [{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "1",
"ExtendedUnitTotal": 5,
"FreightTotal": 1.5755,
"GrandTaxTotal": 0,
"GrandTotal": 6.5755,
"Identifiers": {"AccountNumberId": "7",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "0",
"Name": null,
"Description": "4300: Widget",
"Key": null
},
"LineNumber": 3,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "4300",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 1,
"QuantityReceived": 1,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 5,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
},
{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "2",
"ExtendedUnitTotal": 31.8,
"FreightTotal": 10.0204,
"GrandTaxTotal": 0,
"GrandTotal": 41.8204,
"Identifiers": {"AccountNumberId": "3",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "4301",
"Name": null,
"Description": "4301: Whatsit",
"Key": ".WHA55-1"
},
"LineNumber": 4,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "66-515",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 4,
"QuantityReceived": 4,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 7.95,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
},
{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "3",
"ExtendedUnitTotal": 26.67,
"FreightTotal": 8.4028,
"GrandTaxTotal": 0,
"GrandTotal": 35.0728,
"Identifiers": {"AccountNumberId": "6",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "94582",
"Name": null,
"Description": "94582: Thingamajig",
"Key": ".THING-2"
},
"LineNumber": 5,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 4,
"QuantityReceived": 4,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 6.6667,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
}
],
"Memo": "",
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": "9406",
"PurchaseOrderSequenceNumber": "0",
"PurchaseTotal": 81.89,
"ShippingMethod": "",
"State": "Posted",
"TermsCode": "",
"Vendor": {"ModelType": "PublicVendor",
"Id": "17412",
"Name": "Parts R Us",
"AdditionalFields": {"InvoiceNumber": "23020",
"InvoiceDateTime": "2024-06-28T05:00:00Z",
"InvoiceDueDateTime": "2024-06-28T05:00:00Z",
"PaymentMethod": null,
"TermDays": null
}
}
}

Retrieve a single Account Payable Invoice

Supported by: Elite

This is a single account payable invoice retrieved by the given payable invoice id.

Several of these fields map to the UI in the Accounting Queue. The Accounting Queue is found from the Left Navigation bar in Elite, go to Accounting → Re-Print GL Entries → View.

Authorizations:

API Key

path Parameters

InvoiceId

required

string

Responses

Response Schema: application/json

ModelType

string

Value: "AccountPayableInvoice"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueuePO.AccountingAPIQueuePOId

PurchaseOrderDateTime

string <date-time>

The purchase order date on the PO that resulted in the payable. All dates are in ISO-8601 format and times are in UTC. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → 'order date'	AccountingAPIQueuePO.PODate

CurrencyCode

string or null

Currency code value set in the accounting system. Code is ISO 4217 format. This is part of the Company's configuration.

Software	UI	Database
Elite	N/A	CurrencyExchange.AccountingLink

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' column	AccountingAPIQueuePO.ErrorMsg

ExchangeRate

number or null

Exchange rate on the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → next to currency dropdown	AccountingAPIQueuePO.ExchangeRate

FreightTotal

number

Total price of the freight. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Freight'	AccountingAPIQueuePO.ShippingCost

GrandTaxTotal

number

Total amount of sales tax. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Tax'	AccountingAPIQueuePO.Tax

GrandTotal

number

Total amount that is payable. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Total'	AccountingAPIQueuePO.TotalAmount

object

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

BatchId

string

Batch Id associated with this record. Found in the Accounting Queue.

Software	UI	Database
Elite	'ID/Batch' column	AccountingAPIQueuePO.Batch

ContractStoreId

string

Store Id associated with the payable invoice.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.Store

ExternalLocationId

string

External store/location Id in the accounting system.

Software	UI	Database
Elite	N/A	AccountingLocation.AccountingLink

ExternalPayableId

string

External payable Id in the accounting system.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.ExternalId

ExternalVendorId

string

External vendor Id in the accounting system.

Software	UI	Database
Elite	N/A	VendorFile.GLLink

FreightAccountId

string

General ledger freight account Id. Freight is included on purchases. Displayed in the 'Account Numbers for Store XX' under the Purchase Orders section.

Software	UI	Database
Elite	'Purchase Orders' section → 'Shipping'	AccountingAPIQueuePO.POShippingAccount

MiscellaneousAccountId

string

General ledger miscellaneous account Id. Relates to miscellaneous cost on purchases. Displayed in the 'Account Numbers for Store XX' under the Purchase Orders section.

Software	UI	Database
Elite	'Purchase Orders' section → 'Miscellaneous'	AccountingAPIQueuePO.POMiscellaneousAccount

PayableAccountId

string

General ledger payable account Id. Displayed in the 'Account Numbers for Store XX' under the Purchase Orders section.

Software	UI	Database
Elite	'Purchase Orders' section → 'Accounts Payable'	AccountingAPIQueuePO.AccountsPayableAccount

TaxAccountId

string

General ledger tax account Id. Relates to tax on purchases. Displayed in the 'Account Numbers for Store XX' under the Purchase Orders section.

Software	UI	Database
Elite	'Purchase Orders' section → 'Tax'	AccountingAPIQueuePO.POTaxAccount

Array of objects

A collection of line items related to the contract Id.

Array

ModelType

string

Value: "AccountPayableInvoiceLineItem"

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 upon creation and not updatable.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePODetail.AccountingAPIQueuePODetailid

ExtendedUnitTotal

number

Total price of the quantity on the invoice multiplied by unit total.

Software	UI	Database
Elite	N/A	PurchaseOrderDetail.ExtendedPrice

FreightTotal

number

Total price of the freight. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Freight'	PurchaseOrderDetail.FreightEach * PurchaseOrderDetail.QuantityReceived

GrandTaxTotal

number

Total price of the tax. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Tax'	PurchaseOrderDetail.TaxEach * PurchaseOrderDetail.QuantityReceived

GrandTotal

number

Total price that is payable. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Total'	PurchaseOrderDetail.ExtendedPrice + (PurchaseOrderDetail.FreightEach * PurchaseOrderDetail.QuantityReceived) + (PurchaseOrderDetail.TaxEach * PurchaseOrderDetail.QuantityReceived) + (PurchaseOrderDetail.MiscEach * PurchaseOrderDetail.QuantityReceived)

object

Collection of unique ids related to this payable invoice line item.

object

Elite item associated to this payable invoice line item.

LineNumber

integer

The line number in which this item was added onto the purchase order. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Number' column	AccountingAPIQueuePODetail.LineNumber

MiscellaneousTotal

string

Total price of miscellaneous costs. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Misc'	PurchaseOrderDetail.MiscEach * PurchaseOrderDetail.QuantityReceived

PurchaseOrderNumber

string

Purchase order number associated to the line item. Found on the Purchase Order details screen.

Software	UI	Database
Elite	PO #	AccountingAPIQueuePO.PONumber

PurchaseOrderPartNumber

string

Purchase order part number associated to the line item. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Part Number' column	PurchaseOrderDetail.PartNumber

PurchaseOrderSequenceNumber

string

Purchase order sequence number associated to the line item.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.Sequence

QuantityOrdered

number

Quantity ordered on the purchase order. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Qty' column	PurchaseOrderDetail.QuantityOrdered

QuantityReceived

number

Quantity received on the purchase order. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Recvd' column	PurchaseOrderDetail.QuantityReceived

ReceivedDateTime

string <date-time>

Date and time when the line item was received. All dates are in ISO-8601 format and times are in UTC. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Date Recvd' column	PurchaseOrderDetail.DateReceived

UnitTotal

number

Total price of each individual unit.

Software	UI	Database
Elite	N/A	PurchaseOrderDetail.PriceEach

Memo

string or null

Memo associated to the payable invoice.

Software	Support Note	UI	Database
Elite	Returns empty string	N/A	--

MiscellaneousTotal

number

Total price of miscellaneous costs. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Misc'	AccountingAPIQueuePO.Miscellaneous

PurchaseOrderNumber

string

Purchase order number associated to the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → 'PO #'	AccountingAPIQueuePO.PONumber

PurchaseOrderSequenceNumber

string

Purchase order sequence number associated to the payable invoice.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.Sequence

PurchaseTotal

number

Total price of the purchases. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Subtotal'	AccountingAPIQueuePO.PurchaseAmount

ShippingMethod

string

Shipping method on the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Shipping' section → 'ship method'	PurchaseOrder.ShipMethod

State

string

Enum: "Pending" "Posted" "Error"

Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted', then it can't be updated to another state. Found in the Accounting Queue. Toggle the 'Status' dropdown in the UI to reveal which journal entries are in which state.

Possible Enum Values

Pending: All payments will initially have a Pending state. Payment will not reflect on the AmountDue of the contract until a Get inquiry of this payment has a Posted value under State. The duration until the status is updated is dependent on system cycle settings.
Posted: Once the value is set to Posted, the AmountDue will be updated. Once the value is shown as Posted, it can not update to another state.
Error: An error occurred in the process. Please check ErrorCode and ErrorDescription.

Software	Filterable	UI	Database
Elite	Yes	'Status' dropdown	AccountingAPIQueuePO.DatePosted / AccountingAPIQueuePO.DateError

TermsCode

string

Payment terms code in the accounting system. This field references information found in the Vendor Record Detail screen.

Software	Support Note	UI	Database
Elite	Returns an empty string	'Account' section → 'terms'	--

object

Elite vendor associated to this payable invoice. Found on the Purchase Order details screen.

ModelType

string

Value: "Vendor"

Standard field that denotes the record type. Useful for bulk ingesting different record types. Expand to see nested fields.

Id

string

The unique Id for this record. This is system-generated upon creation and not updatable. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Vendor' section → in parentheses	VendorFile.VendorNumber

Name

string

Name of the vendor. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Vendor' section → 'name'	VendorFile.VendorName

InvoiceNumber

string

Vendor's invoice number associated with the payable. This field references information found in the Verify Invoice screen.

Software	UI	Database
Elite	Invoice Number	AccountingAPIQueuePO.InvoiceNumber

InvoiceDateTime

string <date-time>

Date of vendor's invoice. All dates are in ISO-8601 format and times are in UTC. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Invoice Details' section → 'invoice date'	AccountingAPIQueuePO.InvoiceDate

InvoiceDueDateTime

string <date-time>

Due date of vendor's invoice. All dates are in ISO-8601 format and times are in UTC. This field references information found in the Verify Invoice screen.

Software	UI	Database
Elite	Invoice Due Date	AccountingAPIQueuePO.InvoiceDate + ISNULL(VendorFile.TermDays,0)

Response samples

200
4XX

Content type

application/json

{"ModelType": "AccountPayableInvoice",
"Id": "42",
"PurchaseOrderDateTime": "2024-06-28T05:00:00Z",
"CurrencyCode": "",
"ErrorCode": null,
"ErrorDescription": null,
"ExchangeRate": 1,
"FreightTotal": 1.58,
"GrandTaxTotal": 0,
"GrandTotal": 83.47,
"Identifiers": {"BatchId": 7756,
"ContractStoreId": "001",
"ExternalLocationId": null,
"ExternalPayableId": null,
"ExternalVendorId": "",
"FreightAccountId": "000-6402-33",
"MiscellaneousAccountId": "000-6005-00",
"PayableAccountId": "020-2301-00",
"TaxAccountId": "000-2354-00"
},
"LineItems": [{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "1",
"ExtendedUnitTotal": 5,
"FreightTotal": 1.5755,
"GrandTaxTotal": 0,
"GrandTotal": 6.5755,
"Identifiers": {"AccountNumberId": "7",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "0",
"Name": null,
"Description": "4300: Widget",
"Key": null
},
"LineNumber": 3,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "4300",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 1,
"QuantityReceived": 1,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 5,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
},
{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "2",
"ExtendedUnitTotal": 31.8,
"FreightTotal": 10.0204,
"GrandTaxTotal": 0,
"GrandTotal": 41.8204,
"Identifiers": {"AccountNumberId": "3",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "4301",
"Name": null,
"Description": "4301: Whatsit",
"Key": ".WHA55-1"
},
"LineNumber": 4,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "66-515",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 4,
"QuantityReceived": 4,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 7.95,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
},
{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "3",
"ExtendedUnitTotal": 26.67,
"FreightTotal": 8.4028,
"GrandTaxTotal": 0,
"GrandTotal": 35.0728,
"Identifiers": {"AccountNumberId": "6",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "94582",
"Name": null,
"Description": "94582: Thingamajig",
"Key": ".THING-2"
},
"LineNumber": 5,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 4,
"QuantityReceived": 4,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 6.6667,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
}
],
"Memo": "",
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": "9406",
"PurchaseOrderSequenceNumber": "0",
"PurchaseTotal": 81.89,
"ShippingMethod": "",
"State": "Posted",
"TermsCode": "",
"Vendor": {"ModelType": "PublicVendor",
"Id": "17412",
"Name": "Parts R Us",
"AdditionalFields": {"InvoiceNumber": "23020",
"InvoiceDateTime": "2024-06-28T05:00:00Z",
"InvoiceDueDateTime": "2024-06-28T05:00:00Z",
"PaymentMethod": null,
"TermDays": null
}
}
}

Update an existing Account Payable Invoice

Supported by: Elite

Authorizations:

API Key

path Parameters

InvoiceId

required

string

Example: 42

Provide the unique ID of the Accounts Payabnle Invoice you want to update/patch.

Request Body schema: application/json
required

ErrorCode

string or null

Default: "string"

Error code value whenever the invoice State is set to 'Error'.

Validation

Maximum length is 255 characters.

ErrorDescription

string or null

Default: "string"

Error description value whenever invoice State is set to 'Error'.

Validation

Maximum length is 2^31-1 characters.

object

Collection of unique ids related to this invoice line item.

ExternalPayableId

string or null

External Payable Id in the accounting system.

State

string

Default: "string"

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.

Validation

Must be one of the listed values.

Responses

Response Schema: application/json

ModelType

string

Value: "AccountPayableInvoice"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueuePO.AccountingAPIQueuePOId

PurchaseOrderDateTime

string <date-time>

The purchase order date on the PO that resulted in the payable. All dates are in ISO-8601 format and times are in UTC. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → 'order date'	AccountingAPIQueuePO.PODate

CurrencyCode

string or null

Currency code value set in the accounting system. Code is ISO 4217 format. This is part of the Company's configuration.

Software	UI	Database
Elite	N/A	CurrencyExchange.AccountingLink

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' column	AccountingAPIQueuePO.ErrorMsg

ExchangeRate

number or null

Exchange rate on the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → next to currency dropdown	AccountingAPIQueuePO.ExchangeRate

FreightTotal

number

Total price of the freight. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Freight'	AccountingAPIQueuePO.ShippingCost

GrandTaxTotal

number

Total amount of sales tax. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Tax'	AccountingAPIQueuePO.Tax

GrandTotal

number

Total amount that is payable. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Total'	AccountingAPIQueuePO.TotalAmount

object

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

BatchId

string

Batch Id associated with this record. Found in the Accounting Queue.

Software	UI	Database
Elite	'ID/Batch' column	AccountingAPIQueuePO.Batch

ContractStoreId

string

Store Id associated with the payable invoice.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.Store

ExternalLocationId

string

External store/location Id in the accounting system.

Software	UI	Database
Elite	N/A	AccountingLocation.AccountingLink

ExternalPayableId

string

External payable Id in the accounting system.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.ExternalId

ExternalVendorId

string

External vendor Id in the accounting system.

Software	UI	Database
Elite	N/A	VendorFile.GLLink

FreightAccountId

string

General ledger freight account Id. Freight is included on purchases. Displayed in the 'Account Numbers for Store XX' under the Purchase Orders section.

Software	UI	Database
Elite	'Purchase Orders' section → 'Shipping'	AccountingAPIQueuePO.POShippingAccount

MiscellaneousAccountId

string

General ledger miscellaneous account Id. Relates to miscellaneous cost on purchases. Displayed in the 'Account Numbers for Store XX' under the Purchase Orders section.

Software	UI	Database
Elite	'Purchase Orders' section → 'Miscellaneous'	AccountingAPIQueuePO.POMiscellaneousAccount

PayableAccountId

string

General ledger payable account Id. Displayed in the 'Account Numbers for Store XX' under the Purchase Orders section.

Software	UI	Database
Elite	'Purchase Orders' section → 'Accounts Payable'	AccountingAPIQueuePO.AccountsPayableAccount

TaxAccountId

string

General ledger tax account Id. Relates to tax on purchases. Displayed in the 'Account Numbers for Store XX' under the Purchase Orders section.

Software	UI	Database
Elite	'Purchase Orders' section → 'Tax'	AccountingAPIQueuePO.POTaxAccount

Array of objects

A collection of line items related to the contract Id.

Array

ModelType

string

Value: "AccountPayableInvoiceLineItem"

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 upon creation and not updatable.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePODetail.AccountingAPIQueuePODetailid

ExtendedUnitTotal

number

Total price of the quantity on the invoice multiplied by unit total.

Software	UI	Database
Elite	N/A	PurchaseOrderDetail.ExtendedPrice

FreightTotal

number

Total price of the freight. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Freight'	PurchaseOrderDetail.FreightEach * PurchaseOrderDetail.QuantityReceived

GrandTaxTotal

number

Total price of the tax. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Tax'	PurchaseOrderDetail.TaxEach * PurchaseOrderDetail.QuantityReceived

GrandTotal

number

Total price that is payable. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Total'	PurchaseOrderDetail.ExtendedPrice + (PurchaseOrderDetail.FreightEach * PurchaseOrderDetail.QuantityReceived) + (PurchaseOrderDetail.TaxEach * PurchaseOrderDetail.QuantityReceived) + (PurchaseOrderDetail.MiscEach * PurchaseOrderDetail.QuantityReceived)

object

Collection of unique ids related to this payable invoice line item.

object

Elite item associated to this payable invoice line item.

LineNumber

integer

The line number in which this item was added onto the purchase order. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Number' column	AccountingAPIQueuePODetail.LineNumber

MiscellaneousTotal

string

Total price of miscellaneous costs. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Misc'	PurchaseOrderDetail.MiscEach * PurchaseOrderDetail.QuantityReceived

PurchaseOrderNumber

string

Purchase order number associated to the line item. Found on the Purchase Order details screen.

Software	UI	Database
Elite	PO #	AccountingAPIQueuePO.PONumber

PurchaseOrderPartNumber

string

Purchase order part number associated to the line item. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Part Number' column	PurchaseOrderDetail.PartNumber

PurchaseOrderSequenceNumber

string

Purchase order sequence number associated to the line item.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.Sequence

QuantityOrdered

number

Quantity ordered on the purchase order. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Qty' column	PurchaseOrderDetail.QuantityOrdered

QuantityReceived

number

Quantity received on the purchase order. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Recvd' column	PurchaseOrderDetail.QuantityReceived

ReceivedDateTime

string <date-time>

Date and time when the line item was received. All dates are in ISO-8601 format and times are in UTC. Found on the Purchase Order details screen.

Software	UI	Database
Elite	Items 'Date Recvd' column	PurchaseOrderDetail.DateReceived

UnitTotal

number

Total price of each individual unit.

Software	UI	Database
Elite	N/A	PurchaseOrderDetail.PriceEach

Memo

string or null

Memo associated to the payable invoice.

Software	Support Note	UI	Database
Elite	Returns empty string	N/A	--

MiscellaneousTotal

number

Total price of miscellaneous costs. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Misc'	AccountingAPIQueuePO.Miscellaneous

PurchaseOrderNumber

string

Purchase order number associated to the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Information' section → 'PO #'	AccountingAPIQueuePO.PONumber

PurchaseOrderSequenceNumber

string

Purchase order sequence number associated to the payable invoice.

Software	UI	Database
Elite	N/A	AccountingAPIQueuePO.Sequence

PurchaseTotal

number

Total price of the purchases. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Totals' section → 'Subtotal'	AccountingAPIQueuePO.PurchaseAmount

ShippingMethod

string

Shipping method on the payable invoice. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Shipping' section → 'ship method'	PurchaseOrder.ShipMethod

State

string

Enum: "Pending" "Posted" "Error"

Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted', then it can't be updated to another state. Found in the Accounting Queue. Toggle the 'Status' dropdown in the UI to reveal which journal entries are in which state.

Possible Enum Values

Pending: All payments will initially have a Pending state. Payment will not reflect on the AmountDue of the contract until a Get inquiry of this payment has a Posted value under State. The duration until the status is updated is dependent on system cycle settings.
Posted: Once the value is set to Posted, the AmountDue will be updated. Once the value is shown as Posted, it can not update to another state.
Error: An error occurred in the process. Please check ErrorCode and ErrorDescription.

Software	Filterable	UI	Database
Elite	Yes	'Status' dropdown	AccountingAPIQueuePO.DatePosted / AccountingAPIQueuePO.DateError

TermsCode

string

Payment terms code in the accounting system. This field references information found in the Vendor Record Detail screen.

Software	Support Note	UI	Database
Elite	Returns an empty string	'Account' section → 'terms'	--

object

Elite vendor associated to this payable invoice. Found on the Purchase Order details screen.

ModelType

string

Value: "Vendor"

Standard field that denotes the record type. Useful for bulk ingesting different record types. Expand to see nested fields.

Id

string

The unique Id for this record. This is system-generated upon creation and not updatable. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Vendor' section → in parentheses	VendorFile.VendorNumber

Name

string

Name of the vendor. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Vendor' section → 'name'	VendorFile.VendorName

InvoiceNumber

string

Vendor's invoice number associated with the payable. This field references information found in the Verify Invoice screen.

Software	UI	Database
Elite	Invoice Number	AccountingAPIQueuePO.InvoiceNumber

InvoiceDateTime

string <date-time>

Date of vendor's invoice. All dates are in ISO-8601 format and times are in UTC. Found on the Purchase Order details screen.

Software	UI	Database
Elite	'Invoice Details' section → 'invoice date'	AccountingAPIQueuePO.InvoiceDate

InvoiceDueDateTime

string <date-time>

Due date of vendor's invoice. All dates are in ISO-8601 format and times are in UTC. This field references information found in the Verify Invoice screen.

Software	UI	Database
Elite	Invoice Due Date	AccountingAPIQueuePO.InvoiceDate + ISNULL(VendorFile.TermDays,0)

Request samples

Payload

Content type

application/json

{"Id": "42",
"State": "Pending"
}

Response samples

200
4XX

Content type

application/json

{"ModelType": "AccountPayableInvoice",
"Id": "42",
"PurchaseOrderDateTime": "2024-06-28T05:00:00Z",
"CurrencyCode": "",
"ErrorCode": null,
"ErrorDescription": null,
"ExchangeRate": 1,
"FreightTotal": 1.58,
"GrandTaxTotal": 0,
"GrandTotal": 83.47,
"Identifiers": {"BatchId": 7756,
"ContractStoreId": "001",
"ExternalLocationId": null,
"ExternalPayableId": null,
"ExternalVendorId": "",
"FreightAccountId": "000-6402-33",
"MiscellaneousAccountId": "000-6005-00",
"PayableAccountId": "020-2301-00",
"TaxAccountId": "000-2354-00"
},
"LineItems": [{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "1",
"ExtendedUnitTotal": 5,
"FreightTotal": 1.5755,
"GrandTaxTotal": 0,
"GrandTotal": 6.5755,
"Identifiers": {"AccountNumberId": "7",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "0",
"Name": null,
"Description": "4300: Widget",
"Key": null
},
"LineNumber": 3,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "4300",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 1,
"QuantityReceived": 1,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 5,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
},
{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "2",
"ExtendedUnitTotal": 31.8,
"FreightTotal": 10.0204,
"GrandTaxTotal": 0,
"GrandTotal": 41.8204,
"Identifiers": {"AccountNumberId": "3",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "4301",
"Name": null,
"Description": "4301: Whatsit",
"Key": ".WHA55-1"
},
"LineNumber": 4,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "66-515",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 4,
"QuantityReceived": 4,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 7.95,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
},
{"ModelType": "AccountPayableInvoiceLineItem",
"Id": "3",
"ExtendedUnitTotal": 26.67,
"FreightTotal": 8.4028,
"GrandTaxTotal": 0,
"GrandTotal": 35.0728,
"Identifiers": {"AccountNumberId": "6",
"ExternalPayableId": null,
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "94582",
"Name": null,
"Description": "94582: Thingamajig",
"Key": ".THING-2"
},
"LineNumber": 5,
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": 9406,
"PurchaseOrderPartNumber": "",
"PurchaseOrderSequenceNumber": 0,
"QuantityOrdered": 4,
"QuantityReceived": 4,
"ReceivedDateTime": "2024-06-28T05:00:00Z",
"UnitTotal": 6.6667,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
}
],
"Memo": "",
"MiscellaneousTotal": 0,
"PurchaseOrderNumber": "9406",
"PurchaseOrderSequenceNumber": "0",
"PurchaseTotal": 81.89,
"ShippingMethod": "",
"State": "Posted",
"TermsCode": "",
"Vendor": {"ModelType": "PublicVendor",
"Id": "17412",
"Name": "Parts R Us",
"AdditionalFields": {"InvoiceNumber": "23020",
"InvoiceDateTime": "2024-06-28T05:00:00Z",
"InvoiceDueDateTime": "2024-06-28T05:00:00Z",
"PaymentMethod": null,
"TermDays": null
}
}
}

Accounts Receivable

[Elite Account Receivable Invoices] Get All

All Elite account receivable invoices, use query parameters to filter

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType

string

Value: "AccountReceivableInvoice"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.Id

ContractTotal

number

Total price of the contract excluding sales tax total. From the Contract Information box, this is the sum of Rent Total, Sales Total, Damage Waiver Total, Other Total, and Road Tax Total.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.TransAmount

ContractType

string

Enum: "Cash" "Credit" "Invoice"

Type of contract. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Information' tab → 'Order Info' section → 'Contract Type'	AccountingAPIQueueTR.TransCodeId

CurrencyCode

string or null

Currency code value set in the accounting system. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Information' tab → 'Pricing' section → 'Currency'	CurrencyExchange.AccountingLink

CustomerPurchaseOrderNumber

string or null

Customer purchase order number associated to the invoice. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Information' tab → 'General Info' Section → 'P.O. number'	AccountingAPIQueueTR.CustomerPONumber

DamageWaiverTotal

number

Total price of the damage waiver. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Dmg Wvr'	AccountingAPIQueueTR.DamageWaiverAmount

object

Ship to / delivery details associated with the contract on the invoice. Found on the Contract Processing screen. Expand to see nested fields.

EndDateTime

string or null <date-time>

Date and time when the contract was closed.

Software	Filterable	UI	Database
Elite	Yes	N/A	Transactions.CLDT

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	AccountingAPIQueueTR.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' Column	AccountingAPIQueueTR.ErrorMsg

ExchangeRate

number or null

Exchange rate of the contract on the invoice.

Software	UI	Database
Elite		Transactions.ExchangeRate

GrandTaxTotal

number

Total amount of sales tax invoiced. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Tax'	AccountingAPIQueueTR.TaxAmount

GrandTotal

number

Total price of the contract including sales tax. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Total'	AccountingAPIQueueTR.TotalAmount

object

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

InvoiceNumber

string or null

The Sequential Invoice Number associated with the Contract.

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

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.InvoiceNumber

ItemPercentageTotal

number or null

Total value of item percentage on the contract. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Road Tax'	Transactions.ItemPercentage

Array of objects

A collection of line items related to the contract Id. The UI for these nested fields is found on the 'Contract Processing' screen under the 'Items' tab. To configure the columns, double click on the header of Line Items to reveal a menu that allows a user to add/view other available options. Expand to see nested fields.

OrderedBy

string or null

Customer representative who originated the contract. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Information' tab → 'Order Info' Section → 'Ordered by'	Transactions.OrderedBy

OtherTotal

number

Total price of other/miscellaneous items on the contract. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Other'	AccountingAPIQueueTR.OtherAmount

PaidTotal

number

Total amount paid prior to the contract being closed.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Paid'	AccountingAPIQueueTR.PaidAmount

PickedUpBy

string or null

Customer representative who picked up the items.

Software	UI	Database
Elite	'Information' tab → 'Order Info' Section → 'Picked up by'	Transactions.PickedUpBy

RentTotal

number

Total price of rental items on the contract.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Rent'	AccountingAPIQueueTR.RentAmount

RevenueDateTime

string <date-time>

Date and time of the revenue posting.

Software	Filterable	UI	Database
Elite	Yes	N/A	Transactions.RevenueDate

SaleTotal

number

Total price of sale items on the contract.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Sale'	AccountingAPIQueueTR.SaleAmount

StartDateTime

string <date-time>

Date and time of when the contract opened.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.TransDate

State

string

Enum: "Pending" "Posted" "Error"

Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted', then it can't be updated to another state. Found in the Accounting Queue. Toggle the 'Status' dropdown in the UI to reveal which journal entries are in which state.

Possible Enum Values

Pending: All payments will initially have a Pending state. Payment will not reflect on the AmountDue of the contract until a Get inquiry of this payment has a Posted value under State. The duration until the status is updated is dependent on system cycle settings.
Posted: Once the value is set to Posted, the AmountDue will be updated. Once the value is shown as Posted, it can not update to another state.
Error: An error occurred in the process. Please check ErrorCode and ErrorDescription.

Software	Filterable	UI	Database
Elite	Yes	'Status' dropdown	AccountingAPIQueueTR.DatePosted, AccountingAPIQueueTR.DateError

TaxableTotal

number

Total taxable price of the contract. Sum of Damage Waiver Total, Other Total, Rent Total, Road Tax Total, and Sale Total.

Software	UI	Database
Elite	N/A	N/A

Response samples

200
4XX

Content type

application/json

{"ModelType": "AccountReceivableInvoice",
"Id": "1",
"ContractTotal": 852.5,
"ContractType": "Invoice",
"CurrencyCode": null,
"CustomerPurchaseOrderNumber": "",
"InvoiceNumber": "",
"DamageWaiverTotal": 77.5,
"Delivery": {"Address": {"Type": "Default",
"City": "",
"Line1": "",
"PostalCode": "",
"Province": ""
},
"DateTime": "2024-08-08T18:19:00Z",
"LocationName": ""
},
"EndDateTime": "2024-08-08T05:00:00Z",
"ErrorCode": null,
"ErrorDescription": null,
"ExchangeRate": 1,
"GrandTaxTotal": 0,
"GrandTotal": 852.5,
"Identifiers": {"BatchId": 6525,
"ContractId": "776894",
"ContractStoreId": "001",
"CustomerId": "225321",
"ExternalCustomerId": "",
"ExternalInvoiceId": null,
"ExternalLocationId": null,
"ParentContractId": ""
},
"ItemPercentageTotal": 0,
"LineItems": [{"ModelType": "AccountReceivableInvoiceLineItems",
"Id": "1",
"AccountingClass": null,
"DamageWaiverPercent": 10,
"DiscountPercent": 0,
"DiscountTotal": 0,
"DueDateTime": "2024-08-08T18:20:00Z",
"ExtendedPriceTotal": 775,
"GrandTaxTotal": 0,
"GrandTotal": 775,
"HoursCharged": 1,
"Identifiers": {"ContractId": "776894",
"GeneralLedgerAccountId": "000-1200-00",
"GeneralLedgerOffsetAccountId": "000-4100-00",
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": " 17465",
"Name": "BLACK & CHROME CHAIR",
"CategoryId": 16,
"CategoryName": "Chairs",
"Description": "",
"IsAsset": false,
"Manufacturer": "PALMERSYNDER",
"Model": "",
"ModelYear": "",
"Key": "CHAIRBC-1",
"SerialNumber": "SER2024",
"Type": "T"
},
"ItemPercent": 0,
"LineNumber": 1,
"Memo": "(CHAIRBC-1) Chairs",
"MeterIn": 0,
"MeterOut": 0,
"NonTaxable": false,
"OutDateTime": "2024-08-08T18:19:00Z",
"Quantity": 500,
"TypeId": 1,
"TypeName": "Item",
"AdditionalFields": null,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
},
{"ModelType": "AccountReceivableInvoiceLineItems",
"Id": "2",
"AccountingClass": null,
"DamageWaiverPercent": 0,
"DiscountPercent": 0,
"DiscountTotal": 0,
"DueDateTime": null,
"ExtendedPriceTotal": 77.5,
"GrandTaxTotal": 0,
"GrandTotal": 77.5,
"HoursCharged": 0,
"Identifiers": {"ContractId": "776894",
"GeneralLedgerAccountId": "000-1200-00",
"GeneralLedgerOffsetAccountId": "000-4111-01",
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "",
"Name": null,
"CategoryId": 0,
"CategoryName": null,
"Description": null,
"IsAsset": null,
"Manufacturer": null,
"Model": "",
"ModelYear": null,
"Key": null,
"SerialNumber": null,
"Type": null
},
"ItemPercent": 0,
"LineNumber": 2,
"Memo": "Damage Waiver",
"MeterIn": null,
"MeterOut": null,
"NonTaxable": false,
"OutDateTime": null,
"Quantity": 1,
"TypeId": 3,
"TypeName": "Damage Waiver",
"AdditionalFields": null,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
}
],
"OrderedBy": "",
"OtherTotal": 0,
"PaidTotal": 0,
"PickedUpBy": "",
"RentTotal": 775,
"RevenueDateTime": "2024-08-08T05:00:00Z",
"SaleTotal": 0,
"StartDateTime": "2024-08-08T05:00:00Z",
"State": "Posted",
"TaxableTotal": 0
}

[Elite Account Receivable Invoices] Get By Id

Single Elite account receivable invoice by Id

Authorizations:

API Key

path Parameters

InvoiceId

required

string

Responses

Response Schema: application/json

ModelType

string

Value: "AccountReceivableInvoice"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.Id

ContractTotal

number

Total price of the contract excluding sales tax total. From the Contract Information box, this is the sum of Rent Total, Sales Total, Damage Waiver Total, Other Total, and Road Tax Total.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.TransAmount

ContractType

string

Enum: "Cash" "Credit" "Invoice"

Type of contract. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Information' tab → 'Order Info' section → 'Contract Type'	AccountingAPIQueueTR.TransCodeId

CurrencyCode

string or null

Currency code value set in the accounting system. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Information' tab → 'Pricing' section → 'Currency'	CurrencyExchange.AccountingLink

CustomerPurchaseOrderNumber

string or null

Customer purchase order number associated to the invoice. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Information' tab → 'General Info' Section → 'P.O. number'	AccountingAPIQueueTR.CustomerPONumber

DamageWaiverTotal

number

Total price of the damage waiver. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Dmg Wvr'	AccountingAPIQueueTR.DamageWaiverAmount

object

Ship to / delivery details associated with the contract on the invoice. Found on the Contract Processing screen. Expand to see nested fields.

Type

string

Value: "Default"

A general label that could be used to help define the type of address being returned.

City

string

City or Town for this address.

Software	UI	Database
Elite	'Delivery' tab → 'Used At/Delivery Address' → 'City'	Transactions.DeliveryCity

Line1

string

Includes the main address details such as street number, street name, and any additional information as needed, such as apartment or building number.

Software	UI	Database
Elite	'Delivery' tab → 'Used At/Delivery Address' → 'Street'	Transactions.DeliveryAddress.Id

PostalCode

string

May be postal code, postcode, PIN, ZIP Code, etc. depending on the country.

Software	UI	Database
Elite	'Delivery' tab → 'Used At/Delivery Address' → 'Postcode'	Transactions.DeliveryZip

Province

string

???

Software	UI	Database
Elite	'Delivery' tab → 'Used At/Delivery Address' → 'City'	Transactions.DeliveryCity

EndDateTime

string or null <date-time>

Date and time when the contract was closed.

Software	Filterable	UI	Database
Elite	Yes	N/A	Transactions.CLDT

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	AccountingAPIQueueTR.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' Column	AccountingAPIQueueTR.ErrorMsg

ExchangeRate

number or null

Exchange rate of the contract on the invoice.

Software	UI	Database
Elite		Transactions.ExchangeRate

GrandTaxTotal

number

Total amount of sales tax invoiced. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Tax'	AccountingAPIQueueTR.TaxAmount

GrandTotal

number

Total price of the contract including sales tax. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Total'	AccountingAPIQueueTR.TotalAmount

object

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

ContractId

string

Contract Id associated to the invoice, which will also map to the Id property on the /Invoices endpoint. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Contract #'	AccountingAPIQueueTR.ContractNumber

BatchId

string or null

Elite accounting batch id associated with the invoice. Found on the 'Accounting Queue' screen.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	'ID / Batch' Column	AccountingAPIQueueTR.Batch

ContractStoreId

string or null

Store Id associated to the contract on the invoice.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.Store

CustomerId

string or null

Elite customer id associated with the invoice.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.CustomerNumber

ExternalLocationId

string or null

External location Id associated to the invoice.

Software	UI	Database
Elite	N/A	AccountingLocation.AccountingLink

ExternalInvoiceId

string or null

External invoice Id associated to the invoice.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.ExternalInvoiceId

ExternalCustomerId

string or null

The value from a 3rd party system that identifies the Customer record for integrations.

Software	UI	Database
Elite	N/A	CustomerFile.APILink

ParentContractId

string or null

Parent contract id associated with the invoice.

Software	UI	Database
Elite	N/A	Transactions.ParentContract

InvoiceNumber

string or null

The Sequential Invoice Number associated with the Contract.

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

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.InvoiceNumber

ItemPercentageTotal

number or null

Total value of item percentage on the contract. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Road Tax'	Transactions.ItemPercentage

Array of objects

A collection of line items related to the contract Id. The UI for these nested fields is found on the 'Contract Processing' screen under the 'Items' tab. To configure the columns, double click on the header of Line Items to reveal a menu that allows a user to add/view other available options. Expand to see nested fields.

Array

ModelType

string

Value: "AccountReceivableInvoiceLineItem"

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

Id

string

Unique identifier for the model type.

Software	UI	Database
Elite	'Items' tab → configurable column	AccountingAPIQueueTRDetail.Id

AccountingClass

string or null

Class / Category in the accounting system.

Software	UI	Database
Elite	N/A	AccountingClass.AccountingLink

DamageWaiverPercent

number or null

Percentage used in the damage waiver calculation on the line item.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.DmgWvr

DiscountPercent

number or null

Percentage discount applied to the line item.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.DiscountPercent

DiscountTotal

number or null

Discount amount applied to the line item.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.DiscountAmount

DueDateTime

string <date-time>

The date the item was returned.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.DDT

ExtendedPriceTotal

number or null

Extended line item price.

Software	UI	Database
Elite	'Items' tab → configurable column	(TransactionItems.PRIC - TransactionItems.DiscountAmount) OR AccountingAPIQueueTRDetail.ItemAmount

GrandTaxTotal

number

Total sales tax amount for the line item.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.TaxAmount

GrandTotal

number

Total price charged on the line item, before adjustments from DiscountTotal.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.PRIC or AccountingAPIQueueTRDetail.ItemAmount

HoursCharged

number or null

Total value of the hours charged.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.HRSC

object

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

object

Elite item associated to this invoice line item.

ItemPercent

number or null

Percentage used in the Item Percentage calculation for the item.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.ItemPercentage

LineNumber

integer

The line number in which this item was added onto the contract.

Software	UI	Database
Elite	'Items' tab → configurable column	AccountingAPIQueueTRDetail.LineNumber

Memo

string or null

Memo associated to the line item.

Software	UI	Database
Elite	'Items' tab → configurable column	AccountingAPIQueueTRDetail.ItemMemo

MeterIn

number or null

Meter reading on the line item when it was returned.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.ReadingIn

MeterOut

number or null

Meter reading on the line item when it was sent out.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.ReadingOut

NonTaxable

boolean

Flag denoting if the item is non taxable.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.Nontaxable

OutDateTime

string <date-time>

Date representing when the line item was sent out.

Software	UI	Database
Elite	'Items' tab → configurable column	TransactionItems.OutDate

Quantity

number or null

Quantity associated to the line item. Number of units recorded on the contract for this line item.

Software	UI	Database
Elite	'Items' tab → configurable column	AccountingAPIQueueTRDetail.ItemQuantity

TypeId

integer or null

Invoice line item type identifier.

Table of available type Ids

Type Id

Type Name

1

TransItem

2

SalesTax

3

DamageWaiver

4

ItemPercentage

5

OtherIncome

6

PaidPriorToClose

7

Credit

8

Disbursement

Software	UI	Database
Elite	'Items' tab → configurable column	AccountingAPIQueueTRDetail.LineItemTypeId

TypeName

string

Enum: "TransItem" "SalesTax" "DamageWaiver" "ItemPercentage" "OtherIncome" "PaidPriorToClose" "Credit" "Disbursement" null

Invoice line item type name

Software	UI	Database
Elite	'Items' tab → configurable column	AccountingAPIQueueTRDetail.LineItemTypeId

OrderedBy

string or null

Customer representative who originated the contract. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Information' tab → 'Order Info' Section → 'Ordered by'	Transactions.OrderedBy

OtherTotal

number

Total price of other/miscellaneous items on the contract. Found on the Contract Processing screen.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Other'	AccountingAPIQueueTR.OtherAmount

PaidTotal

number

Total amount paid prior to the contract being closed.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Paid'	AccountingAPIQueueTR.PaidAmount

PickedUpBy

string or null

Customer representative who picked up the items.

Software	UI	Database
Elite	'Information' tab → 'Order Info' Section → 'Picked up by'	Transactions.PickedUpBy

RentTotal

number

Total price of rental items on the contract.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Rent'	AccountingAPIQueueTR.RentAmount

RevenueDateTime

string <date-time>

Date and time of the revenue posting.

Software	Filterable	UI	Database
Elite	Yes	N/A	Transactions.RevenueDate

SaleTotal

number

Total price of sale items on the contract.

Software	UI	Database
Elite	'Items' tab → 'Contract Information' section → 'Sale'	AccountingAPIQueueTR.SaleAmount

StartDateTime

string <date-time>

Date and time of when the contract opened.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.TransDate

State

string

Enum: "Pending" "Posted" "Error"

Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted', then it can't be updated to another state. Found in the Accounting Queue. Toggle the 'Status' dropdown in the UI to reveal which journal entries are in which state.

Possible Enum Values

Pending: All payments will initially have a Pending state. Payment will not reflect on the AmountDue of the contract until a Get inquiry of this payment has a Posted value under State. The duration until the status is updated is dependent on system cycle settings.
Posted: Once the value is set to Posted, the AmountDue will be updated. Once the value is shown as Posted, it can not update to another state.
Error: An error occurred in the process. Please check ErrorCode and ErrorDescription.

Software	Filterable	UI	Database
Elite	Yes	'Status' dropdown	AccountingAPIQueueTR.DatePosted, AccountingAPIQueueTR.DateError

TaxableTotal

number

Total taxable price of the contract. Sum of Damage Waiver Total, Other Total, Rent Total, Road Tax Total, and Sale Total.

Software	UI	Database
Elite	N/A	N/A

Response samples

200
4XX

Content type

application/json

{"ModelType": "AccountReceivableInvoice",
"Id": "1",
"ContractTotal": 852.5,
"ContractType": "Invoice",
"CurrencyCode": null,
"CustomerPurchaseOrderNumber": "",
"InvoiceNumber": "",
"DamageWaiverTotal": 77.5,
"Delivery": {"Address": {"Type": "Default",
"City": "",
"Line1": "",
"PostalCode": "",
"Province": ""
},
"DateTime": "2024-08-08T18:19:00Z",
"LocationName": ""
},
"EndDateTime": "2024-08-08T05:00:00Z",
"ErrorCode": null,
"ErrorDescription": null,
"ExchangeRate": 1,
"GrandTaxTotal": 0,
"GrandTotal": 852.5,
"Identifiers": {"BatchId": 6525,
"ContractId": "776894",
"ContractStoreId": "001",
"CustomerId": "225321",
"ExternalCustomerId": "",
"ExternalInvoiceId": null,
"ExternalLocationId": null,
"ParentContractId": ""
},
"ItemPercentageTotal": 0,
"LineItems": [{"ModelType": "AccountReceivableInvoiceLineItems",
"Id": "1",
"AccountingClass": null,
"DamageWaiverPercent": 10,
"DiscountPercent": 0,
"DiscountTotal": 0,
"DueDateTime": "2024-08-08T18:20:00Z",
"ExtendedPriceTotal": 775,
"GrandTaxTotal": 0,
"GrandTotal": 775,
"HoursCharged": 1,
"Identifiers": {"ContractId": "776894",
"GeneralLedgerAccountId": "000-1200-00",
"GeneralLedgerOffsetAccountId": "000-4100-00",
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": " 17465",
"Name": "BLACK & CHROME CHAIR",
"CategoryId": 16,
"CategoryName": "Chairs",
"Description": "",
"IsAsset": false,
"Manufacturer": "PALMERSYNDER",
"Model": "",
"ModelYear": "",
"Key": "CHAIRBC-1",
"SerialNumber": "SER2024",
"Type": "T"
},
"ItemPercent": 0,
"LineNumber": 1,
"Memo": "(CHAIRBC-1) Chairs",
"MeterIn": 0,
"MeterOut": 0,
"NonTaxable": false,
"OutDateTime": "2024-08-08T18:19:00Z",
"Quantity": 500,
"TypeId": 1,
"TypeName": "Item",
"AdditionalFields": null,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
},
{"ModelType": "AccountReceivableInvoiceLineItems",
"Id": "2",
"AccountingClass": null,
"DamageWaiverPercent": 0,
"DiscountPercent": 0,
"DiscountTotal": 0,
"DueDateTime": null,
"ExtendedPriceTotal": 77.5,
"GrandTaxTotal": 0,
"GrandTotal": 77.5,
"HoursCharged": 0,
"Identifiers": {"ContractId": "776894",
"GeneralLedgerAccountId": "000-1200-00",
"GeneralLedgerOffsetAccountId": "000-4111-01",
"InvoiceId": "1"
},
"Item": {"ModelType": "Item",
"Id": "",
"Name": null,
"CategoryId": 0,
"CategoryName": null,
"Description": null,
"IsAsset": null,
"Manufacturer": null,
"Model": "",
"ModelYear": null,
"Key": null,
"SerialNumber": null,
"Type": null
},
"ItemPercent": 0,
"LineNumber": 2,
"Memo": "Damage Waiver",
"MeterIn": null,
"MeterOut": null,
"NonTaxable": false,
"OutDateTime": null,
"Quantity": 1,
"TypeId": 3,
"TypeName": "Damage Waiver",
"AdditionalFields": null,
"Name": null,
"CreatedDateTime": null,
"UpdatedDateTime": null
}
],
"OrderedBy": "",
"OtherTotal": 0,
"PaidTotal": 0,
"PickedUpBy": "",
"RentTotal": 775,
"RevenueDateTime": "2024-08-08T05:00:00Z",
"SaleTotal": 0,
"StartDateTime": "2024-08-08T05:00:00Z",
"State": "Posted",
"TaxableTotal": 0
}

[Elite Account Receivable Payments] Get All

All Elite account receivable payments, use query parameters to filter

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType

string

Value: "AccountReceivablePayment"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.Id

ContractCodeName

string

Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment. Found on the 'Accounting Queue' screen.

Software	Filterable	UI	Database
Elite	Yes	'Type' column	AccountingAPIQueueTR.TransactionType

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' column	AccountingAPIQueueTR.ErrorMsg

GrandTotal

number

Total amount credited to the customer invoice. Found on the 'Accounting Queue' screen.

Software	Filterable	UI	Database
Elite	Yes	'Amount' column	AccountingAPIQueueTR.TransAmount

object

Memo

string

Note, reference or description related to the payment. Found on the 'Accounting Queue' screen.

Software	Filterable	UI	Database
Elite	Yes	'Memo' column	AccountingAPIQueueTR.TransMemo

Method

string

Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.TransClass

PostedDateTime

string <date-time>

Date and time when the payment was posted.

This holds the posting time even when State is "Pending"

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.TransDate

State

string

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.

Possible Enum Values

Pending: All payments will initially have a Pending state. Payment will not reflect on the AmountDue of the contract until a Get inquiry of this payment has a Posted value under State. The duration until the status is updated is dependent on system cycle settings.
Posted: Once the value is set to Posted, the AmountDue will be updated. Once the value is shown as Posted, it can not update to another state.
Error: An error occurred in the process. Please check ErrorCode and ErrorDescription.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.DatePosted OR AccountingAPIQueueTR.DateError

Response samples

200
4XX

Content type

application/json

{"ModelType": "AccountReceivablePayment",
"Id": "52",
"ContractCodeName": "Payment",
"ErrorCode": null,
"ErrorDescription": "",
"GrandTotal": 10,
"Identifiers": {"ContractId": "001735",
"ExternalInvoiceId": "654321",
"InvoiceNumber": "12345",
"ExternalContractId": "654321",
"CreditSourceContractId": null,
"CreditSourceInvoiceNumber": null,
"ExternalCreditId": null,
"CustomerId": "54681",
"ExternalCustomerId": "54681",
"ExternalTransactionId": "99942"
},
"Memo": "Test",
"Method": "Cash",
"TransactionDate": "2024-08-16T11:34:20Z",
"PostedDateTime": "2024-08-21T14:11:18Z",
"State": "Posted"
}

[Elite Account Receivable Payments] Create

Create a single Elite account receivable payment

Authorizations:

API Key

Request Body schema: application/json
required

ContractCodeName

required

string

Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment.

Validation

Required
Must be one of the listed values.

required

object

Identifiers Needed for All Requests
ONE from each of the bullet points below is REQUIRED:

ContractId, ExternalInvoiceId, or InvoiceNumber
CustomerId or ExternalCustomerId

Payment Requests Identifier Requirements
When ContractCodeName = Payment, the ExternalTransactionId is REQUIRED to be set in addition.

Credit Requests Identifier Requirements
When ContractCodeName = 'Credit', ONE of the following from each bullet point is REQUIRED to be set in addition:

CreditSourceContractId or CreditSourceInvoiceNumber.
ExternalCreditId

Expand to see nested fields.

ContractId	string Contract Id associated to the payment. Contract that has credit or payment applied. Validation Conditionally Required One of the following is required: `ContractId`, `ExternalInvoiceId`, or `InvoiceNumber`.
InvoiceNumber	string The Sequential Invoice Number associated with the Contract. Validation Conditionally Required One of the following is required: `ContractId`, `ExternalInvoiceId`, or `InvoiceNumber`.
ExternalInvoiceId	string External invoice Id in the accounting system. It must be associated with an Elite contract accounting link. Validation Conditionally Required One of the following is required: `ContractId`, `ExternalInvoiceId`, or `InvoiceNumber`.
CreditSourceContractId	string Contract Id sourcing the credit amount. This is the credit contract that sourced the credit being applied. Validation Conditionally Required When `ContractCodeName = Credit`, one of the following is required: `CreditSourceContractId` or `CreditSourceInvoiceNumber`.
CreditSourceInvoiceNumber	string The Sequential Invoice Number associated with the Credit Source Contract. Validation Conditionally Required When `ContractCodeName = Credit`, one of the following is required: `CreditSourceContractId` or `CreditSourceInvoiceNumber`.
ExternalCreditId	string External credit memo Id in the accounting system. Credit Id must be associated to a contract accounting link. Validation Conditionally Required when `ContractCodeName = Credit`.
CustomerId	string Elite Customer Id associated with the payment. must be associated to a contract accounting link. Validation Conditionally Required One of the following is required: `CustomerId` or `ExternalCustomerId`.
ExternalCustomerId	string The value from a 3rd party system that identifies the Customer record for integrations. It must be associated with an Elite customer's accounting link. Validation Conditionally Required One of the following is required: `CustomerId` or `ExternalCustomerId`.
ExternalTransactionId	string External Transaction Id in the accounting system. Validation Conditionally Required Required when `ContractCodeName` = `Payment`

GrandTotal

required

number

Total amount credited to the customer invoice.

Validation

Required
Takes a max of 4 decimals points and will round to the hundredths place. (Ex: An input of 12.43995 will round to 12.4400)

PostedDateTime

required

string <date-time>

Date and time when the payment was posted. Format must be in this ISO-8601 format:

Validation

Required
Formatted in this ISO-8601 format: YYYY-MM-DDTHH:MM:SSZ

DateTime must be in this specific ISO-8601 format. Here is an example: 2024-09-17T11:15:05Z

Method

string

Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

Validation

Conditionally Required
Required if ContractCodeName = `Payment.
Must be one of the listed values.

Memo

string

Note, reference, or description related to the payment.

Validation

Max characters is 255.

Responses

Request samples

Payload

Content type

application/json

{"ContractCodeName": "Payment",
"ContractId": "001735",
"CustomerId": "54681",
"ExternalTransactionId": "99942",
"GrandTotal": "10",
"PostedDateTime": "2024-08-21T14:11:18Z",
"Method": "Cash",
"Memo": "Test"
}

Response samples

201
4XX

Content type

application/json

{"ModelType": "AccountReceivablePayment",
"Id": "52",
"ContractCodeName": "Payment",
"ErrorCode": null,
"ErrorDescription": "",
"GrandTotal": 10,
"Identifiers": {"ContractId": "001735",
"ExternalInvoiceId": "654321",
"InvoiceNumber": "12345",
"ExternalContractId": "654321",
"CreditSourceContractId": null,
"CreditSourceInvoiceNumber": null,
"ExternalCreditId": null,
"CustomerId": "54681",
"ExternalCustomerId": "54681",
"ExternalTransactionId": "99942"
},
"Memo": "Test",
"Method": "Cash",
"TransactionDate": "2024-08-16T11:34:20Z",
"PostedDateTime": "2024-08-21T14:11:18Z",
"State": "Posted"
}

[Elite Account Receivable Payments] Get By Id

Single Elite account receivable payment by Id

Authorizations:

API Key

path Parameters

PaymentId

required

string

Responses

Response Schema: application/json

ModelType

string

Value: "AccountReceivablePayment"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.Id

ContractCodeName

string

Enum: "Credit" "Payment"

Contract code class name, either Credit or Payment. Found on the 'Accounting Queue' screen.

Software	Filterable	UI	Database
Elite	Yes	'Type' column	AccountingAPIQueueTR.TransactionType

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' column	AccountingAPIQueueTR.ErrorMsg

GrandTotal

number

Total amount credited to the customer invoice. Found on the 'Accounting Queue' screen.

Software	Filterable	UI	Database
Elite	Yes	'Amount' column	AccountingAPIQueueTR.TransAmount

object

ExternalContractId

required

string

External contract Id in the accounting system.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.AccountingLink

ContractId

string

Contract Id associated to the payment. Contract that has credit or payment applied.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.ContractNumber

CreditSourceContractId

string

Contract Id sourcing the credit amount. This is the credit contract that sourced the credit being applied.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.KeyValue

CustomerId

string

Elite Customer Id associated with the payment.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.CustomerNumber

ExternalCreditId

string

External credit memo Id in the accounting system. Credit Id must be associated to a contract accounting link.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.ExternalId

ExternalCustomerId

string

The value from a 3rd party system that identifies the Customer record for integrations. It must be associated with an Elite customer's accounting link.

Software	UI	Database
Elite	N/A	CustomerFile.Key

ExternalInvoiceId

string

External invoice Id in the accounting system. It must be associated with an Elite contract accounting link.

Software	UI	Database
Elite	N/A	AccountingAPIQueueTR.ExternalInvoiceId OR Transactions.CNTR

Memo

string

Note, reference or description related to the payment. Found on the 'Accounting Queue' screen.

Software	Filterable	UI	Database
Elite	Yes	'Memo' column	AccountingAPIQueueTR.TransMemo

Method

string

Enum: "Card" "Cash" "Check" "Credit" "Debit"

Method of payment.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.TransClass

PostedDateTime

string <date-time>

Date and time when the payment was posted.

This holds the posting time even when State is "Pending"

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.TransDate

State

string

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.

Possible Enum Values

Pending: All payments will initially have a Pending state. Payment will not reflect on the AmountDue of the contract until a Get inquiry of this payment has a Posted value under State. The duration until the status is updated is dependent on system cycle settings.
Posted: Once the value is set to Posted, the AmountDue will be updated. Once the value is shown as Posted, it can not update to another state.
Error: An error occurred in the process. Please check ErrorCode and ErrorDescription.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueTR.DatePosted OR AccountingAPIQueueTR.DateError

Response samples

200
4XX

Content type

application/json

{"ModelType": "AccountReceivablePayment",
"Id": "52",
"ContractCodeName": "Payment",
"ErrorCode": null,
"ErrorDescription": "",
"GrandTotal": 10,
"Identifiers": {"ContractId": "001735",
"ExternalInvoiceId": "654321",
"InvoiceNumber": "12345",
"ExternalContractId": "654321",
"CreditSourceContractId": null,
"CreditSourceInvoiceNumber": null,
"ExternalCreditId": null,
"CustomerId": "54681",
"ExternalCustomerId": "54681",
"ExternalTransactionId": "99942"
},
"Memo": "Test",
"Method": "Cash",
"TransactionDate": "2024-08-16T11:34:20Z",
"PostedDateTime": "2024-08-21T14:11:18Z",
"State": "Posted"
}

Journal Entries

Retrieve a list of General Ledger Journal Entries

Supported by: Elite

This is a list of general ledger journal entries. By default you can retrieve a list of journal entries where State property is equal to 'Pending'. Apply an additional filter to the the State property in order to receive other journal entries states.

Several of these fields map to the UI in the Accounting Queue. The Accounting Queue is found from the Left Navigation bar in Elite, go to Accounting → Re-Print GL Entries → View.

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType

string

Value: "JournalEntry"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueGL.Id

object

Collection of dimensions related to a specific type. Only related to Intacct accounting integration. Each dimension has a tab on the 'Intacct Configuration' screen. Expand to see nested fields.

EntryDateTime

string or null

Date and time when the journal entry was created. Found in the Accounting Queue.

Software	Filterable	UI	Database
Elite	Yes	'Queued' column	AccountingAPIQueueGL.TransDate

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	N/A	AccountingAPIQueueGL.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' column	AccountingAPIQueueGL.ErrorMsg

object

Collection of unique IDs related to this Journal Entry. Expand to see nested fields.

Array of objects

A collection of line items related to the journal entry. Expand to see nested fields.

Memo

string or null

Memo associated with the journal entry as a whole (as opposed to the Memo present on a line item).

Software	UI	Database
Elite	N/A	AccountingAPIQueueGL.Reference

State

string

Enum: "Pending" "Posted" "Error"

Defines the state of the journal entry. Initial value of an journal entry is 'Pending'. If the value is 'Posted', then it can't be updated to another state. Found in the Accounting Queue. Toggle the 'Status' dropdown in the UI to reveal which journal entries are in which state.

Software	Filterable	UI	Database
Elite	Yes	'Status' dropdown	AccountingAPIQueueGL.DatePosted or AccountingAPIQueueGL.DateError

Response samples

200
4XX

Content type

application/json

{"ModelType": "JournalEntry",
"Id": "8484",
"Dimensions": { },
"EntryDateTime": "2024-10-25T00:00:00Z",
"ErrorCode": null,
"ErrorDescription": null,
"Identifiers": {"BatchId": 6537,
"ExternalJournalEntryId": null
},
"LineItems": [{"ModelType": "JournalEntryLineItem",
"Id": "8402",
"GrandTotal": 31.14,
"Identifiers": {"ContractId": "77777",
"CustomerId": "888888",
"ExternalContractId": null,
"ExternalCustomerId": "999999",
"JournalEntryAccountId": "000-1111-33",
"JournalEntryId": "8484"
},
"Memo": "{D} 77777 Cash",
"Name": null
},
{"ModelType": "JournalEntryLineItem",
"Id": "8403",
"GrandTotal": -31.14,
"Identifiers": {"ContractId": "77777",
"CustomerId": "888888",
"ExternalContractId": null,
"ExternalCustomerId": "999999",
"JournalEntryAccountId": "000-1111-22",
"JournalEntryId": "8484"
},
"Memo": "{D} 77777 Suspense",
"Name": null
}
],
"Memo": null,
"State": "Pending"
}

Retrieve a single General Ledger Journal Entry

Supported by: Elite

This is a single general ledger journal entries retrieved by a given journal entry id.

Several of these fields map to the UI in the Accounting Queue. The Accounting Queue is found from the Left Navigation bar in Elite, go to Accounting → Re-Print GL Entries → View.

Authorizations:

API Key

path Parameters

JournalEntryId

required

string

Responses

Response Schema: application/json

ModelType

string

Value: "JournalEntry"

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 upon creation and not updatable.

Software	Filterable	UI	Database
Elite	Yes	N/A	AccountingAPIQueueGL.Id

object

Collection of dimensions related to a specific type. Only related to Intacct accounting integration. Each dimension has a tab on the 'Intacct Configuration' screen. Expand to see nested fields.

Class

string

Classes dimension.

Software	UI	Database
Elite	'Classes' in Intacct UI	AccountingAPIQueueGLDimensions.DimensionKey = 1

Contract

string

Contracts dimension.

Software	UI	Database
Elite	N/A	AccountingAPIQueueGLDimension.DimensionKey = 9

Customer

string

Customers dimension.

Software	UI	Database
Elite	'Customers' in Intacct UI	AccountingAPIQueueGLDimension.DimensionKey = 2

Department

string

Departments dimension.

Software	UI	Database
Elite	'Departments' in Intacct UI	AccountingAPIQueueGLDimension.DimensionKey = 3

Employee

string

Employees dimension.

Software	UI	Database
Elite	'Employees' in Intacct UI	AccountingAPIQueueGLDimension.DimensionKey = 4

Item

string

Item dimension.

Software	UI	Database
Elite	N/A	AccountingAPIQueueGLDimension.DimensionKey = 5

JobSite

string

JobSite dimension. In Intacct, this will only show up as a tab if setup as a 'User Defined' field. The 'User Defined' fields are found in the 'Dimension Setup' tab on Intacct.

Software	UI	Database
Elite	'Jobsite/Venue' in Intacct UI if configured	AccountingAPIQueueGLDimension.DimensionKey = 10

Location

string

Location dimension.

Software	UI	Database
Elite	'Locations' in Intacct UI	AccountingAPIQueueGLDimension.DimensionKey = 6

Project

string

Project dimension. This will only show up as a tab in Intacct if setup as a 'User Defined' field. The 'User Defined' fields are found in the 'Dimension Setup' tab on Intacct.

Software	UI	Database
Elite	'Project' In Intacct UI if configured	AccountingAPIQueueGLDimension.DimensionKey = 8

SalesPerson

string

SalesPerson dimension. This will only show up as a tab in Intacct if setup as a 'User Defined' field. The 'User Defined' fields are found in the 'Dimension Setup' tab on Intacct.

Software	UI	Database
Elite	'Salesman' in Intacct UI if configured	AccountingAPIQueueGLDimension.DimensionKey = 11

Vendor

string

Vendors dimension.

Software	UI	Database
Elite	'Vendors' in Intacct UI	AccountingAPIQueueGLDimension.DimensionKey = 7

EntryDateTime

string or null

Date and time when the journal entry was created. Found in the Accounting Queue.

Software	Filterable	UI	Database
Elite	Yes	'Queued' column	AccountingAPIQueueGL.TransDate

ErrorCode

string or null

Short code describing the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	N/A	AccountingAPIQueueGL.ErrorCode

ErrorDescription

string or null

Longer text description of the problem. Only included when State is set to 'Error.' Found in the Accounting Queue.

Software	UI	Database
Elite	'Error' column	AccountingAPIQueueGL.ErrorMsg

object

Collection of unique IDs related to this Journal Entry. Expand to see nested fields.

BatchId

string or null

Batch Id associated with this record. Found in the Accounting Queue.

Software	UI	Database
Elite	'ID/Batch' column	AccountingAPIQueueGL.Batch

ExternalJournalEntryId

string or null

External journal entry Id from the accounting system.

Software	UI	Database
Elite	N/A	AccountingAPIQueueGL.ExternalId

Array of objects

A collection of line items related to the journal entry. Expand to see nested fields.

Array

ModelType

string

Value: "JournalEntryLineItem"

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 upon creation and not updatable.

Software	UI	Database
Elite	N/A	AccountingAPIQueueGLDetail.Id

GrandTotal

number

Line item amount. Positive values are debits. Negative values are credits.

Software	UI	Database
Elite	N/A	AccountingAPIQueueGLDetail.TransAmount

object

Collection of unique IDs related to this journal entry's line item. Expand to see nested fields.

Memo

string or null

Memo associated with this specific line item. Found in the Accounting Queue.

Software	UI	Database
Elite	'Memo' column	AccountingAPIQueueGLDetail.AcccountingAPIQueueGL.TransMemo

Memo

string or null

Memo associated with the journal entry as a whole (as opposed to the Memo present on a line item).

Software	UI	Database
Elite	N/A	AccountingAPIQueueGL.Reference

State

string

Enum: "Pending" "Posted" "Error"

Defines the state of the journal entry. Initial value of an journal entry is 'Pending'. If the value is 'Posted', then it can't be updated to another state. Found in the Accounting Queue. Toggle the 'Status' dropdown in the UI to reveal which journal entries are in which state.

Software	Filterable	UI	Database
Elite	Yes	'Status' dropdown	AccountingAPIQueueGL.DatePosted or AccountingAPIQueueGL.DateError

Response samples

200
4XX

Content type

application/json

{"ModelType": "JournalEntry",
"Id": "8484",
"Dimensions": { },
"EntryDateTime": "2024-10-25T00:00:00Z",
"ErrorCode": null,
"ErrorDescription": null,
"Identifiers": {"BatchId": 6537,
"ExternalJournalEntryId": null
},
"LineItems": [{"ModelType": "JournalEntryLineItem",
"Id": "8402",
"GrandTotal": 31.14,
"Identifiers": {"ContractId": "77777",
"CustomerId": "888888",
"ExternalContractId": null,
"ExternalCustomerId": "999999",
"JournalEntryAccountId": "000-1111-33",
"JournalEntryId": "8484"
},
"Memo": "{D} 77777 Cash",
"Name": null
},
{"ModelType": "JournalEntryLineItem",
"Id": "8403",
"GrandTotal": -31.14,
"Identifiers": {"ContractId": "77777",
"CustomerId": "888888",
"ExternalContractId": null,
"ExternalCustomerId": "999999",
"JournalEntryAccountId": "000-1111-22",
"JournalEntryId": "8484"
},
"Memo": "{D} 77777 Suspense",
"Name": null
}
],
"Memo": null,
"State": "Pending"
}

Call Logs

Supported by: Elite

Call Logs are simple note records generated in various areas of Elite's software. For instance, when modifying an open contract, you can create a new log by selecting the Add Calls tab and clicking New Call. Similarly, call logs can be created for Customers, Job Sites, and Purchase Orders. Additionally, calling an item off-rent will automatically generate a call log.

Create a new Call Log

Supported by: Elite.

Creates a new Call Log record.

Authorizations:

API Key

Request Body schema: application/json
required

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

ContractId	string or null If this Call Log is associated with a Contract, the ContractId will display here.
CustomerId	string or null If this Call Log is associated with a Customer, the CustomerId will display here.
RelationshipId	string or null
RemoteUserId	string or null

Body

string or null

This is represented in the UI as the Notes field. This contains the text of the Call Log.

ContactName

string or null

If this Call Log is associated with a Contact, the Contact's name will display here.

ForceAcknowledge

boolean

Default: false

If true, each time a user opens the record associated with this call log, a screen displaying the call log will pop up and the user will be required to click 'OK' to acknowledge it.

Type

string or null

Default: null

This is a dropdown list of categories for this call log. For example, "Sales," "Customer Problem," "Follow-up," etc.

Responses

Request samples

Payload

Content type

application/json

{"Body": "Interested in renting a trailer.",
"CreatedBy": "Leeland Frank",
"Type": "Sales"
}

Response samples

201
4XX

Content type

application/json

{"ModelType": "CallLog",
"Id": "19",
"Name": "19",
"Identifiers": {"ContractId": "495495",
"CustomerId": "41414",
"RelationshipId": "29292",
"RemoteUserId": "11"
},
"Body": "Interested in renting a trailer.",
"ContactName": null,
"CreatedBy": "Leeland Frank",
"ForceAcknowledge": false,
"Type": "Sales",
"AdditionalFields": null,
"CreatedDateTime": "2017-10-14T19:55:52Z",
"UpdatedDateTime": null,
"Hidden": 0
}

Retrieve a list of Call Logs

Supported by: Elite.

Returns an array containing all Call Logs for your organization.

Authorizations:

APIKey

Responses

Results returned as shown below.

Response Schema: application/json

Array

ModelType

string

Value: "CallLog"

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 upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Number / Call #	CallLog.Number

Name

string or null

This returns the same as the unique Id for this record.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Number / Call #	CallLog.Number

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

Body

string or null

This is represented in the UI as the Notes field. This contains the text of the Call Log.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Notes	CallLog.Notes

CreatedBy

string or null

This represents the RMS user that generated the Call Log.

Software	Supported	Filterable	UI	Database
Elite	Yes		Operator

ContactName

string or null

If this Call Log is associated with a Contact, the Contact's name will display here.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CallLog.Contact

ForceAcknowledge

boolean or null

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Force Acknowledge	CallLog.Acknowledge

Type

string or null

This is a customizable dropdown list of categories for this call log. For example, it might contain "Sales," "Customer Problem," "Follow-up," etc. To set up the call log type of your choice, please go to Program Menu → System Configurations → Transaction Configuration → Call Log Types

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Type	CallLogType.TypeName

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Date	CallLog.Date

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00. Included for future growth.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--

Hidden

integer

Enum: 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database
Elite	Yes	--	--	--

Response samples

200
4XX

Content type

application/json

{"ModelType": "CallLog",
"Id": "19",
"Name": "19",
"Identifiers": {"ContractId": "495495",
"CustomerId": "41414",
"RelationshipId": "29292",
"RemoteUserId": "11"
},
"Body": "Interested in renting a trailer.",
"ContactName": null,
"CreatedBy": "Leeland Frank",
"ForceAcknowledge": false,
"Type": "Sales",
"AdditionalFields": null,
"CreatedDateTime": "2017-10-14T19:55:52Z",
"UpdatedDateTime": null,
"Hidden": 0
}

Retrieve a single Call Log by Id

Supported by: Elite.

Retrieves a single Call Log record specified by its Call Log ID.

Authorizations:

APIKey

path Parameters

CallLogId

required

string

Provide the unique ID of the Call Log you want to retrieve.

Responses

Results returned as shown below.

Response Schema: application/json

ModelType

string

Value: "CallLog"

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 upon creation and not updatable.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Number / Call #	CallLog.Number

Name

string or null

This returns the same as the unique Id for this record.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Number / Call #	CallLog.Number

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future. Supported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.

ContractId

string or null

If this Call Log is associated with a Contract, the ContractId will display here.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Contract #	CallLog.ContractId

CustomerId

string or null

If this Call Log is associated with a Customer, the CustomerId will display here.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CallLog.CustomerId

RelationshipId

string or null

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	Operator.RelationshipId

RemoteUserId

string or null

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	Operator.OPNO

Body

string or null

This is represented in the UI as the Notes field. This contains the text of the Call Log.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Notes	CallLog.Notes

CreatedBy

string or null

This represents the RMS user that generated the Call Log.

Software	Supported	Filterable	UI	Database
Elite	Yes		Operator

ContactName

string or null

If this Call Log is associated with a Contact, the Contact's name will display here.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	N/A	CallLog.Contact

ForceAcknowledge

boolean or null

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Force Acknowledge	CallLog.Acknowledge

Type

string or null

This is a customizable dropdown list of categories for this call log. For example, it might contain "Sales," "Customer Problem," "Follow-up," etc. To set up the call log type of your choice, please go to Program Menu → System Configurations → Transaction Configuration → Call Log Types

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Type	CallLogType.TypeName

AdditionalFields

object or null

Standardized attribute for any number of additional nested fields for each RMS. May return an empty object, but there is always the possibility of added nested fields in the future.

CreatedDateTime

string or null <date-time>

A date and time stamp of when the record was created. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, April 5, 1982 at 6:43pm in US Central Standard Time is represented as 1982-04-05T18:43:00-6:00.

Software	Supported	Filterable	UI	Database
Elite	Yes	Yes	Date	CallLog.Date

UpdatedDateTime

string or null <date-time>

A date and time stamp of when the record was last updated. All dates are in ISO-8601 format. Times may include an offset from UTC. For example, August 12, 2024 at 10:57pm in US Central Standard Time is represented as 2024-08-12T22:57:00-6:00. Included for future growth.

Software	Supported	Filterable	UI	Database
Elite	No	--	--	--

Hidden

integer

Enum: 0 1

0 = false, 1 = true | True means a user-unrecoverable deletion.

Software	Supported	Filterable	UI	Database
Elite	Yes	--	--	--

Response samples

200
4XX

Content type

application/json

{"ModelType": "CallLog",
"Id": "19",
"Name": "19",
"Identifiers": {"ContractId": "495495",
"CustomerId": "41414",
"RelationshipId": "29292",
"RemoteUserId": "11"
},
"Body": "Interested in renting a trailer.",
"ContactName": null,
"CreatedBy": "Leeland Frank",
"ForceAcknowledge": false,
"Type": "Sales",
"AdditionalFields": null,
"CreatedDateTime": "2017-10-14T19:55:52Z",
"UpdatedDateTime": null,
"Hidden": 0
}

Hire Rates

Supported by: Syrinx

Hire Rates are records that define rental pricing based on duration, such as hourly, daily, and weekly rates. Since this endpoint pertains to Syrinx, a product primarily used in the UK, the term "Hire" is used instead of "Rental." These rates are managed via the Update Hire Rates screen in Syrinx SP Configuration under Administration. UI terminology may vary between the configuration and equipment screens, which is why the field tables often include multiple UI terms for clarity.

Retrieve a list of Hire Rates

Supported by: Syrinx

Returns an array containing all HireRates for your organization's equipment.

Authorizations:

API Key

Responses

Response Schema: application/json

Array

ModelType

string

Value: "GapiHireRate"

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 upon creation and not updatable.

Software	Supported	Database
Syrinx	Yes	EQP_ID

Name

string

Software	Supported	UI	Database
Syrinx	Yes	Hire Rate / Stock No	EQP_NAME

CategoryName

string

The category that the hire rate belongs to.

Software	Supported	UI	Database
Syrinx	Yes	Cat / Part of Stock No	EQP_NAME

DayRate

number

The flat rate to charge for a single day.

Software	Supported	UI	Database
Syrinx	Yes	Daily Rate / Per Day	EQP_DFLT_DAY_RATE

HourRate

number

The rate to charge per hour.

Software	Supported	UI	Database
Syrinx	Yes	Hourly Rate / Hour	EQP_DFLT_HOUR_RATE

WeekRate

number

The rate to charge per week.

Software	Supported	UI	Database
Syrinx	Yes	Weekly Rate	EQP_DFLT_WEEK_RATE

WeekRateHalfDay

number

The rate to charge for half a week day.

Software	Supported	UI	Database
Syrinx	Yes	4 Hrs	EQP_WEEK_RATE_HALF_DAY

WeekRate1Day

number

The rate to charge for a week day.

Software	Supported	UI	Database
Syrinx	Yes	1 Day	EQP_WEEK_RATE_1_DAY

WeekRate2Day

number

The rate to charge for 2 week days.

Software	Supported	UI	Database
Syrinx	Yes	2 Days	EQP_WEEK_RATE_2_DAY

WeekRate3Day

number

The rate to charge for 3 week days.

Software	Supported	UI	Database
Syrinx	Yes	3 Days	EQP_WEEK_RATE_3_DAY

WeekRate4Day

number

The rate to charge for 4 week days.

Software	Supported	UI	Database
Syrinx	Yes	4 Days	EQP_WEEK_RATE_4_DAY

WeekendRate

number

The rate to charge over a weekend.

Software	Supported	UI	Database
Syrinx	Yes	W/E	EQP_DFLT_WEEKEND_RATE

MonthRate

number

The rate to charge per month.

Software	Supported	UI	Database
Syrinx	Yes	Month	EQP_DFLT_MONTH_RATE

Response samples

200

Content type

application/json

{"ModelType": "GapiHireRate",
"Id": "123",
"Name": "1.5 ton Excavator",
"CategoryName": "Excavators",
"DayRate": null,
"HourRate": 40.1899,
"WeekRate": 160.1899,
"WeekRateHalfDay": null,
"WeekRate1Day": 64.1899,
"WeekRate2Day": 96.1899,
"WeekRate3Day": 128.1899,
"WeekRate4Day": 144.1899,
"WeekendRate": null,
"MonthRate": null
}

Retrieve a single Hire Rate by Id

Supported by: Syrinx

Retrieves a single Hire Rates record specified by its specified by the HireRateId.

Authorizations:

API Key

path Parameters

HireRateId

required

string

Example: 123

Provide the unique ID of the Hire Rates you want to retrieve.

Responses

Response Schema: application/json

ModelType

string

Value: "GapiHireRate"

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 upon creation and not updatable.

Software	Supported	Database
Syrinx	Yes	EQP_ID

Name

string

Software	Supported	UI	Database
Syrinx	Yes	Hire Rate / Stock No	EQP_NAME

CategoryName

string

The category that the hire rate belongs to.

Software	Supported	UI	Database
Syrinx	Yes	Cat / Part of Stock No	EQP_NAME

DayRate

number

The flat rate to charge for a single day.

Software	Supported	UI	Database
Syrinx	Yes	Daily Rate / Per Day	EQP_DFLT_DAY_RATE

HourRate

number

The rate to charge per hour.

Software	Supported	UI	Database
Syrinx	Yes	Hourly Rate / Hour	EQP_DFLT_HOUR_RATE

WeekRate

number

The rate to charge per week.

Software	Supported	UI	Database
Syrinx	Yes	Weekly Rate	EQP_DFLT_WEEK_RATE

WeekRateHalfDay

number

The rate to charge for half a week day.

Software	Supported	UI	Database
Syrinx	Yes	4 Hrs	EQP_WEEK_RATE_HALF_DAY

WeekRate1Day

number

The rate to charge for a week day.

Software	Supported	UI	Database
Syrinx	Yes	1 Day	EQP_WEEK_RATE_1_DAY

WeekRate2Day

number

The rate to charge for 2 week days.

Software	Supported	UI	Database
Syrinx	Yes	2 Days	EQP_WEEK_RATE_2_DAY

WeekRate3Day

number

The rate to charge for 3 week days.

Software	Supported	UI	Database
Syrinx	Yes	3 Days	EQP_WEEK_RATE_3_DAY

WeekRate4Day

number

The rate to charge for 4 week days.

Software	Supported	UI	Database
Syrinx	Yes	4 Days	EQP_WEEK_RATE_4_DAY

WeekendRate

number

The rate to charge over a weekend.

Software	Supported	UI	Database
Syrinx	Yes	W/E	EQP_DFLT_WEEKEND_RATE

MonthRate

number

The rate to charge per month.

Software	Supported	UI	Database
Syrinx	Yes	Month	EQP_DFLT_MONTH_RATE

Response samples

200

Content type

application/json

{"ModelType": "GapiHireRate",
"Id": "123",
"Name": "1.5 ton Excavator",
"CategoryName": "Excavators",
"DayRate": null,
"HourRate": 40.1899,
"WeekRate": 160.1899,
"WeekRateHalfDay": null,
"WeekRate1Day": 64.1899,
"WeekRate2Day": 96.1899,
"WeekRate3Day": 128.1899,
"WeekRate4Day": 144.1899,
"WeekendRate": null,
"MonthRate": null
}

Changelog by Release

This changelog outlines modifications to public APIs. Releases consisting solely of internal improvements are mentioned only if they represent the latest version update.

Changelog

2024.17.00

Revised the following endpoints for accuracy and clarity: GET all, GET by Id, and PATCH requests at /workOrders/{WorkOrderId}/parts, both LOOKUP requests at /workOrders, PATCH requests for all Elite - Accounting endpoints, both GET requests for Syrinx at /HireRates.
Increased the font size and applied bold formatting to the Table of Contents headers for improved readability.
Added the following field to the /customers endpoint: AdditionalFields.InsuranceExpirationDate.
Moved the recently added Call Logs endpoint to a new section titled "Elite - Other" since this endpoint is only available for integrations with the Elite platform.
Updated field description at for AmountDue at the /contracts response.
Added the following readOnly field to the /contracts response: AmountPaid, which defaults to 0.
Added the following readOnly field to the /lineItems response: ShowOnContract, which defaults to false. This can also be seen in the Contract model since the /lineItems option returns as a part of that model.
Added the following readOnly field to the /contracts response: AdditionalFields.ExternalTaxCode.
Added the following field to the /stocks and /products request and response models: AdditionalFields.ExternalTaxCode.
Updated the requirements for the POST request at /elite/accountsReceivable/payments.

2024.15.00

Revised the following endpoints for accuracy and clarity: GET all and GET by Id requests at /Depots, POST and PATCH requests at /workOrders, and all GET requests at /elite/AccountsReceivable.

2024.14.00

Added GET at /apikey/stock/{StockId}/workOrders. This will retrieve all the work orders for a given existing Stock Id.
Added endpoint Call Logs.
Added the following fields to the /contracts endpoint: LineItems.AdditionalFields.SalesRepId, LineItems.AdditionalFields.SalesRepName, LineItems.AdditionalFields.AssignedtoId, and LineItems.AdditionalFields.AssignedtoName.
Added an additional array to the /contracts.LineItems /LineItems endpoint called LineItems.AllRates with the following objects: LineItems.AllRates.PeriodName, LineItems.AllRates.Rate, and LineItems.AllRates.CurrencyType.
Added the following fields to the /contracts endpoint: IsDelivery, IsPickup, and Revision. Contracts.IsDelivery and Contracts.IsPickup both default to false.
Added the following response ONLY field to the /customers, /locations, /products, and /stocks endpoints: Revisions.
Allowed for an additional required field option to the POST request at elite/accountsReceivable/payments: Identifiers.ExternalContractId.
Added the following fields to the /products and /stocks endpoint: Identifiers.Alias. Identifiers.Barcode, AdditionalFields.TaxCode, and AdditionalFields.TaxName. Important Note: AdditionalFields.TaxCode is a the ONLY updatable field.

2024.13.00

Updated POST required descriptions at /elite/accountsReceivable/payments to increase clarity for customers.
Note added to GET at /lineItem endpoints to clarify that the fields Rates is currently not supported by Elite.
Updated GET documentation for /customers, /contacts, and /salespersons endpoints.

2024.12.00

Added POST at /contracts/callOffRent to a new section called Contract Actions. This will call off rent all line items on the contract and mark the contract as “Called off Rent.”
Added POST at /lineItem/callOffRent to a new section called Line Item Actions. This will call off rent select line items and will only mark the contract as “Called off Rent” if all line items are called off rent.
Added PATCH at /stock/:StockId with the following properties available to update: SerialNumber, Depreciation.TotalDepreciation, Depreciation.CurrentValue, AdditionalFields.CaseQuantity, AdditionalFields.CriticalLevel, AdditionalFields.GlNumber, AdditionalFields.RentalCaseQuantity. AdditionalFields.ReorderMaximum, and AdditionalFields.ReorderMinimum.

2024.11.00

Added AdditionalFields.CaseQuantity, AdditionalFields.CriticalLevel, AdditionalFields.RentalCaseQuantity, AdditionalFields.ReorderMinimum, and AdditionalFields.ReorderMaximum to the /Product and /Stock endpoints.
Added AdditionalFields.Restrictions to /customers endpoint.
Updated GET documentation for /categories endpoints.

2024.08.00

Added Status field to /Stock endpoint.

2024.07.02

Added endpoint Work Order.
Added Esignstate field to response model for /contracts and /contracts/{ContractID} endpoint.
Added DisplayOnStorefront field to response model for /products and /products/{ProductID} endpoint.
Added AdditionalFields.SpecDescription field to response model for /products and /products/{ProductID} endpoint.
Added InvoiceNumber field to response model for /elite/accountsReceivable/invoices and /elite/accountsReceivable/invoices/{InvoiceId} endpoint.

2024.06.00

Added support for Line Item endpoint with all RMS products (Elite, Essentials, and Syrinx).
Added ExternalRecievableBalance field to request and response model for /customers and /customers/{CustomerID} endpoint.

2023.14.01

Fixed issue where Accounts Receivable endpoints were not being displayed in the documentation.

2023.12.01

Modified QuantityAdjustment field in request model for /stock/{StockId}/bulkAdjust endpoint.
Only positive values are allowed for this field.
Removed unsupported internal endpoints.

Point of Rental API (2024.17.00)

Gaining Access

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

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

3. You will need to have a 'Global Login' enabled account.

4. You will need to obtain an API Key.

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

Future-proofing

Max Request Size

Filtering

Supported Filters

Filter Structure and Examples

Your First API Call

Paging

Response Codes

Select the Correct ID Across API Endpoints

ID Naming Conventions

Additional Resources

Utilize Elite Accounting APIs

Direct vs. Custom Integrations

Modes

How the Various Direct Integration Modes Function

Design

How the APIs Design Power Our Integrations

Flow

How the Data Flows and Synchronizes

SQL

Example Data Flow: SQL Views and Synchronization

AR Payments

How Transaction Mode Utilizes AR Payments

Summary

Categories

Retrieve a list of Categories

Authorizations:

Responses

Response Schema: application/json

Response samples

Retrieve a single Category by Id

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Contacts

Retrieve a list of Contacts

Authorizations:

Responses

Response Schema: application/json

Response samples

Create a new Contact

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve a single Contact by Id

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Update a single Contact by Id

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Contract Actions

Call a Contract Off Rent

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Contracts

Retrieve a list of Contracts

Authorizations:

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required