v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Company

Get ClosedLoop Company By Id

This API is responsible for registering new Contracts within the closed payment arrangement.

post/GetClosedLoopCompanyById

Request body

Methodstring required

Text Containing The Name Of The Method

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

ContractIdentifierstring required

The Store's ContractIdentifier

Example request

{
  "Method": "GetClosedLoopCompanyById",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "ContractIdentifier": "CON965569f9-5c93-4335-b09e-29efe32ba292CON"
}

Response

Retrieve Company Contract

Successboolean

True or False

Messagestring

Returned message

Example response

{
  "Success": true,
  "Message": "Purchase generated successfully",
  "CompanyContract": {
    "ContractIdentifier": "CON965569f9-5c93-4335-b09e-29efe32ba292CON",
    "Name": "Contract Name",
    "TaxNumber": "33.762.255/0001-40",
    "CompanySector": "food",
    "ServiceType": 1,
    "RatePurchaseValue": 1.5,
    "RatePurchaseType": 1,
    "RateWithdrawalValue": 1.5,
    "RateWithdrawalType": 1,
    "RateDepositValue": 1.5,
    "RateDepositType": 1,
    "DaysToSettle": 2,
    "BusinessUnitId": 4548,
    "CreatedAt": "2024-04-17T14:06:04.837Z",
    "UpdatedAt": "2024-04-17T14:06:04.837Z"
  }
}