Invoices
Manage your invoices by listing all invoices, filtering them by start_date and invoice_type, each uniquely identified by an ID. Retrieve specific invoices by their IDs, download them for detailed review, and efficiently export all invoices into a comprehensive CSV file, ensuring a streamlined overview of your invoices
Export invoices
Export invoices in a CSV file.
query Parameters
organization_idOrganization ID. If specified, only invoices from this Organization will be returned. (UUID format)
billing_period_start_afterReturn only invoice with start date greater than billing_period_start. (RFC 3339 format)
billing_period_start_beforeReturn only invoice with start date less than billing_period_start. (RFC 3339 format)
invoice_typeInvoice type. It can either be periodic, purchase or credit_note.
pagePage number.
page_sizePositive integer lower or equal to 100 to select the number of items to return.
order_byHow invoices are ordered in the response.
file_typeFile format for exporting the invoice list.
Export invoices › Responses
namecontent_typecontentList invoices
List all your invoices, filtering by start_date and invoice_type. Each invoice has its own ID.
query Parameters
organization_idOrganization ID. If specified, only invoices from this Organization will be returned. (UUID format)
billing_period_start_afterReturn only invoice with start date greater than billing_period_start. (RFC 3339 format)
billing_period_start_beforeReturn only invoice with start date less than billing_period_start. (RFC 3339 format)
invoice_typeInvoice type. It can either be periodic, purchase or credit_note.
pagePage number.
page_sizePositive integer lower or equal to 100 to select the number of items to return.
order_byHow invoices are ordered in the response.
List invoices › Responses
total_countTotal number of invoices.
Paginated returned invoices.
Get an invoice
Get a specific invoice, specified by its ID.
path Parameters
invoice_idInvoice ID. (UUID format)
Get an invoice › Responses
idInvoice ID. (UUID format)
organization_id(UUID format)
organization_namestart_dateStart date of the billing period. (RFC 3339 format)
stop_date(RFC 3339 format)
billing_periodThe billing period of the invoice in the YYYY-MM format. (RFC 3339 format)
issued_dateDate when the invoice was sent to the customer. (RFC 3339 format)
due_datePayment time limit, set according to the Organization's payment conditions. (RFC 3339 format)
Total amount, untaxed.
Total amount, taxed.
The total tax amount of the invoice.
The total discount amount of the invoice.
The total amount of the invoice before applying the discount.
typeType of invoice, either periodic or purchase.
stateThe state of the Invoice.
numberInvoice number.
seller_nameThe name of the seller (Scaleway).