Complyt Docs
  1. Authentication
Complyt Docs
  • Getting Started
    • Introduction to Sales Tax Calculation
    • Step By Step - Creating your first transaction
    • Step By Step - Creating VAT / Global Tax Transaction
  • Endpoints
    • Authentication
      • Authentication - Getting Started
      • Create JWT
        POST
      • Create JWT - Partnerships
        GET
      • Get Partnerships
        GET
      • Upsert Client- Partnerships
        POST
      • Delete Client- Partnerships
        DELETE
    • Customers
      • Get to Know
      • Get Customer
      • Get All Customers
      • Upsert Customer
      • Update Customer
    • Exemptions
      • Get to Know
      • Get All Exemptions
      • Post Exemption
      • Update Exemption
      • Patch Exemption
    • Transactions
      • Get to Know
      • The Importance of Shipping Address
      • How to Use Credit Memos
      • Get Transaction (thin)
      • Get Transaction
      • Upsert Transaction
      • Delete Transaction
      • Get All Transactions (thin)
      • Get All Transactions
      • Upsert VAT / GT Transactio
    • Files
      • Get All Files
      • Get One file - With signed link
      • Save file
      • Delete one file
    • Address Validation
      • Address Validation Intro
      • Validate Address
    • Sales Tax Rates
      • Get Sales Tax Rates
    • Vat Validation
      • Validate Vat
  • Special Features
    • Global Tax Rate
    • Partial Address
    • Discounts
    • Inclusive Tax
    • Vat Validation
    • Post exemptions from CSV
      POST
  • Applications
    • Xero - Integration & User Manual
  1. Authentication

Get Partnerships

GET
/v1/partnership
Getting all the supported partnership clients
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/partnership' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
{
    "tenantId": "string",
    "partnerName": "string",
    "supportedReferrals": [
        {
            "tenantId": "string",
            "name": "string",
            "partnershipStatus": "string",
            "timestamps": {
                "createdDate": "string",
                "updatedDate": "string"
            }
        }
    ]
}

Request

Header Params
Content-Type
string 
optional
Example:
application/json
Accept
string 
optional
Example:
application/json

Responses

🟢200Success
application/json
Body
tenantId
string 
required
The tenantId of the partner
partnerName
string 
required
The name of the partner
supportedReferrals
array[object (Referral) {4}] 
required
List of the supported partnership clients
tenantId
string 
required
The tenantId of the client
name
string 
required
The name of the client
partnershipStatus
string 
required
Indicates whether the partnership is active or cancelled
timestamps
object (TimestampsDto) 
required
Modified at 2025-03-31 13:24:00
Previous
Create JWT - Partnerships
Next
Upsert Client- Partnerships
Built with