OurTradie Property Manager API

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

  • Import your properties: Export your property, tradie, landlord and tenant information from your property management software and import it into OurTradie using our API.
  • Create profile: Add your Property management group and your staff.
  • Create a job: Send a job to a tradie as a unquoted work offer or request quotes from your tradies. If you don’t have three tradies of the same type available, send the job out through the OurTradie network to access other qualified tradies. The first three tradies who respond get to quote.
  • Review & Selection: Review the response, approve a quote or pass on the selected quotes on to the landlord for approval
  • Import jobs to your software: Through our API can retrieve approved job invoices as XML data and import into your software.

API Reference

Getting Access

  • To access PM API, complete your user account as office manager.
  • After you have created your account, sign in to pm assistant site generate your api access via Settings > API Access
  • 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

    ParameterDescriptionRequired
    response_typeThe value of this field should always be:  codeYes
    client_idThe "Client Id" value generated in ourtradie.Yes
    authorizeAn 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.
  • API Authorization
  • Press Authorize button, you will get following authorization code response on your redirect url.
  • Response data

    ParameterDescription
    codeAuthorization code from OAuth 2.0 endpoint.
    stateThe 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

    ParameterDescriptionRequired
    codeUse the code got from authorize method.Yes
    client_idThe "Client Id" value generated in ourtradie.Yes
    client_secretThe "Client Secret" value generated in ourtradie.Yes
    grant_typeWhile using authorization code to get token, value should always be:  authorization_codeYes
  • Response data

    ParameterDescription
    access_tokenAccesstoken generated from OAuth 2.0 endpoint.
    expires_inToken expiration time in minutes.
    token_typeType of OAuth generated token.
    refresh_tokenAccesstoken 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

    ParameterDescriptionRequired
    refresh_tokenUse the refresh_token previously got.Yes
    client_idThe "Client Id" value generated in ourtradie.Yes
    client_secretThe "Client Secret" value generated in ourtradie.Yes
    grant_typeWhile using refresh token to get token, value should always be:  refresh_tokenYes
  • Response data

    ParameterDescription
    access_tokenAccesstoken generated from OAuth 2.0 endpoint.
    expires_inToken expiration time in minutes.
    token_typeType of OAuth generated token.
    refresh_tokenAccesstoken generated from OAuth 2.0 endpoint. Once access token expired, Use this to get new access token.

Import Agency Datas to OurTradie

  • Using this method you could import all your agency property managers, properties, tenants, landlords & creditors to ourtradie. On the first import you should pass all your properties & userdetails to ourtradie. After that send only modified properties or creditor informations.
    Click here to check format of Property Information tag
    Click here to check format of Creditor Information tag

  • Also you could send daily Property Statistics datas like rent, paid to, lease start, lease end, vacating date, rent arrear days, arrear amount. Using this details we will send arrear notifications to tenants.
    Click here to check format of Property Statistics tag

  • You could send Property Inspection data to ourtradie. Using ourtradie PM Inpsect mobile app, you can complete inspections perfectly.
    Click here to check format of Property Inspections tag

  • In this method you should pass datas as xml string or xml file. Please refer complete below details for XML format.
  • POST
    /api/SyncProperties
  • Access token should be included in request header with “Authorization: Bearer {access token}”

    Request Params

    ParameterDescriptionRequired
    XMLDataAgency datas passed as xml string.-
    XMLFileUpload xml file instead of xml string. -
    Note:

    Pass XMLData or XMLFile, don't send both param in single call we accept any one of data only. Sample code for api call is available here.

  • Response data

    Success Response
    ParameterDescription
    successOK
    dataXML data successfully added to background process.
    Failed Response
    ParameterDescription
    errorIf api call failed, will get error message.
    error_descriptionFailed response description will obtain this field.

