DELETE api/Invoice
Request Information
URI Parameters
None.
Body Parameters
CancellationRequestName | 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": "0b802081-3158-4e45-8b18-89f6701597c0", "CancellationId": "acd9ac4e-254b-4a68-9a6f-7c23156d7d1a", "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>acd9ac4e-254b-4a68-9a6f-7c23156d7d1a</CancellationId> <ClientId>sample string 2</ClientId> <InvoiceId>0b802081-3158-4e45-8b18-89f6701597c0</InvoiceId> <InvoiceType>invoicedetail</InvoiceType> <Reason>eventcancelled</Reason> </CancellationRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
APIResponseName | 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": "944d6c90-2f91-4376-8a06-e7e6bc6f6991", "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>944d6c90-2f91-4376-8a06-e7e6bc6f6991</Id> <Status>Success</Status> </APIResponse>