API v1 reference

The Sliptree API gives other software read-only access to one business's invoices, credit notes, estimates, the payments recorded on invoices, its products, and its customers. It returns JSON over HTTPS, in the JSON:API format.

Version 1 cannot change anything. It has no write endpoints and no webhooks.

The API is part of the paid plans, and it also works during the free trial. On the Free plan keys can still be created, but every request with them returns 403 until the business chooses a paid plan.

API keys

An Owner or Admin creates a key under Business settings → API keys, with the Create API key button. Sliptree can ask for confirmation that it is the same person first. The key gets a name, which should say where it is used.

The full key is shown once, in the Your new API key window. Sliptree stores only a hash of it, so a lost key cannot be shown again. A new key has to be created instead.

A key belongs to one business and reads only that business. A business can have up to 10 keys. To create an 11th, revoke one first.

A key works only while the person who created it is an Owner or Admin of that business. If that person is demoted or removed, every request with their key returns 403. Keys are best created with the account of someone who will stay.

If a key leaks, revoke it under Business settings → API keys with Revoke. Software that uses the key stops working at once, and this cannot be undone. The list shows who created each key and when it was last used.

Authentication

Send the key in the Authorization header of every request. The base URL is https://sliptree.com/api/v1.

curl https://sliptree.com/api/v1/company \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

GET /company is the quickest way to test a key. It returns the business the key belongs to.

