POST api/PDF/BilletPDFGenerator
Request Information
URI Parameters
None.
Body Parameters
BilletPDFGeneratorVM| Name | Description | Type | Additional information |
|---|---|---|---|
| Username | string |
None. |
|
| Password | string |
None. |
|
| DigitableLine | string |
None. |
|
| BilletDueDate | date |
None. |
|
| Agency | string |
None. |
|
| Account | string |
None. |
|
| OurNumber | string |
None. |
|
| DocumentValue | decimal number |
None. |
|
| Payer | string |
None. |
|
| PayerAddress | string |
None. |
|
| PayerAddressComplement | string |
None. |
|
| PayerNeighborhood | string |
None. |
|
| PayerCity | string |
None. |
|
| PayerState | string |
None. |
|
| Beneficiary | string |
None. |
|
| NumberNF | string |
None. |
|
| SerieNF | string |
None. |
|
| ParcelNF | string |
None. |
|
| Specie | string |
None. |
|
| Wallet | string |
None. |
|
| YourNumber | string |
None. |
|
| PaymentLocal | string |
None. |
|
| CNPJBeneficiary | string |
None. |
|
| DocumentEmission | date |
None. |
|
| SpecieDocument | string |
None. |
|
| Discount | decimal number |
None. |
|
| Mulct | decimal number |
None. |
|
| AmmountCharged | decimal number |
None. |
|
| Instruction | string |
None. |
|
| ClientId | integer |
None. |
|
| GroupCompanyId | integer |
None. |
|
| GroupCompanySubsidiaryId | integer |
None. |
|
| RequestId | integer |
None. |
|
| SocialName | string |
None. |
|
| FantasyName | string |
None. |
|
| ChargeAddress | string |
None. |
|
| PayerCNPJ | string |
None. |
|
| IEPayer | string |
None. |
|
| PayerCEP | string |
None. |
|
| TransferorCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Password": "sample string 2",
"DigitableLine": "sample string 3",
"BilletDueDate": "2026-02-20T02:07:27.4575712-03:00",
"Agency": "sample string 5",
"Account": "sample string 6",
"OurNumber": "sample string 7",
"DocumentValue": 8.0,
"Payer": "sample string 9",
"PayerAddress": "sample string 10",
"PayerAddressComplement": "sample string 11",
"PayerNeighborhood": "sample string 12",
"PayerCity": "sample string 13",
"PayerState": "sample string 14",
"Beneficiary": "sample string 15",
"NumberNF": "sample string 16",
"SerieNF": "sample string 17",
"ParcelNF": "sample string 18",
"Specie": "sample string 19",
"Wallet": "sample string 20",
"YourNumber": "sample string 21",
"PaymentLocal": "sample string 22",
"CNPJBeneficiary": "sample string 23",
"DocumentEmission": "2026-02-20T02:07:27.4731977-03:00",
"SpecieDocument": "sample string 25",
"Discount": 26.0,
"Mulct": 27.0,
"AmmountCharged": 28.0,
"Instruction": "sample string 29",
"ClientId": 30,
"GroupCompanyId": 31,
"GroupCompanySubsidiaryId": 32,
"RequestId": 33,
"SocialName": "sample string 34",
"FantasyName": "sample string 35",
"ChargeAddress": "sample string 36",
"PayerCNPJ": "sample string 37",
"IEPayer": "sample string 38",
"PayerCEP": "sample string 39",
"TransferorCode": "sample string 40"
}
application/xml, text/xml
Sample:
<BilletPDFGeneratorVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PDFGenerator.Models"> <Account>sample string 6</Account> <Agency>sample string 5</Agency> <AmmountCharged>28</AmmountCharged> <Beneficiary>sample string 15</Beneficiary> <BilletDueDate>2026-02-20T02:07:27.4575712-03:00</BilletDueDate> <CNPJBeneficiary>sample string 23</CNPJBeneficiary> <ChargeAddress>sample string 36</ChargeAddress> <ClientId>30</ClientId> <DigitableLine>sample string 3</DigitableLine> <Discount>26</Discount> <DocumentEmission>2026-02-20T02:07:27.4731977-03:00</DocumentEmission> <DocumentValue>8</DocumentValue> <FantasyName>sample string 35</FantasyName> <GroupCompanyId>31</GroupCompanyId> <GroupCompanySubsidiaryId>32</GroupCompanySubsidiaryId> <IEPayer>sample string 38</IEPayer> <Instruction>sample string 29</Instruction> <Mulct>27</Mulct> <NumberNF>sample string 16</NumberNF> <OurNumber>sample string 7</OurNumber> <ParcelNF>sample string 18</ParcelNF> <Password>sample string 2</Password> <Payer>sample string 9</Payer> <PayerAddress>sample string 10</PayerAddress> <PayerAddressComplement>sample string 11</PayerAddressComplement> <PayerCEP>sample string 39</PayerCEP> <PayerCNPJ>sample string 37</PayerCNPJ> <PayerCity>sample string 13</PayerCity> <PayerNeighborhood>sample string 12</PayerNeighborhood> <PayerState>sample string 14</PayerState> <PaymentLocal>sample string 22</PaymentLocal> <RequestId>33</RequestId> <SerieNF>sample string 17</SerieNF> <SocialName>sample string 34</SocialName> <Specie>sample string 19</Specie> <SpecieDocument>sample string 25</SpecieDocument> <TransferorCode>sample string 40</TransferorCode> <Username>sample string 1</Username> <Wallet>sample string 20</Wallet> <YourNumber>sample string 21</YourNumber> </BilletPDFGeneratorVM>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |