Payments

PreviousOrders NextPaymentterms

Last updated 3 months ago

Was this helpful?

Add Payment

post

/Payments

Authorizations

Header parameters

api-versionstring

Body

paymentDatestring · date-time

amountnumber · double

bankFeeAmountnumber · double

exchangeRatenumber · double | nullable

baseCurrencyAmountnumber · double | nullable

payerNamestring | nullable

payerInformationstring | nullable

referencestring | nullable

descriptionstring | nullable

externalBankIdstring | nullable

paymentWriteOffsobject[] | nullable

Payment write offs is not implemented yet

currencyall of | nullable

Allowed as string input: Code, Currency-Id.

Example: SEK

paymentAccountall of | nullable

Allowed as string input: Code, FinancialAccount-Id.

Example: 1510

BankFeeAccountall of | nullable

Allowed as string input: Code, FinancialAccount-Id.

Example: 1510

paymentMethodall ofrequired

Allowed as string input: Name, PaymentMethod-Id.

Example: Standard

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Payments' \
  --header 'Content-Type: application/json' \
  --data '{"paymentWriteOffs":[{"financialAccount":"1510"}],"currency":"SEK","paymentAccount":"1510","BankFeeAccount":"1510","paymentMethod":"Standard"}'

201

400

401

403

No body

Created

Get Payments

get

/Payments

Authorizations

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

Filter is also applied on sub entities: 'paymentSettlements' and 'writeOffs'

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Payments'

200

400

401

403

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "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": "2025-02-22T08:54:28.421Z",
      "postedDate": "2025-02-22T08:54:28.421Z",
      "reference": "text",
      "description": "text",
      "exchangeRate": 1,
      "paymentMethodName": "text",
      "paymentMethodId": "123e4567-e89b-12d3-a456-426614174000",
      "paymentBatchNumber": "text",
      "paymentBatchId": "123e4567-e89b-12d3-a456-426614174000",
      "externalBankId": "text",
      "onlinePaymentIntentId": "text",
      "onlinePaymentChargeId": "text",
      "paymentSettlements": [
        {
          "writeOffs": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "postingText": "text",
              "amount": {
                "amount": 1,
                "currencyCode": "text",
                "currencyConversionDate": "2025-02-22T08:54:28.421Z",
                "baseCurrencyAmount": 1,
                "baseCurrencyCode": "text"
              },
              "financialAccount": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "code": "text",
                "name": "text",
                "description": "text",
                "externalERPId": "text",
                "externalCRMId": "text"
              }
            }
          ],
          "amount": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:54:28.421Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "invoice": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "invoiceNumber": "text",
            "invoiceDate": "2025-02-22T08:54:28.421Z",
            "dueDate": "2025-02-22T08:54:28.421Z",
            "buyerReference": "text",
            "ocrNumber": "text",
            "currency": "text",
            "subtotal": 1,
            "tax": 1,
            "totalAmount": 1,
            "settledAmount": 1,
            "externalERPId": "text",
            "externalCRMId": "text",
            "account": {
              "name": "text",
              "accountNumber": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "externalERPId": "text",
              "externalCRMId": "text"
            },
            "status": "Draft"
          }
        }
      ],
      "paymentWriteOffs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "postingText": "text",
          "amount": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:54:28.421Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "financialAccount": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          }
        }
      ],
      "amount": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:54:28.421Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "bankFeeAmount": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:54:28.421Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "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"
      }
    }
  ]
}

Success

Update Payment

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

patch

/Payments/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

paymentDatestring · date-time | nullable

payerNamestring | nullable

payerInformationstring | nullable

referencestring | nullable

descriptionstring | nullable

externalBankIdstring | nullable

paymentWriteOffsobject[] | nullable

Payment write offs is not implemented yet

paymentSettlementsobject[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Payments/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"paymentWriteOffs":[{"operation":"Change","writeOff":"GUID","financialAccount":"1510"}],"paymentSettlements":[{"writeOffs":[{"operation":"Change","writeOff":"GUID","financialAccount":"1510"}],"operation":"Change","invoice":"IP-000001"}]}'

200

400

401

403

No body

Success

Get Payments by Id

get

/Payments/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Payments/{id}'

200

400

401

403

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "payerName": "text",
  "payerInformation": "text",
  "paymentDate": "2025-02-22T08:54:28.421Z",
  "postedDate": "2025-02-22T08:54:28.421Z",
  "reference": "text",
  "description": "text",
  "exchangeRate": 1,
  "paymentMethodName": "text",
  "paymentMethodId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentBatchNumber": "text",
  "paymentBatchId": "123e4567-e89b-12d3-a456-426614174000",
  "externalBankId": "text",
  "onlinePaymentIntentId": "text",
  "onlinePaymentChargeId": "text",
  "paymentSettlements": [
    {
      "writeOffs": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "postingText": "text",
          "amount": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:54:28.421Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "financialAccount": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          }
        }
      ],
      "amount": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:54:28.421Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "invoice": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "invoiceDate": "2025-02-22T08:54:28.421Z",
        "dueDate": "2025-02-22T08:54:28.421Z",
        "buyerReference": "text",
        "ocrNumber": "text",
        "currency": "text",
        "subtotal": 1,
        "tax": 1,
        "totalAmount": 1,
        "settledAmount": 1,
        "externalERPId": "text",
        "externalCRMId": "text",
        "account": {
          "name": "text",
          "accountNumber": "text",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "externalERPId": "text",
          "externalCRMId": "text"
        },
        "status": "Draft"
      }
    }
  ],
  "paymentWriteOffs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "postingText": "text",
      "amount": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:54:28.421Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "financialAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      }
    }
  ],
  "amount": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:54:28.421Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "bankFeeAmount": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:54:28.421Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "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"
  }
}

Success

Create and Post Payment

post

/Payments/CreateAndPost

Authorizations

Header parameters

api-versionstring

Body

descriptionstring | nullable

paymentDatestring · date-time

amountnumber · double

bankFeeAmountnumber · double

exchangeRatenumber · double | nullable

baseCurrencyAmountnumber · double | nullable

invoiceall ofrequired

paymentAccountall of | nullable

Allowed as string input: Code, FinancialAccount-Id.

Example: 1510

paymentMethodall ofrequired

Allowed as string input: Name, PaymentMethod-Id.

Example: Standard

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Payments/CreateAndPost' \
  --header 'Content-Type: application/json' \
  --data '{"invoice":{},"paymentAccount":"1510","paymentMethod":"Standard"}'

201

400

401

403

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

Created