Fishbowl API Documentation - Version 25.

Introduction
Purchase Orders
Connecting
This is an object representing a Fishbowl ENDPOINTS
Errors purchase order. Purchase orders are
GET /api/purchase-orders
used to buy inventory items from your
GET /api/purchase-orders/:id
vendors.
Login POST /api/purchase-orders

Related guide: Purchase Orders POST /api/purchase-orders/:id

POST /api/purchase-orders/:id/issue
Imports and Exports
POST /api/purchase-orders/:id/unissue

Integrations POST /api/purchase-orders/:id/close-short

POST /api/purchase-orders/:id/close-
Inventory short/:poItemId
POST /api/purchase-orders/:id/void
Location Groups DELETE /api/purchase-orders/:id

Manufacture Orders

Memos The purchase order object

Parts Attributes THE PURCHASE ORDER OBJECT

Payments {
id integer "id": 72,
The purchase order's unique identification "number": "50071",
Products
number. "carrier": {
"id": 5,
Purchase Orders "name": "USPS"
number string },
Sales Orders "fobPointName": "Origin",
The purchase order number.
"paymentTerms": {
"id": 4,
Unit of Measure "name": "Net 30"
status string
},
Users The order status. "vendor": {
"id": 17,
"name": "Brent's Bicycle Brakes"
Vendors class reference object
},
The class category. "vendorSoNumber": "S108",
"customerSoNumber": "10086",
Show child attributes "vendorContact": "Brent's Bicycle
"buyer": {
"id": 1,
carrier reference object "name": "admin"
},
The shipping carrier. "deliverTo": "Allan's Raceway",
"revisionNumber": 3,
Show child attributes "lastModified": {
"username": "admin",
"dateLastModified": "2021-02-24T
fobPointName string },
"issuedByUser": {
Indicates when ownership/liability of the
"username": "admin",
order transfers to the purchaser.
"dateLastModified": "2021-02-24T
},
"dateCreated": "2020-11-18T00:00:0
paymentTerms reference object
"dateConfirmed": "2020-11-18T15:44
The terms of payment on the order. "dateRevision": "2020-11-18T15:44
"dateScheduled": "2020-11-18T00:00
Show child attributes "dateCompleted": "2020-11-20T00:00
"taxRate": {
"id": 0,
shipTerms string "name": "None"
},
The shipping terms on the order. "totalTax": "0",
"totalIncludesTax": false,
"locationGroup": {
type string: 'Standard' | 'Drop Ship'
"id": 5,
Indicates whether the order is a standard "name": "SLC"
or drop ship purchase order. },
"note": "Created for SO #10086",
"url": "",
vendor reference object "currency": {
The vendor on the purchase order. "id": 1,
"name": "US Dollar",
Show child attributes "code": "USD",
"rate": "1",
"homeCurrency": true
},
vendorSoNumber string
"email": "[email protected]",
The vendor sales order number.

customerSoNumber string
The customer sales order number.

buyer reference object

The Fishbowl user that created the order.

Show child attributes

deliverTo string
The intended recipient of the order.

revisionNumber integer
The revision number.

lastModified object
Timestamp of when the order was last
modified and the user that made the
modifications.

Show child attributes

issuedByUser object
Timestamp of when the order was issued
and the user that made the modifications.

Show child attributes

dateCreated date
Timestamp of when the order was created.

dateConfirmed date
Timestamp of when the order was
confirmed by the vendor.

dateRevision date
Timestamp of when the order was last
revised.

dateScheduled date
Timestamp of when the order was
scheduled.

dateCompleted date
Timestamp of when the order was
completed.

taxRate reference object

The tax rate on the order. This object is
ignored for companies in the United
States.

Show child attributes

totalTax money
The total amount of tax on the order.

totalIncludesTax boolean
Indicates if the order total includes tax.

locationGroup reference object

The location group the order belongs to.

Show child attributes

note string
The order's note field.

url string
The url link on the order.

currency reference object

The currency used on the order.

Show child attributes

email string
The vendor's email address for the order.

phone string
The vendor's phone number for the order.
 shipToAddress object
The shipping address on the order.

Show child attributes

remitToAddress object
The remit to address on the order.

Show child attributes

poItems list
A list of the purchase order items.

Show child attributes

customFields list
A list of custom fields associated with the
order.

Show child attributes

Search for purchase orders

Searches for purchase orders.

Parameters GET /api/purchase-orders

curl --location \
pageNumber integer --request GET '<YOUR SERVER>/api/purch
--header 'Content-Type: application/js
The current page of the results.
--header 'Authorization: Bearer <TOKEN

pageSize integer
The number of returned results per page.
(Default 100) RESPONSE

{
poNumber string "totalCount": 73,
The purchase order number. "totalPages": 37,
"pageNumber": 1,
"pageSize": 2,
poType string: 'Standard' | 'Drop "results": [
Ship' {
"id": 10,
Indicates whether the order is a standard
"number": "10",
or drop ship purchase order.
"vendorName": "A&B Distribution"
"dateIssued": "2020-10-01T17:58
"dateScheduled": "2020-08-02T08
vendorSoNumber string
"status": "Fulfilled"
The vendor sales order number. },
{
"id": 73,
issuedFrom date: 'yyyy-MM-dd' "number": "100",
The start issued date cutoff for the search. "vendorName": "A&B Distribution"
"dateIssued": "2020-11-23T11:42
"dateScheduled": "2020-11-23T00
issuedTo date: 'yyyy-MM-dd' "status": "Void"
}
The end issued date cutoff for the search.
]
 }
