Invoices

Create an invoice

Creates an ad-hoc invoice for a customer. Callers can supply line items, a billing period, purchase order number, and an initial status (draft or issued). Requesting issued releases the invoice for issuance, which completes asynchronously — the response returns the invoice in processing and it settles to issued shortly after, observable via the get-invoice endpoint. Alternatively, pass tax_calculation_id to turn a persisted tax calculation into an invoice: its line items, tax, and buyer are pinned and the invoice is issued synchronously; add a payment and status: paid to record settlement and mark it paid in the same call.

POST

invoices

Create an invoice

curl --request POST \
  --url https://api.alguna.io/invoices \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_period_end": "2023-11-07T05:31:56Z",
  "billing_period_start": "2023-11-07T05:31:56Z",
  "currency": "USD",
  "customer_id": "<string>",
  "description": "<string>",
  "issue_date": "2023-11-07T05:31:56Z",
  "line_items": [
    {
      "quantity": "1",
      "unit_price": "100.00",
      "description": "<string>",
      "product_id": "<string>"
    }
  ],
  "payment": {
    "source": "payment_card",
    "note": "<string>",
    "paid_at": "2023-11-07T05:31:56Z",
    "reference": "<string>"
  },
  "purchase_order_number": "<string>",
  "tax_calculation_id": "<string>"
}
'

import requests

url = "https://api.alguna.io/invoices"

payload = {
    "billing_period_end": "2023-11-07T05:31:56Z",
    "billing_period_start": "2023-11-07T05:31:56Z",
    "currency": "USD",
    "customer_id": "<string>",
    "description": "<string>",
    "issue_date": "2023-11-07T05:31:56Z",
    "line_items": [
        {
            "quantity": "1",
            "unit_price": "100.00",
            "description": "<string>",
            "product_id": "<string>"
        }
    ],
    "payment": {
        "source": "payment_card",
        "note": "<string>",
        "paid_at": "2023-11-07T05:31:56Z",
        "reference": "<string>"
    },
    "purchase_order_number": "<string>",
    "tax_calculation_id": "<string>"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    billing_period_end: '2023-11-07T05:31:56Z',
    billing_period_start: '2023-11-07T05:31:56Z',
    currency: 'USD',
    customer_id: '<string>',
    description: '<string>',
    issue_date: '2023-11-07T05:31:56Z',
    line_items: [
      {
        quantity: '1',
        unit_price: '100.00',
        description: '<string>',
        product_id: '<string>'
      }
    ],
    payment: {
      source: 'payment_card',
      note: '<string>',
      paid_at: '2023-11-07T05:31:56Z',
      reference: '<string>'
    },
    purchase_order_number: '<string>',
    tax_calculation_id: '<string>'
  })
};

