Skip to content
API Reference
/
/
Retrieve Incoming Peppol...

Retrieve Incoming Peppol Documents with Sorting and Filters

Request

Retrieve Incoming Peppol Documents. Use the 'sortField' parameter to choose the ordering field: 'createdAt' (default) or 'lastModifiedAt', and the 'sortOrder' parameter to choose the direction: 'desc' (default) or 'asc'. The 'from' and 'until' filters apply to the same field selected by 'sortField'. By default, the response contains the 100 (maxItems property) first items. To retrieve the next items matching the request, use the query parameter 'after' with the ID of the last item.

Security
api_key
Query
idstring

Filter for a Peppol Incoming Document using a specific DocumentID

senderNamestring

Filter for a Peppol Incoming Document with a given Sender Name

documentTypestring

Document Type of the Peppol Incoming Document

Enum:"BIS_BILLING_INVOICE_V3""BIS_SELF_BILLING_INVOICE_V3""BIS_BILLING_CREDIT_NOTE_V3""BIS_SELF_BILLING_CREDIT_NOTE_V3""INVOICE_RESPONSE_3_0""ORDER_3_0""ORDER_AGREEMENT_3_0""ORDER_RESPONSE_3_0""CATALOGUE_3_0""CATALOGUE_RESPONSE_3_0"
fromstring, (date-time)

Filter for PePPOL Documents with the sort field (createdAt by default, or lastModifiedAt when sortField=lastModifiedAt) greater than a specific datetime expressed in UTC timezone (format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

untilstring, (date-time)

Filter for PePPOL Documents with the sort field (createdAt by default, or lastModifiedAt when sortField=lastModifiedAt) less than a specific datetime expressed in UTC timezone (format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

sortFieldstring

Field used to sort the results. The from/until filters apply to this same field. Defaults to createdAt.

Default:"createdAt"
Enum:"createdAt""lastModifiedAt"
sortOrderstring

Order in which to sort the results. Defaults to desc.

Default:"desc"
Enum:"asc""desc"
afterstring

Pagination cursor. Provide the 'after' parameter value returned in the previous response to retrieve the next page of Peppol Documents (items that come immediately after that document in the result order). This value must be URL-encoded as it may contain special characters like #.

maxItemsnumber, [ 1 .. 1000 ]

Maximum number (1 - 1000) of Peppol Documents that might be returned. It is possible that the response contains fewer elements. Default to 100

Default:100
Headers
x-managed-company-idstring

Optional: the ID of the managed company on behalf of which the request is made

curl -i -X GET \
  'https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/peppol-incoming-documents?id=string&senderName=string&documentType=BIS_BILLING_INVOICE_V3&from=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z&sortField=createdAt&sortOrder=asc&after=string&maxItems=100' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Bodyapplication/json
itemsArray of anyrequired

List of items for the current page

totalItemsnumberrequired

Total number of items available (without pagination)

afterstring

Pagination cursor of the current page. This identifier represents the last item returned in the response. Use its value as the 'after' parameter in the next request to retrieve the following page of results.

Response
{
  "items": [
    { … }
  ],
  "totalItems": 0,
  "after": "string"
}