Requires the role: | manager |
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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
organisationId: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }