Scope: accounting:remittances.read https://api.alladdin.com/api/v2/treasury/remittances/{remittanceId}

Retrieves the full details of a remittance by its unique identifier. A remittance groups multiple invoices or purchases into a single SEPA direct debit or credit transfer for batch processing.
The response includes the list of documents bundled in the remittance, each with its contact, amount, and payment status.

Parameters

Path parameters

remittanceId string required

Remittance ID

Request

import requests

url = "https://api.alladdin.com/api/v2/treasury/remittances/{remittanceId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

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

Responses

Response

{
  "id": "string",
  "type": "inbound",
  "treasury_id": "string",
  "description": "string",
  "date": "2024-01-15",
  "mode": "core",
  "iban": "string",
  "swift": "string",
  "creditor_id": "string",
  "issuer_id": "string",
  "total": "1234.56",
  "status": "pending",
  "documents": [
    {
      "id": "string",
      "type": "invoice",
      "contact_id": "string",
      "contact_name": "string",
      "number": "string",
      "description": "string",
      "pending": "500.00",
      "total": "1000.00",
      "date": "2024-01-15",
      "due_date": "2024-01-15"
    }
  ]
}

Success responses

200 Remittance found application/json object id string

Unique identifier of the remittance

type string

Direction of the remittance

Enum: inbound outbound treasury_id string

Identifier of the treasury account used

description string | null

Free-text description of the remittance

date string<date> | null

Remittance date in ISO 8601 format

mode string | null

SEPA direct debit scheme used for the remittance

Enum: core cor1 b2b coredto `` iban string

IBAN of the creditor bank account

swift string | null

SWIFT/BIC code of the creditor bank

creditor_id string | null

SEPA creditor identifier

issuer_id string | null

Issuer identifier for the remittance

total string

Total amount of the remittance as a decimal string

status string

Current processing status of the remittance

Enum: pending completed processing documents[] object[]

List of documents included in this remittance

id string

Unique identifier of the document included in the remittance

type string

Type of the document

Enum: invoice purchase payroll expemployee creditnote purchaserefund salesreceipt receiptnote contact_id string

Identifier of the contact associated with the document

contact_name string

Name of the contact

number string

Document number

description string

Description of the document

pending string

Pending amount as a decimal string

total string

Total amount as a decimal string

date string<date> | null

Document issue date in ISO 8601 format

due_date string<date> | null

Document due date in ISO 8601 format

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Remittance not found application/json 429 Rate limit exceeded application/json

← PreviousList remittances →