GET
/
customer_invoices
{
  "has_more": true,
  "next_cursor": "<string>",
  "items": [
    {
      "invoice_number": "<string>",
      "currency": "AED",
      "amount": "<string>",
      "currency_amount": "<string>",
      "currency_amount_before_tax": "<string>",
      "date": "<string>",
      "deadline": "<string>",
      "currency_tax": "<string>",
      "tax": "<string>",
      "id": 123,
      "label": "<string>",
      "exchange_rate": "<string>",
      "public_file_url": "<string>",
      "filename": "<string>",
      "remaining_amount_with_tax": "<string>",
      "remaining_amount_without_tax": "<string>",
      "archived_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "v1_external_id": "<string>",
      "v2_id": 123,
      "customer": {
        "id": 123,
        "url": "<string>"
      },
      "language": "fr_FR",
      "discount": {
        "type": "relative",
        "value": "<string>"
      },
      "special_mention": "<string>",
      "pdf_invoice_free_text": "<string>",
      "pdf_invoice_subject": "<string>",
      "pdf_description": "<string>",
      "billing_subscription": {
        "id": 123,
        "url": "<string>"
      },
      "external_reference": "<string>",
      "paid": true,
      "draft": true,
      "ledger_entry": {
        "id": 123,
        "url": "<string>"
      },
      "estimate": {
        "id": 123,
        "url": "<string>"
      },
      "credited_invoice": {
        "id": 123,
        "url": "<string>"
      },
      "from_estimate_id": 123,
      "customer_invoice_template": {
        "id": 123,
        "url": "<string>"
      },
      "invoice_lines": {
        "url": "<string>"
      },
      "payments": "<any>",
      "matched_transactions": "<any>",
      "appendices": "<any>",
      "status": "incomplete",
      "transaction_reference": {
        "banking_provider": "gocardless",
        "provider_field_name": "payment_id",
        "provider_field_value": "<string>"
      }
    }
  ]
}

Query Parameters

cursor
string | null
limit
number
default:100
Required range: 1 <= x <= 2000
sort
string
filter
object[]

Response

200
application/json

200

The response is of type object.