The Document object
You can create extensive range of documents in DocuMocu.com, ranging from proposals to contracts, and more. These documents are readily shareable with recipients, who can seamlessly approve them by signing electronically.
Attributes
activity
nullable associative array
Activity log of the document.
allow_download
boolean
Whether the recipients are allowed to download a PDF copy of the document.
allow_forwarding
boolean
Whether the recipients are allowed to forward the document.
archived_at
nullable string
Time at which the document was archived.
author
string
The ID of the the document author user.
completed_at
nullable string
Time at which the document was completed.
cover_page
nullable string
The URL of the document cover page image.
created_at
string
Time at which the document was created.
currency
string
Three-letter ISO currency code.
declined_at
nullable string
Time at which the document was declined.
deleted_at
nullable string
Time at which the document was moved to trash.
expiration_date
nullable string
Time at which the document will expire.
expiration_date_in_days
nullable integer
Days in which the document is going to expire after it has been sent.
expiration_warning
boolean
Whether the recipients will receive notification before the document expires.
expired_at
nullable string
Time at which the document has expired.
id
string
Unique identifier for the document.
modifier
string
The ID of the the document modifier user.
name
string
The name of the document.
page_orientation
enum
The orientation of the document pages. One of
portrait, landscape.page_size
enum
The size of the document pages. One of
letter, a4, slide.recipient_language
string
Display language of the document in Java Locale format.
recipients
nullable associative array
Recipients of the document.
recurring_reminder_frequency
nullable integer
Positive integer describing the recurring frequency.
recurring_reminder_period_unit
nullable enum
The unit in which the recurring frequency is measured. One of
day, week, month, year.reminder_days
nullable integer
Integer describing how many days before the document expiration a reminder will be sent to all recipients.
sent_at
nullable string
Time at which the document was sent.
sent_via
nullable enum
How the document has been sent. One of
mail, link.status
enum
The status of the document. One of
draft, sent, viewed, completed, expired, paid, declined.type
enum
The type of the document. One of
regular, template.updated_at
string
Time at which the document was last updated.
value
integer
The total value of the document in cents.
updated_at
nullable string
Time at which the document was viewed.
The Document object
{
"activity": null,
"allow_download": false,
"allow_forwarding": true,
"archived_at": null,
"author": "u_zxlr80cwmrshq0uk0bk7nnik",
"completed_at": null,
"cover_page": null,
"created_at": "2024-05-14T05:36:50+00:00",
"currency": "USD",
"declined_at": null,
"deleted_at": null,
"expiration_date": null,
"expiration_date_in_days": null,
"expiration_warning": false,
"expired_at": null,
"id": "doc_96kjrc28vp1xdjestep1fu25",
"modifier": "u_by5010epw5yhbrnb73hgxbjc",
"name": "Veniam rerum earum debitis et quia et.",
"page_orientation": "portrait",
"page_size": "a4",
"recipient_language": "en_US",
"recipients": null,
"recurring_reminder_frequency": null,
"recurring_reminder_period_unit": null,
"reminder_days": null,
"sent_at": null,
"sent_via": null,
"status": "draft",
"type": "regular",
"updated_at": "2024-05-14T05:36:50+00:00",
"value": 0,
"viewed_at": null
}