invoices

QUERY

Returns invoices.

Arguments

query

SqlQuery

The query to filter the invoices with based on Pay Theory defined data.

limit

Int

The number of invoices to return.

offset

String

The value of the offset item for which the list is being sorted.

direction

MoveDirection

The direction of the pagination. Makes sure the results are returned in the correct order.

Values

BACKWARDFORWARD

offset_id

String

The invoice_id of the offset item.

Response

Invoices

items

[Invoice]| null

List of Invoices.

total_row_count

Int| null

Total number of rows matching the query.

Examples

Get a paid invoice

Gets the invoice after createOfflineTransaction. status is PAID and total_paid_amount equals invoice_amount.

SUCCESS 200

GRAPHQL

query Invoices($query: SqlQuery, $limit: Int) {
  invoices(query: $query, limit: $limit) {
    items {
      invoice_id
      merchant_uid
      invoice_name
      invoice_description
      invoice_amount
      total_paid_amount
      currency
      status
      fee_mode
      due_by
      invoice_date
      merchant_invoice_number
      account_code
      reference
      created_date
      settings {
        is_secure
        security_pin
        require_payor_address
        accepted_payment_methods { ach card cash }
      }
      payor {
        payor_id
        full_name
        email
        merchant_uid
      }
      metadata
      offline_transactions { instance_id amount type note transaction_date }
    }
    total_row_count
  }
}