Field Name Data Type Comment id String Unique identifier name String Display name of the folder
Field Name Data Type Comment id String Unique identifier folder_reference FolderReference Folder the file belongs to metadata Object Metadata is provided by the client at the time of submitting the file. It can be helpful to store related information such as lookup identifiers for data models in the client application. Scale does not modify or use the metadata. documents Array< Document> Logical documents in the file created_at String RFC 3339 date time
Field Name Data Type Comment id String Unique identifier type String Extracted document type version Integer Schema version of the extracted data specific to the document type structured_data Union See the Structured Data table for mapping the
version to the corresponding schema.
The information extracted from the document. It varies based on the
version of the document.
Type Version Schema accounts_payable_invoice 1 AccountsPayableInvoiceV1 bill_of_lading 1 BillOfLadingV1 air_waybill 1 AirWaybillV1 commercial_invoice 1 CommercialInvoiceV1
Example: If the
structured_data field in the file object will contain
Field Name Data Type Comment address_lines Array<String> Text lines of the address