Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

FunçãoCriar lote de implantação de título
VerboPOST
URLhttps://{servidor}/api/fin/v1/accountPayableDocument/AccountPayableBatch
Path Param

Incluir os parâmetros separados por ponto e vírgula (;) após a URL. Exemplo: https://{servidor}/api/fin/v1/accountPayableDocument/AccountPayableBatch/ems2;yes

1 - Matriz de Tradução: utilizada para traduzir os atributos terminados em Ext, caso estes atributos não sejam informados não é necessário informar a matriz de tradução.

2 - Indicador atualização do lote: indica se atualiza o lote de implantação ou deixa pendente, valores possíveis: yes ou no. Caso não for informado o indicador de atualização do lote, o lote será atualizado.

PayloadEnviar JSON conforme exemplos abaixo:
Totvs custom tabs box
tabsCompleto,Duplicata,Duplicata com Imposto,Duplicata com abatimento de Antecipação, Duplicata paga com Cartão de Crédito, Duplicata com abatimento de Previsão\Provisão, Nota de Crédito, Previsão,Provisão
idsCompleto,Duplicata,DuplicataComImposto,DuplicataComAntecipação,DuplicataComCartãoDeCrédito,DuplicataComPrevisãoProvisão,NotaDeCrédito,Previsão,Provisão
Totvs custom tabs box items
defaultyes
referenciaCompleto

Abaixo segue JSON completo com todos os atributos disponíveis na implantação de título:


