SAP Ariba · Schema

PurchaseOrder

A complete purchase order document representing a buyer's commitment to purchase goods or services from a supplier through the SAP Ariba Network

B2BContract ManagementProcurementSourcingSpend AnalysisSupplier ManagementSupply Chain

Properties

Name	Type	Description
orderId	string	Unique purchase order identifier (UniqueName) including version
erpPONumber	string	ERP system purchase order number. Unique ID for every version of the purchase order in the backend ERP system.
versionNumber	integer	Supplemental version number of the order. Incremented with each change request.
orderDate	string	Date and time when the purchase order was created
status	object
orderMethodCategory	string	Ordering method category indicating how the order was generated (e.g., manual, automatic, blanket release)
supplier	object
buyer	object
currency	string	ISO 4217 currency code for the order
totalAmount	object
taxAmount	object
shippingAmount	object
paymentTerms	object
purchaseOrg	string	Purchasing organization identifier
purchaseGroup	string	Purchasing group identifier
companyCode	string	Company code for the buying entity
shipTo	object
billTo	object
lineItems	array	Line items contained in the purchase order
requisitionId	string	Reference to the originating purchase requisition
contractId	string	Reference to a master agreement or contract
comments	string	Header-level comments on the purchase order
createdDate	string	Timestamp when the order was first created
lastModifiedDate	string	Timestamp of the most recent modification
closedDate	string	Timestamp when the order was closed

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PurchaseOrder",
  "title": "PurchaseOrder",
  "type": "object",
  "description": "A complete purchase order document representing a buyer's commitment to purchase goods or services from a supplier through the SAP Ariba Network",
  "required": [
    "orderId",
    "orderDate",
    "supplier",
    "currency",
    "lineItems"
  ],
  "properties": {
    "orderId": {
      "type": "string",
      "description": "Unique purchase order identifier (UniqueName) including version",
      "examples": [
        "PO-2025-001234"
      ]
    },
    "erpPONumber": {
      "type": "string",
      "description": "ERP system purchase order number. Unique ID for every version of the purchase order in the backend ERP system.",
      "example": "example_value"
    },
    "versionNumber": {
      "type": "integer",
      "description": "Supplemental version number of the order. Incremented with each change request.",
      "minimum": 1,
      "example": 10
    },
    "orderDate": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the purchase order was created",
      "example": "2026-01-15T10:30:00Z"
    },
    "status": {
      "$ref": "#/components/schemas/PurchaseOrderStatus"
    },
    "orderMethodCategory": {
      "type": "string",
      "description": "Ordering method category indicating how the order was generated (e.g., manual, automatic, blanket release)",
      "example": "example_value"
    },
    "supplier": {
      "$ref": "#/components/schemas/SupplierReference"
    },
    "buyer": {
      "$ref": "#/components/schemas/BuyerReference"
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code for the order",
      "pattern": "^[A-Z]{3}$",
      "example": "example_value"
    },
    "totalAmount": {
      "$ref": "#/components/schemas/Money"
    },
    "taxAmount": {
      "$ref": "#/components/schemas/Money"
    },
    "shippingAmount": {
      "$ref": "#/components/schemas/Money"
    },
    "paymentTerms": {
      "$ref": "#/components/schemas/PaymentTerms"
    },
    "purchaseOrg": {
      "type": "string",
      "description": "Purchasing organization identifier",
      "example": "example_value"
    },
    "purchaseGroup": {
      "type": "string",
      "description": "Purchasing group identifier",
      "example": "example_value"
    },
    "companyCode": {
      "type": "string",
      "description": "Company code for the buying entity",
      "example": "example_value"
    },
    "shipTo": {
      "$ref": "#/components/schemas/Address"
    },
    "billTo": {
      "$ref": "#/components/schemas/Address"
    },
    "lineItems": {
      "type": "array",
      "description": "Line items contained in the purchase order",
      "items": {
        "$ref": "#/components/schemas/PurchaseOrderLineItem"
      },
      "minItems": 1,
      "example": []
    },
    "requisitionId": {
      "type": "string",
      "description": "Reference to the originating purchase requisition",
      "example": "500123"
    },
    "contractId": {
      "type": "string",
      "description": "Reference to a master agreement or contract",
      "example": "500123"
    },
    "comments": {
      "type": "string",
      "description": "Header-level comments on the purchase order",
      "example": "example_value"
    },
    "createdDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the order was first created",
      "example": "2026-01-15T10:30:00Z"
    },
    "lastModifiedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp of the most recent modification",
      "example": "2026-01-15T10:30:00Z"
    },
    "closedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the order was closed",
      "example": "2026-01-15T10:30:00Z"
    }
  }
}