Create a new vendor credit.

curl --request POST \
  --url https://api.example.com/api/vendor-credits \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "vendorId": 1,
  "exchangeRate": 1,
  "vendorCreditNumber": "123456",
  "referenceNo": "123456",
  "vendorCreditDate": "2021-01-01",
  "note": "123456",
  "open": true,
  "warehouseId": 1,
  "branchId": 1,
  "entries": [
    {
      "itemId": 1,
      "quantity": 1,
      "unitPrice": 1,
      "discount": 1,
      "discountType": "percentage",
      "accountId": 1,
      "amount": 1
    }
  ],
  "attachments": [
    {
      "key": "123456"
    }
  ],
  "discount": 1,
  "discountType": "percentage",
  "adjustment": 1
}
'

import requests

url = "https://api.example.com/api/vendor-credits"

payload = {
    "vendorId": 1,
    "exchangeRate": 1,
    "vendorCreditNumber": "123456",
    "referenceNo": "123456",
    "vendorCreditDate": "2021-01-01",
    "note": "123456",
    "open": True,
    "warehouseId": 1,
    "branchId": 1,
    "entries": [
        {
            "itemId": 1,
            "quantity": 1,
            "unitPrice": 1,
            "discount": 1,
            "discountType": "percentage",
            "accountId": 1,
            "amount": 1
        }
    ],
    "attachments": [{ "key": "123456" }],
    "discount": 1,
    "discountType": "percentage",
    "adjustment": 1
}
headers = {
    "Authorization": "<authorization>",
    "organization-id": "<organization-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: '<authorization>',
    'organization-id': '<organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    vendorId: 1,
    exchangeRate: 1,
    vendorCreditNumber: '123456',
    referenceNo: '123456',
    vendorCreditDate: '2021-01-01',
    note: '123456',
    open: true,
    warehouseId: 1,
    branchId: 1,
    entries: [
      {
        itemId: 1,
        quantity: 1,
        unitPrice: 1,
        discount: 1,
        discountType: 'percentage',
        accountId: 1,
        amount: 1
      }
    ],
    attachments: [{key: '123456'}],
    discount: 1,
    discountType: 'percentage',
    adjustment: 1
  })
};

