v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-211931021.7 MB

Vendors

Retrieve a Vendor

Vendor account information

OAuth Scope

This endpoint requires the following OAuth scope vendor.

get/vendor/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Vendor

Response

Vendor record retrieved successfully

business_numberstring

The company's business identification number as required by the local tax authority. For example, ABN in Australia, EIN in the USA, VAT number in the EU, or business registration number. Format varies by country/region.

emailstring email

Primary email address for the company. Used for system notifications, customer communications, and as the default sender address for emails sent from the system.

email_accountsstring

Accounts/billing email accounts configured for the company.

billing_addressstring

The company's billing address where invoices and financial correspondence should be sent.

{"stackTrail":"components:schemas:Vendor:properties:accepted_payment_methods","oasType":"schema","type":"unknown","description":"DEPRECATED"}

default_regionstring

Default geographic region for the company. Affects currency, tax calculations, date formats, and other region-specific behaviors in the system.

currencystring

Three-letter ISO currency code (e.g., 'USD', 'AUD', 'EUR') representing the company's primary currency. Used for all financial calculations and displays in the system.

opening_time_mondaystring

The minute of the day (from midnight) when the business opens on Monday. For example, 480 represents 8:00 AM (8 hours × 60 minutes). Used for scheduling and availability calculations.

closing_time_mondaystring

The minute of the day (from midnight) when the business closes on Monday. For example, 1020 represents 5:00 PM (17 hours × 60 minutes). Used for scheduling and availability calculations.

opening_time_tuesdaystring

The minute of the day (from midnight) when the business opens on Tuesday. For example, 480 represents 8:00 AM (8 hours × 60 minutes). Used for scheduling and availability calculations.

closing_time_tuesdaystring

The minute of the day (from midnight) when the business closes on Tuesday. For example, 1020 represents 5:00 PM (17 hours × 60 minutes). Used for scheduling and availability calculations.

opening_time_wednesdaystring

The minute of the day (from midnight) when the business opens on Wednesday. For example, 480 represents 8:00 AM (8 hours × 60 minutes). Used for scheduling and availability calculations.

closing_time_wednesdaystring

The minute of the day (from midnight) when the business closes on Wednesday. For example, 1020 represents 5:00 PM (17 hours × 60 minutes). Used for scheduling and availability calculations.

opening_time_thursdaystring

The minute of the day (from midnight) when the business opens on Thursday. For example, 480 represents 8:00 AM (8 hours × 60 minutes). Used for scheduling and availability calculations.

closing_time_thursdaystring

The minute of the day (from midnight) when the business closes on Thursday. For example, 1020 represents 5:00 PM (17 hours × 60 minutes). Used for scheduling and availability calculations.

opening_time_fridaystring

The minute of the day (from midnight) when the business opens on Friday. For example, 480 represents 8:00 AM (8 hours × 60 minutes). Used for scheduling and availability calculations.

closing_time_fridaystring

The minute of the day (from midnight) when the business closes on Friday. For example, 1020 represents 5:00 PM (17 hours × 60 minutes). Used for scheduling and availability calculations.

opening_time_saturdaystring

The minute of the day (from midnight) when the business opens on Saturday. For example, 480 represents 8:00 AM (8 hours × 60 minutes). Used for scheduling and availability calculations.

closing_time_saturdaystring

The minute of the day (from midnight) when the business closes on Saturday. For example, 1020 represents 5:00 PM (17 hours × 60 minutes). Used for scheduling and availability calculations.

opening_time_sundaystring

The minute of the day (from midnight) when the business opens on Sunday. For example, 480 represents 8:00 AM (8 hours × 60 minutes). Used for scheduling and availability calculations.

closing_time_sundaystring

The minute of the day (from midnight) when the business closes on Sunday. For example, 1020 represents 5:00 PM (17 hours × 60 minutes). Used for scheduling and availability calculations.

timezone_namestring

IANA timezone name (e.g., 'America/New_York', 'Australia/Sydney') for the company's primary location. Used for date/time calculations, scheduling, and display of times across the system.

invoice_termsstring

Text describing the payment terms that appear on invoices. For example, '14 days', 'Net 30', etc. Used to communicate payment expectations to customers on invoices and financial documents.

job_default_statusstring

Default status for new jobs created in the system. Valid values are 'Quote' or 'Work Order'. Controls the initial state of newly created jobs.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

namestring required

Company Name

abn_numberstring

Company ABN Number (Australian Accounts Only)

websitestring

Company Website address

Example response

{
  "uuid": "123e4567-3627-468a-b8e0-23f9446e9adb",
  "edit_date": "2026-03-01 12:00:00"
}