DDS Invoice Cancel

This api cancels invoices whichs are uploaded by dealer before.

API Information

URL

 /cancelDDSInvoice

Method

 POST

Version

 1.0

Scope

 payment

Authorization Flow

 Authorization Code


Input Information

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

CurrencyCode

 String (3) Invoice currency code
Explained at DDS/DCS services section 		Required


Output Information

InvoiceInfo

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

LastPaymentDate

 yyyy-MM-ddTHH24:mm:ss Invoice last payment date

InvoiceAmount

 Decimal Invoice amount

CurrencyCode

 String Invoice currency code

NameSurname

 String Dealer name/title that is given by main company

InvoiceType

 Integer Invoice type
1: Term invoice, 2: Advance Invoice

Description

 String Description

InvoiceReleaseDate

 yyyy-MM-ddTHH24:mm:ss Invoice release date

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 Invoice total offset amount

TransactionId

Integer Transaction identification number which is created by system

InvoiceStatusCode

Integer Invocie status
1:Active, 2:Inactive

InvoiceStatusDetailCode

Integer DDS Status Detail Codes
Explained at DDS/DCS services section

InvoiceStatus

Integer Invoice Status Codes
Explained at DDS/DCS services section

SystemEntryDate

yyyy-MM-ddTHH24:mm:ss Invoice enrty date

Reference6

String Special area for company

Reference7

String Special area for company

Reference8

String Special area for company

Reference9

String Special area for company

Reference10

String Special area for company


Message Codes

Message Code Description

ACBH000027

Currenny code cannot be empty.

ACBH000028

Currency code is invalid.

ACBH000162

Main company id format is incorrect.

ACBH000163

Dealer code id format is incorrect.

ACBH000164

Invoice number format is incoorect.

ACBH000170

Dealer code cannot be empty.

ACBH000171

Invoice number cannot be empty.

ACBH000174

Transaction cannot be performed with retail customer number.

Example

Request:

{
	"MainCompanyID": 371004,
	"MainCompanyDealerCode": "apitest1",
	"InvoiceNumber": "1011012",
	"CurrencyCode": "TL"
}

Response:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Completed",
        "ObjectID": "4a887691-8852-4198-858f-325c44e2c4ea"
    },
    "Data": {
        "InvoiceInfo": {
            "CurrencyCode": "TL",
            "InvoiceStatusCode": 2,
            "InvoiceStatusDetailCode": 10,
            "InvoiceNumber": 1011012,
            "MainCompanyID": 371004,
            "MainCompanyDealerCode": "apitest1"
        }
    }
}