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.

Retrieve an invoice

GET
/api/v1/invoices/{id}
curl --request GET \
  --url https://api.pitch2sale.com/api/v1/invoices/example \
  --header 'Authorization: Bearer <token>'

Includes the invoice’s payments for the payment history.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

The invoice

Media typeapplication/json
object
invoice
required
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
Examplegenerated
{
  "invoice": {
    "_id": "example",
    "invoice_number": "example",
    "status": "example",
    "lead_id": "example",
    "lead_name": "example",
    "total": 1,
    "amount_paid": 1,
    "balance_due": 1
  }
}

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"
    }
  ]
}