Sales Invoices

Add payment to invoice.

Add payment to invoice.

post/sales-invoices/{uuid}/payments

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/sales-invoices/{uuid}/payments
  • Auth: OAuth 2 (password, token URL https://api.floorworks.co.uk/api/v1/auth)

Path parameters

uuidstring required

UUID of the document

Request body

amountnumber double

Amount

method'CARD' | 'BACS' | 'CASH' | 'CHEQUE' | 'WEB' | 'PAYPAL' | 'ELECTRONIC'

Payment Method

datestring d/m/Y

Payment Date. A backdate can be supplied as well. If omited a current timestamp is applied.

timestring H:i

Payment Time.

detailsstring

Additional details about the payment.

reference_externalstring

Optional reference linking to external document.

Response

Created

total_balancenumber double

Remaining balance of invoice

total_paymentsnumber double

Total amount paid to invoice

status'DRAFT' | 'INVOICED' | 'VOID' | 'PAID' | 'PAID_PARTIALLY'

Current status of invoice

transaction_idstring uuid

Current transaction id

Changes

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