Retrieve completed datas from ourtradie

  • Using this method, user can retrieve property maintenance jobs, completed inspections and arrear notifications sent to tenants/landlords on a day. Get all above infos as a xml string from this method.
  • Property Maintenance Jobs

  • Once the agency datas export process complete in ourtradie, property manager/landlords/tenant could create property maintenance job request to tradies in ourtradie. Tradie allocated to a job request by PM or job accepted by tradie, job was confirmed. Confirmed jobs informations are available inside "ConfirmedJob" tag.
  • After tradie complete the request, he could send invoice to PM. Invoice is approved by PM, job details sent with invoice details inside "WorkOrder" tag.
  • In this process, job request is allocated to a tradie not available in your agency, we will send those creditor details inside "Creditor" tag. Creditor details had a tag "Reference", this value is mapped to corresponding WorkOrder/ConfirmedJob details "CreditorRef" tag.
  • On invoice approved state PM can move the job back to complete status. We will send those job ids on "JobReverse" tag.
  • Completed Inspections

  • Inspections can be create in ourtradie or Imported through SyncProperties api call from trust system. Created inspections can be scheduled & completed by inspection managers using our website / mobile Inspection apps. Those completed inspections informations are available inside Inspection tag.
  • Arrear notifications

  • Using your daily property statistics datas, ourtradie will send arrear notifications as Email/SMS and generate CALL/Letter details. Completed arrear actions as passed inside "Arrear" tag
  • GET
    /api/RetrieveCompleted
  • Access token should be included in request header with “Authorization: Bearer {access token}”

    Request Params

  • No more request params
  • Response data

    Success Response
    ParameterDescription
    successOK
    dataXML string data contains job & other infos. Please refer this link for XML format.

Send imported jobs & arrear actions

  • Import jobs & arrear actions to your agency software received from RetrieveCompleted method. Send Job IDs, arrear ids of successfully imported jobs on your side.
  • We will mark those jobs & arrear actions as imported on agency software and prevent those details again sending on retrieve method.
  • POST
    /api/UpdateImported
  • Access token should be included in request header with “Authorization: Bearer {access token}”

    Request Params

    ParameterDescription
    jobsArray list value of ourtradie jobs id in Job details.
    arrearidsArray list value of ourtradie arrear actions id in arrear details.
  • Response data

    Success Response
    ParameterDescription
    successOK
    dataReceived jobs & arrear records marked as imported.

Client side API access library file

SyncProperties request XML structure

  • Here all dates are must be in this format - yyyy-mm-dd H:i:s (ex: 2016-07-29 05:20:29)
<?xml version="1.0" encoding="UTF-8"?>
<root>
   

 

<!-- Managements tag contains property, property manager, owner and tenant details.--> <Managements> <!-- Management tag contains property details.--> <Management> <ID>{Property ID}</ID> <KeyNo>{Property Key no}</KeyNo> <ManagerID>{PropertyManager ID}</ManagerID> <OwnerID>{PropertyOwner ID}</OwnerID> <BusinessId>{Property Reference/Unique Code}</BusinessId> <StreetName>{Property Street}</StreetName> <Suburb>{Property Suburb}</Suburb> <State>{Property State}</State> <PostCode>{Property Postcode}</PostCode> <Zone>{Property Zone}</Zone> <Furnished>{Property Zone}</Furnished> <Limit>{Expenditure / Spend Limit}</Limit> <!-- All date fields must be in the format yyyy-mm-dd H:i:s--> <ModDate>{Property Details Last Modified Date}</ModDate> <Managers> <Manager> <FullName>{PM FullName}</FullName> <FirstName>{PM FirstName}</FirstName> <LastName>{PM LastName}</LastName> <Salutation>{PM Salutation}</Salutation> <Contact>{PM Contact Name}</Contact> <ReferenceID>{PM Reference/Unique Code}</ReferenceID> <Email>{PM Email ID}</Email> <Mobile>{PM Mobile No.}</Mobile> <ModDate>{PM Details Last Modified Date}</ModDate> </Manager> </Managers> <Tenants> <Tenant> <FullName>{Tenant FullName}</FullName> <FirstName>{Tenant FirstName}</FirstName> <LastName>{Tenant LastName}</LastName> <Salutation>{Tenant Salutation}</Salutation> <Contact>{Tenant Contact Name}</Contact> <ReferenceID>{Tenant Reference/Unique Code}</ReferenceID> <Email>{Tenant Email ID}</Email> <Mobile>{Tenant Mobile No.}</Mobile> <Home>{Tenant Home Contact No.}</Home> <Business>{Tenant Business Contact No.}</Business> <LeaseStart>{Tenant Lease First Start Date}</LeaseStart> <LeaseEnd>{Tenant Lease End Date}</LeaseEnd> <VacateDate>{Tenant Vacating Date}</VacateDate> <ModDate>{Tenant Details Last Modified Date}</ModDate> </Tenant> </Tenants> <Landlords> <Landlord> <FullName>{Owner FullName}</FullName> <FirstName>{Owner FirstName}</FirstName> <LastName>{Owner LastName}</LastName> <Salutation>{Owner Salutation}</Salutation> <Contact>{Owner Contact Name}</Contact> <ReferenceID>{Owner Reference/Unique Code}</ReferenceID> <Email>{Owner Email ID}</Email> <Mobile>{Owner Mobile No.}</Mobile> <Home>{Owner Home Contact No.}</Home> <Business>{Owner Business Contact No.}</Business> <MailingAddressLine1>{Owner Street Address}</MailingAddressLine1> <MailingAddressLine2>{Suburb State Postcode}</MailingAddressLine2> <ModDate>{Owner Details Last Modified Date}</ModDate> </Landlord> </Landlords> </Management> </Managements>

 

