💼

invoices

Billing document issued to customers for goods or services provided. Tracks invoice details, customer information, payment amounts, tax calculations, payment status, and due dates.

🎯 Request Builder

https://api.mockly.codes/invoices?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/invoices

Get a collection of invoices

Alternative: /business/invoices
GET/invoices/:id

Get a single invoice by ID

Alternative: /business/invoices/:id
GET/invoices/meta

Get resource metadata and schema

Alternative: /business/invoices/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/invoices?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/invoices?q=laptop&search_fields=name,description

💡 Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 invoices
fetch('https://api.mockly.codes/invoices?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/invoices?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/invoices?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/invoices?nocache=true')

Schema Properties

idinteger

Unique identifier for the invoice record

Gen:random_int
invoice_numberstring

Unique invoice number or reference code used for tracking and accounting purposes

Gen:invoice_number
customer_idinteger

Foreign key reference to the customer or client this invoice is billed to

Gen:random_int
customer_namestring

Full name of the customer or business entity being invoiced

Gen:name
customer_emailstring

Email address where the invoice is sent and payment notifications are delivered

Gen:emailemail
amountnumber

Subtotal amount before taxes and additional fees

Gen:price
taxnumber

Tax amount calculated based on applicable tax rates

Gen:tax
totalnumber

Total amount due including subtotal, taxes, and all applicable fees

Gen:price
currencystring

ISO currency code for the invoice amounts (e.g., USD, EUR, GBP)

Gen:currency
statusstring

Current payment status of the invoice (e.g., pending, paid, overdue, cancelled, refunded)

Gen:invoice_status
issue_datestring

Date when the invoice was created and issued to the customer

Gen:past_datedate
due_datestring

Date by which payment is expected or required

Gen:future_datedate
paid_atstring

Timestamp when the invoice was fully paid, null if still pending

Gen:past_datedate-time

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request