Retrieve an invoice

Prev Next
Get
/v1/invoices/{invoiceId}

Retrieves invoice details by ID.

Grouped Invoices: If the invoice is a combined/grouped invoice, this endpoint returns all child invoices in the group.


Response Fields

Field Type Description
id integer Unique invoice identifier.
hash_id string Invoice hash for optimistic locking. Use this value in PATCH requests.
parent_id integer Parent invoice ID for grouped invoices. Null if not grouped.
supplier_info object Supplier details (name, web, email, phone_number, address, supplierId).
ship_to object Ship-to address (name, address).
bill_to object Bill-to address (name, address, memo, departmentId, entityId).
invoice_number string Invoice number from the document.
po_number string Purchase order number.
invoice_terms string Payment terms (e.g., "Net 30").
invoice_date string Invoice date (YYYY-MM-DD).
invoice_due string Payment due date (YYYY-MM-DD).
invoice_items array Line items (see below).
invoice_total number Total invoice amount.
tags string Comma-separated tags.
rejected string Rejection timestamp. Null if not rejected.
approved string Approval timestamp. Null if not approved.
approvers array List of users who acted on this invoice.
document object Document metadata (url, name, size). Null if no document.
modified string Last modification timestamp.
created string Creation timestamp.
integration_id integer Accounting integration ID. Null if not linked.
integration_api_id string Synced record API ID in the accounting system. Null if not synced.

Line Item fields: id, qty, price, total, description, sku, itemId, customerId, accountId, classId, poId, poLineId, billable, departmentId, entityId, taxId, taxInclusive

Approver fields: id (integer or array of integers), name, approved, rejected, rejected_note

Security
HTTP
Type bearer

Enter your API token.

Path parameters
invoiceId
integerRequired

The unique identifier of the invoice to retrieve.

Minimum1
Responses
200

Invoice retrieved successfully

singleInvoice

Single Invoice

{
  "status": "OK",
  "msg": "Record found",
  "result": [
    {
      "id": 12345,
      "hash_id": "abc123def456",
      "parent_id": null,
      "supplier_info": {
        "name": "Acme Corp",
        "web": "https://acme.com",
        "email": "billing@acme.com",
        "phone_number": "+1-555-123-4567",
        "address": "123 Main St, New York, NY 10001",
        "supplierId": "SUP-001"
      },
      "ship_to": {
        "name": "Warehouse A",
        "address": "456 Oak Ave, Los Angeles, CA 90001"
      },
      "bill_to": {
        "name": "Accounts Payable",
        "address": "789 Corporate Blvd, Chicago, IL 60601",
        "memo": "Attn: John Smith",
        "departmentId": "DEPT-100",
        "entityId": null
      },
      "invoice_number": "INV-2024-001",
      "po_number": "PO-789",
      "invoice_terms": "Net 30",
      "invoice_date": "2024-01-15",
      "invoice_due": "2024-02-14",
      "invoice_items": [
        {
          "id": "1",
          "qty": 10,
          "price": 100.0,
          "total": 1000.0,
          "description": "Professional Services - January 2024",
          "sku": "SVC-001",
          "itemId": null,
          "customerId": null,
          "accountId": "EXP-100",
          "classId": "CLASS-100",
          "poId": null,
          "poLineId": null,
          "billable": true,
          "departmentId": "DEPT-100",
          "entityId": null,
          "taxId": null,
          "taxInclusive": false
        },
        {
          "id": "2",
          "qty": 5,
          "price": 100.0,
          "total": 500.0,
          "description": "Consulting Hours",
          "sku": "SVC-002",
          "itemId": null,
          "customerId": "CUST-001",
          "accountId": null,
          "classId": null,
          "poId": "PO-789",
          "poLineId": "PO-789-1",
          "billable": true,
          "departmentId": null,
          "entityId": null,
          "taxId": null,
          "taxInclusive": false
        }
      ],
      "invoice_total": 1500.0,
      "tags": "verified,q1-2024",
      "rejected": null,
      "approved": "2024-01-16T14:30:00Z",
      "approvers": [
        {
          "id": 42,
          "name": "John Smith",
          "approved": "2024-01-16T14:30:00Z",
          "rejected": null,
          "rejected_note": null
        }
      ],
      "document": {
        "url": "https://storage.makershub.ai/invoices/abc123.pdf",
        "name": "invoice-2024-001.pdf",
        "size": 245678
      },
      "modified": "2024-01-16T14:30:00Z",
      "created": "2024-01-15T10:00:00Z",
      "integration_id": 3,
      "integration_api_id": "1234"
    }
  ]
}
Expand All
object
status
string
Valid values[ "OK", "Error" ]
msg
string
result
Array of object (Invoice)
object

