Skip to main content
​
business_id
string<biz_string>
required

The id of the Business

Example:

"biz_R2fAXCjqJPdpYata112zyW"

​
name
string
required

The original file name

Maximum string length: 255
Example:

"receipt.pdf"

​
description
string
required

The description of the Document

Maximum string length: 255
Example:

"Receipt"

​
document_type
enum<string>
required

The type of the Document.

Available options:
receipt,
statement,
other,
payroll,
bill
Examples:

"receipt"

"statement"

"other"

​
file_size
integer
required

The size of the file in kilobytes

Example:

1024

​
status
enum<string>
required

The status of the Document

Available options:
file_too_large,
file_type_not_supported,
failed_account_matching,
failed_period_matching,
failed_s3_upload,
parsing_failed,
processing,
processed,
partially_processed,
unprocessed
Examples:

"processing"

"failed_account_matching"

"failed_period_matching"

"parsing_failed"

"processed"

"unprocessed"

​
external_account_id
string<uuid> | null
required
​
transaction_id
string<uuid> | null
required
​
id
string<doc_string>
required

The id of the Document

Example:

"doc_R2fAXCjqJPdpYata112zyW"

​
created_at
string<date-time>
required

The datetime the Document was created in UTC ISO-8601 format

​
task_id
string<tsk_string> | null

The id of the Task

Example:

"tsk_R2fAXCjqJPdpYata112zyW"

​
external_id
string | null

External identifier for deduplication (e.g., provider payroll ID)

Maximum string length: 255
Example:

"gusto-payroll-abc123"

​
metadata_
Metadata · object
​
journal_entry_ids
string<je_string>[] | null

The ids of the Journal Entries associated with the document

Example:

"je_R2fAXCjqJPdpYata112zyW"

​
external_account_ids
string<eac_string>[] | null

The ids of the External Accounts associated with the document

Example:

"eac_R2fAXCjqJPdpYata112zyW"

​
transaction_ids
string<txn_string>[] | null

The ids of the Transactions associated with the document

Example:

"txn_R2fAXCjqJPdpYata112zyW"

​
bill_id
string<bil_string> | null

The id of the Bill associated with the document

Example:

"bil_R2fAXCjqJPdpYata112zyW"