API Docs / Operations / Returns / Get Return

Get Return

GET /tenants/{tenant}/returns/{year}/{month}

Returns the monthly return for the tax month ending in the given year and month, with its totals, status and, after a rejected submission, HMRC's errors in plain language. submissionBlockedReason says why billing blocks submissions (the 402 a submit would get), or is null. For an organisation of a SodiumHQ-managed practice, whose filing credits pay for its returns, creditsRequired is what a submit would use now (one per subcontractor beyond those already paid for this month; one for a nil return) and creditBalance is the practice's balance.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

month* path integer (int32)
year* path integer (int32)

Responses

401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
404 Not Found
application/problem+json