--- title: "Get all invoices" method: GET path: "/1.0/invoices" tags: ["Invoices"] --- # Get all invoices `GET /1.0/invoices` ## Query parameters - `dateOfIssue.eq` string, date - `dateOfIssue.gt` string, date - `dateOfIssue.ge` string, date - `dateOfIssue.lt` string, date - `dateOfIssue.le` string, date - `dueDate.eq` string, date - `dueDate.gt` string, date - `dueDate.ge` string, date - `dueDate.lt` string, date - `dueDate.le` string, date - `amount.eq` number, double - `amount.gt` number, double - `amount.ge` number, double - `amount.lt` number, double - `amount.le` number, double - `amountOutstanding.eq` number, double - `amountOutstanding.gt` number, double - `amountOutstanding.ge` number, double - `amountOutstanding.lt` number, double - `amountOutstanding.le` number, double - `amountPaid.eq` number, double - `amountPaid.gt` number, double - `amountPaid.ge` number, double - `amountPaid.lt` number, double - `amountPaid.le` number, double - `amountWrittenOff.eq` number, double - `amountWrittenOff.gt` number, double - `amountWrittenOff.ge` number, double - `amountWrittenOff.lt` number, double - `amountWrittenOff.le` number, double - `createdAt.gt` integer - `createdAt.eq` integer - `createdAt.lt` integer - `createdAt.ge` integer - `createdAt.le` integer - `companyId.eq` string - `companyId.oneOf` string - `companyId.noneOf` string - `invoiceNumber.eq` string - `invoiceNumber.cn` string - `invoiceNumber.nc` string - `status.eq` string - `status.oneOf` string - `status.noneOf` string - `pageSize` number - `pageToken` string - `includeFields` string[] - `includeAllFields` boolean - `sortBy` 'createdAt' | 'invoiceNumber' - `sortOrder` 'ASC' | 'DESC' - `match` 'all' | 'any' ## Response `200` The requested action was successfully executed. - ExampleAPIResponseInvoices - `data` InvoicePublicAPIResponseEntity[] — Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response. - `invoiceId` integer — Unique identifier of the invoice - `invoiceNumber` string — Invoice number assigned to this invoice - `dateOfIssue` string — Date when the invoice was issued. The format for the issue date is _YYYY-MM-DD_ - `dueDate` string — Due date for the invoice payment. The format for the due date is _YYYY-MM-DD_ - `currency` 'AFN' | 'ALL' | 'DZD' | 'ARS' | 'AMD' | 'AUD' | 'AZN' | 'BHD' | 'BDT' | 'BYN' | 'BZD' | 'BOB' | 'BAM' | 'BWP' | 'BRL' | 'GBP' | 'BND' | 'BGN' | 'BIF' | 'KHR' | 'CAD' | 'CVE' | 'XAF' | 'CLP' | 'CNY' | 'COP' | 'KMF' | 'CDF' | 'CRC' | 'HRK' | 'CZK' | 'DKK' | 'DJF' | 'DOP' | 'EGP' | 'ERN' | 'EEK' | 'ETB' | 'EUR' | 'GEL' | 'GHS' | 'GTQ' | 'GNF' | 'HNL' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'IRR' | 'IQD' | 'ILS' | 'JMD' | 'JPY' | 'JOD' | 'KZT' | 'KES' | 'KWD' | 'LVL' | 'LBP' | 'LYD' | 'LTL' | 'MOP' | 'MKD' | 'MGA' | 'MYR' | 'MUR' | 'MXN' | 'MDL' | 'MAD' | 'MZN' | 'MMK' | 'NAD' | 'NPR' | 'TWD' | 'NZD' | 'NIO' | 'NGN' | 'NOK' | 'OMR' | 'PKR' | 'PAB' | 'PYG' | 'PEN' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'RWF' | 'SAR' | 'RSD' | 'SGD' | 'SOS' | 'ZAR' | 'KRW' | 'LKR' | 'SDG' | 'SEK' | 'CHF' | 'SYP' | 'TZS' | 'THB' | 'TOP' | 'TTD' | 'TND' | 'TRY' | 'USD' | 'UGX' | 'UAH' | 'AED' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'XOF' | 'YER' | 'ZMK' | 'ZWL' — Currency of the invoice amount - `status` string — Current status of the invoice - `amount` number — Total amount of the invoice including tax - `tax` number — Tax amount applied to the invoice - `subTotal` number — Total amount of the invoice excluding tax - `amountOutstanding` number — Balance amount remaining to be paid - `amountPaid` number — Total amount paid for this invoice - `amountWrittenOff` number — Total amount written off for this invoice - `notes` string — Notes or additional information about the invoice - `createdAt` integer — Timestamp when the invoice was created - `updatedAt` integer — Timestamp when the invoice was last updated - `createdBy` ProjectVendorUserPublicAPI — The team member who last updated the invoice - `emailId` string — The team members email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `updatedBy` ProjectVendorUserPublicAPI — The team member who last updated the invoice - `emailId` string — The team members email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `company` CustomerCompanyProjectPublicResponse — Company details for the invoice - `companyId` integer — The unique identifier for the customer company. - `companyName` string — The customer company name. - `companyUrl` string — The URL of the client's website. Unless explicitly stated, the value for this field can be left blank. - `projects` InvoiceProjectPublicAPIResponseEntity[] — List of projects mapped to this invoice - `projectId` integer — The project's unique, system-generated identifier, which can be used to identify the project globally. - `projectName` string — The name of the project. - `fields` InvoiceFieldPublicResponseEntity[] — Fields lists the custom invoice fields whose values were provided during invoice creation or updated later. Refer these [examples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know more about different types of custom fields returned in response. - `fieldId` integer — The unique identifier for the field. - `fieldLabel` string — The label of the field. - `fieldValue` object — The `fieldValue` is the value provided while creation or updating. The fieldValue can be a string, an integer, or an array and it must match the type of the field. Refer [e xamples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how each `field_type` is associated with task. - `fieldValueLabel` string — The `fieldValueLabel` is the value provided while creation or updating in a String format. - `attachments` InvoiceAttachmentPublicAPIResponseEntity[] — List of attachments associated with the invoice - `attachmentId` integer — Attachment ID - `attachmentName` string — Attachment Name - `createdAt` integer — Attachment Created timestamp - `location` string — Attachment Location - `thumbLocation` string — Attachment Thumb location - `visibility` boolean — Attachment Visibility - `pagination` ExamplePaginationInvoices — Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages. - `pageSize` integer — Denotes the page size mentioned in the current request (limit). It defaults to 100 if left blank. - `hasMore` boolean — Tells us if there is more content. - `totalRecordCount` integer — Denotes the total resources matching the filters. - `nextPage` string — Denotes an API URL, which can be conveniently called to perform the subsequent search call to get to the next page. - `nextPageToken` string — Denotes a unique token that points to the next page of resources. To get results from subsequent pages, you can use the nextPageToken available in the response under pagination. This token is valid for 15 minutes. ## Other responses - `400` — This 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. - `401` — You 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. --- [API](https://skmtc.net/rocketlane/apis/rocketlane-api.md) · [All operations](https://skmtc.net/rocketlane/apis/rocketlane-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocketlane/rocketlane-api/versions/1e8ba619e741/schema)