List invoices for current user

GET /api/v1/documents/contracts/invoices

List invoices for current user

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/documents/contracts/invoices \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hevn.finance/api/v1/documents/contracts/invoices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hevn.finance/api/v1/documents/contracts/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "invoices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "onchainTransactionId": "<string>",
      "transaction": {
        "onchainTransactionId": "<string>",
        "amount": 123,
        "txHash": "<string>",
        "type": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "discount": "<string>",
      "comment": "<string>",
      "emailMessage": "<string>",
      "invoiceNumber": "<string>",
      "periodNumber": 123,
      "issuedDate": "2023-12-25",
      "dueDate": "2023-12-25",
      "items": [
        {}
      ],
      "paymentMethods": [
        {
          "bankName": "<string>",
          "ibanNumber": "<string>",
          "beneficiaryName": "<string>",
          "bankAddress": "<string>",
          "currency": "<string>",
          "accountHolderFirstName": "<string>",
          "accountHolderLastName": "<string>",
          "accountHolderBusinessName": "<string>",
          "accountHolderAddress": {
            "streetAddress": "<string>",
            "addressLine2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "zip": "<string>"
          },
          "paymentReference": "<string>",
          "accountType": "sepa",
          "bic": "<string>"
        }
      ],
      "client": {
        "email": "<string>",
        "displayName": "<string>",
        "address": {
          "streetAddress": "<string>",
          "addressLine2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>"
        }
      },
      "contractor": {
        "email": "<string>",
        "displayName": "<string>",
        "address": {
          "streetAddress": "<string>",
          "addressLine2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zip": "<string>"
        }
      },
      "contract": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "isRecurring": true,
        "period": "<string>",
        "activationAt": "2023-11-07T05:31:56Z",
        "expirationAt": "2023-11-07T05:31:56Z"
      },
      "invoiceLink": "<string>",
      "documents": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "key": "<string>"
        }
      ],
      "paidAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Response

200

application/json

Successful Response

List of invoices.

invoices · InvoiceResponse · object[] · required

Show child attributes