Invoices

Import a credit note

Apply a credit note from another system to an invoice. The credit note lowers the amount due. The invoice must still take payments.

post/invoices/{invoiceId}/credit_notes

Request

Base URL
https://api.adfin.com/api
Auth
- OAuth 2
  Client credentials
  Token URLhttps://api.staging.adfin.com/api/oauth2/token
- or OAuth 2
  Client credentials
  Token URLhttps://api.adfin.com/api/oauth2/token
TypeScript
https://skmtc.dev/adfin/apis/adfin-api/docs/invoices/:invoiceId/credit_notes/post.ts
A function with typed inputs. Its response is checked against the schema.

invoiceIdstring uuid required

The id of the invoice

numberstring required

The credit note number. A number can be used once per invoice. It can be used again after that credit note is cancelled.

amountnumber required

The credit note amount. It lowers the amount due of the invoice and cannot be more than the amount due.

valueDatestring date-time

The date when the credit note was applied.

{
  "number": "CN-0042",
  "amount": 25
}

Credit note successfully imported.

idstring

Credit note id.

numberstring

Credit note number.

amountnumber

Credit note amount.

valueDatestring date-time

Date when credit note was applied.