Vendor APIs

Get /api/v3/vendor/{vendorId}

Operation: GetVendorV3 Permissions: VendorsAndRatesModule (View)

Retrieves one vendor

---

Put /api/v3/vendor/{vendorId}

Operation: EditVendorV3 Permissions: Vendors (Edit)

Edits a vendor

---

Delete /api/v3/vendor/{vendorId}

Operation: DeleteVendorV3 Permissions: Vendors (Delete)

Deletes a vendor

---

Get /api/v3/vendor

Operation: GetVendorsV3 Permissions: VendorsAndRatesModule (View) Paginated

Retrieves an array of vendors. The array of vendors can be filtered by a number of criteria. See the filter property for more details

---

Post /api/v3/vendor

Operation: CreateVendorV3 Permissions: Vendors (Create)

Creates a vendor

---

Put /api/v3/vendor/{vendorId}/udf

Operation: EditVendorUDFsV3 Permissions: Vendors (Edit)

Edits user defined field / custom field values for a particular vendor

---

Get /api/v3/vendor/{vendorId}/udf

Operation: GetVendorUdfsV3 Permissions: VendorsAndRatesModule (View)

Retrieves all user defined fields / custom fields for a particular vendor

---

Get /api/v3/vendor/udf

Operation: GetVendorsUdfsV3 Permissions: VendorsAndRatesModule (View) Paginated

Retrieves all user defined fields / custom fields for all vendors

---

Get /api/v3/vendor/{vendorId}/contract

Operation: GetVendorContractsV3 Permissions: VendorsAndRatesModule (View)

Retrieves all Contracts for a particular vendor.

Contracts are not supported in EnergyCAP Version 7, this API is for reading existing contracts only and may be removed in the future.

---

Put /api/v3/vendor/{vendorId}/account

Operation: AddAccountsV3 Permissions: MoveAccountsBetweenVendors (Manage)

Add accounts to a vendor

---

Get /api/v202206/vendor/{vendorId}/template

Operation: GetVendorTemplateV202206 Permissions: VendorsAndRatesModule (View)

Retrieves the most recent template from the specified vendor

---

Put /api/v202206/vendor/{vendorId}/template

Operation: PutVendorTemplateV202206 Permissions: Vendors (Edit)

Updates the template for the specified vendor

---

Post /api/v202206/vendor/{sourceVendorId}/template/copy

Operation: CopyVendorTemplateV202206 Permissions: Vendors (Edit)

Copies any template attached to the provided sourceVendorId to each of the recipientVendorIds specified in the body.
If the recipient vendor has a template defined, it will be replaced with the lines on the source vendor’s template.
If the recipient vendor does not have a template defined, a new template will be created with the lines on the source vendor’s template.

---

Get /api/v202105/vendor/{vendorId}/udf/{udfId}/download

Operation: DownloadVendorCustomFieldFileV202105 Permissions: VendorsAndRatesModule (View)

Download file for a vendor custom field

---

Put /api/v202104/vendor/{vendorId}/auditEnabled

Operation: SetVendorAccountsAuditExclusionV202104 Permissions: FlaggedItems (Manage)

Enable or disable all accounts assigned to a vendor from audits

---