Get invoices

Retrieve rental or retail invoices for the authenticated user.

GET /v1/invoices/{type}

Get invoices

cURL

curl --request GET \
  --url https://api.example.com/v1/invoices/{type}

import requests

url = "https://api.example.com/v1/invoices/{type}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/invoices/{type}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/invoices/{type}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/invoices/{type}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/invoices/{type}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/invoices/{type}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200 (rental)

{
  "message": "Rental invoices retrieved successfully!",
  "code": 200,
  "data": {
    "invoiceCount": 2,
    "invoices": {
      "2025": [
        {
          "InvoiceID": "inv_abc123",
          "UserID": "user_xyz789",
          "due_date_month": "3",
          "due_date_year": "2025"
        }
      ],
      "2024": [
        {
          "InvoiceID": "inv_def456",
          "UserID": "user_xyz789",
          "due_date_month": "12",
          "due_date_year": "2024"
        }
      ]
    }
  }
}

{
  "message": "No rental invoices found for this user.",
  "code": 200,
  "data": null
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid invoice type 'unknown'. Must be 'rental' or 'retail'"
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid retail sub-type 'xyz'. Valid options: food-delivery, clothing, technology, subscriptions, grocery, utility, miscellaneous, travel"
  }
}

Authentication

All requests to this endpoint must include a valid JWT in the Authorization header.

Authorization: Bearer <token>

Path parameters

type · string · required

Invoice type. Must be rental or retail.

Query parameters

The following query parameters are supported for retail invoices only (type=retail). They are not valid when type=rental.

subtype · string

Filter by retail invoice sub-type. Valid values: food-delivery, clothing, technology, subscriptions, grocery, utility, miscellaneous, travel.

invoice-id · string

Retrieve the parsed detail record for a specific retail invoice. Requires subtype to also be set.

counts · boolean

When true, return invoice counts instead of invoice records. Can be combined with subtype to count a specific category. Cannot be used together with invoice-id.

Behavior by mode

Rental invoices

GET /v1/invoices/rental

Returns all rental invoices for the user from the RentalInvoices DynamoDB table, grouped by year. No query parameters are supported for rental invoices.

Response data:

• invoiceCount — total number of invoices
• invoices — object keyed by year (e.g. "2025"), each value an array of invoice objects

curl --request GET \
  --url https://api.paypulse.io/v1/invoices/rental \
  --header 'Authorization: Bearer <token>'

All retail invoices

GET /v1/invoices/retail

Returns all retail invoices for the user from the RetailInvoices base table (summary records only).

Response data:

• invoiceCount — total number of retail invoices
• invoices — array of invoice summary objects

curl --request GET \
  --url https://api.paypulse.io/v1/invoices/retail \
  --header 'Authorization: Bearer <token>'

Retail by sub-type

GET /v1/invoices/retail?subtype=food-delivery

Returns retail invoices filtered to a specific category using the sub_type-invoice_date-index GSI.

curl --request GET \
  --url 'https://api.paypulse.io/v1/invoices/retail?subtype=food-delivery' \
  --header 'Authorization: Bearer <token>'

Retail invoice details

GET /v1/invoices/retail?subtype=food-delivery&invoice-id=retail_invoice_abc123

Returns the full parsed detail record from the category detail table (e.g. FoodDeliveryInvoices) for a specific invoice. Both subtype and invoice-id are required together.

Response data:

• invoiceDetails — the full detail record from the category-specific DynamoDB table

curl --request GET \
  --url 'https://api.paypulse.io/v1/invoices/retail?subtype=clothing&invoice-id=retail_invoice_abc123' \
  --header 'Authorization: Bearer <token>'

Invoice counts

GET /v1/invoices/retail?counts=true

Returns the count of retail invoices per sub-type for the user. Add subtype to count only one category.

# All categories
curl --request GET \
  --url 'https://api.paypulse.io/v1/invoices/retail?counts=true' \
  --header 'Authorization: Bearer <token>'

# Single category
curl --request GET \
  --url 'https://api.paypulse.io/v1/invoices/retail?subtype=grocery&counts=true' \
  --header 'Authorization: Bearer <token>'

Response (rental invoices)

message · string

Example: "Rental invoices retrieved successfully!"

code · number

200 on success.

data · object | null

null when no invoices exist. Otherwise:

Hide properties

invoiceCount · number

Total number of rental invoices found.

invoices · object

Invoices grouped by year (e.g., "2024", "2025"). Each value is an array of invoice objects.

Show invoice object

InvoiceID · string

Unique invoice identifier.

UserID · string

ID of the user who owns this invoice.

due_date_month · string

Month of the invoice due date (e.g., "3" for March).

due_date_year · string

Year of the invoice due date (e.g., "2025").

Error responses

Status	Error code	Description
400	INVALID_REQUEST	The type path parameter is not rental or retail, an invalid subtype value was provided, invoice-id was given without subtype, or counts and invoice-id were combined.
401	INVALID_CREDENTIALS	The Authorization header is missing or the token is invalid.
401	TOKEN_EXPIRED	The JWT has expired.
404	INVALID_REQUEST	Invoice not found (when using invoice-id).
502	DEPENDENCY_FAILURE	A downstream dependency (DynamoDB) returned an error.
500	INTERNAL_SERVER_ERROR	An unexpected server-side error occurred.

200 (rental)

{
  "message": "Rental invoices retrieved successfully!",
  "code": 200,
  "data": {
    "invoiceCount": 2,
    "invoices": {
      "2025": [
        {
          "InvoiceID": "inv_abc123",
          "UserID": "user_xyz789",
          "due_date_month": "3",
          "due_date_year": "2025"
        }
      ],
      "2024": [
        {
          "InvoiceID": "inv_def456",
          "UserID": "user_xyz789",
          "due_date_month": "12",
          "due_date_year": "2024"
        }
      ]
    }
  }
}

{
  "message": "No rental invoices found for this user.",
  "code": 200,
  "data": null
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid invoice type 'unknown'. Must be 'rental' or 'retail'"
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid retail sub-type 'xyz'. Valid options: food-delivery, clothing, technology, subscriptions, grocery, utility, miscellaneous, travel"
  }
}