Requires the role: | manager |
GET | /payments/{Id} |
---|
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.Resources
Namespace Global
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 Payment
Implements IIdentifiableResource
Public Overridable Property SalaryPackageId As String
Public Overridable Property Amount As Decimal
Public Overridable Property GstAmount As Decimal
Public Overridable Property Particulars As String
Public Overridable Property BudgetCategory As String
Public Overridable Property Status 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 GetOperationTenanted(Of TResponse)
Inherits GetOperationUnTenanted(Of TResponse)
Implements ITenantedRequest
Public Overridable Property OrganisationId As String
End Class
Public Partial Class GetOperationUnTenanted(Of TResponse)
Implements IHasGetOptions
Implements IGet
Public Overridable Property Embed As String
End Class
End Namespace
Namespace Infrastructure.Api.Interfaces.ServiceOperations.Payments
Public Partial Class GetPaymentRequest
Inherits GetOperationTenanted(Of GetPaymentResponse)
Public Overridable Property Id As String
End Class
Public Partial Class GetPaymentResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property Payment As Payment
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /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"}},"payment":{"salaryPackageId":"String","amount":0,"gstAmount":0,"particulars":"String","budgetCategory":"String","status":"String","toAccount":{"bsbNumber":"String","accountNumber":"String"},"id":"String"}}