External API

Billing

Endpointhttps://api.datavisual.ca

Invoices

List invoices

GET

https://api.datavisual.ca

/v1/invoices

List invoices › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

created_after

string · date-time

modified_after

string · date-time

status

string

expand

string

List invoices › 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 invoices › Responses

Invoices

object[]

next_cursor

string | null

GET/v1/invoices

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

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "invoice_number": "INV-00000",
      "customer_name": "Datavisual",
      "status": "sent",
      "total": 67.79,
      "balance": 67.79,
      "date": "2025-01-16",
      "due_date": "2025-02-15",
      "last_modified": "2025-01-16T14:30:00.000Z"
    }
  ],
  "next_cursor": null
}

json

application/json

Get invoice by ID

GET

https://api.datavisual.ca

/v1/invoices/{id}

Get invoice by ID › path Parameters

id

string · uuid · required

Get invoice by ID › query Parameters

expand

string

Get invoice by ID › 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 invoice by ID › Responses

Invoice

object

GET/v1/invoices/{id}

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

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "invoice_number": "INV-00000",
    "reference_number": null,
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "customer_name": "Datavisual",
    "status": "sent",
    "date": "2025-01-16",
    "due_date": "2025-02-15",
    "currency_code": "CAD",
    "sub_total": 59.99,
    "tax_total": 7.8,
    "shipping_charge": 0,
    "discount_total": 0,
    "total": 67.79,
    "balance": 67.79,
    "credits_applied": 0,
    "payment_terms_label": "Net 30",
    "notes": null,
    "salesorder_id": "00000000-0000-0000-0000-000000000000",
    "billing_address": {
      "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"
    },
    "shipping_address": {
      "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"
    },
    "last_modified": "2025-01-16T14:30:00.000Z",
    "line_items": [
      {
        "line_item_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000",
        "sku": "DV-1000",
        "name": "Datavisual Product",
        "description": null,
        "quantity": 1,
        "rate": 59.99,
        "discount_amount": 0,
        "item_total": 59.99,
        "tax_name": "HST",
        "tax_percentage": 13,
        "warehouse_id": "00000000-0000-0000-0000-000000000000",
        "warehouse_name": "Datavisual Warehouse"
      }
    ]
  }
}

json

application/json

List invoice line items

GET

https://api.datavisual.ca

/v1/invoices/{id}/line-items

List invoice line items › path Parameters

id

string · uuid · required

List invoice line items › 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 invoice line items › Responses

Line items

object[]

GET/v1/invoices/{id}/line-items

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

shell

Example Responses

{
  "data": [
    {
      "line_item_id": "00000000-0000-0000-0000-000000000000",
      "item_id": "00000000-0000-0000-0000-000000000000",
      "sku": "DV-1000",
      "name": "Datavisual Product",
      "description": null,
      "quantity": 1,
      "rate": 59.99,
      "discount_amount": 0,
      "item_total": 59.99,
      "tax_name": "HST",
      "tax_percentage": 13,
      "warehouse_id": "00000000-0000-0000-0000-000000000000",
      "warehouse_name": "Datavisual Warehouse"
    }
  ]
}

json

application/json

Orders Fulfillment

List invoices

GET

https://api.datavisual.ca

/v1/invoices

List invoices › query Parameters

limit

integer · min: 1 · max: 200

Default: 25

cursor

string

created_after

string · date-time

modified_after

string · date-time

status

string

expand

string

List invoices › 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 invoices › Responses

Invoices

object[]

next_cursor

string | null

Get invoice by ID

GET

https://api.datavisual.ca

/v1/invoices/{id}

Get invoice by ID › path Parameters

id

string · uuid · required

Get invoice by ID › query Parameters

expand

string

Get invoice by ID › 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 invoice by ID › Responses

Invoice

object

{ "data": { "id": "00000000-0000-0000-0000-000000000000", "invoice_number": "INV-00000", "reference_number": null, "customer_id": "00000000-0000-0000-0000-000000000000", "customer_name": "Datavisual", "status": "sent", "date": "2025-01-16", "due_date": "2025-02-15", "currency_code": "CAD", "sub_total": 59.99, "tax_total": 7.8, "shipping_charge": 0, "discount_total": 0, "total": 67.79, "balance": 67.79, "credits_applied": 0, "payment_terms_label": "Net 30", "notes": null, "salesorder_id": "00000000-0000-0000-0000-000000000000", "billing_address": { "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" }, "shipping_address": { "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" }, "last_modified": "2025-01-16T14:30:00.000Z", "line_items": [ { "line_item_id": "00000000-0000-0000-0000-000000000000", "item_id": "00000000-0000-0000-0000-000000000000", "sku": "DV-1000", "name": "Datavisual Product", "description": null, "quantity": 1, "rate": 59.99, "discount_amount": 0, "item_total": 59.99, "tax_name": "HST", "tax_percentage": 13, "warehouse_id": "00000000-0000-0000-0000-000000000000", "warehouse_name": "Datavisual Warehouse" } ] } }

List invoice line items

GET

https://api.datavisual.ca

/v1/invoices/{id}/line-items

List invoice line items › path Parameters

id

string · uuid · required

List invoice line items › 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 invoice line items › Responses

Line items

object[]