Skip to main content

​
List Invoices

Retrieve a list of invoices for the authenticated business.
​
schema
string
required
Schema identifier. Must be invoicing
​
page
number
Page number for pagination
​
limit
number
Number of records per page
​
date_order
string
Order records by date. Values: asc (oldest first) or desc (newest first). Default: desc
curl -X GET "https://api.useadam.io/v1/adam/invoices?schema=invoicing&page=1&limit=20" \
  -H "X-API-Key: your_secret_key"

​
Get Invoice

Retrieve a specific invoice by UUID or source_uuid.
​
uuid
string
required
Invoice UUID or source_uuid
curl -X GET "https://api.useadam.io/v1/adam/invoices/invoice-uuid" \
  -H "X-API-Key: your_secret_key"

​
Create Invoice

Create a new invoice using AI prompt.
​
prompt
string
required
Description of the invoice to create
​
attachments
array
Array of attachment URLs or file references
​
text_attachment
string
Additional text context
curl -X POST "https://api.useadam.io/v1/adam/invoices" \
  -H "X-API-Key: your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Create an invoice for ABC Company for $1,000 for web development services"
  }'

​
Update Invoice

Update an existing invoice by UUID or source_uuid.
​
uuid
string
required
Invoice UUID or source_uuid
​
date
string
Invoice date (YYYY-MM-DD)
​
due_date
string
Due date (YYYY-MM-DD)
​
narration
string
Invoice description
​
record_items
array
Array of invoice line items
curl -X PUT "https://api.useadam.io/v1/adam/invoices/invoice-uuid" \
  -H "X-API-Key: your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "narration": "Updated invoice description"
  }'

​
Update Invoice Payment

Add or update payments for an invoice.
​
uuid
string
required
Invoice UUID or source_uuid
​
payments
array
required
Array of payment objects
​
payments[].uuid
string
Payment UUID if updating existing payment
​
payments[].amount_paid
number
required
Payment amount
​
payments[].category
string
required
Bank account name where the payment was made or received
​
payments[].date
string
required
Payment date (YYYY-MM-DD)
​
payments[].exchange_rate
number
Exchange rate if different currency
​
overwrite
boolean
If true, replaces all existing payments. Default: false
curl -X POST "https://api.useadam.io/v1/adam/invoices/invoice-uuid/payments" \
  -H "X-API-Key: your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "payments": [
      {
        "amount_paid": 500.00,
        "category": "Chase Bank",
        "date": "2024-01-20"
      }
    ]
  }'

​
Delete Invoice

Delete an invoice by UUID or source_uuid.
​
uuid
string
required
Invoice UUID or source_uuid
curl -X DELETE "https://api.useadam.io/v1/adam/invoices/invoice-uuid" \
  -H "X-API-Key: your_secret_key"