3.3 - Queries
Search for a specific transaction
By ID
API Method = GetFuturePostingById
Makes it possible to perform a Future Posting search for your Id
{
"Method": "GetFuturePostingById",
"PartnerId": 1136,
"BusinessUnitId": 494,
"DocumentNumber": 461821,
"TaxNumber": "070.181.053-07"
}
{
"Success": "true",
"Message": {
"DocumentNumber": 23504,
"Status": 0,
"OriginalValue": 90,
"CurrentValue": 0,
"InitialDate": "27/02/2024 00:00:00",
"DueDate": "28/02/2024 00:00:00",
"Description": "Future Posting",
"DebitType": 1,
"Tags": [
"FuturePosting",
"Documentação"
],
"FromTaxNumber": 11111111111,
"FromBank": null,
"FromBankBranch": null,
"FromBankAccount": null,
"FromBankAccountDigit": null,
"ToTaxNumber": 22222222222,
"ToBank": null,
"ToBankBranch": null,
"ToBankAccount": null,
"ToBankAccountDigit": null,
"OperationId": 629912,
"Identifier": "1045dffg-2daf-7ec-7526671de085",
"RateValueType": 0,
"RateValue": 0,
"CaptureHistory": [
{
"CapturedDate": "27/02/2024 00:00:00",
"CapturedValue": 30
},
{
"CapturedDate": "27/02/2024 00:01:00",
"CapturedValue": 30
},
{
"CapturedDate": "27/02/2024 00:02:00",
"CapturedValue": 30
}
],
"AutomaticType": {
"Type": 3,
"PayeeTaxNumber": 33333333333,
"PayerTaxNumber": 22222222222,
"DocumentNumber": 363465,
"ExternalNumber": 1222111222,
"Status": "Created",
"PrincipalValue": 90,
"PaidValue": 0
}
}
}
Description
Parameter | Type | Description | Mandatory |
---|---|---|---|
Method | String | GetFuturePostingById | YES |
PartnerId | Long | FitBank provided ID | YES |
BusinessUnitId | Long | ID provided by BU FitBank | YES |
Documentnumber | Long | future posting document number | YES |
TaxNumber | String | Payer's CPF/CNPJ | YES |
By operation data
API Method = GetFuturePosting
It makes it possible to perform a Future Posting search for the data:
- Date starts from the period;
- End date of the period;
- CPF/CNPJ account: allows you to bring only future postings from an account;
- Specific account data (optional);
- Status (optional): If informed, returns Future Postings with the status reported.
{
"Method": "GetFuturePosting",
"PartnerId": 341,
"BusinessUnitId":1236,
"InitialDate": "2022-09-22",
"FinalDate": "2022-08-20",
"TaxNumber": "209.209.209-99",
"PageIndex": 100,
"PageSize": 1,
"Bank": "209",
"BankBranch": "2003",
"BankAccount": "999999",
"BankAccountDigit": "2",
"Status": 0
}
{
"Success": true,
"FuturePostings": [
{
"DocumentNumber": 4259,
"Status": 0,
"OperationId": 127615,
"Identifier": "1745e0e5fc-88cb-e6c6772bb103",
"OriginalValue": 4,
"CurrentValue": 0,
"InitialDate": "07/04/2023 00:00:00",
"DueDate": "15/04/2023 00:00:00",
"DebitType": 0,
"Tags": [],
"FromTaxNumber": 11111111111,
"ToTaxNumber": 22222222222,
"AutomaticType": null
},
{
"DocumentNumber": 4960,
"Status": 0,
"OperationId": 14616,
"Identifier": "1745e0e2fc-88cb-e6c6772bb103",
"OriginalValue": 4,
"CurrentValue": 0,
"InitialDate": "08/04/2023 00:00:00",
"DueDate": "15/04/2023 00:00:00",
"DebitType": 0,
"Tags": [],
"FromTaxNumber": 11111111111,
"ToTaxNumber": 22222222222,
"AutomaticType": {
"Type": 3,
"PayeeTaxNumber": 33333333333,
"PayerTaxNumber": 44444444444,
"DocumentNumber:447543": null,
"ExternalNumber": 65665,
"Status:Paid": null,
"PrincipalValue": 100,
"PaidValue": 100
}
}
]
}
Parameter | Type | Description | Mandatory |
---|---|---|---|
Method | String | GetFuturePostingById | YES |
PartnerId | Long | FitBank provided ID | YES |
BusinessUnitId | Long | ID provided by BU FitBank | YES |
InicialDate | Long | Start date of future posting | YES |
FinalDate | Long | Expiration date of future posting | YES |
Taxnumber | String | Payer's CPF/CNPJ | YES |
PageIndex | Int | Reference of which page will be accessed | YES |
PageSize | Int | Number of results that will be displayed on the same page | YES |
Bank | String | Bank number | NO |
BankBranch | String | Bank branch identification | NO |
BankAccount | String | bank account details | NO |
BankAccountDigit | String | bank account digit | NO |
Status | Long | status | NO |
Future Posting STATUS
Status | Description |
---|---|
Created = 0 | Release generated and waits to be processed. |
Settled = 2 | Values are in the target account. |
Canceled = 3 | Canceled by call in api |
Balance error = 4 | Future Posting did not reach the amount or did not have enough balance for settlement |
Authorized = 10 | The Future Posting is authorized to capture values. |
PartiallySettled = 12 | The Future Posting has been partially captured. |
Updated 4 months ago