Skip to main content
POST
/
v1
/
purchase-order
Create purchase order
curl --request POST \
  --url http://localhost:3001/v1/purchase-order \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchaseOrderNumber": "247000-08",
  "currency": "EUR",
  "externalId": "1234567890",
  "deliveryDate": "2024-06-21",
  "orderDate": "2024-06-21",
  "counterpartyId": "90b9e856-a662-41e0-a1b2-32e06f83141f",
  "counterparty": {
    "email": "[email protected]",
    "name": "John Doe",
    "description": "Supplier for monthly raw material",
    "vat": "GB123456789",
    "accountsPayableNumber": 30001,
    "accountsReceivableNumber": 10001,
    "street": "Main Street 123",
    "city": "Vienna",
    "zip": "1010",
    "country": "AT",
    "paymentTermsDays": 30,
    "skontoPercentage": 2.5,
    "skontoDays": 10,
    "defaultLedgerAccount": "0000 - Ledger Account Name",
    "paymentReminderEmails": "<string>"
  },
  "lineItems": [
    {
      "externalId": "1234567890",
      "productCode": "1234567890",
      "title": "Product Title",
      "unit": "1234567890",
      "quantity": 1,
      "unitPrice": 1,
      "pricePerQuantity": 100,
      "totalPrice": 100,
      "discount": 5,
      "taxRate": 20,
      "taxAmount": 150
    }
  ]
}
'
{
  "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>",
    "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,
      "allowDirectInvoiceApproval": true,
      "allowDirectPaymentRunApproval": true,
      "customExportFormats": [
        "custom_experta"
      ],
      "autoPopulateCustomerEmailFromMetadata": true,
      "autoPopulateSupplierEmailFromMetadata": true,
      "excludedEmailDomains": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "inCaseOfLawCustomerId": "<string>",
      "cardCommonBookingTargetName": "<string>",
      "cardCommonBookingTargetAccountsPayableNumber": "<string>",
      "cardFxDifferenceLedgerAccount": "<string>"
    },
    "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"
    },
    "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,
      "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": {
          "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,
              "allowDirectInvoiceApproval": true,
              "allowDirectPaymentRunApproval": true,
              "customExportFormats": [
                "custom_experta"
              ],
              "autoPopulateCustomerEmailFromMetadata": true,
              "autoPopulateSupplierEmailFromMetadata": true,
              "excludedEmailDomains": "<string>",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "inCaseOfLawCustomerId": "<string>",
              "cardCommonBookingTargetName": "<string>",
              "cardCommonBookingTargetAccountsPayableNumber": "<string>",
              "cardFxDifferenceLedgerAccount": "<string>"
            },
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "featureFlags": []
          },
          "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,
          "allowDirectInvoiceApproval": true,
          "allowDirectPaymentRunApproval": true,
          "customExportFormats": [
            "custom_experta"
          ],
          "autoPopulateCustomerEmailFromMetadata": true,
          "autoPopulateSupplierEmailFromMetadata": true,
          "excludedEmailDomains": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "inCaseOfLawCustomerId": "<string>",
          "cardCommonBookingTargetName": "<string>",
          "cardCommonBookingTargetAccountsPayableNumber": "<string>",
          "cardFxDifferenceLedgerAccount": "<string>"
        },
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "featureFlags": []
      },
      "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",
    "apBalance": {
      "openInvoiceAmount": 123,
      "approvedOpenCreditNoteAmount": 123,
      "manualCreditAmount": 123,
      "totalAvailableCredit": 123,
      "netPayableAmount": 123,
      "remainingCreditBalance": 123,
      "scheduledBankTransferAmount": 123,
      "remainingToScheduleAmount": 123,
      "unapprovedCreditNoteAmount": 123,
      "appliedInvoiceCreditAmount": 123,
      "balancesByCurrency": [
        {
          "approvedOpenCreditNoteAmount": 123,
          "manualCreditAmount": 123,
          "totalAvailableCredit": 123,
          "appliedInvoiceCreditAmount": 123,
          "remainingCreditBalance": 123
        }
      ]
    }
  },
  "lineItems": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "productCode": 123,
      "externalId": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "description": "<string>",
      "quantity": 123,
      "unit": 123,
      "unitPrice": 123,
      "pricePerQuantity": 123,
      "totalPrice": 123,
      "discount": 123,
      "taxRate": 123,
      "taxAmount": 123,
      "deliveredQuantity": 123,
      "invoicedQuantity": 123,
      "invoicedTotalAmount": 123,
      "deliveryPercentage": 123,
      "invoicedPercentage": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
purchaseOrderNumber
string
required

The purchase order number.

Example:

"247000-08"

​
currency
enum<string>
default:EUR
required

The currency of the purchase order.

Available options:
EUR,
USD,
GBP,
JPY,
AUD,
CAD,
CHF,
CNY,
HKD,
NZD,
SEK,
KRW,
SGD,
NOK,
MXN,
INR,
BRL,
RUB,
ZAR,
TRY,
AED,
THB,
DKK,
HUF,
PLN,
TWD,
SAR,
MYR,
IDR
​
externalId
string

The external ID of the purchase order.

Example:

"1234567890"

​
deliveryDate
string<date-time>

The delivery date of the purchase order.

Example:

"2024-06-21"

​
orderDate
string<date-time>

The order date of the purchase order.

Example:

"2024-06-21"

​
counterpartyId
string

The ID of an existing counterparty that will receive the purchase order.

Example:

"90b9e856-a662-41e0-a1b2-32e06f83141f"

​
counterparty
object

The counterparty of the purchase order.

​
lineItems
object[]

The line items of the purchase order.

Response

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