How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Apideck Credit Notes API

A Credit Note represents a reduction in the amount owed by a customer, including line items, amounts, and the linked customer or invoice.

Apideck Credit Notes API is one of 54 APIs that Apideck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credit Notes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 10.24.12.

Requests are made against a single base URL, https://unify.apideck.com.

5 operations 2 paths 51 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
10.24.12
Base URL
https://unify.apideck.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Apideck Credit Notes API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey). By default, every request must be authenticated.

  • apiKey — To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Credit Notes 5

A Credit Note represents a reduction in the amount owed by a customer, including line items, amounts, and the linked customer or invoice.

GET
/accounting/credit-notes
Apideck List Credit Notes
creditNotesAll 11 params → 200400401402404422default
POST
/accounting/credit-notes
Apideck Create Credit Note
creditNotesAdd 5 params body → 201400401402404422default
GET
/accounting/credit-notes/{id}
Apideck Get Credit Note
creditNotesOne 7 params → 200400401402404422default
PATCH
/accounting/credit-notes/{id}
Apideck Update Credit Note
creditNotesUpdate 5 params body → 200400401402404422default
DELETE
/accounting/credit-notes/{id}
Apideck Delete Credit Note
creditNotesDelete 5 params → 200400401402404422default

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are CreditNote (37 properties), InvoiceLineItem (35 properties), Address (25 properties), GetCreditNotesResponse (9 properties). Each schema is shown below with its type and property counts.

CreditNote
object
37 properties 2 required
UnauthorizedResponse
object
6 properties
DepartmentId
stringnull
The ID of the department
LinkedInvoiceItem
object
3 properties
WritableId
stringnull
A unique identifier for an object.
CreatedAt
stringnull
The date and time when the object was created.
CreditNotesSort
object
2 properties
Raw
objectnull
Raw response from the integration when raw=true query param is provided
LocationId
stringnull
The ID of the location
InvoiceLineItem
object
35 properties
Address
object
25 properties
NotFoundResponse
object
6 properties
CustomField
object
4 properties
CreatedBy
stringnull
The user who created the object.
AccountingCompanyId
stringnull
The company ID the transaction belongs to
Allocation
object
5 properties
PassThroughBody
array
The passthrough property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
UnexpectedErrorResponse
object
6 properties
LinkedTaxRate
object
4 properties
DeleteCreditNoteResponse
object
7 properties 6 required
PaymentRequiredResponse
object
6 properties
UpdatedAt
stringnull
The date and time when the object was last updated.
SubsidiaryId
stringnull
The ID of the subsidiary
CreateCreditNoteResponse
object
7 properties 6 required
LinkedLedgerAccount
objectnull
6 properties
SortDirection
string
The direction in which to sort the results
LineNumber
integernull
Line number of the resource
LinkedTrackingCategory
objectnull
5 properties
UnitPrice
numbernull
PassThroughQuery
object
1 property
UnprocessableResponse
object
6 properties
GetCreditNoteResponse
object
7 properties 6 required
Currency
stringnull
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO4217).
TermsId
stringnull
The ID of the payment terms
LinkedWorktag
objectnull
2 properties
UnifiedId
object
A object containing a unique identifier for the resource that was created, updated, or deleted.
1 property 1 required
RowVersion
stringnull
A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
CreditNotesFilter
object
1 property
Links
object
Links to navigate to previous or next pages through the API
3 properties
BadRequestResponse
object
7 properties
GetCreditNotesResponse
object
9 properties 6 required
TaxInclusive
booleannull
Amounts are including tax
CurrencyRate
numbernull
Currency Exchange Rate at the time entity was recorded/generated.
CustomMappings
objectnull
When custom mappings are configured on the resource, the result is included here.
UpdatedBy
stringnull
The user who last updated the object.
UnitOfMeasure
stringnull
Description of the unit type the item is sold as, ie: kg, hour.
UpdateCreditNoteResponse
object
7 properties 6 required
LinkedTrackingCategories
arraynull
A list of linked tracking categories.
Meta
object
Response metadata
2 properties
Quantity
numbernull
LinkedCustomer
objectnull
The customer this entity is linked to.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apideck-credit-notes-api-openapi.yml Raw ↑

Other APIs Apideck publishes across the network.

Apideck Activities API
Apideck Aged Creditors API
Apideck Aged Debtors API
Apideck Attachments API
Apideck Balance Sheet API
Apideck Bank Accounts API
Apideck Bank Feed Accounts API
Apideck Bank Feed Statements API
Apideck Bill Payments API
Apideck Bills API
Apideck Categories API
Where this information came from

This is an independent, third-party profile of Apideck Credit Notes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.