invoices

Credit an invoice and create an editable copy of it

Requires the INVOICE.ONE_OFF.CREATE or INVOICE.CREDIT.CREATE permission.

post/v{version}/invoices/{resourceId}/credit_and_copy

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/invoices/{resourceId}/credit_and_copy
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdstring required

The ID of the resource for which the action is posted.

Headers

x-platform-idstring

Platform ID.

Request body

update_new_invoice_to_finalboolean nullable

Whether to move the newly created copy invoice to FINAL. Defaults to false, leaving the copy editable.

update_credit_invoice_to_finalboolean nullable

Whether to move the credit invoice to FINAL. Defaults to false, leaving the credit invoice editable.

credit_details_source'CURRENT' | 'ORIGINAL'

Source of customer and billing entity information on the credit invoice.

Response

OK

original_invoice_idstring

Resource ID of the original invoice that was credited and copied.

credit_invoice_idstring

Resource ID of the created credit invoice.

new_invoice_idstring

Resource ID of the created copy invoice.

Changes

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