External API

Account

Endpointhttps://api.datavisual.ca

Account profile and addresses

Get account profile

GET

https://api.datavisual.ca

/v1/account

Returns the authenticated customer's account summary, including primary billing and primary shipping address snapshots.

Get account profile › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get account profile › Responses

Account profile

object

GET/v1/account

curl --request GET \
  --url https://api.datavisual.ca/v1/account \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "contact_name": "John Smith",
    "company_name": "Datavisual",
    "account_name": "Datavisual",
    "status": "active",
    "phone": "6135550100",
    "website": "https://datavisual.ca",
    "payment_terms": 30,
    "payment_terms_label": "Net 30",
    "credit_limit": 50000,
    "outstanding_receivable_amount": 1250.5,
    "unused_credits_receivable_amount": 0,
    "unused_credits_payable_amount": 0,
    "primary_billing_address": {
      "id": "00000000-0000-0000-0000-000000000000",
      "attention": "John Smith",
      "address_line1": "2210 Thurston Drive",
      "address_line_2": null,
      "city": "Ottawa",
      "province_state": "Ontario",
      "province_state_code": "ON",
      "zip": "K1G 6C9",
      "country": "Canada",
      "country_code": "CA",
      "county": null,
      "phone": "6135550100",
      "fax": null
    },
    "primary_shipping_address": {
      "id": "00000000-0000-0000-0000-000000000000",
      "attention": "John Smith",
      "address_line1": "2210 Thurston Drive",
      "address_line_2": null,
      "city": "Ottawa",
      "province_state": "Ontario",
      "province_state_code": "ON",
      "zip": "K1G 6C9",
      "country": "Canada",
      "country_code": "CA",
      "county": null,
      "phone": null,
      "fax": null
    },
    "last_modified": "2025-01-15T14:30:00.000Z"
  }
}

json

application/json

List account addresses

GET

https://api.datavisual.ca

/v1/account/addresses

Returns the authenticated customer's active address book, including billing, primary shipping, and any additional addresses.

List account addresses › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List account addresses › Responses

Address list

object[]

GET/v1/account/addresses

curl --request GET \
  --url https://api.datavisual.ca/v1/account/addresses \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "source_address_type": "shipping",
      "is_billing": false,
      "is_shipping": true,
      "is_primary_shipping": true,
      "attention": "John Smith",
      "address_line1": "2210 Thurston Drive",
      "address_line_2": null,
      "city": "Ottawa",
      "province_state": "Ontario",
      "province_state_code": "ON",
      "zip": "K1G 6C9",
      "country": "Canada",
      "country_code": "CA",
      "county": null,
      "phone": null,
      "fax": null
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "source_address_type": "billing",
      "is_billing": true,
      "is_shipping": false,
      "is_primary_shipping": false,
      "attention": "Accounting",
      "address_line1": "2210 Thurston Drive",
      "address_line_2": null,
      "city": "Ottawa",
      "province_state": "Ontario",
      "province_state_code": "ON",
      "zip": "K1G 6C9",
      "country": "Canada",
      "country_code": "CA",
      "county": null,
      "phone": "6135550100",
      "fax": null
    }
  ]
}

json

application/json

Health Customer Contacts

Get account profile

GET

https://api.datavisual.ca

/v1/account

Returns the authenticated customer's account summary, including primary billing and primary shipping address snapshots.

Get account profile › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get account profile › Responses

Account profile

object

{ "data": { "id": "00000000-0000-0000-0000-000000000000", "contact_name": "John Smith", "company_name": "Datavisual", "account_name": "Datavisual", "status": "active", "phone": "6135550100", "website": "https://datavisual.ca", "payment_terms": 30, "payment_terms_label": "Net 30", "credit_limit": 50000, "outstanding_receivable_amount": 1250.5, "unused_credits_receivable_amount": 0, "unused_credits_payable_amount": 0, "primary_billing_address": { "id": "00000000-0000-0000-0000-000000000000", "attention": "John Smith", "address_line1": "2210 Thurston Drive", "address_line_2": null, "city": "Ottawa", "province_state": "Ontario", "province_state_code": "ON", "zip": "K1G 6C9", "country": "Canada", "country_code": "CA", "county": null, "phone": "6135550100", "fax": null }, "primary_shipping_address": { "id": "00000000-0000-0000-0000-000000000000", "attention": "John Smith", "address_line1": "2210 Thurston Drive", "address_line_2": null, "city": "Ottawa", "province_state": "Ontario", "province_state_code": "ON", "zip": "K1G 6C9", "country": "Canada", "country_code": "CA", "county": null, "phone": null, "fax": null }, "last_modified": "2025-01-15T14:30:00.000Z" } }

List account addresses

GET

https://api.datavisual.ca

/v1/account/addresses

Returns the authenticated customer's active address book, including billing, primary shipping, and any additional addresses.

List account addresses › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List account addresses › Responses

Address list

object[]

{ "data": [ { "id": "00000000-0000-0000-0000-000000000000", "source_address_type": "shipping", "is_billing": false, "is_shipping": true, "is_primary_shipping": true, "attention": "John Smith", "address_line1": "2210 Thurston Drive", "address_line_2": null, "city": "Ottawa", "province_state": "Ontario", "province_state_code": "ON", "zip": "K1G 6C9", "country": "Canada", "country_code": "CA", "county": null, "phone": null, "fax": null }, { "id": "00000000-0000-0000-0000-000000000000", "source_address_type": "billing", "is_billing": true, "is_shipping": false, "is_primary_shipping": false, "attention": "Accounting", "address_line1": "2210 Thurston Drive", "address_line_2": null, "city": "Ottawa", "province_state": "Ontario", "province_state_code": "ON", "zip": "K1G 6C9", "country": "Canada", "country_code": "CA", "county": null, "phone": "6135550100", "fax": null } ] }