Reference

BackstageClient.taxSettings

BackstageClient.taxSettings in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / taxSettings

taxSettings: {
  get: (partyId: string, requestOptions?: RequestOptions) => Promise<{
     partyId: string;
     role: "agent" | "principal";
     updatedAt: string | null;
  }>;
  put: (partyId: string, request: {
     role: "agent" | "principal";
   }, requestOptions?: RequestOptions) => Promise<{
     partyId: string;
     role: "agent" | "principal";
     updatedAt: string | null;
  }>;
  ukVatRates: (requestOptions?: RequestOptions) => Promise<{
     categories: {
        category:   | "admission"
           | "admission_exempt"
           | "donation"
           | "non_taxable"
           | "service"
           | "goods"
           | "gift_card"
           | "stored_value"
           | "delivery"
           | "booking_fee";
        treatment: "standard" | "reduced" | "zero" | "exempt" | "outside_scope";
     }[];
     jurisdiction: "GB";
     rates: {
        basisPoints: number;
        from: string;
        treatment: "standard" | "reduced" | "zero";
        until: string | null;
     }[];
  }>;
};

Defined in: client.ts:11735

Tax Settings methods

get()#

get: (partyId: string, requestOptions?: RequestOptions) => Promise<{
  partyId: string;
  role: "agent" | "principal";
  updatedAt: string | null;
}>;

Get a party's tax settings Whether the account sells other accounts' events as their agent (the default) or as principal. Needs accounts.read on the account.

Parameters#

Parameter	Type
`partyId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ partyId: string; role: "agent" | "principal"; updatedAt: string | null; }>

Operation Id#

getPartyTaxSettings

put()#

put: (partyId: string, request: {
  role: "agent" | "principal";
}, requestOptions?: RequestOptions) => Promise<{
  partyId: string;
  role: "agent" | "principal";
  updatedAt: string | null;
}>;

Set a party's tax settings Set whether the account sells other accounts' events as agent or principal. It applies to orders priced from now; an order already paid keeps the tax it was charged. Needs accounts.update on the account.

Parameters#

Parameter	Type	Description
`partyId`	`string`	-
`request`	{ `role`: `"agent"` \| `"principal"`; }	-
`request.role`	`"agent"` \| `"principal"`
`requestOptions?`	`RequestOptions`	-

Returns#

Promise<{ partyId: string; role: "agent" | "principal"; updatedAt: string | null; }>

Operation Id#

putPartyTaxSettings

ukVatRates()#

ukVatRates: (requestOptions?: RequestOptions) => Promise<{
  categories: {
     category:   | "admission"
        | "admission_exempt"
        | "donation"
        | "non_taxable"
        | "service"
        | "goods"
        | "gift_card"
        | "stored_value"
        | "delivery"
        | "booking_fee";
     treatment: "standard" | "reduced" | "zero" | "exempt" | "outside_scope";
  }[];
  jurisdiction: "GB";
  rates: {
     basisPoints: number;
     from: string;
     treatment: "standard" | "reduced" | "zero";
     until: string | null;
  }[];
}>;

The UK VAT rate table The effective-dated UK VAT rates UK VAT is computed by, and the treatment each tax category gets: what Manage shows beside a registration. Guidance kept as data, not tax advice.

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ categories: { category: | "admission" | "admission_exempt" | "donation" | "non_taxable" | "service" | "goods" | "gift_card" | "stored_value" | "delivery" | "booking_fee"; treatment: "standard" | "reduced" | "zero" | "exempt" | "outside_scope"; }[]; jurisdiction: "GB"; rates: { basisPoints: number; from: string; treatment: "standard" | "reduced" | "zero"; until: string | null; }[]; }>

Operation Id#

listUkVatRates