Getting Started

Welcome

OurTradie provides solutions for online tradesmen and property managers. It doesn't really matter what type of work or service you are selling or buying on the Internet: from building to electrical work and even dog grooming services. This program will help both tradies and their customers feel empowered and choose the best options to suit their business purposes. We help tradies, property managers, tenants and landlords work through maintenance tasks more efficiently together.

Overview

OurTradie job states

• Offer: When the job has been offered by the customer.
• Quote: When the job is waiting for the tradie to quote.
• Accept: When the job is accepted by the tradie.
• Investigate: When the job is accepted but not dates are set.
• Quoted: When the tradie has quoted the job.
• Approved: When the job has been approved by the customer.
• Active: When the job is in the Active job list for the tradie..
• Future:: Like Active but at a date in the future.
• Completed:: When the job has been invoiced by the tradie.
• Finalised: When the submitted invoice is approved by the Property Manager (Customer).
• Payment: When the job has been paid by the customer.
• Reconciled: When the payment has been detected by the tradie and the tradie has marked it as Reconciled..
• Rejected: When the job has been rejected by the customer. Same as Disputed.
• Cancelled: When the job is cancelled.
• Serviced: When the service job has been completed.

Webhook Reference

Getting Access

• To gain access to webhooks, simply sign in to the Tradie portal and input your webhook URLs on Settings > Webhooks

• You must provide valid url in Notify URL field, webhook notifications will be sent to Notify url as post json data.
• Currently, we support two types of webhook listening:
• Job Status Change Alert
• Favourite Tradie Change Alert

Job Status Change

• Whenever a job associated with your tradie account undergoes a status update, the webhook will be triggered, providing the following information payload:

{
	"JobID": {job_id},
	"NewJob": 0, // IF new job it will be 1 otherwise 0
	"Status": "{job_status}",
	"UserID": {user_id}
}
		

Favourite Tradie Change

• Whenever your status as a favorite tradie is altered by an agency, the webhook will be triggered, offering the following information payload:

{
	"ID": {user_id}, // Who added/removed from Favourite.
	"Email": {user_email},
	"Group": "{user_type}"
}
		

API Reference

Getting Access

• To access PM API, complete your user account either as tradiemanager / soletradie.
• After you have created your account, sign in to Tradie site generate your api access via Settings > API Access

• You must provide valid url in Redirect URL field, api responses will be sent to redirect url.
• Press Generate New Key button to get your client id & client secret key.

Request an authorization code

• We are using OAuth 2.0 for api authorization process.

• GET	/api/authorize

• Request Params

  Parameter	Description	Required
  response_type	The value of this field should always be:  code	Yes
  client_id	The "Client Id" value generated in ourtradie.	Yes
  authorize	An integer value should be pass.	Yes
  redirect_uri	The URI your responses will be sent back to after authorization.  This value must match with redirect url you specified on api access.	Yes
  state	A unique string value of your choice that is hard to guess. Used to prevent CSRF.  e.g. state=DCEeFWf45A53sdfKef424	Yes

• Sample Request Url:
• https://{API_URL}/api/authorize?response_type=code&authorize=1&state=xxxxx&client_id=yyyyyyyy&redirect_uri=zzzz
• While calling above url, you asked to login with your office manager account on api. Then you will see api authorization page.
• 
• Press Authorize button, you will get following authorization code response on your redirect url.

• Response data

  Parameter	Description
  code	Authorization code from OAuth 2.0 endpoint.
  state	The unique string value you passed on request.

Getting access token

• Pass authorization code to Token method to get api access token.

• GET	/api/token

• Request Params

  Parameter	Description	Required
  code	Use the code got from authorize method.	Yes
  client_id	The "Client Id" value generated in ourtradie.	Yes
  client_secret	The "Client Secret" value generated in ourtradie.	Yes
  grant_type	While using authorization code to get token, value should always be:  authorization_code	Yes

