REresolvepay
Invoices

List all invoices

Return a list of invoices.

get/invoices

Request

Query parameters

limitinteger

Limit the number of invoices returned.

pagestring

Specify the page of invoices returned.

invoice_status'ready_to_send' | 'open' | 'paid' | 'captured' | 'processing_payment' | 'past-due'

Filter invoices using the merchant invoice model status.

Filter invoices by the specified fields.

Filter semantics: filter[field][operator]=value.

Available filter operators:

  • eq - equal (=)
  • ne - not equal (!=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)

Filtering is allowed by the following fields:

  • number (eq)
  • order_number (eq)
  • po_number (eq)
  • customer_id (eq)
  • advance_requested (eq)
  • created_at (eq, gt, lt, gte, lte)
  • fully_paid (eq, ne)
  • fully_paid_at (eq, gt, lt, gte, lte)
  • amount_due (eq, gt, lt, gte, lte)
  • amount_balance (eq, gt, lt, gte, lte)
  • amount_pending (eq, gt, lt, gte, lte)
  • amount_refunded (eq, gt, lt, gte, lte)
  • archived (eq, ne)

Example: filter[number][eq]=100

Note: filter with the eq operator is equivalent to the following filter filter[field]=value

Response

An object with an array of results containing up to the limit. If no invoices are found, the results array will be empty.

countinteger
limitinteger
pageinteger

Example response

{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    {
      "id": "PMMlaE5wbg0",
      "source": "MERCHANT_USER",
      "order_number": "5055",
      "number": "Inv # 123",
      "po_number": "PO-555",
      "notes": "Example of additional notes for Customer.",
      "line_items": [],
      "merchant_invoice_url": "https://www.example.com/invoice.pdf",
      "resolve_invoice_url": "https://www.example.com/resolve-invoice.pdf",
      "resolve_invoice_status": "completed",
      "fully_paid": true,
      "fully_paid_at": "2020-01-01T00:00:00.730Z",
      "due_at": "2020-02-01T00:00:00.750Z",
      "original_due_at": "2020-02-01T00:00:00.750Z",
      "invoiced_at": "2020-01-01T00:00:00.750Z",
      "amount_payout_due": 4000,
      "amount_payout_paid": 2000,
      "amount_payout_pending": 1000,
      "amount_payout_refunded": 500,
      "amount_payout_balance": 500,
      "payout_fully_paid_at": "2020-01-02T00:00:00.730Z",
      "amount_balance": 2000,
      "amount_due": 4000,
      "amount_pending": 1000,
      "amount_paid": 1000,
      "amount_advance": 4000,
      "amount_additional_advance": 1000,
      "amount_advance_fee": 10.75,
      "amount_advance_fee_refund": 10.75,
      "advance_rate": 0.75,
      "advanced_at": "2020-01-02T00:00:00.730Z",
      "amount_customer_fee_total": 500,
      "amount_customer_fee_waived": 120,
      "amount_customer_fee_paid": 300,
      "amount_customer_fee_balance": 80,
      "created_at": "2020-01-02T00:00:00.730Z",
      "updated_at": "2020-01-02T00:00:00.730Z",
      "invoice_payment_url": "https://app.resolvepay.com/merchant/invoices/PMMlaE5wbg0"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.