<!-- Creditors tag contains all tradie details.--> <Creditors> <Creditor> <CreditorID>{Creditor Reference/Unique Code}</CreditorID> <CompanyName>{Creditor Company Name}</CompanyName> <FirstName>{Creditor First Name}</FirstName> <Salutation>{Creditor Salutation}</Salutation> <Contact>{Creditor Contact Name}</Contact> <MailingAddressLine1>{Creditor Street Address}</MailingAddressLine1> <MailingAddressLine2>{Suburb State Postcode}</MailingAddressLine2> <PostCode>{Creditor Postcode}</PostCode> <BuinessPhone>{Creditor Business Contact No.}</BuinessPhone> <MobilePhone>{Creditor Mobile No.}</MobilePhone> <Email>{Creditor Email ID}</Email> <TradeCategories>{Trade categories (comma separated values)}</TradeCategories> <ABN>{Creditor ABN}</ABN> <BSB>{Creditor BSB Code}</BSB> <ACN>{Creditor ACN}</ACN> <ACNAME>{Creditor Account name}</ACNAME> <ModDate>{Creditor Details Last Modified Date}</ModDate> </Creditor> </Creditors>

 

<!-- This contains jobs imported from ourtradie and invoice paid/processed in trustsystem.--> <PaidJobs> <Job> <JobID>{Ourtradie Job ID}</JobID> <name>{Job Name}</name> <InvoiceAmount>{Job total amount}</InvoiceAmount> <Invoice>{Invoice Number}</Invoice> <Processed>{Invoice Paid/Processed date}</Processed> <Created>{Job Created/Start date}</Created> <Tradie>{Creditor Reference/Unique code}</Tradie> <Property>{Property Reference/Unique code}</Property> <Reference>{Transaction ID/Reference number}</Reference> </Job> </PaidJobs>

 

<!-- Property & tenant extra informations .--> <PropertyStatistics> <PropertyStatistic> <PropertyReference>{Property Reference/Unique Code}</PropertyReference> <TenantReference>{Tenant Reference/Unique Code}</TenantReference> <Rent>{Rent Amount}</Rent> <PaidTo>{Rent Paid To Date}</PaidTo> <LastPaid>{Rent Last Paid Date}</LastPaid> <LeaseStart>{Lease Start Date}</LeaseStart> <LeaseStop>{Lease End Date}</LeaseStop> <LeaseFirstStart>{Lease First Start Date}</LeaseFirstStart> <Bond>{Bond Amount}</Bond> <LeaseTerm>{Total Lease Periods}</LeaseTerm> <Arrears>{Total invoice + rent arrear amount of Tenant}</Arrears> <RentArrears>{Total rent arrear amount of Tenant}</RentArrears> <DaysInArrears>{Rent Arrears in Days}</DaysInArrears> <ArrearsDueTo>{Arrear due date}</ArrearsDueTo> <ModifiedDate>{Property Details Last Modified Date}</ModifiedDate> <Rental>{0/1 (if Rental property value is 1 otherwise 0)}</Rental> <Credit>{Tenant Rent in Credit amount}</Credit> <Period>{Rent period (weekly/monthly/four weekly/fortnightly)}</Period> </PropertyStatistic> </PropertyStatistics>

 