fetch('https://api.alguna.io/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alguna.io/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billing_period_end' => '2023-11-07T05:31:56Z',
    'billing_period_start' => '2023-11-07T05:31:56Z',
    'currency' => 'USD',
    'customer_id' => '<string>',
    'description' => '<string>',
    'issue_date' => '2023-11-07T05:31:56Z',
    'line_items' => [
        [
                'quantity' => '1',
                'unit_price' => '100.00',
                'description' => '<string>',
                'product_id' => '<string>'
        ]
    ],
    'payment' => [
        'source' => 'payment_card',
        'note' => '<string>',
        'paid_at' => '2023-11-07T05:31:56Z',
        'reference' => '<string>'
    ],
    'purchase_order_number' => '<string>',
    'tax_calculation_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alguna.io/invoices"

	payload := strings.NewReader("{\n  \"billing_period_end\": \"2023-11-07T05:31:56Z\",\n  \"billing_period_start\": \"2023-11-07T05:31:56Z\",\n  \"currency\": \"USD\",\n  \"customer_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"issue_date\": \"2023-11-07T05:31:56Z\",\n  \"line_items\": [\n    {\n      \"quantity\": \"1\",\n      \"unit_price\": \"100.00\",\n      \"description\": \"<string>\",\n      \"product_id\": \"<string>\"\n    }\n  ],\n  \"payment\": {\n    \"source\": \"payment_card\",\n    \"note\": \"<string>\",\n    \"paid_at\": \"2023-11-07T05:31:56Z\",\n    \"reference\": \"<string>\"\n  },\n  \"purchase_order_number\": \"<string>\",\n  \"tax_calculation_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.alguna.io/invoices")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_period_end\": \"2023-11-07T05:31:56Z\",\n  \"billing_period_start\": \"2023-11-07T05:31:56Z\",\n  \"currency\": \"USD\",\n  \"customer_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"issue_date\": \"2023-11-07T05:31:56Z\",\n  \"line_items\": [\n    {\n      \"quantity\": \"1\",\n      \"unit_price\": \"100.00\",\n      \"description\": \"<string>\",\n      \"product_id\": \"<string>\"\n    }\n  ],\n  \"payment\": {\n    \"source\": \"payment_card\",\n    \"note\": \"<string>\",\n    \"paid_at\": \"2023-11-07T05:31:56Z\",\n    \"reference\": \"<string>\"\n  },\n  \"purchase_order_number\": \"<string>\",\n  \"tax_calculation_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_period_end\": \"2023-11-07T05:31:56Z\",\n  \"billing_period_start\": \"2023-11-07T05:31:56Z\",\n  \"currency\": \"USD\",\n  \"customer_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"issue_date\": \"2023-11-07T05:31:56Z\",\n  \"line_items\": [\n    {\n      \"quantity\": \"1\",\n      \"unit_price\": \"100.00\",\n      \"description\": \"<string>\",\n      \"product_id\": \"<string>\"\n    }\n  ],\n  \"payment\": {\n    \"source\": \"payment_card\",\n    \"note\": \"<string>\",\n    \"paid_at\": \"2023-11-07T05:31:56Z\",\n    \"reference\": \"<string>\"\n  },\n  \"purchase_order_number\": \"<string>\",\n  \"tax_calculation_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "amount_paid": "0.00",
  "amount_remaining": "110.00",
  "billing_period": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "USD",
  "customer_id": "<string>",
  "description": "<string>",
  "id": "<string>",
  "line_items": [
    {
      "description": "<string>",
      "id": "<string>",
      "is_editable": true,
      "quantity": "1",
      "total_price": "100.00",
      "unit_price": "100.00",
      "billing_period_end": "2023-11-07T05:31:56Z",
      "billing_period_start": "2023-11-07T05:31:56Z",
      "product_id": "<string>"
    }
  ],
  "subtotal": "100.00",
  "tax": "10.00",
  "total": "110.00",
  "updated_at": "2023-11-07T05:31:56Z",
  "billing_period_end": "2023-11-07T05:31:56Z",
  "billing_period_start": "2023-11-07T05:31:56Z",
  "due_date": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "external_provider": "<string>",
  "external_reference": "<string>",
  "external_url": "<string>",
  "invoicing_date": "2023-11-07T05:31:56Z",
  "issue_date": "2023-11-07T05:31:56Z",
  "paid_date": "2023-11-07T05:31:56Z",
  "purchase_order_number": "<string>"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

Authorizations

Authorization

string

header

required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version

enum<string>

required

Available options:

2026-04-01

Idempotency-Key

string

A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.

Maximum string length: 255

Example:

"ik_a1b2c3d4e5f6"

Body

application/json

billing_period_end

string<date-time> | null

End of the billing period

billing_period_start

string<date-time> | null

Start of the billing period

currency

string

ISO 4217 currency code; required unless tax_calculation_id is set

Example:

"USD"

customer_id

string

Existing customer to bill. On the tax_calculation_id path, leave empty to mint a guest customer from the calculation's buyer.

description

string | null

Invoice description or memo

issue_date

string<date-time> | null

Date to issue the invoice

line_items

object[]

Line items to include on the invoice

Show child attributes

payment

object | null

Record the customer's already-settled payment and mark the invoice paid in the same call; requires tax_calculation_id

Show child attributes

purchase_order_number

string | null

Purchase order number

status

enum<string> | null

Initial invoice status. Defaults to draft. Setting issued releases the invoice for issuance, which completes asynchronously: the response returns the invoice in processing, and it settles to issued shortly after — poll the get-invoice endpoint to observe the final status. paid is only valid on the tax_calculation_id path and must be sent together with a payment.

Available options:

draft,

issued,

paid

tax_calculation_id

string | null

Id of a persisted tax calculation; its stored line items, tax amounts, and buyer become the invoice, which is issued synchronously with no recalculation. Mutually exclusive with line_items (the calculation supplies them). Leave status unset or set it to issued to issue the invoice; set status to paid together with a payment to also mark it paid.

Response

Success

amount_paid

string

required

Amount that has been paid

Example:

"0.00"

amount_remaining

string

required

Remaining amount due

Example:

"110.00"

billing_period

string

required

Formatted billing period string

created_at

string<date-time>

required

Timestamp when the invoice was created

currency

string

required

ISO 4217 currency code

Example:

"USD"

customer_id

string

required

Customer this invoice belongs to

description

string

required

Invoice description or memo

string

required

Unique identifier for the invoice

line_items

object[]

required

Line items on this invoice

Show child attributes

status

enum<string>

required

Current status of the invoice

Available options:

draft,

upcoming,

pending_approval,

scheduled,

processing,

issued,

void,

paid,

canceled,

overdue

subtotal

string

required

Sum of all line item totals before tax

Example:

"100.00"

tax

string

required

Total tax amount

Example:

"10.00"

total

string

required

Total amount including tax

Example:

"110.00"

updated_at

string<date-time>

required

Timestamp when the invoice was last updated

billing_period_end

string<date-time> | null

End of the billing period

billing_period_start

string<date-time> | null

Start of the billing period

due_date

string<date-time> | null

Date the invoice payment is due

external_id

string

Identifier in the external payment provider

external_provider

string

External payment provider name

external_reference

string

Customer-facing invoice reference number

external_url

string

URL to the invoice in the external system

invoicing_date

string<date-time> | null

Date the invoice is scheduled for processing

issue_date

string<date-time> | null

Date the invoice was issued

paid_date

string<date-time> | null

Date the invoice was paid

purchase_order_number

string | null

Purchase order number

Get an invoiceFetches a single invoice by ID, including all line items, totals, and status.

⌘I

Create an invoice

curl --request POST \
  --url https://api.alguna.io/invoices \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_period_end": "2023-11-07T05:31:56Z",
  "billing_period_start": "2023-11-07T05:31:56Z",
  "currency": "USD",
  "customer_id": "<string>",
  "description": "<string>",
  "issue_date": "2023-11-07T05:31:56Z",
  "line_items": [
    {
      "quantity": "1",
      "unit_price": "100.00",
      "description": "<string>",
      "product_id": "<string>"
    }
  ],
  "payment": {
    "source": "payment_card",
    "note": "<string>",
    "paid_at": "2023-11-07T05:31:56Z",
    "reference": "<string>"
  },
  "purchase_order_number": "<string>",
  "tax_calculation_id": "<string>"
}
'

