August 29th, 2018

Delete Document & Delete Template calls added to API

PandaDoc API allows Delete Document and Delete Template.

API returns following HTTP statuses:

"204 No Content" on successful deletion
"403 Forbidden" if a document is deleted.

JSON response example if a document is already deleted:

{
    "type": "permissions_error",
    "detail": "You do not have permission to perform this action."
}

August 29th, 2018

Template information added to Document List call

Using PandaDoc API (List Documents endpoint) you can list documents, created from a specific template.

Request example:
https://api.pandadoc.com/public/v1/documents?template_id=111222333

Response example:

{
    "results": [
        {
            "id": "XQZvGbfYoCCXSLAEdWPQ6C",
            "name": "Integration test",
            "status": "document.completed",
            "date_created": "2018-08-28T19:28:01.539904Z",
            "date_modified": "2018-08-28T19:28:42.923935Z",
            "expiration_date": "2018-10-27T19:28:28.813375Z"
        }
    ]
}

August 8th, 2018

Template information added to Document Details

Document details endpoint and Webhooks now return information about the template that was used for document creation. If a document was created from PDF, it will return null instead of template information.

API example:

{
    "id": "g2wE9fJikvJTPaeyYDe82J",
    ...
    "template": null,
    "expiration_date": "2028-06-16T09:27:01.219415Z",
    "metadata": {},
    "tokens": [],
    ...
}

Webhook example:

[
  {
    "event": "document_state_changed",
    "data": {
      "id": "YcNQSR7kV5CHXivEKpEPY3",
      ...
      },
      ...
      "template": {
        "id": "rpsdeCfuLVNGhA2YJkU4PK",
        "name": "Integration test"
      }
    }
  }
]

August 8th, 2018

Document Expiration date added to Document Details

Document details endpoint and Webhooks now return document's expiration date.

API example:

{
    "id": "g2wE9fJikvJTPaeyYDe82J",
    ...
    "expiration_date": "2028-06-16T09:27:01.219415Z",
    "metadata": {},
    "tokens": [],
    ...
}

Webhook example:

[
  {
    "event": "document_state_changed",
    "data": {
      "id": "g2wE9fJikvJTPaeyYDe82J",
      "name": "Integration test",
      "date_created": "2018-08-08T11:39:56.871553Z",
      "date_modified": "2018-08-08T11:39:57.180209Z",
      "expiration_date": "2028-06-16T09:27:01.219415Z",
      ...
    }
  }
]

July 18th, 2018

Clarifying error for too big files

PandaDoc API allows creating documents from PDF.
There is 50 MB limit on file attachment size.

Now API returns a specific error in case of bigger files - HTTP status "413 Request entity too large".

JSON response example:

{
  "type": "request_error",
  "detail": "Attached file is too big. Maximum file size is 50 MB"
}

June 18th, 2018

Adding document's Grand Total

Document details endpoint and Webhooks now return information about document's Grand Total.

API example:

{
    ...
    "id": "WHT7fGF2QeWSTZEsg6un75",
    "grand_total": {
        "amount": "29.99",
        "currency": "USD"
    },
    ...
}

Webhook example:

{
    "data": {
        ...
        "id": "WHT7fGF2QeWSTZEsg6un75",
        "grand_total": {
        "amount": "29.99",
        "currency": "USD"
        },
        ...
    },
    "event": "document_state_changed"
}

June 18th, 2018

Adding document's expiration date

PandaDoc API and Webhooks now return information about document's expiration date.

Please, take a note that the expiration date may be null as this property only makes sense for documents in Sent, Viewed, Waiting for Payment, and Paid statuses.

List of endpoints that return expiration date:

Create document. The expiration date will always be null here as there is no expiration date for documents in Uploaded and Draft.
Document status.
Document details.
Send document.

API example:

{
    "id": "dvEnR6iJ8pVSEssbQoEshT",
    "name": "API Sample Document from PandaDoc Template",
    "status": "document.waiting_approval",
    "date_created": "2018-06-18T12:07:17.721482Z",
    "date_modified": "2018-06-18T12:07:46.108405Z",
    "expiration_date": null,
    "uuid": "dvEnR6iJ8pVSEssbQoEshT"
}

Webhook example:

{
    "data": {
        ...
        "date_created": "2018-06-18T12:06:54.389089Z",
        "date_modified": "2018-06-18T12:31:24.920614Z",
        "expiration_date": "2018-08-17T12:31:24.833779Z",
        ...
    },
    "event": "document_state_changed"
}

May 2nd, 2018

Introducing API limitations

Our API Reference documentation now contains the list of (limitations):

Request size is limited to 2.5 MB.
The number of API requests per minute may be limited by PandaDoc.
Webhook subscription may be deactivated if a significant number of consequent requests to endpoint URL ends up with HTTP 4xx and 5xx responses.

May 2nd, 2018

Session ID aka Document Link updates

PandaDoc API allows to create (Session ID for sharing your documents).

Our latest release added a couple of updates there:

Manager, Admin, and Owner can create Session ID and check status for documents of other users (according to (team account roles)).
Allow generating Session ID for Completed, Waited for pay, and Paid documents.

April 17th, 2018

Adding information about optional line items to API and Webhooks

PandaDoc API (Document Details endpoint) and Webhooks now returns information about optional line items.

Both optional and exclusive items (Multiple Choice Selection) are supported. You can find additional info about them here: https://support.pandadoc.com/hc/en-us/articles/360049576814-Pricing-table-2-0-Optional-items-and-editable-quantity.

"items": [
    {
        "id": "QpjVZugmvZGtDtJuCchLsc",
        "sku": "001",
        "qty": 1,
        "name": "Painting",
        "cost": "450",
        "price": "500",
        "description": "A painting",
        "custom_fields": {
            "custom": "custom text"
        },
        "custom_columns": {},
        "subtotal": "500",
        "options": {
            "optional": true,
            "optional_selected": true,
            "multichoice_enabled": false
        }
    },
    {
        "id": "Bgf9UuwPZ9gSojgaGUh6rE",
        "sku": "002",
        "qty": 3,
        "name": "Basket",
        "cost": "85",
        "price": "100",
        "description": "A basket",
        "custom_fields": {},
        "custom_columns": {},
        "subtotal": "300",
        "options": {
            "optional": true,
            "optional_selected": false,
            "multichoice_enabled": false
        }
    }
]

"items": [
    {
        "id": "QpjVZugmvZGtDtJuCchLsc",
        "sku": "001",
        "qty": 1,
        "name": "Painting",
        "cost": "450",
        "price": "500",
        "description": "A painting",
        "custom_fields": {
            "custom": "custom text"
        },
        "custom_columns": {},
        "subtotal": "500",
        "options": {
            "optional": false,
            "multichoice_enabled": true,
            "multichoice_selected": true
        }
    },
    {
        "id": "Bgf9UuwPZ9gSojgaGUh6rE",
        "sku": "002",
        "qty": 3,
        "name": "Basket",
        "cost": "85",
        "price": "100",
        "description": "A basket",
        "custom_fields": {},
        "custom_columns": {},
        "subtotal": "300",
        "options": {
            "optional": false,
            "multichoice_enabled": true,
            "multichoice_selected": false
        }
    }
]