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": "12186b54-b471-4884-983e-582f0cd08abf",
  "CancellationId": "236a0549-334e-40b0-8491-3b89450692ac",
  "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>236a0549-334e-40b0-8491-3b89450692ac</CancellationId>
  <InvoiceId>12186b54-b471-4884-983e-582f0cd08abf</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": "a180bdf0-89f2-40f8-bb2a-196aec020b20",
  "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>a180bdf0-89f2-40f8-bb2a-196aec020b20</Id>
  <Status>Success</Status>
</APIResponse>