Fishbowl
Fishbowl Advanced REST API Documentation

Purchase Orders

This is an object representing a Fishbowl purchase order. Purchase orders are used to buy inventory items from your vendors.

Related guide: Purchase Orders

ENDPOINTS
GET /api/purchase-orders
GET /api/purchase-orders/:id
POST /api/purchase-orders
POST /api/purchase-orders/:id
POST /api/purchase-orders/:id/issue
POST /api/purchase-orders/:id/unissue
POST /api/purchase-orders/:id/close-short
POST /api/purchase-orders/:id/close-short/:poItemId
POST /api/purchase-orders/:id/void
DELETE /api/purchase-orders/:id
The purchase order object
Attributes
  • id integer
    The purchase order's unique identification number.
  • number string
    The purchase order number.
  • status string
    The order status.
  • class reference object
    The class category.
  • carrier reference object
    The shipping carrier.
  • fobPointName string
    Indicates when ownership/liability of the order transfers to the purchaser.
  • paymentTerms reference object
    The terms of payment on the order.
  • shipTerms string
    The shipping terms on the order.
  • type string: 'Standard' | 'Drop Ship'
    Indicates whether the order is a standard or drop ship purchase order.
  • vendor reference object
    The vendor on the purchase order.
  • vendorSoNumber string
    The vendor sales order number.
  • customerSoNumber string
    The customer sales order number.
  • buyer reference object
    The Fishbowl user that created the order.
  • 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.
  • issuedByUser object
    Timestamp of when the order was issued and the user that made the modifications.
  • 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.
  • 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.
  • note string
    The order's note field.
  • url string
    The url link on the order.
  • currency reference object
    The currency used on the order.
  • 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.
  • remitToAddress object
    The remit to address on the order.
  • poItems list
    A list of the purchase order items.
  • customFields list
    A list of custom fields associated with the order.
