Skip to content

App - Invoice PDF

GET
/selfservice-pdf/v2/{bucket}/{resource_type}/{uid}/invoice/{signature}/pdf

A printable PDF of an invoice. The template parameter is optional and defaults to sheep-invoice-a4. The standard template uses the logo, address and other settings provided for the client. Contact the support team if you would like a custom template.

bucket
required

The bucket (client) name

string
Example
example
resource_type
required

The type of resource, usually the second element in the URI e.g person, organisation, member, payment

string
Example
person
uid
required

Usually the final element in the URI, an alphanumeric unique identifier

string
Example
6305f074683e800f3abe809e
signature
required

An alphanumeric string that is used to verify the request

string
Example
6305f
template
string
default: sheep-invoice-a4

Binary PDF file

string format: binary

A standard error message

object
description

A human readable description of the error

string
error

A concise error message

string
type

A machine readable error type

string

Unauthorized is the status code to return when the client provides no credentials or invalid credentials.

Forbidden is the status code to return when a client has valid credentials but not enough privileges to perform an action on a resource.

Not found