Invoices | Younium Developer Portal

Younium Developer Portal

Get Invoices

get

/Invoices

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: 'invoiceLines' and 'customFields' on these entities

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/Invoices'

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",
      "invoiceNumber": "text",
      "notes": "text",
      "invoiceDate": "2025-02-22T08:36:33.788Z",
      "dueDate": "2025-02-22T08:36:33.788Z",
      "paymentDate": "2025-02-22T08:36:33.788Z",
      "lastPaymentDate": "2025-02-22T08:36:33.788Z",
      "daysPastDue": 1,
      "nrOfReminders": 1,
      "currency": "text",
      "subtotal": 1,
      "tax": 1,
      "totalAmount": 1,
      "totalRoundingAmount": 1,
      "settledAmount": 1,
      "balancedAmount": 1,
      "taxIncluded": true,
      "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
      "yourReference": "text",
      "ourReference": "text",
      "yourOrderNumber": "text",
      "buyerReference": "text",
      "ocrNumber": "text",
      "sendMethod": "text",
      "exchangeRate": 1,
      "settledNotes": "text",
      "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "disableAutomaticInvoiceReminder": true,
      "onlinePaymentLink": "text",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-02-22T08:36:33.788Z",
      "modified": "2025-02-22T08:36:33.788Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "invoiceLines": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "invoiceLineNumber": 1,
          "productNumber": "text",
          "productName": "text",
          "chargeDescription": "text",
          "chargeNumber": "text",
          "quantity": 1,
          "price": 1,
          "subtotal": 1,
          "total": 1,
          "tax": 1,
          "subtotalPreDiscount": 1,
          "totalPreDiscount": 1,
          "taxPreDiscount": 1,
          "servicePeriodStartDate": "2025-02-22T08:36:33.788Z",
          "servicePeriodEndDate": "2025-02-22T08:36:33.788Z",
          "notes": "text",
          "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
          "orderId": "123e4567-e89b-12d3-a456-426614174000",
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
          "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2025-02-22T08:36:33.788Z",
          "modified": "2025-02-22T08:36:33.788Z",
          "taxCategoryName": "text",
          "taxRate": 1,
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "charge": {
            "name": "text",
            "chargeNumber": "OPC-000001",
            "description": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "unitOfMeasure": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "unitCode": "text",
            "name": "text",
            "displayName": "text"
          },
          "accountsReceivable": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "deferredRevenue": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "recognizedRevenue": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "code": "text",
            "name": "text",
            "description": "text",
            "externalERPId": "text",
            "externalCRMId": "text"
          }
        }
      ],
      "latestOnlinePaymentLogs": [
        {
          "failedPayment": true,
          "paymentDescription": "text",
          "timeStamp": "2025-02-22T08:36:33.788Z",
          "payoutId": "text",
          "isPayout": true,
          "paymentIntentId": "text"
        }
      ],
      "status": "Draft",
      "account": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "paymentTerm": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "days": 1,
        "name": "text"
      },
      "invoiceAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "deliveryAddress": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "name": "text",
        "street": "text",
        "street2": "text",
        "city": "text",
        "county": "text",
        "state": "text",
        "zip": "text",
        "country": "text"
      },
      "onlinePaymentStatus": "None",
      "invoiceType": "Invoice",
      "invoiceDeliveryMethod": "Email",
      "accountsReceivable": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      }
    }
  ]
}

Success

Get an Invoice by id

Requires permission Invoice Read.

get

