CopycURL Copied Copy failed

#!/usr/bin/env bash
# Invoice a customer and get paid
#
# Create a customer, write them an invoice, issue it, and record the payment when it arrives, so you
# know what the platform does at each stage of an invoice's life.
#
# Every API call in this blueprint, in order. Each value a call returns is passed to the calls after
# it. A step that happens outside the API is a comment, and any failed call stops the script.

set -euo pipefail

BASE_URL="{{BASE_URL}}"
API_KEY="{{API_KEY}}"

# Sends one request and prints the response body. A failed call prints the API's answer and stops
# the script.
call() {
  local method="$1" path="$2" body="${3:-}" out
  local args=(-sS --fail-with-body -X "$method" "$BASE_URL$path" -H "api-key: $API_KEY")
  if [ -n "$body" ]; then
    args+=(-H "Content-Type: application/json" -d "$body")
  fi
  if ! out=$(curl "${args[@]}"); then
    printf '%s\n' "$out" >&2
    return 1
  fi
  printf '%s' "$out"
}

# Percent-encodes a value for use in a URL.
urlencode() {
  jq -rn --arg value "$1" '$value | @uri'
}

# Phase 1: Set up the customer

# Step 1: Read the merchant id off a sandbox sale
step1=$(call POST "/api/transactions" '{
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
}')
merchantId=$(jq -er '.merchantId | if . == null then error("The response carried no value for merchantId.") else tostring end' <<< "$step1")

# Step 2: Create the customer you are invoicing
body=$(jq -n --arg merchantId "$merchantId" '{
  "merchantId": $merchantId,
  "name": "Jane Doe",
  "isActive": true,
  "contactDetail": {
    "primaryContactName": "Jane Doe",
    "emailAddress": "jane.doe@example.com",
    "phone": "5555550123",
    "addresses": [
      {
        "address1": "100 Main Street",
        "city": "Minneapolis",
        "state": "MN",
        "zip": "55401",
        "isDefault": true
      }
    ]
  }
}')
step2=$(call POST "/api/customers" "$body")
customerId=$(jq -er '.id | if . == null then error("The response carried no value for customerId.") else tostring end' <<< "$step2")

# Phase 2: Write the invoice

# Step 3: Create the invoice as a draft
body=$(jq -n --arg merchantId "$merchantId" --arg customerId "$customerId" '{
  "billerId": $merchantId,
  "billerType": "Merchant",
  "recipientId": $customerId,
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net30",
  "recipientSnapshot": {
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "lineItems": [
    {
      "description": "Website redesign",
      "quantity": 1,
      "unitPrice": 1200.00
    },
    {
      "description": "Managed hosting, monthly",
      "quantity": 12,
      "unitPrice": 25.00
    }
  ]
}')
step3=$(call POST "/api/invoicing/invoices" "$body")
invoiceId=$(jq -er '.id | if . == null then error("The response carried no value for invoiceId.") else tostring end' <<< "$step3")

# Step 4: Issue the invoice
call POST "/api/invoicing/invoices/$(urlencode "$invoiceId")/issue" > /dev/null

# Phase 3: Get paid

# Step 5: Record the payment
call POST "/api/invoicing/invoices/$(urlencode "$invoiceId")/record-payment" '{
  "amount": 1500.00,
  "paymentMethod": "Check",
  "notes": "Check received by mail."
}' > /dev/null

# Step 6: Read the invoice back
call GET "/api/invoicing/invoices/$(urlencode "$invoiceId")" > /dev/null

# Phase 4: Go further

# Step 7: Send the invoice to the customer
# In production you send the invoice rather than recording a payment by hand. The send call runs the
# whole delivery workflow: it issues the invoice if it's still a draft, creates a payment link and a
# view token for the recipient, marks the status Sent, and delivers the notification. That last part
# needs a merchant with a configured email destination, which a fresh sandbox may not have, and it's
# why this flow records a payment as its runnable path instead. Once you have configured delivery,
# call send from your own integration and let the payment link do the collecting.