{
  "dsAccountPayableDocument": {
    "accountPayableDocumentBatch": [
      {
        "branchCode": "",
        "referenceCode": "",
        "documentType": "",
        "transactionDate": "2026-04-02",
        "origin": "APB",
        "branchCodeExt": "",
        "totalBatchAmount": 0.0,
        "companyCode": "",
        "companyCodeExt": "",
        "economicPurposeCodeExt": "",
        "currencyCode": "",
        "importBalance": false,
        "requiresApproval": false,
        "accountPayableDocument": [
          {
            "documentSequence": 0,
            "vendorCode": 0,
            "documentType": "",
            "documentPrefix": "",
            "documentNumber": "",
            "documentInstallment": "",
            "issueDate": "2026-04-02",
            "dueDate": "2026-04-02",
            "forecastDate": "2026-04-02",
            "discountDate": "2026-04-02",
            "currencyCode": "",
            "documentValue": 0.0,
            "discountValue": 0.0,
            "discountPercentage": 0.0,
            "daysPastDue": 0,
            "dailyLateInterestValue": 0.0,
            "dailyLateInterestRate": 0.0,
            "penaltyPercentage": 0.0,
            "holderCode": "",
            "insurancePolicyCode": "",
            "insuranceCompanyCode": "",
            "lessorCode": "",
            "leaseAgreementCode": "",
            "documentDescription": "",
            "documentID": 0,
            "documentTransactionID": 0,
            "bankTransactionID": 0,
            "numberOfInstallments": 1.0,
            "numberOfDays": 0,
            "dueDateBasis": "Mês",
            "economicPurposeCodeExt": "",
            "holderCodeExt": "",
            "portfolioExt": "",
            "portfolio": "",
            "paymentMethod": "",
            "quotationValueEconomicIndex": 0.0,
            "investmentOrder": 0,
            "tenNineNineValue": 0.0,
            "taxIdentNumber": "",
            "tenNineNineTransactionType": "Rendas",
            "barcodeType": "",
            "barcode": "",
            "bankReferenceNumber": "",
            "zeroOutBalance": false,
            "cropCode": "",
            "grainContractCode": "",
            "payeeFederalID": "",
            "payeeEntityType": "",
            "payeeName": "",
            "pixTxId": "",
            "pixQrCode": "",
            "meOrder": "",
            "datasulOrder": "",
            "laborContractWork": false,
            "laborServiceType": 0,
            "constructionRegistrationType": 0,
            "constructionID": "",
            "payoutType": "",
            "payoutDescription": "",
            "reinf": false,
            "documentAccountDistribution": [
              {
                "generalLedgerCode": "",
                "accountCode": "",
                "businessUnitCode": "",
                "costCenterPlanCode": "",
                "costCenterCode": "",
                "cashFlowTypeCode": "",
                "distributionAmountValue": 0.0,
                "cashFlowTypeCodeExt": "",
                "accountCodeExt": "",
                "subaccountCodeExt": "",
                "costCenterCodeExt": "",
                "businessUnitCodeExt": ""
              }
            ],
            "documentTaxes": [
              {
                "countryCode": "",
                "stateCode": "",
                "taxCode": "",
                "taxClassCode": "",
                "taxClass": "",
                "generalLedgerCode": "",
                "accountCode": "",
                "documentType": "",
                "documentPrefix": "",
                "documentNumber": "",
                "documentInstallment": "",
                "taxableIncome": 0.0,
                "taxDeduction": 0.0,
                "dependentsDeduction": 0.0,
                "pensionDeduction": 0.0,
                "otherDeduction": 0.0,
                "netTaxBase": 0.0,
                "aliquot": 0.0,
                "taxAlreadyColl": 0.0,
                "taxValue": 0.0,
                "dueDate": "2026-04-02",
                "currencyCode": "",
                "currencyTaxValue": 0.0,
                "documentDescription": "",
                "taxVendorCode": 0,
                "deductionTaxRange": 0.0,
                "documentID": 0,
                "documentTransactionID": 0,
                "bankTransactionID": 0,
                "countryCodeExt": "",
                "accountCodeExt": "",
                "subaccountCodeExt": "",
                "cashFlowTypeCodeExt": "",
                "feedValue": 0.0,
                "equipmentValue": 0.0,
                "transportValue": 0.0,
                "taxAccountDistribution": [
                  {
                    "batchReferenceCode": "",
                    "documentSequence": 0,
                    "generalLedgerCode": "",
                    "accountCode": "",
                    "businessUnitCode": "",
                    "costCenterPlanCode": "",
                    "costCenterCode": "",
                    "cashFlowTypeCode": "",
                    "distributionAmountValue": 0.0,
                    "cashFlowTypeCodeExt": "",
                    "accountCodeExt": "",
                    "subaccountCodeExt": "",
                    "costCenterCodeExt": "",
                    "businessUnitCodeExt": ""
                  }
                ]
              }
            ],
            "taxNatureIncome": [
              {
                "countryCode": "",
                "stateCode": "",
                "taxCode": "",
                "taxClassCode": "",
                "natureIncomeTaxCode": "",
                "grossIncomeTaxAmount": 0.0,
                "irfBaseTaxAmount": 0.0,
                "irfAmountTax": 0.0,
                "suspendedIncomeTaxAmount": 0.0,
                "irfBaseValueNotWithheld": 0.0,
                "irfAmountTaxNotWithheld": 0.0,
                "irfTaxAmountCourtDeposit": 0.0,
                "csllTaxBaseValue": 0.0,
                "csllAmountTax": 0.0,
                "csllBaseValueNotWithheld": 0.0,
                "csllAmountTaxNotWithheld": 0.0,
                "csllTaxAmountCourtDeposit": 0.0,
                "cofinsTaxBaseValue": 0.0,
                "cofinsAmountTax": 0.0,
                "cofinsBaseValueNotWithheld": 0.0,
                "confinsAmountTaxNotWithheld": 0.0,
                "cofinsTaxAmountCourtDeposit": 0.0,
                "pisTaxBaseValue": 0.0,
                "pisAmountTax": 0.0,
                "pisBaseValueNotWithheld": 0.0,
                "pisAmountTaxNotWithheld": 0.0,
                "pisTaxAmountCourtDeposit": 0.0,
                "judicialProcessCode": "",
                "suspensionCode": "",
                "natureIncomeTaxPercentValue": 0.0,
                "addedTaxAmountValue": 0.0,
                "addedAmountTax": 0.0
              }
            ],
            "linkedPrepayment": [
              {
                "branchCode": "",
                "documentType": "",
                "documentPrefix": "",
                "vendorCode": 0,
                "documentNumber": "",
                "documentInstallment": "",
                "linkedValue": 0.0
              }
            ],
            "linkedForecast": [
              {
                "branchCode": "",
                "documentType": "",
                "documentPrefix": "",
                "vendorCode": 0,
                "documentNumber": "",
                "documentInstallment": "",
                "linkedValue": 0.0
              }
            ],
            "creditCardPayment": [
              {
                "creditCardContractCode": "",
                "creditCardHolderCode": "",
                "vendorCode": 0,
                "documentType": "",
                "documentPrefix": "",
                "documentNumber": "",
                "documentInstallment": "",
                "dueDate": "2026-04-02"
              }
            ],
            "pendingDocumentLinking": [
              {
                "documentType": "",
                "documentPrefix": "",
                "documentNumber": "",
                "documentInstallment": "",
                "linkedAmount": 0.0,
                "linkingReason": "Alteração",
                "linkDocument": true,
                "documentLinkingAccountDistribution": [
                  {
                    "batchReferenceCode": "",
                    "documentSequence": 0,
                    "generalLedgerCode": "",
                    "accountCode": "",
                    "distributionAmountValue": 0.0,
                    "accountDistributionType": "Saldo",
                    "costCenterPlanCode": "",
                    "costCenterCode": "",
                    "businessUnitCode": "",
                    "cashFlowTypeCode": ""
                  }
                ]
              }
            ],
            "eletronicFiscalTax": [
              {
                "eletronicFiscalDocumentCode": "",
                "eletronicFiscalDocumentOrigin": "",
                "taxType": "",
                "taxFieldType": "",
                "taxFieldValue": ""
              }
            ]
          }
        ],
        "eletronicFiscalDocument": [
          {
            "eletronicFiscalDocumentCode": "",
            "accessKey": "",
            "branchCodeExt": "",
            "documentPrefix": "",
            "fiscalDocumentNumber": "",
            "fiscalDocumentAmount": 0.0,
            "nonTaxableTotal": 0.0,
            "documentNature": "",
            "deemedTaxCredit": false
          }
        ]
      }
    ]
  }
}

