Appointments
API | Description |
---|---|
GET v1/appointments/{id} |
Gets appointment details by id |
POST v1/appointments/search |
Gets list of appointment using the search filters passed in the request body |
GET v1/appointments/types |
Gets all appointment types |
BillCredits
APIs to search, create and update bill credits.
API | Description |
---|---|
GET v1/bill-credits/{id} |
Gets bill credit details by id |
POST v1/bill-credits/search |
Gets list of bill credits using the search filters passed in the request body |
POST v1/bill-credits |
Creates new or updates existing bill credit. This API performs full update for an existing bill credit so ensure that all parameters and IDs are correctly supplied when using this api for update. If AppliedToBills property is set, the bill credit will be applied to the specified bills. |
POST v1/bill-credits/{id}/apply |
Applies bill credits unapplied amount to specified open bills. |
POST v1/bill-credits/{id}/void |
Voids bill credit specified by id. This action cannot be undone. |
GET v1/bill-credits/{id}/notes?PageIndex={PageIndex}&PageSize={PageSize} |
Gets list of notes for the bill credit specified by bill credit id |
GET v1/bill-credits/{id}/attachments |
Gets list of attachments for the bill credit specified by bill credit id |
GET v1/bill-credits/{id}/attachments/{attachmentId} |
Downloads a bill credit's attachment specified by attachment id and bill credit id |
POST v1/bill-credits/{id}/attachments |
Uploads attachment to a specified bill credit |
Bills
APIs to search, create and update bills.
API | Description |
---|---|
GET v1/bills/{id} |
Gets bill details by id |
POST v1/bills/search |
Gets list of bills using the search filters passed in the request body |
POST v1/bills |
Creates new or updates existing bill. This API performs full update for an existing bill so ensure that all parameters and IDs are correctly supplied when using this api for update. |
POST v1/bills/{id}/void |
Voids bill specified by id. This action cannot be undone. |
GET v1/bills/{id}/notes?PageIndex={PageIndex}&PageSize={PageSize} |
Gets list of notes for the bill specified by bill id |
GET v1/bills/{id}/attachments |
Gets list of attachments for the bill specified by bill id |
GET v1/bills/{id}/attachments/{attachmentId} |
Downloads a bill's attachment specified by attachment id and bill id |
POST v1/bills/{id}/attachments |
Uploads attachment to a specified bill |
Categories
APIs to pull categories
API | Description |
---|---|
GET v1/customer-categories |
Gets list of all available active/inactive customer categories |
GET v1/item-categories |
Gets list of all available active/inactive item categories |
GET v1/vendor-categories |
Gets list of all available active/inactive vendor categories |
GET v1/opportunity-categories |
Gets list of all available active/inactive opportunity categories |
Classes
API | Description |
---|---|
GET v1/classes |
Gets list of all available active/inactive classes |
Company
APIs to pull company Information
API | Description |
---|---|
GET v1/company/profile |
Gets company profile information |
CompanyLocations
API's to search company locations
API | Description |
---|---|
GET v1/company-locations |
Gets list of company locations |
Contacts
APIs to search, create and update contacts
API | Description |
---|---|
GET v1/contacts/{id} |
Gets contact details by id including customer and vendor associations |
POST v1/contacts/search |
Gets list of available contacts using the search filters passed in the request body |
POST v1/contacts |
Allows contact creation and update |
POST v1/contacts/{id}/associate-customer |
Associates an existing contact with an existing customer. User should know the ContactID and CustomerID prior to creating association. if there is an existing asssociation between the contact and customer, the association will be updated with the information supplied |
POST v1/contacts/{id}/associate-vendor |
Associates an existing contact with an existing vendor. User should know the ContactID and VendorID prior to creating association. if there is an existing asssociation between the contact and vendor, the association will be updated with the information supplied |
CreditMemos
APIs for searching Credit Memo and getting Credit Memo Details
API | Description |
---|---|
GET v1/credit-memos/{id} |
Gets credit memo details by id |
POST v1/credit-memos/search |
Search for credit memo using the search filters passed in request body |
POST v1/credit-memos |
Creates new or updates existing Credit Memo. This API performs full update for an existing credit memo so ensure that all parameters and IDs are correctly supplied when using this api for update. |
POST v1/credit-memos/{id}/apply |
Applies credit memo unapplied amount to specified open invoices. |
POST v1/credit-memos/{id}/auto-apply |
Auto applies credit memo unapplied amount to open invoices starting with oldest date and greater open balance. |
POST v1/credit-memos/{id}/void |
Voids CreditMemo specified by id. This action cannot be undone. |
GET v1/credit-memos/{id}/attachments |
Gets list of attachments for the Credit Memo specified by Credit Memo id |
GET v1/credit-memos/{id}/attachments/{attachmentId} |
Downloads a Credit Memo's attachment specified by attachment id and Credit Memo id |
POST v1/credit-memos/{id}/attachments |
Uploads attachment to a specified Credit Memo |
CustomerAssets
API | Description |
---|---|
GET v1/customer-assets/{id} |
Gets customer asset details by id |
POST v1/customer-assets |
Creates new or updates existing customer asset. This API performs full update for an existing customer asset, so ensure that all parameters and IDs are correctly supplied when using this API for an update. |
POST v1/customer-assets/search |
Gets a list of customer assets that meet the search parameter criteria |
GET v1/customer-assets/types |
Gets a list of all available asset types |
GET v1/customer-assets/{id}/custom-fields |
Gets list of custom fields for the asset specified by customer asset id |
GET v1/customer-assets/types/{assetTypeId}/custom-fields |
Gets the custom field definitions for the customer asset type id |
POST v1/customer-assets/{id}/custom-fields |
Saves the custom fields for the specified id |
POST v1/customer-assets/{id}/update-status |
Updates the status and sets the Status Note |
POST v1/customer-assets/{id}/maintenance-schedule |
Creates or updates a Maintenance Schedule entry for an Asset. |
CustomerLocations
APIs to search customer locations
API | Description |
---|---|
POST v1/customer-locations/search |
Gets list of available customer locations using the search filters passed in the request body |
Customers
APIs to search, create and update customers
API | Description |
---|---|
GET v1/customers/{id} |
Gets customer details by id |
POST v1/customers/search |
Gets list of available customers using the search filters passed in the request body |
POST v1/customers |
Allows customer creation and full update |
POST v1/customers/create |
Allows customer creation |
POST v1/customers/{id}/location |
Creates a new customer location -- returns the new location, which contains the newly generated unique id |
GET v1/customers/{id}/contacts |
Gets list of contacts associated with the customer specified by customer id |
GET v1/customers/{id}/price-list |
Gets list of price list items associated with the customer specified by customer id |
GET v1/customers/{id}/price-list/items/{itemId} |
Gets price list item associated with the specified customer and item id |
GET v1/customers/{id}/locations |
Gets list of locations for the customer specified by customer id |
GET v1/customers/{id}/payment-profiles |
Gets list of payment profiles for the customer specified by customer id |
GET v1/customers/{id}/custom-fields |
Gets list of custom fields for the customer specified by customer id |
POST v1/customers/{id}/custom-fields |
Saves the custom fields for the specified id |
GET v1/customers/{id}/hub/content-groups |
Gets the hub content groups for a particular customer |
POST v1/customers/{id}/hub/content-groups/{groupId}/documents |
Uploads a document to the customer's hub. NOTE: If you want to upload documents to a group by its name, then specify the group name in the header with this key: Content-Group-Name If the group does not exist, then a new group with this name will be created. In this case you don't have to pass groupId as URI parameter. Specify the Overwrite-Existing-Files header (true|false) to overwrite the existing file(s). Specify Visible-On-Portal header (true|false) to set visibility of uploaded documents on the Striven Customer/Vendor Portal. |
POST v1/customers/{id}/hub/documents?groupId={groupId} |
Uploads a document to the customer's hub. NOTE: If you want to upload documents to a group by its name, then specify the group name in the header with this key: Content-Group-Name If the group does not exist, then a new group with this name will be created. In this case you don't have to pass groupId as URI parameter. Specify the Overwrite-Existing-Files header (true|false) to overwrite the existing file(s). Specify Visible-On-Portal header (true|false) to set visibility of uploaded documents on the Striven Customer/Vendor Portal. |
CustomList
Gets items of a custom list in the system
API | Description |
---|---|
GET v1/custom-lists |
Gets list of all types of custom lists. |
GET v1/custom-lists/{id}/list-items |
Gets the list of choices for a custom list type |
CustomReports
APIs to pull categories
API | Description |
---|---|
GET v2/custom-report/{accessKey}?pageIndex={pageIndex} |
Gets data from Striven Custom Reports |
Employees
API to search employees
API | Description |
---|---|
GET v1/employees |
Gets a list of available active employees in the system |
GET v1/employees/{id} |
Gets employee details by id |
Formats
APIs to pull formats
API | Description |
---|---|
GET v1/invoice-formats |
Get list of all available active/inactive invoice formats |
GLAccounts
API | Description |
---|---|
POST v1/gl-accounts |
Creates new or updates existing gl account This API performs full update of an existing gl account. Ensure that all parameters and IDs are correctly supplied. |
GET v1/gl-accounts/{id} |
Gets a GL Acccount by id |
POST v1/gl-accounts/search |
Gets GL Accounts based on filters |
GET v1/glaccounts Deprecated |
This method is deprecated. Please use v1/gl-accounts/search instead. |
GLCategories
API | Description |
---|---|
GET v1/glcategories Deprecated |
Gets all active GLCategories. (This method is deprecated. Please use v1/classes instead.) |
Industries
API | Description |
---|---|
GET v1/industries |
Gets list of available active/inactive industries |
InventoryAdjustments
APIs to adjust inventory
API | Description |
---|---|
POST v1/inventory/adjustments |
Creates new quantity/value inventory adjustments. This API does not update the existing inventory adjustments. |
InventoryLocations
API | Description |
---|---|
GET v1/inventory-locations |
Gets list of all available active/inactive inventory locations |
Invoices
APIs for searching Invoices and getting Invoice Details
API | Description |
---|---|
GET v1/invoices/{id} |
Gets invoice details by id |
POST v1/invoices/search |
Search for invoice using the search filters passed in request body |
POST v1/invoices |
Creates new or updates existing Invoice. This API performs full update for an existing invoice so ensure that all parameters and IDs are correctly supplied when using this api for update. |
POST v1/invoices/{id}/void |
Voids Invoice specified by id. This action cannot be undone. |
GET v1/invoices/{id}/attachments |
Gets list of attachments for the invoice specified by invoice id |
GET v1/invoices/{id}/attachments/{attachmentId} |
Downloads an invoice's attachment specified by attachment id and invoice id |
POST v1/invoices/{id}/attachments |
Uploads attachment to a specified invoice |
GET v1/invoices/{id}/format |
Downloads an invoice's format related to the invoice specified by invoice id |
GET v1/invoices/{id}/format/{formatId} |
Downloads an invoice's format specified by format id and invoice id |
ItemBuilds
API | Description |
---|---|
GET v1/item-builds/{id} |
Gets item build details by id |
POST v1/item-builds/search |
Gets list of available builds using the search filters passed in the request body |
POST v1/item-builds |
Creates new or updates existing builds. This API performs a full update for an existing build, so ensure that all parameters and IDs are correctly supplied when using this api for update. Update is only valid for Builds with Incomplete/Pending Status. When creating a build IF the status is pending or finalized, validation will be performed if the quantity to be built is not available. An error will be returned in that case. |
POST v1/item-builds/{id}/mark-finalized |
Performs validation and marks the build as finalized if validations are met and if the status is pending/incomplete. Postings will also be generated. |
POST v1/item-builds/{id}/mark-pending |
Performs validation and marks the build as pending if the status is incomplete. |
POST v1/item-builds/{id}/void |
Voids build specified by id. This action cannot be undone. |
GET v1/item-builds/{id}/attachments |
Gets list of attachments for the build specified by build id |
GET v1/item-builds/{id}/attachments/{attachmentId} |
Downloads a build's attachment specified by attachment id and build id |
POST v1/item-builds/{id}/attachments |
Uploads attachment to a specified build |
GET v1/item-builds/{id}/custom-fields |
Gets list of custom fields for the build specified by build id |
POST v1/item-builds/{id}/custom-fields |
Saves the custom fields for the specified id |
Items
API | Description |
---|---|
GET v1/items/{id} |
Gets Item details by id |
POST v1/items/{id}/deactivate |
Deactivates an item given an ID |
POST v1/items/search |
Gets list of available items using the search filters passed in the request body |
POST v1/items |
Creates new or updates existing item. This API performs full update for an existing item so ensure that all parameters and IDs are correctly supplied when using this api for update. |
GET v1/items/{itemId}/inventory-locations?asOfDate={asOfDate} |
Returns Inventory locations with Qty On Hand and Qty Available for an item. If UoM tracking is ON, then the returned numbers are in base unit for that item. |
GET v1/items/{id}/custom-fields |
Gets list of custom fields for the item specified by item id |
POST v1/items/{id}/custom-fields |
Saves the custom fields for the specified id |
POST v1/items/{id}/images |
Uploads images for an item. Optionally set one as the default. (If no default is set, the first one will be automatically chosen if there is currently no default). Requires a MIME Multipart Content with the files you wish to upload. Use Default-Filename to set which file is default. The filename is the name of the original file with extension. |
GET v1/items/{id}/images |
Gets list of images for the item specified by item id |
GET v1/items/{id}/images/{imageId} |
Downloads an item's image specified by id and image id |
DELETE v1/items/{id}/images/{imageId} |
Deletes an image from the item |
POST v1/items/{id}/images/{imageId}/set-default |
Sets an image as default |
ItemTypes
API | Description |
---|---|
GET v1/item-types |
Gets list of all available item types |
JournalEntries
API | Description |
---|---|
POST v1/journal-entries |
Creates new or updates existing Journal Entry. This API performs full update for an existing journal entry so ensure that all parameters and IDs are correctly supplied when using this api for update. |
POST v1/journal-entries/{id}/void |
Voids JournalEntry specified by id. This action cannot be undone. |
Opportunities
APIs to search and create opportunities
API | Description |
---|---|
POST v1/opportunities |
Allows the creation of a new Opportunity. |
GET v1/opportunities/{id} |
Gets opportunity details by id |
POST v1/opportunities/search |
Gets a list of opportunities that meet the search parameter criteria |
GET v1/opportunities/{id}/custom-fields |
Gets list of custom fields for the opportunity specified by opportunity id |
POST v1/opportunities/{id}/custom-fields |
Saves the custom fields for the specified id |
GET v1/opportunities/types |
Gets list of opportunity types along with stages associated to those types |
GET v1/opportunities/priorities |
Gets list of opportunity priorities |
PaymentMethods
API to search payment methods.
API | Description |
---|---|
GET v1/payment-methods |
Gets list of available payment methods that doesn't require processing |
PaymentProcessingMethods
API to search payment processing methods.
API | Description |
---|---|
GET v1/payment-processing-methods |
Gets list of available payment processing methods |
Payments
APIs to search, create and update payments.
API | Description |
---|---|
GET v1/payments/{id} |
Gets payment details by id |
POST v1/payments/search |
Gets list of payments using the search filters passed in the request body |
POST v1/payments |
Creates a new payment. If the AutoApply flag is set to true, the payment will be auto-applied to open invoices if there are any. If AppliedToInvoices property is set, the payment will be applied to the specified invoices. Update operation is not available. |
POST v1/payments/{id}/apply |
Applies payment unapplied amount to specified open invoices. |
POST v1/payments/{id}/auto-apply |
Auto applies payment unapplied amount to open invoices starting with oldest date and greater open balance. |
POST v1/payments/{id}/void |
Voids payment specified by id. This action cannot be undone. |
GET v1/payments/{id}/attachments |
Gets list of attachments for the payment specified by payment id |
GET v1/payments/{id}/attachments/{attachmentId} |
Downloads a payment's attachment specified by attachment id and payment id |
POST v1/payments/{id}/attachments |
Uploads attachment to a specified payment |
PaymentTerms
API | Description |
---|---|
GET v1/payment-terms?excludeDiscounts={excludeDiscounts} |
Gets list of all available active/inactive payment terms |
Pools
API to search pools
API | Description |
---|---|
GET v1/pools |
Gets a list of available active pools in the system |
Projects
APIs for searching projects, getting project details. Also available are API's to upload and download attachment for a given project hub.
API | Description |
---|---|
GET v1/projects/{id}/hub/content-groups |
Gets the hub content groups for a particular project |
POST v1/projects/{id}/hub/content-groups/{groupId}/documents |
Uploads a document to the project's hub. NOTE: If you want to upload documents to a group by its name, then specify the group name in the header with this key: Content-Group-Name If the group does not exist, then a new group with this name will be created. In this case you don't have to pass groupId as URI parameter. Specify the Overwrite-Existing-Files header (true|false) to overwrite the existing file(s). Specify Visible-On-Portal header (true|false) to set visibility of uploaded documents on the Striven Customer/Vendor Portal. |
POST v1/projects/{id}/hub/documents?groupId={groupId} |
Uploads a document to the project's hub. NOTE: If you want to upload documents to a group by its name, then specify the group name in the header with this key: Content-Group-Name If the group does not exist, then a new group with this name will be created. In this case you don't have to pass groupId as URI parameter. Specify the Overwrite-Existing-Files header (true|false) to overwrite the existing file(s). Specify Visible-On-Portal header (true|false) to set visibility of uploaded documents on the Striven Customer/Vendor Portal. |
GET v1/projects/{id} |
Get Project details by ProjectId |
POST v1/projects/search |
Searches for projects using the search filters passed in request body |
PurchaseOrders
APIs for searching Purchase Order, getting PO Details, notes, attachments. Also available are API's to download an attachment for a given Purchase Order.
API | Description |
---|---|
POST v1/purchase-orders/search |
Search for purchase order using the search filters passed in request body |
GET v1/purchase-orders/{id} |
Gets purchase order details by id |
POST v1/purchase-orders |
Creates new or updates existing non-contract managed purchase order. This API performs full update for an existing purchase order so ensure that all parameters and IDs are correctly supplied when using this api for update. |
POST v1/purchase-orders/{id}/close-po |
Marks the PO as closed. Also provides the ability to bill for the remaining items on close. |
POST v1/purchase-orders/{id}/bill-remaining |
Creates a bill for all the remaining items that haven’t been billed for in the PO. All defaults from the PO are used to create the bill. |
GET v1/purchase-orders/{id}/notes?pageIndex={pageIndex}&pageSize={pageSize} |
Gets all notes for a purchase order |
GET v1/purchase-orders/{id}/attachments |
Gets all attachments for a purchase order |
GET v1/purchase-orders/{id}/attachments/{attachmentId} |
Downloads a purchase orders's attachment specified by attachment id and PO id |
GET v1/purchase-orders/{id}/custom-fields |
Gets list of custom fields for the specified id |
POST v1/purchase-orders/{id}/custom-fields |
Saves the custom fields for the specified id |
GET v1/purchase-orders/formats |
Get list of all available active purchase order formats |
GET v1/purchase-orders/{id}/format/{formatId} |
Downloads a purchase order's format specified by format id and purchase order id |
POST v1/purchase-orders/{id}/email-vendor-contact?formatId={formatId} |
Emails the purchase order to the contact set on the PO in the format specified by the id. To get the formats refer to GET v1/purchase-orders/formats |
PurchaseOrderTypes
API | Description |
---|---|
GET v1/purchase-order-types |
Gets list of all available purchase order types |
ReferralSources
API | Description |
---|---|
GET v1/referral-sources |
Gets list of available active/inactive referral sources |
SalesOrders
APIs to search, create and update sales orders.
API | Description |
---|---|
GET v1/sales-orders/{id} |
Gets sales order details by id |
POST v1/sales-orders/search |
Gets list of sales orders using the search filters passed in the request body |
POST v1/sales-orders |
Creates new or updates existing non-contract managed sales order. This API performs full update for an existing sales order so ensure that all parameters and IDs are correctly supplied when using this api for update. |
POST v1/sales-orders/{id}/mark-complete |
Marks a sales order complete. Also provides the ability to notify the order contact about the sales order status change and generate an invoice for the remaining items that have not been invoiced yet. |
GET v1/sales-orders/{id}/notes?PageIndex={PageIndex}&PageSize={PageSize} |
Gets list of notes for the sales order specified by sales order id |
GET v1/sales-orders/{id}/attachments |
Gets list of attachments for the sales order specified by sales order id |
GET v1/sales-orders/{id}/attachments/{attachmentId} |
Downloads a sales order's attachment specified by attachment id and sales order id |
POST v1/sales-orders/{id}/attachments |
Uploads attachment to a specified sales order |
GET v1/sales-orders/{id}/custom-fields |
Gets list of custom fields for the specified id |
POST v1/sales-orders/{id}/custom-fields |
Saves the custom fields for the specified id |
GET v1/sales-orders/formats |
Get list of all available active sales order formats |
GET v1/sales-orders/{id}/format/{formatId} |
Downloads a sales order's format specified by format id and sales order id |
SalesOrderTypes
API | Description |
---|---|
GET v1/sales-order-types?excludeContractManagedTypes={excludeContractManagedTypes} |
Gets list of all available sales order types |
ShippingMethods
Gets a list of shipping methods available in the system
API | Description |
---|---|
GET v1/shipping-methods |
No documentation available. |
Tasks
APIs to search, create and update tasks.
API | Description |
---|---|
POST v2/tasks/search |
Searches for tasks using the search filters passed in request body |
GET v2/tasks/{id} |
Gets task detail by id |
POST v2/tasks |
Creates a new task |
GET v2/tasks/{id}/assignments |
Gets task assignments by task id |
DELETE v2/tasks/{id}/assignments |
Deletes a task assignment |
POST v2/tasks/{id}/assignments |
Adds an assignment to task |
GET v2/tasks/types?active={active} |
Gets task types based on active parameter |
GET v2/tasks/priorities?active={active} |
Gets task priorities based on active parameter |
POST v2/tasks/{id}/mark-open |
Marks task status open |
POST v2/tasks/{id}/mark-on-hold |
Marks task status on hold |
POST v2/tasks/{id}/mark-canceled |
Marks task status canceled |
POST v2/tasks/{id}/mark-done |
Marks task status done |
GET v2/tasks/{id}/attachments |
Gets all attachments for a task |
GET v2/tasks/{id}/attachments/{attachmentId} |
Downloads an attachment for a task by attachment id |
POST v2/tasks/{id}/attachments |
Uploads an attachment to the task |
PATCH v2/tasks/{id} |
Updates tasks partially with supplied information. You may only provide the properties that needs updating instead of whole object in the body. For example, in order to update Title, just supply Title in the request body. |
GET v2/tasks/{id}/customer-assets |
Gets all customer assets for a task |
GET v2/tasks/{id}/contacts |
Gets all task contacts |
POST v2/tasks/{id}/contacts |
Adds a contact to task |
DELETE v2/tasks/{id}/contacts |
Deletes a contact for a task |
POST v2/tasks/{id}/customer-assets |
Adds customer asset for a task |
DELETE v2/tasks/{id}/customer-assets |
Deletes a customer asset to the task |
GET v2/tasks/types/{id}/custom-fields |
Gets the custom field definitions for the task type id |
GET v2/tasks/types/{id}/mark-done-custom-fields |
Gets the mark done custom field definitions for the task type id |
GET v2/tasks/{id}/custom-fields |
Gets the custom fields for a task. For custom list fields, if there is no selection, the custom field is not returned in the response. |
GET v2/tasks/{id}/mark-done-custom-fields |
Gets the mark done custom fields for a task |
POST v2/tasks/{id}/custom-fields |
Saves the custom fields for the specified id |
GET v2/tasks/{id}/checklist-items |
Gets all checklist items for a task |
POST v2/tasks/{id}/checklist-items/{checkListItemId} |
Checks off checklist item and adds notes to a task |
Tasks
APIs for searching Tasks, creating tasks, getting task details, notes, attachments by TaskID. Also available are API's to upload and download attachment for a given task.
API | Description |
---|---|
POST v1/Tasks/Search Deprecated |
Searches for tasks using the search filters passed in request body. This endpoint is deprecated. Please use v2 version of endpoint v2/tasks/search |
GET v1/Tasks/{TaskID} Deprecated |
Gets Task detail by TaskID. This endpoint is deprecated. Please use v2/tasks/{id} instead. |
GET v1/Tasks/{TaskID}/Notes?PageIndex={PageIndex}&PageSize={PageSize} |
Gets all notes for a task |
GET v1/Tasks/{TaskID}/Attachments Deprecated |
Gets all attachments for a task. This endpoint is deprecated. Please use v2/tasks/{id}/attachments instead |
GET v1/Tasks/{id}/Attachments/{attachmentId} Deprecated |
Downloads a task's attachment specified by AttachmentID and TaskID. This endpoint is deprecated. Please use v2/tasks/{id}/attachments/{attachmentId} instead |
POST v1/Tasks/{TaskID}/Attachments Deprecated |
Uploads attachment to a specified Task. This endpoint is deprecated. Please use v2/tasks/{id}/attachments instead |
GET v1/Tasks/types Deprecated |
Gets all task types. This endpoint is deprecated. Please use v2 version of endpoint v2/tasks/types instead |
GET v1/Tasks/priorities Deprecated |
Gets all task priorities. This endpoint is deprecated. Please use v2/tasks/priorities instead |
POST v1/Tasks/create Deprecated |
Create a new task. This endpoint is deprecated. Please use v2/tasks instead. |
GET v1/Tasks/{id}/custom-fields Deprecated |
Gets list of custom fields for the task specified by task id. This endpoint is deprecated. Please use v2/tasks instead. |
POST v1/Tasks/{id}/custom-fields Deprecated |
Saves the custom fields for the specified id. This endpoint is deprecated. Please use v2/tasks instead. |
GET v1/Tasks/types/{id}/custom-fields Deprecated |
Gets the custom field definitions for the task type id. This endpoint is deprecated. Please use v2/tasks instead. |
VendorLocations
APIs to search vendor locations
API | Description |
---|---|
POST v1/vendor-locations/search |
Gets list of available vendor locations using the search filters passed in the request body |
Vendors
APIs to search, create and update vendors
API | Description |
---|---|
GET v1/vendors/{id} |
Gets vendor details by id |
POST v1/vendors/search |
Gets list of available vendors using the search filters passed in the request body |
POST v1/vendors |
Allows vendor creation and full update |
GET v1/vendors/{id}/contacts |
Gets list of contacts associated with the vendor specified by vendor id |
GET v1/vendors/{id}/cost-list |
Gets list of cost list items associated with the vendor specified by vendor id |
GET v1/vendors/{id}/cost-list/items/{itemId} |
Gets cost list item associated with the specified vendor and item id |
GET v1/vendors/{id}/locations |
Gets list of locations for the vendor specified by vendor id |
GET v1/vendors/{id}/custom-fields |
Gets list of custom fields for the vendor specified by vendor id |
POST v1/vendors/{id}/custom-fields |
Saves the custom fields for the specified id |
GET v1/vendors/{id}/hub/content-groups |
Gets the hub content groups for a particular vendor |
POST v1/vendors/{id}/hub/content-groups/{groupId}/documents |
Uploads a document to the vendor's hub. NOTE: If you want to upload documents to a group by its name, then specify the group name in the header with this key: Content-Group-Name If the group does not exist, then a new group with this name will be created. In this case you don't have to pass groupId as URI parameter. Specify the Overwrite-Existing-Files header (true|false) to overwrite the existing file(s) |
POST v1/vendors/{id}/hub/documents?groupId={groupId} |
Uploads a document to the vendor's hub. NOTE: If you want to upload documents to a group by its name, then specify the group name in the header with this key: Content-Group-Name If the group does not exist, then a new group with this name will be created. In this case you don't have to pass groupId as URI parameter. Specify the Overwrite-Existing-Files header (true|false) to overwrite the existing file(s) |