Payments

Add Payment

POSThttps://api.sandbox.younium.com/Payments

Authorization

oauth2

Header parameters

Body

application/json

paymentDatestring (date-time)

currencynullable all of

Allowed as string input: Code, Currency-Id.

Example: "SEK"

amountnumber (double)

bankFeeAmountnumber (double)

exchangeRatenullable number (double)

baseCurrencyAmountnullable number (double)

paymentAccountnullable all of

Allowed as string input: Code, FinancialAccount-Id.

Example: "1510"

BankFeeAccountnullable all of

Allowed as string input: Code, FinancialAccount-Id.

Example: "1510"

paymentMethod*all of

Allowed as string input: Name, PaymentMethod-Id.

Example: "Standard"

paymentWriteOffsnullable array of CreateWriteOffRequest (object)

Payment write offs is not implemented yet

payerNamenullable string

payerInformationnullable string

referencenullable string

descriptionnullable string

externalBankIdnullable string

Response

201400401403

Created

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Payments', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "paymentMethod": "Standard"
    }),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Payments

GEThttps://api.sandbox.younium.com/Payments

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of PaymentResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Payments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "payerName": "text",
      "payerInformation": "text",
      "paymentDate": "2024-12-22T11:42:01.729Z",
      "postedDate": "2024-12-22T11:42:01.729Z",
      "reference": "text",
      "description": "text",
      "amount": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:42:01.729Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "bankFeeAmount": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:42:01.729Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "exchangeRate": 0,
      "paymentAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "BankFeeAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "paymentMethodName": "text",
      "paymentMethodId": "123e4567-e89b-12d3-a456-426614174000",
      "paymentBatchNumber": "text",
      "paymentBatchId": "123e4567-e89b-12d3-a456-426614174000",
      "paymentSettlements": [
        {
          "amount": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:42:01.729Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "invoice": {
            "account": {
              "name": "text",
              "accountNumber": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "externalERPId": "text",
              "externalCRMId": "text"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "invoiceNumber": "text",
            "status": {},
            "invoiceDate": "2024-12-22T11:42:01.729Z",
            "dueDate": "2024-12-22T11:42:01.729Z",
            "buyerReference": "text",
            "ocrNumber": "text",
            "currency": "text",
            "subtotal": 0,
            "tax": 0,
            "totalAmount": 0,
            "settledAmount": 0,
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "writeOffs": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "amount": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:42:01.729Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "postingText": "text",
              "financialAccount": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "code": "text",
                "name": "text",
                "description": "text",
                "externalERPId": "text",
                "externalCRMId": "text"
              }
            }
          ]
        }
      ],
      "paymentWriteOffs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "amount": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:42:01.729Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "postingText": "text",
          "financialAccount": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          }
        }
      ],
      "externalBankId": "text",
      "onlinePaymentIntentId": "text",
      "onlinePaymentChargeId": "text"
    }
  ]
}

Update Payment

Update Payment details and Add, remove or edit payment settlements and write offs.

PATCHhttps://api.sandbox.younium.com/Payments/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

paymentDatenullable string (date-time)

paymentWriteOffsnullable array of UpdatePaymentWriteOffRequest (object)

Payment write offs is not implemented yet

paymentSettlementsnullable array of PaymentSettlementRequest (object)

payerNamenullable string

payerInformationnullable string

referencenullable string

descriptionnullable string

externalBankIdnullable string

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Payments/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Payments by Id

GEThttps://api.sandbox.younium.com/Payments/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

payerNamenullable string

payerInformationnullable string

paymentDatestring (date-time)

postedDatenullable string (date-time)

referencenullable string

descriptionnullable string

amountnullable all of

bankFeeAmountnullable all of

exchangeRatenullable number (double)

paymentAccountnullable all of

BankFeeAccountnullable all of

paymentMethodNamenullable string

paymentMethodIdnullable string (uuid)

paymentBatchNumbernullable string

paymentBatchIdstring (uuid)

paymentSettlementsnullable array of PaymentSettlementResponse (object)

paymentWriteOffsnullable array of WriteOffResponse (object)

Payment write offs is not implemented yet

externalBankIdnullable string

onlinePaymentIntentIdnullable string

onlinePaymentChargeIdnullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Payments/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "payerName": "text",
  "payerInformation": "text",
  "paymentDate": "2024-12-22T11:42:01.729Z",
  "postedDate": "2024-12-22T11:42:01.729Z",
  "reference": "text",
  "description": "text",
  "amount": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:42:01.729Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "bankFeeAmount": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:42:01.729Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "exchangeRate": 0,
  "paymentAccount": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "description": "text",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "BankFeeAccount": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "description": "text",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "paymentMethodName": "text",
  "paymentMethodId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentBatchNumber": "text",
  "paymentBatchId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentSettlements": [
    {
      "amount": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:42:01.729Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "invoice": {
        "account": {
          "name": "text",
          "accountNumber": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "externalERPId": "text",
          "externalCRMId": "text"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "status": {},
        "invoiceDate": "2024-12-22T11:42:01.729Z",
        "dueDate": "2024-12-22T11:42:01.729Z",
        "buyerReference": "text",
        "ocrNumber": "text",
        "currency": "text",
        "subtotal": 0,
        "tax": 0,
        "totalAmount": 0,
        "settledAmount": 0,
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "writeOffs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "amount": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:42:01.729Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "postingText": "text",
          "financialAccount": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          }
        }
      ]
    }
  ],
  "paymentWriteOffs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:42:01.729Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "postingText": "text",
      "financialAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      }
    }
  ],
  "externalBankId": "text",
  "onlinePaymentIntentId": "text",
  "onlinePaymentChargeId": "text"
}

Create and Post Payment

POSThttps://api.sandbox.younium.com/Payments/CreateAndPost

Authorization

oauth2

Header parameters

Body

application/json

invoice*all of

descriptionnullable string

paymentDatestring (date-time)

amountnumber (double)

bankFeeAmountnumber (double)

exchangeRatenullable number (double)

baseCurrencyAmountnullable number (double)

paymentAccountnullable all of

Allowed as string input: Code, FinancialAccount-Id.

Example: "1510"

paymentMethod*all of

Allowed as string input: Name, PaymentMethod-Id.

Example: "Standard"

Response

201400401403

Created

Body

application/json

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Payments/CreateAndPost', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "invoice": {},
      "paymentMethod": "Standard"
    }),
});
const data = await response.json();

Response

201400

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

---