# Purchase Orders

Purchase Orders

## POST /v1/purchase-orders/

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Purchase Orders","description":"Purchase Orders"}],"paths":{"/v1/purchase-orders/":{"post":{"tags":["Purchase Orders"],"operationId":"0eb27748619e99f2136f427482bffebb","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePurchaseOrder"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}}}}}}},"components":{"schemas":{"CreatePurchaseOrder":{"required":["supplier","line_items"],"properties":{"supplier":{"type":"string"},"shipping_location":{"type":"string","default":null,"nullable":true},"delivery_date":{"type":"string","default":null,"nullable":true},"shipping_name":{"type":"string","default":null,"nullable":true},"shipping_fee":{"type":"number","default":null,"nullable":true},"shipping_fee_tax":{"type":"number","default":null,"nullable":true},"payment_method":{"type":"string","default":null,"nullable":true},"notes":{"type":"string","default":null,"nullable":true},"status":{"type":"string","default":"DRAFT"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/CreatePurchaseOrderLineItem"}}},"type":"object"},"CreatePurchaseOrderLineItem":{"required":["product_id","qty"],"properties":{"product_id":{"type":"integer"},"qty":{"type":"number"},"carton_qty":{"type":"number","default":null},"carton_price":{"type":"number","default":null,"nullable":true}},"type":"object"},"PurchaseOrder":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/PurchaseOrderType"},"company_id":{"type":"integer"},"order_number":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string","format":"datetime"},"shipped_at":{"type":"string","format":"datetime","nullable":true},"paid_at":{"type":"string","format":"datetime","nullable":true},"received_at":{"type":"string","format":"datetime","nullable":true},"completed_at":{"type":"string","format":"datetime","nullable":true},"shipping_location_id":{"type":"string","nullable":true},"shipping_location_name":{"type":"string","nullable":true},"delivery_date":{"type":"string","format":"datetime","nullable":true},"currency":{"type":"string"},"amount":{"type":"number"},"amount_notax":{"type":"number"},"amount_tax":{"type":"number"},"amount_paid":{"type":"number","nullable":true},"payment_method":{"type":"string","nullable":true},"shipping_name":{"type":"string","nullable":true},"shipping_fee":{"type":"number","nullable":true},"shipping_fee_notax":{"type":"number","nullable":true},"shipping_fee_tax":{"type":"number","nullable":true},"credit_card_fee":{"type":"number","nullable":true},"credit_card_fee_notax":{"type":"number","nullable":true},"credit_card_fee_tax":{"type":"number","nullable":true},"credit":{"type":"number","nullable":true},"credit_notax":{"type":"number","nullable":true},"credit_tax":{"type":"number","nullable":true},"notes":{"type":"string"},"last_modified_at":{"type":"string","nullable":true},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderLineItem"}},"supplier":{"$ref":"#/components/schemas/PurchaseOrderSupplier"}},"type":"object"},"PurchaseOrderType":{"type":"string","enum":["Internal","External","Purchase"]},"PurchaseOrderLineItem":{"properties":{"id":{"type":"integer"},"order_id":{"type":"integer"},"product_id":{"type":"integer","nullable":true},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"qty":{"type":"number"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"amount":{"type":"number","nullable":true},"amount_notax":{"type":"number","nullable":true},"amount_tax":{"type":"number","nullable":true}},"type":"object"},"PurchaseOrderSupplier":{"$ref":"#/components/schemas/Supplier"},"Supplier":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"abn":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"account_number":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"payment_terms":{"type":"integer"},"payment_terms_period":{"type":"string"},"currency":{"type":"string"},"notes":{"type":"string","nullable":true},"last_modified_at":{"type":"string","nullable":true},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SupplierGroup"}}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"Contact":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile_area":{"type":"string","nullable":true},"mobile_number":{"type":"string","nullable":true},"role":{"type":"string","nullable":true}},"type":"object"},"Location":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"is_billing":{"type":"boolean"},"is_shipping":{"type":"boolean"},"manage_stock":{"type":"boolean"},"address":{"type":"string"},"suburb":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"},"location":{"type":"object","nullable":true},"opening_hours":{"type":"object","nullable":true}},"type":"object"},"SupplierGroup":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}}}}
```

## GET /v1/purchase-orders/get

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Purchase Orders","description":"Purchase Orders"}],"paths":{"/v1/purchase-orders/get":{"get":{"tags":["Purchase Orders"],"operationId":"c7ca436da101bb5fa269e1c207d12493","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}}}}}}},"components":{"schemas":{"PurchaseOrder":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/PurchaseOrderType"},"company_id":{"type":"integer"},"order_number":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string","format":"datetime"},"shipped_at":{"type":"string","format":"datetime","nullable":true},"paid_at":{"type":"string","format":"datetime","nullable":true},"received_at":{"type":"string","format":"datetime","nullable":true},"completed_at":{"type":"string","format":"datetime","nullable":true},"shipping_location_id":{"type":"string","nullable":true},"shipping_location_name":{"type":"string","nullable":true},"delivery_date":{"type":"string","format":"datetime","nullable":true},"currency":{"type":"string"},"amount":{"type":"number"},"amount_notax":{"type":"number"},"amount_tax":{"type":"number"},"amount_paid":{"type":"number","nullable":true},"payment_method":{"type":"string","nullable":true},"shipping_name":{"type":"string","nullable":true},"shipping_fee":{"type":"number","nullable":true},"shipping_fee_notax":{"type":"number","nullable":true},"shipping_fee_tax":{"type":"number","nullable":true},"credit_card_fee":{"type":"number","nullable":true},"credit_card_fee_notax":{"type":"number","nullable":true},"credit_card_fee_tax":{"type":"number","nullable":true},"credit":{"type":"number","nullable":true},"credit_notax":{"type":"number","nullable":true},"credit_tax":{"type":"number","nullable":true},"notes":{"type":"string"},"last_modified_at":{"type":"string","nullable":true},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderLineItem"}},"supplier":{"$ref":"#/components/schemas/PurchaseOrderSupplier"}},"type":"object"},"PurchaseOrderType":{"type":"string","enum":["Internal","External","Purchase"]},"PurchaseOrderLineItem":{"properties":{"id":{"type":"integer"},"order_id":{"type":"integer"},"product_id":{"type":"integer","nullable":true},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"qty":{"type":"number"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"amount":{"type":"number","nullable":true},"amount_notax":{"type":"number","nullable":true},"amount_tax":{"type":"number","nullable":true}},"type":"object"},"PurchaseOrderSupplier":{"$ref":"#/components/schemas/Supplier"},"Supplier":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"abn":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"account_number":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"payment_terms":{"type":"integer"},"payment_terms_period":{"type":"string"},"currency":{"type":"string"},"notes":{"type":"string","nullable":true},"last_modified_at":{"type":"string","nullable":true},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SupplierGroup"}}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"Contact":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile_area":{"type":"string","nullable":true},"mobile_number":{"type":"string","nullable":true},"role":{"type":"string","nullable":true}},"type":"object"},"Location":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"is_billing":{"type":"boolean"},"is_shipping":{"type":"boolean"},"manage_stock":{"type":"boolean"},"address":{"type":"string"},"suburb":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"},"location":{"type":"object","nullable":true},"opening_hours":{"type":"object","nullable":true}},"type":"object"},"SupplierGroup":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}}}}
```

