Billiecart API

<back to all web services

DeletePaymentRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
DELETE/payments/{Id}

export class DeleteOperationUnTenanted<TResponse> implements IDelete
{

    public constructor(init?: Partial<DeleteOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class DeleteOperationTenanted<TResponse> extends DeleteOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<DeleteOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class DeletePaymentResponse
{
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<DeletePaymentResponse>) { (Object as any).assign(this, init); }
}

export class DeletePaymentRequest extends DeleteOperationTenanted<DeletePaymentResponse>
{
    public id?: string;

    public constructor(init?: Partial<DeletePaymentRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript DeletePaymentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /payments/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}