GET
/
v1
/
invoices
List invoices
curl --request GET \
  --url https://api.wellapp.ai/v1/invoices
{
  "links": {
    "self": "<string>",
    "next": "<string>",
    "prev": "<string>"
  },
  "data": [
    {
      "type": "invoice",
      "id": "<string>",
      "attributes": {
        "reference_number": "<string>",
        "document_type": "commercial_invoice",
        "document_type_code": "380",
        "issue_date": "2023-12-25",
        "due_date": "2023-12-25",
        "currency": "<string>",
        "totals": {
          "items_total": 123,
          "tax_total": 123,
          "grand_total": 123
        },
        "terms": "<string>",
        "status": "draft",
        "payment_status": {
          "paid": true,
          "amount_paid": 123,
          "amount_remaining": 123
        },
        "billing_context": "<string>",
        "description": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "issuer": {
          "data": {
            "type": "<string>",
            "id": "<string>"
          }
        },
        "receiver": {
          "data": {
            "type": "<string>",
            "id": "<string>"
          }
        },
        "documents": {
          "data": [
            {
              "type": "<string>",
              "id": "<string>"
            }
          ]
        },
        "related_documents": {
          "data": [
            {
              "type": "<string>",
              "id": "<string>"
            }
          ]
        }
      },
      "links": {
        "self": "<string>"
      }
    }
  ]
}

Query Parameters

issuer_id
string

Filter invoices where the specified company is the issuer.

receiver_id
string

Filter invoices where the specified company is the receiver.

status
enum<string>

Filter invoices by status.

Available options:
draft,
sent,
paid,
cancelled
date_from
string<date>

Filter invoices issued on or after this date (YYYY-MM-DD).

date_to
string<date>

Filter invoices issued on or before this date (YYYY-MM-DD).

page[limit]
integer
default:20

Number of invoices per page.

Required range: 1 <= x <= 100
page[cursor]
string

Cursor for pagination.

Response

200 - application/vnd.api+json

Invoices retrieved successfully

The response is of type object.