Skip to main content
GET
/
v1
/
counterparty
Get counterparties
curl --request GET \
  --url http://localhost:3001/v1/counterparty \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "email": "<string>",
      "name": "<string>",
      "markedTrusted": true,
      "markedTrustedDate": "2023-11-07T05:31:56Z",
      "markedTrustedUser": {
        "email": "<string>",
        "name": "<string>",
        "authId": "<string>",
        "role": "<string>",
        "hasPushNotification": true,
        "organization": {
          "name": "<string>",
          "slug": "<string>",
          "logoFileName": "<string>",
          "country": "<string>",
          "vatNumber": "<string>",
          "featureFlags": [
            {
              "featureName": "<string>",
              "isEnabled": true,
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ],
          "baseCurrency": "EUR",
          "paymentRunBatchBooking": true,
          "paymentRunVerificationOfPayee": true,
          "invoiceExportIncludeForeignCurrencies": true,
          "customExportFormats": [
            "custom_experta"
          ],
          "autoPopulateCustomerEmailFromMetadata": true,
          "autoPopulateSupplierEmailFromMetadata": true,
          "excludedEmailDomains": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "description": "<string>",
      "vat": "<string>",
      "accountsPayableNumber": "22 0391919",
      "street": "<string>",
      "city": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "paymentTermsDays": 123,
      "skontoPercentage": 123,
      "skontoDays": 123,
      "organization": {
        "name": "<string>",
        "slug": "<string>",
        "logoFileName": "<string>",
        "country": "<string>",
        "vatNumber": "<string>",
        "featureFlags": [
          {
            "featureName": "<string>",
            "isEnabled": true,
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "baseCurrency": "EUR",
        "paymentRunBatchBooking": true,
        "paymentRunVerificationOfPayee": true,
        "invoiceExportIncludeForeignCurrencies": true,
        "customExportFormats": [
          "custom_experta"
        ],
        "autoPopulateCustomerEmailFromMetadata": true,
        "autoPopulateSupplierEmailFromMetadata": true,
        "excludedEmailDomains": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "bankAccount": {
        "name": "<string>",
        "iban": "<string>",
        "bic": "<string>",
        "countryCode": "<string>",
        "address": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "bankAccountVerification": {
        "bankAccount": {
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "paymentProvider": "<string>",
        "status": "VALID",
        "initializedAt": "2023-11-07T05:31:56Z",
        "mailTrackings": {
          "version": 123,
          "type": "ONBOARDING",
          "status": "ACCEPTED",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "fullName": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "transactions": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "amount": 123,
        "remittanceInformation": "<string>",
        "requestedExecutionDate": "2023-11-07T05:31:56Z",
        "skontoAmount": 123,
        "skontoDate": "2023-11-07T05:31:56Z",
        "ignoreSkontoDeadline": true,
        "express": true,
        "currency": "EUR",
        "creditor": {
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "debitor": {
          "name": "<string>",
          "iban": "<string>",
          "bic": "<string>",
          "countryCode": "<string>",
          "address": "<string>",
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "analysis": {
          "analysisRules": {
            "type": "AMOUNT_DEVIATION",
            "severity": "NORMAL",
            "markedOk": true,
            "markedOkReason": "<string>",
            "markedOkDate": "2023-11-07T05:31:56Z",
            "value": "<string>",
            "markedOkUser": {
              "email": "<string>",
              "name": "<string>",
              "authId": "<string>",
              "role": "<string>",
              "hasPushNotification": true,
              "organization": {
                "name": "<string>",
                "slug": "<string>",
                "logoFileName": "<string>",
                "country": "<string>",
                "vatNumber": "<string>",
                "featureFlags": [
                  {
                    "featureName": "<string>",
                    "isEnabled": true,
                    "id": "<string>",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  }
                ],
                "baseCurrency": "EUR",
                "paymentRunBatchBooking": true,
                "paymentRunVerificationOfPayee": true,
                "invoiceExportIncludeForeignCurrencies": true,
                "customExportFormats": [
                  "custom_experta"
                ],
                "autoPopulateCustomerEmailFromMetadata": true,
                "autoPopulateSupplierEmailFromMetadata": true,
                "excludedEmailDomains": "<string>",
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              },
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "customRules": {
            "name": "<string>",
            "description": "<string>",
            "rule": "<string>",
            "twoFactorCheck": true,
            "accountCheck": true,
            "deleted": true,
            "active": true,
            "organization": {
              "name": "<string>",
              "slug": "<string>",
              "logoFileName": "<string>",
              "country": "<string>",
              "vatNumber": "<string>",
              "featureFlags": [
                {
                  "featureName": "<string>",
                  "isEnabled": true,
                  "id": "<string>",
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              ],
              "baseCurrency": "EUR",
              "paymentRunBatchBooking": true,
              "paymentRunVerificationOfPayee": true,
              "invoiceExportIncludeForeignCurrencies": true,
              "customExportFormats": [
                "custom_experta"
              ],
              "autoPopulateCustomerEmailFromMetadata": true,
              "autoPopulateSupplierEmailFromMetadata": true,
              "excludedEmailDomains": "<string>",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            },
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "archived": true,
        "archivedDate": "2023-11-07T05:31:56Z",
        "archivedByUser": {
          "email": "<string>",
          "name": "<string>",
          "authId": "<string>",
          "role": "<string>",
          "hasPushNotification": true,
          "organization": {
            "name": "<string>",
            "slug": "<string>",
            "logoFileName": "<string>",
            "country": "<string>",
            "vatNumber": "<string>",
            "featureFlags": [
              {
                "featureName": "<string>",
                "isEnabled": true,
                "id": "<string>",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            ],
            "baseCurrency": "EUR",
            "paymentRunBatchBooking": true,
            "paymentRunVerificationOfPayee": true,
            "invoiceExportIncludeForeignCurrencies": true,
            "customExportFormats": [
              "custom_experta"
            ],
            "autoPopulateCustomerEmailFromMetadata": true,
            "autoPopulateSupplierEmailFromMetadata": true,
            "excludedEmailDomains": "<string>",
            "id": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "paymentRun": {
          "id": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "createdById": "<string>",
          "createdByName": "<string>",
          "organizationId": "<string>",
          "sumAmount": 123,
          "sumAmountWithSkonto": 123,
          "sumBookedAmount": 123,
          "transactionCount": 123,
          "batchBooking": true
        },
        "counterparty": "<unknown>",
        "invoice": {
          "id": "<string>",
          "invoiceNumber": "<string>",
          "status": "<string>",
          "totalAmount": 123,
          "dueDate": "2023-11-07T05:31:56Z",
          "invoiceDate": "2023-11-07T05:31:56Z",
          "currency": "<string>"
        }
      },
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "take": 123,
    "itemCount": 123,
    "pageCount": 123,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
order
enum<string>
default:ASC

Choose between ascending and descending order.

Available options:
ASC,
DESC
​
page
number
default:1

Specify the number of the page you want to retrieve.

Required range: x >= 1
​
take
number
default:10

Specify the number of items you want to retrieve per page.

Required range: 1 <= x <= 100
​
searchTerm
string

The search term to look for in the counterparty list.

​
status
string

Filter counterparties by status.

​
counterpartyIds
string

Filter counterparties by id.

​
email
string

Filter counterparties by email.

​
vatValidationStatus
string

Filter counterparties by VAT validation status (comma-separated values: VALID, INVALID, VALIDATION_FAILED, PENDING, or NO_VAT for counterparties without VAT).

​
orderField
string

Specify the field you want to order by.

​
orderDir
string

Choose between ascending and descending order.

Response

200 - application/json
​
data
object[]
required

Paginated items.

​
meta
object
required

Additional information about the page.