Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API REST
Nome Físico	accountPayableDocument

Objetivo

Tem como objetivo viabilizar integração\estorno\cancelamento de títulos através de api Rest.

Passo a Passo

Importante: Os endpoints abaixo permitem informar vários registros no Payload, porém é indicado que não seja enviado um alto volume de registros em uma única requisição, pois a API é síncrona. Por isto, caso ocorra demora na efetivação das informações no Contas a Pagar, devido a uma grande quantidade de registros, a requisição pode apresentar problema de time-out do servidor. Não é possível indicar um número ideal de registros, pois depende das parametrizações de cada ambiente, como por exemplo se a informação está parametrizada para integrar com outros módulos: Fluxo de Caixa, Caixa e Bancos, etc. Caso haja necessidade de inclusão de um alto volume de registros o indicado é executar várias requisições com poucos registros.

Função	Criar lote de implantação de título
Verbo	POST
URL	https://{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.
Payload	Enviar JSON conforme exemplos abaixo:

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": "",
"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
}
]
}
]
}
}

{
"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
}
]
}
]
}
]
}

{
"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": 10000.00,
"documentAccountDistribution": [
{
"generalLedgerCode": "Geral",
"accountCode": "11313103",
"businessUnitCode": "999",
"distributionAmountValue": 10000.00
}
],
"documentTaxes": [
{
"countryCode": "BRA",
"stateCode": "",
"taxCode": "1708",
"taxClassCode": "1708",
"taxableIncome": 10000.00,
"aliquot": 0.00,
"taxValue": 100.00
},
{
"countryCode": "BRA",
"stateCode": "",
"taxCode": "5952",
"taxClassCode": "5952",
"taxableIncome": 10000.00,
"aliquot": 0.00,
"taxValue": 100.00
}
],
"taxNatureIncome": [
{
"countryCode": "BRA",
"stateCode": "",
"taxCode": "1708",
"taxClassCode": "1708",
"natureIncomeTaxCode": "10001",
"grossIncomeTaxAmount": 10000.00,
"irfBaseTaxAmount": 10000.00,
"irfAmountTax": 100.00,
"natureIncomeTaxPercentValue": 100.00
},
{
"countryCode": "BRA",
"stateCode": "",
"taxCode": "5952",
"taxClassCode": "5952",
"natureIncomeTaxCode": "10001",
"grossIncomeTaxAmount": 1000.00,
"natureIncomeTaxPercentValue": 100.00,
"addedTaxAmountValue": 10000.00,
"addedAmountTax": 485.00
}
]
}
]
}
]
}

{
"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
}
],
"linkedPrepayment": [
{
"branchCode": "401",
"documentType": "an",
"documentPrefix": "un",
"vendorCode": 11012,
"documentNumber": "tstrest",
"documentInstallment": "01",
"linkedValue": 200.00
}
]
}
]
}
]
}

{
"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
}
],
"creditCardPayment": [
{
"creditCardContractCode": "1",
"creditCardHolderCode": "001",
"vendorCode": 1,
"documentType": "dp",
"documentPrefix": "un",
"documentNumber": "tstrestcartao",
"documentInstallment": "01",
"dueDate": "2026-03-31"
}
]
}
]
}
]
}

{
"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,
"zeroOutBalance": true,
"documentAccountDistribution": [
{
"generalLedgerCode": "Geral",
"accountCode": "11313103",
"businessUnitCode": "999",
"distributionAmountValue": 1000.00
}
],
"linkedForecast": [
{
"branchCode": "401",
"documentType": "pr",
"documentPrefix": "un",
"vendorCode": 11012,
"documentNumber": "tstrest",
"documentInstallment": "1",
"linkedValue": 200.00
},
{
"branchCode": "401",
"documentType": "po",
"documentPrefix": "un",
"vendorCode": 11012,
"documentNumber": "tstrest",
"documentInstallment": "1",
"linkedValue": 100.00
}
]
}
]
}
]
}

{
"accountPayableDocumentBatch": [
{
"branchCode": "401",
"referenceCode": "tstrest01",
"transactionDate": "2026-03-01",
"accountPayableDocument": [
{
"documentSequence": 1,
"vendorCode": 11012,
"documentType": "nc",
"documentPrefix": "un",
"documentNumber": "restnccomvinculo",
"documentInstallment": "01",
"issueDate": "2026-03-01",
"dueDate": "2026-03-01",
"forecastDate": "2026-03-01",
"currencyCode": "Real",
"documentValue": 1000.00,
"pendingDocumentLinking": [
{
"documentType": "dp",
"documentPrefix": "un",
"documentNumber": "tstrestvincul",
"documentInstallment": "01",
"linkedAmount": 1000.00,
"documentLinkingAccountDistribution": [
{
"batchReferenceCode":"tstrest01",
"documentSequence": 1,
"generalLedgerCode": "Geral",
"accountCode": "11313103",
"distributionAmountValue": 1000.00,
"businessUnitCode": "999"
}
]
}
]
},
{
"documentSequence": 2,
"vendorCode": 11012,
"documentType": "nc",
"documentPrefix": "un",
"documentNumber": "restnccomvinculo",
"documentInstallment": "02",
"issueDate": "2026-03-01",
"dueDate": "2026-03-01",
"forecastDate": "2026-03-01",
"currencyCode": "Real",
"documentValue": 2000.00,
"pendingDocumentLinking": [
{
"documentType": "dp",
"documentPrefix": "un",
"documentNumber": "tstrestvincul",
"documentInstallment": "01",
"linkedAmount": 2000.00,
"documentLinkingAccountDistribution": [
{
"batchReferenceCode":"tstrest01",
"documentSequence": 2,
"generalLedgerCode": "Geral",
"accountCode": "11313103",
"distributionAmountValue": 2000.00,
"businessUnitCode": "999"
}
]
}
]
},
{
"documentSequence": 3,
"vendorCode": 11012,
"documentType": "NC",
"documentPrefix": "un",
"documentNumber": "restncsemvinculo",
"documentInstallment": "01",
"issueDate": "2026-03-01",
"dueDate": "2026-03-01",
"forecastDate": "2026-03-01",
"currencyCode": "Real",
"documentValue": 3000.00,
"documentAccountDistribution": [
{
"generalLedgerCode": "Geral",
"accountCode": "71835808",
"businessUnitCode": "999",
"costCenterPlanCode": "Geral",
"costCenterCode": "00001",
"distributionAmountValue": 3000.00
}
]
}
]
}
]
}

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

{
"accountPayableDocumentBatch": [
{
"branchCode": "401",
"referenceCode": "tstrest01",
"documentType": "PO",
"transactionDate": "2026-03-01",
"accountPayableDocument": [
{
"documentSequence": 1,
"vendorCode": 11012,
"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",
"cashFlowTypeCode": "31002",
"businessUnitCode": "999",
"distributionAmountValue": 1000.00
}
]
}
]
}
]
}