GET
/
invoices
/
credit-note
/
{id}
Retrieve an invoice credit note
curl --request GET \
  --url https://api.syntage.com/invoices/credit-note/{id} \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/InvoicePayment",
  "@id": "/invoices/credit-note/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "InvoicePayment",
  "appliedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
  "issuedInvoice": "/invoices/91106968-1abd-4d64-85c1-4e73d96fb997",
  "issuedAt": "2023-11-07T05:31:56Z",
  "proportionalRate": 19.8,
  "amount": 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"
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Response

Invoice credit note resource response

​
@context
string
default:/contexts/InvoicePayment
​
@id
string<iri-reference>

Invoice Credit Note IRI reference

Example:

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

​
@type
string
default:InvoicePayment
​
appliedInvoice
string<iri-reference>

Invoice IRI reference

Example:

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

​
issuedInvoice
string<iri-reference>

Invoice IRI reference

Example:

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

​
issuedAt
string<date-time>

Set when the payment invoice is canceled

​
proportionalRate
number | null

The proportional credit rate applied to the target invoice.

Example:

19.8

​
amount
number | null

The total amount of credits applied to the target invoice.

Example:

19.8

​
issuedInvoiceTotal
number | null

The total of the issued invoice that was taken into account to calculate the credit.

Example:

19.8

​
canceledAt
string<date-time> | null

Set when the payment invoice is 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"