Method: InvoicesClient#delete_invoice

Defined in:
lib/lockstep_sdk/clients/invoices_client.rb

#delete_invoice(id:) ⇒ Object

Deletes the Invoice referred to by this unique identifier. An Invoice represents a bill sent from one company to another. The creator of the invoice is identified by the ‘CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field. Most invoices are uniquely identified both by a Lockstep Platform ID number and a customer ERP “key” that was generated by the system that originated the invoice. Invoices have a total amount and a due date, and when some payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be different.

Parameters:

  • id (uuid) —

    The unique Lockstep Platform ID number of the invoice to delete; NOT the customer’s ERP key



58
59
60
61
 
# File 'lib/lockstep_sdk/clients/invoices_client.rb', line 58

def delete_invoice(id:)
    path = "/api/v1/Invoices/#{id}"
    @connection.request(:delete, path, nil, nil)
end