Histórico da Página

...

Totvs custom tabs box

tabs	POST,PUT
ids	POST,PUT

Totvs custom tabs box items

default	yes
referencia	post

POST - Criar lote de títulos. Deve ser enviada requisição POST na ROTA https://{servidor}/api/fin/v1/accountPayableDocument/AccountPayableBatch passando o JSON com as informações do lote de títulos.

Se o registro for criado com sucesso, irá retornar status 200, caso ocorrer erros, será retornado o JSON com as mensagens de erro.

POST - Criar antecipação. Deve ser enviada requisição POST na ROTA https://{servidor}/api/fin/v1/accountPayableDocument/AccountPayableAdvance passando o JSON com as informações da antecipação.

Se o registro for criado com sucesso, irá retornar status 200, caso ocorrer erros, será retornado o JSON com as mensagens de erro.

Image Modified

POST - Criar lote de pagamento ou borderô. Deve ser enviada requisição POST na ROTA https://{servidor}/api/fin/v1/accountPayableDocument/Payment passando o JSON com as informações do lote de pagamento.

Se o registro for criado com sucesso, irá retornar status 200, caso ocorrer erros, será retornado o JSON com as mensagens de erro.

Image Modified

Totvs custom tabs box items

default	no
referencia	PUT

PUT - Estornar ou cancelar títulos. Deve ser enviada requisição PUT na ROTA https://{servidor}/api/fin/v1/accountPayableDocument/Reversal passando o JSON com as informações do título para ser estornado.

Se o registro for estornado com sucesso, irá retornar status 200, caso ocorrer erros, será retornado o JSON com as mensagens de erro.

PUT - Atualizar títulos. Deve ser enviada requisição PUT na ROTA https://{servidor}/api/fin/v1/accountPayableDocument passando o JSON com as informações do título.

Se o registro for atualizado com sucesso, irá retornar status 200, caso ocorrer erros, será retornado o JSON com as mensagens de erro.

Image Modified

04. DEMAIS INFORMAÇÕES

Exemplo de URL para consulta:

https://engjv.totvs.io/api/fin/v1/taxesCalculate?CompanyCode=10&VendorCode=1&SiteCode=1&PaymentAmount=103,25&TransDate=2024-09-05&PrintDate=2024-09-05&DueDate=2024-10-05&IsMandatoryTaxOnly=false&IdVendorsPayments=56511

JSON Retorno:

JSON para criar lote de títulos no contas a pagar (POST):

