List invoice records

GET /invoices

Retrieve a paginated collection of Invoices belonging to your Organization

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Query parameters

  • page_size integer

    Results per page (max 50)

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses

GET /invoices
curl \
 -X GET https://api.arta.io/invoices \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
{
  "items": [
    {
      "id": 2216,
      "status": "closed",
      "issued_on": "2021-03-10",
      "created_at": "2021-03-10T20:15:34.096258",
      "updated_at": "2021-03-10T20:16:10.202836",
      "amount_owed": "276.91",
      "amount_paid": "276.91",
      "invoice_url": null,
      "shipment_id": "53d6bdec-1eae-46e2-97c2-3e56b1a1095d",
      "amount_owed_currency": "USD",
      "amount_paid_currency": "USD"
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}