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
namespace Infrastructure.Api.Interfaces.ServiceOperations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ExportPaymentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ExportPaymentRequest() = 
        inherit PutPatchOperationTenanted<ExportPaymentResponse>()

    [<AllowNullLiteral>]
    type PutPatchOperationTenanted<'TResponse>() = 
        inherit PutPatchOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PutPatchOperationUnTenanted<'TResponse>() = 
        interface IPatch
        interface IPut

F# ExportPaymentRequest 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.

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

{"organisationId":"String"}
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"}}}