Skip to content
digizeDocs

List invoices

GET
/api/v1/invoices
curl --request GET \
  --url https://digize.com/api/v1/invoices \
  --header 'x-api-key: <x-api-key>'

Invoices, the newest first, up to 1,000. Sent or viewed ones past their due date read as overdue.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
rows
required
Array<object>
object
id
required
string
number
required
string
contact
required
object
id
required

The contact’s id.

string
name
required
string
email
required
string
company
required
string | null
lines
required
Array<object>
object
id
required
string
description
required
string
quantity
required
number
unitPrice
required

In the workspace currency’s minor unit: 2000 is $20.00.

integer
<= 100000000
discount
required

Taken off the subtotal before tax.

integer
<= 100000000
taxRate
required

Percent: 8.25 is 8.25%.

number
notes
required
string | null
status
required
string
Allowed values: draft sent viewed paid overdue void
issuedAt
required
string format: date-time
dueAt
required
string format: date-time
sentAt
required
Any of:
string format: date-time
viewedAt
required
Any of:
string format: date-time
paidAt
required
Any of:
string format: date-time
paymentUrl
required

Where the customer pays it online.

string
total
required
number

Example 

{
  "rows": [
    {
      "status": "draft"
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}