@ptkl/sdk - v1.3.4
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    actionGetOnOrder actionGetOnStockEntry actionOnInbox actionOnIssuedInvoice actionOnIssuedInvoicePosting actionPutOnOrder actionPutOnStockEntry deleteAddress deleteAnalytic deleteBankAccount deleteContact deleteCusomter deleteDocument deleteDocumentAttachment deleteEmployee deleteInbox deleteInboxAttachment deleteIssuedInvoice deleteIssuedInvoicePosting deleteItem deleteJournal deleteJournalVatEntry deleteOrder deleteProductGroup deleteReceivedInvoice deleteStockEntry deleteWarehouse getAccount getAccountByCode getAccountByContent getAccounts getAccountsForSync getAddress getAddresses getAddressesForSync getAllOrganisations getAllOuboxes getAnalytic getAnalytics getAnalyticsForSync getBankAccount getBankAccounts getBankAccountsForSync getContact getContactForSync getContacts getCountries getCountriesForSync getCountry getCountryByCode getCurrencies getCurrenciesForSync getCurrency getCurrencyByCode getCurrencyByDate getCurrentUser getCurrentUserOrgs getCustomer getCustomerByCode getCustomerContacts getCustomers getCustomersForSync getDashboardsData getDocument getDocumentAttachment getDocumentNumbering getDocumentNumberings getDocuments getDocumentsForSync getEFakturaList getEmployee getEmployees getEmployeesForSync getExchangeRate getExchangeRateByCode getInbox getInboxes getIssuedInvoice getIssuedInvoicePosting getIssuedInvoicePostings getIssuedInvoices getIssuedInvoicesForSync getItem getItemByCode getItemData getItemPricelist getItems getItemSettings getItemsForSync getJournal getJournalEntries getJournals getJournalsForSync getJournalsInVODStandard getJournalType getJournalTypeByCode getJournalTypes getJournalTypesForSync getJournalVatEntry getOrder getOrders getOrdersForSync getOrganisation getOutbox getPaymentMethods getPaymentMethodsOnIssuedInvoicePostings getPaymentMethodsOnIssuedInvoices getPayrollSettingsByCode getPostalCode getPostalCodesByCountry getPostalCodesForSync getProductGroup getProductGroups getProductGroupsForSync getPurposeCode getPurposeCodeByCode getPurposeCodes getPurposeCodesForSync getReceivedInvoice getReceivedInvoices getReceivedInvoicesAttachments getReportTemplate getReportTemplates getReportTemplatesForSync getStock getStockEntries getStockEntry getStockForItem getVatAccountingTypes getVatAccountingTypesForSync getVatRate getVatRateByCode getVatRates getVatRatesForSync getWarehouse getWarehouses getWarehousesForSync newAddress newAnalytic newBankAccount newContact newCustomer newCustomerByTaxNumber newDocument newDocumentAttachment newEmployee newInbox newInboxAttachment newIssuedInvoice newIssuedInvoicePosting newItem newJournal newJournalVatEntry newOrder newProductGroup newReceivedInvoice newReceivedInvoiceAttachment newStockEntry newWarehouse setClient settings updateAddress updateAnalytic updateBankAccount updateContact updateCustomer updateDocument updateDocumentAttachment updateEmployee updateIssuedInvoice updateItem updateJournal updateJournalVatEntry updateOrder updateProductGroup updateReceivedInvoice updateStockEntry updateWarehouse

    Constructors

    • Parameters

      • Optionaloptions: { env?: string; host?: string; token?: string }

      Returns default

    Properties

    client: AxiosInstance
    env: null | string = null
    host: null | string = null
    token: null | string = null

    Methods

    • Parameters

      • userId: string
      • organisationId: number
      • orderId: number
      • action: "getorderpdf"
      • Optionalparams: { rowVersion?: string }

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • stockEntryId: number
      • action: "getDeliveryNotepdf"
      • Optionalparams: { rowVersion?: string }

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • inboxId: number
      • action: "approve" | "reject"

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • issuedInvoiceId: number
      • action:
            | "issue"
            | "issueCancellation"
            | "generatepdf"
            | "copytocreditnote"
            | "copyToReverse"
            | "issueAndGeneratepdf"
            | "sendEInvoice"

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • issuedInvoicePostingId: number
      • action: "issue" | "issueCancellation"

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • orderId: number
      • action:
            | "generatepdf"
            | "confirm"
            | "cancelConfirmation"
            | "complete"
            | "cancelCompletion"
            | "invalidate"
            | "cancelInvalidation"
            | "createissuedinvoice"
      • Optionalparams: { rowVersion?: string }

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • stockEntryId: number
      • action: "confirm" | "cancelConfirmation"
      • Optionalparams: { rowVersion?: string }

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • addressId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • analyticId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • bankAccountId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • contactId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • documentId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • documentId: number
      • documentAttachmentId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • employeeId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • inboxId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • inboxId: number
      • inboxAttachmentId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • issuedInvoiceId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • issuedInvoicePostingId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • itemId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • journalId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • journalId: number
      • vatId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • orderId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • productGroupId: number

      Returns Promise<{}>

    • RECEIVED INVOICES

      Parameters

      • userId: string
      • organisationId: number
      • receivedInvoiceId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • stockEntryId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • warehouseId: number

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • accountId: number

      Returns Promise<MinimaxAccount>

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<MinimaxAccount>

    • Parameters

      • userId: string
      • organisationId: number
      • content: string

      Returns Promise<MinimaxAccount>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • addressId: number

      Returns Promise<MinimaxAddress>

    • Parameters

      • userId: string
      • params: { endRowIndex: number; searchString: string; startRowIndex: number }

      Returns Promise<MinimaxSearchResult<MinimaxOrganisation>>

    • OUTBOX

      Parameters

      • userId: string
      • organisationId: number
      • params: MinimaxSearchParams<MinimaxOutbox> & {
            OutboxDateFrom?: string;
            OutboxDateTo?: string;
            OutboxImportStatus?: string;
            OutboxType?: string;
        }

      Returns Promise<MinimaxSearchResult<MinimaxOutbox>>

    • Parameters

      • userId: string
      • organisationId: number
      • analyticId: number

      Returns Promise<MinimaxAnalytic>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • bankAccountId: number

      Returns Promise<MinimaxBankAccount>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • contactId: number

      Returns Promise<MinimaxContact>

    • Parameters

      • userId: string
      • organisationId: number
      • countryId: number

      Returns Promise<MinimaxCountry>

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<MinimaxCountry>

    • Parameters

      • userId: string
      • organisationId: number
      • currencyId: number

      Returns Promise<MinimaxCurrency>

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<MinimaxCurrency>

    • Parameters

      • userId: string
      • organisationId: number
      • date: Date

      Returns Promise<MinimaxCurrency>

    • USERS

      Parameters

      • userId: string

      Returns Promise<MinimaxUser>

    • Parameters

      • userId: string

      Returns Promise<
          MinimaxSearchResult<
              {
                  APIAccess: string;
                  MobileAccess: string;
                  Organisation: MinimaxReference;
              },
          >,
      >

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number

      Returns Promise<MinimaxCustomer>

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<MinimaxCustomer>

    • DASHBOARDS

      Parameters

      • userId: string
      • organisationId: number

      Returns Promise<MinimaxDashboardData>

    • Parameters

      • userId: string
      • organisationId: number
      • documentId: number

      Returns Promise<MinimaxDocument>

    • Parameters

      • userId: string
      • organisationId: number
      • documentId: number
      • documentAttachmentId: number

      Returns Promise<MinimaxDocumentAttachment>

    • Parameters

      • userId: string
      • organisationId: number
      • documentNumberingId: number

      Returns Promise<MinimaxDocumentNumbering>

    • Parameters

      • userId: string
      • organisationId: number
      • employeeId: number

      Returns Promise<MinimaxEmployee>

    • EXCHANGE RATES

      Parameters

      • userId: string
      • organisationId: number
      • currencyId: number

      Returns Promise<MinimaxExchangeRate>

    • Parameters

      • userId: string
      • organisationId: number
      • currencyCode: string

      Returns Promise<MinimaxExchangeRate>

    • Parameters

      • userId: string
      • organisationId: number
      • inboxId: number

      Returns Promise<MinimaxInbox>

    • Parameters

      • userId: string
      • organisationId: number
      • issuedInvoiceId: number

      Returns Promise<MinimaxIssuedInvoice>

    • Parameters

      • userId: string
      • organisationId: number
      • issuedInvoicePostingId: number

      Returns Promise<MinimaxIssuedInvoicePosting>

    • Parameters

      • userId: string
      • organisationId: number
      • itemId: number

      Returns Promise<MinimaxItem>

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<MinimaxItem>

    • Parameters

      • userId: string
      • organisationId: number
      • params: { CustomerId: number; ItemId: number; WarehouseId: number }

      Returns Promise<
          {
              Rows: (
                  Pick<MinimaxItem, "Title" | "Code" | "Price" | "UnitOfMeasurement"> & {
                      Customer: MinimaxReference;
                      Item: MinimaxReference;
                      Warehouse: MinimaxReference;
                  }
              )[];
              ValidationMessages: { Message: string; PropertyName: string }[];
          },
      >

    • Parameters

      • userId: string
      • organisationId: number
      • params: { CustomerId: number; ItemId: number; WarehouseId: number }

      Returns Promise<
          {
              Rows: (
                  Pick<MinimaxItem, "Title" | "Code" | "UnitOfMeasurement"> & {
                      Customer: MinimaxReference;
                      Item: MinimaxReference;
                      PriceWithoutVAT: number;
                      PriceWithVAT: number;
                      Warehouse: MinimaxReference;
                  }
              )[];
              ValidationMessages: { Message: string; PropertyName: string }[];
          },
      >

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<{ PricesIncludeVAT: string }>

    • Parameters

      • userId: string
      • organisationId: number
      • journalId: number

      Returns Promise<MinimaxJournal>

    • Parameters

      • userId: string
      • organisationId: number
      • Optionalparams: MinimaxSearchParams<MinimaxLeanJournal> & {
            RecordDtModifiedFrom?: Date;
            RecordDtModifiedTo?: Date;
        } & {
            DateFrom?: string;
            DateTo?: string;
            FromJournalId?: number;
            JournalId?: number;
        }

      Returns Promise<
          {
              Content: string;
              Headers: string;
              IsSuccessStatusCode: string;
              ReasonPhrase: string;
              RequestMessage: string;
              StatusCode: string;
              Version: string;
          },
      >

    • Parameters

      • userId: string
      • organisationId: number
      • journalTypeId: number

      Returns Promise<MinimaxJournalType>

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<MinimaxJournalType>

    • Parameters

      • userId: string
      • organisationId: number
      • journalId: number
      • vatId: number

      Returns Promise<MinimaxJournalVatEntry>

    • Parameters

      • userId: string
      • organisationId: number
      • orderId: number

      Returns Promise<MinimaxOrder>

    • ORGANISATIONS

      Parameters

      • userId: string
      • organisationId: number

      Returns Promise<MinimaxOrganisation>

    • Parameters

      • userId: string
      • organisationId: number
      • outboxId: number

      Returns Promise<MinimaxOutbox>

    • PAYROLL SETTINGS

      Parameters

      • userId: string
      • code: string

      Returns Promise<MinimaxPayrollSettings>

    • Parameters

      • userId: string
      • organisationId: number
      • postalCodeId: number

      Returns Promise<MinimaxPostalCode>

    • Parameters

      • userId: string
      • organisationId: number
      • productGroupId: number

      Returns Promise<MinimaxProductGroup>

    • Parameters

      • userId: string
      • organisationId: number
      • purposeCodeId: number

      Returns Promise<MinimaxPurposeCode>

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<MinimaxPurposeCode>

    • Parameters

      • userId: string
      • organisationId: number
      • receivedInvoiceId: number

      Returns Promise<MinimaxReceivedInvoice>

    • Parameters

      • userId: string
      • organisationId: number
      • reportTemplateId: number

      Returns Promise<MinimaxReportTemplate>

    • Parameters

      • userId: string
      • organisationId: number
      • stockEntryId: number

      Returns Promise<MinimaxStockEntry>

    • Parameters

      • userId: string
      • organisationId: number
      • itemId: number

      Returns Promise<MinimaxStock>

    • Parameters

      • userId: string
      • organisationId: number
      • vatRateId: number

      Returns Promise<MinimaxVatRate>

    • Parameters

      • userId: string
      • organisationId: number
      • code: string

      Returns Promise<MinimaxVatRate>

    • Parameters

      • userId: string
      • organisationId: number
      • warehouseId: number

      Returns Promise<MinimaxWarehouse>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • address: MinimaxAddress

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • contact: MinimaxContact

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • taxNumber: string

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      • client: AxiosInstance

      Returns default

    • Returns Promise<AxiosResponse<any, any>>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • address: MinimaxAddress

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      • userId: string
      • organisationId: number
      • customerId: number
      • contact: MinimaxContact

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>

    • Parameters

      Returns Promise<{}>