---
title: "/financial_counterparties"
method: GET
path: "/financial_counterparties"
tags: ["FinancialCounterparty"]
---

# /financial_counterparties

`GET /financial_counterparties`

## Request

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

## Query parameters

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

## Response `200`

FinancialCounterparty objects

- FinancialCounterparty[]
  - `abbreviation` string, string(50), required: Abbreviation
  - `active` boolean: Active
  - `bank-code` string, string(16): Bank Code
  - `branch-code` string, string(10): Branch Code
  - `counterparty-address` CounterpartyAddress
    - `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
  - `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(500): Description
  - `external-identification-lei` string, string(20): Legal Entity Identifier (LEI)
  - `external-identification-name` string, string(100): Deviating Name
  - `id` integer: Coupa Internal ID
  - `name` string, string(255), required: Name
  - `payment-usage` string, string(255): Payment Usage
  - `swift-code` string, string(255): Swift Code
  - `treasury-usage` string, string(255): Treasury Usage
  - `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)