• Response data

  Parameter	Description
  access_token	Accesstoken generated from OAuth 2.0 endpoint.
  expires_in	Token expiration time in seconds.
  token_type	Type of OAuth generated token.
  refresh_token	Accesstoken generated from OAuth 2.0 endpoint. Once access token expired, Use this to get new access token.

Using refresh token to get access token

• Pass refresh token instead of authorization code to Token method to obtain api access token.

• GET	/api/token

• Request Params

  Parameter	Description	Required
  refresh_token	Use the refresh_token previously got.	Yes
  client_id	The "Client Id" value generated in ourtradie.	Yes
  client_secret	The "Client Secret" value generated in ourtradie.	Yes
  grant_type	While using refresh token to get token, value should always be:  refresh_token	Yes

• Response data

  Parameter	Description
  access_token	Accesstoken generated from OAuth 2.0 endpoint.
  expires_in	Token expiration time in minutes.
  token_type	Type of OAuth generated token.
  refresh_token	Accesstoken generated from OAuth 2.0 endpoint. Once access token expired, Use this to get new access token.

Get Agencies

• GET	/api/GetAgencies

Purpose:


Retrieving Agencies using api.

• Request Params

  Parameter	Description	Required
  Skip	No. of Records to be skipped	No
  Count	No.of Records to be retrieved	No

• Response data

  Parameter	Description
  AgencyID	Agency Id
  AgencyName	Agent's Company Name

  Failed Response

  Parameter	Description
  error	If api call failed, will get error message.
  error_description	Failed response description will obtain this field.

Get All Residential Properties

• GET	/api/GetAllResidentialProperties

Purpose:


Retrieving properties using api.

• Request Params

  Parameter	Description	Required
  Address1	Search by Street name	No
  Suburb	Search by Suburb.	No
  State	Search by State.	No
  Postcode	Search by Postcode.	No
  AgencyID	Search by AgencyID.	No
  Skip	No. of Records to be skipped	No
  Count	No.of Records to be retrieved	No

• Response data

  Parameter	Description
  ID	Property Id
  Address1	Street Name
  Address2	Address2
  Suburb	Property Suburb
  State	State
  Postcode	Postcode
  KeyNumber	Property KeyNumber
  LeaseStart	Lease Start Date
  LeaseEnd	Lease End Date
  Agency_Contacts	Agency Contact Details
  Owner_Contacts	Owner Contact Details
  Tenant_Contacts	Tenant Contact Details
  SmokeTradie	Smoke Tradi Contact Details

  Failed Response

  Parameter	Description
  error	If api call failed, will get error message.
  error_description	Failed response description will obtain this field.

Tradie Job Retrieve

• POST	/api/TradieJobRetrieve

Purpose:


Retrieving a job using api.

• Request Params

  Parameter	Description	Required
  ID	Job Id	Yes
  Status	Status of the jobs.	No
  Since	Retrieve the jobs which is start > Since	No
  Skip	No. of Records to be skipped	No
  Count	No.of Records to be retrieved	No

• Response data

  Parameter	Description
  ID	Job Id
  Title	Job Title
  Type	General Type
  JobType	Job Type
  Description	Job Description
  StartDate	Start date of a job
  EndDate	End date of a job
  Status	Job status
  Notes	Job notes
  Documents	Documents of a Job
  Media	Media
  Trade	Trade
  Property	Property Details
  ApprovedStart	ApprovedStart
  Creditor	Creditor Details
  InvoiceDescription	Invoice Description
  InvoiceNumber	Invoice Number
  JobNumber	Job Number
  Related	Related
  Contract	Job Agreement

  Failed Response

  Parameter	Description
  error	If api call failed, will get error message.
  error_description	Failed response description will obtain this field.

Tradie Create New Job

• POST	/api/TradieCreateNewJob

Purpose:


Creating a new job using api. Here you need to send Property Owner contact details & property informations to create a new job.

