Invoices

Retrieve a single Invoice

Changed on Nov 10, 2026

Retrieves a single Invoice by its ID.

get/v2/invoices/{id}

Request

Base URL
https://api.workiz.com/crm/api
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/workiz/apis/developer-api/docs/v2/invoices/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

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",
  "serialId": 56,
  "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,
      "soldBy": {
        "id": "USR-38c1ee5c4efa38a4",
        "name": "John Doe"
      }
    }
  ],
  "payments": [
    {
      "id": "PAY-BA5r7o4bqzR9MONa",
      "date": "2026-01-01 10:00:00",
      "amount": 250.5,
      "tipAmount": 10,
      "type": "charge",
      "status": "succeeded",
      "estimateId": "ES-LwqGJnRwvZPaNe5E",
      "confirmationCode": "ch_3QwErTyUiOp12345",
      "collectedById": "USR-38c1ee5c4efa38a4"
    }
  ],
  "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"
}

Changes

Nov 10, 2026bb1c25c92b05 Revision changes
- info
  added the optional property // to the response with the status
Sep 29, 2026a2110eaa32f2 Revision changes
- warning
  added the new bank_transfer enum value to the // response property for the response status
- warning
  added the new bank_transfer_offline enum value to the // response property for the response status
- warning
  added the new cash enum value to the // response property for the response status
- warning
  added the new cash_app enum value to the // response property for the response status
- warning
  added the new charge enum value to the // response property for the response status
- warning
  added the new check enum value to the // response property for the response status
- warning
  added the new check_deposit enum value to the // response property for the response status
- warning
  added the new consumer_financing enum value to the // response property for the response status
- warning
  added the new credit enum value to the // response property for the response status
- warning
  added the new debit_offline enum value to the // response property for the response status
- warning
  added the new installments enum value to the // response property for the response status
- warning
  added the new interac enum value to the // response property for the response status
- warning
  added the new refund enum value to the // response property for the response status
- warning
  added the new refund_offline enum value to the // response property for the response status
- warning
  added the new venmo enum value to the // response property for the response status
- warning
  added the new zelle enum value to the // response property for the response status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history