---
title: "Searches Supplier Invoices by parameters"
url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c/operations/get-supplierinvoices"
---

> Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/210b509a-613e-44ac-a87b-ef6c22c23a2c.md

# Searches Supplier Invoices by parameters

`GET` `/supplierinvoices`

Operation ID: `get-supplierinvoices`

Searches Supplier Invoices by parameters

## Query parameters

- `filter_by` (string, optional) - Filter by. Available field name values: id, supplier_invoice_number, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, status, total_buy_price_ex, distribute_costs_by, freight_total_ex, freight_includes_tax, freight_total_tax, freight_total_inc, duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc, misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc, purchase_order_supplier, purchase_order_id, total_tax, total_buy_price_inc, total_applied_buy_price_ex, supplier_invoiced_on In string values: '|' and ',' characters have to be escaped with slash, i.e. '\\,' '\\|' For operators that support multiple values (in, notin): multiple values are delimited using '|' character Available operators: eq - Equal neq - Not equals lt - Less lte - Less or equal gt - Greater gte - Greater or equal in - In notin - Not In contains - Contains isnull - Is Null isnullorempty - Is Null Or Empty isnotnull - Is Not Null startswith - Starts with endswith - Ends with doesnotcontain - Does not contain For non-nullable fields operators isnull and isnotnull are unavailable For dates operators: contains, startswith, endswith, doesnotcontain, isnullorempty are unavailable For strings operators: lt, lte, gt, gte are unavailable Example: created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432
- `order_by` (string, optional) - Order by. Available field name values: id, supplier_invoice_number, created_on, created_by_id, created_by_first_name, created_by_surname, modified_on, modified_by_id, modified_by_first_name, modified_by_surname, finalised_on, finalised_by_id, finalised_by_first_name, finalised_by_surname, status, total_buy_price_ex, distribute_costs_by, freight_total_ex, freight_includes_tax, freight_total_tax, freight_total_inc, duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc, misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc, total_tax, total_buy_price_inc, total_applied_buy_price_ex, supplier_invoiced_on Available direction values: asc, desc. Example: id asc, product_id desc
- `page_number` (integer, int32, optional)
- `page_size` (integer, int32, optional)

## Header parameters

- `x-api-key` (string, required) - Api subscription key
- `Cache-Control` (string, optional)
- `Authorization` (string, required) - Bearer token for authorization (e.g., Bearer <token>)

## Responses

- `200` - Paging Response with Supplier Invoices data
- `400` - Bad request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not found

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Retail Express API
  version: v2.1
servers:
  - url: https://api.retailexpress.com.au/v2.1
