AcceptReturn

This operation transfers the agency's decision, to accept or return the application, from their IT system to the online state DA digital service.

path Parameters
CaseID
required
string

A fully qualified application number.

header Parameters
OrganisationID
required
string

Used by the API gateway to identify the agency from which the request was initiated.

IdempotencyID
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json
lodgementOutcome
required
string

This is to track the agency's acceptance or rejection of an application. 1.Application was lodged 2.Application was returned

returnDate
string <date>

This is to track the date the application was returned to the applicant. Mandatory if lodgementOutcome is'Application was returned'.

returnReason
string

This is to track the reason the agency returned the application. Mandatory if lodgementOutcome is 'Application was returned'.

Array of objects (DownloadableDocument)
updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal.

Responses

Request samples

Content type
application/json
{
  • "lodgementOutcome": "Refer to description for values.",
  • "returnDate": "2019-08-24",
  • "returnReason": "string",
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}
Next to FeeCalculation