invoicepdfs-com Branding Profiles API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Branding Profiles API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged branding-profiles across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: branding-profiles
paths:
  /api/v1/branding-profiles:
    get:
      tags:
      - branding-profiles
      summary: List Branding Profiles
      description: 'The looks a document can be rendered in, newest first.


        Colours, logo, fonts and footer text — how a document appears. Who it is

        issued by is a business profile, which is a different thing.'
      operationId: list_branding_profiles
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingProfilesListResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
    post:
      tags:
      - branding-profiles
      summary: Create Branding Profile
      description: 'Create a look: colours, logo, fonts and footer.


        Applies on top of whichever template a render names, so one template can

        serve several brands. Mark one as the default and documents that name no

        profile will use it.'
      operationId: create_branding_profile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandingProfileCreateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
      - HTTPBearer: []
      x-visibility: public
  /api/v1/branding-profiles/{profile_id}:
    get:
      tags:
      - branding-profiles
      summary: Get Branding Profile
      description: One branding profile.
      operationId: get_branding_profile
      security:
      - HTTPBearer: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          title: Profile Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    patch:
      tags:
      - branding-profiles
      summary: Update Branding Profile
      description: 'Change a branding profile.


        Only the fields you send are changed. `hide_invoicepdfs_branding` is stored

        on any plan but only honoured on a plan that includes it — it is applied

        when a document renders, not validated here, so setting it on a plan without

        it is accepted and has no effect.'
      operationId: update_branding_profile
      security:
      - HTTPBearer: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          title: Profile Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandingProfilePatchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    delete:
      tags:
      - branding-profiles
      summary: Delete Branding Profile
      description: 'Remove a branding profile.


        Deleting the default is allowed: the oldest remaining profile becomes the

        default in its place, so documents that name no profile keep rendering.'
      operationId: delete_branding_profile
      security:
      - HTTPBearer: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          title: Profile Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleBoolResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/branding-profiles/{profile_id}/default:
    post:
      tags:
      - branding-profiles
      summary: Set Default Branding Profile
      description: 'Make this the profile used when a document names none.


        Exactly one profile is the default; setting a new one clears the previous.'
      operationId: set_default_branding_profile
      security:
      - HTTPBearer: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          title: Profile Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/branding-profiles/{profile_id}/logo:
    post:
      tags:
      - branding-profiles
      summary: Upload Branding Logo
      description: 'Attach a logo image to this branding profile.


        Replaces whatever logo the profile carried. The image is embedded when a

        document renders, so a later change applies to future renders and leaves

        PDFs already produced as they were.'
      operationId: upload_branding_logo
      security:
      - HTTPBearer: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          title: Profile Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_branding_logo'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandingProfileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    delete:
      tags:
      - branding-profiles
      summary: Delete Branding Logo
      description: Remove this profile's logo, leaving its colours and text intact.
      operationId: delete_branding_logo
      security:
      - HTTPBearer: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          title: Profile Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleBoolResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    Body_upload_branding_logo:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
      type: object
      required:
      - file
      title: Body_upload_branding_logo
    BrandingProfilesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/BrandingProfileOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: BrandingProfilesListResponse
    BrandingProfilePatchRequest:
      properties:
        name:
          type: string
          title: Name
        primary_color:
          type: string
          title: Primary Color
        accent_color:
          type: string
          title: Accent Color
        font_family:
          anyOf:
          - type: string
          - type: 'null'
          title: Font Family
        header_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Header Text
        footer_text:
          type: string
          title: Footer Text
        hide_invoicepdfs_branding:
          type: boolean
          title: Hide Invoicepdfs Branding
        is_default:
          type: boolean
          title: Is Default
      type: object
      title: BrandingProfilePatchRequest
    BrandingProfileOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        is_default:
          type: boolean
          title: Is Default
        logo_file_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Logo File Id
        primary_color:
          type: string
          title: Primary Color
        accent_color:
          type: string
          title: Accent Color
        font_family:
          anyOf:
          - type: string
          - type: 'null'
          title: Font Family
        header_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Header Text
        footer_text:
          type: string
          title: Footer Text
        hide_invoicepdfs_branding:
          type: boolean
          title: Hide Invoicepdfs Branding
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - name
      - is_default
      - primary_color
      - accent_color
      - footer_text
      - hide_invoicepdfs_branding
      - created_at
      - updated_at
      title: BrandingProfileOut
    BrandingProfileResponse:
      properties:
        data:
          $ref: '#/components/schemas/BrandingProfileOut'
      type: object
      required:
      - data
      title: BrandingProfileResponse
    SimpleBoolResponse:
      properties:
        data:
          additionalProperties:
            type: boolean
          type: object
          title: Data
      type: object
      required:
      - data
      title: SimpleBoolResponse
      description: 'Generic boolean response envelope.


        Example:

        {"data": {"deleted": true}}'
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
    BrandingProfileCreateRequest:
      properties:
        name:
          type: string
          title: Name
          examples:
          - Acme Corp
        primary_color:
          type: string
          title: Primary Color
          default: '#111827'
          examples:
          - '#111827'
        accent_color:
          type: string
          title: Accent Color
          default: '#111827'
          examples:
          - '#06B6D4'
        font_family:
          anyOf:
          - type: string
          - type: 'null'
          title: Font Family
          examples:
          - Inter
        header_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Header Text
          examples:
          - Acme Corp — Invoices
        footer_text:
          type: string
          title: Footer Text
          default: Generated by InvoicePDFs
        hide_invoicepdfs_branding:
          type: boolean
          title: Hide Invoicepdfs Branding
          default: false
        is_default:
          type: boolean
          title: Is Default
          default: false
      type: object
      required:
      - name
      title: BrandingProfileCreateRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs