Company Info

Update a company's own settings — name, contact email, default VAT rate, logo, signature, and document defaults. Authenticate with the company's Partner API Key.

Use cases: Configure a newly provisioned company, or keep its details in sync with your own system.
PUT/settings/

Update the authenticated company's settings. All fields are optional; only the fields you send are changed — except logoFileId and signatureFileId (see notes).

logoFileId and signatureFileId use write-null semantics: if you omit them, they are set to null. Always resend their current values unless you intend to clear them. There is no company phone field.

Body Parameters

NameTypeDescription
name
stringCompany display name (min 1 character).
taxAmount
numberDefault VAT rate as a decimal (e.g. 0.18).
email
stringCompany contact email.
addressId
numberID of the address that prints on documents. See the Company Address section.
logoFileId
numberFile ID of the company logo. WRITE-NULL: omitting this field clears the logo. Resend it to keep the current logo.
signatureFileId
numberFile ID of the company signature. WRITE-NULL: omitting this field clears the signature. Resend it to keep the current signature.
type
stringCompany type. One of "MURSHE", "COMPANY", or "PATOOR".
defaultVatMode
stringDefault VAT mode. One of "before" or "include".
defaultCashLedgerId
number | nullDefault ledger for cash payments.
defaultChecksLedgerId
number | nullDefault ledger for check payments.
defaultCreditCardLedgerId
number | nullDefault ledger for credit-card payments.
defaultBankLedgerId
number | nullDefault ledger for bank transfers.
defaultQuotationValidityDays
number | nullDefault validity window for quotations, in days.
defaultOrderDeliveryDays
number | nullDefault delivery window for orders, in days.
documentTotalRounding
string | nullRounding applied to document totals. One of "none", "round", "round_up", "round_down".
prepaidPackagesEnabled
booleanEnable prepaid packages.
hideDeliveryPrices
booleanHide prices on delivery notes.
hideOrderPrices
booleanHide prices on orders.
deriveBookingAvailabilityFromShifts
booleanDerive booking availability from staff shifts.
letterheadMarginTopMm
number | nullTop letterhead margin in millimetres (0–100).
letterheadMarginBottomMm
number | nullBottom letterhead margin in millimetres (0–100).
docTypeMarginOverrides
object | nullPer-document-type letterhead margin overrides: a map of document type to { topMm, bottomMm } (each 0–100).

Request

curl -X PUT "https://api.glance.co.il/settings/" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example_name",
  "taxAmount": 0,
  "email": "example_email",
  "addressId": 0,
  "logoFileId": 0,
  "signatureFileId": 0,
  "type": "example_type",
  "defaultVatMode": "example_defaultVatMode",
  "defaultCashLedgerId": "example_defaultCashLedgerId",
  "defaultChecksLedgerId": "example_defaultChecksLedgerId",
  "defaultCreditCardLedgerId": "example_defaultCreditCardLedgerId",
  "defaultBankLedgerId": "example_defaultBankLedgerId",
  "defaultQuotationValidityDays": "example_defaultQuotationValidityDays",
  "defaultOrderDeliveryDays": "example_defaultOrderDeliveryDays",
  "documentTotalRounding": "example_documentTotalRounding",
  "prepaidPackagesEnabled": true,
  "hideDeliveryPrices": true,
  "hideOrderPrices": true,
  "deriveBookingAvailabilityFromShifts": true,
  "letterheadMarginTopMm": "example_letterheadMarginTopMm",
  "letterheadMarginBottomMm": "example_letterheadMarginBottomMm",
  "docTypeMarginOverrides": "example_docTypeMarginOverrides"
}'

Response

Response
{
  "success": true,
  "company": {
    "id": 123,
    "name": "Acme Ltd",
    "email": "info@acme.com",
    "taxAmount": 0.18,
    "type": "COMPANY",
    "addressId": 456
  }
}