Get invoice for given reference number

GET

referenceNumber

{referenceNumber}

curl --request GET \
  --globoff \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "currency": "EUR",
  "amount": 123,
  "createdDate": "2019-11-27T05:08:31",
  "dueDate": "2019-11-27",
  "id": "<string>",
  "paidAmount": 123,
  "paymentReference": {
    "type": "MOD10",
    "number": 1234567897
  },
  "period": {
    "start": "2020-01-01",
    "end": "2020-01-31"
  },
  "status": "OPEN",
  "dunning": {
    "dunningStatus": "WAIT",
    "reminder1TriggerDate": "2019-11-27",
    "blockTriggerDate": "2019-11-27",
    "reminder2TriggerDate": "2019-11-27",
    "collectionTriggerDate": "2019-11-27"
  },
  "invoiceNumber": "<string>",
  "accountId": "<string>",
  "amountBreakdown": {
    "capitalAmount": 123,
    "interestAmount": 123,
    "feeAmount": 123
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

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

referenceNumber

string

required

Invoice reference number for given invoice

Query Parameters

auditUser

string

required

The audit user to log the request

Response

Successful lookup of invoice for given reference number

currency

string

A valid ISO 4217 currency code

Pattern: [A-Z]{3}

Example:

"EUR"

amount

number

Total amount of this invoice

createdDate

string<date-time>

Date when invoice was created

Example:

"2019-11-27T05:08:31"

dueDate

string<date>

Date when invoice is due

Example:

"2019-11-27"

string

Unique id for invoice

paidAmount

number

Total amount that is paid of this invoice

paymentReference

object

Number connected to account that will be used to map incoming payments to

Show child attributes

period

object

Show child attributes

status

enum<string>

OPEN Open
OVERDUE Overdue
PAID Paid
PAID_PARTIALLY Partially Paid
WRITE-OFF Written Off

Available options:

OPEN,

OVERDUE,

PAID,

PAID_PARTIALLY,

WRITE-OFF

dunning

dunning · object

Dunning details, this should only be populated if invoice status is overdue

Show child attributes

invoiceNumber

string

Number of the invoice

accountId

string

Account id this invoice belongs to

amountBreakdown

amountBreakdown · object | null

Breakdown of the invoice amount into capital, interest and fees, as reported by the billing document engine. All amounts are gross. Null when the breakdown could not be resolved (e.g. the upstream service did not respond or returned an incomplete breakdown).

Show child attributes

⌘I

Get invoice for given reference number

curl --request GET \
  --globoff \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/invoice/v1/referenceNumber/{referenceNumber}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "currency": "EUR",
  "amount": 123,
  "createdDate": "2019-11-27T05:08:31",
  "dueDate": "2019-11-27",
  "id": "<string>",
  "paidAmount": 123,
  "paymentReference": {
    "type": "MOD10",
    "number": 1234567897
  },
  "period": {
    "start": "2020-01-01",
    "end": "2020-01-31"
  },
  "status": "OPEN",
  "dunning": {
    "dunningStatus": "WAIT",
    "reminder1TriggerDate": "2019-11-27",
    "blockTriggerDate": "2019-11-27",
    "reminder2TriggerDate": "2019-11-27",
    "collectionTriggerDate": "2019-11-27"
  },
  "invoiceNumber": "<string>",
  "accountId": "<string>",
  "amountBreakdown": {
    "capitalAmount": 123,
    "interestAmount": 123,
    "feeAmount": 123
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Introduction

Account Details

Authorisation Control

Authorisation Forwarding

Card details

Customer

Exchange Rates API

ID

Instalment

Invoice

Notification

PIN

PIN Control

Purchase Details

Repricing

Transaction

Transfer API

Wallet

Test API

Hierarchy API

Spend Control API

Fraud Case API

Get invoice for given reference number

Authorizations

Path Parameters

Query Parameters

Response