List bills

GET

bills

curl --request GET \
  --url https://api.helloproper.com/bills \
  --header 'Authorization: <api-key>'

{
  "bills": [
    {
      "id": "<string>",
      "leaseId": "<string>",
      "created": "<string>",
      "modified": "<string>",
      "period": "<string>",
      "dueDate": "<string>",
      "billLineItems": {
        "id": "<string>",
        "amount": {
          "currency": "<string>",
          "amount": 123
        },
        "quantity": 123,
        "unitNetPrice": {
          "currency": "<string>",
          "amount": 123
        },
        "netPrice": {
          "currency": "<string>",
          "amount": 123
        },
        "productKey": "<string>",
        "productName": {
          "en": "<string>",
          "da": "<string>",
          "nl": "<string>",
          "de": "<string>"
        },
        "vat": {
          "taxMode": "<string>",
          "taxRate": 123
        },
        "accountingPeriod": "<string>"
      },
      "subtotal": {
        "currency": "<string>",
        "amount": 123
      },
      "total": {
        "currency": "<string>",
        "amount": 123
      },
      "vatTotals": {
        "vat": {
          "taxMode": "<string>",
          "taxRate": 123
        },
        "amount": {
          "currency": "<string>",
          "amount": 123
        }
      },
      "postedOn": "<string>",
      "annulledOn": "<string>",
      "invoiceNumber": 123,
      "creditNoteNumber": 123
    }
  ]
}

Request

This request supports pagination.

Response

bills

array

Show child attributes

string

The unique identifier for the bill

leaseId

string

The identifier for the lease associated with the bill

created

date

The creation date and time of the bill in ISO 8601 format

modified

date

The last modification date and time of the bill in ISO 8601 format

period

string

The billing period covered by the bill, in the format “YYYY-MM-DD/YYYY-MM-DD”

dueDate

date

The due date for the bill payment in ISO 8601 format

billLineItems

Array of Bill Line Item Objects

Show properties of Bill Line Item Object

string

The unique identifier for the bill line item

amount

Amount Object

The amount charged for the item

Show properties of Amount Object

currency

string

The currency code for the amount (e.g., “DKK”)

amount

number

The amount charged

quantity

Number

The quantity of items billed

unitNetPrice

Amount Object

The unit net price charged for the item

Show properties of Amount Object

currency

string

The currency code for the amount (e.g., “DKK”)

amount

number

The amount charged

netPrice

Amount Object

The net price charged for the item

Show properties of Amount Object

currency

string

The currency code for the amount (e.g., “DKK”)

amount

number

The amount charged

productKey

string

The key or identifier for the product or service billed

productName

Localised String Object

The name of the product or service in different languages

Show properties

string

The English name of the product or service

string

The Danish name of the product or service

string

The Dutch name of the product or service

string

The German name of the product or service

vat

VAT Object

The VAT details for the bill line item

Show properties of VAT Object

taxMode

string

The tax mode for the VAT (e.g., “Exempt”)

taxRate

number

The tax rate for the VAT (e.g., 0.25)

accountingPeriod

string

The accounting period for the bill line item, in the format “YYYY-MM-DD/YYYY-MM-DD”

subtotal

Amount Object

The subtotal amount for the bill

Show properties of Amount Object

currency

string

The currency code for the subtotal (e.g., “DKK”)

amount

number

The subtotal amount

total

Amount Object

The total amount due for the bill

Show properties of Amount Object

currency

string

The currency code for the total (e.g., “DKK”)

amount

number

The total amount due

vatTotals

Array of VAT Total Objects

The total VAT amounts for the bill, split by different VAT rates or categories

Show properties of VAT Total Object

vat

VAT Object

The VAT details for the bill line item

Show properties of VAT Object

taxMode

string

The tax mode for the VAT (e.g., “Exempt”)

taxRate

number

The tax rate for the VAT (e.g., 0.25)

amount

Amount Object

The total amount for the VAT category

Show properties of Amount Object

currency

string

The currency code for the amount (e.g., “DKK”)

amount

number

The amount

postedOn

date

The date in ISO 8601 format when bill was posted

annulledOn

date

The date in ISO 8601 format when bill was annulled

invoiceNumber

long

The number of the invoice corresponding to the bill

creditNoteNumber

long

The number of the credit note corresponding to the bill

curl --request GET \
  --url https://api.helloproper.com/bills \
  --header 'Authorization: <api-key>'

{
  "bills": [
    {
      "id": "<string>",
      "leaseId": "<string>",
      "created": "<string>",
      "modified": "<string>",
      "period": "<string>",
      "dueDate": "<string>",
      "billLineItems": {
        "id": "<string>",
        "amount": {
          "currency": "<string>",
          "amount": 123
        },
        "quantity": 123,
        "unitNetPrice": {
          "currency": "<string>",
          "amount": 123
        },
        "netPrice": {
          "currency": "<string>",
          "amount": 123
        },
        "productKey": "<string>",
        "productName": {
          "en": "<string>",
          "da": "<string>",
          "nl": "<string>",
          "de": "<string>"
        },
        "vat": {
          "taxMode": "<string>",
          "taxRate": 123
        },
        "accountingPeriod": "<string>"
      },
      "subtotal": {
        "currency": "<string>",
        "amount": 123
      },
      "total": {
        "currency": "<string>",
        "amount": 123
      },
      "vatTotals": {
        "vat": {
          "taxMode": "<string>",
          "taxRate": 123
        },
        "amount": {
          "currency": "<string>",
          "amount": 123
        }
      },
      "postedOn": "<string>",
      "annulledOn": "<string>",
      "invoiceNumber": 123,
      "creditNoteNumber": 123
    }
  ]
}

GET

bills

