---
title: "Query business entities"
method: GET
path: "/business_entities"
tags: ["BusinessEntity"]
---

# Query business entities

`GET /business_entities`

## Request

- Base URL: `https://r38.coupadev.com/api`
- URL: `https://r38.coupadev.com/api/business_entities`
- 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/business_entities/get.ts> (a function with typed inputs; its response is checked against the schema)

Query business entities

## Query parameters

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

## Response `200`

BusinessEntity objects

- BusinessEntity[]
  - `addresses` Address[]
    - `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
  - `business-entity-account-owners` BusinessEntityAccountOwner[]
    - `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
    - `email` string: Email
    - `fullname` string: Fullname
    - `id` integer: Coupa unique identifier
    - `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
    - `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
    - `user-id` integer, required: User
  - `business-entity-alternate-names` BusinessEntityAlternateName[]
    - `business-entity-id` integer: Business entity
    - `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
  - `business-entity-external-references` BusinessEntityExternalReference[]
    - `business-entity-id` integer: Business entity
    - `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
    - `type` string, string(255): Type
    - `updated-at` string: Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ
    - `value` string, string(100): Value
  - `business-entity-relationships` BusinessEntityRelationship[]
    - `business-entity-id` integer: Business entity
    - `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
    - `related-business-entity-id` integer: Related business entity
    - `relationship-type` 'parent_child', string(255), required: Relationship type
    - `status` string, string(255): 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
  - `country-of-origin` 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
  - `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
  - `display-name` string, string(100): Display Name
  - `formation-type` 'Organization' | 'Person', string(255): Formation Type
  - `id` integer: Coupa Internal ID
  - `name` string, string(100), required: Name
  - `primary-address` BusinessEntityAddress
    - `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[]
      - `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
    - `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
  - `primary-contact` Contact
    - `active` boolean: Active
    - `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
    - `email` string, string(255): email
    - `id` integer: Coupa unique identifier
    - `name-additional` string, string(255): name_additional
    - `name-family` string, string(255): name_family
    - `name-fullname` string, string(255): name_fullname
    - `name-given` string, string(255): name_given
    - `name-prefix` string, string(255): name_prefix
    - `name-suffix` string, string(255): name_suffix
    - `notes` string, text: notes
    - `phone-fax` PhoneNumber
      - `area-code` string, string(255): area_code
      - `country-code` string, string(255): country_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
      - `extension` string, string(255): extension
      - `id` integer: Coupa unique identifier
      - `number` string, string(255): number
      - `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
    - `phone-mobile` PhoneNumber
      - `area-code` string, string(255): area_code
      - `country-code` string, string(255): country_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
      - `extension` string, string(255): extension
      - `id` integer: Coupa unique identifier
      - `number` string, string(255): number
      - `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
    - `phone-work` PhoneNumber
      - `area-code` string, string(255): area_code
      - `country-code` string, string(255): country_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
      - `extension` string, string(255): extension
      - `id` integer: Coupa unique identifier
      - `number` string, string(255): number
      - `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
    - `photo` string, string(255): photo
    - `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
    - `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
  - `status` string, string(255): Status
  - `tax-registrations` TaxRegistration[]
    - `active` boolean: Tax code is enabled or disabled
    - `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
    - `fiscal-representative` unknown
    - `id` integer: Coupa unique identifier
    - `local` boolean: True if tax registration cannot be used for cross-border invoices
    - `number` string, string(47), required: Tax Registration number
    - `owner-id` integer: Coupa unique identifier of the object associated with this tax registration
    - `owner-type` string, string(255): Type of the owning object
    - `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
  - `type` 'LegalBusinessEntity' | 'OrganizationalBusinessEntity', string(255): 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

## 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)