Get a customer including their outstanding AR balance.

GEThttps://staging.softsolz.uk/api/v1/services/invoicing/customers/{id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

idintegerCustomer id.

display_namestringCustomer display name.

emailstring | nullPrimary AR email.

phonestring | nullContact phone.

billing_address_line1string | nullBilling address line 1.

billing_citystring | nullBilling city.

billing_postal_codestring | nullBilling postal code.

billing_countrystring | nullBilling country (ISO 2-letter).

tax_idstring | nullTax / VAT id.

default_payment_terms_daysintegerDefault payment terms in days.

default_currencystringDefault ISO 4217 currency code.

is_activebooleanFalse once archived.

created_atstringCreation timestamp.

updated_atstringLast update timestamp; round-trip as expected_updated_at.

ar_balancenumberOutstanding receivables balance across this customer's open invoices.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.invoicing.getCustomer('<id>');
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": 0,
    "display_name": "string",
    "email": "string",
    "phone": "string",
    "billing_address_line1": "string",
    "billing_city": "string",
    "billing_postal_code": "string",
    "billing_country": "string",
    "tax_id": "string",
    "default_payment_terms_days": 0,
    "default_currency": "string",
    "is_active": true,
    "created_at": "string",
    "updated_at": "string",
    "ar_balance": 0
  }
}