Class CallbacksApi

Hierarchy

CallbacksApi

Index

Constructors

Properties

Methods

createCustomer createExchangeRate createInvoice createTerm doCustomerSearch doInvoiceSearch doProductSearch doTaxSearch getById invoicePdf

Constructors

constructor

new CallbacksApi(configuration, requestFactory?, responseProcessor?): CallbacksApi
Parameters
- configuration: Configuration
- Optional requestFactory: CallbacksApiRequestFactory
- Optional responseProcessor: CallbacksApiResponseProcessor
Returns CallbacksApi
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:27

Properties

`Private` api

api: ObservableCallbacksApi

Methods

createCustomer

createCustomer(requestId, resultIdAccountingResponse, _options?): Promise<void>
Call this endpoint with the response to a customer creation request. Endpoint for customer creation response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- resultIdAccountingResponse: ResultIdAccountingResponse
  
  The ID of the created customer.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:41

createExchangeRate

createExchangeRate(requestId, exchangeRateResponse, _options?): Promise<void>
Call this endpoint with the response to an exchange rate request. Endpoint for exchange rate response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- exchangeRateResponse: ExchangeRateResponse
  
  The result of the exchange rate request.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:52

createInvoice

createInvoice(requestId, resultIdAccountingResponse, _options?): Promise<void>
Call this endpoint with the response to a invoice creation request. Endpoint for invoice creation response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- resultIdAccountingResponse: ResultIdAccountingResponse
  
  The ID of the created invoice.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:63

createTerm

createTerm(requestId, termsResponse, _options?): Promise<void>
Call this endpoint with the response to a terms search request. Endpoint for terms search response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- termsResponse: TermsResponse
  
  The result of the terms search
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:74

doCustomerSearch

doCustomerSearch(requestId, customerSearchResponseExternal, _options?): Promise<void>
Call this endpoint with the response to a customer search request. Endpoint for customer search response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- customerSearchResponseExternal: CustomerSearchResponseExternal
  
  The result of the customer search request.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:85

doInvoiceSearch

doInvoiceSearch(requestId, invoiceSearchResponse, _options?): Promise<void>
Call this endpoint with the response to a invoice search request. Endpoint for invoice search response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- invoiceSearchResponse: InvoiceSearchResponse
  
  The result of the invoice search request.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:96

doProductSearch

doProductSearch(requestId, productSearchResponse, _options?): Promise<void>
Call this endpoint with the response to a product search request. Endpoint for product search response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- productSearchResponse: ProductSearchResponse
  
  The result of the product search request.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:107

doTaxSearch

doTaxSearch(requestId, taxSearchResponse, _options?): Promise<void>
Call this endpoint with the response to a taxes search request. Endpoint for taxes search response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- taxSearchResponse: TaxSearchResponse
  
  The result of the taxes search request.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:118

getById

getById(requestId, invoicesResponseExternal, _options?): Promise<void>
Call this endpoint with the response to a invoice get-by-id request. Endpoint for invoice get-by-id response
Parameters
- requestId: string
  
  The ID of the request that this response is for
- invoicesResponseExternal: InvoicesResponseExternal
  
  The result of the invoice request.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:129

invoicePdf

invoicePdf(requestId, invoicePdfResponse, _options?): Promise<void>
Call this endpoint with the PDF content of a requested invoice. Endpoint for PDF content of invoice
Parameters
- requestId: string
  
  The ID of the request that this response is for
- invoicePdfResponse: InvoicePdfResponse
  
  The bytes of the invoice PDF.
- Optional _options: Configuration
Returns Promise<void>
- Defined in codegen/crm/extensions/accounting/types/PromiseAPI.ts:140

Class CallbacksApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Optional requestFactory: CallbacksApiRequestFactory

Optional responseProcessor: CallbacksApiResponseProcessor

Returns CallbacksApi

Properties

Private api

Methods

createCustomer

Parameters

requestId: string

resultIdAccountingResponse: ResultIdAccountingResponse

Optional _options: Configuration

Returns Promise<void>

createExchangeRate

Parameters

requestId: string

exchangeRateResponse: ExchangeRateResponse

Optional _options: Configuration

Returns Promise<void>

createInvoice

Parameters

requestId: string

resultIdAccountingResponse: ResultIdAccountingResponse

Optional _options: Configuration

Returns Promise<void>

createTerm

Parameters

requestId: string

termsResponse: TermsResponse

Optional _options: Configuration

Returns Promise<void>

doCustomerSearch

Parameters

requestId: string

customerSearchResponseExternal: CustomerSearchResponseExternal

Optional _options: Configuration

Returns Promise<void>

doInvoiceSearch

Parameters

requestId: string

invoiceSearchResponse: InvoiceSearchResponse

Optional _options: Configuration

Returns Promise<void>

doProductSearch

Parameters

requestId: string

productSearchResponse: ProductSearchResponse

Optional _options: Configuration

Returns Promise<void>

doTaxSearch

Parameters

requestId: string

taxSearchResponse: TaxSearchResponse

Optional _options: Configuration

Returns Promise<void>

getById

Parameters

requestId: string

invoicesResponseExternal: InvoicesResponseExternal

Optional _options: Configuration

Returns Promise<void>

invoicePdf

Parameters

requestId: string

invoicePdfResponse: InvoicePdfResponse

Optional _options: Configuration

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` requestFactory: CallbacksApiRequestFactory

`Optional` responseProcessor: CallbacksApiResponseProcessor

`Private` api

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration

`Optional` _options: Configuration