...
Todas as URLs e documentações estão disponíveis no swagger de cada API disponível para acesso através dos host Base oficial ou Base treino.
Segurança
O Token de Autorização tem a responsabilidade de autenticar os usuários nas diversas API's,
...
Outro ponto importante para verificar a integridade dos dados é a chave de acesso única ou conhecido como "x-api-key",
onde este é gerado exclusivamente para cada cliente e está é obrigatório ser informando em todas as as requisições.
Trabalhando juntas e aumentando a segurança e a integridade dos seus dados.
Estrutura
A grande maioria das requisições que retornam uma coleção possuem as seguintes opções:
- page: Controle de pagina.
- page size: Controle de quantidade de coleções a serem retornadas por paginas.
- expand: Controle de quais coleções realmente precisam ser retornadas, eliminando dados desnecessários.
- limit: Indica a quantidade de recursos a serem retornados, indo de 1 e no máximo 1000 registros por páginas.
- order: Indica por qual atributo a consulta deve ser ordenada.
- max change date: Indica qual a maior data de alteração referente ao filtro realizado.
Lista
Abaixo a lista contendo as API's e o link de sua documentação com suas funcionalidades disponíveis para utilização.
Abaixo temos um exemplo de como gerar o Token de Autorização pelo Postman, importando através de uma cURL.
Na aba Headers temos o campo x-api-key, onde deve ser inserida a chave de acesso única.
Na aba Body temos os campos onde devem ser inseridas as credenciais do cliente.
Image Added
Lista
Abaixo a lista contendo as API's e o link de sua documentação com suas funcionalidades disponíveis para utilização.
| Authorization | Documentação |
|---|
Gerar tokenAuthorizationauthorization_tokenAuthorizationauthorization_token| Accounts-receivable | Documentação |
|---|
Obter valor de limite do clienteAccountsReceivableaccounts_receivablecustomerfinancialbalanceAccountsReceivableaccounts_receivablecustomerfinancialbalance documentos de constas a receberAccountsReceivableaccountsreceivablev2documentsAccountsReceivableaccountsreceivablev2documents de boletos já impressosAccountsReceivableaccountsreceivablev2invoicesprintAccountsReceivableaccountsreceivablev2invoicesprintLiquidar faturas de contas a receberAccountsReceivablepostaccountsreceivableinvoices_settle_createAccountsReceivablepostaccountsreceivableinvoicessettlecreate| Analytics | Documentação |
|---|
Obter empresas da movimentação fiscalAnalyticsanalyticsbranch_fiscal_movement_searchAnalyticsanalyticsbranch_fiscal_movement_search dados de comprador da movimentação fiscalAnalyticspostanalyticsbuyer_fiscal_movement_searchAnalyticspostanalyticsbuyer_fiscal_movement_searchObter movimentação fiscalAnalyticsanalyticsfiscalmovementsearchAnalyticsanalyticsfiscalmovementsearch dados operação movimentação fiscalAnalyticspostanalyticsoperationfiscalmovementsearchAnalyticspostanalyticsoperationfiscalmovement_search dados de condição de pagamento da movimentação AnalyticspostanalyticspaymentfiscalmovementAnalyticspostanalyticspaymentfiscalmovement dados de pessoa da movimentação fiscalAnalyticspostanalyticspersonfiscalmovementsearchAnalyticspostanalyticspersonfiscalmovementsearch dados de produto da movimentação fiscalAnalyticsanalyticsproduct_fiscal_movementAnalyticsanalyticsproduct_fiscal_movement dados de representante da movimentação fiscalAnalyticspostanalyticsrepresentativefiscalmovementsearchAnalyticspostanalyticsrepresentativefiscalmovement_search | General | Documentação |
|---|
| Obter dados de |
vendedor da movimentação fiscalAnalyticspostanalyticsseller_fiscal_movement_searchAnalyticspostanalyticsseller_fiscal_movement_search tipo de saldo da movimentação fiscalAnalyticspostanalyticsstock_fiscal_movement_searchAnalyticspostanalyticsstock_fiscal_movement_search| Data-package | Documentação |
|---|
Obter o conteúdo de um pacote de dadosDataPackagegetdata_packagecontent_packages__packageId_DataPackagegetdata_packagecontent_packages__packageId_ um pacote de dadosDataPackagedatapackagev2inputpackagesDataPackagedatapackagev2inputpackages lista de pacotes de dadosDataPackagedatapackage_output_packagesDataPackagedatapackage_v2_output_packagesAlterar situação de um pacote de dados para "Recebido"DataPackagedatapackage_output_packages_receiveDataPackagedatapackage_output_packages_receiveObter as informações de um pacote de dadosDataPackagedata_packagepackagespackageIdDataPackagedatapackage_packagespackageId| Fiscal | Documentação |
|---|
Obter detalhe de uma item da nota fiscalFiscalfiscal_v2_invoices_item_detail_searchFiscalfiscalinvoices_item_detail_searchObter saldo de produto em condicional por empresa e pessoaFiscalfiscalinvoices_pending_conditional_productsFiscalfiscalinvoices_pending_conditional_productsObter lista de notas fiscais e seus dados por filtro geralFiscalpostfiscalinvoices_searchFiscalpostfiscalinvoices_searchObter XML(s) de uma nota fiscal eletrônica Fiscalgetfiscalxml_contents__accessKey_Fiscalgetfiscalxml_contents__accessKey_| General | Documentação |
|---|
Obter dados de operaçãoGeneralgetgeneraloperationsGeneralgetgeneraloperationsObter dados de condição de pagamento GeneralgeneralpaymentconditionsGeneralgeneralpaymentconditions| Global | Documentação |
|---|
| Consultar CEP | Treino: Produção: |
| Consultar país | Treino: Produção: |
| Consultar estado | Treino: Produção: |
| Consultar cidade | Treino: Produção: |
| Image | Documentação |
|---|
Importar imagem de produto | Treino: parameter |
| Obter parâmetros corporativos | Treino: |
ProductImagepostimageproductProductImagepostimageproductConsultar imagem de produtoProductImagepostimageproduct_searchProductImagepostimageproduct_searchManagement | Person - Pessoa | Documentação |
|---|
| Obter |
parâmetros por empresaManagementmanagementbranchparameterManagementmanagementbranchparameter parâmetros corporativosManagementmanagementglobal_parameterManagementmanagementglobal_parameterObter lista de usuáriosManagementgetmanagementusersManagementgetmanagementusers| Person | Documentação |
|---|
Obter os dados de uma empresa pelo código ou CNPJgetbranches_branchId_getbranches_branchId_ empresagetbranchesListgetbranchesListRelacionar cliente a representantecustomerrepresentativescustomerrepresentativesCriar ou alterar um cliente pessoa físicaindividualcustomersindividualcustomerssearch |
| Consultar saldo de bônus de cliente |
Obter os dados de pessoa físicaindividualssearchindividualssearchbonus |
| Obter os dados de recepção de venda |
Criar ou alterar um cliente pessoa jurídicapostlegalcustomerspostlegalcustomers pessoa jurídicalegalentities_legal_entitiesConsultar saldo de bônus de clientePersonpersonlistbalance_bonusPersonpersonlistbalance_bonusObter os dados de recepção de vendaPersongetpersonreception_sale_searchPersongetpersonreception_sale_searchObter os dados de representantePersonpersonrepresentativessearchPersonpersonrepresentatives_search| Product | Documentação saldos de produtos por filtro geralpostbalances_searchpostbalances_search código barras para barcodesbarcodes dados código de barras de barcodesbarcodes dados de categoriagetcategorygetcategoryIncluir classificação de produtopostclassification_relationship_createpost_classification_relationshipcreateAlteração classificação de produtopostclassificationrelationship_updatepostclassificationrelationship_update custos costscosts dados de gradegetgridgetgrid unidades de medida (espécie)getmeasurementunitgetmeasurementunit preços de produtos por filtro geralpostpricessearchpostpricessearch lista de produtos por filtro geralproductcodes_productcodes_Obter dados | Incluir preço ou custo de produto |
por filtro geralproductssearchproductssearchObter dados a partir de um códigogetproducts_code_getproducts_code_update |
| Obter dados de escalas de tabela de |
referênciasProductpostreferencessearchProductpostreferencessearchscales |
| Obter dados de tabela de preço |
Incluir preço ou custo de produtoProductpostvaluescreateProductpostvaluescreateheaders |
| Obter preços de produtos baseado em tabela de preço |
Alterar preço ou custo de produtoProductvaluesupdateProductvaluesupdate | Production-order - Ordem de produção | Documentação |
|---|
| Consultar |
Ordem Produção| HTML |
|---|
<!-- esconder o menu -->
<style>
div.theme-default .ia-splitter #main {
margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
display: none;
}
#main {
padding-left: 10px;
padding-right: 10px;
overflow-x: hidden;
}
.aui-header-primary .aui-nav, .aui-page-panel {
margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
margin-left: 0px !important;
}
</style>
|