<!-- Property inspection informations .--> <Inspecs> <Inspec> <Ref>{Inspection Unique Reference}</Ref> <PropertyReference>{Property Reference/Unique Code}</PropertyReference> <InspectionBegin>{Inspection start date}</InspectionBegin> <InspectionEnd>{Inspection end date}</InspectionEnd> <InspectionCompleted>{If inspection not completed value should be 0000-00-00 00:00:00 else Inspection completed date}</InspectionCompleted> <InspectionType>{Entry/Exit/Routine}</InspectionType> <InspectionDescription>{Description detail of inspection}</InspectionDescription> <Deleted>{If inspection deleted in trust send value 1 otherwise 0}</Deleted> <ModifiedDate>{Inspection details modified date}</ModifiedDate> </Inspec> </Inspecs> <!-- Tenant transaction/ledger informations --> <!-- Transaction Type Expansion RE - Rent BO - Bond DE - Deposit OW - Owner CR - Creditor LE - Let Fee PF - Prep Fee AD - Advertising SD - Sale Deposit SA - Sale CA - Cancel BA - Bank IN - Invoice --> <!-- Ledger Type Expansion C - Receipt RC - Reverse Receipt JC - Journal Credit JD - Journal Debit D - Payment RD - Reverse Payment --> <TenantLedgers> <Ledgers> <Ledger> <ID>{Transaction/Ledger ID}</ID> <TenantID>{Tenant ID}</TenantID> <Reference>{Transaction/Ledger Reference number}</Reference> <TenantRef>{Tenant Reference/Unique Code}</TenantRef> <Notes>{Transaction/Ledger Description}</Notes> <Amount>{Transaction/Ledger AMOUNT)</Amount> <TransType>{BO / CR / DE / IN / LE / OW / RE}</TransType> <LedgerType>{C / D / JC / JD / RC / RD}</LedgerType> <FromRef>{Transaction/Ledger from user Reference/Unique Code}</FromRef> <ToRef>{Transaction/Ledger to user Reference/Unique Code}</ToRef> <Address>{Property_Refere property_street suburb state postcode}</Address> <Created>{Transaction/Ledger Created date}</Created> </Ledger> </Ledgers> </TenantLedgers> <!-- Owner transaction/statement informations --> <OwnerStatements> <Statements> <Statement> <ID>{Transaction/Statement ID}</ID> <Reference>{Transaction/Statement Reference number}</Reference> <OwnerRef>{Owner Reference/Unique Code}</OwnerRef> <Notes>{Transaction/Statement Description}</Notes> <Amount>{Transaction/Statement Amount}</Amount> <TransType>{BO / DE / IN / LE / OW / RE}</TransType> <LedgerType>C / D / JC / JD / RC / RD</LedgerType> <FromRef>{Transaction/Statement from user Reference/Unique Code}</FromRef> <ToRef>{Transaction/Statement to user Reference/Unique Code}</ToRef> <Address>{Owner contact address}</Address> <Created>{Transaction/Ledger Created date}</Created> </Statement> </Statements> </OwnerStatements> <!-- Tenant invoice records --> <TenantInvoices> <Invoice> <ID>{Invoice ID}</ID> <Reference>{Invoice Reference Number}</Reference> <ToRef>{Invoice to user Reference/Unique Code}</ToRef> <Due>{Invoice due date}</Due> <Details>{Invoice description/details}</Details> <Created>{Invoice created date}</Created> <Amount>{Invoice Amount}</Amount> <Received>{Received Amount}</Received> <AmountDue>{Due Amount = Invoice Amount - Received Amount}</AmountDue> <Modified>{Invoice details modified date}</Modified> </Invoice> </TenantInvoices> <!-- Tenant Lease records --> <TenantLease> <Lease> <TRef>{Tenant Reference/Unique Code}</TRef> <PRef>{Property Reference/Unique Code}</PRef> <PID>{Property ID in your system}</PID> <TID>{Tenant ID in your system}</TID> <lease_first_start>{Lease first start date}</lease_first_start> <lease_start>{Lease start date}</lease_start> <lease_end>{Lease end date}</> <lease_terminate /> <lease_break /> <vacant_date>0000-00-00 00:00:00</vacant_date> <bank_code>2343</bank_code> <direct_debit>1</direct_debit> <gst>True</gst> <letfee_amount>0</letfee_amount> <rebate>0</rebate> <bond_required>820</bond_required> <bond_received>820</bond_received> <bond_reference>2479464-3</bond_reference> <rent>280</rent> <last_paid>2018-10-18 00:00:00</last_paid> <paid_to>2018-10-24 00:00:00</paid_to> <lease_term></lease_term> <rent_review>0000-00-00 00:00:00</rent_review> <next_rent_date></next_rent_date> <Period>weekly</Period> <letfee_type>Number of Weeks</letfee_type> <tenantpayswater>no</tenantpayswater> </Lease> </TenantLease> <!-- Send imported ourtradie maintenance jobs invoice processed date, to update job processed date in ourtradie --> <PaidJobs> <Job> <JobID>{Ourtradie maintenance Job ID}</JobID> <Processed>{Job invoice payment processed date}</Processed> </Job> </PaidJobs> <!-- Send imported ourtradie maintenance jobs invoice disbursed date, to update job payment disbursed date in ourtradie --> <DisbursedJobs> <Row> <JobID>{Ourtradie maintenance Job ID}</JobID> <Processed>{Job invoice payment processed date}</Processed> </Row> </DisbursedJobs> <!-- Today inactived/deleted properties, owners, tenants, creditors & Managers --> <Inactive> <Properties> <Ref>{Today inactived/deleted Property Reference/Unique Code}</Ref> <Ref>{Today inactived/deleted Property Reference/Unique Code}</Ref> </Properties> <Owners> <Ref>{Today inactived/deleted Owner Reference/Unique Code}</Ref> </Owners> <Tenants> <Ref>{Today inactived/deleted Tenant Reference/Unique Code}</Ref> </Tenants> <Creditors> <Ref>{Today inactived/deleted Creditor Reference/Unique Code}</Ref> </Creditors> <Managers> <Ref>{Today inactived/deleted Manager Reference/Unique Code}</Ref> </Managers> </Inactive> <LastUpdateDate>{xml data prepared date and time}</LastUpdateDate> <!-- Send once banking update process completed in agency software on the date. Otherwise don't send it. --> <BankUpdateDate>{Banking update compeleted time}</BankUpdateDate> </root>

