SaaSFlow
DevelopersAPIReferencefiles

Update file

Update a file record: rename it, correct the parsed amount, date, or document type, or change which transactions it is attached to.

Authentication

Checking whether you're signed in…
PUT
/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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/companies/string/files/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}

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…

Batch delete

Delete many files at once. selection takes either mode: "ids" with an explicit list, or mode: "filter" with the same filter the list endpoint takes plus…