PUT
/
v2
/
invoice-template
curl --request PUT \
  --url https://api.sonderplan.com/v2/invoice-template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Long Form Jobs",
  "type_id": 1,
  "default": false,
  "title": "Invoice",
  "logo": [
    {
      "name": "Avid_Icon",
      "size": 174285,
      "alias": "7e73ab25155974c230d09494548201b9f5056ef",
      "extension": "png",
      "mime_type": "image/png"
    }
  ],
  "top_left_container": "<string>",
  "top_center_container": "<string>",
  "top_right_container": "<string>",
  "middle_left_container": "<string>",
  "middle_center_container": "<string>",
  "middle_right_container": "<string>",
  "bottom_left_container": "<string>",
  "bottom_center_container": "<string>",
  "bottom_right_container": "<string>",
  "email_subject_template": "<string>",
  "email_body_template": "<string>",
  "options": {
    "items_column_visibility": {
      "item": true,
      "description": true,
      "quantity": true,
      "price": true,
      "discount": true,
      "tax": true,
      "total": true
    },
    "totals_visibility": {
      "sub_total": true,
      "discount_total": true,
      "net_total": true,
      "tax_total": true,
      "total": true
    }
  }
}'
{
  "success": {
    "id": 2384
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string
required

The ID of the invoice template you wish to update

Body

application/json
​
name
string

Name of the Invoice Template

Example:

"Long Form Jobs"

​
type_id
integer

1 = Invoice, 2 = Quote

Example:

1

​
default
boolean

Sets the default template used when creating an invoice

Example:

false

​
title
string

Text shown in the top left hand corner of the template

Example:

"Invoice"

Simplified file model containing only a subset of fields

​
top_left_container
string

Top left grid container content

​
top_center_container
string

Top center grid container content

​
top_right_container
string

Top right grid container content

​
middle_left_container
string

Middle left grid container content

​
middle_center_container
string

Middle center grid container content

​
middle_right_container
string

Middle right grid container content

​
bottom_left_container
string

Bottom left grid container content

​
bottom_center_container
string

Bottom center grid container content

​
bottom_right_container
string

Bottom right grid container content

​
email_subject_template
string

Template used to populate the email subject line

​
email_body_template
string

Template used to populate the email body

​
options
object

Additional options and settings that apply to this invoice template

Response

200
application/json
Successful Operation
​
success
object