Billiecart API

<back to all web services

SearchAllPaymentsRequest

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Payments
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces

        Public Partial Class Filtering
            Public Sub New()
                Fields = New List(Of String)
            End Sub

            Public Overridable Property Fields As List(Of String)
            Public Overridable Property Search As String
        End Class

        Public Partial Class SearchMetadata
            Public Overridable Property Total As Integer
            Public Overridable Property Limit As Integer
            Public Overridable Property Offset As Integer
            Public Overridable Property Sort As Sorting
            Public Overridable Property Filter As Filtering
        End Class

        Public Enum SortDirection
            Ascending
            Descending
        End Enum

        Public Partial Class Sorting
            Public Overridable Property By As String
            Public Overridable Property Direction As SortDirection
        End Class
    End Namespace

    Namespace Application.Interfaces.Resources

        Public Partial Class BankAccount
            Public Overridable Property BsbNumber As String
            Public Overridable Property AccountNumber As String
        End Class

        Public Partial Class SearchAllPayment
            Implements IIdentifiableResource
            Public Overridable Property Amount As Decimal
            Public Overridable Property BudgetCategory As String
            Public Overridable Property Status As String
            Public Overridable Property CustomerFirstName As String
            Public Overridable Property CustomerLastName As String
            Public Overridable Property ToAccount As BankAccount
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class

        Public Partial Class SearchOperationResponse
            Public Overridable Property Metadata As SearchMetadata
        End Class

        Public Partial Class SearchOperationTenanted(Of TResponse)
            Inherits SearchOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class SearchOperationUnTenanted(Of TResponse)
            Inherits GetOperationUnTenanted(Of TResponse)
            Implements IHasSearchOptions
            Public Overridable Property Distinct As String
            Public Overridable Property Limit As Nullable(Of Integer)
            Public Overridable Property Offset As Nullable(Of Integer)
            Public Overridable Property Sort As String
            Public Overridable Property Filter As String
            Public Overridable Property Search As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Payments

        Public Partial Class SearchAllPaymentsRequest
            Inherits SearchOperationTenanted(Of SearchAllPaymentsResponse)
            Public Overridable Property Status As String
        End Class

        Public Partial Class SearchAllPaymentsResponse
            Inherits SearchOperationResponse
            Public Sub New()
                Payments = New List(Of SearchAllPayment)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Payments As List(Of SearchAllPayment)
        End Class
    End Namespace
End Namespace

VB.NET SearchAllPaymentsRequest DTOs

GET /payments 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"}},"payments":[{"amount":0,"budgetCategory":"String","status":"String","customerFirstName":"String","customerLastName":"String","toAccount":{"bsbNumber":"String","accountNumber":"String"},"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}