Get Specific Vendor Credit Note

Getting Started

Get Specific Vendor Credit Note

Purpose

To get the specific creditnote of your organization.

Request URL

https://live.membroz.com/api/creditnotes/[creditnoteid]

Request Method

GET

Note

Send authkey in https header
Enterprise customer can replace domain name with their hosting Url. for example https://app.xyz.com/api/creditnotes
API return matching creditnote data or return error message.

Request JSON

Attribute	Data Type	Mandatory	Description
CREDITNOTEID	String	Yes	The record ID of the creditnote you want to update. it is pass in request /api/creditnotes/[creditnoteid]

Sample Request

curl --location --request GET 'https://live.membroz.com/api/creditnotes/[creditnoteid]'\
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "search": [
        { "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datatype": "text" }
    ]
}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/creditnotes/[creditnoteid]")
  .method("GET", null)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

 "https://live.membroz.com/api/creditnotes/[creditnoteid]",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS =>"{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"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/creditnotes/[creditnoteid]"

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

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

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

require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/creditnotes/[creditnoteid]")

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

request = Net::HTTP::Get.new(url)
request["authkey"] = "XXXXXXXXXX"
request["Content-Type"] = "application/json"
request.body = "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"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/creditnotes/[creditnoteid]");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("authkey", "XXXXXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"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

{
    "amountused": 0,
    "status": "active",
    "_id": "5f71c304d866c63ee338daaa",
    "indentnumber": 1,
    "prefix": "gymme",
    "customerid": null,
    "onModelCustomer": "Vendor",
    "billid": "5f6dbec1e5e33a695b36e7b6",
    "onModelBill": "PurchaseBill",
    "reason": "Sales Retuen",
    "date": "2020-09-25T10:03:57.185Z",
    "items": [
        {
            "tax": [],
            "_id": "5f6dc0a9e5e33a695b36e7c3",
            "item": null,
            "crdquantity": 2,
            "billquantity": 5,
            "cost": 24000,
            "discount": 0,
            "totalcost": 48000
        }
    ],
    "adjustment": 2000,
    "amount": 48000,
    "notes": null,
    "type": "vendorcredit",
    "applyto": [
        {
            "_id": "5f6dc0fde5e33a695b36e7c9",
            "billid": "5f6db483e5e33a695b36e782",
            "onModelAdjustedBill": "PurchaseBill",
            "amount": 25000
        }
    ],
    "branchid": "5e954c7b9df11624f81e7859",
    "createdAt": "2020-09-28T11:03:32.386Z",
    "updatedAt": "2020-09-28T11:04:59.036Z",
    "updatedby": "5e954c7b9df11624f81e785b",
    "addedby": "5e954c7b9df11624f81e785b",
}