Skip to main content
POST
/
v3
/
invoice
/
{invoiceId}
/
payment
Post payment to given invoice
curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transaction/v3/invoice/{invoiceId}/payment' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": "EUR",
  "text": "<string>",
  "additionalInfo": {
    "ref": "<string>",
    "message": "<string>",
    "paymentReceiver": "<string>",
    "transferId": "<string>",
    "text": "<string>",
    "discLinkTransactionId": "<string>",
    "discLinkPurchaseDetailId": "<string>",
    "paymentReference": "<string>",
    "payerName": "<string>",
    "fromAddress": "<string>",
    "fromZip": "<string>",
    "fromCity": "<string>",
    "fromBankAccountNumber": "<string>",
    "fromCustomerAccountNumber": "<string>",
    "fromOrganizationalNumber": "<string>",
    "fromBankName": "<string>",
    "toBic": "<string>",
    "toBankAccountNumber": "<string>",
    "fileName": "<string>",
    "receivedFromCollectionAgency": true,
    "vatRate": "<string>",
    "vatAmount": "<string>",
    "billNumber": "<string>"
  },
  "transactionDetails": "<string>",
  "date": "2023-12-25",
  "postingDate": "2023-12-25",
  "transactionDate": "2023-12-25"
}
'
{
  "description": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
invoiceId
string<biginteger>
required

Invoice id to allocate the payment to

Query Parameters

​
auditUser
string
required

The audit user to log the request

Body

application/json

The fields that you want to apply to your newly created invoice payment transaction, these values will override the predefined template values. Note: Transaction type is derived by the backend and must not be provided.

​
amount
number
required

Transaction amount. It is possible to post only amount which is equal or more than minimal currency unit (For example, for EUR, SEK, NOK minimal unit is 0,01)

​
currency
string
required

A valid ISO 4217 currency code

Pattern: [A-Z]{3}
Example:

"EUR"

​
text
string

Free input text

Maximum string length: 255
​
additionalInfo
additionalInfo · object
​
transactionDetails
string

Merchant name

Maximum string length: 255
​
date
string<date>

The date when transaction was posted at Enfuce in ISO-8601 date format (YYYY-MM-DD). Only one of date or postingDate can be used at a time. This field will always post a transaction even if this date is not valid.

​
postingDate
string<date>

The date when transaction was posted at Enfuce in ISO-8601 date format (YYYY-MM-DD). Only one of date or postingDate can be used at a time. When using this field an exception will be thrown if posting date is not valid. For a postingDate to be valid, it must be no later than the due date of the account's contract.

​
transactionDate
string<date>

The local date when the transaction was made in ISO-8601 date format (YYYY-MM-DD).

Response

Successful creation of payment transaction allocated to invoice

​
description
string

Short description of the result of the action

​
id
string

Will contain the ID of the resource that has been created or updated