fetch('https://api.example.com/api/vendor-credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/vendor-credits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'vendorId' => 1,
    'exchangeRate' => 1,
    'vendorCreditNumber' => '123456',
    'referenceNo' => '123456',
    'vendorCreditDate' => '2021-01-01',
    'note' => '123456',
    'open' => true,
    'warehouseId' => 1,
    'branchId' => 1,
    'entries' => [
        [
                'itemId' => 1,
                'quantity' => 1,
                'unitPrice' => 1,
                'discount' => 1,
                'discountType' => 'percentage',
                'accountId' => 1,
                'amount' => 1
        ]
    ],
    'attachments' => [
        [
                'key' => '123456'
        ]
    ],
    'discount' => 1,
    'discountType' => 'percentage',
    'adjustment' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json",
    "organization-id: <organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/vendor-credits"

	payload := strings.NewReader("{\n  \"vendorId\": 1,\n  \"exchangeRate\": 1,\n  \"vendorCreditNumber\": \"123456\",\n  \"referenceNo\": \"123456\",\n  \"vendorCreditDate\": \"2021-01-01\",\n  \"note\": \"123456\",\n  \"open\": true,\n  \"warehouseId\": 1,\n  \"branchId\": 1,\n  \"entries\": [\n    {\n      \"itemId\": 1,\n      \"quantity\": 1,\n      \"unitPrice\": 1,\n      \"discount\": 1,\n      \"discountType\": \"percentage\",\n      \"accountId\": 1,\n      \"amount\": 1\n    }\n  ],\n  \"attachments\": [\n    {\n      \"key\": \"123456\"\n    }\n  ],\n  \"discount\": 1,\n  \"discountType\": \"percentage\",\n  \"adjustment\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("organization-id", "<organization-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/vendor-credits")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"vendorId\": 1,\n  \"exchangeRate\": 1,\n  \"vendorCreditNumber\": \"123456\",\n  \"referenceNo\": \"123456\",\n  \"vendorCreditDate\": \"2021-01-01\",\n  \"note\": \"123456\",\n  \"open\": true,\n  \"warehouseId\": 1,\n  \"branchId\": 1,\n  \"entries\": [\n    {\n      \"itemId\": 1,\n      \"quantity\": 1,\n      \"unitPrice\": 1,\n      \"discount\": 1,\n      \"discountType\": \"percentage\",\n      \"accountId\": 1,\n      \"amount\": 1\n    }\n  ],\n  \"attachments\": [\n    {\n      \"key\": \"123456\"\n    }\n  ],\n  \"discount\": 1,\n  \"discountType\": \"percentage\",\n  \"adjustment\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/vendor-credits")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"vendorId\": 1,\n  \"exchangeRate\": 1,\n  \"vendorCreditNumber\": \"123456\",\n  \"referenceNo\": \"123456\",\n  \"vendorCreditDate\": \"2021-01-01\",\n  \"note\": \"123456\",\n  \"open\": true,\n  \"warehouseId\": 1,\n  \"branchId\": 1,\n  \"entries\": [\n    {\n      \"itemId\": 1,\n      \"quantity\": 1,\n      \"unitPrice\": 1,\n      \"discount\": 1,\n      \"discountType\": \"percentage\",\n      \"accountId\": 1,\n      \"amount\": 1\n    }\n  ],\n  \"attachments\": [\n    {\n      \"key\": \"123456\"\n    }\n  ],\n  \"discount\": 1,\n  \"discountType\": \"percentage\",\n  \"adjustment\": 1\n}"

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

POST

api

vendor-credits

Create a new vendor credit.

curl --request POST \
  --url https://api.example.com/api/vendor-credits \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "vendorId": 1,
  "exchangeRate": 1,
  "vendorCreditNumber": "123456",
  "referenceNo": "123456",
  "vendorCreditDate": "2021-01-01",
  "note": "123456",
  "open": true,
  "warehouseId": 1,
  "branchId": 1,
  "entries": [
    {
      "itemId": 1,
      "quantity": 1,
      "unitPrice": 1,
      "discount": 1,
      "discountType": "percentage",
      "accountId": 1,
      "amount": 1
    }
  ],
  "attachments": [
    {
      "key": "123456"
    }
  ],
  "discount": 1,
  "discountType": "percentage",
  "adjustment": 1
}
'

import requests

url = "https://api.example.com/api/vendor-credits"

payload = {
    "vendorId": 1,
    "exchangeRate": 1,
    "vendorCreditNumber": "123456",
    "referenceNo": "123456",
    "vendorCreditDate": "2021-01-01",
    "note": "123456",
    "open": True,
    "warehouseId": 1,
    "branchId": 1,
    "entries": [
        {
            "itemId": 1,
            "quantity": 1,
            "unitPrice": 1,
            "discount": 1,
            "discountType": "percentage",
            "accountId": 1,
            "amount": 1
        }
    ],
    "attachments": [{ "key": "123456" }],
    "discount": 1,
    "discountType": "percentage",
    "adjustment": 1
}
headers = {
    "Authorization": "<authorization>",
    "organization-id": "<organization-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: '<authorization>',
    'organization-id': '<organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    vendorId: 1,
    exchangeRate: 1,
    vendorCreditNumber: '123456',
    referenceNo: '123456',
    vendorCreditDate: '2021-01-01',
    note: '123456',
    open: true,
    warehouseId: 1,
    branchId: 1,
    entries: [
      {
        itemId: 1,
        quantity: 1,
        unitPrice: 1,
        discount: 1,
        discountType: 'percentage',
        accountId: 1,
        amount: 1
      }
    ],
    attachments: [{key: '123456'}],
    discount: 1,
    discountType: 'percentage',
    adjustment: 1
  })
};

