get https://secure.fusebill.com/v1/CreditNotes/
This action retrieves detailed information on a specific credit note using its Fusebill generated ID.
Path Parameters
Property | Type | Description |
---|---|---|
creditNoteId | Integer | Fusebill generated ID of the specific credit note you want to read |
Examples
curl –X GET https://secure.fusebill.com/v1/CreditNotes/{creditNoteId}\
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}"
//Setup Credit Note ID:
int creditNoteId = {creditNoteId}
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/CreditNotes/" + creditNoteId);
//Add Content type
request.ContentType = "application/json";
//Add Api key authorization
request.Headers.Add(HttpRequestHeader.Authorization, "Basic "+apiKey);
//Set request method
request.Method = "GET";
//Perform the request
var httpResponse = (HttpWebResponse)request.GetResponse();
//Record the response from our request
var result = "";
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
result = streamReader.ReadToEnd();
}
#Import library JSON
import json
#Import library Requests
import requests
#Pass in a dictionary to the Headers parameter
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'}
#Pass in your URI and Headers
r = requests.get('https://secure.fusebill.com/v1/CreditNotes/{creditNoteId}', headers=headers)
print(r.content)
Responses
{
"netAmount": 39.6,
"invoiceNumber": 4,
"creditNotesNumber": "04-CR-01",
"reference": "referenceString",
"customerId": 593374,
"invoice": {
"invoiceSignature": "<p><strong>[email protected]</strong> </p>",
"poNumber": null,
"effectiveTimestamp": "2019-05-09T10:37:31",
"postedTimestamp": "2019-08-27T02:04:25",
"chargeGroups": null,
"subtotal": 402.88,
"invoiceAmount": 402.88,
"totalPayments": 0,
"unsettled": false,
"outstandingBalance": 0,
"terms": null,
"defaultTerms": null,
"isDefaultTerms": true,
"customerId": 593374,
"invoiceCustomer": {
"firstName": "Josephine",
"middleName": "Queen",
"lastName": "Richardson",
"companyName": "Kindaloo",
"suffix": "Jr.",
"primaryEmail": "[email protected]",
"primaryPhone": 9605252522,
"secondaryEmail": "[email protected]",
"secondaryPhone": 9834142750,
"title": "Miss",
"reference": "referenceString",
"status": null,
"customerAccountStatus": null,
"currency": "NZD",
"customerReference": null,
"customerAcquisition": null,
"monthlyRecurringRevenue": 249.26,
"netMonthlyRecurringRevenue": 395.03,
"salesforceId": null,
"salesforceAccountType": null,
"salesforceSynchStatus": null,
"netsuiteId": null,
"netsuiteSynchStatus": null,
"netsuiteCustomerType": null,
"portalUserName": null,
"parentId": null,
"quickBooksLatchType": null,
"quickBooksId": null,
"quickBooksSyncToken": null,
"hubSpotId": null,
"id": 0,
"uri": null
},
"invoiceCustomerAddressPreference": {
"contactName": "White Potts",
"shippingInstructions": null,
"useBillingAddressAsShippingAddress": false,
"billingAddress": {
"customerAddressPreferenceId": 0,
"companyName": "Xinware",
"line1": "345 main street",
"line2": "suite B",
"countryId": 124,
"country": "Canada",
"stateId": 9,
"state": "Ontario",
"city": "London",
"postalZip": "k3k3k3",
"addressType": null,
"valid": false,
"id": 12638,
"uri": null
},
"id": 0,
"uri": null
},
"sumOfCreditNotes": 43.33,
"totalWriteoffs": 115.23,
"taxes": [],
"totalDiscount": 0,
"paymentSchedules": [
{
"dueDateTimestamp": "2019-06-27T07:37:54",
"status": "Void",
"amount": 2000,
"outstandingBalance": 0,
"daysDueAfterTerm": 0
}
],
"notes": null,
"customerReferenceValue": "referenceString",
"openingArBalance": 1908.33,
"closingArBalance": 1164.27,
"invoiceInMemoryOnly": false,
"totalTaxes": 0,
"isSummarized": false,
"rollUpPdf": false,
"id": 514403,
"uri": "https://secure.fusebill.com/v1/Invoices/514403"
},
"currency": "EUR",
"customerName": null,
"customerCompany": "Acme",
"invoicePostedDate": "2019-03-31T01:54:28",
"effectiveTimestamp": "2019-05-16T05:10:38",
"lineItems": [
{
"chargeGroupName": "Bronze",
"chargeGroupDescription": null,
"chargeGroupReference": null,
"lineItems": [
{
"lineItem": {
"originalChargeId": 62042449,
"netAmount": 30.18,
"name": "Screen Priv"
},
"taxes": null,
"discounts": null
}
]
}
],
"id": 8795,
"uri": "https://secure.fusebill.com/v1/creditNotes/8795"
}
{
"ErrorId": 0,
"HttpStatusCode": 404,
"Errors": [
{
"Key": "Api Error",
"Value": "CreditNoteGroup with id 4 not found."
}
]
}