Create Credit Note
Create a credit note against an invoice
curl --request POST \
--url https://api.getmeasure.com/api/v1/companies/{company_id}/credit_notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"adjusted_invoice_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"effective_date": "2023-11-07T05:31:56Z",
"existing_invoice_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"internal_reason": "<string>",
"invoice_uuid": "<string>",
"line_items": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"line_item_id": "<string>"
}
],
"subtotal_credit_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"total_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"total_amount_excluding_taxes": {
"currency": "<string>",
"value_in_cents": 123
},
"internal_note": "<string>",
"name": "<string>",
"note": "<string>",
"refund_options": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"existing_transaction_id": "<string>"
}
]
}
'import requests
url = "https://api.getmeasure.com/api/v1/companies/{company_id}/credit_notes"
payload = {
"adjusted_invoice_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"effective_date": "2023-11-07T05:31:56Z",
"existing_invoice_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"internal_reason": "<string>",
"invoice_uuid": "<string>",
"line_items": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"line_item_id": "<string>"
}
],
"subtotal_credit_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"total_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"total_amount_excluding_taxes": {
"currency": "<string>",
"value_in_cents": 123
},
"internal_note": "<string>",
"name": "<string>",
"note": "<string>",
"refund_options": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"existing_transaction_id": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adjusted_invoice_amount: {currency: '<string>', value_in_cents: 123},
effective_date: '2023-11-07T05:31:56Z',
existing_invoice_amount: {currency: '<string>', value_in_cents: 123},
internal_reason: '<string>',
invoice_uuid: '<string>',
line_items: [
{amount: {currency: '<string>', value_in_cents: 123}, line_item_id: '<string>'}
],
subtotal_credit_amount: {currency: '<string>', value_in_cents: 123},
total_amount: {currency: '<string>', value_in_cents: 123},
total_amount_excluding_taxes: {currency: '<string>', value_in_cents: 123},
internal_note: '<string>',
name: '<string>',
note: '<string>',
refund_options: [
{
amount: {currency: '<string>', value_in_cents: 123},
existing_transaction_id: '<string>'
}
]
})
};
fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/credit_notes', 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.getmeasure.com/api/v1/companies/{company_id}/credit_notes",
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([
'adjusted_invoice_amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'effective_date' => '2023-11-07T05:31:56Z',
'existing_invoice_amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'internal_reason' => '<string>',
'invoice_uuid' => '<string>',
'line_items' => [
[
'amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'line_item_id' => '<string>'
]
],
'subtotal_credit_amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'total_amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'total_amount_excluding_taxes' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'internal_note' => '<string>',
'name' => '<string>',
'note' => '<string>',
'refund_options' => [
[
'amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'existing_transaction_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.getmeasure.com/api/v1/companies/{company_id}/credit_notes"
payload := strings.NewReader("{\n \"adjusted_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"existing_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_reason\": \"<string>\",\n \"invoice_uuid\": \"<string>\",\n \"line_items\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"line_item_id\": \"<string>\"\n }\n ],\n \"subtotal_credit_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount_excluding_taxes\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_note\": \"<string>\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"refund_options\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"existing_transaction_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.getmeasure.com/api/v1/companies/{company_id}/credit_notes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"adjusted_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"existing_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_reason\": \"<string>\",\n \"invoice_uuid\": \"<string>\",\n \"line_items\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"line_item_id\": \"<string>\"\n }\n ],\n \"subtotal_credit_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount_excluding_taxes\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_note\": \"<string>\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"refund_options\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"existing_transaction_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/credit_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"adjusted_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"existing_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_reason\": \"<string>\",\n \"invoice_uuid\": \"<string>\",\n \"line_items\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"line_item_id\": \"<string>\"\n }\n ],\n \"subtotal_credit_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount_excluding_taxes\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_note\": \"<string>\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"refund_options\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"existing_transaction_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"customer": {
"email": "<string>",
"id": "<string>",
"identifier": "<string>",
"name": "<string>",
"org_name": "<string>",
"parent_customer": "<unknown>",
"parent_customer_id": "<string>"
},
"customer_id": "<string>",
"effective_date": "2023-11-07T05:31:56Z",
"id": "<string>",
"internal_note": "<string>",
"internal_reason": "<string>",
"invoice": {
"auto_charges": true,
"billed_customer": {
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"country": "US",
"place_id": "<string>",
"state": "<string>",
"zip": "<string>"
},
"arr": {
"currency": "<string>",
"value_in_cents": 123
},
"billing_emails": [
"<string>"
],
"company_id": "<string>",
"computed_entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"inherited_from_id": "<string>",
"inherited_from_type": "<string>",
"key": "<string>",
"name": "<string>",
"original_value": "<unknown>",
"overridden": true,
"type": "<string>",
"value": "<unknown>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"customer_integration_metadata": {},
"display_name": "<string>",
"email": "<string>",
"exclude_from_metrics": true,
"id": "<string>",
"identifier": "<string>",
"integration_references": [
{
"integration_icon": "<string>",
"integration_id": "<string>",
"integration_key": "<string>",
"integration_name": "<string>",
"reference_type": "<string>",
"remote_id": "<string>",
"remote_type": "<string>"
}
],
"locale": "<string>",
"managed_externally": true,
"metadata": {},
"mrr": {
"currency": "<string>",
"value_in_cents": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": "<string>",
"parent_customer_id": "<string>",
"phone": "<string>",
"status": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"billed_customer_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"customer": {
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"country": "US",
"place_id": "<string>",
"state": "<string>",
"zip": "<string>"
},
"arr": {
"currency": "<string>",
"value_in_cents": 123
},
"billing_emails": [
"<string>"
],
"company_id": "<string>",
"computed_entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"inherited_from_id": "<string>",
"inherited_from_type": "<string>",
"key": "<string>",
"name": "<string>",
"original_value": "<unknown>",
"overridden": true,
"type": "<string>",
"value": "<unknown>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"customer_integration_metadata": {},
"display_name": "<string>",
"email": "<string>",
"exclude_from_metrics": true,
"id": "<string>",
"identifier": "<string>",
"integration_references": [
{
"integration_icon": "<string>",
"integration_id": "<string>",
"integration_key": "<string>",
"integration_name": "<string>",
"reference_type": "<string>",
"remote_id": "<string>",
"remote_type": "<string>"
}
],
"locale": "<string>",
"managed_externally": true,
"metadata": {},
"mrr": {
"currency": "<string>",
"value_in_cents": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": "<string>",
"parent_customer_id": "<string>",
"phone": "<string>",
"status": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"customer_id": "<string>",
"due": {
"currency": "<string>",
"value_in_cents": 123
},
"due_date": "2023-11-07T05:31:56Z",
"hosted_link": "<string>",
"invoice_date": "2023-11-07T05:31:56Z",
"name": "<string>",
"number": "<string>",
"paid": {
"currency": "<string>",
"value_in_cents": 123
},
"paid_date": "2023-11-07T05:31:56Z",
"pdf_link": "<string>",
"prorated_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"revenue": {
"currency": "<string>",
"value_in_cents": 123
},
"status": "<string>",
"sub_total": {
"currency": "<string>",
"value_in_cents": 123
},
"subscription_id": "<string>",
"total": {
"currency": "<string>",
"value_in_cents": 123
},
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"invoice_uuid": "<string>",
"line_items": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"line_item_id": "<string>"
}
],
"name": "<string>",
"note": "<string>",
"refund_options": {
"items": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"existing_transaction_id": "<string>",
"new_credit_id": "<string>",
"new_refund_transaction_id": "<string>",
"refund_type": "<string>"
}
]
},
"total": {
"currency": "<string>",
"value_in_cents": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The idempotency key that will be used to ensure the request is only performed once
Path Parameters
The company ID with the prefix 'cmp_'.
Body
New adjusted invoice amount after applying current credit note
Show child attributes
Show child attributes
Invoice amount after applying existing credit notes
Show child attributes
Show child attributes
Internal reason for the credit note. This reason will not be visible to the customer
UUID of the invoice to attach the credit note
Show child attributes
Show child attributes
The amount which has value in cents and a currency
Show child attributes
Show child attributes
Total amount of credit note (including taxes)
Show child attributes
Show child attributes
The amount which has value in cents and a currency
Show child attributes
Show child attributes
Optional note attached to the credit note. This note will only be visible to admins
Optional note attached to the credit note. This note will be visible to the customer
Show child attributes
Show child attributes
Response
Created
Show child attributes
Show child attributes
The date the credit note is effective at
Internal note attached to the credit note
The reason for the credit note, such as ORDER_CHANGE, DUPLICATE, FRAUDULENT, or PRODUCT_UNSATISFACTORY
Show child attributes
Show child attributes
The invoice line items for the credit note
Show child attributes
Show child attributes
Note attached to the credit note
Show child attributes
Show child attributes
The total amount for the credit note
Show child attributes
Show child attributes
curl --request POST \
--url https://api.getmeasure.com/api/v1/companies/{company_id}/credit_notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"adjusted_invoice_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"effective_date": "2023-11-07T05:31:56Z",
"existing_invoice_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"internal_reason": "<string>",
"invoice_uuid": "<string>",
"line_items": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"line_item_id": "<string>"
}
],
"subtotal_credit_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"total_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"total_amount_excluding_taxes": {
"currency": "<string>",
"value_in_cents": 123
},
"internal_note": "<string>",
"name": "<string>",
"note": "<string>",
"refund_options": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"existing_transaction_id": "<string>"
}
]
}
'import requests
url = "https://api.getmeasure.com/api/v1/companies/{company_id}/credit_notes"
payload = {
"adjusted_invoice_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"effective_date": "2023-11-07T05:31:56Z",
"existing_invoice_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"internal_reason": "<string>",
"invoice_uuid": "<string>",
"line_items": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"line_item_id": "<string>"
}
],
"subtotal_credit_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"total_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"total_amount_excluding_taxes": {
"currency": "<string>",
"value_in_cents": 123
},
"internal_note": "<string>",
"name": "<string>",
"note": "<string>",
"refund_options": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"existing_transaction_id": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adjusted_invoice_amount: {currency: '<string>', value_in_cents: 123},
effective_date: '2023-11-07T05:31:56Z',
existing_invoice_amount: {currency: '<string>', value_in_cents: 123},
internal_reason: '<string>',
invoice_uuid: '<string>',
line_items: [
{amount: {currency: '<string>', value_in_cents: 123}, line_item_id: '<string>'}
],
subtotal_credit_amount: {currency: '<string>', value_in_cents: 123},
total_amount: {currency: '<string>', value_in_cents: 123},
total_amount_excluding_taxes: {currency: '<string>', value_in_cents: 123},
internal_note: '<string>',
name: '<string>',
note: '<string>',
refund_options: [
{
amount: {currency: '<string>', value_in_cents: 123},
existing_transaction_id: '<string>'
}
]
})
};
fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/credit_notes', 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.getmeasure.com/api/v1/companies/{company_id}/credit_notes",
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([
'adjusted_invoice_amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'effective_date' => '2023-11-07T05:31:56Z',
'existing_invoice_amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'internal_reason' => '<string>',
'invoice_uuid' => '<string>',
'line_items' => [
[
'amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'line_item_id' => '<string>'
]
],
'subtotal_credit_amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'total_amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'total_amount_excluding_taxes' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'internal_note' => '<string>',
'name' => '<string>',
'note' => '<string>',
'refund_options' => [
[
'amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'existing_transaction_id' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.getmeasure.com/api/v1/companies/{company_id}/credit_notes"
payload := strings.NewReader("{\n \"adjusted_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"existing_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_reason\": \"<string>\",\n \"invoice_uuid\": \"<string>\",\n \"line_items\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"line_item_id\": \"<string>\"\n }\n ],\n \"subtotal_credit_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount_excluding_taxes\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_note\": \"<string>\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"refund_options\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"existing_transaction_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.getmeasure.com/api/v1/companies/{company_id}/credit_notes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"adjusted_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"existing_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_reason\": \"<string>\",\n \"invoice_uuid\": \"<string>\",\n \"line_items\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"line_item_id\": \"<string>\"\n }\n ],\n \"subtotal_credit_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount_excluding_taxes\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_note\": \"<string>\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"refund_options\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"existing_transaction_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/credit_notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"adjusted_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"effective_date\": \"2023-11-07T05:31:56Z\",\n \"existing_invoice_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_reason\": \"<string>\",\n \"invoice_uuid\": \"<string>\",\n \"line_items\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"line_item_id\": \"<string>\"\n }\n ],\n \"subtotal_credit_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"total_amount_excluding_taxes\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"internal_note\": \"<string>\",\n \"name\": \"<string>\",\n \"note\": \"<string>\",\n \"refund_options\": [\n {\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"existing_transaction_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"customer": {
"email": "<string>",
"id": "<string>",
"identifier": "<string>",
"name": "<string>",
"org_name": "<string>",
"parent_customer": "<unknown>",
"parent_customer_id": "<string>"
},
"customer_id": "<string>",
"effective_date": "2023-11-07T05:31:56Z",
"id": "<string>",
"internal_note": "<string>",
"internal_reason": "<string>",
"invoice": {
"auto_charges": true,
"billed_customer": {
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"country": "US",
"place_id": "<string>",
"state": "<string>",
"zip": "<string>"
},
"arr": {
"currency": "<string>",
"value_in_cents": 123
},
"billing_emails": [
"<string>"
],
"company_id": "<string>",
"computed_entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"inherited_from_id": "<string>",
"inherited_from_type": "<string>",
"key": "<string>",
"name": "<string>",
"original_value": "<unknown>",
"overridden": true,
"type": "<string>",
"value": "<unknown>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"customer_integration_metadata": {},
"display_name": "<string>",
"email": "<string>",
"exclude_from_metrics": true,
"id": "<string>",
"identifier": "<string>",
"integration_references": [
{
"integration_icon": "<string>",
"integration_id": "<string>",
"integration_key": "<string>",
"integration_name": "<string>",
"reference_type": "<string>",
"remote_id": "<string>",
"remote_type": "<string>"
}
],
"locale": "<string>",
"managed_externally": true,
"metadata": {},
"mrr": {
"currency": "<string>",
"value_in_cents": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": "<string>",
"parent_customer_id": "<string>",
"phone": "<string>",
"status": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"billed_customer_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"customer": {
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"city": "<string>",
"country": "US",
"place_id": "<string>",
"state": "<string>",
"zip": "<string>"
},
"arr": {
"currency": "<string>",
"value_in_cents": 123
},
"billing_emails": [
"<string>"
],
"company_id": "<string>",
"computed_entitlements": [
{
"entitlement_id": "<string>",
"id": "<string>",
"inherited_from_id": "<string>",
"inherited_from_type": "<string>",
"key": "<string>",
"name": "<string>",
"original_value": "<unknown>",
"overridden": true,
"type": "<string>",
"value": "<unknown>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"customer_integration_metadata": {},
"display_name": "<string>",
"email": "<string>",
"exclude_from_metrics": true,
"id": "<string>",
"identifier": "<string>",
"integration_references": [
{
"integration_icon": "<string>",
"integration_id": "<string>",
"integration_key": "<string>",
"integration_name": "<string>",
"reference_type": "<string>",
"remote_id": "<string>",
"remote_type": "<string>"
}
],
"locale": "<string>",
"managed_externally": true,
"metadata": {},
"mrr": {
"currency": "<string>",
"value_in_cents": 123
},
"name": "<string>",
"org_name": "<string>",
"owner_id": "<string>",
"parent_customer_id": "<string>",
"phone": "<string>",
"status": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"customer_id": "<string>",
"due": {
"currency": "<string>",
"value_in_cents": 123
},
"due_date": "2023-11-07T05:31:56Z",
"hosted_link": "<string>",
"invoice_date": "2023-11-07T05:31:56Z",
"name": "<string>",
"number": "<string>",
"paid": {
"currency": "<string>",
"value_in_cents": 123
},
"paid_date": "2023-11-07T05:31:56Z",
"pdf_link": "<string>",
"prorated_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"revenue": {
"currency": "<string>",
"value_in_cents": 123
},
"status": "<string>",
"sub_total": {
"currency": "<string>",
"value_in_cents": 123
},
"subscription_id": "<string>",
"total": {
"currency": "<string>",
"value_in_cents": 123
},
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"invoice_uuid": "<string>",
"line_items": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"line_item_id": "<string>"
}
],
"name": "<string>",
"note": "<string>",
"refund_options": {
"items": [
{
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"existing_transaction_id": "<string>",
"new_credit_id": "<string>",
"new_refund_transaction_id": "<string>",
"refund_type": "<string>"
}
]
},
"total": {
"currency": "<string>",
"value_in_cents": 123
}
}
