POST/api/v1/financial/credits/apply

Apply credit to invoice

Applies client credit to an invoice via FinancialService.applyCreditToInvoice().

RBAC · financial

Request body

Content type: application/json · schema FinancialApplyCreditToInvoiceBody

client_idstring <uuid>Required

invoice_idstring <uuid>Required

requested_amountnumberRequired

≥ 0

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Credit operation completed.

201

Credit operation created a new record.

400

Invalid request payload.

401

API key missing/invalid.

403

financial:update permission denied.

500

Unexpected credit operation failure.

POST /api/v1/financial/credits/apply

cURL

curl -X POST "https://algapsa.com/api/v1/financial/credits/apply" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "01HN2K7VRB9PQ3Y0000000000",
  "invoice_id": "01HN2K7VRB9PQ3Y0000000000",
  "requested_amount": 0
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/financial/credits/apply", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "invoice_id": "01HN2K7VRB9PQ3Y0000000000",
    "requested_amount": 0
  })
});
const data = await response.json();

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

200 OK·application/json

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