Get delivery notes

GET

/delivery_notes

GET

/v1/delivery_notes

curl https://api.sandbox.monite.com/v1/delivery_notes \
     -H "x-monite-version: 2024-05-25" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "created_at": "2022-01-01T00:00:00Z",
      "updated_at": "2022-01-01T00:00:00Z",
      "counterpart": {
        "id": "id",
        "individual": {
          "first_name": "Adnan",
          "is_customer": true,
          "is_vendor": true,
          "last_name": "Singh",
          "email": "asingh@example.net",
          "phone": "5553211234",
          "tags": [
            {
              "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
              "created_at": "2022-09-07T16:35:18Z",
              "updated_at": "2022-09-07T16:35:18Z",
              "name": "Marketing",
              "category": "document_type",
              "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
              "description": "Tag for the Marketing Department"
            }
          ],
          "title": "Mr."
        },
        "language": "ab",
        "organization": {
          "is_customer": true,
          "is_vendor": true,
          "legal_name": "Acme Inc.",
          "email": "acme@example.com",
          "phone": "5551231234",
          "tags": [
            {
              "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
              "created_at": "2022-09-07T16:35:18Z",
              "updated_at": "2022-09-07T16:35:18Z",
              "name": "Marketing",
              "category": "document_type",
              "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
              "description": "Tag for the Marketing Department"
            }
          ]
        }
      },
      "counterpart_address": {
        "city": "Counterpart City",
        "country": "DE",
        "line1": "Counterpart Street",
        "postal_code": "123009",
        "line2": "line2",
        "state": "state"
      },
      "counterpart_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "display_signature_placeholder": true,
      "document_id": "DN-2022-01-01-0001",
      "entity": {
        "type": "organization",
        "name": "name",
        "email": "email",
        "logo": "logo",
        "phone": "phone",
        "registration_authority": "registration_authority",
        "registration_number": "registration_number",
        "tax_id": "tax_id",
        "vat_id": "vat_id",
        "website": "website"
      },
      "entity_address": {
        "city": "Entity City",
        "line1": "Entity Street",
        "postal_code": "123009",
        "country": "DE",
        "line2": "line2",
        "state": "state"
      },
      "entity_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "file_language": "en",
      "line_items": [
        {
          "product": {
            "name": "Product Name",
            "description": "Description of product",
            "measure_unit": {
              "name": "pcs",
              "description": "Pieces"
            }
          },
          "quantity": 20
        }
      ],
      "original_file_language": "de",
      "status": "created",
      "based_on": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "based_on_document_id": "IN-2022-01-01-0001",
      "created_by_entity_user_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "delivery_date": "2022-01-01",
      "delivery_number": "102-2022-0987",
      "file_url": "https://example.com/delivery_note.pdf",
      "memo": "This is a memo",
      "original_file_url": "https://example.com/delivery_note_original.pdf"
    }
  ],
  "next_pagination_token": "next_pagination_token",
  "prev_pagination_token": "prev_pagination_token"
}

Get all delivery notes with filtering and pagination.

Authentication

AuthorizationBearer

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

Query parameters

orderenumOptional

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

Allowed values:

limitintegerOptional1-100Defaults to 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.

pagination_tokenstringOptional

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.

sortenumOptional

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

Allowed values:

id__instringOptionalformat: "uuid"

statusenumOptional

Allowed values:

status__inenumOptional

Allowed values:

document_idstringOptional<=100 characters

document_id__containsstringOptional<=100 characters

document_id__icontainsstringOptional<=100 characters

created_by_entity_user_idstringOptionalformat: "uuid"

counterpart_idstringOptionalformat: "uuid"

based_onstringOptionalformat: "uuid"

based_on_document_idstringOptional<=100 characters

based_on_document_id__containsstringOptional<=100 characters

based_on_document_id__icontainsstringOptional<=100 characters

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

delivery_date__gtstringOptionalformat: "date"

delivery_date__ltstringOptionalformat: "date"

delivery_date__gtestringOptionalformat: "date"

delivery_date__ltestringOptionalformat: "date"

Response

Successful Response

datalist of objects

List of delivery notes

next_pagination_tokenstringOptional

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_tokenstringOptional

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).

Errors

400

Get Delivery Notes Request Bad Request Error

401

Get Delivery Notes Request Unauthorized Error

403

Get Delivery Notes Request Forbidden Error

422

Get Delivery Notes Request Unprocessable Entity Error

429

Get Delivery Notes Request Too Many Requests Error

Authentication

Headers

Query parameters

Response

Errors