Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
invoices

Record payment for invoice

Records a payment for the invoice. If no payment is due, the invoice is marked as PAID. Otherwise, the invoice is marked as PARTIALLY PAID.

post/v2/invoicing/invoices/{invoice_id}/payments

Path parameters

invoice_idstring required

The ID of the draft invoice to delete.

Request body

type'PAYPAL' | 'EXTERNAL'

The payment type. Can be PayPal or an external payment. Includes cash or a check.

payment_idstring

The ID for a PayPal payment transaction. Required for the PAYPAL payment type.

payment_datestring ppaas_date_notime_v2

The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

payment_date_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

method'BANK_TRANSFER' | 'CASH' | 'CHECK' | 'CREDIT_CARD' | 'DEBIT_CARD' | 'PAYPAL' | 'WIRE_TRANSFER' | 'OTHER' required

The payment mode or method through which the invoicer can accept the payments.

notestring

A note associated with an external cash or check payment.

Response

A successful request returns the HTTP 200 Created status code and a reference to the recorded payment.

payment_idstring

The ID for the invoice payment.