POST api/Receipt

Upload Receipts

Request Information

URI Parameters

None.

Body Parameters

Receipt
NameDescriptionTypeAdditional information
Company

The company name

string

Required

String length: inclusive between 0 and 6

ReceiptNumber

The receipt number / code

string

Required

String length: inclusive between 0 and 15

Store

The receipt store code

string

Required

String length: inclusive between 0 and 15

AccountCode

The account code

string

Required

String length: inclusive between 0 and 15

AccountName

The account name

string

String length: inclusive between 0 and 50

ReceiptDate

The receipt date

date

Required

Collector

The code of the collector

string

Required

String length: inclusive between 0 and 5

Currency

The receipt currency code

string

Required

String length: inclusive between 0 and 3

CurrencyRate

The currency rate

decimal number

None.

Amount

The receipt amount

decimal number

None.

Discount

The receipt discount

decimal number

None.

Details

Details about the receipt

string

String length: inclusive between 0 and 100

Remarks

More information about the receipt

string

String length: inclusive between 0 and 200

PaymentMethod

Payment method codes. CQ: Cheque, CH: Cash, CC: Credit Card, AD: Advice

string

None.

ChequeBank

The bank of the cheque

string

String length: inclusive between 0 and 50

ChequeBranch

The cheque branch

string

String length: inclusive between 0 and 15

ChequeNo

The cheque number

string

String length: inclusive between 0 and 15

ChequeDate

The cheque published date

date

None.

Reference

Reference

string

String length: inclusive between 0 and 20

Text1

Text field for additional info

string

String length: inclusive between 0 and 50

Text2

Text field for additional info

string

String length: inclusive between 0 and 50

Text3

Text field for additional info

string

String length: inclusive between 0 and 50

Text4

Text field for additional info

string

String length: inclusive between 0 and 50

Text5

Text field for additional info

string

String length: inclusive between 0 and 50

H1

Header Analysis 1 code

string

String length: inclusive between 0 and 30

H2

Header Analysis 2 code

string

String length: inclusive between 0 and 30

H3

Header Analysis 3 code

string

String length: inclusive between 0 and 30

H4

Header Analysis 4 code

string

String length: inclusive between 0 and 30

H5

Header Analysis 5 code

string

String length: inclusive between 0 and 30

DebitAccount

The debit account code

string

String length: inclusive between 0 and 15

Request Formats

application/json, text/json

Sample:
{
  "Company": "DEMO",
  "ReceiptNumber": "1236547895",
  "Store": "001",
  "AccountCode": "320020",
  "AccountName": "",
  "ReceiptDate": "2019-12-25T00:00:00",
  "Collector": "001",
  "Currency": "EUR",
  "CurrencyRate": 1.0,
  "Amount": 100.0,
  "Discount": 10.0,
  "Details": "",
  "Remarks": "",
  "PaymentMethod": "CH",
  "ChequeBank": null,
  "ChequeBranch": null,
  "ChequeNo": null,
  "ChequeDate": null,
  "Reference": "",
  "Text1": "",
  "Text2": "",
  "Text3": "",
  "Text4": "",
  "Text5": "",
  "H1": "Header analysis 1 code",
  "H2": "",
  "H3": "",
  "H4": "",
  "H5": "",
  "DebitAccount": ""
}

Response Information

Resource Description

MsgControl
NameDescriptionTypeAdditional information
result

Response flag: 1 = success else something went wrong: see Message

integer

Required

Message

Corresponding success and error message

string

Required

MethodName

The name of the API

string

None.

AppName

The name of the current API method

string

None.

EsoftUser

The username of the logged in Esoft user. Can be empty

string

None.

User

Username

string

None.

Password

Password

string

None.

SystemDate

Current date

date

None.

GenList

List of additional message for calls with multiple object

Collection of Collection of string

None.

GenMsg1

Additional message

string

None.

GenMsg2

Additional message

string

None.

GenMsg3

Additional message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "result": 0,
  "Message": "Corresponding success and error message",
  "MethodName": "api/<Method>",
  "AppName": "EsoftWebApi",
  "EsoftUser": "ESOFT",
  "User": "Username",
  "Password": "Password",
  "SystemDate": "2025-01-06T22:32:15.1720865+02:00",
  "GenList": [],
  "GenMsg1": "",
  "GenMsg2": "",
  "GenMsg3": ""
}