Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Company

Get Company Contracts By Arrangement

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

post/GetCompanyContractsByArrangement

Request body

Methodstring required

Text Containing The Name Of The Method

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

ArrangementIdentifierstring required

Arrangement Identifier

Pagesizeinteger

Page Size

PageIndexinteger

Index of the page starting in 0

Example request

{
  "Method": "GetCompanyContractsByArrangement",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "ArrangementIdentifier": "ARR880ff122-e5a9-4069-aaac-d9e5f58dee8cARR",
  "Pagesize": 10,
  "PageIndex": 2
}

Response

Get Company Contracts By Arrangement

Successboolean

True or False

Messagestring

Returned message

TotalRecordsinteger

amount of results

Example response

{
  "Success": true,
  "Message": "Purchase generated successfully",
  "TotalRecords": 1,
  "CompanyContracts": {
    "ContractIdentifier": "CON965569f9-5c93-4335-b09e-29efe32ba292CON",
    "Name": "Contract Name",
    "NickName": "Contract NickName",
    "TaxNumber": "33.762.255/0001-40",
    "BusinessUnitId": 4548
  }
}