Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

List invoices

GET
/api/v1/invoices
curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/invoices?page=1&limit=25&status=draft&sort=created_at' \
  --header 'Authorization: Bearer <token>'

Paginated; filter by lead_id, status, search (invoice number) and date ranges. Limited to the invoices the caller may view (own, team or all). Each invoice carries lead_name, contact_name, grand_total, balance_due and issue_date.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
number
default: 1 >= 1
limit
number
default: 25 >= 1 <= 100
lead_id
string
/^[0-9a-fA-F]{24}$/
status
string
Allowed values: draft sent viewed partial paid overdue cancelled
search
string
<= 200 characters
sort
string
Allowed values: created_at -created_at due_date -due_date total -total invoice_number -invoice_number
date_from
string
<= 40 characters
date_to
string
<= 40 characters

Responses

Section titled “Responses”

200

Section titled “200”

A page of invoices

Media typeapplication/json
object
invoices
required
Array<object>
object
_id
required
string
invoice_number
required
string
status
required
string
lead_id
required
string
lead_name
required
string | null
total
required
number
amount_paid
required
number
balance_due
required
number
key
additional properties
any
total
required
number
page
required
number
limit
required
number
totalPages
required
number
Examplegenerated
{
  "invoices": [
    {
      "_id": "example",
      "invoice_number": "example",
      "status": "example",
      "lead_id": "example",
      "lead_name": "example",
      "total": 1,
      "amount_paid": 1,
      "balance_due": 1
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1,
  "totalPages": 1
}

400

Section titled “400”

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “401”

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “403”

Role permission or token scope missing

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}