{"openapi":"3.0.3","info":{"title":"1_SandBox_MuleCustomerPortal","version":"1.0.0","contact":{}},"servers":[{"url":"https://mule-metricon-customer-portal-api-di3cwp.dlh4l3.aus-s1.cloudhub.io"}],"paths":{"/api/customerdetails":{"get":{"tags":["MID/Finance"],"summary":"/api/customerdetails?contractNumber/745490","description":"/api/customerdetails?contractNumber/745490","operationId":"apiCustomerdetailsContractnumber/745490","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"745490"}}],"responses":{"200":{"description":""}}}},"/api/finance/contractsummary":{"get":{"tags":["MID/Finance"],"summary":"/api/finance/contractsummary?contractNumber&#61;745490","description":"## GET /api/finance/contractsummary\n\n### 1\\. Summary\n\nRetrieves a summary of a finance contract based on the provided contract number. This endpoint is typically used to fetch contract details, billing information, and financial totals for a specific contract in the system.\n\n---\n\n### 2\\. Query Parameters\n\n| Name | Type | Required | Description | Example Value |\n| --- | --- | --- | --- | --- |\n| &#96;contractNumber&#96; | string/integer | Yes | The unique identifier for the contract to retrieve. | &#96;745490&#96; |\n\n- **Example:**\n    \n    &#96;&#96;&#96; http\n    GET /api/finance/contractsummary?contractNumber&#61;745490\n    \n     &#96;&#96;&#96;\n    \n\n---\n\n### 3\\. Request Headers\n\n| Header | Required | Description | Example Value |\n| --- | --- | --- | --- |\n| &#96;API-Version&#96; | Optional | Specifies the API version to use. | &#96;1.0&#96; |\n| &#96;Accept&#96; | Optional | Desired response content type. | &#96;text/plain&#96; |\n\n---\n\n### 4\\. Example Response\n\n&#96;&#96;&#96; json\n[\n  {\n    &#34;CustomerNumber&#34;: &#34;553217&#34;,\n    &#34;ContractNumber&#34;: 745490,\n    &#34;OperatingCenter&#34;: &#34;181&#34;,\n    &#34;BPAYCustomerReferenceCde&#34;: &#34;7454901&#34;,\n    &#34;BPAYBillerCode&#34;: &#34;341396&#34;,\n    &#34;ContractPrice&#34;: 1021226,\n    &#34;Variations&#34;: 1021226,\n    &#34;GrandTotal&#34;: 1034518\n  }\n]\n\n &#96;&#96;&#96;\n\n#### Field Explanations\n\n- &#96;CustomerNumber&#96;: The unique identifier for the customer associated with the contract.\n    \n- &#96;ContractNumber&#96;: The contract&#39;s unique number (matches the query parameter).\n    \n- &#96;OperatingCenter&#96;: Code representing the operating center handling the contract.\n    \n- &#96;BPAYCustomerReferenceCde&#96;: BPAY customer reference code for payments.\n    \n- &#96;BPAYBillerCode&#96;: BPAY biller code for the contract.\n    \n- &#96;ContractPrice&#96;: The base price of the contract.\n    \n- &#96;Variations&#96;: The total value of contract variations.\n    \n- &#96;GrandTotal&#96;: The total contract value including all variations.\n    \n\n---\n\n### 5\\. Related Requests for Further Context\n\nFor additional usage patterns and variations, see these similar requests in your workspace:\n\n- [<code>/api/finance/contractsummary</code>](https://request/47023579-bf9e9dbf-92bb-4644-8b75-2d3d803e88dc)\n    \n- [<code>/api/finance/contractsummary</code>](https://request/47023579-fec9f91c-6e92-4421-88c8-001f60ccbed8)\n    \n\n---\n\n_This documentation is auto-generated based on current workspace context and example responses._","operationId":"apiFinanceContractsummaryContractnumber61745490","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"745490"}}],"responses":{"200":{"description":""}}}},"/api/finance/contractvariation":{"get":{"tags":["MID/Finance"],"summary":"/api/finance/contractvariation?contractNumber&#61;745490","description":"/api/finance/contractvariation?contractNumber&#61;745490","operationId":"apiFinanceContractvariationContractnumber61745490","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"745490"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/finance/contractallinvoicespaymentsdetails":{"get":{"tags":["MID/Finance"],"summary":"/api/finance/contractallinvoicespaymentsdetails?contractNumber&#61;745490","description":"/api/finance/contractallinvoicespaymentsdetails?contractNumber&#61;745490","operationId":"apiFinanceContractallinvoicespaymentsdetailsContractnumber61745490","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"745490"}}],"responses":{"200":{"description":""}}}},"/api/finance/contractpayments":{"get":{"tags":["MID/Finance"],"summary":"/api/finance/contractpayments?contractNumber&#61;745490","description":"/api/finance/contractpayments?contractNumber&#61;745490","operationId":"apiFinanceContractpaymentsContractnumber61745490","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"745490"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/finance/contractpaymentsforuidisply":{"get":{"tags":["MID/Finance"],"summary":"/api/finance/contractpaymentsforuidisply?contractNumber&#61;745490","description":"/api/finance/contractpaymentsforuidisply?contractNumber&#61;745490","operationId":"apiFinanceContractpaymentsforuidisplyContractnumber61745490","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"745490"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/finance/invoicepaymentsdetails":{"get":{"tags":["MID/Finance"],"summary":"/api/finance/invoicepaymentsdetails?contractNumber&#61;745490&amp;invoiceNumber&#61;974173","description":"/api/finance/invoicepaymentsdetails?contractNumber&#61;745490&amp;invoiceNumber&#61;974173","operationId":"apiFinanceInvoicepaymentsdetailsContractnumber61745490AmpInvoicenumber61974173","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"745490"}},{"name":"invoiceNumber","in":"query","schema":{"type":"string","example":"974173"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/tender/notes/list":{"get":{"tags":["ClickHomeApi"],"summary":"/api/tender/notes/list?contractNumber&#61;748136","description":"/api/tender/notes/list?contractNumber&#61;748136","operationId":"apiTenderNotesListContractnumber61748136","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"748136"}},{"name":"optionalSubContractID","in":"query","schema":{"type":"string","example":"185654"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/tender/documents/list":{"get":{"tags":["ClickHomeApi"],"summary":"/api/tender/documents/list?contractNumber&#61;748136","description":"/api/tender/documents/list?contractNumber&#61;748136","operationId":"apiTenderDocumentsListContractnumber61748136","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"748136"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/tender/appointments/list":{"get":{"tags":["ClickHomeApi"],"summary":"/api/tender/appointments/list?contractNumber&#61;748136","description":"/api/tender/appointments/list?contractNumber&#61;748136","operationId":"apiTenderAppointmentsListContractnumber61748136","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"748136"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/tender/documents/18323169/download":{"get":{"tags":["ClickHomeApi"],"summary":"/api/tender/documents/18323169/download?contractNumber&#61;748136","description":"/api/tender/documents/18323169/download?contractNumber&#61;748136","operationId":"apiTenderDocuments18323169DownloadContractnumber61748136","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"748136"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/tender/documents/upload":{"post":{"tags":["ClickHomeApi"],"summary":"/api/tender/documents/upload","description":"/api/tender/documents/upload","operationId":"apiTenderDocumentsUpload","parameters":[{"name":"api-version","in":"header","schema":{"type":"string","example":"1.0"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"ContractID":{"type":"string","example":" 104989"},"Data":{"type":"string","format":"binary"},"Description":{"type":"string","example":"tile555 pdf file"},"MasterContractNumber":{"type":"string","example":"735972"},"Name":{"type":"string","example":"tile555.pdf"},"Title":{"type":"string","example":"tile555"}}}}}},"responses":{"200":{"description":"http://localhost:8081/api/tender/notes/4974599/read?contractNumber&#61;748136","headers":{"Content-Length":{"schema":{"type":"string","example":"131"}},"Date":{"schema":{"type":"string","example":"Tue, 02 Dec 2025 03:13:04 GMT"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"DocumentID":{"type":"string","example":" 104989"},"DocumentName":{"type":"string","example":"tile555.pdf"},"Extension":{"type":"string","example":"application/pdf"},"Title":{"type":"string","example":"tile555"},"Url":{"type":"string","example":""}}},"examples":{"http://localhost:8081/api/tender/notes/4974599/read?contractNumber&#61;748136":{"value":{"DocumentID":" 104989","DocumentName":"tile555.pdf","Extension":"application/pdf","Title":"tile555","Url":""}}}}}}}}},"/api/tender/notes/add":{"post":{"tags":["ClickHomeApi"],"summary":"/api/tender/notes/add","description":"/api/tender/notes/add","operationId":"apiTenderNotesAdd","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"Body":{"type":"string","example":"good notes to save by DG"},"ContractNumber":{"type":"string","example":"735972"},"IsFromCustomer":{"type":"boolean","example":true},"NoteType":{"type":"string","example":"N"},"ReplyTo":{"type":"object","properties":{"NoteID":{"type":"number","example":0}}},"SubContractID":{"type":"number","example":104989},"Subject":{"type":"string","example":"this is a test note add to CH"}}},"examples":{"/api/tender/notes/add":{"value":{"Body":"good notes to save by DG","ContractNumber":"735972","IsFromCustomer":true,"NoteType":"N","ReplyTo":{"NoteID":0},"SubContractID":104989,"Subject":"this is a test note add to CH"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/useraccount":{"get":{"tags":["CognitoServices"],"summary":"/api/useraccount?username=frankzhao@metricon.com.au","description":"/api/useraccount?username=frankzhao@metricon.com.au","operationId":"apiUseraccountUsernameFrankzhaoMetriconComAu","parameters":[{"name":"username","in":"query","schema":{"type":"string","example":"frankzhao@metricon.com.au"}}],"requestBody":{"content":{"application/json":{"examples":{"/api/useraccount?username=frankzhao@metricon.com.au":{"value":""}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/useraccount/create":{"post":{"tags":["CognitoServices"],"summary":"/api/useraccount/create","description":"/api/useraccount/create","operationId":"apiUseraccountCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"EmailAddress":{"type":"string","example":"durgeshgopisetty@metricon.com.au"},"FirstName":{"type":"string","example":"Durgesh"},"LastName":{"type":"string","example":"Gopisetty"},"MembershipGroupName":{"type":"string","example":"Coustomer"},"MfaPreference":{"type":"string","example":true},"PhoneNumber":{"type":"string","example":"+61414894836"}}},"examples":{"/api/useraccount/create":{"value":{"EmailAddress":"durgeshgopisetty@metricon.com.au","FirstName":"Durgesh","LastName":"Gopisetty","MembershipGroupName":"Coustomer","MfaPreference":true,"PhoneNumber":"+61414894836"}},"/api/useraccount/update":{"value":{"EmailAddress":"durgeshgopisetty@metricon.com.au","FirstName":"Durgesh","LastName":"Gopisetty","MembershipGroupName":"Coustomer","MfaPreference":true,"PhoneNumber":"+61414894836"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/useraccount/enable":{"post":{"tags":["CognitoServices"],"summary":"/api/useraccount/enable?username=durgeshgopisetty@metricon.com.au","description":"/api/useraccount/enable?username=durgeshgopisetty@metricon.com.au","operationId":"apiUseraccountEnableUsernameDurgeshgopisettyMetriconComAu","parameters":[{"name":"username","in":"query","schema":{"type":"string","example":"durgeshgopisetty@metricon.com.au"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"UserPoolId":{"type":"string","example":"ap-southeast-2_yIw7ymv4N"},"Username":{"type":"string","example":"DurgeshGopisetty82"}}},"examples":{"/api/useraccount/enable?username=durgeshgopisetty@metricon.com.au":{"value":{"UserPoolId":"ap-southeast-2_yIw7ymv4N","Username":"DurgeshGopisetty82"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/useraccount/delete":{"delete":{"tags":["CognitoServices"],"summary":"/api/useraccount/delete?username=lynettelincoln@metricon.com.au","description":"/api/useraccount/delete?username=lynettelincoln@metricon.com.au","operationId":"apiUseraccountDeleteUsernameLynettelincolnMetriconComAu","parameters":[{"name":"username","in":"query","schema":{"type":"string","example":"durgeshgopisetty@metricon.com.au"}}],"requestBody":{"content":{"application/json":{"examples":{"/api/useraccount/delete?username=lynettelincoln@metricon.com.au":{"value":""}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/useraccount/group/list":{"get":{"tags":["CognitoServices"],"summary":"/api/useraccount/group/list","description":"/api/useraccount/group/list","operationId":"apiUseraccountGroupList","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"Description":{"type":"string","example":"My Example Group10"},"Name":{"type":"string","example":"ExampleGroup10"}}},"examples":{"/api/useraccount/group/list":{"value":{"Description":"My Example Group10","Name":"ExampleGroup10"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/useraccount/group/create":{"post":{"tags":["CognitoServices"],"summary":"/api/useraccount/group/create","description":"/api/useraccount/group/create","operationId":"apiUseraccountGroupCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"Description":{"type":"string","example":"My Example Group10"},"Name":{"type":"string","example":"ExampleGroup10"}}},"examples":{"/api/useraccount/group/create":{"value":{"Description":"My Example Group10","Name":"ExampleGroup10"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/useraccount/group/update":{"post":{"tags":["CognitoServices"],"summary":"/api/useraccount/group/update","description":"/api/useraccount/group/update","operationId":"apiUseraccountGroupUpdate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"Description":{"type":"string","example":"My Example Group10"},"Name":{"type":"string","example":"ExampleGroup10"}}},"examples":{"/api/useraccount/group/update":{"value":{"Description":"My Example Group10","Name":"ExampleGroup10"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/useraccount/group/delete":{"delete":{"tags":["CognitoServices"],"summary":"/api/useraccount/group/delete?groupName=ExampleGroup101","description":"/api/useraccount/group/delete?groupName=ExampleGroup101","operationId":"apiUseraccountGroupDeleteGroupnameExamplegroup101","parameters":[{"name":"groupName","in":"query","schema":{"type":"string","example":"ExampleGroup101"}}],"requestBody":{"content":{"application/json":{"examples":{"/api/useraccount/group/delete?groupName=ExampleGroup101":{"value":""}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/nosec/token":{"post":{"tags":["CognitoServices"],"summary":"http://localhost:8081/nosec/token","description":"http://localhost:8081/nosec/token","operationId":"httpLocalhost8081NosecToken","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ClientID":{"type":"string","example":"1mn1cn9fh67tatb86di6cbuufh"},"ClientSecretKey":{"type":"string","example":"12nlcavnac10164ikcju7b8stvhb7eu2d181icgfcgbikmh0n7ac"}}},"examples":{"http://localhost:8081/nosec/token":{"value":{"ClientID":"1mn1cn9fh67tatb86di6cbuufh","ClientSecretKey":"12nlcavnac10164ikcju7b8stvhb7eu2d181icgfcgbikmh0n7ac"}}}}}},"responses":{"200":{"description":""}},"security":[{}]}},"/api/servicewarranty/areas":{"get":{"tags":["CRM"],"summary":"getswarealocal-/api/servicewarranty/areas","description":"getswarealocal-/api/servicewarranty/areas","operationId":"getswarealocalApiServicewarrantyAreas","responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/subareas":{"get":{"tags":["CRM"],"summary":"getsubareaslocal","description":"getsubareaslocal","operationId":"getsubareaslocal","parameters":[{"name":"id","in":"query","schema":{"type":"string","example":"e1af2cf5-a2af-e111-b269-005056b457c1"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/contracts/731472":{"get":{"tags":["CRM"],"summary":"getcontractlocal","description":"getcontractlocal","operationId":"getcontractlocal","parameters":[{"name":"$select","in":"query","schema":{"type":"string","example":"new_description,new_name,new_serviceitemareaid"}},{"name":"odata-maxversion","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"odata-version","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;*"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/notes":{"get":{"tags":["CRM"],"summary":"getnoteslocal","description":"getnoteslocal","operationId":"getnoteslocal","parameters":[{"name":"$select","in":"query","schema":{"type":"string","example":"new_description,new_name,new_serviceitemareaid"}},{"name":"belongingObjectID","in":"query","schema":{"type":"string","example":"27F9FEBD-464D-EF11-BCCD-0050568B577"}},{"name":"odata-maxversion","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"odata-version","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;*"}}],"responses":{"200":{"description":""}},"security":[{}]}},"/api/servicewarranty/serviceitems":{"get":{"tags":["CRM"],"summary":"getserviceitemlocal","description":"getserviceitemlocal","operationId":"getserviceitemlocal","parameters":[{"name":"contractID","in":"query","schema":{"type":"string","example":"5efbc111-f72a-ec11-a2c7-005056b4c7c6"}},{"name":"ownerCreatedOn","in":"query","schema":{"type":"string","example":"2001-10-10T00:00:00"}},{"name":"odata-maxversion","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"odata-version","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;*"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/warrantyitems":{"get":{"tags":["CRM"],"summary":"getwarrantyItemlocal","description":"getwarrantyItemlocal","operationId":"getwarrantyitemlocal","parameters":[{"name":"contractID","in":"query","schema":{"type":"string","example":"FA85F3B3-7EBC-E811-A2C0-005056B431B4"}},{"name":"ownerCreatedOn","in":"query","schema":{"type":"string","example":"2022-01-03T02:56:05Z"}},{"name":"odata-maxversion","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"odata-version","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;*"}}],"responses":{"200":{"description":""}},"security":[{}]}},"/api/servicewarranty/serviceitems/889e4387-4497-ef11-bcda-0050568bb0ea":{"get":{"tags":["CRM"],"summary":"getserviceitembyidlocal","description":"getserviceitembyidlocal","operationId":"getserviceitembyidlocal","parameters":[{"name":"odata-maxversion","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"odata-version","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;*"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/warrantyitems/6e5bc4ee-c2bd-f011-bb1a-020511b32e43":{"get":{"tags":["CRM"],"summary":"get warrantyitem by id local","description":"get warrantyitem by id local","operationId":"getWarrantyitemByIdLocal","responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/data/v8.2/new_serviceitems":{"post":{"tags":["CRM"],"summary":"Service Item Add","description":"Service Item Add","operationId":"serviceItemAdd","parameters":[{"name":"odata-maxversion","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"odata-version","in":"header","schema":{"type":"string","example":"4.0"}},{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;&#34;*&#34;"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_SubArea@odata.bind":{"type":"string","example":"/new_serviceitemsubareas(944df9c0-c59b-ed11-a2e9-005056b4070e)"},"new_area@odata.bind":{"type":"string","example":"/new_serviceitemareas(e5af2cf5-a2af-e111-b269-005056b457c1)"},"new_contractid@odata.bind":{"type":"string","example":"/new_contracts(FA85F3B3-7EBC-E811-A2C0-005056B431B4)"},"new_details":{"type":"string","example":"this is a test to add an item for service55"},"new_name":{"type":"string","example":"Test Add S item55"},"new_raisedbycustomer":{"type":"boolean","example":true},"new_urgent":{"type":"boolean","example":true},"statuscode":{"type":"number","example":100000004}}},"examples":{"Service Item Add":{"value":{"new_SubArea@odata.bind":"/new_serviceitemsubareas(944df9c0-c59b-ed11-a2e9-005056b4070e)","new_area@odata.bind":"/new_serviceitemareas(e5af2cf5-a2af-e111-b269-005056b457c1)","new_contractid@odata.bind":"/new_contracts(FA85F3B3-7EBC-E811-A2C0-005056B431B4)","new_details":"this is a test to add an item for service55","new_name":"Test Add S item55","new_raisedbycustomer":true,"new_urgent":true,"statuscode":100000004}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/data/v8.2/new_serviceitems(b1778165-08b6-f011-bb1a-020511b32e43)":{"patch":{"tags":["CRM"],"summary":"Service Item update","description":"Service Item update","operationId":"serviceItemUpdate","parameters":[{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;*"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_SubArea@odata.bind":{"type":"string","example":"/new_serviceitemsubareas(c44ef9c0-c59b-ed11-a2e9-005056b4070e)"},"new_area@odata.bind":{"type":"string","example":"/new_serviceitemareas(27b02cf5-a2af-e111-b269-005056b457c1)"},"new_contractid@odata.bind":{"type":"string","example":"/new_contracts(FA85F3B3-7EBC-E811-A2C0-005056B431B4)"},"new_details":{"type":"string","example":"this is a test to add an item for service updated asdfsfs 555"},"new_name":{"type":"string","example":"Test Add S item udpated 555"},"new_urgent":{"type":"boolean","example":false}}},"examples":{"Service Item update":{"value":{"new_SubArea@odata.bind":"/new_serviceitemsubareas(c44ef9c0-c59b-ed11-a2e9-005056b4070e)","new_area@odata.bind":"/new_serviceitemareas(27b02cf5-a2af-e111-b269-005056b457c1)","new_contractid@odata.bind":"/new_contracts(FA85F3B3-7EBC-E811-A2C0-005056B431B4)","new_details":"this is a test to add an item for service updated asdfsfs 555","new_name":"Test Add S item udpated 555","new_urgent":false}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/serviceitems/add":{"post":{"tags":["CRM"],"summary":"serviceitemaddlocal","description":"serviceitemaddlocal","operationId":"serviceitemaddlocal","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"AreaID":{"type":"string","example":"e5af2cf5-a2af-e111-b269-005056b457c1"},"ContractID":{"type":"string","example":"FA85F3B3-7EBC-E811-A2C0-005056B431B4"},"Description":{"type":"string","example":"this is Test title new 2026"},"ID":{"type":"string","example":""},"IsUrgent":{"type":"boolean","example":false},"SubAreaID":{"type":"string","example":"944df9c0-c59b-ed11-a2e9-005056b4070e"},"Title":{"type":"string","example":"Test title new 82026"}}},"examples":{"serviceitemaddlocal":{"value":{"AreaID":"e5af2cf5-a2af-e111-b269-005056b457c1","ContractID":"FA85F3B3-7EBC-E811-A2C0-005056B431B4","Description":"this is Test title new 2026","ID":"","IsUrgent":false,"SubAreaID":"944df9c0-c59b-ed11-a2e9-005056b4070e","Title":"Test title new 82026"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/serviceitems/update":{"post":{"tags":["CRM"],"summary":"serviceitemupdatelocal","description":"serviceitemupdatelocal","operationId":"serviceitemupdatelocal","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"AreaID":{"type":"string","example":"e5af2cf5-a2af-e111-b269-005056b457c1"},"ContractID":{"type":"string","example":"FA85F3B3-7EBC-E811-A2C0-005056B431B4"},"Description":{"type":"string","example":"this is Test title new 666"},"ID":{"type":"string","example":"b1778165-08b6-f011-bb1a-020511b32e43"},"IsUrgent":{"type":"boolean","example":false},"SubAreaID":{"type":"string","example":"944df9c0-c59b-ed11-a2e9-005056b4070e"},"Title":{"type":"string","example":"Test title new 666"}}},"examples":{"serviceitemupdatelocal":{"value":{"AreaID":"e5af2cf5-a2af-e111-b269-005056b457c1","ContractID":"FA85F3B3-7EBC-E811-A2C0-005056B431B4","Description":"this is Test title new 666","ID":"b1778165-08b6-f011-bb1a-020511b32e43","IsUrgent":false,"SubAreaID":"944df9c0-c59b-ed11-a2e9-005056b4070e","Title":"Test title new 666"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/warrantyitems/update":{"post":{"tags":["CRM"],"summary":"warrantyitemupdatelocal","description":"warrantyitemupdatelocal","operationId":"warrantyitemupdatelocal","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"AreaID":{"type":"string","example":"e5af2cf5-a2af-e111-b269-005056b457c1"},"ContractID":{"type":"string","example":"FA85F3B3-7EBC-E811-A2C0-005056B431B4"},"Description":{"type":"string","example":"updated desc 2025 11/03"},"ID":{"type":"string","example":"117bdb8e-235e-f011-bce3-0050568bec06"},"IsUrgent":{"type":"boolean","example":false},"SubAreaID":{"type":"string","example":"944df9c0-c59b-ed11-a2e9-005056b4070e"},"Title":{"type":"string","example":"Bathroom - Cracking to plaster/Mould updated 2025 ffff"}}},"examples":{"warrantyitemupdatelocal":{"value":{"AreaID":"e5af2cf5-a2af-e111-b269-005056b457c1","ContractID":"FA85F3B3-7EBC-E811-A2C0-005056B431B4","Description":"updated desc 2025 11/03","ID":"117bdb8e-235e-f011-bce3-0050568bec06","IsUrgent":false,"SubAreaID":"944df9c0-c59b-ed11-a2e9-005056b4070e","Title":"Bathroom - Cracking to plaster/Mould updated 2025 ffff"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/attachments":{"get":{"tags":["CRM"],"summary":"servicewarranty attachment local","description":"servicewarranty attachment local","operationId":"servicewarrantyAttachmentLocal","parameters":[{"name":"belongingObjectID","in":"query","schema":{"type":"string","example":"6e5bc4ee-c2bd-f011-bb1a-020511b32e43"}}],"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/data/v8.2/new_warrantyitems(117bdb8e-235e-f011-bce3-0050568bec06)":{"patch":{"tags":["CRM"],"summary":"warrantyItemUpdate","description":"warrantyItemUpdate","operationId":"warrantyitemupdate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_areaid@odata.bind":{"type":"string","example":"/new_serviceitemareas(e5af2cf5-a2af-e111-b269-005056b457c1)"},"new_details":{"type":"string","example":"updated desc 2025"},"new_name":{"type":"string","example":"Bathroom - Cracking to plaster/Mould updated 2025"},"new_subarea@odata.bind":{"type":"string","example":"/new_serviceitemsubareas(944df9c0-c59b-ed11-a2e9-005056b4070e)"},"new_urgent":{"type":"boolean","example":false}}},"examples":{"warrantyItemUpdate":{"value":{"new_areaid@odata.bind":"/new_serviceitemareas(e5af2cf5-a2af-e111-b269-005056b457c1)","new_details":"updated desc 2025","new_name":"Bathroom - Cracking to plaster/Mould updated 2025","new_subarea@odata.bind":"/new_serviceitemsubareas(944df9c0-c59b-ed11-a2e9-005056b4070e)","new_urgent":false}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/warrantyitems/add":{"post":{"tags":["CRM"],"summary":"warrantyitems add local","description":"warrantyitems add local","operationId":"warrantyitemsAddLocal","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"AreaID":{"type":"string","example":"e5af2cf5-a2af-e111-b269-005056b457c1"},"ContractID":{"type":"string","example":"FA85F3B3-7EBC-E811-A2C0-005056B431B4"},"Description":{"type":"string","example":"Test desc for new warranty items. new desc 2025-12-16 mule 44"},"IsUrgent":{"type":"boolean","example":false},"ParentWarrantyID":{"nullable":true,"example":null},"SubAreaID":{"type":"string","example":"944df9c0-c59b-ed11-a2e9-005056b4070e"},"Title":{"type":"string","example":"New added w item on 2025-12-16 mule 44"}}},"examples":{"warrantyitems add local":{"value":{"AreaID":"e5af2cf5-a2af-e111-b269-005056b457c1","ContractID":"FA85F3B3-7EBC-E811-A2C0-005056B431B4","Description":"Test desc for new warranty items. new desc 2025-12-16 mule 44","IsUrgent":false,"ParentWarrantyID":null,"SubAreaID":"944df9c0-c59b-ed11-a2e9-005056b4070e","Title":"New added w item on 2025-12-16 mule 44"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/data/v8.2/new_warrantyitems":{"post":{"tags":["CRM"],"summary":"get service zone","description":"get service zone","operationId":"getServiceZone","parameters":[{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;*"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"new_areaid@odata.bind":{"type":"string","example":"e5af2cf5-a2af-e111-b269-005056b457c1"},"new_details":{"type":"string","example":"Test desc for new warranty items."},"new_name":{"type":"string","example":"New added w item"},"new_notifycustomer":{"type":"boolean","example":true},"new_raisedbycustomer":{"type":"boolean","example":true},"new_subarea@odata.bind":{"type":"string","example":"944df9c0-c59b-ed11-a2e9-005056b4070e"},"new_urgent":{"type":"boolean","example":true},"new_warrantyid@odata.bind":{"type":"string","example":"795a143b-aebb-f011-bb1a-020511b32e43"},"statuscode":{"type":"number","example":100000002}}},"examples":{"get service zone":{"value":{"new_areaid@odata.bind":"e5af2cf5-a2af-e111-b269-005056b457c1","new_details":"Test desc for new warranty items.","new_name":"New added w item","new_notifycustomer":true,"new_raisedbycustomer":true,"new_subarea@odata.bind":"944df9c0-c59b-ed11-a2e9-005056b4070e","new_urgent":true,"new_warrantyid@odata.bind":"795a143b-aebb-f011-bb1a-020511b32e43","statuscode":100000002}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/attachments/e629707b-9bbe-f011-bb1a-020511b32e43/download":{"get":{"tags":["CRM"],"summary":"service warranty document download local","description":"service warranty document download local","operationId":"serviceWarrantyDocumentDownloadLocal","responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/attachments/add":{"post":{"tags":["CRM"],"summary":"add service warranty attachment local","description":"add service warranty attachment local","operationId":"addServiceWarrantyAttachmentLocal","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"Data":{"type":"string","example":"dGhpcyBpcyBhIHRlc3QgZmlsZSBjb250ZW50cy4="},"Filename":{"type":"string","example":"uploadfile4.txt"},"WarrantyItemID":{"type":"string","example":"7ba51a25-31da-f011-bb27-020511b32e31"}}},"examples":{"add service warranty attachment local":{"value":{"Data":"dGhpcyBpcyBhIHRlc3QgZmlsZSBjb250ZW50cy4=","Filename":"uploadfile4.txt","WarrantyItemID":"7ba51a25-31da-f011-bb27-020511b32e31"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/data/v8.2/annotations":{"post":{"tags":["CRM"],"summary":"add service warranty attachment","description":"add service warranty attachment","operationId":"addServiceWarrantyAttachment","parameters":[{"name":"prefer","in":"header","schema":{"type":"string","example":"odata.include-annotations&#61;*"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"documentbody":{"type":"string","example":"dGhpcyBpcyBhIHRlc3QgZmlsZSBjb250ZW50cy4="},"filename":{"type":"string","example":"uploadfile3.txt"},"isdocument":{"type":"boolean","example":true},"mimetype":{"type":"string","example":"application/txt"},"notetext":{"type":"string","example":"#CUST#"},"objectid_new_warrantyitem@odata.bind":{"type":"string","example":"/new_warrantyitems(7ba51a25-31da-f011-bb27-020511b32e41)"},"subject":{"type":"string","example":"File Upload 3"}}},"examples":{"add service warranty attachment":{"value":{"documentbody":"dGhpcyBpcyBhIHRlc3QgZmlsZSBjb250ZW50cy4=","filename":"uploadfile3.txt","isdocument":true,"mimetype":"application/txt","notetext":"#CUST#","objectid_new_warrantyitem@odata.bind":"/new_warrantyitems(7ba51a25-31da-f011-bb27-020511b32e41)","subject":"File Upload 3"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/attachments/delete/5f20afca-9bbe-f011-bb1a-020511b32e":{"delete":{"tags":["CRM"],"summary":"service warranty attachment delete local","description":"service warranty attachment delete local","operationId":"serviceWarrantyAttachmentDeleteLocal","responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/appointments":{"get":{"tags":["CRM"],"summary":"service warranty appointment local","description":"service warranty appointment local","operationId":"serviceWarrantyAppointmentLocal","parameters":[{"name":"contractID","in":"query","schema":{"type":"string","example":"92351866-23BC-E511-A840-005056B44BD9"}},{"name":"ownerCreatedOn","in":"query","schema":{"type":"string","example":"2025-01-01T14:49:00"}}],"responses":{"200":{"description":""}}}},"/api/servicewarranty/contractnotes":{"get":{"tags":["CRM"],"summary":"get notes for a contract local","description":"get notes for a contract local","operationId":"getNotesForAContractLocal","parameters":[{"name":"contractNumber","in":"query","schema":{"type":"string","example":"123"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ContractNumber":{"type":"string","example":"731472"},"NoteText":{"type":"string","example":"some test test for the description222"},"ServiceItemID":{"type":"string","example":"1e5a8abe-25d9-ef11-bcdc-0050568bec06"},"Subject":{"type":"string","example":"Test Sub for a gladsf222"},"UploadedByEmail":{"type":"string","example":"false"}}},"examples":{"get notes for a contract local":{"value":{"ContractNumber":"731472","NoteText":"some test test for the description222","ServiceItemID":"1e5a8abe-25d9-ef11-bcdc-0050568bec06","Subject":"Test Sub for a gladsf222","UploadedByEmail":"false"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/servicewarranty/notes/add":{"post":{"tags":["CRM"],"summary":"add notes for a contract local","description":"add notes for a contract local","operationId":"addNotesForAContractLocal","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"CarbonCopyList":{"type":"array","items":{"type":"string","example":"frankzhao@metricon.com.au"},"example":["frankzhao@metricon.com.au"]},"ContractNumber":{"type":"string","example":"731472"},"NoteText":{"type":"string","example":"some test test for the description 333"},"ServiceItemID":{"type":"string","example":"889e4387-4497-ef11-bcda-0050568bb0ea"},"Subject":{"type":"string","example":"Test Sub for a glads 2026_03_06 3333"},"UploadedByEmail":{"type":"string","example":"false"}}},"examples":{"add notes for a contract local":{"value":{"CarbonCopyList":["frankzhao@metricon.com.au"],"ContractNumber":"731472","NoteText":"some test test for the description 333","ServiceItemID":"889e4387-4497-ef11-bcda-0050568bb0ea","Subject":"Test Sub for a glads 2026_03_06 3333","UploadedByEmail":"false"}}}}}},"responses":{"200":{"description":""}},"security":[{"Bearer":[]}]}},"/api/integration/importcontract":{"post":{"tags":["CRM"],"summary":"integration import contract local","description":"integration import contract local","operationId":"integrationImportContractLocal","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"authorId":{"type":"number","example":1},"buildDistrict":{"type":"string","example":"182"},"buildDistrictDescription":{"type":"string","example":"VIC - 182 Metro East (Nick Harms)"},"chStage":{"type":"string","example":"construction"},"cnBrandName":{"type":"string","example":"Freedom"},"cnFacadeName":{"type":"string","example":"traditional"},"cnHouseBath":{"type":"string","example":"2"},"cnHouseBed":{"type":"string","example":"4"},"cnHouseCar":{"type":"string","example":"2"},"cnHouseName":{"type":"string","example":"Arlie 23"},"cnHouseSize":{"type":"string","example":"18"},"cnHouseTotalArea":{"type":"string","example":"150"},"cnLotAddress":{"type":"string","example":"123 test lot 5, blackburn rd mt waverley"},"cnStoreys":{"type":"string","example":"1"},"constructionContractId":{"type":"number","example":33730360},"contacts":{"type":"array","items":{"type":"object","properties":{"FirstName":{"type":"string","example":"Mans"},"IsCognitoNewUser":{"type":"boolean","example":true},"LastName":{"type":"string","example":"Laster"},"contactClientTitle":{"type":"string","example":"Mr"},"contactEmailAddress":{"type":"string","example":"Testjames@testcompany.com.au"},"contactMobilePhone":{"type":"string","example":"0999768765"},"contactPrimary":{"type":"boolean","example":true},"contactResidentialAddress":{"type":"string","example":"4 test street, kew vic"}}},"example":[{"FirstName":"Mans","IsCognitoNewUser":true,"LastName":"Laster","contactClientTitle":"Mr","contactEmailAddress":"Testjames@testcompany.com.au","contactMobilePhone":"0999768765","contactPrimary":true,"contactResidentialAddress":"4 test street, kew vic"},{"FirstName":"Goods","IsCognitoNewUser":false,"LastName":"Wild","contactClientTitle":"Mr","contactEmailAddress":"testbond@testcompnay.com.au","contactMobilePhone":"0888767876","contactPrimary":false,"contactResidentialAddress":"4 new test road kew"}]},"contractNumber":{"type":"number","example":9990000011},"contractType":{"type":"string","example":"STC"},"enabled":{"type":"boolean","example":true},"isAbc":{"type":"boolean","example":false},"leadContractId":{"type":"number","example":67080898},"opCentre":{"type":"string","example":"181"},"opCentreDescription":{"type":"string","example":"181 - Metro Central - Order Housing"},"owningState":{"type":"string","example":"VIC"},"preconContractId":{"type":"number","example":50934051},"stmbeforecontract":{"type":"boolean","example":false},"studiomAppointmentType":{"type":"string","example":"In-Studio Appointment"},"swOnly":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"object","properties":{"myTeamEmail":{"type":"string","example":"testcsc@metricon.com.au"},"myTeamMobile":{"type":"string","example":"0999123456"},"myTeamName":{"type":"string","example":"test csc"},"myTeamPosition":{"type":"string","example":"CSC"}}},"example":[{"myTeamEmail":"testcsc@metricon.com.au","myTeamMobile":"0999123456","myTeamName":"test csc","myTeamPosition":"CSC"}]}}},"examples":{"integration import contract local":{"value":{"authorId":1,"buildDistrict":"182","buildDistrictDescription":"VIC - 182 Metro East (Nick Harms)","chStage":"construction","cnBrandName":"Freedom","cnFacadeName":"traditional","cnHouseBath":"2","cnHouseBed":"4","cnHouseCar":"2","cnHouseName":"Arlie 23","cnHouseSize":"18","cnHouseTotalArea":"150","cnLotAddress":"123 test lot 5, blackburn rd mt waverley","cnStoreys":"1","constructionContractId":33730360,"contacts":[{"FirstName":"Mans","IsCognitoNewUser":true,"LastName":"Laster","contactClientTitle":"Mr","contactEmailAddress":"Testjames@testcompany.com.au","contactMobilePhone":"0999768765","contactPrimary":true,"contactResidentialAddress":"4 test street, kew vic"},{"FirstName":"Goods","IsCognitoNewUser":false,"LastName":"Wild","contactClientTitle":"Mr","contactEmailAddress":"testbond@testcompnay.com.au","contactMobilePhone":"0888767876","contactPrimary":false,"contactResidentialAddress":"4 new test road kew"}],"contractNumber":9990000011,"contractType":"STC","enabled":true,"isAbc":false,"leadContractId":67080898,"opCentre":"181","opCentreDescription":"181 - Metro Central - Order Housing","owningState":"VIC","preconContractId":50934051,"stmbeforecontract":false,"studiomAppointmentType":"In-Studio Appointment","swOnly":false,"teams":[{"myTeamEmail":"testcsc@metricon.com.au","myTeamMobile":"0999123456","myTeamName":"test csc","myTeamPosition":"CSC"}]}}}}}},"responses":{"200":{"description":""}}}},"/api/integration/updatecontacts":{"post":{"tags":["CRM"],"summary":"integration update contact local","description":"integration update contact local","operationId":"integrationUpdateContactLocal","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"Address":{"type":"string","example":"708 Residential Street, Suburb, 4000"},"ContractNumber":{"type":"string","example":"700008"},"EmailAddress":{"type":"string","example":"700008@annix.com.au"},"FirstName":{"type":"string","example":"aaa8"},"IsPrimary":{"type":"boolean","example":true},"LastName":{"type":"string","example":"test8"},"PhoneNumber":{"type":"string","nullable":true,"example":"0111 222 708"},"Title":{"type":"string","example":"MRS"}}},"example":[{"Address":"708 Residential Street, Suburb, 4000","ContractNumber":"700008","EmailAddress":"700008@annix.com.au","FirstName":"aaa8","IsPrimary":true,"LastName":"test8","PhoneNumber":"0111 222 708","Title":"MRS"},{"Address":"708 Residential Street, Suburb, 4000","ContractNumber":"700008","EmailAddress":"bbb8test8@metricon.com.au","FirstName":"bbb8","IsPrimary":false,"LastName":"test8","PhoneNumber":null,"Title":"MRS"}]},"examples":{"integration update contact local":{"value":[{"Address":"708 Residential Street, Suburb, 4000","ContractNumber":"700008","EmailAddress":"700008@annix.com.au","FirstName":"aaa8","IsPrimary":true,"LastName":"test8","PhoneNumber":"0111 222 708","Title":"MRS"},{"Address":"708 Residential Street, Suburb, 4000","ContractNumber":"700008","EmailAddress":"bbb8test8@metricon.com.au","FirstName":"bbb8","IsPrimary":false,"LastName":"test8","PhoneNumber":null,"Title":"MRS"}]}}}}},"responses":{"200":{"description":""}}}},"/api/integration/changeowner":{"post":{"tags":["CRM"],"summary":"integration change owner local","description":"integration change owner local","operationId":"integrationChangeOwnerLocal","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"Address":{"type":"string","example":"test address"},"ContractNumber":{"type":"string","example":"-9999"},"EmailAddress":{"type":"string","example":"fsdf@123.com"},"FirstName":{"type":"string","example":"Test"},"IsPrimary":{"type":"boolean","example":true},"LastName":{"type":"string","example":"LastTest"},"PhoneNumber":{"type":"string","example":"043454565"},"Title":{"type":"string","example":"Mr"}}},"examples":{"integration change owner local":{"value":{"Address":"test address","ContractNumber":"-9999","EmailAddress":"fsdf@123.com","FirstName":"Test","IsPrimary":true,"LastName":"LastTest","PhoneNumber":"043454565","Title":"Mr"}}}}}},"responses":{"200":{"description":""}}}}},"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Bearer Token","name":"Authorization","in":"header"}}},"security":[{"Bearer":[]}],"tags":[{"name":"MID/Finance"},{"name":"ClickHomeApi"},{"name":"CognitoServices"},{"name":"CRM"}]}