LIlight
v1 - Invoice Payables

List invoice payable details

Returns a paginated list of invoice payables. Defaults to createdAt:desc when sort is omitted. updatedAt, approverUserId, userId and hasWithholding can be filtered on but are not returned in the response, and updatedAt cannot be sorted by. Resolve vendorId against GET /v1/vendors/{vendorId} for the vendor's details beyond vendorName. Filter on documentStatus:in:POSTED|PARTIALLY_CLEARED to list the bills that still owe money; a state filter cannot express that, because the scheduled and payment-pending bills owe money too. There is no partial-match operator, so a filter on a text field such as vendorName, description or invoiceNumber matches the stored value exactly and returns an empty page when nothing matches.

get/v1/invoice-payables

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Query parameters

sortstring

Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

Available directions: asc, desc.

Available fields: amount, canceledAt, createdAt, description, dueDate, invoiceNumber, issuedDate, ocrCompletedAt, paymentAt, senderEmail, state, vendorName.

Example:amount:desc,createdAt:asc
filterstring

Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

  • For in and not_in operators, provide multiple values separated by the pipe character (|).

Available fields: amount, approverUserId, companyEntityId, createdAt, description, documentStatus, dueDate, hasWithholding, id, invoiceNumber, issuedDate, paymentAt, senderBankAccountId, state, type, updatedAt, userId, vendorId, vendorName.

These fields accept only a subset of the operators: hasWithholding (eq, ne).

Example:state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null
limitinteger

Maximum number of items to return. Default is 50, maximum is 200.

cursorstring

The cursor position to start returning results from. To opt-in into cursor-based pagination, provide 0 for the initial request. For subsequent requests, use nextCursor and prevCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually.

Response

default response

hasMoreboolean

Boolean flag indicating if there are more records available

nextCursorstring nullable

Cursor for fetching the next page

prevCursorstring nullable

Cursor for fetching the previous page

Example response

{
  "records": [
    {
      "currency": "USD"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.