Schema CreateCustomDocumentRequest

CreateCustomDocumentRequest (object)

Field

Type

Description

account_user_id

integer

—

address_line_1

string

First line of the address (Street and House number)

address_line_2

string

Second line of the address

city

string

City of the address.

contact_id*

integer

—

country_code

string

ISO country code of the address.

date*

string

—

formatted_number

string

—

name_line_1

string

—

name_line_2

string

—

name_line_3

string

—

print_background_id

integer

—

print_layout_id

integer

—

print_options

object

Field	Type	Description
show_contact_number	boolean	Show contact number
show_folding_marks	boolean	Show folding marks
show_footer	boolean	Show footer
show_header	boolean	Show header
show_item_prices	boolean	Show item prices
show_item_quantities	boolean	Show item quantities
show_item_sku	boolean	Show item SKU
show_item_tax_rate	boolean	Show item tax rate
show_item_totals	boolean	Show item totals
show_logo	boolean	Show logo
show_logo_text	boolean	Show logo text
show_page_numbers	boolean	Show page numbers
show_signature_field	boolean	Show signature field
show_terms	boolean	Show terms
show_totals	boolean	Show totals

project_id

integer

—

reference

string

—

service_contract_id

integer

—

service_object_ids

integer[]

array

Elements

integer

service_order_id

integer

—

source_document

object

Polymorphic reference to a business document in the account

Field	Type	Description
id*	integer	—
type*	string	string quote order_confirmation delivery_note invoice credit_note custom_document

state

string

State or region of the address.

subject

string

—

text

string

—

zip

string

ZIP or postal code.

Example (JSON)

{
  "formatted_number": "string",
  "date": "string",
  "contact_id": 0,
  "project_id": 0,
  "service_contract_id": 0,
  "service_order_id": 0
}