THE PURCHASE ORDER OBJECT
{
  "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 Brakes",
  "buyer": {
    "id": 1,
    "name": "admin"
  },
  "deliverTo": "Allan's Raceway",
  "revisionNumber": 3,
  "lastModified": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.493-0700"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.490-0700"
  },
  "dateCreated": "2020-11-18T00:00:00.000-0700",
  "dateConfirmed": "2020-11-18T15:44:40.886-0700",
  "dateRevision": "2020-11-18T15:44:40.839-0700",
  "dateScheduled": "2020-11-18T00:00:00.000-0700",
  "dateCompleted": "2020-11-20T00:00:00.000-0700",
  "taxRate": {
    "id": 0,
    "name": "None"
  },
  "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": "brent@example.com",
  "phone": "801-932-1101",
  "shipToAddress": {
    "name": "Allan's Raceway",
    "street": "2222 Wrecker's Blvd",
    "city": "Santa Barbara",
    "state": "CA",
    "postalCode": "93101",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "Brent's Bicycle Brakes",
    "street": "777 South Delivery Lane",
    "city": "Salt Lake City",
    "state": "UT",
    "postalCode": "84111",
    "country": "UNITED STATES"
  },
  "status": "Issued",
  "class": {
    "id": 12,
    "name": "LA:LA Store"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Drop Ship",
  "poItems": [
    {
      "id": 182,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B1-7878",
      "quantity": "1",
      "quantityFulfilled": "0",
      "quantityPicked": "0",
      "unitCost": "9",
      "totalCost": "9",
      "mcTotalCost": "9",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateScheduledFulfillment": "2020-11-18T15:44:34.096-0700",
      "revision": "",
      "note": "",
      "customer": {
        "id": 52,
        "name": "Allan's Raceway"
      },
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "status": "Entered",
      "class": {
        "id": 12,
        "name": "LA:LA Store"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
Search for purchase orders

Searches for purchase orders.

Parameters
  • pageNumber integer
    The current page of the results.
  • pageSize integer
    The number of returned results per page. (Default 100)
  • poNumber string
    The purchase order number.
  • poType string: 'Standard' | 'Drop Ship'
    Indicates whether the order is a standard or drop ship purchase order.
  • vendorSoNumber string
    The vendor sales order number.
  • issuedFrom date: 'yyyy-MM-dd'
    The start issued date cutoff for the search.
  • issuedTo date: 'yyyy-MM-dd'
    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.
GET /api/purchase-orders 
curl --location \
--request GET '<YOUR SERVER>/api/purchase-orders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{
  "totalCount": 73,
  "totalPages": 37,
  "pageNumber": 1,
  "pageSize": 2,
  "results": [
    {
      "id": 10,
      "number": "10",
      "vendorName": "A&B Distribution",
      "dateIssued": "2020-10-01T17:58:04.821-0600",
      "dateScheduled": "2020-08-02T08:54:21.000-0600",
      "status": "Fulfilled"
    },
    {
      "id": 73,
      "number": "100",
      "vendorName": "A&B Distribution",
      "dateIssued": "2020-11-23T11:42:58.984-0700",
      "dateScheduled": "2020-11-23T00:00:00.000-0700",
      "status": "Void"
    }
  ]
}
Get a purchase order

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

Attributes

    No attributes.

GET /api/purchase-orders/:id 
curl --location \
--request GET '<YOUR SERVER>/api/purchase-orders/:id' \
--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 Brakes",
  "buyer": {
    "id": 1,
    "name": "admin"
  },
  "deliverTo": "Allan's Raceway",
  "revisionNumber": 3,
  "lastModified": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.493-0700"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.490-0700"
  },
  "dateCreated": "2020-11-18T00:00:00.000-0700",
  "dateRevision": "2020-11-18T15:44:40.839-0700",
  "dateScheduled": "2020-11-18T00:00:00.000-0700",
  "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": "brent@example.com",
  "phone": "801-932-1101",
  "shipToAddress": {
    "name": "Allan's Raceway",
    "street": "2222 Wrecker's Blvd",
    "city": "Santa Barbara",
    "state": "CA",
    "postalCode": "93101",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "Brent's Bicycle Brakes",
    "street": "777 South Delivery Lane",
    "city": "Salt Lake City",
    "state": "UT",
    "postalCode": "84111",
    "country": "UNITED STATES"
  },
  "status": "Issued",
  "class": {
    "id": 12,
    "name": "LA:LA Store"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Drop Ship",
  "poItems": [
    {
      "id": 182,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B1-7878",
      "quantity": "1",
      "quantityFulfilled": "0",
      "quantityPicked": "0",
      "unitCost": "9",
      "totalCost": "9",
      "mcTotalCost": "9",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateScheduledFulfillment": "2020-11-18T15:44:34.096-0700",
      "revision": "",
      "note": "",
      "customer": {
        "id": 52,
        "name": "Allan's Raceway"
      },
      "uomId": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "status": "Entered",
      "class": {
        "id": 12,
        "name": "LA:LA Store"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
Create a purchase order

Creates a purchase order.

Attributes
  • number string optional
    The purchase order number.
  • status string optional
    The order status.
  • class reference object optional
    The class category.
  • carrier reference object optional
    The shipping carrier.
  • fobPointName string optional
    Indicates when ownership/liability of the order transfers to the purchaser.
  • paymentTerms reference object optional
    The terms of payment on the order.
  • shipTerms string optional
    The shipping terms on the order.
  • vendor reference object
    The vendor on the purchase order.
  • vendorSoNumber string optional
    The vendor sales order number.
  • customerSoNumber string optional
    The customer sales order number.
  • buyer reference object optional
    The Fishbowl user that created the order.
  • deliverTo string optional
    The intended recipient of the order.
  • revisionNumber integer optional
    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.
  • totalIncludesTax boolean optional
    Indicates if the order total includes tax. For international orders.
  • locationGroup reference object optional
    The location group the order belongs to.
  • 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.
  • 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.
  • remitToAddress object optional
    The remit to address on the order.
  • poItems list optional
    A list of the purchase order items.
  • customFields list optional
    A list of the order's custom fields.
POST /api/purchase-orders 
curl --location \
--request POST '<YOUR SERVER>/api/purchase-orders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '<PO JSON>'
RESPONSE
{
  "id": 72,
  "number": "50071",
  "carrier": {
    "id": 5,
    "name": "USPS",
    "service": {
      "id": 16,
      "name": "Priority Mail"
    }
  },
  "fobPointName": "Origin",
  "paymentTerms": {
    "id": 4,
    "name": "Net 30"
  },
  "vendor": {
    "id": 17,
    "name": "Brent's Bicycle Brakes"
  },
  "vendorSoNumber": "S108",
  "customerSoNumber": "10086",
  "vendorContact": "Brent's Bicycle Brakes",
  "buyer": {
    "id": 1,
    "name": "admin"
  },
  "deliverTo": "Allan's Raceway",
  "revisionNumber": 3,
  "lastModified": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.493-0700"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.490-0700"
  },
  "dateCreated": "2020-11-18T00:00:00.000-0700",
  "dateRevision": "2020-11-18T15:44:40.839-0700",
  "dateScheduled": "2020-11-18T00:00:00.000-0700",
  "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": "brent@example.com",
  "phone": "801-932-1101",
  "shipToAddress": {
    "name": "Allan's Raceway",
    "street": "2222 Wrecker's Blvd",
    "city": "Santa Barbara",
    "state": "CA",
    "postalCode": "93101",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "Brent's Bicycle Brakes",
    "street": "777 South Delivery Lane",
    "city": "Salt Lake City",
    "state": "UT",
    "postalCode": "84111",
    "country": "UNITED STATES"
  },
  "status": "Issued",
  "class": {
    "id": 12,
    "name": "LA:LA Store"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Drop Ship",
  "poItems": [
    {
      "id": 182,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B1-7878",
      "quantity": "1",
      "quantityFulfilled": "0",
      "quantityPicked": "0",
      "unitCost": "9",
      "totalCost": "9",
      "mcTotalCost": "9",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateScheduledFulfillment": "2020-11-18T15:44:34.096-0700",
      "revision": "",
      "note": "",
      "customer": {
        "id": 52,
        "name": "Allan's Raceway"
      },
      "uomId": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "status": "Entered",
      "class": {
        "id": 12,
        "name": "LA:LA Store"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
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
  • number string optional
    The purchase order number.
  • class reference object optional
    The class category.
  • carrier reference object optional
    The shipping carrier.
  • fobPointName string optional
    Indicates when ownership/liability of the order transfers to the purchaser.
  • paymentTerms reference object optional
    The terms of payment on the order.
  • shipTerms string optional
    The shipping terms on the order.
  • vendor reference object
    The vendor on the purchase order.
  • vendorSoNumber string optional
    The vendor sales order number.
  • customerSoNumber string optional
    The customer sales order number.
  • buyer reference object optional
    The Fishbowl user that created the order.
  • deliverTo string optional
    The intended recipient of the order.
  • revisionNumber integer optional
    The revision number.
  • 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.
  • totalIncludesTax boolean optional
    Indicates if the order total includes tax. For international orders.
  • locationGroup reference object optional
    The location group the order belongs to.
  • 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.
  • 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.
  • remitToAddress object optional
    The remit to address on the order.
  • poItems list optional
    A list of the purchase order items.
  • customFields list optional
    A list of the order's custom fields.
POST /api/purchase-orders/:id 
curl --location \
--request POST '<YOUR SERVER>/api/purchase-orders/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '<PO JSON>'
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 Brakes",
  "buyer": {
    "id": 1,
    "name": "admin"
  },
  "deliverTo": "Allan's Raceway",
  "revisionNumber": 3,
  "lastModified": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.493-0700"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.490-0700"
  },
  "dateCreated": "2020-11-18T00:00:00.000-0700",
  "dateRevision": "2020-11-18T15:44:40.839-0700",
  "dateScheduled": "2020-11-18T00:00:00.000-0700",
  "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": "brent@example.com",
  "phone": "801-932-1101",
  "shipToAddress": {
    "name": "Allan's Raceway",
    "street": "2222 Wrecker's Blvd",
    "city": "Santa Barbara",
    "state": "CA",
    "postalCode": "93101",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "Brent's Bicycle Brakes",
    "street": "777 South Delivery Lane",
    "city": "Salt Lake City",
    "state": "UT",
    "postalCode": "84111",
    "country": "UNITED STATES"
  },
  "status": "Issued",
  "class": {
    "id": 12,
    "name": "LA:LA Store"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Drop Ship",
  "poItems": [
    {
      "id": 182,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B1-7878",
      "quantity": "1",
      "quantityFulfilled": "0",
      "quantityPicked": "0",
      "unitCost": "9",
      "totalCost": "9",
      "mcTotalCost": "9",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateScheduledFulfillment": "2020-11-18T15:44:34.096-0700",
      "revision": "",
      "note": "",
      "customer": {
        "id": 52,
        "name": "Allan's Raceway"
      },
      "uomId": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "status": "Entered",
      "class": {
        "id": 12,
        "name": "LA:LA Store"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
Issue a purchase order

Issues the purchase order with the specified ID.

Attributes

    No attributes.

POST /api/purchase-orders/:id/issue 
curl --location \
--request POST '<YOUR SERVER>/api/purchase-orders/:id/issue' \
--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 Brakes",
  "buyer": {
    "id": 1,
    "name": "admin"
  },
  "deliverTo": "Allan's Raceway",
  "revisionNumber": 3,
  "lastModified": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.493-0700"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.490-0700"
  },
  "dateCreated": "2020-11-18T00:00:00.000-0700",
  "dateRevision": "2020-11-18T15:44:40.839-0700",
  "dateScheduled": "2020-11-18T00:00:00.000-0700",
  "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": "brent@example.com",
  "phone": "801-932-1101",
  "shipToAddress": {
    "name": "Allan's Raceway",
    "street": "2222 Wrecker's Blvd",
    "city": "Santa Barbara",
    "state": "CA",
    "postalCode": "93101",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "Brent's Bicycle Brakes",
    "street": "777 South Delivery Lane",
    "city": "Salt Lake City",
    "state": "UT",
    "postalCode": "84111",
    "country": "UNITED STATES"
  },
  "status": "Issued",
  "class": {
    "id": 12,
    "name": "LA:LA Store"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Drop Ship",
  "poItems": [
    {
      "id": 182,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B1-7878",
      "quantity": "1",
      "quantityFulfilled": "0",
      "quantityPicked": "0",
      "unitCost": "9",
      "totalCost": "9",
      "mcTotalCost": "9",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateScheduledFulfillment": "2020-11-18T15:44:34.096-0700",
      "revision": "",
      "note": "",
      "customer": {
        "id": 52,
        "name": "Allan's Raceway"
      },
      "uomId": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "status": "Entered",
      "class": {
        "id": 12,
        "name": "LA:LA Store"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
Unissue a purchase order

Unissues the purchase order with the specified ID.

Attributes

    No attributes.

POST /api/purchase-orders/:id/unissue 
curl --location \
--request POST '<YOUR SERVER>/api/purchase-orders/:id/unissue' \
--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 Brakes",
  "buyer": {
    "id": 1,
    "name": "admin"
  },
  "deliverTo": "Allan's Raceway",
  "revisionNumber": 3,
  "lastModified": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.493-0700"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.490-0700"
  },
  "dateCreated": "2020-11-18T00:00:00.000-0700",
  "dateRevision": "2020-11-18T15:44:40.839-0700",
  "dateScheduled": "2020-11-18T00:00:00.000-0700",
  "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": "brent@example.com",
  "phone": "801-932-1101",
  "shipToAddress": {
    "name": "Allan's Raceway",
    "street": "2222 Wrecker's Blvd",
    "city": "Santa Barbara",
    "state": "CA",
    "postalCode": "93101",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "Brent's Bicycle Brakes",
    "street": "777 South Delivery Lane",
    "city": "Salt Lake City",
    "state": "UT",
    "postalCode": "84111",
    "country": "UNITED STATES"
  },
  "status": "Bid Request",
  "class": {
    "id": 12,
    "name": "LA:LA Store"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Drop Ship",
  "poItems": [
    {
      "id": 182,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B1-7878",
      "quantity": "1",
      "quantityFulfilled": "0",
      "quantityPicked": "0",
      "unitCost": "9",
      "totalCost": "9",
      "mcTotalCost": "9",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateScheduledFulfillment": "2020-11-18T15:44:34.096-0700",
      "revision": "",
      "note": "",
      "customer": {
        "id": 52,
        "name": "Allan's Raceway"
      },
      "uomId": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "status": "Entered",
      "class": {
        "id": 12,
        "name": "LA:LA Store"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
Close short a purchase order

Close shorts the purchase order with the specified ID.

Attributes

    No attributes.

POST /api/purchase-orders/:id/close-short 
curl --location \
--request POST '<YOUR SERVER>/api/purchase-orders/:id/close-short' \
--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-26T11:24:27.393-0600"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-03-17T09:52:45.346-0600"
  },
  "dateCreated": "2021-03-17T00:00:00.000-0600",
  "dateScheduled": "2021-03-17T00:00:00.000-0600",
  "dateCompleted": "2021-03-26T11:24:27.388-0600",
  "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",
    "street": "580 Technology Way",
    "city": "Orem",
    "state": "UT",
    "postalCode": "84097",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "A&B Distribution",
    "street": "432 Vine St.",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": "91775",
    "country": "UNITED STATES"
  },
  "status": "Closed Short",
  "class": {
    "id": 1,
    "name": "None"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Standard",
  "poItems": [
    {
      "id": 194,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B201",
      "unitCost": "5",
      "totalTax": "0",
      "totalCost": "5",
      "mcTotalTax": "0",
      "mcTotalCost": "5",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateLastFulfilled": "2021-03-26T11:24:27.381-0600",
      "dateScheduled": "2021-03-17T09:52:24.126-0600",
      "revision": "",
      "note": "",
      "status": "Closed Short",
      "quantity": "1",
      "quantityFulfilled": "1",
      "quantityPicked": "0",
      "class": {
        "id": 1,
        "name": "None"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
Close short a purchase order item

Close shorts the purchase order item with the specified ID.

Attributes

    No attributes.

POST /api/purchase-orders/:id/close-short/:poItemId 
curl --location \
--request POST '<YOUR SERVER>/api/purchase-orders/:id/close-short/:poItemId' \
--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-26T11:24:27.393-0600"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-03-17T09:52:45.346-0600"
  },
  "dateCreated": "2021-03-17T00:00:00.000-0600",
  "dateScheduled": "2021-03-17T00:00:00.000-0600",
  "dateCompleted": "2021-03-26T11:24:27.388-0600",
  "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",
    "street": "580 Technology Way",
    "city": "Orem",
    "state": "UT",
    "postalCode": "84097",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "A&B Distribution",
    "street": "432 Vine St.",
    "city": "Los Angeles",
    "state": "CA",
    "postalCode": "91775",
    "country": "UNITED STATES"
  },
  "status": "Closed Short",
  "class": {
    "id": 1,
    "name": "None"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Standard",
  "poItems": [
    {
      "id": 194,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "uom": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B201",
      "unitCost": "5",
      "totalTax": "0",
      "totalCost": "5",
      "mcTotalTax": "0",
      "mcTotalCost": "5",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateLastFulfilled": "2021-03-26T11:24:27.381-0600",
      "dateScheduled": "2021-03-17T09:52:24.126-0600",
      "revision": "",
      "note": "",
      "status": "Closed Short",
      "quantity": "1",
      "quantityFulfilled": "1",
      "quantityPicked": "0",
      "class": {
        "id": 1,
        "name": "None"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
Void a purchase order

Voids the purchase order with the specified ID.

Attributes

    No attributes.

POST /api/purchase-orders/:id/void 
curl --location \
--request POST '<YOUR SERVER>/api/purchase-orders/:id/void' \
--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 Brakes",
  "buyer": {
    "id": 1,
    "name": "admin"
  },
  "deliverTo": "Allan's Raceway",
  "revisionNumber": 3,
  "lastModified": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.493-0700"
  },
  "issuedByUser": {
    "username": "admin",
    "dateLastModified": "2021-02-24T13:49:20.490-0700"
  },
  "dateCreated": "2020-11-18T00:00:00.000-0700",
  "dateRevision": "2020-11-18T15:44:40.839-0700",
  "dateScheduled": "2020-11-18T00:00:00.000-0700",
  "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": "brent@example.com",
  "phone": "801-932-1101",
  "shipToAddress": {
    "name": "Allan's Raceway",
    "street": "2222 Wrecker's Blvd",
    "city": "Santa Barbara",
    "state": "CA",
    "postalCode": "93101",
    "country": "UNITED STATES"
  },
  "remitToAddress": {
    "name": "Brent's Bicycle Brakes",
    "street": "777 South Delivery Lane",
    "city": "Salt Lake City",
    "state": "UT",
    "postalCode": "84111",
    "country": "UNITED STATES"
  },
  "status": "Void",
  "class": {
    "id": 12,
    "name": "LA:LA Store"
  },
  "shipTerms": "Prepaid & Billed",
  "type": "Drop Ship",
  "poItems": [
    {
      "id": 182,
      "part": {
        "id": 28,
        "name": "B201",
        "description": "Premium Brake Cables"
      },
      "type": {
        "id": 10,
        "name": "Purchase"
      },
      "lineNumber": 1,
      "vendorPartNumber": "B1-7878",
      "quantity": "1",
      "quantityFulfilled": "0",
      "quantityPicked": "0",
      "unitCost": "9",
      "totalCost": "9",
      "mcTotalCost": "9",
      "taxRate": {
        "id": 1,
        "name": "None",
        "rate": 0
      },
      "dateScheduledFulfillment": "2020-11-18T15:44:34.096-0700",
      "revision": "",
      "note": "",
      "customer": {
        "id": 52,
        "name": "Allan's Raceway"
      },
      "uomId": {
        "id": 1,
        "name": "Each",
        "abbreviation": "ea"
      },
      "status": "Void",
      "class": {
        "id": 12,
        "name": "LA:LA Store"
      },
      "customFields": []
    }
  ],
  "customFields": [
    {
      "id": 19,
      "name": "Custom",
      "value": "My Custom Field",
      "type": "Text"
    }
  ]
}
Delete a purchase order

Deletes the purchase order with the specified ID.

Attributes

    No attributes.

DELETE /api/purchase-orders/:id 
curl --location \
--request DELETE '<YOUR SERVER>/api/purchase-orders/:id' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{}