• Request Params

  Parameter	Description	Required
  FirstName	Owner firstname.	Yes
  LastName	Owner lastname.	Yes
  Salutation	Owner salutation.	Yes
  EmailAddress	Owner mail id.	Yes
  PhoneNo	Owner phone no.
  Mobile	Owner mobile no.	Yes
  Street	Property street address.	Yes
  City	Property suburb	Yes
  State	Property State in short code. (ACT / NSW / NT / QLD / SA / TAS / VIC / WA)	Yes
  Postcode	Property postcode	Yes
  ServiceRequired	Job trade type. Send type from this list.	Yes
  JobName	Job name	Yes
  Comments	Job description/comments	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	New job created successfully.

  Failed Response

  Parameter	Description
  error	If api call failed, will get error message.
  error_description	Failed response description will obtain this field.

Tradie Job Accept

• POST	/api/TradieJobAccept

Purpose:


Accept offer state job.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Job Moved to Accept State Successfully.

  Failed Response

  Parameter	Description
  error	If api call failed, will get error message.
  error_description	Failed response description will obtain this field.

Note:


Once the job is moved to the OurTradie Accept state, the related job will move either Active or Future State depending upon the job start date.

• Future state - Scheduled with future dates.
• Active state - Scheduled with current dates.

The Tradie can Schedule or complete the Inspection or Reject the job.

Tradie Job Reject

• POST	/api/TradieJobReject

Purpose:

Reject the job.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  RejectReason	Reason for Rejection.	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Job Moved to Reject State Successfully.

Note:


Once the job is moved to the Reject state the tradie cannot access that job.

Tradie Job Schedule

• POST	/api/TradieJobSchedule

Purpose:

Schedule the Offer/Accept state jobs. The status of the job will be changed based on dates (Active/Future).

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  StartDate	dd-mm-yyyy hh:mm:ss	Yes
  EndDate	dd-mm-yyyy hh:mm:ss	Yes
  EntryNotice	If it is 1, then send email to tenant	Optional

• Response data

  Parameter	Description
  Success	Ok
  data	Job Moved to Active/Future State Successfully.

Note:


Depending on the date selected, the job will be either moved to the Active or Future state.

Tradie Job Startnow

• POST	/api/TradieJobStartnow

Purpose:

Start a job in the Future state with the current date.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Job Moved to Active State Successfully.

Note:


Can start the job and job moved to active state, In Future page, can start the job as current date.

Tradie Job Reschedule

• POST	/api/TradieJobReschedule

Purpose:

Reschedule the Active or Future state job dates based on tradie circumstances. The status of the job will be changed based on dates.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  ApprovedStart	Approved Start date for the job	Yes
  ApprovedEnd	Approved End date for the job	Yes
  RescheduleReason	Reason for Reschedule	Yes
  EntryNotice	If it is 1, then send email to tenant	Optional

• Response data

  Parameter	Description
  Success	Ok
  data	Jobs are rescheduled successfully.

Note:


Reschedule the dates, depending on that the job will be moved either Active or future state.

Tradie Job Submit Invoice

• POST	/api/TradieJobSubmitInvoice

Purpose:

Submit the invoice for Accepted Offer, Investigate state, Active and Future state jobs.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  InspectionDate	Inspection date for the job	Yes
  ApprovedStart	Approved Start date for the job	Optional(only for contract job)
  ApprovedEnd	Approved End date for the job	Optional(only for contract job)
  InvoiceDescription	Invoice Description	Optional
  Documents	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Media	Supported file formats gif,jpeg,png,jpg,zip
  Items	Workitems for the job
  JobNumber	Job number
  InvoiceNumber	Invoice number
  Related	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Contract	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip

• Response data

  Parameter	Description
  Success	Ok
  data	Job Moved to Complete State Successfully.

Note:


Once furnish all details, Submit the job invoice to customer. Propertymanager receives the Invoice details via email.

Tradie Job Cancel

• POST	/api/TradieJobCancel

Purpose:

Cancel the Job.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  CancelReason	Cancel Reason.

• Response data

  Parameter	Description
  Success	Ok
  data	Job Cancelled Successfully.

Note:


Tradie can cancel the job on Active and Future states.

Tradie Job Retract Cancel

• POST	/api/TradieJobRetractCancel

Purpose:

