creditnotesapi.md

fiken › CreditNotesApi

Class: CreditNotesApi

Hierarchy

• BaseAPI

  ↳ CreditNotesApi

Index

Constructors

• constructor

Properties

• configuration

Methods

• addAttachmentToCreditNoteDraft
• addAttachmentToCreditNoteDraftRaw
• createCreditNoteDraft
• createCreditNoteDraftRaw
• createCreditNoteFromDraft
• createCreditNoteFromDraftRaw
• createFullCreditNote
• createFullCreditNoteRaw
• createPartialCreditNote
• createPartialCreditNoteRaw
• deleteCreditNoteDraft
• deleteCreditNoteDraftRaw
• getCreditNote
• getCreditNoteDraft
• getCreditNoteDraftAttachments
• getCreditNoteDraftAttachmentsRaw
• getCreditNoteDraftRaw
• getCreditNoteDrafts
• getCreditNoteDraftsRaw
• getCreditNoteRaw
• getCreditNotes
• getCreditNotesRaw
• request
• sendCreditNote
• sendCreditNoteRaw
• updateCreditNoteDraft
• updateCreditNoteDraftRaw
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

+ new CreditNotesApi(configuration: Configuration‹›): CreditNotesApi

Inherited from BaseAPI.constructor

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: CreditNotesApi

Properties

Protected configuration

• configuration: Configuration‹›

Inherited from BaseAPI.configuration

Methods

addAttachmentToCreditNoteDraft

▸ addAttachmentToCreditNoteDraft(requestParameters: AddAttachmentToCreditNoteDraftRequest): Promise‹void›

Creates and adds a new attachment to a credit note draft

Parameters:

Name	Type
requestParameters	AddAttachmentToCreditNoteDraftRequest

Returns: Promise‹void›

---

addAttachmentToCreditNoteDraftRaw

▸ addAttachmentToCreditNoteDraftRaw(requestParameters: AddAttachmentToCreditNoteDraftRequest): Promise‹ApiResponse‹void››

Creates and adds a new attachment to a credit note draft

Parameters:

Name	Type
requestParameters	AddAttachmentToCreditNoteDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createCreditNoteDraft

▸ createCreditNoteDraft(requestParameters: CreateCreditNoteDraftRequest): Promise‹void›

Creates a credit note draft.

Parameters:

Name	Type
requestParameters	CreateCreditNoteDraftRequest

Returns: Promise‹void›

---

createCreditNoteDraftRaw

▸ createCreditNoteDraftRaw(requestParameters: CreateCreditNoteDraftRequest): Promise‹ApiResponse‹void››

Creates a credit note draft.

Parameters:

Name	Type
requestParameters	CreateCreditNoteDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createCreditNoteFromDraft

▸ createCreditNoteFromDraft(requestParameters: CreateCreditNoteFromDraftRequest): Promise‹void›

Creates a credit note from an already created draft.

Parameters:

Name	Type
requestParameters	CreateCreditNoteFromDraftRequest

Returns: Promise‹void›

---

createCreditNoteFromDraftRaw

▸ createCreditNoteFromDraftRaw(requestParameters: CreateCreditNoteFromDraftRequest): Promise‹ApiResponse‹void››

Creates a credit note from an already created draft.

Parameters:

Name	Type
requestParameters	CreateCreditNoteFromDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createFullCreditNote

▸ createFullCreditNote(requestParameters: CreateFullCreditNoteRequest): Promise‹void›

Creates a new credit note.

Parameters:

Name	Type
requestParameters	CreateFullCreditNoteRequest

Returns: Promise‹void›

---

createFullCreditNoteRaw

▸ createFullCreditNoteRaw(requestParameters: CreateFullCreditNoteRequest): Promise‹ApiResponse‹void››

Creates a new credit note.

Parameters:

Name	Type
requestParameters	CreateFullCreditNoteRequest

Returns: Promise‹ApiResponse‹void››

---

createPartialCreditNote

▸ createPartialCreditNote(requestParameters: CreatePartialCreditNoteRequest): Promise‹void›

Creates a new credit note.

Parameters:

Name	Type
requestParameters	CreatePartialCreditNoteRequest

Returns: Promise‹void›

---

createPartialCreditNoteRaw

▸ createPartialCreditNoteRaw(requestParameters: CreatePartialCreditNoteRequest): Promise‹ApiResponse‹void››

Creates a new credit note.

Parameters:

Name	Type
requestParameters	CreatePartialCreditNoteRequest

Returns: Promise‹ApiResponse‹void››

---

deleteCreditNoteDraft

▸ deleteCreditNoteDraft(requestParameters: DeleteCreditNoteDraftRequest): Promise‹void›

Delete credit note draft with specified id.

Parameters:

Name	Type
requestParameters	DeleteCreditNoteDraftRequest

Returns: Promise‹void›

---

deleteCreditNoteDraftRaw

▸ deleteCreditNoteDraftRaw(requestParameters: DeleteCreditNoteDraftRequest): Promise‹ApiResponse‹void››

Delete credit note draft with specified id.

Parameters:

Name	Type
requestParameters	DeleteCreditNoteDraftRequest

Returns: Promise‹ApiResponse‹void››

---

getCreditNote

▸ getCreditNote(requestParameters: GetCreditNoteRequest): Promise‹CreditNoteResult›

Returns credit note with specified id.

Parameters:

Name	Type
requestParameters	GetCreditNoteRequest