{
"AccountPayableBatchInformation": {
"BranchCode": "100",
"Reference": "241128Tzhm",
"DocumentClassCode": "",
"TransactionDate": "2024-11-28",
"ExternalBranchCode": "",
"TransactionTotalValue": 0,
"CompanyCode": "001",
"ExternalCompanyCode": "",
"ExternalEconomicPurposeCode": "",
"CurrencyCode": "",
"IsBalanceImplantation": false,
"AccountPayableDocumentInformation": [
{
"Sequence": "1",
"SupplierCode": 95,
"DocumentClassCode": "DP",
"DocumentSerieCode": "1",
"DocumentNumber": "281120241140",
"DocumentParcelNumber": "1",
"PrintDate": "2024-11-28",
"DueDate": "2025-11-28",
"PaymentForecastDate": "2025-11-28",
"DiscountDate": "",
"CurrencyCode": "Real",
"QuotationValue": 1,
"DocumentValue": 100,
"DiscountValue": 0,
"DiscountPercentage": 0,
"DaysLate": 0,
"DaysLateInterest": 0,
"DayLateInterestPercentage": 0,
"Penalty": 0,
"CollectorCode": "90000",
"ExternalModalityCode": "",
"PortfolioCode": "",
"InsurerCode": "",
"InsurancePolicyNumber": "",
"LessorCode": "",
"LeasingContractNumber": "",
"StandardHistoryDescription": "",
"ParcelQuantity": 0,
"Days": 0,
"DueForecastType": 0,
"ExternalCollectorCode": "",
"PaymentMethodCode": "TED",
"InvestmentOrder": 0,
"TenNineNineValue": 0,
"TaxIdentNumber": "",
"TenNineNineTransactionType": 0,
"ExternalEconomicPurposeCode": "",
"HarvestCode": "",
"PrepaymentWriteOffInformation": [
{
"BranchCode": "BranchCode1",
"DocumentClassCode": "DocumentClassCode1",
"DocumentSerieCode": "DocumentSerieCode1",
"DocumentNumber": "DocumentNumber1",
"DocumentParcelNumber": "DocumentParcelNumber1",
"WriteOffValue": 1.00
}
],
"ProvisionWriteOffInformation": [
{
"BranchCode": "BranchCode4",
"DocumentClassCode": "DocumentClassCode4",
"DocumentSerieCode": "DocumentSerieCode4",
"DocumentNumber": "DocumentNumber4",
"DocumentParcelNumber": "DocumentParcelNumber4",
"SupplierCode": 1,
"WriteOffValue": 1.00,
"IsZeroBal": true,
"ExternalBranchCode": "BranchCode1"
}
],
"PendentGLAppropriationInformation": [
{
"AccountPlanCode": "Geral",
"AccountCode": "11031601",
"BusinessUnitCode": "1",
"CostCenterPlanCode": "",
"CostCenterCode": "",
"FinancialFlowTypeCode": "10.06.01",
"GLAppropriationValue": 60,
"CountryCode": "",
"StateCode": "",
"TaxCode": "",
"TaxClassificationCode": "",
"ExternalFinancialFlowTypeCode": "",
"ExternalAccountCode": "",
"ExternalSubAccountCode": "",
"ExternalCostCenterCode": "",
"ExternalBusinessUnitCode": ""
},
{
"AccountPlanCode": "Geral",
"AccountCode": "21010606",
"BusinessUnitCode": "1",
"CostCenterPlanCode": "",
"CostCenterCode": "",
"FinancialFlowTypeCode": "10.06.01",
"GLAppropriationValue": 40,
"CountryCode": "",
"StateCode": "",
"TaxCode": "",
"TaxClassificationCode": "",
"ExternalFinancialFlowTypeCode": "",
"ExternalAccountCode": "",
"ExternalSubAccountCode": "",
"ExternalCostCenterCode": "",
"ExternalBusinessUnitCode": ""
}
],
"PendentTaxInformation": [
{
"CountryCode": "CountryCode1",
"StateCode": "StateCode1",
"TaxCode": "TaxC1",
"TaxClass": 1,
"TaxClassification": "TaxClassifica1",
"AccountPlanCode": "AccountPlanCode1",
"AccountCode": "AccountCode1",
"DocumentClassCode": "DocumentClassCode1",
"DocumentSerieCode": "DocumentSerieCode1",
"DocumentNumber": "DocumentNumber1",
"DocumentParcelNumber": "DocumentParcelNumber1",
"RevenueTax": 1.00,
"INSSDeduction": 1.00,
"DependentDeduction": 1.00,
"PensionDeduction": 1.00,
"OtherDeductions": 1.00,
"TaxBaseValue": 1.00,
"PaidTax": 1.00,
"TaxValue": 1.00,
"DueDate": "1900-01-01",
"CurrencyCode": "CurrencyCode1",
"EconomicPurposeValue": 1.00,
"StandardHistoryDescription": "StandardHistoryDescription1",
"SupplierCode": 1,
"DeductionValue": 1,
"ExternalCountryCode": "CountryCode1",
"ExternalAccountCode": "AccountCode1",
"ExternalSubAccountCode": "SubAccountCode1",
"ExternalFinancialFlowTypeCode": "FinancialFlowTypeCode1"
}
],
"PendentRelationInformation": [
{
"BranchCode": "BranchCode1",
"RelationValue": 1.00,
"CorrectValueReason": 1,
"RelationAppropriationInformation": {
"AccountPlanCode": "AccountPlanCode1",
"AccountCode": "AccountCode1",
"GLAppropriationValue": 1.00,
"GLAppropriationType": 1
}
}
]
}
]
},
"ExternalOrganizationTranslationMatrixCode": "EMS2"
}

JSON para criar antecipação no contas a pagar (POST):