Retract the cancelled Job.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Retract the Cancelled Job Successfully.

Note:


Tradie can retract their cancelled jobs and come back to old status.

Tradie Job Reject Cancel

• POST	/api/TradieJobRejectCancel

Purpose:

Propertymanager rejects the Tradie cancelled Job.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  CancelReason	Job Id

• Response data

  Parameter	Description
  Success	Ok
  data	Job Moved to Active/Future State Successfully.

Note:


Propertymanager cancelled the Tradie jobs or the tradie allows to reject cancel request for the particular jobs and comeback to old status.

Tradie Job Complete Existing Contract

• POST	/api/TradieJobCompleteExistingContract

Purpose:

Complete the already existing contract Job in Active / Future State.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  ApprovedStart	Approved Start date for the job(dd-mm-yyyy hh:mm:ss)	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Contract job Moved to Reconciled state Successfully.

Note:


Depending upon the contract date,

• Job start & end - start > current – Prepaid status.
• Job start & end - end > current - Current status.
• Job start & end - end < current – Super seeded status.

Tradie Job Mark As Paid

• POST	/api/TradieJobMarkAsPaid

Purpose:

Complete the already existing Job in the Active / Future State. Mark the approved invoice which is in Finalised state as Paid.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Job Moved to Reconciled state Successfully.

Note:


Paid status will be done by Finalised state jobs.

Tradie Job Resubmit Invoice

• POST	/api/TradieJobResubmitInvoice

Purpose:

Resubmit the invoice in Complete state with new inputs. Again Property Manager will approve the invoice which is submitted by the tradie. The approved invoice will be moved to the Finalised state.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  InspectionDate	Inspection date for the job	Yes
  ApprovedStart	Approved Start date for the job	Optional(only for contract job)
  ApprovedEnd	Approved End date for the job	Optional(only for contract job)
  InvoiceDescription	Invoice Description	Optional
  Documents	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Media	Supported file formats gif,jpeg,png,jpg,zip
  Items	Workitems for the job
  JobNumber	Job number
  Related	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Contract	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip

• Response data

  Parameter	Description
  Success	Ok
  data	Job Invoice Resubmitted Successfully.

Note:


Resubmit the Invoice, The status of the job will not be changed on resubmit. That means the job stays in the Complete state.

Tradie Job Confirm Payment

• POST	/api/TradieJobConfirmPayment

Purpose:

Tradie confirm the payment after Propertymanager approves Invoice.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Invoice Moved to Reconciled state Successfully.

Note:


Mark the approved invoice in Finalised state as Paid.

Tradie Job Complete Inspection

• POST	/api/TradieJobCompleteInspection

Purpose:

Complete the inspection job in the Accept/Active/Future status.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  InspectionDate	Inspection date for the job	Yes
  Documents	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip

• Response data

  Parameter	Description
  Success	Ok
  data	Invoice Moved to Reconciled state Successfully.

Note:


Only the state of Accepted/Active/Future, can complete the Inspection job and moved to Reconciled status.

Tradie Job Add Appointments

• POST	/api/TradieJobAddAppointments

Purpose:

Appointment added on Accept offer/Investigate/Quote/Active/Future States.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  AppointmentComment	Appointment comment
  AppointmentTime	Appointment time for the job(dd-mm-yyyy hh:mm:ss)	Yes
  InvitePM	1- PM attending,0- not attending	Optional

• Response data

  Parameter	Description
  Success	Ok
  data	Job Moved to Active/Future State Successfully.

Note:


Appointment added only before Invoice submission of the job, After Invoice submit, you can't added appointment for the job.

Tradie Job Complete Smoke Payment

• POST	/api/TradieJobCompleteSmokepayment

Purpose:

Tradie completes the Smoke payment jobs.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  ContractStartDate	Contract Start date for the jobb(dd-mm-yyyy hh:mm:ss)	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Contract job Moved to Reconciled state Successfully.

Note:


Complete the smoke alarm contract Job in Active / Future States.

Tradie Job Save

• POST	/api/TradieJobSave

Purpose:

