Skip to content
Bottle

Update invoice settings

PATCH
/invoice-settings
curl --request PATCH \
  --url https://example.com/invoice-settings \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "logo": "example", "bankAccountName": "example", "bankSortCode": "example", "bankAccountNumber": "example", "footer": "example", "dueDays": 1, "invoiceCalendar": { "weeklyDay": 1, "monthlyDay": 1, "quarterlyDay": 1, "quarterMonth": 1 }, "defaultTermsCommercial": "prepaid", "defaultTermsDomestic": "prepaid", "depositRefunds": "automatic", "defaultCylinderCharge": "deposit", "remindersOn": true, "reminderAfterDays": 1, "reminderEveryDays": 1, "reminderLimit": 1, "reminderSubject": "example", "reminderMessage": "example", "numberPrefix": "example", "startNumber": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
logo
string | null
<= 1000000 characters /^data:image\/(png|jpeg);base64,[\d+/A-Za-z]+={0,2}$/
bankAccountName
string | null
<= 120 characters
bankSortCode
string | null
/^\d{2}-?\d{2}-?\d{2}$/
bankAccountNumber
string | null
/^\d{8}$/
footer
string | null
<= 500 characters
dueDays
integer
<= 120
invoiceCalendar
object
weeklyDay
required
integer
>= 1 <= 7
monthlyDay
required
integer
<= 31
quarterlyDay
required
integer
<= 31
quarterMonth
required
integer
>= 1 <= 3
defaultTermsCommercial
string
Allowed values: prepaid on_account cash_on_delivery
defaultTermsDomestic
string
Allowed values: prepaid on_account cash_on_delivery
depositRefunds
string
Allowed values: automatic on_request
defaultCylinderCharge
string
Allowed values: deposit rent both
remindersOn
boolean
reminderAfterDays
integer
>= 1 <= 90
reminderEveryDays
integer
>= 1 <= 60
reminderLimit
integer
>= 1 <= 10
reminderSubject
string | null
<= 200 characters
reminderMessage
string | null
<= 4000 characters
numberPrefix
string
>= 1 characters <= 12 characters /^[A-Za-z0-9/-]+$/
startNumber
integer | null
>= 1 <= 9999999

Responses

Section titled “Responses”

200

Section titled “200”

The settings as they now stand

Media typeapplication/json
object
logo
required
string | null
logoImage
object
width
required
integer
height
required
integer
thumb
required
string
card
required
string
large
required
string
bankAccountName
required
string | null
bankSortCode
required
string | null
bankAccountNumber
required
string | null
footer
required
string | null
dueDays
required
integer
<= 120
invoiceCalendar
object
weeklyDay
required
integer
>= 1 <= 7
monthlyDay
required
integer
<= 31
quarterlyDay
required
integer
<= 31
quarterMonth
required
integer
>= 1 <= 3
defaultTermsCommercial
required
string
Allowed values: prepaid on_account cash_on_delivery
defaultTermsDomestic
required
string
Allowed values: prepaid on_account cash_on_delivery
depositRefunds
required
string
Allowed values: automatic on_request
defaultCylinderCharge
required
string
Allowed values: deposit rent both
remindersOn
required
boolean
reminderAfterDays
required
integer
>= 1 <= 90
reminderEveryDays
required
integer
>= 1 <= 60
reminderLimit
required
integer
>= 1 <= 10
reminderSubject
required
string | null
reminderMessage
required
string | null
numberPrefix
required
string
startNumber
required
integer | null
nextNumber
string
updatedAt
required
string format: date-time

Example 

{
  "defaultTermsCommercial": "prepaid",
  "defaultTermsDomestic": "prepaid",
  "depositRefunds": "automatic",
  "defaultCylinderCharge": "deposit",
  "numberPrefix": "INV-BTL",
  "nextNumber": "INV-BTL00042"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}