InvoicesCredit notes
See what is left to credit on an invoice
GET
What is left uncredited on this invoice, line by line and in total. A void invoice answers with everything at zero.
apiKeyheader
AuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
id*stringSuccess
application/json- response
Success
currency*stringISO 4217 currency code
Value in
"USD""EUR""GBP""CAD""AUD""NZD""CHF""SEK""NOK""DKK""PLN""INR""SGD""HKD""AED""ZAR""BRL""MXN"taxBps*|nulllines*array<>subtotal*integerWhat is left uncredited, before tax
Range
0 <= valuetax*integerThe tax on what is left uncredited
Range
0 <= valuetotal*integerWhat is left uncredited, before tax and after it, added together
Range
0 <= valuecurl -X GET "https://example.com/v1/invoices/inv_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/creditable"{ "currency": "USD", "taxBps": 2000, "lines": [ { "saleId": "sal_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "description": "northwind-telecom.com, 2 years", "quantity": 2, "unitPrice": 1439, "total": 2878, "credited": 2878, "creditable": 2878 } ], "subtotal": 2878, "tax": 2878, "total": 2878}