Get partner details

GET

partners

{partnerId}

Get partner details

curl --request GET \
  --url https://stage-api.findity.com/api/v1/admin/partners/{partnerId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://stage-api.findity.com/api/v1/admin/partners/{partnerId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://stage-api.findity.com/api/v1/admin/partners/{partnerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://stage-api.findity.com/api/v1/admin/partners/{partnerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://stage-api.findity.com/api/v1/admin/partners/{partnerId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://stage-api.findity.com/api/v1/admin/partners/{partnerId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "abc123",
  "name": "Partner Test",
  "partnerCode": "123",
  "vat": "1234-0000",
  "clientApplicationId": "987654321",
  "invoiceEmailAddress": "test@example.com",
  "licenseGroup": 2,
  "licensingEnabled": "INHERITED",
  "inheritedLicenseGroup": 2,
  "inheritedLicensingEnabled": "INACTIVE",
  "partnerType": "DIRECT",
  "settings": {
    "showReportOverview": true,
    "numberOfReportGroups": 1
  },
  "administrators": [
    {
      "id": "1234abcd",
      "firstName": "Partner",
      "lastName": "Admin",
      "email": "admin@example.com",
      "supportRole": false,
      "invite": false
    }
  ]
}

{
  "result": "error",
  "code": "INVALID_PARAMETER",
  "description": "Unknown include value(s): unknownSection"
}

