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": "d63de8c8-3c48-420f-8806-9b3919574263",
"CancellationId": "d113e85f-c6f6-4a31-937b-6fb0a2b60022",
"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>d113e85f-c6f6-4a31-937b-6fb0a2b60022</CancellationId> <ClientId>sample string 2</ClientId> <InvoiceId>d63de8c8-3c48-420f-8806-9b3919574263</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": "471fc4d8-bf48-4662-9274-bd1efd6847fd",
"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>471fc4d8-bf48-4662-9274-bd1efd6847fd</Id> <Status>Success</Status> </APIResponse>