3.29. E-Invoices list
Connection URL
(AL)TEST URL | http://al.dev.icash.bg/clientapi/v1/einvoices-list |
( AL ) PRODUCTION URL | https://v1.icash.al/clientapi/v1/documents-list |
( BG ) PRODUCTION URL | https://v5.icash.bg/clientapi/v1/documents-list |
POST REQUEST
Param | Description | Field type | Required |
api_key | API Key | String | YES |
nonce | Nonce | Integer | YES |
signature | Signature | String | YES |
ses |
Session | String | YES |
AlbaniaEinvoiceInfoEIC | Document ID | String (40) | No/YES |
AlbaniaEinvoiceInfoPartyType | Type | SET(BUYER, SELLER) | No/YES |
AlbaniaEinvoiceInfoStatus | Status | SET(All,DELIVERED, ACCEPTED, REFUSED, PARTIALLY_PAID, PAID) | No/YES |
AlbaniaEinvoiceInfoSellerTin | Seller TIN | STRING(20) | No/YES |
AlbaniaEinvoiceOrderNumber | PO | STRING(10) | No/YES |
DateFrom | Date From | Format(YYYY-MM-DD) | No/YES |
DateTo | Date To | Format(YYYY-MM-DD) | No/YES |
sort | Sort by | String | No |
order | Order | ENUM(ASC,DESC)
Default ASC |
No |
offset | Offset | Integer
Default 0 |
No |
count | Count | Integer(MAX 100)
Default 10 |
No |
JSON response on success
Param | Description | Field type | Required |
nonce | Nonce from request | Integer | YES |
status | Request status | Integer
1 – successful |
YES |
data | Result | result | YES |
Structure of type “result”
Param | Description | Field type | Required |
TotalRecords | Count of total records | Integer | YES |
Data | Array of items | Array of document | YES |
Structure of type “document”
Param | Description | Field type | Required |
AlbaniaEinvoiceInfoID | Document ID internal | Integer | YES |
ID | FIC | ENUM(NORMAL,DELETED)
Default NORMAL |
YES |
DocNumber | Number of document | String id/date | YES |
RecDateTime | date time
2021-10-29T14:16:25+02:00 |
datetime | YES |
DueDateTime | date time
2021-10-29T14:16:25+02:00 |
Integer | YES |
Status | einvoice status | SET(All,DELIVERED, ACCEPTED, REFUSED, PARTIALLY_PAID, PAID) | YES |
Amount | Sub type of document | ENUM(NORMAL,CREDIT,DEBIT) | YES |
PartyType | Document date | STRING(YYYY-MM-DD) | YES |
eik | TAX number
L04820001N |
String | YES |
SELLER |
Name of seller | String | YES |
ContragentID | ContragentID
internal number |
String | YES |
StoreName | Department/store name | String | YES |
DocumentAlbaniaFiscNum | Fiscal number FIC | Integer | YES |
NSLF | NSLF – number | String | YES |
price | Total price | String | YES |
DocumentAlbaniaTaxBase | Tax base amount | String | YES |
DocumentAlbaniaVatAmount | VAT number | String | YES |
CurrencyCode | ISO AL,EURO | String | YES |
ReferenceRateValue | currency rate | Float | YES |
OperationAlbaniaSupplyFromDate | date FROM of supply | String
(YYYY-MM-DD) |
YES |
OperationAlbaniaSupplyToDate | Date TO of supply | date | YES |
UserName | User name | user name | YES |
AlbaniaEinvoiceInfoUpdateDate | Last update date | date | YES |
Orders | Total price in text | String | YES |
OperationImportRefID | Currency | String | YES |
Example:
{ "nonce": "1638351876", "status": 1, "data": { "TotalRecords": 3231, "Data": [ { "AlbaniaEinvoiceInfoID": 2682, "ID": "0013fed5-3f28-4f45-80aa-2996a6e07f78", "DocNumber": "1051/2021/", "RecDateTime": "2021-10-29T14:16:25+02:00", "DueDateTime": "2021-10-29T00:00:00+02:00", "Status": "DELIVERED", "Amount": "8.00", "PartyType": "SELLER", "eik": "L04820001N", "SELLER": null, "ContragentID": null, "StoreName": null, "DocumentAlbaniaFiscNum": "c8ed0e5d-fdda-42e5-aa51-295b68800127", "NSLF": "F4A32B7ABDD37BA5E930920E5F93A32E", "price": "8.23", "DocumentAlbaniaTaxBase": "6.86", "DocumentAlbaniaVatAmount": "1.37", "CurrencyCode": "EUR", "ReferenceRateValue": "123.92", "OperationAlbaniaSupplyFromDate": "", "OperationAlbaniaSupplyToDate": "", "UserName": null, "AlbaniaEinvoiceInfoUpdateDate": "", "Orders": null, "OperationImportRefID": "" }, { "AlbaniaEinvoiceInfoID": 682, "ID": "00182234-2c14-4105-a8db-433efb63ed5c", "DocNumber": "432/2021/", "RecDateTime": "2021-01-04T21:51:57+01:00", "DueDateTime": "2021-01-04T00:00:00+01:00", "Status": "PARTIALLY_PAID", "Amount": "4,900.00", "PartyType": "BUYER", "eik": "", "SELLER": null, "ContragentID": null, "StoreName": null, "DocumentAlbaniaFiscNum": "", "NSLF": "", "price": "0.00", "DocumentAlbaniaTaxBase": "0.00", "DocumentAlbaniaVatAmount": "0.00", "CurrencyCode": "", "ReferenceRateValue": "0.00", "OperationAlbaniaSupplyFromDate": "", "OperationAlbaniaSupplyToDate": "", "UserName": null, "AlbaniaEinvoiceInfoUpdateDate": "", "Orders": null, "OperationImportRefID": "" } ] |
JSON response on unsuccess
Param | Description | Field type | Required |
nonce | Nonce from request | Integer | YES |
status | Request status | Integer
0 – unsuccess request |
YES |
error_message | Error Description | String | YES |
Example:
{ „nonce“: „1552990901“, „status“: 0, „error_message“: „Session expired“ } |