v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payments

Generate Payment DARF

Method used to generate tribute Darfs.

post/GeneratePaymentDARF

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

TaxNumberstring required

Legal Identification From Company

FromBankstring

Bank code

FromBankBranchstring

Bank branch

FromBankAccountstring

Bank account

FromBankAccountDIgitstring

Bank account digit

DARFTypeinteger required

GrossRevenueValuenumber

GrossRevenuePercentagestring

CalculationPeriodstring required

CodeRevenuestring required

ContributorTaxNumberstring required

ReferenceNumberstring

DueDatestring date

Date of Due (format YYYY-MM-DD)

PrincipalValuenumber float required

Collection Order Value

FineValuenumber float

Fine Value

InterestValuenumber float

Interest Value

PaymentDatenumber required

Constitution Date

Tagsstring[]

Example request

{
  "Method": "GeneratePaymentDARF",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "TaxNumber": "33.762.255/0001-40",
  "FromBank": "001",
  "FromBankBranch": "0801",
  "FromBankAccount": "0178945",
  "FromBankAccountDIgit": "5",
  "GrossRevenuePercentage": "0.0",
  "CalculationPeriod": "2022/06/05",
  "CodeRevenue": "4321",
  "ContributorTaxNumber": "87649862097",
  "ReferenceNumber": "012018",
  "DueDate": "2022-10-24",
  "PrincipalValue": 5,
  "InterestValue": 1,
  "Tags": [
    "my payment order 00051",
    "test 00051"
  ],
  "Description": "This is a new internal transfer",
  "Identifier": "PurchaseTest1106new4",
  "RateValueType": 1
}

Response

Successstring

DocumentNumberstring

EntryIdstring

Messagestring

Urlstring

AlreadyExistsstring