POST /api/charitycommission/charities/annual_returns
Price: 10 credits
Accounts and annual returns a charity has filed with the register of England and Wales: what was filed, the reporting year it covers, when it arrived, whether it arrived on time, and a link to the filed document where one is published.
Each reporting year normally produces two results, the annual return and the accounts, and only the accounts carry a `document_url` — an empty one means the register publishes no file for that row, not that the filing is missing. `received_status` is the register's own punctuality verdict, so use it rather than comparing `received_date` against `reporting_year_end` yourself.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)charity_number string required — Registered charity number as it appears on the register, including the suffix of a linked sub-charity (examples: "1089464", "1089464-1"; minLength: 1)@type string (default: "CharitycommissionAnnualReturn")charity_number string requireddocument_title string requiredreporting_year_end string nullablereceived_date string nullablereceived_status string nullabledocument_url string nullable422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.412 — No charity is registered under that number Retrying will not help: either the entity does not exist, or the input points at a different one.429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.X-Retry-After — Seconds to wait before retrying. Present only on 429.