Finance

documento /v3/api docs/finance · pacote generated/finance · 75 operações método do sdk descrição http caminho escopo exigido corpo approvalcontrollerbydocument lista as aprovações de um documento financeiro get /api/finance/financial documents/{documentid}/approvals read finance — bankaccountcontrollercreate cadastra uma nova conta bancária post /api/finance/bank accounts manage finance catalog bankaccountrequest bankaccountcontrollerdelete inativa uma conta bancária delete /api/finance/bank accounts/{id} manage finance catalog — bankaccountcontrollerfindall lista as contas bancárias get /api/finance/bank accounts read finance — bankaccountcontrollerfindbyid retorna uma conta bancária pelo identificador get /api/finance/bank accounts/{id} manage finance catalog — bankaccountcontrollerrestore reativa uma conta bancária post /api/finance/bank accounts/{id}/restore manage finance catalog — bankaccountcontrollersetprimary define a conta bancária como principal do seu favorecido post /api/finance/bank accounts/{id}/primary manage finance catalog — bankaccountcontrollerupdate atualiza uma conta bancária existente put /api/finance/bank accounts/{id} manage finance catalog bankaccountrequest bankreconciliationcontrolleraddline adiciona uma linha de extrato a uma conciliação bancária post /api/finance/bank reconciliations/{id}/lines settle document statementlinerequest bankreconciliationcontrollercancel — post /api/finance/bank reconciliations/{id}/cancel manage treasury cancelrequest bankreconciliationcontrollerclassifyline classifica uma linha de extrato associando a a uma movimentação de caixa post /api/finance/bank reconciliations/lines/{lineid}/classify settle document — bankreconciliationcontrollerfindall lista as conciliações bancárias get /api/finance/bank reconciliations read finance — bankreconciliationcontrollergetlines lista as linhas de extrato de uma conciliação bancária get /api/finance/bank reconciliations/{id}/lines read finance — bankreconciliationcontrolleropen abre uma conciliação bancária post /api/finance/bank reconciliations settle document bankreconciliationrequest bankreconciliationcontrollerrecognizeascustomeradvance reconhece uma linha de extrato como adiantamento de cliente, criando um recebível post /api/finance/bank reconciliations/lines/{lineid}/recognize customer advance settle document recognizecustomeradvancerequest bankreconciliationcontrollerreconcile encerra uma conciliação bancária post /api/finance/bank reconciliations/{id}/reconcile settle document — bankreconciliationcontrollerunclassifiedlines — get /api/finance/bank reconciliations/unclassified lines read finance — cashmovementcontrollerbalance retorna o saldo de caixa/banco get /api/finance/cash movements/balance read finance — cashmovementcontrollercashflowbydimension retorna o fluxo de caixa segmentado por dimensão (centro, unidade ou empresa) get /api/finance/cash movements/cash flow by dimension settle document — cashmovementcontrollerfindbyaccount lista as movimentações de caixa/banco por conta get /api/finance/cash movements read finance — cashmovementcontrollerregister registra uma movimentação manual de caixa/banco post /api/finance/cash movements settle document cashmovementrequest contractcontrolleraddmeasurement — post /api/finance/contracts/{id}/measurements manage contract measurementrequest contractcontrollerattest — post /api/finance/contracts/{id}/measurements/{measurementid}/attest manage contract — contractcontrollerbyid — get /api/finance/contracts/{id} read finance — contractcontrollercreate — post /api/finance/contracts manage contract contractrequest contractcontrollerdelete — delete /api/finance/contracts/{id} manage contract — contractcontrollerdiscardmeasurement — delete /api/finance/contracts/{id}/measurements/{measurementid} manage contract — contractcontrollerlist — get /api/finance/contracts read finance — contractcontrollermeasurements — get /api/finance/contracts/{id}/measurements read finance — contractcontrollerremainingbalance — get /api/finance/contracts/{id}/remaining balance read finance — contractcontrollerupdate — put /api/finance/contracts/{id} manage contract contractrequest costallocationcontrollerfindall lista os rateios de centro de custo de um documento financeiro get /api/finance/financial documents/{documentid}/allocations read finance — costallocationcontrollerreplace substitui o rateio de centros de custo de um documento financeiro put /api/finance/financial documents/{documentid}/allocations approve document costallocationrequest costcentercontrollercreate cadastra um novo centro de custo post /api/finance/cost centers manage finance catalog costcenterrequest costcentercontrollerdelete inativa um centro de custo delete /api/finance/cost centers/{id} manage finance catalog — costcentercontrollerfindall lista os centros de custo get /api/finance/cost centers read finance — costcentercontrollerfindbyid retorna um centro de custo pelo identificador get /api/finance/cost centers/{id} read finance — costcentercontrollerrestore reativa um centro de custo post /api/finance/cost centers/{id}/restore manage finance catalog — costcentercontrollerupdate atualiza um centro de custo existente put /api/finance/cost centers/{id} manage finance catalog costcenterrequest financialagingcontrollerap retorna o aging de contas a pagar get /api/finance/aging/ap read finance — financialagingcontrollerar retorna o aging de contas a receber get /api/finance/aging/ar read finance — financialagingcontrollerkpis retorna os indicadores (kpis) de aging get /api/finance/aging/kpis read finance — financialagingcontrollertopdebtors retorna os maiores devedores por saldo vencido get /api/finance/aging/top debtors read finance — financialdocumentcontrolleradvancereceipt retorna o comprovante de adiantamento de um documento financeiro get /api/finance/financial documents/{id}/advance receipt read finance — financialdocumentcontrollerapplyadvances aplica automaticamente os adiantamentos em aberto do parceiro no título post /api/finance/financial documents/{id}/apply advances settle document — financialdocumentcontrollerblock bloqueia um título financeiro, impedindo sua baixa post /api/finance/financial documents/{id}/block approve document — financialdocumentcontrollercancel cancela um título financeiro post /api/finance/financial documents/{id}/cancel cancel document canceldocumentrequest financialdocumentcontrollercreate cadastra um novo documento financeiro (pagar ou receber) post /api/finance/financial documents manage financial document registerfinancialdocumentrequest financialdocumentcontrollercreateinstallments cadastra um título financeiro parcelado post /api/finance/financial documents/installments manage financial document registerfinancialdocumentrequest financialdocumentcontrollerendorse endossa um título financeiro a outro parceiro, transferindo a titularidade post /api/finance/financial documents/{id}/endorse approve document — financialdocumentcontrollerextend prorroga a data de vencimento de um documento financeiro post /api/finance/financial documents/{id}/extend approve document — financialdocumentcontrollerfindall lista os documentos financeiros get /api/finance/financial documents read finance — financialdocumentcontrollerfindbyid retorna um documento financeiro pelo identificador get /api/finance/financial documents/{id} read finance — financialdocumentcontrollergetsettlements lista as liquidações de um documento financeiro get /api/finance/financial documents/{id}/settlements read finance — financialdocumentcontrolleroffsetadvance compensa um documento financeiro contra um adiantamento post /api/finance/financial documents/{id}/offset advance settle document advanceoffsetrequest financialdocumentcontrollersettle registra a liquidação de um documento financeiro post /api/finance/financial documents/{id}/settlements settle document settlementrequest financialdocumentcontrollerunblock desbloqueia um documento financeiro, permitindo sua liquidação post /api/finance/financial documents/{id}/unblock approve document — financialdocumentlinkcontrolleradd vincula um documento de origem comercial a um título financeiro post /api/finance/financial documents/{documentid}/links manage financial document linkrequest financialdocumentlinkcontrollerlist lista os vínculos de origem comercial de um documento financeiro get /api/finance/financial documents/{documentid}/links read finance — financialdocumentlinkcontrollerremove remove um vínculo de origem comercial de um documento financeiro delete /api/finance/financial documents/{documentid}/links/{linkid} manage financial document — financialdocumentsurchargecontrollerlist lista os acréscimos de um documento financeiro get /api/finance/financial documents/{documentid}/surcharges read finance — financialdocumentsurchargecontrolleropenbalance retorna o saldo em aberto de acréscimos de um documento financeiro get /api/finance/financial documents/{documentid}/surcharges/open balance read finance — financialdocumentsurchargecontrollerregister registra um acréscimo (juros/multa) em um título financeiro post /api/finance/financial documents/{documentid}/surcharges settle document surchargerequest operationalbankaccountcontrolleractivate ativa a extensão de tesouraria de uma conta bancária post /api/finance/bank accounts/{bankaccountid}/operational manage finance catalog operationalbankaccountrequest operationalbankaccountcontrollerdeactivate desativa a extensão de tesouraria de uma conta bancária delete /api/finance/bank accounts/{bankaccountid}/operational manage finance catalog — operationalbankaccountcontrollerfindbyid retorna a extensão de tesouraria de uma conta bancária get /api/finance/bank accounts/{bankaccountid}/operational manage finance catalog — operationalbankaccountcontrollerupdate atualiza a extensão de tesouraria de uma conta bancária put /api/finance/bank accounts/{bankaccountid}/operational manage finance catalog operationalbankaccountrequest paymentordercontrollerauthorize autoriza uma ordem de pagamento post /api/finance/payment orders/{id}/authorize approve document — paymentordercontrollercancel cancela uma ordem de pagamento post /api/finance/payment orders/{id}/cancel cancel document — paymentordercontrollercreate cadastra uma nova ordem de pagamento post /api/finance/payment orders settle document paymentorderrequest paymentordercontrollerfindall lista as ordens de pagamento get /api/finance/payment orders read finance — paymentordercontrollerfindbyid retorna uma ordem de pagamento pelo identificador get /api/finance/payment orders/{id} read finance — paymentordercontrollergetitems lista os itens de uma ordem de pagamento get /api/finance/payment orders/{id}/items read finance — paymentordercontrollersetitems substitui os itens (documentos e valores) de uma ordem de pagamento put /api/finance/payment orders/{id}/items settle document paymentorderitemrequest paymentordercontrollersettle liquida uma ordem de pagamento post /api/finance/payment orders/{id}/settle settle document — corpos de requisição advanceoffsetrequest campo tipo obrigatório observação advancedocumentid string (uuid) sim — amount number sim — notes string — máx 400 bankaccountrequest campo tipo obrigatório observação accountnumber string — máx 24 bankcode string — máx 8 bankname string — máx 80 branch string — máx 16 checkdigit string — máx 4 holderdocument string — máx 20 holdername string — máx 120 name string sim máx 120 ownerpartnerid string (uuid) — — pixkey string — máx 140 pixkeytype string — máx 20 bankreconciliationrequest campo tipo obrigatório observação bankaccountid string (uuid) sim — bookbalance number sim — referencedate string (date) sim — statementbalance number — — canceldocumentrequest campo tipo obrigatório observação reason string — — cancelrequest campo tipo obrigatório observação reason string sim máx 240 cashmovementrequest campo tipo obrigatório observação amount number sim — bankaccountid string (uuid) sim — companyid string (uuid) — — description string — máx 240 establishmentid string (uuid) — — movementdate string (date) — — origin string — settlement · manual · transfer · schedule · check · payment order · investment resultcenterid string (uuid) — — settlementid string (uuid) — — type string sim credit · debit contractrequest campo tipo obrigatório observação adjustmentindex string sim none · ipca · igpm · incc category string sim goods supply · lease · services · works contractnumber string sim — direction string sim payable · receivable dueday integer (int32) sim mín 1 · máx 28 enddate string (date) sim — financialcategoryid string (uuid) sim — notes string — — objectdescription string sim — partnerid string (uuid) sim — startdate string (date) sim — status string — active · suspended · terminated totalamount number sim — costallocationrequest campo tipo obrigatório observação costcenterid string (uuid) sim — percentage number sim — costcenterrequest campo tipo obrigatório observação acceptsentry boolean — — code string sim máx 32 name string sim máx 160 parentid string (uuid) — — type string sim cost center · result center linkrequest campo tipo obrigatório observação label string — máx 160 linktype string sim invoice · contract · receipt · purchase order · delivery note · other reference string sim máx 80 targetid string (uuid) — — targettype string — máx 40 measurementrequest campo tipo obrigatório observação measuredamount number sim — measuredat string (date) sim — notes string — — reference string sim — operationalbankaccountrequest campo tipo obrigatório observação agreementcode string — máx 20 openingbalance number sim mín 0 openingbalancedate string (date) — — portfolio string — máx 8 treasurypurpose string sim checking · savings · cash paymentorderitemrequest campo tipo obrigatório observação amount number sim — financialdocumentid string (uuid) sim — paymentorderrequest campo tipo obrigatório observação bankaccountid string (uuid) sim — description string — máx 400 scheduleddate string (date) — — recognizecustomeradvancerequest campo tipo obrigatório observação categoryid string (uuid) — — description string — — partnerid string (uuid) sim — registerfinancialdocumentrequest campo tipo obrigatório observação advance boolean — — amount number sim — budgetcommitmentid string (uuid) — — categoryid string (uuid) sim — currency string — máx 3 description string — máx 400 documentnumber string — máx 40 duedate string (date) sim — establishmentid string (uuid) — — exchangerate number — — installment integer (int32) — — issuedate string (date) — — partnerid string (uuid) sim — series string — máx 16 sourcedocument string — máx 40 totalinstallments integer (int32) — — type string sim payable · receivable settlementrequest campo tipo obrigatório observação advancedocumentid string (uuid) — — amount number sim — bankaccountid string (uuid) — — cardfee number — — discount number — — interest number — — notes string — máx 400 paymentmethod string — cash · transfer · bank slip · check · card · pix · offset · substitution penalty number — — settlementdate string (date) — — statementlinerequest campo tipo obrigatório observação amount number sim — description string — máx 240 linedate string (date) sim — surchargerequest campo tipo obrigatório observação amount number sim — categoryid string (uuid) — — description string — máx 400 surchargetype string sim interest · penalty · other fee · discount · other deduction