fulfilledFrom date: 'yyyy-MM-dd'
The start fulfilled date cutoff for the
search.

fulfilledTo date: 'yyyy-MM-dd'

The end fulfilled date cutoff for the search.

vendorName string
The name of the vendor.

partNumber string
The part number.

partDescription string
The description on the part.

partDetails string
The details for the part.

status string: 'All' | 'All Open' | 'Bid

Request' | 'Pending Approval' |
'Issued' | 'Picking' | 'Partial' | 'Picked' |
'Shipped' | 'Fulfilled' | 'Closed Short' |
'Void' | 'Historical'
The order status.

customSoNumber string
The customer sales order number.

locationGroupId integer
The unique identifier for the location group
on the order.

vendorPartNumber string
The number for the vendor part.

buyerId integer
The unique identifier for the salesperson
on the order.

remitTo string
The vendor address on the order.

shipTo string
The ship to address on the order.

customerName string
The name of the customer or job on the
order.
Attributes

customFields list
A list of the order's custom fields.

Show child attributes

Get a purchase order

Retrieves the details of an existing purchase order. You only need to provide the
unique purchase order ID.

Attributes GET /api/purchase-orders/:id

No attributes.
curl --location \
--request GET '<YOUR SERVER>/api/purch
--header 'Authorization: Bearer <TOKEN

RESPONSE