## GET /v1/purchase-orders/latest

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Purchase Orders","description":"Purchase Orders"}],"paths":{"/v1/purchase-orders/latest":{"get":{"tags":["Purchase Orders"],"operationId":"c8a674b9aeec129fdd7e0bb309aea786","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"Link":{"description":"Next page of results","schema":{"type":"string","format":"uri-reference"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrder"}}}}}}}}},"components":{"schemas":{"PurchaseOrder":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/PurchaseOrderType"},"company_id":{"type":"integer"},"order_number":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string","format":"datetime"},"shipped_at":{"type":"string","format":"datetime","nullable":true},"paid_at":{"type":"string","format":"datetime","nullable":true},"received_at":{"type":"string","format":"datetime","nullable":true},"completed_at":{"type":"string","format":"datetime","nullable":true},"shipping_location_id":{"type":"string","nullable":true},"shipping_location_name":{"type":"string","nullable":true},"delivery_date":{"type":"string","format":"datetime","nullable":true},"currency":{"type":"string"},"amount":{"type":"number"},"amount_notax":{"type":"number"},"amount_tax":{"type":"number"},"amount_paid":{"type":"number","nullable":true},"payment_method":{"type":"string","nullable":true},"shipping_name":{"type":"string","nullable":true},"shipping_fee":{"type":"number","nullable":true},"shipping_fee_notax":{"type":"number","nullable":true},"shipping_fee_tax":{"type":"number","nullable":true},"credit_card_fee":{"type":"number","nullable":true},"credit_card_fee_notax":{"type":"number","nullable":true},"credit_card_fee_tax":{"type":"number","nullable":true},"credit":{"type":"number","nullable":true},"credit_notax":{"type":"number","nullable":true},"credit_tax":{"type":"number","nullable":true},"notes":{"type":"string"},"last_modified_at":{"type":"string","nullable":true},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderLineItem"}},"supplier":{"$ref":"#/components/schemas/PurchaseOrderSupplier"}},"type":"object"},"PurchaseOrderType":{"type":"string","enum":["Internal","External","Purchase"]},"PurchaseOrderLineItem":{"properties":{"id":{"type":"integer"},"order_id":{"type":"integer"},"product_id":{"type":"integer","nullable":true},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"qty":{"type":"number"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"amount":{"type":"number","nullable":true},"amount_notax":{"type":"number","nullable":true},"amount_tax":{"type":"number","nullable":true}},"type":"object"},"PurchaseOrderSupplier":{"$ref":"#/components/schemas/Supplier"},"Supplier":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"abn":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"account_number":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"payment_terms":{"type":"integer"},"payment_terms_period":{"type":"string"},"currency":{"type":"string"},"notes":{"type":"string","nullable":true},"last_modified_at":{"type":"string","nullable":true},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SupplierGroup"}}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"Contact":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile_area":{"type":"string","nullable":true},"mobile_number":{"type":"string","nullable":true},"role":{"type":"string","nullable":true}},"type":"object"},"Location":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"is_billing":{"type":"boolean"},"is_shipping":{"type":"boolean"},"manage_stock":{"type":"boolean"},"address":{"type":"string"},"suburb":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"},"location":{"type":"object","nullable":true},"opening_hours":{"type":"object","nullable":true}},"type":"object"},"SupplierGroup":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}}}}
```

## PUT /v1/purchase-orders/modify

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Purchase Orders","description":"Purchase Orders"}],"paths":{"/v1/purchase-orders/modify":{"put":{"tags":["Purchase Orders"],"operationId":"5cc4fb2c764c6d96d081b0b8570df179","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePurchaseOrder"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrder"}}}}}}}},"components":{"schemas":{"UpdatePurchaseOrder":{"required":["line_items"],"properties":{"shipping_location":{"type":"string","default":null,"nullable":true},"delivery_date":{"type":"string","default":null,"nullable":true},"shipping_name":{"type":"string","default":null,"nullable":true},"shipping_fee":{"type":"number","default":null,"nullable":true},"shipping_fee_tax":{"type":"number","default":null,"nullable":true},"payment_method":{"type":"string","default":null,"nullable":true},"notes":{"type":"string","default":null,"nullable":true},"status":{"type":"string","default":null,"nullable":true},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/UpdatePurchaseOrderLineItem"}}},"type":"object"},"UpdatePurchaseOrderLineItem":{"required":["id"],"properties":{"id":{"type":"integer"},"qty":{"type":"number","default":null,"nullable":true},"carton_qty":{"type":"number","default":null,"nullable":true},"carton_price":{"type":"number","default":null,"nullable":true}},"type":"object"},"PurchaseOrder":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/PurchaseOrderType"},"company_id":{"type":"integer"},"order_number":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string","format":"datetime"},"shipped_at":{"type":"string","format":"datetime","nullable":true},"paid_at":{"type":"string","format":"datetime","nullable":true},"received_at":{"type":"string","format":"datetime","nullable":true},"completed_at":{"type":"string","format":"datetime","nullable":true},"shipping_location_id":{"type":"string","nullable":true},"shipping_location_name":{"type":"string","nullable":true},"delivery_date":{"type":"string","format":"datetime","nullable":true},"currency":{"type":"string"},"amount":{"type":"number"},"amount_notax":{"type":"number"},"amount_tax":{"type":"number"},"amount_paid":{"type":"number","nullable":true},"payment_method":{"type":"string","nullable":true},"shipping_name":{"type":"string","nullable":true},"shipping_fee":{"type":"number","nullable":true},"shipping_fee_notax":{"type":"number","nullable":true},"shipping_fee_tax":{"type":"number","nullable":true},"credit_card_fee":{"type":"number","nullable":true},"credit_card_fee_notax":{"type":"number","nullable":true},"credit_card_fee_tax":{"type":"number","nullable":true},"credit":{"type":"number","nullable":true},"credit_notax":{"type":"number","nullable":true},"credit_tax":{"type":"number","nullable":true},"notes":{"type":"string"},"last_modified_at":{"type":"string","nullable":true},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/PurchaseOrderLineItem"}},"supplier":{"$ref":"#/components/schemas/PurchaseOrderSupplier"}},"type":"object"},"PurchaseOrderType":{"type":"string","enum":["Internal","External","Purchase"]},"PurchaseOrderLineItem":{"properties":{"id":{"type":"integer"},"order_id":{"type":"integer"},"product_id":{"type":"integer","nullable":true},"sku":{"type":"string"},"barcode":{"type":"string"},"name":{"type":"string"},"qty":{"type":"number"},"carton_qty":{"type":"number"},"carton_price":{"type":"number"},"amount":{"type":"number","nullable":true},"amount_notax":{"type":"number","nullable":true},"amount_tax":{"type":"number","nullable":true}},"type":"object"},"PurchaseOrderSupplier":{"$ref":"#/components/schemas/Supplier"},"Supplier":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/SupplierType"},"name":{"type":"string"},"abn":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"account_number":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"payment_terms":{"type":"integer"},"payment_terms_period":{"type":"string"},"currency":{"type":"string"},"notes":{"type":"string","nullable":true},"last_modified_at":{"type":"string","nullable":true},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SupplierGroup"}}},"type":"object"},"SupplierType":{"type":"string","enum":["Internal","External","Store"]},"Contact":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"mobile_area":{"type":"string","nullable":true},"mobile_number":{"type":"string","nullable":true},"role":{"type":"string","nullable":true}},"type":"object"},"Location":{"properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"is_billing":{"type":"boolean"},"is_shipping":{"type":"boolean"},"manage_stock":{"type":"boolean"},"address":{"type":"string"},"suburb":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"},"location":{"type":"object","nullable":true},"opening_hours":{"type":"object","nullable":true}},"type":"object"},"SupplierGroup":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}}}}
```

## DELETE /v1/purchase-orders/modify

>

```json
{"openapi":"3.0.0","info":{"title":"Supply'd API","version":"1.0"},"tags":[{"name":"Purchase Orders","description":"Purchase Orders"}],"paths":{"/v1/purchase-orders/modify":{"delete":{"tags":["Purchase Orders"],"operationId":"a16fe24788dd1b0b1a61945e7b29841c","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Accepted"}}}}}}
```