caesardev/visma-erp-client

PHP Client for VismaNet ERP API

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

pkg:composer/caesardev/visma-erp-client

dev-main 2025-12-11 15:04 UTC

This package is auto-updated.

Last update: 2025-12-11 15:04:59 UTC


README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/VismaNetClient/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: serviceapi
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$active = True; // bool | Set to True to select active accounts.
$include_account_class_description = True; // bool | Set to True to include AccountClass description.
$greater_than_value = 'greater_than_value_example'; // string | Enter the from-value for Account no.
$public_code = 'public_code_example'; // string | Filter by the Public code 1, authorities mapped code to the account.
$external_code1 = 'external_code1_example'; // string | Filter by External code 1 (field used for sorting and inquiries.)
$external_code2 = 'external_code2_example'; // string | Filter by External code 2 (field used for sorting and inquiries.)
$analysis_code = 'analysis_code_example'; // string | Filter by Analysis code (field used for sorting and inquiries.)
$number_to_read = 56; // int | This field has been deprecated and will be removed in future versions.
$skip_records = 56; // int | This field has been deprecated and will be removed in future versions.
$last_modified_date_time = 'last_modified_date_time_example'; // string | This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.    Accepted format:  * ```yyyy-MM-dd```  * ```yyyy-MM-dd HH:mm:ss```  * ```yyyy-MM-dd HH:mm:ss.FFF```  * ```yyyy-MM-ddTHH:mm:ss```  * ```yyyy-MM-ddTHH:mm:ss.FFF```    _Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.
$last_modified_date_time_condition = 'last_modified_date_time_condition_example'; // string | This value represents the condition to be applied when retrieving records.    Accepted values (without the single quotes):  * '&gt;' for greater than  * '&lt;' for less than  * '&gt;=' for greater than or equal  * '&lt;=' for less than or equal    _Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.
$erp_api_background = 'erp_api_background_example'; // string | Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location. Supported values: * a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location. * \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished. * \"subscription[:<name_1>=<value_1>,..,<name_n>=<value_n>]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client. Optionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.  To find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content