/Invoices/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceNumber": "text",
  "notes": "text",
  "invoiceDate": "2025-02-22T08:36:33.788Z",
  "dueDate": "2025-02-22T08:36:33.788Z",
  "paymentDate": "2025-02-22T08:36:33.788Z",
  "lastPaymentDate": "2025-02-22T08:36:33.788Z",
  "daysPastDue": 1,
  "nrOfReminders": 1,
  "currency": "text",
  "subtotal": 1,
  "tax": 1,
  "totalAmount": 1,
  "totalRoundingAmount": 1,
  "settledAmount": 1,
  "balancedAmount": 1,
  "taxIncluded": true,
  "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "ocrNumber": "text",
  "sendMethod": "text",
  "exchangeRate": 1,
  "settledNotes": "text",
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "disableAutomaticInvoiceReminder": true,
  "onlinePaymentLink": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-02-22T08:36:33.788Z",
  "modified": "2025-02-22T08:36:33.788Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invoiceLines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceLineNumber": 1,
      "productNumber": "text",
      "productName": "text",
      "chargeDescription": "text",
      "chargeNumber": "text",
      "quantity": 1,
      "price": 1,
      "subtotal": 1,
      "total": 1,
      "tax": 1,
      "subtotalPreDiscount": 1,
      "totalPreDiscount": 1,
      "taxPreDiscount": 1,
      "servicePeriodStartDate": "2025-02-22T08:36:33.788Z",
      "servicePeriodEndDate": "2025-02-22T08:36:33.788Z",
      "notes": "text",
      "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-02-22T08:36:33.788Z",
      "modified": "2025-02-22T08:36:33.788Z",
      "taxCategoryName": "text",
      "taxRate": 1,
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "charge": {
        "name": "text",
        "chargeNumber": "OPC-000001",
        "description": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "unitOfMeasure": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "unitCode": "text",
        "name": "text",
        "displayName": "text"
      },
      "accountsReceivable": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "deferredRevenue": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "recognizedRevenue": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      }
    }
  ],
  "latestOnlinePaymentLogs": [
    {
      "failedPayment": true,
      "paymentDescription": "text",
      "timeStamp": "2025-02-22T08:36:33.788Z",
      "payoutId": "text",
      "isPayout": true,
      "paymentIntentId": "text"
    }
  ],
  "status": "Draft",
  "account": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "paymentTerm": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "days": 1,
    "name": "text"
  },
  "invoiceAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "deliveryAddress": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "name": "text",
    "street": "text",
    "street2": "text",
    "city": "text",
    "county": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "onlinePaymentStatus": "None",
  "invoiceType": "Invoice",
  "invoiceDeliveryMethod": "Email",
  "accountsReceivable": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "description": "text",
    "externalERPId": "text",
    "externalCRMId": "text"
  }
}

Success

Edit Invoice

patch

/Invoices/{id}

Authorizations

Path parameters

idstring · uuidrequired

Invoice Id

Header parameters

api-versionstring

Body

dueDatestring · date-time

disableAutomaticInvoiceReminderboolean

notesstring | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

yourOrderNumberstring | nullable

referenceNumberstring | nullable

customFieldsobject | nullable

invoiceDeliveryMethodall of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Invoices/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"invoiceDeliveryMethod":"Email"}'

200

400

401

403

No body

Success

Get Posted Invoice PDF Attachment

Get the invoice attachment generated based on the document template when the invoice where posted.
File in pdf format.
Requires permission Invoice View.

get

/Invoices/invoiceDownloadAttachment/{invoiceId}

Authorizations

Path parameters

invoiceIdstring · uuidrequired

Invoice Id

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Invoices/invoiceDownloadAttachment/{invoiceId}'

200

400

401

403

404

No body

Success

Get Posted Invoice PDF Attachment URL

Get a generated URL to posted invoice pdf attachment of specified Invoice. The generated URL is valid for up to 24 hours.

get

/Invoices/generateAttachmentURL/{invoiceId}

Authorizations

Path parameters

invoiceIdstring · uuidrequired

Invoice Id

Query parameters

ExpirationTimeSpanHoursstring

parameter to set expiration time span in hours for shared access signature of the URL (SAS). Value must be convertible to an integer and cannot be negative. value 'max' is allowed for the longest possible expiration time. Default value is 24 hours.

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Invoices/generateAttachmentURL/{invoiceId}'

200

400

401

403

https://example.com

Success

Get Invoice Attachments

Get a list of invoice attachments with urls by invoice Id. The generated URLs are valid for up to 24 hours. Requires permission Invoice View.

get

/Invoices/{id}/Attachments

Authorizations

Path parameters

idstring · uuidrequired

Invoice id

Query parameters

ExpirationTimeSpanHoursstring

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

Apply a separate filter to only get records that has been modified Before the specified date time.

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/Invoices/{id}/Attachments'

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": {
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "attachmentDetail": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "contentType": "text",
    "created": "2025-02-22T08:36:33.788Z",
    "modified": "2025-02-22T08:36:33.788Z",
    "fileURL": "https://example.com",
    "fileURLErrorMessage": "text"
  }
}

Success

Get Posted Invoice Document attachments

Get a list of invoice attachments with urls by invoice Id. The generated URLs are valid for up to 24 hours. Requires permission Invoice View.

get

/Invoices/PostedInvoiceDocumentAttachments

Authorizations

Query parameters

ExpirationTimeSpanHoursstring

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