{
"AccountPayableDocumentInformation": {
"CompanyCode": "001",
"BranchCode": "100",
"DocumentClassCode": "AN",
"DocumentSerieCode": "1",
"SupplierCode": 95,
"DocumentNumber": "291120240945",
"DocumentParcelNumber": "1",
"CollectorCode": "90000",
"CurrencyCode": "Real",
"DocumentValue": 100,
"QuotationValue": 1,
"PrintDate": "2024-11-29",
"DueDate": "2025-11-29",
"InsurerCode": "",
"InsurancePolicyNumber": "",
"LessorCode": "",
"LeasingContractNumber": "",
"StandardHistoryCode": "",
"StandardHistoryDescription": "",
"ExternalCompanyCode": "",
"ExternalBranchCode": "",
"ExternalCollectorCode": "",
"ExternalModalityCode": "",
"PrePaymentReference": "241129acxn",
"CheckBookNumber": 0,
"CheckNumber": 0,
"CheckBearer": "",
"CheckBearerName": "",
"CollectorDocumentBarCode": "",
"CollectorDocumentNumber": "",
"CollectorDocumentBarCodeType": "",
"HarvestCode": "" ,
"ProvisionWriteOffInformation": [
{
"BranchCode": "",
"DocumentClassCode": "",
"DocumentSerieCode": "",
"DocumentNumber": "",
"DocumentParcelNumber": "",
"SupplierCode": 1,
"WriteOffValue": 1.00,
"IsZeroBal": true,
"ExternalBranchCode": ""
}
],
"PendentGLAppropriationInformation": [
{
"AccountPlanCode": "Geral",
"AccountCode": "11031601",
"BusinessUnitCode": "1",
"CostCenterPlanCode": "",
"CostCenterCode": "",
"FinancialFlowTypeCode": "10.06.01",
"GLAppropriationValue": 60,
"CountryCode": "",
"StateCode": "",
"TaxCode": "",
"TaxClassificationCode": "",
"ExternalFinancialFlowTypeCode": "",
"ExternalAccountCode": "",
"ExternalSubAccountCode": "",
"ExternalCostCenterCode": "",
"ExternalBusinessUnitCode": ""
},
{
"AccountPlanCode": "Geral",
"AccountCode": "21010606",
"BusinessUnitCode": "1",
"CostCenterPlanCode": "",
"CostCenterCode": "",
"FinancialFlowTypeCode": "10.06.01",
"GLAppropriationValue": 40,
"CountryCode": "",
"StateCode": "",
"TaxCode": "",
"TaxClassificationCode": "",
"ExternalFinancialFlowTypeCode": "",
"ExternalAccountCode": "",
"ExternalSubAccountCode": "",
"ExternalCostCenterCode": "",
"ExternalBusinessUnitCode": ""
}
] ,
"PendentTaxInformation": [
{
"CountryCode": "",
"StateCode": "",
"TaxCode": "",
"TaxClass": 1,
"TaxClassification": "",
"AccountPlanCode": "",
"AccountCode": "",
"DocumentClassCode": "",
"DocumentSerieCode": "",
"DocumentNumber": "",
"DocumentParcelNumber": "",
"RevenueTax": 1.00,
"INSSDeduction": 1.00,
"DependentDeduction": 1.00,
"PensionDeduction": 1.00,
"OtherDeductions": 1.00,
"TaxBaseValue": 1.00,
"PaidTax": 1.00,
"TaxValue": 1.00,
"DueDate": "1900-01-01",
"CurrencyCode": "Real",
"EconomicPurposeValue": 1.00,
"StandardHistoryDescription": "",
"SupplierCode": 1,
"DeductionValue": 1,
"ExternalCountryCode": "",
"ExternalAccountCode": "",
"ExternalSubAccountCode": "",
"ExternalFinancialFlowTypeCode": ""
}
]
},
"ExternalOrganizationTranslationMatrixCode": "EMS2"
}

JSON para criar lote de pagamento ou borderô no contas a pagar (POST):

