iotoms Docs

Create or update report branding

PUT
/api/v1/reports/branding

Saves the merchant's branding for generated reports (company name, logo, colours, address, tax number, currency and terms). companyName is required; any other field you leave out keeps its saved value. logoBytes is a base64-encoded image.

How to use it

  1. Read the current settings with Get report branding.
  2. Send companyName plus only the fields to change; logoBytes takes a base64-encoded image.
  3. Reports generated from now on use the new branding. Colours default to #008060/#F4F6F9 and currency to USD/$ if never set.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

Request Body

application/json
  1. body
companyName*string

Company name printed on reports. Required on every save.

logoBytes?|

Logo image as base64. Leave out to keep the current logo; it cannot be cleared by sending null.

primaryColor?|

Main accent colour as a hex value, e.g. #008060. Leave out to keep the current one.

secondaryColor?|

Secondary colour as a hex value. Leave out to keep the current one.

footerText?|

Footer text for reports. Leave out to keep the current text.

companyAddressLine1?|

First line of the company address. Leave out to keep it.

companyAddressLine2?|

Second line of the company address. Leave out to keep it.

companyCountry?|

Country in the company address. Leave out to keep it.

companyPhone?|

Company phone number. Leave out to keep it.

companyEmail?|

Company email address. Leave out to keep it.

taxRegLabel?|

Label for the tax number, e.g. GSTIN or VAT No. Leave out to keep it.

taxRegNumber?|

Tax registration number. Leave out to keep it.

currencyCode?|

Currency code, e.g. INR. Leave out to keep it (USD if never set).

currencySymbol?|

Currency symbol, e.g. ₹. Leave out to keep it ($ if never set).

termsAndConditions?|

Terms and conditions text. Leave out to keep it.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?

The report branding settings, or null if none have been saved yet.

Example Request
curl -X PUT 'https://beta.iotoms.com/api/v1/reports/branding' \  -H 'Content-Type: application/json' \  -d '{  "companyName": "string"}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "tenantId": "string",    "companyName": "string",    "hasLogo": true,    "primaryColor": "string",    "secondaryColor": "string",    "footerText": "string",    "companyAddressLine1": "string",    "companyAddressLine2": "string",    "companyCountry": "string",    "companyPhone": "string",    "companyEmail": "string",    "taxRegLabel": "string",    "taxRegNumber": "string",    "currencyCode": "string",    "currencySymbol": "string",    "termsAndConditions": "string",    "updatedAt": "2019-08-24T14:15:22Z"  }}