The Email Digest object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

enabled boolean

Default: false

company string required
frequency string required
next_send string
income boolean

Default: false

expenses_booked boolean

Default: false

income_year_to_date boolean

Default: false

expense_year_to_date boolean

Default: false

bank_balance boolean

Default: false

credit_balance boolean

Default: false

invoiced_amount boolean

Default: false

payables boolean

Default: false

sales_orders_to_bill boolean

Default: false

purchase_orders_to_bill boolean

Default: false

sales_order boolean

Default: false

purchase_order boolean

Default: false

sales_orders_to_deliver boolean

Default: false

purchase_orders_to_receive boolean

Default: false

sales_invoice boolean

Default: false

purchase_invoice boolean

Default: false

new_quotations boolean

Default: false

pending_quotations boolean

Default: false

issue boolean

Default: false

project boolean

Default: false

purchase_orders_items_overdue boolean

Default: false

calendar_events boolean

Default: false

todo_list boolean

Default: false

notifications boolean

Default: false

add_quote boolean

Default: false

The Email Digest object 
{
  "id": "email-digest_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "enabled": false,
  "company": "Example Corp",
  "frequency": "frequency_example",
  "next_send": "next_send_example",
  "income": false,
  "expenses_booked": false,
  "income_year_to_date": false,
  "expense_year_to_date": false,
  "bank_balance": false,
  "credit_balance": false,
  "invoiced_amount": false,
  "payables": false,
  "sales_orders_to_bill": false,
  "purchase_orders_to_bill": false,
  "sales_order": false,
  "purchase_order": false,
  "sales_orders_to_deliver": false,
  "purchase_orders_to_receive": false,
  "sales_invoice": false,
  "purchase_invoice": false,
  "new_quotations": false,
  "pending_quotations": false,
  "issue": false,
  "project": false,
  "purchase_orders_items_overdue": false,
  "calendar_events": false,
  "todo_list": false,
  "notifications": false,
  "add_quote": false
}
GET /api/setup/email-digest/{id}

Retrieve a email digest

Retrieves the details of an existing email digest. Supply the unique email digest ID that was returned from a previous request.

Path parameters

id string required

The identifier of the email digest to retrieve.

Returns

Returns the email digest object if a valid identifier was provided.

GET /api/setup/email-digest/{id} 
curl https://api.overplane.dev/api/setup/email-digest/email-digest_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "email-digest_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "enabled": false,
  "company": "Example Corp",
  "frequency": "frequency_example",
  "next_send": "next_send_example",
  "income": false,
  "expenses_booked": false,
  "income_year_to_date": false,
  "expense_year_to_date": false,
  "bank_balance": false,
  "credit_balance": false,
  "invoiced_amount": false,
  "payables": false,
  "sales_orders_to_bill": false,
  "purchase_orders_to_bill": false,
  "sales_order": false,
  "purchase_order": false,
  "sales_orders_to_deliver": false,
  "purchase_orders_to_receive": false,
  "sales_invoice": false,
  "purchase_invoice": false,
  "new_quotations": false,
  "pending_quotations": false,
  "issue": false,
  "project": false,
  "purchase_orders_items_overdue": false,
  "calendar_events": false,
  "todo_list": false,
  "notifications": false,
  "add_quote": false
}
GET /api/setup/email-digest

List all email digests

Returns a list of email digests. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of email digest objects.

GET /api/setup/email-digest 
curl https://api.overplane.dev/api/setup/email-digest \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "email-digest_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "enabled": false,
      "company": "Example Corp",
      "frequency": "frequency_example",
      "next_send": "next_send_example",
      "income": false,
      "expenses_booked": false,
      "income_year_to_date": false,
      "expense_year_to_date": false,
      "bank_balance": false,
      "credit_balance": false,
      "invoiced_amount": false,
      "payables": false,
      "sales_orders_to_bill": false,
      "purchase_orders_to_bill": false,
      "sales_order": false,
      "purchase_order": false,
      "sales_orders_to_deliver": false,
      "purchase_orders_to_receive": false,
      "sales_invoice": false,
      "purchase_invoice": false,
      "new_quotations": false,
      "pending_quotations": false,
      "issue": false,
      "project": false,
      "purchase_orders_items_overdue": false,
      "calendar_events": false,
      "todo_list": false,
      "notifications": false,
      "add_quote": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/email-digest

Create a email digest

Creates a new email digest object.

Body parameters

enabled boolean

Default: false

company string required
frequency string required
next_send string
income boolean

Default: false

expenses_booked boolean

Default: false

income_year_to_date boolean

Default: false

expense_year_to_date boolean

Default: false

bank_balance boolean

Default: false

credit_balance boolean

Default: false

invoiced_amount boolean

Default: false

payables boolean

Default: false

sales_orders_to_bill boolean

Default: false

purchase_orders_to_bill boolean

Default: false

sales_order boolean

Default: false

purchase_order boolean

Default: false

sales_orders_to_deliver boolean

Default: false

purchase_orders_to_receive boolean

Default: false

sales_invoice boolean

Default: false

purchase_invoice boolean

Default: false

new_quotations boolean

Default: false

pending_quotations boolean

Default: false

issue boolean

Default: false

project boolean

Default: false

purchase_orders_items_overdue boolean

Default: false

calendar_events boolean

Default: false

todo_list boolean

Default: false

notifications boolean

Default: false

add_quote boolean

Default: false

Returns

Returns the newly created email digest object if the call succeeded.

POST /api/setup/email-digest 
curl https://api.overplane.dev/api/setup/email-digest \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","frequency":"frequency_example"}'
Response 
{
  "id": "email-digest_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "enabled": false,
  "company": "Example Corp",
  "frequency": "frequency_example",
  "next_send": "next_send_example",
  "income": false,
  "expenses_booked": false,
  "income_year_to_date": false,
  "expense_year_to_date": false,
  "bank_balance": false,
  "credit_balance": false,
  "invoiced_amount": false,
  "payables": false,
  "sales_orders_to_bill": false,
  "purchase_orders_to_bill": false,
  "sales_order": false,
  "purchase_order": false,
  "sales_orders_to_deliver": false,
  "purchase_orders_to_receive": false,
  "sales_invoice": false,
  "purchase_invoice": false,
  "new_quotations": false,
  "pending_quotations": false,
  "issue": false,
  "project": false,
  "purchase_orders_items_overdue": false,
  "calendar_events": false,
  "todo_list": false,
  "notifications": false,
  "add_quote": false
}
PATCH /api/setup/email-digest/{id}

Update a email digest

Updates the specified email digest by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the email digest to update.

Body parameters

enabled boolean

Default: false

company string
frequency string
next_send string
income boolean

Default: false

expenses_booked boolean

Default: false

income_year_to_date boolean

Default: false

expense_year_to_date boolean

Default: false

bank_balance boolean

Default: false

credit_balance boolean

Default: false

invoiced_amount boolean

Default: false

payables boolean

Default: false

sales_orders_to_bill boolean

Default: false

purchase_orders_to_bill boolean

Default: false

sales_order boolean

Default: false

purchase_order boolean

Default: false

sales_orders_to_deliver boolean

Default: false

purchase_orders_to_receive boolean

Default: false

sales_invoice boolean

Default: false

purchase_invoice boolean

Default: false

new_quotations boolean

Default: false

pending_quotations boolean

Default: false

issue boolean

Default: false

project boolean

Default: false

purchase_orders_items_overdue boolean

Default: false

calendar_events boolean

Default: false

todo_list boolean

Default: false

notifications boolean

Default: false

add_quote boolean

Default: false

Returns

Returns the updated email digest object.

PATCH /api/setup/email-digest/{id} 
curl https://api.overplane.dev/api/setup/email-digest/email-digest_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"enabled":false,"company":"Example Corp"}'
Response 
{
  "id": "email-digest_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "enabled": false,
  "company": "Example Corp",
  "frequency": "frequency_example",
  "next_send": "next_send_example",
  "income": false,
  "expenses_booked": false,
  "income_year_to_date": false,
  "expense_year_to_date": false,
  "bank_balance": false,
  "credit_balance": false,
  "invoiced_amount": false,
  "payables": false,
  "sales_orders_to_bill": false,
  "purchase_orders_to_bill": false,
  "sales_order": false,
  "purchase_order": false,
  "sales_orders_to_deliver": false,
  "purchase_orders_to_receive": false,
  "sales_invoice": false,
  "purchase_invoice": false,
  "new_quotations": false,
  "pending_quotations": false,
  "issue": false,
  "project": false,
  "purchase_orders_items_overdue": false,
  "calendar_events": false,
  "todo_list": false,
  "notifications": false,
  "add_quote": false
}
DELETE /api/setup/email-digest/{id}

Delete a email digest

Permanently deletes a email digest. This cannot be undone.

Path parameters

id string required

The identifier of the email digest to delete.

Returns

Returns a confirmation that the email digest has been deleted.

DELETE /api/setup/email-digest/{id} 
curl https://api.overplane.dev/api/setup/email-digest/email-digest_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "email-digest_abc123",
  "deleted": true
}

Line items

Child objects that belong to this email digest. These are accessed via the parent's ID.

Email Digest Recipient

Attributes

idx integer
email_digest_id string required
recipient string required

Endpoints

GET /api/setup/email-digest-recipient?parent_id={id}
POST /api/setup/email-digest-recipient
PATCH /api/setup/email-digest-recipient/{id}
DELETE /api/setup/email-digest-recipient/{id}
POST /api/setup/email-digest-recipient/reorder
Email Digest Recipient object 
{
  "id": "email-digest-recipient_abc123",
  "idx": 1,
  "email_digest_id": "[email protected]",
  "recipient": "recipient_example"
}