List pending bills

GET

pending-bills

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

{
  "bills": [
    {
      "dueDate": "<string>",
      "pendingBillLineItems": [
        {
          "productKey": "<string>",
          "amount": {
            "currency": "<string>",
            "amount": 123
          },
          "quantity": 123,
          "unitNetPrice": {
            "currency": "<string>",
            "amount": 123
          },
          "netPrice": {
            "currency": "<string>",
            "amount": 123
          },
          "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
          }
        }
      ]
    }
  ]
}

Request

leaseId

string

required

Lease identifier for which pending bills will be retrieved

period

string

required

The period for pending bills, in the format “YYYY-MM-DD/YYYY-MM-DD”

Response

bills

array

Show child attributes

dueDate

date

The due date for the pending bill payment in ISO 8601 format

pendingBillLineItems

array

Show child attributes

productKey

string

The key or identifier for the product or service billed

amount

Amount Object

The amount charged for the item

Show child attributes

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

vat

object

The VAT details for the pending bill line item

Show child attributes

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 pending bill line item, in the format “YYYY-MM-DD/YYYY-MM-DD”

subtotal

object

The subtotal amount for the pending bill

Show child attributes

currency

string

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

amount

number

The subtotal amount

total

object

The total amount due for the pending bill

Show child attributes

currency

string

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

amount

number

The total amount due

vatTotals

array

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

Show child attributes

vat

object

The VAT details for the pending bill line item

Show child attributes

taxMode

string

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

taxRate

number

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

amount

object

The total amount for the VAT category

Show child attributes

currency

string

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

amount

number

The amount

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

{
  "bills": [
    {
      "dueDate": "<string>",
      "pendingBillLineItems": [
        {
          "productKey": "<string>",
          "amount": {
            "currency": "<string>",
            "amount": 123
          },
          "quantity": 123,
          "unitNetPrice": {
            "currency": "<string>",
            "amount": 123
          },
          "netPrice": {
            "currency": "<string>",
            "amount": 123
          },
          "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
          }
        }
      ]
    }
  ]
}

GET

pending-bills

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

{
  "bills": [
    {
      "dueDate": "<string>",
      "pendingBillLineItems": [
        {
          "productKey": "<string>",
          "amount": {
            "currency": "<string>",
            "amount": 123
          },
          "quantity": 123,
          "unitNetPrice": {
            "currency": "<string>",
            "amount": 123
          },
          "netPrice": {
            "currency": "<string>",
            "amount": 123
          },
          "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
          }
        }
      ]
    }
  ]
}

Request

leaseId

string

required

Lease identifier for which pending bills will be retrieved

period

string

required

The period for pending bills, in the format “YYYY-MM-DD/YYYY-MM-DD”

Response

bills

array

Show child attributes

dueDate

date

The due date for the pending bill payment in ISO 8601 format

pendingBillLineItems

array

Show child attributes

productKey

string

The key or identifier for the product or service billed

amount

Amount Object

The amount charged for the item

Show child attributes

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

vat

object

The VAT details for the pending bill line item

Show child attributes

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 pending bill line item, in the format “YYYY-MM-DD/YYYY-MM-DD”

subtotal

object

The subtotal amount for the pending bill

Show child attributes

currency

string

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

amount

number

The subtotal amount

total

object

The total amount due for the pending bill

Show child attributes

currency

string

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

amount

number

The total amount due

vatTotals

array

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

Show child attributes

vat

object

The VAT details for the pending bill line item

Show child attributes

taxMode

string

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

taxRate

number

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

amount

object

The total amount for the VAT category

Show child attributes

currency

string

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

amount

number

The amount

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

{
  "bills": [
    {
      "dueDate": "<string>",
      "pendingBillLineItems": [
        {
          "productKey": "<string>",
          "amount": {
            "currency": "<string>",
            "amount": 123
          },
          "quantity": 123,
          "unitNetPrice": {
            "currency": "<string>",
            "amount": 123
          },
          "netPrice": {
            "currency": "<string>",
            "amount": 123
          },
          "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
          }
        }
      ]
    }
  ]
}

Request

Response

API reference

Resources

List pending bills

Request

Response

​Request

​Response

API reference

Resources

​Request

​Response

Request

Response

Request

Response