FaxStore

Our Discord

Weblutions Documentation / FaxStore / Invoices API

Invoices API

The Invoices API for FaxStore manages invoice creation, updates, deletion, and retrieval. It streamlines the invoicing process for efficient billing and record-keeping.

Table of Contents

Get All Invoices

GET/api/invoices

Returns all invoices created in an array with an optional filter

Authorization

Name	Type	Required	Description
authorization	String	required

Query parameters

Name	Type	Required	Description
filter	String	optional	Filter invoices for a user, or invoice status. See note below.

Responses

200OKjson

View response body

[
  {
    "id": 39,
    "userId": "183355725132050432",
    "items": "[{"title":"Test 1","url":"","description":"test description 2","price":"2.00","productId":null,"subId":null}]",
    "due": "1700006400000",
    "status": "Cancelled",
    "createdAt": "1699940740527",
    "username": "John Doe",
    "tos": "",
    "memo": "Test memo."
  },
  ...
]

404Not Foundplaintext

View response body

Invoices table not found.

Examples

curl -X GET 'https://api.example.com/api/invoices?filter=example_filter' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/invoices?filter=example_filter', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/invoices?filter=example_filter', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/invoices?filter=example_filter', false, $context);
$data = json_decode($response, true);

Filter notes

The filter can contain a user ID or an invoice status consisting of:

Due
Overdue
Paid
Cancelled

Get Single Invoice

GET/api/invoices/:id

Returns all invoices created in an array with an optional filter.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	An invoice ID.

Responses

200OKjson

View response body

{
  "id": 39,
  "userId": "183355725132050432",
  "items": "[{"title":"Test 1","url":"","description":"test description 2","price":"2.00","productId":null,"subId":null}]",
  "due": "1700006400000",
  "status": "Cancelled",
  "createdAt": "1699940740527",
  "username": "John Doe",
  "tos": "",
  "memo": "Test memo."
}

404Not Foundplaintext

View response body

Invoice not found.

Examples

curl -X GET 'https://api.example.com/api/invoices/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/invoices/123', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/invoices/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/invoices/123', false, $context);
$data = json_decode($response, true);

Create Invoice

POST/api/invoices

Creates an invoice. If due is not present the due date gets set as the current time.

Authorization

Name	Type	Required	Description
authorization	String	required

Request body

Name	Type	Required	Description
userId	String	required	The account ID to assign the invoice to.
username	String	required	The accounts display name for the invoice.
items	String	required	A formatted JSON string for the invoice object. See note below.
due	String	optional	A timestamp of when the invoice is due. Defaults to time of creation.
status	String	optional	The desired status of the invoice. Defaults to 'Due'.
tos	String	optional	An optional set of terms to attach to the invoice.
memo	String	required	An optional memo to attach to the invoice.

Responses

200OKjson

View response body

{
  "id": 44,
  "userId": "183355725132050432",
  "items": "[]",
  "due": "1723782546862",
  "status": "Due",
  "createdAt": "1723782546862",
  "username": "John",
  "tos": "",
  "memo": ""
}

400Bad Requestplaintext

View response body

Missing required body items - userId, username, and items are required.

404Not Foundplaintext

View response body

Invoice not found after creation.

Examples

curl -X POST 'https://api.example.com/api/invoices' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "userId": "123",
  "username": "example_username",
  "items": "example_items",
  "due": "example_due",
  "status": "example_status",
  "tos": "example_tos",
  "memo": "example_memo"
}'

const response = await fetch('https://api.example.com/api/invoices', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "userId": "123",
  "username": "example_username",
  "items": "example_items",
  "due": "example_due",
  "status": "example_status",
  "tos": "example_tos",
  "memo": "example_memo"
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/invoices', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "userId": "123",
    "username": "example_username",
    "items": "example_items",
    "due": "example_due",
    "status": "example_status",
    "tos": "example_tos",
    "memo": "example_memo"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'POST',
    'header' => "Authorization: Bearer YOUR_API_TOKEN\\r\\nContent-Type: application/json",
    'content' => json_encode([
        "userId" => "123",
        "username" => "example_username",
        "items" => "example_items",
        "due" => "example_due",
        "status" => "example_status",
        "tos" => "example_tos",
        "memo" => "example_memo"
    ])
  ]
]);

$response = file_get_contents('https://api.example.com/api/invoices', false, $context);
$data = json_decode($response, true);

Invoice items Object

[{"title": "ITEM_TITLE", "description": "ITEM_DESCRIPTION", "price": "9.50", "productId": null, "subId": null}]

Delete Invoice

DELETE/api/invoices/:id

Deletes the invoice completely. This is not a recommended action. consider cancelling it.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required

Responses

200OKplaintext

View response body

(no content)

404Not Foundjson

View response body

Invoice not found.

Examples

curl -X DELETE 'https://api.example.com/api/invoices/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/invoices/123', {
  "method": "DELETE",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.delete('https://api.example.com/api/invoices/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'DELETE',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/invoices/123', false, $context);
$data = json_decode($response, true);

Document History

Loading version history...