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

Apply credit to invoice

Applies credit amount to one invoice.

RBAC · invoice

Path parameters

idstring <uuid>Required

Path UUID parameter resolved by ApiBaseController.extractIdFromPath().

Request body

Content type: application/json · schema InvoiceCreditBody

credit_amountintegerRequired

≥ 0

transaction_idstring <uuid>

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:credit permission denied.

404

Invoice not found.

500

Unexpected invoice action failure.

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

cURL

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

TypeScript

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

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

200 OK·application/json

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