curl --request GET \
  --url https://api.helloproper.com/bills \
  --header 'Authorization: <api-key>'

{
  "bills": [
    {
      "id": "<string>",
      "leaseId": "<string>",
      "created": "<string>",
      "modified": "<string>",
      "period": "<string>",
      "dueDate": "<string>",
      "billLineItems": {
        "id": "<string>",
        "amount": {
          "currency": "<string>",
          "amount": 123
        },
        "quantity": 123,
        "unitNetPrice": {
          "currency": "<string>",
          "amount": 123
        },
        "netPrice": {
          "currency": "<string>",
          "amount": 123
        },
        "productKey": "<string>",
        "productName": {
          "en": "<string>",
          "da": "<string>",
          "nl": "<string>",
          "de": "<string>"
        },
        "vat": {
          "taxMode": "<string>",
          "taxRate": 123
        },
        "accountingPeriod": "<string>"
      },
      "subtotal": {
        "currency": "<string>",
        "amount": 123
      },
      "total": {
        "currency": "<string>",
        "amount": 123
      },
      "vatTotals": {
        "vat": {
          "taxMode": "<string>",
          "taxRate": 123
        },
        "amount": {
          "currency": "<string>",
          "amount": 123
        }
      },
      "postedOn": "<string>",
      "annulledOn": "<string>",
      "invoiceNumber": 123,
      "creditNoteNumber": 123
    }
  ]
}

Request

This request supports pagination.

Response

bills

array

Show child attributes

string

The unique identifier for the bill

leaseId

string

The identifier for the lease associated with the bill

created

date

The creation date and time of the bill in ISO 8601 format

modified

date

The last modification date and time of the bill in ISO 8601 format

period

string

The billing period covered by the bill, in the format “YYYY-MM-DD/YYYY-MM-DD”

dueDate

date

The due date for the bill payment in ISO 8601 format

billLineItems

Array of Bill Line Item Objects

Show properties of Bill Line Item Object

string

The unique identifier for the bill line item

amount

Amount Object

The amount charged for the item

Show properties of Amount Object

currency

string

The currency code for the amount (e.g., “DKK”)

amount

number

The amount charged

quantity

Number

The quantity of items billed

unitNetPrice

Amount Object

The unit net price charged for the item

Show properties of Amount Object

currency

string

The currency code for the amount (e.g., “DKK”)

amount

number

The amount charged

netPrice

Amount Object

The net price charged for the item

Show properties of Amount Object

currency

string

The currency code for the amount (e.g., “DKK”)

amount

number

The amount charged

productKey

string

The key or identifier for the product or service billed

productName

Localised String Object

The name of the product or service in different languages

Show properties

string

The English name of the product or service

string

The Danish name of the product or service

string

The Dutch name of the product or service

string

The German name of the product or service

vat

VAT Object

The VAT details for the bill line item

Show properties of VAT Object

taxMode

string

The tax mode for the VAT (e.g., “Exempt”)

taxRate

number

The tax rate for the VAT (e.g., 0.25)

accountingPeriod

string

The accounting period for the bill line item, in the format “YYYY-MM-DD/YYYY-MM-DD”

subtotal

Amount Object

The subtotal amount for the bill

Show properties of Amount Object

currency

string

The currency code for the subtotal (e.g., “DKK”)

amount

number

The subtotal amount

total

Amount Object

The total amount due for the bill

Show properties of Amount Object

currency

string

The currency code for the total (e.g., “DKK”)

amount

number

The total amount due

vatTotals

Array of VAT Total Objects

The total VAT amounts for the bill, split by different VAT rates or categories

Show properties of VAT Total Object

vat

VAT Object

The VAT details for the bill line item

Show properties of VAT Object

taxMode

string

The tax mode for the VAT (e.g., “Exempt”)

taxRate

number

The tax rate for the VAT (e.g., 0.25)

amount

Amount Object

The total amount for the VAT category

Show properties of Amount Object

currency

string

The currency code for the amount (e.g., “DKK”)

amount

number

The amount

postedOn

date

The date in ISO 8601 format when bill was posted

annulledOn

date

The date in ISO 8601 format when bill was annulled

invoiceNumber

long

The number of the invoice corresponding to the bill

creditNoteNumber

long

The number of the credit note corresponding to the bill

curl --request GET \
  --url https://api.helloproper.com/bills \
  --header 'Authorization: <api-key>'

{
  "bills": [
    {
      "id": "<string>",
      "leaseId": "<string>",
      "created": "<string>",
      "modified": "<string>",
      "period": "<string>",
      "dueDate": "<string>",
      "billLineItems": {
        "id": "<string>",
        "amount": {
          "currency": "<string>",
          "amount": 123
        },
        "quantity": 123,
        "unitNetPrice": {
          "currency": "<string>",
          "amount": 123
        },
        "netPrice": {
          "currency": "<string>",
          "amount": 123
        },
        "productKey": "<string>",
        "productName": {
          "en": "<string>",
          "da": "<string>",
          "nl": "<string>",
          "de": "<string>"
        },
        "vat": {
          "taxMode": "<string>",
          "taxRate": 123
        },
        "accountingPeriod": "<string>"
      },
      "subtotal": {
        "currency": "<string>",
        "amount": 123
      },
      "total": {
        "currency": "<string>",
        "amount": 123
      },
      "vatTotals": {
        "vat": {
          "taxMode": "<string>",
          "taxRate": 123
        },
        "amount": {
          "currency": "<string>",
          "amount": 123
        }
      },
      "postedOn": "<string>",
      "annulledOn": "<string>",
      "invoiceNumber": 123,
      "creditNoteNumber": 123
    }
  ]
}

Request

Response

API reference

Resources

List bills

Request

Response

​Request

​Response

API reference

Resources

​Request

​Response

Request

Response

Request

Response