Skip to main content
GET
/
delivery_notes
Get delivery notes
curl --request GET \
  --url https://api.sandbox.monite.com/v1/delivery_notes \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "status": "created",
      "created_at": "2022-01-01T00:00:00Z",
      "updated_at": "2022-01-01T00:00:00Z",
      "entity_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "entity": {
        "name": "Entity Name"
      },
      "entity_address": {
        "line1": "Entity Street",
        "city": "Entity City",
        "postal_code": "123009",
        "country": "DE"
      },
      "created_by_entity_user_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "counterpart_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "counterpart": {
        "name": "Counterpart Name"
      },
      "counterpart_address": {
        "line1": "Counterpart Street",
        "city": "Counterpart City",
        "postal_code": "123009",
        "country": "DE"
      },
      "line_items": [
        {
          "quantity": 20,
          "product": {
            "name": "Product Name",
            "description": "Description of product",
            "measure_unit": {
              "name": "pcs",
              "description": "Pieces"
            }
          }
        }
      ],
      "document_id": "DN-2022-01-01-0001",
      "delivery_date": "2022-01-01",
      "delivery_number": "102-2022-0987",
      "memo": "This is a memo",
      "display_signature_placeholder": true,
      "file_url": "https://example.com/delivery_note.pdf",
      "original_file_url": "https://example.com/delivery_note_original.pdf",
      "file_language": "en",
      "original_file_language": "de",
      "based_on": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "based_on_document_id": "IN-2022-01-01-0001"
    }
  ],
  "next_pagination_token": "<string>",
  "prev_pagination_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Query Parameters

​
order
enum<string>
default:asc

Sort order (ascending by default). Typically used together with the sort parameter.

Available options:
asc,
desc
​
limit
integer
default:100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

Required range: 1 <= x <= 100
​
pagination_token
string

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

​
sort
enum<string>

The field to sort the results by. Typically used together with the order parameter.

Available options:
status,
document_id,
delivery_date,
created_at
​
id__in
string<uuid>[]
​
status
enum<string>
Available options:
created,
canceled,
delivered
​
status__in
enum<string>[]
Available options:
created,
canceled,
delivered
​
document_id
string
Maximum string length: 100
​
document_id__contains
string
Maximum string length: 100
​
document_id__icontains
string
Maximum string length: 100
​
created_by_entity_user_id
string<uuid>
​
counterpart_id
string<uuid>
​
based_on
string<uuid>
​
based_on_document_id
string
Maximum string length: 100
​
based_on_document_id__contains
string
Maximum string length: 100
​
based_on_document_id__icontains
string
Maximum string length: 100
​
created_at__gt
string<date-time>
​
created_at__lt
string<date-time>
​
created_at__gte
string<date-time>
​
created_at__lte
string<date-time>
​
delivery_date__gt
string<date>
​
delivery_date__lt
string<date>
​
delivery_date__gte
string<date>
​
delivery_date__lte
string<date>

Response

Successful Response

​
data
object[]
required

List of delivery notes

​
next_pagination_token
string

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

​
prev_pagination_token
string

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).