Billiecart API

SearchAllPaymentsRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/payments

**SearchAllPaymentsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Status	query	string	No

**SearchOperationTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
OrganisationId	form	string	No

**SearchOperationUnTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required
Distinct	form	string	No
Limit	form	int?	No
Offset	form	int?	No
Sort	form	string	No
Filter	form	string	No
Search	form	string	No

**GetOperationUnTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
Embed	form	string	No

**SearchAllPaymentsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Payments	form	List<SearchAllPayment>	No

**SearchOperationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Metadata	form	SearchMetadata	No

**SearchMetadata** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
Limit	form	int	No
Offset	form	int	No
Sort	form	Sorting	No
Filter	form	Filtering	No

**Sorting** Parameters:
Name	Parameter	Data Type	Required	Description
By	form	string	No
Direction	form	SortDirection	No

**SortDirection** Enum:
Ascending
Descending

**Filtering** Parameters:
Name	Parameter	Data Type	Required	Description
Fields	form	List<string>	No
Search	form	string	No

**SearchAllPayment** Parameters:
Name	Parameter	Data Type	Required
Amount	form	decimal	No
BudgetCategory	form	string	No
Status	form	string	No
CustomerFirstName	form	string	No
CustomerLastName	form	string	No
ToAccount	form	BankAccount	No
Id	form	string	No

**BankAccount** Parameters:
Name	Parameter	Data Type	Required	Description
BsbNumber	form	string	No
AccountNumber	form	string	No

**SearchAllPaymentsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Payments	form	List<SearchAllPayment>	No

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

HTTP + JSV

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

GET /payments HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv

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
		}
	},
	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
		}
	}
}