DELETE api/Invoice
Request Information
URI Parameters
None.
Body Parameters
CancellationRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| APIKey | string |
Required |
|
| ClientId | string |
Required |
|
| InvoiceType | CancellationType |
Required |
|
| InvoiceId | globally unique identifier |
Required |
|
| CancellationId | globally unique identifier |
Required |
|
| Reason | CancellationReason |
None. |
Request Formats
application/json, text/json
Sample:
{
"APIKey": "sample string 1",
"ClientId": "sample string 2",
"InvoiceType": 0,
"InvoiceId": "9683e3c5-13e6-435e-8757-21e23bb81f48",
"CancellationId": "caaa84e2-a5c7-4bf1-919e-e51ae74f38d9",
"Reason": 0
}
application/xml, text/xml
Sample:
<CancellationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Invoice"> <APIKey>sample string 1</APIKey> <CancellationId>caaa84e2-a5c7-4bf1-919e-e51ae74f38d9</CancellationId> <ClientId>sample string 2</ClientId> <InvoiceId>9683e3c5-13e6-435e-8757-21e23bb81f48</InvoiceId> <InvoiceType>invoicedetail</InvoiceType> <Reason>eventcancelled</Reason> </CancellationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
APIResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | Status |
None. |
|
| Id | globally unique identifier |
None. |
|
| Description | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": 0,
"Id": "fcc2e2f0-04e0-4304-8dbd-db3f5d5bee60",
"Description": "sample string 2"
}
application/xml, text/xml
Sample:
<APIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Response"> <Description>sample string 2</Description> <Id>fcc2e2f0-04e0-4304-8dbd-db3f5d5bee60</Id> <Status>Success</Status> </APIResponse>