@apideck/node
Version:
Apideck Node.js SDK
1,900 lines (1,675 loc) • 248 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* Apideck
* The Apideck OpenAPI Spec: SDK Optimized
*
* The version of the OpenAPI document: 10.13.0
* Contact: support@apideck.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import {
AccountingDepartment,
AccountingDepartmentsFilter,
AccountingDepartmentToJSON,
AccountingLocation,
AccountingLocationsFilter,
AccountingLocationToJSON,
AgedReportFilter,
AttachmentReferenceType,
BalanceSheetFilter,
Bill,
BillPayment,
BillPaymentToJSON,
BillsFilter,
BillsSort,
BillToJSON,
CreateAccountingDepartmentResponse,
CreateAccountingDepartmentResponseFromJSON,
CreateAccountingLocationResponse,
CreateAccountingLocationResponseFromJSON,
CreateBillPaymentResponse,
CreateBillPaymentResponseFromJSON,
CreateBillResponse,
CreateBillResponseFromJSON,
CreateCreditNoteResponse,
CreateCreditNoteResponseFromJSON,
CreateCustomerResponse,
CreateCustomerResponseFromJSON,
CreateExpenseResponse,
CreateExpenseResponseFromJSON,
CreateInvoiceItemResponse,
CreateInvoiceItemResponseFromJSON,
CreateInvoiceResponse,
CreateInvoiceResponseFromJSON,
CreateJournalEntryResponse,
CreateJournalEntryResponseFromJSON,
CreateLedgerAccountResponse,
CreateLedgerAccountResponseFromJSON,
CreatePaymentResponse,
CreatePaymentResponseFromJSON,
CreatePurchaseOrderResponse,
CreatePurchaseOrderResponseFromJSON,
CreateSubsidiaryResponse,
CreateSubsidiaryResponseFromJSON,
CreateSupplierResponse,
CreateSupplierResponseFromJSON,
CreateTaxRateResponse,
CreateTaxRateResponseFromJSON,
CreateTrackingCategoryResponse,
CreateTrackingCategoryResponseFromJSON,
CreditNote,
CreditNotesFilter,
CreditNotesSort,
CreditNoteToJSON,
Customer,
CustomersFilter,
CustomersSort,
CustomerToJSON,
DeleteAccountingDepartmentResponse,
DeleteAccountingDepartmentResponseFromJSON,
DeleteAccountingLocationResponse,
DeleteAccountingLocationResponseFromJSON,
DeleteAttachmentResponse,
DeleteAttachmentResponseFromJSON,
DeleteBillPaymentResponse,
DeleteBillPaymentResponseFromJSON,
DeleteBillResponse,
DeleteBillResponseFromJSON,
DeleteCreditNoteResponse,
DeleteCreditNoteResponseFromJSON,
DeleteCustomerResponse,
DeleteCustomerResponseFromJSON,
DeleteExpenseResponse,
DeleteExpenseResponseFromJSON,
DeleteInvoiceResponse,
DeleteInvoiceResponseFromJSON,
DeleteJournalEntryResponse,
DeleteJournalEntryResponseFromJSON,
DeleteLedgerAccountResponse,
DeleteLedgerAccountResponseFromJSON,
DeletePaymentResponse,
DeletePaymentResponseFromJSON,
DeletePurchaseOrderResponse,
DeletePurchaseOrderResponseFromJSON,
DeleteSubsidiaryResponse,
DeleteSubsidiaryResponseFromJSON,
DeleteSupplierResponse,
DeleteSupplierResponseFromJSON,
DeleteTaxRateResponse,
DeleteTaxRateResponseFromJSON,
DeleteTrackingCategoryResponse,
DeleteTrackingCategoryResponseFromJSON,
Expense,
ExpenseToJSON,
GetAccountingDepartmentResponse,
GetAccountingDepartmentResponseFromJSON,
GetAccountingDepartmentsResponse,
GetAccountingDepartmentsResponseFromJSON,
GetAccountingLocationResponse,
GetAccountingLocationResponseFromJSON,
GetAccountingLocationsResponse,
GetAccountingLocationsResponseFromJSON,
GetAgedCreditorsResponse,
GetAgedCreditorsResponseFromJSON,
GetAgedDebtorsResponse,
GetAgedDebtorsResponseFromJSON,
GetAttachmentResponse,
GetAttachmentResponseFromJSON,
GetAttachmentsResponse,
GetAttachmentsResponseFromJSON,
GetBalanceSheetResponse,
GetBalanceSheetResponseFromJSON,
GetBillPaymentResponse,
GetBillPaymentResponseFromJSON,
GetBillPaymentsResponse,
GetBillPaymentsResponseFromJSON,
GetBillResponse,
GetBillResponseFromJSON,
GetBillsResponse,
GetBillsResponseFromJSON,
GetCompanyInfoResponse,
GetCompanyInfoResponseFromJSON,
GetCreditNoteResponse,
GetCreditNoteResponseFromJSON,
GetCreditNotesResponse,
GetCreditNotesResponseFromJSON,
GetCustomerResponse,
GetCustomerResponseFromJSON,
GetCustomersResponse,
GetCustomersResponseFromJSON,
GetExpenseResponse,
GetExpenseResponseFromJSON,
GetExpensesResponse,
GetExpensesResponseFromJSON,
GetInvoiceItemResponse,
GetInvoiceItemResponseFromJSON,
GetInvoiceItemsResponse,
GetInvoiceItemsResponseFromJSON,
GetInvoiceResponse,
GetInvoiceResponseFromJSON,
GetInvoicesResponse,
GetInvoicesResponseFromJSON,
GetJournalEntriesResponse,
GetJournalEntriesResponseFromJSON,
GetJournalEntryResponse,
GetJournalEntryResponseFromJSON,
GetLedgerAccountResponse,
GetLedgerAccountResponseFromJSON,
GetLedgerAccountsResponse,
GetLedgerAccountsResponseFromJSON,
GetPaymentResponse,
GetPaymentResponseFromJSON,
GetPaymentsResponse,
GetPaymentsResponseFromJSON,
GetProfitAndLossResponse,
GetProfitAndLossResponseFromJSON,
GetPurchaseOrderResponse,
GetPurchaseOrderResponseFromJSON,
GetPurchaseOrdersResponse,
GetPurchaseOrdersResponseFromJSON,
GetSubsidiariesResponse,
GetSubsidiariesResponseFromJSON,
GetSubsidiaryResponse,
GetSubsidiaryResponseFromJSON,
GetSupplierResponse,
GetSupplierResponseFromJSON,
GetSuppliersResponse,
GetSuppliersResponseFromJSON,
GetTaxRateResponse,
GetTaxRateResponseFromJSON,
GetTaxRatesResponse,
GetTaxRatesResponseFromJSON,
GetTrackingCategoriesResponse,
GetTrackingCategoriesResponseFromJSON,
GetTrackingCategoryResponse,
GetTrackingCategoryResponseFromJSON,
Invoice,
InvoiceItem,
InvoiceItemFilter,
InvoiceItemsFilter,
InvoiceItemsSort,
InvoiceItemToJSON,
InvoicesFilter,
InvoicesSort,
InvoiceToJSON,
JournalEntriesFilter,
JournalEntriesSort,
JournalEntry,
JournalEntryToJSON,
LedgerAccount,
LedgerAccountsFilter,
LedgerAccountsSort,
LedgerAccountToJSON,
PassThroughQuery,
Payment,
PaymentsFilter,
PaymentsSort,
PaymentToJSON,
ProfitAndLossFilter,
PurchaseOrder,
PurchaseOrdersFilter,
PurchaseOrdersSort,
PurchaseOrderToJSON,
Subsidiary,
SubsidiaryToJSON,
Supplier,
SuppliersFilter,
SuppliersSort,
SupplierToJSON,
TaxRate,
TaxRatesFilter,
TaxRateToJSON,
TrackingCategory,
TrackingCategoryToJSON,
UpdateAccountingDepartmentResponse,
UpdateAccountingDepartmentResponseFromJSON,
UpdateAccountingLocationResponse,
UpdateAccountingLocationResponseFromJSON,
UpdateBillPaymentResponse,
UpdateBillPaymentResponseFromJSON,
UpdateBillResponse,
UpdateBillResponseFromJSON,
UpdateCreditNoteResponse,
UpdateCreditNoteResponseFromJSON,
UpdateCustomerResponse,
UpdateCustomerResponseFromJSON,
UpdateExpenseResponse,
UpdateExpenseResponseFromJSON,
UpdateInvoiceItemsResponse,
UpdateInvoiceItemsResponseFromJSON,
UpdateInvoiceResponse,
UpdateInvoiceResponseFromJSON,
UpdateJournalEntryResponse,
UpdateJournalEntryResponseFromJSON,
UpdateLedgerAccountResponse,
UpdateLedgerAccountResponseFromJSON,
UpdatePaymentResponse,
UpdatePaymentResponseFromJSON,
UpdatePurchaseOrderResponse,
UpdatePurchaseOrderResponseFromJSON,
UpdateSubsidiaryResponse,
UpdateSubsidiaryResponseFromJSON,
UpdateSupplierResponse,
UpdateSupplierResponseFromJSON,
UpdateTaxRateResponse,
UpdateTaxRateResponseFromJSON,
UpdateTrackingCategoryResponse,
UpdateTrackingCategoryResponseFromJSON
} from '../models'
import * as runtime from '../runtime'
export interface AccountingApiAgedCreditorsOneRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
filter?: AgedReportFilter
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiAgedDebtorsOneRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
filter?: AgedReportFilter
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiAttachmentsAllRequest {
referenceType: AttachmentReferenceType
referenceId: string
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
fields?: string | null
}
export interface AccountingApiAttachmentsDeleteRequest {
referenceType: AttachmentReferenceType
referenceId: string
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiAttachmentsDownloadRequest {
referenceType: AttachmentReferenceType
referenceId: string
id: string
consumerId?: string
appId?: string
serviceId?: string
fields?: string | null
}
export interface AccountingApiAttachmentsOneRequest {
referenceType: AttachmentReferenceType
referenceId: string
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiBalanceSheetOneRequest {
consumerId?: string
appId?: string
serviceId?: string
passThrough?: PassThroughQuery
filter?: BalanceSheetFilter
raw?: boolean
}
export interface AccountingApiBillPaymentsAddRequest {
billPayment: BillPayment
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiBillPaymentsAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: PaymentsFilter
sort?: PaymentsSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiBillPaymentsDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiBillPaymentsOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiBillPaymentsUpdateRequest {
id: string
billPayment: BillPayment
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiBillsAddRequest {
bill: Bill
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiBillsAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: BillsFilter
sort?: BillsSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiBillsDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiBillsOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiBillsUpdateRequest {
id: string
bill: Bill
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiCompanyInfoOneRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
fields?: string | null
}
export interface AccountingApiCreditNotesAddRequest {
creditNote: CreditNote
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiCreditNotesAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: CreditNotesFilter
sort?: CreditNotesSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiCreditNotesDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiCreditNotesOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiCreditNotesUpdateRequest {
id: string
creditNote: CreditNote
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiCustomersAddRequest {
customer: Customer
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiCustomersAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: CustomersFilter
sort?: CustomersSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiCustomersDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiCustomersOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiCustomersUpdateRequest {
id: string
customer: Customer
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiDepartmentsAddRequest {
department: AccountingDepartment
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiDepartmentsAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
fields?: string | null
filter?: AccountingDepartmentsFilter
}
export interface AccountingApiDepartmentsDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiDepartmentsOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiDepartmentsUpdateRequest {
id: string
department: AccountingDepartment
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiExpensesAddRequest {
expense: Expense
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiExpensesAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
}
export interface AccountingApiExpensesDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiExpensesOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiExpensesUpdateRequest {
id: string
expense: Expense
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiInvoiceItemsAddRequest {
invoiceItem: InvoiceItem
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiInvoiceItemsAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: InvoiceItemsFilter
sort?: InvoiceItemsSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiInvoiceItemsDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiInvoiceItemsOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
filter?: InvoiceItemFilter
}
export interface AccountingApiInvoiceItemsUpdateRequest {
id: string
invoiceItem: InvoiceItem
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiInvoicesAddRequest {
invoice: Invoice
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiInvoicesAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: InvoicesFilter
sort?: InvoicesSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiInvoicesDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiInvoicesOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiInvoicesUpdateRequest {
id: string
invoice: Invoice
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiJournalEntriesAddRequest {
journalEntry: JournalEntry
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiJournalEntriesAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: JournalEntriesFilter
sort?: JournalEntriesSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiJournalEntriesDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiJournalEntriesOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiJournalEntriesUpdateRequest {
id: string
journalEntry: JournalEntry
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiLedgerAccountsAddRequest {
ledgerAccount: LedgerAccount
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiLedgerAccountsAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: LedgerAccountsFilter
sort?: LedgerAccountsSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiLedgerAccountsDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiLedgerAccountsOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiLedgerAccountsUpdateRequest {
id: string
ledgerAccount: LedgerAccount
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiLocationsAddRequest {
location: AccountingLocation
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiLocationsAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
fields?: string | null
filter?: AccountingLocationsFilter
}
export interface AccountingApiLocationsDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiLocationsOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiLocationsUpdateRequest {
id: string
location: AccountingLocation
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiPaymentsAddRequest {
payment: Payment
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiPaymentsAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: PaymentsFilter
sort?: PaymentsSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiPaymentsDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiPaymentsOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiPaymentsUpdateRequest {
id: string
payment: Payment
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiProfitAndLossOneRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
filter?: ProfitAndLossFilter
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiPurchaseOrdersAddRequest {
purchaseOrder: PurchaseOrder
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiPurchaseOrdersAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
passThrough?: PassThroughQuery
limit?: number
filter?: PurchaseOrdersFilter
sort?: PurchaseOrdersSort
}
export interface AccountingApiPurchaseOrdersDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiPurchaseOrdersOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiPurchaseOrdersUpdateRequest {
id: string
purchaseOrder: PurchaseOrder
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiSubsidiariesAddRequest {
subsidiary: Subsidiary
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiSubsidiariesAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
fields?: string | null
}
export interface AccountingApiSubsidiariesDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiSubsidiariesOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiSubsidiariesUpdateRequest {
id: string
subsidiary: Subsidiary
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiSuppliersAddRequest {
supplier: Supplier
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiSuppliersAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: SuppliersFilter
sort?: SuppliersSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiSuppliersDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiSuppliersOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiSuppliersUpdateRequest {
id: string
supplier: Supplier
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiTaxRatesAddRequest {
taxRate: TaxRate
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiTaxRatesAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: TaxRatesFilter
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiTaxRatesDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiTaxRatesOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiTaxRatesUpdateRequest {
id: string
taxRate: TaxRate
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiTrackingCategoriesAddRequest {
trackingCategory: TrackingCategory
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
}
export interface AccountingApiTrackingCategoriesAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
passThrough?: PassThroughQuery
fields?: string | null
}
export interface AccountingApiTrackingCategoriesDeleteRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
export interface AccountingApiTrackingCategoriesOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface AccountingApiTrackingCategoriesUpdateRequest {
id: string
trackingCategory: TrackingCategory
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
}
/**
*
*/
export class AccountingApi extends runtime.BaseAPI {
/**
* Get Aged Creditors
* Get Aged Creditors
*/
async agedCreditorsOneRaw(
requestParameters: AccountingApiAgedCreditorsOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetAgedCreditorsResponse>> {
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.filter !== undefined) {
queryParameters['filter'] = requestParameters.filter
}
if (requestParameters.passThrough !== undefined) {
queryParameters['pass_through'] = requestParameters.passThrough
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/aged-creditors`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetAgedCreditorsResponseFromJSON(jsonValue)
)
}
/**
* Get Aged Creditors
* Get Aged Creditors
*/
async agedCreditorsOne(
requestParameters: AccountingApiAgedCreditorsOneRequest = {},
initOverrides?: RequestInit
): Promise<GetAgedCreditorsResponse> {
const response = await this.agedCreditorsOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Aged Debtors
* Get Aged Debtors
*/
async agedDebtorsOneRaw(
requestParameters: AccountingApiAgedDebtorsOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetAgedDebtorsResponse>> {
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.filter !== undefined) {
queryParameters['filter'] = requestParameters.filter
}
if (requestParameters.passThrough !== undefined) {
queryParameters['pass_through'] = requestParameters.passThrough
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/aged-debtors`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetAgedDebtorsResponseFromJSON(jsonValue)
)
}
/**
* Get Aged Debtors
* Get Aged Debtors
*/
async agedDebtorsOne(
requestParameters: AccountingApiAgedDebtorsOneRequest = {},
initOverrides?: RequestInit
): Promise<GetAgedDebtorsResponse> {
const response = await this.agedDebtorsOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* List Attachments
* List Attachments
*/
async attachmentsAllRaw(
requestParameters: AccountingApiAttachmentsAllRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetAttachmentsResponse>> {
if (requestParameters.referenceType === null || requestParameters.referenceType === undefined) {
throw new runtime.RequiredError(
'referenceType',
'Required parameter requestParameters.referenceType was null or undefined when calling attachmentsAll.'
)
}
if (requestParameters.referenceId === null || requestParameters.referenceId === undefined) {
throw new runtime.RequiredError(
'referenceId',
'Required parameter requestParameters.referenceId was null or undefined when calling attachmentsAll.'
)
}
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.cursor !== undefined) {
queryParameters['cursor'] = requestParameters.cursor
}
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/attachments/{reference_type}/{reference_id}`
.replace(
`{${'reference_type'}}`,
encodeURIComponent(String(requestParameters.referenceType))
)
.replace(
`{${'reference_id'}}`,
encodeURIComponent(String(requestParameters.referenceId))
),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetAttachmentsResponseFromJSON(jsonValue)
)
}
/**
* List Attachments
* List Attachments
*/
async attachmentsAll(
requestParameters: AccountingApiAttachmentsAllRequest,
initOverrides?: RequestInit
): Promise<GetAttachmentsResponse> {
const response = await this.attachmentsAllRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Delete Attachment
* Delete Attachment
*/
async attachmentsDeleteRaw(
requestParameters: AccountingApiAttachmentsDeleteRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<DeleteAttachmentResponse>> {
if (requestParameters.referenceType === null || requestParameters.referenceType === undefined) {
throw new runtime.RequiredError(
'referenceType',
'Required parameter requestParameters.referenceType was null or undefined when calling attachmentsDelete.'
)
}
if (requestParameters.referenceId === null || requestParameters.referenceId === undefined) {
throw new runtime.RequiredError(
'referenceId',
'Required parameter requestParameters.referenceId was null or undefined when calling attachmentsDelete.'
)
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling attachmentsDelete.'
)
}
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/attachments/{reference_type}/{reference_id}/{id}`
.replace(
`{${'reference_type'}}`,
encodeURIComponent(String(requestParameters.referenceType))
)
.replace(`{${'reference_id'}}`, encodeURIComponent(String(requestParameters.referenceId)))
.replace(`{${'id'}}`, encodeURIComponent(String(requestParameters.id))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
DeleteAttachmentResponseFromJSON(jsonValue)
)
}
/**
* Delete Attachment
* Delete Attachment
*/
async attachmentsDelete(
requestParameters: AccountingApiAttachmentsDeleteRequest,
initOverrides?: RequestInit
): Promise<DeleteAttachmentResponse> {
const response = await this.attachmentsDeleteRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Download Attachment
* Download Attachment
*/
async attachmentsDownloadRaw(
requestParameters: AccountingApiAttachmentsDownloadRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<Blob>> {
if (requestParameters.referenceType === null || requestParameters.referenceType === undefined) {
throw new runtime.RequiredError(
'referenceType',
'Required parameter requestParameters.referenceType was null or undefined when calling attachmentsDownload.'
)
}
if (requestParameters.referenceId === null || requestParameters.referenceId === undefined) {
throw new runtime.RequiredError(
'referenceId',
'Required parameter requestParameters.referenceId was null or undefined when calling attachmentsDownload.'
)
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling attachmentsDownload.'
)
}
const queryParameters: any = {}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/attachments/{reference_type}/{reference_id}/{id}/download`
.replace(
`{${'reference_type'}}`,
encodeURIComponent(String(requestParameters.referenceType))
)
.replace(`{${'reference_id'}}`, encodeURIComponent(String(requestParameters.referenceId)))
.replace(`{${'id'}}`, encodeURIComponent(String(requestParameters.id))),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.BlobApiResponse(response)
}
/**
* Download Attachment
* Download Attachment
*/
async attachmentsDownload(
requestParameters: AccountingApiAttachmentsDownloadRequest,
initOverrides?: RequestInit
): Promise<Blob> {
const response = await this.attachmentsDownloadRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Attachment
* Get Attachment
*/
async attachmentsOneRaw(
requestParameters: AccountingApiAttachmentsOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetAttachmentResponse>> {
if (requestParameters.referenceType === null || requestParameters.referenceType === undefined) {
throw new runtime.RequiredError(
'referenceType',
'Required parameter requestParameters.referenceType was null or undefined when calling attachmentsOne.'
)
}
if (requestParameters.referenceId === null || requestParameters.referenceId === undefined) {
throw new runtime.RequiredError(
'referenceId',
'Required parameter requestParameters.referenceId was null or undefined when calling attachmentsOne.'
)
}
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling attachmentsOne.'
)
}
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/attachments/{reference_type}/{reference_id}/{id}`
.replace(
`{${'reference_type'}}`,
encodeURIComponent(String(requestParameters.referenceType))
)
.replace(`{${'reference_id'}}`, encodeURIComponent(String(requestParameters.referenceId)))
.replace(`{${'id'}}`, encodeURIComponent(String(requestParameters.id))),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetAttachmentResponseFromJSON(jsonValue)
)
}
/**
* Get Attachment
* Get Attachment
*/
async attachmentsOne(
requestParameters: AccountingApiAttachmentsOneRequest,
initOverrides?: RequestInit
): Promise<GetAttachmentResponse> {
const response = await this.attachmentsOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get BalanceSheet
* Get BalanceSheet
*/
async balanceSheetOneRaw(
requestParameters: AccountingApiBalanceSheetOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetBalanceSheetResponse>> {
const queryParameters: any = {}
if (requestParameters.passThrough !== undefined) {
queryParameters['pass_through'] = requestParameters.passThrough
}
if (requestParameters.filter !== undefined) {
queryParameters['filter'] = requestParameters.filter
}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/balance-sheet`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetBalanceSheetResponseFromJSON(jsonValue)
)
}
/**
* Get BalanceSheet
* Get BalanceSheet
*/
async balanceSheetOne(
requestParameters: AccountingApiBalanceSheetOneRequest = {},
initOverrides?: RequestInit
): Promise<GetBalanceSheetResponse> {
const response = await this.balanceSheetOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Create Bill Payment
* Create Bill Payment
*/
async billPaymentsAddRaw(
requestParameters: AccountingApiBillPaymentsAddRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<CreateBillPaymentResponse>> {
if (requestParameters.billPayment === null || requestParameters.billPayment === undefined) {
throw new runtime.RequiredError(
'billPayment',
'Required parameter requestParameters.billPayment was null or undefined when calling billPaymentsAdd.'
)
}
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
const headerParameters: runtime.HTTPHeaders = {}
headerParameters['Content-Type'] = 'application/json'
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/bill-payments`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: BillPaymentToJSON(requestParameters.billPayment)
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
CreateBillPaymentResponseFromJSON(jsonValue)
)
}
/**
* Create Bill Payment
* Create Bill Payment
*/
async billPaymentsAdd(
requestParameters: AccountingApiBillPaymentsAddRequest,
initOverrides?: RequestInit
): Promise<CreateBillPaymentResponse> {
const response = await this.billPaymentsAddRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* List Bill Payments
* List Bill Payments
*/
async billPaymentsAllRaw(
requestParameters: AccountingApiBillPaymentsAllRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetBillPaymentsResponse>> {
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.cursor !== undefined) {
queryParameters['cursor'] = requestParameters.cursor
}
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit
}
if (requestParameters.filter !== undefined) {
queryParameters['filter'] = requestParameters.filter
}
if (requestParameters.sort !== undefined) {
queryParameters['sort'] = requestParameters.sort
}
if (requestParameters.passThrough !== undefined) {
queryParameters['pass_through'] = requestParameters.passThrough
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/bill-payments`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetBillPaymentsResponseFromJSON(jsonValue)
)
}
/**
* List Bill Payments
* List Bill Payments
*/
async billPaymentsAll(
requestParameters: AccountingApiBillPaymentsAllRequest = {},
initOverrides?: RequestInit
): Promise<GetBillPaymentsResponse> {
const response = await this.billPaymentsAllRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Delete Bill Payment
* Delete Bill Payment
*/
async billPaymentsDeleteRaw(
requestParameters: AccountingApiBillPaymentsDeleteRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<DeleteBillPaymentResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling billPaymentsDelete.'
)
}
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/accounting/bill-payments/{id}`.replace(
`{${'id'}}`,
encodeURIComp