Count draft, overdue and total invoices

GET

/api/v1/invoices/dashboard/quick-actions

curl --request GET \
  --url https://api.pitch2sale.com/api/v1/invoices/dashboard/quick-actions \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Responses

200

Counts for the quick-action tiles

Media typeapplication/json

object

draft_count

required

number

overdue_count

required

number

total_count

required

number

key

additional properties

any

Example^generated

{
  "draft_count": 1,
  "overdue_count": 1,
  "total_count": 1
}

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}