Download OpenAPI specification:
The Point of Rental API is intended for both customer and 3rd party usage. As our API grows, we will do our best to enrich this documentation. Please check back often.
In order to make calls through the Global API, you will need to have a few things in place. These steps vary by product. Make sure you read over the parts that call out your flavor of Point of Rental.
This means you must first be an active and paying customer of the Elite, Syrinx 365, or Essentials platforms.
If you are Elite/Syrinx based, you will need to have what we call the “SQS Listener” running on the machine that serves your database and current Elite/Syrinx API. This should be setup by Point of Rental, so feel free to ask us if you suspect it may not be live. Once this service is running, we will be able to talk between the Global API and your local server through a secure channel. This is what will allow us to continue setting up users and licenses through our Global Admin tool. This also enables your server to talk to our POR One mobile application, among other things.
This means your user account inside of our product must have an email address for the username and a password that fits the minimum requirements. Additionally, your company must have the “Global Login” feature turned on and synced up. This is done a little bit differently depending on your product, but we can help you with that.
You will need to obtain an API Key from Point of Rental that can then be used to authenticate the calls you will make against the Global API. This Key is sacred and will need to be protected, as it allows access to your data. We can change them over time if you wish, so feel free to reach out to us on that.
Feel free to test out the API now with your API Key. Otherwise, happy API'ing!
There are two types of URLs you can hit.
https://api.pointofrental.com/v1/apikey/contactshttps://api.pointofrental.com/v1/apikey/contacts/{ContactId} could resolve tohttps://api.pointofrental.com/v1/apikey/contacts/12345Your 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>
Supported by Elite and Syrinx:
Only supported per-endpoint where noted:
Additional comparaters supported by Elite:
Filters are of the form:
{
"field": "The field from the model to compare.",
"type": "The type of comparator (from above list).",
"value": "The value to compare the field to."
}
Example:
GET /apikey/customers
X-Filter: [
{
"type": "AND",
"value": [
{
"field": "Name",
"type": "LIKE",
"value": "John Doe"
},
{
"field": "CompanyName",
"type": "LIKE",
"value": "XYZ Company"
}
]
}
]
Search filter example:
GET /apikey/contacts
X-Filter: [
{
"field": "Search",
"type": "==",
"value": "some search query"
}
]
Note: 100 is the upper limit on page size requests.
Paging example:
GET /apikey/contracts
X-Paging: {
"page": 1,
"pageSize": 25
}
2xx Responses:
Create:
201 - Record created.
Get All:
200 - Record(s) found.
Get by Id:
200 - Record found.
Update:
200 - Record updated.
Delete:
200 - Record deleted.
204 - No record found to delete.
4xx Responses:
Bad Request:
400 - The request is malformed in some way. See the response message for details.
Unauthorized:
403 - Resource exists but you do not have access.
Not Found:
404 - Resource does not exist.
Creates a call log record
| Name | string or null Default: "Customer Follow-up - Equipment Return" Brief title or subject line describing the call or interaction |
object or null Collection of related entity identifiers associated with this call log | |
| Body | string or null Default: "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks." Detailed notes about the interaction, including discussion points, decisions, and action items |
| ContactName | string or null Name of the person contacted or who initiated the communication |
| ForceAcknowledge | boolean or null Flag indicating if this call log requires acknowledgment by other staff members |
| Type | string or null Category or type of communication (e.g., Customer Service, Sales, Technical Support, Payment) |
| AdditionalFields | object or null Custom fields for storing additional information specific to the business needs |
{- "ModelType": "CallLog",
- "Name": "Customer Follow-up - Equipment Return",
- "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}{- "ModelType": "CallLog",
- "Name": "Customer Follow-up - Equipment Return",
- "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}All call logs for your organization, use query parameters to filter
[- {
- "ModelType": "CallLog",
- "Name": "Customer Follow-up - Equipment Return",
- "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}
]Single call log record by call log Id
| CallLogId required | string |
{- "ModelType": "CallLog",
- "Name": "Customer Follow-up - Equipment Return",
- "Body": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}Supported by: Elite
With this endpoint, you can look up dynamic enum values for Vendor fields. The description on a particular field will indicate if it supports a lookup.
| field required | string |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Create a transaction via POR Pay.
See the /iam/transactions endpoint in the POR Pay documentation for details.
| CustomerGuid required | string <= 191 characters Default: "123" The calling app's Customer ID for this Customer. Must be unique per Organization. |
| Amount_Requested required | integer <= 9223372036854776000 Default: 100 The integer representing the amount of the smallest denomination of currency. For example, 10000 Amount with a CurrencyCode of USD for $100.00 |
| TaxAmount | integer <= 9223372036854776000 The integer representing the amount of the smallest denomination of currency (Total Tax). For example, 10000 Amount with a CurrencyCode of USD for $100.00 |
| CurrencyCode | string or null = 3 characters The 3-letter ISO 4217 uppercase currency code |
| TransactionTypeEnum required | integer (CreateTransactionTypeEnum) Default: 1 Enum: 1 3 6 9 The type of this Transaction allowed for creating new Transactions. Refer to Transaction.table.ts for a full list of Transaction Types available. |
| TerminalId | string <= 191 characters If present, this signifies that the Transaction uses a Terminal, and should use the Terminal UI. |
| IsCustomerFacing | boolean Filter processor list to only show processors that are customer facing. |
| ProcessorId | string <= 191 characters If present, this signifies that the Transaction will use a specific processor. |
| RemoteDepotId | string or null <= 191 characters If present, will be used to fetch payment methods from processor config. |
| ExcludedPaymentMethods | Array of integers or null (PaymentMethodEnum) Enum: 1 2 4 An enumeration of supported payment types to exclude on transaction creation. 1=CreditCard, 2=DebitCard, 3=GiftCard, 4=ACH, 5=Crypto |
| ApplicationFeeBasisPoints | integer or null <= 9223372036854776000 The percentage of amount requested that should be applied as a fee |
object The additional details of a transaction that will be sent to the merchant as part of L3 enhanced data. |
{- "CustomerGuid": "123",
- "Amount_Requested": 100,
- "TransactionTypeEnum": 1
}{- "ApiKey": "junior",
- "TransactionData": {
- "IsCustomerFacing": 1
}, - "TransactionId": 573
}Supported by: Elite
Create a received payment.
The constraints listed on the below fields (e.g. maximum length) are per the Global database. These may differ in the targeted RMS.
| Source required | string <= 64 characters Default: "ConsumerPortal" The microapp that took the payment (e.g. ConsumerPortal) |
| Processor required | string <= 128 characters Default: "PORPay" The processor for the payment ('PORPay' for PORPay) |
| TotalPaid required | number Default: 100 Dollar value that was paid against this contract |
| ContractId | string <= 32 characters Deprecated Unique identifier of the contract associated with the payment. Use |
| ContractIds | Array of strings[ items <= 32 characters ] Unique identifier of the contract associated with the payment |
| PaidDateTime required | string <date-time> Default: "2025-01-10T14:15:22Z" Date-time the payment happened |
| ReferenceNumber required | string <= 64 characters Default: "1234567890" Necessary value to lookup more details regarding the payment in PORPay |
| Currency required | string <= 8 characters Default: "USD" ISO 4217 currency code |
| DepotId | string <= 32 characters Unique identifier of the store or depot |
object The customer who paid | |
| PaymentMethod | number Enum: 1 4 Acceptable values:
|
{- "Source": "ConsumerPortal",
- "Processor": "PORPay",
- "TotalPaid": 100,
- "PaidDateTime": "2025-01-10T14:15:22Z",
- "ReferenceNumber": "1234567890",
- "Currency": "USD"
}{- "Source": "WEB_APP",
- "Processor": "Paypal",
- "TotalPaid": 324,
- "ContractIds": [
- "Table",
- "Bike"
], - "PaidDateTime": "2026-11-20T03:39:54.684Z",
- "ReferenceNumber": "M1UT2TMQQIMC",
- "Currency": "WST",
- "DepotId": 277,
- "PaidBy": {
- "Address": {
- "City": "Lake Karianneville",
- "Country": "Aruba",
- "GeoRegion2": "495 Forest Road",
- "GeoRegion3": "71698 Savion Gateway",
- "Latitude": -48.8159,
- "Line1": "73384 W 2nd Street",
- "Line2": "Suite 400",
- "Line3": "formula",
- "Longitude": -17.6985,
- "Name": "Malcolm Wisoky",
- "PostalCode": "01823",
- "Province": "Montana",
- "Type": "payment"
}, - "CompanyName": "Medhurst, Reinger and Schmidt",
- "FirstName": "Travon",
- "LastName": "White",
- "Phone": {
- "CountryCode": "RW",
- "Extension": "knuckle",
- "Number": "587-724-8459 x80106",
- "NumberE164": "+15549854945",
- "SmsCapable": false,
- "Type": "primary"
}
}, - "PaymentMethod": 1,
- "Consumed": 2,
- "Created": "2025-09-27T11:01:14.226Z",
- "Updated": "2025-10-10T02:31:26.362Z"
}[- {
- "Source": "INTERNAL_PROCESS",
- "Processor": "Internal",
- "TotalPaid": 370,
- "ContractId": 940,
- "ContractIds": [
- "Keyboard"
], - "PaidDateTime": "2025-10-06T18:25:00.700Z",
- "ReferenceNumber": "EHSYXXFIUJ8C",
- "Currency": "MRU",
- "DepotId": 427,
- "PaidBy": {
- "Address": {
- "City": "North Svenville",
- "Country": "Cocos (Keeling) Islands",
- "GeoRegion2": "267 Donny Turnpike",
- "GeoRegion3": "723 Gage Glens",
- "Latitude": 39.5856,
- "Line1": "2315 Pearline Glen",
- "Line2": "Suite 954",
- "Line3": "bob",
- "Longitude": -106.9539,
- "Name": "Margie Rutherford",
- "PostalCode": "79451",
- "Province": "Missouri",
- "Type": "payment"
}, - "CompanyName": "Bosco Group",
- "FirstName": "Heidi",
- "LastName": "Deckow",
- "Phone": {
- "CountryCode": "VC",
- "Extension": "summer",
- "Number": "(320) 209-8066 x228",
- "NumberE164": "+12864325675",
- "SmsCapable": true,
- "Type": "user"
}
}, - "PaymentMethod": 4,
- "Consumed": 1,
- "Created": "2026-06-11T15:38:33.796Z",
- "Updated": "2025-12-14T11:07:02.209Z"
}
]Update a received payment.
required | integer or string GUID - Allows catchup/verification should a push be missed |
| Source | string <= 64 characters Default: "API" The microapp that took the payment (e.g. ConsumerPortal) |
| Processor | string <= 128 characters Default: "Internal" The processor for the payment ('PORPay' for PORPay) |
| TotalPaid | number Default: 657 Dollar value that was paid against this contract |
| ContractId | string <= 32 characters Default: 289 Unique identifier of the contract associated with the payment |
| ContractIds | Array of strings[ items <= 32 characters ] Default: ["Shirt","Gloves"] Unique identifier of the contract associated with the payment |
| PaidDateTime | string <date-time> Default: "2026-10-20T11:25:05.097Z" Date-time the payment happened |
| ReferenceNumber | string <= 64 characters Default: "EMZPX1FAJLUR" Necessary value to lookup more details regarding the payment in PORPay |
| Currency | string <= 8 characters Default: "BDT" ISO 4217 currency code |
| DepotId | string <= 32 characters Default: 146 Unique identifier of the store or depot |
object Default: {"Address":{"City":"Newport Beach","Country":"Aruba","GeoRegion2":"68108 Abbott Stream","GeoRegion3":"650 Judge Tunnel","Latitude":-24.7078,"Line1":"2609 Jeff Motorway","Line2":"Apt. 774","Line3":"ice-cream","Longitude":173.9417,"Name":"Teri Hammes","PostalCode":"45719-2906","Province":"California","Type":"user"},"CompanyName":"Beatty, Muller and McKenzie","Email":"[email protected]","FirstName":"Wellington","LastName":"Kuhlman","Phone":{"CountryCode":"MQ","Extension":"kinase","Number":"625.612.8764 x78847","NumberE164":"+13545262063","SmsCapable":false,"Type":"default"}} The customer who paid | |
| PaymentMethod | number Default: 4 Enum: 1 4 Acceptable values:
|
| Consumed | number or null Default: 1 Enum: 1 2 3 The payment processing status based on the RMS. Acceptable values:
|
| Hidden | integer or null Value: 1 Hidden |
| Disabled | integer or null Value: 1 Disabled |
{- "Source": "API",
- "Processor": "Internal",
- "TotalPaid": 657,
- "ContractId": 289,
- "ContractIds": [
- "Shirt",
- "Gloves"
], - "PaidDateTime": "2026-10-20T11:25:05.097Z",
- "ReferenceNumber": "EMZPX1FAJLUR",
- "Currency": "BDT",
- "DepotId": 146,
- "PaidBy": {
- "Address": {
- "City": "Newport Beach",
- "Country": "Aruba",
- "GeoRegion2": "68108 Abbott Stream",
- "GeoRegion3": "650 Judge Tunnel",
- "Latitude": -24.7078,
- "Line1": "2609 Jeff Motorway",
- "Line2": "Apt. 774",
- "Line3": "ice-cream",
- "Longitude": 173.9417,
- "Name": "Teri Hammes",
- "PostalCode": "45719-2906",
- "Province": "California",
- "Type": "user"
}, - "CompanyName": "Beatty, Muller and McKenzie",
- "FirstName": "Wellington",
- "LastName": "Kuhlman",
- "Phone": {
- "CountryCode": "MQ",
- "Extension": "kinase",
- "Number": "625.612.8764 x78847",
- "NumberE164": "+13545262063",
- "SmsCapable": false,
- "Type": "default"
}
}, - "PaymentMethod": 4,
- "Consumed": 1,
- "Created": "2026-05-17T10:12:28.196Z",
- "Updated": "2026-05-29T15:41:45.804Z"
}{- "Source": "INTERNAL_PROCESS",
- "Processor": "Internal",
- "TotalPaid": 370,
- "ContractId": 940,
- "ContractIds": [
- "Keyboard"
], - "PaidDateTime": "2025-10-06T18:25:00.700Z",
- "ReferenceNumber": "EHSYXXFIUJ8C",
- "Currency": "MRU",
- "DepotId": 427,
- "PaidBy": {
- "Address": {
- "City": "North Svenville",
- "Country": "Cocos (Keeling) Islands",
- "GeoRegion2": "267 Donny Turnpike",
- "GeoRegion3": "723 Gage Glens",
- "Latitude": 39.5856,
- "Line1": "2315 Pearline Glen",
- "Line2": "Suite 954",
- "Line3": "bob",
- "Longitude": -106.9539,
- "Name": "Margie Rutherford",
- "PostalCode": "79451",
- "Province": "Missouri",
- "Type": "payment"
}, - "CompanyName": "Bosco Group",
- "FirstName": "Heidi",
- "LastName": "Deckow",
- "Phone": {
- "CountryCode": "VC",
- "Extension": "summer",
- "Number": "(320) 209-8066 x228",
- "NumberE164": "+12864325675",
- "SmsCapable": true,
- "Type": "user"
}
}, - "PaymentMethod": 4,
- "Consumed": 1,
- "Created": "2026-06-11T15:38:33.796Z",
- "Updated": "2025-12-14T11:07:02.209Z"
}Supported by: Elite
With this endpoint, you can look up enums related to categories. Currently, the only enum used is "departmentid".
| field required | string |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Supported by: Elite
Create a new Contact
Required fields:
| Name | string or null [ 1 .. 50 ] characters Default: "55365DR2" The display name for the contact. Example: 'John Smith' or 'Smith, John - Project Manager' |
object or null Default: {"ParentId":"103559"} Identifying items for Contact. | |
| Department | string or null <= 50 characters Department of the company. Example: 'Field Operations' or 'Equipment Management' |
| Disabled | boolean or null This is the state of the Contact record. By default, this state is FALSE. Setting a Contact Disabled property to TRUE temporarily deactivates the Contact until it is updated to FALSE. Example: Set to TRUE when an employee leaves the company or is no longer authorized to rent equipment. Elite: Supported Essentials: Supported Syrinx: Not Supported |
Array of objects or null Default: [{"Type":"Default","Email":"[email protected]"}] Can support multiple email addresses for a contact. Example: Work email and personal email for notifications. Elite: This array will only have a single element. | |
| FirstName | string or null Default: "John" First Name (if it's an individual). Example: 'John' or 'Maria' Elite: Read-Only |
| LastName | string or null Default: "Doe" Last Name (if it's an individual). Example: 'Smith' or 'Garcia' Elite: Read-Only |
Array of objects or null Can support multiple phone numbers for a contact. Example: Office phone, mobile phone for urgent notifications. | |
| Title | string or null <= 255 characters The contact's title. Example: 'Project Manager' or 'Equipment Supervisor' |
object or null Additional fields for Contact. |
{- "FirstName": "John",
- "LastName": "Doe",
- "Name": "55365DR2",
- "Identifiers": {
- "ParentId": "103559"
},
}{- "ModelType": "CustomerContact",
- "Addresses": [
- {
- "Type": "default",
- "Name": "Bethany Trantow",
- "Line1": "7114 Kling Station",
- "Line2": "Suite 445",
- "Line3": "swing",
- "City": "Murrayland",
- "GeoRegion2": "149 Kertzmann Brooks",
- "GeoRegion3": "2453 South Avenue",
- "Province": "Kentucky",
- "PostalCode": "78376",
- "Latitude": -55.557,
- "Longitude": 79.8627,
- "Country": "Saint Kitts and Nevis"
}, - {
- "Type": "system",
- "Name": "Cary Cruickshank",
- "Line1": "4457 Viviane Circle",
- "Line2": "Apt. 676",
- "Line3": "tenant",
- "City": "Fort Delphaton",
- "GeoRegion2": "284 Roman Road",
- "GeoRegion3": "2426 Elvie Shoals",
- "Province": "Utah",
- "PostalCode": "52355",
- "Latitude": 60.8355,
- "Longitude": 134.1322,
- "Country": "Azerbaijan"
}, - {
- "Type": "default",
- "Name": "Robin Lebsack",
- "Line1": "181 Beatty Lane",
- "Line2": "Apt. 896",
- "Line3": "viability",
- "City": "Vonshire",
- "GeoRegion2": "3884 Lauren Ford",
- "GeoRegion3": "56480 Strosin Lights",
- "Province": "Tennessee",
- "PostalCode": "95777-1076",
- "Latitude": 66.873,
- "Longitude": 74.3285,
- "Country": "Saint Helena"
}
]
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
[- {
- "ModelType": "CustomerContact",
- "Addresses": [
- {
- "Type": "default",
- "Name": "Bethany Trantow",
- "Line1": "7114 Kling Station",
- "Line2": "Suite 445",
- "Line3": "swing",
- "City": "Murrayland",
- "GeoRegion2": "149 Kertzmann Brooks",
- "GeoRegion3": "2453 South Avenue",
- "Province": "Kentucky",
- "PostalCode": "78376",
- "Latitude": -55.557,
- "Longitude": 79.8627,
- "Country": "Saint Kitts and Nevis"
}, - {
- "Type": "system",
- "Name": "Cary Cruickshank",
- "Line1": "4457 Viviane Circle",
- "Line2": "Apt. 676",
- "Line3": "tenant",
- "City": "Fort Delphaton",
- "GeoRegion2": "284 Roman Road",
- "GeoRegion3": "2426 Elvie Shoals",
- "Province": "Utah",
- "PostalCode": "52355",
- "Latitude": 60.8355,
- "Longitude": 134.1322,
- "Country": "Azerbaijan"
}, - {
- "Type": "default",
- "Name": "Robin Lebsack",
- "Line1": "181 Beatty Lane",
- "Line2": "Apt. 896",
- "Line3": "viability",
- "City": "Vonshire",
- "GeoRegion2": "3884 Lauren Ford",
- "GeoRegion3": "56480 Strosin Lights",
- "Province": "Tennessee",
- "PostalCode": "95777-1076",
- "Latitude": 66.873,
- "Longitude": 74.3285,
- "Country": "Saint Helena"
}
]
}
]Supported by: Elite, Syrinx
Retrieve a single Contact by Id
| ContactId required | string |
{- "ModelType": "CustomerContact",
- "Addresses": [
- {
- "Type": "default",
- "Name": "Bethany Trantow",
- "Line1": "7114 Kling Station",
- "Line2": "Suite 445",
- "Line3": "swing",
- "City": "Murrayland",
- "GeoRegion2": "149 Kertzmann Brooks",
- "GeoRegion3": "2453 South Avenue",
- "Province": "Kentucky",
- "PostalCode": "78376",
- "Latitude": -55.557,
- "Longitude": 79.8627,
- "Country": "Saint Kitts and Nevis"
}, - {
- "Type": "system",
- "Name": "Cary Cruickshank",
- "Line1": "4457 Viviane Circle",
- "Line2": "Apt. 676",
- "Line3": "tenant",
- "City": "Fort Delphaton",
- "GeoRegion2": "284 Roman Road",
- "GeoRegion3": "2426 Elvie Shoals",
- "Province": "Utah",
- "PostalCode": "52355",
- "Latitude": 60.8355,
- "Longitude": 134.1322,
- "Country": "Azerbaijan"
}, - {
- "Type": "default",
- "Name": "Robin Lebsack",
- "Line1": "181 Beatty Lane",
- "Line2": "Apt. 896",
- "Line3": "viability",
- "City": "Vonshire",
- "GeoRegion2": "3884 Lauren Ford",
- "GeoRegion3": "56480 Strosin Lights",
- "Province": "Tennessee",
- "PostalCode": "95777-1076",
- "Latitude": 66.873,
- "Longitude": 74.3285,
- "Country": "Saint Helena"
}
]
}Supported by: Elite
Update a single Contact by Id
Required fields:
| ContactId required | string |
| Name | string or null [ 1 .. 50 ] characters Default: "55365DR2" The display name for the contact. Example: 'John Smith' or 'Smith, John - Project Manager' |
object or null Default: {"ParentId":"103559"} Identifying items for Contact. | |
| Department | string or null <= 50 characters Department of the company. Example: 'Field Operations' or 'Equipment Management' |
| Disabled | boolean or null This is the state of the Contact record. By default, this state is FALSE. Setting a Contact Disabled property to TRUE temporarily deactivates the Contact until it is updated to FALSE. Example: Set to TRUE when an employee leaves the company or is no longer authorized to rent equipment. Elite: Supported Essentials: Supported Syrinx: Not Supported |
Array of objects or null Default: [{"Type":"Default","Email":"[email protected]"}] Can support multiple email addresses for a contact. Example: Work email and personal email for notifications. Elite: This array will only have a single element. | |
| FirstName | string or null Default: "John" First Name (if it's an individual). Example: 'John' or 'Maria' Elite: Read-Only |
| LastName | string or null Default: "Doe" Last Name (if it's an individual). Example: 'Smith' or 'Garcia' Elite: Read-Only |
Array of objects or null Can support multiple phone numbers for a contact. Example: Office phone, mobile phone for urgent notifications. | |
| Title | string or null <= 255 characters The contact's title. Example: 'Project Manager' or 'Equipment Supervisor' |
object or null Additional fields for Contact. |
{- "FirstName": "John",
- "LastName": "Doe",
- "Name": "55365DR2",
- "Identifiers": {
- "ParentId": "103559"
},
}{- "ModelType": "CustomerContact",
- "Addresses": [
- {
- "Type": "default",
- "Name": "Bethany Trantow",
- "Line1": "7114 Kling Station",
- "Line2": "Suite 445",
- "Line3": "swing",
- "City": "Murrayland",
- "GeoRegion2": "149 Kertzmann Brooks",
- "GeoRegion3": "2453 South Avenue",
- "Province": "Kentucky",
- "PostalCode": "78376",
- "Latitude": -55.557,
- "Longitude": 79.8627,
- "Country": "Saint Kitts and Nevis"
}, - {
- "Type": "system",
- "Name": "Cary Cruickshank",
- "Line1": "4457 Viviane Circle",
- "Line2": "Apt. 676",
- "Line3": "tenant",
- "City": "Fort Delphaton",
- "GeoRegion2": "284 Roman Road",
- "GeoRegion3": "2426 Elvie Shoals",
- "Province": "Utah",
- "PostalCode": "52355",
- "Latitude": 60.8355,
- "Longitude": 134.1322,
- "Country": "Azerbaijan"
}, - {
- "Type": "default",
- "Name": "Robin Lebsack",
- "Line1": "181 Beatty Lane",
- "Line2": "Apt. 896",
- "Line3": "viability",
- "City": "Vonshire",
- "GeoRegion2": "3884 Lauren Ford",
- "GeoRegion3": "56480 Strosin Lights",
- "Province": "Tennessee",
- "PostalCode": "95777-1076",
- "Latitude": 66.873,
- "Longitude": 74.3285,
- "Country": "Saint Helena"
}
]
}Supported by: Elite, Syrinx
Retrieve a list of Contracts
[- {
- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "LocationName": "Dallas Equipment Yard",
- "Address": {
- "Type": "Default",
- "Line1": "456 Equipment Drive",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "Instructions": "Please check in at main office",
- "DateTime": "2024-03-15T08:00:00Z"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "ModelType": "LineItem",
- "Id": "LI-2024-001234501",
- "Name": "CAT 320 Excavator",
- "Classification": "Rental",
- "SerialNumber": "CAT320-789XYZ",
- "IsSerialized": true,
- "Quantity": 1,
- "LineTaxTotal": 202.19,
- "LineTotal": 2652.94,
- "Status": "Out",
- "MeterReadings": [
- {
- "MeterType": "Hours",
- "MeterReading": 1250.5
}, - {
- "MeterType": "Fuel",
- "MeterReading": 75
}
], - "Rates": [
- "Weekly Rate: $2450.75",
- "Hourly Rate: $125.00"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}
]Supported by: Elite, Syrinx
Retrieve a single Contract by Id
| ContractId required | string |
{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "LocationName": "Dallas Equipment Yard",
- "Address": {
- "Type": "Default",
- "Line1": "456 Equipment Drive",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "Instructions": "Please check in at main office",
- "DateTime": "2024-03-15T08:00:00Z"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "ModelType": "LineItem",
- "Id": "LI-2024-001234501",
- "Name": "CAT 320 Excavator",
- "Classification": "Rental",
- "SerialNumber": "CAT320-789XYZ",
- "IsSerialized": true,
- "Quantity": 1,
- "LineTaxTotal": 202.19,
- "LineTotal": 2652.94,
- "Status": "Out",
- "MeterReadings": [
- {
- "MeterType": "Hours",
- "MeterReading": 1250.5
}, - {
- "MeterType": "Fuel",
- "MeterReading": 75
}
], - "Rates": [
- "Weekly Rate: $2450.75",
- "Hourly Rate: $125.00"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite
Update an existing Contract record by ContractId. Only fields defined below in swagger can be modified. Additional changes will be ignored
| ContractId required | string |
| ContractInformation | string or null Text field for additional details to be added to a Contract that would make it easier to identify based on the context entered. Supported by: Elite, Essentials |
object or null Location, address, special instructions and date/time for driver actions, delivery, or customer pickup | |
object or null Location, address, special instructions and date/time for driver actions, delivery, or customer pickup | |
Array of objects or null Updatable line items: Id (required), Comments; Quantity requires PatchLineItemQty license. | |
| LocationId | string or null Id of the Location. (see the Location endpoints) |
Array of objects Default: [{"Type":"Delivery","Value":"availability"},{"Type":"Pickup","Value":"vista"},{"Type":"Delivery","Value":"unibody"}] Any comments or notes. | |
| IsDelivery | boolean Default: false True when the contract is marked for delivery. |
| IsPickup | boolean Default: true True when the contract is marked for customer pickup. |
{- "Notes": [
- {
- "Type": "Delivery",
- "Value": "availability"
}, - {
- "Type": "Pickup",
- "Value": "vista"
}, - {
- "Type": "Delivery",
- "Value": "unibody"
}
], - "IsDelivery": false,
- "IsPickup": true
}{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "LocationName": "Dallas Equipment Yard",
- "Address": {
- "Type": "Default",
- "Line1": "456 Equipment Drive",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "Instructions": "Please check in at main office",
- "DateTime": "2024-03-15T08:00:00Z"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "ModelType": "LineItem",
- "Id": "LI-2024-001234501",
- "Name": "CAT 320 Excavator",
- "Classification": "Rental",
- "SerialNumber": "CAT320-789XYZ",
- "IsSerialized": true,
- "Quantity": 1,
- "LineTaxTotal": 202.19,
- "LineTotal": 2652.94,
- "Status": "Out",
- "MeterReadings": [
- {
- "MeterType": "Hours",
- "MeterReading": 1250.5
}, - {
- "MeterType": "Fuel",
- "MeterReading": 75
}
], - "Rates": [
- "Weekly Rate: $2450.75",
- "Hourly Rate: $125.00"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Retrieve payment boundaries for a single Contract by Id.
| ContractId required | string |
[- {
- "PaymentType": "Recurring",
- "Frequency": "Monthly",
- "DayOfMonth": 1,
- "PaymentTerms": "NET30",
- "MinimumPayment": 500,
- "LateFeePercentage": 0.015,
- "GracePeriodDays": 5
}
]Supported by: Elite
Call a Contract Off Rent
| ContractId required | string Default: "123" The unique id for the contract |
| CalledOffDateTime required | string <date-time> Default: "2025-05-27T00:00:00Z" What date and time to call off the line item. UTC time zone. e.g. 2023-01-01T06:00:00Z |
| PersonCallingOff | string Default: "John Doe" Name of the person who is calling the contract off rent. |
| Memo | string Default: "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks." Additional textual information for calling a contract off rent. |
| RemoteUserId | string An identifier on the remote server for the user's account. Can be User ID, Username, anything to match the Relationship to a user. |
{- "ContractId": "123",
- "CalledOffDateTime": "2025-05-27T00:00:00Z",
- "PersonCallingOff": "John Doe",
- "Memo": "Customer called regarding scheduled equipment return. Agreed to extend rental period by 2 weeks."
}{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "LocationName": "Dallas Equipment Yard",
- "Address": {
- "Type": "Default",
- "Line1": "456 Equipment Drive",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "Instructions": "Please check in at main office",
- "DateTime": "2024-03-15T08:00:00Z"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "ModelType": "LineItem",
- "Id": "LI-2024-001234501",
- "Name": "CAT 320 Excavator",
- "Classification": "Rental",
- "SerialNumber": "CAT320-789XYZ",
- "IsSerialized": true,
- "Quantity": 1,
- "LineTaxTotal": 202.19,
- "LineTotal": 2652.94,
- "Status": "Out",
- "MeterReadings": [
- {
- "MeterType": "Hours",
- "MeterReading": 1250.5
}, - {
- "MeterType": "Fuel",
- "MeterReading": 75
}
], - "Rates": [
- "Weekly Rate: $2450.75",
- "Hourly Rate: $125.00"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite
Retrieve files for a single Contract by Id.
| ContractId required | string |
| tagKey required | string
|
[- {
- "Id": "FILE-2024-001",
- "Name": "equipment-manual.pdf",
- "ContentType": "application/pdf",
}
]Supported by: Elite
Retrieve Tax Details for a single Contract by Id.
| ContractId required | string |
{- "SubTotal": 1000,
- "TaxableAmount": 1000,
- "TaxAmount": 82.5,
- "TotalAmount": 1082.5,
- "TaxDetails": [
- {
- "TaxType": "State Sales Tax",
- "Rate": 0.0625,
- "Amount": 62.5
}, - {
- "TaxType": "Local Sales Tax",
- "Rate": 0.02,
- "Amount": 20
}
]
}Supported by: Elite
Cancels a contract by changing its status to cancelled. The contract record is not deleted
| ContractId required | string |
| CancelReasonId | string or null Use the contracts/lookup/CancelReasonId to get the list of options. |
| Reason | string or null The reason why they are canceling/voiding the contract |
{ }{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "LocationName": "Dallas Equipment Yard",
- "Address": {
- "Type": "Default",
- "Line1": "456 Equipment Drive",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "Instructions": "Please check in at main office",
- "DateTime": "2024-03-15T08:00:00Z"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "ModelType": "LineItem",
- "Id": "LI-2024-001234501",
- "Name": "CAT 320 Excavator",
- "Classification": "Rental",
- "SerialNumber": "CAT320-789XYZ",
- "IsSerialized": true,
- "Quantity": 1,
- "LineTaxTotal": 202.19,
- "LineTotal": 2652.94,
- "Status": "Out",
- "MeterReadings": [
- {
- "MeterType": "Hours",
- "MeterReading": 1250.5
}, - {
- "MeterType": "Fuel",
- "MeterReading": 75
}
], - "Rates": [
- "Weekly Rate: $2450.75",
- "Hourly Rate: $125.00"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite
Changes a contract quote into a reservation. See quoteToReservationEligible to check if a quote is eligible to be converted into a reservation.
| ContractId required | string |
{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "LocationName": "Dallas Equipment Yard",
- "Address": {
- "Type": "Default",
- "Line1": "456 Equipment Drive",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "Instructions": "Please check in at main office",
- "DateTime": "2024-03-15T08:00:00Z"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "ModelType": "LineItem",
- "Id": "LI-2024-001234501",
- "Name": "CAT 320 Excavator",
- "Classification": "Rental",
- "SerialNumber": "CAT320-789XYZ",
- "IsSerialized": true,
- "Quantity": 1,
- "LineTaxTotal": 202.19,
- "LineTotal": 2652.94,
- "Status": "Out",
- "MeterReadings": [
- {
- "MeterType": "Hours",
- "MeterReading": 1250.5
}, - {
- "MeterType": "Fuel",
- "MeterReading": 75
}
], - "Rates": [
- "Weekly Rate: $2450.75",
- "Hourly Rate: $125.00"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite
Elite users can look up enums related to contracts. Currently lookup/cancelReasonId is the only field this returns a value
| field required | string |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Supported by: Elite
Create a new Customer
Required fields:
| Name | string or null [ 1 .. 50 ] characters Default: "ABC Construction Co" Can be a company or individual name. Example Business: "ABC Construction Services LLC" Example Individual: "John Smith" |
object or null These are unique properties that are specific to certain products (Elite, Essentials, Syrinx). Supported List All
Elite Only
Syrinx Only
Not all properties are valid across all products. | |
Array of objects Supported types will depend on the product. Elite:
Example: [ { "Type": "Customer", "Line1": "1234 Construction Way", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ] | |
| BillingName | string or null <= 50 characters Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type. Example: "Sarah Johnson, Accounts Payable" |
| Classification | string or null What kind of customer is this? Examples include:
You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Classification" to receive a list of acceptable values for this field. |
Array of objects If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location. Elite: Supported. | |
| CreditLimit | integer or null <= 2147483647 The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager. Example: 25000 (represents $25,000 credit limit) |
| CurrencyCode | string or null Default: "USD" Defaults to "USD". Code is ISO 4217 format. Common Examples:
You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field. |
| DoNotEmail | boolean or null Prevents the software from sending 'marketing' emails. |
Array of objects Example: [ { "Type": "Primary", "Email": "contracts@abcconstruction.com" } ] | |
| FirstName | string or null [ 1 .. 50 ] characters First Name of Customer (individual only). Example: "John" |
| HeardAboutUs | string or null Common Examples:
You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "HeardAboutUs" to receive a list of acceptable values for this field. |
| LastName | string or null [ 1 .. 50 ] characters Last Name of Customer (individual only). Example: "Smith" |
| Locale | string or null Default: "en-US" Defaults to "en-US". Code is ISO 639 format. You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Locale" to receive a list of acceptable values for this field. |
| Nontaxable | boolean or null Means no tax is calculated for this customer on any contracts |
Array of objects Example: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123" }, { "Type": "Mobile", "CountryCode": "1", "Number": "214-555-0124" } ] | |
| RecordType | string Default: "Business" Enum: "Business" "Individual" Denotes if this record is a business or an individual. Example Business: Construction company renting heavy equipment Example Individual: Homeowner renting tools |
object or null Data related to the sales person associated with the Customer. | |
| Status | string Default: "Lead" Enum: "Lead" "Prospect" "Cash" "Account" Examples:
You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Status" to receive a list of acceptable values for this field. |
| ExternalReceivableBalance | number (Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization. |
object or null Additional fields for Customer. Example: { "CustomerWebPortal": true, "ExternalTaxClass": "CONST", "ExternalTaxCode": "TX-CONST-01", "ForceContractInfo": true, "ForceJobId": true, "ForcePurchaseOrder": true, "InvoiceSendBy": "Email", "StatementSendBy": "Email", "Terms": "Net 30", "UserDefined1": "VIP Customer", "UserDefined2": "Annual Revenue >$5M" } |
{- "Name": "ABC Construction Co"
}{- "ModelType": "Customer",
- "Id": "CUST-12345",
- "Name": "ABC Construction Co",
- "Identifiers": {
- "CustomerKey": "ABC123",
- "TaxNumber": "123-45-6789"
}, - "Addresses": [
- {
- "Type": "Customer",
- "Line1": "123 Construction Ave",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201"
}
], - "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
[- {
- "ModelType": "Customer",
- "Id": "CUST-12345",
- "Name": "ABC Construction Co",
- "Identifiers": {
- "CustomerKey": "ABC123",
- "TaxNumber": "123-45-6789"
}, - "Addresses": [
- {
- "Type": "Customer",
- "Line1": "123 Construction Ave",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201"
}
], - "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}
]Supported by: Elite, Syrinx
Retrieve a single Customer by Id
| CustomerId required | string |
{- "ModelType": "Customer",
- "Id": "CUST-12345",
- "Name": "ABC Construction Co",
- "Identifiers": {
- "CustomerKey": "ABC123",
- "TaxNumber": "123-45-6789"
}, - "Addresses": [
- {
- "Type": "Customer",
- "Line1": "123 Construction Ave",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201"
}
], - "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite
Update a single Customer by Id
Required fields:
| CustomerId required | string |
| Name | string or null [ 1 .. 50 ] characters Default: "ABC Construction Co" Can be a company or individual name. Example Business: "ABC Construction Services LLC" Example Individual: "John Smith" |
object or null These are unique properties that are specific to certain products (Elite, Essentials, Syrinx). Supported List All
Elite Only
Syrinx Only
Not all properties are valid across all products. | |
Array of objects Supported types will depend on the product. Elite:
Example: [ { "Type": "Customer", "Line1": "1234 Construction Way", "Line2": "Suite 100", "City": "Dallas", "Province": "TX", "PostalCode": "75201" } ] | |
| BillingName | string or null <= 50 characters Full name associated with billing contact. Other billing details can be placed in Address, Phone & Email fields by type. Example: "Sarah Johnson, Accounts Payable" |
| Classification | string or null What kind of customer is this? Examples include:
You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Classification" to receive a list of acceptable values for this field. |
Array of objects If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location. Elite: Supported. | |
| CreditLimit | integer or null <= 2147483647 The highest outstanding balance (open, closed, etc summed) that a non-elevated rental employee can create/modify a contract without override from a manager. Example: 25000 (represents $25,000 credit limit) |
| CurrencyCode | string or null Default: "USD" Defaults to "USD". Code is ISO 4217 format. Common Examples:
You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field. |
| DoNotEmail | boolean or null Prevents the software from sending 'marketing' emails. |
Array of objects Example: [ { "Type": "Primary", "Email": "contracts@abcconstruction.com" } ] | |
| FirstName | string or null [ 1 .. 50 ] characters First Name of Customer (individual only). Example: "John" |
| HeardAboutUs | string or null Common Examples:
You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "HeardAboutUs" to receive a list of acceptable values for this field. |
| LastName | string or null [ 1 .. 50 ] characters Last Name of Customer (individual only). Example: "Smith" |
| Locale | string or null Default: "en-US" Defaults to "en-US". Code is ISO 639 format. You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Locale" to receive a list of acceptable values for this field. |
| Nontaxable | boolean or null Means no tax is calculated for this customer on any contracts |
Array of objects Example: [ { "Type": "Default", "CountryCode": "1", "Number": "214-555-0123" }, { "Type": "Mobile", "CountryCode": "1", "Number": "214-555-0124" } ] | |
| RecordType | string Default: "Business" Enum: "Business" "Individual" Denotes if this record is a business or an individual. Example Business: Construction company renting heavy equipment Example Individual: Homeowner renting tools |
object or null Data related to the sales person associated with the Customer. | |
| Status | string Default: "Lead" Enum: "Lead" "Prospect" "Cash" "Account" Examples:
You can hit the /customers/lookup/{Field} endpoint and pass in the query parameter "Field" --> "Status" to receive a list of acceptable values for this field. |
| ExternalReceivableBalance | number (Elite Only) The value representing the balance due as calculated by an external ERP system that handles all lines of business for an organization. |
object or null Additional fields for Customer. Example: { "CustomerWebPortal": true, "ExternalTaxClass": "CONST", "ExternalTaxCode": "TX-CONST-01", "ForceContractInfo": true, "ForceJobId": true, "ForcePurchaseOrder": true, "InvoiceSendBy": "Email", "StatementSendBy": "Email", "Terms": "Net 30", "UserDefined1": "VIP Customer", "UserDefined2": "Annual Revenue >$5M" } |
{- "Name": "ABC Construction Co"
}{- "ModelType": "Customer",
- "Id": "CUST-12345",
- "Name": "ABC Construction Co",
- "Identifiers": {
- "CustomerKey": "ABC123",
- "TaxNumber": "123-45-6789"
}, - "Addresses": [
- {
- "Type": "Customer",
- "Line1": "123 Construction Ave",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201"
}
], - "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite
With this endpoint, you can look up dynamic enum values for Customer fields. The description on a particular field will indicate if it supports a lookup.
| field required | string |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
[- {
- "ModelType": "Depot",
- "Id": "DEP-001",
- "Name": "Main Equipment Yard",
- "Address": {
- "Line1": "1000 Industrial Blvd",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "ContactName": "Yard Manager",
- "ContactPhone": "214-555-7890",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}
]Supported by: Elite, Syrinx
Retrieve a single Depot by Id
| DepotId required | string |
{- "ModelType": "Depot",
- "Id": "DEP-001",
- "Name": "Main Equipment Yard",
- "Address": {
- "Line1": "1000 Industrial Blvd",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "ContactName": "Yard Manager",
- "ContactPhone": "214-555-7890",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}[- {
- "ModelType": "Invoice",
- "Id": "INV-2024-001",
- "InvoiceNumber": "24001",
- "CustomerId": "CUST-12345",
- "InvoiceDate": "2024-03-15T00:00:00Z",
- "DueDate": "2024-04-14T00:00:00Z",
- "SubTotal": 1500,
- "TaxAmount": 123.75,
- "TotalAmount": 1623.75,
- "Status": "Open",
- "CreatedDateTime": "2024-03-15T14:30:00Z"
}
]Retrieve a single Invoice by Id
| InvoiceId required | string |
{- "ModelType": "Invoice",
- "Id": "INV-2024-001",
- "InvoiceNumber": "24001",
- "CustomerId": "CUST-12345",
- "InvoiceDate": "2024-03-15T00:00:00Z",
- "DueDate": "2024-04-14T00:00:00Z",
- "SubTotal": 1500,
- "TaxAmount": 123.75,
- "TotalAmount": 1623.75,
- "Status": "Open",
- "CreatedDateTime": "2024-03-15T14:30:00Z"
}Supported by: Elite
Retrieve files for a single Invoice by Id.
| InvoiceId required | string |
| tagKey required | string
|
[- {
- "Id": "FILE-2024-001",
- "Name": "equipment-manual.pdf",
- "ContentType": "application/pdf",
}
][- {
- "Id": "LI-001",
- "ContractId": "CNT-2024-001",
- "ProductId": "PROD-123",
- "Name": "20T Excavator",
- "Quantity": 1,
- "RateAmount": 450,
- "RateType": "Daily",
- "StartDate": "2024-03-15T00:00:00Z",
- "EndDate": "2024-04-15T00:00:00Z",
- "Status": "OnRent",
- "SubTotal": 13500,
- "TaxAmount": 1113.75,
- "TotalAmount": 14613.75
}
]Retrieve a single line item by its id
| LineItemId required | string |
{- "Id": "LI-001",
- "ContractId": "CNT-2024-001",
- "ProductId": "PROD-123",
- "Name": "20T Excavator",
- "Quantity": 1,
- "RateAmount": 450,
- "RateType": "Daily",
- "StartDate": "2024-03-15T00:00:00Z",
- "EndDate": "2024-04-15T00:00:00Z",
- "Status": "OnRent",
- "SubTotal": 13500,
- "TaxAmount": 1113.75,
- "TotalAmount": 14613.75
}Supported by: Elite
Call Line Items Off Rent
| LineItemIds required | Array of strings Default: ["687122~@!^$1"] Array of unique line item IDs to be called off rent. Each ID represents a piece of equipment being returned. |
| CalledOffDateTime required | string <date-time> Default: "2024-04-15T00:00:00" The exact date and time when the equipment will be called off rent (returned). Must be in UTC timezone. |
| PersonCallingOff | string Full name of the customer representative who is authorizing the return of the equipment. This person should be authorized to make rental decisions. |
| Memo | string Additional notes about the return, such as equipment condition, reason for return, or special handling instructions |
| RemoteUserId | string The identifier for the user account on the remote system making this request. Could be an email, username, or internal ID that maps to the user in the remote system. |
{- "LineItemIds": [
- "687122~@!^$1"
], - "ContractId": "CNT-2024-001",
- "ReturnDate": "2024-04-15T00:00:00Z",
- "CalledOffDateTime": "2024-04-15T00:00:00",
- "Condition": "Good",
- "Notes": "Equipment returned in clean condition, no damage",
- "MeterReading": 150.5,
- "FuelLevel": 0.75
}{- "ModelType": "Contract",
- "Id": "CNT-2024-0012345",
- "Name": "Excavator Rental - ABC Construction",
- "Identifiers": {
- "InvoiceNumber": "INV-2024-987654",
- "Barcode": "EQ-CAT320-789",
- "Alias": "CAT 320 Excavator #12",
- "ParentId": "CNT-2024-0012345"
}, - "Addresses": [
- {
- "Type": "Default",
- "Name": "Construction Site",
- "Line1": "123 Construction Way",
- "Line2": "Building A",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75201",
- "Latitude": "32.7767",
- "Longitude": "-96.7970"
}
], - "AmountDue": 2450.75,
- "AmountPaid": 1000,
- "Contacts": [
- {
- "Type": "Customer",
- "Contact": {
- "ModelType": "CustomerContact",
- "Name": "John Smith",
- "FirstName": "John",
- "LastName": "Smith",
- "CompanyName": "ABC Construction",
- "Department": "Operations",
- "Phones": [
- {
- "Type": "Default",
- "Number": "214-555-0123",
- "CountryCode": "+1"
}, - {
- "Type": "Mobile",
- "Number": "214-555-0124",
- "CountryCode": "+1"
}
]
}
}
], - "ContractInformation": "Weekly rental of CAT 320 Excavator for Downtown Dallas project",
- "CustomerId": "CUST-ABC-001",
- "CustomerName": "ABC Construction",
- "CustomerPickup": {
- "LocationName": "Dallas Equipment Yard",
- "Address": {
- "Type": "Default",
- "Line1": "456 Equipment Drive",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75207"
}, - "Instructions": "Please check in at main office",
- "DateTime": "2024-03-15T08:00:00Z"
}, - "DepotId": "DPT-DAL-001",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "EsignState": "Signed",
- "GrandTaxTotal": 202.19,
- "GrandTotal": 2652.94,
- "LineItems": [
- {
- "ModelType": "LineItem",
- "Id": "LI-2024-001234501",
- "Name": "CAT 320 Excavator",
- "Classification": "Rental",
- "SerialNumber": "CAT320-789XYZ",
- "IsSerialized": true,
- "Quantity": 1,
- "LineTaxTotal": 202.19,
- "LineTotal": 2652.94,
- "Status": "Out",
- "MeterReadings": [
- {
- "MeterType": "Hours",
- "MeterReading": 1250.5
}, - {
- "MeterType": "Fuel",
- "MeterReading": 75
}
], - "Rates": [
- "Weekly Rate: $2450.75",
- "Hourly Rate: $125.00"
]
}
], - "LocationId": "LOC-DAL-001",
- "Notes": [
- {
- "Type": "Default",
- "Value": "Customer requested delivery to site by 8 AM"
}
], - "PONumber": "ABC-PO-98765",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "Status": "Open",
- "Totals": [
- {
- "Label": "Equipment Rental",
- "Value": 2450.75
}, - {
- "Label": "Tax (8.25%)",
- "Value": 202.19
}, - {
- "Label": "Grand Total",
- "Value": 2652.94
}
], - "CreatedDateTime": "2024-03-14T15:30:00Z",
- "UpdatedDateTime": "2024-03-15T08:15:00Z",
- "IsPickup": true,
- "Revision": 2,
- "AdditionalFields": {
- "ClassName": "StandardContract",
- "CurrencyCode": "USD",
- "CustomerJobNumber": "ABC-2024-456",
- "CustomerPurchaseOrder": "PO-98765",
- "OrderedBy": "John Smith",
- "PrecheckCompletedDateTime": "2024-03-14T16:00:00Z",
- "ReceivedBy": "Jane Doe"
}
}Supported by: Elite
Create a new Location
Required fields:
| Name | string or null [ 1 .. 255 ] characters Default: "Downtown Construction Site" This would map to the jobsite description in Elite. Examples:
|
object or null Location address with specific delivery instructions. Examples:
| |
Array of objects If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location. Elite: Supported. | |
| EndDate | string or null <date-time> This is the date from which the location is no longer valid to be used. A location cannot be used after this date. Examples:
Elite: This field is not supported. |
Array of objects Currently we only support SiteDeliveryInstructions for special delivery requirements and site access information. | |
| OwnerId | string or null Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc. Examples:
|
Array of objects Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Examples:
| |
| StartDate | string or null <date-time> This is the date from which the location is valid to be used. A location cannot be used before this date. Examples:
Elite: Not supported. |
| AdditionalFields | object or null Additional fields for Location. Example: Custom fields for site-specific requirements or certifications. |
{- "Name": "Downtown Construction Site"
}{- "ModelType": "Location",
- "Id": "LOC-2024-001",
- "Name": "Downtown Construction Site",
- "CustomerId": "CUST-12345",
- "Address": {
- "Line1": "456 Project Site",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75202"
}, - "ContactName": "Site Manager",
- "ContactPhone": "214-555-5678",
- "Status": "Active",
- "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
[- {
- "ModelType": "Location",
- "Id": "LOC-2024-001",
- "Name": "Downtown Construction Site",
- "CustomerId": "CUST-12345",
- "Address": {
- "Line1": "456 Project Site",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75202"
}, - "ContactName": "Site Manager",
- "ContactPhone": "214-555-5678",
- "Status": "Active",
- "CreatedDateTime": "2024-03-15T00:00:00Z"
}
]Supported by: Elite, Syrinx
Retrieve a single Location by Id
| LocationId required | string |
{- "ModelType": "Location",
- "Id": "LOC-2024-001",
- "Name": "Downtown Construction Site",
- "CustomerId": "CUST-12345",
- "Address": {
- "Line1": "456 Project Site",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75202"
}, - "ContactName": "Site Manager",
- "ContactPhone": "214-555-5678",
- "Status": "Active",
- "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite
Update a single Location by Id
Required fields:
| LocationId required | string |
| Name | string or null [ 1 .. 255 ] characters Default: "Downtown Construction Site" This would map to the jobsite description in Elite. Examples:
|
object or null Location address with specific delivery instructions. Examples:
| |
Array of objects If there are any contacts associated with this Location, then they will be listed here. NOTE - Syrinx has contacts on the customer record, but not the location. Elite: Supported. | |
| EndDate | string or null <date-time> This is the date from which the location is no longer valid to be used. A location cannot be used after this date. Examples:
Elite: This field is not supported. |
Array of objects Currently we only support SiteDeliveryInstructions for special delivery requirements and site access information. | |
| OwnerId | string or null Can be null if SharedLocation is true. Should be a CustomerId if Type is Customer, SupplierId if Type is Supplier, etc. Examples:
|
Array of objects Type can == "Customer" or "Billing" for now. This supports multiple phone numbers. Examples:
| |
| StartDate | string or null <date-time> This is the date from which the location is valid to be used. A location cannot be used before this date. Examples:
Elite: Not supported. |
| AdditionalFields | object or null Additional fields for Location. Example: Custom fields for site-specific requirements or certifications. |
{- "Name": "Downtown Construction Site"
}{- "ModelType": "Location",
- "Id": "LOC-2024-001",
- "Name": "Downtown Construction Site",
- "CustomerId": "CUST-12345",
- "Address": {
- "Line1": "456 Project Site",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75202"
}, - "ContactName": "Site Manager",
- "ContactPhone": "214-555-5678",
- "Status": "Active",
- "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite, Syrinx
Retrieve availability for a single Product by Id
| ProductId required | string |
| startdate required | string |
| enddate required | string |
| returnSingleRecord required | string |
{- "ProductId": "PROD-123",
- "Name": "20T Excavator",
- "TotalQuantity": 5,
- "AvailableQuantity": 3,
- "ReservedQuantity": 1,
- "RentedQuantity": 1,
- "NextAvailableDate": "2024-03-20T00:00:00Z",
- "DepotId": "DEP-001"
}Create a new product in the system. This endpoint is used to create a new product in the system. The product will be created with the default values for the product type. The product will be created with the default values for the product type.
| Name required | string or null Default: "Test MOdel " The display name for the item. Should be clear and descriptive, including key specifications when relevant. |
required | object or null Default: {"Key":"12435","Barcode":"123","Alias":"smith"} Identifying items for Product. Contains various codes and numbers used to track and identify the product across systems. |
| CategoryName | string or null Default: "Audio - Video - Lighting" Denormalized name of the Category. Elite only supports one category name. Used for display and filtering. |
| Classification required | string Default: "Rental" Enum: "Rental" "Sale" Specifies if the product is available for rental or sale. Only Rental and Sale supported for POST. |
| DepotId required | string or null Default: "000" Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) where the equipment is located. |
| Description required | string or null Default: "Nodescription" Detailed description of the product including key features, specifications, and use cases. |
| IsPart | boolean or null Indicates if this is a spare part or consumable item rather than rental equipment. |
required | object or null Default: {"ExternalTaxCode":"12AS","RentalType":"Rental - Header","CurrentDepotId":"000","ReorderMinimum":"2","ReorderMaximum":"3","CaseQuantity":5,"RentalCaseQuantity":2,"CriticalLevel":1,"TaxCode":14} Additional fields for inventory management and ordering. |
{- "ModelType": "Product",
- "Name": "Test MOdel ",
- "Identifiers": {
- "Key": "12435",
- "Barcode": "123",
- "Alias": "smith"
}, - "CategoryIds": [
- "63"
], - "CategoryName": "Audio - Video - Lighting",
- "Classification": "Rental",
- "Description": "Nodescription",
- "Images": [ ],
- "Key": ".ACPLUG",
- "ModelNumber": "23",
- "ModelYear": "2025",
- "OtherUrls": [ ],
- "Tags": [ ],
- "DepotId": "000",
- "AdditionalFields": {
- "ExternalTaxCode": "12AS",
- "RentalType": "Rental - Header",
- "CurrentDepotId": "000",
- "ReorderMinimum": "2",
- "ReorderMaximum": "3",
- "CaseQuantity": 5,
- "RentalCaseQuantity": 2,
- "CriticalLevel": 1,
- "TaxCode": 14
}
}{- "ModelType": "Product",
- "Id": "PROD-123",
- "Name": "20T Excavator",
- "Description": "20-ton tracked excavator suitable for large construction projects",
- "Category": "Heavy Equipment",
- "Manufacturer": "CAT",
- "Model": "320",
- "SerialNumber": "CAT320-123456",
- "Status": "Available",
- "DepotId": "DEP-001",
- "Rates": [
- {
- "RateType": "Daily",
- "Amount": 450
}
], - "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
[- {
- "ModelType": "Product",
- "Id": "PROD-123",
- "Name": "20T Excavator",
- "Description": "20-ton tracked excavator suitable for large construction projects",
- "Category": "Heavy Equipment",
- "Manufacturer": "CAT",
- "Model": "320",
- "SerialNumber": "CAT320-123456",
- "Status": "Available",
- "DepotId": "DEP-001",
- "Rates": [
- {
- "RateType": "Daily",
- "Amount": 450
}
], - "CreatedDateTime": "2024-03-15T00:00:00Z"
}
]Supported by: Elite, Syrinx
Retrieve a single Product by Id
| ProductId required | string |
{- "ModelType": "Product",
- "Id": "PROD-123",
- "Name": "20T Excavator",
- "Description": "20-ton tracked excavator suitable for large construction projects",
- "Category": "Heavy Equipment",
- "Manufacturer": "CAT",
- "Model": "320",
- "SerialNumber": "CAT320-123456",
- "Status": "Available",
- "DepotId": "DEP-001",
- "Rates": [
- {
- "RateType": "Daily",
- "Amount": 450
}
], - "CreatedDateTime": "2024-03-15T00:00:00Z"
}Update a Product
| ProductId required | string |
| Name required | string or null Default: "Test MOdel " The display name for the item. Should be clear and descriptive, including key specifications when relevant. |
required | object or null Default: {"Key":"12435","Barcode":"123","Alias":"smith"} Identifying items for Product. Contains various codes and numbers used to track and identify the product across systems. |
| CategoryName | string or null Default: "Audio - Video - Lighting" Denormalized name of the Category. Elite only supports one category name. Used for display and filtering. |
| Classification required | string Default: "Rental" Enum: "Rental" "Sale" Specifies if the product is available for rental or sale. Only Rental and Sale supported for POST. |
| DepotId required | string or null Default: "000" Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) where the equipment is located. |
| Description required | string or null Default: "Nodescription" Detailed description of the product including key features, specifications, and use cases. |
| IsPart | boolean or null Indicates if this is a spare part or consumable item rather than rental equipment. |
required | object or null Default: {"ExternalTaxCode":"12AS","RentalType":"Rental - Header","CurrentDepotId":"000","ReorderMinimum":"2","ReorderMaximum":"3","CaseQuantity":5,"RentalCaseQuantity":2,"CriticalLevel":1,"TaxCode":14} Additional fields for inventory management and ordering. |
{- "ModelType": "Product",
- "Name": "Test MOdel ",
- "Identifiers": {
- "Key": "12435",
- "Barcode": "123",
- "Alias": "smith"
}, - "CategoryIds": [
- "63"
], - "CategoryName": "Audio - Video - Lighting",
- "Classification": "Rental",
- "Description": "Nodescription",
- "Images": [ ],
- "Key": ".ACPLUG",
- "ModelNumber": "23",
- "ModelYear": "2025",
- "OtherUrls": [ ],
- "Tags": [ ],
- "DepotId": "000",
- "AdditionalFields": {
- "ExternalTaxCode": "12AS",
- "RentalType": "Rental - Header",
- "CurrentDepotId": "000",
- "ReorderMinimum": "2",
- "ReorderMaximum": "3",
- "CaseQuantity": 5,
- "RentalCaseQuantity": 2,
- "CriticalLevel": 1,
- "TaxCode": 14
}
}{- "ModelType": "Product",
- "Id": "PROD-123",
- "Name": "20T Excavator",
- "Description": "20-ton tracked excavator suitable for large construction projects",
- "Category": "Heavy Equipment",
- "Manufacturer": "CAT",
- "Model": "320",
- "SerialNumber": "CAT320-123456",
- "Status": "Available",
- "DepotId": "DEP-001",
- "Rates": [
- {
- "RateType": "Daily",
- "Amount": 450
}
], - "CreatedDateTime": "2024-03-15T00:00:00Z"
}Supported by: Elite, Syrinx
Retrieve rates for a single Product by Id.
| ProductId required | string |
| depotId required | string |
| locationId required | string |
| customerId required | string |
| startDate required | string |
| endDate required | string |
{- "ProductId": "PROD-123",
- "Name": "20T Excavator",
- "Rates": [
- {
- "RateType": "Daily",
- "Amount": 450,
- "MinimumDays": 1
}, - {
- "RateType": "Weekly",
- "Amount": 2250,
- "MinimumDays": 7
}, - {
- "RateType": "Monthly",
- "Amount": 8000,
- "MinimumDays": 28
}
]
}[- {
- "ModelType": "ProductAssociation",
- "ParentProductId": 837,
- "ChildProductId": 246,
- "AssociationType": "KitComponent",
- "GroupSelectionType": "ChooseQty",
- "IsSelected": false,
- "DisplayOrder": 218.05
}
]Supported by: Elite
Retrieve files for a single Product by Id.
| ProductId required | string |
| tagKey required | string
|
[- {
- "Id": "FILE-2024-001",
- "Name": "equipment-manual.pdf",
- "ContentType": "application/pdf",
}
]Supported by: Elite
Only serialized stock is supported for POST at this time.
Required fields:
| Name | string or null Default: "20T Excavator" A display name for this record. Often used as a summary for lookups. |
object or null Default: {"PartNumber":"12345","ReorderMinimum":"2","Alias":"CAT320-123456","Barcode":"1234567890123"} Identifying items for Stock. | |
| Classification | string Default: "Sale" Enum: "Internal" "Rental" "Sale" This Product is either meant for sale, rental or internal. |
| DepotId | string or null <= 3 characters Default: "001" Id of the Depot (Syrinx), Store (Elite), or Company (Essentials) of the stock. (See Depot endpoints) |
| IsAsset | boolean or null Item is eligible for depreciation |
| LoadingRatio | integer or null A number that represents the ability for a stock item to fit on a vehicle. Elite: This field is not supported. |
| Manufacturer | string or null <= 50 characters The manufacturer associated with a specific instance of an item. |
| ModelName | string or null <= 30 characters OPTIONAL. This also exists on Product. The model name associated with a specific instance of an item. Elite: This field is not supported. |
| ModelNumber | string or null <= 30 characters Default: "1234" OPTIONAL. This also exists on Product. The model number associated with a specific instance of an item. |
| ModelYear | string or null Default: "2020" OPTIONAL. This also exists on Product. The model year associated with a specific instance of an item. |
| ProductId | string <= 16 characters Default: "158" Id of the Product this Stock belongs to (see Product endpoint). |
| PurchaseDateTime | string or null <date-time> Date stock was purchased. Elite: On serialized items, it is the date and time the item was purchased. On bulk items, it is the last date and time the items were purchased. |
| PurchasePrice | number or null Price stock was purchased. Elite: On serialized items, it is the purchase price for the item. On bulk items, it is the most recent purchase price of the item. |
| Quantity | string or null Field only required for bulk stock endpoints |
| SerialNumber | string or null <= 50 characters The serial number associated with a specific instance of an item. |
object or null Default: {"ReorderMinimum":2,"ReorderMaximum":3,"CaseQuantity":5,"RentalCaseQuantity":2,"CriticalLevel":1,"GlNumber":"1234"} | |
object or null Depreciation fields for Stock | |
object or null Deprecated Depreciation fields for Stock |
{- "Name": "20T Excavator",
- "DepotId": "001",
- "ProductId": "158",
- "Classification": "Sale",
- "ModelNumber": "1234",
- "ModelYear": "2020",
- "Identifiers": {
- "PartNumber": "12345",
- "ReorderMinimum": "2",
- "Alias": "CAT320-123456",
- "Barcode": "1234567890123"
}, - "AdditionalFields": {
- "ReorderMinimum": 2,
- "ReorderMaximum": 3,
- "CaseQuantity": 5,
- "RentalCaseQuantity": 2,
- "CriticalLevel": 1,
- "GlNumber": "1234"
}, - "IsPart": true
}{- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "CategoryName": "Mini Excavators",
- "Classification": "Rental",
- "DepartmentId": "DEPT-EARTHMOVING",
- "DepartmentName": "Earthmoving Equipment",
- "DepotId": "DEPOT-DALLAS",
- "HasFuel": true,
- "FuelCapacity": 15.5,
- "IsAsset": true,
- "IsSerialized": true,
- "IsCustomerWorkOrderItem": true,
- "IsGenericWorkOrderItem": true,
- "LoadingRatio": 100,
- "Manufacturer": "Caterpillar",
- "ModelName": "305E2",
- "ModelNumber": "CAT305E2-2023",
- "ModelYear": "2023",
- "ProductId": "PROD-CAT305E2",
- "PurchaseDateTime": "2023-01-15T08:30:00Z",
- "PurchasePrice": 65000,
- "Quantity": 1,
- "SerialNumber": "CAT305E2ABC123456",
- "Status": "Available",
- "CreatedDateTime": "2023-01-15T08:30:00Z",
- "UpdatedDateTime": "2023-06-15T14:30:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
[- {
- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "CategoryName": "Mini Excavators",
- "Classification": "Rental",
- "DepartmentId": "DEPT-EARTHMOVING",
- "DepartmentName": "Earthmoving Equipment",
- "DepotId": "DEPOT-DALLAS",
- "HasFuel": true,
- "FuelCapacity": 15.5,
- "IsAsset": true,
- "IsSerialized": true,
- "IsCustomerWorkOrderItem": true,
- "IsGenericWorkOrderItem": true,
- "LoadingRatio": 100,
- "Manufacturer": "Caterpillar",
- "ModelName": "305E2",
- "ModelNumber": "CAT305E2-2023",
- "ModelYear": "2023",
- "ProductId": "PROD-CAT305E2",
- "PurchaseDateTime": "2023-01-15T08:30:00Z",
- "PurchasePrice": 65000,
- "Quantity": 1,
- "SerialNumber": "CAT305E2ABC123456",
- "Status": "Available",
- "CreatedDateTime": "2023-01-15T08:30:00Z",
- "UpdatedDateTime": "2023-06-15T14:30:00Z"
}
]Supported by: Elite
Update an existing Stock record by StockId
| StockId required | string |
| SerialNumber | string or null Default: "null" The unique serial number of the stock item. For equipment, this is typically the manufacturer's serial number (e.g., 'CAT0123456789' for a Caterpillar excavator). For parts or consumables without a manufacturer serial, use your internal tracking number. |
object or null Default: {"Alias":"MINI-EX-35","Barcode":"EQ-123456"} Additional identifying information for tracking the stock item in the system | |
object Default: {"TotalDepreciation":15000,"CurrentValue":30000} | |
object Default: {"CaseQuantity":12,"CriticalLevel":5,"GlNumber":"15200","RentalCaseQuantity":1,"ReorderMaximum":50,"ReorderMinimum":24,"TaxCode":1,"ExternalTaxCode":"PC040100"} |
{- "SerialNumber": "CAT0123456789",
- "Identifiers": {
- "Alias": "MINI-EX-35",
- "Barcode": "EQ-123456"
}, - "Depreciation": {
- "TotalDepreciation": 15000,
- "CurrentValue": 30000
}, - "AdditionalFields": {
- "CaseQuantity": 12,
- "CriticalLevel": 5,
- "GlNumber": "15200",
- "RentalCaseQuantity": 1,
- "ReorderMaximum": 50,
- "ReorderMinimum": 24,
- "TaxCode": 1,
- "ExternalTaxCode": "PC040100"
}
}{- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "CategoryName": "Mini Excavators",
- "Classification": "Rental",
- "DepartmentId": "DEPT-EARTHMOVING",
- "DepartmentName": "Earthmoving Equipment",
- "DepotId": "DEPOT-DALLAS",
- "HasFuel": true,
- "FuelCapacity": 15.5,
- "IsAsset": true,
- "IsSerialized": true,
- "IsCustomerWorkOrderItem": true,
- "IsGenericWorkOrderItem": true,
- "LoadingRatio": 100,
- "Manufacturer": "Caterpillar",
- "ModelName": "305E2",
- "ModelNumber": "CAT305E2-2023",
- "ModelYear": "2023",
- "ProductId": "PROD-CAT305E2",
- "PurchaseDateTime": "2023-01-15T08:30:00Z",
- "PurchasePrice": 65000,
- "Quantity": 1,
- "SerialNumber": "CAT305E2ABC123456",
- "Status": "Available",
- "CreatedDateTime": "2023-01-15T08:30:00Z",
- "UpdatedDateTime": "2023-06-15T14:30:00Z"
}Supported by: Elite, Syrinx
| StockId required | string |
{- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "CategoryName": "Mini Excavators",
- "Classification": "Rental",
- "DepartmentId": "DEPT-EARTHMOVING",
- "DepartmentName": "Earthmoving Equipment",
- "DepotId": "DEPOT-DALLAS",
- "HasFuel": true,
- "FuelCapacity": 15.5,
- "IsAsset": true,
- "IsSerialized": true,
- "IsCustomerWorkOrderItem": true,
- "IsGenericWorkOrderItem": true,
- "LoadingRatio": 100,
- "Manufacturer": "Caterpillar",
- "ModelName": "305E2",
- "ModelNumber": "CAT305E2-2023",
- "ModelYear": "2023",
- "ProductId": "PROD-CAT305E2",
- "PurchaseDateTime": "2023-01-15T08:30:00Z",
- "PurchasePrice": 65000,
- "Quantity": 1,
- "SerialNumber": "CAT305E2ABC123456",
- "Status": "Available",
- "CreatedDateTime": "2023-01-15T08:30:00Z",
- "UpdatedDateTime": "2023-06-15T14:30:00Z"
}Supported by: Elite, Syrinx
Retrieve realtime Availability for a single Stock record by Id
| StockId required | string |
{- "ModelType": "StockAvailability",
- "Id": "SA-12345678-90AB-CDEF",
- "Name": "CAT 305E2 #SN12345",
- "Identifiers": {
- "Key": "MINI-EX-305E2-12345"
}, - "StockId": "STK-98765432-10FE-DCBA",
- "StockName": "Caterpillar 305E2 Mini Excavator",
- "SerialNumber": "CAT0305E2ABCD12345",
- "DepotId": "DEPOT-001-CHICAGO",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "AvailableQuantity": 1,
- "ExpectedQuantity": 3,
- "TotalQuantity": 5,
- "QtyExpected": 3
}Gets all the work orders for a stock item
| StockId required | string |
{- "ModelType": "WorkOrder",
- "Id": "WO-20240315-1234",
- "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
- "StockId": "STOCK-CAT320-789",
- "StockName": "2022 CAT 320 Excavator",
- "DepotId": "DEPOT-DALLAS-001",
- "OpenDateTime": "2024-03-15T08:00:00Z",
- "CloseDateTime": "2024-03-15T16:30:00Z",
- "CustomerId": "CUST-ACME-001",
- "Status": "Open",
- "Type": "PM Service",
- "SubType": "250-Hour Service",
- "IsCustomerWO": true,
- "LaborTracking": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
- "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
- "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
- "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
- "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
- "Operation": "250 Hour Preventive Maintenance Service",
- "DueDateTime": "2024-03-17T17:00:00Z",
- "AssignedRemoteUserId": "TECH-JOHN-001",
- "AdditionalFields": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}Supported by: Elite
Add fuel to a contract line itemitem. Returns empty object on success. User can determine if it is successful by checking the response status code. 20X = success, 40X or 50X status codes are failures.
Required fields:
| ContractLineItemId required | string Default: "CLI-2024-0472891" The line item id of the contract that this stock item is associated with. This links the fuel to a specific piece of equipment on a rental contract. |
| FuelStockId required | string Default: "FUEL-DSL-RED-001" The id of the fuel type added. Found either on the line item additional fields, or the fuel info response. Common types include diesel (red or clear) and gasoline. |
| QuantitySold required | number Default: 25.5 Amount of fuel added in gallons/liters (depending on region settings). For example, adding 25.5 gallons of diesel to a mini excavator. |
{- "ContractLineItemId": "CLI-2024-0472891",
- "FuelStockId": "FUEL-DSL-RED-001",
- "QuantitySold": 25.5
}nullSupported by: Elite
Retrieve fuel info for a single Stock record by Id
| StockId required | string |
{- "ModelType": "StockAvailability",
- "Id": "SA-12345678-90AB-CDEF",
- "Name": "CAT 305E2 #SN12345",
- "Identifiers": {
- "Key": "MINI-EX-305E2-12345"
}, - "StockId": "STK-98765432-10FE-DCBA",
- "StockName": "Caterpillar 305E2 Mini Excavator",
- "SerialNumber": "CAT0305E2ABCD12345",
- "DepotId": "DEPOT-001-CHICAGO",
- "StartDateTime": "2024-03-15T08:00:00Z",
- "EndDateTime": "2024-03-22T17:00:00Z",
- "AvailableQuantity": 1,
- "ExpectedQuantity": 3,
- "TotalQuantity": 5,
- "QtyExpected": 3
}Supported by: Elite
Retrieve files for a single Stock by Id.
| StockId required | string |
| tagKey required | string
|
[- {
- "Id": "FILE-2024-001",
- "Name": "equipment-manual.pdf",
- "ContentType": "application/pdf",
}
]Supported by: Elite
Add or remove quantity of bulk Stock records. Quantity IS modifiable here, whereas it is not modifiable on the PATCH /apikey/stock/{StockId} endpoint.
| StockId required | string |
| StockId | string Default: "STK-12345" The unique identifier of the Stock record being adjusted. For example: 'STK-12345' for a specific excavator's stock record or 'STK-78901' for a particular generator's stock entry. |
| QuantityAdjustment required | number Default: 5 The quantity change to apply to the stock level. Use positive numbers for additions (e.g., +5 for receiving new units) and negative numbers for reductions (e.g., -2 for damaged units). Common scenarios: receiving new inventory (+), cycle count adjustments (+/-), damage write-offs (-), theft (-) |
| AdjustmentReason | string or null Default: "New shipment received - PO#45678" Brief explanation for the stock adjustment. Examples: 'New shipment received', 'Cycle count adjustment', 'Damaged in transit', 'Annual inventory reconciliation', 'Write-off due to theft' |
| DepotId | string or null Default: "DEP-001" Location identifier where the stock adjustment is occurring. Examples: 'DEP-001' (Main Warehouse), 'STO-789' (Downtown Rental Center), 'COM-456' (West Coast Branch) |
| ProductId | string or null Default: "PRD-5566" Product identifier for the item being adjusted. Examples: 'PRD-5566' (CAT 305E2 Mini Excavator), 'PRD-7788' (Honda EU2200i Generator), 'PRD-9900' (Genie S-65 Boom Lift) |
| PurchaseDateTime | string or null <date-time> Default: "2024-03-15T14:30:00Z" The date and time when the stock was purchased. Important for depreciation calculations and warranty tracking. Format: ISO 8601 datetime |
| PurchasePrice | number or null Default: 50000 The purchase price per unit in the system's base currency. Examples: 50000.00 for a mini excavator, 1200.00 for a generator, 75000.00 for a boom lift. Used for asset valuation and depreciation calculations. |
{- "StockId": "STK-12345",
- "QuantityAdjustment": 5,
- "AdjustmentReason": "New shipment received - PO#45678",
- "DepotId": "DEP-001",
- "ProductId": "PRD-5566",
- "PurchaseDateTime": "2024-03-15T14:30:00Z",
- "PurchasePrice": 50000
}{- "ModelType": "Stock",
- "Id": "STK-12345",
- "Name": "CAT 305E2 Mini Excavator #123",
- "CategoryIds": [
- "CAT-EXCAVATOR-MINI"
], - "CategoryName": "Mini Excavators",
- "Classification": "Rental",
- "DepartmentId": "DEPT-EARTHMOVING",
- "DepartmentName": "Earthmoving Equipment",
- "DepotId": "DEPOT-DALLAS",
- "HasFuel": true,
- "FuelCapacity": 15.5,
- "IsAsset": true,
- "IsSerialized": true,
- "IsCustomerWorkOrderItem": true,
- "IsGenericWorkOrderItem": true,
- "LoadingRatio": 100,
- "Manufacturer": "Caterpillar",
- "ModelName": "305E2",
- "ModelNumber": "CAT305E2-2023",
- "ModelYear": "2023",
- "ProductId": "PROD-CAT305E2",
- "PurchaseDateTime": "2023-01-15T08:30:00Z",
- "PurchasePrice": 65000,
- "Quantity": 1,
- "SerialNumber": "CAT305E2ABC123456",
- "Status": "Available",
- "CreatedDateTime": "2023-01-15T08:30:00Z",
- "UpdatedDateTime": "2023-06-15T14:30:00Z"
}Supported by: Elite
Create a new Vendor
Required fields:
| Name | string or null [ 1 .. 50 ] characters Default: "Equipment Supply Co" The full name of the vendor. Could be a company or an individual. Examples:
|
object or null Identifying items for Vendor. Examples:
| |
Array of objects Supported types will depend on the product. Examples:
Elite:
| |
Array of objects Name and Types of Contacts related to the Vendor. Examples:
| |
| CurrencyCode | string or null Default: "USD" Defaults to "USD". Code is ISO 4217 format. Examples:
You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field. |
| Inactive | boolean or null Used to denote whether a vendor is considered active. Examples:
|
Array of objects Any comments or notes. Examples:
| |
Array of objects | |
| Terms | string or null <= 50 characters Billing terms for the vendor. Examples:
|
object or null Additional fields specific to each vendor. Examples include:
|
{- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30"
}{- "ModelType": "Vendor",
- "Id": "VEN-001",
- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite, Syrinx
Elite supports the following fields for the Search filter:
[- {
- "ModelType": "Vendor",
- "Id": "VEN-001",
- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}
]Supported by: Elite, Syrinx
| VendorId required | string |
{- "ModelType": "Vendor",
- "Id": "VEN-001",
- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite
Update a single Vendor by Id
Required fields:
| VendorId required | string |
| Name | string or null [ 1 .. 50 ] characters Default: "Equipment Supply Co" The full name of the vendor. Could be a company or an individual. Examples:
|
object or null Identifying items for Vendor. Examples:
| |
Array of objects Supported types will depend on the product. Examples:
Elite:
| |
Array of objects Name and Types of Contacts related to the Vendor. Examples:
| |
| CurrencyCode | string or null Default: "USD" Defaults to "USD". Code is ISO 4217 format. Examples:
You can hit the /vendors/lookup/{Field} endpoint and pass in the query parameter "Field" --> "CurrencyCode" to receive a list of acceptable values for this field. |
| Inactive | boolean or null Used to denote whether a vendor is considered active. Examples:
|
Array of objects Any comments or notes. Examples:
| |
Array of objects | |
| Terms | string or null <= 50 characters Billing terms for the vendor. Examples:
|
object or null Additional fields specific to each vendor. Examples include:
|
{- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30"
}{- "ModelType": "Vendor",
- "Id": "VEN-001",
- "Name": "Equipment Supply Co",
- "VendorNumber": "V1234",
- "TaxId": "12-3456789",
- "Address": {
- "Line1": "789 Supplier Lane",
- "City": "Dallas",
- "Province": "TX",
- "PostalCode": "75203"
}, - "ContactName": "Bob Johnson",
- "ContactPhone": "214-555-4321",
- "PaymentTerms": "NET30",
- "Status": "Active",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite
With this endpoint, you can look up dynamic enum values for Vendor fields. The description on a particular field will indicate if it supports a lookup.
| field required | string |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Create a work order
| StockId | string or null Default: "25266" Unique identifier of the equipment being serviced. Example: 'STOCK-JD320D-123' |
| StockName | string or null Default: "SOD CUTTER, 18\"" Descriptive name of the equipment being serviced. Example: '2019 John Deere 320D Excavator' |
| DepotId | string or null Default: "002" Identifier of the service location or branch. Example: 'DEPOT-CHICAGO-001' |
| OpenDateTime | string or null <date-time> Default: "2017-11-29T21:48:00Z" When the work order was opened. Example: '2024-03-15T09:00:00Z' |
| CloseDateTime | string or null <date-time> Default: "2017-11-30T17:59:00Z" When the work order was completed. Example: '2024-03-15T16:30:00Z' |
| CustomerId | string or null Default: "51963" Reference to the customer responsible for this Work Order. Example: 'CUST-ACME-001' |
| Status | string Default: "Closed" Enum: "Quote" "Open" "Closed" Current status of the work order. 'Quote' for estimates, 'Open' for active work, 'Closed' for completed work. |
| Type | string or null Default: "Internal Repair" Primary classification of the work order. Example: 'Preventive Maintenance', 'Repair', 'Inspection' |
| SubType | string or null Secondary classification of the work order. Example: '500 Hour Service', 'Hydraulic System', 'Annual DOT' |
Array of objects or strings or null Default: [] | |
| IsCustomerWO | boolean Indicates if this is a customer-facing work order. Example: true for customer repairs, false for internal maintenance |
| Complaint | string The issue detected by the technician. Example: 'Hydraulic system losing pressure during operation' |
| Cause | string The identified root cause of the issue. Example: 'Worn hydraulic pump seals causing internal leakage' |
| Correction | string The repair actions taken. Example: 'Replaced hydraulic pump seals and tested system pressure' |
| ReportedIssue | string Default: "Broken blade drive belt" The initial problem reported by the customer. Example: 'Machine is slow to lift' |
| OtherComments | string Additional notes about the work order. Example: 'Customer requested completion by end of week' |
| Operation | string Default: "Repair complete" Specific maintenance or repair operation to be performed. Use the "Name" field from the operations lookup endpoint (workorders/lookup/operations or workorders/lookup/consumerOperations) to display the operation to the user. |
| DueDateTime | string <date-time> Default: "2017-11-30T17:59:00Z" When the work order needs to be completed. Example: '2024-03-20T17:00:00Z' |
| Hidden | integer or null Value: 1 Flag to hide work order from normal views. 0 = visible, 1 = hidden |
{- "ModelType": "WorkOrder",
- "Id": "r962692",
- "Name": "r962692",
- "ReportedIssue": "Broken blade drive belt",
- "Identifiers": { },
- "CloseDateTime": "2017-11-30T17:59:00Z",
- "CustomerId": "51963",
- "DepotId": "002",
- "OpenDateTime": "2017-11-29T21:48:00Z",
- "DueDateTime": "2017-11-30T17:59:00Z",
- "Parts": [ ],
- "Status": "Closed",
- "StockId": "25266",
- "StockName": "SOD CUTTER, 18\"",
- "Type": "Internal Repair",
- "Operation": "Repair complete",
- "LaborTracking": {
- "LaborTypes": [ ]
}, - "AdditionalFields": { },
- "CreatedDateTime": "2017-11-29T21:50:11.377Z",
- "UpdatedDateTime": "2017-11-30T18:00:01.813Z"
}{- "ModelType": "WorkOrder",
- "Id": "WO-20240315-1234",
- "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
- "StockId": "STOCK-CAT320-789",
- "StockName": "2022 CAT 320 Excavator",
- "DepotId": "DEPOT-DALLAS-001",
- "OpenDateTime": "2024-03-15T08:00:00Z",
- "CloseDateTime": "2024-03-15T16:30:00Z",
- "CustomerId": "CUST-ACME-001",
- "Status": "Open",
- "Type": "PM Service",
- "SubType": "250-Hour Service",
- "IsCustomerWO": true,
- "LaborTracking": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
- "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
- "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
- "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
- "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
- "Operation": "250 Hour Preventive Maintenance Service",
- "DueDateTime": "2024-03-17T17:00:00Z",
- "AssignedRemoteUserId": "TECH-JOHN-001",
- "AdditionalFields": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}[- {
- "ModelType": "WorkOrder",
- "Id": "WO-20240315-1234",
- "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
- "StockId": "STOCK-CAT320-789",
- "StockName": "2022 CAT 320 Excavator",
- "DepotId": "DEPOT-DALLAS-001",
- "OpenDateTime": "2024-03-15T08:00:00Z",
- "CloseDateTime": "2024-03-15T16:30:00Z",
- "CustomerId": "CUST-ACME-001",
- "Status": "Open",
- "Type": "PM Service",
- "SubType": "250-Hour Service",
- "IsCustomerWO": true,
- "LaborTracking": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
- "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
- "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
- "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
- "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
- "Operation": "250 Hour Preventive Maintenance Service",
- "DueDateTime": "2024-03-17T17:00:00Z",
- "AssignedRemoteUserId": "TECH-JOHN-001",
- "AdditionalFields": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}
]Retrieve a single work order by its id
| WorkOrderId required | string |
{- "ModelType": "WorkOrder",
- "Id": "WO-20240315-1234",
- "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
- "StockId": "STOCK-CAT320-789",
- "StockName": "2022 CAT 320 Excavator",
- "DepotId": "DEPOT-DALLAS-001",
- "OpenDateTime": "2024-03-15T08:00:00Z",
- "CloseDateTime": "2024-03-15T16:30:00Z",
- "CustomerId": "CUST-ACME-001",
- "Status": "Open",
- "Type": "PM Service",
- "SubType": "250-Hour Service",
- "IsCustomerWO": true,
- "LaborTracking": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
- "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
- "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
- "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
- "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
- "Operation": "250 Hour Preventive Maintenance Service",
- "DueDateTime": "2024-03-17T17:00:00Z",
- "AssignedRemoteUserId": "TECH-JOHN-001",
- "AdditionalFields": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}Update a single work order by its id
| WorkOrderId required | string |
| StockId | string or null Default: "25266" Unique identifier of the equipment being serviced. Example: 'STOCK-JD320D-123' |
| StockName | string or null Default: "SOD CUTTER, 18\"" Descriptive name of the equipment being serviced. Example: '2019 John Deere 320D Excavator' |
| DepotId | string or null Default: "002" Identifier of the service location or branch. Example: 'DEPOT-CHICAGO-001' |
| OpenDateTime | string or null <date-time> Default: "2017-11-29T21:48:00Z" When the work order was opened. Example: '2024-03-15T09:00:00Z' |
| CloseDateTime | string or null <date-time> Default: "2017-11-30T17:59:00Z" When the work order was completed. Example: '2024-03-15T16:30:00Z' |
| CustomerId | string or null Default: "51963" Reference to the customer responsible for this Work Order. Example: 'CUST-ACME-001' |
| Status | string Default: "Closed" Enum: "Quote" "Open" "Closed" Current status of the work order. 'Quote' for estimates, 'Open' for active work, 'Closed' for completed work. |
| Type | string or null Default: "Internal Repair" Primary classification of the work order. Example: 'Preventive Maintenance', 'Repair', 'Inspection' |
| SubType | string or null Secondary classification of the work order. Example: '500 Hour Service', 'Hydraulic System', 'Annual DOT' |
Array of objects or strings or null Default: [] | |
| IsCustomerWO | boolean Indicates if this is a customer-facing work order. Example: true for customer repairs, false for internal maintenance |
| Complaint | string The issue detected by the technician. Example: 'Hydraulic system losing pressure during operation' |
| Cause | string The identified root cause of the issue. Example: 'Worn hydraulic pump seals causing internal leakage' |
| Correction | string The repair actions taken. Example: 'Replaced hydraulic pump seals and tested system pressure' |
| ReportedIssue | string Default: "Broken blade drive belt" The initial problem reported by the customer. Example: 'Machine is slow to lift' |
| OtherComments | string Additional notes about the work order. Example: 'Customer requested completion by end of week' |
| Operation | string Default: "Repair complete" Specific maintenance or repair operation to be performed. Use the "Name" field from the operations lookup endpoint (workorders/lookup/operations or workorders/lookup/consumerOperations) to display the operation to the user. |
| DueDateTime | string <date-time> Default: "2017-11-30T17:59:00Z" When the work order needs to be completed. Example: '2024-03-20T17:00:00Z' |
| Hidden | integer or null Value: 1 Flag to hide work order from normal views. 0 = visible, 1 = hidden |
{- "ModelType": "WorkOrder",
- "Id": "r962692",
- "Name": "r962692",
- "ReportedIssue": "Broken blade drive belt",
- "Identifiers": { },
- "CloseDateTime": "2017-11-30T17:59:00Z",
- "CustomerId": "51963",
- "DepotId": "002",
- "OpenDateTime": "2017-11-29T21:48:00Z",
- "DueDateTime": "2017-11-30T17:59:00Z",
- "Parts": [ ],
- "Status": "Closed",
- "StockId": "25266",
- "StockName": "SOD CUTTER, 18\"",
- "Type": "Internal Repair",
- "Operation": "Repair complete",
- "LaborTracking": {
- "LaborTypes": [ ]
}, - "AdditionalFields": { },
- "CreatedDateTime": "2017-11-29T21:50:11.377Z",
- "UpdatedDateTime": "2017-11-30T18:00:01.813Z"
}{- "ModelType": "WorkOrder",
- "Id": "WO-20240315-1234",
- "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
- "StockId": "STOCK-CAT320-789",
- "StockName": "2022 CAT 320 Excavator",
- "DepotId": "DEPOT-DALLAS-001",
- "OpenDateTime": "2024-03-15T08:00:00Z",
- "CloseDateTime": "2024-03-15T16:30:00Z",
- "CustomerId": "CUST-ACME-001",
- "Status": "Open",
- "Type": "PM Service",
- "SubType": "250-Hour Service",
- "IsCustomerWO": true,
- "LaborTracking": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
- "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
- "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
- "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
- "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
- "Operation": "250 Hour Preventive Maintenance Service",
- "DueDateTime": "2024-03-17T17:00:00Z",
- "AssignedRemoteUserId": "TECH-JOHN-001",
- "AdditionalFields": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}Retrieve a list of work order parts
| WorkOrderId required | string |
[- {
- "ModelType": "WorkOrderPart",
- "Id": "WOP-12345-6789",
- "Classification": "Sale",
- "Name": "Oil Filter 10 Micron",
- "IsBulk": true,
- "ProductId": "FILTER-10M",
- "PullFromStock": true,
- "PurchasePrice": 45.99,
- "Quantity": "2",
- "SerialNumber": "CAT123456",
- "Status": "Out",
- "StockId": "BIN-A123",
- "Comments": "Customer requested OEM parts only",
- "CreatedDateTime": "2024-03-15T14:30:00Z",
- "UpdatedDateTime": "2024-03-16T09:15:00Z"
}
]Create a work order part
| WorkOrderId required | string |
| Name | string Default: "Crystal Schoen" The display name for this record, typically including the part name and any relevant specifications. For example: '1/2" Hydraulic Hose - 10ft' or 'Air Filter - CAT 259D3' |
| IsBulk | boolean or null Items with this field do not have unique serial numbers. For example, nuts, bolts, and fluids are bulk items (true), while engines and transmissions are not bulk items (false). If isSerialized and isBulk are both true, then an alternate serialization method is being used. |
| IsSerialized | boolean or null Indicates whether we expect this Line Item to have a unique Serial Number. For example, major components like engines (true) vs consumables like oil filters (false). NOTE: If isSerialized and isBulk are both true, then an alternate serialization method is being used. |
| ProductId | string or null If exists, this is a reference to the header "Item" or "Inventory" record. Could even be a "Category". For example: 'HYD-HOSE-12' for hydraulic hose category or 'ENG-CAT-3126' for a specific engine model. |
| PullFromStock | boolean or null Indicates if the items should be pulled from stock when added to a work order. For example, common parts like filters and fluids (true) vs special order items (false). |
| PurchasePrice | number or null The purchase price of the part. For example: 45.99 for a standard air filter or 2500.00 for a hydraulic pump. |
| Quantity | string or null The quantity of this part on the work order. For example: '2' for two air filters or '10.5' for 10.5 feet of hydraulic hose. |
| StockId | string or null Id of stock item in inventory. For example: 'STK-HYD-001' for a specific hydraulic component or 'STK-FIL-002' for a specific filter in inventory. |
| Comments | string Default: "majority" Any comments for this part, such as installation notes, condition observations, or special handling instructions. For example: 'Replace gasket during installation' or 'Customer requested OEM parts only' |
{- "Name": "Crystal Schoen",
- "Comments": "majority"
}{- "ModelType": "WorkOrderPart",
- "Id": "WOP-12345-6789",
- "Classification": "Sale",
- "Name": "Oil Filter 10 Micron",
- "IsBulk": true,
- "ProductId": "FILTER-10M",
- "PullFromStock": true,
- "PurchasePrice": 45.99,
- "Quantity": "2",
- "SerialNumber": "CAT123456",
- "Status": "Out",
- "StockId": "BIN-A123",
- "Comments": "Customer requested OEM parts only",
- "CreatedDateTime": "2024-03-15T14:30:00Z",
- "UpdatedDateTime": "2024-03-16T09:15:00Z"
}Supported by: Elite, Essentials, Syrinx
Creates a work order from Record360 inspection webhook payload. Validates the inspection data and extracts work order creation information.
| id required | string Default: 405 Event id from Record360 |
| object required | string Default: "event" Value: "event" Specifies you are receiving an event object |
| type required | string Default: "inspection.updated" Enum: "inspection.created" "inspection.updated" "inspection.completed" Type of event from Record360 |
| created_at required | string <date-time> Default: "2024-12-20T08:29:04.332Z" When the event was created |
required | object Default: {"id":78,"object":"inspection","type":"maintenance","location":{"id":203,"name":"Nettie Hyatt Jr."},"damage_present":true,"unit":{"id":22,"reference_number":"mouser"},"user":{"id":947,"username":"Etha.Reinger33"},"results":["Computer","Keyboard","Tuna"],"workflow":"blowgun","dashboard_url":"https://alarmed-goat.net/","photos":[{"url":"https://outstanding-heroine.name/","instruction_id":875},{"url":"https://spiteful-devastation.biz","instruction_id":739},{"url":"https://meager-opera.com","instruction_id":341}],"videos":[{"url":"https://forsaken-hippodrome.com/"}],"signatures":[{"url":"https://querulous-papa.com/"},{"url":"https://personal-advancement.info/"},{"url":"https://acclaimed-chops.org"}],"created_at":"2026-07-06T04:48:45.665Z","updated_at":"2026-08-30T23:44:37.946Z"} The inspection data from Record360 |
{- "id": 405,
- "object": "event",
- "type": "inspection.updated",
- "created_at": "2024-12-20T08:29:04.332Z",
- "data": {
- "id": 78,
- "object": "inspection",
- "type": "maintenance",
- "location": {
- "id": 203,
- "name": "Nettie Hyatt Jr."
}, - "damage_present": true,
- "unit": {
- "id": 22,
- "reference_number": "mouser"
}, - "user": {
- "id": 947,
- "username": "Etha.Reinger33"
}, - "results": [
- "Computer",
- "Keyboard",
- "Tuna"
], - "workflow": "blowgun",
- "photos": [
], - "signatures": [
], - "created_at": "2026-07-06T04:48:45.665Z",
- "updated_at": "2026-08-30T23:44:37.946Z"
}
}{- "ModelType": "WorkOrder",
- "Id": "WO-20240315-1234",
- "Name": "WO-20240315-1234 - ACME Construction - CAT 320 Excavator PM Service",
- "StockId": "STOCK-CAT320-789",
- "StockName": "2022 CAT 320 Excavator",
- "DepotId": "DEPOT-DALLAS-001",
- "OpenDateTime": "2024-03-15T08:00:00Z",
- "CloseDateTime": "2024-03-15T16:30:00Z",
- "CustomerId": "CUST-ACME-001",
- "Status": "Open",
- "Type": "PM Service",
- "SubType": "250-Hour Service",
- "IsCustomerWO": true,
- "LaborTracking": {
- "LaborTypes": [
- {
- "Description": "Mechanical Labor",
- "Value": "4.5"
}, - {
- "Description": "Diagnostic Time",
- "Value": "1.0"
}
]
}, - "Complaint": "Excessive hydraulic noise when operating boom functions, visible oil leak at main pump",
- "Cause": "Failed seal in main hydraulic pump allowing air infiltration and internal wear",
- "Correction": "Removed and replaced main hydraulic pump assembly, performed system flush, replaced filters, and tested all functions",
- "ReportedIssue": "Customer reports loud noise from hydraulic system and oil spots under machine",
- "OtherComments": "Customer requested notification before proceeding with repairs over $1000. Machine is needed back in service by Friday.",
- "Operation": "250 Hour Preventive Maintenance Service",
- "DueDateTime": "2024-03-17T17:00:00Z",
- "AssignedRemoteUserId": "TECH-JOHN-001",
- "AdditionalFields": {
- "purchaseOrderNumber": "PO-4567",
- "warrantyCase": "WC-789",
- "mileageReading": "1234.5"
}, - "CreatedDateTime": "2024-03-15T08:00:00Z",
- "UpdatedDateTime": "2024-03-15T16:30:00Z"
}Supported by: Elite
With this endpoint, you receive an array of contract operations supported by the current organization for the internal Work Order. This response is similar to the other EnumLookup responses.
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Supported by: Elite
With this endpoint, you receive an array of consumer operations supported by the current organization for the customer. This response is similar to the other EnumLookup responses.
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
][- {
- "description": "Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.",
- "type": "object",
- "properties": {
- "ModelType": {
- "type": "string",
- "enum": [
- "HireRate"
]
}, - "Id": {
- "type": "string"
}, - "Name": {
- "type": "string"
}, - "CategoryName": {
- "description": "The category that the hire rate belongs to.",
- "type": "string"
}, - "DayRate": {
- "description": "The flat rate to charge for a single day.",
- "type": "number"
}, - "HourRate": {
- "description": "The rate to charge per hour.",
- "type": "number"
}, - "WeekRate": {
- "description": "The rate to charge per week.",
- "type": "number"
}, - "WeekRateHalfDay": {
- "description": "The rate to charge for half a week day.",
- "type": "number"
}, - "WeekRate1Day": {
- "description": "The rate to charge for a week day.",
- "type": "number"
}, - "WeekRate2Day": {
- "description": "The rate to charge for 2 week days.",
- "type": "number"
}, - "WeekRate3Day": {
- "description": "The rate to charge for 3 week days.",
- "type": "number"
}, - "WeekRate4Day": {
- "description": "The rate to charge for 4 week days.",
- "type": "number"
}, - "WeekendRate": {
- "description": "The rate to charge over a weekend.",
- "type": "number"
}, - "MonthRate": {
- "description": "The rate to charge per month.",
- "type": "number"
}
}
}
]Supported by: Syrinx
| HireRateId required | string |
[- {
- "description": "Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.",
- "type": "object",
- "properties": {
- "ModelType": {
- "type": "string",
- "enum": [
- "HireRate"
]
}, - "Id": {
- "type": "string"
}, - "Name": {
- "type": "string"
}, - "CategoryName": {
- "description": "The category that the hire rate belongs to.",
- "type": "string"
}, - "DayRate": {
- "description": "The flat rate to charge for a single day.",
- "type": "number"
}, - "HourRate": {
- "description": "The rate to charge per hour.",
- "type": "number"
}, - "WeekRate": {
- "description": "The rate to charge per week.",
- "type": "number"
}, - "WeekRateHalfDay": {
- "description": "The rate to charge for half a week day.",
- "type": "number"
}, - "WeekRate1Day": {
- "description": "The rate to charge for a week day.",
- "type": "number"
}, - "WeekRate2Day": {
- "description": "The rate to charge for 2 week days.",
- "type": "number"
}, - "WeekRate3Day": {
- "description": "The rate to charge for 3 week days.",
- "type": "number"
}, - "WeekRate4Day": {
- "description": "The rate to charge for 4 week days.",
- "type": "number"
}, - "WeekendRate": {
- "description": "The rate to charge over a weekend.",
- "type": "number"
}, - "MonthRate": {
- "description": "The rate to charge per month.",
- "type": "number"
}
}
}
]Supported by: Elite
This is a list of account payable invoices. By default you can retrieve a list of payable invoices where State property is equal to 'Pending'. Apply an additional filter to the the State property in order to receive other payable invoices states.
[- {
- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2024-11-28T15:44:54.502Z",
- "FreightTotal": 237.07,
- "GrandTaxTotal": 635.11,
- "GrandTotal": 123.43,
- "Identifiers": {
- "BatchId": 993,
- "ContractStoreId": 498,
- "ExternalLocationId": 167,
- "ExternalPayableId": 651,
- "ExternalVendorId": 130,
- "FreightAccountId": 783,
- "MiscellaneousAccountId": 374,
- "PayableAccountId": 878,
- "TaxAccountId": 347
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 402,
- "ExtendedUnitTotal": 614.31,
- "FreightTotal": 96.93,
- "GrandTaxTotal": 274.22,
- "GrandTotal": 4.79,
- "Identifiers": {
- "AccountNumberId": 758,
- "ExternalPayableId": 743,
- "InvoiceId": 168
}, - "Item": {
- "ModelType": "Item",
- "Id": 554,
- "Description": "SAMPLE: feminize slip whether scarification aw minus gadzooks short-term without bobble",
- "Key": "dulcimer"
}, - "LineNumber": 123,
- "MiscellaneousTotal": "louse",
- "PurchaseOrderNumber": "lift",
- "PurchaseOrderPartNumber": "scarification",
- "PurchaseOrderSequenceNumber": "procurement",
- "QuantityOrdered": 54.94,
- "QuantityReceived": 108.27,
- "ReceivedDateTime": "2025-05-14T00:44:24.163Z",
- "UnitTotal": 565.14
}
], - "MiscellaneousTotal": 906.13,
- "PurchaseOrderNumber": "surface",
- "PurchaseOrderSequenceNumber": "cauliflower",
- "PurchaseTotal": 27.72,
- "ShippingMethod": "disadvantage",
- "State": "Posted",
- "TermsCode": "accountability",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 220,
- "Name": "Tommie Dibbert",
- "InvoiceNumber": "zen",
- "InvoiceDateTime": "2025-02-02T21:27:08.074Z",
- "InvoiceDueDateTime": "2026-09-19T11:16:36.997Z"
}
}
]Supported by: Elite
This is a single account payable invoice retrieved by the given payable invoice id.
| InvoiceId required | string |
{- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2024-11-28T15:44:54.502Z",
- "FreightTotal": 237.07,
- "GrandTaxTotal": 635.11,
- "GrandTotal": 123.43,
- "Identifiers": {
- "BatchId": 993,
- "ContractStoreId": 498,
- "ExternalLocationId": 167,
- "ExternalPayableId": 651,
- "ExternalVendorId": 130,
- "FreightAccountId": 783,
- "MiscellaneousAccountId": 374,
- "PayableAccountId": 878,
- "TaxAccountId": 347
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 402,
- "ExtendedUnitTotal": 614.31,
- "FreightTotal": 96.93,
- "GrandTaxTotal": 274.22,
- "GrandTotal": 4.79,
- "Identifiers": {
- "AccountNumberId": 758,
- "ExternalPayableId": 743,
- "InvoiceId": 168
}, - "Item": {
- "ModelType": "Item",
- "Id": 554,
- "Description": "SAMPLE: feminize slip whether scarification aw minus gadzooks short-term without bobble",
- "Key": "dulcimer"
}, - "LineNumber": 123,
- "MiscellaneousTotal": "louse",
- "PurchaseOrderNumber": "lift",
- "PurchaseOrderPartNumber": "scarification",
- "PurchaseOrderSequenceNumber": "procurement",
- "QuantityOrdered": 54.94,
- "QuantityReceived": 108.27,
- "ReceivedDateTime": "2025-05-14T00:44:24.163Z",
- "UnitTotal": 565.14
}
], - "MiscellaneousTotal": 906.13,
- "PurchaseOrderNumber": "surface",
- "PurchaseOrderSequenceNumber": "cauliflower",
- "PurchaseTotal": 27.72,
- "ShippingMethod": "disadvantage",
- "State": "Posted",
- "TermsCode": "accountability",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 220,
- "Name": "Tommie Dibbert",
- "InvoiceNumber": "zen",
- "InvoiceDateTime": "2025-02-02T21:27:08.074Z",
- "InvoiceDueDateTime": "2026-09-19T11:16:36.997Z"
}
}Supported by: Elite
Update an existing Account Payable Invoice
| InvoiceId required | string |
| ErrorCode | string or null Error code value whenever the payable invoice |
| ErrorDescription | string or null Error description value whenever payable invoice |
object Default: {"BatchId":67,"ContractStoreId":46,"ExternalLocationId":681,"ExternalPayableId":854,"ExternalVendorId":831,"FreightAccountId":919,"MiscellaneousAccountId":501,"PayableAccountId":378,"TaxAccountId":913} Collection of unique ids related to this payable invoice. | |
| State | string Default: "Error" Enum: "Pending" "Posted" "Error" Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state. |
{- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2025-10-03T15:10:11.104Z",
- "FreightTotal": 156.99,
- "GrandTaxTotal": 212.73,
- "GrandTotal": 4.01,
- "Identifiers": {
- "BatchId": 67,
- "ContractStoreId": 46,
- "ExternalLocationId": 681,
- "ExternalPayableId": 854,
- "ExternalVendorId": 831,
- "FreightAccountId": 919,
- "MiscellaneousAccountId": 501,
- "PayableAccountId": 378,
- "TaxAccountId": 913
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 632,
- "ExtendedUnitTotal": 421.53,
- "FreightTotal": 428.71,
- "GrandTaxTotal": 799.69,
- "GrandTotal": 513.59,
- "Identifiers": {
- "AccountNumberId": 809,
- "ExternalPayableId": 930,
- "InvoiceId": 458
}, - "Item": {
- "ModelType": "Item",
- "Id": 795,
- "Description": "SAMPLE: hourly splendid out magnetize quizzically emphasise between waist how successfully",
- "Key": "fundraising"
}, - "LineNumber": 225,
- "MiscellaneousTotal": "farmer",
- "PurchaseOrderNumber": "place",
- "PurchaseOrderPartNumber": "markup",
- "PurchaseOrderSequenceNumber": "embossing",
- "QuantityOrdered": 268.04,
- "QuantityReceived": 314.69,
- "ReceivedDateTime": "2025-06-17T14:49:43.564Z",
- "UnitTotal": 567.81
}
], - "MiscellaneousTotal": 457.9,
- "PurchaseOrderNumber": "essence",
- "PurchaseOrderSequenceNumber": "recommendation",
- "PurchaseTotal": 899.89,
- "ShippingMethod": "shore",
- "State": "Error",
- "TermsCode": "smoke",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 672,
- "Name": "Deanna Powlowski-Moore",
- "InvoiceNumber": "academics",
- "InvoiceDateTime": "2025-05-13T17:57:39.551Z",
- "InvoiceDueDateTime": "2025-10-07T21:28:34.392Z"
}
}{- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2024-11-28T15:44:54.502Z",
- "FreightTotal": 237.07,
- "GrandTaxTotal": 635.11,
- "GrandTotal": 123.43,
- "Identifiers": {
- "BatchId": 993,
- "ContractStoreId": 498,
- "ExternalLocationId": 167,
- "ExternalPayableId": 651,
- "ExternalVendorId": 130,
- "FreightAccountId": 783,
- "MiscellaneousAccountId": 374,
- "PayableAccountId": 878,
- "TaxAccountId": 347
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 402,
- "ExtendedUnitTotal": 614.31,
- "FreightTotal": 96.93,
- "GrandTaxTotal": 274.22,
- "GrandTotal": 4.79,
- "Identifiers": {
- "AccountNumberId": 758,
- "ExternalPayableId": 743,
- "InvoiceId": 168
}, - "Item": {
- "ModelType": "Item",
- "Id": 554,
- "Description": "SAMPLE: feminize slip whether scarification aw minus gadzooks short-term without bobble",
- "Key": "dulcimer"
}, - "LineNumber": 123,
- "MiscellaneousTotal": "louse",
- "PurchaseOrderNumber": "lift",
- "PurchaseOrderPartNumber": "scarification",
- "PurchaseOrderSequenceNumber": "procurement",
- "QuantityOrdered": 54.94,
- "QuantityReceived": 108.27,
- "ReceivedDateTime": "2025-05-14T00:44:24.163Z",
- "UnitTotal": 565.14
}
], - "MiscellaneousTotal": 906.13,
- "PurchaseOrderNumber": "surface",
- "PurchaseOrderSequenceNumber": "cauliflower",
- "PurchaseTotal": 27.72,
- "ShippingMethod": "disadvantage",
- "State": "Posted",
- "TermsCode": "accountability",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 220,
- "Name": "Tommie Dibbert",
- "InvoiceNumber": "zen",
- "InvoiceDateTime": "2025-02-02T21:27:08.074Z",
- "InvoiceDueDateTime": "2026-09-19T11:16:36.997Z"
}
}All Elite account receivable invoices, use query parameters to filter
[- {
- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 905.43,
- "ContractType": "Cash",
- "DamageWaiverTotal": 216.01,
- "Delivery": {
- "Type": "Default",
- "City": "Lake Ottiliehaven",
- "Line1": "787 Willow Close",
- "PostalCode": "05361-7271",
- "Province": "North Carolina"
}, - "GrandTaxTotal": 885.14,
- "GrandTotal": 256.57,
- "Identifiers": {
- "ContractId": 916,
- "BatchId": 266,
- "ContractStoreId": 270,
- "CustomerId": 764,
- "ExternalLocationId": 84,
- "ExternalInvoiceId": 766,
- "ExternalCustomerId": 390,
- "ParentContractId": 340
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 616,
- "AccountingClass": "detective",
- "DamageWaiverPercent": 793.37,
- "DiscountPercent": 17,
- "DiscountTotal": 15,
- "DueDateTime": "2026-09-25T01:15:33.236Z",
- "ExtendedPriceTotal": 355.9,
- "GrandTaxTotal": 999.64,
- "GrandTotal": 623.85,
- "HoursCharged": 954.77,
- "Identifiers": {
- "InvoiceId": 247,
- "ContractId": 27,
- "GeneralLedgerAccountId": 939,
- "GeneralLedgerOffsetAccountId": 736
}, - "Item": {
- "ModelType": "Item",
- "Id": 572,
- "Name": "Javier Hammes",
- "Key": "necklace",
- "CategoryId": 153,
- "CategoryName": "Kelvin Mann",
- "Description": "SAMPLE: burgeon inure appreciate design wrong meanwhile unsightly ick alert tuber",
- "IsAsset": true,
- "Manufacturer": "mantua",
- "Model": "Maruti ATS",
- "ModelYear": "dusk",
- "SerialNumber": "catalyst",
- "Type": "Retail"
}, - "ItemPercent": "Shirt",
- "LineNumber": 275,
- "Memo": "unique",
- "MeterIn": 372.25,
- "MeterOut": 164.65,
- "NonTaxable": false,
- "OutDateTime": "2026-03-02T02:36:06.361Z",
- "Quantity": 21,
- "TypeId": 647,
- "TypeName": "Credit"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 885,
- "AccountingClass": "cake",
- "DamageWaiverPercent": 222.72,
- "DiscountPercent": 17,
- "DiscountTotal": 39,
- "DueDateTime": "2026-04-24T14:25:02.286Z",
- "ExtendedPriceTotal": 373.05,
- "GrandTaxTotal": 118.92,
- "GrandTotal": 234.98,
- "HoursCharged": 687.4,
- "Identifiers": {
- "InvoiceId": 100,
- "ContractId": 550,
- "GeneralLedgerAccountId": 352,
- "GeneralLedgerOffsetAccountId": 711
}, - "Item": {
- "ModelType": "Item",
- "Id": 75,
- "Name": "Katie Abshire",
- "Key": "remark",
- "CategoryId": 766,
- "CategoryName": "Genevieve Russel IV",
- "Description": "SAMPLE: harmful aboard after gadzooks serenade noisily kookily handful cheetah ramp",
- "IsAsset": true,
- "Manufacturer": "SUV",
- "Model": "Polestar Colorado",
- "ModelYear": "tray",
- "SerialNumber": "almighty",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 264,
- "Memo": "flood",
- "MeterIn": 144.28,
- "MeterOut": 280.1,
- "NonTaxable": true,
- "OutDateTime": "2025-05-20T15:11:18.286Z",
- "Quantity": 92,
- "TypeId": 93,
- "TypeName": "OtherIncome"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 617,
- "AccountingClass": "starboard",
- "DamageWaiverPercent": 205.04,
- "DiscountPercent": 16,
- "DiscountTotal": 100,
- "DueDateTime": "2025-09-29T03:52:21.051Z",
- "ExtendedPriceTotal": 830.82,
- "GrandTaxTotal": 408.76,
- "GrandTotal": 286.17,
- "HoursCharged": 839.11,
- "Identifiers": {
- "InvoiceId": 333,
- "ContractId": 268,
- "GeneralLedgerAccountId": 298,
- "GeneralLedgerOffsetAccountId": 232
}, - "Item": {
- "ModelType": "Item",
- "Id": 413,
- "Name": "Eula Hamill",
- "Key": "cheese",
- "CategoryId": 457,
- "CategoryName": "Tony Halvorson",
- "Description": "SAMPLE: shadowy whistle drat whether enormously who finer skateboard intent freely",
- "IsAsset": false,
- "Manufacturer": "fuel",
- "Model": "Toyota Fiesta",
- "ModelYear": "napkin",
- "SerialNumber": "quit",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 459,
- "Memo": "scratch",
- "MeterIn": 215.24,
- "MeterOut": 534.7,
- "NonTaxable": false,
- "OutDateTime": "2025-09-30T23:17:24.488Z",
- "Quantity": 50,
- "TypeId": 608,
- "TypeName": "SalesTax"
}
], - "OtherTotal": 165.62,
- "PaidTotal": 713.73,
- "RentTotal": 867.11,
- "RevenueDateTime": "2025-07-02T06:12:13.675Z",
- "SaleTotal": "Bike",
- "StartDateTime": "2024-12-11T04:56:18.692Z",
- "State": "Posted",
- "TaxableTotal": 358.19
}
]Single Elite account receivable invoice by Id
| InvoiceId required | string |
{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 905.43,
- "ContractType": "Cash",
- "DamageWaiverTotal": 216.01,
- "Delivery": {
- "Type": "Default",
- "City": "Lake Ottiliehaven",
- "Line1": "787 Willow Close",
- "PostalCode": "05361-7271",
- "Province": "North Carolina"
}, - "GrandTaxTotal": 885.14,
- "GrandTotal": 256.57,
- "Identifiers": {
- "ContractId": 916,
- "BatchId": 266,
- "ContractStoreId": 270,
- "CustomerId": 764,
- "ExternalLocationId": 84,
- "ExternalInvoiceId": 766,
- "ExternalCustomerId": 390,
- "ParentContractId": 340
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 616,
- "AccountingClass": "detective",
- "DamageWaiverPercent": 793.37,
- "DiscountPercent": 17,
- "DiscountTotal": 15,
- "DueDateTime": "2026-09-25T01:15:33.236Z",
- "ExtendedPriceTotal": 355.9,
- "GrandTaxTotal": 999.64,
- "GrandTotal": 623.85,
- "HoursCharged": 954.77,
- "Identifiers": {
- "InvoiceId": 247,
- "ContractId": 27,
- "GeneralLedgerAccountId": 939,
- "GeneralLedgerOffsetAccountId": 736
}, - "Item": {
- "ModelType": "Item",
- "Id": 572,
- "Name": "Javier Hammes",
- "Key": "necklace",
- "CategoryId": 153,
- "CategoryName": "Kelvin Mann",
- "Description": "SAMPLE: burgeon inure appreciate design wrong meanwhile unsightly ick alert tuber",
- "IsAsset": true,
- "Manufacturer": "mantua",
- "Model": "Maruti ATS",
- "ModelYear": "dusk",
- "SerialNumber": "catalyst",
- "Type": "Retail"
}, - "ItemPercent": "Shirt",
- "LineNumber": 275,
- "Memo": "unique",
- "MeterIn": 372.25,
- "MeterOut": 164.65,
- "NonTaxable": false,
- "OutDateTime": "2026-03-02T02:36:06.361Z",
- "Quantity": 21,
- "TypeId": 647,
- "TypeName": "Credit"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 885,
- "AccountingClass": "cake",
- "DamageWaiverPercent": 222.72,
- "DiscountPercent": 17,
- "DiscountTotal": 39,
- "DueDateTime": "2026-04-24T14:25:02.286Z",
- "ExtendedPriceTotal": 373.05,
- "GrandTaxTotal": 118.92,
- "GrandTotal": 234.98,
- "HoursCharged": 687.4,
- "Identifiers": {
- "InvoiceId": 100,
- "ContractId": 550,
- "GeneralLedgerAccountId": 352,
- "GeneralLedgerOffsetAccountId": 711
}, - "Item": {
- "ModelType": "Item",
- "Id": 75,
- "Name": "Katie Abshire",
- "Key": "remark",
- "CategoryId": 766,
- "CategoryName": "Genevieve Russel IV",
- "Description": "SAMPLE: harmful aboard after gadzooks serenade noisily kookily handful cheetah ramp",
- "IsAsset": true,
- "Manufacturer": "SUV",
- "Model": "Polestar Colorado",
- "ModelYear": "tray",
- "SerialNumber": "almighty",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 264,
- "Memo": "flood",
- "MeterIn": 144.28,
- "MeterOut": 280.1,
- "NonTaxable": true,
- "OutDateTime": "2025-05-20T15:11:18.286Z",
- "Quantity": 92,
- "TypeId": 93,
- "TypeName": "OtherIncome"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 617,
- "AccountingClass": "starboard",
- "DamageWaiverPercent": 205.04,
- "DiscountPercent": 16,
- "DiscountTotal": 100,
- "DueDateTime": "2025-09-29T03:52:21.051Z",
- "ExtendedPriceTotal": 830.82,
- "GrandTaxTotal": 408.76,
- "GrandTotal": 286.17,
- "HoursCharged": 839.11,
- "Identifiers": {
- "InvoiceId": 333,
- "ContractId": 268,
- "GeneralLedgerAccountId": 298,
- "GeneralLedgerOffsetAccountId": 232
}, - "Item": {
- "ModelType": "Item",
- "Id": 413,
- "Name": "Eula Hamill",
- "Key": "cheese",
- "CategoryId": 457,
- "CategoryName": "Tony Halvorson",
- "Description": "SAMPLE: shadowy whistle drat whether enormously who finer skateboard intent freely",
- "IsAsset": false,
- "Manufacturer": "fuel",
- "Model": "Toyota Fiesta",
- "ModelYear": "napkin",
- "SerialNumber": "quit",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 459,
- "Memo": "scratch",
- "MeterIn": 215.24,
- "MeterOut": 534.7,
- "NonTaxable": false,
- "OutDateTime": "2025-09-30T23:17:24.488Z",
- "Quantity": 50,
- "TypeId": 608,
- "TypeName": "SalesTax"
}
], - "OtherTotal": 165.62,
- "PaidTotal": 713.73,
- "RentTotal": 867.11,
- "RevenueDateTime": "2025-07-02T06:12:13.675Z",
- "SaleTotal": "Bike",
- "StartDateTime": "2024-12-11T04:56:18.692Z",
- "State": "Posted",
- "TaxableTotal": 358.19
}Update a single Elite account receivable invoice
| InvoiceId required | string |
| Id | string Unique identifier for the model type. |
| ErrorCode | string or null Error code value whenever the invoice |
| ErrorDescription | string or null Error description value whenever invoice |
object Default: {"ContractId":135,"BatchId":476,"ContractStoreId":374,"CustomerId":290,"ExternalLocationId":621,"ExternalInvoiceId":672,"ExternalCustomerId":926} Collection of unique ids related to this invoice. | |
| State | string Default: "Pending" Enum: "Pending" "Posted" "Error" Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted' you can not update to another state. |
{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 996.42,
- "ContractType": "Credit",
- "DamageWaiverTotal": 9.95,
- "Delivery": {
- "Type": "Default",
- "City": "Binsberg",
- "Line1": "8125 Blanda Junction",
- "PostalCode": "68358",
- "Province": "Missouri"
}, - "GrandTaxTotal": 927.11,
- "GrandTotal": 255.56,
- "Identifiers": {
- "ContractId": 135,
- "BatchId": 476,
- "ContractStoreId": 374,
- "CustomerId": 290,
- "ExternalLocationId": 621,
- "ExternalInvoiceId": 672,
- "ExternalCustomerId": 926
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 265,
- "AccountingClass": "mentor",
- "DamageWaiverPercent": 993.32,
- "DiscountPercent": 58,
- "DiscountTotal": 35,
- "DueDateTime": "2025-03-18T05:09:57.653Z",
- "ExtendedPriceTotal": 950.19,
- "GrandTaxTotal": 706.44,
- "GrandTotal": 827.68,
- "HoursCharged": 75.82,
- "Identifiers": {
- "InvoiceId": 609,
- "ContractId": 863,
- "GeneralLedgerAccountId": 143,
- "GeneralLedgerOffsetAccountId": 692
}, - "Item": {
- "ModelType": "Item",
- "Id": 759,
- "Name": "Rachael Wyman Jr.",
- "Key": "unibody",
- "CategoryId": 55,
- "CategoryName": "Lena Hintz-Mueller",
- "Description": "SAMPLE: for versus necessary enthusiastically glimmer what phooey considering really secret",
- "IsAsset": false,
- "Manufacturer": "hamburger",
- "Model": "Hyundai Model Y",
- "ModelYear": "gazebo",
- "SerialNumber": "typewriter",
- "Type": "Retail"
}, - "ItemPercent": "Towels",
- "LineNumber": 152,
- "Memo": "someplace",
- "MeterIn": 488.55,
- "MeterOut": 232.41,
- "NonTaxable": true,
- "OutDateTime": "2025-03-01T21:25:58.067Z",
- "Quantity": 32,
- "TypeId": 450,
- "TypeName": "SalesTax"
}
], - "OtherTotal": 182.12,
- "PaidTotal": 5.23,
- "RentTotal": 242.93,
- "RevenueDateTime": "2025-04-02T13:06:03.957Z",
- "SaleTotal": "Salad",
- "StartDateTime": "2026-09-05T13:52:00.183Z",
- "State": "Pending",
- "TaxableTotal": 270.95
}{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 905.43,
- "ContractType": "Cash",
- "DamageWaiverTotal": 216.01,
- "Delivery": {
- "Type": "Default",
- "City": "Lake Ottiliehaven",
- "Line1": "787 Willow Close",
- "PostalCode": "05361-7271",
- "Province": "North Carolina"
}, - "GrandTaxTotal": 885.14,
- "GrandTotal": 256.57,
- "Identifiers": {
- "ContractId": 916,
- "BatchId": 266,
- "ContractStoreId": 270,
- "CustomerId": 764,
- "ExternalLocationId": 84,
- "ExternalInvoiceId": 766,
- "ExternalCustomerId": 390,
- "ParentContractId": 340
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 616,
- "AccountingClass": "detective",
- "DamageWaiverPercent": 793.37,
- "DiscountPercent": 17,
- "DiscountTotal": 15,
- "DueDateTime": "2026-09-25T01:15:33.236Z",
- "ExtendedPriceTotal": 355.9,
- "GrandTaxTotal": 999.64,
- "GrandTotal": 623.85,
- "HoursCharged": 954.77,
- "Identifiers": {
- "InvoiceId": 247,
- "ContractId": 27,
- "GeneralLedgerAccountId": 939,
- "GeneralLedgerOffsetAccountId": 736
}, - "Item": {
- "ModelType": "Item",
- "Id": 572,
- "Name": "Javier Hammes",
- "Key": "necklace",
- "CategoryId": 153,
- "CategoryName": "Kelvin Mann",
- "Description": "SAMPLE: burgeon inure appreciate design wrong meanwhile unsightly ick alert tuber",
- "IsAsset": true,
- "Manufacturer": "mantua",
- "Model": "Maruti ATS",
- "ModelYear": "dusk",
- "SerialNumber": "catalyst",
- "Type": "Retail"
}, - "ItemPercent": "Shirt",
- "LineNumber": 275,
- "Memo": "unique",
- "MeterIn": 372.25,
- "MeterOut": 164.65,
- "NonTaxable": false,
- "OutDateTime": "2026-03-02T02:36:06.361Z",
- "Quantity": 21,
- "TypeId": 647,
- "TypeName": "Credit"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 885,
- "AccountingClass": "cake",
- "DamageWaiverPercent": 222.72,
- "DiscountPercent": 17,
- "DiscountTotal": 39,
- "DueDateTime": "2026-04-24T14:25:02.286Z",
- "ExtendedPriceTotal": 373.05,
- "GrandTaxTotal": 118.92,
- "GrandTotal": 234.98,
- "HoursCharged": 687.4,
- "Identifiers": {
- "InvoiceId": 100,
- "ContractId": 550,
- "GeneralLedgerAccountId": 352,
- "GeneralLedgerOffsetAccountId": 711
}, - "Item": {
- "ModelType": "Item",
- "Id": 75,
- "Name": "Katie Abshire",
- "Key": "remark",
- "CategoryId": 766,
- "CategoryName": "Genevieve Russel IV",
- "Description": "SAMPLE: harmful aboard after gadzooks serenade noisily kookily handful cheetah ramp",
- "IsAsset": true,
- "Manufacturer": "SUV",
- "Model": "Polestar Colorado",
- "ModelYear": "tray",
- "SerialNumber": "almighty",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 264,
- "Memo": "flood",
- "MeterIn": 144.28,
- "MeterOut": 280.1,
- "NonTaxable": true,
- "OutDateTime": "2025-05-20T15:11:18.286Z",
- "Quantity": 92,
- "TypeId": 93,
- "TypeName": "OtherIncome"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 617,
- "AccountingClass": "starboard",
- "DamageWaiverPercent": 205.04,
- "DiscountPercent": 16,
- "DiscountTotal": 100,
- "DueDateTime": "2025-09-29T03:52:21.051Z",
- "ExtendedPriceTotal": 830.82,
- "GrandTaxTotal": 408.76,
- "GrandTotal": 286.17,
- "HoursCharged": 839.11,
- "Identifiers": {
- "InvoiceId": 333,
- "ContractId": 268,
- "GeneralLedgerAccountId": 298,
- "GeneralLedgerOffsetAccountId": 232
}, - "Item": {
- "ModelType": "Item",
- "Id": 413,
- "Name": "Eula Hamill",
- "Key": "cheese",
- "CategoryId": 457,
- "CategoryName": "Tony Halvorson",
- "Description": "SAMPLE: shadowy whistle drat whether enormously who finer skateboard intent freely",
- "IsAsset": false,
- "Manufacturer": "fuel",
- "Model": "Toyota Fiesta",
- "ModelYear": "napkin",
- "SerialNumber": "quit",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 459,
- "Memo": "scratch",
- "MeterIn": 215.24,
- "MeterOut": 534.7,
- "NonTaxable": false,
- "OutDateTime": "2025-09-30T23:17:24.488Z",
- "Quantity": 50,
- "TypeId": 608,
- "TypeName": "SalesTax"
}
], - "OtherTotal": 165.62,
- "PaidTotal": 713.73,
- "RentTotal": 867.11,
- "RevenueDateTime": "2025-07-02T06:12:13.675Z",
- "SaleTotal": "Bike",
- "StartDateTime": "2024-12-11T04:56:18.692Z",
- "State": "Posted",
- "TaxableTotal": 358.19
}All Elite account receivable payments, use query parameters to filter
[- {
- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}
]Create a single Elite account receivable payment
| ContractCodeName required | string Default: "Payment" Enum: "Credit" "Payment" Contract code class name, either Credit or Payment. |
| GrandTotal | number Default: 100 Total amount credited to the customer invoice. |
required | object Default: {"ContractId":"775511","CustomerId":"8","ExternalContractId":"775511"} All RequestsFor every request, ONE from each of the bullet points below is REQUIRED:
Credit Requests Require an Additional
|
| Memo | string Default: "test" Note, reference or description related to the payment. |
| Method | string Default: "Cash" Enum: "Card" "Cash" "Check" "Credit" "Debit" Method of payment. REQUIRED if |
| TransactionDate | string <date-time> Default: "2025-01-10T14:15:22Z" Date and time when the payment was posted. |
{- "ContractCodeName": "Payment",
- "GrandTotal": 100,
- "Memo": "test",
- "Method": "Cash",
- "TransactionDate": "2025-01-10T14:15:22Z",
- "Identifiers": {
- "ContractId": "775511",
- "CustomerId": "8",
- "ExternalContractId": "775511"
}
}{- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}Single Elite account receivable payment by Id
| PaymentId required | string |
{- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}Supported by: Elite
This is a list of general ledger journal entries. By default you can retrieve a list of journal entries where State property is equal to 'Pending'. Apply an additional filter to the the State property in order to receive other journal entries states.
[- {
- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "cutlet",
- "Contract": "bowler",
- "Customer": "extent",
- "Department": "Clothing",
- "Employee": "consistency",
- "Item": "Gloves",
- "JobSite": "transparency",
- "Location": "8626 Boyer Plain",
- "Project": "seal",
- "SalesPerson": "Chips",
- "Vendor": "vision"
}, - "Identifiers": {
- "BatchId": 64,
- "ExternalJournalEntryId": 46
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 814,
- "GrandTotal": 890.96,
- "Identifiers": {
- "ContractId": 830,
- "CustomerId": 445,
- "ExternalContractId": 150,
- "ExternalCustomerId": 910,
- "JournalEntryAccountId": 992,
- "JournalEntryId": 101
}, - "Memo": "marketplace"
}
], - "State": "Posted"
}
]Supported by: Elite
This is a single general ledger journal entries retrieved by a given journal entry id.
| JournalEntryId required | string |
{- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "cutlet",
- "Contract": "bowler",
- "Customer": "extent",
- "Department": "Clothing",
- "Employee": "consistency",
- "Item": "Gloves",
- "JobSite": "transparency",
- "Location": "8626 Boyer Plain",
- "Project": "seal",
- "SalesPerson": "Chips",
- "Vendor": "vision"
}, - "Identifiers": {
- "BatchId": 64,
- "ExternalJournalEntryId": 46
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 814,
- "GrandTotal": 890.96,
- "Identifiers": {
- "ContractId": 830,
- "CustomerId": 445,
- "ExternalContractId": 150,
- "ExternalCustomerId": 910,
- "JournalEntryAccountId": 992,
- "JournalEntryId": 101
}, - "Memo": "marketplace"
}
], - "State": "Posted"
}Supported by: Elite
Update an existing General Ledger Journal Entry
| JournalEntryId required | string |
| Id | string Unique identifier for the model type. |
| ErrorCode | string or null Error code value whenever the invoice |
| ErrorDescription | string or null Error description value whenever invoice |
object Default: {"BatchId":811,"ExternalJournalEntryId":651} Collection of unique ids related to this invoice line item. | |
| State | string Default: "Error" Enum: "Pending" "Posted" "Error" Defines the state of the journal entry. Initial value of an journal entry is 'Pending'. If the value is 'Posted' you can not update to another state. |
{- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "tapioca",
- "Contract": "spirit",
- "Customer": "coin",
- "Department": "Electronics",
- "Employee": "handle",
- "Item": "Tuna",
- "JobSite": "glider",
- "Location": "63620 Lexus Parkways",
- "Project": "sarong",
- "SalesPerson": "Towels",
- "Vendor": "seafood"
}, - "Identifiers": {
- "BatchId": 811,
- "ExternalJournalEntryId": 651
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 924,
- "GrandTotal": 25.63,
- "Identifiers": {
- "ContractId": 918,
- "CustomerId": 448,
- "ExternalContractId": 355,
- "ExternalCustomerId": 858,
- "JournalEntryAccountId": 511,
- "JournalEntryId": 995
}, - "Memo": "lamp"
}, - {
- "ModelType": "JournalEntryLineItem",
- "Id": 907,
- "GrandTotal": 271.74,
- "Identifiers": {
- "ContractId": 232,
- "CustomerId": 227,
- "ExternalContractId": 262,
- "ExternalCustomerId": 458,
- "JournalEntryAccountId": 788,
- "JournalEntryId": 532
}, - "Memo": "bidet"
}
], - "State": "Error"
}{- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "cutlet",
- "Contract": "bowler",
- "Customer": "extent",
- "Department": "Clothing",
- "Employee": "consistency",
- "Item": "Gloves",
- "JobSite": "transparency",
- "Location": "8626 Boyer Plain",
- "Project": "seal",
- "SalesPerson": "Chips",
- "Vendor": "vision"
}, - "Identifiers": {
- "BatchId": 64,
- "ExternalJournalEntryId": 46
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 814,
- "GrandTotal": 890.96,
- "Identifiers": {
- "ContractId": 830,
- "CustomerId": 445,
- "ExternalContractId": 150,
- "ExternalCustomerId": 910,
- "JournalEntryAccountId": 992,
- "JournalEntryId": 101
}, - "Memo": "marketplace"
}
], - "State": "Posted"
}[- {
- "description": "Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.",
- "type": "object",
- "properties": {
- "ModelType": {
- "type": "string",
- "enum": [
- "HireRate"
]
}, - "Id": {
- "type": "string"
}, - "Name": {
- "type": "string"
}, - "CategoryName": {
- "description": "The category that the hire rate belongs to.",
- "type": "string"
}, - "DayRate": {
- "description": "The flat rate to charge for a single day.",
- "type": "number"
}, - "HourRate": {
- "description": "The rate to charge per hour.",
- "type": "number"
}, - "WeekRate": {
- "description": "The rate to charge per week.",
- "type": "number"
}, - "WeekRateHalfDay": {
- "description": "The rate to charge for half a week day.",
- "type": "number"
}, - "WeekRate1Day": {
- "description": "The rate to charge for a week day.",
- "type": "number"
}, - "WeekRate2Day": {
- "description": "The rate to charge for 2 week days.",
- "type": "number"
}, - "WeekRate3Day": {
- "description": "The rate to charge for 3 week days.",
- "type": "number"
}, - "WeekRate4Day": {
- "description": "The rate to charge for 4 week days.",
- "type": "number"
}, - "WeekendRate": {
- "description": "The rate to charge over a weekend.",
- "type": "number"
}, - "MonthRate": {
- "description": "The rate to charge per month.",
- "type": "number"
}
}
}
][- {
- "description": "Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.",
- "type": "object",
- "properties": {
- "ModelType": {
- "type": "string",
- "enum": [
- "HireRate"
]
}, - "Id": {
- "type": "string"
}, - "Name": {
- "type": "string"
}, - "CategoryName": {
- "description": "The category that the hire rate belongs to.",
- "type": "string"
}, - "DayRate": {
- "description": "The flat rate to charge for a single day.",
- "type": "number"
}, - "HourRate": {
- "description": "The rate to charge per hour.",
- "type": "number"
}, - "WeekRate": {
- "description": "The rate to charge per week.",
- "type": "number"
}, - "WeekRateHalfDay": {
- "description": "The rate to charge for half a week day.",
- "type": "number"
}, - "WeekRate1Day": {
- "description": "The rate to charge for a week day.",
- "type": "number"
}, - "WeekRate2Day": {
- "description": "The rate to charge for 2 week days.",
- "type": "number"
}, - "WeekRate3Day": {
- "description": "The rate to charge for 3 week days.",
- "type": "number"
}, - "WeekRate4Day": {
- "description": "The rate to charge for 4 week days.",
- "type": "number"
}, - "WeekendRate": {
- "description": "The rate to charge over a weekend.",
- "type": "number"
}, - "MonthRate": {
- "description": "The rate to charge per month.",
- "type": "number"
}
}
}
]Supported by: Syrinx
| HireRateId required | string |
[- {
- "description": "Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.",
- "type": "object",
- "properties": {
- "ModelType": {
- "type": "string",
- "enum": [
- "HireRate"
]
}, - "Id": {
- "type": "string"
}, - "Name": {
- "type": "string"
}, - "CategoryName": {
- "description": "The category that the hire rate belongs to.",
- "type": "string"
}, - "DayRate": {
- "description": "The flat rate to charge for a single day.",
- "type": "number"
}, - "HourRate": {
- "description": "The rate to charge per hour.",
- "type": "number"
}, - "WeekRate": {
- "description": "The rate to charge per week.",
- "type": "number"
}, - "WeekRateHalfDay": {
- "description": "The rate to charge for half a week day.",
- "type": "number"
}, - "WeekRate1Day": {
- "description": "The rate to charge for a week day.",
- "type": "number"
}, - "WeekRate2Day": {
- "description": "The rate to charge for 2 week days.",
- "type": "number"
}, - "WeekRate3Day": {
- "description": "The rate to charge for 3 week days.",
- "type": "number"
}, - "WeekRate4Day": {
- "description": "The rate to charge for 4 week days.",
- "type": "number"
}, - "WeekendRate": {
- "description": "The rate to charge over a weekend.",
- "type": "number"
}, - "MonthRate": {
- "description": "The rate to charge per month.",
- "type": "number"
}
}
}
]Supported by: Syrinx
| HireRateId required | string |
[- {
- "description": "Hire Rates belong to a Syrinx category and can be set against items within that category to dictate default rates.",
- "type": "object",
- "properties": {
- "ModelType": {
- "type": "string",
- "enum": [
- "HireRate"
]
}, - "Id": {
- "type": "string"
}, - "Name": {
- "type": "string"
}, - "CategoryName": {
- "description": "The category that the hire rate belongs to.",
- "type": "string"
}, - "DayRate": {
- "description": "The flat rate to charge for a single day.",
- "type": "number"
}, - "HourRate": {
- "description": "The rate to charge per hour.",
- "type": "number"
}, - "WeekRate": {
- "description": "The rate to charge per week.",
- "type": "number"
}, - "WeekRateHalfDay": {
- "description": "The rate to charge for half a week day.",
- "type": "number"
}, - "WeekRate1Day": {
- "description": "The rate to charge for a week day.",
- "type": "number"
}, - "WeekRate2Day": {
- "description": "The rate to charge for 2 week days.",
- "type": "number"
}, - "WeekRate3Day": {
- "description": "The rate to charge for 3 week days.",
- "type": "number"
}, - "WeekRate4Day": {
- "description": "The rate to charge for 4 week days.",
- "type": "number"
}, - "WeekendRate": {
- "description": "The rate to charge over a weekend.",
- "type": "number"
}, - "MonthRate": {
- "description": "The rate to charge per month.",
- "type": "number"
}
}
}
]Supported by: Elite
This is a list of account payable invoices. By default you can retrieve a list of payable invoices where State property is equal to 'Pending'. Apply an additional filter to the the State property in order to receive other payable invoices states.
[- {
- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2024-11-28T15:44:54.502Z",
- "FreightTotal": 237.07,
- "GrandTaxTotal": 635.11,
- "GrandTotal": 123.43,
- "Identifiers": {
- "BatchId": 993,
- "ContractStoreId": 498,
- "ExternalLocationId": 167,
- "ExternalPayableId": 651,
- "ExternalVendorId": 130,
- "FreightAccountId": 783,
- "MiscellaneousAccountId": 374,
- "PayableAccountId": 878,
- "TaxAccountId": 347
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 402,
- "ExtendedUnitTotal": 614.31,
- "FreightTotal": 96.93,
- "GrandTaxTotal": 274.22,
- "GrandTotal": 4.79,
- "Identifiers": {
- "AccountNumberId": 758,
- "ExternalPayableId": 743,
- "InvoiceId": 168
}, - "Item": {
- "ModelType": "Item",
- "Id": 554,
- "Description": "SAMPLE: feminize slip whether scarification aw minus gadzooks short-term without bobble",
- "Key": "dulcimer"
}, - "LineNumber": 123,
- "MiscellaneousTotal": "louse",
- "PurchaseOrderNumber": "lift",
- "PurchaseOrderPartNumber": "scarification",
- "PurchaseOrderSequenceNumber": "procurement",
- "QuantityOrdered": 54.94,
- "QuantityReceived": 108.27,
- "ReceivedDateTime": "2025-05-14T00:44:24.163Z",
- "UnitTotal": 565.14
}
], - "MiscellaneousTotal": 906.13,
- "PurchaseOrderNumber": "surface",
- "PurchaseOrderSequenceNumber": "cauliflower",
- "PurchaseTotal": 27.72,
- "ShippingMethod": "disadvantage",
- "State": "Posted",
- "TermsCode": "accountability",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 220,
- "Name": "Tommie Dibbert",
- "InvoiceNumber": "zen",
- "InvoiceDateTime": "2025-02-02T21:27:08.074Z",
- "InvoiceDueDateTime": "2026-09-19T11:16:36.997Z"
}
}
]Supported by: Elite
This is a single account payable invoice retrieved by the given payable invoice id.
| InvoiceId required | string |
{- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2024-11-28T15:44:54.502Z",
- "FreightTotal": 237.07,
- "GrandTaxTotal": 635.11,
- "GrandTotal": 123.43,
- "Identifiers": {
- "BatchId": 993,
- "ContractStoreId": 498,
- "ExternalLocationId": 167,
- "ExternalPayableId": 651,
- "ExternalVendorId": 130,
- "FreightAccountId": 783,
- "MiscellaneousAccountId": 374,
- "PayableAccountId": 878,
- "TaxAccountId": 347
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 402,
- "ExtendedUnitTotal": 614.31,
- "FreightTotal": 96.93,
- "GrandTaxTotal": 274.22,
- "GrandTotal": 4.79,
- "Identifiers": {
- "AccountNumberId": 758,
- "ExternalPayableId": 743,
- "InvoiceId": 168
}, - "Item": {
- "ModelType": "Item",
- "Id": 554,
- "Description": "SAMPLE: feminize slip whether scarification aw minus gadzooks short-term without bobble",
- "Key": "dulcimer"
}, - "LineNumber": 123,
- "MiscellaneousTotal": "louse",
- "PurchaseOrderNumber": "lift",
- "PurchaseOrderPartNumber": "scarification",
- "PurchaseOrderSequenceNumber": "procurement",
- "QuantityOrdered": 54.94,
- "QuantityReceived": 108.27,
- "ReceivedDateTime": "2025-05-14T00:44:24.163Z",
- "UnitTotal": 565.14
}
], - "MiscellaneousTotal": 906.13,
- "PurchaseOrderNumber": "surface",
- "PurchaseOrderSequenceNumber": "cauliflower",
- "PurchaseTotal": 27.72,
- "ShippingMethod": "disadvantage",
- "State": "Posted",
- "TermsCode": "accountability",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 220,
- "Name": "Tommie Dibbert",
- "InvoiceNumber": "zen",
- "InvoiceDateTime": "2025-02-02T21:27:08.074Z",
- "InvoiceDueDateTime": "2026-09-19T11:16:36.997Z"
}
}Supported by: Elite
Update an existing Account Payable Invoice
| InvoiceId required | string |
| ErrorCode | string or null Error code value whenever the payable invoice |
| ErrorDescription | string or null Error description value whenever payable invoice |
object Default: {"BatchId":67,"ContractStoreId":46,"ExternalLocationId":681,"ExternalPayableId":854,"ExternalVendorId":831,"FreightAccountId":919,"MiscellaneousAccountId":501,"PayableAccountId":378,"TaxAccountId":913} Collection of unique ids related to this payable invoice. | |
| State | string Default: "Error" Enum: "Pending" "Posted" "Error" Defines the state of the payable invoice. Initial value of an payable invoice is 'Pending'. If the value is 'Posted' you can not update to another state. |
{- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2025-10-03T15:10:11.104Z",
- "FreightTotal": 156.99,
- "GrandTaxTotal": 212.73,
- "GrandTotal": 4.01,
- "Identifiers": {
- "BatchId": 67,
- "ContractStoreId": 46,
- "ExternalLocationId": 681,
- "ExternalPayableId": 854,
- "ExternalVendorId": 831,
- "FreightAccountId": 919,
- "MiscellaneousAccountId": 501,
- "PayableAccountId": 378,
- "TaxAccountId": 913
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 632,
- "ExtendedUnitTotal": 421.53,
- "FreightTotal": 428.71,
- "GrandTaxTotal": 799.69,
- "GrandTotal": 513.59,
- "Identifiers": {
- "AccountNumberId": 809,
- "ExternalPayableId": 930,
- "InvoiceId": 458
}, - "Item": {
- "ModelType": "Item",
- "Id": 795,
- "Description": "SAMPLE: hourly splendid out magnetize quizzically emphasise between waist how successfully",
- "Key": "fundraising"
}, - "LineNumber": 225,
- "MiscellaneousTotal": "farmer",
- "PurchaseOrderNumber": "place",
- "PurchaseOrderPartNumber": "markup",
- "PurchaseOrderSequenceNumber": "embossing",
- "QuantityOrdered": 268.04,
- "QuantityReceived": 314.69,
- "ReceivedDateTime": "2025-06-17T14:49:43.564Z",
- "UnitTotal": 567.81
}
], - "MiscellaneousTotal": 457.9,
- "PurchaseOrderNumber": "essence",
- "PurchaseOrderSequenceNumber": "recommendation",
- "PurchaseTotal": 899.89,
- "ShippingMethod": "shore",
- "State": "Error",
- "TermsCode": "smoke",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 672,
- "Name": "Deanna Powlowski-Moore",
- "InvoiceNumber": "academics",
- "InvoiceDateTime": "2025-05-13T17:57:39.551Z",
- "InvoiceDueDateTime": "2025-10-07T21:28:34.392Z"
}
}{- "ModelType": "AccountPayableInvoice",
- "PurchaseOrderDateTime": "2024-11-28T15:44:54.502Z",
- "FreightTotal": 237.07,
- "GrandTaxTotal": 635.11,
- "GrandTotal": 123.43,
- "Identifiers": {
- "BatchId": 993,
- "ContractStoreId": 498,
- "ExternalLocationId": 167,
- "ExternalPayableId": 651,
- "ExternalVendorId": 130,
- "FreightAccountId": 783,
- "MiscellaneousAccountId": 374,
- "PayableAccountId": 878,
- "TaxAccountId": 347
}, - "LineItems": [
- {
- "ModelType": "AccountPayableInvoiceLineItem",
- "Id": 402,
- "ExtendedUnitTotal": 614.31,
- "FreightTotal": 96.93,
- "GrandTaxTotal": 274.22,
- "GrandTotal": 4.79,
- "Identifiers": {
- "AccountNumberId": 758,
- "ExternalPayableId": 743,
- "InvoiceId": 168
}, - "Item": {
- "ModelType": "Item",
- "Id": 554,
- "Description": "SAMPLE: feminize slip whether scarification aw minus gadzooks short-term without bobble",
- "Key": "dulcimer"
}, - "LineNumber": 123,
- "MiscellaneousTotal": "louse",
- "PurchaseOrderNumber": "lift",
- "PurchaseOrderPartNumber": "scarification",
- "PurchaseOrderSequenceNumber": "procurement",
- "QuantityOrdered": 54.94,
- "QuantityReceived": 108.27,
- "ReceivedDateTime": "2025-05-14T00:44:24.163Z",
- "UnitTotal": 565.14
}
], - "MiscellaneousTotal": 906.13,
- "PurchaseOrderNumber": "surface",
- "PurchaseOrderSequenceNumber": "cauliflower",
- "PurchaseTotal": 27.72,
- "ShippingMethod": "disadvantage",
- "State": "Posted",
- "TermsCode": "accountability",
- "Vendor": {
- "ModelType": "Vendor",
- "Id": 220,
- "Name": "Tommie Dibbert",
- "InvoiceNumber": "zen",
- "InvoiceDateTime": "2025-02-02T21:27:08.074Z",
- "InvoiceDueDateTime": "2026-09-19T11:16:36.997Z"
}
}All Elite account receivable invoices, use query parameters to filter
[- {
- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 905.43,
- "ContractType": "Cash",
- "DamageWaiverTotal": 216.01,
- "Delivery": {
- "Type": "Default",
- "City": "Lake Ottiliehaven",
- "Line1": "787 Willow Close",
- "PostalCode": "05361-7271",
- "Province": "North Carolina"
}, - "GrandTaxTotal": 885.14,
- "GrandTotal": 256.57,
- "Identifiers": {
- "ContractId": 916,
- "BatchId": 266,
- "ContractStoreId": 270,
- "CustomerId": 764,
- "ExternalLocationId": 84,
- "ExternalInvoiceId": 766,
- "ExternalCustomerId": 390,
- "ParentContractId": 340
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 616,
- "AccountingClass": "detective",
- "DamageWaiverPercent": 793.37,
- "DiscountPercent": 17,
- "DiscountTotal": 15,
- "DueDateTime": "2026-09-25T01:15:33.236Z",
- "ExtendedPriceTotal": 355.9,
- "GrandTaxTotal": 999.64,
- "GrandTotal": 623.85,
- "HoursCharged": 954.77,
- "Identifiers": {
- "InvoiceId": 247,
- "ContractId": 27,
- "GeneralLedgerAccountId": 939,
- "GeneralLedgerOffsetAccountId": 736
}, - "Item": {
- "ModelType": "Item",
- "Id": 572,
- "Name": "Javier Hammes",
- "Key": "necklace",
- "CategoryId": 153,
- "CategoryName": "Kelvin Mann",
- "Description": "SAMPLE: burgeon inure appreciate design wrong meanwhile unsightly ick alert tuber",
- "IsAsset": true,
- "Manufacturer": "mantua",
- "Model": "Maruti ATS",
- "ModelYear": "dusk",
- "SerialNumber": "catalyst",
- "Type": "Retail"
}, - "ItemPercent": "Shirt",
- "LineNumber": 275,
- "Memo": "unique",
- "MeterIn": 372.25,
- "MeterOut": 164.65,
- "NonTaxable": false,
- "OutDateTime": "2026-03-02T02:36:06.361Z",
- "Quantity": 21,
- "TypeId": 647,
- "TypeName": "Credit"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 885,
- "AccountingClass": "cake",
- "DamageWaiverPercent": 222.72,
- "DiscountPercent": 17,
- "DiscountTotal": 39,
- "DueDateTime": "2026-04-24T14:25:02.286Z",
- "ExtendedPriceTotal": 373.05,
- "GrandTaxTotal": 118.92,
- "GrandTotal": 234.98,
- "HoursCharged": 687.4,
- "Identifiers": {
- "InvoiceId": 100,
- "ContractId": 550,
- "GeneralLedgerAccountId": 352,
- "GeneralLedgerOffsetAccountId": 711
}, - "Item": {
- "ModelType": "Item",
- "Id": 75,
- "Name": "Katie Abshire",
- "Key": "remark",
- "CategoryId": 766,
- "CategoryName": "Genevieve Russel IV",
- "Description": "SAMPLE: harmful aboard after gadzooks serenade noisily kookily handful cheetah ramp",
- "IsAsset": true,
- "Manufacturer": "SUV",
- "Model": "Polestar Colorado",
- "ModelYear": "tray",
- "SerialNumber": "almighty",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 264,
- "Memo": "flood",
- "MeterIn": 144.28,
- "MeterOut": 280.1,
- "NonTaxable": true,
- "OutDateTime": "2025-05-20T15:11:18.286Z",
- "Quantity": 92,
- "TypeId": 93,
- "TypeName": "OtherIncome"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 617,
- "AccountingClass": "starboard",
- "DamageWaiverPercent": 205.04,
- "DiscountPercent": 16,
- "DiscountTotal": 100,
- "DueDateTime": "2025-09-29T03:52:21.051Z",
- "ExtendedPriceTotal": 830.82,
- "GrandTaxTotal": 408.76,
- "GrandTotal": 286.17,
- "HoursCharged": 839.11,
- "Identifiers": {
- "InvoiceId": 333,
- "ContractId": 268,
- "GeneralLedgerAccountId": 298,
- "GeneralLedgerOffsetAccountId": 232
}, - "Item": {
- "ModelType": "Item",
- "Id": 413,
- "Name": "Eula Hamill",
- "Key": "cheese",
- "CategoryId": 457,
- "CategoryName": "Tony Halvorson",
- "Description": "SAMPLE: shadowy whistle drat whether enormously who finer skateboard intent freely",
- "IsAsset": false,
- "Manufacturer": "fuel",
- "Model": "Toyota Fiesta",
- "ModelYear": "napkin",
- "SerialNumber": "quit",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 459,
- "Memo": "scratch",
- "MeterIn": 215.24,
- "MeterOut": 534.7,
- "NonTaxable": false,
- "OutDateTime": "2025-09-30T23:17:24.488Z",
- "Quantity": 50,
- "TypeId": 608,
- "TypeName": "SalesTax"
}
], - "OtherTotal": 165.62,
- "PaidTotal": 713.73,
- "RentTotal": 867.11,
- "RevenueDateTime": "2025-07-02T06:12:13.675Z",
- "SaleTotal": "Bike",
- "StartDateTime": "2024-12-11T04:56:18.692Z",
- "State": "Posted",
- "TaxableTotal": 358.19
}
]Single Elite account receivable invoice by Id
| InvoiceId required | string |
{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 905.43,
- "ContractType": "Cash",
- "DamageWaiverTotal": 216.01,
- "Delivery": {
- "Type": "Default",
- "City": "Lake Ottiliehaven",
- "Line1": "787 Willow Close",
- "PostalCode": "05361-7271",
- "Province": "North Carolina"
}, - "GrandTaxTotal": 885.14,
- "GrandTotal": 256.57,
- "Identifiers": {
- "ContractId": 916,
- "BatchId": 266,
- "ContractStoreId": 270,
- "CustomerId": 764,
- "ExternalLocationId": 84,
- "ExternalInvoiceId": 766,
- "ExternalCustomerId": 390,
- "ParentContractId": 340
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 616,
- "AccountingClass": "detective",
- "DamageWaiverPercent": 793.37,
- "DiscountPercent": 17,
- "DiscountTotal": 15,
- "DueDateTime": "2026-09-25T01:15:33.236Z",
- "ExtendedPriceTotal": 355.9,
- "GrandTaxTotal": 999.64,
- "GrandTotal": 623.85,
- "HoursCharged": 954.77,
- "Identifiers": {
- "InvoiceId": 247,
- "ContractId": 27,
- "GeneralLedgerAccountId": 939,
- "GeneralLedgerOffsetAccountId": 736
}, - "Item": {
- "ModelType": "Item",
- "Id": 572,
- "Name": "Javier Hammes",
- "Key": "necklace",
- "CategoryId": 153,
- "CategoryName": "Kelvin Mann",
- "Description": "SAMPLE: burgeon inure appreciate design wrong meanwhile unsightly ick alert tuber",
- "IsAsset": true,
- "Manufacturer": "mantua",
- "Model": "Maruti ATS",
- "ModelYear": "dusk",
- "SerialNumber": "catalyst",
- "Type": "Retail"
}, - "ItemPercent": "Shirt",
- "LineNumber": 275,
- "Memo": "unique",
- "MeterIn": 372.25,
- "MeterOut": 164.65,
- "NonTaxable": false,
- "OutDateTime": "2026-03-02T02:36:06.361Z",
- "Quantity": 21,
- "TypeId": 647,
- "TypeName": "Credit"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 885,
- "AccountingClass": "cake",
- "DamageWaiverPercent": 222.72,
- "DiscountPercent": 17,
- "DiscountTotal": 39,
- "DueDateTime": "2026-04-24T14:25:02.286Z",
- "ExtendedPriceTotal": 373.05,
- "GrandTaxTotal": 118.92,
- "GrandTotal": 234.98,
- "HoursCharged": 687.4,
- "Identifiers": {
- "InvoiceId": 100,
- "ContractId": 550,
- "GeneralLedgerAccountId": 352,
- "GeneralLedgerOffsetAccountId": 711
}, - "Item": {
- "ModelType": "Item",
- "Id": 75,
- "Name": "Katie Abshire",
- "Key": "remark",
- "CategoryId": 766,
- "CategoryName": "Genevieve Russel IV",
- "Description": "SAMPLE: harmful aboard after gadzooks serenade noisily kookily handful cheetah ramp",
- "IsAsset": true,
- "Manufacturer": "SUV",
- "Model": "Polestar Colorado",
- "ModelYear": "tray",
- "SerialNumber": "almighty",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 264,
- "Memo": "flood",
- "MeterIn": 144.28,
- "MeterOut": 280.1,
- "NonTaxable": true,
- "OutDateTime": "2025-05-20T15:11:18.286Z",
- "Quantity": 92,
- "TypeId": 93,
- "TypeName": "OtherIncome"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 617,
- "AccountingClass": "starboard",
- "DamageWaiverPercent": 205.04,
- "DiscountPercent": 16,
- "DiscountTotal": 100,
- "DueDateTime": "2025-09-29T03:52:21.051Z",
- "ExtendedPriceTotal": 830.82,
- "GrandTaxTotal": 408.76,
- "GrandTotal": 286.17,
- "HoursCharged": 839.11,
- "Identifiers": {
- "InvoiceId": 333,
- "ContractId": 268,
- "GeneralLedgerAccountId": 298,
- "GeneralLedgerOffsetAccountId": 232
}, - "Item": {
- "ModelType": "Item",
- "Id": 413,
- "Name": "Eula Hamill",
- "Key": "cheese",
- "CategoryId": 457,
- "CategoryName": "Tony Halvorson",
- "Description": "SAMPLE: shadowy whistle drat whether enormously who finer skateboard intent freely",
- "IsAsset": false,
- "Manufacturer": "fuel",
- "Model": "Toyota Fiesta",
- "ModelYear": "napkin",
- "SerialNumber": "quit",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 459,
- "Memo": "scratch",
- "MeterIn": 215.24,
- "MeterOut": 534.7,
- "NonTaxable": false,
- "OutDateTime": "2025-09-30T23:17:24.488Z",
- "Quantity": 50,
- "TypeId": 608,
- "TypeName": "SalesTax"
}
], - "OtherTotal": 165.62,
- "PaidTotal": 713.73,
- "RentTotal": 867.11,
- "RevenueDateTime": "2025-07-02T06:12:13.675Z",
- "SaleTotal": "Bike",
- "StartDateTime": "2024-12-11T04:56:18.692Z",
- "State": "Posted",
- "TaxableTotal": 358.19
}Update a single Elite account receivable invoice
| InvoiceId required | string |
| Id | string Unique identifier for the model type. |
| ErrorCode | string or null Error code value whenever the invoice |
| ErrorDescription | string or null Error description value whenever invoice |
object Default: {"ContractId":135,"BatchId":476,"ContractStoreId":374,"CustomerId":290,"ExternalLocationId":621,"ExternalInvoiceId":672,"ExternalCustomerId":926} Collection of unique ids related to this invoice. | |
| State | string Default: "Pending" Enum: "Pending" "Posted" "Error" Defines the state of the invoice. Initial value of an invoice is 'Pending'. If the value is 'Posted' you can not update to another state. |
{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 996.42,
- "ContractType": "Credit",
- "DamageWaiverTotal": 9.95,
- "Delivery": {
- "Type": "Default",
- "City": "Binsberg",
- "Line1": "8125 Blanda Junction",
- "PostalCode": "68358",
- "Province": "Missouri"
}, - "GrandTaxTotal": 927.11,
- "GrandTotal": 255.56,
- "Identifiers": {
- "ContractId": 135,
- "BatchId": 476,
- "ContractStoreId": 374,
- "CustomerId": 290,
- "ExternalLocationId": 621,
- "ExternalInvoiceId": 672,
- "ExternalCustomerId": 926
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 265,
- "AccountingClass": "mentor",
- "DamageWaiverPercent": 993.32,
- "DiscountPercent": 58,
- "DiscountTotal": 35,
- "DueDateTime": "2025-03-18T05:09:57.653Z",
- "ExtendedPriceTotal": 950.19,
- "GrandTaxTotal": 706.44,
- "GrandTotal": 827.68,
- "HoursCharged": 75.82,
- "Identifiers": {
- "InvoiceId": 609,
- "ContractId": 863,
- "GeneralLedgerAccountId": 143,
- "GeneralLedgerOffsetAccountId": 692
}, - "Item": {
- "ModelType": "Item",
- "Id": 759,
- "Name": "Rachael Wyman Jr.",
- "Key": "unibody",
- "CategoryId": 55,
- "CategoryName": "Lena Hintz-Mueller",
- "Description": "SAMPLE: for versus necessary enthusiastically glimmer what phooey considering really secret",
- "IsAsset": false,
- "Manufacturer": "hamburger",
- "Model": "Hyundai Model Y",
- "ModelYear": "gazebo",
- "SerialNumber": "typewriter",
- "Type": "Retail"
}, - "ItemPercent": "Towels",
- "LineNumber": 152,
- "Memo": "someplace",
- "MeterIn": 488.55,
- "MeterOut": 232.41,
- "NonTaxable": true,
- "OutDateTime": "2025-03-01T21:25:58.067Z",
- "Quantity": 32,
- "TypeId": 450,
- "TypeName": "SalesTax"
}
], - "OtherTotal": 182.12,
- "PaidTotal": 5.23,
- "RentTotal": 242.93,
- "RevenueDateTime": "2025-04-02T13:06:03.957Z",
- "SaleTotal": "Salad",
- "StartDateTime": "2026-09-05T13:52:00.183Z",
- "State": "Pending",
- "TaxableTotal": 270.95
}{- "ModelType": "AccountReceivableInvoice",
- "ContractTotal": 905.43,
- "ContractType": "Cash",
- "DamageWaiverTotal": 216.01,
- "Delivery": {
- "Type": "Default",
- "City": "Lake Ottiliehaven",
- "Line1": "787 Willow Close",
- "PostalCode": "05361-7271",
- "Province": "North Carolina"
}, - "GrandTaxTotal": 885.14,
- "GrandTotal": 256.57,
- "Identifiers": {
- "ContractId": 916,
- "BatchId": 266,
- "ContractStoreId": 270,
- "CustomerId": 764,
- "ExternalLocationId": 84,
- "ExternalInvoiceId": 766,
- "ExternalCustomerId": 390,
- "ParentContractId": 340
}, - "LineItems": [
- {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 616,
- "AccountingClass": "detective",
- "DamageWaiverPercent": 793.37,
- "DiscountPercent": 17,
- "DiscountTotal": 15,
- "DueDateTime": "2026-09-25T01:15:33.236Z",
- "ExtendedPriceTotal": 355.9,
- "GrandTaxTotal": 999.64,
- "GrandTotal": 623.85,
- "HoursCharged": 954.77,
- "Identifiers": {
- "InvoiceId": 247,
- "ContractId": 27,
- "GeneralLedgerAccountId": 939,
- "GeneralLedgerOffsetAccountId": 736
}, - "Item": {
- "ModelType": "Item",
- "Id": 572,
- "Name": "Javier Hammes",
- "Key": "necklace",
- "CategoryId": 153,
- "CategoryName": "Kelvin Mann",
- "Description": "SAMPLE: burgeon inure appreciate design wrong meanwhile unsightly ick alert tuber",
- "IsAsset": true,
- "Manufacturer": "mantua",
- "Model": "Maruti ATS",
- "ModelYear": "dusk",
- "SerialNumber": "catalyst",
- "Type": "Retail"
}, - "ItemPercent": "Shirt",
- "LineNumber": 275,
- "Memo": "unique",
- "MeterIn": 372.25,
- "MeterOut": 164.65,
- "NonTaxable": false,
- "OutDateTime": "2026-03-02T02:36:06.361Z",
- "Quantity": 21,
- "TypeId": 647,
- "TypeName": "Credit"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 885,
- "AccountingClass": "cake",
- "DamageWaiverPercent": 222.72,
- "DiscountPercent": 17,
- "DiscountTotal": 39,
- "DueDateTime": "2026-04-24T14:25:02.286Z",
- "ExtendedPriceTotal": 373.05,
- "GrandTaxTotal": 118.92,
- "GrandTotal": 234.98,
- "HoursCharged": 687.4,
- "Identifiers": {
- "InvoiceId": 100,
- "ContractId": 550,
- "GeneralLedgerAccountId": 352,
- "GeneralLedgerOffsetAccountId": 711
}, - "Item": {
- "ModelType": "Item",
- "Id": 75,
- "Name": "Katie Abshire",
- "Key": "remark",
- "CategoryId": 766,
- "CategoryName": "Genevieve Russel IV",
- "Description": "SAMPLE: harmful aboard after gadzooks serenade noisily kookily handful cheetah ramp",
- "IsAsset": true,
- "Manufacturer": "SUV",
- "Model": "Polestar Colorado",
- "ModelYear": "tray",
- "SerialNumber": "almighty",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 264,
- "Memo": "flood",
- "MeterIn": 144.28,
- "MeterOut": 280.1,
- "NonTaxable": true,
- "OutDateTime": "2025-05-20T15:11:18.286Z",
- "Quantity": 92,
- "TypeId": 93,
- "TypeName": "OtherIncome"
}, - {
- "ModelType": "AccountReceivableInvoiceLineItem",
- "Id": 617,
- "AccountingClass": "starboard",
- "DamageWaiverPercent": 205.04,
- "DiscountPercent": 16,
- "DiscountTotal": 100,
- "DueDateTime": "2025-09-29T03:52:21.051Z",
- "ExtendedPriceTotal": 830.82,
- "GrandTaxTotal": 408.76,
- "GrandTotal": 286.17,
- "HoursCharged": 839.11,
- "Identifiers": {
- "InvoiceId": 333,
- "ContractId": 268,
- "GeneralLedgerAccountId": 298,
- "GeneralLedgerOffsetAccountId": 232
}, - "Item": {
- "ModelType": "Item",
- "Id": 413,
- "Name": "Eula Hamill",
- "Key": "cheese",
- "CategoryId": 457,
- "CategoryName": "Tony Halvorson",
- "Description": "SAMPLE: shadowy whistle drat whether enormously who finer skateboard intent freely",
- "IsAsset": false,
- "Manufacturer": "fuel",
- "Model": "Toyota Fiesta",
- "ModelYear": "napkin",
- "SerialNumber": "quit",
- "Type": "Rental"
}, - "ItemPercent": "Towels",
- "LineNumber": 459,
- "Memo": "scratch",
- "MeterIn": 215.24,
- "MeterOut": 534.7,
- "NonTaxable": false,
- "OutDateTime": "2025-09-30T23:17:24.488Z",
- "Quantity": 50,
- "TypeId": 608,
- "TypeName": "SalesTax"
}
], - "OtherTotal": 165.62,
- "PaidTotal": 713.73,
- "RentTotal": 867.11,
- "RevenueDateTime": "2025-07-02T06:12:13.675Z",
- "SaleTotal": "Bike",
- "StartDateTime": "2024-12-11T04:56:18.692Z",
- "State": "Posted",
- "TaxableTotal": 358.19
}All Elite account receivable payments, use query parameters to filter
[- {
- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}
]Create a single Elite account receivable payment
| ContractCodeName required | string Default: "Payment" Enum: "Credit" "Payment" Contract code class name, either Credit or Payment. |
| GrandTotal | number Default: 100 Total amount credited to the customer invoice. |
required | object Default: {"ContractId":"775511","CustomerId":"8","ExternalContractId":"775511"} All RequestsFor every request, ONE from each of the bullet points below is REQUIRED:
Credit Requests Require an Additional
|
| Memo | string Default: "test" Note, reference or description related to the payment. |
| Method | string Default: "Cash" Enum: "Card" "Cash" "Check" "Credit" "Debit" Method of payment. REQUIRED if |
| TransactionDate | string <date-time> Default: "2025-01-10T14:15:22Z" Date and time when the payment was posted. |
{- "ContractCodeName": "Payment",
- "GrandTotal": 100,
- "Memo": "test",
- "Method": "Cash",
- "TransactionDate": "2025-01-10T14:15:22Z",
- "Identifiers": {
- "ContractId": "775511",
- "CustomerId": "8",
- "ExternalContractId": "775511"
}
}{- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}Single Elite account receivable payment by Id
| PaymentId required | string |
{- "ModelType": "AccountReceivablePayment",
- "Id": "34",
- "ContractCodeName": "Payment",
- "GrandTotal": 100.25,
- "Identifiers": {
- "ContractId": "7755090",
- "ExternalContractId": "CO-0000001",
- "CustomerId": "12"
}, - "Memo": "Payment being processed through the front counter terminal.",
- "Method": "Card",
- "TransactionDate": "2024-12-01T20:00:00.000Z",
- "State": "Posted"
}Supported by: Elite
This is a list of general ledger journal entries. By default you can retrieve a list of journal entries where State property is equal to 'Pending'. Apply an additional filter to the the State property in order to receive other journal entries states.
[- {
- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "cutlet",
- "Contract": "bowler",
- "Customer": "extent",
- "Department": "Clothing",
- "Employee": "consistency",
- "Item": "Gloves",
- "JobSite": "transparency",
- "Location": "8626 Boyer Plain",
- "Project": "seal",
- "SalesPerson": "Chips",
- "Vendor": "vision"
}, - "Identifiers": {
- "BatchId": 64,
- "ExternalJournalEntryId": 46
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 814,
- "GrandTotal": 890.96,
- "Identifiers": {
- "ContractId": 830,
- "CustomerId": 445,
- "ExternalContractId": 150,
- "ExternalCustomerId": 910,
- "JournalEntryAccountId": 992,
- "JournalEntryId": 101
}, - "Memo": "marketplace"
}
], - "State": "Posted"
}
]Supported by: Elite
This is a single general ledger journal entries retrieved by a given journal entry id.
| JournalEntryId required | string |
{- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "cutlet",
- "Contract": "bowler",
- "Customer": "extent",
- "Department": "Clothing",
- "Employee": "consistency",
- "Item": "Gloves",
- "JobSite": "transparency",
- "Location": "8626 Boyer Plain",
- "Project": "seal",
- "SalesPerson": "Chips",
- "Vendor": "vision"
}, - "Identifiers": {
- "BatchId": 64,
- "ExternalJournalEntryId": 46
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 814,
- "GrandTotal": 890.96,
- "Identifiers": {
- "ContractId": 830,
- "CustomerId": 445,
- "ExternalContractId": 150,
- "ExternalCustomerId": 910,
- "JournalEntryAccountId": 992,
- "JournalEntryId": 101
}, - "Memo": "marketplace"
}
], - "State": "Posted"
}Supported by: Elite
Update an existing General Ledger Journal Entry
| JournalEntryId required | string |
| Id | string Unique identifier for the model type. |
| ErrorCode | string or null Error code value whenever the invoice |
| ErrorDescription | string or null Error description value whenever invoice |
object Default: {"BatchId":811,"ExternalJournalEntryId":651} Collection of unique ids related to this invoice line item. | |
| State | string Default: "Error" Enum: "Pending" "Posted" "Error" Defines the state of the journal entry. Initial value of an journal entry is 'Pending'. If the value is 'Posted' you can not update to another state. |
{- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "tapioca",
- "Contract": "spirit",
- "Customer": "coin",
- "Department": "Electronics",
- "Employee": "handle",
- "Item": "Tuna",
- "JobSite": "glider",
- "Location": "63620 Lexus Parkways",
- "Project": "sarong",
- "SalesPerson": "Towels",
- "Vendor": "seafood"
}, - "Identifiers": {
- "BatchId": 811,
- "ExternalJournalEntryId": 651
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 924,
- "GrandTotal": 25.63,
- "Identifiers": {
- "ContractId": 918,
- "CustomerId": 448,
- "ExternalContractId": 355,
- "ExternalCustomerId": 858,
- "JournalEntryAccountId": 511,
- "JournalEntryId": 995
}, - "Memo": "lamp"
}, - {
- "ModelType": "JournalEntryLineItem",
- "Id": 907,
- "GrandTotal": 271.74,
- "Identifiers": {
- "ContractId": 232,
- "CustomerId": 227,
- "ExternalContractId": 262,
- "ExternalCustomerId": 458,
- "JournalEntryAccountId": 788,
- "JournalEntryId": 532
}, - "Memo": "bidet"
}
], - "State": "Error"
}{- "ModelType": "JournalEntry",
- "Dimensions": {
- "Class": "cutlet",
- "Contract": "bowler",
- "Customer": "extent",
- "Department": "Clothing",
- "Employee": "consistency",
- "Item": "Gloves",
- "JobSite": "transparency",
- "Location": "8626 Boyer Plain",
- "Project": "seal",
- "SalesPerson": "Chips",
- "Vendor": "vision"
}, - "Identifiers": {
- "BatchId": 64,
- "ExternalJournalEntryId": 46
}, - "LineItems": [
- {
- "ModelType": "JournalEntryLineItem",
- "Id": 814,
- "GrandTotal": 890.96,
- "Identifiers": {
- "ContractId": 830,
- "CustomerId": 445,
- "ExternalContractId": 150,
- "ExternalCustomerId": 910,
- "JournalEntryAccountId": 992,
- "JournalEntryId": 101
}, - "Memo": "marketplace"
}
], - "State": "Posted"
}Supported by: Elite
Adds a serialized line item
| LineItemId | string Default: 603 The line item id associated with the fulfillment line item |
| ActionId required | string Default: 374 The id for the fulfillment action being taken. The id must exist in enumlookup/fulfillment/actionid |
| QuantityActioned required | number Default: 582.09 Quantity of the item being actioned. (can be negative) |
| StockId required | string Default: 524 The item id being fulfilled. |
| Eyeballed | boolean Default: false Indicator if the item has been visually inspected during fulfillment. Generally used to indicate if the quantity has been estimated. |
| Notes | string Default: "nucleotidase" The note associated with the fulfillment serialized line item |
{- "LineItemId": 603,
- "ActionId": 374,
- "QuantityActioned": 582.09,
- "StockId": 524,
- "Eyeballed": false,
- "Notes": "nucleotidase"
}{- "ContractId": 370,
- "LineItemId": 719,
- "StockId": 283,
- "ActionId": 461,
- "ActionName": "Rudolph Glover",
- "ActionSourceId": 862,
- "ActionSourceName": "Eileen Spencer",
- "QuantityActioned": 112.43,
- "Eyeballed": false,
- "Notes": "circumference",
- "RemoteUserId": 27
}Supported by: Elite
With this endpoint, you can look up the fulfillment action id. These will be used with the actionid field in the fulfillment endpoints.
| field required | string |
[- {
- "ModelType": "Lookup",
- "Id": "LU-2024-001-ABC",
- "Name": "Aerial Work Platform - Scissor Lift",
- "Description": "Self-propelled elevating work platform with extending platform for heights up to 40ft",
- "Field": "EquipmentCategory",
- "Value": "AWP-SCSR"
}
]Supported by: Elite
| ContractId required | string |
[- {
- "ContractId": 139,
- "LineItemId": 408,
- "StockId": 27,
- "Actions": [
- {
- "Id": 703,
- "Name": "Irma Bradtke-Connelly PhD",
- "QuantityFulfilled": 557.81,
- "QuantityRemaining": 91.34,
- "AreAnyEyeballed": true,
- "LastFulfillmentDateTime": "2026-06-23T06:17:19.845Z",
- "FirstFulfillmentDateTime": "2026-07-01T02:34:17.385Z"
}
]
}
]Supported by: Elite
| LineItemId required | string |
{- "ContractId": 139,
- "LineItemId": 408,
- "StockId": 27,
- "Actions": [
- {
- "Id": 703,
- "Name": "Irma Bradtke-Connelly PhD",
- "QuantityFulfilled": 557.81,
- "QuantityRemaining": 91.34,
- "AreAnyEyeballed": true,
- "LastFulfillmentDateTime": "2026-06-23T06:17:19.845Z",
- "FirstFulfillmentDateTime": "2026-07-01T02:34:17.385Z"
}
]
}Supported by: Elite
| LineItemId required | string |
[- {
- "ContractId": 370,
- "LineItemId": 719,
- "StockId": 283,
- "ActionId": 461,
- "ActionName": "Rudolph Glover",
- "ActionSourceId": 862,
- "ActionSourceName": "Eileen Spencer",
- "QuantityActioned": 112.43,
- "Eyeballed": false,
- "Notes": "circumference",
- "RemoteUserId": 27
}
]Supported by: Elite
Elite supports the following fields for the Search filter:
[- {
- "ModelType": "SalesPerson",
- "Id": "SP-001",
- "Name": "Jane Smith",
- "Phone": "214-555-9876",
- "Status": "Active",
- "Territory": "North Texas",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}
]Supported by: Elite
Retrieve a single SalesPerson by ID
| SalesPersonId required | string |
{- "ModelType": "SalesPerson",
- "Id": "SP-001",
- "Name": "Jane Smith",
- "Phone": "214-555-9876",
- "Status": "Active",
- "Territory": "North Texas",
- "CreatedDateTime": "2024-01-01T00:00:00Z"
}Supported by: Elite
Elite supports the following fields for the Search filter:
[- {
- "ProductId": "17254",
- "Quantity": "1",
- "ProductAssociation": {
- "ProductAssociationId": "21068",
- "ProductAssociationType": "Automatic"
}
}
]Supported by: Elite
{- "ModelType": "WebProductAssociation",
- "Id": "WPA-2024-03-15-001",
- "ParentProductId": "SKU-SKIDSTEER-S650",
- "ParentStockId": "STOCK-S650-123456",
- "ChildProductId": "SKU-ATTACHMENT-BUCKET-72",
- "ChildStockId": "STOCK-BUCKET-987654",
- "AssociationType": "Optional",
- "Group": "Skid Steer Attachments",
- "GroupSelectionType": "ChooseOne",
- "IsSelected": true,
- "DisplayOrder": 1,
- "CreatedDateTime": "2024-03-15T14:30:00Z",
- "UpdatedDateTime": "2024-03-15T15:45:00Z",
- "Quantity": 4
}Supported by: Elite
Retrieve a single WebProduct by Id
| Id required | string |
{- "ProductId": "17254",
- "Quantity": "1",
- "ProductAssociation": {
- "ProductAssociationId": "21068",
- "ProductAssociationType": "Automatic"
}
}Supported by: Elite
Get an Estimate
| CustomerId | string The unique identifier of the customer requesting the estimate |
| DepotId required | string Default: "001" The unique identifier of the rental depot/branch location where the equipment will be rented from |
| LocationId | string or null Optional identifier for the specific delivery location within the customer's account |
| EndDateTime required | string <date-time> Default: "2025-04-29T04:00:00Z" The date and time when the rental period ends (in ISO 8601 format) |
| StartDateTime required | string <date-time> Default: "2025-04-29T00:00:00Z" The date and time when the rental period begins (in ISO 8601 format) |
required | Array of objects Default: [{"Quantity":"1","ProductId":"17254","ProductAssociation":{"ProductAssociationId":"21068","ProductAssociationType":"Automatic"}}] List of products to be included in the rental estimate |
{- "DepotId": "001",
- "StartDateTime": "2025-04-29T00:00:00Z",
- "EndDateTime": "2025-04-29T04:00:00Z",
- "Products": [
- {
- "Quantity": "1",
- "ProductId": "17254",
- "ProductAssociation": {
- "ProductAssociationId": "21068",
- "ProductAssociationType": "Automatic"
}
}
]
}{- "CustomerId": "227179",
- "DepotId": "002",
- "StartDateTime": "2025-08-01T12:00:00Z",
- "EndDateTime": "2025-08-05T12:00:00Z",
- "Notes": "Notes mine"
}