> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pland.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Article

> Create a new article with supplier and group ID conversion.



## OpenAPI

````yaml POST /articles/
openapi: 3.0.0
info:
  title: PlanD API
  description: PlanD Public API
  version: '2'
servers:
  - url: http:localhost:3000/v2
    description: Local Server
  - url: https://beta-api.pland.app/v2
    description: Sandbox Server
  - url: https://cloud-api.pland.app/v2
    description: Production Server
security: []
tags:
  - name: Absences
    description: >-
      Absence management endpoints for creating, updating, and managing user
      absences
  - name: Activity Types
    description: Activity type management operations
  - name: API Keys
    description: API key management operations for programmatic access to the API
  - name: Assignments
    description: Assignment management operations
  - name: Chat (Legacy)
    description: >-
      Legacy chat operations using Stream Chat service (deprecated - use Entity
      Chat v2 instead)
  - name: Client
    description: Unauthenticated client-facing operations
  - name: Company
    description: Company information and settings management operations
  - name: Complaints
    description: Customer complaint and ticket management operations
  - name: Contacts
    description: Contact person management operations
  - name: Customers
    description: Customer management operations
  - name: Customer Objects
    description: >-
      Customer object management operations - locations and buildings where
      services are performed
  - name: Documents
    description: >-
      Document management operations for uploading, retrieving, and managing
      files
  - name: Logbuch
    description: >-
      Operations for sending, retrieving, updating, and deleting Logbuch in
      entity chats.
  - name: Push Notifications
    description: Operations for listing, reading, and deleting user notifications.
  - name: Equipment
    description: Equipment management operations
  - name: Equipment Types
    description: Equipment type management operations
  - name: Assignment Confirmations
    description: Assignment confirmation management operations
  - name: Credit
    description: >-
      Credit note management operations for creating and handling credit
      documents
  - name: Invoice
    description: >-
      Invoice management operations for creating, managing, and processing
      customer invoices
  - name: Invoice Reminders
    description: >-
      Invoice reminder management operations for creating and handling payment
      reminder documents
  - name: Invoice Reminder Templates
    description: >-
      Invoice reminder template management operations for creating and handling
      reminder document templates
  - name: Invoice Storno
    description: Invoice storno (cancellation) document management operations
  - name: Invoice Templates
    description: >-
      Invoice template management operations for creating and handling invoice
      document templates
  - name: Offers
    description: Offer management operations
  - name: ServiceReport
    description: >-
      Service report management operations for creating and handling service
      documentation
  - name: Holiday
    description: Holidays management
  - name: Implementation
    description: User implementation progress tracking and onboarding management
  - name: Jobs
    description: >-
      Endpoints for managing jobs, including creation, listing, updating, and
      job-specific actions.
  - name: Material Orders
    description: Operations for listing, viewing, updating, and managing material orders.
  - name: Notifications
    description: User notification management operations
  - name: Payment Methods
    description: >-
      Payment method management operations for configuring available payment
      options
  - name: Payment Terms
    description: Operations for managing payment terms
  - name: Payments
    description: Payment management operations
  - name: Articles
    description: >-
      Operations for creating, listing, viewing, updating, and deleting
      articles.
  - name: Suppliers
    description: Supplier management operations
  - name: Service Products
    description: >-
      Operations for creating, listing, viewing, updating, and deleting service
      products.
  - name: Quality Control
    description: Quality control and assessment management operations
  - name: Pay Types
    description: Pay type management operations for salary and absence types
  - name: Salary
    description: >-
      Salary management operations for tracking and managing employee
      compensation
  - name: Surcharges
    description: Surcharge management operations for pay types and salary calculations
  - name: Search
    description: Search for entities in PlanD
  - name: Signing
    description: Endpoints for creating and listing signings (digital signatures).
  - name: Tasks
    description: Task management operations
  - name: Task Types
    description: Task type management operations
  - name: Tax Rates
    description: >-
      Tax rate management operations for handling VAT, zero rates, exemptions,
      and reverse charge scenarios
  - name: Time Tracking
    description: >-
      Time tracking management endpoints for recording, monitoring, and managing
      work time entries
  - name: Assets
    description: Asset URL management operations for secure access to uploaded files
  - name: Upload
    description: >-
      CSV and file uploads for various entities (articles, material, users,
      customers, objects, contacts, equipment, images)
  - name: Users
    description: >-
      User management endpoints for creating, updating, and managing system
      users
  - name: Authentication
    description: User authentication and password management operations
  - name: Banking Transactions
    description: Banking transaction management operations
  - name: Webhooks
  - name: SMS
    description: Endpoints for SMS status updates and link tracking.
paths:
  /articles/:
    post:
      tags:
        - Articles
      summary: Create a new article (custom logic)
      description: Create a new article with supplier and group ID conversion.
      operationId: createArticleCustom
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Article'
      responses:
        '201':
          description: Article created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Article'
        '400':
          description: Invalid input
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - API-Key: []
        - Bearer-Auth: []
