v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Generation

Generate Future Posting

This method can be used to generate a new Future Posting

post/GenerateFuturePosting

Request body

Methodstring required

Method name

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

InitialDatestring

Start date for future posting

DueDatestring date

Date of Due (format YYYY-MM-DD)

TaxNumberstring required

Legal Identification From Company

BankBranchstring

Beneficiary's Bank Branch

BankAccountstring

Beneficiary's Account Number (without digit)

BankAccountDigitstring

Beneficiary's Account Digit

Identifierstring required

Identifier Of The Transaction

ReceiverNamestring required

Receiver name

ReceiverTaxNumberstring required

Recipient's CPF/CNPJ

ReceiverBankstring

Receiver bank code

ReceiverBankBranchstring

Receiver bank branch

ReceiverBankAccountstring

Receiver bank account

ReceiverBankAccountDigitstring

Receiver bank account digit

DebitTypenumber required

(0 = total debit, 1 = partial debit)

Valuenumber

Value Of The Transaction without Rates

AutomaticTypenumber

(0 = Nothing, 1 = AutomaticFuturePosting)

RateValueTypeinteger

Rate type

RateValuenumber

Rate value

Descriptionstring

Description

Tagsstring[]

Example request

{
  "Method": "GenerateFuturePosting",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "InitialDate": "2022-05-21",
  "DueDate": "2022-10-24",
  "TaxNumber": "33.762.255/0001-40",
  "Identifier": "PurchaseTest1106new4",
  "ReceiverName": "Maria Isolda Sales",
  "ReceiverTaxNumber": "069.331.730-20",
  "ReceiverBank": "001",
  "ReceiverBankBranch": "0001",
  "ReceiverBankAccount": "01241455",
  "ReceiverBankAccountDigit": "1",
  "Value": 2.45,
  "ReceiverBankingData": {
    "PayeeTaxNumber": "123.456.789-00",
    "PayeeName": "José Maria",
    "BankCode": "001",
    "OurNumber": "12345678",
    "ExternalNumber": "12345678"
  },
  "RateValueType": 1,
  "RateValue": 12.5,
  "Description": "This is a new internal transfer",
  "Tags": [
    "my payment order 00051",
    "test 00051"
  ]
}

Response

Successboolean

True or False

DocumentNumberinteger

Transaction id

Example response

{
  "Success": true,
  "DocumentNumber": 656
}