Purchase Invoices

Register an expense payment

Record a partial or total payment against an expense and append it to its ledger; returns 201 with a Location header.

  • Returns 422 if amount is zero or above the balance, paid_on is future, or the expense is cancelled.
  • When payments cover the total the expense settles on its own; no mark_paid call is needed.
post/companies/{company}/purchase-invoices/{purchase_invoice}/payments

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/purchase-invoices/{purchase_invoice}/payments
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

purchase_invoicestring uuid required

Public identifier (UUID v7) of the purchase invoice.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

amountnumber required
paid_onstring date required
payment_methodstring required
bank_account_idinteger nullable
referencestring nullable
notesstring nullable

Response

The newly registered purchase-invoice payment.

Example response

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8e02",
    "amount": "200.00",
    "paid_date": "2026-03-16",
    "payment_method": "bank_transfer",
    "reference": "TRF-PROV-2026-0007",
    "notes": "Primer pago parcial."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.