Returns: Promise‹CreditNoteResult›

---

getCreditNoteDraft

▸ getCreditNoteDraft(requestParameters: GetCreditNoteDraftRequest): Promise‹InvoiceishDraftResult›

Returns credit note draft with specified id.

Parameters:

Name	Type
requestParameters	GetCreditNoteDraftRequest

Returns: Promise‹InvoiceishDraftResult›

---

getCreditNoteDraftAttachments

▸ getCreditNoteDraftAttachments(requestParameters: GetCreditNoteDraftAttachmentsRequest): Promise‹Array‹Attachment››

Returns all attachments for specified draft.

Parameters:

Name	Type
requestParameters	GetCreditNoteDraftAttachmentsRequest

Returns: Promise‹Array‹Attachment››

---

getCreditNoteDraftAttachmentsRaw

▸ getCreditNoteDraftAttachmentsRaw(requestParameters: GetCreditNoteDraftAttachmentsRequest): Promise‹ApiResponse‹Array‹Attachment›››

Returns all attachments for specified draft.

Parameters:

Name	Type
requestParameters	GetCreditNoteDraftAttachmentsRequest

Returns: Promise‹ApiResponse‹Array‹Attachment›››

---

getCreditNoteDraftRaw

▸ getCreditNoteDraftRaw(requestParameters: GetCreditNoteDraftRequest): Promise‹ApiResponse‹InvoiceishDraftResult››

Returns credit note draft with specified id.

Parameters:

Name	Type
requestParameters	GetCreditNoteDraftRequest

Returns: Promise‹ApiResponse‹InvoiceishDraftResult››

---

getCreditNoteDrafts

▸ getCreditNoteDrafts(requestParameters: GetCreditNoteDraftsRequest): Promise‹Array‹InvoiceishDraftResult››

Returns all credit note drafts for given company.

Parameters:

Name	Type
requestParameters	GetCreditNoteDraftsRequest

Returns: Promise‹Array‹InvoiceishDraftResult››

---

getCreditNoteDraftsRaw

▸ getCreditNoteDraftsRaw(requestParameters: GetCreditNoteDraftsRequest): Promise‹ApiResponse‹Array‹InvoiceishDraftResult›››

Returns all credit note drafts for given company.

Parameters:

Name	Type
requestParameters	GetCreditNoteDraftsRequest

Returns: Promise‹ApiResponse‹Array‹InvoiceishDraftResult›››

---

getCreditNoteRaw

▸ getCreditNoteRaw(requestParameters: GetCreditNoteRequest): Promise‹ApiResponse‹CreditNoteResult››

Returns credit note with specified id.

Parameters:

Name	Type
requestParameters	GetCreditNoteRequest

Returns: Promise‹ApiResponse‹CreditNoteResult››

---

getCreditNotes

▸ getCreditNotes(requestParameters: GetCreditNotesRequest): Promise‹Array‹CreditNoteResult››

Returns all credit notes for given company

Parameters:

Name	Type
requestParameters	GetCreditNotesRequest

Returns: Promise‹Array‹CreditNoteResult››

---

getCreditNotesRaw

▸ getCreditNotesRaw(requestParameters: GetCreditNotesRequest): Promise‹ApiResponse‹Array‹CreditNoteResult›››

Returns all credit notes for given company

Parameters:

Name	Type
requestParameters	GetCreditNotesRequest

Returns: Promise‹ApiResponse‹Array‹CreditNoteResult›››

---

Protected request

▸ request(context: RequestOpts): Promise‹Response›

Inherited from BaseAPI.request

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

sendCreditNote

▸ sendCreditNote(requestParameters: SendCreditNoteOperationRequest): Promise‹void›

Sends the specified document

Parameters:

Name	Type
requestParameters	SendCreditNoteOperationRequest

Returns: Promise‹void›

---

sendCreditNoteRaw

▸ sendCreditNoteRaw(requestParameters: SendCreditNoteOperationRequest): Promise‹ApiResponse‹void››

Sends the specified document

Parameters:

Name	Type
requestParameters	SendCreditNoteOperationRequest

Returns: Promise‹ApiResponse‹void››

---

updateCreditNoteDraft

▸ updateCreditNoteDraft(requestParameters: UpdateCreditNoteDraftRequest): Promise‹void›

Updates credit note draft with provided id.

Parameters:

Name	Type
requestParameters	UpdateCreditNoteDraftRequest

Returns: Promise‹void›

---

updateCreditNoteDraftRaw

▸ updateCreditNoteDraftRaw(requestParameters: UpdateCreditNoteDraftRequest): Promise‹ApiResponse‹void››

Updates credit note draft with provided id.

Parameters:

Name	Type
requestParameters	UpdateCreditNoteDraftRequest

Returns: Promise‹ApiResponse‹void››

---

withMiddleware

▸ withMiddleware‹T›(this: T, ...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...middlewares	Middleware[]

Returns: T

---

withPostMiddleware

▸ withPostMiddleware‹T›(this: T, ...postMiddlewares: Array‹Middleware["post"]›): T

Inherited from BaseAPI.withPostMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...postMiddlewares	Array‹Middleware["post"]›

Returns: T

---

withPreMiddleware

▸ withPreMiddleware‹T›(this: T, ...preMiddlewares: Array‹Middleware["pre"]›): T

Inherited from BaseAPI.withPreMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...preMiddlewares	Array‹Middleware["pre"]›

Returns: T