Home
API Catalog
About
Back to System
BirchStreet API
1.0.0
OAS 3.0
Servers
https://api.birchstreet.com/v1
Authorize
Users
GET
/users
List Users
POST
/users
Create User
GET
/users
/{userId}
Get User
PUT
/users
/{userId}
Update User
DELETE
/users
/{userId}
Delete User
Reports
GET
/reports
List Reports
POST
/reports
Create Report
GET
/reports
/{reportId}
Get Report
Invoices
GET
/invoices
List Invoices
POST
/invoices
Create Invoice
GET
/invoices
/{invoiceId}
Get Invoice
POST
/invoices
/{invoiceId}
/pay
Pay Invoice
Suppliers
GET
/suppliers
List Suppliers
POST
/suppliers
Create Supplier
GET
/suppliers
/{supplierId}
Get Supplier
PUT
/suppliers
/{supplierId}
Update Supplier
DELETE
/suppliers
/{supplierId}
Delete Supplier
Admin
GET
/admin
/roles
List Roles
GET
/admin
/permissions
List Permissions
GET
/admin
/roles
/{roleId}
Get Role
Organizations
GET
/organizations
List Organizations
POST
/organizations
Create Organization
GET
/organizations
/{organizationId}
Get Organization
PUT
/organizations
/{organizationId}
Update Organization
DELETE
/organizations
/{organizationId}
Delete Organization
Purchase Orders
GET
/purchase-orders
List Purchase Orders
POST
/purchase-orders
Create Purchase Order
GET
/purchase-orders
/{purchaseOrderId}
Get Purchase Order
PUT
/purchase-orders
/{purchaseOrderId}
Update Purchase Order
POST
/purchase-orders
/{purchaseOrderId}
/approve
Approve Purchase Order
Settings
GET
/settings
/api-keys
List API Keys
POST
/settings
/api-keys
Create API Key
GET
/settings
/webhooks
List Webhooks
POST
/settings
/webhooks
Create Webhook
DELETE
/settings
/api-keys
/{apiKeyId}
Delete API Key
DELETE
/settings
/webhooks
/{webhookId}
Delete Webhook
Locations
GET
/locations
/{locationId}
Get Location
PUT
/locations
/{locationId}
Update Location
DELETE
/locations
/{locationId}
Delete Location
GET
/organizations
/{organizationId}
/locations
List Locations for Organization
POST
/organizations
/{organizationId}
/locations
Create Location for Organization
Items
GET
/catalogs
/{catalogId}
/items
List Items in Catalog
Catalogs
GET
/suppliers
/{supplierId}
/catalogs
List Catalogs for Supplier
Schemas
ID
Item
Role
User
Error
ApiKey
Report
Catalog
Invoice
Webhook
Location
Supplier
Permission
UserCreate
UserUpdate
ApiKeyCreate
Organization
ReportCreate
InvoiceCreate
PurchaseOrder
WebhookCreate
LineItemCreate
LocationCreate
SupplierCreate
OrganizationCreate
PurchaseOrderCreate
PurchaseOrderUpdate
ApiKeyCreateResponse