Paperless Parts Customers API

openapi: 3.2.0
info:
  title: Paperless Parts Customers API
  description: The Paperless Parts API provides access to your data, enabling developers to easily integrate Paperless Parts with third-party systems, such as Customer Relationship Management (CRM) and Enterprise Resource Planning (ERP) tools.
  version: '1.0'
  termsOfService: https://www.paperlessparts.com/web-service-agreement/
  contact:
    name: Paperless Parts
    url: https://www.paperlessparts.com
    email: support@paperlessparts.com
servers:
- url: '{url}/{version}'
  variables:
    url:
      default: https://api.paperlessparts.com
    version:
      default: v1
security:
- app_id: []
tags:
- name: Customers
  description: Paperless Parts includes Customer Relationship Management (CRM) functionality to make it easy to send quotes to new and existing customers, while keeping data consistent with third-party CRM and ERP systems.
paths:
  /contacts/public:
    get:
      summary: List contacts
      description: Returns a list of contacts. The contacts are returned 20 results at a time and can be iterated over by using the page parameter.
      operationId: ListContacts
      parameters:
      - in: query
        name: search
        schema:
          type: string
        required: false
        description: 'Value used to search against the following fields: email, first name, last name, notes, phone, and account_id. Comparisons are not case sensitive and will match when the field value includes the search value as a substring.'
      - in: query
        name: page
        schema:
          type: string
        required: false
        description: The page of results to return.
      - in: query
        name: account_id
        schema:
          type: integer
        required: false
        description: The id of the account who's contacts to return. Must be an exact match.
        example: 17'
      tags:
      - Customers
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    account_id:
                      type:
                      - integer
                      - 'null'
                      example: 17
                      description: the ID of the associated Account
                    created:
                      type: string
                      example: '2020-08-25T18:00:53+00:00'
                    email:
                      type: string
                      example: careers@paperlessparts.com
                      description: email address (must be non-null, unique across all Contacts, and a valid email format)
                    first_name:
                      type: string
                      example: Gordon
                      description: Contact first name (must be non-null)
                    id:
                      type: integer
                      example: 137
                    last_name:
                      type: string
                      example: Moore
                      description: Contact last name (must be non-null)
                    phone:
                      type:
                      - string
                      - 'null'
                      example: '6176354500'
                      description: Contact phone number
                    phone_ext:
                      type:
                      - string
                      - 'null'
                      example: null
                      description: Contact phone number extension
        404:
          description: Not found response
          content:
            text/plain:
              schema:
                title: Customers not found
                type: string
                example: 'Error: Not Found'
    post:
      summary: Create new contact
      description: Creates a new contact.
      operationId: CreateContact
      tags:
      - Customers
      responses:
        201:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type:
                  - integer
                  - 'null'
                  description: the ID of the associated Account
                  example: 137
                address:
                  type:
                  - object
                  - 'null'
                  description: the contact's address
                  properties:
                    address1:
                      type: string
                      description: The street address
                      example: 137 Portland St.
                    address2:
                      type:
                      - string
                      - 'null'
                      description: Unit
                      example: Unit 1
                    city:
                      type: string
                      description: The city of the address
                      example: Boston
                    country:
                      type: string
                      description: The three character country abbreviation
                      example: USA
                    postal_code:
                      type: string
                      description: The postal code for the address
                      example: '02114'
                    state:
                      type: string
                      description: The two character state abbreviation
                      example: MA
                email:
                  type: string
                  description: email address (must be non-null, unique across all Contacts, and a valid email format)
                  example: careers@paperlessparts.com
                first_name:
                  type: string
                  description: Contact first name (must be non-null)
                  example: Gordon
                last_name:
                  type: string
                  description: Contact last name (must be non-null)
                  example: Moore
                notes:
                  type:
                  - string
                  - 'null'
                  description: Contact notes
                phone:
                  type:
                  - string
                  - 'null'
                  example: '6176354500'
                  description: Customer phone number
                phone_ext:
                  type:
                  - string
                  - 'null'
                  example: null
                  description: Customer phone number extension
                salesperson:
                  type:
                  - object
                  - 'null'
                  description: the contacts salesperson
                  properties:
                    email:
                      type: string
                      description: The salespersons email address. Must correspond to an active team member in your Paperless Parts account.
                      example: careers@paperlessparts.com
  /contacts/public/{contactId}:
    get:
      summary: Get details about a Contact
      description: Get all Contact attributes
      operationId: ContactDetails
      parameters:
      - $ref: '#/components/parameters/contactId'
      tags:
      - Customers
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
    patch:
      summary: Update a Contact
      description: Partially update Contact attributes (not including associated entities)
      operationId: UpdateCustomer
      parameters:
      - $ref: '#/components/parameters/contactId'
      tags:
      - Customers
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type:
                  - integer
                  - 'null'
                  description: the ID of the associated Account
                  example: 137
                address:
                  type:
                  - object
                  - 'null'
                  description: The contact's address. If an address exists on a customer then individual fields can be patched, otherwise all fields are required
                  properties:
                    address1:
                      type: string
                      description: The street address
                      example: 137 Portland St.
                    address2:
                      type:
                      - string
                      - 'null'
                      description: Unit
                      example: Unit 1
                    city:
                      type: string
                      description: The city of the address
                      example: Boston
                    country:
                      type: string
                      description: The three character country abbreviation
                      example: USA
                    postal_code:
                      type: string
                      description: The postal code for the address
                      example: '02114'
                    state:
                      type: string
                      description: The two character state abbreviation
                      example: MA
                email:
                  type: string
                  description: email address (must be non-null, unique across all Contacts, and a valid email format)
                  example: careers@paperlessparts.com
                first_name:
                  type: string
                  description: Contact first name (must be non-null)
                  example: Gordon
                last_name:
                  type: string
                  description: Contact last name (must be non-null)
                  example: Moore
                notes:
                  type:
                  - string
                  - 'null'
                  description: Contact notes
                phone:
                  type:
                  - string
                  - 'null'
                  example: '6176354500'
                  description: Customer phone number
                phone_ext:
                  type:
                  - string
                  - 'null'
                  example: null
                  description: Customer phone number extension
                salesperson:
                  type:
                  - object
                  - 'null'
                  description: the contacts salesperson
                  properties:
                    email:
                      type: string
                      description: The salespersons email address. Must correspond to an active team member in your Paperless Parts account.
                      example: careers@paperlessparts.com
            example:
              phone: '6176354500'
  /accounts/public:
    get:
      summary: List accounts
      description: Returns a list of accounts. The accounts are returned 20 results at a time and can be iterated over by using the page parameter.
      operationId: ListAccounts
      parameters:
      - in: query
        name: search
        schema:
          type: string
        required: false
        description: 'Value used to search against the following fields: account name, erp code, notes, and id. Comparisons are not case sensitive and will match when the field value includes the search value as a substring.'
      - in: query
        name: page
        schema:
          type: string
        required: false
        description: The page of results to return.
      - in: query
        name: erp_code
        schema:
          type: string
        required: false
        description: The erp code of the accounts to return. Must be an exact match.
        example: PPI
      - in: query
        name: null_erp_code
        schema:
          type: boolean
        required: false
        description: Filters for accounts whose erp code is either null or an empty string.
        example: true
      tags:
      - Customers
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      example: Paperless Parts, Inc.
                      description: The name of the account
                    erp_code:
                      type: string
                      example: PPI
                      description: The ERP code of the account
                    id:
                      type: integer
                      example: 17
                      description: the ID of the account
                    phone:
                      type: string
                      example: '6176354500'
                      description: Account phone number
                    phone_ext:
                      type: string
                      example: null
                      description: Account phone number extension
                    type:
                      type: string
                      example: customer
                      description: Account type, either customer or vendor
        404:
          description: Not found response
          content:
            text/plain:
              schema:
                title: Accounts not found
                type: string
                example: 'Error: Not Found'
    post:
      summary: Create new Account
      description: Creates a new account.
      operationId: CreateAccoumt
      tags:
      - Customers
      responses:
        201:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: (Required) Account Name (must be non-null and non-blank)
                  example: Paperless Parts, Inc.
                credit_line:
                  type:
                  - number
                  - 'null'
                  description: An account's credit line
                  example: 10000.0
                erp_code:
                  type:
                  - string
                  - 'null'
                  description: Erp code for the account
                  example: PPI
                notes:
                  type:
                  - string
                  - 'null'
                  description: Account notes
                payment_terms:
                  type:
                  - string
                  - 'null'
                  description: Payment terms; required if `payment_terms_period` are included
                  example: Net 30
                payment_terms_period:
                  type:
                  - string
                  - 'null'
                  description: Payment terms period in days; required if `payment_terms` are included, but can be `null`
                  example: 30
                phone:
                  type:
                  - string
                  - 'null'
                  example: '6176354500'
                  description: Account phone number
                phone_ext:
                  type:
                  - string
                  - 'null'
                  example: null
                  description: Account phone number extension
                purchase_orders_enabled:
                  type: boolean
                  example: true
                  description: When `true` any contact associated with this account will be allowed to check out with a purchase order.
                salesperson:
                  type:
                  - object
                  - 'null'
                  description: the accounts salesperson
                  properties:
                    email:
                      type: string
                      description: The salespersons email address. Must correspond to an active team member in your Paperless Parts account.
                      example: careers@paperlessparts.com
                sold_to_address:
                  type:
                  - object
                  - 'null'
                  description: The address for the account's headquarters.
                  properties:
                    address1:
                      type: string
                      description: The street address
                      example: 137 Portland St.
                    address2:
                      type:
                      - string
                      - 'null'
                      description: Unit
                      example: Unit 1
                    city:
                      type: string
                      description: The city of the address
                      example: Boston
                    country:
                      type: string
                      description: The three character country abbreviation
                      example: USA
                    postal_code:
                      type: string
                      description: The postal code for the address
                      example: '02114'
                    state:
                      type: string
                      description: The two character state abbreviation
                      example: MA
                    erp_code:
                      type: string
                      maxLength: 50
                      description: The unique identifier for this address record in the ERP
                      example: B1234
                tax_exempt:
                  type: boolean
                  example: true
                  description: When `true`, sales tax will not be added to a quote
                tax_rate:
                  type:
                  - number
                  - 'null'
                  example: 6.25
                  description: Sales tax rate for this Account
                type:
                  type: string
                  example: customer
                  description: Type of this Account, either customer or vendor
                url:
                  type:
                  - string
                  - 'null'
                  example: https://paperlessparts.com
            example:
              credit_line: 100000
              erp_code: PPI
              purchase_orders_enabled: true
              name: Paperless Parts, Inc.
              notes: This is a test account
              tax_exempt: true
              tax_rate: 6.25
              phone: '6175555555'
              url: www.paperlessparts.com
              type: customer
  /accounts/public/{accountId}:
    get:
      summary: Get details about an Account
      description: Get all Account attributes, including a list of billing addresses.
      operationId: AccountDetails
      parameters:
      - $ref: '#/components/parameters/accountId'
      tags:
      - Customers
      responses:
        200:
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        404:
          description: Not found response
          content:
            text/plain:
              schema:
                title: Account not found
                type: string
                example: 'Error: Not Found'
    patch:
      summary: Update an Account
      description: Partially update Account attributes (not including associated entities)
      operationId: UpdateCompany
      parameters:
      - $ref: '#/components/parameters/accountId'
      tags:
      - Customers
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: (Required) Account Name (must be non-null and non-blank)
                  example: Paperless Parts, Inc.
                credit_line:
                  type:
                  - number
                  - 'null'
                  description: An account's credit line
                  example: 10000.0
                erp_code:
                  type:
                  - string
                  - 'null'
                  description: Erp code for the account
                  example: PPI
                notes:
                  type:
                  - string
                  - 'null'
                  description: Account notes
                payment_terms:
                  type:
                  - string
                  - 'null'
                  description: Payment terms; required if `payment_terms_period` are included
                  example: Net 30
                payment_terms_period:
                  type:
                  - string
                  - 'null'
                  description: Payment terms period in days; required if `payment_terms` are included, but can be `null`
                  example: 30
                phone:
                  type:
                  - string
                  - 'null'
                  example: '6176354500'
                  description: Account phone number
                phone_ext:
                  type:
                  - string
                  - 'null'
                  example: null
                  description: Account phone number extension
                purchase_orders_enabled:
                  type: boolean
                  example: true
                  description: When `true` any contact associated with this account will be allowed to check out with a purchase order.
                salesperson:
                  type:
                  - object
                  - 'null'
                  description: the accounts salesperson
                  properties:
                    email:
                      type: string
                      description: The salespersons email address. Must correspond to an active team member in your Paperless Parts account.
                      example: careers@paperlessparts.com
                sold_to_address:
                  type:
                  - object
                  - 'null'
                  description: The address for the account's headquarters. If a sold_to_address is present on the account then individual fields can be patched otherwise all fields are required.
                  properties:
                    address1:
                      type: string
                      description: The street address
                      example: 137 Portland St.
                    address2:
                      type:
                      - string
                      - 'null'
                      description: Unit
                      example: Unit 1
                    city:
                      type: string
                      description: The city of the address
                      example: Boston
                    country:
                      type: string
                      description: The three character country abbreviation
                      example: USA
                    postal_code:
                      type: string
                      description: The postal code for the address
                      example: '02114'
                    state:
                      type: string
                      description: The two character state abbreviation
                      example: MA
                    erp_code:
                      type: string
                      maxLength: 50
                      description: The unique identifier for this address record in the ERP
                      example: B1234
                tax_exempt:
                  type: boolean
                  example: true
                  description: When `true`, sales tax will not be added to a quote
                tax_rate:
                  type:
                  - number
                  - 'null'
                  example: 6.25
                  description: Sales tax rate for this Account
                type:
                  type: string
                  example: customer
                  description: Type of this Account, either customer or vendor
                url:
                  type:
                  - string
                  - 'null'
                  example: https://paperlessparts.comA
            example:
              erp_code: PPI
              name: Paperless Parts, Inc.
              url: www.paperlessparts.com
  /accounts/public/{accountId}/billing_addresses:
    get:
      summary: List account billing addresses
      description: List all billing addresses associated with an account
      operationId: ListBillingAddresses
      parameters:
      - $ref: '#/components/parameters/accountId'
      tags:
      - Customers
      responses:
        200:
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Address'
        404:
          description: Not found response
          content:
            text/plain:
              schema:
                title: Account not found
                type: string
                example: 'Error: Not Found'
    post:
      summary: Create a new billing address for an account
      operationId: CreateBillingAddress
      parameters:
      - $ref: '#/components/parameters/accountId'
      tags:
      - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
      responses:
        201:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingAddress'
  /accounts/public/{accountId}/facilities:
    get:
      summary: List account facilites
      description: List all facilities associated with an account
      operationId: ListFacilities
      parameters:
      - $ref: '#/components/parameters/accountId'
      tags:
      - Customers
      responses:
        200:
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Facility'
        404:
          description: Not found response
          content:
            text/plain:
              schema:
                title: Account not found
                type: string
                example: 'Error: Not Found'
    post:
      summary: Create a new facility for an account
      operationId: CreateFacility
      parameters:
      - $ref: '#/components/parameters/accountId'
      tags:
      - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type:
                  - string
                  - 'null'
                  description: Name of Facility
                  example: Boston Office
                attention:
                  type:
                  - string
                  - 'null'
                  description: The person or department to ship packages to at the facility
                address:
                  type:
                  - object
                  - 'null'
                  description: The address of the facility.
                  properties:
                    address1:
                      type: string
                      description: The street address
                      example: 137 Portland St.
                    address2:
                      type:
                      - string
                      - 'null'
                      description: Unit
                      example: Unit 1
                    city:
                      type: string
                      description: The city of the address
                      example: Boston
                    country:
                      type: string
                      description: The three character country abbreviation
                      example: USA
                    postal_code:
                      type: string
                      description: The postal code for the address
                      example: '02114'
                    state:
                      type: string
                      description: The two character state abbreviation
                      example: MA
                    erp_code:
                      type: string
                      maxLength: 50
                      description: The unique identifier for this address record in the ERP
                      example: B1234
                salesperson:
                  type:
                  - object
                  - 'null'
                  description: the contacts salesperson
                  properties:
                    email:
                      type: string
                      description: The salespersons email address. Must correspond to an active team member in your Paperless Parts account.
                      example: careers@paperlessparts.com
      responses:
        201:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Facility'
  /billing_addresses/public/{billingAddressId}:
    get:
      summary: Get Billing Address
      description: Get a sepecific billing address
      operationId: BillingAddress
      parameters:
      - $ref: '#/components/parameters/billingAddressId'
      tags:
      - Customers
      responses:
        200:
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
        404:
          description: Not found response
          content:
            text/plain:
              schema:
                title: Billing Address not found
                type: string
                example: 'Error: Not Found'
    patch:
      summary: Update a Billing Address
      description: Partially update a Billing Address
      operationId: UpdateBillingAddress
      parameters:
      - $ref: '#/components/parameters/billingAddressId'
      tags:
      - Customers
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                address1:
                  type: string
                  description: The street address
                  example: 137 Portland St.
                address2:
                  type:
                  - string
                  - 'null'
                  description: Unit
                  example: Unit 1
                city:
                  type: string
                  description: The city of the address
                  example: Boston
                country:
                  type: string
                  description: The three character country abbreviation
                  example: USA
                postal_code:
                  type: strin

# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/paperless-parts/refs/heads/main/openapi/paperless-parts-customers-api-openapi.yml