BObookingexperts
Invoice PeppolDeliveries

GET peppol deliveries

Changed on

Returns peppol deliveries of a specific Invoice

get/v3/administrations/{administration_id}/invoices/{invoice_id}/peppol_deliveries

Request

Path parameters

administration_idstring required

Administration ID

invoice_idstring required

Invoice 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

fields[peppol_delivery]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[state]string

Filter on state

filter[status_code]string

Filter on status_code

filter[peppol_guid]string

Filter on peppol_guid

filter[invoice]string

Filter on invoice. 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.

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

PeppolDeliveryCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "peppol_delivery",
      "relationships": {
        "invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        }
      }
    }
  ],
  "included": [
    {
      "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"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • 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