LawVu Invoices (1.0)

Download OpenAPI specification:Download

Apis for invoice resources

Invoices

Get invoices

Get invoices

Request
query Parameters
skip
integer <int32>

Format - int32. The number of invoices to skip (used for paging)

filtering.field
string or null

Field to filter by (optional)

filtering.operator
string

Operator used for filtering (optional)

Options:

  • eq
  • neq
  • lt
  • lte
  • gt
  • gte
  • startswith
  • endswith
  • contains
  • doesnotcon
  • isnull

Enum: "eq" "neq" "lt" "lte" "gt" "gte" "startswith" "endswith" "contains" "doesnotcon" "isnull"
filtering.value
string or null

Value to filter by (optional)

sorting.direction
string

Set the sorting direction

Options:

  • asc
  • desc

Enum: "asc" "desc"
sorting.field
string or null

Set the sorting fields

take
integer <int32>
Default: 50

Format - int32. The maximum number of invoices to return

Default: 50

Responses
200

Success

get/v1/invoices
Response samples 
null

Update invoice

Update invoice

Request
path Parameters
invoiceId
required
integer <int32>

Format - int32. The invoice Id

Request Body schema:

The update definition (json patch)

Array
value
object or null
path
string or null
op
string or null
from
string or null
Responses
200

Success

patch/v1/invoices/{invoiceId}
Request samples
[
  • {
    }
]

Retrieve Invoice Recipients

Retrieve Invoice Recipients

Responses
200

Success

get/v1/invoices/recipients
Response samples 
[
  {
    "id": 1,
    "name": "Jeff",
    "addressLine1": "123 Sesame Street",
    "addressLine2": "Narnia",
    "addressLine3": "Antarctica",
    "taxType": "GST",
    "taxNumber": "4",
    "contactName": "Bill",
    "contactPhone": "17",
    "contactEmail": "emailaddress@gmail.com"
  },
  {
    "id": 2,
    "name": "Steve",
    "addressLine1": "124 Sesame Street",
    "addressLine2": "South Narnia",
    "addressLine3": "Antarctica",
    "taxType": "TAX",
    "taxNumber": "40",
    "contactName": "Stan",
    "contactPhone": "71",
    "contactEmail": "anotheremailaddress@gmail.com"
  }
]