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 bottle.session_token=<bottle.session_token> \
  --data '{ "logo": "example", "bankAccountName": "example", "bankSortCode": "example", "bankAccountNumber": "example", "footer": "example", "dueDays": 1, "defaultTermsCommercial": "prepaid", "defaultTermsDomestic": "prepaid", "depositRefunds": "automatic", "depositRefundPercent": 1, "depositRefundDeductionPence": 1, "remindersOn": true, "reminderAfterDays": 1, "reminderEveryDays": 1, "reminderLimit": 1, "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
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 none
depositRefundPercent
integer
<= 100
depositRefundDeductionPence
integer
<= 1000000
remindersOn
boolean
reminderAfterDays
integer
>= 1 <= 90
reminderEveryDays
integer
>= 1 <= 60
reminderLimit
integer
>= 1 <= 10
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
bankAccountName
required
string | null
bankSortCode
required
string | null
bankAccountNumber
required
string | null
footer
required
string | null
dueDays
required
integer
<= 120
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 none
depositRefundPercent
required
integer
<= 100
depositRefundDeductionPence
required
integer
remindersOn
required
boolean
reminderAfterDays
required
integer
>= 1 <= 90
reminderEveryDays
required
integer
>= 1 <= 60
reminderLimit
required
integer
>= 1 <= 10
numberPrefix
required
string
startNumber
required
integer | null
updatedAt
required
string format: date-time
Example
{
  "defaultTermsCommercial": "prepaid",
  "defaultTermsDomestic": "prepaid",
  "depositRefunds": "automatic",
  "numberPrefix": "INV-BTL"
}

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"
    }
  ]
}