SAP Sales and Distribution (SD) Sales Order Header API

openapi: 3.1.0
info:
  title: SAP Sales and Distribution (SD) SAP Billing Document Sales Order Header API
  description: Read, cancel, and retrieve billing documents in PDF format from SAP S/4HANA. This OData service (API_BILLING_DOCUMENT_SRV) provides access to billing document headers, items, partners, and pricing elements. Supports invoices, credit memos, debit memos, and other billing document types as part of the order-to-cash cycle.
  version: 1.0.0
  contact:
    name: SAP Support
    url: https://support.sap.com
  license:
    name: SAP Developer License
    url: https://www.sap.com/about/agreements/product-use-and-support-terms.html
servers:
- url: https://sandbox.api.sap.com/s4hanacloud/sap/opu/odata/sap/API_BILLING_DOCUMENT_SRV
  description: SAP S/4HANA Cloud Sandbox
- url: https://{host}:{port}/sap/opu/odata/sap/API_BILLING_DOCUMENT_SRV
  description: SAP S/4HANA On-Premise
  variables:
    host:
      default: localhost
    port:
      default: '443'
security:
- basicAuth: []
- oauth2: []
tags:
- name: Sales Order Header
  description: Operations on sales order header entity (A_SalesOrder)
paths:
  /A_SalesOrder:
    get:
      operationId: listSalesOrders
      summary: Retrieve a list of sales orders
      description: Returns a collection of sales order headers with support for OData query options including $filter, $select, $expand, $top, $skip, $orderby, and $inlinecount. Use $expand to include related items, partners, pricing elements, and other sub-entities.
      tags:
      - Sales Order Header
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderby'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/expand'
      - $ref: '#/components/parameters/inlinecount'
      responses:
        '200':
          description: Successfully retrieved sales orders
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/SalesOrder'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      operationId: createSalesOrder
      summary: Create a new sales order
      description: Creates a new sales order using a deep insert request. The request body can include header data along with related items, partners, pricing elements, schedule lines, billing plans, and text elements in a single POST operation.
      tags:
      - Sales Order Header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SalesOrderCreate'
      responses:
        '201':
          description: Sales order successfully created
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    $ref: '#/components/schemas/SalesOrder'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /A_SalesOrder('{SalesOrder}'):
    get:
      operationId: getSalesOrder
      summary: Retrieve a single sales order
      description: Returns a single sales order header by its key. Use $expand to include related entities such as items, partners, pricing elements, schedule lines, billing plans, and text elements.
      tags:
      - Sales Order Header
      parameters:
      - name: SalesOrder
        in: path
        required: true
        description: Sales order number (10 characters)
        schema:
          type: string
          maxLength: 10
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/expand'
      responses:
        '200':
          description: Successfully retrieved the sales order
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    $ref: '#/components/schemas/SalesOrder'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    patch:
      operationId: updateSalesOrder
      summary: Update a sales order
      description: Updates an existing sales order header. Only the fields included in the request body are updated. Requires an If-Match header with the ETag value for optimistic concurrency control.
      tags:
      - Sales Order Header
      parameters:
      - name: SalesOrder
        in: path
        required: true
        description: Sales order number (10 characters)
        schema:
          type: string
          maxLength: 10
      - $ref: '#/components/parameters/ifMatch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SalesOrderUpdate'
      responses:
        '204':
          description: Sales order successfully updated
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      operationId: deleteSalesOrder
      summary: Delete a sales order
      description: Deletes an existing sales order. Requires an If-Match header with the ETag value for optimistic concurrency control.
      tags:
      - Sales Order Header
      parameters:
      - name: SalesOrder
        in: path
        required: true
        description: Sales order number (10 characters)
        schema:
          type: string
          maxLength: 10
      - $ref: '#/components/parameters/ifMatch'
      responses:
        '204':
          description: Sales order successfully deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '412':
          $ref: '#/components/responses/PreconditionFailed'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Forbidden:
      description: Insufficient authorization for the requested operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PreconditionFailed:
      description: ETag mismatch - resource was modified by another process
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request - invalid parameters or payload
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      description: OData error response
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code
            message:
              type: object
              properties:
                lang:
                  type: string
                value:
                  type: string
                  description: Error message text
    SalesOrder:
      type: object
      description: Sales order header entity (A_SalesOrder)
      properties:
        SalesOrder:
          type: string
          maxLength: 10
          description: Sales order number
        SalesOrderType:
          type: string
          maxLength: 4
          description: Sales document type
        SalesOrganization:
          type: string
          maxLength: 4
          description: Sales organization
        DistributionChannel:
          type: string
          maxLength: 2
          description: Distribution channel
        OrganizationDivision:
          type: string
          maxLength: 2
          description: Division
        SalesGroup:
          type: string
          maxLength: 3
          description: Sales group
        SalesOffice:
          type: string
          maxLength: 4
          description: Sales office
        SalesDistrict:
          type: string
          maxLength: 6
          description: Sales district
        SoldToParty:
          type: string
          maxLength: 10
          description: Sold-to party customer number
        CreationDate:
          type: string
          format: date
          description: Date on which the sales order was created
        CreatedByUser:
          type: string
          maxLength: 12
          description: User who created the sales order
        LastChangeDate:
          type: string
          format: date
          description: Date of last change
        LastChangeDateTime:
          type: string
          format: date-time
          description: Timestamp of last change (UTC)
        PurchaseOrderByCustomer:
          type: string
          maxLength: 35
          description: Customer purchase order number
        CustomerPurchaseOrderType:
          type: string
          maxLength: 4
          description: Customer purchase order type
        CustomerPurchaseOrderDate:
          type: string
          format: date
          description: Customer purchase order date
        SalesOrderDate:
          type: string
          format: date
          description: Document date of the sales order
        TotalNetAmount:
          type: string
          description: Net value of the sales order in document currency
        TransactionCurrency:
          type: string
          maxLength: 5
          description: SD document currency
        SDDocumentReason:
          type: string
          maxLength: 3
          description: Order reason
        PricingDate:
          type: string
          format: date
          description: Date for pricing and exchange rate determination
        RequestedDeliveryDate:
          type: string
          format: date
          description: Requested delivery date
        ShippingCondition:
          type: string
          maxLength: 2
          description: Shipping conditions
        CompleteDeliveryIsDefined:
          type: boolean
          description: Complete delivery flag
        ShippingType:
          type: string
          maxLength: 2
          description: Shipping type
        HeaderBillingBlockReason:
          type: string
          maxLength: 2
          description: Billing block for the header
        DeliveryBlockReason:
          type: string
          maxLength: 2
          description: Delivery block for the header
        IncotermsClassification:
          type: string
          maxLength: 3
          description: Incoterms (part 1)
        IncotermsTransferLocation:
          type: string
          maxLength: 28
          description: Incoterms (part 2)
        IncotermsLocation1:
          type: string
          maxLength: 70
          description: Incoterms location 1
        IncotermsLocation2:
          type: string
          maxLength: 70
          description: Incoterms location 2
        PaymentMethod:
          type: string
          maxLength: 1
          description: Payment method
        CustomerPaymentTerms:
          type: string
          maxLength: 4
          description: Terms of payment key
        OverallSDProcessStatus:
          type: string
          maxLength: 1
          description: Overall processing status of the sales order
        TotalCreditCheckStatus:
          type: string
          maxLength: 1
          description: Overall status of credit checks
        OverallDeliveryStatus:
          type: string
          maxLength: 1
          description: Overall delivery status
        OverallBillingStatus:
          type: string
          maxLength: 1
          description: Overall billing status
    SalesOrderUpdate:
      type: object
      description: Sales order header update payload
      properties:
        PurchaseOrderByCustomer:
          type: string
          maxLength: 35
        RequestedDeliveryDate:
          type: string
          format: date
        ShippingCondition:
          type: string
          maxLength: 2
        HeaderBillingBlockReason:
          type: string
          maxLength: 2
        DeliveryBlockReason:
          type: string
          maxLength: 2
        CustomerPaymentTerms:
          type: string
          maxLength: 4
        IncotermsClassification:
          type: string
          maxLength: 3
    SalesOrderItemCreate:
      type: object
      description: Sales order item creation payload
      properties:
        Material:
          type: string
          maxLength: 40
          description: Material number
        RequestedQuantity:
          type: string
          description: Order quantity
        RequestedQuantityUnit:
          type: string
          maxLength: 3
          description: Sales unit
        Plant:
          type: string
          maxLength: 4
          description: Plant
        SalesOrderItemText:
          type: string
          maxLength: 40
          description: Item text
    SalesOrderCreate:
      type: object
      description: Sales order creation payload with deep insert support
      required:
      - SalesOrderType
      - SalesOrganization
      - DistributionChannel
      - OrganizationDivision
      properties:
        SalesOrderType:
          type: string
          maxLength: 4
          description: Sales document type
        SalesOrganization:
          type: string
          maxLength: 4
          description: Sales organization
        DistributionChannel:
          type: string
          maxLength: 2
          description: Distribution channel
        OrganizationDivision:
          type: string
          maxLength: 2
          description: Division
        SoldToParty:
          type: string
          maxLength: 10
          description: Sold-to party customer number
        PurchaseOrderByCustomer:
          type: string
          maxLength: 35
          description: Customer purchase order number
        SalesOrderDate:
          type: string
          format: date
          description: Document date
        RequestedDeliveryDate:
          type: string
          format: date
          description: Requested delivery date
        ShippingCondition:
          type: string
          maxLength: 2
          description: Shipping conditions
        CustomerPaymentTerms:
          type: string
          maxLength: 4
          description: Terms of payment key
        IncotermsClassification:
          type: string
          maxLength: 3
          description: Incoterms (part 1)
        to_Item:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/SalesOrderItemCreate'
        to_Partner:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/SalesOrderHeaderPartner'
    SalesOrderHeaderPartner:
      type: object
      description: Sales order header partner entity (A_SalesOrderHeaderPartner)
      properties:
        SalesOrder:
          type: string
          maxLength: 10
          description: Sales order number
        PartnerFunction:
          type: string
          maxLength: 2
          description: Partner function (AG=Sold-to, WE=Ship-to, RE=Bill-to, RG=Payer)
        Customer:
          type: string
          maxLength: 10
          description: Customer number
        Supplier:
          type: string
          maxLength: 10
          description: Vendor account number
        Personnel:
          type: string
          maxLength: 8
          description: Personnel number
        ContactPerson:
          type: string
          maxLength: 10
          description: Contact person number
  parameters:
    skip:
      name: $skip
      in: query
      description: Number of records to skip
      schema:
        type: integer
        minimum: 0
    orderby:
      name: $orderby
      in: query
      description: Sort order for the result set
      schema:
        type: string
    expand:
      name: $expand
      in: query
      description: Comma-separated list of navigation properties to expand
      schema:
        type: string
    inlinecount:
      name: $inlinecount
      in: query
      description: Include total count of matching resources
      schema:
        type: string
        enum:
        - allpages
        - none
    select:
      name: $select
      in: query
      description: Comma-separated list of properties to include in the response
      schema:
        type: string
    ifMatch:
      name: If-Match
      in: header
      description: ETag value for optimistic concurrency control
      required: true
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Maximum number of records to return
      schema:
        type: integer
        minimum: 0
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.authentication.{landscape}.hana.ondemand.com/oauth/token
          scopes:
            API_BILLING_DOCUMENT_SRV: Access to Billing Document API