v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payments

Generate Payment GRU

Generates a GRU payment.

post/GeneratePaymentGRU

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

RevenueCodestring

ReferenceNumberstring

Typestring

TaxNumberstring required

Legal Identification From Company

ContributorNamestring

ContributorTaxNumberstring required

BeneficiaryNamestring

ManagerUnitstring

Identifierstring

Identifier Of The Transaction

BarCodestring required

Competencestring

PaymentDatestring required

DueDatestring required

PrincipalValuestring required

DiscountValuestring

OtherDeductionsstring

FineValuestring

InterestValuestring

OtherValuesstring

TotalValuestring

RateValueTypestring

RateValuestring

FromBankstring

Bank code

FromBankBranchstring

Bank branch

FromBankAccountstring

Bank account

FromBankAccountDigitstring

Bank account digit

Example request

{
  "Method": "GeneratePaymentGRU",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "RevenueCode": "4321",
  "ReferenceNumber": "012018",
  "Type": "0",
  "TaxNumber": "33.762.255/0001-40",
  "ContributorName": "Maria Sousa",
  "ContributorTaxNumber": "87649862097",
  "BeneficiaryName": "João Silva",
  "ManagerUnit": "154034",
  "Identifier": "PurchaseTest1106new4",
  "BarCode": "03394894500000087671760680778200262003064000",
  "Competence": "06/2024",
  "PaymentDate": "25/06/2024",
  "DueDate": "27/06/2024",
  "PrincipalValue": "168,67",
  "DiscountValue": "0",
  "OtherDeductions": "0",
  "FineValue": "1.230,65",
  "InterestValue": "30,5",
  "OtherValues": "0",
  "TotalValue": "134,5",
  "RateValueType": "1",
  "RateValue": "1,19",
  "FromBank": "001",
  "FromBankBranch": "0801",
  "FromBankAccount": "0178945",
  "FromBankAccountDigit": "5"
}

Response

Successboolean

Messagestring

DocumentNumberinteger

Urlstring