Prerequisites
Installation & Setup
API
Config File
Developer Mode
Developer Tools
Enable Debug Mode
Events
Extensions
Features
Integrations
License System Extension
Permissions
Updating FaxStore
Weblutions Documentation > FaxStore > API > Invoices
Invoices
The Invoices API for FaxStore manages invoice creation, updates, deletion, and retrieval. It streamlines the invoicing process for efficient billing and record-keeping.
GET /api/invoices
Returns all invoices created in an array with an optional filter
Parameters:
authorization | [Header] A valid API token |
filter | [Query] Optional, a filter to define the userId or invoice status. Reference below for these. |
Response: [Expand]
Filters:
The userId can be passed or one of the below status'
Due, Overdue, Paid, Cancelled
GET /api/invoices/:id
Returns all invoices created in an array with an optional filter
Parameters:
authorization | [Header] A valid API token |
id | [URL] the ID of the invoice |
Response: [Expand]
POST Creates an invoice. If due is not present the due date gets set as the current time.
Parameters:
authorization | [Header] A valid API token |
userId | [Body] The userId to assign the invoice to |
username | [Body] The display name of the invoiced customer |
items | [Body] The formatted JSON string of the items and pricing for the invoice. Example below |
due | [Body] Optional, Unix timestamp in ms for the due date. Defaults to current time |
status | [Body] Optional, must be one of the above defined statuses for invoices. Defaults to Due |
tos | [Body] Optional, the Terms of Service footer to apply to the invoice |
memo | [Body] Optional, the memo to suffix the invoice |
Response: [Expand]
Items Example:
[{"title": "ITEM_TITLE", "description": "ITEM_DESCRIPTION", "price": "9.50", "productId": null, "subId": null}]
DELETE Deletes the invoice completely. This is not a recommended action. consider cancelling it.
Parameters:
authorization | [Header] A valid API token |
id | [URL] the ID of the invoice |
Response: [Expand]
Related Articles
Review this page
invoice api
1 recommend this page