SAP Invoices API

openapi: 3.2.0
info:
  title: SAP Business One Service Layer Invoices API
  description: RESTful API for accessing SAP Business One data and business logic. Provides CRUD operations on business objects such as orders, business partners, items, and financial documents through OData-compatible endpoints.
  version: '1.0'
  contact:
    name: SAP Support
    url: https://support.sap.com/
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
servers:
- url: https://{server}:50000/b1s/v1
  description: SAP Business One Service Layer Server
  variables:
    server:
      description: The hostname of your SAP Business One server
      default: localhost
security:
- sessionCookie: []
tags:
- name: Invoices
  description: AR and AP invoice management
paths:
  /Invoices:
    get:
      operationId: listInvoices
      summary: Sap List Ar Invoices
      description: Retrieves accounts receivable invoices with OData query support.
      tags:
      - Invoices
      parameters:
      - $ref: '#/components/parameters/Select'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Top'
      - $ref: '#/components/parameters/Skip'
      responses:
        '200':
          description: List of invoices
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invoice'
              examples:
                Listinvoices200Example:
                  summary: Default listInvoices 200 response
                  x-microcks-default: true
                  value:
                    value:
                    - DocEntry: 10
                      DocNum: 10
                      CardCode: example_value
                      DocDate: '2026-01-15'
                      DocDueDate: '2026-01-15'
                      DocTotal: 42.5
                      DocumentLines:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createInvoice
      summary: Sap Create an Ar Invoice
      description: Creates a new accounts receivable invoice with line items.
      tags:
      - Invoices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Invoice'
            examples:
              CreateinvoiceRequestExample:
                summary: Default createInvoice request
                x-microcks-default: true
                value:
                  DocEntry: 10
                  DocNum: 10
                  CardCode: example_value
                  DocDate: '2026-01-15'
                  DocDueDate: '2026-01-15'
                  DocTotal: 42.5
                  DocumentLines:
                  - ItemCode: example_value
                    Quantity: 42.5
                    UnitPrice: 42.5
                    Currency: example_value
                    WarehouseCode: example_value
                    TaxCode: example_value
      responses:
        '201':
          description: Invoice created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invoice'
              examples:
                Createinvoice201Example:
                  summary: Default createInvoice 201 response
                  x-microcks-default: true
                  value:
                    DocEntry: 10
                    DocNum: 10
                    CardCode: example_value
                    DocDate: '2026-01-15'
                    DocDueDate: '2026-01-15'
                    DocTotal: 42.5
                    DocumentLines:
                    - ItemCode: example_value
                      Quantity: 42.5
                      UnitPrice: 42.5
                      Currency: example_value
                      WarehouseCode: example_value
                      TaxCode: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    Select:
      name: $select
      in: query
      description: Comma-separated list of fields to include in the response
      schema:
        type: string
    Skip:
      name: $skip
      in: query
      description: Number of records to skip
      schema:
        type: integer
        minimum: 0
    Top:
      name: $top
      in: query
      description: Maximum number of records to return
      schema:
        type: integer
        minimum: 1
    Filter:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
  schemas:
    DocumentLine:
      type: object
      properties:
        ItemCode:
          type: string
          description: Item code
          example: example_value
        Quantity:
          type: number
          format: double
          description: Ordered quantity
          example: 42.5
        UnitPrice:
          type: number
          format: double
          description: Price per unit
          example: 42.5
        Currency:
          type: string
          description: Line currency
          example: example_value
        WarehouseCode:
          type: string
          description: Warehouse code for the line item
          example: example_value
        TaxCode:
          type: string
          description: Tax code applied to the line
          example: example_value
    Invoice:
      type: object
      properties:
        DocEntry:
          type: integer
          description: Unique document entry number
          readOnly: true
          example: 10
        DocNum:
          type: integer
          description: Document number
          example: 10
        CardCode:
          type: string
          description: Customer business partner code
          example: example_value
        DocDate:
          type: string
          format: date
          description: Invoice date
          example: '2026-01-15'
        DocDueDate:
          type: string
          format: date
          description: Payment due date
          example: '2026-01-15'
        DocTotal:
          type: number
          format: double
          description: Total invoice amount
          readOnly: true
          example: 42.5
        DocumentLines:
          type: array
          description: Invoice line items
          items:
            $ref: '#/components/schemas/DocumentLine'
          example: []
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: cookie
      name: B1SESSION
      description: Session cookie obtained from the Login endpoint
externalDocs:
  description: SAP Business One Service Layer Documentation
  url: https://help.sap.com/docs/SAP_BUSINESS_ONE_SERVICE_LAYER