POST v1/Invoices/VoidAndRefund
Request Information
URI Parameters
None.
Body Parameters
Common.Dto.Post.VoidAndRefundInvoice| Name | Description | Type | Additional information |
|---|---|---|---|
| invoiceId | integer |
None. |
|
| reference | string |
String length: inclusive between 0 and 500 |
|
| triggeringUserId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"invoiceId": 1,
"reference": "sample string 2",
"triggeringUserId": 3
}
Response Information
Resource Description
Common.Dto.Get.Invoice| Name | Description | Type | Additional information |
|---|---|---|---|
| invoiceNumber | integer |
None. |
|
| invoiceSignature | string |
None. |
|
| poNumber | string |
None. |
|
| effectiveTimestamp | date |
None. |
|
| postedTimestamp | date |
None. |
|
| modifiedTimestamp | date |
None. |
|
| charges | Collection of Common.Dto.Get.InvoiceCharge |
None. |
|
| chargeGroups | Collection of Common.Dto.Get.ChargeGroup |
None. |
|
| subtotal | decimal number |
None. |
|
| invoiceAmount | decimal number |
None. |
|
| totalPayments | decimal number |
None. |
|
| unsettled | boolean |
None. |
|
| outstandingBalance | decimal number |
None. |
|
| terms | string |
None. |
|
| defaultTerms | string |
None. |
|
| isDefaultTerms | boolean |
None. |
|
| customerId | integer |
None. |
|
| invoiceCustomer | Common.Dto.Get.Customer |
None. |
|
| invoiceCustomerAddressPreference | Common.Dto.Get.CustomerAddressPreference |
None. |
|
| sumOfCreditNotes | decimal number |
None. |
|
| totalWriteoffs | decimal number |
None. |
|
| taxes | Collection of Common.Dto.Get.Tax |
None. |
|
| totalDiscount | decimal number |
None. |
|
| paymentSchedules | Collection of Common.Dto.Get.PaymentSchedule |
None. |
|
| notes | string |
None. |
|
| customerReferenceValue | string |
None. |
|
| openingArBalance | decimal number |
None. |
|
| closingArBalance | decimal number |
None. |
|
| invoiceInMemoryOnly | boolean |
None. |
|
| datePaid | date |
None. |
|
| invoiceRevisions | Collection of Common.Dto.Get.InvoiceRevision |
None. |
|
| invoiceAdjustments | Common.Dto.Get.InvoiceAdjustmentCollection |
None. |
|
| invoicePreview | Common.Dto.Get.InvoicePreview |
None. |
|
| additionalInvoicesForPreview | Collection of Common.Dto.Get.InvoicePreview |
None. |
|
| totalTaxes | decimal number |
None. |
|
| isSummarized | boolean |
None. |
|
| rollUpPdf | boolean |
None. |
|
| invoiceSummarizationOption | string |
None. |
|
| salesforceId | string |
None. |
|
| invoiceNetsuite | Common.Dto.Get.InvoiceNetsuite |
None. |
|
| invoiceQuickBooksOnline | Common.Dto.Get.InvoiceQuickBooksOnline |
None. |
|
| childCharges | Collection of Common.Dto.Get.InvoiceChildChargeSummary |
None. |
|
| childChargeTotals | Common.Dto.Get.ChildChargeSummary |
None. |
|
| parentSummary | Common.Dto.Get.ParentChargeSummary |
None. |
|
| canReverseAll | boolean |
None. |
|
| isTermsEditableFromPaymentScheduleDates | boolean |
None. |
|
| surchargingFee | decimal number |
None. |
|
| hideOnSSP | boolean |
None. |
|
| referenceDate | date |
None. |
|
| sageIntacctId | integer |
None. |
|
| sageIntacctAttemptNumber | integer |
None. |
|
| showInvoiceWatermark | boolean |
None. |
|
| id | integer |
None. |
|
| uri | string |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.