{
"id": 72,
"number": "50071",
"carrier": {
"id": 5,
"name": "USPS"
},
"fobPointName": "Origin",
"paymentTerms": {
"id": 4,
"name": "Net 30"
},
"vendor": {
"id": 17,
"name": "Brent's Bicycle Brakes"
},
"vendorSoNumber": "S108",
"customerSoNumber": "10086",
"vendorContact": "Brent's Bicycle
"buyer": {
"id": 1,
"name": "admin"
},
"deliverTo": "Allan's Raceway",
"revisionNumber": 3,
"lastModified": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
"issuedByUser": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
"dateCreated": "2020-11-18T00:00:0
"dateRevision": "2020-11-18T15:44
"dateScheduled": "2020-11-18T00:00
"totalTax": "0",
"totalIncludesTax": false,
"locationGroup": {
"id": 5,
"name": "SLC"
 },
"note": "Created for SO #10086",
"url": "",
"currency": {
"id": 1,
"name": "US Dollar",
"code": "USD",
"rate": "1",
"homeCurrency": true
},
"email": "[email protected]",
"phone": "801-932-1101",
"shipToAddress": {
"name": "Allan's Raceway",
"street": "2222 Wrecker's Blvd",
"city": "Santa Barbara",
"state": "CA",

Create a purchase order

Creates a purchase order.

Attributes POST /api/purchase-orders

curl --location \
number string optional --request POST '<YOUR SERVER>/api/purc
The purchase order number. --header 'Content-Type: application/js
--header 'Authorization: Bearer <TOKEN
--data-raw '<PO JSON>'
status string optional
The order status.

RESPONSE
class reference object optional
The class category. {
"id": 72,
Show child attributes "number": "50071",
"carrier": {
"id": 5,
"name": "USPS",
carrier reference object optional
"service": {
The shipping carrier. "id": 16,
"name": "Priority Mail"
Show child attributes }
},
"fobPointName": "Origin",
fobPointName string optional "paymentTerms": {
"id": 4,
Indicates when ownership/liability of the "name": "Net 30"
order transfers to the purchaser. },
"vendor": {
"id": 17,
paymentTerms reference object
"name": "Brent's Bicycle Brakes"
optional },
The terms of payment on the order. "vendorSoNumber": "S108",
"customerSoNumber": "10086",
Show child attributes "vendorContact": "Brent's Bicycle
"buyer": {
"id": 1,
"name": "admin"
shipTerms string optional
},
The shipping terms on the order. "deliverTo": "Allan's Raceway",
"revisionNumber": 3,
 "lastModified": {
vendor reference object "username": "admin",
The vendor on the purchase order. "dateLastModified": "2021-02-24T
},
Show child attributes "issuedByUser": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
vendorSoNumber string optional
"dateCreated": "2020-11-18T00:00:0
The vendor sales order number. "dateRevision": "2020-11-18T15:44
"dateScheduled": "2020-11-18T00:00
"totalTax": "0",
customerSoNumber string optional "totalIncludesTax": false,
The customer sales order number. "locationGroup": {
"id": 5,
"name": "SLC"
buyer reference object optional },
"note": "Created for SO #10086",
The Fishbowl user that created the order.
"url": "",
"currency": {
Show child attributes
"id": 1,
"name": "US Dollar",
"code": "USD",
deliverTo string optional "rate": "1",
The intended recipient of the order. "homeCurrency": true
},
"email": "[email protected]",
revisionNumber integer optional "phone": "801-932-1101",
"shipToAddress": {
The revision number.

dateCreated date optional

Timestamp of when the order was created.

dateConfirmed date optional

Timestamp of when the order was
confirmed by the vendor.

dateScheduled date optional

Timestamp of when the order is scheduled
to be fulfilled.

taxRate reference object optional

The tax rate on the order. For international
orders.

Show child attributes

totalIncludesTax boolean optional

Indicates if the order total includes tax. For
international orders.

locationGroup reference object

optional
The location group the order belongs to.

Show child attributes

note string optional

 The order's note field.

url string optional

The url link on the order.

currency reference object optional

The currency used on the order.

Show child attributes

email string optional

The vendor's email address for the order.

phone string optional

The vendor's phone number for the order.

shipToAddress object optional

The shipping address on the order.

Show child attributes

remitToAddress object optional

The remit to address on the order.

Show child attributes

poItems list optional

A list of the purchase order items.

Show child attributes

customFields list optional

A list of the order's custom fields.

Show child attributes

Update a purchase order

Updates a purchase order. Optional parameters that are not passed in will be reset to
their default values. Best practice is to send the complete object you would like to
save.

Attributes POST /api/purchase-orders/:id

curl --location \
number string optional --request POST '<YOUR SERVER>/api/purc
--header 'Content-Type: application/js
The purchase order number.
--header 'Authorization: Bearer <TOKEN
--data-raw '<PO JSON>'
class reference object optional
The class category.
 Show child attributes RESPONSE

{
carrier reference object optional "id": 72,
"number": "50071",
The shipping carrier. "carrier": {
"id": 5,
Show child attributes
"name": "USPS"
},
"fobPointName": "Origin",
fobPointName string optional "paymentTerms": {
"id": 4,
Indicates when ownership/liability of the
"name": "Net 30"
order transfers to the purchaser.
},
"vendor": {
paymentTerms reference object "id": 17,
"name": "Brent's Bicycle Brakes"
optional
},
The terms of payment on the order. "vendorSoNumber": "S108",
"customerSoNumber": "10086",
Show child attributes "vendorContact": "Brent's Bicycle
"buyer": {
"id": 1,
shipTerms string optional "name": "admin"
},
The shipping terms on the order. "deliverTo": "Allan's Raceway",
"revisionNumber": 3,
"lastModified": {
vendor reference object
"username": "admin",
The vendor on the purchase order. "dateLastModified": "2021-02-24T
},
Show child attributes "issuedByUser": {
"username": "admin",
"dateLastModified": "2021-02-24T
vendorSoNumber string optional },
"dateCreated": "2020-11-18T00:00:0
The vendor sales order number. "dateRevision": "2020-11-18T15:44
"dateScheduled": "2020-11-18T00:00
"totalTax": "0",
customerSoNumber string optional
"totalIncludesTax": false,
The customer sales order number. "locationGroup": {
"id": 5,
"name": "SLC"
buyer reference object optional },
The Fishbowl user that created the order. "note": "Created for SO #10086",
"url": "",
Show child attributes "currency": {
"id": 1,
"name": "US Dollar",
"code": "USD",
deliverTo string optional
"rate": "1",
The intended recipient of the order. "homeCurrency": true
},
"email": "[email protected]",
revisionNumber integer optional "phone": "801-932-1101",
The revision number. "shipToAddress": {
"name": "Allan's Raceway",
"street": "2222 Wrecker's Blvd",
dateConfirmed date optional "city": "Santa Barbara",
"state": "CA",
Timestamp of when the order was
confirmed by the vendor.

dateScheduled date optional

Timestamp of when the order is scheduled
to be fulfilled.
taxRate reference object optional
The tax rate on the order. For international
orders.

Show child attributes

totalIncludesTax boolean optional

Indicates if the order total includes tax. For
international orders.

locationGroup reference object

optional
The location group the order belongs to.

Show child attributes

note string optional

The order's note field.

url string optional

The url link on the order.

currency reference object optional

The currency used on the order.

Show child attributes

email string optional

The vendor's email address for the order.

phone string optional

The vendor's phone number for the order.

shipToAddress object optional

The shipping address on the order.

Show child attributes

remitToAddress object optional

The remit to address on the order.

Show child attributes

poItems list optional

A list of the purchase order items.

Show child attributes

customFields list optional

A list of the order's custom fields.
 Show child attributes

Issue a purchase order

Issues the purchase order with the specified ID.

Attributes POST /api/purchase-orders/:id/issue

No attributes. curl --location \

--request POST '<YOUR SERVER>/api/purc
--header 'Authorization: Bearer <TOKEN

RESPONSE

{
"id": 72,
"number": "50071",
"carrier": {
"id": 5,
"name": "USPS"
},
"fobPointName": "Origin",
"paymentTerms": {
"id": 4,
"name": "Net 30"
},
"vendor": {
"id": 17,
"name": "Brent's Bicycle Brakes"
},
"vendorSoNumber": "S108",
"customerSoNumber": "10086",
"vendorContact": "Brent's Bicycle
"buyer": {
"id": 1,
"name": "admin"
},
"deliverTo": "Allan's Raceway",
"revisionNumber": 3,
"lastModified": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
"issuedByUser": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
"dateCreated": "2020-11-18T00:00:0
"dateRevision": "2020-11-18T15:44
"dateScheduled": "2020-11-18T00:00
"totalTax": "0",
"totalIncludesTax": false,
"locationGroup": {
"id": 5,
"name": "SLC"
},
"note": "Created for SO #10086",
"url": "",
"currency": {
"id": 1,
"name": "US Dollar",
"code": "USD",
 "rate": "1",
"homeCurrency": true
},
"email": "[email protected]",
"phone": "801-932-1101",
"shipToAddress": {
"name": "Allan's Raceway",
"street": "2222 Wrecker's Blvd",
"city": "Santa Barbara",
"state": "CA",

Unissue a purchase order

Unissues the purchase order with the specified ID.

Attributes POST /api/purchase-orders/:id/unissue

No attributes. curl --location \

--request POST '<YOUR SERVER>/api/purc
--header 'Authorization: Bearer <TOKEN

RESPONSE

{
"id": 72,
"number": "50071",
"carrier": {
"id": 5,
"name": "USPS"
},
"fobPointName": "Origin",
"paymentTerms": {
"id": 4,
"name": "Net 30"
},
"vendor": {
"id": 17,
"name": "Brent's Bicycle Brakes"
},
"vendorSoNumber": "S108",
"customerSoNumber": "10086",
"vendorContact": "Brent's Bicycle
"buyer": {
"id": 1,
"name": "admin"
},
"deliverTo": "Allan's Raceway",
"revisionNumber": 3,
"lastModified": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
"issuedByUser": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
"dateCreated": "2020-11-18T00:00:0
"dateRevision": "2020-11-18T15:44
"dateScheduled": "2020-11-18T00:00
"totalTax": "0",
"totalIncludesTax": false,
"locationGroup": {
 "id": 5,
"name": "SLC"
},
"note": "Created for SO #10086",
"url": "",
"currency": {
"id": 1,
"name": "US Dollar",
"code": "USD",
"rate": "1",
"homeCurrency": true
},
"email": "[email protected]",
"phone": "801-932-1101",
"shipToAddress": {
"name": "Allan's Raceway",
"street": "2222 Wrecker's Blvd",
"city": "Santa Barbara",
"state": "CA",

Close short a purchase order

Close shorts the purchase order with the specified ID.

Attributes POST /api/purchase-orders/:id/close-

short
No attributes.

curl --location \
--request POST '<YOUR SERVER>/api/purc
--header 'Authorization: Bearer <TOKEN

RESPONSE
 {
"id": 83,
"number": "200",
"carrier": {
"id": 1,
"name": "Will Call"
},
"fobPointName": "Origin",
"paymentTerms": {
"id": 1,
"name": "COD"
},
"vendor": {
"id": 22,
"name": "A&B Distribution"
},
"vendorSoNumber": "",
"customerSoNumber": "",
"vendorContact": "A&B Distribution
"buyer": {
"id": 1,
"name": "admin"
},
"deliverTo": "",
"revisionNumber": 4,
"lastModified": {
"username": "admin",
"dateLastModified": "2021-03-26T
},
"issuedByUser": {
"username": "admin",
"dateLastModified": "2021-03-17T
},
"dateCreated": "2021-03-17T00:00:0
"dateScheduled": "2021-03-17T00:00
"dateCompleted": "2021-03-26T11:24
"totalTax": "0",
"totalCost": "5",
"mcTotalTax": "0",
"mcTotalCost": "5",
"totalIncludesTax": false,
"locationGroup": {
"id": 5,
"name": "SLC"
},
"note": "",
"url": "",
"currency": {
"id": 1,
"name": "US Dollar",
"code": "USD",
"rate": "1",
"homeCurrency": true
},
"email": "",
"phone": "801-932-1101",
"shipToAddress": {
"name": "Fishbowl Bikes",

Close short a purchase order item

Close shorts the purchase order item with the specified ID.
Attributes POST /api/purchase-orders/:id/close-
short/:poItemId
No attributes.

curl --location \
--request POST '<YOUR SERVER>/api/purc
--header 'Authorization: Bearer <TOKEN

RESPONSE

{
"id": 83,
"number": "200",
"carrier": {
"id": 1,
"name": "Will Call"
},
"fobPointName": "Origin",
"paymentTerms": {
"id": 1,
"name": "COD"
},
"vendor": {
"id": 22,
"name": "A&B Distribution"
},
"vendorSoNumber": "",
"customerSoNumber": "",
"vendorContact": "A&B Distribution
"buyer": {
"id": 1,
"name": "admin"
},
"deliverTo": "",
"revisionNumber": 4,
"lastModified": {
"username": "admin",
"dateLastModified": "2021-03-26T
},
"issuedByUser": {
"username": "admin",
"dateLastModified": "2021-03-17T
},
"dateCreated": "2021-03-17T00:00:0
"dateScheduled": "2021-03-17T00:00
"dateCompleted": "2021-03-26T11:24
"totalTax": "0",
"totalCost": "5",
"mcTotalTax": "0",
"mcTotalCost": "5",
"totalIncludesTax": false,
"locationGroup": {
"id": 5,
"name": "SLC"
},
"note": "",
"url": "",
"currency": {
"id": 1,
"name": "US Dollar",
"code": "USD",
"rate": "1",
"homeCurrency": true
},
"email": "",
 "phone": "801-932-1101",
"shipToAddress": {
"name": "Fishbowl Bikes",

Void a purchase order

Voids the purchase order with the specified ID.

Attributes POST /api/purchase-orders/:id/void

No attributes. curl --location \

--request POST '<YOUR SERVER>/api/purc
--header 'Authorization: Bearer <TOKEN

RESPONSE

{
"id": 72,
"number": "50071",
"carrier": {
"id": 5,
"name": "USPS"
},
"fobPointName": "Origin",
"paymentTerms": {
"id": 4,
"name": "Net 30"
},
"vendor": {
"id": 17,
"name": "Brent's Bicycle Brakes"
},
"vendorSoNumber": "S108",
"customerSoNumber": "10086",
"vendorContact": "Brent's Bicycle
"buyer": {
"id": 1,
"name": "admin"
},
"deliverTo": "Allan's Raceway",
"revisionNumber": 3,
"lastModified": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
"issuedByUser": {
"username": "admin",
"dateLastModified": "2021-02-24T
},
"dateCreated": "2020-11-18T00:00:0
"dateRevision": "2020-11-18T15:44
"dateScheduled": "2020-11-18T00:00
"totalTax": "0",
"totalIncludesTax": false,
"locationGroup": {
"id": 5,
"name": "SLC"
},
"note": "Created for SO #10086",
"url": "",
"currency": {
"id": 1,
 "name": "US Dollar",
"code": "USD",
"rate": "1",
"homeCurrency": true
},
"email": "[email protected]",
"phone": "801-932-1101",
"shipToAddress": {
"name": "Allan's Raceway",
"street": "2222 Wrecker's Blvd",
"city": "Santa Barbara",
"state": "CA",

Delete a purchase order

Deletes the purchase order with the specified ID.

Attributes DELETE /api/purchase-orders/:id

No attributes.
curl --location \
--request DELETE '<YOUR SERVER>/api/pu
--header 'Authorization: Bearer <TOKEN

RESPONSE

{}