APapaleo
InvoiceAction

Marks an invoice as paid.

Settles the invoice, if the invoice has an amount to be paid (total != 0).<br>You must have this scope: 'invoices.manage'.<br>For fine-grained clients, you must have this permission: 'core.invoice_actions.pay'.

put/finance/v1/invoice-actions/{id}/pay

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/finance/v1/invoice-actions/{id}/pay
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: invoices.manage, admin

Path parameters

idstring required

The invoice ID

Request body

paymentMethod'Cash' | 'BankTransfer' | 'CreditCard' | 'Amex' | 'VisaCredit' | 'VisaDebit' | 'MasterCard' | 'MasterCardDebit' | 'Maestro' | 'GiroCard' | 'DiscoverCard' | 'Diners' | 'Jcb' | 'BookingCom' | 'VPay' | 'PayPal' | 'Postcard' | 'Reka' | 'Twint' | 'Lunchcheck' | 'Voucher' | 'ChinaUnionPay' | 'Other' | 'Cheque' | 'Airbnb' | 'HolidayCheck' | 'Representation' | 'IDeal' required

The payment method used for paying the invoice. Used for accounting.

receiptstring required

The receipt for the payment. Each transaction in accounting has a receipt set.

Example request

{
  "paymentMethod": "BankTransfer",
  "receipt": "BANK-123456"
}

Response

Invoice marked as paid.

Changes

No recorded changes to this operation across all 3 revisions of this API.