Implementation Notes
Parameters
Parameter | Value | Description |
---|---|---|
Response Messages
|
Reason | Response Model |
---|---|---|
400 |
New invoices save for using this API.
URL |
/uploadDDSInvoice |
Method |
POST |
Version |
1.0 |
Scope |
payment |
Authorization Flow |
Authorization Code |
Name | Format | Description | Required/Optional |
MainCompanyID |
Integer (19) | Main company identification that is given by bank | Required |
MainCompanyDealerCode |
String (30) | Dealer identication number that is given by main company | Required |
InvoiceNumber |
String (20) | Invoice number that is given by main company | Required |
InvoiceAmount |
Decimal (9,2) | Invoice amount | Required |
CurrencyCode |
String (3) |
Invoice currency type
Explaiden in DDS/DCS services seciton |
Required |
AreaCode |
String | If dealer areas has differencies, dealer area code /name could send in this section | Optional |
NameSurname |
String (80) | Dealer name/title that is given by main company | Optional |
LastPaymentDate |
yyyy-MM-ddTHH24:mm:ss | Invoice last payment date | Required |
InvoiceType |
Integer (1) |
Invoice type 1: Term invoice, 2: Advance Invoice |
Required |
Description |
String (200) | Description | Optional |
InvoiceReleaseDate |
yyyy-MM-ddTHH24:mm:ss | Invoice release date, hour and minute | Optional |
Reference6 |
String (100) | Special area for companies | Optional |
Reference7 |
String (100) | Special area for companies | Optional |
Reference8 |
String (100) | Special area for companies | Optional |
Reference9 |
String (100) | Special area for companies | Optional |
Reference10 |
String (100) | Special area for companies | 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 |
AreaCode |
String | If dealer areas has differencies, dealer area code /name could send in this section |
InvoiceNumber |
Integer | Invoice number that is given by main company |
LastPaymentDate |
yyyy-MM-ddTHH24:mm:ss | Invoice last payment date |
InvoiceAmount |
Decimal | Invoice amount |
CurrencyCode |
String | Currency code |
InvoiceReleaseDate |
yyyy-MM-ddTHH24:mm:ss | Invoice release date |
InvoiceStatus |
Integer |
Invoice Status Code
Explained at DDS/DCS services section. |
NameSurname |
String | Dealer name/title that is given by main company |
InvoiceType |
Integer |
Invoice type 1: Term invoice, 2: Advance Invoice |
Description |
String | Description |
CompanyName |
String | Main company name |
GuaranteedAmountOriginal |
Decimal | Guaranteed Amount at entry date |
NonGuaranteedAmountOriginal |
Decimal | Nonguaranteed Amount at entry date |
AmountPaid |
Decimal | Invoice paid amount |
OffsetAmount |
Decimal | Total invoicce offest amount |
TransactionId |
Integer | Transaction identification number which is created by system |
InvoiceStatusCode |
Integer |
Invoice status 1:Active, 2:Inactive |
InvoiceStatusDetailCode |
Integer |
DDS Status Detail Code Explained at 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 special area |
Reference7 |
String | Special area for special area |
Reference8 |
String | Special area for special area |
Reference9 |
String | Special area for special area |
Reference10 |
String | Special area for special area |
Message Code | Description |
ACBH000027 |
Currency code cannot be empty. |
ACBH000028 |
Currency code is invalid. |
ACBH000162 |
Main company id format is incorrect. |
ACBH000163 |
Dealer code format is incorrect. |
ACBH000164 |
Invoice number format is incorrect. |
ACBH000167 |
Last payment date format is incorrect. |
ACBH000168 |
Invoice release date format is incorrect. |
ACBH000169 |
Invoice type is incorrect. |
ACBH000170 |
Dealer code cannot be empty. |
ACBH000171 |
Invoice number cannot be empty. |
ACBH000174 |
Transaction cannot be performed with retail customer number. |
ACBH000243 |
Last payment date cannot be empty. |
Request:
{ "MainCompanyID": 371004, "MainCompanyDealerCode": "apitest1", "InvoiceNumber": "1011012", "InvoiceAmount": 100, "CurrencyCode": "TL", "LastPaymentDate": "2021-03-01T00:00:00+03:00", "InvoiceType": 1, "AreaCode": "", "NameSurname": "", "Description": "", "InvoiceReleaseDate": "", "Reference6": "", "Reference7": "", "Reference8": "", "Reference9": "", "Reference10": "" }
Response:
{ "Header": { "StatusCode": "APIGW000000", "StatusDescription": "Completed", "ObjectID": "436874cd-3d26-4bcb-aadb-c01e3a4c610e" }, "Data": { "InvoiceInfo": { "CurrencyCode": "TL", "InvoiceStatusCode": 2, "LastPaymentDate": "2021-03-01T00:00:00+03:00", "InvoiceStatusDetailCode": 21, "InvoiceNumber": 1011012, "InvoiceAmount": 100, "MainCompanyID": 371004, "MainCompanyDealerCode": "apitest1", "InvoiceType": 1 } } }
API URL : https://apigw.vakifbank.com.tr:8443