Billiecart API

<back to all web services

ExportPaymentRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT/payments/export

export class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{

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

export class PutPatchOperationTenanted<TResponse> extends PutPatchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export class ExportPaymentResponse
{
    public responseStatus?: ResponseStatus;

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

export class ExportPaymentRequest extends PutPatchOperationTenanted<ExportPaymentResponse>
{

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

TypeScript ExportPaymentRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /payments/export HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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