# Step 8: Download the invoice as a PDF
# Any issued invoice can be rendered as a PDF from the snapshots and lines frozen at issue. Fetch it
# when your customer asks for a copy or when your own records need the document rather than the
# data. The response is the file itself, not JSON.

# Step 9: Offer a payment plan
# A larger invoice can be split into scheduled installments the platform collects against a stored
# payment method. Create the plan on an issued invoice; each installment is applied to the balance
# the same way the payment above was, so the invoice reaches Paid when the last one clears. Payment
# plans, credit notes and recurring invoices each have their own reference pages.

CopyPowerShell Copied Copy failed

# Invoice a customer and get paid
#
# Create a customer, write them an invoice, issue it, and record the payment when it arrives, so you
# know what the platform does at each stage of an invoice's life.
#
# Every API call in this blueprint, in order. Each value a call returns is passed to the calls after
# it. A step that happens outside the API is a comment, and any failed call stops the script.

$ErrorActionPreference = 'Stop'

$baseUrl = '{{BASE_URL}}'
$apiKey = '{{API_KEY}}'

# Sends one request and returns the parsed response body. A failed call stops the script.
function Invoke-BlueprintCall([string] $Method, [string] $Path, [string] $Body) {
    $arguments = @{
        Method  = $Method
        Uri     = $baseUrl + $Path
        Headers = @{ 'api-key' = $apiKey }
    }
    if ($Body) {
        $arguments.ContentType = 'application/json'
        $arguments.Body = [System.Text.Encoding]::UTF8.GetBytes($Body)
    }
    Invoke-RestMethod @arguments
}

# Turns a value read off a response back into the text the API sent. A missing value stops the
# script.
function ConvertTo-CaptureValue($Value, [string] $Name) {
    if ($null -eq $Value) { throw "The response carried no value for $Name." }
    if ($Value -is [datetime] -and $Value.Kind -eq 'Unspecified') { return $Value.ToString('yyyy-MM-ddTHH:mm:ss.FFFFFFF', [cultureinfo]::InvariantCulture) }
    if ($Value -is [datetime]) { return $Value.ToUniversalTime().ToString('o') }
    if ($Value -is [bool]) { return $Value.ToString().ToLowerInvariant() }
    [string]$Value
}

# Phase 1: Set up the customer

# Step 1: Read the merchant id off a sandbox sale
$body = @'
{
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
}
'@
$step1 = Invoke-BlueprintCall -Method 'POST' -Path '/api/transactions' -Body $body
$merchantId = ConvertTo-CaptureValue $step1.merchantId 'merchantId'

# Step 2: Create the customer you are invoicing
$body = @"
{
  "merchantId": $(ConvertTo-Json -InputObject ([string]($merchantId))),
  "name": "Jane Doe",
  "isActive": true,
  "contactDetail": {
    "primaryContactName": "Jane Doe",
    "emailAddress": "jane.doe@example.com",
    "phone": "5555550123",
    "addresses": [
      {
        "address1": "100 Main Street",
        "city": "Minneapolis",
        "state": "MN",
        "zip": "55401",
        "isDefault": true
      }
    ]
  }
}
"@
$step2 = Invoke-BlueprintCall -Method 'POST' -Path '/api/customers' -Body $body
$customerId = ConvertTo-CaptureValue $step2.id 'customerId'

# Phase 2: Write the invoice

