Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Purchase Order

List purchase orders

Lists all available purchase orders.

get/api/v1/purchaseOrders

Query parameters

key'id' | 'status' | 'date' | 'supplier' | 'documentNumber' | 'project' | 'createdAt' | 'updatedAt' | 'salesOrderConfirmationReference' | 'suppliersOfferReference'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'date' | 'project' | 'status' | 'documentNumber'
dir'asc' | 'desc'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "17",
      "date": "2024-09-24",
      "project": {
        "id": "1337"
      },
      "status": "Pending",
      "documentNumber": "DOC-2024-4567",
      "supplier": {
        "id": "supplier-12345",
        "number": "S-2024-001",
        "customerNumberAtSupplier": "CUST-001",
        "honorific": "Mr.",
        "name": "John Doe Enterprises",
        "department": "Procurement",
        "subDepartment": "Supplier Relations",
        "extraAddressLine": "Attn: Accounts Payable",
        "street": "123 Main St.",
        "zipCode": "10115",
        "city": "Berlin",
        "state": "Berlin",
        "country": "Germany",
        "contactPerson": "Jane Smith",
        "telephone": "+49 30 123456",
        "telefax": "+49 30 654321",
        "email": "contact@johndoenterprises.com"
      },
      "requestForQuotation": {
        "id": "1337"
      },
      "bodyIntroduction": "Welcome to our product catalog. Please find the details below.",
      "bodyOutroduction": "Thank you for reviewing our offerings. We look forward to your order.",
      "salesOrderConfirmationReference": "SO123456789",
      "isConfirmationRequested": true,
      "suppliersOfferReference": "SUP-REF-2024-001",
      "internalDesignation": "PO-INV-2024-001",
      "language": {
        "iso2": "DE"
      },
      "confirmedVia": "email",
      "financials": {
        "paymentMethod": {
          "id": "1337"
        },
        "total": {
          "amount": "1500.00",
          "currency": "EUR"
        },
        "paymentTerms": {
          "paymentTargetDiscount": 5,
          "paymentTargetDays": 30,
          "paymentTargetDiscountDays": 10,
          "paymentTargetDiscountAmount": 75,
          "isPaymentTargetDiscountApplied": true
        },
        "costCenter": "CC-2024-001",
        "tax": {
          "taxation": "Domestic",
          "vatId": "DE123456789",
          "taxDisplay": "Gross"
        }
      },
      "delivery": {
        "deliveryTerms": {
          "id": "1337"
        },
        "hasDifferentDeliveryAddress": true,
        "deliveryAddress": {
          "honorific": "Mr.",
          "name": "John Doe",
          "department": "Sales",
          "subDepartment": "International Sales",
          "extraAddressLine": "Suite 200",
          "street": "Main Street 123",
          "zipCode": "10115",
          "city": "Berlin",
          "state": "Berlin",
          "country": "Germany",
          "contactPerson": "Jane Smith"
        },
        "dates": {
          "desiredDeliveryDate": "2024-10-15",
          "confirmedDeliveryDate": "2024-10-14"
        }
      },
      "formatting": {
        "hideLetterHead": true,
        "hidePrices": false,
        "hideProductNumbers": true,
        "showLongProductNumbers": false,
        "hideProductDescriptions": true,
        "showOwnProductNumberInColumn": true
      },
      "internalComment": "Please prioritize this order due to customer request.",
      "liabilitiesInfo": "This purchase order includes liabilities that must be addressed within 30 days."
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}