Settings

GET 
/api/settings

Settings

Request

Header Parameters

X-Company-Slug stringrequired

Responses

200

Successful response

application/json

Schema

Schema

defaults

object

account integer

currency CurrencyEnum (string)

Possible values: [EUR, USD, GBP, TRY]

tax integer

payment_method integer

language string

records_per_page integer

invoicing

object

prefix string

digits integer

next integer

title string

notes string

footer string

template InvoiceTemplateEnum (string)

Possible values: [default, modern, classic]

billing

object

prefix string

digits integer

next integer

title string

notes string

footer string

template InvoiceTemplateEnum (string)

Possible values: [default, modern, classic]

Example (from schema)

{
  "defaults": {
    "account": 12345,
    "currency": "EUR",
    "tax": 0,
    "payment_method": 1,
    "language": "en",
    "records_per_page": 25
  },
  "invoicing": {
    "prefix": "INV",
    "digits": 5,
    "next": 1001,
    "title": "Invoice",
    "notes": "Thank you for your business!",
    "footer": "Company Contact Information",
    "template": "default"
  },
  "billing": {
    "prefix": "BILL",
    "digits": 5,
    "next": 2001,
    "title": "Billing Statement",
    "notes": "Thank you for your payment!",
    "footer": "Company Contact Information",
    "template": "default"
  }
}

Loading...