v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Invoices

Get invoices

Returns a list of invoices for the specified matter.

get/matters/{matterId}/invoices

Path parameters

matterIdstring required

The unique identifier of the matter that the invoice belongs to.

Query parameters

LastUpdatedstring date-time
Example:2022-04-23T14:00:00Z

Returns items updated since the specified date and time.

UpdatedSinceinteger

Returns items updated since a specified time (.net ticks representation of the UTC datetime).

Offsetinteger
Limitinteger

Response

When request is successful. Returns a paged collection of 'Invoice' objects.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
offsetinteger nullable
limitinteger nullable
sizeinteger

Example response

{
  "value": [
    {
      "id": "16567e88-784c-470e-8952-e5a70fe2eb0c",
      "versionId": "39ffde97-eeeb-4747-bb8f-7c7c10b3c985",
      "matterId": "6398a045-509e-49a2-9268-bb8231fa9340",
      "lastUpdatedByUserId": "5fc5ee85-6643-4623-b019-a0dccceafe47",
      "description": "Services provided.",
      "invoiceNumber": 10001,
      "invoiceTitle": "My First Invoice",
      "invoiceTitleLine2": "Subtitle",
      "issuedDate": "2022-09-16T00:00:00+00:00",
      "dueDate": "2022-09-25T00:00:00+00:00",
      "paidDate": "2022-09-20T00:00:00+00:00",
      "discount": {
        "fixedDiscount": 100,
        "percentage": 10,
        "description": "Friend of the Firm"
      },
      "surcharge": {
        "fixedSurcharge": 100,
        "description": "Late Payment Fee"
      },
      "invoiceTotals": {
        "paid": 100,
        "billed": 200,
        "unpaid": 100,
        "unpaidExcInterest": 100,
        "total": 100,
        "tax": 10,
        "feeTotal": 100,
        "writtenOffFeeTotal": 100,
        "expenseTotal": 100,
        "writtenOffExpenseTotal": 180
      }
    }
  ]
}