import requests

url = "https://api.alguna.io/invoices"

payload = {
    "billing_period_end": "2023-11-07T05:31:56Z",
    "billing_period_start": "2023-11-07T05:31:56Z",
    "currency": "USD",
    "customer_id": "<string>",
    "description": "<string>",
    "issue_date": "2023-11-07T05:31:56Z",
    "line_items": [
        {
            "quantity": "1",
            "unit_price": "100.00",
            "description": "<string>",
            "product_id": "<string>"
        }
    ],
    "payment": {
        "source": "payment_card",
        "note": "<string>",
        "paid_at": "2023-11-07T05:31:56Z",
        "reference": "<string>"
    },
    "purchase_order_number": "<string>",
    "tax_calculation_id": "<string>"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    billing_period_end: '2023-11-07T05:31:56Z',
    billing_period_start: '2023-11-07T05:31:56Z',
    currency: 'USD',
    customer_id: '<string>',
    description: '<string>',
    issue_date: '2023-11-07T05:31:56Z',
    line_items: [
      {
        quantity: '1',
        unit_price: '100.00',
        description: '<string>',
        product_id: '<string>'
      }
    ],
    payment: {
      source: 'payment_card',
      note: '<string>',
      paid_at: '2023-11-07T05:31:56Z',
      reference: '<string>'
    },
    purchase_order_number: '<string>',
    tax_calculation_id: '<string>'
  })
};