Save the job with new inputs for our reference.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  InspectionDate	Inspection date for the job	Yes
  Notes	Notes added for the job
  InvoiceDescription	Invoice Description	Optional
  Documents	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Media	Supported file formats gif,jpeg,png,jpg,zip	Yes
  Items	Workitems for the job
  JobNumber	Job number
  Related	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Contract	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip

• Response data

  Parameter	Description
  Success	Ok
  data	Job Saved Successfully.

Note:


Job save done on Accepted /Quote/Active/Future states. The status of the job will not be changed.

Tradie Job Future Save

• POST	/api/TradieJobFutureSave

Purpose:

Save the job in Future state with new inputs.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  InspectionDate	Inspection date for the job	Yes
  Notes	Notes added for the job
  InvoiceDescription	Invoice Description	Optional
  Documents	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Media	Supported file formats gif,jpeg,png,jpg,zip	Yes
  Items	Workitems for the job
  JobNumber	Job number
  Related	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Contract	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip

• Response data

  Parameter	Description
  Success	Ok
  data	Future Job Saved Successfully.

Note:


Once Save, The status of the job will not be changed.

Tradie Job Active Save

• POST	/api/TradieJobActiveSave

Purpose:

Save the job in Active state with new inputs.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  InspectionDate	Inspection date for the job	Yes
  Notes	Notes added for the job
  InvoiceDescription	Invoice Description	Optional
  Documents	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Media	Supported file formats gif,jpeg,png,jpg,zip	Yes
  Items	Workitems for the job
  JobNumber	Job number
  Related	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Contract	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip

• Response data

  Parameter	Description
  Success	Ok
  data	Active Job Saved Successfully.

Note:


Once Save, The status of the job will not be changed.

Tradie Offer to Quote

• POST	/api/TradieOffertoQuote

Purpose:

Tradie converts the offer jobs to Quote jobs.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  InvoiceDescription	Invoice Description	Optional
  Documents	Supported file formats pdf,xls,odt,doc,docx,jpeg,png,gif,jpg,ppt,bmp,txt,xlsx,zip
  Media	Supported file formats gif,jpeg,png,jpg,zip
  Items	Workitems for the job
  JobNumber	Job number
  Related	Zip folder with name Related.zip
  Contract	Zip folder with name Related.zip
  InvoiceNumber	Invoice number

• Response data

  Parameter	Description
  Success	Ok
  data	Offer changed to Quote successfully.

Note:


The Jobs in Accept , Investigate, Future, Active states only can be convert to quote. After Convert to quote the job will be moved to QuoteSent. Cannot able to convert contract job to quote.

Tradie Quote Submit

• POST	/api/TradieQuoteSubmit

Purpose:

Tradie submits the Quote job.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  EstimatedStart	dd-mm-yyyy hh:mm:ss	Optional
  EstimateEnd	dd-mm-yyyy hh:mm:ss	Optional
  QuoteDescription	QuoteDescription	Optional
  QuoteDocuments	Zip folder with name Documents.zip
  QuoteMedia	Zip folder with name Media.zip
  QuoteItems	Workitems for the quote
  Notes	Notes for quotes
  QuoteRelated	Zip folder with name Related.zip
  QuoteContract	Zip folder with name Contract.zip

• Response data

  Parameter	Description
  Success	Ok
  data	Quote Submitted Successfully.

Note:


Only submits the quote in Quote state ie) PM Requested job. If the job is moved to Reject state the tradie cannot access that job.

Tradie Quote ReSubmit

• POST	/api/TradieQuoteReSubmit

Purpose:

Tradie resubmits the Quote job.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  EstimatedStart	dd-mm-yyyy hh:mm:ss	Optional
  EstimateEnd	dd-mm-yyyy hh:mm:ss	Optional
  QuoteDescription	QuoteDescription	Optional
  QuoteDocuments	Zip folder with name Documents.zip
  QuoteMedia	Zip folder with name Media.zip
  QuoteItems	Workitems for the quote
  Notes	Notes for quotes
  QuoteRelated	Zip folder with name Related.zip
  QuoteContract	Zip folder with name Contract.zip

