Inventory

Create a purchase order

This endpoint is available to Group API Keys only.

Creates a new purchase order in draft status with the specified line items. The quantities specified in the line items are expected to be in the same unit of measure as the configured unit of measure for the inventory code.

A purchase order tracks an order placed by a clinic to a supplier for inventory items. Each purchase order contains one or more line items identifying the inventory being ordered, the quantity, and the price. Purchase orders are created in draft status and can later be finalized in the pims web ui.

post/ext/v2/purchase-orders/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/purchase-orders/
  • Auth
    HTTP bearer

Request body

clinic_idinteger required

The ID of the clinic this purchase order belongs to

order_datetimestring date-time required

The datetime when the order was placed

po_numberstring nullable

An optional purchase order number. If omitted, one is auto-generated.

supplierstring required

The name of the supplier for this order

Response

Created

clinic_idinteger required

The ID of the clinic this purchase order belongs to

createdstring date-time required

The datetime this object was created.

effective_totalinteger required

The effective total of the order, in cents

idinteger required

The unique identifier for the purchase order

modifiedstring date-time required

The datetime this object was last modified; changes to related entities will not update this field.

order_datetimestring date-time required

The datetime when the order was placed

po_numberstring required

The purchase order number

raw_totalinteger required

The raw total of the order, in cents

status'DRAFT' | 'PENDING' | 'PARTIALLY_RECEIVED' | 'FULLY_RECEIVED' | 'CANCELED' | 'RETURNED' | 'CLOSED' required
supplierstring required

The name of the supplier for this order

Changes

No recorded changes to this operation across all 1 revision of this API.