v2

latestOpenAPI 3.0.02026-08-08112115411.4 KB

Invoices

Get a list of invoices

get/invoices

Query parameters

filter[lead]string

Filter invoices by lead

filter[dateMin]string

Filter invoices created after this date. Date expected in the format YYYY-MM-DD

filter[dateMax]string

Filter invoices created before this date. Date expected in the format YYYY-MM-DD

page[limit]string

Limit the number of results returned, for pagination.

page[page]string

Request a specific page of results, for pagination. Used in conjunction with the page[limit] parameter. Indexing is 0-based.

Response

A list of invoices

linksobject

Pagination links

Example response

{
  "invoices": [
    {
      "id": "789-quotes",
      "type": "invoices",
      "number": "1000-01",
      "displayStatus": "ACCEPTED",
      "total": {
        "amount": "3200.50",
        "currency": "USD",
        "formatted": "$3,200.50"
      },
      "productLineItems": [
        {
          "id": "1-quoteProductLineItems",
          "position": 0,
          "product": "100-products",
          "name": "Consulting Services",
          "description": "Monthly consulting retainer",
          "sku": "CONS-001",
          "quantity": 2,
          "term": null,
          "price": {
            "amount": "1500.00",
            "currency": "USD",
            "formatted": "$1,500.00"
          },
          "total": {
            "amount": "3000.00",
            "currency": "USD",
            "formatted": "$3,000.00"
          },
          "discountUnit": null,
          "discountNumber": null
        }
      ],
      "subtotalLineItems": [
        {
          "id": "1-quoteSubtotalLineItems",
          "position": 0,
          "label": "Tax",
          "modifierUnit": "%",
          "modifierValue": 6.5,
          "operation": "+",
          "total": {
            "amount": "200.50",
            "currency": "USD",
            "formatted": "$200.50"
          }
        }
      ],
      "recipient": {
        "id": "321-contacts",
        "name": "Jane Doe",
        "email": "jane@example.com"
      },
      "validThroughTime": "2024-12-31T23:59:59Z",
      "createdTime": "2024-01-15T10:30:00Z",
      "publishedTime": "2024-01-16T14:20:00Z",
      "sentTime": "2024-01-17T09:15:00Z",
      "paidTime": "2024-01-20T16:45:00Z",
      "acceptedName": "Jane Customer",
      "acceptedEmail": "jane@example.com",
      "completionComment": "Paid via ACH",
      "deletedTime": null,
      "links": {
        "lead": "456-leads"
      }
    },
    {
      "id": "790-quotes",
      "type": "invoices",
      "number": "1000-02",
      "displayStatus": "SENT",
      "total": {
        "amount": "1500.00",
        "currency": "USD",
        "formatted": "$1,500.00"
      },
      "productLineItems": [
        {
          "id": "2-quoteProductLineItems",
          "position": 0,
          "product": "101-products",
          "name": "Setup Fee",
          "description": "One-time setup",
          "sku": "SETUP-001",
          "quantity": 1,
          "term": null,
          "price": {
            "amount": "1500.00",
            "currency": "USD",
            "formatted": "$1,500.00"
          },
          "total": {
            "amount": "1500.00",
            "currency": "USD",
            "formatted": "$1,500.00"
          },
          "discountUnit": null,
          "discountNumber": null
        }
      ],
      "subtotalLineItems": [],
      "recipient": {
        "id": "322-contacts",
        "name": "John Smith",
        "email": "john@example.com"
      },
      "validThroughTime": "2024-11-30T23:59:59Z",
      "createdTime": "2024-02-01T08:00:00Z",
      "publishedTime": "2024-02-02T10:00:00Z",
      "sentTime": "2024-02-03T11:00:00Z",
      "paidTime": null,
      "acceptedName": null,
      "acceptedEmail": null,
      "completionComment": null,
      "deletedTime": null,
      "links": {
        "lead": "457-leads"
      }
    }
  ],
  "meta": {
    "instanceId": "12345"
  },
  "links": {
    "self": "/rest/invoices?page[page]=0&page[limit]=25",
    "first": "/rest/invoices?page[page]=0&page[limit]=25",
    "last": "/rest/invoices?page[page]=0&page[limit]=25"
  }
}