Puzzle User API
The User API from Puzzle — 3 operation(s) for user.
OpenAPI Specification
openapi: 3.0.3
info:
title: Puzzle Api Accounts User API
description: Puzzle Api
version: '0'
servers:
- url: https://staging.southparkdata.com/rest/v0
tags:
- name: User
paths:
/linkToken:
post:
operationId: createTemporaryLinkToken
summary: Fetch a Link Token
description: "This authentication method has been deprecated. Please use the Authentication endpoints instead. Additional details can be found here.\n\nCreates a link token that can be used to authenticate a user when directing them to the connection flow. The token expires after 30 minutes.\n\nAfter obtaining your link token, create a link to Puzzle so the user can connect their Puzzle account.\n\n<a \n href=\"https://staging.southparkdata.com/connect/{your_company_name}\n\t?token={link_token}\n\t&redirect_uri={your_redirect_uri}\"\n>\n Connect your Puzzle account\n</a>\n\nThey will see your welcome page and an opportunity to log in or sign up with Puzzle."
tags:
- User
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
userName:
type: string
userEmail:
type: string
companyId:
type: string
minLength: 1
companyName:
type: string
required:
- userName
- userEmail
- companyId
- companyName
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
linkToken:
type: string
companyId:
type: string
minLength: 1
description: Partner-facing external identifier
required:
- linkToken
- companyId
/me:
get:
operationId: me
summary: Get Current User
description: Gets information about the current user. Only valid for OAuth connections.
tags:
- User
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
description: Partner-facing external identifier
companies:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
description: Partner-facing external identifier
name:
type: string
connectedAt:
type: string
minLength: 1
description: ISO 8601 timestamp
status:
type: string
enum:
- Ready
- Syncing
- NoData
financialYearStartDate:
type: string
reportingCurrency:
type: string
minLength: 3
maxLength: 3
description: ISO 4217 currency code
required:
- id
- name
- connectedAt
- status
- financialYearStartDate
- reportingCurrency
required:
- id
- companies
/categories:
get:
operationId: puzzleCategories
summary: Get Puzzle Categories
description: 'Retrieves all of the valid Puzzle categories that can be used to categorize transactions.
Only valid for OAuth connections.'
tags:
- User
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
categories:
type: array
items:
type: string
enum:
- accounts_receivable
- accrued_revenue
- accumulated_depreciation_fixed_assets
- cash_adjustments
- deposits
- fixed_assets
- other_current_assets
- other_noncurrent_assets
- security_deposits
- accounts_payable
- debt_payable_current
- debt_payable_noncurrent
- deferred_revenue
- notes_payable
- other_current_liabilities
- accrued_salaries_and_benefits
- accrued_expenses
- advertising
- bad_debt
- bank_fees
- benefits_adjustments
- benefits_payment_medical
- benefits_payment_other_payable
- benefits_payment_other_prepaid
- benefits_payment_retirement
- bonuses
- bonuses_adjustments
- branded_gifts_and_swag
- business_development_and_conferences
- commissions
- commissions_adjustments
- computers_and_hardware
- consultants
- cost_of_sales
- credit_card_payment
- depreciation_fixed_assets
- design
- dues_and_subscriptions
- employee_gifts
- entertainment
- facilities
- furniture
- gain_loss_fixed_asset_disposal
- general_and_administrative
- independent_contractors
- interest_expense
- interest_and_dividend_income
- insurance
- legal
- marketing
- meals_and_entertainment
- meals_with_clients
- miscellaneous_expenses
- office_meals
- other_expenses
- other_meals
- other_employee_costs
- other_payroll
- payroll_fees
- payroll_taxes
- payment_processor_fees
- partnership_revenue
- penalties_and_settlements
- personnel_expense
- professional_services
- prepaid_benefits
- prepaid_expenses
- recruiting
- recruiters
- rent
- repairs_and_maintenance
- retirement_expense
- salaries_adjustments
- salaries_and_benefits
- sales_and_marketing
- shipping
- software
- software_subscriptions_and_tools
- supplies
- tax
- tax_and_accounting
- training_and_development
- travel
- travel_airfare
- travel_ground_transportation
- travel_lodging
- travel_meals
- utilities
- uncategorized_expenses
- hosting
- bill_pay_clearing
- employee_reimbursement_clearing
- income
- consulting_income
- consulting_income_refund
- subscription_income
- subscription_income_refund
- transaction_income
- transaction_income_refund
- usage_income
- usage_income_refund
- miscellaneous_income
- miscellaneous_income_refund
- credit_card_rewards_redeemed
- other_revenue
- equity
- common_stock
- debt_convertible_note
- other_investments
- preferred_stock
- venture_safe_note
- retained_earnings
- transfer_account
- processor_transfers
- realized_gains_and_losses
- unrealized_gains_and_losses
- no_category
required:
- categories