{
  "result": "error",
  "code": "PARTNER_NOT_FOUND",
  "description": "Partner not found"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partnerId

string

required

Partner external ID

Example:

"abc123"

Query Parameters

include

enum<string>[]

Comma-separated list of optional sections to add to the response, e.g. ?include=invoicing,administrators.

Available options:

settings,

invoicing,

identityProvider,

partnerConfig,

content,

administrators,

paymentSettings,

memberOrganizations,

templateOrganizations

Response

Partner details

Partner details response. Only the core fields (id, name, partnerCode, vat, clientApplicationId) are always present. Every other field appears only when its section is requested via the include query parameter.

string

required

Partner external ID

name

string

required

Partner name

partnerCode

string

required

Partner code

vat

string | null

required

VAT number

clientApplicationId

string

required

Client application that owns the partner

invoiceAddress

object | null

Invoice address (include=invoicing). Free-form address object.

invoiceEmailAddress

string | null

Invoice email address (include=invoicing)

invoiceRefOur

string | null

Our invoice reference (include=invoicing)

invoiceRefTheir

string | null

Their invoice reference (include=invoicing)

licenseGroup

integer

License group identifier (include=invoicing)

licensingEnabled

enum<string>

Licensing enabled state (include=invoicing). Accepted values are ACTIVE, INACTIVE, INHERITED.

Available options:

ACTIVE,

INACTIVE,

INHERITED

inheritedLicenseGroup

integer

License group inherited from the client application (include=invoicing)

inheritedLicensingEnabled

enum<string>

Licensing state inherited from the client application (include=invoicing). Accepted values are ACTIVE, INACTIVE, INHERITED.

Available options:

ACTIVE,

INACTIVE,

INHERITED

dateCreated

string<date-time>

Creation date (include=invoicing)

identityProviderId

string | null

Identity provider external ID (include=identityProvider)

identityProviderEnabled

boolean

Whether the identity provider is enabled (include=identityProvider)

partnerType

enum<string>

Partner type (include=partnerConfig). Accepted values are DIRECT, INDIRECT.

Available options:

DIRECT,

INDIRECT

sendEventToExternalSystem

boolean | null

Whether events are sent to an external system (include=partnerConfig)

settings

object

Partner settings map - design, fieldSettings, reports, etc. (include=settings). Free-form settings object.

content

object[]

Partner images - icon, banner, fav icon, menu logo (include=content)

Hide child attributes

content.id

string

Unique identifier of the image resource

content.name

string | null

Display name of the image

content.contentType

string | null

MIME type of the image (e.g. image/png)

content.type

enum<string>

Image role. Accepted values are ICON, BANNER, FAV_ICON, MENU_LOGO.

Available options:

ICON,

BANNER,

FAV_ICON,

MENU_LOGO

content.url

string | null

URL to retrieve the image

administrators

object[]

Partner administrators (include=administrators)

Hide child attributes

administrators.id

string

Unique identifier of the administrator

administrators.externalSourceId

string | null

External source identifier, if provisioned from an external system

administrators.firstName

string | null

First name of the administrator

administrators.lastName

string | null

Last name of the administrator

administrators.email

string

Email address of the administrator

administrators.supportRole

boolean

Whether the administrator has the partner support role

administrators.invite

boolean

Whether the administrator has a pending invitation (not yet activated)

paymentSettings

object | null

Customer payment settings for the partner (include=paymentSettings). Free-form payment settings object.

memberOrganizations

object[]

Member organizations (include=memberOrganizations). Non-paginated - for paginated/searchable listing use GET /v1/admin/partners/{id}/organizations instead.

Hide child attributes

memberOrganizations.id

string

Organization ID

Example:

"memberorg123"

memberOrganizations.name

string

Organization name

Example:

"Member Organization"

memberOrganizations.externalSourceId

string | null

External source identifier

Example:

"EXT002"

memberOrganizations.vat

string | null

VAT number

Example:

"SE123456789001"

memberOrganizations.dateCreated

string<date-time>

Date when organization was created

memberOrganizations.employees

integer | null

Number of employees

Example:

50

memberOrganizations.hasOwnLicensePrice

boolean

Whether organization has its own license price

Example:

true

memberOrganizations.licensePrice

number | null

License price if hasOwnLicensePrice is true

Example:

25.5

memberOrganizations.payedByPartner

boolean | null

Whether organization is paid by partner

Example:

false

memberOrganizations.label

string | null

Organization label

Example:

"label"

memberOrganizations.unverifiedCards

integer | null

Number of unverified cards

Example:

3

memberOrganizations.paymentSettings

object | null

Payment settings for the organization

Hide child attributes

memberOrganizations.paymentSettings.id

string

Example:

"payment"

memberOrganizations.paymentSettings.product

string

Example:

"product"

memberOrganizations.paymentSettings.priceFixed

number

Example:

100

memberOrganizations.accountingConsultants

object[]

List of accounting consultants

Hide child attributes

memberOrganizations.accountingConsultants.id

string

Consultant ID

Example:

"consultant123"

memberOrganizations.accountingConsultants.firstName

string

First name of consultant

Example:

"John"

memberOrganizations.accountingConsultants.lastName

string

Last name of consultant

Example:

"Doe"

memberOrganizations.accountingConsultants.email

string

Email of consultant

Example:

"john.doe@consultant.com"

templateOrganizations

object[]

Template organizations (include=templateOrganizations)

Hide child attributes

templateOrganizations.id

string

Organization ID

Example:

"tempid123"

templateOrganizations.name

string

Organization name

Example:

"Template Organization"

templateOrganizations.externalSourceId

string | null

External source identifier

Example:

"EXT001"

templateOrganizations.dateCreated

string<date-time>

Date when organization was created

templateOrganizations.accountingSettingsCountryCode

string | null

Country code for accounting settings

Example:

"SE"

templateOrganizations.categoryGroups

string[]

List of category groups

Example:

[
  "com.findity.economy.accounting.RepresentationExpenseCategory"
]

templateOrganizations.recipients

object[]

List of recipients for this template organization

Hide child attributes

templateOrganizations.recipients.id

string

Recipient ID

Example:

"recipient123"

templateOrganizations.recipients.integrationPluginName

string

Integration plugin name

Example:

"integration plugin name"

templateOrganizations.recipients.recipientName

string

Display name of recipient

Example:

"Test Integration"

templateOrganizations.recipients.originalRecipientName

string | null

Original recipient name

Example:

"Test"

templateOrganizations.recipients.customRecipientName

string | null

Custom recipient name

Example:

"Custom Test"

templateOrganizations.recipients.email

string | null

Recipient email

Example:

"integration@test.com"

templateOrganizations.recipients.errorEmail

string | null

Error notification email

Example:

"errors@test.com"

templateOrganizations.recipients.sortOrder

integer

Sort order of recipient

Example:

1

templateOrganizations.recipients.status

string

Recipient status

Example:

"NORMAL"

templateOrganizations.recipients.doDebitAccounting

boolean

Whether recipient does debit accounting

Example:

true

templateOrganizations.recipients.doCreditAccounting

boolean

Whether recipient does credit accounting

Example:

true

templateOrganizations.recipients.usesAccountingNumbers

boolean

Whether recipient uses accounting numbers

Example:

true

templateOrganizations.recipients.usesSalaryCodes

boolean

Whether recipient uses salary codes

Example:

false

templateOrganizations.recipients.requiresApiKey

boolean

Whether recipient requires API key

Example:

true

templateOrganizations.recipients.hasApiKey

boolean | null

Whether recipient has API key configured

Example:

true

templateOrganizations.recipients.settings

object

Recipient settings configuration

⌘I

Get partner details

curl --request GET \
  --url https://stage-api.findity.com/api/v1/admin/partners/{partnerId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://stage-api.findity.com/api/v1/admin/partners/{partnerId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://stage-api.findity.com/api/v1/admin/partners/{partnerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://stage-api.findity.com/api/v1/admin/partners/{partnerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://stage-api.findity.com/api/v1/admin/partners/{partnerId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://stage-api.findity.com/api/v1/admin/partners/{partnerId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "abc123",
  "name": "Partner Test",
  "partnerCode": "123",
  "vat": "1234-0000",
  "clientApplicationId": "987654321",
  "invoiceEmailAddress": "test@example.com",
  "licenseGroup": 2,
  "licensingEnabled": "INHERITED",
  "inheritedLicenseGroup": 2,
  "inheritedLicensingEnabled": "INACTIVE",
  "partnerType": "DIRECT",
  "settings": {
    "showReportOverview": true,
    "numberOfReportGroups": 1
  },
  "administrators": [
    {
      "id": "1234abcd",
      "firstName": "Partner",
      "lastName": "Admin",
      "email": "admin@example.com",
      "supportRole": false,
      "invite": false
    }
  ]
}

{
  "result": "error",
  "code": "INVALID_PARAMETER",
  "description": "Unknown include value(s): unknownSection"
}

{
  "result": "error",
  "code": "PARTNER_NOT_FOUND",
  "description": "Partner not found"
}

Authentication

Findity Expense API

Findity Admin API

Findity Admin API V0

Findity Connect API

Authorizations

Path Parameters

Query Parameters

Response