Invoices

Returns invoices of the administration

get/v3/administrations/{administration_id}/invoices

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, created_at, updated_at

fields[invoice]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[date]string

Filter on date

filter[type]string

Filter on type

filter[invoice_nr]string

Filter on invoice_nr

filter[company]string

Filter on company

filter[country_code]string

Filter on country_code

filter[city]string

Filter on city

filter[address_line_1]string

Filter on address_line_1

filter[address_line_2]string

Filter on address_line_2

filter[postalcode]string

Filter on postalcode

filter[address_subdivision]string

Filter on address_subdivision

filter[memo]string

Filter on memo

filter[period_start_date]string

Filter on period_start_date

filter[period_end_date]string

Filter on period_end_date

filter[total]string

Filter on total

filter[last_sent]string

Filter on last_sent

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[owner]string

Filter on owner. Specify a comma separated list of IDs to filter on.

filter[invoice_items]string

Filter on invoice_items. Specify a comma separated list of IDs to filter on.

filter[debtor]string

Filter on debtor. Specify a comma separated list of IDs to filter on.

filter[administration]string

Filter on administration. Specify a comma separated list of IDs to filter on.

filter[booking]string

Filter on booking. Specify a comma separated list of IDs to filter on.

filter[inventory_objects]string

Filter on inventory_objects. Specify a comma separated list of IDs to filter on.

filter[credited_invoice]string

Filter on credited_invoice. Specify a comma separated list of IDs to filter on.

filter[previous_invoice]string

Filter on previous_invoice. Specify a comma separated list of IDs to filter on.

filter[payments]string

Filter on payments. Specify a comma separated list of IDs to filter on.

filter[security_deposits]string

Filter on security_deposits. Specify a comma separated list of IDs to filter on.

filter[sent]boolean

Filter on sent. When false, concept invoices will be returned.

filter[paid]boolean

Filter on paid. When true, only fully paid invoices will be returned. When false, only invoices with an outstanding amount (either direction) will be returned.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

InvoiceCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "invoice",
      "relationships": {
        "owner": {
          "data": {
            "type": "owner"
          }
        },
        "invoice_items": {
          "data": [
            {
              "type": "invoice_item"
            }
          ]
        },
        "debtor": {
          "data": {
            "type": "debtor"
          }
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "reservation": {
          "data": {
            "type": "reservation"
          }
        },
        "booking": {
          "data": {
            "type": "booking"
          }
        },
        "inventory_objects": {
          "data": [
            {
              "type": "inventory_object"
            }
          ]
        },
        "credited_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "previous_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "payments": {
          "data": [
            {
              "type": "payment"
            }
          ]
        },
        "security_deposits": {
          "data": [
            {
              "type": "security_deposit"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "owner",
      "attributes": {
        "title": "mr",
        "locale": "cs",
        "country_code": "NL"
      },
      "relationships": {
        "primary_contact": {
          "data": {
            "type": "contact"
          }
        },
        "contacts": {
          "data": [
            {
              "type": "contact"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "active_inventory_objects": {
          "data": [
            {
              "type": "inventory_object"
            }
          ]
        },
        "owner_guests": {
          "data": [
            {
              "type": "owner_guest"
            }
          ]
        },
        "active_rentable_identities": {
          "data": {
            "type": "rentable_identity"
          }
        },
        "labels": {
          "data": [
            {
              "type": "label"
            }
          ]
        }
      }
    }
  ]
}

Changes

    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • info

      added the new optional query request parameter filter[debtor]

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added to the / response property anyOf list for the response status