Finance

finance pacote generated/finance · 70 operações approvalcontrollerbydocument lista as aprovações de um documento financeiro classe approvalcontrollerapi · retorna array\<approval> parâmetro tipo obrigatório documentid string sim const result = await new approvalcontrollerapi(config) approvalcontrollerbydocument({ documentid / string / }); bankaccountcontrollercreate cadastra uma nova conta bancária classe bankaccountcontrollerapi · retorna bankaccountresponse parâmetro tipo obrigatório bankaccountrequest bankaccountrequest sim const result = await new bankaccountcontrollerapi(config) bankaccountcontrollercreate({ bankaccountrequest / bankaccountrequest / }); bankaccountcontrollerdelete inativa uma conta bancária classe bankaccountcontrollerapi · retorna bankaccountresponse parâmetro tipo obrigatório id string sim const result = await new bankaccountcontrollerapi(config) bankaccountcontrollerdelete({ id / string / }); bankaccountcontrollerfindall lista as contas bancárias classe bankaccountcontrollerapi · retorna pageresponsebankaccountresponse parâmetro tipo obrigatório pageable pageable sim ownerpartnerid string — const result = await new bankaccountcontrollerapi(config) bankaccountcontrollerfindall({ pageable / pageable /, ownerpartnerid / string / // opcional }); bankaccountcontrollerfindbyid retorna uma conta bancária pelo identificador classe bankaccountcontrollerapi · retorna bankaccountresponse parâmetro tipo obrigatório id string sim const result = await new bankaccountcontrollerapi(config) bankaccountcontrollerfindbyid({ id / string / }); bankaccountcontrollerrestore reativa uma conta bancária classe bankaccountcontrollerapi · retorna bankaccountresponse parâmetro tipo obrigatório id string sim const result = await new bankaccountcontrollerapi(config) bankaccountcontrollerrestore({ id / string / }); bankaccountcontrollersetprimary define a conta bancária como principal do seu favorecido classe bankaccountcontrollerapi · retorna bankaccountresponse parâmetro tipo obrigatório id string sim const result = await new bankaccountcontrollerapi(config) bankaccountcontrollersetprimary({ id / string / }); bankaccountcontrollerupdate atualiza uma conta bancária existente classe bankaccountcontrollerapi · retorna bankaccountresponse parâmetro tipo obrigatório id string sim bankaccountrequest bankaccountrequest sim const result = await new bankaccountcontrollerapi(config) bankaccountcontrollerupdate({ id / string /, bankaccountrequest / bankaccountrequest / }); bankreconciliationcontrolleraddline adiciona uma linha de extrato a uma conciliação bancária classe bankreconciliationcontrollerapi · retorna statementline parâmetro tipo obrigatório id string sim statementlinerequest statementlinerequest sim const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrolleraddline({ id / string /, statementlinerequest / statementlinerequest / }); bankreconciliationcontrollercancel classe bankreconciliationcontrollerapi · retorna bankreconciliation parâmetro tipo obrigatório id string sim cancelrequest cancelrequest sim const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrollercancel({ id / string /, cancelrequest / cancelrequest / }); bankreconciliationcontrollerclassifyline classifica uma linha de extrato associando a a uma movimentação de caixa classe bankreconciliationcontrollerapi · retorna statementline parâmetro tipo obrigatório lineid string sim cashmovementid string sim const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrollerclassifyline({ lineid / string /, cashmovementid / string / }); bankreconciliationcontrollerfindall lista as conciliações bancárias classe bankreconciliationcontrollerapi · retorna pageresponsebankreconciliation parâmetro tipo obrigatório pageable pageable sim const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrollerfindall({ pageable / pageable / }); bankreconciliationcontrollergetlines lista as linhas de extrato de uma conciliação bancária classe bankreconciliationcontrollerapi · retorna array\<statementline> parâmetro tipo obrigatório id string sim const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrollergetlines({ id / string / }); bankreconciliationcontrolleropen abre uma conciliação bancária classe bankreconciliationcontrollerapi · retorna bankreconciliation parâmetro tipo obrigatório bankreconciliationrequest bankreconciliationrequest sim const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrolleropen({ bankreconciliationrequest / bankreconciliationrequest / }); bankreconciliationcontrollerrecognizeascustomeradvance reconhece uma linha de extrato como adiantamento de cliente, criando um recebível classe bankreconciliationcontrollerapi · retorna recognizecustomeradvanceresponse parâmetro tipo obrigatório lineid string sim recognizecustomeradvancerequest recognizecustomeradvancerequest sim const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrollerrecognizeascustomeradvance({ lineid / string /, recognizecustomeradvancerequest / recognizecustomeradvancerequest / }); bankreconciliationcontrollerreconcile encerra uma conciliação bancária classe bankreconciliationcontrollerapi · retorna bankreconciliation parâmetro tipo obrigatório id string sim const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrollerreconcile({ id / string / }); bankreconciliationcontrollerunclassifiedlines classe bankreconciliationcontrollerapi · retorna array\<statementline> sem parâmetros const result = await new bankreconciliationcontrollerapi(config) bankreconciliationcontrollerunclassifiedlines(); cashmovementcontrollerbalance retorna o saldo de caixa/banco classe cashmovementcontrollerapi · retorna number parâmetro tipo obrigatório bankaccountid string sim const result = await new cashmovementcontrollerapi(config) cashmovementcontrollerbalance({ bankaccountid / string / }); cashmovementcontrollercashflowbydimension retorna o fluxo de caixa segmentado por dimensão (centro, unidade ou empresa) classe cashmovementcontrollerapi · retorna cashflowbydimensionreport parâmetro tipo obrigatório axis cashmovementcontrollercashflowbydimensionaxisenum sim const result = await new cashmovementcontrollerapi(config) cashmovementcontrollercashflowbydimension({ axis / cashmovementcontrollercashflowbydimensionaxisenum / }); cashmovementcontrollerfindbyaccount lista as movimentações de caixa/banco por conta classe cashmovementcontrollerapi · retorna array\<cashmovement> parâmetro tipo obrigatório bankaccountid string sim const result = await new cashmovementcontrollerapi(config) cashmovementcontrollerfindbyaccount({ bankaccountid / string / }); cashmovementcontrollerregister registra uma movimentação manual de caixa/banco classe cashmovementcontrollerapi · retorna cashmovement parâmetro tipo obrigatório cashmovementrequest cashmovementrequest sim const result = await new cashmovementcontrollerapi(config) cashmovementcontrollerregister({ cashmovementrequest / cashmovementrequest / }); contractcontrolleraddmeasurement classe contractcontrollerapi · retorna contractmeasurement parâmetro tipo obrigatório id string sim measurementrequest measurementrequest sim const result = await new contractcontrollerapi(config) contractcontrolleraddmeasurement({ id / string /, measurementrequest / measurementrequest / }); contractcontrollerattest classe contractcontrollerapi · retorna contractmeasurement parâmetro tipo obrigatório id string sim measurementid string sim const result = await new contractcontrollerapi(config) contractcontrollerattest({ id / string /, measurementid / string / }); contractcontrollerbyid classe contractcontrollerapi · retorna contract parâmetro tipo obrigatório id string sim const result = await new contractcontrollerapi(config) contractcontrollerbyid({ id / string / }); contractcontrollercreate classe contractcontrollerapi · retorna contract parâmetro tipo obrigatório contractrequest contractrequest sim const result = await new contractcontrollerapi(config) contractcontrollercreate({ contractrequest / contractrequest / }); contractcontrollerdelete classe contractcontrollerapi · retorna void parâmetro tipo obrigatório id string sim await new contractcontrollerapi(config) contractcontrollerdelete({ id / string / }); contractcontrollerdiscardmeasurement classe contractcontrollerapi · retorna void parâmetro tipo obrigatório id string sim measurementid string sim await new contractcontrollerapi(config) contractcontrollerdiscardmeasurement({ id / string /, measurementid / string / }); contractcontrollermeasurements classe contractcontrollerapi · retorna array\<contractmeasurement> parâmetro tipo obrigatório id string sim const result = await new contractcontrollerapi(config) contractcontrollermeasurements({ id / string / }); contractcontrollerremainingbalance classe contractcontrollerapi · retorna number parâmetro tipo obrigatório id string sim const result = await new contractcontrollerapi(config) contractcontrollerremainingbalance({ id / string / }); contractcontrollerupdate classe contractcontrollerapi · retorna contract parâmetro tipo obrigatório id string sim contractrequest contractrequest sim const result = await new contractcontrollerapi(config) contractcontrollerupdate({ id / string /, contractrequest / contractrequest / }); costallocationcontrollerfindall lista os rateios de centro de custo de um documento financeiro classe costallocationcontrollerapi · retorna array\<costallocation> parâmetro tipo obrigatório documentid string sim const result = await new costallocationcontrollerapi(config) costallocationcontrollerfindall({ documentid / string / }); costallocationcontrollerreplace substitui o rateio de centros de custo de um documento financeiro classe costallocationcontrollerapi · retorna array\<costallocation> parâmetro tipo obrigatório documentid string sim costallocationrequest costallocationrequest \[] sim const result = await new costallocationcontrollerapi(config) costallocationcontrollerreplace({ documentid / string /, costallocationrequest / array\<costallocationrequest> / }); costcentercontrollercreate cadastra um novo centro de custo classe costcentercontrollerapi · retorna costcenter parâmetro tipo obrigatório costcenterrequest costcenterrequest sim const result = await new costcentercontrollerapi(config) costcentercontrollercreate({ costcenterrequest / costcenterrequest / }); costcentercontrollerdelete inativa um centro de custo classe costcentercontrollerapi · retorna costcenter parâmetro tipo obrigatório id string sim const result = await new costcentercontrollerapi(config) costcentercontrollerdelete({ id / string / }); costcentercontrollerfindall lista os centros de custo classe costcentercontrollerapi · retorna pageresponsecostcenter parâmetro tipo obrigatório pageable pageable sim type costcentercontrollerfindalltypeenum — active boolean — q string — const result = await new costcentercontrollerapi(config) costcentercontrollerfindall({ pageable / pageable /, type / costcentercontrollerfindalltypeenum / // opcional, active / boolean / // opcional, q / string / // opcional }); costcentercontrollerfindbyid retorna um centro de custo pelo identificador classe costcentercontrollerapi · retorna costcenter parâmetro tipo obrigatório id string sim const result = await new costcentercontrollerapi(config) costcentercontrollerfindbyid({ id / string / }); costcentercontrollerrestore reativa um centro de custo classe costcentercontrollerapi · retorna costcenter parâmetro tipo obrigatório id string sim const result = await new costcentercontrollerapi(config) costcentercontrollerrestore({ id / string / }); costcentercontrollerupdate atualiza um centro de custo existente classe costcentercontrollerapi · retorna costcenter parâmetro tipo obrigatório id string sim costcenterrequest costcenterrequest sim const result = await new costcentercontrollerapi(config) costcentercontrollerupdate({ id / string /, costcenterrequest / costcenterrequest / }); financialdocumentcontrolleradvancereceipt retorna o comprovante de adiantamento de um documento financeiro classe financialdocumentcontrollerapi · retorna string parâmetro tipo obrigatório id string sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrolleradvancereceipt({ id / string / }); financialdocumentcontrollerapplyadvances aplica automaticamente os adiantamentos em aberto do parceiro no título classe financialdocumentcontrollerapi · retorna array\<advanceapplication> parâmetro tipo obrigatório id string sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollerapplyadvances({ id / string / }); financialdocumentcontrollerblock bloqueia um título financeiro, impedindo sua baixa classe financialdocumentcontrollerapi · retorna financialdocument parâmetro tipo obrigatório id string sim reason string — const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollerblock({ id / string /, reason / string / // opcional }); financialdocumentcontrollercancel cancela um título financeiro classe financialdocumentcontrollerapi · retorna financialdocument parâmetro tipo obrigatório id string sim canceldocumentrequest canceldocumentrequest — const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollercancel({ id / string /, canceldocumentrequest / canceldocumentrequest / // opcional }); financialdocumentcontrollercreate cadastra um novo documento financeiro (pagar ou receber) classe financialdocumentcontrollerapi · retorna financialdocument parâmetro tipo obrigatório registerfinancialdocumentrequest registerfinancialdocumentrequest sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollercreate({ registerfinancialdocumentrequest / registerfinancialdocumentrequest / }); financialdocumentcontrollercreateinstallments cadastra um título financeiro parcelado classe financialdocumentcontrollerapi · retorna array\<financialdocument> parâmetro tipo obrigatório installments number sim registerfinancialdocumentrequest registerfinancialdocumentrequest sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollercreateinstallments({ installments / number /, registerfinancialdocumentrequest / registerfinancialdocumentrequest / }); financialdocumentcontrollerendorse endossa um título financeiro a outro parceiro, transferindo a titularidade classe financialdocumentcontrollerapi · retorna financialdocument parâmetro tipo obrigatório id string sim newpartnerid string sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollerendorse({ id / string /, newpartnerid / string / }); financialdocumentcontrollerextend prorroga a data de vencimento de um documento financeiro classe financialdocumentcontrollerapi · retorna financialdocument parâmetro tipo obrigatório id string sim newduedate string sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollerextend({ id / string /, newduedate / string / }); financialdocumentcontrollerfindall lista os documentos financeiros classe financialdocumentcontrollerapi · retorna pageresponsefinancialdocument parâmetro tipo obrigatório pageable pageable sim type financialdocumentcontrollerfindalltypeenum — partnerid string — const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollerfindall({ pageable / pageable /, type / financialdocumentcontrollerfindalltypeenum / // opcional, partnerid / string / // opcional }); financialdocumentcontrollerfindbyid retorna um documento financeiro pelo identificador classe financialdocumentcontrollerapi · retorna financialdocument parâmetro tipo obrigatório id string sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollerfindbyid({ id / string / }); financialdocumentcontrollergetsettlements lista as liquidações de um documento financeiro classe financialdocumentcontrollerapi · retorna array\<settlement> parâmetro tipo obrigatório id string sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollergetsettlements({ id / string / }); financialdocumentcontrolleroffsetadvance compensa um documento financeiro contra um adiantamento classe financialdocumentcontrollerapi · retorna settlement parâmetro tipo obrigatório id string sim advanceoffsetrequest advanceoffsetrequest sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrolleroffsetadvance({ id / string /, advanceoffsetrequest / advanceoffsetrequest / }); financialdocumentcontrollersettle registra a liquidação de um documento financeiro classe financialdocumentcontrollerapi · retorna settlement parâmetro tipo obrigatório id string sim settlementrequest settlementrequest sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollersettle({ id / string /, settlementrequest / settlementrequest / }); financialdocumentcontrollerunblock desbloqueia um documento financeiro, permitindo sua liquidação classe financialdocumentcontrollerapi · retorna financialdocument parâmetro tipo obrigatório id string sim const result = await new financialdocumentcontrollerapi(config) financialdocumentcontrollerunblock({ id / string / }); financialdocumentlinkcontrolleradd vincula um documento de origem comercial a um título financeiro classe financialdocumentlinkcontrollerapi · retorna financialdocumentlink parâmetro tipo obrigatório documentid string sim linkrequest linkrequest sim const result = await new financialdocumentlinkcontrollerapi(config) financialdocumentlinkcontrolleradd({ documentid / string /, linkrequest / linkrequest / }); financialdocumentlinkcontrollerlist lista os vínculos de origem comercial de um documento financeiro classe financialdocumentlinkcontrollerapi · retorna array\<financialdocumentlink> parâmetro tipo obrigatório documentid string sim const result = await new financialdocumentlinkcontrollerapi(config) financialdocumentlinkcontrollerlist({ documentid / string / }); financialdocumentlinkcontrollerremove remove um vínculo de origem comercial de um documento financeiro classe financialdocumentlinkcontrollerapi · retorna void parâmetro tipo obrigatório documentid string sim linkid string sim await new financialdocumentlinkcontrollerapi(config) financialdocumentlinkcontrollerremove({ documentid / string /, linkid / string / }); financialdocumentsurchargecontrollerlist lista os acréscimos de um documento financeiro classe financialdocumentsurchargecontrollerapi · retorna array\<financialdocumentsurcharge> parâmetro tipo obrigatório documentid string sim const result = await new financialdocumentsurchargecontrollerapi(config) financialdocumentsurchargecontrollerlist({ documentid / string / }); financialdocumentsurchargecontrolleropenbalance retorna o saldo em aberto de acréscimos de um documento financeiro classe financialdocumentsurchargecontrollerapi · retorna { \[key string] number; } parâmetro tipo obrigatório documentid string sim const result = await new financialdocumentsurchargecontrollerapi(config) financialdocumentsurchargecontrolleropenbalance({ documentid / string / }); financialdocumentsurchargecontrollerregister registra um acréscimo (juros/multa) em um título financeiro classe financialdocumentsurchargecontrollerapi · retorna financialdocumentsurcharge parâmetro tipo obrigatório documentid string sim surchargerequest surchargerequest sim const result = await new financialdocumentsurchargecontrollerapi(config) financialdocumentsurchargecontrollerregister({ documentid / string /, surchargerequest / surchargerequest / }); operationalbankaccountcontrolleractivate ativa a extensão de tesouraria de uma conta bancária classe operationalbankaccountcontrollerapi · retorna operationalbankaccountresponse parâmetro tipo obrigatório bankaccountid string sim operationalbankaccountrequest operationalbankaccountrequest sim const result = await new operationalbankaccountcontrollerapi(config) operationalbankaccountcontrolleractivate({ bankaccountid / string /, operationalbankaccountrequest / operationalbankaccountrequest / }); operationalbankaccountcontrollerdeactivate desativa a extensão de tesouraria de uma conta bancária classe operationalbankaccountcontrollerapi · retorna void parâmetro tipo obrigatório bankaccountid string sim await new operationalbankaccountcontrollerapi(config) operationalbankaccountcontrollerdeactivate({ bankaccountid / string / }); operationalbankaccountcontrollerfindbyid retorna a extensão de tesouraria de uma conta bancária classe operationalbankaccountcontrollerapi · retorna operationalbankaccountresponse parâmetro tipo obrigatório bankaccountid string sim const result = await new operationalbankaccountcontrollerapi(config) operationalbankaccountcontrollerfindbyid({ bankaccountid / string / }); operationalbankaccountcontrollerupdate atualiza a extensão de tesouraria de uma conta bancária classe operationalbankaccountcontrollerapi · retorna operationalbankaccountresponse parâmetro tipo obrigatório bankaccountid string sim operationalbankaccountrequest operationalbankaccountrequest sim const result = await new operationalbankaccountcontrollerapi(config) operationalbankaccountcontrollerupdate({ bankaccountid / string /, operationalbankaccountrequest / operationalbankaccountrequest / }); paymentordercontrollerauthorize autoriza uma ordem de pagamento classe paymentordercontrollerapi · retorna paymentorder parâmetro tipo obrigatório id string sim const result = await new paymentordercontrollerapi(config) paymentordercontrollerauthorize({ id / string / }); paymentordercontrollercancel cancela uma ordem de pagamento classe paymentordercontrollerapi · retorna paymentorder parâmetro tipo obrigatório id string sim const result = await new paymentordercontrollerapi(config) paymentordercontrollercancel({ id / string / }); paymentordercontrollercreate cadastra uma nova ordem de pagamento classe paymentordercontrollerapi · retorna paymentorder parâmetro tipo obrigatório paymentorderrequest paymentorderrequest sim const result = await new paymentordercontrollerapi(config) paymentordercontrollercreate({ paymentorderrequest / paymentorderrequest / }); paymentordercontrollerfindall lista as ordens de pagamento classe paymentordercontrollerapi · retorna array\<paymentorder> sem parâmetros const result = await new paymentordercontrollerapi(config) paymentordercontrollerfindall(); paymentordercontrollerfindbyid retorna uma ordem de pagamento pelo identificador classe paymentordercontrollerapi · retorna paymentorder parâmetro tipo obrigatório id string sim const result = await new paymentordercontrollerapi(config) paymentordercontrollerfindbyid({ id / string / }); paymentordercontrollergetitems lista os itens de uma ordem de pagamento classe paymentordercontrollerapi · retorna array\<paymentorderitem> parâmetro tipo obrigatório id string sim const result = await new paymentordercontrollerapi(config) paymentordercontrollergetitems({ id / string / }); paymentordercontrollersetitems substitui os itens (documentos e valores) de uma ordem de pagamento classe paymentordercontrollerapi · retorna array\<paymentorderitem> parâmetro tipo obrigatório id string sim paymentorderitemrequest paymentorderitemrequest \[] sim const result = await new paymentordercontrollerapi(config) paymentordercontrollersetitems({ id / string /, paymentorderitemrequest / array\<paymentorderitemrequest> / }); paymentordercontrollersettle liquida uma ordem de pagamento classe paymentordercontrollerapi · retorna paymentorder parâmetro tipo obrigatório id string sim const result = await new paymentordercontrollerapi(config) paymentordercontrollersettle({ id / string / });