BokaMera.API.Host

<back to all web services

ExportInvoice

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/billing/company/invoices/{InvoiceId}Get a invoice as a PDF fileGet a PDF invoice

// @ValidateRequest(Validator="IsAuthenticated")
export class ExportInvoice implements ICompany
{
    /** @description Id of the invoice */
    // @ApiMember(Description="Id of the invoice", IsRequired=true, ParameterType="path")
    public InvoiceId: number;

    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    public constructor(init?: Partial<ExportInvoice>) { (Object as any).assign(this, init); }
}

TypeScript ExportInvoice DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /billing/company/invoices/{InvoiceId} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}