Ecommerce Sales data via list payments API offers necessary types of data to build powerful data products. Get in touch with the List Payments API provider to receive precise data for fetching payment information of a customer upon integration objectives conveniently.
Menu
List Credit Notes API
List credit notes API for fetching credit notes of a customer upon integration by Apideck
Access the database of Apideck and take advantage of this list credit notes API with the goal of fetching credit notes of a customer upon integration. It is always intriguing to hear about new projects that use this list customer credit notes data, it is possible to imagine several business cases with the data but several ideas are; accounting optimization, sales management, customer account management and more. Developers often think of innovative ways to make use of the data from the API system and develop a new product with it. When filtering the system based on the x-apideck-consumer-id, x-apideck-app-id, x-apideck-service-id, raw, cursor and limit you will get the response which you need for your platform. The database has global data coverage available. The API is used by small business, medium business and enterprises, the clients use the API in the sales, ecommerce, business intelligence, accounting, SaaS and more sector. Some ideas of the type of company that uses the API are companies and businesses, sales managers, SaaS developers and more.
Menu
List Credit Notes API endpoints
| GET |
| /accounting/credit-notes |
| GET | /accounting/credit-notes |
In order to get a data response as in the example output, customers need to connect with the customer credit notes list data endpoint by sending a GET request to the endpoint; /accounting/credit-notes with the required object parameters. Place the API endpoint in the URL to execute the request. Using the API key parameter and setting it to your private API key, you can begin receiving data by using any of the major programming languages. The object table clarifies the available parameters and objects output explanations.
Data filtering methods
See here the filters applicable with the list credit notes API.
| Filters | ||
x-apideck-consumer-id |
limit |
|
x-apideck-app-id |
|
|
x-apideck-service-id |
|
|
raw |
|
|
cursor |
|
Data attributes for list credit notes API
Clarify the objects and their associated description with the table to make use of the API system also make use of the different parameters to be able to access the needed data as a response output.
| Objects | Description |
data | |
id | Unique identifier representing the entity |
number | Credit note number |
customer | The customer this entity is linked to |
currency | Indicates the associated currency for an amount of money. Values correspond to ISO 4217. |
currency_rate | Currency Exchange Rate at the time entity was recorded/generated. |
tax_inclusive | Amounts are including tax |
sub_total | Sub-total amount, normally before tax |
total_amount | Amount of payment |
total_tax | Total tax amount applied to this invoice |
tax_code | Applicable tax id/code override if tax is not supplied on a line item basis |
balance | The balance reflecting any payments made against the transaction |
remaining_credit | Indicates the total credit amount still available to apply towards the payment |
status | Status of payment |
reference | Optional reference message ie: Debit remittance detail. |
date_issued | Date credit note issued – YYYY:MM::DDThh:mm:ss.sTZD |
date_paid | Date credit note paid – YYYY:MM::DDThh:mm:ss.sTZD |
type | Type of payment |
account | Account details |
line_items | |
etc | etc |
Output response of the list credit notes API
Opt-in to the system to call the full outputbut you can already see part of the response output here.
{
"status_code": 200,
"status": "OK",
"service": "xero",
"resource": "credit-notes",
"operation": "all",
"data": [
{
"id": "123456",
"number": "OIT00546",
"customer": {
"id": "12345",
"display_id": "CUST00101",
"display_name": "Windsurf Shop",
"name": "Windsurf Shop",
"company_name": "The boring company"
},
"currency": "USD",
"currency_rate": 0.69,
"tax_inclusive": true,
"sub_total": 27500,
"total_amount": 49.99,
"total_tax": 2500,
"tax_code": "1234",
"balance": 27500,
"remaining_credit": 27500,
"status": "authorised",
"reference": "123456",
"date_issued": "2021-05-01T12:00:00.000Z",
"date_paid": "2021-05-01T12:00:00.000Z",
"type": "accounts_receivable_credit",
"account": {
"id": "123456",
"name": "Bank account",
"nominal_code": "N091",
"code": "453"
},
"line_items": [
{
"id": "12345",
"row_id": "12345",
"code": "120-C",
"line_number": 1,
"description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
"type": "sales_item",
"tax_amount": 27500,
"total_amount": 27500,
"quantity": 1,
"unit_price": 27500.5,
"unit_of_measure": "pc.",
"discount_percentage": 0.01,
"location_id": "1234",
"department_id": "1234",
"item": {
"id": "12344",
"code": "120-C",
"name": "Model Y"
},
"tax_rate": {
"id": "123456",
"code": "N-T",
"name": "GST on Purchases"
},
"ledger_account": {
"id": "123456",
"name": "Bank account",
"nominal_code": "N091",
"code": "453"
},
"row_version": "1-12345",
"updated_by": "12345",
"created_by": "12345",
"created_at": "2020-09-30T07:43:32.000Z",
"updated_at": "2020-09-30T07:43:32.000Z"
}
],
"allocations": [
{
"id": "123456",
"type": "invoice",
"code": "N091",
"amount": 49.99
}
],
"note": "Some notes about this credit note",
"row_version": "1-12345",
"updated_by": "12345",
"created_by": "12345",
"updated_at": "2020-09-30T07:43:32.000Z",
"created_at": "2020-09-30T07:43:32.000Z"
}
],
"meta": {
"items_on_page": 50,
"cursors": {
"previous": "em9oby1jcm06OnBhZ2U6OjE=",
"current": "em9oby1jcm06OnBhZ2U6OjI=",
"next": "em9oby1jcm06OnBhZ2U6OjM="
}
},
"links": {
"previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
"current": "https://unify.apideck.com/crm/companies",
"next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
}
}
SDK
This is a JSON API and if clients would like SDKs, those are available for Python, Javascript, Swift, JAVA, Angular, NodeJS, R, C#, PHP, Ruby, VueJS, Strest, Rust, Go, Scala and JQuery. Just ask for it and they are provided. Start using the filter attributes and use the output with the SDKs to design the project.
List Credit Notes API pricing
Samples and trials access is freely available if requested, just get in contact and ask for it. You will be able to access the list customer credit notes data and find out if it is precisely what you are looking for. After testing it, people can determine if they want to work with the paid version.
API cost
The API by Apideck is available monthly from $249 with secure payment and prompt access to get data.
| Option | Price |
Monthly subscription | From $249/month |
Variable pricing | no |
Free Trial
Free trial is available
Alternative options
Contact the BIN Lookup API provider to receive comprehensive data for building fraud protection systems and payment analysis purposes right away. The BIN lookup API is the ideal tool to precisely get Fraud Detection data to your API client.
Menu
