Retrieve a Purchase Order

1 min

GET

https://developer.digitail.io/api/v1/purchase-orders/{id}

Permissions needed: VIEW_ORDERS.

Returns the purchase order with its items; each item carries is_received. The clinic is resolved from the X-ClinicId header and must match the order's clinic.

Responses

200successful operation

object
- dataobject
  - idinteger
    Example
    1
  - clinic_idinteger
    Example
    1
  - supplier_idinteger
    Example
    1
  - supplierobject
    - idinteger
      Example
      1
    - cifstring
      Example
      RO123456
    - register_nostring
      Example
      J22/12345/2025
    - namestring
      Example
      Supplier A
    - addressstring
      Example
      123 Main Street, Anytown, USA, 12345
    - subsidiary_addressstring
      Example
      123 Supply Chain Way, Logistics City, CA 90210
    - administratorstring
      Example
      John Doe
    - is_vat_payerboolean
      Example
      true
    - bank_namestring
      Example
      ING BANK
    - bank_accountstring
      Example
      RO66BACX0000001234567890
    - bank_addressstring
      Example
      123 Main Street, Anytown, USA, 12345
    - bank_swiftstring
      Example
      INGBROBUXXX
    - external_sourcestring
    - external_idstring
  - statusstring<draft | pending | backorder | completed>
    Example
    completed
    Allowed
    draftpendingbackordercompleted
  - purchase_order_numberinteger
    Example
    1
    Description
    Unique purchase order number. Automatically generated by the system. Can be used to search for the purchase order.
  - datestring<date-time>
    Example
    2021-08-01T00:00:00.000Z
    Format
    date-time
  - reception_committeestring[]
    Example
    [ "Jane", "John" ]
  - order_typestring<original | backorder>
    Allowed
    originalbackorder
  - document_typestring< | 1 | 2 | 3 | 4 | 5 | 6>
    Example
    1
    Description
    empty: NO_DOCUMENT, 1: INVOICE, 2: RECEIPT, 3: BILL, 4: NOTICE, 5: TRANSFER_NOTE, 6: CASH_REGISTER_RECEIPT
    Allowed
    123456
  - document_datestring<date-time>
    Example
    2021-08-01T00:00:00.000Z
    Format
    date-time
  - document_numberstring
    Example
    123
  - document_seriesstring
    Example
    DGT
  - document_due_datestring<date-time>
    Example
    2021-08-01T00:00:00.000Z
    Format
    date-time
  - global_discountnumber
    Example
    10
  - updated_atstring<date-time>
    Example
    2021-08-01T00:00:00.000Z
    Format
    date-time
  - cogs_subtotalnumber
    Example
    10
    Description
    Visible only when viewing individual purchase order.
  - cogs_taxnumber
    Example
    1
    Description
    Visible only when viewing individual purchase order.
  - cogs_totalnumber
    Example
    11
    Description
    Visible only when viewing individual purchase order.
  - selling_price_subtotalnumber
    Example
    10
    Description
    Visible only when viewing individual purchase order.
  - selling_price_taxnumber
    Example
    1
    Description
    Visible only when viewing individual purchase order.
  - selling_price_totalnumber
    Example
    11
    Description
    Visible only when viewing individual purchase order.
  - goods_subtotalnumber
    Example
    7
    Description
    Visible only when viewing multiple purchase orders.
  - consumables_subtotalnumber
    Example
    3
    Description
    Visible only when viewing multiple purchase orders.
  - itemsobject[]
    - idinteger
      Example
      1
    - product_idinteger
      Example
      1
    - productobject
      Description
      Details related to the product the Purchase Order Item is linked to. Included only when receiving a single purchase order.
      - namestring
        Example
        Product Name
      - fixed_feenumber<float>
        Format
        float
      - unitstring
        Example
        Box
      - last_cogsobject
        Description
        Last cost of goods sold for the product, per unit and per sub-unit. COGS doesnt include tax.
        unitnumber<float>
        Example
        10
        Format
        float
        subunitnumber<float>
        Example
        2.5
        Format
        float
      - last_pricestring
        Example
        10.00
        Description
        Last selling price recorded for the product, as a decimal string.
      - last_price_includes_taxboolean
      - pricenumber<float>
        Example
        25
        Description
        Current selling price of the product.
        Format
        float
      - price_includes_taxboolean
        Example
        true
      - is_newly_auto_createdboolean
        Example
        true
      - is_disabledboolean
      - is_deletedboolean
      - external_sourcestring
        Example
        external
        Description
        Provider the product was imported from (e.g. vetcove, external), if any.
    - batchstring
      Example
      123
    - expiration_datestring<date-time>
      Example
      2027-01-01T00:00:00.000000Z
      Format
      date-time
    - quantitynumber<float>
      Example
      1
      Format
      float
    - cogsstring
      Example
      658.73
      Description
      Unit cost of goods sold, as a decimal string. Does not include tax.
    - cogs_discount_valuenumber<float>
      Format
      float
    - cogs_discount_is_fixedboolean
      Description
      True if discount is fixed amount, false if discount is percentage.
    - supplier_taxnumber<float>
      Example
      1
      Format
      float
    - pricestring
      Example
      295.20
      Description
      Unit selling price, as a decimal string.
    - selling_taxnumber<float>
      Example
      1
      Format
      float
    - markupnumber<float>
      Example
      50.473
      Description
      Markup of the product. calculated on cogs and selling price
      Format
      float
    - consumedboolean
      Description
      True if current batch of product was consumed. Product data non-editable if true
    - unit_cogs_post_discount_netnumber<float>
      Example
      10
      Format
      float
    - cogs_post_discount_grossnumber<float>
      Example
      10
      Format
      float
    - unit_cogs_post_supplier_discount_netnumber<float>
      Example
      10
      Description
      Unit COGS after the supplier discount, before the order (global) discount is allocated
      Format
      float
    - cogs_post_supplier_discount_grossnumber<float>
      Example
      10
      Description
      Total COGS with supplier tax after the supplier discount, before the order (global) discount is allocated
      Format
      float
    - consumableboolean
    - sub_unit_cogsnumber<float>
      Example
      329.36
      Description
      Unit cost divided by the product formula (cost per sub-unit).
      Format
      float
    - is_receivedboolean
      Example
      true
      Description
      Whether the line was received. Set when the order is completed.
    - override_sale_priceboolean
    - cogs_prefilled_from_vetcoveboolean
      Description
      Whether the COGS still holds the unit price Vetcove sent when it created the order. Cleared on the first COGS edit.
  - unreceived_disabled_itemsitems[]
  - related_orderobject
    Description
    Included on request. The backorder created for this order's unreceived lines, or the original order this backorder was split from. Carries the same fields as a purchase order except items and related_order.
  - items_countnumber
    Example
    3
    Description
    Visible only when viewing multiple purchase orders.
  - has_consumed_itemsboolean
    Example
    true
    Description
    Visible only when viewing multiple purchase orders.

curl

curl --request GET \
     --url https://developer.digitail.io/api/v1/purchase-orders/{id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/purchase-orders/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/purchase-orders/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/purchase-orders/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// successful operation
{
  "data": {
    "id": 1,
    "clinic_id": 1,
    "supplier_id": 1,
    "supplier": {
      "id": 1,
      "cif": "RO123456",
      "register_no": "J22/12345/2025",
      "name": "Supplier A",
      "address": "123 Main Street, Anytown, USA, 12345",
      "subsidiary_address": "123 Supply Chain Way, Logistics City, CA 90210",
      "administrator": "John Doe",
      "is_vat_payer": true,
      "bank_name": "ING BANK",
      "bank_account": "RO66BACX0000001234567890",
      "bank_address": "123 Main Street, Anytown, USA, 12345",
      "bank_swift": "INGBROBUXXX",
      "external_source": "",
      "external_id": ""
    },
    "status": "completed",
    "purchase_order_number": 1,
    "date": "2021-08-01T00:00:00.000Z",
    "reception_committee": [
      ""
    ],
    "order_type": "",
    "document_type": 1,
    "document_date": "2021-08-01T00:00:00.000Z",
    "document_number": "123",
    "document_series": "DGT",
    "document_due_date": "2021-08-01T00:00:00.000Z",
    "global_discount": 10,
    "updated_at": "2021-08-01T00:00:00.000Z",
    "cogs_subtotal": 10,
    "cogs_tax": 1,
    "cogs_total": 11,
    "selling_price_subtotal": 10,
    "selling_price_tax": 1,
    "selling_price_total": 11,
    "goods_subtotal": 7,
    "consumables_subtotal": 3,
    "items": [
      {
        "id": 1,
        "product_id": 1,
        "product": {
          "name": "Product Name",
          "fixed_fee": "",
          "unit": "Box",
          "last_cogs": {
            "unit": 10,
            "subunit": 2.5
          },
          "last_price": "10.00",
          "last_price_includes_tax": false,
          "price": 25,
          "price_includes_tax": true,
          "is_newly_auto_created": true,
          "is_disabled": false,
          "is_deleted": false,
          "external_source": "external"
        },
        "batch": "123",
        "expiration_date": "2027-01-01T00:00:00.000000Z",
        "quantity": 1,
        "cogs": "658.73",
        "cogs_discount_value": "",
        "cogs_discount_is_fixed": false,
        "supplier_tax": 1,
        "price": "295.20",
        "selling_tax": 1,
        "markup": 50.473,
        "consumed": false,
        "unit_cogs_post_discount_net": 10,
        "cogs_post_discount_gross": 10,
        "unit_cogs_post_supplier_discount_net": 10,
        "cogs_post_supplier_discount_gross": 10,
        "consumable": false,
        "sub_unit_cogs": 329.36,
        "is_received": true,
        "override_sale_price": false,
        "cogs_prefilled_from_vetcove": false
      }
    ],
    "unreceived_disabled_items": [
      ""
    ],
    "related_order": {},
    "items_count": 3,
    "has_consumed_items": true
  }
}