Puzzle Vendors API
The Vendors API from Puzzle — 2 operation(s) for vendors.
OpenAPI Specification
openapi: 3.0.3
info:
title: Puzzle Api Accounts Vendors API
description: Puzzle Api
version: '0'
servers:
- url: https://staging.southparkdata.com/rest/v0
tags:
- name: Vendors
paths:
/company/{id}/vendors:
get:
operationId: vendors
summary: Get Vendors
description: 'Retrieves a list of all of the company''s vendors.
Required scope: read:company'
tags:
- Vendors
parameters:
- name: id
in: path
required: true
description: The company ID
schema:
type: string
minLength: 1
description: Partner-facing external identifier
- name: type
in: query
required: false
schema:
type: string
enum:
- Individual
- Business
- Unknown
- name: status
in: query
required: false
schema:
type: string
enum:
- Active
- Inactive
- Unknown
- name: permaNames
in: query
required: false
schema:
anyOf:
- type: string
- type: array
items:
type: string
- name: is1099Vendor
in: query
required: false
schema:
type: string
description: Boolean flag; "true" enables, any other value disables
- name: count
in: query
required: false
schema:
type: integer
- name: after
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
description: Partner-facing external identifier
permaName:
type: string
name:
type: string
is1099Vendor:
type: boolean
nullable: true
description:
type: string
nullable: true
type:
type: string
enum:
- Individual
- Business
- Unknown
nullable: true
status:
type: string
enum:
- Active
- Inactive
- Unknown
nullable: true
required:
- id
- permaName
- name
- is1099Vendor
- description
- type
- status
pageInfo:
type: object
properties:
endCursor:
type: string
nullable: true
hasNextPage:
type: boolean
total:
type: integer
nullable: true
required:
- endCursor
- hasNextPage
- total
required:
- items
- pageInfo
post:
operationId: createVendorApi
summary: Create Vendor
description: 'Creates a new Vendor for the company.
Required scope: write:vendor'
tags:
- Vendors
parameters:
- name: id
in: path
required: true
description: The company ID
schema:
type: string
minLength: 1
description: Partner-facing external identifier
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
is1099Vendor:
type: boolean
description:
type: string
type:
type: string
enum:
- Individual
- Business
- Unknown
status:
type: string
enum:
- Active
- Inactive
- Unknown
required:
- name
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
description: Partner-facing external identifier
permaName:
type: string
name:
type: string
is1099Vendor:
type: boolean
nullable: true
description:
type: string
nullable: true
type:
type: string
enum:
- Individual
- Business
- Unknown
nullable: true
status:
type: string
enum:
- Active
- Inactive
- Unknown
nullable: true
required:
- id
- permaName
- name
- is1099Vendor
- description
- type
- status
/company/{id}/vendors/{vendorId}:
patch:
operationId: updateVendorApi
summary: Update Vendor
description: 'Updates an existing Vendor for the company.
Required scope: write:vendor'
tags:
- Vendors
parameters:
- name: id
in: path
required: true
description: The company ID
schema:
type: string
minLength: 1
description: Partner-facing external identifier
- name: vendorId
in: path
required: true
description: The vendor ID
schema:
type: string
minLength: 1
description: Partner-facing external identifier
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
is1099Vendor:
type: boolean
description:
type: string
type:
type: string
enum:
- Individual
- Business
- Unknown
status:
type: string
enum:
- Active
- Inactive
- Unknown
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
description: Partner-facing external identifier
permaName:
type: string
name:
type: string
is1099Vendor:
type: boolean
nullable: true
description:
type: string
nullable: true
type:
type: string
enum:
- Individual
- Business
- Unknown
nullable: true
status:
type: string
enum:
- Active
- Inactive
- Unknown
nullable: true
required:
- id
- permaName
- name
- is1099Vendor
- description
- type
- status