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": "1b41ba3d-ff8f-49b1-8391-a2982ee83765", "CancellationId": "c8d06602-78c9-44b4-9501-a0dbe7969897", "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>c8d06602-78c9-44b4-9501-a0dbe7969897</CancellationId> <ClientId>sample string 2</ClientId> <InvoiceId>1b41ba3d-ff8f-49b1-8391-a2982ee83765</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": "b51b6007-616c-4003-bdf3-949272aa75f9", "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>b51b6007-616c-4003-bdf3-949272aa75f9</Id> <Status>Success</Status> </APIResponse>