{
"AccountPayableBatchInformation": {
"CompanyCode": "001",
"ReferenceBranchCode": "",
"Reference": "",
"BordereauBranchCode": "100",
"TransactionDate": "2024-12-05",
"CurrencyCode": "Real",
"TotalPaymentValue": 0.0,
"TotalInformedValue": 0.0,
"SupplierCode": 0,
"StatementNumber": 17,
"InitialMessage": "",
"FinalMessage": "",
"IsStatementEletronic": false,
"IsStatementSent": false,
"EconomicPurposeCode": "",
"PortfolioCode": "",
"IsReferenceUpdated": false,
"IsPartialBatchGenerated": false,
"CollectorCode": "03399",
"ExternalBranchCode": "",
"ExternalCollectorCode": "",
"ExternalModalityCode": "",
"ExternalEconomicPurposeCode": "",
"TransactionType": 2,
"IsDocumentBranchUsed": true,
"TenNineNineInformation": {
"TenNineNineValue": 0.0,
"TaxIndentificationNumber": "",
"TenNineNineTransactionType": 0
},
"AccountPayableDocumentInformation": [
{
"CompanyCode": "001",
"Reference": "",
"CollectorCode": "90000",
"PrepaymentReference": "",
"BranchCode": "100",
"DocumentClassCode": "DP",
"DocumentSerieCode": "1",
"SupplierCode": 95,
"DocumentNumber": "281120240951",
"DocumentParcelNumber": "1",
"QuotationDate": "2024-11-28",
"QuotationValue": 1,
"PaymentValue": 100.00,
"RestatementValue": 0.0,
"DiscountValue": 0.0,
"WriteOffValue": 0.00,
"PenaltyValue": 0.0,
"InterestValue": 0.0,
"Comment": "",
"PaymentMethodCode": "TED",
"AlternativePaymentMethodCode": "",
"PaymentBankDocumentNumber": "",
"CheckBranchCode": "",
"Sequence": "1",
"EconomicPurposeCode": "",
"CheckbookNumber": 0,
"CheckNumber": 0,
"CheckBearer": "",
"CheckBearerName": "",
"CurrencyCode": "Real",
"ExchangeVarianceValue": 0.0,
"PortfolioCode": "",
"ExternalCollectorCode": "",
"ExternalModalityCode": "",
"ExternalEconomicPurposeCode": "" ,
"PrepaymentWriteOffInformation": [
{
"BranchCode": "BranchCode1",
"DocumentClassCode": "DocumentClassCode1",
"DocumentSerieCode": "DocumentSerieCode1",
"SupplierCode": 0,
"DocumentNumber": "DocumentNumber1",
"DocumentParcelNumber": "DocumentParcelNumber1",
"WriteOffValue": 1.00
}
] ,
"ProvisionWriteOffInformation": [
{
"BranchCode": "BranchCode4",
"DocumentClassCode": "DocumentClassCode4",
"DocumentSerieCode": "DocumentSerieCode4",
"SupplierCode": 1,
"DocumentNumber": "DocumentNumber4",
"DocumentParcelNumber": "DocumentParcelNumber4",
"WriteOffValue": 1.00,
"IsZeroBal": true
}
],
"PendentGLAppropriationInformation": [
{
"AccountPlanCode": "Geral",
"AccountCode": "11031601",
"BusinessUnitCode": "1",
"CostCenterPlanCode": "",
"CostCenterCode": "",
"FinancialFlowTypeCode": "10.06.01",
"GLAppropriationValue": 60,
"CountryCode": "",
"StateCode": "",
"TaxCode": "",
"TaxClassificationCode": "",
"ExternalFinancialFlowTypeCode": "",
"ExternalAccountCode": "",
"ExternalSubAccountCode": "",
"ExternalCostCenterCode": "",
"ExternalBusinessUnitCode": ""
}
],
"PendentTaxInformation": [
{
"SupplierCode": 1,
"CountryCode": "CountryCode1",
"StateCode": "StateCode1",
"TaxCode": "TaxC1",
"TaxClass": 1,
"TaxClassification": "TaxClassifica1",
"AccountPlanCode": "AccountPlanCode1",
"AccountCode": "AccountCode1",
"DocumentClassCode": "DocumentClassCode1",
"DocumentSerieCode": "DocumentSerieCode1",
"DocumentNumber": "DocumentNumber1",
"DocumentParcelNumber": "DocumentParcelNumber1",
"RevenueTax": 1.00,
"INSSDeduction": 1.00,
"DependentDeduction": 1.00,
"PensionDeduction": 1.00,
"OtherDeductions": 1.00,
"TaxBaseValue": 1.00,
"TaxPercentage": 0.0,
"PaidTax": 1.00,
"TaxValue": 1.00,
"DueDate": "1900-01-01",
"CurrencyCode": "CurrencyCode1",
"EconomicPurposeValue": 1.00,
"DeductionValue": 1,
"StandardHistoryDescription": "StandardHistoryDescription1",
"ExternalCountryCode": "CountryCode1",
"ExternalAccountCode": "AccountCode1",
"ExternalSubAccountCode": "SubAccountCode1",
"ExternalFinancialFlowTypeCode": "FinancialFlowTypeCode1"
}
],
"ExchangeInformation": [
{
"ExchangeContractNumber": "",
"ExchangeContractIDNumber": 0,
"ImportExchangeContractDate": "2024-12-04",
"BranchCode": "",
"Reference": "",
"ReferenceDate": "2024-12-04"
}
]
}
]
},
"ExternalOrganizationTranslationMatrixCode": "EMS2"
}