RetrieveCompleted response XML structure

  • Here all dates are in this format - yyyy-mm-dd H:i:s (ex: 2016-07-29 05:20:29)
<?xml version="1.0" encoding="UTF-8"?>
<WorkOrders>

   

 

<!-- Each Workorder tag contains ourtradie completed Job informations to import on Trust Systems --> <!-- All date fields must be in the format yyyy-mm-dd H:i:s--> <WorkOrder> <UserRef>{PM Reference/Unique Code}</UserRef> <TenantRef>{Tenant Reference/Unique Code}</TenantRef> <OwnerRef>{Owner Reference/Unique Code}</OwnerRef> <BondTenant>{Bond pay selected Tenant Reference/Unique Code otherwise 0}</BondTenant> <CreditorRef>{Creditor Reference/Unique Code}</CreditorRef> <PropertyRef>{Property Reference/Unique Code}</PropertyRef> <JobStart>{Job started date}</JobStart> <JobEnd>{Job end date}</JobEnd> <JobDescription>{Job notes/description}</JobDescription> <JobID>{Ourtradie Job unique ID number}</JobID> <JobName>{Ourtradie Job Name}</JobName> <JobStatus>{finalised / landlord-to-pay / take-from-bond / tenant-to-pay}</JobStatus> <Trade>{Job Trade Categorie Name}</Trade> <!-- If a job was offered job, quote tag should be qmpty --> <QuoteList> <Quote> <TradieID>{Quoted Tradie Reference/Unique Code}</TradieID> <Amount>{Quoted Amount}</Amount> <Desc>{Quoted Description}</Desc> </Quote> <Quote> <TradieID>{Quoted Tradie Reference/Unique Code}</TradieID> <Amount>{Quoted Amount}</Amount> <Desc>{Quoted Description}</Desc> </Quote> </QuoteList> <!-- If a job was quote job & quote tags presented, QuoteSelected value is 1 otherwise 0. --> <QuoteSelected>{Selected Quote Number }</QuoteSelected> <!-- Trust system enabled Invoice tenants for bond work in Ourtradie agency settings & job was take-from-bond only TenantBond tag will be available --> <TenantBond>1</TenantBond> <Created>{Job Created date}</Created> <Completed>{Job Completed date}</Completed> <Modified>{Job Details Modified date}</Modified> <TotalAmount>{Job total invoice amount}</TotalAmount> <TradieCompany>{Tradie Company Name}</TradieCompany> <Notes>{Job notes entered by Tradie/PM/Tenant/Owner}</Notes> <InvoiceNumber>{Job Invoice Number}</InvoiceNumber> <InvoiceDesc>{Job Invoice Description}</InvoiceDesc> <Attachments> <Attachment>{Job Invoice PDF Url}</Attachment> </Attachments> <Categories>{~General Maintenance~/~Residential~}</Categories> <!-- below tags are optional/defualt tags.--> <GST>1</GST> <Status>10</Status> <ActionReference /> <Action>2</Action> <ActionTypeIndex>9</ActionTypeIndex> <Invoice>1</Invoice> <DataSetID>0</DataSetID> <Remind>0</Remind> <Private>0</Private> <RTAVersion>0</RTAVersion> <TypeIndex>0</TypeIndex> <OrderIndex>0</OrderIndex> <AccountID>1</AccountID> <Type>2</Type> <ChequeNumber>0</ChequeNumber> <CommissionType>3</CommissionType> <Withhold>1</Withhold> <Hold>0</Hold> <DissectionID>0</DissectionID> <FileType>4</FileType> <OriginalTransactionID>0</OriginalTransactionID> <AdvertisingDebit>0</AdvertisingDebit> <Audit>0</Audit> <AttachmentFileID>42</AttachmentFileID> </WorkOrder>

 

