POST/api/v1/invoices/bulk/credit

Bulk apply invoice credits

Applies the same credit amount to each listed invoice; response includes successes and per-invoice errors.

RBAC · invoice

Request body

Content type: application/json · schema InvoiceBulkCreditBody

invoice_idsarray of stringRequired

min items 1 · max items 100

itemsstring <uuid>

credit_amount_per_invoiceintegerRequired

≥ 0

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Bulk credit operation completed.

400

Invalid bulk credit payload.

401

API key missing/invalid.

403

invoice:bulk_credit permission denied.

500

Unexpected bulk credit failure.

POST /api/v1/invoices/bulk/credit

cURL

curl -X POST "https://algapsa.com/api/v1/invoices/bulk/credit" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "invoice_ids": [
    "01HN2K7VRB9PQ3Y0000000000"
  ],
  "credit_amount_per_invoice": 0
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/invoices/bulk/credit", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "invoice_ids": [
      "01HN2K7VRB9PQ3Y0000000000"
    ],
    "credit_amount_per_invoice": 0
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/invoices/bulk/credit");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""invoice_ids"": [
    ""01HN2K7VRB9PQ3Y0000000000""
  ],
  ""credit_amount_per_invoice"": 0
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

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