Factuarea APIDevelopers
Support
Open app

Register a purchase invoice payment

Record a partial (or total) payment against a purchase invoice and append it to its ledger.

  • Body: amount, paid_on, payment_method, plus the optional bank_account_id, reference and notes.
  • Three invariants are enforced and return 422: the amount must be greater than zero and no larger than the outstanding balance, paid_on must fall between the invoice issue date and today, and a cancelled invoice accepts no payments.
  • Once the accumulated payments cover the total, the invoice settles on its own — you do not need to call mark_paid as well.
  • Returns 201 with the payment just created and a Location header pointing at the ledger.
POST
/purchase_invoices/{purchase_invoice}/payments

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

purchase_invoice*string

Headers

Idempotency-Key?string

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 409 idempotency_key_reused. See the Idempotency guide.

Length1 <= length <= 255
Factuarea-Version?string

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.

Formatdate
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Previous/v1/purchase_invoices/find-by-external-id
POST

Find a purchase invoice by external ID

Look up a single purchase invoice by its external_id (sent in the JSON body), the integration key that maps it to a record in a third-party system (ERP/CRM/e-commerce). Orthogonal to the supplier-provided external_invoice_number (the vendor's fiscal number). Returns the matching purchase invoice or 404 purchase_invoice_not_found if none uses that external_id within your company.

Next/v1/purchase_invoices/{purchase_invoice}/mark_paid
POST

Mark purchase invoice as paid

Record payment of a purchase invoice using the optional paid_on date. When a draft invoice contains stock-managed catalog lines, this transition registers their frozen base quantities as inbound stock exactly once. A pending invoice has already registered them, so marking it as paid never duplicates stock.