<!-- Each ConfirmedJob tag contains ourtradie tradie confirmed Job informations to import on Trust Systems --> <!-- All date fields must be in the format yyyy-mm-dd H:i:s--> <ConfirmedJob> <UserRef>{PM Reference/Unique Code}</UserRef> <TenantRef>{Tenant Reference/Unique Code}</TenantRef> <OwnerRef>{Owner Reference/Unique Code}</OwnerRef> <BondTenant>{Bond pay selected Tenant Reference/Unique Code otherwise 0}</BondTenant> <CreditorRef>{Creditor Reference/Unique Code}</CreditorRef> <PropertyRef>{Property Reference/Unique Code}</PropertyRef> <JobStart>{Job started date}</JobStart> <JobEnd>{Job end date}</JobEnd> <JobDescription>{Job notes/description}</JobDescription> <JobID>{Ourtradie Job unique ID number}</JobID> <JobName>{Ourtradie Job Name}</JobName> <JobStatus>{future / active}</JobStatus> <Trade>{Job Trade Categorie Name}</Trade> <!-- If a job was offered job, quote tag should be qmpty --> <QuoteList> <Quote> <TradieID>{Quoted Tradie Reference/Unique Code}</TradieID> <Amount>{Quoted Amount}</Amount> <Desc>{Quoted Description}</Desc> </Quote> <Quote> <TradieID>{Quoted Tradie Reference/Unique Code}</TradieID> <Amount>{Quoted Amount}</Amount> <Desc>{Quoted Description}</Desc> </Quote> </QuoteList> <!-- If a job was quote job & quote tags presented, QuoteSelected value is 1 otherwise 0. --> <QuoteSelected>{Selected Quote Number }</QuoteSelected> <Created>{Job Created date}</Created> <Completed>{Job Completed date}</Completed> <Modified>{Job Details Modified date}</Modified> <TotalAmount>{Job total invoice amount}</TotalAmount> <TradieCompany>{Tradie Company Name}</TradieCompany> <Notes>{Job notes entered by Tradie/PM/Tenant/Owner}</Notes> <InvoiceNumber>{Job Invoice Number}</InvoiceNumber> <InvoiceDesc>{Job Invoice Description}</InvoiceDesc> <Attachments> <Attachment>{Job Invoice PDF Url}</Attachment> </Attachments> <Categories>{~General Maintenance~/~Residential~}</Categories> <!-- below tags are optional/defualt tags.--> <GST>1</GST> <Status>10</Status> <ActionReference /> <Action>2</Action> <ActionTypeIndex>9</ActionTypeIndex> <Invoice>1</Invoice> <DataSetID>0</DataSetID> <Remind>0</Remind> <Private>0</Private> <RTAVersion>0</RTAVersion> <TypeIndex>0</TypeIndex> <OrderIndex>0</OrderIndex> <AccountID>1</AccountID> <Type>2</Type> <ChequeNumber>0</ChequeNumber> <CommissionType>3</CommissionType> <Withhold>1</Withhold> <Hold>0</Hold> <DissectionID>0</DissectionID> <FileType>4</FileType> <OriginalTransactionID>0</OriginalTransactionID> <AdvertisingDebit>0</AdvertisingDebit> <Audit>0</Audit> <AttachmentFileID>42</AttachmentFileID> </ConfirmedJob>

 

