This operation transfers the payment done by applicant on CNR application from ePlanning's IT system to Agency's IT System.
CaseID required | string A fully qualified Concurrence and Referral case Number |
OrganisationID required | string The council LGA name to indicate where the request is originated from. |
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" |
Information request object
caseStatus | string <= 80 characters Status of the payment case |
paymentStatus | string It infers the current status of payment |
caseRef | string <= 32 characters It infers the CNR case number corresponding to which payment case is created |
existingDANumber | string <= 50 characters It infers the DA number to which the Payment is being requested |
paymentReferenceNumber | string Payment reference number |
totalAmount | number <decimal> Amount of payment done by applicant |
paymentDueDate | string <date> It infers the date by which the payment has to be made by applicant |
paymentTransDate | string <date> Date of Payment |
Array of objects (agencyInfo) | |
Array of objects (DownloadableDocument) | |
object (UpdatedBy) |
{- "caseStatus": "Paid",
- "paymentStatus": "Approved",
- "caseRef": "CNR-XXXX",
- "existingDANumber": "string",
- "paymentReferenceNumber": "string",
- "totalAmount": 0,
- "paymentDueDate": "2021-03-18T00:00:00.000Z",
- "paymentTransDate": "2021-03-18T00:00:00.000Z",
- "agencies": [
- {
- "agencyName": "string",
- "agencyCaseID": "A-XXXX or CL-XXX (CL-XXX Applicable only for 'Biodiversity' Clause)",
- "agencyCaseStatus": "string",
- "agencyAmount": 0
}
], - "documents": [
- {
- "documentName": "test.docx",
- "documentType": "string",
- "uploadedDateTime": "2019-08-24T14:15:22Z",
- "documentURL": "string",
- "documentSize": 0,
- "isSensitiveDoc": true,
- "updatedBy": "Council"
}
], - "updatedBy": {
- "person": {
- "firstName": "John",
- "familyName": "Smith",
- "email": "john.smith@gmail.com",
- "contactNumber": "stringst"
}
}
}
{- "statusCode": 404,
- "message": "Internal Server error 19876",
- "activityId": "00000011-0ab-xy00-0000-500000000000",
- "errorCode": "DPE_TMS01",
- "errorDetails": "Inner Exceptions, Stack Trace, etc"
}