Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Invoices

Get all invoices

get/1.0/invoices

Query parameters

dateOfIssue.eqstring date
Example:2023-03-28

Filter by date of issue (equals).

dateOfIssue.gtstring date
Example:2023-03-28

Filter by date of issue greater than.

dateOfIssue.gestring date
Example:2023-03-28

Filter by date of issue greater than or equal.

dateOfIssue.ltstring date
Example:2023-03-28

Filter by date of issue less than.

dateOfIssue.lestring date
Example:2023-03-28

Filter by date of issue less than or equal.

dueDate.eqstring date
Example:2023-03-28

Filter by due date (equals).

dueDate.gtstring date
Example:2023-03-28

Filter by due date greater than.

dueDate.gestring date
Example:2023-03-28

Filter by due date greater than or equal.

dueDate.ltstring date
Example:2023-03-28

Filter by due date less than.

dueDate.lestring date
Example:2023-03-28

Filter by due date less than or equal.

amount.eqnumber double
Example:1000

Filter by amount (equals).

amount.gtnumber double
Example:1000

Filter by amount greater than.

amount.genumber double
Example:1000

Filter by amount greater than or equal.

amount.ltnumber double
Example:1000

Filter by amount less than.

amount.lenumber double
Example:1000

Filter by amount less than or equal.

amountOutstanding.eqnumber double
Example:500

Filter by amount outstanding (equals).

amountOutstanding.gtnumber double
Example:500

Filter by amount outstanding greater than.

amountOutstanding.genumber double
Example:500

Filter by amount outstanding greater than or equal.

amountOutstanding.ltnumber double
Example:500

Filter by amount outstanding less than.

amountOutstanding.lenumber double
Example:500

Filter by amount outstanding less than or equal.

amountPaid.eqnumber double
Example:500

Filter by amount paid (equals).

amountPaid.gtnumber double
Example:500

Filter by amount paid greater than.

amountPaid.genumber double
Example:500

Filter by amount paid greater than or equal.

amountPaid.ltnumber double
Example:500

Filter by amount paid less than.

amountPaid.lenumber double
Example:500

Filter by amount paid less than or equal.

amountWrittenOff.eqnumber double
Example:500

Filter by amount written off (equals).

amountWrittenOff.gtnumber double
Example:500

Filter by amount written off greater than.

amountWrittenOff.genumber double
Example:500

Filter by amount written off greater than or equal.

amountWrittenOff.ltnumber double
Example:500

Filter by amount written off less than.

amountWrittenOff.lenumber double
Example:500

Filter by amount written off less than or equal.

createdAt.gtinteger
Example:1625164800000

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.eqinteger
Example:1625164800000

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.ltinteger
Example:1625164800000

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.geinteger
Example:1625164800000

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.leinteger
Example:1625164800000

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.eqstring

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.oneOfstring
Example:1,2,3

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.noneOfstring
Example:1,2,3

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.eqstring
Example:INV-2024-001

Filter by invoice number (equals).

invoiceNumber.cnstring
Example:INV

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.ncstring
Example:US-21

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.eqstring
Example:DRAFT

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

status.oneOfstring
Example:DRAFT,PAID

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

status.noneOfstring
Example:DRAFT,PAID

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

pageSizenumber
Example:100

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.

pageTokenstring
Example:59c12a42-dd10-11ed-afa1-0242ac120002

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.

includeFieldsstring[]

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.

includeAllFieldsboolean
Example:true

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'createdAt' | 'invoiceNumber'

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

sortOrder'ASC' | 'DESC'

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

match'all' | 'any'

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

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "invoiceId": 201,
      "invoiceNumber": "INV-2024-001",
      "dateOfIssue": "2023-03-28",
      "dueDate": "2023-03-28",
      "currency": "USD",
      "status": "DRAFT",
      "amount": 1000.25,
      "tax": 100.25,
      "subTotal": 1000.25,
      "amountOutstanding": 500.25,
      "amountPaid": 500.25,
      "amountWrittenOff": 500.25,
      "notes": "This is the default address",
      "createdAt": 1681319726000,
      "updatedAt": 1681319726000,
      "createdBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "updatedBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "company": {
        "companyId": 201,
        "companyName": "Acme Inc",
        "companyUrl": "https://www.acme.com"
      },
      "projects": [
        {
          "projectId": 201,
          "projectName": "Acme onboarding"
        }
      ],
      "fields": [
        {
          "fieldId": 201,
          "fieldLabel": "MRR",
          "fieldValueLabel": "1000"
        }
      ],
      "attachments": [
        {
          "attachmentId": 201,
          "attachmentName": "test_upload.png",
          "createdAt": 1680616174929,
          "location": "https://rocketlane.com/attachments/0/db83eb19-0bbf-4a37-b4e2-cd1b96708c73/test_upload.png",
          "thumbLocation": "https://rocketlane.com/attachments/0/db83eb19-0bbf-4a37-b4e2-cd1b96708c73/thumb_test_upload.png"
        }
      ]
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/invoices?pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}