Billing API

Examples - GET invoices

OVERVIEW

Using the GET method, you can retrieve an invoice available for the current user. The request returns information about the invoice that is described in schema. In order to return complex properties (e.g. taxes, adjustments, etc.), $expand parameter has to be used. Please refer to examples below.

$expand parameters examples

$expand invoice file info - use to get additional info about this file

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand=invoiceFileInfo
"invoiceFileInfo": {
        "fileName": "Invoice__gener_98BI_attach_01.txt",
        "size": 1333,
        "uploadedDateTime": "2021-03-15T04:05:37.27",
        "md5Hash": "4F033785D8AE31127877C25DE4777B28",
        "downloadLink": "Y:\\TrackerData\\d5bf2e99-a65b-420c-b05e-70ccd7d35251.txt"
    },

 

$expand adjustments - use to get invoice adjustment details

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand=adjustments
"adjustments": [
  {
    "type": "fia",
    "amount": -55,
    "adjusterID": "53509",
    "adjusterName": "CoSysAdminFirst CoSysAdminLast",
    "dateTime": 2021-11-11T03:13:45.233",
    "reason": "Fee - Excessive time",
    "comment": "please see billing guidelines - hours"
    "lineItemNumber": "1"
   }
 ]

 

$expand attachments - use to see information on type of attachment

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand=attachments
"attachments": [
        {
            "id": 81229,
            "typeId": 60901,
            "description": "descr1",
            "fileInfo": null
        },
        {
            "id": 81231,
            "typeId": 80864,
            "description": "descr2",
        }
     ]    

 

$expand taxes - use to get additional information on taxes

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand=taxes
"taxes": [
  {
    "taxType": "gst"
    "subjectToTax": 112,
    "taxRate": 0.1,
    "taxAmount": 11.2
  }
]

 

$expand attachments file info - use to get additional info on the attachment file

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand=Attachments($expand=fileInfo)
"fileInfo": {
                "fileName": "upload_payment_2 (1).csv",
                "size": 290,
                "uploadedDateTime": "2021-03-15T04:05:34.737",
                "md5Hash": "3630C82A0DBFE58658F5C62166A17182",
                "downloadLink": "Y:\\TrackerData\\ef02e567-3965-458b-8118-0adbef875702.csv"
            },

 

$expand both info and attachment file info - use to get additional detail for invoice file info and attachment file info

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand=invoiceFileInfo, attachments($expand=fileInfo)

 

$expand taxes and adjustments - use to get additional detail for taxes and adjustments

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand= taxes, adjustments

 

$expand attachments, taxes - use to get additional detail for attachements and taxes

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand=attachments, taxes

 

$expand all properties - use to get additional detail for all properties

https://api.thomsonreuters.com/legal-tracker/billing-api/v1/invoices/81218?$expand=invoiceFileInfo, attachments($expand=fileInfo), taxes, adjustments
Last Updated: Dec 06,2021