Contract file

To keep all contract-related documents together, you can upload and download files to contracts using any Attachment endpoint. Thus, each contract can contain several files: the contract itself (always), the contract verification file (if all participants have already signed the contract), and other attachments (optional).

📘

Note:

You can download these files either as one document using the contract file type or as separate files using the corresponding file type id.

Contract file attributes

Attribute

Type

Description

_links

object

Contains links to endpoints associated with the parent object. See Links.

extension

string(enum)

Indicates the attached file extension (see Attachments). See also, Contract file extensions.

id

integer(signed_integer_id)

The ID of the contract file.

name

string

If the file name contains only non-US-ASCII characters, the default filename will be generated as type_id.extension. For example, a file named *-+%&.png will be changed to attachment_123.png, where 123 is the value of the id attribute.

type

string(enum)

The type of the contract file. See Contract file types.

Contract file extensions

Currently, The following file extensions are allowed: ASICE, BMP, CSV, DOC, DOCX, DOTX, GIF, JPEG, JPG, KEY, NUMBERS, ODS, PAGES, PDF, PNG, PPSX, PPT, PPTX, RTF, TIF, TIFF, TXT, XLS, XLSB, XLSM, XLSX, XML.

Contract file types

The following table shows the file types allowed for contracts:

File type

Description

contract

The actual contract file that can be download in PDF format.
The contract file id is always 1, and the file extension is always pdf.

verification

The contract verification information file is available only after the contract is signed.
The verification file id is always 2, and the file extension is always pdf.

pdf

The file uploaded to the contract as the extended_pdf file type (see the Create a contract with a PDF) is automatically saved in the contract as the pdf type.
The pdf file id is generated automatically when you save the file; the file extension is always pdf.

attachment

The file uploaded to the contract as an attachment.
The attachment file id is generated automatically when you save the file; the file extension can be of any type listed in the Contract file extensions.


Did this page help you?