Skip to main content
GET
/
v1
/
delivery
Get all deliveries
curl --request GET \
  --url http://localhost:3001/v1/delivery \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deliveryNumber": "<string>",
      "externalId": "<string>",
      "deliveryDate": "2023-11-07T05:31:56Z",
      "purchaseOrder": {
        "currency": "<string>",
        "counterpartyId": "<string>",
        "counterpartyName": "<string>",
        "totalOrderAmount": 123,
        "totalInvoicedAmount": 123,
        "totalLineItems": 123,
        "fullyInvoicedLineItemsCount": 123,
        "fullyDeliveredLineItemsCount": 123,
        "invoiceCompletionPercentage": 123,
        "totalOrderQuantity": 123,
        "totalDeliveredQuantity": 123,
        "uniqueDeliveriesCount": 123,
        "totalInvoicedQuantity": 123,
        "uniqueInvoicesCount": 123,
        "outstandingInvoiceAmount": 123,
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "purchaseOrderNumber": "<string>",
        "externalId": "<string>",
        "orderDate": "2023-11-07T05:31:56Z",
        "deliveryDate": "2023-11-07T05:31:56Z",
        "counterparty": {
          "email": "<string>",
          "name": "<string>",
          "markedTrusted": true,
          "markedTrustedDate": "2023-11-07T05:31:56Z",
          "markedTrustedUser": {
            "email": "<string>",
            "name": "<string>",
            "authId": "<string>",
            "role": "<string>",
            "hasPushNotification": true,
            "organization": {
              "name": "<string>",
              "slug": "<string>",
              "logoFileName": "<string>",
              "country": "<string>",
              "vatNumber": "<string>",
              "featureFlags": [
                {
                  "featureName": "<string>",
                  "isEnabled": true,
                  "id": "<string>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              ],
              "baseCurrency": "EUR",
              "paymentRunBatchBooking": true,
              "paymentRunVerificationOfPayee": true,
              "invoiceExportIncludeForeignCurrencies": true,
              "customExportFormats": [
                "custom_experta"
              ],
              "autoPopulateCustomerEmailFromMetadata": true,
              "autoPopulateSupplierEmailFromMetadata": true,
              "excludedEmailDomains": "<string>",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "description": "<string>",
          "vat": "<string>",
          "accountsPayableNumber": "22 0391919",
          "street": "<string>",
          "city": "<string>",
          "zip": "<string>",
          "country": "<string>",
          "paymentTermsDays": 123,
          "skontoPercentage": 123,
          "skontoDays": 123,
          "organization": {
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "country": "<string>",
            "vatNumber": "<string>",
            "featureFlags": [
              {
                "featureName": "<string>",
                "isEnabled": true,
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            ],
            "baseCurrency": "EUR",
            "paymentRunBatchBooking": true,
            "paymentRunVerificationOfPayee": true,
            "invoiceExportIncludeForeignCurrencies": true,
            "customExportFormats": [
              "custom_experta"
            ],
            "autoPopulateCustomerEmailFromMetadata": true,
            "autoPopulateSupplierEmailFromMetadata": true,
            "excludedEmailDomains": "<string>",
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "bankAccount": {
            "name": "<string>",
            "iban": "<string>",
            "bic": "<string>",
            "countryCode": "<string>",
            "address": "<string>",
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "bankAccountVerification": {
            "bankAccount": {
              "name": "<string>",
              "iban": "<string>",
              "bic": "<string>",
              "countryCode": "<string>",
              "address": "<string>",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "paymentProvider": "<string>",
            "status": "VALID",
            "initializedAt": "2023-11-07T05:31:56Z",
            "mailTrackings": {
              "version": 123,
              "type": "ONBOARDING",
              "status": "ACCEPTED",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "fullName": "<string>",
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "transactions": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "amount": 123,
            "remittanceInformation": "<string>",
            "requestedExecutionDate": "2023-11-07T05:31:56Z",
            "skontoAmount": 123,
            "skontoDate": "2023-11-07T05:31:56Z",
            "ignoreSkontoDeadline": true,
            "express": true,
            "currency": "EUR",
            "creditor": {
              "name": "<string>",
              "iban": "<string>",
              "bic": "<string>",
              "countryCode": "<string>",
              "address": "<string>",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "debitor": {
              "name": "<string>",
              "iban": "<string>",
              "bic": "<string>",
              "countryCode": "<string>",
              "address": "<string>",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "analysis": {
              "analysisRules": {
                "type": "AMOUNT_DEVIATION",
                "severity": "NORMAL",
                "markedOk": true,
                "markedOkReason": "<string>",
                "markedOkDate": "2023-11-07T05:31:56Z",
                "value": "<string>",
                "markedOkUser": {
                  "email": "<string>",
                  "name": "<string>",
                  "authId": "<string>",
                  "role": "<string>",
                  "hasPushNotification": true,
                  "organization": {
                    "name": "<string>",
                    "slug": "<string>",
                    "logoFileName": "<string>",
                    "country": "<string>",
                    "vatNumber": "<string>",
                    "featureFlags": [
                      {
                        "featureName": "<string>",
                        "isEnabled": true,
                        "id": "<string>",
                        "createdAt": "2023-11-07T05:31:56Z",
                        "updatedAt": "2023-11-07T05:31:56Z"
                      }
                    ],
                    "baseCurrency": "EUR",
                    "paymentRunBatchBooking": true,
                    "paymentRunVerificationOfPayee": true,
                    "invoiceExportIncludeForeignCurrencies": true,
                    "customExportFormats": [
                      "custom_experta"
                    ],
                    "autoPopulateCustomerEmailFromMetadata": true,
                    "autoPopulateSupplierEmailFromMetadata": true,
                    "excludedEmailDomains": "<string>",
                    "id": "<string>",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  },
                  "id": "<string>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                },
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              },
              "customRules": {
                "name": "<string>",
                "description": "<string>",
                "rule": "<string>",
                "twoFactorCheck": true,
                "accountCheck": true,
                "deleted": true,
                "active": true,
                "organization": {
                  "name": "<string>",
                  "slug": "<string>",
                  "logoFileName": "<string>",
                  "country": "<string>",
                  "vatNumber": "<string>",
                  "featureFlags": [
                    {
                      "featureName": "<string>",
                      "isEnabled": true,
                      "id": "<string>",
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z"
                    }
                  ],
                  "baseCurrency": "EUR",
                  "paymentRunBatchBooking": true,
                  "paymentRunVerificationOfPayee": true,
                  "invoiceExportIncludeForeignCurrencies": true,
                  "customExportFormats": [
                    "custom_experta"
                  ],
                  "autoPopulateCustomerEmailFromMetadata": true,
                  "autoPopulateSupplierEmailFromMetadata": true,
                  "excludedEmailDomains": "<string>",
                  "id": "<string>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                },
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              },
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "archived": true,
            "archivedDate": "2023-11-07T05:31:56Z",
            "archivedByUser": {
              "email": "<string>",
              "name": "<string>",
              "authId": "<string>",
              "role": "<string>",
              "hasPushNotification": true,
              "organization": {
                "name": "<string>",
                "slug": "<string>",
                "logoFileName": "<string>",
                "country": "<string>",
                "vatNumber": "<string>",
                "featureFlags": [
                  {
                    "featureName": "<string>",
                    "isEnabled": true,
                    "id": "<string>",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                ],
                "baseCurrency": "EUR",
                "paymentRunBatchBooking": true,
                "paymentRunVerificationOfPayee": true,
                "invoiceExportIncludeForeignCurrencies": true,
                "customExportFormats": [
                  "custom_experta"
                ],
                "autoPopulateCustomerEmailFromMetadata": true,
                "autoPopulateSupplierEmailFromMetadata": true,
                "excludedEmailDomains": "<string>",
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              },
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "paymentRun": {
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "createdById": "<string>",
              "createdByName": "<string>",
              "organizationId": "<string>",
              "sumAmount": 123,
              "sumAmountWithSkonto": 123,
              "sumBookedAmount": 123,
              "transactionCount": 123,
              "batchBooking": true
            },
            "counterparty": "<unknown>",
            "invoice": {
              "id": "<string>",
              "invoiceNumber": "<string>",
              "status": "<string>",
              "totalAmount": 123,
              "dueDate": "2023-11-07T05:31:56Z",
              "invoiceDate": "2023-11-07T05:31:56Z",
              "currency": "<string>"
            }
          },
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "lineItems": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "productCode": 123,
            "externalId": "<string>",
            "title": "<string>",
            "description": "<string>",
            "quantity": 123,
            "unit": 123,
            "unitPrice": 123,
            "totalPrice": 123,
            "discount": 123,
            "taxRate": 123,
            "taxAmount": 123,
            "deliveredQuantity": 123,
            "invoicedQuantity": 123,
            "invoicedTotalAmount": 123,
            "deliveryPercentage": 123,
            "invoicedPercentage": 123
          }
        ]
      },
      "lineItems": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "productCode": 123,
          "externalId": "<string>",
          "title": "<string>",
          "description": "<string>",
          "quantity": 123,
          "unit": 123,
          "unitPrice": 123,
          "totalPrice": 123,
          "discount": 123,
          "taxRate": 123,
          "taxAmount": 123,
          "purchaseOrderLineItem": {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "productCode": 123,
            "externalId": "<string>",
            "title": "<string>",
            "description": "<string>",
            "quantity": 123,
            "unit": 123,
            "unitPrice": 123,
            "totalPrice": 123,
            "discount": 123,
            "taxRate": 123,
            "taxAmount": 123,
            "deliveredQuantity": 123,
            "invoicedQuantity": 123,
            "invoicedTotalAmount": 123,
            "deliveryPercentage": 123,
            "invoicedPercentage": 123
          }
        }
      ],
      "totalQuantity": 123
    }
  ],
  "meta": {
    "page": 123,
    "take": 123,
    "itemCount": 123,
    "pageCount": 123,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

order
enum<string>
default:ASC

Choose between ascending and descending order.

Available options:
ASC,
DESC
page
number
default:1

Specify the number of the page you want to retrieve.

Required range: x >= 1
take
number
default:10

Specify the number of items you want to retrieve per page.

Required range: 1 <= x <= 100
deliveryNumber
string

Filter deliveries by delivery number.

externalId
string

Filter deliveries by external ID.

Response

200 - application/json
data
object[]
required

Paginated items.

meta
object
required

Additional information about the page.