Schema

Data types for API resources

FolderReference

Field NameData TypeComment
idStringUnique identifier
nameStringDisplay name of the folder

File

Field NameData TypeComment
idStringUnique identifier
folder_referenceFolderReferenceFolder the file belongs to
metadataObjectMetadata 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.
documentsArray<Document>Logical documents in the file
created_atStringRFC 3339 date time

Document

Field NameData TypeComment
idStringUnique identifier
typeStringExtracted document type
versionIntegerSchema version of the extracted data specific to the document type
structured_dataUnionSee the Structured Data table for mapping the type and version to the corresponding schema.

Structured Data

The information extracted from the document. It varies based on the type and version of the document.

TypeVersionSchema
accounts_payable_invoice1AccountsPayableInvoiceV1
bill_of_lading1BillOfLadingV1
air_waybill1AirWaybillV1
commercial_invoice1CommercialInvoiceV1

Example: If the type is accounts_payable_invoice and version is 1 the structured_data field in the file object will contain AccountsPayableInvoiceV1 object.

PostalAddressV1

Field NameData TypeComment
address_linesArray<String>Text lines of the address