SaaSFlow
DevelopersAPIReferencefiles

List files

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

Authentication

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

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

Query Parameters

unassignedOnly?string

Value in

  • "true"
  • "false"
limit?|
Range0 <= value <= 500
Default100
offset?|
Range0 <= value
Default0

Response Body

application/json

curl -X GET "https://example.com/companies/string/files"
{  "items": [    {      "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"    }  ],  "totalCount": 0}

Unread

Mark one notification as unread again, putting it back in the bell menu. Returns 404 if the notification does not exist or the caller cannot read it.

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.