<!-- Job completed creditor was not mapped in trust system, he was our registered creditor means, Creditor tag is available to update in trust system --> <Creditor> <id>{Creditor id in Ourtradie}</id> <name>{Creditor name in Ourtradie}</name> <lastname>{Creditor lastname in Ourtradie}</lastname> <email>{Creditor email in Ourtradie}</email> <mobile>{Creditor mobile phone number in Ourtradie}</mobile> <business>{Creditor business phone number in Ourtradie}</business> <home>{Creditor home phone number in Ourtradie}</home> <abn>{Creditor ABN Number}</abn> <bank_name>{Creditor Bank name}</bank_name> <bsb>{Creditor BSB number}</bsb> <Account>{Creditor Account number}</Account> <AccountName>{Creditor Account name}</AccountName> <company>{Creditor Company Name}</company> <address>{Creditor Street Address}</address> <suburb>{Creditor Suburb}</suburb> <state>{Creditor State}</state> <zipcode>{Creditor postcode}</zipcode> <Reference>{Creditor Reference/Unique Code}</Reference> <Trade>{Creditor Trade Categories comma separated values.}</Trade> </Creditor>

 

<!-- Previously imported Invoice approved jobs changed back to complete state by Property Manager in ourtradie --> <JobReverse> <id>{Ourtradie Job id}</id> </JobReverse>

 

<!-- Inspection tag contains information of property inspections completed through Ourtradie Inspection Apps --> <Inspection> <ID>{Inspection ID in Ourtradie}</ID> <InsID>{If inspection created from SyncProperties call, hold Inspection Unique Reference of trust otherwise empty}</InsID> <PropRef>{Property Reference/Unique Code}</PropRef> <Attachment>{Completed inspection report PDF url}</Attachment> <CleanReport>{Cleaning report PDF url}</CleanReport> <InspectionBegin>{Inspection start date}</InspectionBegin> <InspectionType>{Entry / Routine / Exit}</InspectionType> <Deleted>{If inspection deleted in ourtradie send value 1 otherwise 0}</Deleted> <InspectionDescription>{Inspection description }</InspectionDescription> <InspectionEnd>{Inspection end date}</InspectionEnd> <Completed>{Inspection completed date}</Completed> <Bedrooms>{Property Bedrooms count}</Bedrooms> <Bathrooms>{Property Bathrooms count}</Bathrooms> <CarAccomm>{Car accommadation count}</CarAccomm> <FirstRoutine>{Duration between entry and first routine inspection in number of weeks}</FirstRoutine> <RoutineDuration>{Regular routine inspection period in number of weeks}</RoutineDuration> </Inspection>

 

<!-- Arrear tag contains arrear sms/email/phone call/letter action informations done in ourtradie --> <Arrear> <Type>{SMS / EMAIL / CALL / LETTER}</Type> <PropertyRef>{Property Reference/Unique Code}</PropertyRef> <User>{Tenant/Owner Reference/Unique Code}</User> <UType>{tnt / ll}</UType> <Email>{Tenant/Owner Email address}</Email> <Subject>{Arrear subject}</Subject> <Message><![CDATA[{Arrear message / description }]]></Message> <SentTime>{Arrear notification sent time}</SentTime> <ID>{Arrear notification ID in Ourtradie}</ID> </Arrear> </WorkOrders>

This API documentation is provided by OurTradie.