{
  "data": {
    "id": "01m78xkp0eb7ej9x97szhdzac3",
    "type": "companies",
    "attributes": {
      "name": "Kestrel OÜ",
      "country": "EE"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

A key works only on /api/v1. It is refused everywhere else in Sliptree.

Response format

Every successful response has the content type application/vnd.api+json. A paged list adds the profile parameter, see Paging. A successful request returns 200. A request can send Accept: application/json or Accept: application/vnd.api+json. Both work. Invoices and estimates can also be fetched as a PDF or an e-invoice file instead, see File formats.

A record is a resource object with these members:

Member Description
id The id of the record. It is a member of the resource object, not one of the attributes.
type invoices, estimates, products, customers or companies. Credit notes are in invoices.
attributes The fields of the record, described in Fields. Their names are in snake_case, such as issue_date.
relationships Only on an invoice or an estimate: the customer and the source of the document. See Customer and Source.
links Only on an invoice or an estimate: the address of the document itself in self, and its address in each file format. See Links to the files.

A single record is in data as one resource object. A list is in data as an array of them, with links beside it. The jsonapi member names the version of the format, 1.1.

An invoice has no attribute called type, because JSON:API reserves that name. The kind of invoice is in invoice_type, with the value invoice or credit_note.

The API does not take part of the format that it has no use for. A request with include or fields[...] returns 400, because the API does not include related records and has no sparse fieldsets. An Accept header that allows the JSON:API media type only with a parameter such as ext returns 406. A Content-Type of application/vnd.api+json with a parameter such as charset returns 415. The only parameter that is allowed is profile.

Errors

Every error has the content type application/vnd.api+json and a body with an errors list. The API never redirects, also when the request asks for text/html.

This response is for a request with two bad filters:

{
  "errors": [
    {
      "status": "422",
      "code": "invalid_filter_value",
      "title": "Invalid filter value",
      "detail": "The selected filter[status] is invalid.",
      "source": {
        "parameter": "filter[status]"
      },
      "meta": {
        "request_id": "01M78XKPG9EJQ8B2A64NFYEFSQ"
      }
    },
    {
      "status": "422",
      "code": "invalid_filter_value",
      "title": "Invalid filter value",
      "detail": "The filter[issue_date_min] field must match the format Y-m-d.",
      "source": {
        "parameter": "filter[issue_date_min]"
      },
      "meta": {
        "request_id": "01M78XKPG9EJQ8B2A64NFYEFSQ"
      }
    }
  ]
}

Each error object has these members:

Member Description
status The HTTP status as a string.
code A short name for the kind of error. It does not change, so software can branch on it. The list of codes is below.
title The same text for every error with this code.
detail A sentence about this case. Its wording can change, so do not parse it. It never holds internal names.
source.parameter The query parameter at fault, as written in the request, such as filter[status].
links.type On the paging errors, the address of the error type that the cursor pagination profile defines.
meta.request_id The id of the request, the same as in the X-Request-Id header.

An error response lists every error that one check found. A request with two bad filters returns two error objects. The API runs its checks in order: the media type, include and fields first, then output_format and attach_pdf, then the other query parameters of a list. When an earlier check finds an error, the response holds only the errors of that check. A request with a bad Accept header and an unknown parameter gets only the Accept error back. Once that is fixed, the next response shows the other.

When the errors of one response have different statuses, the response uses the lowest of them, and each error object keeps its own status. The next response has a 400 status because of the page size, even though the bad filter alone would give a 422:

{
  "errors": [
    {
      "status": "422",
      "code": "invalid_filter_value",
      "title": "Invalid filter value",
      "detail": "The selected filter[status] is invalid.",
      "source": {
        "parameter": "filter[status]"
      },
      "meta": {
        "request_id": "01M78XKPJWM9DFTBH6749TK5PV"
      }
    },
    {
      "status": "400",
      "code": "max_page_size_exceeded",
      "title": "Max page size exceeded",
      "detail": "The page[size] can be at most 100.",
      "source": {
        "parameter": "page[size]"
      },
      "links": {
        "type": "https://jsonapi.org/profiles/ethanresnick/cursor-pagination/max-size-exceeded"
      },
      "meta": {
        "page": {
          "maxSize": 100
        },
        "request_id": "01M78XKPJWM9DFTBH6749TK5PV"
      }
    }
  ]
}

New codes can be added. A client treats a code that it does not know as a failure with the HTTP status of the response. A 429 response also has a Retry-After header, see Rate limit.

Request id

Every response from /api/v1 has an X-Request-Id header, also an error response and a 404 for an unknown path. The value is made by Sliptree and is different for each request. A value that a client sends in this header is ignored. Give the id to support when you report a problem, and the request can be found.

Error codes

Code Status When
unauthenticated 401 The key is missing, wrong or revoked.
forbidden 403 The key is valid, but its creator is no longer an Owner or Admin of the business. The same code is returned when the user or the business is suspended.
plan_upgrade_required 403 The business is on the Free plan.
not_found 404 No such document, product or customer in this business, or the document is a draft. An estimate id on an invoice endpoint also returns 404, and the other way round. A path that is not one of the endpoints below, such as /api/v1/taxes, also returns 404.
method_not_allowed 405 A method other than GET. Version 1 only reads.
bad_request 4xx Any other error in the request.
invalid_filter_value 422 The value of a filter is not valid.
invalid_parameter_value 400 page[size] is not a positive whole number, or page[after] or page[before] is not a cursor that this list gave for this sort.
unsupported_parameter 400 The list does not have this query parameter or filter. This includes page, page[number] and per_page.
unsupported_sort 400 The sort value is not one of the values this list offers.
unsupported_include 400 The request has include.
unsupported_fields 400 The request has fields[...]. One error for each record type named.
max_page_size_exceeded 400 page[size] is above 100. The error has meta.page.maxSize, set to 100.
range_pagination_not_supported 400 page[after] and page[before] are in the same request.
unsupported_output_format 422 output_format is empty or is not one of the values this endpoint offers. See File formats.
unsupported_attach_pdf 422 attach_pdf is not true or false, or it is true anywhere but on one invoice in an e-invoice format. See The PDF inside an e-invoice.
not_acceptable 406 Accept allows the JSON:API media type only with a parameter other than profile.
unsupported_media_type 415 Content-Type is the JSON:API media type with a parameter other than profile.
rate_limited 429 The business used up its requests for this minute. See Rate limit.
server_error 5xx Something failed at Sliptree. The detail is generic.

This response is for an id that does not exist:

{
  "errors": [
    {
      "status": "404",
      "code": "not_found",
      "title": "Not found",
      "detail": "The requested resource was not found.",
      "meta": {
        "request_id": "01M78XKPK9BFQWB66FND4069TJ"
      }
    }
  ]
}

Endpoints

Endpoint Returns
GET /company The business of the key.
GET /invoices A page of invoices and credit notes.
GET /invoices/{id} One invoice or credit note, with its payments.
GET /estimates A page of estimates.
GET /estimates/{id} One estimate.
GET /products A page of products. See Products.
GET /products/{id} One product.
GET /customers A page of customers. See Customers.
GET /customers/{id} One customer.
GET /deleted A page of deleted invoices, credit notes, estimates, products and customers. See Deleted records.

{id} is the id of the document, product or customer. Drafts are never returned. A draft has no number yet and is not an issued document, so it is left out of lists and answers 404 when requested by id.

Deleted records

GET /deleted lists the invoices, credit notes, estimates, products and customers deleted in the business, oldest deletion first. A deleted draft is not listed, because the API never returned it. Each deletion stays in the list for 365 days.

Parameter Valid values
filter[deleted_since] A date and time in ISO 8601 with an offset, in the same format as filter[updated_since]. Returns records deleted at that moment or later.
page[size], page[after], page[before] Paging, as on the other lists. See Paging.

The order is always the time of deletion, then the id, so the list takes no sort. A request with one returns 400, and so does a request with any other filter.

Each deleted record is a resource object of the type it had in its own list. It has no attributes.

Member Description
id The id the record had.
type invoices, estimates, products or customers. A deleted credit note is invoices, because credit notes are in the invoice list.
meta.deleted_at When the record was deleted.
curl -g "https://sliptree.com/api/v1/deleted?filter[deleted_since]=2026-10-05T12:00:00Z" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

The -g option stops curl from reading the square brackets as a pattern.

{
  "data": [
    {
      "id": "01m78xkp7zdhhp6m1nryq17jj3",
      "type": "invoices",
      "meta": {
        "deleted_at": "2026-10-05T12:40:00Z"
      }
    },
    {
      "id": "01m78xkp7sc0twxc090wc0n70c",
      "type": "customers",
      "meta": {
        "deleted_at": "2026-10-05T13:05:00Z"
      }
    }
  ],
  "links": {
    "prev": null,
    "next": null
  },
  "jsonapi": {
    "version": "1.1",
    "profile": [
      "https://jsonapi.org/profiles/ethanresnick/cursor-pagination/"
    ]
  }
}

Filters, sorting and paging

The invoice and estimate lists take the same query parameters. Filters combine with AND. The product list takes fewer, see Products.

Parameter Valid values
filter[status] One status. For invoices: completed, sent, viewed, partially_paid, paid or overdue. For estimates: completed, sent, viewed, accepted or rejected. Several values at once return 422.
filter[number] The document number, matched exactly as sent, commas included.
filter[type] Invoices only: invoice or credit_note.
filter[issue_date_min] A date as YYYY-MM-DD. Returns documents issued on that day or later.
filter[issue_date_max] A date as YYYY-MM-DD. Returns documents issued on that day or earlier.
filter[updated_since] A date and time in ISO 8601 with an offset, such as 2026-10-05T12:00:00Z or 2026-10-05T14:00:00+02:00. Returns documents changed at that moment or later. Write a + as %2B in a URL.
sort issue_date, -issue_date, updated_at or -updated_at. A leading - sorts newest first. The default is -issue_date: newest issue date first.
page[size] A whole number from 1 to 100. The default is 25.
page[after], page[before] A cursor from links.next or links.prev. See Paging.
output_format The format of the answer, json by default. The invoice list can also answer with an e-invoice file of each page. See File formats.

The API never ignores a parameter it does not understand. An unknown parameter or filter name returns 400 and a bad filter value returns 422, so a typo cannot return an unfiltered list by accident.

overdue is a filter value only. It returns invoices that are past their due date and not yet paid. The status field never reads overdue; use the overdue field instead.

Rows with the same sort value are ordered by id, so the order is the same on every request.

Paging

Lists page with cursors, as the cursor pagination profile of JSON:API describes. A page holds page[size] records, and links has the address of the page before and the page after. This is the first page of a list of deleted records, with one record on a page:

{
  "data": [
    {
      "id": "01m78xkp7zdhhp6m1nryq17jj3",
      "type": "invoices",
      "meta": {
        "deleted_at": "2026-10-05T12:40:00Z"
      }
    }
  ],
  "links": {
    "prev": null,
    "next": "https://sliptree.com/api/v1/deleted?filter%5Bdeleted_since%5D=2026-10-05T12%3A00%3A00Z&page%5Bsize%5D=1&page%5Bafter%5D=eyJpdiI6IkdS…"
  },
  "jsonapi": {
    "version": "1.1",
    "profile": [
      "https://jsonapi.org/profiles/ethanresnick/cursor-pagination/"
    ]
  }
}

The cursors in this example are shortened. A real one is a longer string.

  • links.prev and links.next are always in a list response. A link is null when there is no such page, so links.next is null on the last page.
  • A link keeps the filters, sort and page[size] of the request. Follow it as it is.
  • A cursor is opaque. Do not read it, build one, or use it with another list or another sort. Such a cursor returns 400 with invalid_parameter_value. A cursor can also stop working when Sliptree changes the key that protects it. Keep a cursor only for the walk in progress, and start a new walk when a stored one returns 400.
  • page[after] and page[before] cannot be used together.
  • A paged response has the profile in its content type, as application/vnd.api+json; profile="https://jsonapi.org/profiles/ethanresnick/cursor-pagination/", and in jsonapi.profile.
  • A list has no total. The API does not count the records.
  • The page and per_page parameters of offset paging do not exist. They return 400 with unsupported_parameter.

A walk with sort=updated_at never skips a record. A record that is edited during the walk moves to the end, so it can appear again later in the same walk. Match records by id, as the sync steps say.

File formats

The invoice and estimate endpoints can answer with a file instead of JSON. The output_format query parameter chooses the format, and without it the answer is JSON.

Value GET /invoices/{id} GET /invoices GET /estimates/{id} GET /estimates
json (the default) JSON JSON JSON JSON
pdf The PDF 422 The PDF 422
peppol_bis_3 A UBL 2.1 Invoice or CreditNote in Peppol BIS Billing 3.0 A zip with one XML file for each invoice on the page 422 422
en16931_ubl A UBL 2.1 Invoice or CreditNote in the EN 16931-1:2017 core format A zip with one XML file for each invoice on the page 422 422
estonian_e_invoice_1_2 An E_Invoice with one invoice, in the Estonian e-invoice standard 1.2 One E_Invoice with every invoice on the page 422 422

Each value names one standard and one version, and its meaning does not change. A new standard or a new version of one will get a new value. Estimates have no e-invoice format, because neither standard covers them.

curl -OJ "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=peppol_bis_3" \
  -H "Authorization: Bearer YOUR_API_KEY"

The -OJ options make curl save the file under the name that the response gives. A file response has these headers:

Content-Type: application/xml
Content-Disposition: attachment; filename=invoice-no-1042.xml

The content type is application/pdf for a PDF, application/xml for an XML file, and application/zip for a zip. A file is always sent as an attachment, and its name ends in .pdf, .xml or .zip.

Only output_format chooses the format. The Accept header does not, so a request with Accept: application/json and output_format=pdf gets the PDF. An error is always a JSON error, as described in Errors, whatever format the request asked for. A draft returns 404 in every format and is left out of every list file.

An output_format that the endpoint does not offer returns 422 with unsupported_output_format. This response is for GET /invoices?output_format=pdf:

{
  "errors": [
    {
      "status": "422",
      "code": "unsupported_output_format",
      "title": "Unsupported output format",
      "detail": "The output_format here must be one of: json, peppol_bis_3, en16931_ubl, estonian_e_invoice_1_2. A list has no PDF. Fetch each PDF from the pdf link of its document.",
      "source": {
        "parameter": "output_format"
      },
      "meta": {
        "request_id": "01M7909JQ5A7GSHDMKCGV7KH07"
      }
    }
  ]
}

A list has no PDF format, because one PDF can take several seconds to make. Fetch PDFs one document at a time.

Every invoice and estimate in a JSON response has links. self is the address of the document, and each other link is its address in one file format. A link needs the API key, like any other request.

"links": {
  "self": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137",
  "pdf": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=pdf",
  "peppol_bis_3": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=peppol_bis_3",
  "en16931_ubl": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=en16931_ubl",
  "estonian_e_invoice_1_2": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=estonian_e_invoice_1_2"
}

An estimate has only self and pdf.

Peppol BIS 3 and the buyer's e-invoice address

A peppol_bis_3 file must contain the buyer's e-invoice address (EndpointID). Sliptree builds that address from the registration code or the VAT number of the customer.

For a Finnish buyer, the address built this way is right for about 70% of receivers. The others use an OVT address with a suffix, or an IBAN. For buyers in other countries, how often the address is right has not been measured.

If you do not send the file on over Peppol yourself, use en16931_ubl. It has the same content, without the Peppol profile and without the buyer's e-invoice address.

The PDF inside an e-invoice

With attach_pdf=true, the e-invoice file also contains the PDF of the invoice. The default is false.

  • In peppol_bis_3 and en16931_ubl, the PDF is in an AdditionalDocumentReference, as an EmbeddedDocumentBinaryObject with mimeCode="application/pdf".
  • In estonian_e_invoice_1_2, the PDF is in the AttachmentFile of the invoice.

attach_pdf=true works only on GET /invoices/{id} with peppol_bis_3, en16931_ubl or estonian_e_invoice_1_2. Anywhere else it returns 422 with unsupported_attach_pdf, and so does any value other than true or false.

Lists in a file format

A list in a file format is paged in the same way as the JSON list. The same filters, sort, page[size] and cursors apply, and each page is one file. Each file is complete and valid on its own, so save or import one file per page, and do not join pages into one file.

  • In peppol_bis_3 and en16931_ubl, a page is a zip with one XML file for each invoice.
  • In estonian_e_invoice_1_2, a page is one E_Invoice with every invoice of the page. Each file has its own FileId. The invoice count and the TotalAmount in its footer describe that page, and TotalAmount adds up the invoice totals whatever their currency.

A file has no room for links, so the addresses of the pages before and after are in the Link header. This is the header of the first page of GET /invoices?output_format=en16931_ubl&sort=issue_date&page[size]=1:

Link: <https://sliptree.com/api/v1/invoices?output_format=en16931_ubl&sort=issue_date&page%5Bsize%5D=1&page%5Bafter%5D=eyJpdiI6Im16…>; rel="next"

The cursor in this example is shortened. Follow the next link until a response has none. Every page after the first one also has a prev link.

A page without invoices, such as a list whose filter matches nothing, returns 204 with no body and no Link header, because an e-invoice file must contain at least one invoice.

Fields

The tables in this section describe attributes, except where they say otherwise.

A business (GET /company) has two attributes: name, the name of the business, and country, its two-letter country code such as EE, or null.

Formats

  • Money is a decimal string with 2 places, such as "124.00". It is never a number, so a client does not parse a float. Amounts on a credit note are negative.
  • Exact decimals (quantity, net_price, gross_price, discount_rate and the tax rate, on lines and on products, and late_fee_rate on customers) are strings too, but they are not rounded to cents. They have at least 2 decimal places and keep any further ones that were stored, such as "10.0125".
  • Dates (issue_date, due_date, expiry_date, payments[].date) are YYYY-MM-DD.
  • Times (created_at, updated_at, meta.deleted_at) are ISO 8601 in UTC, ending in Z.
  • Ids are strings. Documents, lines, payments, customers, products and taxes each have their own ids. Every id is a ULID: a 26-character string that sorts in the order the record was created.

Invoice and credit note

Field Description
invoice_type invoice or credit_note.
number The document number.
status See Statuses.
overdue true when the invoice is past its due date and not paid. Always false on a credit note. It is worked out from today's date, so it can turn true without any change to the invoice and without a new updated_at.
issue_date The issue date.
due_date The due date, or null when there is none.
currency The three-letter currency code of the document.
reference_number The payment reference number, or null.
total_net The total before tax.
total_tax The tax.
total The total including tax.
total_paid The sum of the payments recorded on the document.
total_credited The part of the total taken off by credit notes.
total_unpaid total minus total_paid minus total_credited.
items The lines of the document, in the order they appear on it. See Line item.
tax_lines The totals for each tax rate used on the document. See Tax row.
customer_details The customer details stored on the document. See Customer.
payments The payments recorded on the document, oldest first. Empty when there are none.
created_at When the document was created.
updated_at When the document last changed, including when it was sent or viewed and any change to its payments.

Estimate

An estimate has number, status, issue_date, currency, total_net, total_tax, total, items, tax_lines, customer_details, created_at and updated_at, with the same meaning as above. It also has expiry_date, the date the estimate expires, or null when there is none. An estimate has no invoice_type, overdue, due_date, reference_number, total_paid, total_credited, total_unpaid or payments.

Customer

A document has two parts that concern its customer.

relationships.customer.data links the document to the customer record. It is {"type": "customers", "id": "..."}, or null when no customer is linked to the document. The id is the same on every document of that customer, so it can be used to group documents by customer, and GET /customers/{id} returns the customer. The link stays on the document after the customer is deleted. GET /customers/{id} then returns 404, and the id appears in /deleted. The response holds the link only, not the customer record, because the API does not support include.

attributes.customer_details is a copy of the customer details stored on the document when it was issued. The copy is not the current customer record, so renaming a customer later does not change old documents.

Field Description
customer_number The customer number.
name The customer name.
reg_code The registration number.
vat_number The VAT number.
email The email address, as it was typed. It can hold several addresses separated by commas.
phone The phone number.
website The website.
address The first address line.
address_2 The second address line.
city The city.
state The state or county.
postal_code The postal code.
country The country code, such as EE.
additional_info The additional information about the customer.

These are the same fields, with the same names, as on a customer record, without the settings for new documents. Each field is null when the document has no value for it. Old documents stored fewer fields, so more of them are null.

Source

relationships.source.data links the document to the document it was made from. On a credit note it is {"type": "invoices", "id": "..."}, the invoice the credit note credits. On an invoice made from an estimate it is {"type": "estimates", "id": "..."}. It is null for any other document, such as an invoice made by a recurring invoice or written from scratch. It is also null when the source is a draft or has been deleted, because the API never links to a record it does not return. Unlike a customer, a deleted document leaves no link behind: its id appears in /deleted and the source of the documents made from it is null. GET /invoices/{id} or GET /estimates/{id} returns the source.

Line item

Each row in items is one line of the document, and its amounts are in the currency of the document. Quantities, unit prices and rates are exact decimals, and the amounts are money with 2 decimal places.

Field Description
id The line id.
product The product the line was added from, with its id. It is null when the line has no product, and also after that product is deleted, which does not move the document's updated_at.
name The name of the line.
description The description of the line, or null.
unit The unit, such as h or pcs, or null.
quantity The quantity.
net_price The unit price before tax.
gross_price The unit price including tax.
calculate_price_from The field the user typed on the line: net_price, gross_price, net_amount or gross_amount. That field holds the typed value, and the other prices and amounts were worked out from it, so a worked-out unit price can have more decimal places. To get the same totals in your own system, start from this field.
subtotal The line total before the discount and before tax.
discount_rate The discount in percent, such as "20.00". It is "0.00" when the line has no discount.
discount_amount The amount the discount takes off.
net_amount The line total before tax: subtotal minus discount_amount.
tax The tax of the line, with its id, name and rate. rate is a percentage, such as "24.00", and null for the exempt rate. The tax is a record of its own, and the line shows it as it is now: if the business renames a tax, old documents show the new name without a new updated_at. The rate of a tax that is in use cannot change.
tax_amount The tax on the line.
gross_amount The line total including tax: net_amount plus tax_amount.

Tax row

tax_lines has one row for each tax rate used on the lines of the document. The rows add up to the document totals: their net_amount values to total_net, and their tax_amount values to total_tax.

Field Description
id The id of the row itself. It stays the same when the document is saved again.
tax.id The id of the tax, the same as tax.id on the lines with this rate.
tax.name The name of the tax as it is now, the same as tax.name on a line.
tax.rate The rate in percent, or null for the exempt rate.
net_amount The total before tax of the lines with this rate.
tax_amount The tax on the lines with this rate.

Payment

Field Description
id The payment id.
date The payment date.
amount The amount applied to this document, in the currency of the document. A payment that covers several invoices shows its share of each one.
currency The currency of the document, the same as the document's currency.
method bank_transfer, card, check, cash, paypal or other.

Example

GET /invoices/01m79yc5cs5ceqya2q276ss137. A list of invoices holds the same resource objects in data.

{
  "data": {
    "id": "01m79yc5cs5ceqya2q276ss137",
    "type": "invoices",
    "attributes": {
      "invoice_type": "invoice",
      "number": "1042",
      "status": "partially_paid",
      "overdue": true,
      "issue_date": "2026-10-01",
      "due_date": "2026-10-04",
      "currency": "EUR",
      "reference_number": "12345",
      "total_net": "100.00",
      "total_tax": "24.00",
      "total": "124.00",
      "total_paid": "50.00",
      "total_credited": "0.00",
      "total_unpaid": "74.00",
      "items": [
        {
          "id": "01m79yc5e2bwp90abbadvtrvqn",
          "product": {
            "id": "01m79yc5b1y44w42196ddmxgv9"
          },
          "name": "Logo design",
          "description": "Three drafts and one round of changes",
          "unit": "h",
          "quantity": "2.50",
          "net_price": "24.00",
          "gross_price": "29.76",
          "calculate_price_from": "net_price",
          "subtotal": "60.00",
          "discount_rate": "0.00",
          "discount_amount": "0.00",
          "net_amount": "60.00",
          "tax": {
            "id": "01m79yc5a2f9zasj53yv6e8zp9",
            "name": "VAT",
            "rate": "24.00"
          },
          "tax_amount": "14.40",
          "gross_amount": "74.40"
        },
        {
          "id": "01m79yc5egetdnhdfakk5wxgw4",
          "product": null,
          "name": "Web hosting",
          "description": null,
          "unit": "month",
          "quantity": "1.00",
          "net_price": "50.00",
          "gross_price": "62.00",
          "calculate_price_from": "gross_price",
          "subtotal": "50.00",
          "discount_rate": "20.00",
          "discount_amount": "10.00",
          "net_amount": "40.00",
          "tax": {
            "id": "01m79yc5a2f9zasj53yv6e8zp9",
            "name": "VAT",
            "rate": "24.00"
          },
          "tax_amount": "9.60",
          "gross_amount": "49.60"
        }
      ],
      "tax_lines": [
        {
          "id": "01m79yc5epy4vpeefg8afv2dm3",
          "tax": {
            "id": "01m79yc5a2f9zasj53yv6e8zp9",
            "name": "VAT",
            "rate": "24.00"
          },
          "net_amount": "100.00",
          "tax_amount": "24.00"
        }
      ],
      "customer_details": {
        "customer_number": "C-100",
        "name": "Kestrel OÜ",
        "reg_code": "12345678",
        "vat_number": "EE100000001",
        "email": "arved@kestrel.ee,boss@kestrel.ee",
        "phone": "+372 5555 5555",
        "website": "https://kestrel.ee",
        "address": "Tamme 1",
        "address_2": null,
        "city": "Tallinn",
        "state": "Harjumaa",
        "postal_code": "10111",
        "country": "EE",
        "additional_info": null
      },
      "payments": [
        {
          "id": "01m79yc5fa1n280m9s8s95nfpx",
          "date": "2026-10-05",
          "amount": "50.00",
          "currency": "EUR",
          "method": "bank_transfer"
        }
      ],
      "created_at": "2026-10-01T09:00:00Z",
      "updated_at": "2026-10-05T12:00:00Z"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customers",
          "id": "01m79yc5a4fracgn2enjd529ra"
        }
      },
      "source": {
        "data": {
          "type": "estimates",
          "id": "01m79yc5bc493dv7pzy3j7s1tx"
        }
      }
    },
    "links": {
      "self": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137",
      "pdf": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=pdf",
      "peppol_bis_3": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=peppol_bis_3",
      "en16931_ubl": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=en16931_ubl",
      "estonian_e_invoice_1_2": "https://sliptree.com/api/v1/invoices/01m79yc5cs5ceqya2q276ss137?output_format=estonian_e_invoice_1_2"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

GET /estimates/01m79yc5bc493dv7pzy3j7s1tx:

{
  "data": {
    "id": "01m79yc5bc493dv7pzy3j7s1tx",
    "type": "estimates",
    "attributes": {
      "number": "E-15",
      "status": "accepted",
      "issue_date": "2026-10-01",
      "expiry_date": "2026-10-31",
      "currency": "EUR",
      "total_net": "100.00",
      "total_tax": "24.00",
      "total": "124.00",
      "items": [
        {
          "id": "01m79yc5bx0rgy0nyw522vx42h",
          "product": null,
          "name": "Logo design",
          "description": null,
          "unit": "h",
          "quantity": "4.00",
          "net_price": "25.00",
          "gross_price": "31.00",
          "calculate_price_from": "net_price",
          "subtotal": "100.00",
          "discount_rate": "0.00",
          "discount_amount": "0.00",
          "net_amount": "100.00",
          "tax": {
            "id": "01m79yc5a2f9zasj53yv6e8zp9",
            "name": "VAT",
            "rate": "24.00"
          },
          "tax_amount": "24.00",
          "gross_amount": "124.00"
        }
      ],
      "tax_lines": [
        {
          "id": "01m79yc5c44stqdnqsgxmngpy4",
          "tax": {
            "id": "01m79yc5a2f9zasj53yv6e8zp9",
            "name": "VAT",
            "rate": "24.00"
          },
          "net_amount": "100.00",
          "tax_amount": "24.00"
        }
      ],
      "customer_details": {
        "customer_number": "C-100",
        "name": "Kestrel OÜ",
        "reg_code": "12345678",
        "vat_number": "EE100000001",
        "email": "arved@kestrel.ee,boss@kestrel.ee",
        "phone": "+372 5555 5555",
        "website": "https://kestrel.ee",
        "address": "Tamme 1",
        "address_2": null,
        "city": "Tallinn",
        "state": "Harjumaa",
        "postal_code": "10111",
        "country": "EE",
        "additional_info": null
      },
      "created_at": "2026-10-01T09:00:00Z",
      "updated_at": "2026-10-05T12:00:00Z"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customers",
          "id": "01m79yc5a4fracgn2enjd529ra"
        }
      },
      "source": {
        "data": null
      }
    },
    "links": {
      "self": "https://sliptree.com/api/v1/estimates/01m79yc5bc493dv7pzy3j7s1tx",
      "pdf": "https://sliptree.com/api/v1/estimates/01m79yc5bc493dv7pzy3j7s1tx?output_format=pdf"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Statuses

The status field takes the values below. Draft is not one of them, because drafts are never returned. The statuses are the same ones the app shows. For when each one is applied, see How does invoice status work? and How does estimate status work?.

Value Applies to Meaning
completed Invoices, credit notes, estimates Issued and numbered, but not sent yet.
sent Invoices, credit notes, estimates Sent to the customer by email or as an e-invoice.
viewed Invoices, credit notes, estimates The customer opened the document.
partially_paid Invoices, credit notes Some money was paid and total_unpaid is not yet zero. On a credit note this means partially refunded.
paid Invoices, credit notes Some money was paid and nothing is left open: total_unpaid is zero. Credit notes count towards this, so total_paid can be less than total. On a credit note this means refunded.
accepted Estimates The estimate was accepted, or it was turned into an invoice.
rejected Estimates The estimate was marked as rejected.

An invoice that was credited in full and never paid keeps its status, such as sent, and total_unpaid is 0.00. An overdue invoice keeps its status too, so read the overdue field.

Products

GET /products lists the products of the business, sorted by name. GET /products/{id} returns one product, and another business's product returns 404.

Parameter Valid values
filter[updated_since] A date and time in ISO 8601 with an offset, in the same format as on the document lists. Returns products changed at that moment or later.
sort name, -name, created_at, -created_at, updated_at or -updated_at. A leading - reverses the order. The default is name, in alphabetical order.
page[size], page[after], page[before] Paging, as on the other lists. See Paging.

Any other filter or sort returns 400. Products with the same sort value are ordered by id, as on the other lists.

Field Description
name The product name.
sku The SKU or code of the product, as shown in the app, or null.
description The description in Markdown, the way the editor stores bold text, lists and links, or null.
unit The unit, such as hour, each or kilogram, or null. A unit the user typed in is returned as it was typed.
net_price The unit price before tax.
gross_price The unit price including tax.
calculate_price_from The price the user typed: net_price or gross_price. The other price was worked out from it.
tax The tax rate of the product: its id, its name, and its rate as a percentage, such as "22.00". The rate is null for a rate without a percentage, such as a tax exemption. The tax is a record of its own and is shown as it is now, so a renamed tax shows its new name.
created_at When the product was created.
updated_at When the product last changed.

A product price has no currency. Sliptree copies the number as it is into an invoice or estimate in any currency.

GET /products/01m79yc5b1y44w42196ddmxgv9:

{
  "data": {
    "id": "01m79yc5b1y44w42196ddmxgv9",
    "type": "products",
    "attributes": {
      "name": "Logo design",
      "sku": "LOGO-1",
      "description": "Three drafts and **one round** of changes",
      "unit": "h",
      "net_price": "24.00",
      "gross_price": "29.76",
      "calculate_price_from": "net_price",
      "tax": {
        "id": "01m79yc5a2f9zasj53yv6e8zp9",
        "name": "VAT",
        "rate": "24.00"
      },
      "created_at": "2026-10-01T09:00:00Z",
      "updated_at": "2026-10-01T09:00:00Z"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Customers

GET /customers lists the customers of the business, sorted by name. GET /customers/{id} returns one customer, and another business's customer returns 404. A deleted customer is not listed and returns 404. It appears in /deleted instead.

Parameter Valid values
filter[customer_number] Returns the customer with this customer number.
filter[reg_code] Returns the customers with this registration number. Capitals, spaces, dashes and dots do not matter.
filter[vat_number] Returns the customers with this VAT number. Capitals, spaces, dashes and dots do not matter.
filter[email] One email address. Returns the customers that have this address, also when they have several. The case does not matter.
filter[country] A two-letter country code in capitals, such as EE. Returns the customers of that country.
filter[updated_since] A date and time in ISO 8601 with an offset, in the same format as on the document lists. Returns customers changed at that moment or later.
sort name, -name, created_at, -created_at, updated_at or -updated_at. A leading - reverses the order. The default is name, in alphabetical order.
page[size], page[after], page[before] Paging, as on the other lists. See Paging.

Any other filter or sort returns 400. Customers with the same sort value are ordered by id, as on the other lists.

Field Description
customer_number The customer number shown in Sliptree, or null. It is unique in a business.
name The customer name.
reg_code The registration number, or null.
vat_number The VAT number, or null.
email The email address, or null. It is stored as it was typed, so it can hold several addresses separated by commas.
phone The phone number, or null.
website The website, or null.
address The first address line, or null.
address_2 The second address line, or null.
city The city, or null.
state The state or county, or null.
postal_code The postal code, or null.
country The two-letter country code, such as EE, or null.
iban The bank account number (IBAN) of the customer, or null.
currency The three-letter currency code for new documents of this customer, or null.
locale The language for new documents of this customer, such as et, or null.
invoice_payment_terms The number of days between the issue date and the due date of an invoice, or null.
estimate_expiration_terms The number of days an estimate stays valid, or null.
late_fee_rate The late fee in percent for each day, as an exact decimal such as "7.50", or null.
additional_info The additional information about the customer, as typed, or null.
created_at When the customer was created.
updated_at When the customer last changed.

The lookup filters take one value each. The filters combine with each other, with filter[updated_since] and with paging. An empty value, a list of values, a filter[email] that is not an email address, a filter[reg_code] or filter[vat_number] without a letter or digit, or a filter[country] that is not a two-letter code in capitals returns 422.

Use these filters to check whether a customer is already in Sliptree. filter[customer_number] and filter[country] match the stored value exactly, so A-001 does not find a-001. filter[reg_code] and filter[vat_number] compare only the letters and digits, in capitals, so EE 100 000 001, ee100000001 and EE100000001 find each other. filter[email] finds a customer that has the address among its addresses, whatever the case: a customer with a@kestrel.ee, b@kestrel.ee is found by filter[email]=b@kestrel.ee. The value stored on the customer does not change.

A null in currency, locale, invoice_payment_terms, estimate_expiration_terms or late_fee_rate means the customer has no setting of its own. The default of the business applies then.

GET /customers/01m79yc5a4fracgn2enjd529ra:

{
  "data": {
    "id": "01m79yc5a4fracgn2enjd529ra",
    "type": "customers",
    "attributes": {
      "customer_number": "C-100",
      "name": "Kestrel OÜ",
      "reg_code": "12345678",
      "vat_number": "EE100000001",
      "email": "arved@kestrel.ee,boss@kestrel.ee",
      "phone": "+372 5555 5555",
      "website": "https://kestrel.ee",
      "address": "Tamme 1",
      "address_2": null,
      "city": "Tallinn",
      "state": "Harjumaa",
      "postal_code": "10111",
      "country": "EE",
      "iban": "EE382200221020145685",
      "currency": "EUR",
      "locale": "et",
      "invoice_payment_terms": 14,
      "estimate_expiration_terms": null,
      "late_fee_rate": "0.50",
      "additional_info": null,
      "created_at": "2026-10-01T09:00:00Z",
      "updated_at": "2026-10-01T09:00:00Z"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Rate limit

The limit is 60 requests a minute for each business. All keys of one business share it, and keys of other businesses do not count towards it.

Every response carries X-RateLimit-Limit and X-RateLimit-Remaining. After the limit is passed, requests return 429. The 429 response has a Retry-After header with the number of seconds to wait. The 60 seconds start with the first request in them, not on the clock minute.

{
  "errors": [
    {
      "status": "429",
      "code": "rate_limited",
      "title": "Too many requests",
      "detail": "Too many requests. Try again in 60 seconds.",
      "meta": {
        "request_id": "01M78XKPMW29RNPPB9A9T5937Y"
      }
    }
  ]
}

Keeping your data in sync

The API has no webhooks, so a client polls. Ask only for what changed since the last poll. Each poll is a walk through the pages of a list:

curl -g "https://sliptree.com/api/v1/invoices?filter[updated_since]=2026-10-05T11:55:00Z&sort=updated_at&page[size]=100" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
  1. On the first poll, leave out filter[updated_since] to read everything. Use sort=updated_at and page[size]=100.
  2. Follow links.next of each response until it is null. Use the address as it is. Do not build a cursor.
  3. While you read, keep the newest updated_at that you see. At the next poll, send that value minus a small overlap, such as 5 minutes, as filter[updated_since]. The overlap makes sure that a change saved at almost the same moment is not missed.
  4. Match documents by id and overwrite your copy. Because of the overlap, a document can appear in two polls. A document that is edited while you read can appear again later in the same walk. Neither case skips a document.
  5. A cursor is valid for the walk in progress only. If a request with a stored cursor returns 400, start the walk again from the last filter[updated_since] that you completed.
  6. A document's updated_at moves when it is sent or viewed, and when you record, change or delete a payment on it, so these changes arrive in the same poll as edits.
  7. overdue changes with the date alone. Work it out yourself from due_date and total_unpaid, or read the list again with filter[status]=overdue.

Products and customers sync the same way: read /products or /customers with filter[updated_since] and sort=updated_at, and match them by id.

A deleted document no longer appears in /invoices or /estimates, a deleted product no longer appears in /products, and a deleted customer no longer appears in /customers, so updated_since cannot report them. In each poll, also read /deleted the same way: follow links.next to the end, keep the newest meta.deleted_at, and send it minus the overlap as filter[deleted_since] in the next poll. Remove the documents, products and customers it lists from your copy. Match them by type and id: the type says which list the record was in.

A deleted record stays in /deleted for 365 days. If your client has not polled for longer than that, the list can miss some deleted records. Read all documents, products and customers again in that case, and remove the ones you hold that are no longer there.

Standards

The API follows these standards:

It differs from them in these ways:

  • Attribute names are in snake_case, such as issue_date. JSON:API recommends camelCase, but that is a recommendation, not a rule of the standard.
  • The API does not support include, fields[...] (sparse fieldsets) or extensions. A request that uses one returns 400, 406 or 415, as JSON:API requires of a server without them.
  • A list has no total count.
  • A list refuses every query parameter that it does not have, with 400.
  • A response in a file format (any output_format other than json) is not JSON:API. A list in a file format has its page links in the Link header, and a page without records returns 204.
  • The /deleted list holds records of several types. Each has the type of its own list and no attributes, only the time of deletion in meta.
  • Each error has a code from the list of codes and a meta.request_id, which the standard leaves to the server.
  • Only GET requests are served, because version 1 cannot change anything.

A description of the API in OpenAPI 3.1 is planned.

Still need help? Contact Us Contact Us