Thank you for using Point of Rental's API, other developer services, and associated software
(collectively, "API"). By accessing or using our API, you are agreeing to the terms below.
Collectively, we refer to the terms below, any additional terms, terms within the accompanying
API documentation, and any applicable policies and guidelines as the "Terms." You agree to
comply with the Terms and that the Terms control your relationship with us. So please read all
the Terms carefully. If you use the API as an interface to, or in conjunction with other Point
of Rental products or services, then the terms for those other products or services also apply.
Some of the software required by or included in the API may be offered under an open source
license. Open source software licenses are identified in the API documentation and constitute
separate written agreements for use of the API. To the limited extent the open source software
license expressly supersedes the Terms, the open source license instead sets forth your
agreement with Point of Rental for the applicable open source software.
Point of Rental reserves the right to suspend or terminate your right to access the API, in its
sole discretion, in the event of any violation of these Terms.
Under the Terms, "Point of Rental" means Point of Rental, Inc., with offices at 14401 Statler
Blvd., Fort Worth, Texas 76155, United States and its affiliates. We may refer to Point of
Rental as “we”, “our”, or “us” in the Terms.
ACCOUNT AND REGISTRATION
You may not use the API and may not accept the Terms if (a) you are not of legal age to form a
binding contract with Point of Rental, or (b) you are a person barred from using or receiving
the API under the applicable laws of the United States or other countries including the country
in which you are resident or from which you use the API.
If you are using the API on behalf of an entity, you represent and warrant that you have
authority to bind that entity to the Terms and, by accepting the Terms, you are doing so on
behalf of that entity (and all references to "you" in the Terms refer to that entity).
In order to access the API you may be required to provide certain information (such as
identification or contact details) as part of the registration process or as part of your
continued use of the API. Any registration information you give to Point of Rental will always
be accurate and up to date, and you'll inform us promptly of any updates.
All activities that occur using your access credentials are your responsibility. Access
credentials are non-transferable and non-assignable. Keep them secret. Do not try to circumvent
them.
USING THE API
Subject to the limitations set forth in these Terms, we grant you a limited, non-exclusive,
non-assignable, non-transferable, revocable license to access and use the API only as necessary
to develop, test, implement, use and support an application (an "Application" or "App") that
interoperates with the Point of Rental services. You may charge for your Application; however,
you may not sell, rent, lease, sublicense, redistribute, or syndicate access to the API.
You must use the API only in accordance with these Terms and will not: (A) access the API in
violation of any law, regulation or third-party rights; (B) access the API in any manner that
(i) compromises, breaks or circumvents any of our technical processes or security measures
associated with the Point of Rental services, (ii) poses a security vulnerability to customers
or users of the Point of Rental services, or (iii) tests the vulnerability of our systems or
networks; (C) access the API in order to replicate or compete with the Point of Rental services;
(D) attempt to reverse engineer or otherwise derive source code, trade secrets, or know-how of
the API or the Point of Rental services; or (E) attempt to use the API in a manner that exceeds
rate limits, or constitutes excessive or abusive usage.
You will only access (or attempt to access) the API by the means described in the API
documentation and for the purposes that have been expressly licensed to you by Point of Rental.
If Point of Rental assigns you developer credentials (e.g. client IDs), you must use them to
access the API for development purposes. You will not misrepresent or mask either your identity
or your API Client's identity when using the API or your developer account.
Point of Rental sets and enforces limits on your use of the API (e.g. limiting the number of API
calls your API Client may make or the number of users you may serve), in our sole discretion.
You agree to, and will not attempt to circumvent, such limitations. If you would like to use the
API beyond these limits, you must obtain Point of Rental's express consent (and Point of Rental
may decline such request or condition acceptance on your agreement to additional terms and/or
charges for that use).
PROHIBITED USES OF THE API
When using the API, you may not (or allow those acting on your behalf to):
sublicense the API, any data obtained using the API, or any other Point of Rental Software
for use by a third party;
create an API Client that functions substantially the same as the API and offer it for use
by third parties;
reverse engineer, decompile or disassemble the API or any related software;
scrape, build databases or otherwise create copies of any data accessed or obtained using
the API, except as necessary to enable an intended usage scenario for your Application;
circumvent any technological measures intended to prevent direct database access, or
manufacture tools or products to that effect;
use an unreasonable amount of bandwidth, or adversely impact the stability of the API or the
behavior of other apps using the API;
disrupt, interfere with, or attempt to gain unauthorized access to services, servers,
devices, or networks connected to or which can be accessed via the API;
perform an action with the intent of introducing to Point of Rental products and services
any viruses, worms, defects, Trojan horses, malware, or any items of a destructive nature;
use the API to engage in, or to encourage or promote, illegal activity or violation of third
party right;
defame, abuse, harass, stalk, or threaten others;
promote or facilitate unlawful online gambling or disruptive commercial messages or
advertisements;
use the API for any activities where the use or failure of the API could lead to death,
personal injury, or environmental damage (such as the operation of nuclear facilities, air
traffic control, or life support systems); or
remove, obscure, or alter any Point of Rental terms of service or any links to or notices of
those terms.
remove any attribution(s) required by Point of Rental as described in the documentation for
the API.
COMPLIANCE WITH APPLICABLE PRIVACY AND DATA PROTECTION LAWS
You must comply with all laws and regulations applicable to your use of the data accessed
through the API, including without limitation laws related to privacy, biometric data, data
protection and confidentiality of communications. By way of example and not limitation, you
will, and will ensure that your employees, agents and service providers will, comply with all
applicable local, state, provincial, national or international laws or regulations, and policies
of regulatory bodies or agencies, including: (i) the European Union General Data Protection
Regulation (Regulation 2016/679); (ii) the ePrivacy Directive (Directive 2002/58/EC) or any
local or European law implementing or replacing the same; (iii) the Canadian Personal
Information Protection and Electronic Documents Act (S.C. 2000, c. 5); (iv) the Federal Trade
Commission Act of 1914 (15 U.S.C. § 43); and (v) the Children’s Online Privacy Protection Act
(15 U.S.C. § 6501-6505) or any regulations implemented pursuant thereto.
Your use of the API is conditioned upon implementing and maintaining appropriate protections and
measures for your service and Application, and that includes your responsibility to the data
obtained through the use of the API. For the data you obtain through the API, you must:
obtain all necessary consents before processing data and obtain additional consent if the
processing changes ("Data Access Consents");
implement proper retention and deletion policies, including deleting all data when a user
abandons your Application, uninstalls your Application, closes its account with you, or
abandons the account; and
maintain and comply with a written statement available to Customers and users that describes
your privacy practices regarding data and information you collect and use ("Your Privacy
Statement"), and that statement must be as protective as the Point of Rental Privacy
Statement.
Nothing in the Agreement shall be construed as creating a joint controller or processor-subprocessor
relationship between you and Point of Rental.
CONFIDENTIALITY
Each party (“Disclosing Party”) may disclose “Confidential Information” to the other party
(“Receiving Party”) in connection with these Terms, which is anything that reasonably should be
understood to be confidential given the nature of the information and the circumstances of
disclosure including non-public business, product, technology and marketing information.
Notwithstanding the above, Confidential Information does not include information that (a) is or
becomes generally available to the public without breach of any obligation owed to the
Disclosing Party; (b) was known to the Receiving Party prior to its disclosure by the Disclosing
Party without breach of any obligation owed to the Disclosing Party; (c) is received from a
third party without breach of any obligation owed to the Disclosing Party; or (d) was
independently developed by the Receiving Party.
The Receiving Party will (a) take at least reasonable measures to prevent the unauthorized
disclosure or use of Confidential Information, and limit access to those employees, affiliates
and contractors who need to know such information in connection with the Contract; and (b) not
use or disclose any Confidential Information of the Disclosing Party for any purpose outside the
scope of these Terms. Nothing above will prevent either party from sharing Confidential
Information with financial and legal advisors; provided, however, that the advisors are bound to
confidentiality obligations at least as restrictive as those in these Terms.
The Receiving Party may access or disclose Confidential Information of the Disclosing Party if
it is required by law; provided, however, that the Receiving Party gives the Disclosing Party
prior notice of the compelled access or disclosure (to the extent legally permitted) and
reasonable assistance, at the Disclosing Party's cost, if the Disclosing Party wishes to contest
the access or disclosure. If the Receiving Party is compelled by law to access or disclose the
Disclosing Party’s Confidential Information, the Disclosing Party will reimburse the Receiving
Party for its reasonable cost of compiling and providing access to such Confidential Information
as well as the reasonable cost for any support provided in connection with the Disclosing Party
seeking a protective order or confidential treatment for the Confidential Information to be
produced.
YOUR API CLIENT(S)
The API is designed to help you enhance your websites and applications ("API Client(s)"). YOU
AGREE THAT POINT OF RENTAL MAY MONITOR USE OF THE API TO ENSURE QUALITY, IMPROVE POINT OF RENTAL
PRODUCTS AND SERVICES, AND VERIFY YOUR COMPLIANCE WITH THE TERMS. This monitoring may include
Point of Rental accessing and using your API Client, for example to identify security issues
that could affect Point of Rental or its users. You will not interfere with this monitoring.
Point of Rental may use any technical means to overcome such interference.
POINT OF RENTAL MAY SUSPEND ACCESS TO THE API BY YOU OR YOUR API CLIENT WITHOUT NOTICE IF WE
REASONABLY BELIEVE THAT YOU ARE IN VIOLATION OF THE TERMS.
You will use commercially reasonable efforts to protect user information collected by your API
Client, including personal data, from unauthorized access or use and will promptly report to
your users any unauthorized access or use of such information to the extent required by
applicable law. You will provide and adhere to a privacy policy for your API Client that clearly
and accurately describes to users of your API Client what user information you collect and how
you use and share such information (including for advertising) with Point of Rental and third
parties.
Point of Rental does not acquire ownership in your API Clients, and by using our API, you do not
acquire ownership of any rights in our API or the content that is accessed through our API.
COMMUNICATION WITH POINT OF RENTAL
We may send you certain communications in connection with your use of the API. Please review the
API documentation for information about opting out of certain types of communication.
You understand and agree that your communications with Point of Rental are not confidential or
proprietary to you. If you provide feedback or suggestions about our API, then we (and those we
allow) may use such information without obligation to you.
CONTENT PROVIDED THROUGH THE API
Our API may contains some third party content (such as text, images, videos, audio, or
software). This content is the sole responsibility of the person that makes it available. We may
sometimes review content to determine whether it is illegal or violates our policies or the
Terms, and we may remove or refuse to display content. Finally, content accessible through our
API may be subject to intellectual property rights, and, if so, you may not use it unless you
are licensed to do so by the owner of that content or are otherwise permitted by law. Your
access to the content provided through the API may be restricted, limited, or filtered in
accordance with applicable law, regulation, and policy.
When a user's non-public content is obtained through the API, you may not expose that content to
other users or to third parties without explicit opt-in consent from that user.
TRADEMARKS AND PUBLICITY
Point of Rental hereby grants to you a non-transferable, non-sublicenseable, non-exclusive
license while the Terms are in effect to display Point of Rental's trademark in standard
character format for the purpose of promoting or advertising that you use the API. You must only
use the Point of Rental trademark in accordance with the Terms and for the purpose of fulfilling
your obligations under this Section.
Peek 2024-07-29 17-13
You will not make any statement regarding your use of the API which suggests partnership with,
sponsorship by, or endorsement by Point of Rental without Point of Rental's prior written
approval.
In the course of promoting, marketing, or demonstrating the API and the associated Point of
Rental products, Point of Rental may produce and distribute incidental depictions, including
screenshots, video, or other content from your API Client, and may use your company or product
name. You grant us all necessary rights for the above purposes.
TERMINATION
You may stop using the API at any time with or without notice to Point of Rental. If you want to
terminate the Terms, you must provide Point of Rental with prior written notice and, upon
termination, cease your use of the API. Point of Rental reserves the right to terminate or
modify the Terms or discontinue the API or any portion or feature or your access thereto for any
reason and at any time without liability or other obligation to you.
Upon any termination of the Terms or discontinuation of your access to the API, you will
immediately stop using the API, cease all use of the Point of Rental trademark, and delete any
cached or stored content that was retrieved by you from the API. Point of Rental may
independently communicate with any account owner whose account(s) are associated with your API
Client and developer credentials to provide notice of the termination of your right to use an
API.
When the Terms come to an end, those terms that by their nature are intended to continue
indefinitely will continue to apply, including but not limited to Confidentiality, Compliance
with Applicable Privacy and Data Protection Laws, and Warranties and Indemnification.
WARRANTIES AND INDEMNIFICATION
Unless prohibited by applicable law, if you are a business, you will defend and indemnify Point
of Rental, and its affiliates, directors, officers, employees, and users, against all
liabilities, damages, losses, costs, fees (including legal fees), and expenses relating to any
allegation or third-party legal proceeding to the extent arising from:
your misuse or your end user's misuse of the API;
your violation or your end user's violation of the Terms; or
any content or data routed into or used with the API by you, those acting on your behalf, or
your end users.
EXCEPT AS EXPRESSLY SET OUT IN THE TERMS, NEITHER POINT OF RENTAL NOR ITS SUPPLIERS OR DISTRIBUTORS
MAKE ANY SPECIFIC PROMISES ABOUT THE API. FOR EXAMPLE, WE DON'T MAKE ANY COMMITMENTS ABOUT THE
CONTENT ACCESSED THROUGH THE API, THE SPECIFIC FUNCTIONS OF THE API, OR ITS RELIABILITY,
AVAILABILITY, OR ABILITY TO MEET YOUR NEEDS. WE PROVIDE THE API "AS-IS, WHERE-IS".
SOME JURISDICTIONS PROVIDE FOR CERTAIN WARRANTIES, LIKE THE IMPLIED WARRANTY OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. EXCEPT AS EXPRESSLY PROVIDED FOR IN THE
TERMS, TO THE EXTENT PERMITTED BY LAW, WE DISCLAIM ALL WARRANTIES, GUARANTEES, CONDITIONS,
REPRESENTATIONS, AND UNDERTAKINGS.
WHEN PERMITTED BY LAW, POINT OF RENTAL, AND POINT OF RENTAL'S SUPPLIERS AND DISTRIBUTORS, WILL NOT
BE RESPONSIBLE FOR LOST PROFITS, REVENUES, OR DATA; FINANCIAL LOSSES; OR INDIRECT, SPECIAL,
CONSEQUENTIAL, EXEMPLARY, OR PUNITIVE DAMAGES.
TO THE EXTENT PERMITTED BY LAW, THE TOTAL LIABILITY OF POINT OF RENTAL, AND ITS SUPPLIERS AND
DISTRIBUTORS, FOR ANY CLAIM UNDER THE TERMS, INCLUDING FOR ANY IMPLIED WARRANTIES, IS LIMITED TO THE
AMOUNT YOU PAID US TO USE THE API DURING THE SIX MONTHS PRIOR TO THE EVENT GIVING RISE TO THE
LIABILITY.
IN ALL CASES, POINT OF RENTAL, AND ITS SUPPLIERS AND DISTRIBUTORS, WILL NOT BE LIABLE FOR ANY
SPECIAL, CONSEQUENTIAL, INCIDENTAL, EXEMPLARY OR PUNITIVE DAMAGES.
MISCELLANEOUS
The Terms are the entire agreement between you and Point of Rental relating to its subject and
supersede any prior or contemporaneous agreements on that subject. We each agree to contract in
the English language. If we provide a translation of the Terms, we do so for your convenience
only and the English Terms will solely govern our relationship.
We may modify the Terms or any portion to, for example, reflect changes to the law or changes to
our API, in our sole discretion. Notice of modifications to the Terms within the documentation
of the API and/or to this website. Changes will not apply retroactively and will become
effective no sooner than 30 days after they are posted. But changes addressing new functions for
the API or changes made for legal reasons will be effective immediately. If you do not agree to
the modified Terms for the API, your sole remedy is to discontinue your use of the API. Your
continued use of the API constitutes your acceptance of the modified Terms.
The Terms do not create any agency, partnership, or joint venture or any third party beneficiary
rights. Nothing in the Terms is intended to create, nor shall it be construed as creating, any
exclusive arrangement between the parties to the Terms.
Nothing in the Terms will limit either party's ability to seek injunctive relief. If you do not
comply with the Terms, and Point of Rental does not take action right away, this does not mean
that Point of Rental is giving up any rights that it may have (such as taking action in the
future). If it turns out that a particular term is not enforceable, this will not affect any
other terms.
Peek 2024-07-29 17-13
We are not liable for failure or delay in performance to the extent caused by circumstances
beyond our reasonable control.
The laws of Texas, U.S.A., excluding its conflict of laws rules, will apply to any disputes
arising out of or related to the Terms or the API. ALL CLAIMS ARISING OUT OF OR RELATING TO THE
TERMS OR THE API WILL BE LITIGATED EXCLUSIVELY IN THE FEDERAL OR STATE COURTS OF TARRANT COUNTY
TEXAS, USA, AND YOU AND POINT OF RENTAL CONSENT TO PERSONAL JURISDICTION IN THOSE COURTS.
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 support@point-of-rental.com.
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.
3. You will need to have a 'Global Login' enabled account.
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’:
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:
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.
*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:
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
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.
Categories
Supported by: Elite, Essentials, and Syrinx
Categories represent different buckets that products can be included in. Each product must be given one and only onecategory in each RMS. On a customer-facing storefront, Categories might be used as a top-level organization that consumers can use to filter results.
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:null01
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
Tags
Array of strings
This is an array of keywords. May be used like a subcategory.
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:null01
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
Tags
Array of strings
This is an array of keywords. May be used like a subcategory.
Software
Supported
Filterable
UI
Database
Elite
No, returns empty array
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
Yes
Keyword
CW_SEARCH_KEYWORDS.[CWK_KEYWORDS]
Response samples
200
4XX
Content type
application/json
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
https://api.pointofrental.com/v1/apikey/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:01null
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
{
"ModelType": "Contact",
"Id": "2",
"Name": "Joe Bloggs",
"Identifiers": {
"ParentId": "54321",
"DriversLicense": "11223344",
"EmployeeId": "22"
},
"Addresses": [ ],
"CompanyName": null,
"Emails": [
{
"Type": "Default",
"Email": "demo@pointofrental.com"
}
],
"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
https://api.pointofrental.com/v1/apikey/contacts
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.
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
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:01null
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.
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.
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.
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:null1
0 = false, 1 = true | This basically means Deleted
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": [ ],
"Precheck": false,
"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
https://api.pointofrental.com/v1/apikey/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.
Precheck
boolean
Default: false
Has a contract been prechecked. This is only available if the user passes in this explicitly in the precheck x-columns
PONumber
string or null
Default: "string"
A number associated to a Contract. Thi is user definable and associated by a POR user and their customer.
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.
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
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:null1
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.
Precheck
boolean
Default: false
Has a contract been prechecked. This is only available if the user passes in this explicitly in the precheck x-columns
PONumber
string or null
Default: "string"
A number associated to a Contract. Thi is user definable and associated by a POR user and their customer.
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.
PrecheckCompletedDateTime
string or null <date-time>
Elite Only: When was a contract prechecked. All date times are expected to be in UTC & ISO-8601 format.
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:null1
0 = false, 1 = true | This basically means Deleted
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
https://api.pointofrental.com/v1/apikey/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:01
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
{
"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": "demo@pointofrental.com"
}
],
"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": "demo@pointofrental.com"
}
],
"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": "demo@point-of-rental.com"
}
},
"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
https://api.pointofrental.com/v1/apikey/customers
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.
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
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.
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.
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
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:01null
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:01
0 = false, 1 = true | True means a user-unrecoverable deletion.
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.
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
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.
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.
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
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.
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:null1
0 = false, 1 = true | This basically means Deleted
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.
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
https://api.pointofrental.com/v1/apikey/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:null01
0 = false, 1 = true | True means a user-unrecoverable deletion.
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.
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:null01
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
{
"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
https://api.pointofrental.com/v1/apikey/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.
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
https://api.pointofrental.com/v1/apikey/lineItems
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:null1
Hidden
ItemId
string or null
Deprecated
Default: "string"
Kept for legacy support, will eventually only need StockId and ProductId.
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": [ ],
"Precheck": false,
"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
https://api.pointofrental.com/v1/apikey/locations
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.
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
https://api.pointofrental.com/v1/apikey/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.
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.
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.
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.
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.
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.
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
https://api.pointofrental.com/v1/apikey/products
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
https://api.pointofrental.com/v1/apikey/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:null1
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.
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:null1
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
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.
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.
CaseQuantity
number or null
Default: "null"
The number of items in a case. This is used to make sure when doing ordering, to avoid getting a fraction of a case since it will cost more.
CriticalLevel
number or null
Default: "null"
When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.
CurrentDepotId
string or null
(Elite Only) The id of the current store/depot.
InternalClassificationType
string or null
Enum:"Non-rental Asset""Work Order item"
(Elite Only) If the classification field is set as "Internal" this further specifies the type. If this is not set, this defaults to "null".
RentalCaseQuantity
number or null
Default: "null"
The amount in a case for a rental.
RentalType
string or null
Value:"Rental - Header"
(Elite Only) If the classification field is set as "Rental" this further specifies the type. If this is not set, this defaults to "null"
ReorderMaximum
number or null
Default: "null"
The maximum for reordering the item.
ReorderMinimum
number or null
Default: "null"
The minimum for reordering the item.
SalesType
string or null
Value:"Sales - Header"
(Elite Only) If the classification field is set as "Sales" this further specifies the type. If this is not set, this defaults to "null"
SpecDescription
string or null
(Elite only) This is the text field currently present on rentalhosting as additional information/info
TaxCode
number or null
The tax code for the item. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.
TaxCodeName
string or null
The name of the tax code.
ExternalTaxCode
string or null
The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.
CreatedDateTime
string or null <date-time>
Default: "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:null1
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.
One of
number
For elite, only a number. It is a monotomic that can be used to detect changes.
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.
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.
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
{
"ModelType": "SalesPerson",
"Id": "30",
"Name": "Wayne Harris",
"Email": {
"Type": "Primary",
"Email": "demo@point-of-rental.com"
}
}
Stock
Create a new Stock record (serialized)
https://api.pointofrental.com/v1/apikey/stock
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
https://api.pointofrental.com/v1/apikey/stock
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.
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.
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.
(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:null1
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.
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.
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.
(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:null1
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
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.
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.
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.
(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:null1
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.
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:null1
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
https://api.pointofrental.com/v1/apikey/vendors
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.
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
https://api.pointofrental.com/v1/apikey/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.
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:null1
0 = false, 1 = true | This basically means Deleted
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.
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:null1
0 = false, 1 = true | This basically means Deleted
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.
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.
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:null1
0 = false, 1 = true | This basically means Deleted
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.
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:null01
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.
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.
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.
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.
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.
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:
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.
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.
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:null01
0 = false, 1 = true | True means a user-unrecoverable deletion.
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.
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."
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."
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Provide the unique ID of the Invoice record 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.
ExternalInvoiceId
string or null
External Invoice 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:"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.
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.
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.
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.
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
CreatedDateTime
string <date-time>
Date and time when the payment was added to the queue.
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.
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
CreatedDateTime
string <date-time>
Date and time when the payment was added to the queue.
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
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.
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
Provide the unique ID of the Category record you want to retrieve.
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.
ExternalJournalEntryId
string or null
External journal entry 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:"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.
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
Request samples
Payload
Content type
application/json
{
"Id": "42",
"State": "Pending"
}
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
https://api.pointofrental.com/v1/apikey/callLogs
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
https://api.pointofrental.com/v1/apikey/callLogs
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:01
0 = false, 1 = true | True means a user-unrecoverable deletion.
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:01
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.
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
2025.02.00
Added more verbose error messages for RMS timeouts.
Updated /stock/{StockId} endpoint to match documentation.
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.
\n\n
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.
\n
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!.
"},{"name":"Paging","x-displayName":"Paging","description":"Note: 100 is the **upper limit** on page size requests.\nPaging example:\n
GET /apikey/contracts X-Paging: { 'page': 1, 'pageSize': 25 }
## 2xx Responses:\n200 OK:\n-- Get All - Record(s) found.\n-- Get By Id - Record found.\n-- Update - Record updated.\n-- Delete - Record deleted.\n\n201 Created - Record created.\n\n204 No Content - No record found.\n\n## 4xx Responses:\n400 Bad Request - The request is malformed in some way. See the response message for details.\n403 Unauthorized - Resource exists but you do not have access.\n404 Not Found - Resource does not exist.
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.
Categories represent different buckets that products can be included in. Each product must be given one and only onecategory in each RMS. On a customer-facing storefront, Categories might be used as a top-level organization that consumers can use to filter results.
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.
\n
In Elite's UI, Depots are typically referred to as Stores.
\n
In Essentials' UI, Depots are called Companies.
\n
In Syrinx's UI Depots is used in the UI as well. This RMS is where this endpoint's namesake originated.
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.
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:
\n
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.
\n
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.
\n
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.
The Customer endpoint will return information stored from each Customer record, including both business and individual consumers.
\n
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.
\n
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.
\n
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.
"},{"name":"Changelog by Release","description":"This changelog outlines modifications to public APIs. Releases consisting solely of internal improvements are mentioned only if they represent the latest version update.
Changelog
2025.02.00
Added more verbose error messages for RMS timeouts.
Updated `/stock/{StockId}` endpoint to match documentation.
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.
"},{"name":"Utilize Elite Accounting APIs","x-displayName":"Utilize Elite Accounting APIs","description":"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. \n\n## Direct vs. Custom Integrations\nDirect 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.\nCustom 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. \n\n## Modes\n\n
How the Various Direct Integration Modes Function
\n
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.)
\n
Each mode has unique advantages. The table below outlines the key differences between them:
\n
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.
\n\n## Design\n\n
How the APIs Design Power Our Integrations
\n
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:
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.
\n\n## Flow\n\n
How the Data Flows and Synchronizes
\n
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.
\n\n\n\n## SQL\n\n
Example Data Flow: SQL Views and Synchronization
\n
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.
\n
Pass
Update State with the word ‘Posted’
Fail
Update State with the word ‘Error’
Update ErrorDescription with error message (reason for failing)
\n
AP Bill Parent Row: vwAPI_AP_Invoice Child Row(s): vwAPI_AP_InvoiceLines where InvoiceId = vwAPI_AP_Invoice.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
\n\n## AR Payments\n\n
How Transaction Mode Utilizes AR Payments
\n
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.
\n
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.
\nThe 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.
\n\n## Summary\n\n
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.
The Work Orders endpoint returns information related to the repair and maintenance of stock items for both Elite and Essentials.
\n
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.
\n
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.
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. "}],"components":{"securitySchemes":{"API Key":{"type":"apiKey","in":"header","name":"X-API-Key"},"APIKey":{"type":"apiKey","name":"X-API-Key","in":"header","description":"[See this article on gaining access to our [Global API](#tag/GlobalAPIAccess)]"}},"schemas":{"application+json":{"type":"object","additionalProperties":true},"GetAll":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"CallLog","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["CallLog"]},"Id":{"type":"string","description":"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":{"nullable":true,"type":"string","description":"This returns the same as the unique `Id` for this record.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Number / Call #
CallLog.Number
"},"Identifiers":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"ContractId":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"string","description":"If this Call Log is associated with a Customer, the CustomerId will display here.
"},"Type":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"object","description":"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.","properties":{}},"CreatedDateTime":{"nullable":true,"type":"string","description":"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
","format":"date-time"},"UpdatedDateTime":{"nullable":true,"type":"string","description":"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
--
--
--
","format":"date-time"},"Hidden":{"type":"integer","description":"0 = false, 1 = true | True means a user-unrecoverable deletion.
Software
Supported
Filterable
UI
Database
Elite
Yes
--
--
--
","enum":[0,1]}}}},"BadRequestSchema":{"description":"Returned when the calling application has made a malformed request or other error.","type":"object","properties":{"statusCode":{"type":"integer","description":"Numeric http status code which may be ommitted.","nullable":true,"enum":[400,403,404,500]},"code":{"type":"string","description":"A short description of the error.","nullable":true},"error":{"type":"string","description":"A short description of the error.","nullable":true},"message":{"type":"string","description":"An extended message regarding the error, potentially with troubleshooting info and string-encoded json included.","nullable":true},"timestamp":{"type":"string","description":"The date/time the error occurred","format":"date-time","nullable":true},"path":{"type":"string","description":"The path as read by the server on which the error occurred.","nullable":true}}},"PostCreate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"CallLog","type":"object","properties":{"Identifiers":{"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","nullable":true,"properties":{"ContractId":{"type":"string","nullable":true,"description":"If this Call Log is associated with a Contract, the ContractId will display here."},"CustomerId":{"type":"string","nullable":true,"description":"If this Call Log is associated with a Customer, the CustomerId will display here."},"RelationshipId":{"type":"string","nullable":true,"description":""},"RemoteUserId":{"type":"string","nullable":true,"description":""}}},"Body":{"type":"string","nullable":true,"description":"This is represented in the UI as the Notes field. This contains the text of the Call Log."},"ContactName":{"type":"string","nullable":true,"description":"If this Call Log is associated with a Contact, the Contact's name will display here."},"ForceAcknowledge":{"type":"boolean","description":"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":{"type":"string","nullable":true,"description":"This is a dropdown list of categories for this call log. For example, \"Sales,\" \"Customer Problem,\" \"Follow-up,\" etc."}},"default":{"ForceAcknowledge":false,"Hidden":0,"Type":null}},"GetById":{"$schema":"http://json-schema.org/draft-07/schema#","title":"CallLog","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["CallLog"]},"Id":{"type":"string","description":"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":{"nullable":true,"type":"string","description":"This returns the same as the unique `Id` for this record.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Number / Call #
CallLog.Number
"},"Identifiers":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"ContractId":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"string","description":"If this Call Log is associated with a Customer, the CustomerId will display here.
"},"Type":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"object","description":"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.","properties":{}},"CreatedDateTime":{"nullable":true,"type":"string","description":"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
","format":"date-time"},"UpdatedDateTime":{"nullable":true,"type":"string","description":"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
--
--
--
","format":"date-time"},"Hidden":{"type":"integer","description":"0 = false, 1 = true | True means a user-unrecoverable deletion.
Software
Supported
Filterable
UI
Database
Elite
Yes
--
--
--
","enum":[0,1]}}},"GetAll-2":{"type":"array","items":{"description":"A category get list response.","type":"object","properties":{"ModelType":{"type":"string","enum":["Category"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint."},"AdditionalFields":{"nullable":true,"type":"object","description":"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":{"type":"string","format":"date-time","nullable":true,"description":"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":{"type":"string","format":"date-time","nullable":true,"description":"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":{"type":"integer","description":"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.
","enum":[null,0,1],"nullable":true},"Description":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"number","description":"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
","minimum":0},"Division":{"nullable":true,"type":"string","description":"This is a parent grouping for Categories.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Division
ItemCategory.DivisionName
Essentials
No, always `null`
--
--
--
Syrinx
No
--
--
--
"},"Images":{"type":"array","description":"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
--
--
--
--
","items":{"type":"object","description":"Object with image data.","properties":{"Uri":{"type":"string","description":"Essentials Only: Public URL for the image.","nullable":false},"AltText":{"nullable":true,"type":"string","description":"Essentials Only: Currently returns the 'Name' of the Category."}}}},"ParentCategoryId":{"nullable":true,"type":"string","description":"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
"},"Tags":{"type":"array","description":"This is an array of keywords. May be used like a subcategory.
Software
Supported
Filterable
UI
Database
Elite
No, returns empty array
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
Yes
Keyword
CW_SEARCH_KEYWORDS.[CWK_KEYWORDS]
","items":{"type":"string"}}}}},"GetById-2":{"type":"object","properties":{"ModelType":{"type":"string","enum":["Category"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint."},"AdditionalFields":{"nullable":true,"type":"object","description":"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":{"type":"string","format":"date-time","nullable":true,"description":"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":{"type":"string","format":"date-time","nullable":true,"description":"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":{"type":"integer","description":"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.
","enum":[null,0,1],"nullable":true},"Description":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"number","description":"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
","minimum":0},"Division":{"nullable":true,"type":"string","description":"This is a parent grouping for Categories.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Division
ItemCategory.DivisionName
Essentials
No, always `null`
--
--
--
Syrinx
No
--
--
--
"},"Images":{"type":"array","description":"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
--
--
--
--
","items":{"type":"object","description":"Object with image data.","properties":{"Uri":{"type":"string","description":"Essentials Only: Public URL for the image.","nullable":false},"AltText":{"nullable":true,"type":"string","description":"Essentials Only: Currently returns the 'Name' of the Category."}}}},"ParentCategoryId":{"nullable":true,"type":"string","description":"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
"},"Tags":{"type":"array","description":"This is an array of keywords. May be used like a subcategory.
Software
Supported
Filterable
UI
Database
Elite
No, returns empty array
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
Yes
Keyword
CW_SEARCH_KEYWORDS.[CWK_KEYWORDS]
","items":{"type":"string"}}}},"GetAll-3":{"type":"array","items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["Contact","CustomerContact","VendorContact"],"nullable":false,"description":"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":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Identifiers":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint. Expand to see nested fields.","properties":{"DriversLicense":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
"}}},"Addresses":{"type":"array","description":"Only supported by Essentials and Syrinx with details described below. \n\nAn 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. \n\nAs 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.","items":{"type":"object","properties":{"Type":{"type":"string","enum":["Billing","Shipping","Default"],"nullable":false,"description":"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":{"type":"string","nullable":true,"description":"Optional freeform field used to name the address.
Software
Supported
Filterable
UI
Database
Essentials
No
--
--
--
Syrinx
Yes
Yes
Name
CUST.NAME
"},"Line1":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Third line of the address field. Additional information if needed.
Software
Supported
Filterable
UI
Database
Essentials
No
--
--
--
Syrinx
Yes
Yes
Address
ADR_LINE3
"},"City":{"type":"string","nullable":true,"description":"City or Town for this address.
Software
Supported
Filterable
UI
Database
Essentials
Yes
Yes
City
N/A
Syrinx
Yes
Yes
Town
ADR_TOWN
"},"GeoRegion2":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":"true","description":"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":{"type":"string","nullable":true,"description":"This is the geographical State for this Address.
Software
Supported
Filterable
UI
Database
Essentials
Yes
Yes
State
N/A
Syrinx
No, always `null`
--
--
--
"},"PostalCode":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
Software
Supported
Filterable
UI
Database
Essentials
Yes
No
Country
N/A
Syrinx
No, matches `Addresses.GeoRegion2`
--
--
--
"}}}},"CompanyName":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"boolean","nullable":true,"description":"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
--
--
--
"},"Emails":{"type":"array","nullable":true,"description":"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.","items":{"type":"object","properties":{"Type":{"type":"string","enum":["Default","Billing"],"nullable":false,"description":"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":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
--
--
--
"},"Phones":{"type":"array","nullable":true,"description":"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.","items":{"type":"object","properties":{"Type":{"type":"string","enum":["Default","Mobile","Primary","Secondary"],"nullable":false,"description":"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":{"type":"string","nullable":true,"deprecated":true,"description":"This field is deprecated and will completely lose support in the future. \nA 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."},"CountryCode":{"type":"string","nullable":true,"description":"Country code prefix to phone number. List of country code prefixes found [here.](https://en.wikipedia.org/wiki/List_of_country_calling_codes)
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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"A supplied phone number will return here if it has been validated according to the [E.164 format.](https://en.wikipedia.org/wiki/E.164)
Software
Supported
Filterable
Elite
No, always `null`
--
Essentials
Yes
Yes
Syrinx
Yes
Yes
"},"Extension":{"type":"string","nullable":true,"description":"Extension associated with the provided number.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
No, always `null`
--
--
--
"},"SmsCapable":{"type":"boolean","nullable":true,"description":"Answers whether the phone can be sent SMS messages. Included for future growth.
"},"AdditionalFields":{"type":"object","nullable":true,"description":"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.","properties":{"InactiveDateTime":{"type":"string","nullable":true,"format":"date-time","description":"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":{"type":"string","format":"date-time","nullable":true,"description":"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":{"type":"string","format":"date-time","nullable":true,"description":"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":{"type":"integer","enum":[0,1,null],"nullable":true,"description":"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`
"}}}},"GetById-3":{"type":"object","description":"Returns a Contact object if a valid ID was provided and the user has permission to view it.","properties":{"ModelType":{"type":"string","enum":["Contact","CustomerContact","VendorContact"],"nullable":false,"description":"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":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Identifiers":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint. Expand to see nested fields.","properties":{"DriversLicense":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
"}}},"Addresses":{"type":"array","description":"Only supported by Essentials and Syrinx with details described below. \n\nAn 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. \n\nAs 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.","items":{"type":"object","properties":{"Type":{"type":"string","enum":["Billing","Shipping","Default"],"nullable":false,"description":"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":{"type":"string","nullable":true,"description":"Optional freeform field used to name the address.
Software
Supported
Filterable
UI
Database
Essentials
No
--
--
--
Syrinx
Yes
Yes
Name
CUST.NAME
"},"Line1":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Third line of the address field. Additional information if needed.
Software
Supported
Filterable
UI
Database
Essentials
No
--
--
--
Syrinx
Yes
Yes
Address
ADR_LINE3
"},"City":{"type":"string","nullable":true,"description":"City or Town for this address.
Software
Supported
Filterable
UI
Database
Essentials
Yes
Yes
City
N/A
Syrinx
Yes
Yes
Town
ADR_TOWN
"},"GeoRegion2":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":"true","description":"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":{"type":"string","nullable":true,"description":"This is the geographical State for this Address.
Software
Supported
Filterable
UI
Database
Essentials
Yes
Yes
State
N/A
Syrinx
No, always `null`
--
--
--
"},"PostalCode":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
Software
Supported
Filterable
UI
Database
Essentials
Yes
No
Country
N/A
Syrinx
No, matches `Addresses.GeoRegion2`
--
--
--
"}}}},"CompanyName":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"boolean","nullable":true,"description":"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
--
--
--
"},"Emails":{"type":"array","nullable":true,"description":"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.","items":{"type":"object","properties":{"Type":{"type":"string","enum":["Default","Billing"],"nullable":false,"description":"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":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
--
--
--
"},"Phones":{"type":"array","nullable":true,"description":"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.","items":{"type":"object","properties":{"Type":{"type":"string","enum":["Default","Mobile","Primary","Secondary"],"nullable":false,"description":"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":{"type":"string","nullable":true,"deprecated":true,"description":"This field is deprecated and will completely lose support in the future. \nA 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."},"CountryCode":{"type":"string","nullable":true,"description":"Country code prefix to phone number. List of country code prefixes found [here.](https://en.wikipedia.org/wiki/List_of_country_calling_codes)
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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"A supplied phone number will return here if it has been validated according to the [E.164 format.](https://en.wikipedia.org/wiki/E.164)
Software
Supported
Filterable
Elite
No, always `null`
--
Essentials
Yes
Yes
Syrinx
Yes
Yes
"},"Extension":{"type":"string","nullable":true,"description":"Extension associated with the provided number.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
No, always `null`
--
--
--
"},"SmsCapable":{"type":"boolean","nullable":true,"description":"Answers whether the phone can be sent SMS messages. Included for future growth.
"},"AdditionalFields":{"type":"object","nullable":true,"description":"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.","properties":{"InactiveDateTime":{"type":"string","nullable":true,"format":"date-time","description":"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":{"type":"string","format":"date-time","nullable":true,"description":"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":{"type":"string","format":"date-time","nullable":true,"description":"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":{"type":"integer","enum":[0,1,null],"nullable":true,"description":"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`
"}}},"GetAll-4":{"type":"array","items":{"type":"object","properties":{"PaymentCollectionBoundaries":{"type":"array","items":{"type":"object","properties":{"BoundaryTypeEnum":{"type":"string","enum":["RentalSaleCollectionBoundary","DepositAmountCollectionBoundary"],"description":""},"PaymentMethodEnum":{"type":"string","enum":["Credit Card","ACH"],"description":""},"MaximumCollectionAmount":{"type":"number","description":""},"MinimumCollectionAmount":{"type":"number","description":""},"CollectAmountFee":{"type":"array","items":{"type":"object","properties":{"FeeCalculationEnum":{"type":"string","enum":["Fixed","Percent"],"description":""},"Value":{"type":"number","description":""}}}},"CollectAmountFeeTax":{"type":"array","items":{"type":"object","properties":{"FeeCalculationEnum":{"type":"string","enum":["Fixed","Percent"],"description":""},"Value":{"type":"number","description":""}}}}}}}}}},"GetById-4":{"type":"object","description":"Returns a Salesperson object if a valid ID was provided and the user has permission to view.","properties":{"ModelType":{"type":"string","enum":["SalesPerson"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Email":{"type":"object","description":"An email associated with this record. Expand to see nested fields.","properties":{"Type":{"type":"string","enum":["Primary","Default"],"nullable":false,"description":"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":{"type":"string","nullable":false,"description":"Email associated with this record.
Software
Supported
Filterable
UI
DB
Elite
Yes
Yes
Email
Salesman.Email
Essentials
Yes
Yes
Email
N/A
"}}},"FirstName":{"type":"string","nullable":true,"description":"First name of the Salesperson.
Software
Supported
Filterable
UI
DB
Elite
No
–
–-
–-
Essentials
Yes
Yes
First Name
N/A
"},"LastName":{"type":"string","nullable":true,"description":"Last name of the Salesperson.
Software
Supported
Filterable
UI
DB
Elite
No
–
–-
–-
Essentials
Yes
Yes
Last Name
N/A
"}}},"GetAll-5":{"type":"array","items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["Customer"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Identifiers":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"AccountNumber":{"type":"string","nullable":true,"description":"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":{"type":"string","description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","description":"Federal Id of the Customer.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Federal Id
CustomerFile.FederalId
Essentials
No
--
--
--
Syrinx
No
--
--
--
"},"InsuranceNumber":{"type":"string","nullable":true,"description":"Insurance Number of Customer.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Insurance Number
CustomerFile.InsuranceNumber
Essentials
No
--
--
--
Syrinx
No
--
--
--
"},"OtherId":{"type":"string","nullable":true,"description":"Additional Id for Customer.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Other Id
CustomerFile.OTHERID
Essentials
No
--
--
--
Syrinx
No
--
--
--
"},"RegistrationNumber":{"type":"string","nullable":true,"description":"Registration Number of Customer.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
Yes
Reg No
CST_COMPANY_REG_NO
"},"TaxNumber":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"VAT Number for the Customer.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
Yes
VAT No
CST_VAT_NUMBER
"}}},"Addresses":{"type":"array","description":"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.","items":{"type":"object","properties":{"Type":{"type":"string","enum":["Billing","Customer","Default"],"nullable":false,"description":"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":{"type":"string","nullable":true,"description":"Optional freeform field used to name the address.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
No
Name
ADR_NAME
"},"Line1":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Contacts":{"description":"If there are any Contact records associated with this Customer, then they will be returned here. Expand to see nested fields.","$ref":"#/components/schemas/GetAll-3"},"CreditLimit":{"type":"integer","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"'USD' is the default. Code is [ISO 4217 format.](https://en.wikipedia.org/wiki/ISO_4217) 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":{"type":"boolean","nullable":true,"description":"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
"},"Emails":{"type":"array","description":"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.","items":{"type":"object","nullable":false,"properties":{"Type":{"type":"string","enum":["Primary"],"nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"For Elite and Essentials, this defaults to 'en-US'. For Syrinx, this defaults to 'en-GB'. Code is [ISO 639 format](https://www.w3.org/TR/html401/struct/dirlang.html). 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":{"type":"boolean","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Phones":{"type":"array","description":"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.","items":{"type":"object","nullable":false,"properties":{"Type":{"type":"string","nullable":false,"enum":["Default","Primary","Secondary"],"description":"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":{"deprecated":true,"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Country code prefix to phone number. List of country code prefixes found [here.](https://en.wikipedia.org/wiki/List_of_country_calling_codes)
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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"A supplied phone number will return here if it has been validated according to the [E.164 format.](https://en.wikipedia.org/wiki/E.164)
Software
Supported
Filterable
UI
Database
Elite
Yes
No
--
--
Essentials
Yes
No
Primary Phone Number
N/A
Syrinx
Yes
No
Phone
ADR_TELEPHONE
"},"Extension":{"type":"string","nullable":true,"description":"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":{"type":"boolean","nullable":true,"description":"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":{"type":"string","enum":["Business","Individual"],"nullable":false,"description":"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'
"},"SalesPerson":{"description":"Data related to the SalesPerson record associated with the Customer. Only supported by Elite and Essentials. Expand to see nested fields.","$ref":"#/components/schemas/GetById-4","nullable":true},"Status":{"type":"string","enum":["Lead","Prospect","Cash","Account"],"nullable":false,"description":"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":{"type":"number","description":"(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
--
--
--
"},"AdditionalFields":{"type":"object","nullable":true,"description":"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.","properties":{"CustomerWebPortal":{"type":"boolean","nullable":true,"description":"(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":{"type":"string","nullable":true,"description":"(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":{"type":"string","nullable":true,"description":"(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":{"type":"boolean","nullable":true,"description":"(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":{"type":"boolean","nullable":true,"description":"(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":{"type":"boolean","nullable":true,"description":"(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":{"type":"boolean","nullable":true,"description":"(Elite Only) Flag to force purchase orders.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Force PO or Purchase Order Number
CustomerFile.ForcePO
"},"InvoiceSendBy":{"type":"string","enum":["Email","Fax","No Statement","Printer","None"],"nullable":true,"description":"(Elite Only) Determines how a customer will receive contracts.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Invoice Send By
PrintSendOption.Description
"},"Restrictions":{"type":"string","nullable":true,"description":"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":{"type":"string","enum":["Email","Fax","No Statement","Printer","None"],"nullable":true,"description":"(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":{"type":"string","nullable":true,"description":"(Elite Only) Terms for the customer.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Terms
CustomerFile.Terms
"},"UserDefined1":{"type":"string","nullable":true,"description":"(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":{"type":"string","nullable":true,"description":"(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":{"type":"string","description":"The date the customer's insurance expires.
"},{"type":"string","description":"Not currently used, but reserved for future-proofing."}],"readOnly":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"integer","enum":[0,1],"nullable":false,"description":"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
"}}}},"GetById-5":{"type":"object","properties":{"ModelType":{"type":"string","enum":["Customer"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Identifiers":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"AccountNumber":{"type":"string","nullable":true,"description":"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":{"type":"string","description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","description":"Federal Id of the Customer.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Federal Id
CustomerFile.FederalId
Essentials
No
--
--
--
Syrinx
No
--
--
--
"},"InsuranceNumber":{"type":"string","nullable":true,"description":"Insurance Number of Customer.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Insurance Number
CustomerFile.InsuranceNumber
Essentials
No
--
--
--
Syrinx
No
--
--
--
"},"OtherId":{"type":"string","nullable":true,"description":"Additional Id for Customer.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Other Id
CustomerFile.OTHERID
Essentials
No
--
--
--
Syrinx
No
--
--
--
"},"RegistrationNumber":{"type":"string","nullable":true,"description":"Registration Number of Customer.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
Yes
Reg No
CST_COMPANY_REG_NO
"},"TaxNumber":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"VAT Number for the Customer.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
Yes
VAT No
CST_VAT_NUMBER
"}}},"Addresses":{"type":"array","description":"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.","items":{"type":"object","properties":{"Type":{"type":"string","enum":["Billing","Customer","Default"],"nullable":false,"description":"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":{"type":"string","nullable":true,"description":"Optional freeform field used to name the address.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
No
Name
ADR_NAME
"},"Line1":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Contacts":{"description":"If there are any Contact records associated with this Customer, then they will be returned here. Expand to see nested fields.","$ref":"#/components/schemas/GetAll-3"},"CreditLimit":{"type":"integer","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"'USD' is the default. Code is [ISO 4217 format.](https://en.wikipedia.org/wiki/ISO_4217) 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":{"type":"boolean","nullable":true,"description":"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
"},"Emails":{"type":"array","description":"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.","items":{"type":"object","nullable":false,"properties":{"Type":{"type":"string","enum":["Primary"],"nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"For Elite and Essentials, this defaults to 'en-US'. For Syrinx, this defaults to 'en-GB'. Code is [ISO 639 format](https://www.w3.org/TR/html401/struct/dirlang.html). 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":{"type":"boolean","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Phones":{"type":"array","description":"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.","items":{"type":"object","nullable":false,"properties":{"Type":{"type":"string","nullable":false,"enum":["Default","Primary","Secondary"],"description":"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":{"deprecated":true,"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Country code prefix to phone number. List of country code prefixes found [here.](https://en.wikipedia.org/wiki/List_of_country_calling_codes)
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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"A supplied phone number will return here if it has been validated according to the [E.164 format.](https://en.wikipedia.org/wiki/E.164)
Software
Supported
Filterable
UI
Database
Elite
Yes
No
--
--
Essentials
Yes
No
Primary Phone Number
N/A
Syrinx
Yes
No
Phone
ADR_TELEPHONE
"},"Extension":{"type":"string","nullable":true,"description":"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":{"type":"boolean","nullable":true,"description":"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":{"type":"string","enum":["Business","Individual"],"nullable":false,"description":"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'
"},"SalesPerson":{"description":"Data related to the SalesPerson record associated with the Customer. Only supported by Elite and Essentials. Expand to see nested fields.","$ref":"#/components/schemas/GetById-4","nullable":true},"Status":{"type":"string","enum":["Lead","Prospect","Cash","Account"],"nullable":false,"description":"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":{"type":"number","description":"(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
--
--
--
"},"AdditionalFields":{"type":"object","nullable":true,"description":"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.","properties":{"CustomerWebPortal":{"type":"boolean","nullable":true,"description":"(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":{"type":"string","nullable":true,"description":"(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":{"type":"string","nullable":true,"description":"(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":{"type":"boolean","nullable":true,"description":"(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":{"type":"boolean","nullable":true,"description":"(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":{"type":"boolean","nullable":true,"description":"(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":{"type":"boolean","nullable":true,"description":"(Elite Only) Flag to force purchase orders.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Force PO or Purchase Order Number
CustomerFile.ForcePO
"},"InvoiceSendBy":{"type":"string","enum":["Email","Fax","No Statement","Printer","None"],"nullable":true,"description":"(Elite Only) Determines how a customer will receive contracts.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Invoice Send By
PrintSendOption.Description
"},"Restrictions":{"type":"string","nullable":true,"description":"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":{"type":"string","enum":["Email","Fax","No Statement","Printer","None"],"nullable":true,"description":"(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":{"type":"string","nullable":true,"description":"(Elite Only) Terms for the customer.
Software
Supported
Filterable
UI
Database
Elite
Yes
Yes
Terms
CustomerFile.Terms
"},"UserDefined1":{"type":"string","nullable":true,"description":"(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":{"type":"string","nullable":true,"description":"(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":{"type":"string","description":"The date the customer's insurance expires.
"},{"type":"string","description":"Not currently used, but reserved for future-proofing."}],"readOnly":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"integer","enum":[0,1],"nullable":false,"description":"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
"}}},"EnumLookup":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"EnumLookupCustomerResponse","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["Lookup"]},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable."},"Name":{"nullable":true,"type":"string","description":"Currently this field returns null."},"Description":{"nullable":true,"type":"string","description":"Contains additional context for the dynamic value. Used when the listed value is not self-explanatory."},"Value":{"type":"string","description":"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.
"}}}},"GetAll-6":{"type":"array","items":{"title":"Depot","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint."},"Addresses":{"type":"array","description":"This returns the Depot's physical address. Not all address fields may be filled out depending on location. Expand to see nested fields.","items":{"title":"Address","type":"object","properties":{"City":{"nullable":true,"type":"string","description":"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
","maxLength":128},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/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`
--
--
--
","maxLength":128},"GeoRegion2":{"nullable":true,"type":"string","description":"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
","maxLength":64},"GeoRegion3":{"nullable":true,"type":"string","description":"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`
--
--
--
","maxLength":64},"Latitude":{"nullable":true,"type":"string","description":"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
","maxLength":64},"Line1":{"nullable":true,"type":"string","description":"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
","maxLength":256},"Line2":{"nullable":true,"type":"string","description":"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
","maxLength":256},"Line3":{"nullable":true,"type":"string","description":"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
","maxLength":256},"Longitude":{"nullable":true,"type":"string","description":"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
","maxLength":64},"Name":{"nullable":true,"type":"string","description":"Optional freeform field used to name the address.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
No
Name
ADR_NAME
","maxLength":128},"PostalCode":{"nullable":true,"type":"string","description":"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
","maxLength":32},"Province":{"nullable":true,"type":"string","description":"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`
--
--
--
","maxLength":128},"Type":{"nullable":true,"type":"string","description":"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
--
","maxLength":32}}}},"DefaultDepot":{"nullable":true,"type":"boolean","description":"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
"},"Emails":{"type":"array","description":"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.","items":{"title":"Email","type":"object","properties":{"Email":{"type":"string","description":"Email associated with this record.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
Yes
Yes
N/A
N/A
Syrinx
No
--
--
--
"},"Type":{"type":"string","description":"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
"}}}},"Phones":{"type":"array","description":"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.","items":{"title":"Phone","type":"object","properties":{"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix to phone number. List of country code prefixes found [here.](https://en.wikipedia.org/wiki/List_of_country_calling_codes)
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
No
--
GAPIPhone
","maxLength":16},"Extension":{"nullable":true,"type":"string","description":"Extension associated with the provided number.
Software
Supported
Filterable
UI
Database
Elite
No, always `null`
--
--
--
Essentials
No
--
--
--
Syrinx
No, always `null`
--
--
--
","maxLength":32},"Number":{"nullable":true,"type":"string","description":"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
","maxLength":32},"NumberE164":{"nullable":true,"type":"string","description":"A supplied phone number will return here if it has been validated according to the [E.164 format.](https://en.wikipedia.org/wiki/E.164)
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
No
GAPIPhone
","maxLength":32},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number?
Software
Supported
Elite
No
Essentials
No
Syrinx
No
"},"Type":{"nullable":true,"type":"string","description":"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
--
","maxLength":32}}}},"AdditionalFields":{"nullable":true,"type":"object","description":"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":{"nullable":true,"type":"string","description":"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
--
--
--
","format":"date-time"},"UpdatedDateTime":{"nullable":true,"type":"string","description":"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
--
--
--
","format":"date-time"},"Hidden":{"nullable":true,"type":"integer","enum":[null,0,1],"description":"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
"}}}},"GetById-6":{"type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint."},"Addresses":{"type":"array","description":"This returns the Depot's physical address. Not all address fields may be filled out depending on location. Expand to see nested fields.","items":{"title":"Address","type":"object","properties":{"City":{"nullable":true,"type":"string","description":"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
","maxLength":128},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/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`
--
--
--
","maxLength":128},"GeoRegion2":{"nullable":true,"type":"string","description":"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
","maxLength":64},"GeoRegion3":{"nullable":true,"type":"string","description":"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`
--
--
--
","maxLength":64},"Latitude":{"nullable":true,"type":"string","description":"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
","maxLength":64},"Line1":{"nullable":true,"type":"string","description":"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
","maxLength":256},"Line2":{"nullable":true,"type":"string","description":"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
","maxLength":256},"Line3":{"nullable":true,"type":"string","description":"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
","maxLength":256},"Longitude":{"nullable":true,"type":"string","description":"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
","maxLength":64},"Name":{"nullable":true,"type":"string","description":"Optional freeform field used to name the address.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
No
Name
ADR_NAME
","maxLength":128},"PostalCode":{"nullable":true,"type":"string","description":"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
","maxLength":32},"Province":{"nullable":true,"type":"string","description":"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`
--
--
--
","maxLength":128},"Type":{"nullable":true,"type":"string","description":"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
--
","maxLength":32}}}},"DefaultDepot":{"nullable":true,"type":"boolean","description":"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
"},"Emails":{"type":"array","description":"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.","items":{"title":"Email","type":"object","properties":{"Email":{"type":"string","description":"Email associated with this record.
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
Yes
Yes
N/A
N/A
Syrinx
No
--
--
--
"},"Type":{"type":"string","description":"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
"}}}},"Phones":{"type":"array","description":"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.","items":{"title":"Phone","type":"object","properties":{"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix to phone number. List of country code prefixes found [here.](https://en.wikipedia.org/wiki/List_of_country_calling_codes)
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
No
--
GAPIPhone
","maxLength":16},"Extension":{"nullable":true,"type":"string","description":"Extension associated with the provided number.
Software
Supported
Filterable
UI
Database
Elite
No, always `null`
--
--
--
Essentials
No
--
--
--
Syrinx
No, always `null`
--
--
--
","maxLength":32},"Number":{"nullable":true,"type":"string","description":"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
","maxLength":32},"NumberE164":{"nullable":true,"type":"string","description":"A supplied phone number will return here if it has been validated according to the [E.164 format.](https://en.wikipedia.org/wiki/E.164)
Software
Supported
Filterable
UI
Database
Elite
No
--
--
--
Essentials
No
--
--
--
Syrinx
Yes
No
GAPIPhone
","maxLength":32},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number?
Software
Supported
Elite
No
Essentials
No
Syrinx
No
"},"Type":{"nullable":true,"type":"string","description":"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
--
","maxLength":32}}}},"AdditionalFields":{"nullable":true,"type":"object","description":"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":{"nullable":true,"type":"string","description":"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
--
--
--
","format":"date-time"},"UpdatedDateTime":{"nullable":true,"type":"string","description":"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
--
--
--
","format":"date-time"},"Hidden":{"nullable":true,"type":"integer","enum":[null,0,1],"description":"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
"}}},"GetAll-7":{"type":"array","items":{"title":"AccountPayableInvoiceResponse","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountPayableInvoice"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"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":{"type":"string","format":"date-time","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"number","description":"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":{"type":"number","description":"Total price of the freight. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Freight'
AccountingAPIQueuePO.ShippingCost
"},"GrandTaxTotal":{"type":"number","description":"Total amount of sales tax. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Tax'
AccountingAPIQueuePO.Tax
"},"GrandTotal":{"type":"number","description":"Total amount that is payable. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Total'
AccountingAPIQueuePO.TotalAmount
"},"Identifiers":{"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"BatchId":{"type":"string","description":"Batch Id associated with this record. Found in the Accounting Queue.
Software
UI
Database
Elite
'ID/Batch' column
AccountingAPIQueuePO.Batch
"},"ContractStoreId":{"type":"string","description":"Store Id associated with the payable invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.Store
"},"ExternalLocationId":{"type":"string","description":"External store/location Id in the accounting system.
Software
UI
Database
Elite
N/A
AccountingLocation.AccountingLink
"},"ExternalPayableId":{"type":"string","description":"External payable Id in the accounting system.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.ExternalId
"},"ExternalVendorId":{"type":"string","description":"External vendor Id in the accounting system.
Software
UI
Database
Elite
N/A
VendorFile.GLLink
"},"FreightAccountId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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
"}}},"LineItems":{"type":"array","description":"A collection of line items related to the contract Id.","items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["AccountPayableInvoiceLineItem"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
"},"Identifiers":{"type":"object","description":"Collection of unique ids related to this payable invoice line item.","properties":{"AccountNumberId":{"type":"string","description":"General ledger account number Id (asset, inventory, expense). In Elite's UI, find by referencing the GL Account table, located at Purchase Orders → Options → General Ledger Account.
Software
UI
Database
Elite
'Account #' column
AccountingAPIQueuePO.AccountNumber
"},"ExternalPayableId":{"type":"string","description":"External payable Id in the accounting system.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.ExternalId
"},"InvoiceId":{"type":"string","description":"Accounts payable invoice Id associated to the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.AccountingAPIQueuePOId
"}}},"Item":{"type":"object","description":"Elite item associated to this payable invoice line item.","properties":{"ModelType":{"type":"string","enum":["Item"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
UI
Database
Elite
N/A
PurchaseOrderDetail.LineNumber
"},"Description":{"type":"string","format":"date-time","description":"Description of the item. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
Items 'Description' column
AccountingAPIQueuePODetail.Reference
"},"Key":{"type":"string","description":"Key of the item. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
Items 'Key' column
ItemFile.Key
"}}},"LineNumber":{"type":"integer","description":"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":{"type":"string","description":"Total price of miscellaneous costs. Found on the `Purchase Order` details screen.
"},"PurchaseOrderNumber":{"type":"string","description":"Purchase order number associated to the line item. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
PO #
AccountingAPIQueuePO.PONumber
"},"PurchaseOrderPartNumber":{"type":"string","description":"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":{"type":"string","description":"Purchase order sequence number associated to the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.Sequence
"},"QuantityOrdered":{"type":"number","description":"Quantity ordered on the purchase order. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
Items 'Qty' column
PurchaseOrderDetail.QuantityOrdered
"},"QuantityReceived":{"type":"number","description":"Quantity received on the purchase order. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
Items 'Recvd' column
PurchaseOrderDetail.QuantityReceived
"},"ReceivedDateTime":{"type":"string","format":"date-time","description":"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":{"type":"number","description":"Total price of each individual unit.
Software
UI
Database
Elite
N/A
PurchaseOrderDetail.PriceEach
"}}}},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the payable invoice.
Software
Support Note
UI
Database
Elite
Returns empty string
N/A
--
"},"MiscellaneousTotal":{"type":"number","description":"Total price of miscellaneous costs. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Misc'
AccountingAPIQueuePO.Miscellaneous
"},"PurchaseOrderNumber":{"type":"string","description":"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":{"type":"string","description":"Purchase order sequence number associated to the payable invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.Sequence
"},"PurchaseTotal":{"type":"number","description":"Total price of the purchases. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Subtotal'
AccountingAPIQueuePO.PurchaseAmount
"},"ShippingMethod":{"type":"string","description":"Shipping method on the payable invoice. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Shipping' section → 'ship method'
PurchaseOrder.ShipMethod
"},"State":{"type":"string","enum":["Pending","Posted","Error"],"description":"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`.
"},"TermsCode":{"type":"string","description":"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'
--
"},"Vendor":{"type":"object","description":"Elite vendor associated to this payable invoice. Found on the `Purchase Order` details screen.","properties":{"ModelType":{"type":"string","enum":["Vendor"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types. Expand to see nested fields."},"Id":{"type":"string","description":"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":{"type":"string","description":"Name of the vendor. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Vendor' section → 'name'
VendorFile.VendorName
"},"InvoiceNumber":{"type":"string","description":"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":{"type":"string","format":"date-time","description":"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":{"type":"string","format":"date-time","description":"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.
"}}}},"$id":"AccountPayableInvoiceResponse"}},"GetById-7":{"title":"AccountPayableInvoiceResponse","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountPayableInvoice"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"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":{"type":"string","format":"date-time","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"number","description":"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":{"type":"number","description":"Total price of the freight. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Freight'
AccountingAPIQueuePO.ShippingCost
"},"GrandTaxTotal":{"type":"number","description":"Total amount of sales tax. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Tax'
AccountingAPIQueuePO.Tax
"},"GrandTotal":{"type":"number","description":"Total amount that is payable. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Total'
AccountingAPIQueuePO.TotalAmount
"},"Identifiers":{"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"BatchId":{"type":"string","description":"Batch Id associated with this record. Found in the Accounting Queue.
Software
UI
Database
Elite
'ID/Batch' column
AccountingAPIQueuePO.Batch
"},"ContractStoreId":{"type":"string","description":"Store Id associated with the payable invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.Store
"},"ExternalLocationId":{"type":"string","description":"External store/location Id in the accounting system.
Software
UI
Database
Elite
N/A
AccountingLocation.AccountingLink
"},"ExternalPayableId":{"type":"string","description":"External payable Id in the accounting system.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.ExternalId
"},"ExternalVendorId":{"type":"string","description":"External vendor Id in the accounting system.
Software
UI
Database
Elite
N/A
VendorFile.GLLink
"},"FreightAccountId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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
"}}},"LineItems":{"type":"array","description":"A collection of line items related to the contract Id.","items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["AccountPayableInvoiceLineItem"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
"},"Identifiers":{"type":"object","description":"Collection of unique ids related to this payable invoice line item.","properties":{"AccountNumberId":{"type":"string","description":"General ledger account number Id (asset, inventory, expense). In Elite's UI, find by referencing the GL Account table, located at Purchase Orders → Options → General Ledger Account.
Software
UI
Database
Elite
'Account #' column
AccountingAPIQueuePO.AccountNumber
"},"ExternalPayableId":{"type":"string","description":"External payable Id in the accounting system.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.ExternalId
"},"InvoiceId":{"type":"string","description":"Accounts payable invoice Id associated to the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.AccountingAPIQueuePOId
"}}},"Item":{"type":"object","description":"Elite item associated to this payable invoice line item.","properties":{"ModelType":{"type":"string","enum":["Item"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
UI
Database
Elite
N/A
PurchaseOrderDetail.LineNumber
"},"Description":{"type":"string","format":"date-time","description":"Description of the item. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
Items 'Description' column
AccountingAPIQueuePODetail.Reference
"},"Key":{"type":"string","description":"Key of the item. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
Items 'Key' column
ItemFile.Key
"}}},"LineNumber":{"type":"integer","description":"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":{"type":"string","description":"Total price of miscellaneous costs. Found on the `Purchase Order` details screen.
"},"PurchaseOrderNumber":{"type":"string","description":"Purchase order number associated to the line item. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
PO #
AccountingAPIQueuePO.PONumber
"},"PurchaseOrderPartNumber":{"type":"string","description":"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":{"type":"string","description":"Purchase order sequence number associated to the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.Sequence
"},"QuantityOrdered":{"type":"number","description":"Quantity ordered on the purchase order. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
Items 'Qty' column
PurchaseOrderDetail.QuantityOrdered
"},"QuantityReceived":{"type":"number","description":"Quantity received on the purchase order. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
Items 'Recvd' column
PurchaseOrderDetail.QuantityReceived
"},"ReceivedDateTime":{"type":"string","format":"date-time","description":"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":{"type":"number","description":"Total price of each individual unit.
Software
UI
Database
Elite
N/A
PurchaseOrderDetail.PriceEach
"}}}},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the payable invoice.
Software
Support Note
UI
Database
Elite
Returns empty string
N/A
--
"},"MiscellaneousTotal":{"type":"number","description":"Total price of miscellaneous costs. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Misc'
AccountingAPIQueuePO.Miscellaneous
"},"PurchaseOrderNumber":{"type":"string","description":"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":{"type":"string","description":"Purchase order sequence number associated to the payable invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueuePO.Sequence
"},"PurchaseTotal":{"type":"number","description":"Total price of the purchases. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Totals' section → 'Subtotal'
AccountingAPIQueuePO.PurchaseAmount
"},"ShippingMethod":{"type":"string","description":"Shipping method on the payable invoice. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Shipping' section → 'ship method'
PurchaseOrder.ShipMethod
"},"State":{"type":"string","enum":["Pending","Posted","Error"],"description":"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`.
"},"TermsCode":{"type":"string","description":"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'
--
"},"Vendor":{"type":"object","description":"Elite vendor associated to this payable invoice. Found on the `Purchase Order` details screen.","properties":{"ModelType":{"type":"string","enum":["Vendor"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types. Expand to see nested fields."},"Id":{"type":"string","description":"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":{"type":"string","description":"Name of the vendor. Found on the `Purchase Order` details screen.
Software
UI
Database
Elite
'Vendor' section → 'name'
VendorFile.VendorName
"},"InvoiceNumber":{"type":"string","description":"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":{"type":"string","format":"date-time","description":"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":{"type":"string","format":"date-time","description":"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.
"}}}},"$id":"AccountPayableInvoiceResponse"},"PatchById":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the invoice `State` is set to 'Error'.
Validation
Maximum length is 255 characters.
"},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever invoice `State` is set to 'Error'.
Validation
Maximum length is 2^31-1 characters.
"},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice line item.","properties":{"ExternalPayableId":{"nullable":true,"type":"string","description":"External Payable Id in the accounting system."}}},"State":{"type":"string","description":"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.
","enum":["Pending","Posted","Error"]}},"default":{"ErrorCode":"string","ErrorDescription":"string","State":"string"}},"GetAll-8":{"type":"array","items":{"title":"AccountReceivableInvoiceResponse","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivableInvoice"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"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":{"type":"number","description":"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":{"type":"string","enum":["Cash","Credit","Invoice"],"description":"Type of contract. Found on the `Contract Processing` screen.
"},"CurrencyCode":{"type":"string","nullable":true,"description":"Currency code value set in the accounting system. Found on the `Contract Processing` screen.
"},"CustomerPurchaseOrderNumber":{"type":"string","nullable":true,"description":"Customer purchase order number associated to the invoice. Found on the `Contract Processing` screen.
"},"Delivery":{"type":"object","description":"Ship to / delivery details associated with the contract on the invoice. Found on the `Contract Processing` screen. Expand to see nested fields.","properties":{"Type":{"type":"string","enum":["Default"],"description":"A general label that could be used to help define the type of address being returned."},"City":{"type":"string","description":"City or Town for this address.
"},"Line1":{"type":"string","description":"Includes the main address details such as street number, street name, and any additional information as needed, such as apartment or building number.
"}}},"EndDateTime":{"type":"string","format":"date-time","nullable":true,"description":"Date and time when the contract was closed.
Software
Filterable
UI
Database
Elite
Yes
N/A
Transactions.CLDT
"},"ErrorCode":{"type":"string","nullable":true,"description":"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":{"nullable":true,"type":"string","description":"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":{"type":"number","nullable":true,"description":"Exchange rate of the contract on the invoice.
Software
UI
Database
Elite
Transactions.ExchangeRate
"},"GrandTaxTotal":{"type":"number","description":"Total amount of sales tax invoiced. Found on the `Contract Processing` screen.
"},"Identifiers":{"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"ContractId":{"type":"string","description":"Contract Id associated to the invoice, which will also map to the `Id` property on the `/Invoices` endpoint. Found on the `Contract Processing` screen.
"},"BatchId":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Store Id associated to the contract on the invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.Store
"},"CustomerId":{"type":"string","nullable":true,"description":"Elite customer id associated with the invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.CustomerNumber
"},"ExternalLocationId":{"type":"string","nullable":true,"description":"External location Id associated to the invoice.
Software
UI
Database
Elite
N/A
AccountingLocation.AccountingLink
"},"ExternalInvoiceId":{"type":"string","nullable":true,"description":"External invoice Id associated to the invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.ExternalInvoiceId
"},"ExternalCustomerId":{"type":"string","nullable":true,"description":"The value from a 3rd party system that identifies the Customer record for integrations.
Software
UI
Database
Elite
N/A
CustomerFile.APILink
"},"ParentContractId":{"nullable":true,"type":"string","description":"Parent contract id associated with the invoice.
Software
UI
Database
Elite
N/A
Transactions.ParentContract
"}}},"InvoiceNumber":{"type":"string","nullable":true,"description":"The Sequential Invoice Number associated with the Contract.\n\nOn 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":{"type":"number","nullable":true,"description":"Total value of item percentage on the contract. Found on the `Contract Processing` screen.
"},"LineItems":{"type":"array","description":"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.","items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivableInvoiceLineItem"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"Unique identifier for the model type.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.Id
"},"AccountingClass":{"type":"string","nullable":true,"description":"Class / Category in the accounting system.
Software
UI
Database
Elite
N/A
AccountingClass.AccountingLink
"},"DamageWaiverPercent":{"type":"number","nullable":true,"description":"Percentage used in the damage waiver calculation on the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.DmgWvr
"},"DiscountPercent":{"type":"number","nullable":true,"description":"Percentage discount applied to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.DiscountPercent
"},"DiscountTotal":{"type":"number","nullable":true,"description":"Discount amount applied to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.DiscountAmount
"},"DueDateTime":{"type":"string","format":"date-time","description":"The date the item was returned.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.DDT
"},"ExtendedPriceTotal":{"type":"number","nullable":true,"description":"Extended line item price.
Software
UI
Database
Elite
'Items' tab → configurable column
(TransactionItems.PRIC - TransactionItems.DiscountAmount) OR AccountingAPIQueueTRDetail.ItemAmount
"},"GrandTaxTotal":{"type":"number","description":"Total sales tax amount for the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.TaxAmount
"},"GrandTotal":{"type":"number","description":"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":{"type":"number","nullable":true,"description":"Total value of the hours charged.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.HRSC
"},"Identifiers":{"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"InvoiceId":{"type":"string","description":"Account receivable invoice Id associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.AccountingAPIQueueTRId
"},"ContractId":{"type":"string","description":"Contract Id associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTR.ContractNumber
"},"GeneralLedgerAccountId":{"type":"string","nullable":true,"description":"General ledger account Id associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.AccountNumber
"},"GeneralLedgerOffsetAccountId":{"type":"string","nullable":true,"description":"General ledger offset account Id associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.OffsetAccountNumber
"}}},"Item":{"type":"object","description":"Elite item associated to this invoice line item.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["Item"]},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.ItemNumber
"},"Name":{"type":"string","description":"Name of the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.Name
"},"Key":{"type":"string","description":"Unique key identifier associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.KEY
"},"CategoryId":{"type":"integer","nullable":true,"description":"Unique category Id associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.ItemCategoryId
"},"CategoryName":{"type":"string","nullable":true,"description":"Category name associated to the `CategoryId`.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemCategory.Name
"},"Description":{"type":"string","nullable":true,"description":"A description associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFileDescriptionLong
"},"IsAsset":{"type":"boolean","description":"Flag denoting if the item is a capitalized asset.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.Asset
"},"Manufacturer":{"type":"string","nullable":true,"description":"Manufacturer associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.MANF
"},"Model":{"type":"string","nullable":true,"description":"Model name associated to the item.
Software
Supported
Filterable
UI
Database
Elite
No, always ''
--
--
--
"},"ModelYear":{"type":"string","nullable":true,"description":"Model year associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.ModelYear
"},"SerialNumber":{"type":"string","nullable":true,"description":"Serial number associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.SerialNumber
"},"Type":{"type":"string","description":"Type associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.TYPE
","enum":["Rental","Retail"]}}},"ItemPercent":{"type":"number","nullable":true,"description":"Percentage used in the Item Percentage calculation for the item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.ItemPercentage
"},"LineNumber":{"type":"integer","description":"The line number in which this item was added onto the contract.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.LineNumber
"},"Memo":{"type":"string","nullable":true,"description":"Memo associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.ItemMemo
"},"MeterIn":{"type":"number","nullable":true,"description":"Meter reading on the line item when it was returned.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.ReadingIn
"},"MeterOut":{"type":"number","nullable":true,"description":"Meter reading on the line item when it was sent out.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.ReadingOut
"},"NonTaxable":{"type":"boolean","description":"Flag denoting if the item is non taxable.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.Nontaxable
"},"OutDateTime":{"type":"string","format":"date-time","description":"Date representing when the line item was sent out.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.OutDate
"},"Quantity":{"type":"number","nullable":true,"description":"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":{"type":"integer","nullable":true,"description":"Invoice line item type identifier. \n\nTable of available type Ids\n\n|Type Id|Type Name|\n|------|------|\n| 1 |TransItem|\n| 2 |SalesTax|\n| 3 |DamageWaiver|\n| 4 |ItemPercentage|\n| 5 |OtherIncome|\n| 6 |PaidPriorToClose|\n| 7 |Credit|\n| 8 |Disbursement|\n
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.LineItemTypeId
"},"TypeName":{"type":"string","description":"Invoice line item type name
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.LineItemTypeId
","enum":["TransItem","SalesTax","DamageWaiver","ItemPercentage","OtherIncome","PaidPriorToClose","Credit","Disbursement",null]}}}},"OrderedBy":{"type":"string","nullable":true,"description":"Customer representative who originated the contract. Found on the `Contract Processing` screen.
"},"StartDateTime":{"type":"string","format":"date-time","description":"Date and time of when the contract opened.
Software
Filterable
UI
Database
Elite
Yes
N/A
AccountingAPIQueueTR.TransDate
"},"State":{"type":"string","description":"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`.
","enum":["Pending","Posted","Error"]},"TaxableTotal":{"type":"number","description":"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
"}},"$id":"AccountReceivableInvoiceResponse"}},"GetById-8":{"title":"AccountReceivableInvoiceResponse","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivableInvoice"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"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":{"type":"number","description":"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":{"type":"string","enum":["Cash","Credit","Invoice"],"description":"Type of contract. Found on the `Contract Processing` screen.
"},"CurrencyCode":{"type":"string","nullable":true,"description":"Currency code value set in the accounting system. Found on the `Contract Processing` screen.
"},"CustomerPurchaseOrderNumber":{"type":"string","nullable":true,"description":"Customer purchase order number associated to the invoice. Found on the `Contract Processing` screen.
"},"Delivery":{"type":"object","description":"Ship to / delivery details associated with the contract on the invoice. Found on the `Contract Processing` screen. Expand to see nested fields.","properties":{"Type":{"type":"string","enum":["Default"],"description":"A general label that could be used to help define the type of address being returned."},"City":{"type":"string","description":"City or Town for this address.
"},"Line1":{"type":"string","description":"Includes the main address details such as street number, street name, and any additional information as needed, such as apartment or building number.
"}}},"EndDateTime":{"type":"string","format":"date-time","nullable":true,"description":"Date and time when the contract was closed.
Software
Filterable
UI
Database
Elite
Yes
N/A
Transactions.CLDT
"},"ErrorCode":{"type":"string","nullable":true,"description":"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":{"nullable":true,"type":"string","description":"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":{"type":"number","nullable":true,"description":"Exchange rate of the contract on the invoice.
Software
UI
Database
Elite
Transactions.ExchangeRate
"},"GrandTaxTotal":{"type":"number","description":"Total amount of sales tax invoiced. Found on the `Contract Processing` screen.
"},"Identifiers":{"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"ContractId":{"type":"string","description":"Contract Id associated to the invoice, which will also map to the `Id` property on the `/Invoices` endpoint. Found on the `Contract Processing` screen.
"},"BatchId":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"Store Id associated to the contract on the invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.Store
"},"CustomerId":{"type":"string","nullable":true,"description":"Elite customer id associated with the invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.CustomerNumber
"},"ExternalLocationId":{"type":"string","nullable":true,"description":"External location Id associated to the invoice.
Software
UI
Database
Elite
N/A
AccountingLocation.AccountingLink
"},"ExternalInvoiceId":{"type":"string","nullable":true,"description":"External invoice Id associated to the invoice.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.ExternalInvoiceId
"},"ExternalCustomerId":{"type":"string","nullable":true,"description":"The value from a 3rd party system that identifies the Customer record for integrations.
Software
UI
Database
Elite
N/A
CustomerFile.APILink
"},"ParentContractId":{"nullable":true,"type":"string","description":"Parent contract id associated with the invoice.
Software
UI
Database
Elite
N/A
Transactions.ParentContract
"}}},"InvoiceNumber":{"type":"string","nullable":true,"description":"The Sequential Invoice Number associated with the Contract.\n\nOn 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":{"type":"number","nullable":true,"description":"Total value of item percentage on the contract. Found on the `Contract Processing` screen.
"},"LineItems":{"type":"array","description":"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.","items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivableInvoiceLineItem"],"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"Unique identifier for the model type.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.Id
"},"AccountingClass":{"type":"string","nullable":true,"description":"Class / Category in the accounting system.
Software
UI
Database
Elite
N/A
AccountingClass.AccountingLink
"},"DamageWaiverPercent":{"type":"number","nullable":true,"description":"Percentage used in the damage waiver calculation on the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.DmgWvr
"},"DiscountPercent":{"type":"number","nullable":true,"description":"Percentage discount applied to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.DiscountPercent
"},"DiscountTotal":{"type":"number","nullable":true,"description":"Discount amount applied to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.DiscountAmount
"},"DueDateTime":{"type":"string","format":"date-time","description":"The date the item was returned.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.DDT
"},"ExtendedPriceTotal":{"type":"number","nullable":true,"description":"Extended line item price.
Software
UI
Database
Elite
'Items' tab → configurable column
(TransactionItems.PRIC - TransactionItems.DiscountAmount) OR AccountingAPIQueueTRDetail.ItemAmount
"},"GrandTaxTotal":{"type":"number","description":"Total sales tax amount for the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.TaxAmount
"},"GrandTotal":{"type":"number","description":"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":{"type":"number","nullable":true,"description":"Total value of the hours charged.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.HRSC
"},"Identifiers":{"type":"object","description":"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. \nSupported fields vary by endpoint. The inclusion of a field in one endpoint does not guarantee inclusion on another endpoint.","properties":{"InvoiceId":{"type":"string","description":"Account receivable invoice Id associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.AccountingAPIQueueTRId
"},"ContractId":{"type":"string","description":"Contract Id associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTR.ContractNumber
"},"GeneralLedgerAccountId":{"type":"string","nullable":true,"description":"General ledger account Id associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.AccountNumber
"},"GeneralLedgerOffsetAccountId":{"type":"string","nullable":true,"description":"General ledger offset account Id associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.OffsetAccountNumber
"}}},"Item":{"type":"object","description":"Elite item associated to this invoice line item.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["Item"]},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.ItemNumber
"},"Name":{"type":"string","description":"Name of the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.Name
"},"Key":{"type":"string","description":"Unique key identifier associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.KEY
"},"CategoryId":{"type":"integer","nullable":true,"description":"Unique category Id associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.ItemCategoryId
"},"CategoryName":{"type":"string","nullable":true,"description":"Category name associated to the `CategoryId`.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemCategory.Name
"},"Description":{"type":"string","nullable":true,"description":"A description associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFileDescriptionLong
"},"IsAsset":{"type":"boolean","description":"Flag denoting if the item is a capitalized asset.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.Asset
"},"Manufacturer":{"type":"string","nullable":true,"description":"Manufacturer associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.MANF
"},"Model":{"type":"string","nullable":true,"description":"Model name associated to the item.
Software
Supported
Filterable
UI
Database
Elite
No, always ''
--
--
--
"},"ModelYear":{"type":"string","nullable":true,"description":"Model year associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.ModelYear
"},"SerialNumber":{"type":"string","nullable":true,"description":"Serial number associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.SerialNumber
"},"Type":{"type":"string","description":"Type associated to the item.
Software
UI
Database
Elite
'Items' tab → configurable column
ItemFile.TYPE
","enum":["Rental","Retail"]}}},"ItemPercent":{"type":"number","nullable":true,"description":"Percentage used in the Item Percentage calculation for the item.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.ItemPercentage
"},"LineNumber":{"type":"integer","description":"The line number in which this item was added onto the contract.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.LineNumber
"},"Memo":{"type":"string","nullable":true,"description":"Memo associated to the line item.
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.ItemMemo
"},"MeterIn":{"type":"number","nullable":true,"description":"Meter reading on the line item when it was returned.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.ReadingIn
"},"MeterOut":{"type":"number","nullable":true,"description":"Meter reading on the line item when it was sent out.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.ReadingOut
"},"NonTaxable":{"type":"boolean","description":"Flag denoting if the item is non taxable.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.Nontaxable
"},"OutDateTime":{"type":"string","format":"date-time","description":"Date representing when the line item was sent out.
Software
UI
Database
Elite
'Items' tab → configurable column
TransactionItems.OutDate
"},"Quantity":{"type":"number","nullable":true,"description":"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":{"type":"integer","nullable":true,"description":"Invoice line item type identifier. \n\nTable of available type Ids\n\n|Type Id|Type Name|\n|------|------|\n| 1 |TransItem|\n| 2 |SalesTax|\n| 3 |DamageWaiver|\n| 4 |ItemPercentage|\n| 5 |OtherIncome|\n| 6 |PaidPriorToClose|\n| 7 |Credit|\n| 8 |Disbursement|\n
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.LineItemTypeId
"},"TypeName":{"type":"string","description":"Invoice line item type name
Software
UI
Database
Elite
'Items' tab → configurable column
AccountingAPIQueueTRDetail.LineItemTypeId
","enum":["TransItem","SalesTax","DamageWaiver","ItemPercentage","OtherIncome","PaidPriorToClose","Credit","Disbursement",null]}}}},"OrderedBy":{"type":"string","nullable":true,"description":"Customer representative who originated the contract. Found on the `Contract Processing` screen.
"},"StartDateTime":{"type":"string","format":"date-time","description":"Date and time of when the contract opened.
Software
Filterable
UI
Database
Elite
Yes
N/A
AccountingAPIQueueTR.TransDate
"},"State":{"type":"string","description":"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`.
","enum":["Pending","Posted","Error"]},"TaxableTotal":{"type":"number","description":"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
"}},"$id":"AccountReceivableInvoiceResponse"},"PatchById-2":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the invoice `State` is set to 'Error'.
Validation
Maximum length is 255 characters.
"},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever invoice `State` is set to 'Error'.
Validation
Maximum length is 2^31-1 characters.
"},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice line item.","properties":{"ExternalInvoiceId":{"nullable":true,"type":"string","description":"External Invoice Id in the accounting system."}}},"State":{"type":"string","description":"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.
","enum":["Pending","Posted","Error"]}},"default":{"ErrorCode":"string","ErrorDescription":"string","State":"string"}},"GetAll-9":{"type":"array","items":{"title":"AccountReceivablePaymentResponse","description":"To view information from imported payments, navigate to the accounting export queue in Elite. In the selection criteria box, selected the 'imported' check box and change the 'Type' dropdown to 'AR Transactions'.","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["AccountReceivablePayment"]},"Id":{"type":"string","description":"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":{"type":"string","description":"Contract code class name, either Credit or Payment. Found on the 'Accounting Queue' screen.
Software
Filterable
UI
Database
Elite
Yes
'Type' column
AccountingAPIQueueTR.TransactionType
","enum":["Credit","Payment"]},"ErrorCode":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"number","description":"Total amount credited to the customer invoice. Found on the 'Accounting Queue' screen.
Software
Filterable
UI
Database
Elite
Yes
'Amount' column
AccountingAPIQueueTR.TransAmount
"},"Identifiers":{"type":"object","properties":{"ContractId":{"type":"string","description":"Contract Id associated to the payment. Contract that has credit or payment applied.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.ContractNumber
"},"CreditSourceContractId":{"type":"string","description":"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":{"type":"string","description":"Elite Customer Id associated with the payment.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.CustomerNumber
"},"ExternalContractId":{"type":"string","description":"External contract Id in the accounting system.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.AccountingLink
"},"ExternalCreditId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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
"}},"required":["ExternalContractId"]},"Memo":{"type":"string","description":"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":{"type":"string","description":"Method of payment.
Software
Filterable
UI
Database
Elite
Yes
N/A
AccountingAPIQueueTR.TransClass
","enum":["Card","Cash","Check","Credit","Debit"]},"PostedDateTime":{"type":"string","description":"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
","format":"date-time"},"State":{"type":"string","description":"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
","enum":["Pending","Posted","Error"]},"CreatedDateTime":{"type":"string","description":"Date and time when the payment was added to the queue.","format":"date-time"}},"$id":"AccountReceivablePaymentResponse"}},"PostCreate-2":{"title":"AccountReceivablePaymentRequest","description":"test","type":"object","properties":{"ContractCodeName":{"type":"string","description":"Contract code class name, either Credit or Payment.
Validation
Required
Must be one of the listed values.
","enum":["Credit","Payment"]},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the payment `State` is set to 'Error'.","readOnly":true},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever payment `State` is set to 'Error'.","readOnly":true},"Identifiers":{"type":"object","description":"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.","properties":{"ContractId":{"type":"string","description":"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":{"type":"string","description":"The Sequential Invoice Number associated with the Contract.
Validation
Conditionally Required
One of the following is required: `ContractId`, `ExternalInvoiceId`, or `InvoiceNumber`.
"},"ExternalInvoiceId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"External Transaction Id in the accounting system.
Validation
Conditionally Required
Required when `ContractCodeName` = `Payment`
"}}},"GrandTotal":{"type":"number","description":"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":{"type":"string","description":"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
","format":"date-time"},"Method":{"type":"string","description":"Method of payment.
Validation
Conditionally Required
Required if `ContractCodeName` = `Payment.
Must be one of the listed values.
","enum":["Card","Cash","Check","Credit","Debit"]},"Memo":{"type":"string","description":"Note, reference, or description related to the payment.
Validation
Max characters is 255.
"}},"required":["ContractCodeName","Identifiers","GrandTotal","PostedDateTime","Identifiers.ExternalTransactionId"],"$id":"AccountReceivablePaymentRequest"},"GetById-9":{"title":"AccountReceivablePaymentResponse","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["AccountReceivablePayment"]},"Id":{"type":"string","description":"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":{"type":"string","description":"Contract code class name, either Credit or Payment. Found on the 'Accounting Queue' screen.
Software
Filterable
UI
Database
Elite
Yes
'Type' column
AccountingAPIQueueTR.TransactionType
","enum":["Credit","Payment"]},"ErrorCode":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"number","description":"Total amount credited to the customer invoice. Found on the 'Accounting Queue' screen.
Software
Filterable
UI
Database
Elite
Yes
'Amount' column
AccountingAPIQueueTR.TransAmount
"},"Identifiers":{"type":"object","properties":{"ContractId":{"type":"string","description":"Contract Id associated to the payment. Contract that has credit or payment applied.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.ContractNumber
"},"CreditSourceContractId":{"type":"string","description":"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":{"type":"string","description":"Elite Customer Id associated with the payment.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.CustomerNumber
"},"ExternalContractId":{"type":"string","description":"External contract Id in the accounting system.
Software
UI
Database
Elite
N/A
AccountingAPIQueueTR.AccountingLink
"},"ExternalCreditId":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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
"}},"required":["ExternalContractId"]},"Memo":{"type":"string","description":"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":{"type":"string","description":"Method of payment.
Software
Filterable
UI
Database
Elite
Yes
N/A
AccountingAPIQueueTR.TransClass
","enum":["Card","Cash","Check","Credit","Debit"]},"PostedDateTime":{"type":"string","description":"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
","format":"date-time"},"State":{"type":"string","description":"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
","enum":["Pending","Posted","Error"]},"CreatedDateTime":{"type":"string","description":"Date and time when the payment was added to the queue.","format":"date-time"}},"$id":"AccountReceivablePaymentResponse"},"GetAll-10":{"title":"JournalEntryRequest","type":"array","items":{"description":"General ledger journal entry.","type":"object","properties":{"ModelType":{"type":"string","enum":["JournalEntry"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"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
"},"Dimensions":{"type":"object","nullable":false,"description":"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.","properties":{"Class":{"type":"string","nullable":false,"description":"Classes dimension.
"},"JobSite":{"type":"string","nullable":false,"description":"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.
"},"Project":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":false,"description":"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.
"}}},"EntryDateTime":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Identifiers":{"type":"object","nullable":false,"description":"Collection of unique IDs related to this Journal Entry. Expand to see nested fields.","properties":{"BatchId":{"type":"string","nullable":true,"description":"Batch Id associated with this record. Found in the Accounting Queue.
Software
UI
Database
Elite
'ID/Batch' column
AccountingAPIQueueGL.Batch
"},"ExternalJournalEntryId":{"type":"string","nullable":true,"description":"External journal entry Id from the accounting system.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGL.ExternalId
"}}},"LineItems":{"type":"array","description":"A collection of line items related to the journal entry. Expand to see nested fields.","items":{"type":"object","description":"General ledger journal entry line item.","properties":{"ModelType":{"type":"string","enum":["JournalEntryLineItem"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.Id
"},"GrandTotal":{"type":"number","nullable":false,"description":"Line item amount. Positive values are debits. Negative values are credits.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.TransAmount
"},"Identifiers":{"type":"object","description":"Collection of unique IDs related to this journal entry's line item. Expand to see nested fields.","properties":{"ContractId":{"type":"string","nullable":true,"description":"Contract Id associated with the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.CNTR
"},"CustomerId":{"type":"string","nullable":true,"description":"Customer Id associated with the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.CUSN
"},"ExternalContractId":{"type":"string","nullable":true,"description":"External contract Id associated with the line item.
Software
UI
Database
Elite
N/A
AccountingTransaction.AccountingLink
"},"ExternalCustomerId":{"type":"string","nullable":true,"description":"The value from a 3rd party system that identifies the Customer record for integrations.
Software
UI
Database
Elite
N/A
AccountingTransaction.AccountingLink
"},"JournalEntryAccountId":{"type":"string","nullable":true,"description":"General Ledger account ID associated with the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.AccountNumber
"},"JournalEntryId":{"type":"string","nullable":false,"description":"Journal Entry ID associated with the line item. Found in the Accounting Queue. White rows are line items.
"}}}},"Memo":{"type":"string","nullable":true,"description":"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":{"type":"string","enum":["Pending","Posted","Error"],"nullable":false,"description":"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
"}}}},"GetById-10":{"type":"object","properties":{"ModelType":{"type":"string","enum":["JournalEntry"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"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
"},"Dimensions":{"type":"object","nullable":false,"description":"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.","properties":{"Class":{"type":"string","nullable":false,"description":"Classes dimension.
"},"JobSite":{"type":"string","nullable":false,"description":"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.
"},"Project":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":false,"description":"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.
"}}},"EntryDateTime":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Identifiers":{"type":"object","nullable":false,"description":"Collection of unique IDs related to this Journal Entry. Expand to see nested fields.","properties":{"BatchId":{"type":"string","nullable":true,"description":"Batch Id associated with this record. Found in the Accounting Queue.
Software
UI
Database
Elite
'ID/Batch' column
AccountingAPIQueueGL.Batch
"},"ExternalJournalEntryId":{"type":"string","nullable":true,"description":"External journal entry Id from the accounting system.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGL.ExternalId
"}}},"LineItems":{"type":"array","description":"A collection of line items related to the journal entry. Expand to see nested fields.","items":{"type":"object","description":"General ledger journal entry line item.","properties":{"ModelType":{"type":"string","enum":["JournalEntryLineItem"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.Id
"},"GrandTotal":{"type":"number","nullable":false,"description":"Line item amount. Positive values are debits. Negative values are credits.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.TransAmount
"},"Identifiers":{"type":"object","description":"Collection of unique IDs related to this journal entry's line item. Expand to see nested fields.","properties":{"ContractId":{"type":"string","nullable":true,"description":"Contract Id associated with the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.CNTR
"},"CustomerId":{"type":"string","nullable":true,"description":"Customer Id associated with the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.CUSN
"},"ExternalContractId":{"type":"string","nullable":true,"description":"External contract Id associated with the line item.
Software
UI
Database
Elite
N/A
AccountingTransaction.AccountingLink
"},"ExternalCustomerId":{"type":"string","nullable":true,"description":"The value from a 3rd party system that identifies the Customer record for integrations.
Software
UI
Database
Elite
N/A
AccountingTransaction.AccountingLink
"},"JournalEntryAccountId":{"type":"string","nullable":true,"description":"General Ledger account ID associated with the line item.
Software
UI
Database
Elite
N/A
AccountingAPIQueueGLDetail.AccountNumber
"},"JournalEntryId":{"type":"string","nullable":false,"description":"Journal Entry ID associated with the line item. Found in the Accounting Queue. White rows are line items.
"}}}},"Memo":{"type":"string","nullable":true,"description":"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":{"type":"string","enum":["Pending","Posted","Error"],"nullable":false,"description":"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
"}}},"PatchById-3":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","description":"General ledger journal entry.","properties":{"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the invoice `State` is set to 'Error'.
Validation
Maximum length is 255 characters.
"},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever invoice `State` is set to 'Error'.
Validation
Maximum length is 2^31-1 characters.
"},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice line item.","properties":{"ExternalJournalEntryId":{"nullable":true,"type":"string","description":"External journal entry Id in the accounting system."}}},"State":{"type":"string","description":"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.
","enum":["Pending","Posted","Error"]}},"default":{"ErrorCode":"string","ErrorDescription":"string","State":"string"}},"GetAll-11":{"type":"array","items":{"$id":"global_package_remote_line-item","$schema":"http://json-schema.org/draft-07/schema#","title":"LineItem","type":"object","description":"An inventory item associated with a contract.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type.","readOnly":true},"Id":{"type":"string","description":"The unique identifier for this record.","readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups.","readOnly":true},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for LineItem.","properties":{"Key":{"nullable":true,"type":"string","description":"(Elite Only) This value is a secondary unique inventory identifier (similar and additional to a serial number) and can be the same as the Primary ID. Must be a unique numeric or alpha-numeric value.","readOnly":true},"Model":{"nullable":true,"type":"string","description":"(Elite Only) The model name associated with a specific instance of an item.","readOnly":true},"ParentId":{"nullable":true,"type":"string","description":"Elite and Essentials Only.","readOnly":true},"PartNumber":{"nullable":true,"type":"string","description":"(Elite Only) The part number associated with a specific instance of an item.","readOnly":true}},"readOnly":true},"Classification":{"type":"string","description":"This product is either meant for sale or rental. The internal classification does not apply to lineitems.","enum":["Rental","Sale",null],"readOnly":true},"EndDateTime":{"nullable":true,"type":"string","description":"UTC - When does the customer intend to return the items?","format":"date-time","readOnly":true},"FuelCapacity":{"nullable":true,"type":"number","description":"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.","readOnly":true},"HasFuel":{"nullable":true,"type":"boolean","description":"If this is related to an item that uses fuel, this field will be set. If not it will be false.","readOnly":true},"IsSerialized":{"nullable":true,"type":"boolean","description":"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.","readOnly":true},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"number","description":"This is the final projected tax for this line.","readOnly":true},"LineTotal":{"nullable":true,"type":"number","description":"This is the final projected price for this line accounting for qty, discounts, duration, tax, etc..","readOnly":true},"LocationId":{"nullable":true,"type":"string","description":"Id of the Location. (see the Location endpoints)","readOnly":true},"MeterReadings":{"nullable":true,"type":"array","description":"Meter readings of this inventory. Multiple readings allowed for different types.","items":{"type":"object","properties":{"MeterReading":{"type":"number","description":"The last known meter reading of this inventory."},"MeterType":{"type":"string","description":"The type of meter for this reading."}}},"readOnly":true},"Notes":{"nullable":true,"type":"string","description":"Notes attached to a line item. Not an array of notes like its similarly name fields.","readOnly":true},"PONumber":{"nullable":true,"type":"string","description":"A number associated to a contract. Thi is user definable and associated by a POR user and their customer.","readOnly":true},"ProductId":{"nullable":true,"type":"string","description":"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.)","readOnly":true},"Quantity":{"type":"number","description":"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.","readOnly":true},"Rates":{"nullable":true,"type":"array","description":"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. \n\nThis is currently not supported in Elite.","items":{"type":"string"},"readOnly":true},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.","readOnly":true},"ShowOnContract":{"type":"boolean","default":true,"readonly":true,"description":"Is it a component/unincluded/optional item to display on contract. If false this item should generally not be shown to the consumer."},"StartDateTime":{"nullable":true,"type":"string","description":"UTC - When does the customer want the items?","format":"date-time","readOnly":true},"Status":{"nullable":true,"type":"string","description":"The displayable status of a lineitem. Sales lineitems might say \"sold\". Rental items might say \"reserved\".\n* Reserved\n* Out\n* Off Rent\n* Returned\n* Sold\n","enum":["Reserved","Out","Off Rent","Returned","Sold"],"readOnly":true},"StockId":{"nullable":true,"type":"string","description":"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.)","readOnly":true},"Workflows":{"type":"array","description":"For Internal Use Only.","readOnly":true,"items":{"$id":"global_package_remote_workflow","$schema":"http://json-schema.org/draft-07/schema#","title":"Workflow","type":"object","properties":{"Creatable":{"nullable":true,"type":"boolean","description":"Can the workflow be created?"},"TemplateId":{"nullable":true,"type":"string"},"PhotoPickerType":{"type":"string","description":"Options are None, Generic, 360","enum":["Default","Image360","None",null]},"RequiredPhotos":{"nullable":true,"type":"number"}}}},"AllRates":{"type":"array","description":"All rates for this product or stock whether relevant or not. In most cases, you will want to use applicable rates.","items":{"type":"object","properties":{"PeriodName":{"type":"string","description":"Example: \"daily rate\", \"1 week rate\""},"Rate":{"nullable":true,"type":"string","description":"Example: \"20.00\""},"CurrencyType":{"type":"string","description":"Example: \"USD\""}}}},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for this record.","properties":{"ContractId":{"oneOf":[{"type":"string","description":"The id of the associated contract."},{"type":"number","description":"The id of the associated contract."}],"nullable":true,"description":"The id of the associated contract."},"FuelStockName":{"nullable":true,"type":"string","description":"(Elite Only) The name of the fuel stock associated with this line item and ios only used for debugging purposes. This field should only show up if the isFuel field is true."},"FuelStockId":{"nullable":true,"type":"string","description":"(Elite Only) The id of the fuel stock associated with this line item and ios only used for debugging purposes. This field should only show up if the isFuel field is true."}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was created.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was updated.","format":"date-time","readOnly":true},"Hidden":{"nullable":true,"type":"integer","enum":[null,1],"description":"Hidden"},"ItemId":{"nullable":true,"type":"string","description":"Kept for legacy support, will eventually only need StockId and ProductId.","deprecated":true,"readOnly":true}},"default":{"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"}}},"CallOffRent":{"$schema":"http://json-schema.org/draft-07/schema#","title":"LineItemsCallOffRent","type":"object","properties":{"LineItemIds":{"type":"array","items":{"type":"string","description":"The unique line items id"},"description":"The unique line items ids"},"CalledOffDateTime":{"type":"string","format":"date-time","description":"What date and time to call off the line items. UTC time zone. e.g. 2023-01-01T06:00:00Z"},"PersonCallingOff":{"type":"string","description":"Name of the person who is calling the line items off rent."},"Memo":{"type":"string","description":"Additional textual information for calling the line items off rent."},"RemoteUserId":{"type":"string","description":"An identifier on the remote server for the user's account. Can be User ID, Username, anything to match the Relationship to a user."}},"required":["LineItemIds","CalledOffDateTime"],"default":{"LineItemIds":[],"CalledOffDateTime":"string","PersonCallingOff":"string","Memo":"string","RemoteUserId":"string"},"$id":"LineItemsCallOffRent"},"GetAll-12":{"type":"array","items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["SalesPerson"],"nullable":false,"description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","nullable":false,"description":"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":{"type":"string","nullable":true,"description":"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
"},"Email":{"type":"object","description":"An email associated with this record. Expand to see nested fields.","properties":{"Type":{"type":"string","enum":["Primary","Default"],"nullable":false,"description":"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":{"type":"string","nullable":false,"description":"Email associated with this record.
Software
Supported
Filterable
UI
DB
Elite
Yes
Yes
Email
Salesman.Email
Essentials
Yes
Yes
Email
N/A
"}}},"FirstName":{"type":"string","nullable":true,"description":"First name of the Salesperson.
Software
Supported
Filterable
UI
DB
Elite
No
–
–-
–-
Essentials
Yes
Yes
First Name
N/A
"},"LastName":{"type":"string","nullable":true,"description":"Last name of the Salesperson.
Software
Supported
Filterable
UI
DB
Elite
No
–
–-
–-
Essentials
Yes
Yes
Last Name
N/A
"}}}},"GetAll-13":{"type":"array","items":{"description":"Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["GapiHireRate"]},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
Supported
Database
Syrinx
Yes
EQP_ID
"},"Name":{"type":"string","description":"
Software
Supported
UI
Database
Syrinx
Yes
Hire Rate / Stock No
EQP_NAME
"},"CategoryName":{"description":"The category that the hire rate belongs to.
Software
Supported
UI
Database
Syrinx
Yes
Cat / Part of Stock No
EQP_NAME
","type":"string"},"DayRate":{"description":"The flat rate to charge for a single day.
Software
Supported
UI
Database
Syrinx
Yes
Daily Rate / Per Day
EQP_DFLT_DAY_RATE
","type":"number"},"HourRate":{"description":"The rate to charge per hour.
Software
Supported
UI
Database
Syrinx
Yes
Hourly Rate / Hour
EQP_DFLT_HOUR_RATE
","type":"number"},"WeekRate":{"description":"The rate to charge per week.
Software
Supported
UI
Database
Syrinx
Yes
Weekly Rate
EQP_DFLT_WEEK_RATE
","type":"number"},"WeekRateHalfDay":{"description":"The rate to charge for half a week day.
Software
Supported
UI
Database
Syrinx
Yes
4 Hrs
EQP_WEEK_RATE_HALF_DAY
","type":"number"},"WeekRate1Day":{"description":"The rate to charge for a week day.
Software
Supported
UI
Database
Syrinx
Yes
1 Day
EQP_WEEK_RATE_1_DAY
","type":"number"},"WeekRate2Day":{"description":"The rate to charge for 2 week days.
Software
Supported
UI
Database
Syrinx
Yes
2 Days
EQP_WEEK_RATE_2_DAY
","type":"number"},"WeekRate3Day":{"description":"The rate to charge for 3 week days.
Software
Supported
UI
Database
Syrinx
Yes
3 Days
EQP_WEEK_RATE_3_DAY
","type":"number"},"WeekRate4Day":{"description":"The rate to charge for 4 week days.
Software
Supported
UI
Database
Syrinx
Yes
4 Days
EQP_WEEK_RATE_4_DAY
","type":"number"},"WeekendRate":{"description":"The rate to charge over a weekend.
Software
Supported
UI
Database
Syrinx
Yes
W/E
EQP_DFLT_WEEKEND_RATE
","type":"number"},"MonthRate":{"description":"The rate to charge per month.
Software
Supported
UI
Database
Syrinx
Yes
Month
EQP_DFLT_MONTH_RATE
","type":"number"}}}},"GetById-11":{"description":"Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["GapiHireRate"]},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
Supported
Database
Syrinx
Yes
EQP_ID
"},"Name":{"type":"string","description":"
Software
Supported
UI
Database
Syrinx
Yes
Hire Rate / Stock No
EQP_NAME
"},"CategoryName":{"description":"The category that the hire rate belongs to.
Software
Supported
UI
Database
Syrinx
Yes
Cat / Part of Stock No
EQP_NAME
","type":"string"},"DayRate":{"description":"The flat rate to charge for a single day.
Software
Supported
UI
Database
Syrinx
Yes
Daily Rate / Per Day
EQP_DFLT_DAY_RATE
","type":"number"},"HourRate":{"description":"The rate to charge per hour.
Software
Supported
UI
Database
Syrinx
Yes
Hourly Rate / Hour
EQP_DFLT_HOUR_RATE
","type":"number"},"WeekRate":{"description":"The rate to charge per week.
Software
Supported
UI
Database
Syrinx
Yes
Weekly Rate
EQP_DFLT_WEEK_RATE
","type":"number"},"WeekRateHalfDay":{"description":"The rate to charge for half a week day.
Software
Supported
UI
Database
Syrinx
Yes
4 Hrs
EQP_WEEK_RATE_HALF_DAY
","type":"number"},"WeekRate1Day":{"description":"The rate to charge for a week day.
Software
Supported
UI
Database
Syrinx
Yes
1 Day
EQP_WEEK_RATE_1_DAY
","type":"number"},"WeekRate2Day":{"description":"The rate to charge for 2 week days.
Software
Supported
UI
Database
Syrinx
Yes
2 Days
EQP_WEEK_RATE_2_DAY
","type":"number"},"WeekRate3Day":{"description":"The rate to charge for 3 week days.
Software
Supported
UI
Database
Syrinx
Yes
3 Days
EQP_WEEK_RATE_3_DAY
","type":"number"},"WeekRate4Day":{"description":"The rate to charge for 4 week days.
Software
Supported
UI
Database
Syrinx
Yes
4 Days
EQP_WEEK_RATE_4_DAY
","type":"number"},"WeekendRate":{"description":"The rate to charge over a weekend.
Software
Supported
UI
Database
Syrinx
Yes
W/E
EQP_DFLT_WEEKEND_RATE
","type":"number"},"MonthRate":{"description":"The rate to charge per month.
Software
Supported
UI
Database
Syrinx
Yes
Month
EQP_DFLT_MONTH_RATE
","type":"number"}}},"GetAll-14":{"type":"array","items":{"$id":"global_common_remote_work-order","$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderPublic","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"object","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"string","format":"date-time","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"string","description":"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
","format":"date-time"},"CustomerId":{"nullable":true,"type":"string","description":"References a CustomerId that should be responsible for this Work Order.
"},"Operation":{"type":"string","description":"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
--
--
--
"},"Parts":{"nullable":true,"type":"array","description":"In Elite, an array of Parts. In Essentials, an array of strings. Expand to see nested fields.","items":{"oneOf":[{"$id":"global_common_remote_abstract/work-order-part","$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"Classification":{"nullable":true,"type":"string","description":"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
","enum":[null,"Rental","Sale"]},"Comments":{"type":"string","description":"Any comments for this part.
Software
Supported
Filterable
UI
DB
Elite
Yes
No
'Items' tab → 'Line Item Comments' column
TransactionItems.Comments
"},"IsBulk":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"boolean","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"number","description":"The purchase price of the part.
Software
Supported
Filterable
UI
DB
Elite
Yes
No
'Items' tab → 'Price' column
Transactions.Price
"},"Quantity":{"nullable":true,"type":"string","description":"The quantity of this part on the work order.
Software
Supported
Filterable
UI
DB
Elite
Yes
No
'Items' tab → 'Qty' column
TransactionItems.QTY
"},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.
Software
Supported
Filterable
UI
DB
Elite
Yes
No
N/A
ItemFile.SerialNumber
","readOnly":true},"Status":{"nullable":true,"type":"string","description":"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
","enum":["Reserved","Out","Off Rent","Returned","Sold"]},"StockId":{"nullable":true,"type":"string","description":"Id of stock
Software
Supported
Filterable
UI
DB
Elite
Yes
No
'Items' tab → 'Numb' column
TransactionItems.Item
"}}},{"type":"string","description":"In Essentials, an array of ProductIds representing the Parts and Labor items in use.
Software
Supported
Filterable
UI
DB
Essentials
Yes
No
Parts table on right of screen
N/A
"}]}},"ReportedIssue":{"type":"string","description":"The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)
"},"UpdatedDateTime":{"nullable":true,"type":"string","description":"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
","format":"date-time"}}}},"PostCreate-3":{"$id":"global_common_remote_work-order","title":"WorkOrderPublic","type":"object","properties":{"Type":{"nullable":true,"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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.
"},"CustomerId":{"type":"string","nullable":true,"description":"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":{"type":"string","description":"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.
"},"DueDateTime":{"type":"string","format":"date-time","description":"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.
"},"Hidden":{"type":"integer","nullable":true,"enum":[null,0,1],"description":"0 = false, 1 = true | True means a user-unrecoverable deletion.
Validation
Must be one of the listed values.
"},"IsCustomerWO":{"type":"boolean","description":"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.
"},"OpenDateTime":{"type":"string","format":"date-time","description":"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.
"},"Operation":{"type":"string","description":"The operation that needs to be performed.
Validation
Maximum length is 2^31-1 characters.
"},"OtherComments":{"type":"string","description":"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.
"},"Parts":{"nullable":true,"type":"array","description":"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
","items":{"properties":{"Comments":{"type":"string","description":"Any comments related to the Parts on this work order.
Validation
Maximum length is 2^31-1 characters.
"}}}},"Status":{"type":"string","enum":["Quote","Open","Closed"],"description":"Represents the status of the work order contract.
Validation
Must be one of the listed values.
"},"StockId":{"type":"string","description":"The piece of Stock being worked on.
Validation
Required
Must be a stock ID that already exists.
"}},"default":{"Hidden":0,"IsCustomerWO":false,"Status":"Open"},"required":["CustomerId","DepotId","StockId","OpenDateTime","DueDateTime"]},"GetById-12":{"$id":"global_common_remote_work-order","$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderPublic","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"object","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"string","format":"date-time","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"string","description":"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
","format":"date-time"},"CustomerId":{"nullable":true,"type":"string","description":"References a CustomerId that should be responsible for this Work Order.
"},"Operation":{"type":"string","description":"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
--
--
--
"},"Parts":{"nullable":true,"type":"array","description":"In Elite, an array of Parts. In Essentials, an array of strings. Expand to see nested fields.","items":{"oneOf":[{"$id":"global_common_remote_abstract/work-order-part","$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"Classification":{"nullable":true,"type":"string","description":"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
","enum":[null,"Rental","Sale"]},"Comments":{"type":"string","description":"Any comments for this part.
Software
Supported
Filterable
UI
DB
Elite
Yes
No
'Items' tab → 'Line Item Comments' column
TransactionItems.Comments
"},"IsBulk":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"boolean","description":"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":{"type":"string","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"number","description":"The purchase price of the part.
Software
Supported
Filterable
UI
DB
Elite
Yes
No
'Items' tab → 'Price' column
Transactions.Price
"},"Quantity":{"nullable":true,"type":"string","description":"The quantity of this part on the work order.
Software
Supported
Filterable
UI
DB
Elite
Yes
No
'Items' tab → 'Qty' column
TransactionItems.QTY
"},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.
Software
Supported
Filterable
UI
DB
Elite
Yes
No
N/A
ItemFile.SerialNumber
","readOnly":true},"Status":{"nullable":true,"type":"string","description":"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
","enum":["Reserved","Out","Off Rent","Returned","Sold"]},"StockId":{"nullable":true,"type":"string","description":"Id of stock
Software
Supported
Filterable
UI
DB
Elite
Yes
No
'Items' tab → 'Numb' column
TransactionItems.Item
"}}},{"type":"string","description":"In Essentials, an array of ProductIds representing the Parts and Labor items in use.
Software
Supported
Filterable
UI
DB
Essentials
Yes
No
Parts table on right of screen
N/A
"}]}},"ReportedIssue":{"type":"string","description":"The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)
"},"UpdatedDateTime":{"nullable":true,"type":"string","description":"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
","format":"date-time"}}},"PatchById-4":{"$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderCreate","type":"object","not":{"type":"object","patternProperties":{"":{"type":"null"}}},"properties":{"Cause":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"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":{"type":"string","description":"The operation that needs to be performed.
Validation
Maximum length is 2^31-1 characters.
"},"OtherComments":{"type":"string","description":"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.
"},"Parts":{"nullable":true,"type":"array","description":"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
","items":{"$id":"global_common_remote_abstract/work-order-part","$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"Id":{"type":"string","description":"Id of the record. Needed to be able to update comments.
Validation
Required if updating Parts.Comments
"},"Comments":{"type":"string","description":"Any comments related to the Parts on this work order.
Validation
Maximum length is 2^31-1 characters.
"}}}}}},"GetAll-15":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderPart","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types."},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable.
Software
Supported
UI
DB
Elite
Yes
TransactionItems.ID
"},"Classification":{"nullable":true,"type":"string","description":"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
","enum":["Rental","Sale",null]},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups.
Software
Supported
UI
DB
Elite
Yes
TransactionItems.Description
"},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"number","description":"The purchase price of the part.
Software
Supported
UI
DB
Elite
Yes
Transactions.Price
"},"Quantity":{"nullable":true,"type":"string","description":"The quantity of this part on the work order.
Software
Supported
UI
DB
Elite
Yes
TransactionItems.QTY
"},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.
Software
Supported
UI
DB
Elite
Yes
ItemFile.SerialNumber
"},"Status":{"nullable":true,"type":"string","description":"The displayable status of a lineitem. Sales lineitems might say \"sold\". Rental items might say \"reserved\".
Software
Supported
UI
DB
Elite
Yes
ItemFile.TXTY
","enum":["Reserved","Out","Off Rent","Returned","Sold"]},"StockId":{"nullable":true,"type":"string","description":"Id of stock
Software
Supported
UI
DB
Elite
Yes
TransactionItems.Item
"},"Comments":{"type":"string","description":"Any comments for this part.
Software
Supported
UI
DB
Elite
Yes
TransactionItems.Comments
"},"CreatedDateTime":{"nullable":true,"type":"string","description":"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
","format":"date-time"},"UpdatedDateTime":{"nullable":true,"type":"string","description":"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
--
--
","format":"date-time"},"Hidden":{"type":"integer","description":"0 = false, 1 = true | True means a user-unrecoverable deletion.
Software
Supported
UI
DB
Elite
Yes
Transactions.Archived
","nullable":true,"enum":[null,0,1]}}}},"PostCreate-4":{"$id":"global_common_remote_work-order-part-create","$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderPartCreate","type":"object","properties":{"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups.
Validation
Maximum length is 150 characters.
"},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"boolean","description":"Indicates if the items should be pulled from stock when added to a work order.
Validation
Only inputs accepted: `true`,`false`,`null`
"},"PurchasePrice":{"nullable":true,"type":"number","description":"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
"},"Quantity":{"nullable":true,"type":"string","description":"The quantity of this part on the work order.
Validation
Required
Must be a positive, numeric value.
May include a decimal.
"},"StockId":{"nullable":true,"type":"string","description":"Id of stock
Validation
Required
Must be the stock ID for a piece of stock that already exists.
"},"Comments":{"type":"string","description":"Any comments for this part.
Validation
Maximum length is 255 characters.
"}},"required":["Quantity","StockId"],"default":{"Name":null,"IsBulk":false,"IsSerialized":false,"PullFromStock":false,"PurchasePrice":null,"Quantity":"string","Comments":null}},"EnumLookupOperations":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"EnumLookupOperationsResponse","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["Lookup"]},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable. "},"Name":{"type":"string","description":"A display name for this record. This should be a self-explanatory word or phrase describing the operation occurring for this work order.\n\n For this lookup, Name, Description, and Value will all match.\n\n Some common examples include \"Waiting on diagnosis,\" \"Waiting on parts,\" \"In Repair,\" and \"Repair Complete.\" "},"Description":{"type":"string","description":"For this lookup, Name, Description, and Value will all match.\n\n Some common examples include \"Waiting on diagnosis,\" \"Waiting on parts,\" \"In Repair,\" and \"Repair Complete.\" "},"Value":{"type":"string","description":"For this lookup, Name, Description, and Value will all match.\n\n Some common examples include \"Waiting on diagnosis,\" \"Waiting on parts,\" \"In Repair,\" and \"Repair Complete.\" "}}}},"EnumLookupConsumerOperations":{"type":"array","items":{"$schema":"http://json-schema.org/draft-07/schema#","title":"EnumLookupConsumerOperationsResponse","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","enum":["Lookup"]},"Id":{"type":"string","description":"The unique Id for this record. This is system-generated upon creation and not updatable. "},"Name":{"type":"string","description":"A display name for this record. This should be a self-explanatory word or phrase describing the operation occurring for this work order.\n\n For this lookup, Name, Description, and Value will all match.\n\n Some common examples include \"Waiting on diagnosis,\" \"Waiting on parts,\" \"In Repair,\" and \"Repair Complete.\" "},"Description":{"type":"string","description":"For this lookup, Name, Description, and Value will all match.\n\n Some common examples include \"Waiting on diagnosis,\" \"Waiting on parts,\" \"In Repair,\" and \"Repair Complete.\" "},"Value":{"type":"string","description":"For this lookup, Name, Description, and Value will all match.\n\n Some common examples include \"Waiting on diagnosis,\" \"Waiting on parts,\" \"In Repair,\" and \"Repair Complete.\" "}}}}},"examples":{"GetAll-Elite":{"summary":"Elite Example","value":{"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}},"PostCreate-Elite":{"summary":"Elite Example","value":{"Body":"Interested in renting a trailer.","CreatedBy":"Leeland Frank","Type":"Sales"}},"GetById-Elite":{"summary":"Elite Example","value":{"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}},"GetAll-Elite-2":{"summary":"Elite Example","value":{"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}},"GetAll-Essentials":{"summary":"Essentials Example","value":{"ModelType":"Category","Id":"12","CreatedDateTime":"2023-10-19T11:41:50-05:00","UpdatedDateTime":"2024-04-23T17:04:20-05:00","Hidden":0,"Name":"Power Tools","Tags":[],"DisplayOrder":"3","Description":"Tools powered by a battery or motor.","Division":null,"Images":[{"Uri":"https://cdn-legacy.porcloud.com/17/897ea912-8fac-4767-88a2-73c4757fb759.png","AltText":"Power Tools"}]}},"GetAll-Syrinx":{"summary":"Syrinx Example","value":{"ModelType":"Category","Id":"12","Name":"Power Tools","Identifiers":{},"Description":"Tools powered by a battery or motor.","DisplayOrder":"3","Images":[],"ParentCategoryId":"6","Tags":["Table saw","Belt sander"],"AdditionalFields":{},"CreatedDateTime":null,"UpdatedDateTime":null,"Hidden":0}},"GetById-Elite-2":{"summary":"Elite Example","value":{"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}},"GetById-Essentials":{"summary":"Essentials Example","value":{"ModelType":"Category","Id":"12","CreatedDateTime":"2023-10-19T11:41:50-05:00","UpdatedDateTime":"2024-04-23T17:04:20-05:00","Hidden":0,"Name":"Power Tools","Tags":[],"DisplayOrder":"3","Description":"Tools powered by a battery or motor.","Division":null,"Images":[{"Uri":"https://cdn-legacy.porcloud.com/17/897ea912-8fac-4767-88a2-73c4757fb759.png","AltText":"Power Tools"}]}},"GetById-Syrinx":{"summary":"Syrinx Example","value":{"ModelType":"Category","Id":"12","Name":"Power Tools","Identifiers":{},"Description":"Tools powered by a battery or motor.","DisplayOrder":"3","Images":[],"ParentCategoryId":"6","Tags":["Table saw","Belt sander"],"AdditionalFields":{},"CreatedDateTime":null,"UpdatedDateTime":null,"Hidden":0}},"GetAll-Elite-3":{"summary":"Elite Example","value":{"ModelType":"Contact","Id":"2","Name":"Joe Bloggs","Identifiers":{"ParentId":"54321","DriversLicense":"11223344","EmployeeId":"22"},"Addresses":[],"CompanyName":null,"Emails":[{"Type":"Default","Email":"demo@pointofrental.com"}],"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}},"GetAll-Essentials-2":{"summary":"Essentials Example","value":{"ModelType":"Contact","Id":"2","Name":"Joe Bloggs","Identifiers":{"ParentId":"2","DriversLicense":"Not Available","EmployeeId":"2022"},"Addresses":[{"Type":"Default","Line1":"123 Overthere Lane","Line2":"Suite 613","GeoRegion2":null,"GeoRegion3":null,"City":"Boston","Province":"MA","PostalCode":"02113","Country":"US"}],"CompanyName":"Point of Rental","Phones":[{"Type":"Primary","CountryCode":"1","Number":"5551231234","NumberE164":"+15551231234"}],"Department":null,"FirstName":"Joe","LastName":"Bloggs","Title":"Support Technician","Emails":[{"Type":"Default","Email":"demo@pointofrental.com"}],"CreatedDateTime":"2022-01-01T17:35:10.457z","UpdatedDateTime":"2023-01-01T17:35:10.457z","Hidden":0}},"GetAll-Syrinx-2":{"summary":"Syrinx Example","value":{"ModelType":"CustomerContact","Id":"2","Name":"Joe Bloggs","Identifiers":{"ParentId":"2022"},"CreatedDateTime":null,"UpdatedDateTime":null,"Hidden":false,"AdditionalFields":null,"CompanyName":"Point of Rental","FirstName":"Joe","LastName":"Bloggs","CustomerId":"2022","Addresses":[{"Name":"Head Office","Type":"Default","Line1":"123 Overthere Drive","Line2":"null","Line3":"null","City":"Reading","Country":null,"GeoRegion2":null,"GeoRegion3":null,"Province":null,"PostalCode":"L12 98R","Latitude":"51.4564","Longitude":"0.9651","State":"unmodified"}],"Phones":[{"Type":"Default","CountryCode":null,"Number":"5551231234","NumberE164":null,"Extension":null,"SmsCapable":false}],"Emails":[{"Type":"Billing","Email":"demo@pointofrental.com"}]}},"GetById-Elite-3":{"summary":"Elite Example","value":{"ModelType":"Contact","Id":"2","Name":"Joe Bloggs","Identifiers":{"ParentId":"54321","DriversLicense":"11223344","EmployeeId":"22"},"Addresses":[],"CompanyName":null,"Emails":[{"Type":"Default","Email":"demo@pointofrental.com"}],"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}},"GetById-Essentials-2":{"summary":"Essentials Example","value":{"ModelType":"Contact","Id":"2","Name":"Joe Bloggs","Identifiers":{"ParentId":"2","DriversLicense":"Not Available","EmployeeId":"2022"},"Addresses":[{"Type":"Default","Line1":"123 Overthere Lane","Line2":"Suite 613","GeoRegion2":null,"GeoRegion3":null,"City":"Boston","Province":"MA","PostalCode":"02113","Country":"US"}],"CompanyName":"Point of Rental","Phones":[{"Type":"Primary","CountryCode":"1","Number":"5551231234","NumberE164":"+15551231234"}],"Department":null,"FirstName":"Joe","LastName":"Bloggs","Title":"Support Technician","Emails":[{"Type":"Default","Email":"demo@pointofrental.com"}],"CreatedDateTime":"2022-01-01T17:35:10.457z","UpdatedDateTime":"2023-01-01T17:35:10.457z","Hidden":0}},"GetById-Syrinx-2":{"summary":"Syrinx Example","value":{"ModelType":"CustomerContact","Id":"2","Name":"Joe Bloggs","Identifiers":{"ParentId":"2022"},"CreatedDateTime":null,"UpdatedDateTime":null,"Hidden":false,"AdditionalFields":null,"CompanyName":"Point of Rental","FirstName":"Joe","LastName":"Bloggs","CustomerId":"2022","Addresses":[{"Name":"Head Office","Type":"Default","Line1":"123 Overthere Drive","Line2":"null","Line3":"null","City":"Reading","Country":null,"GeoRegion2":null,"GeoRegion3":null,"Province":null,"PostalCode":"L12 98R","Latitude":"51.4564","Longitude":"0.9651","State":"unmodified"}],"Phones":[{"Type":"Default","CountryCode":null,"Number":"5551231234","NumberE164":null,"Extension":null,"SmsCapable":false}],"Emails":[{"Type":"Billing","Email":"demo@pointofrental.com"}]}},"GetAll-Elite-4":{"summary":"Elite Example","value":{"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":"demo@pointofrental.com"}],"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":"demo@pointofrental.com"}],"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":"demo@point-of-rental.com"}},"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}},"GetAll-Essentials-3":{"summary":"Essentials Example","value":{"ModelType":"Customer","Id":"1995","Name":"Moe Nielson","Identifiers":{"AccountNumber":"1995","DriversLicense":null,"Tax Number":""},"Addresses":[{"Type":"Customer","Line1":"42 Wallaby Way","Line2":"Suite 101","GeoRegion2":null,"GeoRegion3":null,"City":"Nowhere","Province":"TX","PostalCode":"10000","Country":"US"}],"Hidden":0,"RecordType":"Individual","CustomerName":"Moe Nielson","DoNotEmail":false,"BillingName":"Moe Nielson","Classification":"Mechanical Engineer","Contacts":[{"Type":"Default","Contact":[{"ModelType":"CustomerContact","Id":"2","Name":"Joe Bloggs","Identifiers":{"DriversLicense":"Not Available","ParentId":"1995","EmployeeId":"2"},"Addresses":[{"Type":"Default","Line1":"123 Over There Ln","Line2":"#456","GeoRegion2":null,"GeoRegion3":null,"City":"Somewhere","Province":"TX","PostalCode":"10001","Country":"US"}],"Phones":[{"Type":"Default","CountryCode":"1","Number":"5551212121","NumberE164":"+15551212121"},{"Type":"Primary","CountryCode":"1","Number":"5551212121","NumberE164":"+15551212121"}],"Department":null,"ContactPhone":"5551212121","ContactPhoneCountryCode":"1","ContactPhoneE164":"+15551212121","CreatedDateTime":"2024-07-30T23:49:48-05:00","UpdatedDateTime":"2024-07-30T23:49:48-05:00","Hidden":0,"FirstName":"Joe","LastName":"Bloggs","Title":"Support Technician","CompanyName":null,"Emails":[{"Type":"Default","Email":"joe.b@example.com"}]}]}],"SalesPerson":{"ModelType":"SalesPerson","Id":"30","Name":"Wayne Harris","Email":{"Type":"Default","Email":"wayne.h@example.com"},"FirstName":"Wayne","LastName":"Harris"},"AdditionalFields":{"InvoiceSendBy":"Email","StatementSendBy":"Email"},"CurrencyCode":"USD","Emails":[{"Type":"Primary","Email":"moe.n@example.com"}],"Phones":[{"Type":"Primary","CountryCode":"1","Number":"5551212121","NumberE164":"+15551212121","Extension":"","SmsCapable":false}],"Status":"Account","PaymentTerms":null,"HeardAboutUs":"register","Locale":null,"Nontaxable":false,"CreatedDateTime":"2023-10-19T13:08:24-05:00","UpdatedDateTime":"2024-07-31T00:05:25-05:00","FirstName":"Moe","LastName":"Nielson","CompanyName":null,"PrimaryPhoneCountryCode":"1","CreditLimit":5000,"Tags":["Superb"],"LockDownCountryCode":false}},"GetAll-Syrinx-3":{"summary":"Syrinx Example","value":{"ModelType":"Customer","Id":"1995","Name":"Moe Nielson","Identifiers":{"AccountNumber":null,"RegistrationNumber":null,"VatNumber":null},"CreatedDateTime":"2023-10-19T13:08:24-05:00","UpdatedDateTime":"2024-07-31T00:05:25-05:00","Hidden":false,"AdditionalFields":null,"RecordType":"Individual","CompanyName":"Moe Nielson","FirstName":null,"LastName":null,"BillingName":" ","Locale":"en-GB","CurrencyCode":null,"DoNotEmail":false,"TypeCode":"C","CreditLimit":null,"Nontaxable":false,"Status":"Individual","SalesPerson":{"Id":null,"FirstName":null,"LastName":null,"ModelType":"SalesPerson","Name":" ","Email":null},"HeardAboutUs":null,"Classification":null,"PaymentTerms":"Cash Sales Invoices","Addresses":[{"Name":"42 Wallaby Way","Type":"Default","Line1":"42 Wallaby Way","Line2":"BORROWASH","Line3":null,"City":"DERBY","Country":null,"GeoRegion2":null,"GeoRegion3":null,"Province":null,"PostalCode":"DE72 3GT","Latitude":null,"Longitude":null,"State":"unmodified"}],"EmailAddress":"moe.n@example.com","Emails":[{"Type":"Billing","Email":"moe.n@example.com"}],"Phones":[{"Type":"Default","CountryCode":null,"Number":"01355544444","NumberE164":null,"Extension":null,"SmsCapable":false}]}},"GetById-Elite-4":{"summary":"Elite Example","value":{"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":"demo@pointofrental.com"}],"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":"demo@pointofrental.com"}],"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":"demo@point-of-rental.com"}},"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}},"GetById-Essentials-3":{"summary":"Essentials Example","value":{"ModelType":"Customer","Id":"1995","Name":"Moe Nielson","Identifiers":{"AccountNumber":"1995","DriversLicense":null,"Tax Number":""},"Addresses":[{"Type":"Customer","Line1":"42 Wallaby Way","Line2":"Suite 101","GeoRegion2":null,"GeoRegion3":null,"City":"Nowhere","Province":"TX","PostalCode":"10000","Country":"US"}],"Hidden":0,"RecordType":"Individual","CustomerName":"Moe Nielson","DoNotEmail":false,"BillingName":"Moe Nielson","Classification":"Mechanical Engineer","Contacts":[{"Type":"Default","Contact":[{"ModelType":"CustomerContact","Id":"2","Name":"Joe Bloggs","Identifiers":{"DriversLicense":"Not Available","ParentId":"1995","EmployeeId":"2"},"Addresses":[{"Type":"Default","Line1":"123 Over There Ln","Line2":"#456","GeoRegion2":null,"GeoRegion3":null,"City":"Somewhere","Province":"TX","PostalCode":"10001","Country":"US"}],"Phones":[{"Type":"Default","CountryCode":"1","Number":"5551212121","NumberE164":"+15551212121"},{"Type":"Primary","CountryCode":"1","Number":"5551212121","NumberE164":"+15551212121"}],"Department":null,"ContactPhone":"5551212121","ContactPhoneCountryCode":"1","ContactPhoneE164":"+15551212121","CreatedDateTime":"2024-07-30T23:49:48-05:00","UpdatedDateTime":"2024-07-30T23:49:48-05:00","Hidden":0,"FirstName":"Joe","LastName":"Bloggs","Title":"Support Technician","CompanyName":null,"Emails":[{"Type":"Default","Email":"joe.b@example.com"}]}]}],"SalesPerson":{"ModelType":"SalesPerson","Id":"30","Name":"Wayne Harris","Email":{"Type":"Default","Email":"wayne.h@example.com"},"FirstName":"Wayne","LastName":"Harris"},"AdditionalFields":{"InvoiceSendBy":"Email","StatementSendBy":"Email"},"CurrencyCode":"USD","Emails":[{"Type":"Primary","Email":"moe.n@example.com"}],"Phones":[{"Type":"Primary","CountryCode":"1","Number":"5551212121","NumberE164":"+15551212121","Extension":"","SmsCapable":false}],"Status":"Account","PaymentTerms":null,"HeardAboutUs":"register","Locale":null,"Nontaxable":false,"CreatedDateTime":"2023-10-19T13:08:24-05:00","UpdatedDateTime":"2024-07-31T00:05:25-05:00","FirstName":"Moe","LastName":"Nielson","CompanyName":null,"PrimaryPhoneCountryCode":"1","CreditLimit":5000,"Tags":["Superb"],"LockDownCountryCode":false}},"GetById-Syrinx-3":{"summary":"Syrinx Example","value":{"ModelType":"Customer","Id":"1995","Name":"Moe Nielson","Identifiers":{"AccountNumber":null,"RegistrationNumber":null,"VatNumber":null},"CreatedDateTime":"2023-10-19T13:08:24-05:00","UpdatedDateTime":"2024-07-31T00:05:25-05:00","Hidden":false,"AdditionalFields":null,"RecordType":"Individual","CompanyName":"Moe Nielson","FirstName":null,"LastName":null,"BillingName":" ","Locale":"en-GB","CurrencyCode":null,"DoNotEmail":false,"TypeCode":"C","CreditLimit":null,"Nontaxable":false,"Status":"Individual","SalesPerson":{"Id":null,"FirstName":null,"LastName":null,"ModelType":"SalesPerson","Name":" ","Email":null},"HeardAboutUs":null,"Classification":null,"PaymentTerms":"Cash Sales Invoices","Addresses":[{"Name":"42 Wallaby Way","Type":"Default","Line1":"42 Wallaby Way","Line2":"BORROWASH","Line3":null,"City":"DERBY","Country":null,"GeoRegion2":null,"GeoRegion3":null,"Province":null,"PostalCode":"DE72 3GT","Latitude":null,"Longitude":null,"State":"unmodified"}],"EmailAddress":"moe.n@example.com","Emails":[{"Type":"Billing","Email":"moe.n@example.com"}],"Phones":[{"Type":"Default","CountryCode":null,"Number":"01355544444","NumberE164":null,"Extension":null,"SmsCapable":false}]}},"Lookup":{"summary":"Locale Lookup Example","value":[{"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}]},"GetAll-Elite-5":{"summary":"Elite Example","value":{"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}},"GetAll-Essentials-4":{"summary":"Essentials Example","value":{"ModelType":"Depot","Id":"15","Name":"Dallas Rentals","Identifiers":null,"Addresses":[{"Type":"Default","Name":null,"Line1":"123 Anywhere St.","Line2":"Suite 9000","GeoRegion2":null,"GeoRegion3":null,"City":"Dallas","Province":"TX","PostalCode":"75000","Country":"US"}],"Emails":[],"Phones":[{"Type":"Default","Number":"1231231234"}],"AdditionalFields":null,"CreatedDateTime":"2023-11-21T11:42:52-05:00","UpdatedDateTime":"2023-11-21T12:21:33-05:00","Hidden":0}},"GetAll-Syrinx-4":{"summary":"Syrinx Example","value":{"ModelType":"Depot","Id":"1","Name":"Reading Rentals","Identifiers":{},"CreatedDateTime":null,"UpdatedDateTime":null,"Hidden":true,"AdditionalFields":{},"Addresses":[{"Name":"Depot","Type":"Default","Line1":"Napier Court","Line2":null,"Line3":null,"City":"Reading","Country":null,"GeoRegion2":null,"GeoRegion3":null,"Province":null,"PostalCode":"RG1 8BW","Latitude":"51.4592022","Longitude":"-0.9648865","State":"unmodified"}],"Emails":[],"Phones":[{"Type":"Default","CountryCode":null,"Number":"01189569577","NumberE164":null,"Extension":null,"SmsCapable":false}]}},"GetById-Elite-5":{"summary":"Elite Example","value":{"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}},"GetById-Essentials-4":{"summary":"Essentials Example","value":{"ModelType":"Depot","Id":"15","Name":"Dallas Rentals","Identifiers":null,"Addresses":[{"Type":"Default","Name":null,"Line1":"123 Anywhere St.","Line2":"Suite 9000","GeoRegion2":null,"GeoRegion3":null,"City":"Dallas","Province":"TX","PostalCode":"75000","Country":"US"}],"Emails":[],"Phones":[{"Type":"Default","Number":"1231231234"}],"AdditionalFields":null,"CreatedDateTime":"2023-11-21T11:42:52-05:00","UpdatedDateTime":"2023-11-21T12:21:33-05:00","Hidden":0}},"GetById-Syrinx-4":{"summary":"Syrinx Example","value":{"ModelType":"Depot","Id":"1","Name":"Reading Rentals","Identifiers":{},"CreatedDateTime":null,"UpdatedDateTime":null,"Hidden":true,"AdditionalFields":{},"Addresses":[{"Name":"Depot","Type":"Default","Line1":"Napier Court","Line2":null,"Line3":null,"City":"Reading","Country":null,"GeoRegion2":null,"GeoRegion3":null,"Province":null,"PostalCode":"RG1 8BW","Latitude":"51.4592022","Longitude":"-0.9648865","State":"unmodified"}],"Emails":[],"Phones":[{"Type":"Default","CountryCode":null,"Number":"01189569577","NumberE164":null,"Extension":null,"SmsCapable":false}]}},"GetAll-Elite-6":{"summary":"Elite Example","value":{"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}}}},"GetById-Elite-6":{"summary":"Elite Example","value":{"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}}}},"PatchById-Elite":{"summary":"Elite Example","value":{"Id":"42","State":"Pending"}},"GetAll-Elite-7":{"summary":"Elite Example","value":{"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}},"GetById-Elite-7":{"summary":"Elite Example","value":{"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}},"PatchById-Elite-2":{"summary":"Elite Example","value":{"Id":"1","State":"Pending"}},"GetAll-Elite-8":{"summary":"Elite Example","value":{"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"}},"PostCreate-Elite-2":{"summary":"Elite Example","value":{"ContractCodeName":"Payment","ContractId":"001735","CustomerId":"54681","ExternalTransactionId":"99942","GrandTotal":"10","PostedDateTime":"2024-08-21T14:11:18Z","Method":"Cash","Memo":"Test"}},"GetById-Elite-8":{"summary":"Elite Example","value":{"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"}},"GetAll-Elite-9":{"summary":"Elite Example","value":{"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"}},"GetById-Elite-9":{"summary":"Elite Example","value":{"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"}},"GetAll-Elite-10":{"summary":"Elite Example","value":{"ModelType":"SalesPerson","Id":"30","Name":"Wayne Harris","Email":{"Type":"Primary","Email":"demo@point-of-rental.com"}}},"GetAll-Essentials-5":{"summary":"Essentials Example","value":{"ModelType":"SalesPerson","Id":"30","Name":"Wayne Harris","Email":{"Type":"Default","Email":"demo@point-of-rental.com"},"FirstName":"Wayne","LastName":"Harris"}},"GetById-Elite-10":{"summary":"Elite Example","value":{"ModelType":"SalesPerson","Id":"30","Name":"Wayne Harris","Email":{"Type":"Primary","Email":"demo@point-of-rental.com"}}},"GetById-Essentials-5":{"summary":"Essentials Example","value":{"ModelType":"SalesPerson","Id":"30","Name":"Wayne Harris","Email":{"Type":"Default","Email":"demo@point-of-rental.com"},"FirstName":"Wayne","LastName":"Harris"}},"GetAll-Syrinx-5":{"summary":"Syrinx Example","value":{"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}},"GetAll-Elite-11":{"summary":"Elite Example","value":{"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}},"GetAll-Essentials-6":{"summary":"Essentials Example","value":{"ModelType":"WorkOrder","Id":"3734","Name":"1419","StockId":"23611","DepotId":"15","OpenDateTime":"2024-08-14T19:00:48Z","Type":"MAINTENANCE","SubType":"BILLED","LaborTracking":null,"CreatedDateTime":"2024-08-14T19:04:39Z","UpdatedDateTime":"2024-08-14T19:17:20Z","Hidden":0,"StockName":"Wacky Widget #42","CloseDateTime":"2024-08-15T05:00:00Z","Status":"Quote","Parts":["23690","24095"]}},"PostCreate-Elite-3":{"summary":"Elite Example","value":{"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}},"GetById-Elite-11":{"summary":"Elite Example","value":{"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}},"GetById-Essentials-6":{"summary":"Essentials Example","value":{"ModelType":"WorkOrder","Id":"3734","Name":"1419","StockId":"23611","DepotId":"15","OpenDateTime":"2024-08-14T19:00:48Z","Type":"MAINTENANCE","SubType":"BILLED","LaborTracking":null,"CreatedDateTime":"2024-08-14T19:04:39Z","UpdatedDateTime":"2024-08-14T19:17:20Z","Hidden":0,"StockName":"Wacky Widget #42","CloseDateTime":"2024-08-15T05:00:00Z","Status":"Quote","Parts":["23690","24095"]}},"PatchById-Elite-3":{"summary":"Elite Example","value":{"Operation":"Repair complete","Complaint":"Inoperable"}},"GetAll-Elite-12":{"summary":"Elite Example","value":{"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}},"PostCreate-Elite-4":{"summary":"Elite Example","value":{"Name":"V-Belt","ProductId":"9","IsBulk":true,"Quantity":1}},"PostCreateResponse-Elite":{"summary":"Elite Example","value":{"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-Elite":{"summary":"Elite Example","value":[{"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"}]}},"parameters":{"CallLogId":{"name":"CallLogId","description":"Provide the unique ID of the Call Log you want to retrieve.","required":true,"in":"path","schema":{"type":"string"}},"CategoryId":{"name":"CategoryId","in":"path","description":"Provide the unique ID of the Category record you want to retrieve.","required":true,"schema":{"type":"string","example":"12"}},"ContactId":{"name":"ContactId","in":"path","description":"Provide the unique ID of the Contact you want to retrieve.","required":true,"schema":{"type":"string","example":"24"}},"CustomerId":{"name":"CustomerId","in":"path","description":"Provide the unique ID of the Customer you want to retrieve.","required":true,"schema":{"type":"string","example":"42"}},"DepotId":{"name":"DepotId","description":"Provide the unique ID of the Depot you want to retrieve.","required":true,"in":"path","schema":{"type":"string"}},"SalesPersonId":{"name":"SalespersonId","in":"path","description":"Provide the unique ID of the SalesPerson you want to retrieve.","required":true,"schema":{"type":"string","example":"142"}},"HireRateId":{"name":"HireRateId","required":true,"description":"Provide the unique ID of the Hire Rates you want to retrieve.","in":"path","schema":{"type":"string","example":"123"}},"WorkOrderId":{"name":"WorkOrderId","in":"path","description":"Provide the unique ID of the WorkOrder you want to retrieve.","required":true,"schema":{"type":"string","example:":"r962692"}}}},"x-tagGroups":[{"name":"Getting Started","tags":["Gaining Access","Filtering","Your First API Call","Paging","Response Codes"]},{"name":"How-to Guides","tags":["Select the Correct ID Across API Endpoints","Utilize Elite Accounting APIs"]},{"name":"Global","tags":["Categories","Contacts","Contract Actions","Contracts","Customers","Depots","Invoices","Line Items","Line Item Actions","Locations","Products","SalesPersons","Stock","Vendors","Work Orders"]},{"name":"Elite - Accounting","tags":["Accounts Payable","Accounts Receivable","Journal Entries"]},{"name":"Elite - Other","tags":["Call Logs"]},{"name":"Syrinx","tags":["Hire Rates"]},{"name":"Changelog","tags":["Changelog by Release"]}],"definitions":{"CategoryResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"CategoryResponse","type":"object","description":"Categories represent different buckets that products can fall into.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Category"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Category.","readOnly":true},"Description":{"nullable":true,"type":"string","description":"This should describe the category. Likely a single sentence, but could be small paragraph. \n\nElite: This field is not supported.","readOnly":true},"DisplayOrder":{"nullable":true,"type":"number","description":"By default, we might sort by A -> Z, but in some cases, stores may want to manually set an items display order within a category. This is the internal products display order and may not be optimal for customer facing usages. \n\nElite: This field is not supported.","minimum":1,"readOnly":true},"Division":{"nullable":true,"type":"string","description":"The division of a company.","readOnly":true},"Images":{"type":"array","description":"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. \n\nElite: This field is not supported.","items":{"type":"object","description":"Object with image data.","properties":{"Uri":{"type":"string","description":"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](https://en.wikipedia.org/wiki/Data_URI_scheme)"},"AltText":{"nullable":true,"type":"string","description":"Text found in Alt image field"}}},"readOnly":true},"ParentCategoryId":{"nullable":true,"type":"string","description":"Reference a CategoryId. \n\nElite: This field is not supported.","readOnly":true},"Tags":{"type":"array","description":"This is an array of tags or keywords. Generally expected to be like a subcategory. \n\nElite: This field is not supported.","items":{"type":"string"},"readOnly":true},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Category."},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted. \n\nElite: This is always 0.","enum":[null,1],"readOnly":true}},"default":{"ModelType":"string","Id":"string","Name":"string","Identifiers":{},"Description":"string","DisplayOrder":0,"Division":"string","Images":[],"ParentCategoryId":"string","Tags":[],"AdditionalFields":{},"CreatedDateTime":"string","UpdatedDateTime":"string","Hidden":0},"$id":"CategoryResponse"},"ContactRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ContactRequest","type":"object","description":"Contacts represent people who can act on behalf of the Customer.","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","readOnly":true,"enum":["Contact","CustomerContact","VendorContact","ContractContact"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact.","minLength":1,"maxLength":50},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id."},"ParentId":{"nullable":true,"type":"string","description":"Required by Elite."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact. \n\nElite: This field is not supported.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company. \n\nElite: This field is not supported.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company.","maxLength":50},"Disabled":{"nullable":true,"type":"boolean","description":"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.\n\nElite: Supported\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact. \n\nElite: This array will only have a single element.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","maxLength":50}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: Read-Only"},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: Read-Only"},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. \n\nElite: Only supports one of each value, \"Default\" and \"Mobile\". \n\nEssentials: Only supports \"Default\" and \"Secondary\".","default":"Default","enum":["Default","Mobile","Secondary"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded.","maxLength":50},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title.","maxLength":255},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.\n\nElite: Supported. \nSyrinx: Not supported.","format":"date-time"}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted","enum":[null,1],"readOnly":true}},"default":{"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},"$id":"ContactRequest"},"ContactResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ContactResponse","type":"object","description":"Contacts represent people who can act on behalf of the Customer.","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","readOnly":true,"enum":["Contact","CustomerContact","VendorContact","ContractContact"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id."},"ParentId":{"nullable":true,"type":"string","description":"In Elite, ParentId is the same as CustomerId."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact. \n\nElite: This field is not supported.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company. \n\nElite: This field is not supported.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company."},"Disabled":{"nullable":true,"type":"boolean","description":"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.\n\nElite: Supported\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact. \n\nElite: This array will only have a single element.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: Read-Only"},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: Read-Only"},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. \n\nElite: Only supports one of each value, \"Default\" and \"Mobile\". \n\nEssentials: Only supports \"Default\" and \"Secondary\".","default":"Default","enum":["Default","Mobile","Secondary"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.\n\nElite: Supported. \nSyrinx: Not supported.","format":"date-time"}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted","enum":[null,1],"readOnly":true}},"default":{"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},"$id":"ContactResponse"},"ContractsCallOffRent":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ContractsCallOffRent","type":"object","properties":{"ContractId":{"type":"string","description":"The unique id for the contract"},"CalledOffDateTime":{"type":"string","format":"date-time","description":"What date and time to call off the line item. UTC time zone. e.g. 2023-01-01T06:00:00Z"},"PersonCallingOff":{"type":"string","description":"Name of the person who is calling the contract off rent."},"Memo":{"type":"string","description":"Additional textual information for calling a contract off rent."},"RemoteUserId":{"type":"string","description":"An identifier on the remote server for the user's account. Can be User ID, Username, anything to match the Relationship to a user."}},"required":["ContractId","CalledOffDateTime"],"default":{"ContractId":"string","CalledOffDateTime":"string","PersonCallingOff":"string","Memo":"string","RemoteUserId":"string"},"$id":"ContractsCallOffRent"},"ContractResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ContractResponse","type":"object","description":"Contracts come in different varieties depending on which of our platforms you are using.","properties":{"ModelType":{"type":"string","description":"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.","readOnly":true,"enum":["Contract"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contract.","properties":{"InvoiceNumber":{"nullable":true,"type":"string","description":"The Sequential Invoice Number associated with the Contract.\n\nOn Elite systems enabled for sequential Invoicing, this value (read only) represents the ID of the Invoice.","readOnly":true},"Barcode":{"nullable":true,"type":"string","description":"The barcode identifier assigned to this particular Line Item. \n\nElite: This field is not supported.","readOnly":true},"Alias":{"nullable":true,"type":"string","description":"The alias identifier assigned to this particular Line Item. \n\nElite: This field is not supported.","readOnly":true}},"readOnly":true},"Addresses":{"type":"array","description":"Site addresses. Address type should be default.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"AmountDue":{"type":"number","description":"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.","readOnly":true},"AmountPaid":{"type":"number","readOnly":true,"description":"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"},"Contacts":{"type":"array","description":"Contact records and their corresponding types.","items":{"type":"object","properties":{"Type":{"type":"string","description":"This property describes the role or relationship a contact has with this contract. \n- Default: Contacts related to the customer on the contract that aren’t related to the contacts below. \n- 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 \n- Pickup: Pickup contact information \n- Delivery: Delivery contact information \n- Order: Not implemented \n- Billing: Not implemented","enum":["Default","Customer","Delivery","Pickup","Order","Billing",null],"readOnly":true},"Contact":{"type":"object","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","enum":["Contact","CustomerContact","VendorContact","ContractContact"],"readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number. \n\nElite: This field is not supported."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id. \n\nElite: This field is not supported."},"ParentId":{"nullable":true,"type":"string","description":"In Elite, ParentId is the same as CustomerId."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company. \n\nElite: This field is not supported.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company. \n\nElite: This field is not supported."},"Disabled":{"nullable":true,"type":"boolean","description":"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.\n\nElite: Not supported.\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types. \n\nElite: Only supports \"Default\".","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: Read-Only"},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: Read-Only"},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. \n\nElite: Only supports one of each value, \"Default\" and \"Mobile\". \n\nEssentials: Only supports \"Default\" and \"Secondary\".","default":"Default","enum":["Default","Mobile","Secondary"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title. \n\nElite: This field is not supported."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.\n\nElite: Not supported. \nSyrinx: Not supported.","format":"date-time"}}}}}}},"readOnly":true},"ContractInformation":{"nullable":true,"type":"string","description":"Text field for additional details to be added to a Contract that would make it easier to identify based on the context entered.\n\nSupported by: Elite, Essentials","readOnly":true},"CustomerId":{"nullable":true,"type":"string","description":"Reference a CustomerId that should be responsible for this Contract.","readOnly":true},"CustomerName":{"nullable":true,"type":"string","description":"The Customer Name (usually will include first and last name).","readOnly":true},"CustomerPickup":{"nullable":true,"readOnly":true,"type":"object","properties":{"LocationName":{"nullable":true,"type":"string"},"Address":{"nullable":true,"anyOf":[{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location. \n\nElite: This field is not supported.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."}}},{"nullable":true}]},"Instructions":{"nullable":true,"type":"string"},"DateTime":{"nullable":true,"type":"string","description":"Day and time delivery is expected to be completed.","format":"date-time"}}},"DriverDelivery":{"nullable":true,"type":"object","description":"For Internal Use. Location, address, special instructions and data/time of Delivery","properties":{"LocationName":{"nullable":true,"type":"string"},"Address":{"nullable":true,"anyOf":[{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."}}},{"nullable":true}],"type":"object","properties":{"Type":{"default":"DriveryDelivery"}}},"Instructions":{"nullable":true,"type":"string"},"DateTime":{"nullable":true,"type":"string","description":"Day and time delivery is expected to be completed.","format":"date-time"}},"readOnly":true},"DepotId":{"nullable":true,"type":"string","description":"Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)"},"DriverPickup":{"nullable":true,"readOnly":true,"type":"object","properties":{"LocationName":{"nullable":true,"type":"string"},"Address":{"anyOf":[{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location. \n\nElite: Only \"Default\" is supported.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported. and will always return null. There are no plans to support this in Elite."}}},{"nullable":true}],"description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location. \n\nElite: Only \"Default\" is supported."},"Instructions":{"nullable":true,"type":"string"},"DateTime":{"nullable":true,"type":"string","description":"Day and time delivery is expected to be completed.","format":"date-time"}}},"EndDateTime":{"nullable":true,"type":"string","description":"UTC When does the customer intend to return the items?","format":"date-time","readOnly":true},"EsignState":{"type":"string","description":"This represents the status of a document, indicating whether it has been signed or not.","enum":["None","Requested","Signed","Rejected"],"default":"None","readOnly":true},"EsignUrl":{"nullable":true,"type":"string","description":"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.","readOnly":true},"GrandTaxTotal":{"nullable":true,"type":"number","description":"This is the final projected tax for this contract.","readOnly":true},"GrandTotal":{"nullable":true,"type":"number","description":"This is the final projected total price for this contract accounting for qty, discounts, duration, tax, etc..","readOnly":true},"LaborTracking":{"nullable":true,"type":"object","description":"Labor tracking details.","readOnly":true,"properties":{"LaborTypes":{"nullable":true,"type":"array","items":{"type":"object","properties":{"Description":{"nullable":true,"type":"string","readOnly":true},"Value":{"nullable":true,"type":"string","readOnly":true}}},"readOnly":true}}},"LineItems":{"type":"array","description":"The Line Items associated with this contract.","items":{"type":"object","description":"A list of the inventory items associated to a Contract.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["LineItem"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for LineItem.","properties":{"Key":{"nullable":true,"type":"string","description":"(Elite Only) This value is a secondary unique inventory identifier (similar and additional to a serial number) and can be the same as the Primary ID. Must be a unique numeric or alpha-numeric value.","readOnly":true},"Model":{"nullable":true,"type":"string","description":"(Elite Only) The model name associated with a specific instance of an item.","readOnly":true},"ParentId":{"nullable":true,"type":"string","description":"Elite and Essentials Only.","readOnly":true},"PartNumber":{"nullable":true,"type":"string","description":"(Elite Only) The part number associated with a specific instance of an item.","readOnly":true},"ContractNumber":{"nullable":true,"type":"string","description":"(Elite Only) Contract number."}},"readOnly":true},"Classification":{"type":"string","description":"This product is either meant for sale or rental. The internal classification does not apply to lineitems.","enum":["Rental","Sale",null],"readOnly":true},"FuelCapacity":{"nullable":true,"type":"number","description":"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.","readOnly":true},"HasFuel":{"nullable":true,"type":"boolean","description":"If this is related to an item that uses fuel, this field will be set. If not it will be false.","readOnly":true},"IsSerialized":{"nullable":true,"type":"boolean","description":"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.","readOnly":true},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"string","description":"Kept for legacy support, will eventually only need StockId and ProductId.","deprecated":true,"readOnly":true},"LineTaxTotal":{"nullable":true,"type":"number","description":"This is the final projected tax for this line.","readOnly":true},"LineTotal":{"nullable":true,"type":"number","description":"This is the final projected price for this line accounting for qty, discounts, duration, tax, etc..","readOnly":true},"MeterReadings":{"nullable":true,"type":"array","description":"Meter readings of this inventory. Multiple readings allowed for different types.","items":{"type":"object","properties":{"MeterReading":{"type":"number","description":"The last known meter reading of this inventory."},"MeterType":{"type":"string","description":"The type of meter for this reading."}}},"readOnly":true},"Notes":{"nullable":true,"type":"string","description":"Notes attached to a line item. Not an array of notes like its similarly name fields.","readOnly":true},"ProductId":{"nullable":true,"type":"string","description":"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.)","readOnly":true},"Quantity":{"type":"number","description":"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.","readOnly":true},"Rates":{"nullable":true,"type":"array","description":"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.","items":{"type":"string"},"readOnly":true},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.","readOnly":true},"ShowOnContract":{"type":"boolean","default":true,"readonly":true,"description":"Is it a component/unincluded/optional item to display on contract. If false this item should generally not be shown to the consumer."},"Status":{"nullable":true,"type":"string","description":"The displayable status of a lineitem. Sales lineitems might say \"sold\". Rental items might say \"reserved\".\n* Reserved\n* Out\n* Off Rent\n* Returned\n* Sold\n","enum":["Reserved","Out","Off Rent","Returned","Sold"],"readOnly":true},"StockId":{"nullable":true,"type":"string","description":"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.)","readOnly":true},"Workflows":{"type":"array","description":"For Internal Use Only.","items":{"type":"object","properties":{"Creatable":{"nullable":true,"type":"boolean","description":"Can the workflow be created?"},"TemplateId":{"nullable":true,"type":"string"},"PhotoPickerType":{"type":"string","description":"Options are None, Generic, 360","enum":["Default","Image360","None",null]},"RequiredPhotos":{"nullable":true,"type":"number"}}},"readOnly":true},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for this LineItem.","properties":{"FuelStockName":{"nullable":true,"type":"string","description":"(Elite Only) The name of the fuel stock associated with this line item and ios only used for debugging purposes. This field should only show up if the isFuel field is true."},"FuelStockId":{"nullable":true,"type":"string","description":"(Elite Only) The id of the fuel stock associated with this line item and ios only used for debugging purposes. This field should only show up if the isFuel field is true."},"SalesRepId":{"type":"string","description":"The id of the sales rep retrieved from the enumlookup/contract/salesRepId","nullable":true},"SalesRepName":{"type":"string","description":"The name of the sale rep.","nullable":true,"readonly":true},"AssignedToId":{"type":"string","description":"The id of the employee who is assigned to the contract. Use the lookup enumlookup/contract/assignedToId","nullable":true},"AssignedToName":{"type":"string","description":"The name of the assigned to.","nullable":true,"readonly":true}}},"AllRates":{"type":"array","description":"All rates for this product or stock whether relevant or not. In most cases, you will want to use applicable rates.","items":{"type":"object","properties":{"PeriodName":{"type":"string","description":"Example: \"daily rate\", \"1 week rate\""},"Rate":{"nullable":true,"type":"string","description":"Example: \"20.00\""},"CurrencyType":{"type":"string","description":"Example: \"USD\""}}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted","enum":[null,1],"readOnly":true}}},"readOnly":true},"LocationId":{"nullable":true,"type":"string","description":"Id of the Location. (see the Location endpoints)","readOnly":true},"Notes":{"type":"array","description":"Any comments or notes.","items":{"type":"object","required":["Type","Value"],"properties":{"Type":{"type":"string","description":"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.","readOnly":true,"enum":["Default","Delivery","Pickup"],"default":"Default"},"Value":{"nullable":true,"type":"string","description":"The note text."}}},"readOnly":true},"Precheck":{"type":"boolean","description":"Has a contract been prechecked. This is only available if the user passes in this explicitly in the precheck x-columns","readOnly":true},"PONumber":{"nullable":true,"type":"string","description":"A number associated to a Contract. Thi is user definable and associated by a POR user and their customer.","readOnly":true},"StartDateTime":{"nullable":true,"type":"string","description":"UTC When does the customer want the items?","format":"date-time","readOnly":true},"Status":{"type":"string","description":"What is the current status of the contract?\n- Quote:\n- Reservation\n- Open\n- Returned: All inventory has reached its final spot. Accounted for.\n- Off Rent: All inventory assets are awaiting collection prior to finalization of the contract values.\n- Closed: No further activity available for this contract. Fully Paid.\n- Voided\n","enum":["Quote","Reservation","Open","Off Rent","Returned","Closed","Voided",null],"readOnly":true},"Totals":{"type":"array","description":"Lines which should appear in the totals section for the contract","items":{"type":"object","description":"Individual lines within the totals section","required":[],"properties":{"Label":{"type":"string","description":"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":{"type":"number","description":"the amount in the appropriate currency with no currency symbol and us-style decimal, e.g. 1030.59"}}},"readOnly":true,"nullable":true},"Workflows":{"type":"array","description":"For Internal Use.","items":{"type":"object","properties":{"Creatable":{"nullable":true,"type":"boolean","description":"Can the workflow be created?"},"TemplateId":{"nullable":true,"type":"string"},"PhotoPickerType":{"type":"string","description":"Options are None, Generic, 360","enum":["Default","Image360","None",null]},"RequiredPhotos":{"nullable":true,"type":"number"}}},"readOnly":true},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contract.","properties":{"CurrencyCode":{"nullable":true,"type":"string","description":"(Syrinx Only) Country-specific currency code for the contract. For example: USD, AUD, EUR, etc.","readOnly":true},"CustomerJobNumber":{"nullable":true,"type":"string","description":"(Elite Only) Rental customer supplied identifier for this contract.","readOnly":true},"CustomerPurchaseOrder":{"nullable":true,"type":"string","description":"(Elite Only) Rental customer supplied purchase order for this contract.","readOnly":true},"OrderedBy":{"nullable":true,"type":"string","description":"(Elite Only) The name of the person who requested this contract.","readOnly":true},"PrecheckCompletedDateTime":{"nullable":true,"type":"string","description":"Elite Only: When was a contract prechecked. All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"ReceivedBy":{"nullable":true,"type":"string","description":"(Elite Only) The name of the person who received the items for this contract.","readOnly":true}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"UTC When was the contract created? Should be the time the Quote / Contract was created / inserted into the DB.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"UTC When was the contract updated?","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted","enum":[null,1],"readOnly":true},"ContractStatus":{"type":"string","description":"**Deprecated**: Use Status field instead.\n\nWhat is the current status of the contract?\n- Quote:\n- Reservation\n- Open\n- Returned: All inventory has reached its final spot. Accounted for.\n- Closed: No further activity available for this contract. Fully Paid.\n- Voided\n","enum":["Quote","Reservation","Open","Returned","Closed","Voided",null],"readOnly":true,"deprecated":true},"IsDelivery":{"type":"boolean","description":"True when the contract is marked for delivery."},"IsPickup":{"type":"boolean","description":"True when the contract is marked for customer pickup."},"Revision":{"oneOf":[{"type":"number","description":"For elite, only a number. It is a monotomic that can be used to detect changes."},{"type":"string","description":"For elite, only a number. It is a monotomic that can be used to detect changes."}],"readOnly":true,"description":"For elite, only a number. It is a monotomic that can be used to detect changes."}},"default":{"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":[],"Precheck":false,"PONumber":"string","StartDateTime":"string","Status":"string","Totals":[],"Workflows":[],"AdditionalFields":{},"CreatedDateTime":"string","UpdatedDateTime":"string","Hidden":0,"ContractStatus":"string","IsDelivery":false,"IsPickup":false},"$id":"ContractResponse"},"PublicStoredFile":{"$schema":"http://json-schema.org/draft-07/schema#","title":"PublicStoredFile","type":"object","description":"Stored file information for both secure and non-secure files allowing users to download files.","properties":{"FileName":{"type":"string","description":"Original local filename.","readOnly":true},"FileClass":{"type":"string","description":"Defines the type of stored file.","readOnly":true,"enum":["misc","image","video"]},"PublicURL":{"type":"string","description":"Web URL where the stored file can be downloaded.","readOnly":true},"URLDateTime":{"type":"string","format":"date-time","description":"The date/time the URL was retrieved/created.","readOnly":true},"URLExpires":{"type":"integer","description":"Number of seconds from URLDateTime until URL expires.","readOnly":true},"TagMapKey":{"type":"string","description":"Reverse lookup of tag map to keep that user-centric tag value (if not mapped, actual tag).","readOnly":true,"enum":["pdfs","instructions","photos"]},"ObjectPrimaryKey":{"type":"string","description":"Primary key of the object this file is associated with (same as in the URL for single object get).","readOnly":true},"ObjectType":{"type":"string","description":"Type of object: One of Products, stock, or contract.","readOnly":true},"Tags":{"type":"array","description":"List of all the tag names associated with each file (ONLY the TagName).","items":{"type":"string"},"readOnly":true}},"default":{"FileName":"string","FileClass":"string","PublicURL":"string","URLDateTime":"string","URLExpires":0,"TagMapKey":"string","ObjectPrimaryKey":"string","ObjectType":"string","Tags":[]},"$id":"PublicStoredFile"},"global_package_contracts_payment-boundary":{"$id":"global_package_contracts_payment-boundary","$schema":"http://json-schema.org/draft-07/schema#","title":"PaymentBoundary","type":"object","properties":{"PaymentCollectionBoundaries":{"type":"array","items":{"type":"object","properties":{"BoundaryTypeEnum":{"type":"string","enum":["RentalSaleCollectionBoundary","DepositAmountCollectionBoundary"]},"PaymentMethodEnum":{"type":"string","enum":["Credit Card","ACH"]},"MaximumCollectionAmount":{"type":"number"},"MinimumCollectionAmount":{"type":"number"},"CollectAmountFee":{"type":"array","items":{"type":"object","properties":{"FeeCalculationEnum":{"type":"string","enum":["Fixed","Percent"]},"Value":{"type":"number"}}}},"CollectAmountFeeTax":{"type":"array","items":{"type":"object","properties":{"FeeCalculationEnum":{"type":"string","enum":["Fixed","Percent"]},"Value":{"type":"number"}}}}}}}},"default":{"PaymentCollectionBoundaries":[]}},"CustomerRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"CustomerRequest","type":"object","description":"Can be a company or individual.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Customer"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"Can be a company or individual name.","minLength":1,"maxLength":50},"Identifiers":{"nullable":true,"type":"object","description":"These are unique properties that are specific to certain products (Elite, Essentials, Syrinx).\n\nSupported List\n\nAll\n* TaxNumber\n\nElite Only\n* CustomerKey\n* DriversLicense\n* FederalId\n* InsuranceNumber\n* OtherId\n\nSyrinx Only\n* AccountNumber\n* RegistrationNumber\n* VatNumber\n\nNot all properties are valid across all products.\n","properties":{"AccountNumber":{"nullable":true,"type":"string","description":"(Syrinx Only) Unique user defined customer identifier.","readOnly":true},"CustomerKey":{"nullable":true,"type":"string","description":"(Elite Only) Unique user defined customer identifier. \n\nIf no value is provided, this will be set to the same value as Id."},"DriversLicense":{"nullable":true,"type":"string","description":"(Elite Only) Drivers license for individual type customers."},"ExternalCustomerId":{"nullable":true,"type":"string","description":"(Elite Only) The value from a 3rd party system that identifies the Customer record"},"FederalId":{"nullable":true,"type":"string","description":"(Elite Only) FederalId of Customer."},"InsuranceNumber":{"nullable":true,"type":"string","description":"(Elite Only) Insurance Number of Customer."},"OtherId":{"nullable":true,"type":"string","description":"(Elite Only) Addtional Id's of Customer."},"RegistrationNumber":{"nullable":true,"type":"string","description":"(Syrinx Only) Registration Number of Customer.","readOnly":true},"TaxNumber":{"nullable":true,"type":"string","description":"(Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite."},"VatNumber":{"nullable":true,"type":"string","description":"(Syrinx Only) Vat Number of Customer.","readOnly":true}}},"Addresses":{"type":"array","description":"Supported types will depend on the product.\n\nElite:\n * Supported: \"Customer\"\n * Coming Soon: \"Default\", \"Billing\"\n","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default","enum":["Customer","Billing"]},"Name":{"nullable":true,"type":"string","description":"Optional name for Address \n\nElite: Not supported.","readOnly":true},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street.","maxLength":150},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite.","maxLength":150},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148.","minLength":2},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country.","maxLength":50},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}}},"BillingName":{"nullable":true,"type":"string","description":"Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type.","maxLength":50},"Classification":{"nullable":true,"type":"string","description":"What kind of customer is this? Examples: Plumber, Homeowner, Soletrader. This could also be the customers Job Title.\n\nYou 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":{"nullable":true,"type":"string","description":"Name of the Company.","readOnly":true},"Contacts":{"type":"array","description":"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.**\n\nElite: Supported. \nSyrinx: Supported.","items":{"type":"object","required":["Type","Contact"],"properties":{"Type":{"type":"string","enum":["Default"],"default":"Default"},"Contact":{"type":"object","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","enum":["Contact","CustomerContact","VendorContact","ContractContact"],"readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact.","minLength":1,"maxLength":50},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id."},"ParentId":{"nullable":true,"type":"string","description":"Required by Elite."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company.","maxLength":50},"Disabled":{"nullable":true,"type":"boolean","description":"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.\n\nElite: Supported\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","maxLength":50}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: Read-Only"},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: Read-Only"},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. Elite uses \"Mobile\" as a secondary number whereas Essentials uses \"Secondary\".","default":"Default"},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded.","maxLength":50},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title.","maxLength":255},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.\n\nElite: Supported. \nSyrinx: Not supported.","format":"date-time"}}}}}}}},"CreditLimit":{"nullable":true,"type":"integer","description":"The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager","maximum":2147483647},"CurrencyCode":{"nullable":true,"type":"string","description":"Defaults to \"USD\". Code is [ISO 4217 format.](https://en.wikipedia.org/wiki/ISO_4217) \n\nYou 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.","default":"USD"},"DoNotEmail":{"nullable":true,"type":"boolean","description":"Prevents the software from sending 'marketing' emails."},"Emails":{"type":"array","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Primary"]},"Email":{"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","maxLength":50}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name of Customer (individual only).","minLength":1,"maxLength":50},"HeardAboutUs":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"string","description":"Last Name of Customer (individual only).","minLength":1,"maxLength":50},"Locale":{"nullable":true,"type":"string","description":"Defaults to \"en-US\". Code is [ISO 639 format](https://www.w3.org/TR/html401/struct/dirlang.html). \n\nYou 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.","default":"en-US"},"Nontaxable":{"nullable":true,"type":"boolean","description":"Means no tax is calculated for this customer on any contracts"},"PaymentTerms":{"nullable":true,"type":"string","description":"(Currently not supported)","readOnly":true},"Phones":{"type":"array","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. Elite uses \"Mobile\" as a secondary number whereas Essentials uses \"Secondary\".","default":"Default"},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded.","maxLength":50},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"RecordType":{"type":"string","description":"Denotes if this record is a business or an individual.","enum":["Business","Individual"],"default":"Business"},"SalesPerson":{"nullable":true,"type":"object","description":"Data related to the sales person associated with the Customer.","properties":{"Id":{"type":"string","description":"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.","default":"0"},"Name":{"nullable":true,"type":"string","readOnly":true,"description":"A display name for this record. Often used as a summary for lookups."},"Email":{"type":"object","description":"See the Type description for what types are supported on each product.","readOnly":true,"required":["Type","Email"],"properties":{"Type":{"type":"string","readOnly":true,"description":"Supported types."},"Email":{"nullable":true,"type":"string","readOnly":true,"description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}},"FirstName":{"nullable":true,"type":"string","description":"First name of the sales person","readOnly":true},"LastName":{"nullable":true,"type":"string","description":"Last name of the sales person","readOnly":true}}},"Status":{"type":"string","description":"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.","enum":["Lead","Prospect","Cash","Account"],"default":"Lead"},"ExternalReceivableBalance":{"type":"number","description":"(Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Customer.","properties":{"CustomerWebPortal":{"nullable":true,"type":"boolean","description":"(Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature."},"ExternalTaxClass":{"nullable":true,"type":"string","description":"(Elite Only) A user definable field for an External Tax Service."},"ExternalTaxCode":{"nullable":true,"type":"string","description":"(Elite Only) A user definable field for an External Tax Service."},"ForceContractInfo":{"nullable":true,"type":"boolean","description":"(Elite Only) Requires the employee to collect a text value to identify the contract's purpose."},"ForceJobId":{"nullable":true,"type":"boolean","description":"(Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs."},"ForcePickedUp":{"nullable":true,"type":"boolean","description":"(Elite Only) Requires the employee to collect the name of the person picking up the items."},"ForcePurchaseOrder":{"nullable":true,"type":"boolean","description":"(Elite Only) Flag to force purchase orders."},"InvoiceSendBy":{"type":"string","description":"(Elite Only) Determines how a customer will receive contracts.","enum":["Email","Fax","No Statement","Printer",null]},"Restrictions":{"type":"string","description":"What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions","nullable":true},"StatementSendBy":{"type":"string","description":"(Elite Only) Determines how a customer will receive statements.","enum":["Email","Fax","No Statement","Printer",null]},"Terms":{"nullable":true,"type":"string","description":"(Elite Only) Terms for the customer.","maxLength":50},"UserDefined1":{"nullable":true,"description":"Placeholder field.","type":"string","maxLength":50},"UserDefined2":{"nullable":true,"description":"Placeholder field.","type":"string","maxLength":50}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted","enum":[null,1],"readOnly":true}},"default":{"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},"$id":"CustomerRequest"},"CustomerResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"CustomerResponse","type":"object","description":"Can be a company or individual.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Customer"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"Can be a company or individual name."},"Identifiers":{"nullable":true,"type":"object","description":"These are unique properties that are specific to certain products (Elite, Essentials, Syrinx).\n\nSupported List\n\nAll\n* TaxNumber\n\nElite Only\n* CustomerKey\n* DriversLicense\n* FederalId\n* InsuranceNumber\n* OtherId\n\nSyrinx Only\n* AccountNumber\n* RegistrationNumber\n* VatNumber\n\nNot all properties are valid across all products.\n","properties":{"AccountNumber":{"nullable":true,"type":"string","description":"(Syrinx Only) Unique user defined customer identifier.","readOnly":true},"CustomerKey":{"nullable":true,"type":"string","description":"(Elite Only) Unique user defined customer identifier. \n\nIf no value is provided, this will be set to the same value as Id."},"DriversLicense":{"nullable":true,"type":"string","description":"(Elite Only) Drivers license for individual type customers."},"ExternalCustomerId":{"nullable":true,"type":"string","description":"(Elite Only) The value from a 3rd party system that identifies the Customer record"},"FederalId":{"nullable":true,"type":"string","description":"(Elite Only) FederalId of Customer."},"InsuranceNumber":{"nullable":true,"type":"string","description":"(Elite Only) Insurance Number of Customer."},"OtherId":{"nullable":true,"type":"string","description":"(Elite Only) Addtional Id's of Customer."},"RegistrationNumber":{"nullable":true,"type":"string","description":"(Syrinx Only) Registration Number of Customer.","readOnly":true},"TaxNumber":{"nullable":true,"type":"string","description":"(Elite and Syrinx) Tax Number of Customer. Originally taxExempt Number in Elite."},"VatNumber":{"nullable":true,"type":"string","description":"(Syrinx Only) Vat Number of Customer.","readOnly":true}}},"Addresses":{"type":"array","description":"Supported types will depend on the product. \n\nElite: only supports one \"Customer\" and one \"Billing\" address.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Customer\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default","enum":["Customer","Billing"]},"Name":{"nullable":true,"type":"string","description":"Optional name for Address \n\nElite: Not supported.","readOnly":true},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 148."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 148."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}}},"BillingName":{"nullable":true,"type":"string","description":"Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type."},"Classification":{"nullable":true,"type":"string","description":"What kind of customer is this? Examples: Plumber, Homeowner, Soletrader. This could also be the customers Job Title.\n\nYou 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":{"nullable":true,"type":"string","description":"Name of the Company.","readOnly":true},"Contacts":{"type":"array","description":"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.**\n\nElite: Supported. \nSyrinx: Supported.","items":{"type":"object","required":["Type","Contact"],"properties":{"Type":{"type":"string","enum":["Default"],"default":"Default"},"Contact":{"type":"object","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","enum":["Contact","CustomerContact","VendorContact","ContractContact"],"readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id."},"ParentId":{"nullable":true,"type":"string","description":"In Elite, ParentId is the same as CustomerId."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company."},"Disabled":{"nullable":true,"type":"boolean","description":"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.\n\nElite: Supported\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: Read-Only"},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: Read-Only"},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types.","default":"Default"},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.\n\nElite: Supported. \nSyrinx: Not supported.","format":"date-time"}}}}}}}},"CreditLimit":{"nullable":true,"type":"integer","description":"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":{"nullable":true,"type":"string","description":"Defaults to \"USD\". Code is [ISO 4217 format.](https://en.wikipedia.org/wiki/ISO_4217) \n\nYou 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.","default":"USD"},"DoNotEmail":{"nullable":true,"type":"boolean","description":"Prevents the software from sending 'marketing' emails."},"Emails":{"type":"array","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Primary"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","maxLength":50}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name of Customer (individual only)."},"HeardAboutUs":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"string","description":"Last Name of Customer (individual only)."},"Locale":{"nullable":true,"type":"string","description":"Defaults to \"en-US\". Code is [ISO 639 format](https://www.w3.org/TR/html401/struct/dirlang.html). \n\nYou 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.","default":"en-US"},"Nontaxable":{"nullable":true,"type":"boolean","description":"Means no tax is calculated for this customer on any contracts"},"PaymentTerms":{"nullable":true,"type":"string","description":"(Currently not supported)","readOnly":true},"Phones":{"type":"array","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types.","default":"Default"},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded.","maxLength":50},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"RecordType":{"type":"string","description":"Denotes if this record is a business or an individual.","enum":["Business","Individual"],"default":"Business"},"SalesPerson":{"nullable":true,"type":"object","description":"Data related to the sales person associated with the Customer.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["SalesPerson"]},"Id":{"type":"string","description":"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.","readOnly":true,"default":"0"},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Email":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types."},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}},"FirstName":{"nullable":true,"type":"string","description":"First name of the sales person. \n\nElite: This field is not supported.","readOnly":true},"LastName":{"nullable":true,"type":"string","description":"Last name of the sales person. \n\nElite: This field is not supported.","readOnly":true}}},"Status":{"type":"string","description":"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.","enum":["Lead","Prospect","Cash","Account"],"default":"Lead"},"ExternalReceivableBalance":{"type":"number","description":"(Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Customer.","properties":{"CustomerWebPortal":{"nullable":true,"type":"boolean","description":"(Elite Only) Set to indicate integration access to that specific Customer record. Used with a RentalHosting.com integration and a Customer Portal feature."},"ExternalTaxClass":{"nullable":true,"type":"string","description":"(Elite Only) A user definable field for an External Tax Service."},"ExternalTaxCode":{"nullable":true,"type":"string","description":"(Elite Only) A user definable field for an External Tax Service."},"ForceContractInfo":{"nullable":true,"type":"boolean","description":"(Elite Only) Requires the employee to collect a text value to identify the contract's purpose."},"ForceJobId":{"nullable":true,"type":"boolean","description":"(Elite Only) Requires the employee to collect a text value to identify the Customer's Jobs."},"ForcePickedUp":{"nullable":true,"type":"boolean","description":"(Elite Only) Requires the employee to collect the name of the person picking up the items."},"ForcePurchaseOrder":{"nullable":true,"type":"boolean","description":"(Elite Only) Flag to force purchase orders."},"InvoiceSendBy":{"nullable":true,"type":"string","description":"(Elite Only) Determines how a customer will receive contracts.","enum":["Email","Fax","No Statement","Printer","None"]},"Restrictions":{"type":"string","description":"What customers are unable to do in the systems. Use the enum lookup enumlookup/customer/restrictions","nullable":true},"StatementSendBy":{"nullable":true,"type":"string","description":"(Elite Only) Determines how a customer will receive statements.","enum":["Email","Fax","No Statement","Printer","None"]},"Terms":{"nullable":true,"type":"string","description":"(Elite Only) Terms for the customer.","maxLength":50},"UserDefined1":{"nullable":true,"description":"Placeholder field.","type":"string","maxLength":50},"UserDefined2":{"nullable":true,"description":"Placeholder field.","type":"string","maxLength":50}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted","enum":[null,1],"readOnly":true}},"default":{"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},"$id":"CustomerResponse"},"LookupResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"LookupResponse","type":"object","description":"Response schema for lookup endpoints.","properties":{"ModelType":{"type":"string","description":"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.","readOnly":true,"enum":["Lookup"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Description":{"nullable":true,"type":"string","readOnly":true},"Field":{"type":"string","readOnly":true},"Value":{"type":"string","readOnly":true}},"default":{"ModelType":"string","Id":"string","Name":"string","Description":"string","Field":"string","Value":"string"},"$id":"LookupResponse"},"global_package_remote_depot":{"$id":"global_package_remote_depot","$schema":"http://json-schema.org/draft-07/schema#","title":"Depot","type":"object","description":"Depots are the physical location of the rental/hire storefront or inventory. These are called stores in Elite and companies in Essentials.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type.","readOnly":true},"Id":{"type":"string","description":"The unique identifier for this record.","readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups.","readOnly":true},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Depot.","readOnly":true},"Addresses":{"$id":"global_package_misc_abstract/addresses","$schema":"http://json-schema.org/draft-07/schema#","type":"array","items":{"$id":"global_package_misc_address","$schema":"http://json-schema.org/draft-07/schema#","title":"Address","type":"object","properties":{"City":{"nullable":true,"type":"string","description":"City of the address","maxLength":128},"Country":{"nullable":true,"type":"string","description":"Country of the address","maxLength":128},"GeoRegion2":{"nullable":true,"type":"string","description":"Geographical region 2 of the address","maxLength":64},"GeoRegion3":{"nullable":true,"type":"string","description":"Geographical region 3 of the address","maxLength":64},"Latitude":{"nullable":true,"type":"string","description":"Latitude of the address","maxLength":64},"Line1":{"nullable":true,"type":"string","description":"Line 1 of the address","maxLength":256},"Line2":{"nullable":true,"type":"string","description":"Line 2 of the address","maxLength":256},"Line3":{"nullable":true,"type":"string","description":"Line 3 of the address","maxLength":256},"Longitude":{"nullable":true,"type":"string","description":"Longitude of the address","maxLength":64},"Name":{"nullable":true,"type":"string","description":"An optional name for the address","maxLength":128},"PostalCode":{"nullable":true,"type":"string","description":"Postal code of the address","maxLength":32},"Province":{"nullable":true,"type":"string","description":"Province of the address","maxLength":128},"Type":{"nullable":true,"type":"string","description":"The type of this address (e.g. business)","maxLength":32}}}},"DefaultDepot":{"nullable":true,"type":"boolean","description":"This is this user's current default store/depot. One and only one store/depot may have this column set to 1(true) in any specific call to the depot endpoint for any user."},"Emails":{"$id":"global_package_misc_abstract/emails","$schema":"http://json-schema.org/draft-07/schema#","type":"array","items":{"$id":"global_package_misc_email","$schema":"http://json-schema.org/draft-07/schema#","title":"Email","type":"object","properties":{"Email":{"type":"string","description":"The email address."},"Type":{"type":"string","description":"The type of this email."}}}},"Phones":{"$id":"global_package_misc_abstract/phones","$schema":"http://json-schema.org/draft-07/schema#","type":"array","items":{"$id":"global_package_misc_phone","$schema":"http://json-schema.org/draft-07/schema#","title":"Phone","type":"object","properties":{"CountryCode":{"nullable":true,"type":"string","description":"The phone number's ountry code prefix. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","maxLength":16},"Extension":{"nullable":true,"type":"string","description":"An extension associated with the phone number. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","maxLength":32},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code.","maxLength":32},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","maxLength":32},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"Type":{"nullable":true,"type":"string","description":"The type of this phone (e.g. mobile)","maxLength":32}}}},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for this record."},"CreatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was created.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was updated.","format":"date-time","readOnly":true},"Hidden":{"nullable":true,"type":"integer","enum":[null,1],"description":"Hidden"},"ItemId":{"nullable":true,"type":"string","description":"Kept for legacy support, will eventually only need StockId and ProductId.","deprecated":true,"readOnly":true}},"default":{"ModelType":"string","Id":"string","Name":"string","Identifiers":{},"Addresses":[],"DefaultDepot":false,"Emails":[],"Phones":[],"AdditionalFields":{},"CreatedDateTime":"string","UpdatedDateTime":"string","Hidden":0,"ItemId":"string"}},"AccountPayableInvoiceResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"AccountPayableInvoiceResponse","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountPayableInvoice"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"PurchaseOrderDateTime":{"type":"string","format":"date-time","description":"The purchase order date on the PO that resulted in the payable.","readOnly":true},"CurrencyCode":{"nullable":true,"type":"string","description":"Currency code value set in the accounting system.","readOnly":true},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the payable invoice `State` is set to 'Error'."},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever payable invoice `State` is set to 'Error'."},"ExchangeRate":{"nullable":true,"type":"number","description":"Exchange rate on the payable invoice.","readOnly":true},"FreightTotal":{"type":"number","description":"Total price of the freight.","readOnly":true},"GrandTaxTotal":{"type":"number","description":"Total amount of sales tax.","readOnly":true},"GrandTotal":{"type":"number","description":"Total amount that is payable.","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to this payable invoice.","properties":{"BatchId":{"type":"string","description":"Elite accounting batch Id associated with the payable.","readOnly":true},"ContractStoreId":{"type":"string","description":"Store Id associated with the payable invoice.","readOnly":true},"ExternalLocationId":{"type":"string","description":"External store/location Id in the accounting system.","readOnly":true},"ExternalPayableId":{"type":"string","description":"External payable Id in the accounting system."},"ExternalVendorId":{"type":"string","description":"External vendor Id in the accounting system.","readOnly":true},"FreightAccountId":{"type":"string","description":"General ledger freight account Id (Freight on purchases).","readOnly":true},"MiscellaneousAccountId":{"type":"string","description":"General ledger miscellaneous account Id (Miscellaneous cost on purchases).","readOnly":true},"PayableAccountId":{"type":"string","description":"General ledger payable account Id.","readOnly":true},"TaxAccountId":{"type":"string","description":"General ledger tax account Id (Tax on purchases).","readOnly":true}}},"LineItems":{"type":"array","description":"A collection of line items related to the contract Id.","readOnly":true,"items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["AccountPayableInvoiceLineItem"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"ExtendedUnitTotal":{"type":"number","description":"Total price of the quantity on the invoice multiplied by unit total.","readOnly":true},"FreightTotal":{"type":"number","description":"Total price of the freight.","readOnly":true},"GrandTaxTotal":{"type":"number","description":"Total price of the tax.","readOnly":true},"GrandTotal":{"type":"number","description":"Total price that is payable.","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to this payable invoice line item.","readOnly":true,"properties":{"AccountNumberId":{"type":"string","description":"General ledger account number Id (Asset, inventory, expense).","readOnly":true},"ExternalPayableId":{"type":"string","description":"External payable Id in the accounting system.","readOnly":true},"InvoiceId":{"type":"string","description":"Accounts payable invoice Id associated to the line item.","readOnly":true}}},"Item":{"type":"object","description":"Elite item associated to this payable invoice line item.","readOnly":true,"properties":{"ModelType":{"type":"string","readOnly":true,"enum":["Item"]},"Id":{"type":"string","description":"Unique identifier for the item model type.","readOnly":true},"Description":{"type":"string","format":"date-time","description":"Description of the item.","readOnly":true},"Key":{"type":"string","description":"Key of the item.","readOnly":true}}},"LineNumber":{"type":"integer","description":"The line number in which this item was added onto the purchase order.","readOnly":true},"MiscellaneousTotal":{"type":"string","description":"Total price of miscellaneous costs.","readOnly":true},"PurchaseOrderNumber":{"type":"string","description":"Purchase order number associated to the line item.","readOnly":true},"PurchaseOrderPartNumber":{"type":"string","description":"Purchase order part number associated to the line item.","readOnly":true},"PurchaseOrderSequenceNumber":{"type":"string","description":"Purchase order sequence number associated to the line item.","readOnly":true},"QuantityOrdered":{"type":"number","description":"Quantity ordered on the purchase order.","readOnly":true},"QuantityReceived":{"type":"number","description":"Quantity received on the purchase order.","readOnly":true},"ReceivedDateTime":{"type":"string","format":"date-time","description":"Date and time when the line item was received.","readOnly":true},"UnitTotal":{"type":"number","description":"Total price of each individual unit.","readOnly":true}}}},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the payable invoice.","readOnly":true},"MiscellaneousTotal":{"type":"number","description":"Total price of miscellaneous costs.","readOnly":true},"PurchaseOrderNumber":{"type":"string","description":"Purchase order number associated to the payable invoice.","readOnly":true},"PurchaseOrderSequenceNumber":{"type":"string","description":"Purchase order sequence number associated to the payable invoice.","readOnly":true},"PurchaseTotal":{"type":"number","description":"Total price of the purchases.","readOnly":true},"ShippingMethod":{"type":"string","description":"Shipping method on the payable invoice.","readOnly":true},"State":{"type":"string","description":"Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state.","enum":["Pending","Posted","Error"]},"TermsCode":{"type":"string","description":"Payment terms code in the accounting system.","readOnly":true},"Vendor":{"type":"object","description":"Elite vendor associated to this payable invoice.","readOnly":true,"properties":{"ModelType":{"type":"string","readOnly":true,"enum":["Vendor"]},"Id":{"type":"string","description":"Unique identifier for the vendor model type.","readOnly":true},"Name":{"type":"string","description":"Name of the vendor.","readOnly":true},"InvoiceNumber":{"type":"string","description":"Vendor's invoice number associated with the payable.","readOnly":true},"InvoiceDateTime":{"type":"string","format":"date-time","description":"Date of vendor's invoice.","readOnly":true},"InvoiceDueDateTime":{"type":"string","format":"date-time","description":"Due date of vendor's invoice.","readOnly":true}}}},"default":{"ModelType":"string","Id":"string","PurchaseOrderDateTime":"string","CurrencyCode":"string","ErrorCode":"string","ErrorDescription":"string","ExchangeRate":0,"FreightTotal":0,"GrandTaxTotal":0,"GrandTotal":0,"Identifiers":{},"LineItems":[],"Memo":"string","MiscellaneousTotal":0,"PurchaseOrderNumber":"string","PurchaseOrderSequenceNumber":"string","PurchaseTotal":0,"ShippingMethod":"string","State":"string","TermsCode":"string","Vendor":{}},"$id":"AccountPayableInvoiceResponse"},"AccountPayableInvoiceRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"AccountPayableInvoiceRequest","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountPayableInvoice"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"PurchaseOrderDateTime":{"type":"string","format":"date-time","description":"The purchase order date on the PO that resulted in the payable.","readOnly":true},"CurrencyCode":{"nullable":true,"type":"string","description":"Currency code value set in the accounting system.","readOnly":true},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the payable invoice `State` is set to 'Error'."},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever payable invoice `State` is set to 'Error'."},"ExchangeRate":{"nullable":true,"type":"number","description":"Exchange rate on the payable invoice.","readOnly":true},"FreightTotal":{"type":"number","description":"Total price of the freight.","readOnly":true},"GrandTaxTotal":{"type":"number","description":"Total amount of sales tax.","readOnly":true},"GrandTotal":{"type":"number","description":"Total amount that is payable.","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to this payable invoice.","properties":{"BatchId":{"type":"string","description":"Elite accounting batch Id associated with the payable.","readOnly":true},"ContractStoreId":{"type":"string","description":"Store Id associated with the payable invoice.","readOnly":true},"ExternalLocationId":{"type":"string","description":"External store/location Id in the accounting system.","readOnly":true},"ExternalPayableId":{"type":"string","description":"External payable Id in the accounting system."},"ExternalVendorId":{"type":"string","description":"External vendor Id in the accounting system.","readOnly":true},"FreightAccountId":{"type":"string","description":"General ledger freight account Id (Freight on purchases).","readOnly":true},"MiscellaneousAccountId":{"type":"string","description":"General ledger miscellaneous account Id (Miscellaneous cost on purchases).","readOnly":true},"PayableAccountId":{"type":"string","description":"General ledger payable account Id.","readOnly":true},"TaxAccountId":{"type":"string","description":"General ledger tax account Id (Tax on purchases).","readOnly":true}}},"LineItems":{"type":"array","description":"A collection of line items related to the contract Id.","readOnly":true,"items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["AccountPayableInvoiceLineItem"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"ExtendedUnitTotal":{"type":"number","description":"Total price of the quantity on the invoice multiplied by unit total.","readOnly":true},"FreightTotal":{"type":"number","description":"Total price of the freight.","readOnly":true},"GrandTaxTotal":{"type":"number","description":"Total price of the tax.","readOnly":true},"GrandTotal":{"type":"number","description":"Total price that is payable.","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to this payable invoice line item.","readOnly":true,"properties":{"AccountNumberId":{"type":"string","description":"General ledger account number Id (Asset, inventory, expense).","readOnly":true},"ExternalPayableId":{"type":"string","description":"External payable Id in the accounting system.","readOnly":true},"InvoiceId":{"type":"string","description":"Accounts payable invoice Id associated to the line item.","readOnly":true}}},"Item":{"type":"object","description":"Elite item associated to this payable invoice line item.","readOnly":true,"properties":{"ModelType":{"type":"string","readOnly":true,"enum":["Item"]},"Id":{"type":"string","description":"Unique identifier for the item model type.","readOnly":true},"Description":{"type":"string","format":"date-time","description":"Description of the item.","readOnly":true},"Key":{"type":"string","description":"Key of the item.","readOnly":true}}},"LineNumber":{"type":"integer","description":"The line number in which this item was added onto the purchase order.","readOnly":true},"MiscellaneousTotal":{"type":"string","description":"Total price of miscellaneous costs.","readOnly":true},"PurchaseOrderNumber":{"type":"string","description":"Purchase order number associated to the line item.","readOnly":true},"PurchaseOrderPartNumber":{"type":"string","description":"Purchase order part number associated to the line item.","readOnly":true},"PurchaseOrderSequenceNumber":{"type":"string","description":"Purchase order sequence number associated to the line item.","readOnly":true},"QuantityOrdered":{"type":"number","description":"Quantity ordered on the purchase order.","readOnly":true},"QuantityReceived":{"type":"number","description":"Quantity received on the purchase order.","readOnly":true},"ReceivedDateTime":{"type":"string","format":"date-time","description":"Date and time when the line item was received.","readOnly":true},"UnitTotal":{"type":"number","description":"Total price of each individual unit.","readOnly":true}}}},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the payable invoice.","readOnly":true},"MiscellaneousTotal":{"type":"number","description":"Total price of miscellaneous costs.","readOnly":true},"PurchaseOrderNumber":{"type":"string","description":"Purchase order number associated to the payable invoice.","readOnly":true},"PurchaseOrderSequenceNumber":{"type":"string","description":"Purchase order sequence number associated to the payable invoice.","readOnly":true},"PurchaseTotal":{"type":"number","description":"Total price of the purchases.","readOnly":true},"ShippingMethod":{"type":"string","description":"Shipping method on the payable invoice.","readOnly":true},"State":{"type":"string","description":"Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state.","enum":["Pending","Posted","Error"]},"TermsCode":{"type":"string","description":"Payment terms code in the accounting system.","readOnly":true},"Vendor":{"type":"object","description":"Elite vendor associated to this payable invoice.","readOnly":true,"properties":{"ModelType":{"type":"string","readOnly":true,"enum":["Vendor"]},"Id":{"type":"string","description":"Unique identifier for the vendor model type.","readOnly":true},"Name":{"type":"string","description":"Name of the vendor.","readOnly":true},"InvoiceNumber":{"type":"string","description":"Vendor's invoice number associated with the payable.","readOnly":true},"InvoiceDateTime":{"type":"string","format":"date-time","description":"Date of vendor's invoice.","readOnly":true},"InvoiceDueDateTime":{"type":"string","format":"date-time","description":"Due date of vendor's invoice.","readOnly":true}}}},"default":{"ModelType":"string","Id":"string","PurchaseOrderDateTime":"string","CurrencyCode":"string","ErrorCode":"string","ErrorDescription":"string","ExchangeRate":0,"FreightTotal":0,"GrandTaxTotal":0,"GrandTotal":0,"Identifiers":{},"LineItems":[],"Memo":"string","MiscellaneousTotal":0,"PurchaseOrderNumber":"string","PurchaseOrderSequenceNumber":"string","PurchaseTotal":0,"ShippingMethod":"string","State":"string","TermsCode":"string","Vendor":{}},"$id":"AccountPayableInvoiceRequest"},"AccountReceivableInvoiceResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"AccountReceivableInvoiceResponse","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivableInvoice"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type."},"ContractTotal":{"type":"number","description":"Total price of the contract excluding sales tax total.","readOnly":true},"ContractType":{"type":"string","enum":["Cash","Credit","Invoice"],"description":"Type of contract.","readOnly":true},"CurrencyCode":{"nullable":true,"type":"string","description":"Currency code value set in the accounting system.","readOnly":true},"CustomerPurchaseOrderNumber":{"nullable":true,"type":"string","description":"Customer purchase order number associated to the invoice.","readOnly":true},"DamageWaiverTotal":{"type":"number","description":"Total price of the damage waiver.","readOnly":true},"Delivery":{"type":"object","readOnly":true,"properties":{"Type":{"type":"string","enum":["Default"]},"City":{"type":"string"},"Line1":{"type":"string"},"PostalCode":{"type":"string"},"Province":{"type":"string"}},"description":"Ship to / delivery details associated to the contract on the invoice."},"EndDateTime":{"nullable":true,"type":"string","format":"date-time","description":"Date and time when the contract was closed.","readOnly":true},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the invoice `State` is set to 'Error'."},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever invoice `State` is set to 'Error'."},"ExchangeRate":{"nullable":true,"type":"number","description":"Exchange rate of the contract on the invoice.","readOnly":true},"GrandTaxTotal":{"type":"number","description":"Total amount of sales tax invoiced.","readOnly":true},"GrandTotal":{"type":"number","description":"Total price of the contract including sales tax.","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice.","properties":{"ContractId":{"type":"string","description":"Contract Id associated to the invoice which maps to the `/Invoices` `Id` property.","readOnly":true},"BatchId":{"nullable":true,"type":"string","description":"Elite accounting batch id associated with the invoice.","readOnly":true},"ContractStoreId":{"type":"string","description":"Store Id associated to the contract on the invoice.","readOnly":true},"CustomerId":{"nullable":true,"type":"string","description":"Elite customer id associated with the invoice.","readOnly":true},"ExternalLocationId":{"nullable":true,"type":"string","description":"External location Id associated to the invoice.","readOnly":true},"ExternalInvoiceId":{"nullable":true,"type":"string","description":"External invoice Id associated to the invoice.\n\n_*Only required if `State` is being set to 'Posted'_\n"},"ExternalCustomerId":{"nullable":true,"type":"string","description":"The value from a 3rd party system that identifies the Customer record for integrations.","readOnly":true},"ParentContractId":{"nullable":true,"type":"string","description":"Parent contract id associated with the invoice.","readOnly":true}}},"InvoiceNumber":{"nullable":true,"type":"string","description":"The Sequential Invoice Number associated with the Contract.\n\nOn Elite systems enabled for sequential Invoicing, this value (read only) represents the ID of the Invoice.","readOnly":true},"ItemPercentageTotal":{"nullable":true,"type":"number","description":"Total value of item percentage on the contract.","readOnly":true},"LineItems":{"type":"array","description":"A collection of line items related to the contract Id.","readOnly":true,"items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivableInvoiceLineItem"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"AccountingClass":{"nullable":true,"type":"string","description":"Class / Category in the accounting system.","readOnly":true},"DamageWaiverPercent":{"nullable":true,"type":"number","description":"Percentage used in the damage waiver calculation on the line item.","readOnly":true},"DiscountPercent":{"nullable":true,"type":"number","description":"Percentage discount applied to the line item.","readOnly":true},"DiscountTotal":{"nullable":true,"type":"number","description":"Discount amount applied to the line item.","readOnly":true},"DueDateTime":{"type":"string","format":"date-time","description":"The date the item was returned.","readOnly":true},"ExtendedPriceTotal":{"nullable":true,"type":"number","description":"Extended line item price.","readOnly":true},"GrandTaxTotal":{"type":"number","description":"Total sales tax amount for the line item.","readOnly":true},"GrandTotal":{"type":"number","description":"Total price charged on the line item, before adjustments from `DiscountTotal`.","readOnly":true},"HoursCharged":{"nullable":true,"type":"number","description":"Total value of the hours charged.","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice line item.","readOnly":true,"properties":{"InvoiceId":{"type":"string","description":"Account receivable invoice Id associated to the line item.","readOnly":true},"ContractId":{"type":"string","description":"Contract Id associated to the line item.","readOnly":true},"GeneralLedgerAccountId":{"nullable":true,"type":"string","description":"General ledger account Id associated to the line item.","readOnly":true},"GeneralLedgerOffsetAccountId":{"nullable":true,"type":"string","description":"General ledger offset account Id associated to the line item.","readOnly":true}}},"Item":{"type":"object","description":"Elite item associated to this invoice line item.","readOnly":true,"properties":{"ModelType":{"type":"string","enum":["Item"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the item model type.","readOnly":true},"Name":{"type":"string","description":"Name of the item.","readOnly":true},"Key":{"type":"string","description":"Unique key identifier associated to the item.","readOnly":true},"CategoryId":{"nullable":true,"type":"integer","description":"Unique category Id associated to the item.","readOnly":true},"CategoryName":{"nullable":true,"type":"string","description":"Category name associated to the `CategoryId`.","readOnly":true},"Description":{"nullable":true,"type":"string","description":"A description associated to the item.","readOnly":true},"IsAsset":{"type":"boolean","description":"Flag denoting if the item is a capitalized asset.","readOnly":true},"Manufacturer":{"nullable":true,"type":"string","description":"Manufacturer associated to the item.","readOnly":true},"Model":{"nullable":true,"type":"string","description":"Model name associated to the item.","readOnly":true},"ModelYear":{"nullable":true,"type":"string","description":"Model year associated to the item.","readOnly":true},"SerialNumber":{"nullable":true,"type":"string","description":"Serial number associated to the item.","readOnly":true},"Type":{"type":"string","description":"Type associated to the item.","enum":["Rental","Retail"],"readOnly":true}}},"ItemPercent":{"nullable":true,"type":"number","description":"Percentage used in the Item Percentage calculation for the item.","readOnly":true},"LineNumber":{"type":"integer","description":"The line number in which this item was added onto the contract.","readOnly":true},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the line item.","readOnly":true},"MeterIn":{"nullable":true,"type":"number","description":"Meter reading on the line item when it was returned.","readOnly":true},"MeterOut":{"nullable":true,"type":"number","description":"Meter reading on the line item when it was sent out.","readOnly":true},"NonTaxable":{"type":"boolean","description":"Flag denoting if the item is non taxable.","readOnly":true},"OutDateTime":{"type":"string","format":"date-time","description":"Date representing when the line item was sent out.","readOnly":true},"Quantity":{"nullable":true,"type":"number","description":"Quantity associated to the line item. Number of units recorded on the contract for this line item.","readOnly":true},"TypeId":{"nullable":true,"type":"integer","description":"Invoice line item type identifier. \n\nTable of available type Ids\n\n|Type Id|Type Name|\n|------|------|\n| 1 |TransItem|\n| 2 |SalesTax|\n| 3 |DamageWaiver|\n| 4 |ItemPercentage|\n| 5 |OtherIncome|\n| 6 |PaidPriorToClose|\n| 7 |Credit|\n| 8 |Disbursement|\n","readOnly":true},"TypeName":{"type":"string","description":"Invoice line item type name","enum":["TransItem","SalesTax","DamageWaiver","ItemPercentage","OtherIncome","PaidPriorToClose","Credit","Disbursement",null],"readOnly":true}}}},"OtherTotal":{"type":"number","description":"Total price of other/miscellaneous items on the contract.","readOnly":true},"OrderedBy":{"nullable":true,"type":"string","description":"Customer representative who originated the contract.","readOnly":true},"PaidTotal":{"type":"number","description":"Total amount paid prior to the contract being closed.","readOnly":true},"PickedUpBy":{"nullable":true,"type":"string","description":"Customer representative who picked up the items.","readOnly":true},"RentTotal":{"type":"number","description":"Total price of rental items on the contract.","readOnly":true},"RevenueDateTime":{"type":"string","format":"date-time","description":"Date and time of the revenue posting.","readOnly":true},"SaleTotal":{"type":"number","description":"Total price of sale items on the contract.","readOnly":true},"StartDateTime":{"type":"string","format":"date-time","description":"Date and time of when the contract opened.","readOnly":true},"State":{"type":"string","description":"Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted' you can not update to another state.","enum":["Pending","Posted","Error"]},"TaxableTotal":{"type":"number","description":"Total taxable price of the contract.","readOnly":true}},"default":{"ModelType":"string","Id":"string","ContractTotal":0,"ContractType":"string","CurrencyCode":"string","CustomerPurchaseOrderNumber":"string","DamageWaiverTotal":0,"Delivery":{},"EndDateTime":"string","ErrorCode":"string","ErrorDescription":"string","ExchangeRate":0,"GrandTaxTotal":0,"GrandTotal":0,"Identifiers":{},"InvoiceNumber":"string","ItemPercentageTotal":0,"LineItems":[],"OtherTotal":0,"OrderedBy":"string","PaidTotal":0,"PickedUpBy":"string","RentTotal":0,"RevenueDateTime":"string","SaleTotal":0,"StartDateTime":"string","State":"string","TaxableTotal":0},"$id":"AccountReceivableInvoiceResponse"},"AccountReceivableInvoiceRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"AccountReceivableInvoiceRequest","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivableInvoice"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type."},"ContractTotal":{"type":"number","description":"Total price of the contract excluding sales tax total.","readOnly":true},"ContractType":{"type":"string","enum":["Cash","Credit","Invoice"],"description":"Type of contract.","readOnly":true},"CurrencyCode":{"nullable":true,"type":"string","description":"Currency code value set in the accounting system.","readOnly":true},"CustomerPurchaseOrderNumber":{"nullable":true,"type":"string","description":"Customer purchase order number associated to the invoice.","readOnly":true},"DamageWaiverTotal":{"type":"number","description":"Total price of the damage waiver.","readOnly":true},"Delivery":{"type":"object","readOnly":true,"properties":{"Type":{"type":"string","enum":["Default"]},"City":{"type":"string"},"Line1":{"type":"string"},"PostalCode":{"type":"string"},"Province":{"type":"string"}},"description":"Ship to / delivery details associated to the contract on the invoice."},"EndDateTime":{"nullable":true,"type":"string","format":"date-time","description":"Date and time when the contract was closed.","readOnly":true},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the invoice `State` is set to 'Error'."},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever invoice `State` is set to 'Error'."},"ExchangeRate":{"nullable":true,"type":"number","description":"Exchange rate of the contract on the invoice.","readOnly":true},"GrandTaxTotal":{"type":"number","description":"Total amount of sales tax invoiced.","readOnly":true},"GrandTotal":{"type":"number","description":"Total price of the contract including sales tax.","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice.","properties":{"ContractId":{"type":"string","description":"Contract Id associated to the invoice which maps to the `/Invoices` `Id` property.","readOnly":true},"BatchId":{"nullable":true,"type":"string","description":"Elite accounting batch id associated with the invoice.","readOnly":true},"ContractStoreId":{"type":"string","description":"Store Id associated to the contract on the invoice.","readOnly":true},"CustomerId":{"nullable":true,"type":"string","description":"Elite customer id assoicated with the invoice.","readOnly":true},"ExternalLocationId":{"nullable":true,"type":"string","description":"External location Id associated to the invoice.","readOnly":true},"ExternalInvoiceId":{"nullable":true,"type":"string","description":"External invoice Id associated to the invoice.\n\n_*Only required if `State` is being set to 'Posted'_\n"},"ExternalCustomerId":{"nullable":true,"type":"string","description":"The value from a 3rd party system that identifies the Customer record for integrations.","readOnly":true}}},"ItemPercentageTotal":{"nullable":true,"type":"number","description":"Total value of item percentage on the contract.","readOnly":true},"LineItems":{"type":"array","description":"A collection of line items related to the contract Id.","readOnly":true,"items":{"type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivableInvoiceLineItem"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"AccountingClass":{"nullable":true,"type":"string","description":"Class / Category in the accounting system.","readOnly":true},"DamageWaiverPercent":{"nullable":true,"type":"number","description":"Percentage used in the damage waiver calculation on the line item.","readOnly":true},"DiscountPercent":{"nullable":true,"type":"number","description":"Percentage discount applied to the line item.","readOnly":true},"DiscountTotal":{"nullable":true,"type":"number","description":"Discount amount applied to the line item.","readOnly":true},"DueDateTime":{"type":"string","format":"date-time","description":"The date the item was returned.","readOnly":true},"ExtendedPriceTotal":{"nullable":true,"type":"number","description":"Extended line item price.","readOnly":true},"GrandTaxTotal":{"type":"number","description":"Total sales tax amount for the line item.","readOnly":true},"GrandTotal":{"type":"number","description":"Total price charged on the line item, before adjustments from `DiscountTotal`.","readOnly":true},"HoursCharged":{"nullable":true,"type":"number","description":"Total value of the hours charged.","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice line item.","readOnly":true,"properties":{"InvoiceId":{"type":"string","description":"Account receivable invoice Id associated to the line item.","readOnly":true},"ContractId":{"type":"string","description":"Contract Id associated to the line item.","readOnly":true},"GeneralLedgerAccountId":{"nullable":true,"type":"string","description":"General ledger account Id associated to the line item.","readOnly":true},"GeneralLedgerOffsetAccountId":{"nullable":true,"type":"string","description":"General ledger offset account Id associated to the line item.","readOnly":true}}},"Item":{"type":"object","description":"Elite item associated to this invoice line item.","readOnly":true,"properties":{"ModelType":{"type":"string","enum":["Item"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the item model type.","readOnly":true},"Name":{"type":"string","description":"Name of the item.","readOnly":true},"Key":{"type":"string","description":"Unique key identifier associated to the item.","readOnly":true},"CategoryId":{"nullable":true,"type":"integer","description":"Unique category Id associated to the item.","readOnly":true},"CategoryName":{"nullable":true,"type":"string","description":"Category name associated to the `CategoryId`.","readOnly":true},"Description":{"nullable":true,"type":"string","description":"A description associated to the item.","readOnly":true},"IsAsset":{"type":"boolean","description":"Flag denoting if the item is a capitalized asset.","readOnly":true},"Manufacturer":{"nullable":true,"type":"string","description":"Manufacturer associated to the item.","readOnly":true},"Model":{"nullable":true,"type":"string","description":"Model name associated to the item.","readOnly":true},"ModelYear":{"nullable":true,"type":"string","description":"Model year associated to the item.","readOnly":true},"SerialNumber":{"nullable":true,"type":"string","description":"Serial number associated to the item.","readOnly":true},"Type":{"type":"string","description":"Type associated to the item.","enum":["Rental","Retail"],"readOnly":true}}},"ItemPercent":{"nullable":true,"type":"number","description":"Percentage used in the Item Percentage calculation for the item.","readOnly":true},"LineNumber":{"type":"integer","description":"The line number in which this item was added onto the contract.","readOnly":true},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the line item.","readOnly":true},"MeterIn":{"nullable":true,"type":"number","description":"Meter reading on the line item when it was returned.","readOnly":true},"MeterOut":{"nullable":true,"type":"number","description":"Meter reading on the line item when it was sent out.","readOnly":true},"NonTaxable":{"type":"boolean","description":"Flag denoting if the item is non taxable.","readOnly":true},"OutDateTime":{"type":"string","format":"date-time","description":"Date representing when the line item was sent out.","readOnly":true},"Quantity":{"nullable":true,"type":"number","description":"Quantity associated to the line item. Number of units recorded on the contract for this line item.","readOnly":true},"TypeId":{"nullable":true,"type":"integer","description":"Invoice line item type identifier. \n\nTable of available type Ids\n\n|Type Id|Type Name|\n|------|------|\n| 1 |TransItem|\n| 2 |SalesTax|\n| 3 |DamageWaiver|\n| 4 |ItemPercentage|\n| 5 |OtherIncome|\n| 6 |PaidPriorToClose|\n| 7 |Credit|\n| 8 |Disbursement|\n","readOnly":true},"TypeName":{"type":"string","description":"Invoice line item type name","enum":["TransItem","SalesTax","DamageWaiver","ItemPercentage","OtherIncome","PaidPriorToClose","Credit","Disbursement",null],"readOnly":true}}}},"OtherTotal":{"type":"number","description":"Total price of other/miscellaneous items on the contract.","readOnly":true},"OrderedBy":{"nullable":true,"type":"string","description":"Customer representative who originated the contract.","readOnly":true},"PaidTotal":{"type":"number","description":"Total amount paid prior to the contract being closed.","readOnly":true},"PickedUpBy":{"nullable":true,"type":"string","description":"Customer representative who picked up the items.","readOnly":true},"RentTotal":{"type":"number","description":"Total price of rental items on the contract.","readOnly":true},"RevenueDateTime":{"type":"string","format":"date-time","description":"Date and time of the revenue posting.","readOnly":true},"SaleTotal":{"type":"number","description":"Total price of sale items on the contract.","readOnly":true},"StartDateTime":{"type":"string","format":"date-time","description":"Date and time of when the contract opened.","readOnly":true},"State":{"type":"string","description":"Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted' you can not update to another state.","enum":["Pending","Posted","Error"]},"TaxableTotal":{"type":"number","description":"Total taxable price of the contract.","readOnly":true}},"default":{"ModelType":"string","Id":"string","ContractTotal":0,"ContractType":"string","CurrencyCode":"string","CustomerPurchaseOrderNumber":"string","DamageWaiverTotal":0,"Delivery":{},"EndDateTime":"string","ErrorCode":"string","ErrorDescription":"string","ExchangeRate":0,"GrandTaxTotal":0,"GrandTotal":0,"Identifiers":{},"ItemPercentageTotal":0,"LineItems":[],"OtherTotal":0,"OrderedBy":"string","PaidTotal":0,"PickedUpBy":"string","RentTotal":0,"RevenueDateTime":"string","SaleTotal":0,"StartDateTime":"string","State":"string","TaxableTotal":0},"$id":"AccountReceivableInvoiceRequest"},"AccountReceivablePaymentResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"AccountReceivablePaymentResponse","type":"object","properties":{"ModelType":{"type":"string","enum":["AccountReceivablePayment"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"ContractCodeName":{"type":"string","description":"Contract code class name, either Credit or Payment.","enum":["Credit","Payment"]},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the payment `State` is set to 'Error'.","readOnly":true},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever payment `State` is set to 'Error'.","readOnly":true},"GrandTotal":{"type":"number","description":"Total amount credited to the customer invoice."},"Identifiers":{"type":"object","properties":{"ContractId":{"type":"string","description":"Contract Id associated to the payment. Contract that has credit or payment applied."},"CreditSourceContractId":{"type":"string","description":"Contract Id sourcing the credit amount. This is the credit contract that sourced the credit being applied.\n\n_*Only Required if `ExternalCreditId` is not set'_\n"},"CustomerId":{"type":"string","description":"Elite Customer Id associated with the payment."},"ExternalContractId":{"type":"string","description":"External contract Id in the accounting system."},"ExternalCreditId":{"type":"string","description":"External credit memo Id in the accounting system. Credit Id must be associated to a contract accounting link.\n\n_*Only required if `CreditSourceContractId` is not set'_\n"},"ExternalCustomerId":{"type":"string","description":"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.\n\n_*Only required if `CustomerId` is not set'_\n"},"ExternalInvoiceId":{"type":"string","description":"External invoice Id in the accounting system. It must be associated with an Elite contract accounting link.\n \n _*Only required if `ContractId` is not set'_\n"}}},"Memo":{"type":"string","description":"Note, reference or description related to the payment."},"Method":{"type":"string","description":"Method of payment.\n\n_*Only Required if `ContractCodeName` is set to 'Payment'_\n","enum":["Card","Cash","Check","Credit","Debit"]},"PostedDateTime":{"type":"string","description":"Date and time when the payment was posted.","format":"date-time"},"State":{"type":"string","description":"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.","enum":["Pending","Posted","Error"],"readOnly":true}},"default":{"ModelType":"string","Id":"string","ContractCodeName":"string","ErrorCode":"string","ErrorDescription":"string","GrandTotal":0,"Identifiers":{},"Memo":"string","Method":"string","PostedDateTime":"string","State":"string"},"$id":"AccountReceivablePaymentResponse"},"AccountReceivablePaymentRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"AccountReceivablePaymentRequest","type":"object","examples":[{"ContractCodeName":"Payment","Identifiers":{"ExternalContractId":"CO-0000001","ContractId":"7755090","CustomerId":"12"},"GrandTotal":100.25,"Memo":"Payment being processed through the front counter terminal.","Method":"Card","PostedDateTime":"2024-12-01T20:00:00.000Z"}],"properties":{"ContractCodeName":{"type":"string","description":"Contract code class name, either Credit or Payment.","enum":["Credit","Payment"]},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the payment `State` is set to 'Error'.","readOnly":true},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever payment `State` is set to 'Error'.","readOnly":true},"GrandTotal":{"type":"number","description":"Total amount credited to the customer invoice."},"Identifiers":{"type":"object","description":"### All Requests\nFor every request, ONE from each of the bullet points below is REQUIRED:\n- `ExternalContractId`\n - `ContractId`, `ExternalInvoiceId`, or `InvoiceNumber`\n- `CustomerId` or `ExternalCustomerId`\n\n### Credit Requests Require an Additional `Identifiers` Field \n\n- When posting a credit with the parameter that `ContractCodeName` = `'Credit'`, ONE of the following is REQUIRED to be set IN ADDITION TO THE ABOVE: `CreditSourceContractId`, `ExternalCreditId`, or `CreditSourceInvoiceNumber`.","properties":{"ExternalContractId":{"type":"string","description":"External contract Id in the accounting system."},"ContractId":{"type":"string","description":"Contract Id associated to the payment. Contract that has credit or payment applied.\n\nOne of the following is REQUIRED to be set: `ContractId`, `ExternalInvoiceId`, or `InvoiceNumber`.\n"},"InvoiceNumber":{"type":"string","description":"The Sequential Invoice Number associated with the Contract.\n\nOne of the following is REQUIRED to be set: `ContractId`, `ExternalInvoiceId`, or `InvoiceNumber`.\n"},"ExternalInvoiceId":{"type":"string","description":"External invoice Id in the accounting system. It must be associated with an Elite contract accounting link.\n\nOne of the following is REQUIRED to be set: `ContractId`, `ExternalInvoiceId`, or `InvoiceNumber`.\n"},"CreditSourceContractId":{"type":"string","description":"Contract Id sourcing the credit amount. This is the credit contract that sourced the credit being applied.\n\nWhen posting a credit with the parameter that `ContractCodeName` = `'Credit'`, one of the following is REQUIRED to be set: `CreditSourceContractId`, `ExternalCreditId`, or `CreditSourceInvoiceNumber`. \n"},"CreditSourceInvoiceNumber":{"type":"string","description":"The Sequential Invoice Number associated with the Credit Source Contract. \n \n When posting a credit with the parameter that `ContractCodeName` = `'Credit'`, one of the following is REQUIRED to be set: `CreditSourceContractId`, `ExternalCreditId`, or `CreditSourceInvoiceNumber`. \n"},"ExternalCreditId":{"type":"string","description":"External credit memo Id in the accounting system. Credit Id must be associated to a contract accounting link.\n \n When posting a credit with the parameter that `ContractCodeName` = `'Credit'`, one of the following is REQUIRED to be set: `CreditSourceContractId`, `ExternalCreditId`, or `CreditSourceInvoiceNumber`. \n"},"CustomerId":{"type":"string","description":"Elite Customer Id associated with the payment.\n\nOne of the following is REQUIRED to be set: `CustomerId` or `ExternalCustomerId`.\n"},"ExternalCustomerId":{"type":"string","description":"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.\n\nOne of the following is REQUIRED to be set: `CustomerId` or `ExternalCustomerId`.\n"}}},"Memo":{"type":"string","description":"Note, reference or description related to the payment."},"Method":{"type":"string","description":"Method of payment.\n\nREQUIRED if `ContractCodeName` = `'Payment'`.\n","enum":["Card","Cash","Check","Credit","Debit"]},"PostedDateTime":{"type":"string","description":"Date and time when the payment was posted.","format":"date-time"},"State":{"type":"string","description":"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.","enum":["Pending","Posted","Error"],"readOnly":true}},"required":["ContractCodeName","Identifiers"],"default":{"ContractCodeName":"string","ErrorCode":"string","ErrorDescription":"string","GrandTotal":0,"Identifiers":{},"Memo":"string","Method":"string","PostedDateTime":"string","State":"string"},"$id":"AccountReceivablePaymentRequest"},"JournalEntryResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"JournalEntryResponse","type":"object","description":"General ledger journal entry.","properties":{"ModelType":{"type":"string","enum":["JournalEntry"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type."},"Dimensions":{"type":"object","description":"Collection of dimensions related to a specific type.","readOnly":true,"properties":{"Class":{"type":"string","description":"Class dimension.","readOnly":true},"Contract":{"type":"string","description":"Contract dimension.","readOnly":true},"Customer":{"type":"string","description":"Customer dimension.","readOnly":true},"Department":{"type":"string","description":"Department dimension.","readOnly":true},"Employee":{"type":"string","description":"Employee dimension.","readOnly":true},"Item":{"type":"string","description":"Item dimension.","readOnly":true},"JobSite":{"type":"string","description":"JobSite dimension.","readOnly":true},"Location":{"type":"string","description":"Location dimension.","readOnly":true},"Project":{"type":"string","description":"Project dimension.","readOnly":true},"SalesPerson":{"type":"string","description":"SalesPerson dimension.","readOnly":true},"Vendor":{"type":"string","description":"Vendor dimension.","readOnly":true}}},"EntryDateTime":{"nullable":true,"type":"string","description":"Date and time when the journal entry was created.","readOnly":true},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the invoice `State` is set to 'Error'."},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever invoice `State` is set to 'Error'."},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice line item.","properties":{"BatchId":{"nullable":true,"type":"string","description":"Elite accounting batch Id associated with the journal entry.","readOnly":true},"ExternalJournalEntryId":{"nullable":true,"type":"string","description":"External journal entry Id in the accounting system."}}},"LineItems":{"type":"array","description":"A collection of line items related to the contract Id.","readOnly":true,"items":{"type":"object","description":"General ledger journal entry line item.","properties":{"ModelType":{"type":"string","enum":["JournalEntryLineItem"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"GrandTotal":{"type":"number","description":"Line item amount.\n\nPositive values are debits.\n\nNegative values are credits.\n","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to the journal entry line item.","readOnly":true,"properties":{"ContractId":{"nullable":true,"type":"string","description":"Contract Id associated to the line item.","readOnly":true},"CustomerId":{"nullable":true,"type":"string","description":"Customer Id associated to the line item.","readOnly":true},"ExternalContractId":{"nullable":true,"type":"string","description":"External contract Id associated to the line item.","readOnly":true},"ExternalCustomerId":{"nullable":true,"type":"string","description":"The value from a 3rd party system that identifies the Customer record for integrations.","readOnly":true},"JournalEntryAccountId":{"nullable":true,"type":"string","description":"General Ledger account Id associated with the line item.","readOnly":true},"JournalEntryId":{"type":"string","description":"Journal Entry Id associated with the line item.","readOnly":true}}},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the line item.","readOnly":true}}}},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the journal entry.","readOnly":true},"State":{"type":"string","description":"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.","enum":["Pending","Posted","Error"]}},"default":{"ModelType":"string","Id":"string","Dimensions":{},"EntryDateTime":"string","ErrorCode":"string","ErrorDescription":"string","Identifiers":{},"LineItems":[],"Memo":"string","State":"string"},"$id":"JournalEntryResponse"},"JournalEntryRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"JournalEntryRequest","type":"object","description":"General ledger journal entry.","properties":{"ModelType":{"type":"string","enum":["JournalEntry"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type."},"Dimensions":{"type":"object","description":"Collection of dimensions related to a specific type.","readOnly":true,"properties":{"Class":{"type":"string","description":"Class dimension.","readOnly":true},"Contract":{"type":"string","description":"Contract dimension.","readOnly":true},"Customer":{"type":"string","description":"Customer dimension.","readOnly":true},"Department":{"type":"string","description":"Department dimension.","readOnly":true},"Employee":{"type":"string","description":"Employee dimension.","readOnly":true},"Item":{"type":"string","description":"Item dimension.","readOnly":true},"JobSite":{"type":"string","description":"JobSite dimension.","readOnly":true},"Location":{"type":"string","description":"Location dimension.","readOnly":true},"Project":{"type":"string","description":"Project dimension.","readOnly":true},"SalesPerson":{"type":"string","description":"SalesPerson dimension.","readOnly":true},"Vendor":{"type":"string","description":"Vendor dimension.","readOnly":true}}},"EntryDateTime":{"nullable":true,"type":"string","description":"Date and time when the journal entry was created.","readOnly":true},"ErrorCode":{"nullable":true,"type":"string","description":"Error code value whenever the invoice `State` is set to 'Error'."},"ErrorDescription":{"nullable":true,"type":"string","description":"Error description value whenever invoice `State` is set to 'Error'."},"Identifiers":{"type":"object","description":"Collection of unique ids related to this invoice line item.","properties":{"BatchId":{"nullable":true,"type":"string","description":"Elite accounting batch Id associated with the journal entry.","readOnly":true},"ExternalJournalEntryId":{"nullable":true,"type":"string","description":"External journal entry Id in the accounting system."}}},"LineItems":{"type":"array","description":"A collection of line items related to the contract Id.","readOnly":true,"items":{"type":"object","description":"General ledger journal entry line item.","properties":{"ModelType":{"type":"string","enum":["JournalEntryLineItem"],"readOnly":true},"Id":{"type":"string","description":"Unique identifier for the model type.","readOnly":true},"GrandTotal":{"type":"number","description":"Line item amount.\n\nPositive values are debits.\n\nNegative values are credits.\n","readOnly":true},"Identifiers":{"type":"object","description":"Collection of unique ids related to the journal entry line item.","readOnly":true,"properties":{"ContractId":{"nullable":true,"type":"string","description":"Contract Id associated to the line item.","readOnly":true},"CustomerId":{"nullable":true,"type":"string","description":"Customer Id associated to the line item.","readOnly":true},"ExternalContractId":{"nullable":true,"type":"string","description":"External contract Id associated to the line item.","readOnly":true},"ExternalCustomerId":{"nullable":true,"type":"string","description":"The value from a 3rd party system that identifies the Customer record for integrations.","readOnly":true},"JournalEntryAccountId":{"nullable":true,"type":"string","description":"General Ledger account Id associated with the line item.","readOnly":true},"JournalEntryId":{"type":"string","description":"Journal Entry Id associated with the line item.","readOnly":true}}},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the line item.","readOnly":true}}}},"Memo":{"nullable":true,"type":"string","description":"Memo associated to the journal entry.","readOnly":true},"State":{"type":"string","description":"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.","enum":["Pending","Posted","Error"]}},"default":{"ModelType":"string","Id":"string","Dimensions":{},"EntryDateTime":"string","ErrorCode":"string","ErrorDescription":"string","Identifiers":{},"LineItems":[],"Memo":"string","State":"string"},"$id":"JournalEntryRequest"},"InvoiceResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"InvoiceResponse","type":"object","properties":{"ModelType":{"type":"string","description":"These are the different types of invoice models we can use.","readOnly":true,"enum":["Invoice"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the invoice"},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for invoice","properties":{"ContractId":{"nullable":true,"type":"string","description":"(Elite-Only) The contract id associated with the invoice."}}},"CustomerId":{"nullable":true,"type":"string","description":"The customer id associated with the invoice."},"InvoiceDate":{"nullable":true,"type":"string","description":"The date the invoice was created","format":"date-time"},"InvoiceNumber":{"nullable":true,"type":"string","description":"The invoice number"},"GrandTaxTotal":{"nullable":true,"type":"number","description":"Amount of Tax/VAT on the invoice"},"GrandTotal":{"nullable":true,"type":"number","description":"Value of the invoice including taxes"},"AmountDue":{"nullable":true,"type":"number","description":"Amount of money owed toward the invoice total"},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for invoice","properties":{}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time"},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time"}},"default":{"ModelType":"string","Id":"string","Name":"string","Identifiers":{},"CustomerId":"string","InvoiceDate":"string","InvoiceNumber":"string","GrandTaxTotal":0,"GrandTotal":0,"AmountDue":0,"AdditionalFields":{},"CreatedDateTime":"string","UpdatedDateTime":"string"},"$id":"InvoiceResponse"},"global_package_remote_line-item":{"$id":"global_package_remote_line-item","$schema":"http://json-schema.org/draft-07/schema#","title":"LineItem","type":"object","description":"An inventory item associated with a contract.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type.","readOnly":true},"Id":{"type":"string","description":"The unique identifier for this record.","readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups.","readOnly":true},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for LineItem.","properties":{"Key":{"nullable":true,"type":"string","description":"(Elite Only) This value is a secondary unique inventory identifier (similar and additional to a serial number) and can be the same as the Primary ID. Must be a unique numeric or alpha-numeric value.","readOnly":true},"Model":{"nullable":true,"type":"string","description":"(Elite Only) The model name associated with a specific instance of an item.","readOnly":true},"ParentId":{"nullable":true,"type":"string","description":"Elite and Essentials Only.","readOnly":true},"PartNumber":{"nullable":true,"type":"string","description":"(Elite Only) The part number associated with a specific instance of an item.","readOnly":true}},"readOnly":true},"Classification":{"type":"string","description":"This product is either meant for sale or rental. The internal classification does not apply to lineitems.","enum":["Rental","Sale",null],"readOnly":true},"EndDateTime":{"nullable":true,"type":"string","description":"UTC - When does the customer intend to return the items?","format":"date-time","readOnly":true},"FuelCapacity":{"nullable":true,"type":"number","description":"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.","readOnly":true},"HasFuel":{"nullable":true,"type":"boolean","description":"If this is related to an item that uses fuel, this field will be set. If not it will be false.","readOnly":true},"IsSerialized":{"nullable":true,"type":"boolean","description":"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.","readOnly":true},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"number","description":"This is the final projected tax for this line.","readOnly":true},"LineTotal":{"nullable":true,"type":"number","description":"This is the final projected price for this line accounting for qty, discounts, duration, tax, etc..","readOnly":true},"LocationId":{"nullable":true,"type":"string","description":"Id of the Location. (see the Location endpoints)","readOnly":true},"MeterReadings":{"nullable":true,"type":"array","description":"Meter readings of this inventory. Multiple readings allowed for different types.","items":{"type":"object","properties":{"MeterReading":{"type":"number","description":"The last known meter reading of this inventory."},"MeterType":{"type":"string","description":"The type of meter for this reading."}}},"readOnly":true},"Notes":{"nullable":true,"type":"string","description":"Notes attached to a line item. Not an array of notes like its similarly name fields.","readOnly":true},"PONumber":{"nullable":true,"type":"string","description":"A number associated to a contract. Thi is user definable and associated by a POR user and their customer.","readOnly":true},"ProductId":{"nullable":true,"type":"string","description":"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.)","readOnly":true},"Quantity":{"type":"number","description":"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.","readOnly":true},"Rates":{"nullable":true,"type":"array","description":"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. \n\nThis is currently not supported in Elite.","items":{"type":"string"},"readOnly":true},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.","readOnly":true},"StartDateTime":{"nullable":true,"type":"string","description":"UTC - When does the customer want the items?","format":"date-time","readOnly":true},"Status":{"nullable":true,"type":"string","description":"The displayable status of a lineitem. Sales lineitems might say \"sold\". Rental items might say \"reserved\".\n* Reserved\n* Out\n* Off Rent\n* Returned\n* Sold\n","enum":["Reserved","Out","Off Rent","Returned","Sold"],"readOnly":true},"StockId":{"nullable":true,"type":"string","description":"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.)","readOnly":true},"Workflows":{"type":"array","description":"For Internal Use Only.","readOnly":true,"items":{"$id":"global_package_remote_workflow","$schema":"http://json-schema.org/draft-07/schema#","title":"Workflow","type":"object","properties":{"Creatable":{"nullable":true,"type":"boolean","description":"Can the workflow be created?"},"TemplateId":{"nullable":true,"type":"string"},"PhotoPickerType":{"type":"string","description":"Options are None, Generic, 360","enum":["Default","Image360","None",null]},"RequiredPhotos":{"nullable":true,"type":"number"}}}},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for this record.","properties":{"ContractId":{"oneOf":[{"type":"string","description":"The id of the associated contract."},{"type":"number","description":"The id of the associated contract."}],"nullable":true,"description":"The id of the associated contract."},"FuelStockName":{"nullable":true,"type":"string","description":"(Elite Only) The name of the fuel stock associated with this line item and ios only used for debugging purposes. This field should only show up if the isFuel field is true."},"FuelStockId":{"nullable":true,"type":"string","description":"(Elite Only) The id of the fuel stock associated with this line item and ios only used for debugging purposes. This field should only show up if the isFuel field is true."}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was created.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was updated.","format":"date-time","readOnly":true},"Hidden":{"nullable":true,"type":"integer","enum":[null,1],"description":"Hidden"},"ItemId":{"nullable":true,"type":"string","description":"Kept for legacy support, will eventually only need StockId and ProductId.","deprecated":true,"readOnly":true}},"default":{"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","StartDateTime":"string","Status":"string","StockId":"string","Workflows":[],"AdditionalFields":{},"CreatedDateTime":"string","UpdatedDateTime":"string","Hidden":0,"ItemId":"string"}},"LineItemsCallOffRent":{"$schema":"http://json-schema.org/draft-07/schema#","title":"LineItemsCallOffRent","type":"object","properties":{"LineItemIds":{"type":"array","items":{"type":"string","description":"The unique line items id"},"description":"The unique line items ids"},"CalledOffDateTime":{"type":"string","format":"date-time","description":"What date and time to call off the line items. UTC time zone. e.g. 2023-01-01T06:00:00Z"},"PersonCallingOff":{"type":"string","description":"Name of the person who is calling the line items off rent."},"Memo":{"type":"string","description":"Additional textual information for calling the line items off rent."},"RemoteUserId":{"type":"string","description":"An identifier on the remote server for the user's account. Can be User ID, Username, anything to match the Relationship to a user."}},"required":["LineItemIds","CalledOffDateTime"],"default":{"LineItemIds":[],"CalledOffDateTime":"string","PersonCallingOff":"string","Memo":"string","RemoteUserId":"string"},"$id":"LineItemsCallOffRent"},"LocationRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"LocationRequest","type":"object","description":"These are primarily made up of job sites/venues/places inventory is delivered to/collected from, but they can refer to other locations as well in the future.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Location"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"This would map to the jobsite description in Elite. Example being Madison Square Garden.","minLength":1,"maxLength":255},"Identifiers":{"nullable":true,"type":"object","description":"Location does not have any identifiers at this time.","readOnly":true},"Address":{"nullable":true,"type":"object","description":"Location address.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Customer","enum":["Customer"]},"Name":{"nullable":true,"type":"string","description":"Optional name for Address","readOnly":true},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street.","maxLength":50},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite.","readOnly":true},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.","minLength":2},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country.","maxLength":50},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"Contacts":{"type":"array","description":"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.**\n\nElite: Supported. \nSyrinx: Not supported.","items":{"type":"object","required":["Type","Contact"],"properties":{"Type":{"type":"string","description":"Currently there arent any specific types related to location","default":"Default","readOnly":true},"Contact":{"type":"object","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","enum":["Contact","CustomerContact","VendorContact","ContractContact"],"readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id."},"ParentId":{"nullable":true,"type":"string","description":"In Elite, ParentId is the same as CustomerId."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company."},"Disabled":{"nullable":true,"type":"boolean","description":"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.\n\nElite: Supported\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact. \n\nElite: This field is not supported.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: Read-Only"},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: Read-Only"},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types.","default":"Default","enum":["Default"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id. \n\nElite: This field is not supported.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix. \n\nElite: This field is not supported."},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.\n\nElite: Supported. \nSyrinx: Not supported.","format":"date-time"}}}}}}}},"Emails":{"type":"array","description":"Type can == \"Customer\" or \"Billing\" for now. This supports multiple email addresses.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types."},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}},"readOnly":true},"EndDate":{"nullable":true,"type":"string","description":"This is the date from which the location is no longer valid to be used. A location cannot be used after this date.\n\nElite: This field is not supported. \nSyrinx: Supported.","format":"date-time"},"Notes":{"type":"array","description":"Currently we only support the following types of notes\n* SiteDeliveryInstructions.","items":{"type":"object","required":["Type","Value"],"properties":{"Type":{"type":"string","description":"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.","enum":["SiteDeliveryInstructions"],"default":"SiteDeliveryInstructions"},"Value":{"nullable":true,"type":"string","description":"The note text."}}}},"OwnerId":{"nullable":true,"type":"string","description":"Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc.."},"Phones":{"type":"array","description":"Type can == \"Customer\" or \"Billing\" for now. This supports multiple phone","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types.","default":"Default","enum":["Default"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"StartDate":{"nullable":true,"type":"string","description":"This is the date from which the location is valid to be used. A location cannot be used before this date.\n\nElite: Not supported. \nSyrinx: Supported.","format":"date-time"},"Type":{"type":"string","description":"Location type may be one of the following.\n* Global\n* Customer\n* Supplier","enum":["Global","Customer","Supplier"],"readOnly":true},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Location."},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This means Deleted. \n\nElite: This field is always 0.","enum":[null,1],"readOnly":true}},"default":{"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},"$id":"LocationRequest"},"LocationResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"LocationResponse","type":"object","description":"These are primarily made up of job sites/venues/places inventory is delivered to/collected from, but they can refer to other locations as well in the future.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Location"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"This would map to the jobsite description in Elite. Example being Madison Square Garden."},"Identifiers":{"nullable":true,"type":"object","description":"Location does not have any identifiers at this time.","readOnly":true},"Address":{"nullable":true,"type":"object","description":"Location address.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Customer","enum":["Customer"]},"Name":{"nullable":true,"type":"string","description":"Optional name for Address","readOnly":true},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite.","readOnly":true},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"Contacts":{"type":"array","description":"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.**\n\nElite: Supported. \nSyrinx: Not supported.","items":{"type":"object","required":["Type","Contact"],"properties":{"Type":{"type":"string","description":"Currently there arent any specific types related to location","default":"Default","readOnly":true},"Contact":{"type":"object","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","enum":["Contact","CustomerContact","VendorContact","ContractContact"],"readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id."},"ParentId":{"nullable":true,"type":"string","description":"In Elite, ParentId is the same as CustomerId."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company."},"Disabled":{"nullable":true,"type":"boolean","description":"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.\n\nElite: Supported\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact. \n\nElite: This field is not supported.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: Read-Only"},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: Read-Only"},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types.","default":"Default","enum":["Default"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id. \n\nElite: This field is not supported.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: This field is not supported."},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.\n\nElite: Supported. \nSyrinx: Not supported.","format":"date-time"}}}}}}}},"Emails":{"type":"array","description":"Type can == \"Customer\" or \"Billing\" for now. This supports multiple email addresses.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types."},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}},"readOnly":true},"EndDate":{"nullable":true,"type":"string","description":"This is the date from which the location is no longer valid to be used. A location cannot be used after this date. \n\nElite: This field is not supported. \nSyrinx: Supported.","format":"date-time"},"Notes":{"type":"array","description":"Currently we only support the following types of notes\n* SiteDeliveryInstructions.","items":{"type":"object","required":["Type","Value"],"properties":{"Type":{"type":"string","description":"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.","readOnly":true,"enum":["SiteDeliveryInstructions"],"default":"SiteDeliveryInstructions"},"Value":{"nullable":true,"type":"string","description":"The note text."}}}},"OwnerId":{"nullable":true,"type":"string","description":"Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc.."},"Phones":{"type":"array","description":"Type can == \"Customer\" or \"Billing\" for now. This supports multiple phone","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types.","default":"Default","enum":["Default"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"StartDate":{"nullable":true,"type":"string","description":"This is the date from which the location is valid to be used. A location cannot be used before this date.\n\nElite: Not supported. \nSyrinx: Supported.","format":"date-time"},"Type":{"type":"string","description":"Location type may be one of the following.\n* Global\n* Customer\n* Supplier","enum":["Global","Customer","Supplier"],"readOnly":true},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Location."},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This means Deleted. \n\nElite: This field is always 0.","enum":[null,1],"readOnly":true}},"default":{"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},"$id":"LocationResponse"},"ProductAvailabilityResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ProductAvailabilityResponse","type":"object","description":"Realtime availability for Product","properties":{"ModelType":{"type":"string","description":"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.","readOnly":true},"Id":{"type":"string","description":"Cannot be used for patching or lookups","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Identifiers":{"nullable":true,"type":"object","description":"ProductAvailability does not have any identifiers at this time.","readOnly":true},"ProductId":{"type":"string","description":"Id of product","readOnly":true},"ProductName":{"type":"string","description":"Name of product","readOnly":true},"AvailableStock":{"nullable":true,"type":"array","description":"The available stock for this product.","items":{"type":"object","description":"Realtime availability for Stock","properties":{"ModelType":{"type":"string","description":"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.","readOnly":true},"Id":{"type":"string","description":"Cannot be used for patching or lookups","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Stock Availability.","properties":{"Key":{"nullable":true,"type":"string","description":"(Elite Only) A \"human readable\" form of id.","readOnly":true}},"readOnly":true},"StockId":{"type":"string","description":"Id of stock","readOnly":true},"StockName":{"type":"string","description":"Name of stock","readOnly":true},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number associated with a specific instance of an item.","readOnly":true},"DepotId":{"type":"string","description":"The company id, store id, or depot id depending on which system you are using."},"StartDateTime":{"type":"string","description":"Start date of availability","format":"date-time","readOnly":true},"EndDateTime":{"type":"string","description":"End date of availability","format":"date-time","readOnly":true},"AvailableQuantity":{"type":"number","description":"The current quantity available for rent or sale.","readOnly":true},"ExpectedQuantity":{"type":"number","description":"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.","readOnly":true},"TotalQuantity":{"type":"number","description":"Total quantity owned regardless of availability.","readOnly":true},"QtyExpected":{"type":"number","description":"Expected quantity\n\n**Deprecated**: Please use *ExpectedQuantity* instead.","deprecated":true,"readOnly":true}}},"readOnly":true},"DepotId":{"type":"string","description":"The company id, store id, or depot id depending on which system you are using."},"StartDateTime":{"type":"string","description":"Start date of availability","format":"date-time","readOnly":true},"EndDateTime":{"type":"string","description":"End date of availability","format":"date-time","readOnly":true},"AvailableQuantity":{"type":"number","description":"The current quantity available for rent or sale.","readOnly":true},"ExpectedQuantity":{"type":"number","description":"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.","readOnly":true},"TotalQuantity":{"type":"number","description":"Total quantity owned regardless of availability.","readOnly":true},"QtyExpected":{"type":"number","description":"Expected quantity\n\n**Deprecated**: Please use *ExpectedQuantity* instead.","deprecated":true,"readOnly":true}},"default":{"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},"$id":"ProductAvailabilityResponse"},"ProductRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ProductRequest","type":"object","description":"These are customer facing products. Only products or items that are marked for web display.","required":["Name","CategoryIds","Classification","Description","DepotId","AdditionalFields","Identifiers"],"properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Product"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the item."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Product.","properties":{"Key":{"nullable":true,"type":"string","description":"(Required) A customer defined Id for this item."},"PartNumber":{"nullable":true,"type":"string","description":"The part number associated to a specific instance of a part."},"Alias":{"nullable":true,"type":"string","description":"(Elite Only) Lookup field in Elite."},"Barcode":{"type":"string","description":"(Elite Only) Barcode field in Elite.","nullable":true}}},"CategoryIds":{"type":"array","description":"Reference a CategoryId","items":{"type":"string"},"readOnly":true},"CategoryName":{"nullable":true,"type":"string","description":"Denormalized name of the Category. \n\nElite: Only supports one name."},"Classification":{"type":"string","description":"This Product is either meant for sale, rental or internal. Only Rental and Sale supported for POST.","enum":["Rental","Sale"]},"DepotId":{"nullable":true,"type":"string","description":"Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)"},"Description":{"nullable":true,"type":"string","description":"This should describe the category. Likely a single sentence, but could be small paragraph."},"DisplayOrder":{"nullable":true,"type":"number","description":"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. \n\nElite: This field is not supported.","minimum":1,"readOnly":true},"InstructionsUrl":{"nullable":true,"type":"string","description":"A publicly accessible link to any instructions associated with this item.","readOnly":true},"ModelName":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Stock. The model name associated with a specific instance of an item. \n\nElite: This field is not supported.","readOnly":true},"ModelNumber":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.","readOnly":true},"ModelYear":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.","readOnly":true},"Images":{"type":"array","description":"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.","items":{"type":"object","description":"Object with image data.","properties":{"Uri":{"type":"string","description":"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](https://en.wikipedia.org/wiki/Data_URI_scheme)"},"AltText":{"nullable":true,"type":"string","description":"Text found in Alt image field"}}},"readOnly":true},"OtherUrls":{"type":"array","description":"An array of publicly accessible URLs that can be used for anything. \n\nElite: This field is not supported.","items":{"type":"string"},"readOnly":true},"Tags":{"type":"array","description":"This should be an array of tags. Generally expected to be like a subcategory. \n\nElite: This field is not supported.","items":{"type":"string"},"readOnly":true},"IsPart":{"nullable":true,"type":"boolean","description":"Used to determine if product is a part (Sales"},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Product.","properties":{"CaseQuantity":{"nullable":true,"type":"number","description":"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.","default":"null"},"CriticalLevel":{"nullable":true,"type":"number","description":"When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.","default":"null"},"CurrentDepotId":{"nullable":true,"type":"string","description":"(Elite Only - Required) The id of the current store/depot."},"InternalClassificationType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Internal\" this further specifies the type. If this is not set, this defaults to \"null\".","enum":["Non-rental Asset","Work Order item"],"readOnly":true},"RentalCaseQuantity":{"nullable":true,"type":"number","description":"The amount in a case for a rental.","default":"null"},"RentalType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Rental\" this further specifies the type. If this is not set, this defaults to \"null\"","enum":["Rental - Header"],"readOnly":true},"ReorderMaximum":{"nullable":true,"type":"number","description":"The maximum for reordering the item.","default":"null"},"ReorderMinimum":{"nullable":true,"type":"number","description":"The minimum for reordering the item.","default":"null"},"SalesType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Sales\" this further specifies the type. If this is not set, this defaults to \"null\"","enum":["Sales - Header"],"readOnly":true},"TaxCode":{"type":"number","description":"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.","nullable":true},"ExternalTaxCode":{"type":"string","description":"The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.","nullable":true}}}},"default":{"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":{}},"$id":"ProductRequest"},"ProductResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ProductResponse","type":"object","description":"These are customer facing products. Read Only. Only products or items that are marked for web display.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Product"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the item.","readOnly":true},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Product.","properties":{"Key":{"nullable":true,"type":"string","description":"A customer defined Id for this item.","readOnly":true},"Alias":{"nullable":true,"type":"string","description":"(Elite Only) Lookup field in Elite.","readOnly":true},"Barcode":{"nullable":true,"type":"string","description":"(Elite Only) Barcode field in Elite.","readOnly":true},"PartNumber":{"nullable":true,"type":"string","description":"The part number associated to a specific instance of a part.","readOnly":true}},"readOnly":true},"CategoryIds":{"type":"array","description":"Reference a CategoryId","items":{"type":"string"},"readOnly":true},"CategoryName":{"nullable":true,"type":"string","description":"Denormalized name of the Category. \n\nElite: Only supports one name.","readOnly":true},"Classification":{"type":"string","description":"This Product is either meant for sale, rental or internal.","enum":["Rental","Sale","Internal",null],"readOnly":true},"DepotId":{"nullable":true,"type":"string","description":"Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)"},"Description":{"nullable":true,"type":"string","description":"This should describe the category. Likely a single sentence, but could be small paragraph.","readOnly":true},"DisplayOrder":{"nullable":true,"type":"number","description":"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. \n\nElite: This field is not supported.","minimum":1,"readOnly":true},"InstructionsUrl":{"nullable":true,"type":"string","description":"A publicly accessible link to any instructions associated with this item.","readOnly":true},"ModelName":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Stock. The model name associated with a specific instance of an item. \n\nElite: This field is not supported.","readOnly":true},"ModelNumber":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Stock. The model number associated with a specific instance of an item.","readOnly":true},"ModelYear":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Stock. The model year associated with a specific instance of an item.","readOnly":true},"Key":{"nullable":true,"type":"string","description":"A customer defined Id for this item.\n\n**Deprecated**: This field is being moved to *Identifiers.Key*.","deprecated":true,"readOnly":true},"Images":{"type":"array","description":"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.","items":{"type":"object","description":"Object with image data.","properties":{"Uri":{"type":"string","description":"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](https://en.wikipedia.org/wiki/Data_URI_scheme)"},"AltText":{"nullable":true,"type":"string","description":"Text found in Alt image field"}}},"readOnly":true},"OtherUrls":{"type":"array","description":"An array of publicly accessible URLs that can be used for anything. \n\nElite: This field is not supported.","items":{"type":"string"},"readOnly":true},"Tags":{"type":"array","description":"This should be an array of tags. Generally expected to be like a subcategory. \n\nElite: This field is not supported.","items":{"type":"string"},"readOnly":true},"IsPart":{"nullable":true,"type":"boolean","description":"Used to determine if product is a part","readOnly":true},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Product.","properties":{"CaseQuantity":{"nullable":true,"type":"number","description":"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.","default":"null"},"CriticalLevel":{"nullable":true,"type":"number","description":"When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.","default":"null"},"CurrentDepotId":{"nullable":true,"type":"string","description":"(Elite Only) The id of the current store/depot."},"InternalClassificationType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Internal\" this further specifies the type. If this is not set, this defaults to \"null\".","enum":["Non-rental Asset","Work Order item"],"readOnly":true},"RentalCaseQuantity":{"nullable":true,"type":"number","description":"The amount in a case for a rental.","default":"null"},"RentalType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Rental\" this further specifies the type. If this is not set, this defaults to \"null\"","enum":["Rental - Header"],"readOnly":true},"ReorderMaximum":{"nullable":true,"type":"number","description":"The maximum for reordering the item.","default":"null"},"ReorderMinimum":{"nullable":true,"type":"number","description":"The minimum for reordering the item.","default":"null"},"SalesType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Sales\" this further specifies the type. If this is not set, this defaults to \"null\"","enum":["Sales - Header"],"readOnly":true},"SpecDescription":{"nullable":true,"type":"string","description":"(Elite only) This is the text field currently present on rentalhosting as additional information/info","readOnly":true},"TaxCode":{"type":"number","description":"The tax code for the item. Can't update this value from the API. Use the enumblookup/stock/TaxCode to get the tax codes for the item.","nullable":true},"TaxCodeName":{"type":"string","description":"The name of the tax code.","nullable":true,"readonly":true},"ExternalTaxCode":{"type":"string","description":"The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.","nullable":true}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This means Deleted. \n\nElite: This field is not supported.","enum":[null,1],"readOnly":true},"Alias":{"nullable":true,"type":"string","description":"**Deprecated**: Use Identifiers.Alias \n\n(Elite Only) Lookup field in Elite.","readOnly":true,"deprecated":true},"Barcode":{"nullable":true,"type":"string","description":"**Deprecated**: Use Identifiers.Barcode \n\nElite: This field is not supported.","readOnly":true,"deprecated":true},"DisplayOnStorefront":{"type":"boolean","description":"Whether or not this particular product should display on the storefront.","readOnly":true,"default":true},"Revision":{"oneOf":[{"type":"number","description":"For elite, only a number. It is a monotomic that can be used to detect changes."},{"type":"string","description":"For elite, only a number. It is a monotomic that can be used to detect changes."}],"readOnly":true,"description":"For elite, only a number. It is a monotomic that can be used to detect changes."}},"default":{"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},"$id":"ProductResponse"},"ProductAssociation":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ProductAssociation","type":"object","description":"Abstract model defining a relationship between two products.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["ProductAssociation"]},"Id":{"type":"string","description":"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.","readOnly":true},"ParentProductId":{"type":"string","description":"Product to which the association belongs to ie. the parent.","readOnly":true},"ChildProductId":{"type":"string","description":"Product that is being associated ie. the child.","readOnly":true},"AssociationType":{"type":"string","description":"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.","readOnly":true,"enum":["Optional","Automatic","KitComponent"]},"Group":{"nullable":true,"type":"string","description":"Optional grouping for this relationship","readOnly":true},"GroupSelectionType":{"type":"string","description":"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.","readOnly":true,"enum":["ChooseOne","ChooseMany","ChooseQty"],"default":"ChooseMany"},"IsSelected":{"type":"boolean","description":"Whether or not this item, which is a part of a group, should be pre-selected","readOnly":true},"DisplayOrder":{"type":"number","description":"Defines a sort order for associated products. Lowest value will appear first in the list","readOnly":true},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This means Deleted. \n\nElite: This field is not supported.","enum":[null,1],"readOnly":true},"Disabled":{"nullable":true,"type":"boolean","description":"Whether or not the record is disabled","readOnly":true},"Quantity":{"nullable":true,"type":"number","description":"Quantity of the referenced product that is allocated to this association","readOnly":true}},"default":{"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},"$id":"ProductAssociation"},"ProductRatesResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ProductRatesResponse","type":"object","properties":{"ApplicableRates":{"type":"string","description":"Applicable rates are the most relevant rates, passed back as a single string with line breaks (\\n).\n\nExample #1 (raw): \n\"Daily Rate: $20.00 \\n Weekly Rate: $65.00 \\n Monthly Rate: $240.00”: \n\nExample #1 (displayed): \n- DailyRate: $20.00 \n- Weekly Rate: $65.00 \n- Monthly Rate: $240.00 \n\nExample #2 (raw): \n“Daily: $20.00 \\n (there is a single day surcharge of $15.00) \\n Weekly: $60.00”\n\nExample #2 (displayed): \n- Daily: $20.00 \n- (there is a single day surcharge of $15.00) \n- Weekly: $60.00"},"AllRates":{"type":"array","description":"All rates for this product whether relevant or not. In most cases, you will want to use applicable rates.","items":{"type":"object","properties":{"PeriodName":{"type":"string","description":"Example: \"daily rate\", \"1 week rate\""},"Rate":{"nullable":true,"type":"string","description":"Example: \"20.00\""},"CurrencyType":{"type":"string","description":"Example: \"USD\""}}}}},"description":"Rates for product","default":{"ApplicableRates":"string","AllRates":[]},"$id":"ProductRatesResponse"},"SalesPersonResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"SalesPersonResponse","type":"object","description":"Sales person associated with Contract","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["SalesPerson"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Email":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Primary"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}},"FirstName":{"nullable":true,"type":"string","description":"First name of the sales person. \n\nElite: This field is not supported.","readOnly":true},"LastName":{"nullable":true,"type":"string","description":"Last name of the sales person. \n\nElite: This field is not supported.","readOnly":true}},"default":{"ModelType":"string","Id":"string","Name":"string","Email":{},"FirstName":"string","LastName":"string"},"$id":"SalesPersonResponse"},"StockRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"StockRequest","type":"object","description":"The specific items in your inventory.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Stock"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Stock.","properties":{"Alias":{"nullable":true,"type":"string","description":"(Elite Only) Lookup field in Elite.","readOnly":true},"Barcode":{"nullable":true,"type":"string","description":"(Elite Only) Barcode field in Elite.","readOnly":true},"InventoryNumber":{"nullable":true,"type":"string","description":"A secondary number, possibly a barcode string, associated with an item or specific instance of an item. \n\nElite: This field is not supported."},"Key":{"nullable":true,"type":"string","description":"(Elite Only) A \"human readable\" form of id.","readOnly":true,"maxLength":16},"PartNumber":{"nullable":true,"type":"string","description":"The part number associated to a specific instance of a part (Sales Only)."}}},"CategoryIds":{"type":"array","description":"Reference a CategoryId","items":{"type":"string"},"readOnly":true},"CategoryName":{"nullable":true,"type":"string","description":"Denormalized name of the Category.","readOnly":true},"Classification":{"type":"string","description":"This Product is either meant for sale, rental or internal.","enum":["Internal","Rental","Sale"]},"DepotId":{"nullable":true,"type":"string","description":"Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)","maxLength":3},"IsAsset":{"nullable":true,"type":"boolean","description":"Item is eligible for depreciation"},"LoadingRatio":{"nullable":true,"type":"integer","description":"A number that represents the ability for a stock item to fit on a vehicle. \n\nElite: This field is not supported."},"Manufacturer":{"nullable":true,"type":"string","description":"The manufacturer associated with a specific instance of an item.","maxLength":50},"ModelName":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Product. The model name associated with a specific instance of an item. \n\nElite: This field is not supported.","maxLength":30},"ModelNumber":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item.","maxLength":30},"ModelYear":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item."},"ProductId":{"type":"string","description":"Id of the Product this Stock belongs to (see Product endpoint).","maxLength":16},"PurchaseDateTime":{"nullable":true,"type":"string","description":"Date stock was purchased.\n\nElite: 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.","format":"date-time","writeOnly":true},"PurchasePrice":{"nullable":true,"type":"number","description":"Price stock was purchased.\n\nElite: On serialized items, it is the purchase price for the item. On bulk items, it is the most recent purchase price of the item.","writeOnly":true},"Quantity":{"nullable":true,"type":"string","description":"Field only required for bulk stock endpoints"},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number associated with a specific instance of an item.","maxLength":50},"IsPart":{"nullable":true,"type":"boolean","description":"Used to determine if stock item is a part (Sales Only).","readOnly":true},"AdditionalFields":{"nullable":true,"type":"object","properties":{"CaseQuantity":{"nullable":true,"type":"number","description":"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.","default":"null"},"CriticalLevel":{"nullable":true,"type":"number","description":"When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.","default":"null"},"CurrentStoreId":{"nullable":true,"type":"string","description":"(Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH.","maxLength":3},"GlNumber":{"description":"The gl number for the stock item.","default":"null","nullable":true,"type":"string"},"InternalClassificationType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Internal\" this further specifies the type. If this is not set, this defaults to \"null\".","enum":["Non-rental Asset","Work Order item"],"readOnly":true},"RentalCaseQuantity":{"nullable":true,"type":"number","description":"The amount in a case for a rental.","default":"null"},"RentalType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Rental\" this further specifies the type. If this is not set, this defaults to \"null\"","enum":["Rental - Accessory","Rental - Coupon","Rental - Dynamic Qty","Rental - Hour meter","Rental - Miscellaneous","Rental - No sale","Rental - Normal","Rental - Package","Rental - Usage item"],"readOnly":true},"ReorderMaximum":{"nullable":true,"type":"number","description":"The maximum for reordering the item.","default":"null"},"ReorderMinimum":{"nullable":true,"type":"number","description":"The minimum for reordering the item.","default":"null"},"SalesType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Sales\" this further specifies the type. If this is not set, this defaults to \"null\"","enum":["Sales - Fractional Qty","Sales - Labor item","Sales - Miscellaneous","Sales - Normal","Sales - Percent of Rental"],"readOnly":true},"UserDefined1":{"nullable":true,"type":"string","description":"(Elite Only) Free field for customer use","maxLength":50},"UserDefined2":{"nullable":true,"type":"string","description":"(Elite Only) Free field for customer use","maxLength":50},"TaxCode":{"type":"number","description":"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.","nullable":true},"ExternalTaxCode":{"type":"string","description":"The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.","nullable":true}}},"Depreciation":{"nullable":true,"type":"object","description":"Depreciation fields for Stock","properties":{"DepreciationMethodCode":{"nullable":true,"type":"string","description":"The Value which defines the method (i.e. Straight-Line, MACRS, etc). \n\nComing 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":{"nullable":true,"type":"integer","description":"The amount of years for which the stock depreciates.","writeOnly":true},"CurrentValue":{"nullable":true,"type":"number","description":"The current netbook value of the stock item."},"SalvageValue":{"nullable":true,"type":"number","description":"The Salvageable value in terms of Depreciation."},"TotalDepreciation":{"nullable":true,"type":"number","description":"The total depreciation for the stock item.","default":"null"}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This means Deleted. \n\nElite: This field is always 0.","enum":[null,1],"readOnly":true},"DepreciationFields":{"nullable":true,"deprecated":true,"type":"object","description":"Depreciation fields for Stock","properties":{"DepreciationMethodCode":{"nullable":true,"type":"string","description":"The Value which defines the method (i.e. Straight-Line, MACRS, etc). \n\nComing 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":{"nullable":true,"type":"integer","description":"The amount of years for which the stock depreciates.","writeOnly":true},"CurrentValue":{"nullable":true,"type":"number","description":"The Current Value in terms of depreciation."},"SalvageValue":{"nullable":true,"type":"number","description":"The Salvageable value in terms of Depreciation."}}},"Alias":{"nullable":true,"type":"string","description":"**Deprecated**: Use Identifiers.Alias \n\n(Elite Only) Lookup field in Elite.","readOnly":true,"deprecated":true},"Barcode":{"nullable":true,"type":"string","description":"**Deprecated**: Use Identifiers.Alias \n\n(Elite Only) Barcode field in Elite.","readOnly":true,"deprecated":true}},"default":{"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"},"$id":"StockRequest"},"StockResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"StockResponse","type":"object","description":"The specific items in your inventory.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Stock"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Stock.","properties":{"Alias":{"nullable":true,"type":"string","description":"(Elite Only) Lookup field in Elite.","readOnly":true},"Barcode":{"nullable":true,"type":"string","description":"(Elite Only) Barcode field in Elite.","readOnly":true},"InventoryNumber":{"nullable":true,"type":"string","description":"A secondary number, possibly a barcode string, associated with an item or specific instance of an item. \n\nElite: This field is not supported."},"Key":{"nullable":true,"type":"string","description":"(Elite Only) A \"human readable\" form of id.","readOnly":true},"PartNumber":{"nullable":true,"type":"string","description":"The part number associated to a specific instance of a part (Sales Only).","readOnly":true}}},"CategoryIds":{"type":"array","description":"Reference a CategoryId. \n\nElite: This will only have a single element.","items":{"type":"string"},"readOnly":true},"CategoryName":{"nullable":true,"type":"string","description":"Denormalized name of the Category.","readOnly":true},"Classification":{"type":"string","description":"This Product is either meant for sale, rental or internal.","enum":["Internal","Rental","Sale"]},"DepotId":{"nullable":true,"type":"string","description":"Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints)"},"IsAsset":{"nullable":true,"type":"boolean","description":"Item is eligible for depreciation"},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"boolean","description":"Item is eligible for creating customer work orders"},"IsGenericWorkOrderItem":{"nullable":true,"type":"boolean","description":"Item is eligible for creating work orders"},"IsPart":{"nullable":true,"type":"boolean","description":"Used to determine if stock item is a part (Sales Only).","readOnly":true},"LoadingRatio":{"nullable":true,"type":"integer","description":"A number that represents the ability for a stock item to fit on a vehicle. \n\nElite: This field is not supported."},"Manufacturer":{"nullable":true,"type":"string","description":"The manufacturer associated with a specific instance of an item."},"ModelName":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Product. The model name associated with a specific instance of an item. \n\nElite: This field is not supported."},"ModelNumber":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item."},"ModelYear":{"nullable":true,"type":"string","description":"OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item."},"ProductId":{"nullable":true,"type":"string","description":"Id of the Product this Stock belongs to (see Product endpoint)."},"PurchaseDateTime":{"nullable":true,"type":"string","description":"Date stock was purchased.\n\nElite: 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.","format":"date-time","writeOnly":true},"PurchasePrice":{"nullable":true,"type":"number","description":"Price stock was purchased.\n\nElite: On serialized items, it is the purchase price for the item. On bulk items, it is the most recent purchase price of the item.","writeOnly":true},"Quantity":{"nullable":true,"type":"number","description":"The total amount of a particular Stock owned. Only used for bulk Stock records.","readOnly":true},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number associated with a specific instance of an item."},"Status":{"nullable":true,"type":"string","description":"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 \n - NotReady: State from Ready API. Not available in Syrinx yet\n - NoStock: Not available in Essentials or Syrinx.\n - Unavailable: Essentials: Has Item Unavailablity Record. Syrinx N/A.\n - Available: Essentials: Item is in Stock. Syrinx: Item is available.\n - OnRent: Essentials: Is on contract in order status. Syrinx: N/A\n - OffRent: Not available in Essentials or Syrinx.\n - Transfer: Not available in Essentials or Syrinx.\n - Repair: Essentials: In maintenance of type repair. Syrinx: Under Repair\n - Maintenance: Essentials: In maintenance of type maintenance. Syrinx: Under Repair\n - ServiceOrder: Essentials: In maintenance of type service call.\n - Reserved: Essentials: On Contracdt on reservation status. Syrinx: N/A","enum":["NotReady","NoStock","Unavailable","Available","OnRent","OffRent","Transfer","Repair","Maintenance","ServiceOrder","Reserved"],"readOnly":true},"AdditionalFields":{"nullable":true,"type":"object","properties":{"CaseQuantity":{"nullable":true,"type":"number","description":"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.","default":"null"},"CriticalLevel":{"nullable":true,"type":"number","description":"When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.","default":"null"},"CurrentStoreId":{"nullable":true,"type":"string","description":"(Elite Only) The depot where the stock is currently located or dispatched from. Read-only on PATCH."},"GlNumber":{"description":"The gl number for the stock item.","default":"null","nullable":true,"type":"string"},"InternalClassificationType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Internal\" this further specifies the type. If this is not set, this defaults to \"null\".","enum":["Non-rental Asset","Work Order item"],"readOnly":true},"ReadyStatus":{"nullable":true,"description":"(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.","type":"string","maxLength":255,"enum":["Ready","NotReady","NotSet"],"readOnly":true},"ReadyStatusChangeDateTime":{"nullable":true,"description":"(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.","type":"string","format":"date-time","readOnly":true},"RentalCaseQuantity":{"nullable":true,"type":"number","description":"The amount in a case for a rental.","default":"null"},"RentalType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Rental\" this further specifies the type. If this is not set, this defaults to \"null\"","enum":["Rental - Accessory","Rental - Coupon","Rental - Dynamic Qty","Rental - Hour meter","Rental - Miscellaneous","Rental - No sale","Rental - Normal","Rental - Package","Rental - Usage item"],"readOnly":true},"ReorderMaximum":{"nullable":true,"type":"number","description":"The maximum for reordering the item.","default":"null"},"ReorderMinimum":{"nullable":true,"type":"number","description":"The minimum for reordering the item.","default":"null"},"SalesType":{"nullable":true,"type":"string","description":"(Elite Only) If the classification field is set as \"Sales\" this further specifies the type. If this is not set, this defaults to \"null\"","enum":["Sales - Fractional Qty","Sales - Labor item","Sales - Miscellaneous","Sales - Normal","Sales - Percent of Rental"],"readOnly":true},"UserDefined1":{"nullable":true,"type":"string","description":"(Elite Only) Free field for customer use"},"UserDefined2":{"nullable":true,"type":"string","description":"(Elite Only) Free field for customer use"},"TaxCode":{"type":"number","description":"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.","nullable":true},"ExternalTaxCode":{"type":"string","description":"The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.","nullable":true}}},"Depreciation":{"nullable":true,"type":"object","description":"Depreciation fields for Stock","properties":{"DepreciationMethodCode":{"nullable":true,"type":"string","description":"The Value which defines the method (i.e. Straight-Line, MACRS, etc). \n\nComing 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":{"nullable":true,"type":"integer","description":"The amount of years for which the stock depreciates.","writeOnly":true},"CurrentValue":{"nullable":true,"type":"number","description":"The current netbook value of the stock item."},"SalvageValue":{"nullable":true,"type":"number","description":"The Salvageable value in terms of Depreciation."},"TotalDepreciation":{"nullable":true,"type":"number","description":"The total depreciation for the stock item.","default":"null"}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This means Deleted. \n\nElite: This field is always 0.","enum":[null,1],"readOnly":true},"Revision":{"oneOf":[{"type":"number","description":"For elite, only a number. It is a monotomic that can be used to detect changes."},{"type":"string","description":"For elite, only a number. It is a monotomic that can be used to detect changes."}],"readOnly":true,"description":"For elite, only a number. It is a monotomic that can be used to detect changes."},"DepreciationFields":{"nullable":true,"deprecated":true,"type":"object","description":"Depreciation fields for Stock","properties":{"DepreciationMethodCode":{"nullable":true,"type":"string","description":"The Value which defines the method (i.e. Straight-Line, MACRS, etc). \n\nComing 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":{"nullable":true,"type":"integer","description":"The amount of years for which the stock depreciates.","writeOnly":true},"CurrentValue":{"nullable":true,"type":"number","description":"The Current Value in terms of depreciation."},"SalvageValue":{"nullable":true,"type":"number","description":"The Salvageable value in terms of Depreciation."}}},"Alias":{"nullable":true,"type":"string","description":"**Deprecated**: Use Identifiers.Alias \n\n(Elite Only) Lookup field in Elite.","readOnly":true,"deprecated":true},"Barcode":{"nullable":true,"type":"string","description":"**Deprecated**: Use Identifiers.Barcode \n\n(Elite Only) Barcode field in Elite.","readOnly":true,"deprecated":true}},"default":{"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"},"$id":"StockResponse"},"StockUpdateRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"StockUpdateRequest","type":"object","description":"Update request object for Stock","properties":{"SerialNumber":{"type":"string","description":"The serial number of the stock item.","default":"null","nullable":true},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Stock.","properties":{"Alias":{"nullable":true,"type":"string","description":"(Elite Only) Lookup field in Elite.","readOnly":true},"Barcode":{"nullable":true,"type":"string","description":"(Elite Only) Barcode field in Elite.","readOnly":true}}},"Depreciation":{"type":"object","properties":{"TotalDepreciation":{"type":"number","description":"The total depreciation for the stock item.","default":"null","nullable":true},"CurrentValue":{"type":"number","description":"The current netbook value of the stock item.","default":"null","nullable":true}}},"AdditionalFields":{"type":"object","properties":{"CaseQuantity":{"type":"number","description":"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.","default":"null","nullable":true},"CriticalLevel":{"type":"number","description":"When greaterthan/lessthan this number, the item needs to be order. Shows a message on the screen saying below critical quantity.","default":"null","nullable":true},"GlNumber":{"type":"string","description":"The gl number for the stock item.","default":"null","nullable":true},"RentalCaseQuantity":{"type":"number","description":"The amount in a case for a rental.","default":"null","nullable":true},"ReorderMaximum":{"type":"number","description":"The maximum for reordering the item.","default":"null","nullable":true},"ReorderMinimum":{"type":"number","description":"The minimum for reordering the item.","default":"null","nullable":true},"TaxCode":{"type":"number","description":"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.","nullable":true},"ExternalTaxCode":{"type":"string","description":"The external tax code for the item. Supports Post, Patch, and Get. Only valid if integrated with an External Tax Service.","nullable":true}}}},"examples":[{"SerialNumber":"SN123456789","Depreciation":{"TotalDepreciation":10.5,"CurrentValue":120.5},"AdditionalFields":{"CaseQuantity":45,"CriticalLevel":5,"GlNumber":"123456","RentalCaseQuantity":35,"ReorderMaximum":450,"ReorderMinimum":45}}],"default":{"SerialNumber":"string","Identifiers":{},"Depreciation":{},"AdditionalFields":{}},"$id":"StockUpdateRequest"},"StockAvailabilityResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"StockAvailabilityResponse","type":"object","description":"Realtime availability for Stock","properties":{"ModelType":{"type":"string","description":"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.","readOnly":true},"Id":{"type":"string","description":"Cannot be used for patching or lookups","readOnly":true},"Name":{"nullable":true,"type":"string","description":"A display name for this record. Often used as a summary for lookups."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Stock Availability.","properties":{"Key":{"nullable":true,"type":"string","description":"(Elite Only) A \"human readable\" form of id.","readOnly":true}},"readOnly":true},"StockId":{"type":"string","description":"Id of stock","readOnly":true},"StockName":{"type":"string","description":"Name of stock","readOnly":true},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number associated with a specific instance of an item.","readOnly":true},"DepotId":{"type":"string","description":"The company id, store id, or depot id depending on which system you are using."},"StartDateTime":{"type":"string","description":"Start date of availability","format":"date-time","readOnly":true},"EndDateTime":{"type":"string","description":"End date of availability","format":"date-time","readOnly":true},"AvailableQuantity":{"type":"number","description":"The current quantity available for rent or sale.","readOnly":true},"ExpectedQuantity":{"type":"number","description":"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.","readOnly":true},"TotalQuantity":{"type":"number","description":"Total quantity owned regardless of availability.","readOnly":true},"QtyExpected":{"type":"number","description":"Expected quantity\n\n**Deprecated**: Please use *ExpectedQuantity* instead.","deprecated":true,"readOnly":true}},"default":{"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},"$id":"StockAvailabilityResponse"},"StockBulkAdjustRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"StockBulkAdjustRequest","type":"object","description":"The request schema for adjusting bulk Stock records.","properties":{"StockId":{"type":"string","description":"Which Stock record are you adjusting","writeOnly":true},"QuantityAdjustment":{"type":"number","description":"How much stock are you adding?","writeOnly":true},"AdjustmentReason":{"nullable":true,"type":"string","description":"Short note about why the Stock record is being modified","writeOnly":true},"DepotId":{"nullable":true,"type":"string","description":"Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the Stock. (See Depot endpoints)","writeOnly":true},"ProductId":{"nullable":true,"type":"string","description":"Product Id of the Stock record being modified.","writeOnly":true},"PurchaseDateTime":{"nullable":true,"type":"string","description":"Date the Stock was purchased.","format":"date-time","writeOnly":true},"PurchasePrice":{"nullable":true,"type":"number","description":"Price for which the Stock was purchased.","writeOnly":true}},"required":["QuantityAdjustment"],"default":{"StockId":"string","QuantityAdjustment":0,"AdjustmentReason":"string","DepotId":"string","ProductId":"string","PurchaseDateTime":"string","PurchasePrice":0},"$id":"StockBulkAdjustRequest"},"global_common_remote_work-order":{"$id":"global_common_remote_work-order","$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderPublic","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type.","readOnly":true},"Id":{"type":"string","description":"The unique identifier for this record.","readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups.","readOnly":true},"StockId":{"nullable":true,"type":"string"},"StockName":{"nullable":true,"type":"string"},"DepotId":{"nullable":true,"type":"string"},"OpenDateTime":{"nullable":true,"type":"string","format":"date-time"},"CloseDateTime":{"nullable":true,"type":"string","format":"date-time"},"CustomerId":{"nullable":true,"type":"string","description":"Reference a CustomerId that should be responsible for this Work Order."},"Status":{"type":"string","enum":["Quote","Open","Closed"]},"Type":{"nullable":true,"type":"string"},"SubType":{"nullable":true,"type":"string"},"Parts":{"nullable":true,"type":"array","items":{"oneOf":[{"$id":"global_common_remote_abstract/work-order-part","$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"Classification":{"nullable":true,"type":"string","description":"This product is either meant for sale or rental. The internal classification does not apply to lineitems.","enum":["Rental","Sale",null],"readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups."},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"boolean","description":"Indicates if the items should be pulled from stock when added to a work order."},"PurchasePrice":{"nullable":true,"type":"number","description":"The purchase price of the part."},"Quantity":{"nullable":true,"type":"string","description":"The quantity of this part on the work order"},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.","readOnly":true},"Status":{"nullable":true,"type":"string","description":"The displayable status of a lineitem. Sales lineitems might say \"sold\". Rental items might say \"reserved\".\n* Reserved\n* Out\n* Off Rent\n* Returned\n* Sold\n","enum":["Reserved","Out","Off Rent","Returned","Sold"],"readOnly":true},"StockId":{"nullable":true,"type":"string","description":"Id of stock"},"Comments":{"type":"string","description":"Any comments for this part."}}},{"type":"string"}]}},"IsCustomerWO":{"type":"boolean","description":"Flag to telling whether the WO is consumer facing or not."},"LaborTracking":{"nullable":true,"type":"object","description":"Labor tracking details.","readOnly":true,"properties":{"LaborTypes":{"nullable":true}}},"Complaint":{"type":"string","description":"The issue detected by the technician."},"Cause":{"type":"string","description":"The cause of the issue, to be updated if needed."},"Correction":{"type":"string","description":"The steps taken to correct the issue."},"ReportedIssue":{"type":"string","description":"The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)"},"OtherComments":{"type":"string","description":"Any additional comments for this work order."},"Operation":{"type":"string","description":"The operation that needs to be performed."},"DueDateTime":{"type":"string","format":"date-time","description":"The due date for this work order."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for this record."},"CreatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was created.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was updated.","format":"date-time","readOnly":true},"Hidden":{"nullable":true,"type":"integer","enum":[null,1],"description":"Hidden"}},"default":{"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}},"VendorRequest":{"$schema":"http://json-schema.org/draft-07/schema#","title":"VendorRequest","type":"object","description":"These are companies or individuals which are associated with a purchase order.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Vendor"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"The full name of the vendor. Could be a company or an individual.","minLength":1,"maxLength":50},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Vendor.\n\nWe currently only support\n* AccountNumber\n","properties":{"AccountNumber":{"nullable":true,"type":"string","description":"Vendor Account Number.","maxLength":50},"ExternalVendorId":{"nullable":true,"type":"string","description":"External identification related to the vendor.\n\nElite: 2021.16.0+","maxLength":100}}},"Addresses":{"type":"array","description":"Supported types will depend on the product.\n\nElite:\n * Supported: \"Default\"\n * Coming soon: \"Billing\", \"Shipping\"\n. ","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Type of address \"Default\", \"Billing\", etc. Supported types depend on the context of the address.\n\nFor Vendor, this is only \"Default\".","default":"Default","enum":["Default"]},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street.","maxLength":50},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite.","maxLength":50},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48.","minLength":2},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country.","maxLength":10},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}}},"Contacts":{"type":"array","description":"Name and Types of Contacts related to the Vendor.","items":{"type":"object","required":["Type","Contact"],"properties":{"Type":{"type":"string","description":"Relationship of the contact to the vendor.","enum":["Default","Secondary"],"default":"Default"},"Contact":{"type":"object","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","enum":["Contact","CustomerContact","VendorContact","ContractContact"],"readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact.","minLength":1,"maxLength":50},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id."},"ParentId":{"nullable":true,"type":"string","description":"Required by Elite."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact. \n\nElite: This field is not supported.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company. \n\nElite: This field is not supported.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company. \n\nElite: This field is not supported.","maxLength":50},"Disabled":{"nullable":true,"type":"boolean","description":"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.\n\nElite: This field is not supported.\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","maxLength":50}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: This field is not supported."},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: This field is not supported."},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. \n\nElite: Only supports \"Primary\".","default":"Default","enum":["Default","Mobile","Secondary","Primary"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded.","maxLength":50},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title. \n\nElite: This field is not supported.","maxLength":255},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact. \n\nElite: This field is not supported.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.","format":"date-time"}}}}}}}},"CurrencyCode":{"nullable":true,"type":"string","description":"Defaults to \"USD\". Code is [ISO 4217 format.](https://en.wikipedia.org/wiki/ISO_4217)\n\nYou 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.","default":"USD"},"Inactive":{"nullable":true,"type":"boolean","description":"Used to denote whether a vendor is considered active."},"Notes":{"type":"array","description":"Any comments or notes.","items":{"type":"object","required":["Type","Value"],"properties":{"Type":{"type":"string","description":"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.\n\nElite: There will only be one type of note, \"Default\".","readOnly":true,"enum":["Default"],"default":"Default"},"Value":{"nullable":true,"type":"string","description":"The note text."}}}},"Phones":{"type":"array","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. \n\nElite: Only supports \"Default\".","enum":["Default","Mobile","Secondary"],"default":"Default"},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded.","maxLength":50},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Terms":{"nullable":true,"type":"string","description":"Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)","maxLength":50},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields specific to each vendor.","properties":{"PaymentMethod":{"nullable":true,"type":"string","description":"(Elite Only) Payment methods for this vendor.\n\nComing 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.\n\nElite: 2021.16.0+ \nSyrinx: Not supported."},"TermDays":{"nullable":true,"type":"integer","description":"(Elite Only) Billing term days for the vendor.\n\nElite: 2021.16.0+ \nSyrinx: Not supported.","maximum":2147483647}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted","enum":[null,1],"readOnly":true}},"default":{"ModelType":"string","Id":"string","Name":"string","Identifiers":{},"Addresses":[],"Contacts":[],"CurrencyCode":"string","Inactive":false,"Notes":[],"Phones":[],"Terms":"string","AdditionalFields":{},"CreatedDateTime":"string","UpdatedDateTime":"string","Hidden":0},"$id":"VendorRequest"},"VendorResponse":{"$schema":"http://json-schema.org/draft-07/schema#","title":"VendorResponse","type":"object","description":"These are companies or individuals which are associated with a purchase order.","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type. Useful for bulk ingesting different record types.","readOnly":true,"enum":["Vendor"]},"Id":{"type":"string","description":"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.","readOnly":true},"Name":{"nullable":true,"type":"string","description":"The full name of the vendor. Could be a company or an individual."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Vendor.\n\nWe currently only support\n* AccountNumber\n","properties":{"AccountNumber":{"nullable":true,"type":"string","description":"Vendor Account Number."},"ExternalVendorId":{"nullable":true,"type":"string","description":"External identification related to the vendor.\n\nElite: 2021.16.0+"}}},"Addresses":{"type":"array","description":"Supported types will depend on the product.\n\nElite:\n * Supported: \"Default\"\n * Coming soon: \"Billing\", \"Shipping\"\n","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Type of address \"Default\", \"Billing\", etc. Supported types depend on the context of the address.\n\nFor Vendor, this is only \"Default\".","default":"Default","enum":["Default"]},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for City is tied to the length of Province, where the collective max length for both properties is 48."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"Usage Notes\n- MaxLength: The max length for Province is tied to the length of City, where the collective max length for both properties is 48."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}}},"Contacts":{"type":"array","description":"Name and Types of Contacts related to the Vendor.","items":{"type":"object","required":["Type","Contact"],"properties":{"Type":{"type":"string","description":"Relationship of the contact to the vendor.","enum":["Default","Secondary"],"default":"Default"},"Contact":{"type":"object","properties":{"ModelType":{"type":"string","description":"These are the different types of contact models we can use. Only CustomerContacts are postable.\nThe contact models may be\n- Contact\n- CustomerContact\n- VendorContact\n- ContractContact\n","enum":["Contact","CustomerContact","VendorContact","ContractContact"],"readOnly":true},"Name":{"nullable":true,"type":"string","description":"The display name for the contact."},"Identifiers":{"nullable":true,"type":"object","description":"Identifying items for Contact. \n\nElite: This field is not supported.","properties":{"DriversLicense":{"nullable":true,"type":"string","description":"The contact's drivers license number."},"EmployeeId":{"nullable":true,"type":"string","description":"The contact's employee id."},"ParentId":{"nullable":true,"type":"string","description":"In Elite, ParentId is the same as CustomerId."}}},"Addresses":{"type":"array","description":"Can support multiple addresses for a contact. \n\nElite: This field is not supported.","items":{"type":"object","description":"Customer or vendor addresses. Not all address fields may be filled depending on someone's location.","required":["Type"],"properties":{"Type":{"type":"string","description":"Examples include \"Default\", \"Billing\", etc. Supported types depend on the context of the address.","default":"Default"},"Name":{"nullable":true,"type":"string","description":"Optional name for Address"},"Line1":{"nullable":true,"type":"string","description":"Address Number and Street."},"Line2":{"nullable":true,"type":"string","description":"May be apartment, building, suite."},"Line3":{"nullable":true,"type":"string","description":"May be apartment, building, suite. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."},"City":{"nullable":true,"type":"string","description":"City Address is located in."},"GeoRegion2":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"GeoRegion3":{"nullable":true,"type":"string","description":"Elite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite."},"Province":{"nullable":true,"type":"string","description":"May be State, Province or Division depending on the country."},"PostalCode":{"nullable":true,"type":"string","description":"May be postcode, post code, PIN or ZIP Code depending on the country."},"Latitude":{"nullable":true,"type":"string","description":"Latitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Longitude":{"nullable":true,"type":"string","description":"Longitude in decimal format.\nCan enter up to 9 decimals places per argument based on the 30 character length of the delivery address field in transactions.\n - LOC:LAT, LON\n - Loc:XX.123456789,-YY.123456789\n \nElite: This field is not supported in Elite and will always return null. There are no plans to support this in Elite.\n"},"Country":{"nullable":true,"type":"string","description":"Two letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite."}}},"readOnly":true},"CompanyName":{"nullable":true,"type":"string","description":"Name of the company. \n\nElite: This field is not supported.","readOnly":true},"Department":{"nullable":true,"type":"string","description":"Department of the company. \n\nElite: This field is not supported."},"Disabled":{"nullable":true,"type":"boolean","description":"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. \n\nElite: This field is not supported.\n\nEssentials: Supported\n\nSyrinx: Not Supported"},"Emails":{"nullable":true,"type":"array","description":"Can support multiple email addresses for a contact.","items":{"type":"object","description":"See the Type description for what types are supported on each product.","required":["Type","Email"],"properties":{"Type":{"type":"string","description":"Supported types.","enum":["Default"]},"Email":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id."}}}},"FirstName":{"nullable":true,"type":"string","description":"First Name (if it's an individual).\n\nElite: This field is not supported."},"LastName":{"nullable":true,"type":"string","description":"Last Name (if it's an individual).\n\nElite: This field is not supported."},"Phones":{"nullable":true,"type":"array","description":"Can support multiple phone numbers for a contacts.","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. \n\nElite: Only supports \"Primary\".","default":"Default","enum":["Default","Mobile","Secondary","Primary"]},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Title":{"nullable":true,"type":"string","description":"The contact's title. \n\nElite: This field is not supported."},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields for Contact. \n\nElite: This field is not supported.","properties":{"InactiveDateTime":{"nullable":true,"type":"string","description":"This is the date that a contact is no longer authorized to be associated with the customer account.","format":"date-time"}}}}}}}},"CurrencyCode":{"nullable":true,"type":"string","description":"Defaults to \"USD\". Code is [ISO 4217 format.](https://en.wikipedia.org/wiki/ISO_4217)\n\nYou 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.","default":"USD"},"Inactive":{"nullable":true,"type":"boolean","description":"Used to denote whether a vendor is considered active."},"Notes":{"type":"array","description":"Any comments or notes.","items":{"type":"object","required":["Type","Value"],"properties":{"Type":{"type":"string","description":"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. \n\nElite: There will only be one type of note, \"Default\".","readOnly":true,"enum":["Default"],"default":"Default"},"Value":{"nullable":true,"type":"string","description":"The note text."}}}},"Phones":{"type":"array","items":{"type":"object","required":["Type","Number"],"properties":{"Type":{"type":"string","description":"Supported phone types. \"Default\" is the default phone number for the contact. \n\nElite: Only supports \"Default\".","enum":["Default","Mobile","Secondary"],"default":"Default"},"RemoteId":{"nullable":true,"type":"string","description":"A 3rd party ID can be supplied here if it exists. This is not the Point of Rental Id.","deprecated":true},"CountryCode":{"nullable":true,"type":"string","description":"Country code prefix.\n\nElite: Currently not supported\n"},"Number":{"nullable":true,"type":"string","description":"A phone number without the country code embedded."},"NumberE164":{"nullable":true,"type":"string","description":"A phone number must be supplied and validated according to the E.164 format. \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"Extension":{"nullable":true,"type":"string","description":"Is there an extension associated with this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true},"SmsCapable":{"nullable":true,"type":"boolean","description":"Can an SMS be sent to this phone number? \n\nElite: This field is not supported and will always return null. There are no plans to support this in Elite.","readOnly":true}}}},"Terms":{"nullable":true,"type":"string","description":"Billing terms for the vendor. (e.g. Net 30, Net 60, etc..)"},"AdditionalFields":{"nullable":true,"type":"object","description":"Additional fields specific to each vendor.","properties":{"PaymentMethod":{"nullable":true,"type":"string","description":"(Elite Only) Payment methods for this vendor.\n\nComing 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.\n\nElite: 2021.16.0+ \nSyrinx: Not supported."},"TermDays":{"nullable":true,"type":"integer","description":"(Elite Only) Billing term days for the vendor.\n\nElite: 2021.16.0+ \nSyrinx: Not supported."}}},"CreatedDateTime":{"nullable":true,"type":"string","description":"When was the record created? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"When was the record last updated? All date times are expected to be in UTC & ISO-8601 format. \n\nElite: This field is not supported.","format":"date-time","readOnly":true},"Hidden":{"type":"integer","description":"0 = false, 1 = true | This basically means Deleted","enum":[null,1],"readOnly":true}},"default":{"ModelType":"string","Id":"string","Name":"string","Identifiers":{},"Addresses":[],"Contacts":[],"CurrencyCode":"string","Inactive":false,"Notes":[],"Phones":[],"Terms":"string","AdditionalFields":{},"CreatedDateTime":"string","UpdatedDateTime":"string","Hidden":0},"$id":"VendorResponse"},"global_common_remote_work-order-create":{"$id":"global_common_remote_work-order-create","$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderCreate","type":"object","not":{"type":"object","patternProperties":{"":{"type":"null"}}},"properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type.","readOnly":true},"Id":{"type":"string","description":"The unique identifier for this record.","readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups.","readOnly":true},"StockId":{"nullable":true,"type":"string"},"StockName":{"nullable":true,"type":"string"},"DepotId":{"nullable":true,"type":"string"},"OpenDateTime":{"nullable":true,"type":"string","format":"date-time"},"CloseDateTime":{"nullable":true,"type":"string","format":"date-time"},"CustomerId":{"nullable":true,"type":"string","description":"Reference a CustomerId that should be responsible for this Work Order."},"Status":{"type":"string","enum":["Quote","Open","Closed"]},"Type":{"nullable":true,"type":"string"},"SubType":{"nullable":true,"type":"string"},"Parts":{"nullable":true,"type":"array","items":{"oneOf":[{"$id":"global_common_remote_abstract/work-order-part","$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"Classification":{"nullable":true,"type":"string","description":"This product is either meant for sale or rental. The internal classification does not apply to lineitems.","enum":["Rental","Sale",null],"readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups."},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"boolean","description":"Indicates if the items should be pulled from stock when added to a work order."},"PurchasePrice":{"nullable":true,"type":"number","description":"The purchase price of the part."},"Quantity":{"nullable":true,"type":"string","description":"The quantity of this part on the work order"},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.","readOnly":true},"Status":{"nullable":true,"type":"string","description":"The displayable status of a lineitem. Sales lineitems might say \"sold\". Rental items might say \"reserved\".\n* Reserved\n* Out\n* Off Rent\n* Returned\n* Sold\n","enum":["Reserved","Out","Off Rent","Returned","Sold"],"readOnly":true},"StockId":{"nullable":true,"type":"string","description":"Id of stock"},"Comments":{"type":"string","description":"Any comments for this part."}}},{"type":"string"}]}},"IsCustomerWO":{"type":"boolean","description":"Flag to telling whether the WO is consumer facing or not."},"LaborTracking":{"nullable":true,"type":"object","description":"Labor tracking details.","readOnly":true,"properties":{"LaborTypes":{"nullable":true}}},"Complaint":{"type":"string","description":"The issue detected by the technician."},"Cause":{"type":"string","description":"The cause of the issue, to be updated if needed."},"Correction":{"type":"string","description":"The steps taken to correct the issue."},"ReportedIssue":{"type":"string","description":"The initial reported issue. This could come from anyone. (This is filled from Contract Information in Elite)"},"OtherComments":{"type":"string","description":"Any additional comments for this work order."},"Operation":{"type":"string","description":"The operation that needs to be performed."},"DueDateTime":{"type":"string","format":"date-time","description":"The due date for this work order."},"CreatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was created.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was updated.","format":"date-time","readOnly":true},"Hidden":{"nullable":true,"type":"integer","enum":[null,1],"description":"Hidden"}},"default":{"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","CreatedDateTime":"string","UpdatedDateTime":"string","Hidden":0}},"global_common_remote_work-order-part":{"$id":"global_common_remote_work-order-part","$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderPart","type":"object","properties":{"ModelType":{"type":"string","description":"Standard field that denotes the record type.","readOnly":true},"Id":{"type":"string","description":"The unique identifier for this record.","readOnly":true},"Classification":{"nullable":true,"type":"string","description":"This product is either meant for sale or rental. The internal classification does not apply to lineitems.","enum":["Rental","Sale",null],"readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups."},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"boolean","description":"Indicates if the items should be pulled from stock when added to a work order."},"PurchasePrice":{"nullable":true,"type":"number","description":"The purchase price of the part."},"Quantity":{"nullable":true,"type":"string","description":"The quantity of this part on the work order"},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.","readOnly":true},"Status":{"nullable":true,"type":"string","description":"The displayable status of a lineitem. Sales lineitems might say \"sold\". Rental items might say \"reserved\".\n* Reserved\n* Out\n* Off Rent\n* Returned\n* Sold\n","enum":["Reserved","Out","Off Rent","Returned","Sold"],"readOnly":true},"StockId":{"nullable":true,"type":"string","description":"Id of stock"},"Comments":{"type":"string","description":"Any comments for this part."},"CreatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was created.","format":"date-time","readOnly":true},"UpdatedDateTime":{"nullable":true,"type":"string","description":"UTC when the record was updated.","format":"date-time","readOnly":true},"Hidden":{"nullable":true,"type":"integer","enum":[null,1],"description":"Hidden"}},"default":{"ModelType":"string","Id":"string","Classification":"string","Name":"string","IsBulk":false,"IsSerialized":false,"ProductId":"string","PullFromStock":false,"PurchasePrice":0,"Quantity":"string","SerialNumber":"string","Status":"string","StockId":"string","Comments":"string","CreatedDateTime":"string","UpdatedDateTime":"string","Hidden":0}},"global_common_remote_work-order-part-create":{"$id":"global_common_remote_work-order-part-create","$schema":"http://json-schema.org/draft-07/schema#","title":"WorkOrderPartCreate","type":"object","properties":{"Classification":{"nullable":true,"type":"string","description":"This product is either meant for sale or rental. The internal classification does not apply to lineitems.","enum":["Rental","Sale",null],"readOnly":true},"Name":{"type":"string","description":"The display name for this record. This is often used as a summary for lookups."},"IsBulk":{"nullable":true,"type":"boolean","description":" 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":{"nullable":true,"type":"boolean","description":"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":{"nullable":true,"type":"string","description":"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":{"nullable":true,"type":"boolean","description":"Indicates if the items should be pulled from stock when added to a work order."},"PurchasePrice":{"nullable":true,"type":"number","description":"The purchase price of the part."},"Quantity":{"nullable":true,"type":"string","description":"The quantity of this part on the work order"},"SerialNumber":{"nullable":true,"type":"string","description":"The serial number or unique identifier assigned to this particular Line Item.","readOnly":true},"Status":{"nullable":true,"type":"string","description":"The displayable status of a lineitem. Sales lineitems might say \"sold\". Rental items might say \"reserved\".\n* Reserved\n* Out\n* Off Rent\n* Returned\n* Sold\n","enum":["Reserved","Out","Off Rent","Returned","Sold"],"readOnly":true},"StockId":{"nullable":true,"type":"string","description":"Id of stock"},"Comments":{"type":"string","description":"Any comments for this part."}},"default":{"Classification":"string","Name":"string","IsBulk":false,"IsSerialized":false,"ProductId":"string","PullFromStock":false,"PurchasePrice":0,"Quantity":"string","SerialNumber":"string","Status":"string","StockId":"string","Comments":"string"}}}}},"searchIndex":{"store":["tag/Gaining-Access","tag/Gaining-Access/Future-proofing","tag/Gaining-Access/Max-Request-Size","tag/Filtering","tag/Your-First-API-Call","tag/Paging","tag/Response-Codes","tag/Select-the-Correct-ID-Across-API-Endpoints","tag/Utilize-Elite-Accounting-APIs","tag/Utilize-Elite-Accounting-APIs/Direct-vs.-Custom-Integrations","tag/Utilize-Elite-Accounting-APIs/Modes","tag/Utilize-Elite-Accounting-APIs/Design","tag/Utilize-Elite-Accounting-APIs/Flow","tag/Utilize-Elite-Accounting-APIs/SQL","tag/Utilize-Elite-Accounting-APIs/AR-Payments","tag/Utilize-Elite-Accounting-APIs/Summary","tag/Categories","tag/Categories/operation/GetListofCategories","tag/Categories/operation/GetCategorybyId","tag/Contacts","tag/Contacts/operation/GetListofContacts","tag/Contacts/operation/CreateContact","tag/Contacts/operation/GetContactbyId","tag/Contacts/operation/UpdateContact","tag/Contract-Actions","tag/Contract-Actions/operation/ContractCallOffRent","tag/Contracts","tag/Contracts/operation/ContractsGetAll","tag/Contracts/operation/ContractGetById","tag/Contracts/operation/ContractFilesGetById","tag/Contracts/operation/ContractPaymentBoundaries","tag/Customers","tag/Customers/operation/GetListofCustomers","tag/Customers/operation/CreateCustomer","tag/Customers/operation/GetCustomerbyId","tag/Customers/operation/CustomerPatch","tag/Customers/operation/CustomerLookup","tag/Depots","tag/Depots/operation/DepotGetAll","tag/Depots/operation/DepotGetById","tag/Invoices","tag/Invoices/operation/InvoiceGetAll","tag/Invoices/operation/InvoiceGetById","tag/Invoices/operation/InvoiceFilesGetById","tag/Line-Items","tag/Line-Items/operation/retrieveLineItems","tag/Line-Items/operation/retrieveLineItemById","tag/Line-Item-Actions","tag/Line-Item-Actions/operation/LineItemsCallOffRent","tag/Locations","tag/Locations/operation/CreateLocation","tag/Locations/operation/LocationGetAll","tag/Locations/operation/LocationGetById","tag/Locations/operation/UpdateLocation","tag/Products","tag/Products/operation/ProductAvailabilityGetById","tag/Products/operation/ProductCreate","tag/Products/operation/ProductGetAll","tag/Products/operation/ProductAssociationsGetAll","tag/Products/operation/ProductGetById","tag/Products/operation/ProductUpdate","tag/Products/operation/ProductRatesGetById","tag/Products/operation/ProductFilesGetById","tag/SalesPersons","tag/SalesPersons/operation/GetListofSalesPersons","tag/SalesPersons/operation/GetSalesPersonbyId","tag/Stock","tag/Stock/operation/CreateStock","tag/Stock/operation/StockGetAll","tag/Stock/operation/UpdateStock","tag/Stock/operation/StockGetById","tag/Stock/operation/StockAvailabilityGetById","tag/Stock/operation/StockFilesGetById","tag/Stock/operation/AdjustStockBulk","tag/Stock/operation/GetWorkOrdersByStockId","tag/Vendors","tag/Vendors/operation/CreateVendor","tag/Vendors/operation/VendorGetAll","tag/Vendors/operation/VendorGetById","tag/Vendors/operation/UpdateVendor","tag/Vendors/operation/VendorLookup","tag/Work-Orders","tag/Work-Orders/operation/createWorkOrder","tag/Work-Orders/operation/retrieveWorkOrders","tag/Work-Orders/operation/retrieveWorkOrderById","tag/Work-Orders/operation/updateWorkOrderById","tag/Work-Orders/operation/retrieveWorkOrderParts","tag/Work-Orders/operation/createWorkOrderPart","tag/Work-Orders/operation/OperationLookup","tag/Work-Orders/operation/ConsumerOperationLookup","tag/Accounts-Payable","tag/Accounts-Payable/operation/AccountsPayableInvoicesGet","tag/Accounts-Payable/operation/AccountsPayableInvoicesGetById","tag/Accounts-Payable/operation/AccountsPayableInvoicespatch","tag/Accounts-Receivable","tag/Accounts-Receivable/operation/EliteAccountReceivableInvoiceGetAll","tag/Accounts-Receivable/operation/EliteAccountReceivableInvoiceGetById","tag/Accounts-Receivable/operation/EliteAccountReceivableInvoicePatchById","tag/Accounts-Receivable/operation/EliteAccountReceivablePaymentGetAll","tag/Accounts-Receivable/operation/EliteAccountReceivablePaymentPost","tag/Accounts-Receivable/operation/EliteAccountReceivablePaymentGetById","tag/Journal-Entries","tag/Journal-Entries/operation/JournalEntriesGet","tag/Journal-Entries/operation/JournalEntriesGetById","tag/Journal-Entries/operation/JournalEntriesPost","tag/Call-Logs","tag/Call-Logs/operation/CreateCallLog","tag/Call-Logs/operation/CallLogGetAll","tag/Call-Logs/operation/CallLogGetById","tag/Hire-Rates","tag/Hire-Rates/operation/HireRatesGetAll","tag/Hire-Rates/operation/HireRatesGetbyId","tag/Changelog-by-Release"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,5.183,1,3.868]],["description/0",[1,1.206,2,0.544,3,2.437,4,1.912,5,3.62,6,4.945,7,2.938,8,3.297,9,1.131,10,2.763,11,1.425,12,3.62,13,2.223,14,1.668,15,1.616,16,1.425,17,1.3,18,1.3,19,1.616,20,3.779,21,3.197,22,1.503,23,1.425,24,2.763,25,2.437,26,2.763,27,1.616,28,0.544,29,0.193,30,1.189,31,0.64,32,1.206,33,1.425,34,2.763,35,2.763,36,3.193,37,1.196,38,1.616,39,1.425,40,1.616,41,1.425,42,1.616,43,1.736,44,3.193,45,3.62,46,3.62,47,1.616,48,1.616,49,1.616,50,1.3,51,1.425,52,1.616,53,2.763,54,2.763,55,1.616,56,1.616,57,1.656,58,1.616,59,2.223,60,1.616,61,1.616,62,2.437,63,1.3,64,1.206,65,1.616,66,1.616,67,1.616,68,2.763,69,0.781,70,1.015,71,1.425,72,1.425,73,1.616,74,1.616,75,1.616,76,1.616,77,0.769,78,1.425,79,1.206,80,1.616,81,1.616,82,1.206,83,1.616,84,1.616,85,1.616,86,1.616,87,2.763,88,3.593,89,1.41,90,0.19,91,1.616,92,2.763,93,1.616,94,1.616,95,1.015,96,1.131,97,1.425,98,1.131,99,1.425,100,1.616,101,1.616,102,1.425,103,1.616,104,1.3,105,1.616,106,1.616,107,1.616]],["title/1",[108,6.072]],["description/1",[2,1.887,6,2.708,7,2.973,8,1.929,20,2.708,21,2.292,57,1.841,70,1.929,96,3.921,109,3.071,110,3.071,111,4.096,112,2.292,113,3.071,114,3.071,115,3.071,116,2.47,117,2.708,118,2.918,119,2.377,120,1.37,121,2.47,122,2.47,123,2.708,124,3.071,125,3.071,126,4.644,127,3.921,128,2.292,129,3.071,130,3.071,131,1.216,132,3.071,133,2.47,134,2.708,135,2.918,136,3.071,137,3.466,138,3.071,139,3.071,140,3.071,141,1.062,142,3.071,143,3.071,144,3.071,145,3.071,146,3.071,147,3.071,148,3.071,149,3.071,150,2.149,151,3.071]],["title/2",[152,4.522,153,2.841,154,3.375]],["description/2",[7,3.118,37,2.834,43,3.135,95,4.594,97,4.401,98,3.493,153,3.135,154,3.724,155,4.99,156,1.009,157,4.99,158,4.99,159,4.99,160,4.99,161,4.99,162,4.401,163,4.401,164,4.99,165,4.99,166,2.863]],["title/3",[167,2.991]],["description/3",[7,0.503,22,2.556,28,0.641,29,0.138,31,0.419,37,1.122,43,1.195,70,1.63,71,0.932,72,0.932,90,0.305,102,1.677,116,1.53,119,1.985,120,0.849,128,2.366,133,0.85,134,0.932,137,3.043,141,0.365,150,0.739,167,2.482,168,1.902,169,0.932,170,0.823,171,1.53,172,0.739,173,1.056,174,2.086,175,0.633,176,1.056,177,0.419,178,1.056,179,0.932,180,0.85,181,3.659,182,1.677,183,0.932,184,0.664,185,1.056,186,1.056,187,1.056,188,0.85,189,2.16,190,3.589,191,2.55,192,3.171,193,1.902,194,1.902,195,1.902,196,1.056,197,1.902,198,1.056,199,0.971,200,2.594,201,2.594,202,1.056,203,2.594,204,2.594,205,1.902,206,1.056,207,1.902,208,1.902,209,1.056,210,1.056,211,1.902,212,1.056,213,1.056,214,1.056,215,1.902,216,0.788,217,1.056,218,1.902,219,1.056,220,1.056,221,1.056,222,2.594,223,1.056,224,1.056,225,1.056,226,2.086,227,1.056,228,0.664,229,1.258,230,1.091,231,2.086,232,3.147,233,1.056,234,0.664,235,1.056,236,1.056,237,1.902,238,1.056,239,1.056,240,1.056,241,1.056,242,1.902,243,0.471,244,1.816,245,0.147,246,0.633,247,1.902,248,1.056,249,1.677,250,1.902,251,1.902,252,1.056,253,1.056,254,1.902,255,1.902,256,1.056,257,1.902,258,1.056,259,1.056,260,1.056,261,0.932,262,0.407,263,1.056,264,1.056,265,1.056,266,1.902,267,1.902,268,1.056,269,1.902,270,1.056,271,1.056,272,1.056,273,1.056,274,1.056,275,1.056,276,1.056,277,0.932,278,0.419,279,0.788,280,0.788]],["title/4",[4,2.018,7,2.153,281,3.637]],["description/4",[3,3.087,7,2.438,8,3.217,11,3.087,22,1.598,23,3.087,33,3.087,88,3.821,89,1.787,96,2.45,137,3.821,150,4.237,153,3.804,174,2.815,231,2.815,232,4.896,244,3.584,249,3.087,281,2.815,282,2.008,283,5.12,284,3.5,285,3.5,286,3.5,287,3.217,288,0.917,289,3.5,290,3.5,291,3.5,292,3.5,293,3.5,294,5.12,295,3.087,296,3.5,297,3.5,298,3.5,299,3.5]],["title/5",[300,4.884]],["description/5",[22,2.516,137,4.888,153,3.135,154,3.724,231,4.014,232,3.3,244,3.493,300,5.268,301,3.493,302,4.99,303,4.99,304,4.99,305,4.99,306,4.99,307,4.99,308,4.99,309,4.99,310,4.99]],["title/6",[111,4.572,127,3.628]],["description/6",[1,2.518,22,2.631,127,4.148,153,3.132,175,2.023,262,1.92,278,2.766,288,0.604,311,4.984,312,3.374,313,2.976,314,3.374,315,3.374,316,4.581,317,2.093,318,4.984,319,2.714,320,3.374,321,2.976,322,3.374,323,3.374,324,3.374,325,3.374,326,3.374,327,2.714,328,2.714,329,3.374,330,3.374,331,4.984,332,3.132,333,3.374]],["title/7",[7,1.715,120,1.608,288,0.645,334,2.521,335,3.602]],["description/7",[4,1.224,7,1.713,17,1.289,18,1.289,22,0.856,28,1.212,37,0.693,59,1.289,64,1.196,70,1.007,88,1.196,89,2.444,90,0.188,112,1.196,119,1.212,120,1.605,127,1.121,128,1.196,133,2.206,135,1.007,172,1.92,189,3.573,190,4.696,226,1.289,232,1.814,234,3.863,246,3.13,280,1.196,282,0.919,287,1.007,288,1.303,336,0.96,337,0.96,338,0.96,339,0.96,340,0.96,341,2.064,342,1.602,343,1.602,344,1.289,345,1.413,346,3.757,347,1.121,348,1.602,349,1.06,350,1.814,351,1.289,352,1.602,353,1.602,354,1.196,355,1.602,356,1.602,357,1.602,358,1.602,359,2.743,360,1.602,361,1.602,362,1.602,363,2.743,364,3.597,365,1.51,366,1.4,367,1.602,368,1.602,369,1.602,370,1.413,371,1.057,372,3.172,373,1.602,374,1.602,375,1.602,376,2.743,377,1.602,378,1.602,379,1.602,380,1.007,381,1.602,382,1.602,383,1.602,384,1.602,385,1.602,386,1.289,387,1.602,388,1.289,389,1.413,390,2.743,391,1.602,392,1.602,393,1.602,394,1.602,395,1.602,396,1.602,397,1.602]],["title/8",[7,1.909,29,0.214,69,1.134,398,3.225]],["description/8",[2,1.225,14,1.675,22,1.643,28,1.225,29,0.281,31,1.44,32,2.714,69,1.488,166,2.086,177,1.44,179,3.207,230,2.086,243,1.623,282,2.086,336,2.18,337,2.18,338,2.18,339,2.18,340,2.18,371,1.4,399,2.714,400,3.636,401,2.285,402,3.636,403,3.636,404,2.925,405,3.207,406,2.405,407,3.636,408,3.636,409,3.636,410,3.636,411,3.636,412,3.207,413,3.636,414,3.636,415,3.207,416,2.925,417,3.636,418,2.285,419,1.791,420,1.856,421,2.545,422,2.086,423,3.636,424,2.285,425,2.285,426,2.285,427,2.285]],["title/9",[28,1.351,166,2.301,401,2.52,428,4.01]],["description/9",[2,0.752,7,2.496,8,2.272,22,1.128,25,1.968,28,1.766,29,0.279,32,1.665,36,1.968,37,1.564,69,1.482,90,0.425,95,2.272,98,1.562,99,1.968,112,1.665,120,0.996,121,1.794,162,1.968,166,3.538,175,1.337,226,1.794,232,2.391,243,0.996,244,1.562,262,0.859,278,0.884,282,1.28,336,1.337,337,1.337,338,1.337,339,1.337,340,1.337,341,2.074,345,1.968,350,1.475,371,0.859,380,1.402,399,1.665,401,2.272,415,1.968,421,1.562,424,2.864,425,1.402,426,1.402,427,1.402,429,1.968,430,4.623,431,3.615,432,3.615,433,2.231,434,2.908,435,3.189,436,2.231,437,1.968,438,2.231,439,2.231,440,2.231,441,2.231,442,2.231,443,1.968,444,1.968,445,2.231,446,2.231,447,2.231,448,2.231,449,1.968,450,2.231,451,2.231,452,1.794,453,2.231,454,2.231,455,1.968,456,2.231,457,2.231,458,2.231,459,1.794,460,2.231,461,2.231,462,1.794,463,1.968,464,2.231,465,1.562]],["title/10",[465,4.25]],["description/10",[2,0.809,13,1.405,22,0.545,28,0.589,29,0.128,50,0.773,57,1.77,63,1.931,69,1.768,82,0.718,88,0.718,95,2.152,98,0.673,166,1.002,172,0.673,175,2.702,180,0.773,189,0.925,190,2.409,243,0.78,262,1.137,279,0.718,282,0.552,287,0.604,317,0.733,332,1.855,336,0.576,337,0.576,338,0.576,339,0.576,340,0.576,341,2.587,350,1.155,365,0.53,366,0.491,371,0.673,380,0.604,399,0.718,401,1.098,405,1.541,406,1.155,416,1.405,419,1.454,420,1.507,421,1.68,422,2.406,424,2.833,425,0.604,426,0.604,427,0.604,435,1.541,459,0.773,465,3.155,466,0.718,467,0.962,468,0.718,469,0.848,470,0.962,471,1.588,472,0.848,473,0.962,474,3.425,475,2.4,476,3.552,477,0.962,478,1.541,479,3.425,480,3.021,481,1.889,482,2.117,483,1.931,484,0.962,485,0.962,486,0.962,487,0.962,488,1.588,489,0.848,490,3.364,491,0.962,492,0.962,493,0.962,494,0.962,495,1.747,496,2.862,497,2.4,498,2.4,499,3.382,500,0.962,501,0.848,502,0.962,503,2.4,504,2.4,505,3.382,506,3.382,507,2.4,508,2.4,509,1.747,510,2.4,511,1.747,512,2.4,513,2.952,514,2.4,515,2.299,516,3.929,517,2.4,518,2.4,519,2.4,520,0.962,521,1.747,522,1.747,523,1.747,524,0.962,525,0.962,526,0.962,527,0.962,528,0.673,529,0.673,530,0.962,531,0.962,532,0.773,533,0.848,534,0.848,535,0.962,536,0.962,537,0.962,538,0.962,539,0.636,540,0.962]],["title/11",[541,5.356]],["description/11",[2,0.466,7,2.29,18,1.113,22,1.203,28,0.814,29,0.074,37,0.599,69,1.897,77,0.659,112,1.033,118,0.869,120,1.436,131,2.175,135,1.518,141,1.333,153,2.021,156,0.779,166,1.846,189,2.907,190,3.022,230,1.846,232,1.598,234,1.518,243,1.436,245,0.762,262,0.533,282,0.794,288,0.69,317,1.351,327,1.113,332,2.021,334,0.968,336,0.829,337,0.829,338,0.829,339,0.829,340,0.829,341,1.386,371,0.533,398,3.101,401,1.518,418,2.422,419,1.19,421,0.968,425,0.869,426,0.869,427,0.869,430,1.22,462,1.113,463,1.22,465,1.691,466,1.033,471,1.598,476,2.422,488,2.127,490,4.096,496,3.589,515,2.883,529,0.968,539,0.915,541,1.22,542,1.384,543,1.384,544,1.384,545,1.384,546,1.384,547,0.968,548,1.384,549,1.384,550,1.384,551,1.22,552,1.384,553,5.489,554,3.855,555,2.416,556,3.216,557,1.384,558,3.022,559,1.384,560,2.416,561,1.384,562,1.384,563,1.384,564,2.416,565,1.384,566,1.384,567,1.384,568,1.384,569,3.216,570,1.384,571,1.22]],["title/12",[572,4.532]],["description/12",[7,1.917,22,1.767,29,0.215,69,1.601,82,3.005,95,2.53,131,1.595,166,2.31,243,1.797,282,2.31,336,2.413,337,2.413,338,2.413,339,2.413,340,2.413,341,2.31,401,2.53,420,2.055,424,2.53,425,2.53,426,2.53,427,2.53,434,3.238,466,3.005,483,3.238,506,3.551,528,2.818,529,2.818,572,3.005,573,4.026,574,4.026,575,4.026,576,3.551,577,5.66,578,4.026,579,4.026,580,4.026,581,4.026,582,4.026]],["title/13",[583,5.356]],["description/13",[1,1.216,22,2.119,29,0.087,39,1.438,64,2.078,69,1.03,95,2.707,116,2.239,135,1.024,175,0.977,189,2.282,243,1.242,244,1.141,282,0.935,317,0.684,327,1.311,328,1.311,334,1.949,336,0.977,337,0.977,338,3.375,339,0.977,340,0.977,341,3.682,349,1.078,365,0.898,366,0.832,372,1.438,386,1.311,416,1.311,419,0.803,424,1.024,425,1.024,426,1.024,427,1.024,468,2.078,471,2.41,476,1.024,481,0.803,482,1.438,488,2.41,490,3.216,496,3.216,528,1.141,572,1.216,583,3.214,584,1.63,585,3.941,586,1.63,587,1.311,588,1.311,589,2.455,590,1.141,591,1.63,592,1.438,593,1.141,594,1.63,595,4.839,596,1.216,597,2.784,598,1.438,599,1.141,600,1.63,601,1.63,602,1.63,603,1.63,604,1.63,605,3.214,606,2.784,607,2.784,608,1.63,609,1.63,610,1.63,611,1.63,612,1.438,613,1.63,614,1.63,615,1.63,616,1.63,617,4.309,618,3.643,619,1.63,620,3.643,621,3.643,622,1.63,623,2.784,624,1.63,625,1.63,626,1.63,627,1.63,628,1.63,629,1.63,630,2.455,631,1.63,632,1.63,633,1.63,634,1.63,635,1.63,636,1.63,637,1.438,638,1.63]],["title/14",[420,2.646,529,3.628]],["description/14",[8,1.273,22,1.043,28,0.683,29,0.178,37,0.877,50,1.63,63,3.98,69,1.762,77,0.965,82,2.494,104,1.63,119,0.683,131,0.803,163,1.787,189,1.77,190,4.093,243,0.904,282,1.162,288,0.363,336,1.215,337,1.215,338,1.215,339,1.215,340,1.215,341,1.917,354,1.512,371,2.108,398,1.63,420,2.525,424,3.702,425,1.273,426,1.273,427,1.273,465,1.418,466,1.512,481,1.646,483,1.63,488,2.21,490,2.494,496,4.085,499,3.761,516,1.512,528,3.463,529,4.124,533,1.787,534,1.787,571,1.787,572,1.512,576,1.787,630,1.787,637,1.787,639,2.026,640,2.026,641,2.026,642,2.026,643,3.341,644,2.026,645,2.026,646,2.026,647,2.026,648,2.026,649,1.787,650,2.026,651,2.026,652,4.264,653,1.162,654,2.026,655,2.026,656,2.026,657,4.948,658,4.264,659,1.63,660,1.512,661,2.026,662,2.026,663,1.787]],["title/15",[480,5.356]],["description/15",[7,2.026,8,2.673,28,1.982,29,0.227,37,1.841,77,2.026,90,0.5,95,2.673,121,3.422,166,4.173,277,3.752,341,3.375,388,3.422,399,3.175,401,2.673,429,3.752,443,5.188,444,3.752,449,3.752,462,3.422,664,3.752,665,4.254,666,4.254,667,4.254,668,4.254,669,4.254,670,4.254,671,4.254,672,4.254,673,3.175,674,3.752]],["title/16",[675,4.016]],["description/16",[14,2.891,29,0.249,31,1.854,37,2.716,167,2.305,184,2.94,287,2.94,380,2.94,471,4.151,676,2.805,677,2.805,678,3.275,679,4.679,680,3.763,681,4.679,682,3.492,683,4.679,684,4.679,685,4.679,686,4.679,687,4.127,688,4.679,689,4.679,690,4.127,691,3.275,692,4.679]],["title/17",[141,1.564,245,0.628,675,2.991]],["description/17",[29,0.312,30,1.919,31,2.316,90,0.852,167,2.879,170,2.529,199,2.983,243,2.609,675,3.866,693,3.219,694,3.504,695,5.845]],["title/18",[156,0.811,245,0.556,288,0.718,675,2.652]],["description/18",[29,0.327,30,2.013,31,2.429,90,0.721,156,1.239,228,3.853,245,0.851,288,1.098,675,4.055,696,6.131]],["title/19",[89,3.099]],["description/19",[8,1.454,14,1.066,28,2.31,29,0.123,31,0.916,37,1.611,57,1.387,64,1.726,69,0.654,79,2.778,89,3.499,118,1.454,177,1.475,184,1.454,188,1.861,189,1.972,216,1.726,278,2.803,279,3.996,301,1.619,351,1.861,380,1.454,386,1.861,419,1.14,459,1.861,471,3.541,472,2.04,547,2.606,596,1.726,598,2.04,653,1.327,664,2.04,674,2.04,676,1.387,677,1.387,678,1.619,697,2.313,698,2.04,699,2.313,700,3.27,701,3.723,702,4.722,703,2.313,704,2.313,705,2.313,706,3.486,707,1.861,708,1.274,709,2.313,710,2.313,711,2.313,712,2.04,713,2.04,714,3.723,715,3.723,716,1.387,717,2.313,718,2.313,719,2.04,720,2.313,721,2.313,722,3.723,723,2.313,724,2.313,725,2.313,726,2.313,727,2.313]],["title/20",[89,2.308,141,1.564,245,0.628]],["description/20",[29,0.312,30,1.919,31,2.316,89,2.983,90,0.852,167,2.879,170,2.529,199,2.983,243,2.609,693,3.219,694,3.504,728,5.155]],["title/21",[89,2.308,262,1.742,729,2.308]],["description/21",[22,2.329,29,0.398,77,2.919,90,0.721,119,2.066,246,3.676,728,5.408,730,6.131]],["title/22",[89,2.047,156,0.811,245,0.556,288,0.718]],["description/22",[29,0.332,30,2.047,31,2.469,89,3.181,90,0.733,156,1.26,245,0.865,288,1.116,731,5.498]],["title/23",[89,2.047,156,0.811,288,0.718,317,1.684]],["description/23",[22,2.013,29,0.344,77,3.07,90,0.758,119,2.172,288,1.154,731,5.687]],["title/24",[481,2.554,732,4.169]],["description/24",[]],["title/25",[4,2.018,481,2.228,700,3.165]],["description/25",[29,0.369,90,0.814,733,6.923]],["title/26",[481,2.991]],["description/26",[]],["title/27",[141,1.564,245,0.628,481,2.228]],["description/27",[29,0.362,30,2.232,90,0.8,734,6.798]],["title/28",[156,0.811,245,0.556,288,0.718,481,1.975]],["description/28",[29,0.362,30,2.232,90,0.8,735,6.798]],["title/29",[156,0.728,245,0.5,288,0.645,481,1.774,736,2.688]],["description/29",[29,0.369,90,0.814,737,6.923]],["title/30",[420,2.646,738,5.183]],["description/30",[739,7.189]],["title/31",[28,2.046]],["description/31",[28,2.161,29,0.173,30,0.641,31,1.646,59,1.57,69,1.175,79,3.1,96,1.367,104,1.57,118,1.227,119,1.807,120,0.871,150,2.268,170,2.504,171,1.57,175,1.17,188,1.57,189,1.716,199,0.996,216,1.457,246,2.899,262,1.248,278,2.292,279,2.418,281,1.57,287,1.227,301,1.367,344,1.57,350,1.291,437,2.858,452,1.57,455,1.722,468,1.457,469,3.664,471,1.291,547,2.908,587,3.341,596,2.418,649,1.722,676,1.17,677,1.17,678,1.367,698,1.722,706,3.1,707,1.57,712,1.722,713,2.858,716,1.17,719,1.722,729,2.468,740,1.722,741,1.952,742,1.952,743,2.606,744,1.952,745,1.952,746,3.24,747,3.24,748,1.952,749,1.722,750,1.952,751,1.722,752,3.24,753,1.952,754,1.952,755,1.57,756,1.952,757,1.952,758,1.952,759,1.952,760,1.952,761,1.952,762,1.952,763,1.952,764,1.722,765,1.952,766,1.952,767,3.24,768,3.24,769,2.418,770,1.952,771,1.952,772,1.952,773,1.952,774,1.952]],["title/32",[28,1.523,141,1.564,245,0.628]],["description/32",[28,1.969,29,0.312,30,1.919,31,2.316,90,0.852,167,2.879,170,2.529,199,2.983,243,2.609,693,3.219,694,3.504,775,5.155]],["title/33",[28,1.523,262,1.742,729,2.308]],["description/33",[22,2.606,29,0.298,77,2.659,90,0.657,119,1.881,246,3.347,452,4.491,775,4.925,776,5.584,777,5.584,778,5.584,779,5.584]],["title/34",[28,1.351,156,0.811,245,0.556,288,0.718]],["description/34",[28,2.066,29,0.327,30,2.013,31,2.429,90,0.721,156,1.239,228,3.853,245,0.851,288,1.098,780,5.408]],["title/35",[28,1.351,156,0.811,288,0.718,317,1.684]],["description/35",[22,2.013,29,0.344,77,3.07,90,0.758,119,2.172,288,1.154,780,5.687]],["title/36",[28,1.523,708,2.49,781,2.711]],["description/36",[22,2.345,28,1.371,29,0.304,43,2.557,57,2.44,90,0.774,119,2.531,120,1.816,141,1.407,172,2.849,229,3.772,234,2.557,243,1.816,245,0.565,406,3.772,694,2.44,708,3.626,781,2.44,782,2.849,783,3.273,784,4.07,785,4.07,786,4.07,787,4.07,788,4.07,789,4.07]],["title/37",[790,3.816]],["description/37",[4,1.723,29,0.206,31,2.177,37,1.67,120,1.723,170,1.67,184,2.426,189,2.91,346,3.405,481,1.902,587,3.105,653,2.215,676,2.314,677,2.314,678,2.702,687,3.405,706,4.774,716,2.314,790,4.379,791,3.86,792,3.86,793,2.426,794,3.86,795,3.86,796,3.105,797,3.405,798,3.86,799,3.405,800,5.494,801,3.405,802,3.86,803,3.86,804,3.86,805,3.86,806,3.86,807,3.86,808,3.86,809,3.86]],["title/38",[141,1.564,245,0.628,790,2.841]],["description/38",[29,0.312,30,1.919,31,2.316,90,0.852,167,2.879,170,2.529,199,2.983,243,2.609,693,3.219,694,3.504,790,3.673,810,5.845]],["title/39",[156,0.811,245,0.556,288,0.718,790,2.52]],["description/39",[29,0.327,30,2.013,31,2.429,90,0.721,156,1.239,228,3.853,245,0.851,288,1.098,790,3.853,811,6.131]],["title/40",[371,2.339]],["description/40",[]],["title/41",[141,1.564,245,0.628,371,1.742]],["description/41",[812,7.189]],["title/42",[156,0.811,245,0.556,288,0.718,371,1.544]],["description/42",[813,7.189]],["title/43",[156,0.728,245,0.5,288,0.645,371,1.387,736,2.688]],["description/43",[29,0.369,90,0.814,814,6.923]],["title/44",[365,2.854,366,2.646]],["description/44",[]],["title/45",[141,1.386,245,0.556,365,2.208,366,2.047]],["description/45",[815,7.189]],["title/46",[156,0.728,245,0.5,288,0.645,365,1.983,366,1.838]],["description/46",[816,7.189]],["title/47",[365,2.49,366,2.308,732,3.637]],["description/47",[]],["title/48",[4,1.79,365,2.208,366,2.047,700,2.807]],["description/48",[29,0.369,90,0.814,817,6.923]],["title/49",[793,3.816]],["description/49",[]],["title/50",[262,1.742,729,2.308,793,2.841]],["description/50",[22,2.013,29,0.344,77,3.07,90,0.758,119,2.172,246,3.865,818,5.687]],["title/51",[141,1.564,245,0.628,793,2.841]],["description/51",[29,0.362,30,2.232,90,0.8,818,5.996]],["title/52",[156,0.811,245,0.556,288,0.718,793,2.52]],["description/52",[29,0.362,30,2.232,90,0.8,819,5.996]],["title/53",[156,0.811,288,0.718,317,1.684,793,2.52]],["description/53",[22,2.013,29,0.344,77,3.07,90,0.758,119,2.172,288,1.154,819,5.687]],["title/54",[14,2.798]],["description/54",[]],["title/55",[14,1.66,156,0.728,245,0.5,288,0.645,539,2.382]],["description/55",[29,0.362,30,2.232,90,0.8,820,6.798]],["title/56",[14,2.388,262,1.997]],["description/56",[821,6.341]],["title/57",[14,2.083,141,1.564,245,0.628]],["description/57",[29,0.362,30,2.232,90,0.8,821,5.996]],["title/58",[14,1.66,141,1.245,245,0.5,350,2.382,653,2.067]],["description/58",[29,0.369,90,0.814,822,6.923]],["title/59",[14,1.847,156,0.811,245,0.556,288,0.718]],["description/59",[29,0.362,30,2.232,90,0.8,823,5.996]],["title/60",[14,2.388,317,2.176]],["description/60",[823,6.341]],["title/61",[14,1.66,156,0.728,245,0.5,288,0.645,824,2.263]],["description/61",[29,0.362,30,2.232,90,0.8,825,6.798]],["title/62",[14,1.66,156,0.728,245,0.5,288,0.645,736,2.688]],["description/62",[29,0.369,90,0.814,826,6.923]],["title/63",[827,3.816]],["description/63",[22,1.537,29,0.262,62,4.343,70,3.094,278,2.572,341,3.725,424,3.094,676,2.952,677,2.952,782,3.447,827,4.565,828,4.343,829,4.343,830,4.924,831,4.343,832,4.924,833,4.924,834,4.924,835,4.924,836,4.924,837,4.924]],["title/64",[141,1.564,245,0.628,827,2.841]],["description/64",[29,0.316,31,2.352,90,0.86,167,2.925,170,2.569,199,3.03,243,2.65,693,3.269,694,3.559,827,3.731,838,5.937]],["title/65",[156,0.811,245,0.556,288,0.718,827,2.52]],["description/65",[29,0.338,31,2.511,90,0.746,156,1.281,245,0.88,288,1.135,827,3.983,839,6.338]],["title/66",[840,2.891]],["description/66",[]],["title/67",[262,1.387,278,1.427,729,1.838,840,1.715,841,2.897]],["description/67",[22,2.501,29,0.289,77,2.582,90,0.813,98,3.796,119,1.827,246,3.251,516,4.047,840,2.582,841,4.362,842,5.422,843,5.422,844,5.422,845,4.783]],["title/68",[141,1.386,245,0.556,278,1.589,840,1.909]],["description/68",[29,0.362,30,2.232,90,0.8,845,5.996]],["title/69",[278,1.589,317,1.684,332,2.52,840,1.909]],["description/69",[29,0.369,90,0.814,846,5.569]],["title/70",[156,0.728,245,0.5,278,1.427,288,0.645,840,1.715]],["description/70",[29,0.362,30,2.232,90,0.8,846,5.468]],["title/71",[156,0.605,245,0.415,278,1.186,288,0.536,539,1.98,840,1.425,847,2.993]],["description/71",[29,0.362,30,2.232,90,0.8,848,6.798]],["title/72",[156,0.728,245,0.5,288,0.645,736,2.688,840,1.715]],["description/72",[29,0.369,90,0.814,849,6.923]],["title/73",[156,0.728,278,1.427,840,1.715,850,3.602,851,3.177]],["description/73",[29,0.293,90,0.647,120,2.456,174,4.425,278,2.18,840,2.62,846,4.425,851,4.853,852,4.853,853,5.502,854,6.976,855,5.611,856,5.502,857,4.853,858,5.502]],["title/74",[2,1.101,177,1.295,245,0.454,278,1.295,288,0.585,840,1.557]],["description/74",[2,2.21,177,2.599,366,3.348,840,3.124,859,6.56,860,5.786]],["title/75",[422,3.484]],["description/75",[]],["title/76",[262,1.742,422,2.594,729,2.308]],["description/76",[22,2.013,29,0.344,77,3.07,90,0.758,119,2.172,246,3.865,861,5.687]],["title/77",[141,1.564,245,0.628,422,2.594]],["description/77",[29,0.362,30,2.232,90,0.8,861,5.996]],["title/78",[156,0.811,245,0.556,288,0.718,422,2.301]],["description/78",[29,0.362,30,2.232,90,0.8,862,5.996]],["title/79",[156,0.811,288,0.718,317,1.684,422,2.301]],["description/79",[22,2.013,29,0.344,77,3.07,90,0.758,119,2.172,288,1.154,862,5.687]],["title/80",[422,2.594,708,2.49,781,2.711]],["description/80",[29,0.293,44,4.853,90,0.82,119,2.35,120,2.456,229,3.639,261,4.853,406,3.639,422,3.157,694,3.298,708,3.03,781,3.298,783,4.425,863,5.502,864,5.502]],["title/81",[2,1.746,177,2.054]],["description/81",[2,1.856,4,0.622,21,1.04,28,1.305,29,0.074,37,0.603,43,1.528,51,2.145,79,1.04,96,0.976,119,0.819,120,1.444,123,1.229,150,3.381,156,0.492,169,1.229,170,1.4,172,0.976,177,2.059,183,1.229,189,3.187,190,2.763,199,0.711,216,1.04,278,0.552,280,3.605,287,2.435,300,1.121,354,1.04,365,1.781,366,2.95,370,2.853,404,1.956,468,1.04,481,0.687,528,0.976,532,1.121,539,2.14,547,0.976,551,2.853,588,1.121,653,0.8,659,1.121,676,0.836,677,0.836,680,2.602,691,0.976,700,0.976,702,1.229,706,1.815,707,1.121,740,1.229,743,1.121,751,2.145,797,1.229,801,2.853,828,1.229,829,1.229,831,2.145,840,1.845,841,1.956,865,5.509,866,5.509,867,1.394,868,1.394,869,1.394,870,2.432,871,4.396,872,1.394,873,1.394,874,1.394,875,1.394,876,0.922,877,2.432,878,1.394,879,1.394,880,2.432,881,1.394,882,1.394,883,1.394,884,1.394,885,1.394,886,1.394,887,1.394,888,3.235,889,1.394,890,3.235,891,1.394,892,1.394,893,1.394,894,1.394,895,1.394,896,1.394,897,1.394,898,1.394,899,1.394,900,1.394,901,1.394,902,1.394,903,1.394,904,1.394,905,1.394,906,1.394,907,1.394,908,1.394,909,1.394,910,1.394,911,1.394,912,1.394,913,2.432,914,1.394,915,1.394,916,1.394,917,1.394]],["title/82",[2,1.523,177,1.791,262,1.742]],["description/82",[2,1.91,29,0.302,90,0.667,135,3.562,170,2.453,177,2.246,184,3.562,262,2.183,319,4.559,673,4.23,729,2.893,755,4.559,918,5,919,5,920,5]],["title/83",[2,1.351,141,1.386,177,1.589,245,0.556]],["description/83",[2,1.969,29,0.312,31,2.316,90,0.852,167,2.879,170,2.529,177,2.316,199,2.983,243,2.609,693,3.219,694,3.504,920,5.155]],["title/84",[2,1.213,156,0.728,177,1.427,245,0.5,288,0.645]],["description/84",[2,2.066,29,0.327,31,2.429,90,0.721,156,1.239,177,2.429,228,3.853,245,0.851,288,1.098,921,5.408]],["title/85",[2,1.213,156,0.728,177,1.427,288,0.645,317,1.512]],["description/85",[16,5.237,29,0.316,90,0.86,119,2,170,2.569,243,2.65,313,5.237,317,2.493,547,4.156,673,4.431,921,5.237]],["title/86",[2,1.213,141,1.245,177,1.427,245,0.5,876,2.382]],["description/86",[29,0.332,90,0.733,170,2.697,199,3.181,653,3.576,693,3.432,876,4.123,922,6.233,923,5.498]],["title/87",[2,1.351,177,1.589,262,1.544,876,2.652]],["description/87",[2,1.854,29,0.293,90,0.647,135,3.457,170,2.381,177,2.18,184,3.457,262,2.119,319,4.425,653,3.157,673,4.106,729,2.808,755,4.425,876,3.639,918,4.853,919,4.853,923,4.853]],["title/88",[347,3.165,708,2.49,781,2.711]],["description/88",[2,1.798,28,1.798,29,0.285,37,1.604,43,2.33,57,2.223,70,2.33,90,0.436,119,1.249,120,1.655,175,2.223,177,2.478,229,4.526,234,2.33,245,0.868,347,4.378,380,2.33,406,2.452,653,3.063,691,3.737,708,3.444,781,2.223,782,2.595,924,3.27,925,3.27,926,3.27,927,3.27,928,3.27,929,3.27,930,3.27,931,3.27,932,3.27,933,3.27,934,3.708]],["title/89",[347,2.807,691,2.807,708,2.208,781,2.404]],["description/89",[2,1.811,28,1.811,29,0.287,37,1.62,43,2.353,57,2.245,70,2.353,90,0.44,119,1.262,120,1.671,175,2.245,177,2.492,229,4.546,234,2.353,245,0.873,347,4.403,380,2.353,406,2.477,653,3.085,691,2.621,708,3.464,781,2.245,782,2.621,924,3.303,925,3.303,926,3.303,927,3.303,928,3.303,929,3.303,930,3.303,931,3.303,932,3.303,933,3.303,935,3.745]],["title/90",[69,1.466,515,3.107]],["description/90",[]],["title/91",[69,1.019,141,1.245,245,0.5,371,1.387,515,2.159]],["description/91",[2,1.287,9,2.675,22,1.703,29,0.291,69,1.962,90,0.449,118,2.401,119,1.287,131,1.514,141,1.886,167,1.882,191,3.073,245,0.53,316,2.675,349,2.527,371,2.45,419,1.882,476,2.401,515,3.813,585,2.675,590,2.675,593,2.675,599,3.818,660,2.852,716,2.291,769,2.852,936,5.611,937,4.387,938,3.37,939,2.852,940,2.852,941,2.852,942,3.821]],["title/92",[69,1.019,156,0.728,245,0.5,371,1.387,515,2.159]],["description/92",[9,3.119,22,1.895,29,0.324,69,2.098,90,0.524,119,1.501,156,0.901,245,0.618,288,0.798,316,3.119,349,2.947,371,2.339,419,2.195,476,2.8,515,3.64,585,3.119,590,3.119,593,3.119,599,4.251,682,3.326,716,2.671,939,3.326,940,3.326,941,3.326,943,3.931]],["title/93",[69,1.019,317,1.512,332,2.263,371,1.387,515,2.159]],["description/93",[29,0.369,90,0.814,943,6.107]],["title/94",[69,1.466,131,2.054]],["description/94",[]],["title/95",[29,0.214,69,1.134,131,1.589,371,1.544]],["description/95",[29,0.332,37,2.697,69,1.763,131,2.469,167,3.071,371,2.401,944,5.498,945,5.498,946,6.233]],["title/96",[29,0.192,69,1.019,131,1.427,288,0.645,371,1.387]],["description/96",[29,0.344,69,1.823,131,2.554,156,1.303,288,1.154,371,2.483,947,5.687]],["title/97",[29,0.192,69,1.019,131,1.427,317,1.512,371,1.387]],["description/97",[29,0.344,69,1.823,131,2.554,156,1.303,317,2.707,371,2.483,947,5.687]],["title/98",[29,0.214,69,1.134,131,1.589,420,2.047]],["description/98",[29,0.332,37,2.697,69,1.763,131,2.469,167,3.071,420,3.181,944,5.498,945,5.498,948,5.498]],["title/99",[29,0.192,69,1.019,131,1.427,262,1.387,420,1.838]],["description/99",[29,0.344,69,1.823,131,2.554,156,1.303,262,2.483,420,3.291,948,5.687]],["title/100",[29,0.192,69,1.019,131,1.427,288,0.645,420,1.838]],["description/100",[29,0.344,69,1.823,131,2.554,156,1.303,288,1.154,420,3.291,949,6.447]],["title/101",[419,2.554,558,3.257]],["description/101",[]],["title/102",[141,1.13,230,1.876,245,0.454,418,2.054,419,1.611,558,2.054]],["description/102",[2,1.274,9,2.648,22,1.69,29,0.289,69,1.789,90,0.445,118,2.377,119,1.274,131,1.499,141,1.872,167,1.863,191,3.042,230,2.17,245,0.525,316,2.648,349,2.502,418,2.377,419,3.402,476,2.377,558,3.975,585,2.648,590,2.648,593,2.648,599,3.791,660,2.823,716,2.267,769,2.823,936,5.579,937,4.356,938,3.336,939,2.823,940,2.823,941,2.823,950,3.782]],["title/103",[156,0.661,230,1.876,245,0.454,418,2.054,419,1.611,558,2.054]],["description/103",[9,3.083,22,1.88,29,0.321,69,1.941,90,0.518,119,1.484,156,0.89,230,2.527,245,0.611,288,0.789,316,3.083,349,2.913,418,2.767,419,3.382,476,2.767,558,3.785,585,3.083,590,3.083,593,3.083,599,4.217,682,3.287,716,2.64,939,3.287,940,3.287,941,3.287,951,3.885]],["title/104",[230,1.876,317,1.373,332,2.054,418,2.054,419,1.611,558,2.054]],["description/104",[29,0.369,90,0.814,951,6.107]],["title/105",[4,2.313,952,2.974]],["description/105",[2,1.328,4,3.313,28,1.328,78,3.477,180,3.17,230,3.199,262,2.148,278,1.562,301,2.759,334,2.759,366,2.012,421,2.759,434,3.17,481,1.942,532,3.17,589,3.477,592,3.477,676,2.363,677,2.363,729,2.846,799,3.477,852,3.477,855,3.17,952,3.199,953,3.941,954,3.941,955,3.941,956,3.941,957,3.941,958,3.941,959,3.941,960,3.941,961,3.941,962,3.941,963,3.941,964,3.941]],["title/106",[4,1.79,262,1.544,729,2.047,952,2.301]],["description/106",[4,2.829,29,0.338,90,0.746,262,2.441,278,2.511,729,3.235,952,3.637,965,5.591]],["title/107",[4,1.79,141,1.386,245,0.556,952,2.301]],["description/107",[4,2.782,29,0.332,90,0.733,170,2.697,199,3.181,690,5.498,693,3.432,952,3.576,965,5.498]],["title/108",[4,1.608,156,0.728,245,0.5,288,0.645,952,2.067]],["description/108",[4,3.265,29,0.316,90,0.698,156,1.2,228,3.731,245,0.824,278,2.352,288,1.063,952,4.198,966,5.937]],["title/109",[824,3.257,967,3.628]],["description/109",[13,2.869,14,1.643,21,3.874,30,1.704,37,2.246,119,1.202,120,1.592,171,2.869,182,3.146,278,1.413,287,2.241,317,1.498,350,2.359,351,2.869,404,2.869,412,3.146,478,3.146,488,2.359,505,3.146,588,2.869,676,2.138,677,2.138,678,2.497,716,3.111,764,3.146,782,3.633,796,2.869,824,3.845,967,3.633,968,3.567,969,3.567,970,3.567,971,3.567,972,3.567,973,3.567,974,3.567,975,3.567,976,5.19,977,3.567,978,5.19,979,3.567,980,3.567,981,3.567,982,3.146]],["title/110",[141,1.386,245,0.556,824,2.52,967,2.807]],["description/110",[30,2.047,90,0.733,170,2.697,199,3.181,693,3.432,796,5.014,983,5.498,984,6.233,985,6.233]],["title/111",[156,0.728,245,0.5,288,0.645,824,2.263,967,2.521]],["description/111",[30,1.981,90,0.71,156,1.22,228,4.642,245,0.837,278,2.39,824,3.791,967,4.223,986,6.033,987,6.033]],["title/112",[122,4.169,988,4.572]],["description/112",[2,0.223,4,1.819,7,0.316,14,1.508,17,1.404,22,0.387,28,0.994,29,0.138,30,0.407,31,0.263,32,0.495,41,0.585,57,0.743,69,0.35,77,0.831,89,0.338,90,0.146,117,0.585,118,0.779,119,1.923,120,2.77,122,0.533,127,3.009,128,0.495,131,0.263,135,0.416,153,2.831,154,0.495,166,0.38,170,0.287,177,0.491,184,0.779,189,3.24,190,4.978,229,0.438,234,2.408,245,0.092,280,0.925,288,0.312,295,0.585,301,0.867,317,1.374,321,0.585,328,0.533,332,0.416,334,0.464,344,0.533,354,3.504,365,1.427,366,1.323,388,1.404,389,0.585,481,2.118,488,0.438,489,0.585,501,0.585,516,2.202,539,0.82,596,0.495,605,1.093,612,0.585,659,0.533,660,0.495,663,1.093,675,0.438,680,0.533,682,0.495,693,0.365,700,1.814,708,0.365,729,0.891,732,0.997,743,1.404,749,0.585,769,1.303,783,0.997,790,0.416,793,0.416,824,0.416,827,0.416,840,1.405,855,0.533,857,1.934,860,0.585,876,0.438,937,0.533,952,0.38,982,1.539,983,0.585,988,0.585,989,0.663,990,0.663,991,0.663,992,0.663,993,1.239,994,0.663,995,0.663,996,0.663,997,0.663,998,2.592,999,0.663,1000,0.663,1001,0.663,1002,0.663,1003,0.663,1004,2.193,1005,1.239,1006,0.663,1007,1.239,1008,1.239,1009,0.663,1010,0.663,1011,0.663,1012,0.663,1013,6.024,1014,0.663,1015,0.663,1016,0.663,1017,0.663,1018,1.745,1019,0.663,1020,0.663,1021,2.193,1022,0.663,1023,1.239,1024,1.239,1025,1.239,1026,1.745,1027,0.663,1028,0.663,1029,0.663,1030,0.663,1031,0.663,1032,0.663,1033,0.663,1034,0.663,1035,0.663,1036,0.663,1037,0.663,1038,0.663,1039,0.663,1040,0.663,1041,0.663,1042,0.663,1043,0.663,1044,0.663,1045,0.663,1046,0.663,1047,1.239,1048,0.663,1049,0.663,1050,0.663,1051,0.663,1052,0.663,1053,0.663,1054,0.663,1055,0.663,1056,0.663,1057,1.239,1058,1.239,1059,0.663,1060,1.239,1061,1.239,1062,1.239,1063,0.663,1064,0.663,1065,1.239,1066,1.239,1067,0.663,1068,0.663,1069,0.663,1070,0.663,1071,0.663,1072,0.663,1073,0.663,1074,1.239,1075,0.663,1076,0.663,1077,0.663,1078,0.663,1079,0.663,1080,0.663,1081,0.663,1082,0.663,1083,0.663,1084,0.663,1085,0.663,1086,0.663,1087,0.663,1088,0.663,1089,0.663,1090,0.663,1091,0.663,1092,0.663,1093,0.663]]],"invertedIndex":[["",{"_index":22,"title":{},"description":{"0":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"21":{},"23":{},"33":{},"35":{},"36":{},"50":{},"53":{},"63":{},"67":{},"76":{},"79":{},"91":{},"92":{},"102":{},"103":{},"112":{}}}],["0",{"_index":1020,"title":{},"description":{"112":{}}}],["1",{"_index":23,"title":{},"description":{"0":{},"4":{}}}],["1,.for",{"_index":575,"title":{},"description":{"12":{}}}],["both",{"_index":743,"title":{},"description":{"31":{},"81":{},"112":{}}}],["boundari",{"_index":738,"title":{"30":{}},"description":{}}],["br",{"_index":232,"title":{},"description":{"3":{},"4":{},"5":{},"7":{},"9":{},"11":{}}}],["break",{"_index":115,"title":{},"description":{"1":{}}}],["bucket",{"_index":681,"title":{},"description":{"16":{}}}],["build",{"_index":462,"title":{},"description":{"9":{},"11":{},"15":{}}}],["built",{"_index":433,"title":{},"description":{"9":{}}}],["bulk",{"_index":851,"title":{"73":{}},"description":{"73":{}}}],["busi",{"_index":452,"title":{},"description":{"9":{},"31":{},"33":{}}}],["by:and/orbusinesscustomer.recordtypecustomers.recordtypeindividualindividuals**not",{"_index":538,"title":{},"description":{"10":{}}}],["em>*not",{"_index":536,"title":{},"description":{"10":{}}}],["em>on",{"_index":683,"title":{},"description":{"16":{}}}],["email",{"_index":71,"title":{},"description":{"0":{},"3":{}}}],["emails.email',changelogfilter",{"_index":225,"title":{},"description":{"3":{}}}],["h2>support",{"_index":185,"title":{},"description":{"3":{}}}],["h3>2023.12.012023.14.012024.06.002024.07.022024.08.002024.11.002024.12.002024.13.002024.14.002024.15.002024.17.002025.02.00addit",{"_index":382,"title":{},"description":{"7":{}}}],["h3>exampl",{"_index":584,"title":{},"description":{"13":{}}}],["h3>how",{"_index":466,"title":{},"description":{"10":{},"11":{},"12":{},"14":{}}}],["h3>id",{"_index":352,"title":{},"description":{"7":{}}}],["handl",{"_index":435,"title":{},"description":{"9":{},"10":{}}}],["happen",{"_index":121,"title":{},"description":{"1":{},"9":{},"15":{}}}],["happi",{"_index":106,"title":{},"description":{"0":{}}}],["head",{"_index":427,"title":{},"description":{"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{}}}],["header",{"_index":295,"title":{},"description":{"4":{},"112":{}}}],["help",{"_index":461,"title":{},"description":{"9":{}}}],["here",{"_index":174,"title":{},"description":{"3":{},"4":{},"73":{}}}],["here>",{"_index":299,"title":{},"description":{"4":{}}}],["here’",{"_index":357,"title":{},"description":{"7":{}}}],["hire",{"_index":967,"title":{"109":{},"110":{},"111":{}},"description":{"109":{},"111":{}}}],["hirer",{"_index":983,"title":{},"description":{"110":{},"112":{}}}],["hirerateid",{"_index":986,"title":{},"description":{"111":{}}}],["hit",{"_index":284,"title":{},"description":{"4":{}}}],["hourli",{"_index":972,"title":{},"description":{"109":{}}}],["href=\"http://por.force.com/essentialskb/s/article/adding-a-new-custom",{"_index":762,"title":{},"description":{"31":{}}}],["href=\"http://por.force.com/essentialskb/s/article/essentials-customer-contacts-video",{"_index":718,"title":{},"description":{"19":{}}}],["href=\"http://por.force.com/syrinxkb/s/article/creating-custom",{"_index":774,"title":{},"description":{"31":{}}}],["href=\"http://por.force.com/ulearn/s/article/contacts-brows",{"_index":711,"title":{},"description":{"19":{}}}],["href=\"http://por.force.com/ulearn/s/article/elite-customer-record",{"_index":757,"title":{},"description":{"31":{}}}],["https://api.pointofrental.com/v1/apikey/contact",{"_index":285,"title":{},"description":{"4":{}}}],["https://api.pointofrental.com/v1/apikey/contacts/12345",{"_index":293,"title":{},"description":{"4":{}}}],["https://api.pointofrental.com/v1/apikey/contacts/{contactid",{"_index":291,"title":{},"description":{"4":{}}}],["id",{"_index":288,"title":{"7":{},"18":{},"22":{},"23":{},"28":{},"29":{},"34":{},"35":{},"39":{},"42":{},"43":{},"46":{},"52":{},"53":{},"55":{},"59":{},"61":{},"62":{},"65":{},"70":{},"71":{},"72":{},"74":{},"78":{},"79":{},"84":{},"85":{},"96":{},"100":{},"108":{},"111":{}},"description":{"4":{},"6":{},"7":{},"11":{},"14":{},"18":{},"22":{},"23":{},"34":{},"35":{},"39":{},"53":{},"65":{},"79":{},"84":{},"92":{},"96":{},"100":{},"103":{},"108":{},"112":{}}}],["identifi",{"_index":835,"title":{},"description":{"63":{}}}],["identifiers.alia",{"_index":1045,"title":{},"description":{"112":{}}}],["identifiers.barcod",{"_index":1046,"title":{},"description":{"112":{}}}],["identifiers.externalcontractid",{"_index":1044,"title":{},"description":{"112":{}}}],["identifiers.parentid",{"_index":730,"title":{},"description":{"21":{}}}],["ids:
