purchasesapi.md

fiken › PurchasesApi

Class: PurchasesApi

Hierarchy

• BaseAPI

  ↳ PurchasesApi

Index

Constructors

• constructor

Properties

• configuration

Methods

• addAttachmentToPurchase
• addAttachmentToPurchaseDraft
• addAttachmentToPurchaseDraftRaw
• addAttachmentToPurchaseRaw
• createPurchase
• createPurchaseDraft
• createPurchaseDraftRaw
• createPurchaseFromDraft
• createPurchaseFromDraftRaw
• createPurchasePayment
• createPurchasePaymentRaw
• createPurchaseRaw
• deletePurchaseDraft
• deletePurchaseDraftRaw
• getPurchase
• getPurchaseAttachments
• getPurchaseAttachmentsRaw
• getPurchaseDraft
• getPurchaseDraftAttachments
• getPurchaseDraftAttachmentsRaw
• getPurchaseDraftRaw
• getPurchaseDrafts
• getPurchaseDraftsRaw
• getPurchasePayment
• getPurchasePaymentRaw
• getPurchasePayments
• getPurchasePaymentsRaw
• getPurchaseRaw
• getPurchases
• getPurchasesRaw
• request
• updatePurchaseDraft
• updatePurchaseDraftRaw
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

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

Inherited from BaseAPI.constructor

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: PurchasesApi

Properties

Protected configuration

• configuration: Configuration‹›

Inherited from BaseAPI.configuration

Methods

addAttachmentToPurchase

▸ addAttachmentToPurchase(requestParameters: AddAttachmentToPurchaseRequest): Promise‹void›

Creates and adds a new attachment to a Purchase

Parameters:

Name	Type
requestParameters	AddAttachmentToPurchaseRequest

Returns: Promise‹void›

---

addAttachmentToPurchaseDraft

▸ addAttachmentToPurchaseDraft(requestParameters: AddAttachmentToPurchaseDraftRequest): Promise‹void›

Creates and adds a new attachment to a draft

Parameters:

Name	Type
requestParameters	AddAttachmentToPurchaseDraftRequest

Returns: Promise‹void›

---

addAttachmentToPurchaseDraftRaw

▸ addAttachmentToPurchaseDraftRaw(requestParameters: AddAttachmentToPurchaseDraftRequest): Promise‹ApiResponse‹void››

Creates and adds a new attachment to a draft

Parameters:

Name	Type
requestParameters	AddAttachmentToPurchaseDraftRequest

Returns: Promise‹ApiResponse‹void››

---

addAttachmentToPurchaseRaw

▸ addAttachmentToPurchaseRaw(requestParameters: AddAttachmentToPurchaseRequest): Promise‹ApiResponse‹void››

Creates and adds a new attachment to a Purchase

Parameters:

Name	Type
requestParameters	AddAttachmentToPurchaseRequest

Returns: Promise‹ApiResponse‹void››

---

createPurchase

▸ createPurchase(requestParameters: CreatePurchaseRequest): Promise‹void›

Creates a new purchase.

Parameters:

Name	Type
requestParameters	CreatePurchaseRequest

Returns: Promise‹void›

---

createPurchaseDraft

▸ createPurchaseDraft(requestParameters: CreatePurchaseDraftRequest): Promise‹void›

Creates a purchase draft.

Parameters:

Name	Type
requestParameters	CreatePurchaseDraftRequest

Returns: Promise‹void›

---

createPurchaseDraftRaw

▸ createPurchaseDraftRaw(requestParameters: CreatePurchaseDraftRequest): Promise‹ApiResponse‹void››

Creates a purchase draft.

Parameters:

Name	Type
requestParameters	CreatePurchaseDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createPurchaseFromDraft

▸ createPurchaseFromDraft(requestParameters: CreatePurchaseFromDraftRequest): Promise‹void›

Creates a purchase from an already created draft.

Parameters:

Name	Type
requestParameters	CreatePurchaseFromDraftRequest

Returns: Promise‹void›

---

createPurchaseFromDraftRaw

▸ createPurchaseFromDraftRaw(requestParameters: CreatePurchaseFromDraftRequest): Promise‹ApiResponse‹void››

Creates a purchase from an already created draft.

Parameters:

Name	Type
requestParameters	CreatePurchaseFromDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createPurchasePayment

▸ createPurchasePayment(requestParameters: CreatePurchasePaymentRequest): Promise‹void›

Creates a new payment for a purchase

Parameters:

Name	Type
requestParameters	CreatePurchasePaymentRequest

Returns: Promise‹void›

---

createPurchasePaymentRaw

▸ createPurchasePaymentRaw(requestParameters: CreatePurchasePaymentRequest): Promise‹ApiResponse‹void››

Creates a new payment for a purchase

Parameters:

Name	Type
requestParameters	CreatePurchasePaymentRequest

Returns: Promise‹ApiResponse‹void››

---

createPurchaseRaw

▸ createPurchaseRaw(requestParameters: CreatePurchaseRequest): Promise‹ApiResponse‹void››

Creates a new purchase.

Parameters:

Name	Type
requestParameters	CreatePurchaseRequest

Returns: Promise‹ApiResponse‹void››

---

deletePurchaseDraft

▸ deletePurchaseDraft(requestParameters: DeletePurchaseDraftRequest): Promise‹void›

Delete draft with specified id.

Parameters:

Name	Type
requestParameters	DeletePurchaseDraftRequest

Returns: Promise‹void›

---

deletePurchaseDraftRaw

▸ deletePurchaseDraftRaw(requestParameters: DeletePurchaseDraftRequest): Promise‹ApiResponse‹void››

Delete draft with specified id.

Parameters:

Name	Type
requestParameters	DeletePurchaseDraftRequest

Returns: Promise‹ApiResponse‹void››

---

getPurchase

▸ getPurchase(requestParameters: GetPurchaseRequest): Promise‹PurchaseResult›

Returns purchase with specified id.

Parameters:

Name	Type
requestParameters	GetPurchaseRequest

Returns: Promise‹PurchaseResult›

---

getPurchaseAttachments

▸ getPurchaseAttachments(requestParameters: GetPurchaseAttachmentsRequest): Promise‹Array‹Attachment››

Returns all attachments for specified purchase.

Parameters:

Name	Type
requestParameters	GetPurchaseAttachmentsRequest

Returns: Promise‹Array‹Attachment››

---

getPurchaseAttachmentsRaw

▸ getPurchaseAttachmentsRaw(requestParameters: GetPurchaseAttachmentsRequest): Promise‹ApiResponse‹Array‹Attachment›››

Returns all attachments for specified purchase.

Parameters:

Name	Type
requestParameters	GetPurchaseAttachmentsRequest

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

---

getPurchaseDraft

▸ getPurchaseDraft(requestParameters: GetPurchaseDraftRequest): Promise‹DraftResult›

Returns draft with specified id.

Parameters:

Name	Type
requestParameters	GetPurchaseDraftRequest

Returns: Promise‹DraftResult›

---

getPurchaseDraftAttachments

▸ getPurchaseDraftAttachments(requestParameters: GetPurchaseDraftAttachmentsRequest): Promise‹Array‹Attachment››

Returns all attachments for specified draft.

Parameters:

Name	Type
requestParameters	GetPurchaseDraftAttachmentsRequest

Returns: Promise‹Array‹Attachment››

---

getPurchaseDraftAttachmentsRaw

▸ getPurchaseDraftAttachmentsRaw(requestParameters: GetPurchaseDraftAttachmentsRequest): Promise‹ApiResponse‹Array‹Attachment›››

Returns all attachments for specified draft.

Parameters:

Name	Type
requestParameters	GetPurchaseDraftAttachmentsRequest

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

---

getPurchaseDraftRaw

▸ getPurchaseDraftRaw(requestParameters: GetPurchaseDraftRequest): Promise‹ApiResponse‹DraftResult››

Returns draft with specified id.

Parameters:

Name	Type
requestParameters	GetPurchaseDraftRequest

Returns: Promise‹ApiResponse‹DraftResult››

---

getPurchaseDrafts

▸ getPurchaseDrafts(requestParameters: GetPurchaseDraftsRequest): Promise‹Array‹DraftResult››

Returns all purchase drafts for given company.

Parameters:

Name	Type
requestParameters	GetPurchaseDraftsRequest

Returns: Promise‹Array‹DraftResult››

---

getPurchaseDraftsRaw

▸ getPurchaseDraftsRaw(requestParameters: GetPurchaseDraftsRequest): Promise‹ApiResponse‹Array‹DraftResult›››

Returns all purchase drafts for given company.

Parameters:

Name	Type
requestParameters	GetPurchaseDraftsRequest

Returns: Promise‹ApiResponse‹Array‹DraftResult›››

---

getPurchasePayment

▸ getPurchasePayment(requestParameters: GetPurchasePaymentRequest): Promise‹Payment›

Returns given payment for specified purchase

Parameters:

Name	Type
requestParameters	GetPurchasePaymentRequest

Returns: Promise‹Payment›

---

getPurchasePaymentRaw

▸ getPurchasePaymentRaw(requestParameters: GetPurchasePaymentRequest): Promise‹ApiResponse‹Payment››

Returns given payment for specified purchase

Parameters:

Name	Type
requestParameters	GetPurchasePaymentRequest

Returns: Promise‹ApiResponse‹Payment››

---

getPurchasePayments

▸ getPurchasePayments(requestParameters: GetPurchasePaymentsRequest): Promise‹Array‹Payment››

Returns all purchases for given company

Parameters:

Name	Type
requestParameters	GetPurchasePaymentsRequest

Returns: Promise‹Array‹Payment››

---

getPurchasePaymentsRaw

▸ getPurchasePaymentsRaw(requestParameters: GetPurchasePaymentsRequest): Promise‹ApiResponse‹Array‹Payment›››

Returns all purchases for given company

Parameters:

Name	Type
requestParameters	GetPurchasePaymentsRequest

Returns: Promise‹ApiResponse‹Array‹Payment›››

---

getPurchaseRaw

▸ getPurchaseRaw(requestParameters: GetPurchaseRequest): Promise‹ApiResponse‹PurchaseResult››

Returns purchase with specified id.

Parameters:

Name	Type
requestParameters	GetPurchaseRequest

Returns: Promise‹ApiResponse‹PurchaseResult››

---

getPurchases

▸ getPurchases(requestParameters: GetPurchasesRequest): Promise‹Array‹PurchaseResult››

Returns all purchases for given company

Parameters:

Name	Type
requestParameters	GetPurchasesRequest

Returns: Promise‹Array‹PurchaseResult››

---

getPurchasesRaw

▸ getPurchasesRaw(requestParameters: GetPurchasesRequest): Promise‹ApiResponse‹Array‹PurchaseResult›››

Returns all purchases for given company

Parameters:

Name	Type
requestParameters	GetPurchasesRequest

Returns: Promise‹ApiResponse‹Array‹PurchaseResult›››

---

Protected request

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

Inherited from BaseAPI.request

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

updatePurchaseDraft

▸ updatePurchaseDraft(requestParameters: UpdatePurchaseDraftRequest): Promise‹void›

Updates draft with provided id.

Parameters:

Name	Type
requestParameters	UpdatePurchaseDraftRequest

Returns: Promise‹void›

---

updatePurchaseDraftRaw

▸ updatePurchaseDraftRaw(requestParameters: UpdatePurchaseDraftRequest): Promise‹ApiResponse‹void››

Updates draft with provided id.

Parameters:

Name	Type
requestParameters	UpdatePurchaseDraftRequest

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