DELETE api/Invoice

Request Information

URI Parameters

None.

Body Parameters

CancellationRequest
NameDescriptionTypeAdditional information
InvoiceType

CancellationType

Required

InvoiceId

globally unique identifier

Required

CancellationId

globally unique identifier

Required

Reason

CancellationReason

None.

Request Formats

application/json, text/json

Sample:
{
  "InvoiceType": 0,
  "InvoiceId": "52c6c7d3-9942-463b-a172-5f6e18dc515e",
  "CancellationId": "7b789d83-fcb8-4a43-b890-5ecb8d415ee6",
  "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">
  <CancellationId>7b789d83-fcb8-4a43-b890-5ecb8d415ee6</CancellationId>
  <InvoiceId>52c6c7d3-9942-463b-a172-5f6e18dc515e</InvoiceId>
  <InvoiceType>invoicedetail</InvoiceType>
  <Reason>eventcancelled</Reason>
</CancellationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APIResponse
NameDescriptionTypeAdditional information
Status

Status

None.

Id

globally unique identifier

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 0,
  "Id": "b6f014c9-5e91-43d2-b2d4-8f1ded4e1632",
  "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>b6f014c9-5e91-43d2-b2d4-8f1ded4e1632</Id>
  <Status>Success</Status>
</APIResponse>