Update an APP invoice payment status

Update the payment status of an invoice created in the Access Point Provider integration. The
invoice must already be signed.

PARTIAL may be sent repeatedly until the outstanding balance is settled. A PARTIAL payment that
clears the balance settles the invoice, so the invoice is stored and returned as PAID rather than
PARTIAL, is reported to NRS as PAID with no amount, and is queued for fiscalisation. Sending PAID
against an invoice that is already settled is accepted and changes nothing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Invoice ID on DigiTax

Body Params
string
enum
required

The payment status of the invoice. Requesting PARTIAL settles the invoice to PAID when the payment clears the outstanding balance

Allowed:
string

The reference number of the payment

double

The amount paid in this transaction. Required when payment_status is PARTIAL, and rejected for PAID and REJECTED. PAID settles whatever is still outstanding, so it takes no amount

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json