# Get a list of invoices

Endpoint: GET /invoices
Version: 1.21
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `id` (string)
    Filter by generated invoice identifier
    Example: "0"

  - `contractOwnerId` (string)
    Filter by contract owner identifier
    Example: "0"

  - `billingCycleId` (string)
    Filter by billing cycle identifier
    Example: "0"

  - `billRunId` (string)
    Filter by bill run identifier
    Example: "0"

  - `billRunType` (string)
    Filter by bill run type
    Example: "0"

  - `billRunStatus` (string)
    Filter by bill run status
    Example: "xyz | in:x,y | like:xyz"

  - `customerId` (string)
    Filter by customer identifier
    Example: "0"

  - `siteId` (string)
    Filter by site identifier
    Example: "0"

  - `dueDate` (string)
    Filter by invoice due date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `invoiceDate` (string)
    Filter by invoice date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `paymentMethod` (string)
    Filter by payment method
    Example: "xyz | in:x,y | like:xyz"

  - `mandateStatus` (string)
    Filter by mandate status
    Example: "xyz | in:x,y | like:xyz"

  - `paymentStatus` (string)
    Filter by invoice payment status
    Example: "xyz | in:x,y | like:xyz"

  - `thirdPartyPaymentStatus` (string)
    Filter by invoice payment status of the integrated payment provider
    Example: "xyz | in:x,y | like:xyz"

  - `invoiceNumber` (string)
    Filter by invoice number
    Example: "xyz | in:x,y | like:xyz"

  - `createdDate` (string)
    Filter by created date
    Example: "xyz | in:x,y | like:xyz"

  - `thirdPartyPaymentStatusUpdatedTime` (string)
    Filter by third party payment status updated date and time
    Example: "xyz | in:x,y | like:xyz"

  - `paymentStatusUpdatedDate` (string)
    Filter by payment status updated date
    Example: "xyz | in:x,y | like:xyz"

  - `refundStatusUpdatedDate` (string)
    Filter by refund status updated date
    Example: "xyz | in:x,y | like:xyz"

  - `thirdPartyRefundStatus` (string)
    Filter by third party refund status
    Example: "xyz | in:x,y | like:xyz"

  - `paymentStatusUpdatedTime` (string)
    Filter by payment status updated date and time
    Example: "xyz | in:x,y | like:xyz"

