Update Vendor Credit Note

Getting Started

Update Vendor Credit Note

Purpose

To update the creditnote/location detail of your organization.

Request URL

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

Request Method

PUT

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/creditnotes
API return updated creditnote data in json format 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 PUT 'https://live.membroz.com/api/creditnotes/[creditnoteid]'\
--header 'authkey:  XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amountused": 0,
    "status": "active",
    "indentnumber": 2,
    "prefix": "gymme",
    "customerid": "5e9598377fb65a4204aab5a1",
    "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":"5f6dc0fde5e33a695b36e7c9",
    "branchid": "5e954c7b9df11624f81e7859",
    "createdAt": "2020-09-29T05:32:33.329Z",
    "updatedAt": "2020-09-29T05:32:33.329Z",
    "updatedby": "5e954c7b9df11624f81e785b",
    "addedby": "5e954c7b9df11624f81e785b"
}'

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"amountused\": 0,\r\n    \"status\": \"active\",\r\n    \"indentnumber\": 2,\r\n    \"prefix\": \"gymme\",\r\n    \"customerid\": \"5e9598377fb65a4204aab5a1\",\r\n    \"onModelCustomer\": \"Vendor\",\r\n    \"billid\": \"5f6dbec1e5e33a695b36e7b6\",\r\n    \"onModelBill\": \"PurchaseBill\",\r\n    \"reason\": \"Sales Retuen\",\r\n    \"date\": \"2020-09-25T10:03:57.185Z\",\r\n    \"items\": [\r\n        {\r\n            \"tax\": [],\r\n            \"_id\": \"5f6dc0a9e5e33a695b36e7c3\",\r\n            \"item\": null,\r\n            \"crdquantity\": 2,\r\n            \"billquantity\": 5,\r\n            \"cost\": 24000,\r\n            \"discount\": 0,\r\n            \"totalcost\": 48000\r\n        }\r\n    ],\r\n    \"adjustment\": 2000,\r\n    \"amount\": 48000,\r\n    \"notes\": null,\r\n    \"type\": \"vendorcredit\",\r\n    \"applyto\": [\r\n        {\r\n            \"_id\": \"5f6dc0fde5e33a695b36e7c9\",\r\n            \"billid\": \"5f6db483e5e33a695b36e782\",\r\n            \"onModelAdjustedBill\": \"PurchaseBill\",\r\n            \"amount\": 25000\r\n        }\r\n    ],\r\n    \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n    \"createdAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedby\": \"5e954c7b9df11624f81e785b\",\r\n    \"addedby\": \"5e954c7b9df11624f81e785b\"\r\n}");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/creditnotes/[creditnoteid]")
  .method("PUT", body)
  .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 => "PUT",
  CURLOPT_POSTFIELDS =>"{\r\n    \"amountused\": 0,\r\n    \"status\": \"active\",\r\n    \"indentnumber\": 2,\r\n    \"prefix\": \"gymme\",\r\n    \"customerid\": \"5e9598377fb65a4204aab5a1\",\r\n    \"onModelCustomer\": \"Vendor\",\r\n    \"billid\": \"5f6dbec1e5e33a695b36e7b6\",\r\n    \"onModelBill\": \"PurchaseBill\",\r\n    \"reason\": \"Sales Retuen\",\r\n    \"date\": \"2020-09-25T10:03:57.185Z\",\r\n    \"items\": [\r\n        {\r\n            \"tax\": [],\r\n            \"_id\": \"5f6dc0a9e5e33a695b36e7c3\",\r\n            \"item\": null,\r\n            \"crdquantity\": 2,\r\n            \"billquantity\": 5,\r\n            \"cost\": 24000,\r\n            \"discount\": 0,\r\n            \"totalcost\": 48000\r\n        }\r\n    ],\r\n    \"adjustment\": 2000,\r\n    \"amount\": 48000,\r\n    \"notes\": null,\r\n    \"type\": \"vendorcredit\",\r\n    \"applyto\": [\r\n        {\r\n            \"_id\": \"5f6dc0fde5e33a695b36e7c9\",\r\n            \"billid\": \"5f6db483e5e33a695b36e782\",\r\n            \"onModelAdjustedBill\": \"PurchaseBill\",\r\n            \"amount\": 25000\r\n        }\r\n    ],\r\n    \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n    \"createdAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedby\": \"5e954c7b9df11624f81e785b\",\r\n    \"addedby\": \"5e954c7b9df11624f81e785b\"\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    \"amountused\": 0,\r\n    \"status\": \"active\",\r\n    \"indentnumber\": 2,\r\n    \"prefix\": \"gymme\",\r\n    \"customerid\": \"5e9598377fb65a4204aab5a1\",\r\n    \"onModelCustomer\": \"Vendor\",\r\n    \"billid\": \"5f6dbec1e5e33a695b36e7b6\",\r\n    \"onModelBill\": \"PurchaseBill\",\r\n    \"reason\": \"Sales Retuen\",\r\n    \"date\": \"2020-09-25T10:03:57.185Z\",\r\n    \"items\": [\r\n        {\r\n            \"tax\": [],\r\n            \"_id\": \"5f6dc0a9e5e33a695b36e7c3\",\r\n            \"item\": null,\r\n            \"crdquantity\": 2,\r\n            \"billquantity\": 5,\r\n            \"cost\": 24000,\r\n            \"discount\": 0,\r\n            \"totalcost\": 48000\r\n        }\r\n    ],\r\n    \"adjustment\": 2000,\r\n    \"amount\": 48000,\r\n    \"notes\": null,\r\n    \"type\": \"vendorcredit\",\r\n    \"applyto\": [\r\n        {\r\n            \"_id\": \"5f6dc0fde5e33a695b36e7c9\",\r\n            \"billid\": \"5f6db483e5e33a695b36e782\",\r\n            \"onModelAdjustedBill\": \"PurchaseBill\",\r\n            \"amount\": 25000\r\n        }\r\n    ],\r\n    \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n    \"createdAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedby\": \"5e954c7b9df11624f81e785b\",\r\n    \"addedby\": \"5e954c7b9df11624f81e785b\"\r\n}"