Apply a separate filter to only get records that has been modified Before the specified date time.

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/Invoices/PostedInvoiceDocumentAttachments'

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": {
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "attachmentDetail": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "contentType": "text",
    "created": "2025-02-22T08:36:33.788Z",
    "modified": "2025-02-22T08:36:33.788Z",
    "fileURL": "https://example.com",
    "fileURLErrorMessage": "text"
  }
}

Success

Get Invoice Attachment File by Attachment Id

get attachment file by attachment Id. Requires permission Invoice View.

get

/Invoices/DownloadAttachment/{id}

Authorizations

Path parameters

idstring · uuidrequired

Attachment id

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

No body

Success

Marks Invoice as paid

Marks a posted Invoice as "paid in other system".

post

/Invoices/paid

Authorizations

Header parameters

api-versionstring

Body

invoiceIdstring · uuidrequired

paymentDatestring · date-time | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Invoices/paid' \
  --header 'Content-Type: application/json' \
  --data '{"invoiceId":"123e4567-e89b-12d3-a456-426614174000"}'

200

400

401

403

No body

Success

Generate invoice on Account.

post

/Invoices/onAccountInvoice

Authorizations

Header parameters

api-versionstring

Body

invoiceDatestring · date-time

yourOrderNumberstring | nullable

yourReferencestring | nullable

ourReferencestring | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

customFieldsobject | nullable

invoiceLinesobject[] | nullable

accountall of | nullable

Allowed as string input: AccountNumber, Account-Id, Name.

Example: A-000001

invoiceActionall of

Specify if the invoice should be posted and how to handle draft in case of failure. By default an invoice draft is created first in any case.

accountsReceivableall of | nullable

Allowed as string input: Code, FinancialAccount-Id.

Example: 1510

paymentTermall of | nullable

Allowed as string input: Name, PaymentTerm-Id.

Example: NET30

invoiceTemplateall of | nullable

Allowed as string input: Description, DocumentTemplate_Invoice-Id.

Example: InvoiceTemplate

currencyall ofrequired

Allowed as string input: Code, Currency-Id.

Example: SEK

invoiceDeliveryMethodall of | nullable

invoiceAddressall of | nullable

deliveryAddressall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Invoices/onAccountInvoice' \
  --header 'Content-Type: application/json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"invoiceLines":[{"productName":"text","price":1,"quantity":1,"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"unitOfMeasure":"pcs","recognizedRevenueAccount":"1510","taxTemplate":"Sweden standard"}],"account":"A-000001","invoiceAction":"CreateDraft","accountsReceivable":"1510","paymentTerm":"NET30","invoiceTemplate":"InvoiceTemplate","currency":"SEK","invoiceDeliveryMethod":"Email","invoiceAddress":{"country":"Sweden"},"deliveryAddress":{"country":"Sweden"}}'

201

400

401

403

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

Created

Cancel Invoice

post

/Invoices/{id}/cancel

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Invoices/{id}/cancel'

200

400

401

403

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

Success

Generate Credit Invoice

post

/Invoices/{id}/credit

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

creditInvoiceDatestring · date-time | nullable

creditAllInvoiceLinesboolean

invoiceLineIdsstring · uuid[] | nullable

invoiceActionall of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Invoices/{id}/credit' \
  --header 'Content-Type: application/json' \
  --data '{"invoiceLineIds":[null],"invoiceAction":"CreateDraft"}'

200

400

401

403

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

Success

Post Invoice

post

/Invoices/{id}/post

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Invoices/{id}/post'

201

400

401

403

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

Created

Generate Invoice from Order

post

/Invoices/orders/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

invoiceDatestring · date-time | nullable

targetDatestring · date-time | nullable

customizedTargetDatesall of | nullable

invoiceActionall of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Invoices/orders/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"customizedTargetDates":{},"invoiceAction":"CreateDraft"}'

200

400

401

403

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

Success

Process Stripe Payment for Invoice.

Invoices with online payment status 'Succeeded' and 'Processing' will not be reprocessed

post

/Invoices/{id}/ProcessStripePayment

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Invoices/{id}/ProcessStripePayment'

200

400

401

403

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

Success

Invoices Online Payment Logs

get

/Invoices/{id}/OnlinePaymentLogs

Authorizations

Path parameters

idstring · uuidrequired

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

Apply a separate filter to only get records that has been modified Before the specified date time.

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/Invoices/{id}/OnlinePaymentLogs'

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": [
    {
      "failedPayment": true,
      "paymentDescription": "text",
      "timeStamp": "2025-02-22T08:36:33.788Z",
      "payoutId": "text",
      "isPayout": true,
      "paymentIntentId": "text"
    }
  ]
}

Success