Skip to main content
GET
/
v1
/
purchase-order
/
{id}
Get a purchase order by ID
curl --request GET \
  --url http://localhost:3001/v1/purchase-order/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "name": "<string>",
    "markedTrusted": true,
    "markedTrustedDate": "2023-11-07T05:31:56Z",
    "markedTrustedUser": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "name": "<string>",
      "authId": "<string>",
      "role": "<string>",
      "hasPushNotification": true,
      "organization": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "slug": "<string>",
        "logoFileName": "<string>",
        "country": "<string>",
        "vatNumber": "<string>",
        "featureFlags": [
          {
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "featureName": "<string>",
            "isEnabled": true
          }
        ]
      }
    },
    "description": "<string>",
    "vat": "<string>",
    "accountsPayableNumber": "22 0391919",
    "street": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "paymentTermsDays": 123,
    "skontoPercentage": 123,
    "skontoDays": 123,
    "organization": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "slug": "<string>",
      "logoFileName": "<string>",
      "country": "<string>",
      "vatNumber": "<string>",
      "featureFlags": [
        {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "featureName": "<string>",
          "isEnabled": true
        }
      ]
    },
    "bankAccount": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "iban": "<string>",
      "bic": "<string>",
      "countryCode": "<string>",
      "address": "<string>"
    },
    "bankAccountVerification": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "bankAccount": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>"
      },
      "paymentProvider": "<string>",
      "status": "VALID",
      "initializedAt": "2023-11-07T05:31:56Z",
      "mailTrackings": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "version": 123,
        "type": "ONBOARDING",
        "status": "ACCEPTED"
      },
      "fullName": "<string>"
    },
    "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,
      "creditor": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>"
      },
      "debitor": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>"
      },
      "analysis": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "analysisRules": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "type": "AMOUNT_DEVIATION",
          "severity": "NORMAL",
          "markedOk": true,
          "markedOkReason": "<string>",
          "markedOkDate": "2023-11-07T05:31:56Z",
          "value": "<string>",
          "markedOkUser": {
            "id": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "email": "<any>",
            "name": "<any>",
            "authId": "<any>",
            "role": "<any>",
            "hasPushNotification": "<any>",
            "organization": "<any>"
          }
        },
        "customRules": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "description": "<string>",
          "rule": "<string>",
          "twoFactorCheck": true,
          "accountCheck": true,
          "deleted": true,
          "active": true,
          "organization": {
            "id": "<any>",
            "createdAt": "<any>",
            "updatedAt": "<any>",
            "name": "<any>",
            "slug": "<any>",
            "logoFileName": "<any>",
            "country": "<any>",
            "vatNumber": "<any>",
            "featureFlags": "<any>"
          }
        }
      },
      "archived": true,
      "archivedDate": "2023-11-07T05:31:56Z",
      "archivedByUser": {
        "id": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<any>",
        "email": "<any>",
        "name": "<any>",
        "authId": "<any>",
        "role": "<any>",
        "hasPushNotification": "<any>",
        "organization": "<any>"
      },
      "paymentRun": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "createdById": "<string>",
        "createdByName": "<string>",
        "organizationId": "<string>",
        "sumAmount": 123,
        "sumAmountWithSkonto": 123,
        "sumBookedAmount": 123,
        "transactionCount": 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,
      "deliveredQuantity": 123,
      "invoicedQuantity": 123,
      "invoicedTotalAmount": 123,
      "deliveryPercentage": 123,
      "invoicedPercentage": 123
    }
  ],
  "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
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

200 - application/json
​
currency
string
required

The currency of the purchase order

​
counterpartyId
string
required

The counterparty ID

​
counterpartyName
string
required

The counterparty name

​
totalOrderAmount
number
required

Total monetary amount of the purchase order

​
totalInvoicedAmount
number
required

Total monetary amount invoiced for this purchase order

​
totalLineItems
number
required

Total number of line items in the purchase order

​
fullyInvoicedLineItemsCount
number
required

Number of line items that are fully invoiced (quantity-wise)

​
fullyDeliveredLineItemsCount
number
required

Number of line items that are fully delivered (quantity-wise)

​
invoiceCompletionPercentage
number
required

Percentage of order amount that has been invoiced (monetary)

​
totalOrderQuantity
number
required

Total quantity ordered across all line items

​
totalDeliveredQuantity
number
required

Total quantity delivered across all line items

​
uniqueDeliveriesCount
number
required

Number of unique deliveries for this purchase order

​
totalInvoicedQuantity
number
required

Total quantity invoiced across all line items

​
uniqueInvoicesCount
number
required

Number of unique invoices for this purchase order

​
outstandingInvoiceAmount
number
required

Monetary amount still pending invoicing

​
id
string

The unique identifier of the entity.

​
createdAt
string<date-time>

The date and time the entity was created.

​
updatedAt
string<date-time>

The date and time the entity was last updated.

​
purchaseOrderNumber
string

The unique number of the purchase order.

​
externalId
string

The external ID of the purchase order.

​
orderDate
string<date-time>

The date of the purchase order.

​
deliveryDate
string<date-time>

The date of the delivery of the purchase order.

​
counterparty
object

The counterparty of the purchase order.

​
lineItems
object[]

The line items of the purchase order.