paths:
  /supplierinvoices:
    get:
      tags:
        - supplierinvoices
      summary: Searches Supplier Invoices by parameters
      description: Searches Supplier Invoices by parameters
      operationId: get-supplierinvoices
      parameters:
        - name: filter_by
          in: query
          description: "Filter by. \r

            Available field name values: id, supplier_invoice_number,
            created_on, created_by_id, created_by_first_name,
            created_by_surname, modified_on, modified_by_id,
            modified_by_first_name, modified_by_surname, finalised_on,
            finalised_by_id, finalised_by_first_name, finalised_by_surname,
            status, total_buy_price_ex, distribute_costs_by, freight_total_ex,
            freight_includes_tax, freight_total_tax, freight_total_inc,
            duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc,
            misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc,
            purchase_order_supplier, purchase_order_id, total_tax,
            total_buy_price_inc, total_applied_buy_price_ex,
            supplier_invoiced_on\r

            \            \r

            In string values: '|' and ',' characters have to be escaped with
            slash, i.e. '\\\\,' '\\\\|'\r

            \            \r

            For operators that support multiple values (in, notin): multiple
            values are delimited using '|' character\r

            \r

            Available operators:\r

            \r

            eq -  Equal\r

            \r

            neq - Not equals\r

            \r

            lt  - Less\r

            \r

            lte - Less or equal\r

            \r

            gt -  Greater\r

            \r

            gte - Greater or equal\r

            \r

            in  - In\r

            \r

            notin - Not In\r

            \            \r

            contains - Contains\r

            \r

            isnull - Is Null\r

            \            \r

            isnullorempty - Is Null Or Empty\r

            \r

            isnotnull - Is Not Null\r

            \r

            startswith - Starts with\r

            \r

            endswith - Ends with\r

            \r

            doesnotcontain - Does not contain\r

            \            \r

            For non-nullable fields operators isnull and isnotnull are
            unavailable\r

            \r

            For dates operators: contains, startswith, endswith, doesnotcontain,
            isnullorempty are unavailable\r

            \            \r

            For strings operators: lt, lte, gt, gte are unavailable\r

            \            \r

            Example:
            created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432"
          schema:
            type: string
            description: "Filter by. \r

              Available field name values: id, supplier_invoice_number,
              created_on, created_by_id, created_by_first_name,
              created_by_surname, modified_on, modified_by_id,
              modified_by_first_name, modified_by_surname, finalised_on,
              finalised_by_id, finalised_by_first_name, finalised_by_surname,
              status, total_buy_price_ex, distribute_costs_by, freight_total_ex,
              freight_includes_tax, freight_total_tax, freight_total_inc,
              duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc,
              misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc,
              purchase_order_supplier, purchase_order_id, total_tax,
              total_buy_price_inc, total_applied_buy_price_ex,
              supplier_invoiced_on\r

              \            \r

              In string values: '|' and ',' characters have to be escaped with
              slash, i.e. '\\\\,' '\\\\|'\r

              \            \r

              For operators that support multiple values (in, notin): multiple
              values are delimited using '|' character\r

              \r

              Available operators:\r

              \r

              eq -  Equal\r

              \r

              neq - Not equals\r

              \r

              lt  - Less\r

              \r

              lte - Less or equal\r

              \r

              gt -  Greater\r

              \r

              gte - Greater or equal\r

              \r

              in  - In\r

              \r

              notin - Not In\r

              \            \r

              contains - Contains\r

              \r

              isnull - Is Null\r

              \            \r

              isnullorempty - Is Null Or Empty\r

              \r

              isnotnull - Is Not Null\r

              \r

              startswith - Starts with\r

              \r

              endswith - Ends with\r

              \r

              doesnotcontain - Does not contain\r

              \            \r

              For non-nullable fields operators isnull and isnotnull are
              unavailable\r

              \r

              For dates operators: contains, startswith, endswith,
              doesnotcontain, isnullorempty are unavailable\r

              \            \r

              For strings operators: lt, lte, gt, gte are unavailable\r

              \            \r

              Example:
              created_on:gte:2021-06-03T05:48:09+10:00,created_by_id:in:2|432"
            nullable: true
        - name: order_by
          in: query
          description: "Order by. \r

            \r

            Available field name values: id, supplier_invoice_number,
            created_on, created_by_id, created_by_first_name,
            created_by_surname, modified_on, modified_by_id,
            modified_by_first_name, modified_by_surname, finalised_on,
            finalised_by_id, finalised_by_first_name, finalised_by_surname,
            status, total_buy_price_ex, distribute_costs_by, freight_total_ex,
            freight_includes_tax, freight_total_tax, freight_total_inc,
            duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc,
            misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc,
            total_tax, total_buy_price_inc, total_applied_buy_price_ex,
            supplier_invoiced_on\r

            \r

            Available direction values: asc, desc. \r

            \r

            Example: id asc, product_id desc"
          schema:
            type: string
            description: "Order by. \r

              \r

              Available field name values: id, supplier_invoice_number,
              created_on, created_by_id, created_by_first_name,
              created_by_surname, modified_on, modified_by_id,
              modified_by_first_name, modified_by_surname, finalised_on,
              finalised_by_id, finalised_by_first_name, finalised_by_surname,
              status, total_buy_price_ex, distribute_costs_by, freight_total_ex,
              freight_includes_tax, freight_total_tax, freight_total_inc,
              duty_total_ex, duty_includes_tax, duty_total_tax, duty_total_inc,
              misc_total_ex, misc_includes_tax, misc_total_tax, misc_total_inc,
              total_tax, total_buy_price_inc, total_applied_buy_price_ex,
              supplier_invoiced_on\r

              \r

              Available direction values: asc, desc. \r

              \r

              Example: id asc, product_id desc"
            nullable: true
        - name: page_number
          in: query
          schema:
            maximum: 100000
            minimum: 1
            type: integer
            format: int32
        - name: page_size
          in: query
          schema:
            maximum: 2147483647
            minimum: 1
            type: integer
            format: int32
        - name: x-api-key
          in: header
          description: Api subscription key
          required: true
          schema:
            type: string
        - name: Cache-Control
          in: header
          required: false
          schema:
            type: string
            default: no-cache
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authorization (e.g., Bearer <token>)
          schema:
            type: string
      responses:
        "200":
          description: Paging Response with Supplier Invoices data
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SupplierInvoice.PagingResponse"
              example:
                data:
                  - id: 0
                    supplier_invoice_number: string
                    status: string
                    notes: string
                    international_order: true
                    landed_costs_calculation: Manual
                    currency_conversion: 0
                    rounding_adjustment: 0
                    origin_country:
                      id: 0
                      name: string
                    distribute_costs_by: string
                    direct_costs:
                      applied_on: string
                      apply_pending: true
                      freight:
                        total_ex: 0
                        includes_tax: true
                        total_tax: 0
                        total_inc: 0
                      duty:
                        total_ex: 0
                        includes_tax: true
                        total_tax: 0
                        total_inc: 0
                      misc:
                        total_ex: 0
                        includes_tax: true
                        total_tax: 0
                        total_inc: 0
                    purchase_order_receipts:
                      - id: 0
                        purchase_order_id: 0
                        purchase_order_receipt_items:
                          - purchase_order_item_id: 0
                            buy_price_ex: 0
                            supplier_buy_ex: 0
                            quantity_received: 0
                            quantity_faulty: 0
                            quantity_invoiced: 0
                            bin: string
                            include_tax: true
                            notes: string
                    total_buy_price_ex: 0
                    total_tax: 0
                    total_buy_price_inc: 0
                    total_applied_buy_price_ex: 0
                    created_on: string
                    created_by:
                      id: 0
                      user_code: string
                      first_name: string
                      surname: string
                    modified_on: string
                    modified_by:
                      id: 0
                      user_code: string
                      first_name: string
                      surname: string
                    finalised_on: string
                    finalised_by:
                      id: 0
                      user_code: string
                      first_name: string
                      surname: string
                    supplier_invoiced_on: string
                page_number: 0
                page_size: 0
                total_records: 0
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProblemDetails"
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProblemDetails"
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProblemDetails"
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
        "404":
          description: Not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProblemDetails"
              example:
                type: string
                title: string
                status: 0
                detail: string
                instance: string
