Query for invoices

GET 
/api/v3/invoice

Available query parameter values for filtering:

• invoice_id
• refnumber
• customer_id
• bill_state
• ship_state
• bill_country
• ship_country
• invoice_status_str - See the list of valid values below
• invoice_status_state - See the list of valid values below
• package_token
• package_id
• invoice_index
• date
• currency_id
• token
• custom_1
• custom_2
• custom_3
• line_items.item_id
• line_items.custom_1
• line_items.custom_2
• line_items.custom_3
• line_items.item.categories.item_category_id
• transaction.transaction_id - Get a list of invoices paid by this transaction
• quote.quote_id - Get the invoice that originated from a specific quote
• write_datetime - date/time created
• mod_datetime - date/time last modified

Valid values for invoice_status_str:

• open-unpaid
• open-overdue
• open-collections
• closed-void
• closed-paid

Valid values for invoice_status_state:

• o (any “open” invoice, i.e. anything with money due)
• c (any “closed” invoice, i.e. anything without money due)

By default, only the overview invoice details are returned (i.e. no individual line items). If you get a specific invoice by invoice id value (e.g. GET /api/v3/invoice/1234) you’ll get back the invoice line items.

Request

Query Parameters

where string

customer_id:EQUALS:1000

order string

customer_id:ASC

limit string

2

offset string

8

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response object

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {}
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "invoice_id": "2688",
      "bill_addr1": null,
      "bill_addr2": null,
      "bill_addr3": null,
      "bill_city": null,
      "bill_state": null,
      "bill_postcode": null,
      "bill_country": null,
      "bill_email": null,
      "bill_notes": null,
      "ship_addr1": null,
      "ship_addr2": null,
      "ship_addr3": null,
      "ship_city": null,
      "ship_state": null,
      "ship_postcode": null,
      "ship_country": null,
      "ship_email": null,
      "ship_notes": null,
      "write_datetime": "2012-11-09 18:10:03",
      "void_datetime": null,
      "invoice_status_name": "Unpaid",
      "invoice_status_str": "open-unpaid",
      "invoice_status_state": "o",
      "total": 150,
      "credits": 0,
      "payments": 0,
      "is_paid": false,
      "balance": 150,
      "is_void": false,
      "bill_block": "",
      "ship_block": "",
      "url_permalink": "https://dev.chargeover.com/r/invoice/view/i17fq4huy2ar",
      "url_pdflink": "https://dev.chargeover.com/r/invoice/pdf/i17fq4huy2ar",
      "customer_id": "1"
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...