---
title: "Query Invoices"
method: GET
path: "/v2/invoices"
tags: ["invoice"]
---

# Query Invoices

`GET /v2/invoices`

Query all Invoices

## Query parameters

- `salesOrderNumber` string
- `externalOrderNumber` string
- `invoiceNumber` string
- `itemId` string, uuid
- `customerId` string, uuid — Represents a unique key for identifying a customer in the JTL system.
- `IsExisting` boolean
- `paymentStatus` 0 | 1 | 2 — 0 = UnPayed, 1 = PartialPayed, 2 = Payed
- `isExternalInvoice` boolean
- `pageNumber` integer
- `pageSize` integer

## Headers

- `x-tenant-id` string, uuid, required
- `x-runas` string
- `x-companyid` string

## Response `200`

Returns all non-pending sales orders.

- JTLWawiRestContractsModelsPagedListOfJTLWawiRestContractsModelsV1InvoiceInvoice — Represents a paginated list of items
  - `totalItems` integer — Gets or sets the total number of items available in the data source.
  - `pageNumber` integer — Gets or sets the current page number in the paginated list.
  - `pageSize` integer — Gets or sets the number of items per page in the paginated list.
  - `items` JTLWawiRestContractsModelsV1InvoiceInvoice[] — Gets or sets the collection of items contained in the paged list.
    - `id` string, uuid
    - `number` string — The number of the invoice.
    - `externalNumber` string — The external number of the sales order.
    - `companyId` string, uuid — Represents a key for identifying a firm within the application.
    - `departureCountry` JTLWawiRestContractsModelsV1InvoiceInvoiceDepartureCountry — Model Class: InvoiceDepartureCountry
      - `countryISO` string — ISO code of the departure country.
      - `state` string — Name of the state in the departure country.
      - `currencyIso` string — ISO code of the currency of the departure country.
      - `currencyFactor` number — The currency factor of the departure country.
    - `customerId` string, uuid — Represents a unique key for identifying a customer in the JTL system.
    - `billingAddress` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `shipmentAddress` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `invoiceDate` string, date-time — The date when the invoice was created.
    - `invoicePaymentDetails` JTLWawiRestContractsModelsV1InvoiceInvoicePaymentDetail — Model Class: InvoicePaymentDetail
      - `paymentMethodId` string, uuid
      - `paymentStatus` 0 | 1 | 2 — 0 = UnPayed, 1 = PartialPayed, 2 = Payed
      - `totalGrossAmount` number — The total gross amount of the invoice.
      - `currencyIso` string — ISO code of the currency of the invoice.
      - `currencyFactor` number — The currency factor for the sales order at the time the sales order has been created.
      - `stillToPay` number — The amount that is left to pay for this invoice.
      - `paymentTarget` integer — The due date for payment of the sales order in days.
      - `cashDiscount` number — The cash discount of the sales order.
      - `cashDiscountDays` integer — The days that the cash discount is valid.
      - `stopPaymentRequest` boolean — The creation of dunning letters is blocked.
      - `dunningLevel` integer — The stage at which dunning currently is
      - `nextDueDate` string, date-time — The next due date
    - `colorcodeId` string, uuid — Represents a key for identifying a color entity in the system.
    - `dunningBlock` boolean — The creation of dunning letters is blocked.
    - `isExternalInvoice` boolean — Indicates if the invoice of the sales order was created in an external system like Amazon VCS.
    - `comment` string — A comment on the sales order.
    - `customerComment` string — A customer comment on the sales order.
    - `isCancelled` boolean — Indicates if the invoice has been cancelled.
    - `languageIso` string — The language of the invoice.
    - `cancellationDetails` JTLWawiRestContractsModelsV1InvoiceInvoiceCancellationDetails — Model Class: InvoiceCancellationDetails
      - `cancellationReasonId` string, uuid
      - `cancellationComment` string — A comment that adds further information to the cancellation.
      - `date` string, date-time — The DateTime of Cancellation.
  - `totalPages` integer — Gets the total number of pages based on the total number of items and the page size.
  - `hasPreviousPage` boolean — Gets a value indicating whether there is a previous page available in the paginated list.
  - `hasNextPage` boolean — Gets a value indicating whether there is a next page available.
  - `nextPageNumber` integer — Gets the number of the next page if there is one; otherwise, returns the total number of pages.
  - `previousPageNumber` integer — Gets the number of the previous page. If there is no previous page, it returns 1.

## Other responses

- `401`
- `402` — No licence available or the app has not been authorised by JTL.

---

[API](https://skmtc.net/jtl-software/apis/scx-authentication-api.md) · [All operations](https://skmtc.net/jtl-software/apis/scx-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jtl-software/scx-authentication-api/revisions/f979b1ea6951/schema)