• Response data

  Parameter	Description
  Success	Ok
  data	Quote ReSubmitted Successfully.

Note:


Tradie can only resubmit the job before propertymanager approve the quote.

Tradie Quote Assign

• POST	/api/TradieQuoteAssign

Purpose:

The Tradie manager can only assign the job to his employees.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  QuoteAssign	EmailId of the assigned user	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Quote Assigned Successfully.

Note:


After assigned the job will be moved to Quote Assigned State. After assigned the employee can quote the amount and send it to Tradiemanager. Tradimanager submit the quote to propertymanager for approval.

Tradie Quote ReAssign

• POST	/api/TradieQuoteReassign

Purpose:

The Tradie manager can reassign the quote to another employee.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  QuoteAssign	EmailId of the assigned user	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Quote ReAssigned Successfully.

Note:


ReAssign done only on Assigned jobs. The jobs available on Reassigned Tab.

Tradie Quote Reject

• POST	/api/TradieQuoteReject

Purpose:

Tradie rejects the quote in Quote Status.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  QuoteRejectReason	Reason of the Quote Reject	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Quote Rejected Successfully.

Note:


Tradie employee reject the quote, tradiemanager receive the email. If reject the quote, can't access anymore.

Tradie Quote Confirm

• POST	/api/tradieQuoteConfirm

Purpose:

Tradie confirms the job either active or future state depending on the dates confirm.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  ApprovedStart	(dd-mm-yyyy hh:mm:ss)	Yes
  ApprovedStart	(dd-mm-yyyy hh:mm:ss)	Yes
  Entrynotice	If it is 1, then send email to tenant	Optional

• Response data

  Parameter	Description
  Success	Ok
  data	Quote Moved to Active / Future state Successfully.

Note:


Once Property manager approve the quote as current date, it comes to Tradie confirm state, The tradie can change the job dates and then continue, based on the dates the job will be moved to Active / Future State.

Tradie Quote Cancel

• POST	/api/TradieQuoteCancel

Purpose:

Tradie can cancel the quote.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  QuoteCancelReason	QuoteCancelReason	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Quote Cancelled Reason Successfully.

Note:


Tradie cancel the quote changed as Cancelled status.

Tradie Quote Retract Cancel

• POST	/api/TradieQuoteRetractCancel

Purpose:

Tradie retracts their cancelled quote.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Quote Moved to TradieConfirm State Successfully.

Note:


Retract the cancelled quote by Tradie cancel jobs.

Tradie Quote Reject Cancel

• POST	/api/TradieQuoteRejectCancel

Purpose:

Tradie rejects the propertymanager cancelled job.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  RejectCancelReason	Reason of the quote cancel rejection	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Quote Moved to TradieConfirm State Successfully.

Note:


If propertymanager cancels the Tradie jobs, the Tradie rejects the job and submit the job to Propertymanager.

Tradie Quote Accept Cancel

• POST	/api/TradieQuoteAcceptCancel

Purpose:

Tradie accepts the Quote cancel jobs.

• Request Params

  Parameter	Description	Required
  Id	Job Id	Yes
  AcceptCancelReason	Reason of the accept cancel rejection	Yes

• Response data

  Parameter	Description
  Success	Ok
  data	Quote Cancelled Successfully.

  Note:
  

  Accepts the job on Cancelled Quote status.

Tradie Property Compliance Submit

• POST	/api/TradiePropertyComplianceSubmit

Purpose:

This method is used to submit property compliance date & certificate. Can submit multiple type of compliances at one request.

• Request Params

  Parameter	Description	Required
  PropertyId	Property Id	Yes
  Compliance	Array format of data contains all kind of compliance JobID & Date	Yes
  Documents	Array format of files list	Yes

Request Sample:

