List Clients

curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/billing/clients \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/billing/clients"

headers = {"X-Auth-Token": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};

fetch('https://api.sandbox.flowpayroll.ai/v1/billing/clients', 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://api.sandbox.flowpayroll.ai/v1/billing/clients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Auth-Token: <api-key>"
  ],
]);

$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://api.sandbox.flowpayroll.ai/v1/billing/clients"

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

	req.Header.Add("X-Auth-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/billing/clients")
  .header("X-Auth-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/clients")

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

request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'

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

{
  "content": {
    "data": {
      "clients": [
        {
          "typeDiscriminator": "<string>",
          "name": "<string>",
          "organisationId": "<string>",
          "createdDate": "<string>",
          "createdBy": "<string>",
          "updatedDate": "<string>",
          "updatedBy": "<string>",
          "id": "<string>",
          "invoiceFormatTagGroup": "<string>",
          "invoiceFormatTagName": "<string>",
          "invoiceNumberTagGroup": "<string>",
          "invoiceNumberTagName": "<string>",
          "subtotalTagGroupName": "<string>",
          "rebatePercentage": 123,
          "vatNumber": "<string>",
          "registrationNumber": "<string>",
          "contacts": [
            {
              "firstName": "<string>",
              "lastName": "<string>",
              "email": "<string>",
              "id": "<string>",
              "phone": "<string>",
              "role": "<string>",
              "tags": [
                {
                  "name": "<string>",
                  "group": "<string>",
                  "value": "<string>"
                }
              ],
              "includeInEmails": true
            }
          ],
          "tags": [
            {
              "name": "<string>",
              "group": "<string>",
              "value": "<string>"
            }
          ],
          "defaultRevenueAccountCode": "<string>",
          "defaultTaxType": "<string>",
          "providerId": "<string>",
          "externalProvider": "<string>",
          "lastSyncedAt": "<string>",
          "syncErrorMessage": "<string>",
          "billingAddress": {
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "county": "<string>",
            "postcode": "<string>",
            "countryCode": "<string>"
          },
          "physicalAddress": {
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "county": "<string>",
            "postcode": "<string>",
            "countryCode": "<string>"
          },
          "financeSettings": {
            "defaultRevenueAccount": "<string>",
            "defaultTaxRate": "<string>",
            "payElementMappings": [
              {
                "payElementId": "<string>",
                "accountCode": "<string>",
                "taxType": "<string>"
              }
            ],
            "defaultDueDateDays": 123,
            "defaultCurrencyCode": "<string>",
            "defaultLineAmountTypes": "<string>",
            "invoiceTemplateOverride": {
              "showSubsectionHeader": true,
              "showSubtotalInSubsection": true,
              "showSubtotalVatInSubsection": true,
              "showQuantitySumInSubsection": true,
              "showBottomSubtotals": true,
              "showVatInBottomSubtotals": true,
              "showQuantitySumInBottomSubtotals": true,
              "lineDescriptionFormula": "<string>",
              "lineDescriptionTagGroupId": "<string>",
              "includeAttachmentsWithOnlineInvoice": true
            },
            "creditNoteTemplateOverride": {
              "showSubsectionHeader": true,
              "showSubtotalInSubsection": true,
              "showSubtotalVatInSubsection": true,
              "showQuantitySumInSubsection": true,
              "showBottomSubtotals": true,
              "showVatInBottomSubtotals": true,
              "showQuantitySumInBottomSubtotals": true,
              "lineDescriptionFormula": "<string>",
              "lineDescriptionTagGroupId": "<string>",
              "includeAttachmentsWithOnlineInvoice": true
            },
            "invoiceReferenceFormula": "<string>",
            "invoiceReferenceDateFormat": "<string>"
          }
        }
      ],
      "paginationToken": "<string>",
      "hasMorePages": true,
      "pageSize": 123
    },
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>"
    }
  },
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>"
  },
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "message": {
    "text": "<string>",
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "content": {
    "data": null,
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>"
    }
  },
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>"
  },
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "message": {
    "text": "<string>",
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}