components:
  schemas:
    Article:
      title: Article
      description: An article is a type of product.
      type: object
      allOf:
        - $ref: '#/components/schemas/Product'
        - properties:
            type:
              description: Type of the product
              type: string
              example: ARTICLE
            articleDescription:
              description: Description of the article
              type: string
              nullable: true
            imageUrl:
              description: Image URL for the article
              type: string
              nullable: true
            groupId:
              description: Group ID for the article
              type: string
              format: objectid
              nullable: true
            supplierId:
              description: Supplier ID for the article
              type: string
              format: objectid
              nullable: true
            priority:
              description: Priority of the article
              type: integer
              nullable: true
            inStock:
              description: How many of the articles are currently in stock
              type: integer
              nullable: true
            minimumInStock:
              description: Minimum requirement to be in stock
              type: integer
              nullable: true
          type: object
    Product:
      title: Product
      description: >-
        Base class for products, which can be either service products or
        articles.
      type: object
      allOf:
        - $ref: '#/components/schemas/ChatableEntityModel'
        - properties:
            type:
              description: Product type
              type: string
              enum:
                - SERVICE_PRODUCT
                - ARTICLE
            name:
              description: Name of the product
              type: string
            price:
              description: Unit price of the product
              type: number
              format: float
              nullable: true
            unit:
              description: Unit of measurement for the product
              type: string
              nullable: true
            description:
              description: Description of the product
              type: string
              nullable: true
            numberExtern:
              description: External product number (for supplier or external reference)
              type: string
              nullable: true
            prices:
              description: List of prices for the product
              type: array
              items:
                $ref: '#/components/schemas/ProductPrice'
            bookingAccountNumber:
              description: >-
                DATEV booking account number for the product. If not set, the
                default booking account number of the tax rate will be used.
              type: string
              nullable: true
            skontoBookingAccountNumber:
              description: >-
                DATEV booking account number for Skonto for the product. If not
                set, the default of the tax rate will be used.
              type: string
              nullable: true
            comment:
              description: Comment for the product
              type: string
              nullable: true
            attachmentIds:
              description: List of attachment IDs associated with the product
              type: array
              items:
                type: string
                format: objectid
          type: object
    ChatableEntityModel:
      title: Chatable Entity Model
      description: Base class for all entities that can have a chat associated with them.
      type: object
      allOf:
        - $ref: '#/components/schemas/Entity'
        - properties:
            chatId:
              description: ID of the chat associated with this entity
              type: string
              format: objectid
              nullable: true
          type: object
    ProductPrice:
      title: ProductPrice
      description: >-
        Represents the price of a product, including sell and buy prices,
        currency, tax, and optional comment.
      properties:
        sellPrice:
          title: Sell Price
          description: The selling price of the product.
          type: number
          format: float
          example: 19.99
        buyPrice:
          title: Buy Price
          description: The buying price of the product, if applicable.
          type: number
          format: float
          example: 15
          nullable: true
        currency:
          title: Currency
          description: >-
            The currency of the product price, represented as an ISO 4217
            currency code.
          type: string
          example: EUR
        tax:
          description: >-
            The tax rate applied to the product price, represented as a
            percentage (0 to 1). Deprecated, use taxRateId instead.
          type: number
          format: float
          example: 0.19
          deprecated: true
        taxRateId:
          title: Tax Rate ID
          description: The ID of the tax rate associated with the product price.
          type: string
          format: object-id
          example: 60c72b2f9b1e8d3f4c8b4567
        comment:
          description: Any additional comments
          type: string
          nullable: true
      type: object
    Entity:
      title: Entity
      description: >-
        Base class for all entities in the system, providing common properties
        and methods.
      properties:
        _id:
          description: Unique identifier of the entity
          type: string
          format: objectid
        number:
          description: Unique number of the entity, used for identification
          type: integer
        companyId:
          description: The ID of the company this entity belongs to
          type: string
          format: objectid
          x-internal: true
        status:
          $ref: '#/components/schemas/StatusStruct'
      type: object
    StatusStruct:
      description: Entity Status information
      properties:
        status:
          description: Current status
          type: integer
        createdAt:
          description: Creation timestamp
          type: string
          format: date-time
        createdBy:
          description: User who created this supplier
          type: string
          format: objectid
        lastModifiedAt:
          description: Last modification timestamp
          type: string
          format: date-time
        lastModifiedBy:
          description: User who last modified this supplier
          type: string
          format: objectid
      type: object
  securitySchemes:
    API-Key:
      type: apiKey
      name: x-API-Key
      in: header
    Bearer-Auth:
      type: http
      bearerFormat: JWT
      scheme: bearer

````