Get Sales Bills

Get Sales Bills

Purpose

To get the billing/Location of your Organization.

Billing API accept post request with filter conditions. Response include filter  billings array with matching conditions.

API return JSON array of billings.

Request URL

https://live.membroz.com/api/billings/filter

Request Method

POST
Note
  • Send authkey in https header
  • You must use only Field API names in the input. You can obtain the field API names from Fields metadata API
  • Enterprise customer can replace domain name with their hosting Url. for example https://app.xyz.com/api/billings
  • API will return matching records in array or error message.

Request JSON

Attribute Data Type Mandatory Description
search Array yes Add search fields to filter out return data.
Example: { "search":[{ "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datattype": "text" }]}
Only status = "active" records will return
select Array Add select fields to restrict return data schema.
Example: Example: { "fieldname": "branchname", "value": 1 }
Only branchname will return
sort object Sort return array based on sort input
Example: { "branchname" : 1}
limit number limit return array size
Example: limit: 10
only 10 records will return in the array

Sample Request

curl --location --request POST 'https://live.membroz.com/api/billings/filter' \
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "search": [
         { "searchfield": "status", "searchvalue": "Paid", "criteria": "eq", "datatype": "text" }
    ]
}'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \r\n    \"search\": [\r\n         { \"searchfield\": \"status\", \"searchvalue\": \"Paid\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/billings/filter")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/billings/filter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{ \r\n    \"search\": [\r\n         { \"searchfield\": \"status\", \"searchvalue\": \"Paid\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXXXXX",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://live.membroz.com/api/billings/filter"

payload = "{ \r\n    \"search\": [\r\n         { \"searchfield\": \"status\", \"searchvalue\": \"Paid\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}"
headers = {
  'authkey': 'XXXXXXXXXX',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/billings/filter")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authkey"] = "XXXXXXXXXX"
request["Content-Type"] = "application/json"
request.body = "{ \r\n    \"search\": [\r\n         { \"searchfield\": \"status\", \"searchvalue\": \"Paid\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://live.membroz.com/api/billings/filter");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authkey", "XXXXXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{ \r\n    \"search\": [\r\n         { \"searchfield\": \"status\", \"searchvalue\": \"Paid\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Possible Errors

HTTP Status Error Code Message Reason
permission denied 403 You do not have permission

Sample Response

  {
        "_id": "5f717107d0835e0aac69e197",
        "customerid":  "5f5f12d50cc8296e56de6262",
        "onModel": "Member",
        "items": "5f5f44270cc8296e56de63de",
        "preparedby": {
            "_id": "5f5f0f680cc8296e56de6244",
            "isfirstlogin": false,
            "status": "active",
            "username": "khushi33@gmail.com",
            "password": "$2a$10$gcRox5itzG1iSFgLsguP8eI5Xg/Aya1rJf6vZNa6mwzbufRtMgcPW",
            "role": "5dd37f876c98a22df08b9509",
            "anroiddevices": [],
            "iosdevices": [],
            "designationid": "5c9a0e1112b3f913dc5ab3ba",
            "branchid": "5f5f0f680cc8296e56de6242",
            "property": {
                "fullname": "khushi",
                "mobile_number": "7546987654",
                "email": "khushi33@gmail.com",
                "country": "India",
                "membrozid": "5f5f0f680cc8296e56de6242",
                "isadmin": true
            },
            "createdAt": "2020-09-14T06:36:24.824Z",
            "updatedAt": "2020-09-14T06:44:39.664Z",
            "fullname": "khushi ",
            "namenumber": "khushi  | 7546987654",
            "updatedby": "5a2cbf23ee5c2a1080793272",
            "addedby": "5a2cbf23ee5c2a1080793272"
        },
        "addedby":"5f5f0f680cc8296e56de6244",
    },