Description: This document provides an overview of the data you can access through the Hamlet API's /invoices endpoint.

What You Can Access

Using the Hamlet API, you can retrieve various details about invoices. Here are the key pieces of information you can access:

1. Invoice Information
   • Invoice ID
   • Amount Credited
   • Amount Due
   • Amount Paid
   • Currency
   • Date
   • Due Date
   • Invoice Number
   • Subtotal
   • Status (e.g., PAID, AUTHORISED, VOIDED)
   • Total Amount
   • Total Discount
   • Total Tax
   • Invoice URL
2. Company Information
   • Company ID
   • Company Name
   • Company Email
3. Location Information
   • Location ID
   • Location Name
   • Location Billing Email
   • Location Billing Email Name
4. Xero Information
   • Xero Company ID
   • Xero ID
   • Xero Invoice ID
5. Sales Order Information
   • Sales Order ID
6. Additional Details
   • Branding Theme ID
   • Local Charge Date
   • Schedule Unit (e.g., MONTHLY)
7. Invoice Line Items
   • Quantity
   • Tax Type
   • Tax Amount
   • Description
   • Line Amount
   • Unit Amount
   • Account Code
   • Xero Line Item ID

How to Use

To access this data, you will need to make a request to the Hamlet API's /invoices endpoint. You can filter the data based on various criteria such as invoice ID, company ID, status, date, location ID, and more.

Example Use Cases

• Retrieve Invoices by Status: Get a list of invoices based on their current status (e.g., PAID, AUTHORISED, VOIDED).
• Filter by Date: Find invoices that were created within a specific date range.
• Sort Invoices: Sort the invoices by date or amount due.

Rate Limits

• You can make up to 60 requests per minute.
• Each request can return a maximum of 100 records.