headers = {
  'authkey': ' XXXXXXXXXX',
  'Content-Type': 'application/json'
}

response = requests.request("PUT", 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::Put.new(url)
request["authkey"] = " XXXXXXXXXX"
request["Content-Type"] = "application/json"
request.body = "{\r\n    \"amountused\": 0,\r\n    \"status\": \"active\",\r\n    \"indentnumber\": 2,\r\n    \"prefix\": \"gymme\",\r\n    \"customerid\": \"5e9598377fb65a4204aab5a1\",\r\n    \"onModelCustomer\": \"Vendor\",\r\n    \"billid\": \"5f6dbec1e5e33a695b36e7b6\",\r\n    \"onModelBill\": \"PurchaseBill\",\r\n    \"reason\": \"Sales Retuen\",\r\n    \"date\": \"2020-09-25T10:03:57.185Z\",\r\n    \"items\": [\r\n        {\r\n            \"tax\": [],\r\n            \"_id\": \"5f6dc0a9e5e33a695b36e7c3\",\r\n            \"item\": null,\r\n            \"crdquantity\": 2,\r\n            \"billquantity\": 5,\r\n            \"cost\": 24000,\r\n            \"discount\": 0,\r\n            \"totalcost\": 48000\r\n        }\r\n    ],\r\n    \"adjustment\": 2000,\r\n    \"amount\": 48000,\r\n    \"notes\": null,\r\n    \"type\": \"vendorcredit\",\r\n    \"applyto\": [\r\n        {\r\n            \"_id\": \"5f6dc0fde5e33a695b36e7c9\",\r\n            \"billid\": \"5f6db483e5e33a695b36e782\",\r\n            \"onModelAdjustedBill\": \"PurchaseBill\",\r\n            \"amount\": 25000\r\n        }\r\n    ],\r\n    \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n    \"createdAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedby\": \"5e954c7b9df11624f81e785b\",\r\n    \"addedby\": \"5e954c7b9df11624f81e785b\"\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.PUT);
request.AddHeader("authkey", " XXXXXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\r\n    \"amountused\": 0,\r\n    \"status\": \"active\",\r\n    \"indentnumber\": 2,\r\n    \"prefix\": \"gymme\",\r\n    \"customerid\": \"5e9598377fb65a4204aab5a1\",\r\n    \"onModelCustomer\": \"Vendor\",\r\n    \"billid\": \"5f6dbec1e5e33a695b36e7b6\",\r\n    \"onModelBill\": \"PurchaseBill\",\r\n    \"reason\": \"Sales Retuen\",\r\n    \"date\": \"2020-09-25T10:03:57.185Z\",\r\n    \"items\": [\r\n        {\r\n            \"tax\": [],\r\n            \"_id\": \"5f6dc0a9e5e33a695b36e7c3\",\r\n            \"item\": null,\r\n            \"crdquantity\": 2,\r\n            \"billquantity\": 5,\r\n            \"cost\": 24000,\r\n            \"discount\": 0,\r\n            \"totalcost\": 48000\r\n        }\r\n    ],\r\n    \"adjustment\": 2000,\r\n    \"amount\": 48000,\r\n    \"notes\": null,\r\n    \"type\": \"vendorcredit\",\r\n    \"applyto\": [\r\n        {\r\n            \"_id\": \"5f6dc0fde5e33a695b36e7c9\",\r\n            \"billid\": \"5f6db483e5e33a695b36e782\",\r\n            \"onModelAdjustedBill\": \"PurchaseBill\",\r\n            \"amount\": 25000\r\n        }\r\n    ],\r\n    \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n    \"createdAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedAt\": \"2020-09-29T05:32:33.329Z\",\r\n    \"updatedby\": \"5e954c7b9df11624f81e785b\",\r\n    \"addedby\": \"5e954c7b9df11624f81e785b\"\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": "5f72c6f10bb03b46458a6b95",
    "indentnumber": 2,
    "prefix": "gymme",
    "customerid": "5e9598377fb65a4204aab5a1",
    "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": "5f6dc0fde5e33a695b36e7c9",
    "branchid": "5e954c7b9df11624f81e7859",
    "createdAt": "2020-09-29T05:32:33.329Z",
    "updatedAt": "2020-09-29T05:34:30.088Z",
    "updatedby": "5e954c7b9df11624f81e785b",
    "addedby":"5e954c7b9df11624f81e785b",
}