iVendNextDevelopers Request a sandbox

Auto Email Report

A report sent by email on a schedule.

Area: The retailer's setup · Why it is here: · Fields: 20

Read and write it

Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.

Read a list (only name unless you ask for fields):

curl -s "https://⟨site⟩/api/resource/Auto%20Email%20Report?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one:

curl -s "https://⟨site⟩/api/resource/Auto%20Email%20Report/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Create one (the required fields first), if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/Auto%20Email%20Report" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"report": …, "user": …, "email_to": …, "frequency": …, "format": …}'

Change one with PUT /api/resource/Auto%20Email%20Report/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.

Samples that use it

s40_expiry_recall

Fields

Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.

Field Field name Type Required Read-only Hidden Links to
Report report Link yes Report
Based on Permissions For User user Link yes User
Enabled enabled Check
Report Type report_type Read Only yes
Reference Report reference_report Data yes yes
Send only if there is any data send_if_data Check
Only Send Records Updated in Last X Hours data_modified_till Int
No of Rows (Max 500) no_of_rows Int
Filters filters Text yes
Filter Meta filter_meta Text yes yes
From Date Field from_date_field Select
To Date Field to_date_field Select
Period dynamic_date_period Select one of: Daily, Weekly, Monthly, Quarterly, Half Yearly, Yearly
Use First Day of Period use_first_day_of_period Check
Email To email_to Small Text yes
Day of Week day_of_week Select one of: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
Sender sender Link Email Account
Frequency frequency Select yes one of: Daily, Weekdays, Weekly, Monthly
Format format Select yes one of: HTML, XLSX, CSV
Message description Text Editor

All record types · What you can use

This record type in the kit