# Step 3: Create the invoice as a draft
$body = @"
{
  "billerId": $(ConvertTo-Json -InputObject ([string]($merchantId))),
  "billerType": "Merchant",
  "recipientId": $(ConvertTo-Json -InputObject ([string]($customerId))),
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net30",
  "recipientSnapshot": {
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "lineItems": [
    {
      "description": "Website redesign",
      "quantity": 1,
      "unitPrice": 1200.00
    },
    {
      "description": "Managed hosting, monthly",
      "quantity": 12,
      "unitPrice": 25.00
    }
  ]
}
"@
$step3 = Invoke-BlueprintCall -Method 'POST' -Path '/api/invoicing/invoices' -Body $body
$invoiceId = ConvertTo-CaptureValue $step3.id 'invoiceId'

# Step 4: Issue the invoice
$null = Invoke-BlueprintCall -Method 'POST' -Path "/api/invoicing/invoices/$([uri]::EscapeDataString($invoiceId))/issue"

# Phase 3: Get paid

# Step 5: Record the payment
$body = @'
{
  "amount": 1500.00,
  "paymentMethod": "Check",
  "notes": "Check received by mail."
}
'@
$null = Invoke-BlueprintCall -Method 'POST' -Path "/api/invoicing/invoices/$([uri]::EscapeDataString($invoiceId))/record-payment" -Body $body

# Step 6: Read the invoice back
$null = Invoke-BlueprintCall -Method 'GET' -Path "/api/invoicing/invoices/$([uri]::EscapeDataString($invoiceId))"

# Phase 4: Go further

# Step 7: Send the invoice to the customer
# In production you send the invoice rather than recording a payment by hand. The send call runs the
# whole delivery workflow: it issues the invoice if it's still a draft, creates a payment link and a
# view token for the recipient, marks the status Sent, and delivers the notification. That last part
# needs a merchant with a configured email destination, which a fresh sandbox may not have, and it's
# why this flow records a payment as its runnable path instead. Once you have configured delivery,
# call send from your own integration and let the payment link do the collecting.

# Step 8: Download the invoice as a PDF
# Any issued invoice can be rendered as a PDF from the snapshots and lines frozen at issue. Fetch it
# when your customer asks for a copy or when your own records need the document rather than the
# data. The response is the file itself, not JSON.

# Step 9: Offer a payment plan
# A larger invoice can be split into scheduled installments the platform collects against a stored
# payment method. Create the plan on an issued invoice; each installment is applied to the balance
# the same way the payment above was, so the invoice reaches Paid when the last one clears. Payment
# plans, credit notes and recurring invoices each have their own reference pages.

CopyTypeScript Copied Copy failed

// Invoice a customer and get paid
//
// Create a customer, write them an invoice, issue it, and record the payment when it arrives, so
// you know what the platform does at each stage of an invoice's life.
//
// Every API call in this blueprint, in order. Each value a call returns is passed to the calls
// after it. A step that happens outside the API is a comment, and any failed call stops the script.

export {};

const baseUrl = '{{BASE_URL}}';
const apiKey = '{{API_KEY}}';

// Sends one request and returns the parsed response body. A failed call throws.
async function call(method: string, path: string, body?: unknown): Promise<any> {
  const headers: Record<string, string> = { 'api-key': apiKey };
  if (body !== undefined) {
    headers['Content-Type'] = 'application/json';
  }

  const response = await fetch(baseUrl + path, {
    method,
    headers,
    body: body === undefined ? undefined : JSON.stringify(body),
  });

  const text = await response.text();
  if (!response.ok) {
    throw new Error(`${method} ${path} answered ${response.status}: ${text}`);
  }

  return text ? JSON.parse(text) : null;
}

// Turns a value read off a response into the text the API sent. A missing value throws.
function capture(value: unknown, name: string): string {
  if (value === undefined || value === null) {
    throw new Error(`The response carried no value for ${name}.`);
  }

  return typeof value === 'string' ? value : JSON.stringify(value);
}

// Phase 1: Set up the customer

// Step 1: Read the merchant id off a sandbox sale
const step1 = await call('POST', '/api/transactions', {
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
});
const merchantId = capture(step1.merchantId, 'merchantId');

// Step 2: Create the customer you are invoicing
const step2 = await call('POST', '/api/customers', {
  "merchantId": merchantId,
  "name": "Jane Doe",
  "isActive": true,
  "contactDetail": {
    "primaryContactName": "Jane Doe",
    "emailAddress": "jane.doe@example.com",
    "phone": "5555550123",
    "addresses": [
      {
        "address1": "100 Main Street",
        "city": "Minneapolis",
        "state": "MN",
        "zip": "55401",
        "isDefault": true
      }
    ]
  }
});
const customerId = capture(step2.id, 'customerId');

// Phase 2: Write the invoice

// Step 3: Create the invoice as a draft
const step3 = await call('POST', '/api/invoicing/invoices', {
  "billerId": merchantId,
  "billerType": "Merchant",
  "recipientId": customerId,
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net30",
  "recipientSnapshot": {
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "lineItems": [
    {
      "description": "Website redesign",
      "quantity": 1,
      "unitPrice": 1200.00
    },
    {
      "description": "Managed hosting, monthly",
      "quantity": 12,
      "unitPrice": 25.00
    }
  ]
});
const invoiceId = capture(step3.id, 'invoiceId');

// Step 4: Issue the invoice
await call('POST', `/api/invoicing/invoices/${encodeURIComponent(invoiceId)}/issue`);

// Phase 3: Get paid

// Step 5: Record the payment
await call('POST', `/api/invoicing/invoices/${encodeURIComponent(invoiceId)}/record-payment`, {
  "amount": 1500.00,
  "paymentMethod": "Check",
  "notes": "Check received by mail."
});

// Step 6: Read the invoice back
await call('GET', `/api/invoicing/invoices/${encodeURIComponent(invoiceId)}`);

// Phase 4: Go further

// Step 7: Send the invoice to the customer
// In production you send the invoice rather than recording a payment by hand. The send call runs
// the whole delivery workflow: it issues the invoice if it's still a draft, creates a payment link
// and a view token for the recipient, marks the status Sent, and delivers the notification. That
// last part needs a merchant with a configured email destination, which a fresh sandbox may not
// have, and it's why this flow records a payment as its runnable path instead. Once you have
// configured delivery, call send from your own integration and let the payment link do the
// collecting.

// Step 8: Download the invoice as a PDF
// Any issued invoice can be rendered as a PDF from the snapshots and lines frozen at issue. Fetch
// it when your customer asks for a copy or when your own records need the document rather than the
// data. The response is the file itself, not JSON.

// Step 9: Offer a payment plan
// A larger invoice can be split into scheduled installments the platform collects against a stored
// payment method. Create the plan on an issued invoice; each installment is applied to the balance
// the same way the payment above was, so the invoice reaches Paid when the last one clears. Payment
// plans, credit notes and recurring invoices each have their own reference pages.

CopyC# Copied Copy failed

// Invoice a customer and get paid
//
// Create a customer, write them an invoice, issue it, and record the payment when it arrives, so
// you know what the platform does at each stage of an invoice's life.
//
// Every API call in this blueprint, in order. Each value a call returns is passed to the calls
// after it. A step that happens outside the API is a comment, and any failed call stops the script.

using System.Text;
using System.Text.Json;

var baseUrl = "{{BASE_URL}}";
var apiKey = "{{API_KEY}}";

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("api-key", apiKey);

// Sends one request and returns the parsed response body. A failed call throws.
async Task<JsonElement> CallAsync(string method, string path, string? body = null)
{
    using var request = new HttpRequestMessage(new HttpMethod(method), baseUrl + path);
    if (body is not null)
    {
        request.Content = new StringContent(body, Encoding.UTF8, "application/json");
    }

    using var response = await http.SendAsync(request);
    var json = await response.Content.ReadAsStringAsync();
    if (!response.IsSuccessStatusCode)
    {
        throw new HttpRequestException($"{method} {path} answered {(int)response.StatusCode}: {json}");
    }

    return json.Length == 0 ? default : JsonSerializer.Deserialize<JsonElement>(json);
}

// Turns a value read off a response into the text the API sent. A missing value throws.
static string Capture(JsonElement value, string name) => value.ValueKind switch
{
    JsonValueKind.String => value.GetString()!,
    JsonValueKind.Number or JsonValueKind.True or JsonValueKind.False => value.GetRawText(),
    _ => throw new InvalidOperationException($"The response carried no value for {name}.")
};

// Phase 1: Set up the customer

// Step 1: Read the merchant id off a sandbox sale
var step1 = await CallAsync("POST", "/api/transactions", """
    {
      "transactionType": "Sale",
      "cardData": {
        "cardNumber": "4111111111111111",
        "nameOnCard": "Jane Doe",
        "expirationMonth": 12,
        "expirationYear": 2030,
        "cvv": 123
      },
      "invoiceData": {
        "amounts": { "base": 10.00, "total": 10.00 }
      }
    }
    """);
var merchantId = Capture(step1.GetProperty("merchantId"), "merchantId");

// Step 2: Create the customer you are invoicing
var step2 = await CallAsync("POST", "/api/customers", $$"""
    {
      "merchantId": {{JsonSerializer.Serialize(merchantId)}},
      "name": "Jane Doe",
      "isActive": true,
      "contactDetail": {
        "primaryContactName": "Jane Doe",
        "emailAddress": "jane.doe@example.com",
        "phone": "5555550123",
        "addresses": [
          {
            "address1": "100 Main Street",
            "city": "Minneapolis",
            "state": "MN",
            "zip": "55401",
            "isDefault": true
          }
        ]
      }
    }
    """);
var customerId = Capture(step2.GetProperty("id"), "customerId");

// Phase 2: Write the invoice

// Step 3: Create the invoice as a draft
var step3 = await CallAsync("POST", "/api/invoicing/invoices", $$"""
    {
      "billerId": {{JsonSerializer.Serialize(merchantId)}},
      "billerType": "Merchant",
      "recipientId": {{JsonSerializer.Serialize(customerId)}},
      "recipientType": "Customer",
      "currency": "USD",
      "paymentTermsValue": "Net30",
      "recipientSnapshot": {
        "name": "Jane Doe",
        "email": "jane.doe@example.com"
      },
      "lineItems": [
        {
          "description": "Website redesign",
          "quantity": 1,
          "unitPrice": 1200.00
        },
        {
          "description": "Managed hosting, monthly",
          "quantity": 12,
          "unitPrice": 25.00
        }
      ]
    }
    """);
var invoiceId = Capture(step3.GetProperty("id"), "invoiceId");

// Step 4: Issue the invoice
await CallAsync("POST", $"/api/invoicing/invoices/{Uri.EscapeDataString(invoiceId)}/issue");

// Phase 3: Get paid

// Step 5: Record the payment
await CallAsync("POST", $"/api/invoicing/invoices/{Uri.EscapeDataString(invoiceId)}/record-payment", """
    {
      "amount": 1500.00,
      "paymentMethod": "Check",
      "notes": "Check received by mail."
    }
    """);

// Step 6: Read the invoice back
await CallAsync("GET", $"/api/invoicing/invoices/{Uri.EscapeDataString(invoiceId)}");

// Phase 4: Go further

// Step 7: Send the invoice to the customer
// In production you send the invoice rather than recording a payment by hand. The send call runs
// the whole delivery workflow: it issues the invoice if it's still a draft, creates a payment link
// and a view token for the recipient, marks the status Sent, and delivers the notification. That
// last part needs a merchant with a configured email destination, which a fresh sandbox may not
// have, and it's why this flow records a payment as its runnable path instead. Once you have
// configured delivery, call send from your own integration and let the payment link do the
// collecting.

// Step 8: Download the invoice as a PDF
// Any issued invoice can be rendered as a PDF from the snapshots and lines frozen at issue. Fetch
// it when your customer asks for a copy or when your own records need the document rather than the
// data. The response is the file itself, not JSON.

// Step 9: Offer a payment plan
// A larger invoice can be split into scheduled installments the platform collects against a stored
// payment method. Create the plan on an issued invoice; each installment is applied to the balance
// the same way the payment above was, so the invoice reaches Paid when the last one clears. Payment
// plans, credit notes and recurring invoices each have their own reference pages.

CopyPython Copied Copy failed

# Invoice a customer and get paid
#
# Create a customer, write them an invoice, issue it, and record the payment when it arrives, so you
# know what the platform does at each stage of an invoice's life.
#
# Every API call in this blueprint, in order. Each value a call returns is passed to the calls after
# it. A step that happens outside the API is a comment, and any failed call stops the script.

from urllib.parse import quote

import json
import requests

BASE_URL = "{{BASE_URL}}"
API_KEY = "{{API_KEY}}"


# Sends one request and returns the parsed response body. A failed call raises.
def call(method, path, body=None):
    response = requests.request(
        method,
        BASE_URL + path,
        headers={"api-key": API_KEY},
        json=body,
    )
    response.raise_for_status()
    return response.json() if response.content else None


# Turns a value read off a response into the text the API sent. A missing value raises.
def capture(value, name):
    if value is None:
        raise ValueError(f"The response carried no value for {name}.")
    return value if isinstance(value, str) else json.dumps(value)


# Phase 1: Set up the customer

# Step 1: Read the merchant id off a sandbox sale
step1 = call("POST", "/api/transactions", {
  "transactionType": "Sale",
  "cardData": {
    "cardNumber": "4111111111111111",
    "nameOnCard": "Jane Doe",
    "expirationMonth": 12,
    "expirationYear": 2030,
    "cvv": 123
  },
  "invoiceData": {
    "amounts": { "base": 10.00, "total": 10.00 }
  }
})
merchant_id = capture(step1["merchantId"], "merchantId")

# Step 2: Create the customer you are invoicing
step2 = call("POST", "/api/customers", {
  "merchantId": merchant_id,
  "name": "Jane Doe",
  "isActive": True,
  "contactDetail": {
    "primaryContactName": "Jane Doe",
    "emailAddress": "jane.doe@example.com",
    "phone": "5555550123",
    "addresses": [
      {
        "address1": "100 Main Street",
        "city": "Minneapolis",
        "state": "MN",
        "zip": "55401",
        "isDefault": True
      }
    ]
  }
})
customer_id = capture(step2["id"], "customerId")

# Phase 2: Write the invoice

# Step 3: Create the invoice as a draft
step3 = call("POST", "/api/invoicing/invoices", {
  "billerId": merchant_id,
  "billerType": "Merchant",
  "recipientId": customer_id,
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net30",
  "recipientSnapshot": {
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "lineItems": [
    {
      "description": "Website redesign",
      "quantity": 1,
      "unitPrice": 1200.00
    },
    {
      "description": "Managed hosting, monthly",
      "quantity": 12,
      "unitPrice": 25.00
    }
  ]
})
invoice_id = capture(step3["id"], "invoiceId")

# Step 4: Issue the invoice
call("POST", f"/api/invoicing/invoices/{quote(invoice_id, safe='')}/issue")

# Phase 3: Get paid

# Step 5: Record the payment
call("POST", f"/api/invoicing/invoices/{quote(invoice_id, safe='')}/record-payment", {
  "amount": 1500.00,
  "paymentMethod": "Check",
  "notes": "Check received by mail."
})

# Step 6: Read the invoice back
call("GET", f"/api/invoicing/invoices/{quote(invoice_id, safe='')}")

# Phase 4: Go further

# Step 7: Send the invoice to the customer
# In production you send the invoice rather than recording a payment by hand. The send call runs the
# whole delivery workflow: it issues the invoice if it's still a draft, creates a payment link and a
# view token for the recipient, marks the status Sent, and delivers the notification. That last part
# needs a merchant with a configured email destination, which a fresh sandbox may not have, and it's
# why this flow records a payment as its runnable path instead. Once you have configured delivery,
# call send from your own integration and let the payment link do the collecting.

# Step 8: Download the invoice as a PDF
# Any issued invoice can be rendered as a PDF from the snapshots and lines frozen at issue. Fetch it
# when your customer asks for a copy or when your own records need the document rather than the
# data. The response is the file itself, not JSON.

# Step 9: Offer a payment plan
# A larger invoice can be split into scheduled installments the platform collects against a stored
# payment method. Create the plan on an issued invoice; each installment is applied to the balance
# the same way the payment above was, so the invoice reaches Paid when the last one clears. Payment
# plans, credit notes and recurring invoices each have their own reference pages.