POST data
{
	'PropertyID' => AAAAAA,
	'Compliance[Smoke][JobID]' => XXXXXX,
	'Compliance[Smoke][Date]' => '2025-03-28 08:30:00',
	'Compliance[Gas][JobID]' => YYYYYY,
	'Compliance[Gas][Date]' => '2025-04-25 08:30:00',
	'Compliance[Electric][JobID]' => ZZZZZZZ,
	'Compliance[Electric][Date]' => '2025-04-25 08:30:00',
}

Files 
{
	'Documents' => {
		'Smoke' => [
		            fileObject (pdf),
		            fileObject (pdf),
		          ],
		'Gas' => fileObject (pdf),
		'Electric' => fileObject (pdf)
	}
}
			

• Response data

  Parameter	Description
  Success	Ok
  data	Complicance submitted Successfully.

  Note:
  

  Have to bring & valid respective compliance JobIDs. Job will be processed & certificate pushed to OP document manager. This method support single / multiple file upload for each types.

Client side API access library file

• As we created client side api access library in PHP with CURL. You can refer & user this to make api requests. Client api file was hosted in git repository. You can access it from this link.
• API URL: http://tradie.ourtradie.com.au/api/

Job Trade List

• List of available trades

  Type	Description
  air_conditioning	Airconditioning
  asbestos_removal	Asbestos removal
  brake_clutch_services	Auto Brake & Clutch mechanic
  auto_electrical_services	Auto Electrician
  bathroom_renovations	Bathroom renovations
  blinds_and_shades	Blinds & Shades
  bookkeeping	Bookkeeping
  bricklayers	Building Bricklayer
  carpenters	Building Carpenters
  carports	Building Carports patios & pergolas
  decking_construction	Building Decking & construction
  building_general	Building General
  home_renovation_services	Building renovations
  wardrobes_installation	Building Wardrobes
  car_truck_cleaning	Car wash
  furniture_cleaning	Cleaning Carpet & Furniture
  cleaning_services	Cleaning Domestic
  concrete	Concreting
  couriers	Couriers
  excavating_contractors	Earth moving
  electrical_appliances_services	Electrical Appliances
  burglar_alarm_systems	Electrical Burglar Alarms
  solar_energy_equipment	Electrical Solar
  service_parts_repairs	Electrical Washers & dryers
  electrician	Electricians
  fencing_contractors	Fencing
  general_coverings	Floor Coverings
  floor_polishing_recoating_services	Floor Polishing
  furniture_storage	Furniture Storage & Removals
  gardening_services	Gardener
  glaziers	Glass
  graphic_design	Graphic design
  home_repairs	Handyman
  insulation_supply	Insulation
  interior_designer	Interior Decorator
  kitchens_renovations	Kitchens renovations
  locksmith_services	Locksmith
  shutters_installation	Louvres & Shutters
  garden_maintenance	Mowing
  decorating_services	Painters
  pest_control	Pest controller
  pets_grooming	Pet care
  plasterers	Plasterer
  drainage_services	Plumbing Drainage
  plumbers	Plumbing General
  roof_maintenance	Plumbing Roof Repairs
  swimmingpool_maintenance	Pool Maintenance
  refrigeration	Refrigeration
  roller_doors_shutters	Garage Doors Shutters & Grilles
  tilers	Tiler
  gutters	Gutter cleaning
  tree_lopper	Tree lopper
  fire_protection	Fire Protection
  safety_inspector	Safety inspector
  fridge_seal_repairers	Fridge seal repairers
  antenna_installer	Antenna installer
  plumbing_gas	Plumbing Gas
  plumbing_hw_systems	Plumbing H/W Systems
  engineers	Engineers
  smoke_alarm_tester	Smoke alarms
  photographer	Photographer
  pool_compliance	Pool Compliance
  cleaning_mould	Cleaning Mould
  water_filters	Water Filters
  valuer	Valuer
  reticulation	Reticulation
  security_screens	Security Screens
  inspections_building	Inspections Building
  inspections_pest	Inspections Pest
  fencing_temporary	Fencing Temporary
  surveyor	Surveyor
  building_pest_inspections	Building & pest Inspections
  house_washing	House washing/pressure cleaning
  prime_contractor	Private Contractor