v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Invoices

Get an invoice

Retrieves a specified invoice.

get/matters/{matterId}/invoices/{invoiceId}

Path parameters

matterIdstring required

invoiceIdstring required

Response

When request is successful. Returns a 'Invoice' object.

hrefstring nullable

relationstring nullable

methodstring nullable

idstring nullable

The unique identifier of the invoice.

versionIdstring nullable

The unique identifier representing the current version of the invoice.

matterIdstring nullable

The unique identifier of the matter this invoice belongs to.

lastUpdatedByUserIdstring nullable

The unique identifier of the user who last updated the invoice.

descriptionstring nullable

A short description of the invoice contents or purpose.

status0 | 1 | 2 | 3 | 4

The status of the invoice.

Possible values: Draft = 0, Final = 1, Paid = 2, Deleted = 3 or Void = 4.

invoiceNumberinteger nullable

The sequential number assigned to the invoice.

invoiceTitlestring nullable

The main title of the invoice.

invoiceTitleLine2string nullable

The optional second line of the invoice title.

issuedDatestring date-time

The date the invoice was issued.

dueDatestring date-time

The date by which payment for the invoice is due.

paidDatestring date-time

The date the invoice was fully paid.

Only populated if the invoice has been paid in full.

waivedboolean

Indicates whether the invoice has been waived.

Example response

{
  "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
  }
}