PUT/api/v1/invoices/{id}

Update invoice

Updates an invoice using ApiBaseController.update().

RBAC · invoice

Path parameters

idstring <uuid>Required

Path UUID parameter resolved by ApiBaseController.extractIdFromPath().

Request body

Content type: application/json · schema InvoiceUpdateBody

client_idstring <uuid>

invoice_datestring

due_datestring

subtotalinteger

≥ 0

taxinteger

≥ 0

total_amountinteger

≥ 0

statusstring

Enum: draftsentpaidoverduecancelledpendingprepaymentpartially_applied

credit_appliedinteger

≥ 0

is_manualboolean

is_prepaymentboolean

itemsarray of object

itemsobject

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Invoice operation succeeded.

400

Invalid id or payload.

401

API key missing/invalid.

403

invoice:update permission denied.

404

Invoice not found.

500

Unexpected invoice operation failure.

PUT /api/v1/invoices/{id}

cURL

curl -X PUT "https://algapsa.com/api/v1/invoices/{id}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "01HN2K7VRB9PQ3Y0000000000",
  "invoice_date": "string",
  "due_date": "string",
  "subtotal": 0,
  "tax": 0,
  "total_amount": 0,
  "status": "draft",
  "credit_applied": 0,
  "is_manual": false,
  "is_prepayment": false,
  "items": [
    {}
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/invoices/{id}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "invoice_date": "string",
    "due_date": "string",
    "subtotal": 0,
    "tax": 0,
    "total_amount": 0,
    "status": "draft",
    "credit_applied": 0,
    "is_manual": false,
    "is_prepayment": false,
    "items": [
      {}
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/invoices/{id}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""client_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""invoice_date"": ""string"",
  ""due_date"": ""string"",
  ""subtotal"": 0,
  ""tax"": 0,
  ""total_amount"": 0,
  ""status"": ""draft"",
  ""credit_applied"": 0,
  ""is_manual"": false,
  ""is_prepayment"": false,
  ""items"": [
    {}
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

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