latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Invoices

Retrieve a single Invoice

Retrieves a single Invoice by its ID.

get/v2/invoices/{id}

Path parameters

idstring required

Example:IV-LwqGJnRwvZPaNe5E

The invoice ID (prefix IV-).

Headers

Authorizationstring required

Example:Bearer <token>

Bearer Token

Response

The requested Invoice.

idstring

The ID of the invoice (prefix IV-).

uuidstring

The UUID of the invoice.

serialIdnumber

The serial ID of the invoice.

namestring

The name of the invoice.

notesstring

The invoice note.

jobIdstring

The ID of the associated job (prefix JOB-).

discountAmountnumber

The invoice discount amount.

subTotalnumber

The subtotal of the invoice before tax and discounts.

taxableAmountnumber

The taxable amount of the invoice.

taxPercentnumber

The tax percentage of the invoice.

taxAmountnumber

The tax amount of the invoice.

costingnumber

The cost amount of the invoice.

techExpensesnumber

The technician expenses of the invoice.

tipAmountnumber

The tip amount of the invoice.

totalPricenumber

The total price of the invoice.

amountDuenumber

The amount due for the invoice.

amountDueDatestring date-time

The date and time when the invoice amount is due.

updatedstring date-time

The date and time the invoice was last updated.

createdstring date-time

The date and time the invoice was created.

Example response

{
  "id": "IV-bK9r2XyZL54aWDR0",
  "uuid": "3YBIBO",
  "name": "Invoice 1",
  "notes": "This is a note for the invoice",
  "jobId": "JOB-BA5r7o4bqzR9MONa",
  "discountAmount": 10,
  "subTotal": 946,
  "taxableAmount": 946,
  "taxPercent": 10.111,
  "taxAmount": 10.51,
  "costing": 10.51,
  "techExpenses": 12.51,
  "tipAmount": 43.51,
  "totalPrice": 956.51,
  "amountDue": 956.51,
  "amountDueDate": "2026-01-01 10:00:00",
  "lineItems": [
    {
      "id": "ILI-BA5r7o4bqzR9MONa",
      "productId": 1000,
      "name": "Deadbolt",
      "description": "Deadbolt replacement, any color and size",
      "price": 100,
      "quantity": 1,
      "total": 100,
      "cost": 100,
      "taxable": true,
      "discountable": true,
      "inventoryManaged": true,
      "inventorySync": true,
      "optionalConverted": true
    }
  ],
  "payments": [
    {
      "id": "PAY-BA5r7o4bqzR9MONa",
      "type": "Cash",
      "amount": 100,
      "tipAmount": 10
    }
  ],
  "attachments": [
    {
      "id": "FLE-BA5r7o4bqzR9MONa",
      "name": "file.pdf",
      "fileUrl": "https://example.com/file.pdf"
    }
  ],
  "signatureImage": {
    "id": "IMG-BA5r7o4bqzR9MONa",
    "signedByName": "John Doe",
    "imageUrl": "https://example.com/image.png"
  },
  "updated": "2026-01-01 00:00:00",
  "created": "2026-01-01 00:00:00"
}