Get an intake

Allowed Scopes: experimental:intake:read

Returns a single intake by id: everything List intakes returns for it, plus the received files in documents — the invoice, credit note or receipt itself, and any companion file that arrived with it. This is the only endpoint that returns documents.

Each downloadUrl is pre-signed and expires at most 3 hours after the response was issued. Intake data is cached for up to 3300 seconds, so a link you receive may already be part-way through those 3 hours. Download promptly, and fetch the intake again for a fresh link rather than storing one.

A deleted intake is not a 404: it is still returned, with status deleted, and its documents can still be downloaded. A 404 means this company has no intake with that id. A 403 means either the token is not for companyId, or the Spendesk user the API key was created by is not a Controller, Administrator or Account Owner of that company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Company ID.

string
required

Intake ID.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json