Totvs custom tabs box items
defaultno
referenciaDuplicata

{
  "accountPayableDocumentBatch": [
    {
      "branchCode": "401",
      "referenceCode": "tstrest01",
      "transactionDate": "2026-03-01",
      "accountPayableDocument": [
        {
          "documentSequence": 1,
          "vendorCode": 11012,
          "documentType": "dp",
          "documentPrefix": "un",
          "documentNumber": "tstrest0001",
          "documentInstallment": "01",
          "issueDate": "2026-03-01",
          "dueDate": "2026-03-01",
          "forecastDate": "2026-03-01",
          "currencyCode": "Real",
          "documentValue": 1000.00,
          "documentAccountDistribution": [
            {
              "generalLedgerCode": "Geral",
              "accountCode": "11313103",
              "businessUnitCode": "999",
              "distributionAmountValue": 1000.00
            }
          ]
        }    
      ]
    }
  ]
}

Totvs custom tabs box items
defaultno
referenciaDuplicataComImposto


Totvs custom tabs box items
defaultno
referenciaDuplicataComAntecipação


Totvs custom tabs box items
defaultno
referenciaDuplicataComCartãoDeCrédito


Totvs custom tabs box items
defaultno
referenciaDuplicataComPrevisãoProvisão


Totvs custom tabs box items
defaultno
referenciaNotaDeCrédito


Totvs custom tabs box items
defaultno
referenciaPrevisão


Totvs custom tabs box items
defaultno
referenciaProvisão


...