---
title: "Gets list of Invoices"
method: GET
path: "/api/Invoice"
tags: ["Invoice"]
---

# Gets list of Invoices

`GET /api/Invoice`

TransactionStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"

## Query parameters

- `UpdatedAfter` string, date-time
- `pageSize` integer
- `pageNumber` integer
- `TransactionStatusCode` string
- `IssueDateFrom` string, date-time
- `IssueDateTo` string, date-time
- `DueDateFrom` string, date-time
- `DueDateTo` string, date-time
- `Sort` string
- `CompanyIDFK` integer

## Response `200`

Returns a paginated list of invoices with line items.

- InvoiceList — Paginated collection of customer invoices.
  - `TotalCount` integer — Total number of records matching the query across all pages.
  - `PageNumber` integer — The current page number (1-based).
  - `PageSize` integer — The number of records per page.
  - `Invoices` Invoice[] — The list of invoices on this page.
    - `TransactionID` integer — Unique identifier for the invoice transaction.
    - `AccountIDFK` integer — The Avaza account this invoice belongs to.
    - `TransactionPrefix` string — Prefix used in the invoice number (e.g. 'INV').
    - `InvoiceNumber` string — The full invoice number including prefix.
    - `CompanyIDFK` integer — The customer company ID this invoice is for.
    - `CompanyName` string — Name of the customer company.
    - `ExternalContactUserIDFK` integer — The external contact user ID associated with this invoice.
    - `Subject` string — Subject line for the invoice.
    - `DateIssued` string, date-time — Date the invoice was issued.
    - `DateSent` string, date-time — Date the invoice was sent to the customer.
    - `DueDate` string, date-time — Payment due date.
    - `TransactionStatusCode` string — Current status. Values: Draft, Sent, Late, Paid, Partial, Void.
    - `TaxAmount` number, double — Total tax amount across all line items.
    - `TransactionTaxConfigCode` string — Tax configuration: 'EX' (exclusive) or 'INC' (inclusive).
    - `Balance` number, double — Outstanding balance remaining on the invoice.
    - `CurrencyCode` string — ISO 3-character currency code for the invoice.
    - `TotalAmount` number, double — Total amount of the invoice including tax.
    - `ExchangeRate` number, double — Exchange rate to the account's base currency. 1.0 if same currency.
    - `Notes` string — Additional notes or comments on the invoice.
    - `CustomerPONumber` string — Customer's purchase order number for reference.
    - `DateCreated` string, date-time — Date and time the record was created.
    - `DateUpdated` string, date-time — Date and time the record was last updated.
    - `LineItems` InvoiceLineItem[] — Line items on this invoice.
      - `TransactionLineItemID` integer — Unique identifier for the line item.
      - `InventoryItemIDFK` integer — The inventory/product item ID for this line item.
      - `InventoryItemName` string — Name of the inventory/product item.
      - `InventoryItemSKU` string — Stock Keeping Unit code for the inventory item.
      - `Description` string — Text description for the line item.
      - `Quantity` number, double — Quantity of items on this line.
      - `UnitPrice` number, double — Price per unit for this line item.
      - `TaxAmount` number, double — Calculated tax amount on this line item.
      - `TaxIDFK` integer — The tax rate ID applied to this line item.
      - `TaxCode` string — Short code for the applied tax rate.
      - `TaxName` string — Name of the applied tax rate.
      - `ProjectIDFK` integer — Optional project ID this line item is attributed to for reporting.
      - `ProjectTitle` string — Title of the associated project.
      - `Amount` number, double — Calculated line total (Quantity x UnitPrice less Discount).
      - `Discount` number, double — Discount percentage applied to this line item.
    - `Links` InvoiceLinks — URLs for client-facing view, internal view, and editing an invoice in the Avaza web application.
      - `ClientView` string — URL for the customer to view and pay the invoice online.
      - `View` string — URL for viewing the invoice in the Avaza application.
      - `Edit` string — URL for editing the invoice in the Avaza application.
    - `Issuer` IssuerDetails — Billing address and tax details for the Avaza account (the party issuing an invoice or estimate).
      - `BillingAddress` string — Formatted multi-line billing address.
      - `BillingAddressLine` string — Street address line of the billing address.
      - `BillingAddressCity` string — City/suburb of the billing address.
      - `BillingAddressState` string — State/province of the billing address.
      - `BillingAddressPostCode` string — Postal/ZIP code of the billing address.
      - `BillingCountryCode` string — ISO 3166-1 alpha-2 country code of the billing address.
      - `TaxNumber` string — Tax registration number (e.g. VAT number, ABN, EIN).
    - `Recipient` RecipientDetails — Billing address details for the customer receiving an invoice or estimate.
      - `CompanyIDFK` integer — The customer company ID.
      - `CompanyName` string — Name of the customer company.
      - `RecipientFormattedBillingAddress` string — Pre-formatted multi-line billing address for the recipient.
      - `RecipientBillingAddressLine` string — Street address line for the recipient.
      - `RecipientBillingAddressCity` string — City/suburb for the recipient.
      - `RecipientBillingAddressState` string — State/province for the recipient.
      - `RecipientBillingAddressPostCode` string — Postal/ZIP code for the recipient.
      - `RecipientBillingAddressCountryCode` string — ISO country code for the recipient.

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/avaza/apis/avaza-api-documentation.md) · [All operations](https://skmtc.net/avaza/apis/avaza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avaza/avaza-api-documentation/versions/1eeadf750514/schema)
