Introduction
REST API for the Crisfix Invoices mobile app. Authentication uses Sanctum bearer tokens obtained from the register/login endpoints.
This documentation aims to provide all the information you need to work with our API.
<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>
Authenticating requests
To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
Obtain a bearer token from the Register or Login endpoint, then send it as Authorization: Bearer {token} on the protected endpoints.
Account — Affiliate
Your referral link, the people you've referred, and your earnings (owner only). Commissions and payouts are recorded manually by Crisfix.
Your referral link, referrals and earnings summary.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/affiliate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/affiliate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Email your referral link to someone.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/affiliate/invite" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"friend@example.com\",
\"message\": \"You should try this!\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/affiliate/invite"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "friend@example.com",
"message": "You should try this!"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Account — App Version
Force/soft update rules per mobile platform. The GET below is what the app calls on launch to compare its own version against; the POST is internal (Crisfix team only) and is excluded from the public docs.
Fetch the current version rules for a platform.
The app calls this on launch and compares its own version/build against
the response to decide whether to show a force-update or soft-update
prompt. force_update and soft_update are real JSON booleans, not 0/1.
Rules are stored one row per platform, so a platform with no row yet returns 404 rather than an empty object.
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/app-version?platform=ios" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/app-version"
);
const params = {
"platform": "ios",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"id": 1,
"platform": "ios",
"latest_version": "1.1.0",
"latest_build": "2",
"min_version": "1.0.0",
"min_build": "1",
"force_update": true,
"soft_update": false,
"store_url": "https://apps.apple.com/app/idXXXXXXXX",
"title": "Update Required",
"message": "Please update Crisfix Invoices to continue.",
"created_at": "2026-08-19T10:32:18.000000Z",
"updated_at": "2026-08-19T10:32:18.000000Z"
}
}
Example response (404):
{
"status": false,
"message": "No version rules found for that platform."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Account — Invoice Series
Numbering series used when creating invoices (each has its own prefix and currency). Free plan is limited to a single invoice currency.
List invoice series.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/invoice-series" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoice-series"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create an invoice series.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/invoice-series" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Sales 2026\",
\"prefix\": \"INV\",
\"currency\": \"GBP\",
\"description\": \"Main sales series\",
\"tax_name\": \"VAT\",
\"tax_rate\": 20,
\"space\": \"Thank you\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/invoice-series"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Sales 2026",
"prefix": "INV",
"currency": "GBP",
"description": "Main sales series",
"tax_name": "VAT",
"tax_rate": 20,
"space": "Thank you"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (403):
{
"status": false,
"message": "Your Free plan supports 1 invoice currency. Upgrade to invoice in multiple currencies."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one invoice series.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/invoice-series/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoice-series/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update an invoice series.
requires authentication
Full replace — name, prefix and currency are all required (same fields as create).
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/invoice-series/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Sales 2026\",
\"prefix\": \"INV\",
\"currency\": \"GBP\",
\"description\": \"Main sales series\",
\"tax_name\": \"VAT\",
\"tax_rate\": 20,
\"space\": \"Thank you\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/invoice-series/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Sales 2026",
"prefix": "INV",
"currency": "GBP",
"description": "Main sales series",
"tax_name": "VAT",
"tax_rate": 20,
"space": "Thank you"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete an invoice series (not allowed if it has invoices).
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/invoice-series/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoice-series/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Set this series as the company default.
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/invoice-series/1/default" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoice-series/1/default"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Account — Password
OTP-based password recovery for the mobile app: forgot-password emails a 6-digit code, verify-otp checks it, reset-password sets the new password with the code. Plus changing the password while logged in.
Forgot password — email a 6-digit OTP code.
Always returns success (even if the email isn't registered) so it can't be used to discover which emails have accounts.
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/forgot-password" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"jane@example.com\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/forgot-password"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "jane@example.com"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"message": "If that email is registered, a code has been sent."
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Resend the password-reset OTP.
Issues a fresh 6-digit code and emails it, replacing the previous one. Same no-enumeration behaviour as forgot-password (always returns success).
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/resend-otp" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"jane@example.com\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/resend-otp"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "jane@example.com"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"message": "If that email is registered, a code has been sent."
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Verify an OTP code (without resetting yet).
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/verify-otp" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"jane@example.com\",
\"otp\": \"123456\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/verify-otp"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "jane@example.com",
"otp": "123456"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"verified": true
}
}
Example response (422):
{
"status": false,
"message": "The code is invalid or has expired.",
"errors": {
"otp": [
"The code is invalid or has expired."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Reset password with a verified OTP code.
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/reset-password" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"jane@example.com\",
\"otp\": \"123456\",
\"password\": \"newsecret123\",
\"password_confirmation\": \"newsecret123\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/reset-password"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "jane@example.com",
"otp": "123456",
"password": "newsecret123",
"password_confirmation": "newsecret123"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"message": "Your password has been reset."
}
}
Example response (422):
{
"status": false,
"message": "The code is invalid or has expired.",
"errors": {
"otp": [
"The code is invalid or has expired."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Change password (logged in). Requires the current password.
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/password" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"current_password\": \"secret123\",
\"password\": \"newsecret123\",
\"password_confirmation\": \"newsecret123\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/password"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"current_password": "secret123",
"password": "newsecret123",
"password_confirmation": "newsecret123"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Account — Subscription
Read-only view of the account's current plan, this month's usage against its limits, and the plans available to upgrade to. Starting or changing a subscription happens on the web (Stripe Checkout / Customer Portal).
Current subscription, usage, and available plans.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/subscription" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/subscription"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Account — Team
Manage team members (owner only). Members share the owner's company and plan. Invitees set their password via the emailed web link, then log in normally.
List members, pending invitations and seat usage.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/team" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/team"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Invite a team member (sends an email with an accept link).
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/team/invite" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Jane Doe\",
\"email\": \"jane@example.com\",
\"role\": \"staff\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/team/invite"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Jane Doe",
"email": "jane@example.com",
"role": "staff"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Change a member's role (staff | accountant).
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/team/members/1/role" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"role\": \"accountant\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/team/members/1/role"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"role": "accountant"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Remove a team member.
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/team/members/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/team/members/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Authentication
Register, log in and log out for the mobile app. Register and login return a
Sanctum bearer token to send as Authorization: Bearer {token} on protected
endpoints.
Register a new user.
Creates the user AND their company in one step, locking the billing country (which sets the billing currency) from the start — same as the website. Get the list of countries from the Countries endpoint to populate the country picker on your signup screen. Returns the user, the created company, and a bearer token.
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/register" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Jane Doe\",
\"company_name\": \"Acme Ltd\",
\"country_id\": 232,
\"email\": \"jane@example.com\",
\"password\": \"secret123\",
\"referral_code\": \"ngzmiyvdljnikhwa\",
\"password_confirmation\": \"secret123\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/register"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Jane Doe",
"company_name": "Acme Ltd",
"country_id": 232,
"email": "jane@example.com",
"password": "secret123",
"referral_code": "ngzmiyvdljnikhwa",
"password_confirmation": "secret123"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (201):
{
"status": true,
"data": {
"user": {
"id": 1,
"name": "Jane Doe",
"email": "jane@example.com"
},
"company": {
"id": 1,
"name": "Acme Ltd",
"country": "United Kingdom",
"country_id": 232
},
"token": "1|abcdef..."
}
}
Example response (422):
{
"status": false,
"message": "The email has already been taken.",
"errors": {
"email": [
"The email has already been taken."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Log in.
Verifies credentials and returns a bearer token.
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/login" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"jane@example.com\",
\"password\": \"secret123\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/login"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "jane@example.com",
"password": "secret123"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"user": {
"id": 1,
"name": "Jane Doe",
"email": "jane@example.com"
},
"token": "2|abcdef..."
}
}
Example response (422):
{
"status": false,
"message": "The provided credentials are incorrect.",
"errors": {
"email": [
"The provided credentials are incorrect."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Log out.
requires authentication
Revokes the token used to make this request.
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/logout" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/logout"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"message": "Logged out."
}
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Company Account
The authenticated user's company (one per user). GET returns null when the user has not set a company up yet; PUT creates it on first save, then updates.
Get my company.
requires authentication
Returns the authenticated user's company, or null if none exists yet. In a
browser (HTML request) this serves the test console; the JSON body is
returned when the request sends Accept: application/json with a token.
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/company"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"company": {
"id": 1,
"name": "Acme Ltd",
"vat_number": "GB123",
"email": "hello@acme.com"
}
}
}
Example response (200, No company yet):
{
"status": true,
"data": {
"company": null
}
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create or update my company.
requires authentication
Saves the company for the authenticated user. Creates it the first time, updates it thereafter.
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/company" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Acme Ltd\",
\"company_number\": \"12345678\",
\"trading_name\": \"Acme\",
\"address\": \"1 High Street\",
\"city\": \"London\",
\"country_id\": 232,
\"vat_number\": \"GB123456789\",
\"phone\": \"+44 20 7946 0000\",
\"email\": \"hello@acme.com\",
\"website\": \"https:\\/\\/acme.com\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/company"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Acme Ltd",
"company_number": "12345678",
"trading_name": "Acme",
"address": "1 High Street",
"city": "London",
"country_id": 232,
"vat_number": "GB123456789",
"phone": "+44 20 7946 0000",
"email": "hello@acme.com",
"website": "https:\/\/acme.com"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"company": {
"id": 1,
"name": "Acme Ltd",
"vat_number": "GB123456789"
}
}
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (422):
{
"status": false,
"message": "The name field is required.",
"errors": {
"name": [
"The name field is required."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Upload / replace the company logo.
requires authentication
Send as multipart/form-data with a logo file field (png, jpg, jpeg or
webp, max 2 MB). Replaces any existing logo.
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/company/logo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "logo=@C:\Users\Dell\AppData\Local\Temp\phpCA34.tmp" const url = new URL(
"https://invoices.crisfix.com/api/v1/company/logo"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('logo', document.querySelector('input[name="logo"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"company": {
"id": 1,
"logo_path": "logos/logo_1_1700000000.png"
}
}
}
Example response (422):
{
"status": false,
"message": "The logo must be an image.",
"errors": {
"logo": [
"The logo must be an image."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Remove the company logo.
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/company/logo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/company/logo"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"company": {
"id": 1,
"logo_path": null
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Contacts — Clients
The authenticated company's customers. All scoped to the caller's company.
List clients.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/clients?page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/clients"
);
const params = {
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create a client.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/clients" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Acme Ltd\",
\"company_reg\": \"12345678\",
\"address\": \"1 High Street\",
\"city\": \"London\",
\"country_id\": 232,
\"email\": \"hello@acme.com\",
\"phone\": \"+44 20 7946 0000\",
\"notes\": \"Key account\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/clients"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Acme Ltd",
"company_reg": "12345678",
"address": "1 High Street",
"city": "London",
"country_id": 232,
"email": "hello@acme.com",
"phone": "+44 20 7946 0000",
"notes": "Key account"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one client (with money summary).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/clients/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/clients/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update a client.
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/clients/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"b\",
\"company_reg\": \"n\",
\"address\": \"architecto\",
\"city\": \"n\",
\"country_id\": 16,
\"email\": \"zbailey@example.net\",
\"phone\": \"i\",
\"notes\": \"architecto\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/clients/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "b",
"company_reg": "n",
"address": "architecto",
"city": "n",
"country_id": 16,
"email": "zbailey@example.net",
"phone": "i",
"notes": "architecto"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete a client.
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/clients/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/clients/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Contacts — Supplier Bills
Money you owe suppliers. Bills are unpaid or paid; "overdue" and "due soon" are derived from the due date. Marking a recurring bill paid spawns next month's copy automatically.
List supplier bills (unpaid first, then soonest due).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/supplier-bills?status=unpaid&page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/supplier-bills"
);
const params = {
"status": "unpaid",
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Spending summary (per-currency totals), mirroring the web "My Spending" strip.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/supplier-bills/summary" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/supplier-bills/summary"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download a CSV of all supplier bills.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/supplier-bills/export" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/supplier-bills/export"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create a supplier bill.
requires authentication
Provide either supplier_id (existing) or new_supplier_name (creates a minimal supplier from just that name).
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/supplier-bills" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"supplier_id\": 4,
\"new_supplier_name\": \"New Vendor Ltd\",
\"description\": \"Monthly hosting\",
\"amount\": 49.99,
\"currency\": \"GBP\",
\"issue_date\": \"2026-08-03\",
\"due_date\": \"2026-08-31\",
\"recurrence\": \"monthly\",
\"occurrences\": 4,
\"expense_category\": \"Motor & travel\",
\"notes\": \"Auto-renews\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/supplier-bills"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"supplier_id": 4,
"new_supplier_name": "New Vendor Ltd",
"description": "Monthly hosting",
"amount": 49.99,
"currency": "GBP",
"issue_date": "2026-08-03",
"due_date": "2026-08-31",
"recurrence": "monthly",
"occurrences": 4,
"expense_category": "Motor & travel",
"notes": "Auto-renews"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one supplier bill.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/supplier-bills/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/supplier-bills/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update a supplier bill.
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/supplier-bills/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"supplier_id\": 16,
\"new_supplier_name\": \"n\",
\"description\": \"Animi quos velit et fugiat.\",
\"amount\": 42,
\"currency\": \"ljn\",
\"issue_date\": \"2026-08-25T07:13:33\",
\"due_date\": \"2052-09-17\",
\"recurrence\": \"monthly\",
\"occurrences\": 4,
\"expense_category\": \"Marketing & advertising\",
\"notes\": \"architecto\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/supplier-bills/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"supplier_id": 16,
"new_supplier_name": "n",
"description": "Animi quos velit et fugiat.",
"amount": 42,
"currency": "ljn",
"issue_date": "2026-08-25T07:13:33",
"due_date": "2052-09-17",
"recurrence": "monthly",
"occurrences": 4,
"expense_category": "Marketing & advertising",
"notes": "architecto"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete a supplier bill.
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/supplier-bills/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/supplier-bills/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Mark a bill paid. Recurring bills are pre-created up front, so this just records the payment (no auto-spawn).
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/supplier-bills/1/paid" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/supplier-bills/1/paid"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List the expense categories a bill can be tagged with.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/expense-categories" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/expense-categories"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"expense_categories": [
"Motor & travel",
"Premises (rent, utilities)",
"..."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Contacts — Suppliers
Manage the businesses you buy from. Bills are attached to a supplier.
List suppliers.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/suppliers?page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/suppliers"
);
const params = {
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create a supplier.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/suppliers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Acme Supplies Ltd\",
\"number\": 22,
\"company_reg\": \"12345678\",
\"address\": \"1 Industrial Way\",
\"city\": \"Leeds\",
\"country_id\": 232,
\"email\": \"accounts@acme.test\",
\"phone\": \"+44 113 000 0000\",
\"notes\": \"Net 30 terms\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/suppliers"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Acme Supplies Ltd",
"number": 22,
"company_reg": "12345678",
"address": "1 Industrial Way",
"city": "Leeds",
"country_id": 232,
"email": "accounts@acme.test",
"phone": "+44 113 000 0000",
"notes": "Net 30 terms"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one supplier.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/suppliers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/suppliers/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update a supplier.
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/suppliers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"b\",
\"number\": 22,
\"company_reg\": \"g\",
\"address\": \"architecto\",
\"city\": \"n\",
\"country_id\": 16,
\"email\": \"zbailey@example.net\",
\"phone\": \"i\",
\"notes\": \"architecto\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/suppliers/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "b",
"number": 22,
"company_reg": "g",
"address": "architecto",
"city": "n",
"country_id": 16,
"email": "zbailey@example.net",
"phone": "i",
"notes": "architecto"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete a supplier (also removes its bills).
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/suppliers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/suppliers/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List a supplier's bills (their history with you).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/suppliers/1/bills?page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/suppliers/1/bills"
);
const params = {
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Dashboard
A single summary payload for the app home screen: plan usage, invoice/client counts, this-month money totals (by currency), and the most recent invoices.
Dashboard summary.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/dashboard" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/dashboard"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"company": {
"id": 1,
"name": "Acme Ltd"
},
"plan": {
"name": "Free",
"slug": "free",
"invoice_limit": 5,
"invoices_used_this_month": 2
},
"counts": {
"invoices": {
"all": 12,
"overdue": 1,
"unpaid": 3,
"partially_paid": 0,
"paid": 8,
"cancelled": 0
},
"clients": 5,
"products": 9
},
"this_month": {
"invoiced": {
"GBP": "£1,200.00"
},
"received": {
"GBP": "£800.00"
},
"outstanding": {
"GBP": "£400.00"
}
},
"recent_invoices": [
{
"id": 12,
"invoice_number": "INV-012",
"client": "Acme",
"total_amount": "150.00",
"currency": "GBP",
"status": "sent",
"issue_date": "2026-08-01"
}
],
"six_month_summary": [
{
"label": "Aug 2026",
"invoiced": {
"GBP": "1200.00"
},
"received": {
"GBP": "800.00"
}
},
{
"label": "Jul 2026",
"invoiced": {},
"received": {}
}
],
"recent_payments": [
{
"id": 16,
"amount": "16.50",
"payment_date": "2026-08-11",
"invoice_id": 30,
"invoice_number": "INV-030",
"client": "Acme"
}
]
}
}
Example response (200, No company yet):
{
"status": true,
"data": {
"company": null
}
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Documents — Credit Notes
Credit notes are issued against an existing invoice; their tax rate and currency are inherited from that invoice. Once issued they are not editable.
Issue a credit note against an invoice.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/invoices/1/credit-notes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"issue_date\": \"2026-08-03\",
\"reason\": \"Returned goods\",
\"items\": [
{
\"description\": \"Widget refund\",
\"quantity\": 1,
\"unit_price\": 12.5
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices/1/credit-notes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"issue_date": "2026-08-03",
"reason": "Returned goods",
"items": [
{
"description": "Widget refund",
"quantity": 1,
"unit_price": 12.5
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List credit notes.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/credit-notes?page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/credit-notes"
);
const params = {
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one credit note (with items and its invoice).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/credit-notes/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/credit-notes/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download the credit note PDF (binary, not JSON).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/credit-notes/1/pdf" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/credit-notes/1/pdf"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Documents — Delivery Notes
Delivery notes track dispatched goods (no pricing — quantity and unit only). They can optionally reference an invoice and/or a source quote.
List delivery notes.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/delivery-notes?status=dispatched&page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/delivery-notes"
);
const params = {
"status": "dispatched",
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download a CSV of all delivery notes.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/delivery-notes/export" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/delivery-notes/export"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create a delivery note.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/delivery-notes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"client_id\": 3,
\"invoice_id\": 8,
\"source_quote_id\": 5,
\"delivery_date\": \"2026-08-03\",
\"delivery_address\": \"12 High St, London\",
\"carrier\": \"DHL\",
\"received_by\": \"J. Smith\",
\"notes\": \"Leave with reception\",
\"items\": [
{
\"description\": \"Widget box\",
\"quantity\": 5,
\"unit\": \"boxes\"
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/delivery-notes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"client_id": 3,
"invoice_id": 8,
"source_quote_id": 5,
"delivery_date": "2026-08-03",
"delivery_address": "12 High St, London",
"carrier": "DHL",
"received_by": "J. Smith",
"notes": "Leave with reception",
"items": [
{
"description": "Widget box",
"quantity": 5,
"unit": "boxes"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one delivery note (with items).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/delivery-notes/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/delivery-notes/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update a delivery note.
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/delivery-notes/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"client_id\": 16,
\"delivery_date\": \"2026-08-25T07:13:32\",
\"delivery_address\": \"architecto\",
\"carrier\": \"n\",
\"status\": \"delivered\",
\"received_by\": \"g\",
\"notes\": \"architecto\",
\"items\": [
{
\"description\": \"Eius et animi quos velit et.\",
\"quantity\": 60,
\"unit\": \"d\"
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/delivery-notes/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"client_id": 16,
"delivery_date": "2026-08-25T07:13:32",
"delivery_address": "architecto",
"carrier": "n",
"status": "delivered",
"received_by": "g",
"notes": "architecto",
"items": [
{
"description": "Eius et animi quos velit et.",
"quantity": 60,
"unit": "d"
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete a delivery note.
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/delivery-notes/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/delivery-notes/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download the delivery note PDF (binary, not JSON).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/delivery-notes/1/pdf" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/delivery-notes/1/pdf"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Documents — Invoices
Create, list, view, update, delete invoices, download the PDF, and record payments. All scoped to the authenticated user's company. Plan limits (monthly count / value cap / currency) are enforced on create.
List invoices.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/invoices?status=unpaid&page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices"
);
const params = {
"status": "unpaid",
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download a CSV of all invoices.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/invoices/export" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices/export"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create an invoice.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/invoices" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"series_id\": 1,
\"client_id\": 3,
\"issue_date\": \"2026-08-03\",
\"due_date\": \"2026-08-17\",
\"tax_name\": \"VAT\",
\"tax_rate\": 20,
\"terms\": \"Payment within 14 days\",
\"notes\": \"Thanks for your business\",
\"action\": \"sent\",
\"items\": [
{
\"description\": \"Consulting\",
\"quantity\": 2,
\"unit_price\": 75
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"series_id": 1,
"client_id": 3,
"issue_date": "2026-08-03",
"due_date": "2026-08-17",
"tax_name": "VAT",
"tax_rate": 20,
"terms": "Payment within 14 days",
"notes": "Thanks for your business",
"action": "sent",
"items": [
{
"description": "Consulting",
"quantity": 2,
"unit_price": 75
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Example response (403):
{
"status": false,
"message": "You've reached your Free plan limit of 5 invoices this month. Upgrade your plan to create more."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one invoice (with items, payments, and any linked credit/delivery notes).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/invoices/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"invoice": {
"id": 30,
"invoice_number": "INV-0024",
"payments": [
{
"id": 16,
"amount": "16.50",
"payment_date": "2026-08-11",
"receipt_id": 10,
"has_receipt": true
}
],
"credit_notes": [
{
"id": 12,
"credit_note_number": "CN-0001",
"amount": "16.50"
}
],
"delivery_notes": [
{
"id": 5,
"delivery_note_number": "DN-0001"
}
]
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update an invoice (not allowed once it's paid).
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/invoices/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"issue_date\": \"2026-08-25T07:13:32\",
\"due_date\": \"2052-09-17\",
\"tax_rate\": 22,
\"notes\": \"architecto\",
\"items\": [
{
\"description\": \"Eius et animi quos velit et.\",
\"quantity\": 60,
\"unit_price\": 42,
\"service_category\": \"architecto\"
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"issue_date": "2026-08-25T07:13:32",
"due_date": "2052-09-17",
"tax_rate": 22,
"notes": "architecto",
"items": [
{
"description": "Eius et animi quos velit et.",
"quantity": 60,
"unit_price": 42,
"service_category": "architecto"
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete an invoice (not allowed once it's paid).
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/invoices/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download the invoice PDF.
requires authentication
Returns a binary PDF (not JSON).
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/invoices/1/pdf" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices/1/pdf"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Record a payment against an invoice.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/invoices/1/payments" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"amount\": 150,
\"payment_date\": \"2026-08-03\",
\"payment_method\": \"bank_transfer\",
\"bank_info\": \"architecto\",
\"reference_number\": \"TXN-1234\",
\"notes\": \"Paid in full\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices/1/payments"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"amount": 150,
"payment_date": "2026-08-03",
"payment_method": "bank_transfer",
"bank_info": "architecto",
"reference_number": "TXN-1234",
"notes": "Paid in full"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Documents — Next Numbers
The next sequential document number for every document type, in one call — useful for showing a preview before the document is actually created. Read-only: none of these calls increment the underlying counters.
Get the next number for every document type.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/next-numbers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/next-numbers"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"invoice": "INV-0024",
"proforma": "PRO-0012",
"quote": "QUO-0009",
"delivery_note": "DN-0006",
"credit_note": "CN-0002"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Documents — Proformas
Create, list, view, update, delete proformas, download the PDF, and convert a proforma to an invoice. All scoped to the authenticated user's company.
List proformas.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/proformas?status=sent&page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/proformas"
);
const params = {
"status": "sent",
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download a CSV of all proformas.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/proformas/export" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/proformas/export"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create a proforma.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/proformas" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"client_id\": 3,
\"source_quote_id\": 5,
\"issue_date\": \"2026-08-03\",
\"tax_name\": \"VAT\",
\"tax_rate\": 20,
\"terms\": \"Payment due on delivery\",
\"notes\": \"Proforma for advance payment\",
\"action\": \"sent\",
\"items\": [
{
\"description\": \"Widgets\",
\"quantity\": 10,
\"unit_price\": 12.5
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/proformas"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"client_id": 3,
"source_quote_id": 5,
"issue_date": "2026-08-03",
"tax_name": "VAT",
"tax_rate": 20,
"terms": "Payment due on delivery",
"notes": "Proforma for advance payment",
"action": "sent",
"items": [
{
"description": "Widgets",
"quantity": 10,
"unit_price": 12.5
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one proforma (with items).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/proformas/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/proformas/3"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update a proforma (not allowed once converted).
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/proformas/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"client_id\": 16,
\"issue_date\": \"2026-08-25T07:13:32\",
\"tax_name\": \"n\",
\"tax_rate\": 7,
\"terms\": \"architecto\",
\"notes\": \"architecto\",
\"items\": [
{
\"description\": \"Eius et animi quos velit et.\",
\"quantity\": 60,
\"unit_price\": 42
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/proformas/3"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"client_id": 16,
"issue_date": "2026-08-25T07:13:32",
"tax_name": "n",
"tax_rate": 7,
"terms": "architecto",
"notes": "architecto",
"items": [
{
"description": "Eius et animi quos velit et.",
"quantity": 60,
"unit_price": 42
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete a proforma (not allowed once converted).
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/proformas/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/proformas/3"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download the proforma PDF (binary, not JSON).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/proformas/3/pdf" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/proformas/3/pdf"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Convert the proforma to an invoice.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/proformas/3/convert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/proformas/3/convert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Documents — Quotes
Create, list, view, update, delete quotes, download the PDF, and convert a quote to an invoice. All scoped to the authenticated user's company.
List quotes.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/quotes?status=sent&page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/quotes"
);
const params = {
"status": "sent",
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download a CSV of all quotes.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/quotes/export" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/quotes/export"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create a quote.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/quotes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"client_id\": 3,
\"issue_date\": \"2026-08-03\",
\"expiry_date\": \"2026-08-17\",
\"tax_name\": \"VAT\",
\"tax_rate\": 20,
\"terms\": \"Valid for 14 days\",
\"notes\": \"Thanks for the opportunity\",
\"action\": \"sent\",
\"items\": [
{
\"description\": \"Consulting\",
\"quantity\": 2,
\"unit_price\": 75
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/quotes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"client_id": 3,
"issue_date": "2026-08-03",
"expiry_date": "2026-08-17",
"tax_name": "VAT",
"tax_rate": 20,
"terms": "Valid for 14 days",
"notes": "Thanks for the opportunity",
"action": "sent",
"items": [
{
"description": "Consulting",
"quantity": 2,
"unit_price": 75
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one quote (with items, and any proformas/delivery notes converted from it).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/quotes/2" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/quotes/2"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"quote": {
"id": 2,
"quote_number": "QUO-0009",
"proformas": [
{
"id": 12,
"number": "PRO-0012",
"created_at": "2026-08-13T10:00:00Z"
}
],
"delivery_notes": [
{
"id": 6,
"number": "DN-0006",
"created_at": "2026-08-13T10:00:00Z"
}
]
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update a quote (not allowed once converted).
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/quotes/2" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"client_id\": 16,
\"issue_date\": \"2026-08-25T07:13:32\",
\"expiry_date\": \"2052-09-17\",
\"tax_name\": \"n\",
\"tax_rate\": 7,
\"terms\": \"architecto\",
\"notes\": \"architecto\",
\"action\": \"sent\",
\"items\": [
{
\"description\": \"Eius et animi quos velit et.\",
\"quantity\": 60,
\"unit_price\": 42
}
]
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/quotes/2"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"client_id": 16,
"issue_date": "2026-08-25T07:13:32",
"expiry_date": "2052-09-17",
"tax_name": "n",
"tax_rate": 7,
"terms": "architecto",
"notes": "architecto",
"action": "sent",
"items": [
{
"description": "Eius et animi quos velit et.",
"quantity": 60,
"unit_price": 42
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete a quote (not allowed once converted).
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/quotes/2" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/quotes/2"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download the quote PDF (binary, not JSON).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/quotes/2/pdf" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/quotes/2/pdf"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Convert the quote to an invoice.
requires authentication
Uses the company's default invoice series (or the first one) for numbering and currency. Returns the newly created invoice.
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/quotes/2/convert" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/quotes/2/convert"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Documents — Receipts
Receipts are issued for a recorded invoice payment. Each payment can have at most one receipt.
Issue a receipt for an invoice payment.
requires authentication
If the payment already has a receipt, that existing receipt is returned.
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/invoices/1/payments/1/receipt" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/invoices/1/payments/1/receipt"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List issued receipts.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/receipts?page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/receipts"
);
const params = {
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List payments that don't yet have a receipt.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/receipts/pending" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/receipts/pending"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one receipt.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/receipts/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/receipts/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Download the receipt PDF (binary, not JSON).
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/receipts/1/pdf" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/receipts/1/pdf"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Lookups
Reference data used by the app (e.g. the country dropdown on the register and company screens).
List countries.
Public — used to populate the country dropdown at registration (before the user has a token) and on the company screen.
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/countries" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/countries"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"countries": [
{
"id": 232,
"name": "United Kingdom",
"iso2": "GB",
"iso3": "GBR",
"phone_code": "44",
"currency_code": "GBP"
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Lookups — Currencies
The currencies the app supports, for populating currency pickers. Public reference data (no token needed) — safe to cache on the device.
List currencies.
Returns every supported currency with its code, name, symbol and group.
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/currencies" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/currencies"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 300
x-ratelimit-remaining: 299
access-control-allow-origin: *
{
"status": true,
"data": {
"currencies": [
{
"code": "EUR",
"name": "Euro",
"symbol": "€",
"group": "Major Currencies"
},
{
"code": "GBP",
"name": "British Pound",
"symbol": "£",
"group": "Major Currencies"
},
{
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"group": "Major Currencies"
},
{
"code": "CHF",
"name": "Swiss Franc",
"symbol": "Fr",
"group": "Major Currencies"
},
{
"code": "NOK",
"name": "Norwegian Krone",
"symbol": "kr",
"group": "European Currencies"
},
{
"code": "SEK",
"name": "Swedish Krona",
"symbol": "kr",
"group": "European Currencies"
},
{
"code": "DKK",
"name": "Danish Krone",
"symbol": "kr",
"group": "European Currencies"
},
{
"code": "PLN",
"name": "Polish Zloty",
"symbol": "zł",
"group": "European Currencies"
},
{
"code": "CZK",
"name": "Czech Koruna",
"symbol": "Kč",
"group": "European Currencies"
},
{
"code": "HUF",
"name": "Hungarian Forint",
"symbol": "Ft",
"group": "European Currencies"
},
{
"code": "RON",
"name": "Romanian Leu",
"symbol": "lei",
"group": "European Currencies"
},
{
"code": "BAM",
"name": "Bosnia-Herzegovina Convertible Mark",
"symbol": "KM",
"group": "European Currencies"
},
{
"code": "ISK",
"name": "Icelandic Krona",
"symbol": "kr",
"group": "European Currencies"
},
{
"code": "RSD",
"name": "Serbian Dinar",
"symbol": "дин.",
"group": "European Currencies"
},
{
"code": "TRY",
"name": "Turkish Lira",
"symbol": "₺",
"group": "European Currencies"
},
{
"code": "CNY",
"name": "Chinese Yuan",
"symbol": "CN¥",
"group": "Asian Currencies"
},
{
"code": "INR",
"name": "Indian Rupee",
"symbol": "₹",
"group": "Asian Currencies"
},
{
"code": "JPY",
"name": "Japanese Yen",
"symbol": "¥",
"group": "Asian Currencies"
},
{
"code": "KRW",
"name": "South Korean Won",
"symbol": "₩",
"group": "Asian Currencies"
},
{
"code": "IDR",
"name": "Indonesian Rupiah",
"symbol": "Rp",
"group": "Asian Currencies"
},
{
"code": "SAR",
"name": "Saudi Riyal",
"symbol": "SR",
"group": "Asian Currencies"
},
{
"code": "PKR",
"name": "Pakistani Rupee",
"symbol": "Rs",
"group": "Asian Currencies"
},
{
"code": "BDT",
"name": "Bangladeshi Taka",
"symbol": "৳",
"group": "Asian Currencies"
},
{
"code": "PHP",
"name": "Philippine Peso",
"symbol": "₱",
"group": "Asian Currencies"
},
{
"code": "VND",
"name": "Vietnamese Dong",
"symbol": "₫",
"group": "Asian Currencies"
},
{
"code": "NGN",
"name": "Nigerian Naira",
"symbol": "₦",
"group": "African Currencies"
},
{
"code": "EGP",
"name": "Egyptian Pound",
"symbol": "E£",
"group": "African Currencies"
},
{
"code": "ZAR",
"name": "South African Rand",
"symbol": "R",
"group": "African Currencies"
},
{
"code": "MAD",
"name": "Moroccan Dirham",
"symbol": "DH",
"group": "African Currencies"
},
{
"code": "DZD",
"name": "Algerian Dinar",
"symbol": "DA",
"group": "African Currencies"
},
{
"code": "KES",
"name": "Kenyan Shilling",
"symbol": "KSh",
"group": "African Currencies"
},
{
"code": "ETB",
"name": "Ethiopian Birr",
"symbol": "Br",
"group": "African Currencies"
},
{
"code": "GHS",
"name": "Ghanaian Cedi",
"symbol": "₵",
"group": "African Currencies"
},
{
"code": "TZS",
"name": "Tanzanian Shilling",
"symbol": "TSh",
"group": "African Currencies"
},
{
"code": "AOA",
"name": "Angolan Kwanza",
"symbol": "Kz",
"group": "African Currencies"
},
{
"code": "CAD",
"name": "Canadian Dollar",
"symbol": "CA$",
"group": "American Currencies"
},
{
"code": "MXN",
"name": "Mexican Peso",
"symbol": "MX$",
"group": "American Currencies"
},
{
"code": "BRL",
"name": "Brazilian Real",
"symbol": "R$",
"group": "American Currencies"
},
{
"code": "ARS",
"name": "Argentine Peso",
"symbol": "AR$",
"group": "American Currencies"
},
{
"code": "AUD",
"name": "Australian Dollar",
"symbol": "A$",
"group": "Oceania Currencies"
},
{
"code": "NZD",
"name": "New Zealand Dollar",
"symbol": "NZ$",
"group": "Oceania Currencies"
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Lookups — Tax
Suggested tax names and rates for the document forms. Public reference data (no token needed). Both are only suggestions — the user can type any name or rate on the actual document.
List suggested tax names.
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/tax-names" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/tax-names"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"tax_names": [
"VAT",
"GST",
"HST",
"PST",
"Sales Tax",
"IVA",
"TVA",
"MwSt",
"BTW"
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
List suggested tax rates (percentages).
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/tax-rates" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/tax-rates"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"tax_rates": [
0,
5,
7.5,
10,
12.5,
15,
17.5,
20,
21,
23,
25
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Manage — Products
The company's saved products/services (used to fill invoice line items).
List products.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/products?page=1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/products"
);
const params = {
"page": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Create a product.
requires authentication
Example request:
curl --request POST \
"https://invoices.crisfix.com/api/v1/products" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Consulting hour\",
\"description\": \"One hour of consulting\",
\"unit_price\": 75
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/products"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Consulting hour",
"description": "One hour of consulting",
"unit_price": 75
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Get one product.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/products/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/products/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update a product.
requires authentication
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/products/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"b\",
\"description\": \"Eius et animi quos velit et.\",
\"unit_price\": 60
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/products/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "b",
"description": "Eius et animi quos velit et.",
"unit_price": 60
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete a product.
requires authentication
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/products/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/products/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
My Profile
The authenticated user's own account (name, email, password).
Get my profile.
requires authentication
Returns the authenticated user. In a browser (HTML request) this serves the
test console instead; the JSON body is returned when the request sends
Accept: application/json with a bearer token.
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/profile" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/profile"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"user": {
"id": 1,
"name": "Jane Doe",
"email": "jane@example.com"
}
}
}
Example response (401):
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Update my profile.
requires authentication
Updates name and email; include password (with confirmation) to change it, or leave password blank to keep the current one.
Example request:
curl --request PUT \
"https://invoices.crisfix.com/api/v1/profile" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Jane Doe\",
\"email\": \"jane@example.com\",
\"password\": \"newsecret123\",
\"password_confirmation\": \"newsecret123\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/profile"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Jane Doe",
"email": "jane@example.com",
"password": "newsecret123",
"password_confirmation": "newsecret123"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"user": {
"id": 1,
"name": "Jane Doe",
"email": "jane@example.com"
}
}
}
Example response (401):
{
"message": "Unauthenticated."
}
Example response (422):
{
"status": false,
"message": "The email has already been taken.",
"errors": {
"email": [
"The email has already been taken."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Delete my account.
requires authentication
Permanently deletes the user and everything owned by their company (invoices, clients, documents, etc. all cascade). Requires the current password for confirmation. This cannot be undone.
Example request:
curl --request DELETE \
"https://invoices.crisfix.com/api/v1/profile" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"password\": \"secret123\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/profile"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"password": "secret123"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"status": true,
"data": {
"deleted": true
}
}
Example response (422):
{
"status": false,
"message": "The password is incorrect.",
"errors": {
"password": [
"The password is incorrect."
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Reports
Invoice reporting: filter invoices by issue/payment date and status, grouped by currency with per-currency totals. Read-only.
Invoice report.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/reports/invoices?tab=last_month&date_from=2026-01-01&date_to=2026-12-31&paid_from=2026-06-01&paid_to=2026-06-30&status=paid" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"date_from\": \"2026-08-25T07:13:33\",
\"date_to\": \"2026-08-25T07:13:33\",
\"paid_from\": \"2026-08-25T07:13:33\",
\"paid_to\": \"2026-08-25T07:13:33\",
\"status\": \"unpaid\",
\"tab\": \"last_month\"
}"
const url = new URL(
"https://invoices.crisfix.com/api/v1/reports/invoices"
);
const params = {
"tab": "last_month",
"date_from": "2026-01-01",
"date_to": "2026-12-31",
"paid_from": "2026-06-01",
"paid_to": "2026-06-30",
"status": "paid",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"date_from": "2026-08-25T07:13:33",
"date_to": "2026-08-25T07:13:33",
"paid_from": "2026-08-25T07:13:33",
"paid_to": "2026-08-25T07:13:33",
"status": "unpaid",
"tab": "last_month"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
Spending by expense category (supplier bills), grouped by currency.
requires authentication
Example request:
curl --request GET \
--get "https://invoices.crisfix.com/api/v1/reports/spending-by-category?date_from=2026-01-01&date_to=2026-12-31" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://invoices.crisfix.com/api/v1/reports/spending-by-category"
);
const params = {
"date_from": "2026-01-01",
"date_to": "2026-12-31",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
"message": "Unauthenticated."
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.