Skip to content

SiigoSAS/siigo_sdk_javascript

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
.github/workflows
.github/workflows
 
 
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
src
src
 
 
test
test
 
 
.babelrc
.babelrc
 
 
.czrc
.czrc
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
commitlint.config.js
commitlint.config.js
 
 
git_push.sh
git_push.sh
 
 
mocha.opts
mocha.opts
 
 
package.json
package.json
 
 
release.config.js
release.config.js
 
 

Repository files navigation

siigo_api

SiigoApi - JavaScript client for siigo_api

Installation

Using Node.js

npm install siigo_api --save

Getting Started

Initialization, add only one time in your project setup

import * as SiigoApi from 'siigo_api';

// initial configuration for the SDK  
SiigoApi.initialize({
  basePath: "The base URL for call APIs",  // https://services.siigo.com/alliances/api
  urlSignIn: "The full url sign-in",       // https://services.siigo.com/alliances/api/siigoapi-users/v1/sign-in
});

use the method signIn to generate internally the access token so that the SDK use this in the calls to endpoints of SiigoApi

try {
  await SiigoApi.signIn({ 
    userName: "The user name to sign-in",   // testname
    accessKey: "The access key to sign-in", // euy3423uykwjehqwuywj
  });
} catch (err) {
  // logic when credentials are invalid or present errors in getting token
}

Example of use

- calls with promises

import * as SiigoApi from 'siigo_api';

let apiInstance = new SiigoApi.AccountGroupApi();

apiInstance.getAccountGroups().then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

- calls with async await

import * as SiigoApi from 'siigo_api';

async function main(){
  try {
    let apiInstance = new SiigoApi.AccountGroupApi();
    const data = await apiInstance.getAccountGroups();
    console.log('API called successfully. Returned data: ' + data);
  } catch (error) {
    console.error(error);
  }
}

Documentation for API Endpoints

Class Method HTTP request Description
SiigoApi.AccountGroupApi getAccountGroups GET /v1/account-groups Returns a list of account groups.
SiigoApi.AccountsPayableApi getAccountsPayable GET /v1/accounts-payable Returns a list of document types.
SiigoApi.CostCenterApi getCostCenters GET /v1/cost-centers Returns a list of cost centers.
SiigoApi.CreditNoteApi createCreditNote POST /v1/credit-notes Creates a credit note.
SiigoApi.CreditNoteApi getCreditNote GET /v1/credit-notes/{id} Gets the credit note by GUID.
SiigoApi.CreditNoteApi getCreditNotePDF GET /v1/credit-notes/{id}/pdf Gets the credit note PDF by GUID.
SiigoApi.CreditNoteApi getCreditNotes GET /v1/credit-notes Returns a paginated list of credit notes.
SiigoApi.CustomerApi createCustomer POST /v1/customers Creates a customer.
SiigoApi.CustomerApi deleteCustomer DELETE /v1/customers/{id} Deletes the customer by GUID.
SiigoApi.CustomerApi getCustomer GET /v1/customers/{id} Gets the customer by GUID.
SiigoApi.CustomerApi getCustomers GET /v1/customers Returns a paginated list of customers.
SiigoApi.CustomerApi updateCustomer PUT /v1/customers/{id} Updates the customer by GUID.
SiigoApi.DocumentBalanceApi getDocumentBalances GET /v1/available-documents Returns client document balance.
SiigoApi.DocumentTypeApi getDocumentTypes GET /v1/document-types Returns a list of document types.
SiigoApi.FixedAssetsApi getAssetGroups GET /v1/asset-groups Returns a list of asset groups.
SiigoApi.FixedAssetsApi getFixedAssets GET /v1/fixed-assets Returns a list of fixed assets.
SiigoApi.InvoiceApi annulInvoice POST /v1/invoices/{id}/annul Annul the Invoice by GUID.
SiigoApi.InvoiceApi createInvoice POST /v1/invoices Creates an invoice.
SiigoApi.InvoiceApi deleteInvoice DELETE /v1/invoices/{id} Delete the Invoice by GUID.
SiigoApi.InvoiceApi getElectronicInvoiceErrors GET /v1/invoices/{id}/stamp/errors Returns the errors list for a rejected electronic invoice by GUID.
SiigoApi.InvoiceApi getInvoice GET /v1/invoices/{id} Gets the invoice by GUID.
SiigoApi.InvoiceApi getInvoicePDF GET /v1/invoices/{id}/pdf Gets the invoice PDF by GUID.
SiigoApi.InvoiceApi getInvoices GET /v1/invoices Returns a paginated list of invoices.
SiigoApi.InvoiceApi sendElectronicInvoice POST /v1/invoices/{id}/stamp Send electronic invoice by GUID.
SiigoApi.InvoiceApi sendInvoiceByEmail POST /v1/invoices/{id}/mail Send an invoice by email
SiigoApi.InvoiceApi updateInvoice PUT /v1/invoices/{id} Updates the Invoice by GUID.
SiigoApi.JournalEntryApi createJournal POST /v1/journals Creates a journal entry.
SiigoApi.JournalEntryApi getJournal GET /v1/journals/{id} Gets the journal entry by GUID.
SiigoApi.JournalEntryApi getJournals GET /v1/journals Returns a paginated list of journals entries.
SiigoApi.PaymentTypeApi getPaymentTypes GET /v1/payment-types Returns a list of payment types.
SiigoApi.PriceApi getPriceList GET /v1/price-lists Returns a list of price lists.
SiigoApi.ProductApi createProduct POST /v1/products Creates a product.
SiigoApi.ProductApi deleteProduct DELETE /v1/products/{id} Deletes the product by GUID.
SiigoApi.ProductApi getProduct GET /v1/products/{id} Gets the product by GUID.
SiigoApi.ProductApi getProducts GET /v1/products Returns a paginated list of products.
SiigoApi.ProductApi updateProduct PUT /v1/products/{id} Updates the product by GUID.
SiigoApi.TaxApi getTaxes GET /v1/taxes Returns a list of taxes.
SiigoApi.TestBalanceApi createTestBalance POST /v1/test-balance-report Generate a balance report.
SiigoApi.TestBalanceApi createTestBalanceByThirdparty POST /v1/test-balance-report-by-thirdparty Generate a balance report by customer.
SiigoApi.UserApi getUsers GET /v1/users Returns a paginated list of users.
SiigoApi.VoucherApi createVoucher POST /v1/vouchers Creates a voucher.
SiigoApi.VoucherApi getVoucher GET /v1/vouchers/{id} Gets the voucher by GUID.
SiigoApi.VoucherApi getVouchers GET /v1/vouchers Returns a paginated list of vouchers.
SiigoApi.VoucherApi sendElectronicVoucher POST /v1/vouchers/{id}/stamp Send electronic voucher by GUID.
SiigoApi.VoucherApi sendVoucherByEmail POST /v1/vouchers/{id}/mail Send an invoice by email
SiigoApi.WarehousesApi getWarehouse GET /v1/warehouses Returns a list of warehouse.

Documentation for Models

Documentation for Authorization

Bearer

  • Type: Bearer authentication

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 48

v3.1.0 Latest
Oct 4, 2023
+ 47 releases

Packages

No packages published

Contributors 7

Languages