---
title: "Query balances"
method: GET
path: "/inventory"
tags: ["InventoryBalance"]
---

# Query balances

`GET /inventory`

## Request

- Base URL: `https://r38.coupadev.com/api`
- URL: `https://r38.coupadev.com/api/inventory`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://r38.coupadev.com/oauth2/authorizations/new`
    - Token URL: `https://r38.coupadev.com/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `https://r38.coupadev.com/oauth2/access_tokens`
- TypeScript: <https://skmtc.dev/coupa/apis/coupa-api-4/docs/inventory/get.ts> (a function with typed inputs; its response is checked against the schema)

Query balances

## Query parameters

- `limit` integer
- `offset` integer
- `order_by` string
- `dir` 'asc' | 'desc'
- `return_object` 'limited' | 'shallow' | 'none'
- `filter` string

## Response `200`

InventoryBalance objects

- InventoryBalance[]
  - `adjustment-price` string, string: Price for adjustment
  - `allocated` string, 0.0: allocated quantity
  - `available` string, 0.0: available quantity
  - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `created-by` UserSimple
    - `avatar-thumb-url` string, string: Avatar url
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `email` string, string(255), required: email
    - `employee-number` string, string(255): employee number
    - `firstname` string, string(40), required: first name
    - `fullname` string, string(255): full name
    - `id` integer: Coupa unique identifier
    - `lastname` string, string(40), required: last name
    - `login` string, string(255), required: login
    - `salesforce-id` string, string(255), required: salesforce_id
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `currency` Currency
    - `code` string, string(6), required: code
    - `decimals` integer: Decimal precision
    - `enabled` boolean: Enabled
    - `id` integer: Coupa unique identifier
    - `name` string, string(100), required: name
    - `symbol` string, string(10): symbol
  - `id` integer: Coupa unique identifier
  - `inventory-valuations` InventoryValuation[]
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `currency` Currency, required
      - `code` string, string(6), required: code
      - `decimals` integer: Decimal precision
      - `enabled` boolean: Enabled
      - `id` integer: Coupa unique identifier
      - `name` string, string(100), required: name
      - `symbol` string, string(10): symbol
    - `id` integer: Coupa unique identifier
    - `total` string: Total
    - `unit-price` number: Unit price
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `item` Item, required
    - `active` boolean: Is the item given for this supplier & contract active? and if NOT then DELETE
    - `allow-partial-quantity` boolean: Allow partial quantity in cycle counts
    - `commodity` Commodity
      - `active` boolean: A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.
      - `category` 'goods' | 'services', string(255): Category
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `deductibility` 'fully_deductible' | 'partially_deductible' | 'not_deductible', string(255): Deductibility
      - `id` integer: Coupa unique identifier
      - `imported-from-taxonomy` boolean: A true value will tell that the commodity is imported from Coupa Taxonomy. A false value will tell that the value is created by a user or system
      - `name` string, string(255), required: name
      - `parent` Commodity (recursive)
      - `preferred` 'Yes' | 'No' | 'Automatic' | 'Always' | 'Never', string(255): A Yes/No value will mark/unmark commodity as preferred. Set to Automate if you want the system to mark preferred. 'Automatic' option is available only if 'Automatic Guided Requests configuration' is enabled in company information
      - `subcategory` 'raw_materials' | 'investment_goods' | 'services_exceptions', string(255): Subcategory
      - `translated-name` string, string: Translated name
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `connect-item-id` integer: connect_item_id
    - `consumption-quantity` integer: consumption_quantity
    - `consumption-uom` Uom
      - `active` boolean: A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.
      - `allowable-precision` integer, required: allowable_precision
      - `code` string, string(6), required: code
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa unique identifier
      - `name` string, string(100), required: name
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `created-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `description` string, text, required: Item desciption
    - `dual-uom-allowed` boolean: Dual UOM allowed
    - `external-image-url` string, string: External image URL for item image
    - `id` integer: Coupa unique identifier
    - `image-url` string, string: URL for item image (will be copied into Coupa on item create/update)
    - `inventory-lot-expiration-type` string, string: Lot expiration type
    - `inventory-lot-tracking-enabled` boolean: Enable lot tracking
    - `item-number` string, string(255): Unique item number
    - `item-type` string, string: Item Type
    - `manufacturer-name` string, string(255), required: Manufacturer name
    - `manufacturer-part-number` string, string(255): Manufacturer part number
    - `name` string, string(255), required: Item name
    - `net-weight` number, required: net_weight
    - `net-weight-uom` Uom
      - `active` boolean: A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.
      - `allowable-precision` integer, required: allowable_precision
      - `code` string, string(6), required: code
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa unique identifier
      - `name` string, string(100), required: name
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `pack-qty` number, required: Total items in a pack
    - `pack-uom` Uom
      - `active` boolean: A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.
      - `allowable-precision` integer, required: allowable_precision
      - `code` string, string(6), required: code
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa unique identifier
      - `name` string, string(100), required: name
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `pack-uom-id` integer, required: Pack UOM ID
    - `pack-weight` number, required: Total weight of a pack
    - `receive-catch-weight` boolean: Receive item as a catch weight (pack)
    - `receiving-form` Form
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `form-type` string, string(255): form_type
      - `id` integer: Coupa unique identifier
      - `name` string, string(100), required: name
      - `status` string, string(50): transaction status
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `reorder-alerts` string, string: List of alerts
    - `reorder-point` number, float: reorder_point
    - `require-asset-tag` boolean: Require asset tag
    - `require-inspection` boolean: Require inspection
    - `storage-quantity` integer: storage_quantity
    - `storage-uom` Uom
      - `active` boolean: A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.
      - `allowable-precision` integer, required: allowable_precision
      - `code` string, string(6), required: code
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa unique identifier
      - `name` string, string(100), required: name
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `sustainability-detail` SustainabilityDetail
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa unique identifier
      - `level` integer: Level
      - `title` string, string(255): Title
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `url` string, string(255): Url
    - `tax-detail` ItemTaxDetail
      - `cfop` string, string(255): Cfop
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa unique identifier
      - `ncm` string, string(255): Ncm
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `uom` Uom
      - `active` boolean: A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.
      - `allowable-precision` integer, required: allowable_precision
      - `code` string, string(6), required: code
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa unique identifier
      - `name` string, string(100), required: name
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `updated-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `use-pack-weight` boolean: Item is a pack of items
  - `quantity` integer: consumption quantity
  - `uom` Uom
    - `active` boolean: A false value will inactivate the account making it no longer available to users. A true value will make it active and available to users.
    - `allowable-precision` integer, required: allowable_precision
    - `code` string, string(6), required: code
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `created-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `id` integer: Coupa unique identifier
    - `name` string, string(100), required: name
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `updated-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `updated-by` UserSimple
    - `avatar-thumb-url` string, string: Avatar url
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `email` string, string(255), required: email
    - `employee-number` string, string(255): employee number
    - `firstname` string, string(40), required: first name
    - `fullname` string, string(255): full name
    - `id` integer: Coupa unique identifier
    - `lastname` string, string(40), required: last name
    - `login` string, string(255), required: login
    - `salesforce-id` string, string(255), required: salesforce_id
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `warehouse` Warehouse, required
    - `active-flag` boolean: active_flag
    - `address` Address, required
      - `active` boolean: A no value will make the address inactive making it no longer available to users. A yes value will make it active and available to users.
      - `attention` string, string(255): Address Default Attention Line
      - `business-group-name` string, string: Content Group Name for Address
      - `city` string, string(255), required: City Name
      - `content-groups` BusinessGroup[]
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `created-by` UserSimple
          - `avatar-thumb-url` string, string: Avatar url
          - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
          - `email` string, string(255), required: email
          - `employee-number` string, string(255): employee number
          - `firstname` string, string(40), required: first name
          - `fullname` string, string(255): full name
          - `id` integer: Coupa unique identifier
          - `lastname` string, string(40), required: last name
          - `login` string, string(255), required: login
          - `salesforce-id` string, string(255), required: salesforce_id
          - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `description` string, string(255): description
        - `id` integer: Coupa unique identifier
        - `name` string, string(100), required: name
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `updated-by` UserSimple
          - `avatar-thumb-url` string, string: Avatar url
          - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
          - `email` string, string(255), required: email
          - `employee-number` string, string(255): employee number
          - `firstname` string, string(40), required: first name
          - `fullname` string, string(255): full name
          - `id` integer: Coupa unique identifier
          - `lastname` string, string(40), required: last name
          - `login` string, string(255), required: login
          - `salesforce-id` string, string(255), required: salesforce_id
          - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `country` Country, required
        - `code` string, string(4), required: code
        - `created-at` string: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `id` integer: Coupa unique identifier
        - `name` string, string(100): name
        - `updated-at` string: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa Internal Address ID
      - `local-tax-number` string, string(255), required: Local Tax Number
      - `location-code` string, string(255): location_code
      - `name` string, string(255): Address 'Nickname'
      - `postal-code` string, string(255), required: Postal Code
      - `purposes` Purpose[]
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `created-by` UserSimple
          - `avatar-thumb-url` string, string: Avatar url
          - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
          - `email` string, string(255), required: email
          - `employee-number` string, string(255): employee number
          - `firstname` string, string(40), required: first name
          - `fullname` string, string(255): full name
          - `id` integer: Coupa unique identifier
          - `lastname` string, string(40), required: last name
          - `login` string, string(255), required: login
          - `salesforce-id` string, string(255), required: salesforce_id
          - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `id` integer: Coupa unique identifier
        - `kind` string, string(255), required: Kind
        - `name` string, string(255), required: Name
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `updated-by` UserSimple
          - `avatar-thumb-url` string, string: Avatar url
          - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
          - `email` string, string(255), required: email
          - `employee-number` string, string(255): employee number
          - `firstname` string, string(40), required: first name
          - `fullname` string, string(255): full name
          - `id` integer: Coupa unique identifier
          - `lastname` string, string(40), required: last name
          - `login` string, string(255), required: login
          - `salesforce-id` string, string(255), required: salesforce_id
          - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `state` string, string(255): State Name for Address
      - `state-iso-code` string, string(255): ISO Code for the State
      - `street1` string, string(255), required: Address Line 1
      - `street2` string, string(255): Address Line 2
      - `street3` string, string(255): Address Line 3
      - `street4` string, string(255): Address Line 4
      - `tax-registrations` Address[]
      - `type` string, string(255): Address type
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `vat-country` Country
        - `code` string, string(4), required: code
        - `created-at` string: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `id` integer: Coupa unique identifier
        - `name` string, string(100): name
        - `updated-at` string: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `vat-number` string, string(255): VAT identification number used for value added tax purposes
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `created-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `currency` Currency, required
      - `code` string, string(6), required: code
      - `decimals` integer: Decimal precision
      - `enabled` boolean: Enabled
      - `id` integer: Coupa unique identifier
      - `name` string, string(100), required: name
      - `symbol` string, string(10): symbol
    - `description` string, string(255), required: description
    - `id` integer: Coupa unique identifier
    - `name` string, string(255), required: name
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `updated-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `warehouse-locations` WarehouseLocation[]
      - `active` boolean: Active
      - `aisle` string, string(255), required: aisle
      - `bin` string, string(255): bin
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `id` integer: Coupa unique identifier
      - `label` string, string: Display label
      - `level` string, string(255): level
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `warehouse-id` integer: Warehouse Coupa unique identifier
      - `warehouse-name` string, string: Warehouse name
    - `warehouse-type` WarehouseType, required
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `created-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `description` string, string(255), required: description
      - `id` integer: Coupa unique identifier
      - `name` string, string(255), required: name
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `updated-by` UserSimple
        - `avatar-thumb-url` string, string: Avatar url
        - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
        - `email` string, string(255), required: email
        - `employee-number` string, string(255): employee number
        - `firstname` string, string(40), required: first name
        - `fullname` string, string(255): full name
        - `id` integer: Coupa unique identifier
        - `lastname` string, string(40), required: last name
        - `login` string, string(255), required: login
        - `salesforce-id` string, string(255), required: salesforce_id
        - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
  - `warehouse-location` WarehouseLocation, required
    - `active` boolean: Active
    - `aisle` string, string(255), required: aisle
    - `bin` string, string(255): bin
    - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `created-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `id` integer: Coupa unique identifier
    - `label` string, string: Display label
    - `level` string, string(255): level
    - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `updated-by` UserSimple
      - `avatar-thumb-url` string, string: Avatar url
      - `created-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
      - `email` string, string(255), required: email
      - `employee-number` string, string(255): employee number
      - `firstname` string, string(40), required: first name
      - `fullname` string, string(255): full name
      - `id` integer: Coupa unique identifier
      - `lastname` string, string(40), required: last name
      - `login` string, string(255), required: login
      - `salesforce-id` string, string(255), required: salesforce_id
      - `updated-at` string, datetime: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `warehouse-id` integer: Warehouse Coupa unique identifier
    - `warehouse-name` string, string: Warehouse name

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/coupa/apis/coupa-api-4.md) - [All operations](https://skmtc.dev/coupa/apis/coupa-api-4/llms.txt) - [OpenAPI document](https://skmtc.dev/coupa/apis/coupa-api-4/revisions/adc09cabd758?raw)