Pennylane Products API

The Products API from Pennylane — 2 operation(s) for products.

Documentation

Specifications

Other Resources

OpenAPI Specification

pennylane-products-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Pennylane Company Account Products API
  description: Pennylane is a French financial and accounting operating system for SMEs and accounting firms. The Company API (v2) lets companies, firms, and integration partners access and sync invoicing, accounting, banking, and financial data, and automate end-to-end workflows. V2 is the stable version; V1 is deprecated.
  termsOfService: https://pennylane.readme.io/docs/api-contract-terms
  contact:
    name: Pennylane API Support
    url: https://pennylane.readme.io/docs/how-to-reach-out-to-us
  version: '2.0'
servers:
- url: https://app.pennylane.com/api/external/v2
  description: Production (v2)
security:
- bearerAuth: []
tags:
- name: Products
paths:
  /products:
    get:
      operationId: getProducts
      tags:
      - Products
      summary: List products
      description: 'Requires scope: products:readonly or products:all.'
      responses:
        '200':
          description: OK
    post:
      operationId: postProducts
      tags:
      - Products
      summary: Create a product
      description: 'Requires scope: products:all.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Created
  /products/{id}:
    get:
      operationId: getProduct
      tags:
      - Products
      summary: Retrieve a product
      parameters:
      - $ref: '#/components/parameters/PathId'
      responses:
        '200':
          description: OK
    put:
      operationId: putProduct
      tags:
      - Products
      summary: Update a product
      parameters:
      - $ref: '#/components/parameters/PathId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
components:
  parameters:
    PathId:
      name: id
      in: path
      required: true
      description: Internal Pennylane resource id (v2 uses internal ids only, not source_id).
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: Bearer token in the Authorization header. The token may be a Company API token, a Firm API token, or an OAuth 2.0 access token obtained via https://app.pennylane.com/oauth/authorize and /oauth/token.