Implementation Notes
This API returns invoice informations on system.
Qestioning with Invoice Number
Use for getting invoice informaiton with invoice number. MainCompanyID, MainCompanyDelarCode, InvoiceNumber, QueryType are mandatory. ParentCompanyId are optional.
Invoice Questioning with Expiry Date
Getting invoice information with expiry date. MainCompanyID, StartDate, EndDate and QueryType are mandatory. MainCompanyDealerCode, CurrencyCode and ParentCompanyId are optional.
Invoice Questioning with Collection Date
Getting invoice information with collection date. MainCompanyID, StartDate, EndDate, QueryType are mandatory. MainCompanyDealerCode, CurrencyCode and ParentCompanyID are optional.
Invoice Questioning with Enrty Date
Getting invoice information with enrty date. MainCompanyID, StartDate, EndDate, QueryType are mandatory. MainCompanyDealerCode, CurrencyCode and ParentCompanyID are optional.
URL |
/inquireDDSInvoice |
Method |
POST |
Version |
1.0 |
Scope |
payment |
Authorization Flow |
Authorization Code |
Name | Format | Description | Required/Optional |
QueryType |
Integer (1) |
Questioning Type 1: Questioning with Collection Date, 2: Questioning with Expiry Date, 3: Questioning with Entry Date, 4: Qustioning with Invoice Number |
Required |
MainCompanyID |
Integer (19) | Identity number for main company | Required |
MainCompanyDealerCode |
String (30) | Dealer identication number that is given by main company | Conditionally Required |
InvoiceNumber |
String (20) | Invoice number that is given by main company | Conditionally Required |
StartDate |
yyyy-MM-ddTHH24:mm:ss | Start date | Conditionally Required |
EndDate |
yyyy-MM-ddTHH24:mm:ss | End date | Conditionally Required |
ParentCompanyID |
Integer (19) | Parent Company Id that is given by bank | Optional |
CurrencyCode |
String (3) |
Invoice currency type Explained at DDS/DCS services seciton |
Optional |
Name | Format | Description |
MainCompanyID |
Integer | Main company identification that is given by bank |
MainCompanyDealerCode |
String | Dealer identication number that is given by main company |
InvoiceNumber |
Integer | Invoice number that is given by main company |
InvoiceAmount |
Decimal | Invoice amount |
CurrencyCode |
String | Currency code |
NameSurname |
String | Dealer name/title that is sent by main company |
LastPaymentDate |
yyyy-MM-ddTHH24:mm:ss | Invoice last payment date |
InvoiceType |
Integer |
Invoice type 1: Term Invoice, 2: Advance Invoice |
Description |
String | Description |
InvoiceReleaseDate |
yyyy-MM-ddTHH24:mm:ss | Date which is created by company on their system |
CompanyName |
String | Main company name |
GuaranteedAmountOriginal |
Decimal | Guatanteed part on invoice system entry time |
NonGuaranteedAmountOriginal |
Decimal | Nonguatanteed part on invoice system entry time |
AmountPaid |
Decimal | Paid part of invoice |
OffsetAmount |
Decimal | Total offset amount of invoice. |
TransactionId |
Integer | Trasaction identification number which is created by system |
InvoiceStatusCode |
Integer |
Invoice status code 1: Active , 2: Inactive |
InvoiceStatusDetailCode |
Integer |
DDS Status Detail Codes Explained in DDS/DCS services section |
InvoiceStatus |
Integer |
Invoice Status Code Explained in DDS/DCS services section |
SystemEntryDate |
yyyy-MM-ddTHH24:mm:ss | Invoice system entry date |
RemainingAmount |
Decimal | Invoice remaining amount |
GuaranteedAmount |
Decimal | Invoice remaining guaranteed amount |
NonGuaranteedAmount |
Decimal | Invoice remaining nonguaranteed amount |
Reference6 |
String | Special area for companies |
Reference7 |
String | Special area for companies |
Reference8 |
String | Special area for companies |
Reference9 |
String | Special area for companies |
Reference10 |
String | Special area for companies |
CollectionCurrencyCode |
String | Collection currency code |
CollectionExchangeRate |
Decimal | Collection exchange rate |
CollectionDate |
yyyy-MM-ddTHH24:mm:ss | Collection date |
DeductedAmount |
Decimal | Deducted amount |
Message Code | Description |
ACBH000025 |
Startinng date format is incorrect. |
ACBH000026 |
Ending date format is incorrect. |
ACBH000028 |
Currency code is invalid. |
ACBH000100 |
Starting date could not be greater than ending date. |
ACBH000161 |
Query type should be between 1 – 4. |
ACBH000162 |
Main compnay id format is incorrect. |
ACBH000163 |
Dealer code format is incorrect. |
ACBH000164 |
Invoice number format is incorrect. |
ACBH000165 |
Dealer code / Invoice number could not be empty. Query Type {0} |
ACBH000166 |
Starting date / Ending date could not be empty. Query Type {0} |
ACBH000174 |
Transaction cannot be performed with retail customer number. |
Request:
Qestioning with Invoice Number { "QueryType": 4, "MainCompanyID": 371004, "MainCompanyDealerCode": "apitest1", "InvoiceNumber": "1089" } Invoice Questioning with Enrty Date { "QueryType": 3, "MainCompanyID": 371004, "MainCompanyDealerCode": "apitest1", "StartDate": "2020-01-12T00:00:00+03:00", "EndDate": "2020-11-28T00:00:00+03:00", "CurrencyCode": "TL" }
Response:
{ "Header": { "StatusCode": "APIGW000000", "StatusDescription": "Completed", "ObjectID": "48cfbfb0-1cdc-4425-bc57-6ab8aa5c76e6" }, "Data": { "InvoiceInfo": [ { "InvoiceStatusCode": 2, "LastPaymentDate": "2021-01-01T00:00:00", "InvoiceAmount": 60, "MainCompanyID": 371004, "InvoiceType": 1, "TransactionId": 2020000032898432, "CurrencyCode": "TL", "InvoiceStatusDetailCode": 10, "InvoiceNumber": 1089, "SystemEntryDate": "2020-12-16T10:30:27", "InvoiceStatus": 7, "MainCompanyDealerCode": "apitest1", "RemainingAmount": 60 } ] } }
API URL : https://apigw.vakifbank.com.tr:8443