Get a specific invoice

GET 
/api/v3/invoice/:invoice_id

Request

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": "",
  "details": {},
  "response": {
    "invoice_id": 98165,
    "currency_id": 1,
    "brand_id": 1,
    "terms_id": 2,
    "admin_id": 1,
    "external_key": null,
    "token": "1tslo5m9h51b",
    "refnumber": "98165",
    "cycle_pre_from_date": null,
    "cycle_pre_to_date": null,
    "cycle_this_date": null,
    "cycle_post_from_date": null,
    "cycle_post_to_date": null,
    "bill_addr1": "56 Cowles",
    "bill_addr2": "Suite 620",
    "bill_addr3": "",
    "bill_city": "Minneapolis",
    "bill_state": "MN",
    "bill_postcode": "55416",
    "bill_country": "United States",
    "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_notes": null,
    "memo": null,
    "custom_1": null,
    "custom_2": null,
    "custom_3": null,
    "custom_4": null,
    "custom_5": null,
    "write_datetime": "2019-09-26 10:16:43",
    "void_datetime": null,
    "currency_symbol": "$",
    "currency_iso4217": "USD",
    "admin_name": "ChargeOver Support",
    "invoice_status_name": "Unpaid",
    "invoice_status_str": "open-unpaid",
    "invoice_status_state": "o",
    "subtotal": 100,
    "total": 100,
    "taxes": 0,
    "credits": 0,
    "payments": 35,
    "writeoffs": 0,
    "declines": 0,
    "applied": 35,
    "sum_base": 0,
    "sum_usage": 0,
    "sum_onetime": 100,
    "is_paid": false,
    "paid_date": null,
    "balance": 65,
    "is_void": false,
    "due_date": "2019-12-20",
    "terms_name": "Net 30",
    "terms_days": 30,
    "days_overdue": 0,
    "is_overdue": false,
    "date": "2019-09-26",
    "bill_block": "56 Cowles\r\nSuite 620\r\nMinneapolis, MN 55416\r\nUnited States",
    "ship_block": "",
    "url_permalink": "http://dev1.chargeover.test/r/invoice/view/1tslo5m9h51b",
    "url_paylink": "http://dev1.chargeover.test/r/trans/pay/1tslo5m9h51b",
    "url_pdflink": "http://dev1.chargeover.test/r/invoice/pdf/1tslo5m9h51b",
    "url_self": "http://dev1.chargeover.test/admin/r/invoice/view/98165",
    "package_id": null,
    "customer_id": 3488,
    "line_items": [
      {
        "invoice_id": 98165,
        "item_id": 29,
        "tierset_id": null,
        "admin_id": null,
        "descrip": "1-month subscription to gold plan.",
        "line_rate": 100,
        "line_quantity": 1,
        "line_prorate": 1,
        "line_usage": 0,
        "usage_from": 0,
        "usage_to": 0,
        "tax_id": null,
        "tax_group_id": null,
        "tax_taxable": 100,
        "tax_taxed": 0,
        "tax_total": 0,
        "is_base": false,
        "is_free": false,
        "is_setup": false,
        "is_usage": false,
        "is_recurring": false,
        "is_latefee": false,
        "is_taxed": false,
        "custom_1": null,
        "custom_2": null,
        "custom_3": null,
        "custom_4": null,
        "custom_5": null,
        "item_name": "Gold Plan",
        "item_external_key": null,
        "item_token": "1kzl806611h1",
        "item_accounting_sku": null,
        "item_units": null,
        "tax_name": null,
        "tax_group_name": null,
        "line_subtotal": 100,
        "line_total": 100,
        "line_item_id": 234,
        "package_line_id": null,
        "package_line_external_key": null
      }
    ],
    "sent": [],
    "schedule": [
      {
        "invoice_schedule_id": 13,
        "invoice_id": 98165,
        "token": "199m59nc2k1p",
        "paymethod": "inv",
        "creditcard_id": null,
        "ach_id": null,
        "url_paylink": "http://dev1.chargeover.test/r/trans/sch/1tslo5m9h51b/199m59nc2k1p",
        "amount": 10,
        "balance": 0,
        "amount_or_percent_formatted": "$ 10.00",
        "date": "2019-09-30"
      },
      {
        "invoice_schedule_id": 16,
        "invoice_id": 98165,
        "token": "19nvqp56y146",
        "paymethod": "ach",
        "creditcard_id": null,
        "ach_id": 8,
        "url_paylink": "http://dev1.chargeover.test/r/trans/sch/1tslo5m9h51b/19nvqp56y146",
        "amount": 25,
        "balance": 25,
        "amount_or_percent_formatted": "25%",
        "date": "2019-11-20"
      }
    ]
  }
}

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
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

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

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...