Get all invoices

get

https://api.rocketlane.com/api/1.0/invoices

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

dateOfIssue.eq

date

Filter by date of issue (equals).

dateOfIssue.gt

date

Filter by date of issue greater than.

dateOfIssue.ge

date

Filter by date of issue greater than or equal.

dateOfIssue.lt

date

Filter by date of issue less than.

dateOfIssue.le

date

Filter by date of issue less than or equal.

dueDate.eq

date

Filter by due date (equals).

dueDate.gt

date

Filter by due date greater than.

dueDate.ge

date

Filter by due date greater than or equal.

dueDate.lt

date

Filter by due date less than.

dueDate.le

date

Filter by due date less than or equal.

amount.eq

double

Filter by amount (equals).

amount.gt

double

Filter by amount greater than.

amount.ge

double

Filter by amount greater than or equal.

amount.lt

double

Filter by amount less than.

amount.le

double

Filter by amount less than or equal.

amountOutstanding.eq

double

Filter by amount outstanding (equals).

amountOutstanding.gt

double

Filter by amount outstanding greater than.

amountOutstanding.ge

double

Filter by amount outstanding greater than or equal.

amountOutstanding.lt

double

Filter by amount outstanding less than.

amountOutstanding.le

double

Filter by amount outstanding less than or equal.

amountPaid.eq

double

Filter by amount paid (equals).

amountPaid.gt

double

Filter by amount paid greater than.

amountPaid.ge

double

Filter by amount paid greater than or equal.

amountPaid.lt

double

Filter by amount paid less than.

amountPaid.le

double

Filter by amount paid less than or equal.

amountWrittenOff.eq

double

Filter by amount written off (equals).

amountWrittenOff.gt

double

Filter by amount written off greater than.

amountWrittenOff.ge

double

Filter by amount written off greater than or equal.

amountWrittenOff.lt

double

Filter by amount written off less than.

amountWrittenOff.le

double

Filter by amount written off less than or equal.

createdAt.gt

int64

You can use this param to provide an epoch milli value and the responses will contain invoices whose date are greater than the given invoice created date.

createdAt.eq

int64

You can use this param to provide an epoch milli value and the responses will contain exact matches of invoices that match the given invoice created date.

createdAt.lt

int64

You can use this param to provide an epoch milli value and the responses will contain invoices whose date are less than the given invoice created date.

createdAt.ge

int64

You can use this param to provide an epoch milli value and the responses will contain invoices whose date are greater than or equal to the given invoice created date.

createdAt.le

int64

You can use this param to provide an epoch milli value and the responses will contain invoices whose date are less than or equal to the given invoice created date.

companyId.eq

string

You can use this param to provide a customer company id and the responses will contain exact matches of invoices that match the given customer company id.

companyId.oneOf

string

You can use this param to provide customer company ids separated by commas and the responses will contain matches of invoices that match any of the given customer company id.

companyId.noneOf

string

You can use this param to provide customer company id separated by commas and the responses will not contain matches of invoices that match the given set of customer company id.

invoiceNumber.eq

string

Filter by invoice number (equals).

invoiceNumber.cn

string

You can use this param to specify some text and the responses will contain invoices that contain the given text in their invoice number

invoiceNumber.nc

string

You can use this param to specify some text and the responses will contain invoices that DO NOT contain the given text in their invoice number

status.eq

string

You can use this param to provide status and the responses will contain invoices that are equal to the given status

status.oneOf

string

You can use this param to provide statuses and the responses will contain invoices that match one of the given statuses

status.noneOf

string

You can use this param to provide statuses and the responses will contain invoices that matches none of the given statuses

pageSize

number

≥ 0

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageToken

string

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFields

array of strings

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeFields

includeAllFields

boolean

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

sortBy

string

enum

You can use the sortBy param to sort the responses by the given field.

Allowed:

sortOrder

string

enum

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

Allowed:

match

string

enum

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

Allowed:

Responses

200The requested action was successfully executed.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.