journalentriesapi.md

fiken › JournalEntriesApi

Class: JournalEntriesApi

Hierarchy

• BaseAPI

  ↳ JournalEntriesApi

Index

Constructors

• constructor

Properties

• configuration

Methods

• addAttachmentToJournalEntry
• addAttachmentToJournalEntryRaw
• createGeneralJournalEntry
• createGeneralJournalEntryRaw
• getJournalEntries
• getJournalEntriesRaw
• getJournalEntry
• getJournalEntryAttachments
• getJournalEntryAttachmentsRaw
• getJournalEntryRaw
• request
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

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

Inherited from BaseAPI.constructor

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: JournalEntriesApi

Properties

Protected configuration

• configuration: Configuration‹›

Inherited from BaseAPI.configuration

Methods

addAttachmentToJournalEntry

▸ addAttachmentToJournalEntry(requestParameters: AddAttachmentToJournalEntryRequest): Promise‹void›

Creates and adds a new attachment to a Journal Entry

Parameters:

Name	Type
requestParameters	AddAttachmentToJournalEntryRequest

Returns: Promise‹void›

---

addAttachmentToJournalEntryRaw

▸ addAttachmentToJournalEntryRaw(requestParameters: AddAttachmentToJournalEntryRequest): Promise‹ApiResponse‹void››

Creates and adds a new attachment to a Journal Entry

Parameters:

Name	Type
requestParameters	AddAttachmentToJournalEntryRequest

Returns: Promise‹ApiResponse‹void››

---

createGeneralJournalEntry

▸ createGeneralJournalEntry(requestParameters: CreateGeneralJournalEntryRequest): Promise‹void›

Creates a new general journal entry (fri postering).

Parameters:

Name	Type
requestParameters	CreateGeneralJournalEntryRequest

Returns: Promise‹void›

---

createGeneralJournalEntryRaw

▸ createGeneralJournalEntryRaw(requestParameters: CreateGeneralJournalEntryRequest): Promise‹ApiResponse‹void››

Creates a new general journal entry (fri postering).

Parameters:

Name	Type
requestParameters	CreateGeneralJournalEntryRequest

Returns: Promise‹ApiResponse‹void››

---

getJournalEntries

▸ getJournalEntries(requestParameters: GetJournalEntriesRequest): Promise‹Array‹JournalEntry››

Returns all general journal entries (posteringer) for the specified company.

Parameters:

Name	Type
requestParameters	GetJournalEntriesRequest

Returns: Promise‹Array‹JournalEntry››

---

getJournalEntriesRaw

▸ getJournalEntriesRaw(requestParameters: GetJournalEntriesRequest): Promise‹ApiResponse‹Array‹JournalEntry›››

Returns all general journal entries (posteringer) for the specified company.

Parameters:

Name	Type
requestParameters	GetJournalEntriesRequest

Returns: Promise‹ApiResponse‹Array‹JournalEntry›››

---

getJournalEntry

▸ getJournalEntry(requestParameters: GetJournalEntryRequest): Promise‹JournalEntry›

Returns all journal entries within a given company's Journal Entry Service

Parameters:

Name	Type
requestParameters	GetJournalEntryRequest

Returns: Promise‹JournalEntry›

---

getJournalEntryAttachments

▸ getJournalEntryAttachments(requestParameters: GetJournalEntryAttachmentsRequest): Promise‹Array‹Attachment››

Returns all attachments for a given Journal Entry

Parameters:

Name	Type
requestParameters	GetJournalEntryAttachmentsRequest

Returns: Promise‹Array‹Attachment››

---

getJournalEntryAttachmentsRaw

▸ getJournalEntryAttachmentsRaw(requestParameters: GetJournalEntryAttachmentsRequest): Promise‹ApiResponse‹Array‹Attachment›››

Returns all attachments for a given Journal Entry

Parameters:

Name	Type
requestParameters	GetJournalEntryAttachmentsRequest

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

---

getJournalEntryRaw

▸ getJournalEntryRaw(requestParameters: GetJournalEntryRequest): Promise‹ApiResponse‹JournalEntry››

Returns all journal entries within a given company's Journal Entry Service

Parameters:

Name	Type
requestParameters	GetJournalEntryRequest

Returns: Promise‹ApiResponse‹JournalEntry››

---

Protected request

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

Inherited from BaseAPI.request

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

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