## Response 200 fields (application/json):

  - `id` (integer)
    Invoice identifier
    Example: 1

  - `invoiceSummaryId` (integer)
    Invoice summary identifier
    Example: 1

  - `contractOwnerId` (integer)
    Contract owner identifier

  - `billingCycleId` (integer)
    Billing cycle identifier

  - `billRunId` (integer)
    Bill run identifier

  - `billRunType` (string)
    Billing run type
    Enum: "NORMAL", "ADHOC"

  - `billRunStatus` (string)
    Bill run status
    Enum: "OPEN", "CLOSED", "FINALIZED"

  - `customerId` (integer)
    Customer identifier

  - `siteId` (integer)
    Site identifier

  - `dueDate` (string)
    Invoice due date

  - `invoiceDate` (string)
    Invoice date

  - `createdDate` (string)
    Invoice created date

  - `thirdPartyPaymentStatusUpdatedTime` (string)
    Invoice thirdPartyPaymentStatus updated date and time

  - `paymentStatusUpdatedDate` (string)
    Invoice paymentStatus updated date (deprecated and can be removed in future releases, use paymentStatusUpdatedTime instead)

  - `paymentStatusUpdatedTime` (string)
    Invoice paymentStatus updated date and time

  - `refundStatusUpdatedDate` (string)
    Invoice thirdPartyRefundStatus updated date

  - `paymentMethod` (string)
    Payment method
    Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER"

  - `mandateStatus` (string)
    Invoice payment status
    Enum: "NEW", "INACTIVE", "CREATED", "CUSTOMER_APPROVAL_GRANTED", "CUSTOMER_APPROVAL_SKIPPED", "ACTIVE", "CANCELLED", "FAILED", "TRANSFERRED", "EXPIRED", "SUBMITTED", "RESUBMISSION_REQUESTED", "PENDING_SUBMISSION", "REINSTATED", "REPLACED", "PENDING_CUSTOMER_APPROVAL", "CONSUMED", "BLOCKED", "UNKNOWN"

  - `paymentStatus` (string)
    Invoice payment status
    Enum: "NA", "PAID", "UNPAID", "PENDING", "REFUNDED", "PART_REFUNDED", "REFUND_PENDING", "WRITTEN_OFF", "DISPUTED", "PARTIALLY_PAID"

  - `thirdPartyPaymentStatus` (string)
    Invoice payment status. Not applicable for manual payments
    Enum: "NEW", "CREATED", "PENDING_CUSTOMER_APPROVAL", "PENDING_SUBMISSION", "SUBMITTED", "CONFIRMED", "PAID_OUT", "CANCELLED", "FAILED", "FAILED_RETRYING", "CHARGED_BACK", "CUSTOMER_APPROVAL_GRANTED", "CUSTOMER_APPROVAL_DENIED", "CHARGEBACK_CANCELLED", "LATE_FAILURE_SETTLED", "CHARGEBACK_SETTLED", "SURCHARGE_FEE_DEBITED", "RESUBMISSION_REQUESTED", "UNSUPPORTED_PAYMENT_TYPE", "UNAUTHORISED_PAYMENT_TYPE", "CUSTOMER_APPROVAL_MISSING", "SURCHARGE_FEE_CREDITED", "MANUALLY_PAID", "UNSENT", "REFUNDED", "PARTIALLY_REFUNDED", "REFUND_PENDING"

  - `thirdPartyRefundStatus` (string)
    Third party refund status
    Enum: "CREATED", "PENDING_SUBMISSION", "SUBMITTED", "PAID", "CANCELLED", "BOUNCED", "FUNDS_RETURNED", "MANUALLY_REFUNDED", "REFUND_SETTLED"

  - `invoiceNumber` (string)
    Invoice Number

  - `invoiceTotalAmount` (number)
    Invoice total amount

  - `invoiceTaxAmount` (number)
    Invoice total tax amount

  - `taxExempt` (boolean)
    Invoice is tax exempt

  - `purchaseOrderNumber` (string)
    Purchase Order Number

  - `invoiceRemainingAmount` (number)
    Invoice remaining amount

  - `totalRentalAmount` (number)
    Invoice total rental charge amount

  - `totalRentalTaxAmount` (number)
    Invoice total rental charge tax amount

  - `totalUsageAmount` (number)
    Invoice total usage charge amount

  - `totalUsageTaxAmount` (number)
    Invoice total usage charge tax amount

  - `usageBreakdown` (array)

  - `usageBreakdown.usageProductId` (integer)
    Usage Product identifier

  - `usageBreakdown.chargeGroupCategoryId` (integer)
    Charge group category identifier

  - `usageBreakdown.taxBandId` (integer)
    Tax Band identifier

  - `usageBreakdown.costPrice` (number)
    Net unrated cost price

  - `usageBreakdown.sellPrice` (number)
    Net rated sell price

  - `usageBreakdown.taxAmount` (number)
    Tax amount

  - `usageBreakdown.ratedCostPrice` (number)
    Net rated cost price

  - `totalAdhocAmount` (number)
    Invoice total adhoc charge amount

  - `totalAdhocTaxAmount` (number)
    Invoice total adhoc charge tax amount

  - `totalBoltOnAmount` (number)
    Invoice total bolt-on charge amount

  - `totalBoltOnTaxAmount` (number)
    Invoice total bolt-on charge tax amount

  - `totalReverseVatAmount` (number)
    Invoice total reverse-vat charge amount

  - `paymentRetryCount` (integer)
    Number of payment retries attempted


## Response 400 fields

## Response 401 fields

## Response 403 fields