LawVu Invoices (1.0)

Apis for invoice resources

Download OpenAPI description
LawVu Invoices.openapi.json
LawVu Invoices.openapi.yaml
Languages
Servers
Sandbox API
https://api-sandbox.lawvu.com/invoice-apis/
Production API
https://api.lawvu.com/invoice-apis/

Invoices

Operations

Get invoices

Request

Get invoices

Query
skipinteger(int32)

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

filtering.fieldstring or null

Field to filter by (optional)

filtering.operatorstring

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"
filtering.valuestring or null

Value to filter by (optional)

sorting.directionstring

Set the sorting direction

Options:

  • asc
  • desc

Enum"asc""desc"
sorting.fieldstring or null

Set the sorting fields

takeinteger(int32)

Format - int32. The maximum number of invoices to return

Default: 50

Default 50
No request payload

Responses

Success

Body
dataArray of objects or null(Invoice)

Represents a single page of processed data.

totalinteger(int32)

The total number of records available.

Response
null

Update invoice

Request

Update invoice

Path
invoiceIdinteger(int32)required

Format - int32. The invoice Id

Body

The update definition (json patch)

Array [
valueobject or null
pathstring or null
opstring or null
fromstring or null
]
[
  {
    "value": {},
    "path": "string",
    "op": "string",
    "from": "string"
  }
]

Responses

Success

Retrieve Invoice Recipients

Request

Retrieve Invoice Recipients

No request payload

Responses

Success

Body
Array [
idinteger or null(int32)
namestring or null
addressLine1string or null
addressLine2string or null
addressLine3string or null
taxTypestring or null

Options:

  • GST
  • TAX
  • VAT
Enum"GST""TAX""VAT"
taxNumberstring or null
contactNamestring or null
contactPhonestring or null
contactEmailstring or null
]
Response
[
  {
    "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"
  }
]