HIhitpayapp

Get all invoice

Changed on

Get the invoice and filter

get/v1/invoices

Request

  • Base URL
    https://api.hit-pay.com
  • URL
    https://api.hit-pay.com/v1/invoices
  • Auth
    none declared. Required headers: X-BUSINESS-API-KEY

Query parameters

customer_emailstring
statusstring

Invoice status, options [draft, sent, pending, overdue, paid]

referencestring
per_page5 | 10 | 20 | 25 | 50 | 100 | 1000

Number of invoices per page. Must be one of 5, 10, 20, 25, 50, 100 or 1000.

cursorstring

This endpoint uses cursor pagination, not page numbers (a page parameter is ignored). Leave cursor empty for the first page. For the next page, pass the meta.next_cursor value from the previous response (or follow links.next). Keep the same per_page and filters, and stop when meta.next_cursor is null.

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

Changes

  • eaf43aa8eff7Revision changes
    • breaking

      the query request parameter per_page was restricted to a list of enum values

    • breaking

      for the query request parameter per_page, default value was changed from 10 to 25

    • breaking

      for the query request parameter per_page, the type changed from string to integer

    • breaking

      removed the success response with the status

    • warning

      deleted the query request parameter page

    • info

      added the new optional query request parameter cursor

    • info

      added the new enum value 10.00 to the query request parameter per_page

    • info

      added the new enum value 100.00 to the query request parameter per_page

    • info

      added the new enum value 1000.00 to the query request parameter per_page

    • info

      added the new enum value 20.00 to the query request parameter per_page

    • info

      added the new enum value 25.00 to the query request parameter per_page

    • info

      added the new enum value 5.00 to the query request parameter per_page

    • info

      added the new enum value 50.00 to the query request parameter per_page

    • info

      added the success response with the status