VendorEmailConfigurations

Get the list of Vendor Email Configurations

Path

GET /odata/VendorEmailConfigurations

Description

Returns a paged list list of Vendor Email Configurations within the logged-in organization.

Note

You can filter the results as follows:

For an exact match, use: $filter parameter–entity eq ‘string’
For a partial match, use: $filter=contains parameter–contains(entity, ‘string’)

Request parameters

Parameter	Explanation
includeInactiveVendors boolean default: false in query	Include inactive Vendors.
includeInactiveFacilities boolean default: false in query	Include inactive Facilities.
api-version: string default: 1.0 in header	The requested API version.
$filter: string in query	Restricts the set of items returned. The maximum number of expressions is 100.
$orderby: string in query	Specifies the order in which items are returned. The maximum number of expressions is 5.
$search: string in query	Picks the value in all possible fields.
$top: string in query	Returns only the first n results.
$skip: string in query	Skips the first n results.
Authorization: string default: Bearer access_token in header	Specify the type of the token (bearer) and then insert the `access_token`, which was obtained during authentication.

Responses

Response	Explanation
200 OK	OK
400 Bad Request	Incorrect input data or organization ID does not match with the organization ID user is logged in.
400 Bad Request	The limit for the `$top` query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here.
401 Unauthorized	Incorrect specified `access_token` or `access_token` got expired.
403 Forbidden	User doesn’t have appropriate privileges.
500 Internal Server Error	Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property	Explanation
vendorEmailId: string (uuid)	Unique Identifier of the Vendor Email
emailDescription: string	Description of the Vendor Email
vendorId: string (uuid)	Unique Identifier of the Vendor
vendorNo: string	Code of the Supplier who sells products
vendorName: string	Name of the Vendor
facilityId: string (uuid)	Unique Identifier of the Facility
facilityNo: string	Identification Number of the Facility
facilityName: string	Name of the Facility
emailName: string	Name of the Vendor Email
emailAddress: string	Address of the Vendor Email
emailCC: string	Carbon Copy of the Vendor Email
emailBCC: string	Blind Carbon Copy of the Vendor Email
emailBody: string	Body of the Vendor Email
replyToTypeId: string	Reply To Type Identifier
replyToType: string	Type of the Reply To
replyToAddress: string	Address of the Reply To
requestReadReceipt: boolean	Request a read Receipt
activeStatus: boolean	Is the Status of the Vendor Email active or not?
dateAdded: string (date-time)	Date when the Vendor Email was added
addedBy: string (uuid)	Unique Identifier of the user who added the Vendor Email
addedByName: string	Name of the user who added the Vendor Email
lastUpdated: string (date-time)	Last Date when the Vendor Email was updated
lastUpdatedBy: string (uuid)	Unique Identifier of the last user who updated the Vendor Email
lastUpdatedByName: string	Name of the last user who updated the Vendor Email
confirmOrders: boolean	Orders Confirmation Email
doNotIncludeContactInfo: boolean	Do Not Include Contact Info

Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)

{
    "@odata.context": "link",
    "@odata.count": "number",
    "value": [
        {
            "vendorEmailId": "00000000-0000-0000-0000-000000000000",
            "emailDescription": "string",
            "vendorId": "00000000-0000-0000-0000-000000000000",
            "vendorNo": "string",
            "vendorName": "string",
            "facilityId": "00000000-0000-0000-0000-000000000000",
            "facilityNo": "string",
            "facilityName": "string",
            "emailName": "string",
            "emailAddress": "string",
            "emailCC": "string",
            "emailBCC": "string",
            "emailBody": "string",
            "replyToTypeId": "string",
            "replyToType": "string",
            "replyToAddress": "string",
            "requestReadReceipt": "boolean",
            "activeStatus": "boolean",
            "dateAdded": "string (date-time)",
            "addedBy": "00000000-0000-0000-0000-000000000000",
            "addeddByName": "string",
            "lastUpdated": "string (date-time)",
            "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
            "lastUpdatedByName": "string",
            "confirmOrders": "boolean",
            "doNotIncludeContactInfo": "boolean"
        }
    ],
    "@odata.nextLink": "link"
}

Get the specified Vendor Email Configuration