security: []
components:
  schemas:
    SupplierInvoice.PagingResponse:
      title: ""
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/SupplierInvoice"
          nullable: true
        page_number:
          type: integer
          format: int32
        page_size:
          type: integer
          format: int32
        total_records:
          type: integer
          format: int32
      additionalProperties: false
    ProblemDetails:
      title: ""
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    SupplierInvoice:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id
          format: int32
        supplier_invoice_number:
          type: string
          description: Supplier Invoice Number
          nullable: true
        status:
          type: string
          description: Supplier Invoice status
          nullable: true
        notes:
          type: string
          description: Supplier Invoice notes
          nullable: true
        international_order:
          type: boolean
          description: Is International Order
        landed_costs_calculation:
          $ref: "#/components/schemas/LandedCostsCalculation"
        currency_conversion:
          type: number
          description: Currency multiplier
          format: double
          nullable: true
        rounding_adjustment:
          type: number
          description: Rounding Adjustment
          format: double
        origin_country:
          $ref: "#/components/schemas/CountryLimited"
        distribute_costs_by:
          type: string
          description: Distribute costs by
          nullable: true
        direct_costs:
          $ref: "#/components/schemas/DirectCosts"
        purchase_order_receipts:
          type: array
          items:
            $ref: "#/components/schemas/SupplierInvoicePurchaseOrderReceipt"
          description: Purchase Order Receipts
          nullable: true
        total_buy_price_ex:
          type: number
          description: Total buy price ex
          format: double
        total_tax:
          type: number
          description: Total tax
          format: double
          nullable: true
        total_buy_price_inc:
          type: number
          description: Total buy price inc
          format: double
          nullable: true
        total_applied_buy_price_ex:
          type: number
          description: Total applied buy price ex
          format: double
          nullable: true
        created_on:
          type: string
          description: Created on
          format: date-time
        created_by:
          $ref: "#/components/schemas/UserExtended"
        modified_on:
          type: string
          description: Modified on
          format: date-time
          nullable: true
        modified_by:
          $ref: "#/components/schemas/UserExtended"
        finalised_on:
          type: string
          description: Finalised on
          format: date-time
          nullable: true
        finalised_by:
          $ref: "#/components/schemas/UserExtended"
        supplier_invoiced_on:
          type: string
          description: Supplier Invoiced On
          format: date-time
          nullable: true
      additionalProperties: false
      description: Suplier Invoice Model
    LandedCostsCalculation:
      title: ""
      enum:
        - Manual
        - Currency Conversion
      type: string
    CountryLimited:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: id
          format: int32
          nullable: true
        name:
          type: string
          description: name
          nullable: true
      additionalProperties: false
    DirectCosts:
      title: ""
      type: object
      properties:
        applied_on:
          type: string
          description: DirectCosts AppliedOn
          format: date-time
          nullable: true
        apply_pending:
          type: boolean
          description: Is DirectCosts Apply Pending
        freight:
          $ref: "#/components/schemas/DirectCostsItem"
        duty:
          $ref: "#/components/schemas/DirectCostsItem"
        misc:
          $ref: "#/components/schemas/DirectCostsItem"
      additionalProperties: false
      description: Direct costs model
    SupplierInvoicePurchaseOrderReceipt:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: PurchaseOrderReceipt Id
          format: int32
          nullable: true
        purchase_order_id:
          type: integer
          description: Purchase order identifier
          format: int32
          nullable: true
        purchase_order_receipt_items:
          type: array
          items:
            $ref: "#/components/schemas/SupplierInvoicePurchaseOrderReceiptItem"
          description: Purchase order receipts items
          nullable: true
      additionalProperties: false
      description: Supplier Invoice Purchase Order Receipt Model
    UserExtended:
      title: ""
      type: object
      properties:
        id:
          type: integer
          description: Id.
          format: int32
          nullable: true
        user_code:
          type: string
          description: User code.
          nullable: true
        first_name:
          type: string
          description: First name.
          nullable: true
        surname:
          type: string
          description: Surname.
          nullable: true
      additionalProperties: false
    DirectCostsItem:
      title: ""
      type: object
      properties:
        total_ex:
          type: number
          description: Total ex
          format: double
        includes_tax:
          type: boolean
          description: Includes tax
          nullable: true
        total_tax:
          type: number
          description: Total tax
          format: double
        total_inc:
          type: number
          description: Total inc
          format: double
      additionalProperties: false
      description: Direct Costs Item model
    SupplierInvoicePurchaseOrderReceiptItem:
      title: ""
      type: object
      properties:
        purchase_order_item_id:
          type: integer
          description: Purchase order item identifier
          format: int32
          nullable: true
        buy_price_ex:
          type: number
          description: Buy price ex
          format: double
          nullable: true
        supplier_buy_ex:
          type: number
          description: Supplier buy ex
          format: double
          nullable: true
        quantity_received:
          type: integer
          description: Quantity received
          format: int32
        quantity_faulty:
          type: integer
          description: Quantity faulty
          format: int32
        quantity_invoiced:
          type: integer
          description: Quantity invoiced
          format: int32
          nullable: true
        bin:
          type: string
          description: Bin
          nullable: true
        include_tax:
          type: boolean
          description: Include tax
          nullable: true
        notes:
          type: string
          description: Notes
          nullable: true
      additionalProperties: false
      description: Purchase order receipt item
```