Retrieve an invoice credit note

curl --request GET \
  --url https://api.syntage.com/invoices/credit-notes/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.syntage.com/invoices/credit-notes/{id}', 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.syntage.com/invoices/credit-notes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.syntage.com/invoices/credit-notes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/invoices/credit-notes/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "@context": "/contexts/InvoiceCreditNote",
  "@id": "/invoices/credit-notes/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "InvoiceCreditNote",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "appliedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
  "issuedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
  "appliedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
  "issuedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
  "issuedAt": "2023-11-07T05:31:56Z",
  "proportionalRate": 19.8,
  "amount": 19.8,
  "subTotalAmount": 19.8,
  "issuedInvoiceTotal": 19.8,
  "canceledAt": "2023-11-07T05:31:56Z",
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

invoices

credit-notes

{id}

Retrieve an invoice credit note

curl --request GET \
  --url https://api.syntage.com/invoices/credit-notes/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.syntage.com/invoices/credit-notes/{id}', 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.syntage.com/invoices/credit-notes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.syntage.com/invoices/credit-notes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syntage.com/invoices/credit-notes/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "@context": "/contexts/InvoiceCreditNote",
  "@id": "/invoices/credit-notes/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "InvoiceCreditNote",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "appliedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
  "issuedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
  "appliedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
  "issuedInvoiceUuid": "def404af-5eef-4112-aa99-d1ec8493b89a",
  "issuedAt": "2023-11-07T05:31:56Z",
  "proportionalRate": 19.8,
  "amount": 19.8,
  "subTotalAmount": 19.8,
  "issuedInvoiceTotal": 19.8,
  "canceledAt": "2023-11-07T05:31:56Z",
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

X-API-Key

string

header

required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

string<uuid>

required

Response

Invoice credit note resource response

@context

string

default:/contexts/InvoiceCreditNote

@id

string<iri-reference>

Invoice Credit Note IRI reference

Example:

"/invoices/credit-notes/91106968-1abd-4d64-85c1-4e73d96fb997"

@type

string

default:InvoiceCreditNote

string<uuid>

Invoice credit note ID

Example:

"91106968-1abd-4d64-85c1-4e73d96fb997"

appliedInvoice

string<iri-reference> | null

Invoice receiving the credit

Example:

"/invoices/91106968-1abd-4d64-85c1-4e73d96fb997"

issuedInvoice

string<iri-reference> | null

Invoice issuing the credit

Example:

"/invoices/91106968-1abd-4d64-85c1-4e73d96fb997"

appliedInvoiceUuid

string<uuid> | null

UUID of the invoice receiving the credit

Example:

"def404af-5eef-4112-aa99-d1ec8493b89a"

issuedInvoiceUuid

string<uuid> | null

UUID of the invoice issuing the credit

Example:

"def404af-5eef-4112-aa99-d1ec8493b89a"

issuedAt

string<date-time>

Date and time the credit note invoice was issued

proportionalRate

number<float> | null

Percentage of the credit note applied to the target invoice.

Example:

19.8

amount

number<float>

Amount of the credit note applied to the target invoice, in the target invoice's currency. When an exchange rate is unavailable, the credit note's amount is applied without conversion.

Example:

19.8

subTotalAmount

number<float> | null

Amount of the credit note applied to the target invoice before taxes, in the target invoice's currency. When an exchange rate is unavailable, the credit note's amount is applied without conversion.

Example:

19.8

issuedInvoiceTotal

number<float>

Total of the credit note that was taken into account to calculate the credit, in the credit note's currency.

Example:

19.8

canceledAt

string<date-time> | null

Date and time the credit note invoice was canceled

createdAt

string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt

string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"

Core Resources

Other Resources

Datasource: SAT

Datasource: RPC

Datasource: RUG

Datasource: Syntage

Datasource: Buró de Crédito

Datasource: BIL

Datasource: Infonavit

Insights

Reports

Webhooks

Retrieve an invoice credit note

Authorizations

Path Parameters

Response