fetch('https://api.alguna.io/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alguna.io/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billing_period_end' => '2023-11-07T05:31:56Z',
    'billing_period_start' => '2023-11-07T05:31:56Z',
    'currency' => 'USD',
    'customer_id' => '<string>',
    'description' => '<string>',
    'issue_date' => '2023-11-07T05:31:56Z',
    'line_items' => [
        [
                'quantity' => '1',
                'unit_price' => '100.00',
                'description' => '<string>',
                'product_id' => '<string>'
        ]
    ],
    'payment' => [
        'source' => 'payment_card',
        'note' => '<string>',
        'paid_at' => '2023-11-07T05:31:56Z',
        'reference' => '<string>'
    ],
    'purchase_order_number' => '<string>',
    'tax_calculation_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alguna.io/invoices"

	payload := strings.NewReader("{\n  \"billing_period_end\": \"2023-11-07T05:31:56Z\",\n  \"billing_period_start\": \"2023-11-07T05:31:56Z\",\n  \"currency\": \"USD\",\n  \"customer_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"issue_date\": \"2023-11-07T05:31:56Z\",\n  \"line_items\": [\n    {\n      \"quantity\": \"1\",\n      \"unit_price\": \"100.00\",\n      \"description\": \"<string>\",\n      \"product_id\": \"<string>\"\n    }\n  ],\n  \"payment\": {\n    \"source\": \"payment_card\",\n    \"note\": \"<string>\",\n    \"paid_at\": \"2023-11-07T05:31:56Z\",\n    \"reference\": \"<string>\"\n  },\n  \"purchase_order_number\": \"<string>\",\n  \"tax_calculation_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Alguna-Version", "<alguna-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.alguna.io/invoices")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_period_end\": \"2023-11-07T05:31:56Z\",\n  \"billing_period_start\": \"2023-11-07T05:31:56Z\",\n  \"currency\": \"USD\",\n  \"customer_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"issue_date\": \"2023-11-07T05:31:56Z\",\n  \"line_items\": [\n    {\n      \"quantity\": \"1\",\n      \"unit_price\": \"100.00\",\n      \"description\": \"<string>\",\n      \"product_id\": \"<string>\"\n    }\n  ],\n  \"payment\": {\n    \"source\": \"payment_card\",\n    \"note\": \"<string>\",\n    \"paid_at\": \"2023-11-07T05:31:56Z\",\n    \"reference\": \"<string>\"\n  },\n  \"purchase_order_number\": \"<string>\",\n  \"tax_calculation_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_period_end\": \"2023-11-07T05:31:56Z\",\n  \"billing_period_start\": \"2023-11-07T05:31:56Z\",\n  \"currency\": \"USD\",\n  \"customer_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"issue_date\": \"2023-11-07T05:31:56Z\",\n  \"line_items\": [\n    {\n      \"quantity\": \"1\",\n      \"unit_price\": \"100.00\",\n      \"description\": \"<string>\",\n      \"product_id\": \"<string>\"\n    }\n  ],\n  \"payment\": {\n    \"source\": \"payment_card\",\n    \"note\": \"<string>\",\n    \"paid_at\": \"2023-11-07T05:31:56Z\",\n    \"reference\": \"<string>\"\n  },\n  \"purchase_order_number\": \"<string>\",\n  \"tax_calculation_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "amount_paid": "0.00",
  "amount_remaining": "110.00",
  "billing_period": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "USD",
  "customer_id": "<string>",
  "description": "<string>",
  "id": "<string>",
  "line_items": [
    {
      "description": "<string>",
      "id": "<string>",
      "is_editable": true,
      "quantity": "1",
      "total_price": "100.00",
      "unit_price": "100.00",
      "billing_period_end": "2023-11-07T05:31:56Z",
      "billing_period_start": "2023-11-07T05:31:56Z",
      "product_id": "<string>"
    }
  ],
  "subtotal": "100.00",
  "tax": "10.00",
  "total": "110.00",
  "updated_at": "2023-11-07T05:31:56Z",
  "billing_period_end": "2023-11-07T05:31:56Z",
  "billing_period_start": "2023-11-07T05:31:56Z",
  "due_date": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "external_provider": "<string>",
  "external_reference": "<string>",
  "external_url": "<string>",
  "invoicing_date": "2023-11-07T05:31:56Z",
  "issue_date": "2023-11-07T05:31:56Z",
  "paid_date": "2023-11-07T05:31:56Z",
  "purchase_order_number": "<string>"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

API Reference

Examples

API Reference

Create an invoice

Authorizations

Headers

Body

Response