SaaSFlow
DevelopersAPIReferencefiles

Retrieve file

Retrieve one file's metadata: filename, size, what it is attached to, and the parsed amount and date. This returns the record, not the document.

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/files/{fileId}

Authorization

Authorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

In: header

Path Parameters

companyId*string
Length1 <= length
fileId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/files/string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "transactionIds": [    "string"  ],  "filename": "string",  "fileExtension": "string",  "size": -2147483648,  "storagePath": "string",  "parseStatus": "open",  "parseData": {    "amount": {      "value": 0,      "currency": "string"    },    "date": "string",    "type": "invoice"  },  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

List files

List uploaded files, newest first, paginated. Files are the receipts and invoices attached to transactions as proof for the books.

Delete file

Delete a file and its stored document. The transactions it was attached to are untouched, but they lose their supporting receipt, which matters if the…