fetch('https://api.example.com/api/vendor-credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/vendor-credits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'vendorId' => 1,
    'exchangeRate' => 1,
    'vendorCreditNumber' => '123456',
    'referenceNo' => '123456',
    'vendorCreditDate' => '2021-01-01',
    'note' => '123456',
    'open' => true,
    'warehouseId' => 1,
    'branchId' => 1,
    'entries' => [
        [
                'itemId' => 1,
                'quantity' => 1,
                'unitPrice' => 1,
                'discount' => 1,
                'discountType' => 'percentage',
                'accountId' => 1,
                'amount' => 1
        ]
    ],
    'attachments' => [
        [
                'key' => '123456'
        ]
    ],
    'discount' => 1,
    'discountType' => 'percentage',
    'adjustment' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json",
    "organization-id: <organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/vendor-credits"

	payload := strings.NewReader("{\n  \"vendorId\": 1,\n  \"exchangeRate\": 1,\n  \"vendorCreditNumber\": \"123456\",\n  \"referenceNo\": \"123456\",\n  \"vendorCreditDate\": \"2021-01-01\",\n  \"note\": \"123456\",\n  \"open\": true,\n  \"warehouseId\": 1,\n  \"branchId\": 1,\n  \"entries\": [\n    {\n      \"itemId\": 1,\n      \"quantity\": 1,\n      \"unitPrice\": 1,\n      \"discount\": 1,\n      \"discountType\": \"percentage\",\n      \"accountId\": 1,\n      \"amount\": 1\n    }\n  ],\n  \"attachments\": [\n    {\n      \"key\": \"123456\"\n    }\n  ],\n  \"discount\": 1,\n  \"discountType\": \"percentage\",\n  \"adjustment\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("organization-id", "<organization-id>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/vendor-credits")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"vendorId\": 1,\n  \"exchangeRate\": 1,\n  \"vendorCreditNumber\": \"123456\",\n  \"referenceNo\": \"123456\",\n  \"vendorCreditDate\": \"2021-01-01\",\n  \"note\": \"123456\",\n  \"open\": true,\n  \"warehouseId\": 1,\n  \"branchId\": 1,\n  \"entries\": [\n    {\n      \"itemId\": 1,\n      \"quantity\": 1,\n      \"unitPrice\": 1,\n      \"discount\": 1,\n      \"discountType\": \"percentage\",\n      \"accountId\": 1,\n      \"amount\": 1\n    }\n  ],\n  \"attachments\": [\n    {\n      \"key\": \"123456\"\n    }\n  ],\n  \"discount\": 1,\n  \"discountType\": \"percentage\",\n  \"adjustment\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/vendor-credits")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"vendorId\": 1,\n  \"exchangeRate\": 1,\n  \"vendorCreditNumber\": \"123456\",\n  \"referenceNo\": \"123456\",\n  \"vendorCreditDate\": \"2021-01-01\",\n  \"note\": \"123456\",\n  \"open\": true,\n  \"warehouseId\": 1,\n  \"branchId\": 1,\n  \"entries\": [\n    {\n      \"itemId\": 1,\n      \"quantity\": 1,\n      \"unitPrice\": 1,\n      \"discount\": 1,\n      \"discountType\": \"percentage\",\n      \"accountId\": 1,\n      \"amount\": 1\n    }\n  ],\n  \"attachments\": [\n    {\n      \"key\": \"123456\"\n    }\n  ],\n  \"discount\": 1,\n  \"discountType\": \"percentage\",\n  \"adjustment\": 1\n}"

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

Headers

Authorization

string

required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id

string

required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json

vendorId

number

required

The id of the vendor

Example:

1

exchangeRate

number

required

The exchange rate of the vendor credit

Example:

1

vendorCreditNumber

string

required

The vendor credit number

Example:

"123456"

referenceNo

string

required

The reference number of the vendor credit

Example:

"123456"

vendorCreditDate

string

required

The date of the vendor credit

Example:

"2021-01-01"

note

string

required

The note of the vendor credit

Example:

"123456"

open

boolean

required

The open status of the vendor credit

Example:

true

warehouseId

number

required

The warehouse id of the vendor credit

Example:

1

branchId

number

required

The branch id of the vendor credit

Example:

1

entries

string[]

required

The entries of the vendor credit

Example:

[
  {
    "itemId": 1,
    "quantity": 1,
    "unitPrice": 1,
    "discount": 1,
    "discountType": "percentage",
    "accountId": 1,
    "amount": 1
  }
]

attachments

string[]

required

The attachments of the vendor credit

Example:

[{ "key": "123456" }]

discount

number

required

The discount of the vendor credit

Example:

1

discountType

string

required

The discount type of the vendor credit

Example:

"percentage"

adjustment

number

required

The adjustment of the vendor credit

Example:

1

Response

201 - undefined

Retrieves the vendor credits.Open the given vendor credit.

Get Started

API Reference

Create a new vendor credit.

Headers

Body

Response