> ## Documentation Index > Fetch the complete documentation index at: https://docs.splose.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a paged array of invoices > Get a paged array of invoices ## OpenAPI ````yaml get /invoices openapi: 3.0.0 info: version: 1.0.0 title: splose public API description: "\nWelcome to the splose API documentation. splose serves as a comprehensive Allied Health & NDIS practice management software designed to streamline administrative tasks and foster the growth of your practice.\n\n# Introduction\nThe splose API follows a REST architectural style, offering JSON-encoded responses, standard HTTP response codes, easily understandable resource-oriented URLs, and robust authentication mechanisms.\n\n# Authentication\n### API Key Authentication\nThe splose API employs API keys for request authentication. Workspace owners can apply for and manage API keys through the splose dashboard. It's crucial to safeguard the API key, as it grants the same permissions as the associated user.\n\n### Bearer Authentication\nAuthentication for API access is achieved via Bearer Authentication. Include the API key in the request header using the format: `Authorization: Bearer your_api_key`.\n\n### Secure Communication\nAll API requests must be conducted over HTTPS. Requests made over plain HTTP will not succeed. Additionally, unauthenticated API requests will result in failure.\n\n# Rate limit\nThere are limits to the number of API calls that your application can make with one API key.\n\n+ Minute Limit: 60 calls per minute\n\n# Error\nsplose uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. \nCodes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with splose's servers.\n\nError types:\n+ 400 - Bad request: the request failed due to missing or invalid parameters.\n+ 401 - Unauthorized: No valid API key provided.\n+ 404 - Not Found: \tThe requested resource doesn't exist.\n+ 429 - Too Many Requests: Too many requests hit the API too quickly.\n+ 500 - Internal Server Error : Something went wrong on splose's end.\n\n# Datetime\nAll datetime values provided in request parameters and responses are in Coordinated Universal Time (UTC). The accepted datetime formats are outlined below:\n+ 2023-07-01\n+ 2023-07-01T00:00:00Z\n+ 2023-07-01T00:00:00.000Z\n\n# Pagination\n\n### Pagination for Multiple Objects\nFor endpoints returning multiple objects, pagination is in place to manage response sizes. Each response is limited to a certain number of objects. \nAdditionally, the response includes a `links` field that provides URLs for fetching the next and/or previous pages, if applicable.\n\n### Manual Positioning\nYou have the option to manually specify the `id_gt` or `id_lt` value as a request parameter. This allows you to retrieve objects starting from a specific position. If neither of these values is provided, the initial page of objects will be returned by default.\n+ `id_gt`: Request for next page of objects with id greater than the specified value. \n+ `id_lt`: Request for previous page of objects with id less than the specified value. \n\n# Realtime feed\nCertain users may require real-time data retrieval. Given the substantial data volume, retrieving the complete dataset may not be efficient. To address this, we offer the option to retrieve data based on its update timestamp. This approach necessitates fetching the entire dataset only during the initial request. Subsequent retrievals involve fetching solely the modified data to replace outdated information.\n+ `update_gt`: Request for objects updated after the specified datetime. \n+ `update_lt`: Request for objects updated before the specified datetime. \n\n# Change log\n+ 2024-04-10: add payment method and payment endpoints\n+ 2024-02-28: add availability endpoint\n" contact: email: support@splose.com servers: - url: https://api.splose.com/v1 security: [] externalDocs: description: Find out more about splose url: https://splose.com paths: /invoices: get: tags: - invoice summary: Get a paged array of invoices description: Get a paged array of invoices parameters: - schema: type: integer nullable: true description: The starting object id of the next page example: 200 required: false name: id_gt in: query - schema: type: integer nullable: true description: The starting object id of the previous page example: 100 required: false name: id_lt in: query - schema: anyOf: - type: string - type: string description: Search for objects updated after this date time example: '2023-07-30T09:00:00.000Z' required: false name: update_gt in: query - schema: anyOf: - type: string - type: string description: Search for objects updated before this date time example: '2023-07-30T09:00:00.000Z' required: false name: update_lt in: query - schema: type: string nullable: true enum: - 'true' - 'false' default: 'false' description: Whether archived objects should be retrieved, default is false required: false name: include_archived in: query - schema: type: number nullable: true description: Search for Invoices of this patient example: 1 required: false name: patientId in: query - schema: type: number nullable: true description: Search for Invoices created at this location example: 1 required: false name: locationId in: query - schema: type: number nullable: true description: Search for Invoices created by this practitioner example: 1 required: false name: practitionerId in: query - schema: type: string nullable: true enum: - Draft - Awaiting Payment - Paid description: Search for invoices of this status example: Paid required: false name: status in: query responses: '200': description: A paged array of invoices content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: integer minimum: 0 exclusiveMinimum: true description: Invoice id example: 1 invoiceNumber: type: string description: Invoice number example: INV-0001 issueDate: anyOf: - type: string - type: string description: Invoice issue date time example: '2023-07-30T09:00:00.000Z' dueDate: anyOf: - type: string - type: string description: Invoice due date time example: '2023-07-30T09:00:00.000Z' patientId: type: integer minimum: 0 exclusiveMinimum: true description: The invoice patient id example: 1 contactId: type: integer nullable: true minimum: 0 exclusiveMinimum: true description: The invoice contact id example: 1 locationId: type: integer minimum: 0 exclusiveMinimum: true description: The invoice location id example: 1 practitionerId: type: integer nullable: true minimum: 0 exclusiveMinimum: true description: The invoice practitioner id example: 1 extraBillingInfo: type: string nullable: true description: Invoice extra billing info example: Some extra info subtotal: type: number nullable: true description: Invoice subtotal amount example: 193.99 taxStatus: type: string enum: - including - excluding - no tax description: Invoice tax status example: excluding tax: type: number nullable: true description: Invoice tax amount example: 0 total: type: number nullable: true description: Invoice total amount example: 193.99 paidAmount: type: number nullable: true description: Invoice paid amount example: 193.99 status: type: string enum: - Draft - Awaiting Payment - Paid description: Invoice status example: Paid invoiceItems: type: array items: type: object properties: id: type: integer minimum: 0 exclusiveMinimum: true description: Invoice item id example: 1 type: type: string enum: - appointment - supportActivity - supportItem - service - productStock - custom - GiftVoucher description: Invoice item type example: appointment typeId: type: integer nullable: true minimum: 0 exclusiveMinimum: true description: Invoice item object id example: 1 code: type: string nullable: true description: Invoice item code example: 1234567 description: type: string nullable: true description: Invoice item description example: Wed 30 Aug 2023, 09:00am - Initial Assessment unitPrice: type: number nullable: true description: Invoice item unit price, in dollar example: 193.99 quantity: type: number nullable: true description: Invoice item quantity example: 0.5 discount: type: string nullable: true description: Invoice item discount, in dollar or percentage example: $20.00 taxType: anyOf: - type: string enum: - STANDARD - ZERO - EXEMPT - REDUCED - type: string - nullable: true description: Tax type, check Splose support for more info example: STANDARD taxRate: type: number nullable: true description: Tax rate, in percentage example: 10 required: - id - type - typeId - code - description - unitPrice - quantity - discount - taxType - taxRate paymentIds: type: array items: type: integer minimum: 0 exclusiveMinimum: true example: 1 referenceNumbers: type: array nullable: true items: type: string description: Invoice provider numbers example: - 'Medicare: 12345678' isArchived: type: boolean nullable: true default: false description: Whether the invoice is archvied reference: type: string nullable: true description: Invoice reference example: Some references description: type: string nullable: true description: Invoice description example: Some description createdAt: anyOf: - type: string - type: string description: Object creation date time example: '2023-07-30T09:00:00.000Z' updatedAt: anyOf: - type: string - type: string description: Object update date time example: '2023-07-30T09:00:00.000Z' required: - id - invoiceNumber - issueDate - dueDate - patientId - contactId - locationId - practitionerId - extraBillingInfo - subtotal - taxStatus - tax - total - paidAmount - status - invoiceItems - paymentIds - referenceNumbers - reference - description links: type: object properties: previousPage: type: string description: The link to retrieve next page example: /v1/${object_type}?id_gt=200 nextPage: type: string description: The link to retrieve previous page example: /v1/${object_type}?id_lt=100 required: - data - links security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer ````