Send invoice

Sends one invoice to provided recipient addresses.

RBAC · invoice

Path parameters

idstring <uuid>Required

Path UUID parameter resolved by ApiBaseController.extractIdFromPath().

Request body

Content type: application/json · schema InvoiceSendBody

email_addressesarray of stringRequired

min items 1

itemsstring <email>

subjectstring

messagestring

include_pdfboolean

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Invoice action succeeded.

201

Invoice action created a new invoice resource.

400

Invalid request payload or query.

401

API key missing/invalid.

403

invoice:send permission denied.

404

Invoice not found.

500

Unexpected invoice action failure.

POST /api/v1/invoices/{id}/send

cURL

curl -X POST "https://algapsa.com/api/v1/invoices/{id}/send" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email_addresses": [
    "user@example.com"
  ],
  "subject": "string",
  "message": "string",
  "include_pdf": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/invoices/{id}/send", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email_addresses": [
      "user@example.com"
    ],
    "subject": "string",
    "message": "string",
    "include_pdf": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/invoices/{id}/send");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""email_addresses"": [
    ""user@example.com""
  ],
  ""subject"": ""string"",
  ""message"": ""string"",
  ""include_pdf"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}