NewInvoice designs and replaceable member grants
BeeL
Get startedMulti-NIFVeriFactuRulesStripeAPI referenceChangelog

Invoice designs and replaceable member grants

Invoice designs per company and series, line nature, replaceable member grants and Northern Ireland VAT numbers.


ChangelogNew

A design holds the template, accent colour, language, font, logo source and QR position of an invoice PDF. Each company has a default design, and a series can use its own with invoice_design_id (null uses the default). A change to a design creates a version: invoices issued from then on use it, issued ones keep theirs. The issued invoice reports the version it was rendered with in rendering.

The fields invoice_template_type, invoice_accent_color and invoice_language of the invoice customization are deprecated: reading returns the values of the default design, and writing changes that design, creating it when there is none. Nothing breaks for existing integrations.

What else changed

  • Invoice designs: create, read, change, delete, preview, list versions and set the default design of a company, with the privileged scopes invoice-designs:read and invoice-designs:write. A company holds at most 50 designs.
  • On the invoice: rendering (design, version and language of the PDF). Series accept invoice_design_id.
  • Nature of a line: the optional nature (GOODS or SERVICES) on invoice lines. It has no default: a line without it states neither.
  • Member grants in one call: PUT /v1/accounts/{account_id}/members/{member_id}/grants replaces the whole set of companies a MEMBER reaches, all or nothing. Granting one company at a time keeps working.
  • Northern Ireland: an EU VAT number (NIF_IVA) is also accepted with country GB and a number that starts with XI, intended for goods (CNT-021). A number that starts with GB is rejected.
  • New error codes starting with INVOICE_DESIGN_, plus GRANT_COMPANY_DUPLICATED.

Endpoints

  • GET/v1/companies/{company_id}/invoice-designsList the invoice designs of a company
  • POST/v1/companies/{company_id}/invoice-designsCreate an invoice design
  • POST/v1/companies/{company_id}/invoice-designs/previewPreview an invoice design
  • GET/v1/companies/{company_id}/invoice-designs/{invoice_design_id}Get an invoice design
  • PATCH/v1/companies/{company_id}/invoice-designs/{invoice_design_id}Update an invoice design
  • DELETE/v1/companies/{company_id}/invoice-designs/{invoice_design_id}Delete an invoice design
  • PUT/v1/companies/{company_id}/invoice-designs/{invoice_design_id}/defaultMake an invoice design the default
  • GET/v1/companies/{company_id}/invoice-designs/{invoice_design_id}/versionsList the versions of an invoice design
  • GET/v1/companies/{company_id}/invoice-designs/{invoice_design_id}/versions/{version}Get a version of an invoice design
  • PUT/v1/accounts/{account_id}/members/{member_id}/grantsReplace a member's company grants

Where to go next