Company

• 200 The profile (object)
• Errors 400, 401, 403, 429, 500 (Error: error.type, message)

• legal_name string | null The registered legal name (e.g. Brightline Carpentry LLC)
• dba string | null Doing business as: the trade name customers know; leads on documents when set
• address_line1 string | null Street address
• address_line2 string | null Suite, unit or building
• city string | null City
• region string | null State, province or region (e.g. TN)
• postal_code string | null ZIP or postal code
• country string Two-letter country code (default US; printed only when not US)
• phone string | null Phone for customers (digits, spaces, + - ( ) / x)
• email string | null Email for customers (billing questions)
• website string | null Website (https:// is added when missing)
• ein string | null Employer Identification Number, 9 digits (12-3456789). Shown in full only to people who administer the company; printed on documents only with show_ein
• show_ein boolean Print the EIN on documents (default false)
• sales_tax_id string | null Sales tax permit or registration number, printed on documents when set
• brand_color string | null Brand colour as hex (#1f5f8b): titles, rules and headings on documents, the band and buttons of customer emails. Must be readable on white (contrast at least 3:1)
• payment_instructions string | null How to pay (bank transfer details, who checks are payable to, where to mail them): printed under HOW TO PAY on invoices with a balance due. Up to 12 lines
• footer_text string | null Footer and terms printed at the end of every document (late fees, warranty, thank-you note). Up to 12 lines
• dry_run boolean

• 200 Saved (or, with dry_run, what would be saved) (object)
• Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)

• content_base64 string, required The file, base64-encoded (a PNG is at most 1 MB, an SVG 256 KB; checked after decoding)
• file_name string
• dry_run boolean

• 200 Stored (or checked, with dry_run) (object)
• Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)

• format query, "base64"

• 200 The logo file, or JSON with content_base64 when format=base64
• Errors 400, 401, 403, 429, 500 (Error: error.type, message)

Empty object {}.

• 200 The profile (object)
• Errors 400, 401, 403, 409, 422, 429, 500 (Error: error.type, message)

• kind query, "invoice" | "estimate" | "sales_receipt" | "credit_memo"
• format query, "pdf" | "base64"

• 200 The PDF (or with format=base64, JSON) (PdfFile)
• Errors 400, 401, 403, 429, 500 (Error: error.type, message)