Skip to content

Document

Resource representing a document linked to a job in your workspace.

The Document resource represents a file that's been shared between a user and a Taxfyle Pro. Documents can be added throughout the lifetime of a job as long as the job hasn't been Closed or Canceled. When a document is added to a job, ownership of it gets assigned to the job member of type CLIENT and role CLIENT, which is the person for whom the work is being done.

The Document APIs allow you to upload documents to a job, retrieve documents in a job, and download individual documents.

Endpoints

MethodUrl
GET/v1.0/documents/{document_id}
POST/v1.0/documents
GET/v1.0/documents/{document_id}/download

Document Properties

id
The document's ID.
title
The document's title.
description

The document's description is typically shown around the Worklayer UI. Usually, it contains a description of the type of document linked to the job.

create_time

When the document was created. A timestamp in format 2021-04-28T13:45:25.781Z.

update_time

When the document was updated. A timestamp in format 2021-04-28T13:45:25.781Z.

document_type

Information about the type of document that was uploaded. If no document type was specified when creating the document, this field will return null. You can query for the list of supported Document Types.

Copied
1{
2 "id": "499d692d-67aa-4127-a45c-b9e27f54afad",
3 "title": "Document's title",
4 "description": "Document's description",
5 "create_time": "2021-04-28T13:45:25.781Z",
6 "update_time": "2021-04-28T13:52:27.379Z",
7 "document_type": {
8 "id": "DRAFT_RETURN",
9 "name": "Draft return"
10 }
11}
Last updated on October 18, 2022