try {
    $result = $apiInstance->accountGetAll($active, $include_account_class_description, $greater_than_value, $public_code, $external_code1, $external_code2, $analysis_code, $number_to_read, $skip_records, $last_modified_date_time, $last_modified_date_time_condition, $erp_api_background);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountGetAll: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.finance.visma.net

Class Method HTTP request Description
AccountApi accountGetAll GET /v1/account Get a range of General ledger accounts - ScreenId=GL202500
AccountApi accountGetByaccountCd GET /v1/account/{accountCd} Get a specific Account - ScreenId=GL202500
AccountApi accountPost POST /v1/account Creates an account
AccountApi accountPutByaccountCd PUT /v1/account/{accountCd} Updates an account
AttachmentApi attachmentGetByattachmentId GET /v1/attachment/{attachmentId} Get latest revision of a specific Attachment
AttachmentApi attachmentPutByattachmentId PUT /v1/attachment/{attachmentId} Update a specific Attachment
AttributeApi attributeDeleteByattributeId DELETE /v1/attribute/{attributeId} Deletes an attribute
AttributeApi attributeGetAttributeByattributeId GET /v1/attribute/{attributeId} Get specific Attribute
AttributeApi attributeGetAttributes GET /v1/attribute Get a range of General ledger attributes - screen ID: CS205000. Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
AttributeApi attributePost POST /v1/attribute Creates an attribute
AttributeApi attributePutByattributeId PUT /v1/attribute/{attributeId} Updates an attribute
BackgroundApi backgroundGetBackgroundApiOperationByrequestId GET /v1/background/{requestId} Gets the state of a previously started background API operation
BackgroundApi backgroundGetBackgroundApiOperationContentByrequestId GET /v1/background/{requestId}/content Gets the response content, if any, of a previously started background API operation that has finished
BlobApi blobGetByblobId GET /v1/blob/download/{blobId} Get a specific blob (attachment)
BlobApi blobGetMetadataByblobId GET /v1/blob/metadata/{blobId} Get metadata for a specific blob (attachment)
BlobApi blobGetPresignedUrl GET /v1/blob/presignedurl Get a presigned URL to download a specific blob (attachment)
BranchApi branchGetAllBranches GET /v1/branch Get a range of Branches - ScreenId=CS101500
BranchApi branchGetSpecificBranchBybranchNumber GET /v1/branch/{branchNumber} Get a specific branch
BranchApi branchPutBankSettingsForBranchBybranchNumber PUT /v1/branch/{branchNumber}/BankSettings Update bank settings for branch.
BudgetApi budgetCreateBudget POST /v1/budget Create a Budget
BudgetApi budgetGetAll GET /v1/budget Get a range of General Ledger Budget Figures - ScreenId=GL302010
BudgetApi budgetPut PUT /v1/budget Update a specific Budget
CarrierApi carrierGetAllCarriers GET /v1/carrier Get a range of Carriers - ScreeId=CS207500
CarrierApi carrierGetCarrierBycarrierName GET /v1/carrier/{carrierName} Get a specific Carrier
CashAccountApi cashAccountGetAll GET /v1/cashaccount Get all Cash Accounts - ScreenId=CA202000
CashAccountApi cashAccountGetByaccountNumber GET /v1/cashaccount/{accountNumber} Get a specific cash account
CashSaleApi cashSaleGetAllCashSales GET /v1/cashsale Get a range of Cash Sales - ScreenId=AR304000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2021-October:Added forced pagination
CashSaleApi cashSaleGetBydocumentNumber GET /v1/cashsale/{documentNumber} Get a specific Cash Sale
CashSaleApi cashSalePost POST /v1/cashsale Create a Cash Sale
CashSaleApi cashSalePutBydocumentNumber PUT /v1/cashsale/{documentNumber} Update a specific Cash Sale
CashTransactionApi cashTransactionCreateAttachmentByreferenceNbr POST /v1/cashTransaction/{referenceNbr}/attachment Creates an attachment and associates it with a cash transaction document. If the file already exists, a new revision is created.
CashTransactionApi cashTransactionCreateCashTransaction POST /v1/cashTransaction Create a Cash Transaction- ScreenID=CA304000
CashTransactionApi cashTransactionGetAll GET /v1/cashTransaction Get all Transaction - ScreenID=CA304000
CashTransactionApi cashTransactionGetByreferenceNbr GET /v1/cashTransaction/{referenceNbr} Get a specific Transaction - ScreenID=CA304000
CashTransactionApi cashTransactionPutByreferenceNbr PUT /v1/cashTransaction/{referenceNbr} Update a specific CashTransaction - ScreenID=CA304000
CashTransactionApi cashTransactionReleaseByreferenceNbr POST /v1/cashTransaction/{referenceNbr}/action/release Release cash transaction - ScreenID=CA304000
CashTransactionApi cashTransactionReverseByreferenceNbr POST /v1/cashTransaction/{referenceNbr}/action/reverse Reverse a Cash Transaction- ScreenID=CA304000
ContactApi contactCreateContact POST /v1/contact Create a Contact
ContactApi contactGetAllContacts GET /v1/contact Get a range of Contacts - ScreenId=CR302000
ContactApi contactGetBycontactId GET /v1/contact/{contactId} Get a specific Contact
ContactApi contactPutBycontactId PUT /v1/contact/{contactId} Update a specific Contact
ContractTemplateApi contractTemplateGetAll GET /v1/contractTemplate Get a range of Contract Templates - ScreenId=CT202000
ContractUsageApi contractUsageGetAll GET /v1/contractUsage Get a range of Contract Usage - ScreenId=CT303000
ContractUsageApi contractUsageGetSpecificBycontractId GET /v1/contractUsage/{contractId} Get a specific Contract Usage
ContractUsageApi contractUsagePutBycontractId PUT /v1/contractUsage/{contractId} Update a specific Contract Usage
CountryApi countryGetCountries GET /v1/country Get a range of Countries - ScreenId=CS20400S Please use a page size lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
CountryApi countryGetCountryBycountryId GET /v1/country/{countryId} Get a specific Country
CreditNoteApi creditNoteCreateCreditNote POST /v1/creditNote Create a Credit Note - Method is deprecated start using the new method in endpoint Customer Credit Note
CreditNoteApi creditNoteCreateHeaderAttachmentBycreditNoteNumber POST /v1/creditNote/{creditNoteNumber}/attachment Creates an attachment and associates it with a Credit Note. If the file already exists, a new revision is created. - Method is deprecated start using the new method in endpoint Customer Credit Note
CreditNoteApi creditNoteCreateLineAttachmentBycreditNoteNumberlineNumber POST /v1/creditNote/{creditNoteNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain Credit Note line. If the file already exists, a new revision is created. - Method is deprecated start using the new method in endpoint Customer Credit Note
CreditNoteApi creditNoteGetAllCreditNotesDto GET /v1/creditNote Get a range of Credit Notes - Method is deprecated start using the new method in endpoint Customer Credit Note
CreditNoteApi creditNoteGetBycreditNoteNumber GET /v1/creditNote/{creditNoteNumber} Get a specific Credit Note - Method is deprecated start using the new method in endpoint Customer Credit Note
CreditNoteApi creditNotePutBycreditNoteNumber PUT /v1/creditNote/{creditNoteNumber} Update a specific Credit Note - Method is deprecated start using the new method in endpoint Customer Credit Note
CreditNoteApi creditNoteReleaseInvoiceBycreditNoteNumber POST /v1/creditNote/{creditNoteNumber}/action/release Release credit note operation - Method is deprecated start using the new method in endpoint Customer Credit Note
CreditTermApi creditTermGetCreditTerms GET /v1/creditTerm Get a range of credit terms - ScreenId=CS206500
CurrencyApi currencyGetAll GET /v1/currency Get all available Currencies - ScreenId=CM202000
CurrencyApi currencyGetSpecificCurrencyBycuryId GET /v1/currency/{curyId} Get a specific Currency - ScreenId=CM202000
CurrencyRateApi currencyRateGetAll GET /v2/currencyrate Get all currency rates.
CurrencyRateApi currencyRatePostCurrencyRate POST /v2/currencyrate Create currency rate.
CurrencyRateApi currencyRatePutCurrencyRateBycurrencyRateId PUT /v2/currencyrate/{currencyRateId} Update Currency rate.
CurrencyRateTypeApi currencyRateTypeGetAll GET /v2/currencyratetype Get currency rate types.
CurrencyRateTypeApi currencyRateTypePost POST /v2/currencyratetype Create currency rate type.
CustomerApi customerChangeCustomerNrActionByinternalId POST /v1/customer/action/changeCustomerCd/{internalId} Updates the CustomerNr for the specified Customer
CustomerApi customerCreateDunningLetterActionBycustomer POST /v1/customer/{customer}/action/createDunningLetter Creates dunning letters for a specific customer
CustomerApi customerGetAll GET /v1/customer Get a range of customers - ScreenId=AR303000
CustomerApi customerGetAllCashSalesForCustomerBycustomerNumber GET /v1/customer/{customerNumber}/cashSale Get a range of cash sales for a specific customer
CustomerApi customerGetAllContactsForCustomerBycustomerCd GET /v1/customer/{customerCd}/contact Get a range of Contacts of a specific customer
CustomerApi customerGetAllCustomerBalance GET /v1/customer/balance Get the balance for a range of customers
CustomerApi customerGetAllDocumentsForCustomerBycustomerNumber GET /v1/customer/{customerNumber}/document Gets a range of documents for a specific customer
CustomerApi customerGetAllInvoicesForCustomerBycustomerNumber GET /v1/customer/{customerNumber}/invoice Get a range of invoices for a specific customer
CustomerApi customerGetAllOrderForCustomerBycustomerCd GET /v1/customer/{customerCd}/salesorder Get a range of SO Orders of a specific customer
CustomerApi customerGetAllSalesOrderBasicForCustomerBycustomerCd GET /v1/customer/{customerCd}/salesorderbasic Get a range of SO Orders Basic of a specific customer
CustomerApi customerGetBycustomerCd GET /v1/customer/{customerCd} Get a specific customer
CustomerApi customerGetByinternalID GET /v1/customer/internal/{internalID} Get a specific customer by internalID
CustomerApi customerGetCustomerBalanceBycustomerCd GET /v1/customer/{customerCd}/balance Get a specific customer's balance - ScreenId=AR303000
CustomerApi customerGetCustomerClasses GET /v1/customer/customerClass Get Customer Classes - ScreenId=AR201000
CustomerApi customerGetCustomerDirectDebitBycustomerCd GET /v1/customer/{customerCd}/directdebit Get direct debit information for a specific customer(only for Netherlands)
CustomerApi customerGetCustomerNoteBycustomerCd GET /v1/customer/{customerCd}/note Get a specific customer's note
CustomerApi customerGetSalesPersonsForCustomerBycustomerCd GET /v1/customer/{customerCd}/salespersons Get a range of Sales Persons of a specific customer
CustomerApi customerGetSpecificCustomerClassBycustomerClassId GET /v1/customer/customerClass/{customerClassId} Get a specific customer class - ScreenId=AR201000
CustomerApi customerPost POST /v1/customer Creates a customer
CustomerApi customerPutBycustomerCd PUT /v1/customer/{customerCd} Updates a specific customer
CustomerApi customerPutByinternalID PUT /v1/customer/internal/{internalID} Updates a specific customer using the internalID
CustomerContractApi customerContractActivateContractBycontractId POST /v1/customerContract/{contractId}/action/activateContract Activate contract operation
CustomerContractApi customerContractActivateUpgradeBycontractId POST /v1/customerContract/{contractId}/action/activateUpgrade Activate upgrade contract operation
CustomerContractApi customerContractCreateCustomerContract POST /v1/customerContract Create a CustomerContract
CustomerContractApi customerContractGetAll GET /v1/customerContract Get a range of Customer Contracts, a filter needs to be specified - ScreenId=CT301000
CustomerContractApi customerContractGetCustomerContractBycontractId GET /v1/customerContract/{contractId} Get a specific Customer Contract
CustomerContractApi customerContractGetCustomerContractDetailsBycontractId GET /v1/customerContract/{contractId}/details Get a specific Customer Contract Details
CustomerContractApi customerContractGetCustomerContractRecurringSummaryBycontractId GET /v1/customerContract/{contractId}/recurringSummary Get a specific Customer Contract Recurring Summary
CustomerContractApi customerContractGetCustomerContractSummaryBycontractId GET /v1/customerContract/{contractId}/summary Get a specific Customer Contract Summary
CustomerContractApi customerContractPutBycontractId PUT /v1/customerContract/{contractId} Update a specific CustomerContract
CustomerContractApi customerContractSetupAndActivateContractBycontractId POST /v1/customerContract/{contractId}/action/setupAndActivateContract Setup and Activate contract operation
CustomerContractApi customerContractSetupContractBycontractId POST /v1/customerContract/{contractId}/action/setupContract Setup contract operation
CustomerContractApi customerContractTerminateContractBycontractId POST /v1/customerContract/{contractId}/action/terminateContract Terminate contract operation
CustomerContractApi customerContractUpgradeContractBycontractId POST /v1/customerContract/{contractId}/action/upgradeContract Upgrade contract operation
CustomerCreditNoteApi customerCreditNoteCreate POST /v1/customerCreditNote Create a Credit Note. Method is deprecated and will be removed starting May 2021 - start using new method CustomerCreditNoteV2 endpoint.
CustomerCreditNoteApi customerCreditNoteCreateHeaderAttachmentBycreditNoteNumber POST /v1/customerCreditNote/{creditNoteNumber}/attachment Creates an attachment and associates it with a credit note. If the file already exists, a new revision is created.
CustomerCreditNoteApi customerCreditNoteCreateLineAttachmentBycreditNoteNumberlineNumber POST /v1/customerCreditNote/{creditNoteNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain credit note line. If the file already exists, a new revision is created.
CustomerCreditNoteApi customerCreditNoteDeleteBycreditNoteNumber DELETE /v1/customerCreditNote/{creditNoteNumber} Deletes a specific Customer Credit Note
CustomerCreditNoteApi customerCreditNoteGetAll GET /v1/customerCreditNote Get a range of Customer Credit Notes - ScreenId=AR301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
CustomerCreditNoteApi customerCreditNoteGetBycreditNoteNumber GET /v1/customerCreditNote/{creditNoteNumber} Get a specific Customer Credit Note
CustomerCreditNoteApi customerCreditNotePrintBycreditNoteNumber GET /v1/customerCreditNote/{creditNoteNumber}/print Get the print report of a Customer Credit Note
CustomerCreditNoteApi customerCreditNoteReleaseDocumentBycreditNoteNumber POST /v1/customerCreditNote/{creditNoteNumber}/action/release Release credit note operation
CustomerCreditNoteApi customerCreditNoteSendToAutoInvoiceBycreditNoteNumber POST /v1/customerCreditNote/{creditNoteNumber}/action/sendToAutoInvoice SendToAutoInvoice credit note operation
CustomerCreditNoteApi customerCreditNoteUpdateBycreditNoteNumber PUT /v1/customerCreditNote/{creditNoteNumber} Update a specific Credit Note
CustomerCreditNoteV2Api customerCreditNoteV2Create POST /v2/customerCreditNote Create a Customer Credit Note. ScreenID=AR301000
CustomerCreditWriteOffApi customerCreditWriteOffGetAll GET /v1/customerCreditWriteOff Get a range of Customer Credit WriteOffs - ScreenId=AR301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
CustomerCreditWriteOffApi customerCreditWriteOffGetBycreditWriteOffNumber GET /v1/customerCreditWriteOff/{creditWriteOffNumber} Get a specific Customer Credit WriteOff
CustomerDebitNoteApi customerDebitNoteCreate POST /v1/customerDebitNote Create a Debit Note. Method is deprecated and will be removed starting May 2021 - start using new method CustomerDebitNoteV2 endpoint.
CustomerDebitNoteApi customerDebitNoteCreateHeaderAttachmentBydebitNoteNumber POST /v1/customerDebitNote/{debitNoteNumber}/attachment Creates an attachment and associates it with a debit note. If the file already exists, a new revision is created.
CustomerDebitNoteApi customerDebitNoteCreateLineAttachmentBydebitNoteNumberlineNumber POST /v1/customerDebitNote/{debitNoteNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain debit note line. If the file already exists, a new revision is created.
CustomerDebitNoteApi customerDebitNoteGetAll GET /v1/customerDebitNote Get a range of Customer Debit Notes - ScreenId=AR301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
CustomerDebitNoteApi customerDebitNoteGetBydebitNoteNumber GET /v1/customerDebitNote/{debitNoteNumber} Get a specific Customer Debit Note
CustomerDebitNoteApi customerDebitNotePrintBydebitNoteNumber GET /v1/customerDebitNote/{debitNoteNumber}/print Get the print report of a Customer Debit Note
CustomerDebitNoteApi customerDebitNoteReleaseDocumentBydebitNoteNumber POST /v1/customerDebitNote/{debitNoteNumber}/action/release Release debit note operation
CustomerDebitNoteApi customerDebitNoteSendToAutoInvoiceBydebitNoteNumber POST /v1/customerDebitNote/{debitNoteNumber}/action/sendToAutoInvoice SendToAutoInvoice debit note operation
CustomerDebitNoteApi customerDebitNoteUpdateBydebitNoteNumber PUT /v1/customerDebitNote/{debitNoteNumber} Update a specific Debit Note
CustomerDebitNoteV2Api customerDebitNoteV2Create POST /v2/customerDebitNote Create a Customer Debit Note. ScreenID=AR301000
CustomerDocumentApi customerDocumentGetAllDocuments GET /v1/customerdocument Gets a range of Customer Documents - ScreenId=AR301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added forced pagination
CustomerInvoiceApi customerInvoiceCorrectInvoiceByinvoiceNumber POST /v1/customerinvoice/{invoiceNumber}/action/correct Create a correction document for a released document
CustomerInvoiceApi customerInvoiceCreate POST /v1/customerinvoice Create an Invoice. Method is deprecated and will be removed starting May 2021 - start using new method CustomerInvoiceV2 endpoint.
CustomerInvoiceApi customerInvoiceCreateHeaderAttachmentByinvoiceNumber POST /v1/customerinvoice/{invoiceNumber}/attachment Creates an attachment and associates it with an invoice. If the file already exists, a new revision is created.
CustomerInvoiceApi customerInvoiceCreateLineAttachmentByinvoiceNumberlineNumber POST /v1/customerinvoice/{invoiceNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain invoice line. If the file already exists, a new revision is created.
CustomerInvoiceApi customerInvoiceDeleteByinvoiceNumber DELETE /v1/customerinvoice/{invoiceNumber} Deletes a specific Customer Invoice
CustomerInvoiceApi customerInvoiceGetAll GET /v1/customerinvoice Get a range of Invoices - ScreenId=AR301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added forced pagination
CustomerInvoiceApi customerInvoiceGetByinvoiceNumber GET /v1/customerinvoice/{invoiceNumber} Get a specific Invoice
CustomerInvoiceApi customerInvoiceGetRotRutByrefNbr GET /v1/customerinvoice/{refNbr}/rotrut Get Rot Rut informations for a Customer Invoice
CustomerInvoiceApi customerInvoiceGetWorkTypes GET /v1/customerinvoice/worktypes Get all Work Types
CustomerInvoiceApi customerInvoicePrintInvoiceByrefNbr GET /v1/customerinvoice/{refNbr}/print Get the print report of a Customer Invoice
CustomerInvoiceApi customerInvoiceReleaseInvoiceByinvoiceNumber POST /v1/customerinvoice/{invoiceNumber}/action/release Release invoice operation
CustomerInvoiceApi customerInvoiceReverseInvoiceAndApplyToNoteByinvoiceNumber POST /v1/customerinvoice/{invoiceNumber}/action/reverseandapplytonote Reverse and Apply to Note
CustomerInvoiceApi customerInvoiceReverseInvoiceByinvoiceNumber POST /v1/customerinvoice/{invoiceNumber}/action/reverse Reverse an Invoice
CustomerInvoiceApi customerInvoiceSendToAutoInvoiceByinvoiceNumber POST /v1/customerinvoice/{invoiceNumber}/action/sendToAutoInvoice SendToAutoInvoice invoice operation
CustomerInvoiceApi customerInvoiceUpdateByinvoiceNumber PUT /v1/customerinvoice/{invoiceNumber} Update a specific Invoice
CustomerInvoiceV2Api customerInvoiceV2Create POST /v2/customerinvoice Create an Invoice. ScreenID=AR301000
CustomerOverdueChargeApi customerOverdueChargeCreateHeaderAttachmentByoverdueChargeNumber POST /v1/customerOverdueCharge/{overdueChargeNumber}/attachment Creates an attachment and associates it with an overdue charge. If the file already exists, a new revision is created.
CustomerOverdueChargeApi customerOverdueChargeCreateLineAttachmentByoverdueChargeNumberlineNumber POST /v1/customerOverdueCharge/{overdueChargeNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain overdue charge line. If the file already exists, a new revision is created.
CustomerOverdueChargeApi customerOverdueChargeGetAll GET /v1/customerOverdueCharge Get a range of Customer Overdue Charges - ScreenId=AR301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
CustomerOverdueChargeApi customerOverdueChargeGetByoverdueChargeNumber GET /v1/customerOverdueCharge/{overdueChargeNumber} Get a specific Customer Overdue Charge
CustomerOverdueChargeApi customerOverdueChargeReleaseDocumentByoverdueChargeNumber POST /v1/customerOverdueCharge/{overdueChargeNumber}/action/release Release overdue charge operation
CustomerOverdueChargeApi customerOverdueChargeUpdateByoverdueChargeNumber PUT /v1/customerOverdueCharge/{overdueChargeNumber} Update a specific Overdue Charge
CustomerPaymentApi customerPaymentCreatePayment POST /v1/customerPayment Create a Payment
CustomerPaymentApi customerPaymentGetAllPayments GET /v1/customerPayment Get a range of Payments. - SceenId=AR302000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
CustomerPaymentApi customerPaymentGetBypaymentNumber GET /v1/customerPayment/{paymentNumber} Get a specific Payment
CustomerPaymentApi customerPaymentPutBypaymentNumber PUT /v1/customerPayment/{paymentNumber} Update a specific Payment
CustomerPaymentApi customerPaymentReleasePaymentBypaymentNumber POST /v1/customerPayment/{paymentNumber}/action/release Release payment operation
CustomerPaymentApi customerPaymentVoidPaymentBypaymentNumber POST /v1/customerPayment/{paymentNumber}/action/void Void payment operation
CustomerPaymentMethodApi customerPaymentMethodCreateCustomerPaymentMethod POST /v1/customerpaymentmethod Create a Customer payment method
CustomerPaymentMethodApi customerPaymentMethodGetCustomerPaymentMethodBycustomerIdcustomerPaymentMethodId GET /v1/customerpaymentmethod/{customerId}/{customerPaymentMethodId} Get one specific Customer payment method for one specific customer. ScreenId=AR303010
CustomerPaymentMethodApi customerPaymentMethodGetCustomerPaymentMethods GET /v1/customerpaymentmethod Get Customer payment methods
CustomerPaymentMethodApi customerPaymentMethodGetCustomerPaymentMethodsBycustomerId GET /v1/customerpaymentmethod/{customerId} Get all Customer payment methods for one specific customer. ScreenId=AR303010 and AR303000
CustomerPaymentMethodApi customerPaymentMethodUpdateCustomerPaymentMethodBycustomerIdcustomerPaymentMethodId PUT /v1/customerpaymentmethod/{customerId}/{customerPaymentMethodId} Update a specific Customer payment method
CustomerSalesPriceApi customerSalesPriceGetCustomerSalesPriceByrecordId GET /v1/customerSalesPrice/{recordId} Get a specific Customer Sales Price by recordId
CustomerSalesPriceApi customerSalesPriceGetCustomerSalesPrices GET /v1/customerSalesPrice Get a range of Customer Sales Prices - ScreenId=AR202000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
CustomerSalesPriceApi customerSalesPricePostCustomerSalesPrice POST /v1/customerSalesPrice Create a new Customer Sales Price
CustomerSalesPriceApi customerSalesPricePutCustomerSalesPriceByrecordId PUT /v1/customerSalesPrice/{recordId} Update an existing Customer Sales Price
CustomerV2Api customerV2GetAllCustomerBalance GET /v2/customer/balance Get the balance for one or multiple customers
DeferralCodeApi deferralCodeGetDeferralCodeBydeferralCodeId GET /v1/deferralCode/{deferralCodeId} Get a specific DeferralCode
DeferralCodeApi deferralCodeGetDeferralCodes GET /v1/deferralCode Get a range of DeferralCodes - ScreenId=DR2020PL Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
DepartmentApi departmentCreateDepartment POST /v1/department Creates a department
DepartmentApi departmentGetAllDepartmentDtos GET /v1/department Get a range of departments - ScreenId=EP201500
DepartmentApi departmentGetDepartmentBydepartmentId GET /v1/department/{departmentId} Get a specific department
DepartmentApi departmentUpdateDepartmentBydepartmentId PUT /v1/department/{departmentId} Updates a specific department
DimensionApi dimensionGetDimensionBydimensionId GET /v1/dimension/{dimensionId} Get a specific Dimension
DimensionApi dimensionGetDimensionList GET /v1/dimension Get a list of all Dimension names/IDs ScreenId=CS202000
DimensionApi dimensionGetSegmentBydimensionIdsegmentId GET /v1/dimension/{dimensionId}/{segmentId} Get a specific Segment for a specific Dimension
DimensionApi dimensionGetSegmentValueBydimensionIdsegmentIdpublicId GET /v1/dimension/{dimensionId}/{segmentId}/publicid/{publicId} Get a specific SegmentValue for a specific Segment for a specific Dimension
DimensionApi dimensionGetSegmentValueBydimensionIdsegmentIdvalueId GET /v1/dimension/{dimensionId}/{segmentId}/{valueId} Get a specific SegmentValue for a specific Segment for a specific Dimension
DimensionApi dimensionUpdateSegmentBydimensionIdsegmentId PUT /v1/dimension/{dimensionId}/{segmentId} Update a Segment
DiscountApi discountDeleteBydiscountCodeseries DELETE /v1/discount/{discountCode}/{series}
DiscountApi discountGetDiscounts GET /v1/discount Get a range of discounts - ScreenId=AR209500
DiscountApi discountPost POST /v1/discount
DiscountApi discountPutBydiscountCodeseries PUT /v1/discount/{discountCode}/{series}
DiscountApi discountUpdateDiscountsBydiscountCodeseries POST /v1/discount/{discountCode}/{series}/action/updateDiscounts
DiscountApi discountUpdateDiscountsBydiscountCodeseriesfilerDate POST /v1/discount/{discountCode}/{series}/{filerDate}/action/updateDiscounts
DiscountCodeApi discountCodeGetDiscountCodes GET /v1/discountCode Get a range of discount codes - ScreenId=AR209000
DiscountCodeV2Api discountCodeV2GetDiscountCodes GET /v2/discountCode Get a range of discount codes - ScreenId=AR209000
DiscountV2Api discountV2GetDiscounts GET /v2/discount Get a range of discounts - ScreenId=AR209500
EarningTypeApi earningTypeGetAllEarningTypeDtos GET /v1/earningtype Get a range of earningtypes - ScreenId=EP102000
EarningTypeApi earningTypeGetEarningTypeBytypeCd GET /v1/earningtype/{typeCd} Get a specific earning type
EmployeeApi employeeChangeEmployeeNrActionByinternalId POST /v1/employee/action/changeEmployeeCd/{internalId} Updates the EmployeeNr for the specified employee
EmployeeApi employeeCreateEmployee POST /v1/employee Create an employee
EmployeeApi employeeGetAllEmployees GET /v1/employee Get a range of employees - ScreenId=EP203000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2021-October:Added forced pagination
EmployeeApi employeeGetEmployeeByemployeeCd GET /v1/employee/{employeeCd} Get a specific employee
EmployeeApi employeeGetEmployeeExpenseClaimsByemployeeCd GET /v1/employee/{employeeCd}/expenseClaim Get expense claims for a specific employee
EmployeeApi employeeGetEmployeeExpenseReceiptsByemployeeCd GET /v1/employee/{employeeCd}/expenseReceipt Get expense receipts for a specific employee
EmployeeApi employeeGetEmployeeTimeCardsByemployeeCd GET /v1/employee/{employeeCd}/timecards Get a specific employee time cards
EmployeeApi employeePutByemployeeCd PUT /v1/employee/{employeeCd} Updates a specific employee
ExpenseClaimApi expenseClaimCreateExpenseClaim POST /v1/expenseClaim Create an ExpenseClaim
ExpenseClaimApi expenseClaimDeleteByexpenseClaimNbr DELETE /v1/expenseClaim/{expenseClaimNbr} Deletes a specific ExpenseClaim
ExpenseClaimApi expenseClaimGetAll GET /v1/expenseClaim Get a range of Expense Claims, a filter needs to be specified. ScreenId=EP301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2021-October:Added forced pagination 2022-December: Added the actual code to force pagination!
ExpenseClaimApi expenseClaimGetExpenseClaimByexpenseClaimNbr GET /v1/expenseClaim/{expenseClaimNbr} Get a specific Expense Claim
ExpenseClaimApi expenseClaimPutByexpenseClaimNbr PUT /v1/expenseClaim/{expenseClaimNbr} Update a specific ExpenseClaim
ExpenseClaimApi expenseClaimPutExpenseClaimOnHoldByexpenseClaim POST /v1/expenseClaim/{expenseClaim}/action/hold Put ExpenseClaim on hold
ExpenseClaimApi expenseClaimSendExpenseClaimToApprovalByexpenseClaim POST /v1/expenseClaim/{expenseClaim}/action/approval Send Expense Claim to approval
ExpenseClaimApi expenseClaimSubmitExpenseClaimByexpenseClaim POST /v1/expenseClaim/{expenseClaim}/action/submit Submit Expense Claim operation
ExpenseReceiptApi expenseReceiptCreateAttachmentByreceiptNumber POST /v1/expenseReceipt/{receiptNumber}/attachment Creates an attachment and associates it with an expense receipt. If the file already exists, a new revision is created.
ExpenseReceiptApi expenseReceiptDeleteByreceiptNumber DELETE /v1/expenseReceipt/{receiptNumber} Deletes a specific Expense Receipt
ExpenseReceiptApi expenseReceiptGetAll GET /v1/expenseReceipt Get a range of Expense Receipts, a filter needs to be specified. ScreenId=EP301020
ExpenseReceiptApi expenseReceiptGetByreceiptNumber GET /v1/expenseReceipt/{receiptNumber} Get a specific ExpenseReceipt
ExpenseReceiptApi expenseReceiptPost POST /v1/expenseReceipt Create a Expense Receipt
ExpenseReceiptApi expenseReceiptPutByreceiptNumber PUT /v1/expenseReceipt/{receiptNumber} Update a Expense Receipt
FinancialPeriodApi financialPeriodGetAll GET /v1/financialPeriod Get a range of Financial Periods - ScreenId=GL201000
FinancialPeriodApi financialPeriodGetByfinancialPeriodId GET /v1/financialPeriod/{financialPeriodId} Get a specific Financial Period - ScreenId=GL201000
FirstTimeStartupApi firstTimeStartupGet GET /v1/firstTimeStartup/status Get the status for FTS
FixedAssetApi fixedAssetGetAll GET /v1/fixedAsset Get a range of Fixed Assets - Screen ID:FA303000
FixedAssetApi fixedAssetGetByFixedAssetID GET /v1/fixedAsset/{FixedAssetID} Get a specific Fixed Asset - Screen ID:FA303000
FixedAssetClassApi fixedAssetClassGetAll GET /v1/fixedAssetClass Get a range of Fixed Asset Classes - Screen ID:FA201000
FixedAssetClassApi fixedAssetClassGetByClassID GET /v1/fixedAssetClass/{ClassID} Get a specific Fixed Asset Class - Screen ID:FA201000
FixedAssetPropertyTaxGroupApi fixedAssetPropertyTaxGroupGetAll GET /v1/fixedAssetPropertyTaxGroup Get a range of Fixed Asset Property Tax Groups - Screen ID: FA209000
FixedAssetPropertyTaxGroupApi fixedAssetPropertyTaxGroupGetByPropertyTaxID GET /v1/fixedAssetPropertyTaxGroup/{PropertyTaxID} Get a specific Fixed Asset Property Tax Group - Screen ID: FA209000
FixedAssetTransactionApi fixedAssetTransactionGetAll GET /v1/fixedAssetTransaction Get a range of transactions - Screen ID:FA301000
FixedAssetTransactionApi fixedAssetTransactionGetByRefNo GET /v1/fixedAssetTransaction/{RefNo} Get transactions for a specific Asset - Screen ID:FA301000
GeneralLedgerBalanceV2Api generalLedgerBalanceV2GetGeneralLedgerBalances GET /v2/generalLedgerBalance Get a range of General Ledger Balances. Complete documentation can be found under 8.21 release notes. Please use a page size lower or equal to the allowed max page size which is returned under metadata. If pagesize is greater than the max page size, it will be limited to max page size.
GeneralLedgerTransactionsApi generalLedgerTransactionsGetAll GET /v1/GeneralLedgerTransactions Get a range of General Ledger Transactions - ScreenId=GL404000 Please use a page size lower or equal to the allowed max page size which is returned under metadata. If pagesize is greater than the max page size, it will be limited to max page size.
InventoryApi inventoryChangeInventoryNbrActionByinternalId POST /v1/inventory/action/changeInventoryNbr/{internalId} Updates the InventoryNbr for the specified Inventory
InventoryApi inventoryCreateInventoryAttachmentByinventoryNumber POST /v1/inventory/{inventoryNumber}/attachment Creates an attachment and associates it with a Inventory Item. If the file already exists, a new revision is created.
InventoryApi inventoryCreateInventoryCrossReferencesByinventoryNumber POST /v1/inventory/{inventoryNumber}/crossReferences Creates a cross reference for a specific inventory
InventoryApi inventoryGetAll GET /v1/inventory Get a range of Inventory items - ScreenId=IN202000 and IN202500
InventoryApi inventoryGetByinventoryId GET /v1/inventory/internal/{inventoryId} Get a specific Inventory item by its internal ID
InventoryApi inventoryGetByinventoryNumber GET /v1/inventory/{inventoryNumber} Get a specific Inventory item
InventoryApi inventoryGetInventoryCrossReferencesByinventoryNumber GET /v1/inventory/{inventoryNumber}/crossReferences Get a range of cross-reference for a specific inventory
InventoryApi inventoryGetInventoryPOReceiptTakeBarCodesByreceiptNbr GET /v1/inventory/barcode/purchasereceipt/{receiptNbr} Get a range of barcodes for a specific purchase receipt
InventoryApi inventoryGetInventorySalesOrderBarCodesByorderNbr GET /v1/inventory/barcode/salesorder/{orderNbr} Get a range of barcodes for a specific sales order
InventoryApi inventoryGetInventoryShipmentBarCodesByshipmentNbr GET /v1/inventory/barcode/shipment/{shipmentNbr} Get a range of barcodes for a specific shipment
InventoryApi inventoryGetInventoryStockTakeBarCodesByreferenceNumber GET /v1/inventory/barcode/stocktake/{referenceNumber} Get a range of barcodes for a specific stock count
InventoryApi inventoryGetItemClasses GET /v1/inventory/itemClass Get Inventory Item Classes
InventoryApi inventoryGetItemPostClasses GET /v1/inventory/itemPostClass Get Inventory Item Post Classes
InventoryApi inventoryGetSpecificItemClassByitemClassNumber GET /v1/inventory/itemclass/{itemClassNumber} Get Specific Inventory Item Class
InventoryApi inventoryPost POST /v1/inventory Create an inventory item
InventoryApi inventoryPutByinventoryID PUT /v1/inventory/internal/{inventoryID} Update a specific inventory item
InventoryApi inventoryPutByinventoryNumber PUT /v1/inventory/{inventoryNumber} Update a specific inventory item
InventoryApi inventoryUpdateCostNonStockItemByinventoryCd POST /v1/inventory/{inventoryCd}/action/updateCost Update Cost action on Non-Stock Item
InventoryApi inventoryUpdateInventoryCrossReferencesByinventoryNumberalternateTypealternateId PUT /v1/inventory/{inventoryNumber}/crossReferences/{alternateType}/{alternateId} Updates a specific cross reference for a specific inventory
InventoryAdjustmentApi inventoryAdjustmentGetAll GET /v1/inventoryadjustment Get a range of Inventory Adjustment Dto - ScreenId=IN303000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
InventoryAdjustmentApi inventoryAdjustmentGetByinventoryAdjustmentNumber GET /v1/inventoryadjustment/{inventoryAdjustmentNumber} Get a specific Inventory Adjustment document
InventoryAdjustmentApi inventoryAdjustmentPost POST /v1/inventoryadjustment Create an inventory item
InventoryAdjustmentApi inventoryAdjustmentPutByinventoryAdjustmentNumber PUT /v1/inventoryadjustment/{inventoryAdjustmentNumber} Update a specific inventory item
InventoryAdjustmentApi inventoryAdjustmentReleaseDocumentByadjRefNumber POST /v1/inventoryadjustment/{adjRefNumber}/action/release Release inventory document action
InventoryIssueApi inventoryIssueGetAll GET /v1/inventoryissue Get a range of Inventory items - ScreenId=IN302000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
InventoryIssueApi inventoryIssueGetByinventoryIssueNumber GET /v1/inventoryissue/{inventoryIssueNumber} Get a specific Inventory Issue document
InventoryIssueApi inventoryIssuePost POST /v1/inventoryissue Create an inventory item
InventoryIssueApi inventoryIssuePutByinventoryIssueNumber PUT /v1/inventoryissue/{inventoryIssueNumber} Update a specific inventory item
InventoryIssueApi inventoryIssueReleaseDocumentByinvoiceNumber POST /v1/inventoryissue/{invoiceNumber}/action/release Release inventory operation
InventoryReceiptApi inventoryReceiptGetAll GET /v1/inventoryReceipt Get a range of Inventory Receipts - ScreenId=IN301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
InventoryReceiptApi inventoryReceiptGetByinventoryReceiptNumber GET /v1/inventoryReceipt/{inventoryReceiptNumber} Get a specific Inventory Receipt document
InventoryReceiptApi inventoryReceiptPost POST /v1/inventoryReceipt Create an inventory item
InventoryReceiptApi inventoryReceiptPutByinventoryReceiptNumber PUT /v1/inventoryReceipt/{inventoryReceiptNumber} Update a specific inventory item
InventoryReceiptApi inventoryReceiptReleaseDocumentByinvoiceNumber POST /v1/inventoryReceipt/{invoiceNumber}/action/release Release inventory operation
InventorySummaryApi inventorySummaryGetAllInventorySummaryByinventoryNumber GET /v1/inventorysummary/{inventoryNumber} Get a range of InventorySummary - ScreenId=IN401000
InventoryTransferApi inventoryTransferGetAll GET /v1/inventoryTransfer Get a range of Inventory Transfers - ScreenId=IN304000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
InventoryTransferApi inventoryTransferGetByinventoryTransferNumber GET /v1/inventoryTransfer/{inventoryTransferNumber} Get a specific Inventory Transfer document
InventoryTransferApi inventoryTransferPost POST /v1/inventoryTransfer Create an inventory transfer
InventoryTransferApi inventoryTransferPutByinventoryTransferNumber PUT /v1/inventoryTransfer/{inventoryTransferNumber} Update a specific inventory transfer
InventoryTransferApi inventoryTransferReleaseDocumentBytransferNumber POST /v1/inventoryTransfer/{transferNumber}/action/release Release inventory operation
JournalTransactionV2Api journalTransactionV2AddHeaderAttachmentBymodulejournalTransactionNumber POST /v2/journaltransaction/module/{module}/{journalTransactionNumber}/attachment Creates an attachment and associates it with an journalTransaction. If the file already exists, a new revision is created.
JournalTransactionV2Api journalTransactionV2AddLineAttachmentBymodulejournalTransactionNumberlineNumber POST /v2/journaltransaction/module/{module}/{journalTransactionNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain journalTransaction line. If the file already exists, a new revision is created.
JournalTransactionV2Api journalTransactionV2GetAllJournalTransactions GET /v2/journaltransaction Get a range of Journal Transactions - ScreenId=GL301000. On this particular endpoint, pagesize and totalcount denotes number of journaltransaction lines. When using pagination, the transactions for one specific batch can be split into several responses. Please use a page size lower or equal to the allowed max page size which is returned under metadata. If pagesize is greater than the max page size, it will be limited to max page size.
JournalTransactionV2Api journalTransactionV2GetSpecificJournalTransactionsByjournalTransactionNumber GET /v2/journaltransaction/{journalTransactionNumber} Get a specific Journal Transaction
JournalTransactionV2Api journalTransactionV2Post POST /v2/journaltransaction Create a Journal Transaction
JournalTransactionV2Api journalTransactionV2PutByjournalTransactionNumber PUT /v2/journaltransaction/{journalTransactionNumber} Update a Journal Transaction
JournalTransactionV2Api journalTransactionV2ReleaseJournalTransactionByjournalTransactionNumber POST /v2/journaltransaction/{journalTransactionNumber}/action/release Release journal transaction operation
KitAssemblyApi kitAssemblyDeleteBytyperefNo DELETE /v1/kitassembly/{type}/{refNo} Delete a specific Kit Assembly Document
KitAssemblyApi kitAssemblyGetKitAssemblies GET /v1/kitassembly Get a range of Kit Assemblies - ScreenId = IN307000
KitAssemblyApi kitAssemblyGetKitAssemblyBytyperefNo GET /v1/kitassembly/{type}/{refNo} Get a Kit Assembly - ScreenId = IN307000
KitAssemblyApi kitAssemblyPost POST /v1/kitassembly Creates a Kit Assembly
KitAssemblyApi kitAssemblyPutBytyperefNo PUT /v1/kitassembly/{type}/{refNo} Updates a specific Kit Assembly document
KitAssemblyApi kitAssemblyReleaseKitAssemblyBytyperefNo POST /v1/kitassembly/{type}/{refNo}/action/release Release Kit Assembly
KitSpecificationsApi kitSpecificationsGetAll GET /v1/KitSpecifications Get a range of Kit Specifications - ScreenId = IN209500
KitSpecificationsApi kitSpecificationsGetBykitInventoryID GET /v1/KitSpecifications/{kitInventoryID} Get all revisions for a specific KitSpecification
KitSpecificationsApi kitSpecificationsGetBykitInventoryIDrevisionID GET /v1/KitSpecifications/{kitInventoryID}/{revisionID} Get a specific KitSpecification
KitSpecificationsApi kitSpecificationsPost POST /v1/KitSpecifications Creates a KitSpecification
KitSpecificationsApi kitSpecificationsPutBykitInventoryIDrevisionID PUT /v1/KitSpecifications/{kitInventoryID}/{revisionID} Updates a specific KitSpecification
LandedCostCodeApi landedCostCodeGetAllLandedCosts GET /v1/landedCostCode Get a range of Landed Costs - ScreenId=PO2020PL
LandedCostCodeApi landedCostCodeGetAllLandedCostsBycode GET /v1/landedCostCode/{code} Get a specific Landed Costs - ScreenId=PO2020PL
LedgerApi ledgerGetAllLedgers GET /v1/ledger Get a range of Ledgers - ScreenId=GL201500
LocationApi locationCreate POST /v1/location Create a Location
LocationApi locationGetLocationBybAccountIdlocationId GET /v1/location/{bAccountId}/{locationId} Get a specific Location of a Baccount
LocationApi locationGetLocations GET /v1/location Get a range of Locations - ScreenId=CR303010 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added forced pagination
LocationApi locationGetLocationsForBaccountBybAccountId GET /v1/location/{bAccountId} Get a range of Locations for a BAccount Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
LocationApi locationUpdateBybAccountIdlocationId PUT /v1/location/{bAccountId}/{locationId} Update a specific Location
LotSerialClassApi lotSerialClassGetAllLotSerialClass GET /v1/lotserialclass Get a range of lot serial classes - ScreenId=IN207000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size.
LotSerialClassApi lotSerialClassGetByid GET /v1/lotserialclass/{id} Get a specific
MultilanguageApi multilanguageAddDefaultLanguage PUT /v1/multilanguage/defaultlanguage Set default language (screenId:SM200550). We recommend to activate multilanguage for the first time using the System Locale screen (Screenid SM200550). Please use API only to switch default
MultilanguageApi multilanguageDeleteSpecificInventoryDescrTranslationByinventoryNumberlanguageISO DELETE /v1/multilanguage/inventory/{inventoryNumber}/{languageISO} Deletes the description of an item with the specific language ISO code (screenId:IN202500 and IN202000)
MultilanguageApi multilanguageGetAllActiveLanguages GET /v1/multilanguage/languages Get all languages (screenId:SM200550)
MultilanguageApi multilanguageGetInventoryTranslationsByinventoryNumber GET /v1/multilanguage/inventory/{inventoryNumber} Get all translations for a given item (screenId:IN202500 and IN202000)
MultilanguageApi multilanguageGetSpecificInventoryDescrTranslationByinventoryNumberlanguageISO GET /v1/multilanguage/inventory/{inventoryNumber}/{languageISO} Get a specific translation of the description for a given item and language ISO code (screenId:IN202500 and IN202000)
MultilanguageApi multilanguagePostSpecificInventoryDescrTranslationByinventoryNumberlanguageISO POST /v1/multilanguage/inventory/{inventoryNumber}/{languageISO} Creates item description for given item and language ISO code (screenId:IN202500 and IN202000)
MultilanguageApi multilanguagePutSpecificInventoryDescrTranslationByinventoryNumberlanguageISO PUT /v1/multilanguage/inventory/{inventoryNumber}/{languageISO} Updates item description for given item and language ISO code (screenId:IN202500 and IN202000)
NumberSequenceApi numberSequenceGetAll GET /v1/numberSequence Get a specific Numbering - ScreenId=CS201010
NumberSequenceApi numberSequenceGetBynumberingId GET /v1/numberSequence/{numberingId} Get a specific Numbering
OrganizationApi organizationGetAll GET /v1/organization Get all organisations
OrganizationApi organizationGetByOrganizationCdByorganizationNumber GET /v1/organization/{organizationNumber} Get organisation information by organization number.
OrganizationApi organizationPutBankSettingsForOrganizationByorganizationNumber PUT /v1/organization/{organizationNumber}/BankSettings Update bank settings for organization
PackagingTypeApi packagingTypeGetAllPackagingTypes GET /v1/packagingType Get a range of SO PackagingTypes - ScreenId=CS207600
PackagingTypeApi packagingTypeGetByboxId GET /v1/packagingType/{boxId} Get a specific PackagingType
PaymentApi paymentCreatePayment POST /v1/payment Create a Payment Payment is deprecated, please use CustomerPayment instead.
PaymentApi paymentGetAllPayments GET /v1/payment Get a range of Payments - ScreenId=AP302000 Payment is deprecated, please use CustomerPayment instead.
PaymentApi paymentGetBypaymentNumber GET /v1/payment/{paymentNumber} Get a specific Payment Payment is deprecated, please use CustomerPayment instead.
PaymentApi paymentPutBypaymentNumber PUT /v1/payment/{paymentNumber} Update a specific Payment Payment is deprecated, please use CustomerPayment instead.
PaymentApi paymentReleasePaymentBypaymentNumber POST /v1/payment/{paymentNumber}/action/release Release payment operation Payment is deprecated, please use CustomerPayment instead.
PaymentApi paymentVoidPaymentBypaymentNumber POST /v1/payment/{paymentNumber}/action/void Void payment operation Payment is deprecated, please use CustomerPayment instead.
PaymentMethodApi paymentMethodGetAllPaymentMethod GET /v1/paymentmethod Get a range of Payment Method - ScreenId=CA204000
PaymentMethodApi paymentMethodGetBypaymentMethodNumber GET /v1/paymentmethod/{paymentMethodNumber} Get a specific Payment Method
ProjectApi projectChangeProjectIDActionByinternalId POST /v1/project/action/changeProjectId/{internalId} Updates the ProjectID for the specified project
ProjectApi projectGetAll GET /v1/project Get a range of Projects - ScreenId=PM301000 The requested page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
ProjectApi projectGetByinternalID GET /v1/project/internal/{internalID} Get a specific Project by internal ID
ProjectApi projectGetByprojectID GET /v1/project/{projectID} Get a specific Project
ProjectApi projectGetTasks GET /v1/project/tasks Get all tasks for a project
ProjectApi projectPost POST /v1/project Create an project
ProjectApi projectPutByinternalId PUT /v1/project/internal/{internalId} Update a specific Project
ProjectApi projectPutByprojectId PUT /v1/project/{projectId} Update a specific Project
ProjectAccountGroupApi projectAccountGroupGetAll GET /v1/projectaccountgroup Get a range of Project Account Groups - ScreenId=PM2010PL
ProjectAccountGroupApi projectAccountGroupGetByaccountGroupId GET /v1/projectaccountgroup/{accountGroupId} Get spesific Project Account Group - ScreenId=PM201000
ProjectBasicApi projectBasicGetAll GET /v1/projectbasic Get a range of Projects - ScreenId=PM301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
ProjectBudgetApi projectBudgetGetAll GET /v1/projectbudget Get a range of Project Budgets - ScreenId=PM309000
ProjectBudgetApi projectBudgetPost POST /v1/projectbudget Creates a Project Budget
ProjectTaskApi projectTaskGetAllTasks GET /v1/projecttask Get all project tasks for one project.
ProjectTaskApi projectTaskGetTaskByinternalId GET /v1/projecttask/{internalId} Get project task information by internal id.
ProjectTaskApi projectTaskPostByinternalId POST /v1/projecttask/{internalId} Create a Task
ProjectTaskApi projectTaskPutByinternalId PUT /v1/projecttask/{internalId} Update a specific Task
ProjectTransactionApi projectTransactionGetAll GET /v1/projecttransaction Get a range of Project transaction documents - ScreenId=PM304000
ProjectTransactionApi projectTransactionGetByrefNbr GET /v1/projecttransaction/{refNbr} Get a specific Project transaction document
ProjectTransactionApi projectTransactionPost POST /v1/projecttransaction Create a project transaction document and lines
ProjectTransactionApi projectTransactionPutByrefNbr PUT /v1/projecttransaction/{refNbr} Update a specific Project transaction document
PurchaseOrderApi purchaseOrderCreatePurchaseReceiptFromPurchaseOrderBypurchaseorderNbr POST /v1/purchaseorder/{purchaseorderNbr}/action/createpurchasereceipt Creates a purchase receipt from an existing purchase order.
PurchaseOrderApi purchaseOrderGetAllOrder GET /v1/purchaseorder Get a range of Purchase Order - ScreenId=PO301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added forced pagination
PurchaseOrderApi purchaseOrderGetOrderBypurchaseOrderNumber GET /v1/purchaseorder/{purchaseOrderNumber} Get a specific Purchase Order
PurchaseOrderApi purchaseOrderPost POST /v1/purchaseorder Create a Purchase Order
PurchaseOrderApi purchaseOrderPutBypurchaseOrderNumber PUT /v1/purchaseorder/{purchaseOrderNumber} Update a Purchase Order
PurchaseOrderBasicApi purchaseOrderBasicGetAllOrderBasic GET /v1/purchaseorderbasic Get a range of Purchase Order - ScreenId=PO301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
PurchaseOrderBasicApi purchaseOrderBasicGetPurchaseOrderBasicBypurchaseOrderNumber GET /v1/purchaseorderbasic/{purchaseOrderNumber} Get a specific Purchase Order
PurchaseOrderBasicApi purchaseOrderBasicPost POST /v1/purchaseorderbasic Create a Purchase Order Basic
PurchaseOrderBasicApi purchaseOrderBasicPutBypurchaseOrderNumber PUT /v1/purchaseorderbasic/{purchaseOrderNumber} Update a Purchase Order Basic
PurchaseReceiptApi purchaseReceiptAddPurchaseOrderLinesByreceiptNumber POST /v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorderlines Add purchase order lines to receipt
PurchaseReceiptApi purchaseReceiptAddPurchaseOrdersByreceiptNumber POST /v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorder Add purchase orders to receipt
PurchaseReceiptApi purchaseReceiptCancelReceiptByreceiptNumber POST /v1/PurchaseReceipt/{receiptNumber}/action/cancelReceipt Cancel purchase receipt operation
PurchaseReceiptApi purchaseReceiptGetAllReceiptBasic GET /v1/PurchaseReceipt Get a range of Purchase Receipts - ScreenId=PO302000 Please use a page size lower or equal to the allowed max page size which is 500
PurchaseReceiptApi purchaseReceiptGetPurchaseReceiptBasicByreceiptNumber GET /v1/PurchaseReceipt/{receiptNumber} Get a specific Purchase Receipt
PurchaseReceiptApi purchaseReceiptPost POST /v1/PurchaseReceipt Create a Purchase Receipt
PurchaseReceiptApi purchaseReceiptPrintPurchaseReceiptByreceiptNumber GET /v1/PurchaseReceipt/{receiptNumber}/print Get the print report of a Purchase Receipt
PurchaseReceiptApi purchaseReceiptPutByreceiptNumber PUT /v1/PurchaseReceipt/{receiptNumber} Update a specific Purchase Receipt
PurchaseReceiptApi purchaseReceiptReleaseReceiptByreceiptNumber POST /v1/PurchaseReceipt/{receiptNumber}/action/release Release purchase receipt operation
PurchaseReceiptBasicApi purchaseReceiptBasicGetAllReceiptBasic GET /v1/PurchaseReceiptBasic Get a range with purchase receipts, ScreenId=PO302000 Please use a page size lower or equal to the allowed max page size which is 500
PurchaseReceiptBasicApi purchaseReceiptBasicGetPurchaseReceiptBasicByreceiptNumber GET /v1/PurchaseReceiptBasic/{receiptNumber} Get a specific Purchase Receipt
PurchaseReceiptBasicApi purchaseReceiptBasicPost POST /v1/PurchaseReceiptBasic Create a Purchase Receipt
PurchaseReceiptBasicApi purchaseReceiptBasicPutByreceiptNumber PUT /v1/PurchaseReceiptBasic/{receiptNumber} Update a specific Purchase Receipt
PurchaseReceiptBasicApi purchaseReceiptBasicReleaseInvoiceByreceiptNumber POST /v1/PurchaseReceiptBasic/{receiptNumber}/action/release Release purchase receipt operation
PurchaseReceiptV2Api purchaseReceiptV2GetAllReceipts GET /v2/PurchaseReceipt Get a range of Purchase Receipts - ScreenId=PO302000 Please use a page size lower or equal to the allowed max page size which is 500
PurchaseReceiptV2Api purchaseReceiptV2GetPurchaseReceiptByreceiptNumber GET /v2/PurchaseReceipt/{receiptNumber} Get a specific Purchase Receipt
SalesCategoryApi salesCategoryGet GET /v1/salescategory Get Sales Categories - ScreenId=IN204060
SalesCategoryApi salesCategoryGetCategoryBycategoryId GET /v1/salescategory/{categoryId} Get a Sales Category
SalesCategoryApi salesCategoryGetItemsForCategoryBycategoryId GET /v1/salescategory/{categoryId}/item Get a range of Inventory Items from a specific Sales Category
SalesOrderApi salesOrderCancelSalesOrderBysaleOrderNumber POST /v1/salesorder/{saleOrderNumber}/action/cancelSalesOrder Cancel Order action
SalesOrderApi salesOrderCreateHeaderAttachmentByorderNumber POST /v1/salesorder/{orderNumber}/attachment Creates an attachment and associates it with a sales order. If the file already exists, a new revision is created. - Method is deprecated and will be removed in a future version. Please start using the new method with order type.
SalesOrderApi salesOrderCreateHeaderAttachmentByorderNumberorderType POST /v1/salesorder/orderType/{orderType}/{orderNumber}/attachment Creates an attachment and associates it with a sales order on a specific order type. If the file already exists, a new revision is created.
SalesOrderApi salesOrderCreateLineAttachmentByorderNumberlineNumber POST /v1/salesorder/{orderNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain sales order line. If the file already exists, a new revision is created. - Method is deprecated and will be removed in a future version. Please start using the new method with order type.
SalesOrderApi salesOrderCreateLineAttachmentByorderNumberorderTypelineNumber POST /v1/salesorder/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain sales order line on a specific order type. If the file already exists, a new revision is created.
SalesOrderApi salesOrderCreateShipmentActionBysaleOrderNumber POST /v1/salesorder/{saleOrderNumber}/action/createShipment Create shipment operation
SalesOrderApi salesOrderDeleteLineAttachmentByorderNumberorderTypelineNumberfileId DELETE /v1/salesorder/{orderType}/{orderNumber}/{lineNumber}/attachment/{fileId} Delete an attachment and remove associates it with a certain sales order line on a specific order type.
SalesOrderApi salesOrderDeleteOrderAttachmentByorderNumberorderTypefileId DELETE /v1/salesorder/{orderType}/{orderNumber}/attachment/{fileId} Delete an attachment and remove associates it with a certain sales order on a specific order type.
SalesOrderApi salesOrderGetAllOrders GET /v1/salesorder Get a range of SO Orders - ScreenId=SO301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added force pagination
SalesOrderApi salesOrderGetByorderNbr GET /v1/salesorder/{orderNbr} Get a specific SO Order
SalesOrderApi salesOrderGetCommissionsByorderTypeorderNbr GET /v1/salesorder/{orderType}/{orderNbr}/commissions Get Sales Order Commissions - ScreenId=SO301000, tab Commissions
SalesOrderApi salesOrderGetOrderByTypeByorderTypeorderNbr GET /v1/salesorder/{orderType}/{orderNbr} Get a specific type of Order
SalesOrderApi salesOrderGetROTRUTByorderTypeorderNbr GET /v1/salesorder/{orderType}/{orderNbr}/rotrut Get ROT/RUT details for a specific type of order
SalesOrderApi salesOrderPost POST /v1/salesorder Create a Sale Order
SalesOrderApi salesOrderPrintOrderByorderNumberorderType GET /v1/salesorder/{orderType}/{orderNumber}/printOrder Get the print report of the Sales Order Quote
SalesOrderApi salesOrderPutByorderNbr PUT /v1/salesorder/{orderNbr} Update a specific Sale Order
SalesOrderApi salesOrderReopenSalesOrderBysalesOrderNumber POST /v1/salesorder/{salesOrderNumber}/action/reopenSalesOrder Reopen and update a specific Sales Order. This method requires a sales order update dto where the order type is initialised.
SalesOrderBasicApi salesOrderBasicCreateHeaderAttachmentByorderNumber POST /v1/salesorderbasic/{orderNumber}/attachment Creates an attachment and associates it with a sales order. If the file already exists, a new revision is created. - Method is deprecated and will be removed in a future version. Please start using the new method with order type.
SalesOrderBasicApi salesOrderBasicCreateHeaderAttachmentByorderNumberorderType POST /v1/salesorderbasic/orderType/{orderType}/{orderNumber}/attachment Creates an attachment and associates it with a sales order on a specific order type. If the file already exists, a new revision is created.
SalesOrderBasicApi salesOrderBasicCreateLineAttachmentByorderNumberlineNumber POST /v1/salesorderbasic/{orderNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain sales order line. If the file already exists, a new revision is created. - Method is deprecated and will be removed in a future version. Please start using the new method with order type.
SalesOrderBasicApi salesOrderBasicCreateLineAttachmentByorderNumberorderTypelineNumber POST /v1/salesorderbasic/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain sales order line on a specific order type. If the file already exists, a new revision is created.
SalesOrderBasicApi salesOrderBasicCreateShipmentActionBysaleOrderNumber POST /v1/salesorderbasic/{saleOrderNumber}/action/createShipment Crete shipment operation
SalesOrderBasicApi salesOrderBasicDeleteLineAttachmentByorderNumberorderTypelineNumberfileId DELETE /v1/salesorderbasic/{orderType}/{orderNumber}/{lineNumber}/attachment/{fileId} Delete an attachment and remove associates it with a certain sales order line on a specific order type.
SalesOrderBasicApi salesOrderBasicDeleteOrderAttachmentByorderNumberorderTypefileId DELETE /v1/salesorderbasic/{orderType}/{orderNumber}/attachment/{fileId} Delete an attachment and remove associates it with a certain sales order on a specific order type.
SalesOrderBasicApi salesOrderBasicGetAllOrders GET /v1/salesorderbasic Get a range of Sale Orders - ScreenId=SO301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
SalesOrderBasicApi salesOrderBasicGetByorderNbr GET /v1/salesorderbasic/{orderNbr} Get a specific SO Order
SalesOrderBasicApi salesOrderBasicGetOrderByTypeByorderTypeorderNbr GET /v1/salesorderbasic/{orderType}/{orderNbr} Get a specific type of Order
SalesOrderBasicApi salesOrderBasicPost POST /v1/salesorderbasic Create a Sale Order
SalesOrderBasicApi salesOrderBasicPutByorderNbr PUT /v1/salesorderbasic/{orderNbr} Update a specific Sale Order
SalesOrderBasicV2Api salesOrderBasicV2CreateHeaderAttachmentByorderNumber POST /v2/salesorderbasic/{orderNumber}/attachment Creates an attachment and associates it with a sales order. If the file already exists, a new revision is created. - Method is deprecated and will be removed in a future version. Please start using the new method with order type.
SalesOrderBasicV2Api salesOrderBasicV2CreateHeaderAttachmentByorderNumberorderType POST /v2/salesorderbasic/orderType/{orderType}/{orderNumber}/attachment Creates an attachment and associates it with a sales order on a specific order type. If the file already exists, a new revision is created.
SalesOrderBasicV2Api salesOrderBasicV2CreateLineAttachmentByorderNumberlineNumber POST /v2/salesorderbasic/{orderNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain sales order line. If the file already exists, a new revision is created. - Method is deprecated and will be removed in a future version. Please start using the new method with order type.
SalesOrderBasicV2Api salesOrderBasicV2CreateLineAttachmentByorderNumberorderTypelineNumber POST /v2/salesorderbasic/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain sales order line on a specific order type. If the file already exists, a new revision is created.
SalesOrderBasicV2Api salesOrderBasicV2CreateShipmentActionBysaleOrderNumber POST /v2/salesorderbasic/{saleOrderNumber}/action/createShipment Crete shipment operation
SalesOrderBasicV2Api salesOrderBasicV2Post POST /v2/salesorderbasic Create a Sale Order
SalesOrderBasicV2Api salesOrderBasicV2PrepareInvoiceActionByorderTypeorderNumber POST /v2/salesorderbasic/{orderType}/{orderNumber}/action/prepareInvoice Prepare Invoice operation
SalesOrderBasicV2Api salesOrderBasicV2SendEmailActionByorderTypeorderNumber POST /v2/salesorderbasic/{orderType}/{orderNumber}/action/sendbymail Send by mail operation
SalesOrderTypeApi salesOrderTypeGetAllSalesOrderTypes GET /v1/salesordertype Get a range of SO OrderTypes - ScreenId=SO201000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
SalesOrderTypeApi salesOrderTypeGetSalesOrderTypeByorderType GET /v1/salesordertype/{orderType} Get a specific SO OrderType
SalesOrderV2Api salesOrderV2CancelSalesOrderBysaleOrderNumber POST /v2/salesorder/{saleOrderNumber}/action/cancelSalesOrder Cancel Order action
SalesOrderV2Api salesOrderV2CreateHeaderAttachmentByorderNumber POST /v2/salesorder/{orderNumber}/attachment Creates an attachment and associates it with a sales order. If the file already exists, a new revision is created. - Method is deprecated and will be removed in a future version. Please start using the new method with order type.
SalesOrderV2Api salesOrderV2CreateHeaderAttachmentByorderNumberorderType POST /v2/salesorder/orderType/{orderType}/{orderNumber}/attachment Creates an attachment and associates it with a sales order on a specific order type. If the file already exists, a new revision is created.
SalesOrderV2Api salesOrderV2CreateLineAttachmentByorderNumberlineNumber POST /v2/salesorder/{orderNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain sales order line. If the file already exists, a new revision is created. - Method is deprecated and will be removed in a future version. Please start using the new method with order type.
SalesOrderV2Api salesOrderV2CreateLineAttachmentByorderNumberorderTypelineNumber POST /v2/salesorder/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain sales order line on a specific order type. If the file already exists, a new revision is created.
SalesOrderV2Api salesOrderV2CreatePurchaseOrdersActionBysaleOrderNumber POST /v2/salesorder/{saleOrderNumber}/action/createPurchaseOrders This will create 0..n PO based on SO according to the following rules for the lines on the SO - Only issue lines - Only create PO based on lines with supplier - Create PO (0..n) for each supplier on the SO lines - Create PO type purchase/drop shipment based on PO Source on SO line - If no supplier on inventory item exist the SO line will not have a corresponding PO line (response should point to lines with no supplier in either SO line or inventory item) - If 'createPurchaseOrderActionDto.preferSupplierFromSOLine' is false then the default supplier for SOLine inventory item will be used if any - If 'createPurchaseOrderActionDto.preferSupplierFromSOLine' is true then the supplier from the SOLine inventory item will be used; if there is no supplier on SOLine then the default supplier for SOLine inventory item will be used if any
SalesOrderV2Api salesOrderV2CreateShipmentActionBysaleOrderNumber POST /v2/salesorder/{saleOrderNumber}/action/createShipment Create shipment operation
SalesOrderV2Api salesOrderV2GetAllOrdersV2 GET /v2/salesorder Get a range of SO Orders - ScreenId=SO301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
SalesOrderV2Api salesOrderV2GetByorderNbr GET /v2/salesorder/{orderNbr} Get a specific SO Order
SalesOrderV2Api salesOrderV2Post POST /v2/salesorder Create a Sale Order
SalesOrderV2Api salesOrderV2PrepareInvoiceActionByorderTypeorderNumber POST /v2/salesorder/{orderType}/{orderNumber}/action/prepareInvoice Prepare Invoice operation
SalesOrderV2Api salesOrderV2ReopenSalesOrderBysalesOrderNumber POST /v2/salesorder/{salesOrderNumber}/action/reopenSalesOrder Reopen and update a specific Sales Order. This method requires a sales order update dto where the order type is initialised.
SalesOrderV2Api salesOrderV2SendEmailActionByorderTypeorderNumber POST /v2/salesorder/{orderType}/{orderNumber}/action/sendbymail Send by mail operation
SalesPersonApi salesPersonCreateSalesperson POST /v1/salesperson Create a Salesperson
SalesPersonApi salesPersonGetSalespersonBysalespersonCd GET /v1/salesperson/{salespersonCd} Get a specific Salesperson - screen ID: AR205000
SalesPersonApi salesPersonGetSalespersons GET /v1/salesperson Get all or a range of Salespersons - screen ID: AR205000 Please use a page size lower or equal to the allowed max page size which is returned under metadata. If pagesize is greater than the max page size, it will be limited to max page size.
SalesPersonApi salesPersonUpdateSalespersonBysalespersonCd PUT /v1/salesperson/{salespersonCd} Update a specific Salesperson
SalesPersonV2Api salesPersonV2GetSalespersonBysalespersonCd GET /v2/salesperson/{salespersonCd} Get a specific Salesperson - screen ID: AR205000
SalesPersonV2Api salesPersonV2GetSalespersons GET /v2/salesperson Get all or a range of Salespersons - screen ID: AR205000 Please use a page size lower or equal to the allowed max page size which is returned under metadata. If pagesize is greater than the max page size, it will be limited to max page size.
ShipmentApi shipmentAddLineByshipmentNumber POST /v1/shipment/{shipmentNumber}/action/addLine Adds a new Shipment Line to a specific Shipment
ShipmentApi shipmentAddSOLineByshipmentNumber POST /v1/shipment/{shipmentNumber}/action/addSOLine Adds a Sales Order Line to a specific Shipment
ShipmentApi shipmentAddSOOrderByshipmentNumber POST /v1/shipment/{shipmentNumber}/action/addSOOrder Adds a Sales Order to a specific Shipment
ShipmentApi shipmentCancelShipmentByshipmentNumber POST /v1/shipment/{shipmentNumber}/action/cancelShipment Cancel shipment operation
ShipmentApi shipmentConfirmShipmentByshipmentNumber POST /v1/shipment/{shipmentNumber}/action/confirmShipment Confirm shipment operation
ShipmentApi shipmentCorrectShipmentByshipmentNumber POST /v1/shipment/{shipmentNumber}/action/correctShipment Correct shipment operation
ShipmentApi shipmentDeleteLineByshipmentNumberlineNumber POST /v1/shipment/{shipmentNumber}/action/deleteLine/{lineNumber} Deletes a Shipment Line from a specific Shipment
ShipmentApi shipmentGetAllShipments GET /v1/shipment Get a range of SO Shipments - ScreenId=SO302000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
ShipmentApi shipmentGetByshipmentNbr GET /v1/shipment/{shipmentNbr} Get a specific Shipment
ShipmentApi shipmentPost POST /v1/shipment Create a Shipment
ShipmentApi shipmentPrintPickListByshipmentNbr GET /v1/shipment/{shipmentNbr}/printPickList Get the pick list report
ShipmentApi shipmentPrintShipmentConfirmationByshipmentNbr GET /v1/shipment/{shipmentNbr}/printShipmentConfirmation Get the shipment confirmation report
ShipmentApi shipmentPutByshipmentNbr PUT /v1/shipment/{shipmentNbr} Update a specific Shipment
StocktakeV2Api stocktakeV2GetAllStocktakes GET /v2/stocktake Get a range of stocktakes - ScreenId=IN305000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size.
StocktakeV2Api stocktakeV2GetByreferenceNumber GET /v2/stocktake/{referenceNumber} Get a specific
StocktakeV2Api stocktakeV2PutByreferenceNumber PUT /v2/stocktake/{referenceNumber} Update a specific stocktake
SubaccountApi subaccountGetAllSubaccounts GET /v1/subaccount Get all SubAccounts - ScreenId=GL203000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added force pagination.
SubaccountApi subaccountGetSubaccountBysubAccountNumber GET /v1/subaccount/{subAccountNumber} Get a specific SubAccount
SubaccountApi subaccountPost POST /v1/subaccount Create a Subaccount
SubaccountApi subaccountPutBysubAccountNumber PUT /v1/subaccount/{subAccountNumber} Update a specific Subaccount
SupplierApi supplierGetAll GET /v1/supplier Get a range of suppliers - ScreenId=AP303000
SupplierApi supplierGetAllContactForSupplierBysupplierCd GET /v1/supplier/{supplierCd}/contact Get a range of a Supplier of a specific supplier
SupplierApi supplierGetAllDocumentsForSupplierBysupplierNumber GET /v1/supplier/{supplierNumber}/document Gets a range of documents for a specific supplier
SupplierApi supplierGetAllInvoicesForSupplierBysupplierNumber GET /v1/supplier/{supplierNumber}/invoice Get a range of invoices for a specific supplier Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added forced pagination
SupplierApi supplierGetAllSupplierBalance GET /v1/supplier/balance Get the balance of a range of suppliers
SupplierApi supplierGetAllSupplierClasses GET /v1/supplier/supplierClass Get supplier classes
SupplierApi supplierGetAllSupplierPOBalance GET /v1/supplier/POBalance Get the PO balance of a range of suppliers
SupplierApi supplierGetBysupplierCd GET /v1/supplier/{supplierCd} Get a specific supplier
SupplierApi supplierGetSpecificSupplierClassBysupplierClassId GET /v1/supplier/supplierClass/{supplierClassId} Get a specific supplier class
SupplierApi supplierGetSupplierBalanceBysupplierCd GET /v1/supplier/{supplierCd}/balance Get a specific supplier's PO balance
SupplierApi supplierGetSupplierPOBalanceBysupplierCd GET /v1/supplier/{supplierCd}/POBalance Get a specific supplier's PO balance
SupplierApi supplierPost POST /v1/supplier Create a supplier
SupplierApi supplierPutBysupplierCd PUT /v1/supplier/{supplierCd} Update a specific supplier
SupplierAccountApi supplierAccountGetBysupplierId GET /v1/supplieraccount/{supplierId} Get expense accounts for a supplier
SupplierDocumentApi supplierDocumentGetAllDocumentsForSupplier GET /v1/supplierdocument Gets a range of supplier documents - ScreenId=AP301000 Get a range of Purchase Order - ScreenId=PO301000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size Change log: 2020-May:Added forced pagination
SupplierInvoiceApi supplierInvoiceCorrectInvoiceByinvoiceNumber POST /v1/supplierInvoice/{invoiceNumber}/action/correct Correct invoice operation
SupplierInvoiceApi supplierInvoiceCreateHeaderAttachmentByTypeBydocumentTypeinvoiceNumber POST /v1/supplierInvoice/documentType/{documentType}/{invoiceNumber}/attachment Creates an attachment and associates it with a supplier invoice. If the file already exists, a new revision is created.
SupplierInvoiceApi supplierInvoiceCreateHeaderAttachmentByinvoiceNumber POST /v1/supplierInvoice/{invoiceNumber}/attachment Creates an attachment and associates it with a supplier invoice. If the file already exists, a new revision is created.
SupplierInvoiceApi supplierInvoiceCreateLineAttachmentByTypeBydocumentTypeinvoiceNumberlineNumber POST /v1/supplierInvoice/documentType/{documentType}/{invoiceNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain supplier invoice line. If the file already exists, a new revision is created.
SupplierInvoiceApi supplierInvoiceCreateLineAttachmentByinvoiceNumberlineNumber POST /v1/supplierInvoice/{invoiceNumber}/{lineNumber}/attachment Creates an attachment and associates it with a certain supplier invoice line. If the file already exists, a new revision is created.
SupplierInvoiceApi supplierInvoiceDeleteBydocumentTypeinvoiceNumber DELETE /v1/supplierInvoice/{documentType}/{invoiceNumber} Deletes a specific Supplier Invoice
SupplierInvoiceApi supplierInvoiceDeleteByinvoiceNumber DELETE /v1/supplierInvoice/{invoiceNumber} Deletes a specific Supplier Invoice
SupplierInvoiceApi supplierInvoiceGetAllInvoices GET /v1/supplierInvoice Get a range of Invoices - ScreenId=AP301000. Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
SupplierInvoiceApi supplierInvoiceGetByApprovalDocumentId GET /v1/supplierInvoice/approval Get an invoice based on the systemId. SystemID is used for approving supplier invoices
SupplierInvoiceApi supplierInvoiceGetByTypeBydocumentTypeinvoiceNumber GET /v1/supplierInvoice/{documentType}/{invoiceNumber} Get a specific Invoice, DebitAdj, CreditAdj or Prepayment
SupplierInvoiceApi supplierInvoiceGetByinvoiceNumber GET /v1/supplierInvoice/{invoiceNumber} GET a specific invoice. Only standard invoices are supported. Credit adjustments, credit notes or Prepayments are excluded.
SupplierInvoiceApi supplierInvoicePost POST /v1/supplierInvoice Create an SupplierInvoice
SupplierInvoiceApi supplierInvoicePrebookInvoiceBydocumentTypeinvoiceNumber POST /v1/supplierInvoice/{documentType}/{invoiceNumber}/action/prebook Pre-Book invoice operation
SupplierInvoiceApi supplierInvoicePutByTypeBydocumentTypeinvoiceNumber PUT /v1/supplierInvoice/{documentType}/{invoiceNumber} Update a specific SupplierInvoice
SupplierInvoiceApi supplierInvoicePutByinvoiceNumber PUT /v1/supplierInvoice/{invoiceNumber} Update a specific SupplierInvoice
SupplierInvoiceApi supplierInvoiceReleaseInvoiceByTypeBydocumentTypeinvoiceNumber POST /v1/supplierInvoice/{documentType}/{invoiceNumber}/action/release Release invoice operation
SupplierInvoiceApi supplierInvoiceReleaseInvoiceByinvoiceNumber POST /v1/supplierInvoice/{invoiceNumber}/action/release Release invoice operation
SupplierInvoiceApi supplierInvoiceReverseInvoiceBydocumentTypeinvoiceNumber POST /v1/supplierInvoice/{documentType}/{invoiceNumber}/action/reverse Provides an action for reversing a supplier invoice/adjustment
SupplierInvoiceApi supplierInvoiceSendToApprovalBydocumentTypeinvoiceNumber POST /v1/supplierInvoice/{documentType}/{invoiceNumber}/action/sendtoapproval Send invoice to approval
SupplierInvoiceApi supplierInvoiceVoidInvoiceBydocumentTypeinvoiceNumber POST /v1/supplierInvoice/{documentType}/{invoiceNumber}/action/voidinvoice Void invoice operation
SupplierInvoiceApi supplierInvoiceWriteoffInvoiceBydocumentTypeinvoiceNumber POST /v1/supplierInvoice/{documentType}/{invoiceNumber}/action/writeoff Write-off invoice operation
SupplierLocationApi supplierLocationCreate POST /v1/supplierlocation Create a Location
SupplierLocationApi supplierLocationGetLocationBybAccountIdlocationId GET /v1/supplierlocation/{bAccountId}/{locationId} Get a specific Location of a Baccount
SupplierLocationApi supplierLocationGetLocations GET /v1/supplierlocation Get a range of Locations - List screen=AP3030P1, Entry screen=AP303010 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
SupplierLocationApi supplierLocationGetLocationsForBaccountBybAccountId GET /v1/supplierlocation/{bAccountId} Get a range of Locations for a BAccount Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
SupplierLocationApi supplierLocationUpdateBybAccountIdlocationId PUT /v1/supplierlocation/{bAccountId}/{locationId} Update a specific Location
SupplierPaymentApi supplierPaymentCreateSupplierPayment POST /v1/supplierPayment Create a SupplierPayment
SupplierPaymentApi supplierPaymentGetAllPayments GET /v1/supplierPayment Get all SupplierPayments. Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size ScreenId=AP302000
SupplierPaymentApi supplierPaymentGetByTypeBypaymentTypepaymentNumber GET /v1/supplierPayment/{paymentType}/{paymentNumber} Get a specific SupplierPayment by type and number
SupplierPaymentApi supplierPaymentGetBypaymentNumber GET /v1/supplierPayment/{paymentNumber} Get a specific SupplierPayment
SupplierPaymentApi supplierPaymentPutBypaymentNumber PUT /v1/supplierPayment/{paymentNumber} Update a specific SupplierPayment
SupplierPaymentApi supplierPaymentReleasePaymentBypaymentNumber POST /v1/supplierPayment/{paymentNumber}/action/release Release payment operation
SupplierPaymentApi supplierPaymentWriteoffPaymentBypaymentTypepaymentNumber POST /v1/supplierPayment/{paymentType}/{paymentNumber}/action/writeoff Write-off payment operation
SupplierV2Api supplierV2GetAllSupplierBalance GET /v2/supplier/balance Get the balance for one or multiple suppliers
TimeCardApi timeCardCreateTimeCard POST /v1/timeCard Creates a time card
TimeCardApi timeCardGetAllEmployeeTimeCards GET /v1/timeCard Get all employee time cards, a filter needs to be specified - ScreenId=EP305000
TimeCardApi timeCardGetEmployeeTimeCardByreferenceNumber GET /v1/timeCard/{referenceNumber} Get a specific employee time card
TimeCardApi timeCardPutTimeCardOnHoldBytimeCardCd POST /v1/timeCard/{timeCardCd}/action/hold Put timecard on hold
TimeCardApi timeCardSendTimeCardToApprovalBytimeCardCd POST /v1/timeCard/{timeCardCd}/action/approval Send time card to approval
TimeCardApi timeCardSubmitTimeCardBytimeCardCd POST /v1/timeCard/{timeCardCd}/action/submit Submit time card operation
TimeCardApi timeCardUpdateTimeCardByreferenceNumber PUT /v1/timeCard/{referenceNumber} Updates a specific time card
UiExtensionApi uiExtensionDeleteByownerIdinternalId DELETE /v1/uiExtension/{ownerId}/{internalId} Delete Menu Ui Extension
UiExtensionApi uiExtensionDeleteByownerIdinternalIdscreenIdstepId DELETE /v1/uiExtension/{ownerId}/{internalId}/{screenId}/{stepId} Delete Action Ui Extension
UiExtensionApi uiExtensionGetAllUiExtensions GET /v1/uiExtension/availableScreens Returns the list of available screenIds and their stepIds for Ui Extensions
UiExtensionApi uiExtensionGetAllUiExtensionsByownerId GET /v1/uiExtension/{ownerId} Returns the list of all Ui Extensions for current owner - ScreenId=SM205002
UiExtensionApi uiExtensionPost POST /v1/uiExtension Create Ui Extension
UnitOfMeasureApi unitOfMeasureGetAllUnitsOfMeasure GET /v1/unitofmeasure Get a range of Units of Measure - ScreenId=CS203100
VatApi vatGetAllVats GET /v1/vat Get a range of Vats - ScreenId=TX205000
VatApi vatGetVatByvatId GET /v1/vat/{vatId} Get a specific Vat - TX205000
VatApi vatPutVatHeaderNoteByvendorCdtaxPeriodIdrevisionId PUT /v1/vat/{vendorCd}/{taxPeriodId}/{revisionId} Update vat header note.
VatApi vatPutVatLineNoteByvendorCdtaxPeriodIdrevisionIdlineNumber PUT /v1/vat/{vendorCd}/{taxPeriodId}/{revisionId}/{lineNumber}
VatCategoryApi vatCategoryGetAllVatCategories GET /v1/vatCategory Get a range of VatCategories - ScreenId=TX205500
VatCategoryApi vatCategoryGetVatCategoryBytaxCategoryId GET /v1/vatCategory/{taxCategoryId} Get a specific VatCategory
VatZoneApi vatZoneGetVatZoneByvatZoneId GET /v1/vatZone/{vatZoneId} Get a specific Vat Zone
VatZoneApi vatZoneGetVatZones GET /v1/vatZone Get Tax Zones - ScreenId=TX206000 Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size
WarehouseApi warehouseGetAll GET /v1/warehouse Get a range of Warehouses - ScreenId=IN204000
WarehouseApi warehouseGetBywarehouseID GET /v1/warehouse/{warehouseID} Get a specific Warehouse
WarehouseApi warehousePostBywarehouseID POST /v1/warehouse/{warehouseID}/location Post new location - ScreenId=IN204000
WarehouseApi warehousePutBywarehouseIDlocationID PUT /v1/warehouse/{warehouseID}/location/{locationID} Update location - ScreenId=IN204000
WebhookNotificationFeedbackApi webhookNotificationFeedbackPost POST /v1/webhooknotificationfeedback Creates/Inserts a WebhookNotificationFeedback

Models

Authorization

Authentication schemes defined for the API:

serviceapi

  • Type: OAuth
  • Flow: application
  • Authorization URL: ``
  • Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: v1
    • Generator version: 7.18.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen