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": "4fcd17d2-272f-4e8b-8bc5-b6fffd2d8f50",
  "CancellationId": "df0b10ba-1f4c-4dd0-9302-0d53f207eff2",
  "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>df0b10ba-1f4c-4dd0-9302-0d53f207eff2</CancellationId>
  <InvoiceId>4fcd17d2-272f-4e8b-8bc5-b6fffd2d8f50</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": "719c656d-bc8a-49b3-8010-e58bb13eef94",
  "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>719c656d-bc8a-49b3-8010-e58bb13eef94</Id>
  <Status>Success</Status>
</APIResponse>