JSON para estornar ou cancelar títulos no contas a pagar (PUT):

{
"AccountPayableDocumentInformation": {
"BranchCode": "100",
"Reference": "",
"TransactionDate": "2024-12-16",
"StandardHistoryCode": "",
"StandardHistoryDescription": "",
"CollectorCode": "",
"RefundBranchCode": "100",
"IsItemReopened": false,
"IsRefundable": false,
"IsTaxReverseHeld": false,
"ExternalBranchCode": "",
"SupplierCode": 95,
"DocumentClassCode": "DP",
"DocumentSerieCode": "1",
"DocumentNumber": "281120241600",
"DocumentParcelNumber": "1",
"ReverseTypeCode": 1,
"ReversalOperation": 3,
"TransactionShortName": 3,
"TransactionReference": "241202Tzpp"
},
"ExternalOrganizationTranslationMatrixCode": "EMS2"
}

JSON para atualizar títulos no contas a pagar (PUT):

{
"AccountPayableDocumentInformation": {
"CompanyCode": "001",
"BranchCode": "100",
"SupplierCode": 95,
"DocumentClassCode": "DP",
"DocumentSerieCode": "1",
"DocumentNumber": "281120241600",
"DocumentParcelNumber": "1",
"ExternalBranchCode": "",
"TransactionDate": "2024-11-28",
"Reference": "",
"DocumentBalanceValue": 70,
"PrintDate": "",
"DueDate": "2025-11-29",
"PaymentForecastDate": "",
"LastPaymentDate": "",
"DaysLate": 0,
"Penalty": 0.0,
"DaysLateInterest": 0.0,
"DayLateInterestPercentage": 0.0,
"DiscountDate": "",
"DiscountPercentage": 0.0,
"DiscountValue": 0.0,
"CollectorCode": "90000",
"IsPaymentHeld": false,
"InsurerCode": "",
"InsurancePolicyNumber": "",
"LessorCode": "",
"LeasingContractNumber": "",
"CurrencyCode": "Real",
"IsUpdatedValueGenerated": false,
"CollectorDocumentBarCode": "",
"StandardHistoryCode": "",
"StandardHistoryDescription": "",
"PaymentMethodCode": "BOL",
"CollectorDocumentNumber": "",
"InvestmentOrder": 0,
"PurchaseOrderNumber": 0,
"PurchaseRequisitionNumber": 0,
"InvestmentEventCode": 0,
"TenNineNineValue": 0.0,
"TaxIdentNumber": "",
"TenNineNineTransactionType": 0,
"UpdateReason": 1,
"Situation": 0,
"PendentGLAppropriationInformation": [
{
"BranchCode": "100",
"Reference": "",
"Sequence": 0,
"FinancialFlowTypeCode": "10.06.01",
"AccountPlanCode": "Geral",
"AccountCode": "11031601",
"BusinessUnitCode": "1",
"CostCenterPlanCode": "",
"CostCenterCode": "",
"GLAppropriationValue": 90,
"ProRataType": 3
}
]
},
"ExternalOrganizationTranslationMatrixCode": "EMS2"
}

JSON Retorno de Erros:

{
"detailedMessage": "Mensagem de ajuda",
"code": "Código da mensagem",
"message": "Mensagem",
"type": "error"{
"total": 2,
"hasNext": false,
"items": [
{
"TaxDescription": "IRRF 1%",
"TaxAmount": 0.0,
"TaxCode": "10",
"TaxPercentage": 1.0,
"TaxableRevenue": 103.25,
"TaxDueDate": "2024-10-28",
"StateCode": "",
"IsOptional": false,
"TaxSort": "1708",
"VendorShortName": "NCOM",
"TaxVendorCode": 12704,
"IdVendorsPayments": 56511
},
{
"TaxDescription": "pis cofins csll",
"TaxAmount": 4.8,
"TaxCode": "5952",
"TaxPercentage": 4.65,
"TaxableRevenue": 103.25,
"TaxDueDate": "2024-09-05",
"StateCode": "",
"IsOptional": false,
"TaxSort": "5952",
"VendorShortName": "Fornecedor",
"TaxVendorCode": 1,
"IdVendorsPayments": 56511
}
]
}

05. ASSUNTOS RELACIONADOS

Não se aplica.

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

04. DEMAIS INFORMAÇÕES