Fetch an invoice

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Fetch an Invoice

Retrieve detailed information about a specific invoice in your InvestGlass system.

Endpoint

GET /api/v1/invoices/{id}

Parameters

Path Parameters

ParameterTypeRequiredDescription
idintegerYesThe unique identifier of the invoice

Query Parameters

ParameterTypeRequiredDescription
access_tokenstringYesAccess token generated from user's profile
include_detailsbooleanNoInclude detailed line items in the response (default: true)
formatstringNoResponse format: json or pdf (default: json)

Request Headers

Accept: application/json
Authorization: Bearer {access_token}

Response

Success Response (200 OK)

Returns a JSON object containing the invoice details:

{
  "id": 12345,
  "invoice_number": "INV-2025-001",
  "client_id": 9458,
  "company_id": 167,
  "status": "paid",
  "currency": "USD",
  "total_amount": 15750.00,
  "tax_amount": 2362.50,
  "subtotal": 13387.50,
  "issue_date": "2025-01-15",
  "due_date": "2025-02-14",
  "payment_date": "2025-02-10",
  "description": "Portfolio management services Q1 2025",
  "client_details": {
    "name": "Thompson Family Office",
    "email": "[email protected]",
    "address": {
      "street": "123 Investment Avenue",
      "city": "New York",
      "state": "NY",
      "zip": "10005",
      "country": "United States"
    }
  },
  "line_items": [
    {
      "id": 1,
      "description": "Portfolio Management Fee",
      "quantity": 1,
      "unit_price": 12500.00,
      "total": 12500.00,
      "tax_rate": 0.15
    },
    {
      "id": 2,
      "description": "Performance Analysis Report",
      "quantity": 1,
      "unit_price": 887.50,
      "total": 887.50,
      "tax_rate": 0.15
    }
  ],
  "payment_terms": "Net 30",
  "notes": "Thank you for your business",
  "created_at": "2025-01-15T09:30:00Z",
  "updated_at": "2025-02-10T14:22:00Z",
  "creator_id": 27408,
  "last_modifier_id": 27408
}

Error Responses

401 Unauthorized

{
  "message": "The access token is invalid"
}

403 Forbidden

{
  "status": 403,
  "title": "Not authorized",
  "message": "Access Forbidden"
}

404 Not Found

{
  "status": 404,
  "title": "Not found",
  "message": "The Invoice resource cannot be found"
}

Code Examples

cURL

curl --request GET \
     --url "https://app.investglass.com/api/v1/invoices/12345?access_token=your_access_token" \
     --header "Accept: application/json"

Python

import requests

url = "https://app.investglass.com/api/v1/invoices/12345"
params = {
    "access_token": "your_access_token"
}
headers = {
    "Accept": "application/json"
}

response = requests.get(url, params=params, headers=headers)
invoice = response.json()

JavaScript

const invoiceId = 12345;
const accessToken = 'your_access_token';

const response = await fetch(
  `https://app.investglass.com/api/v1/invoices/${invoiceId}?access_token=${accessToken}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json'
    }
  }
);

const invoice = await response.json();

PDF Download

To retrieve the invoice as a PDF document, set the format parameter to pdf:

curl --request GET \
     --url "https://app.investglass.com/api/v1/invoices/12345?access_token=your_access_token&format=pdf" \
     --header "Accept: application/pdf" \
     --output invoice-12345.pdf

Notes

  • Invoice IDs are unique across your InvestGlass organization
  • The status field can be: draft, sent, paid, overdue, cancelled
  • All monetary amounts are returned as decimal numbers
  • Dates are returned in ISO 8601 format (YYYY-MM-DD)
  • When requesting PDF format, the response will be a binary PDF file

Related Endpoints

Response
200
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!