Complete invoice object returned by the GET endpoint.

id
integer

Unique invoice identifier.

hash_id
string

Invoice hash for optimistic locking. Use this value in PATCH requests.

parent_id
integer | null

Parent invoice ID for grouped invoices. Null if not grouped.

supplier_info
object (InvoiceSupplierInfo)

Supplier/vendor information.

name
string

Supplier name.

web
string

Supplier website URL.

email
string

Supplier email address.

phone_number
string

Supplier phone number.

address
string

Supplier address.

supplierId
string

External supplier/vendor ID reference.

ship_to
object (InvoiceShipTo)

Ship-to address information.

name
string

Ship-to name.

address
string

Ship-to address.

bill_to
object (InvoiceBillTo)

Bill-to address information.

name
string

Bill-to name.

address
string

Bill-to address.

memo
string

Memo or notes for the bill-to.

departmentId
string

Department reference ID.

entityId
string

Entity reference ID.

invoice_number
string | null

Invoice number from the document.

po_number
string | null

Purchase order number.

invoice_terms
string | null

Payment terms (e.g., "Net 30").

invoice_date
string (date) | null

Invoice date (YYYY-MM-DD).

invoice_due
string (date) | null

Payment due date (YYYY-MM-DD).

invoice_items
Array of object (InvoiceLineItemResponse)

Line items on the invoice.

object

Line item as returned in GET responses. Includes all fields from InvoiceLineItem plus response-specific data.

id
string

Line item identifier.

qty
number | null

Quantity.

price
number | null

Unit price.

total
number | null

Line total.

description
string | null

Item description.

sku
string | null

Item SKU.

itemId
string | null

Reference to item master record.

customerId
string | null

Customer reference for billable items.

accountId
string | null

GL account reference ID.

classId
string | null

Accounting class reference ID.

poId
string | null

Purchase order reference ID.

poLineId
string | null

Purchase order line reference ID.

billable
boolean | null

Whether line item is billable.

departmentId
string | null

Department reference ID.

entityId
string | null

Entity reference ID.

taxId
string | null

Tax code reference ID.

taxInclusive
boolean | null

Whether price includes tax.

invoice_total
number | null

Total invoice amount.

tags
string | null

Comma-separated tags.

rejected
string (date-time) | null

Rejection timestamp. Null if not rejected.

approved
string (date-time) | null

Approval timestamp. Null if not fully approved.

approvers
Array of object (InvoiceApprover)

List of users who have acted on this invoice.

object

User who has acted on the invoice approval workflow.

id

User ID. Can be a single integer or an array of integers for grouped approvers.

OneOf
integer
integer
array
array
integer
name
string

User's display name.

approved
string (date-time) | null

Timestamp when user approved. Null if not approved.

rejected
string (date-time) | null

Timestamp when user rejected. Null if not rejected.

rejected_note
string | null

Note provided when rejecting.

document
object (InvoiceDocument) | null

Document/file attachment metadata. Null if no document attached.

url
string (uri)

URL to download the document.

name
string

Original filename.

size
integer

File size in bytes.

modified
string (date-time)

Last modification timestamp.

created
string (date-time)

Creation timestamp.

integration_id
integer | null

Accounting integration ID. Null if not linked to an integration.

integration_api_id
string | null

Synced record API ID in the accounting system. Null if not synced.

400

Bad Request - Invalid invoice ID format

invalidId

Invalid ID

{
  "status": "Error",
  "msg": "Invalid invoice ID",
  "result": null
}
object
status
string
Valid values[ "Error" ]
msg
string
result
401

Unauthorized - Missing or invalid API token

404

Invoice not found

notFound

Not Found

{
  "status": "Error",
  "msg": "Invoice not found",
  "result": null
}
object
status
string
Valid values[ "Error" ]
msg
string
result