/maintainx-inventory | Type: Application | PCID required: Yes
Tools
maintainx_inventory_create_manufacturers
Create new manufacturer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
name | string | Yes | — | Manufacturer name. |
maintainx_inventory_create_models
Create new model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
manufacturerId | integer | Yes | — | Manufacturer ID the model belongs to. |
name | string | Yes | — | Model name. |
maintainx_inventory_create_parts
Create new part Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
area | string | No | — | Area of the part. Deprecated: Use new field inside locations. Will cause error if both fields are sent. |
assetIds | integer[] | No | — | List of asset IDs |
availableQuantity | integer | No | — | Total quantity currently in stock. Deprecated: Use new field inside locations. Will cause error if both fields are sent. |
barcode | string | No | — | String encoded barcode |
description | string | No | — | The description value |
extraFields | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Part Number”) |
locationId | integer | No | — | ID of the location where the part is located. Deprecated: Use new field inside locations. Will cause error if both fields are sent. |
locations | object[] | No | — | Detailed list of locations where the part is stored, including properties such as available quantity, minimum quantity, reserved quantity, and area within each location. |
minimumQuantity | integer | No | — | Total minimum quantity before you should restock. Deprecated: Use new field inside locations. Will cause error if both fields are sent. |
name | string | Yes | — | The name value |
partTypes | string[] | No | — | List of part types |
teamIds | integer[] | No | — | List of team IDs in charge of the part |
unitCost | integer | No | — | Cost in cents. For example, for $1.20, put 120. |
vendorIds | integer[] | No | — | List of vendor IDs. Deprecated: Use the vendorId field inside vendors. |
vendors | object[] | No | — | List of vendors of the part |
maintainx_inventory_create_parttransferrequests
Create a part transfer request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
destinationPartId | integer | Yes | — | ID of the part that belongs to the organization performing the request. (Receiving stocks) |
quantityRequested | integer | Yes | — | Quantity of parts requested for transfer. |
requestMessage | string | No | — | Message to give context surrounding the part transfer request. |
sourcePartId | integer | Yes | — | ID of the part that belongs to the organization receiving the request. (Sending stocks) |
maintainx_inventory_create_purchaseorders
Create new purchase order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
billingAddress | object | No | — | Billing address in the Purchase Order |
billingAddressId | number | No | — | Billing address Id in the Purchase Order |
costs | object[] | No | — | List of costs in the Purchase Order |
deletedAt | string | No | — | Date at which the Purchase Order was deleted |
dueDate | string | No | — | Due date of Purchase Order |
extraFields | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Ordered Date”) |
items | object[] | Yes | — | List of items in the Purchase Order |
note | string | No | — | Notes left for Purchase Orders |
overrideNumber | string | No | — | Custom number/identifier for Purchase Order |
shippingAddress | object | No | — | Shipping address in the Purchase Order |
shippingAddressId | number | No | — | Shipping address Id in the Purchase Order |
title | string | No | — | Title of the Purchase Order. Will be ignored if organization setting for custom purchase order titles is disabled. |
vendorContactIds | number[] | No | — | List of vendor contact IDs in the Purchase Order |
vendorId | number | Yes | — | ID of vendor that this Purchase Order is associated with |
maintainx_inventory_create_purchaseorders_comments
Create new comment on a purchase order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Global ID of the purchase order |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
content | string | Yes | — | Content of the comment to post |
maintainx_inventory_create_purchaseorders_emails
Send Purchase Order as an email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Global ID of the Purchase Order |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
emails | string[] | No | — | Emails to send the Purchase Order to |
emailsCC | string[] | No | — | Emails to send the Purchase Order to as a carbon copy (CC) |
maintainx_inventory_create_vendors
Create new vendor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
x-organization-id | integer | No | — | Required if using a multi organizations token |
description | string | No | — | The description value |
emails | string[] | No | — | List of email address |
extraFields | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Qualifications”) |
name | string | Yes | — | The name value |
phoneNumbers | string[] | No | — | List of phone number |
maintainx_inventory_create_vendors_contacts
Create new contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
email | string | No | — | Email address of contact. |
extension | string | No | — | Phone number extension |
name | string | Yes | — | The name value |
phoneNumber | string | No | — | Phone number of contact |
role | string | No | — | Role/Label of the contact. |
maintainx_inventory_delete_parts
Delete part Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the part |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_inventory_delete_parts_attachments
Remove part attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the part. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_inventory_delete_purchaseorders
Delete purchaseOrder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the purchaseOrder |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_inventory_delete_purchaseorders_attachments
Remove purchase order attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the purchase order. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_inventory_delete_vendors
Delete vendor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_inventory_delete_vendors_attachments
Remove vendor attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_inventory_delete_vendors_contacts
Delete contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor |
contactId | integer | Yes | — | ID of the contact |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
maintainx_inventory_get_manufacturers
Get manufacturer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the manufacturer |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_inventory_get_models
Get model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the model |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_inventory_get_parts
Get part Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the part |
maintainx_inventory_get_parttransferrequests
Get part transfer request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the partTransferRequest |
maintainx_inventory_get_purchaseorders
Get purchase order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the purchaseOrder |
maintainx_inventory_get_vendors
Get vendor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor |
maintainx_inventory_get_vendors_contacts
List contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Contacts returned |
id | integer | Yes | — | ID of the vendor |
maintainx_inventory_get_vendors_contacts_2
Get contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor |
contactId | integer | Yes | — | ID of the contact |
maintainx_inventory_list_manufacturers
List manufacturers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Manufacturers returned |
x-organization-id | integer | No | — | Required if using a multi organizations token |
x-organization-ids | string | No | — | Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other). |
maintainx_inventory_list_models
List models Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Models returned |
x-organization-id | integer | No | — | Required if using a multi organizations token |
x-organization-ids | string | No | — | Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other). |
maintainx_inventory_list_parts
List parts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Parts returned |
partNumber | string[] | No | — | Will only show parts that have a vendor with this part number associated to them. |
customFieldName | string[] | No | — | Filter parts by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named “Industry” with the value “Construction”, you would do this “/parts?Industry=Construction”). <br><br>Adding multiple instance of the same custom field act as an <code>OR</code> and adding a different custom field act as an <code>AND</code>. (ie: To filter by a custom field named <code>Industry</code> with the value <code>Construction</code> OR <code>Transportation</code> AND the custom field <code>Manufacturer</code> with the value <code>ACME</code>, you would do this <code>/parts?Industry=Construction&Industry=Transportation&Manufacturer=ACME</code>). <br><br>If your custom field label is the same as a reserved query parameter such as <code>limit</code>, <code>sort</code>, <code>expand</code>, etc, you can add <code>__c</code> to your custom field filtering (ie: To filter by a custom field named <code>limit</code> with the value <code>ten</code>, you would do this <code>/parts?limit__c=ten</code>). <br><br>Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported. |
sort | string | No | — | Attribute on which to sort the list. (for descending order, prefix attribute with ’-’). |
expand | string[] | No | — | To expand multiple fields: expand=extra_fields&expand=vendors |
x-organization-id | integer | No | — | Required if using a multi organizations token |
x-organization-ids | string | No | — | Required if using a multi organizations token and doing an operation on resources from multiple organizations. This is mutually exclusive with the x-organization-id header (use one or the other). |
maintainx_inventory_list_parttransferrequests
List part transfer requests Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Part Transfer Requests returned |
statuses | string[] | No | — | To filter by multiple status: status=APPROVED&status=DECLINED |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_inventory_list_purchaseorders
List purchase orders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Purchase Orders returned |
customFieldName | string[] | No | — | Filter purchase orders by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named “Industry” with the value “Construction”, you would do this “/purchaseorders?Industry=Construction”). <br><br>Adding multiple instance of the same custom field act as an <code>OR</code> and adding a different custom field act as an <code>AND</code>. (ie: To filter by a custom field named <code>Industry</code> with the value <code>Construction</code> OR <code>Transportation</code> AND the custom field <code>Manufacturer</code> with the value <code>ACME</code>, you would do this <code>/purchaseorders?Industry=Construction&Industry=Transportation&Manufacturer=ACME</code>). <br><br>If your custom field label is the same as a reserved query parameter such as <code>limit</code>, <code>sort</code>, <code>expand</code>, etc, you can add <code>__c</code> to your custom field filtering (ie: To filter by a custom field named <code>limit</code> with the value <code>ten</code>, you would do this <code>/purchaseorders?limit__c=ten</code>). <br><br>Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported. |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_inventory_list_vendors
List vendors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Vendors returned |
customFieldName | string[] | No | — | Filter vendors by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named “Industry” with the value “Construction”, you would do this “/vendors?Industry=Construction”). <br><br>Adding multiple instance of the same custom field act as an <code>OR</code> and adding a different custom field act as an <code>AND</code>. (ie: To filter by a custom field named <code>Industry</code> with the value <code>Construction</code> OR <code>Transportation</code> AND the custom field <code>Manufacturer</code> with the value <code>ACME</code>, you would do this <code>/vendors?Industry=Construction&Industry=Transportation&Manufacturer=ACME</code>). <br><br>If your custom field label is the same as a reserved query parameter such as <code>limit</code>, <code>sort</code>, <code>expand</code>, etc, you can add <code>__c</code> to your custom field filtering (ie: To filter by a custom field named <code>limit</code> with the value <code>ten</code>, you would do this <code>/vendors?limit__c=ten</code>). <br><br>Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported. |
expand | string[] | No | — | Related resources to expand inline |
x-organization-id | integer | No | — | Required if using a multi organizations token |
maintainx_inventory_list_vendors_contacts
List contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Last pagination reference |
limit | integer | No | — | max number of Contacts returned |
id | integer | Yes | — | ID of the vendor |
maintainx_inventory_update_parts
Update part Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the part |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
area | string | No | — | Area of the part. Deprecated: Use new field inside locations. Will cause error if both fields are sent. See https://help.getmaintainx.com/multi-location-parts#integration-issues-with-multi-location-parts for more information. |
assetIds | integer[] | No | — | List of asset IDs |
availableQuantity | integer | No | — | Total quantity currently in stock. Deprecated: Use new field inside locations. Will cause error if both fields are sent. See https://help.getmaintainx.com/multi-location-parts#integration-issues-with-multi-location-parts for more information. |
barcode | string | No | — | String encoded barcode |
createdAt | string | No | — | Date & time at which the part was created |
deletedAt | string | No | — | Date at which the part was deleted |
description | string | No | — | The description value |
extraFields | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Part Number”) |
locationId | integer | No | — | ID of the location where the part is located. Deprecated: Use new field inside locations. Will cause error if both fields are sent. See https://help.getmaintainx.com/multi-location-parts#integration-issues-with-multi-location-parts for more information. |
locations | object | No | — | List of locations to add, update or remove. |
minimumQuantity | integer | No | — | Total minimum quantity before you should restock. Deprecated: Use new field inside locations. Will cause error if both fields are sent. See https://help.getmaintainx.com/multi-location-parts#integration-issues-with-multi-location-parts for more information. |
name | string | No | — | The name value |
partTypes | string[] | No | — | List of part types |
teamIds | integer[] | No | — | List of team IDs in charge of the part |
unitCost | integer | No | — | Cost in cents. For example, for $1.20, put 120. |
updatedAt | string | No | — | Date & time at which the part was last updated. This doesn’t include comments |
vendorIds | integer[] | No | — | List of vendor IDs. Deprecated: Use the vendorId field inside vendors. |
vendors | object[] | No | — | List of vendors of the part |
maintainx_inventory_update_parttransferrequests
Update part transfer request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the part transfer request |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
destinationLocations | object[] | No | — | Locations into which the transferred parts were received. (Receiving stocks) |
quantity | integer | No | — | Quantity to update for the relevant status. |
responseMessage | string | No | — | Message to give context surrounding the transfer of the part transfer request. |
sourceLocationId | integer | No | — | ID of the location in the organization from which parts were transferred. (Sending stocks) |
status | string | No | — | Status of the part transfer request. |
maintainx_inventory_update_purchaseorders
Update purchase order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | number | Yes | — | The id value |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
billingAddress | object | No | — | Billing address in the Purchase Order |
billingAddressId | number | No | — | Billing address Id in the Purchase Order |
costs | object[] | No | — | List of costs in the Purchase Order |
deletedAt | string | No | — | Date at which the Purchase Order was deleted |
dueDate | string | No | — | Due date of Purchase Order |
extraFields | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Ordered Date”) |
items | object[] | No | — | List of items in the Purchase Order |
note | string | No | — | Notes left for Purchase Orders |
overrideNumber | string | No | — | Custom number/identifier for Purchase Order |
reviewNote | string | No | — | Notes to be left for changes to be made when sending a Purchase Order for revision |
shippingAddress | object | No | — | Shipping address in the Purchase Order |
shippingAddressId | number | No | — | Shipping address Id in the Purchase Order |
status | string | No | — | Please use the PATCH /purchaseorders/{id}/status endpoint instead. |
title | string | No | — | Title of the Purchase Order. Will be ignored if organization setting for custom purchase order titles is disabled. |
vendorContactIds | number[] | No | — | List of vendor contact IDs in the Purchase Order |
vendorId | number | No | — | ID of vendor that this Purchase Order is associated with |
maintainx_inventory_update_purchaseorders_fulfillment
Fulfill purchase order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | number | Yes | — | The id value |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
items | any[] | No | — | List of items in the Purchase Order |
maintainx_inventory_update_purchaseorders_status
Update purchase order status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | number | Yes | — | The id value |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
reviewNote | string | No | — | Notes to be left for changes to be made when sending a Purchase Order for revision |
status | string | No | — | Here is a list of valid status transitions: | Current Status | Allowed Transitions | Description | |---------------------|------------------------------------------|-------------------------------------------------------| | REQUESTED | CANCELED DECLINED PENDING | Initial state when PO is first created | | PENDING | APPROVED CANCELED DECLINED | PO is awaiting approval | | DECLINED | CANCELED PENDING | PO was rejected and needs revision | | APPROVED | CANCELED or start receiving items | PO is approved and items can be received | | PARTIALLY_FULFILLED| COMPLETED | Some items have been received | | CANCELED | None | PO has been canceled and cannot be modified | | COMPLETED | PARTIALLY_FULFILLED | All items have been received | Notes: - Status changes trigger notifications to relevant users and vendors - You can subscribe to status changes using webhooks - The DECLINED status is displayed as ‘Rejected’ in the application interface - Moving to PARTIALLY_FULFILLED happens automatically when items are received - Use the optional reviewNote field to provide feedback when declining a purchase order |
maintainx_inventory_update_vendors
Update vendor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
description | string | No | — | The description value |
extraFields | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: “Qualifications”) |
name | string | No | — | The name value |
maintainx_inventory_update_vendors_contacts
Update contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor |
contactId | integer | Yes | — | ID of the contact |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
email | string | No | — | Email address of contact. |
extension | string | No | — | Phone number extension |
name | string | No | — | The name value |
phoneNumber | string | No | — | Phone number of contact |
role | string | No | — | Role/Label of the contact. |
maintainx_inventory_upload_parts_attachments
Update part attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the part. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the attachment. |
maintainx_inventory_upload_parts_thumbnail
Update part’s thumbnail Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the part. |
filename | string | Yes | — | Name of the part thumbnail, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the thumbnail. |
maintainx_inventory_upload_purchaseorders_attachments
Update purchase order attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the purchase order. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the attachment. |
maintainx_inventory_upload_purchaseorders_thumbnail
Update purchase order’s thumbnail Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the purchase order. |
filename | string | Yes | — | Name of the purchase order thumbnail, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the thumbnail. |
maintainx_inventory_upload_vendors_attachments
Update vendor attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor. |
filename | string | Yes | — | Name of the attachment, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the attachment. |
maintainx_inventory_upload_vendors_thumbnail
Update vendor’s thumbnail Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the vendor. |
filename | string | Yes | — | Name of the vendor thumbnail, including the extension. |
skipWebhook | boolean | No | — | Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks |
body | object | Yes | — | Content type should be application/octet-stream and payload should use binary format for the thumbnail. |

