v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payments

Generate Payments FGTS

Method used to generate payments FGTS.

post/GeneratePaymentsFGTS

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

TaxNumberstring required

Legal Identification From Company

ContributorTaxNumberstring required

PrincipalValuenumber float required

Collection Order Value

CodeRevenuestring required

Barcodestring required

FgtsIdentifierstring required

SocialConnectivityCodeinteger required

SocialConnectivityDigitinteger required

PaymentDatenumber required

Constitution Date

Tagsstring[]

Example request

{
  "Method": "GeneratePaymentFGTS",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "TaxNumber": "33.762.255/0001-40",
  "ContributorTaxNumber": "87649862097",
  "PrincipalValue": 5,
  "CodeRevenue": "4321",
  "Barcode": "03394894500000087671760680778200262003064000",
  "FgtsIdentifier": "9",
  "Tags": [
    "my payment order 00051",
    "test 00051"
  ],
  "RateValueType": 1,
  "Description": "This is a new internal transfer",
  "Identifier": "PurchaseTest1106new4",
  "FromBank": "001",
  "FromBankBranch": "0801",
  "FromBankAccount": "0178945",
  "FromBankAccountDigit": "5"
}

Response

Successboolean

DocumentNumberinteger

Urlstring

AlreadyExistsstring