Sign in
billing-theme

Partially update a billing theme (except name)

Changed on
patch/v2/billing/theme/{themeId}

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/v2/billing/theme/{themeId}
  • Auth: HTTP bearer

Path parameters

themeIdstring required

ID of the theme to update

Request body

documentTypesBillingType[]

Additive: assigns these document types to this theme (cannot remove)

Example request

{
  "logo": {
    "id": "019c0650-50e6-7aa8-9426-6eb731b6162f",
    "presetId": "logo-preset-1",
    "size": 150
  },
  "colors": {
    "primary": "#4F46E5",
    "background": "#FFFFFF",
    "text": "#1F2937"
  },
  "table": {
    "columns": [
      {
        "active": true
      }
    ],
    "alternateRows": true,
    "coloredHeader": true,
    "borderRadius": 10
  },
  "decoration": {
    "id": "019c0656-595f-783e-84ec-7c3bd0e26d19",
    "presetId": "decoration-preset-1",
    "opacity": 80
  },
  "footer": {
    "logos": [
      {
        "id": "019c0650-50e6-7aa8-9426-6eb731b6162f",
        "presetId": "additional-logo-preset-1"
      }
    ]
  },
  "margins": {
    "top": 40,
    "bottom": 60,
    "left": 40,
    "right": 40
  },
  "links": {
    "items": [
      {
        "icon": "lucide:globe",
        "url": "https://mon-entreprise.fr"
      }
    ],
    "iconSize": 20
  }
}

Response

Theme updated successfully

idstring required
namestring required
documentTypesBillingType[] required
createdAtnumber required
updatedAtnumber required
isDefaultboolean required

True when this theme is assigned to every billing document type for the company (single default theme).

lockedPathsstring[] required

Dot-paths constrained by the current template, e.g. ["margins.top"]. Front uses this to disable matching controls.

Example response

{
  "id": "019c064c-c933-78c1-b748-4ecdf8753521",
  "name": "Mon thème personnalisé",
  "structure": {
    "creatorName": "Abby",
    "creatorImageUrl": "/plans/mini_abby_free.svg",
    "thumbnailUrl": "/billing/templates/template-1.png"
  },
  "createdAt": 1617619200,
  "updatedAt": 1617619200
}

Changes

  • 3251572cc979Revision changes
    • breaking

      removed the enum value 1.00 of the request property /

    • breaking

      removed the enum value 2.00 of the request property /

    • breaking

      removed the enum value 3.00 of the request property /

    • breaking

      removed the enum value 4.00 of the request property /

    • breaking

      removed the enum value 5.00 of the request property /

    • breaking

      the / request property type changed from number to string

    • breaking

      the / response's property type changed from number to string for status

    • warning

      added the new advance enum value to the / response property for the response status

    • warning

      added the new asset enum value to the / response property for the response status

    • warning

      added the new estimate enum value to the / response property for the response status

    • warning

      added the new invoice enum value to the / response property for the response status

    • warning

      added the new purchase_order enum value to the / response property for the response status

    This list may be incomplete.