List available returns

Get a list of available returns for the authenticated EDUMIS ID.

This endpoint is scoped to the authenticated EDUMIS ID.

Query Parameters
page int32 Pagination page number
pageSize int32 Pagination page size
includeIndicative boolean When true Indicative returns will be included

Header Parameters
EID string — REQUIRED Enter the EDUMIS (Organisation) ID

Responses
200 Submission details including a submission token and a token expiry Schema — OPTIONAL page int32 — OPTIONAL pageSize int32 — OPTIONAL results object[] — OPTIONAL edumis int32 — OPTIONAL The provider code (EDUMIS) that the return is associated to. returnId int32 — OPTIONAL The unique identifier of the return. returnYear int32 — OPTIONAL The year that the return is inteded for returnMonth int32 — OPTIONAL The month that the return is inteded for openWindowDate date-time — OPTIONAL The return opening window closeWindowDate date-time — OPTIONAL The return closing window returnStatus string — OPTIONAL Possible values: [Accumulate, RollBack, Cancelled, FailedToTransfer, Halted, InProgress, Processed, Queued, Rejected, Submitted, UnknownError, SubmitError] The status of the current submission for this return. returnType string — OPTIONAL Possible values: [Indicative, Full] The type of the current submission for this return. closeDate date-time — OPTIONAL The date that the return was closed if appropriate. totalCount int32 — OPTIONAL
400 Bad Pagination parameters - check error code for more detail Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL errors object — OPTIONAL returnId string — OPTIONAL submissionToken string — OPTIONAL content object — OPTIONAL errorCode string — OPTIONAL
401 Authorization failed Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL
429 Rate Limiting may apply. Refer to Retry-After header Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL