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": "10e1adfb-0f26-41fe-a2c1-8d7e01aa8ef7",
  "CancellationId": "379300f9-4538-47a3-8d68-517573fb6697",
  "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>379300f9-4538-47a3-8d68-517573fb6697</CancellationId>
  <InvoiceId>10e1adfb-0f26-41fe-a2c1-8d7e01aa8ef7</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": "4f021870-0b58-4a9c-a788-1a84871d344c",
  "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>4f021870-0b58-4a9c-a788-1a84871d344c</Id>
  <Status>Success</Status>
</APIResponse>