Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Overview

This document details the specification of the myBuildings API import of Creditor invoices. Based on the data returned from the API Call new Creditor Invoices and GL Journals will be created in Synergetic Database and Postings will be shown under Creditor Invoice Entry in Synergetic.

Fees and Subscription Model:

A one-off implementation fee will be charged. This will cover the one-off effort and will depend on the amount of Consultant time requiredValid Creditor provided. Tasks covered:

  1. Implementation of the Synergetic SQL Agent job, testing

  2. Consulting time if client requires help inputting/matching GL codes in myBuildings and/or Synergetic

An ongoing Monthly fee will also be charged. This will cover the costs for any additional expected support (little to none, in reality) and will add an extra ongoing revenue stream. the monthly fee will reflect the time saved by Finance staff from having to manually input myBuildings Invoices into Synergetic.

Clients will be prompted to reach out to their CSM if they would like this feature implemented.

Sample JSON Payload: 

Code Block
languagejson
{"Invoices":[
    {
     "WorkRequestID":11603508,
     "BuildingName":"Elliot Hall",
     "ThirdPartySystem_BuildingID":"6",
     "JobCode":"ELLIOT2300207",
     "InvoiceStatus":"Approved for Processing",
     "ContractorName":"Triangle Fire Protection Ltd",
     "ThirdPartySystem_ContractorID":"",
     "invoiceamount":1539.20,
     "InvoiceTax":230.88,
     "InvoiceTotal":1770.08,
     "InvoiceDate":"2023-10-31T00:00:00",
     "InvoiceNumber":"73596",
     "InvoiceDescription":"MAIN BLOCK/ELLIOT",
         "InvoiceImageURL":"https://mybuildings.blob.core.windows.net/storage/Core/SiteDownloadFiles/719/ContractorInvoices/2023/11/951e84fad3644b4bb5d8.pdf",
         "DateUploaded":"2023-11-06T03:27:00",
         "AccountCodeBreakdown":[
                    {
                    "AccountNumber":"2810-10-5300",
                    "Percentage":100.0,
                    "Amount":1539.20,
                    "TaxAmount":230.88,
                    "TotalIncludingTax":1770.08
                    }
                    ]
        },
        {"WorkRequestID":11567457,
        "BuildingName":"Elizabeth MacFarlan Centre",
        "ThirdPartySystem_BuildingID":"21",
        "JobCode":"EMC2300186",
        "InvoiceStatus":"Approved for Processing",
        "ContractorName":"Advantage Door Services”,
        "ThirdPartySystem_ContractorID":"",
        "invoiceamount":596.70,
        "InvoiceTax":89.50,
        "InvoiceTotal":686.20,
        "InvoiceDate":"2023-10-31T00:00:00",
        "InvoiceNumber":"135022",
        "InvoiceDescription":"Door is constantly opening and closing a",
        "InvoiceImageURL":"https://mybuildings.blob.core.windows.net/storage/Core/SiteDownloadFiles/719/ContractorInvoices/2023/11/9df18f247d934c539525.pdf",
        "DateUploaded":"2023-11-09T01:33:00",
        "AccountCodeBreakdown":[
                    {
                    "AccountNumber":"2040-10-5105",
                    "Percentage":100.0,
                    "Amount":596.70,
                    "TaxAmount":89.50,
                    "TotalIncludingTax":686.20
                    }
                    ]
        }
      ]
},"RecordsReturned":"2"}';

...

Field Name

SQL Data Type

Mandatory

Description

NewStatusID

Integer

 

 

 

 

 

 

 

Yes

New StatusID. If not passed in (or -1), status will not be altered.

Possible statuses available from this API are as follows:

1: New

2: In Progress

3: On Hold

4: Complete

6: Contractor Complete

Comment

String

Yes

Comment to record against each request (added to Work Notes)

WorkRequestID

Integer

No (Yes in our use case)

Which work request to update

User stories:

Valid Creditor provided.

  1. New creditor payment approved in myBuildings

  2. Synergetic agent job will be running on an hourly basis, and picks up an unprocessed invoice (using myBuildings invoices API)

  3. Synergetic creditor identified

  4. New invoice created in Synergetic

...