Invoices

Get Invoices

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

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 InvoiceResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Invoices', {
    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",
      "invoiceNumber": "text",
      "status": {},
      "account": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "notes": "text",
      "invoiceDate": "2024-12-22T11:14:51.793Z",
      "dueDate": "2024-12-22T11:14:51.793Z",
      "paymentDate": "2024-12-22T11:14:51.793Z",
      "lastPaymentDate": "2024-12-22T11:14:51.793Z",
      "daysPastDue": 0,
      "nrOfReminders": 0,
      "paymentTerm": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "days": 0,
        "name": "text"
      },
      "currency": "text",
      "subtotal": 0,
      "tax": 0,
      "totalAmount": 0,
      "totalRoundingAmount": 0,
      "settledAmount": 0,
      "balancedAmount": 0,
      "taxIncluded": false,
      "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"
      },
      "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceLines": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "invoiceLineNumber": 0,
          "productNumber": "text",
          "productName": "text",
          "chargeDescription": "text",
          "chargeNumber": "text",
          "charge": {
            "name": "text",
            "chargeNumber": "OPC-000001",
            "description": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "quantity": 0,
          "unitOfMeasure": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "unitCode": "text",
            "name": "text",
            "displayName": "text"
          },
          "price": 0,
          "subtotal": 0,
          "total": 0,
          "tax": 0,
          "subtotalPreDiscount": 0,
          "totalPreDiscount": 0,
          "taxPreDiscount": 0,
          "servicePeriodStartDate": "2024-12-22T11:14:51.793Z",
          "servicePeriodEndDate": "2024-12-22T11:14:51.793Z",
          "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",
          "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"
          },
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2024-12-22T11:14:51.793Z",
          "modified": "2024-12-22T11:14:51.793Z",
          "taxCategoryName": "text",
          "taxRate": 0
        }
      ],
      "latestOnlinePaymentLogs": [
        {
          "failedPayment": false,
          "paymentDescription": "text",
          "timeStamp": "2024-12-22T11:14:51.793Z",
          "payoutId": "text",
          "isPayout": false,
          "paymentIntentId": "text"
        }
      ],
      "onlinePaymentStatus": {},
      "yourReference": "text",
      "ourReference": "text",
      "yourOrderNumber": "text",
      "buyerReference": "text",
      "invoiceType": {},
      "ocrNumber": "text",
      "sendMethod": "text",
      "exchangeRate": 0,
      "settledNotes": "text",
      "invoiceDeliveryMethod": {},
      "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "disableAutomaticInvoiceReminder": false,
      "onlinePaymentLink": "text",
      "accountsReceivable": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:14:51.793Z",
      "modified": "2024-12-22T11:14:51.793Z"
    }
  ]
}

Get an Invoice by id

Requires permission Invoice Read.

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

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

invoiceNumbernullable string

statusall of

accountnullable all of

notesnullable string

invoiceDatestring (date-time)

dueDatestring (date-time)

paymentDatenullable string (date-time)

lastPaymentDatenullable string (date-time)

daysPastDuenullable integer (int32)

nrOfRemindersinteger (int32)

paymentTermnullable all of

currencynullable string

subtotalnumber (double)

taxnumber (double)

totalAmountnumber (double)

totalRoundingAmountnumber (double)

settledAmountnumber (double)

balancedAmountnumber (double)

taxIncludedboolean

invoiceAddressnullable all of

deliveryAddressnullable all of

invoiceBatchIdstring (uuid)

invoiceLinesnullable array of InvoiceLineResponse (object)

latestOnlinePaymentLogsnullable array of OnlinePaymentLogResponse (object)

Includes the three latest online payment logs for the Invoice

onlinePaymentStatusall of

yourReferencenullable string

ourReferencenullable string

yourOrderNumbernullable string

buyerReferencenullable string

invoiceTypeall of

ocrNumbernullable string

sendMethodnullable string

exchangeRatenullable number (double)

settledNotesnullable string

invoiceDeliveryMethodall of

invoiceTemplateIdnullable string (uuid)

disableAutomaticInvoiceReminderboolean

onlinePaymentLinknullable string

accountsReceivablenullable all of

customFieldsnullable object

externalERPIdnullable string

externalCRMIdnullable string

createdstring (date-time)

modifiedstring (date-time)

Request

JavaScriptCurlPython

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

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceNumber": "text",
  "status": {},
  "account": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "notes": "text",
  "invoiceDate": "2024-12-22T11:14:51.793Z",
  "dueDate": "2024-12-22T11:14:51.793Z",
  "paymentDate": "2024-12-22T11:14:51.793Z",
  "lastPaymentDate": "2024-12-22T11:14:51.793Z",
  "daysPastDue": 0,
  "nrOfReminders": 0,
  "paymentTerm": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "days": 0,
    "name": "text"
  },
  "currency": "text",
  "subtotal": 0,
  "tax": 0,
  "totalAmount": 0,
  "totalRoundingAmount": 0,
  "settledAmount": 0,
  "balancedAmount": 0,
  "taxIncluded": false,
  "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"
  },
  "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
  "invoiceLines": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceLineNumber": 0,
      "productNumber": "text",
      "productName": "text",
      "chargeDescription": "text",
      "chargeNumber": "text",
      "charge": {
        "name": "text",
        "chargeNumber": "OPC-000001",
        "description": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "quantity": 0,
      "unitOfMeasure": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "unitCode": "text",
        "name": "text",
        "displayName": "text"
      },
      "price": 0,
      "subtotal": 0,
      "total": 0,
      "tax": 0,
      "subtotalPreDiscount": 0,
      "totalPreDiscount": 0,
      "taxPreDiscount": 0,
      "servicePeriodStartDate": "2024-12-22T11:14:51.793Z",
      "servicePeriodEndDate": "2024-12-22T11:14:51.793Z",
      "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",
      "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"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:14:51.793Z",
      "modified": "2024-12-22T11:14:51.793Z",
      "taxCategoryName": "text",
      "taxRate": 0
    }
  ],
  "latestOnlinePaymentLogs": [
    {
      "failedPayment": false,
      "paymentDescription": "text",
      "timeStamp": "2024-12-22T11:14:51.793Z",
      "payoutId": "text",
      "isPayout": false,
      "paymentIntentId": "text"
    }
  ],
  "onlinePaymentStatus": {},
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "invoiceType": {},
  "ocrNumber": "text",
  "sendMethod": "text",
  "exchangeRate": 0,
  "settledNotes": "text",
  "invoiceDeliveryMethod": {},
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "disableAutomaticInvoiceReminder": false,
  "onlinePaymentLink": "text",
  "accountsReceivable": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "description": "text",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2024-12-22T11:14:51.793Z",
  "modified": "2024-12-22T11:14:51.793Z"
}

Edit Invoice

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

Authorization

oauth2

Path parameters

id*string (uuid)

Invoice Id

Header parameters

Body

application/merge-patch+json

dueDatestring (date-time)

invoiceDeliveryMethodall of

disableAutomaticInvoiceReminderboolean

notesnullable string

externalERPIdnullable string

externalCRMIdnullable string

yourOrderNumbernullable string

referenceNumbernullable string

customFieldsnullable object

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Invoices/{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 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.

GEThttps://api.sandbox.younium.com/Invoices/invoiceDownloadAttachment/{invoiceId}

Authorization

oauth2

Path parameters

invoiceId*string (uuid)

Invoice Id

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

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

Response

400404

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

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.

GEThttps://api.sandbox.younium.com/Invoices/generateAttachmentURL/{invoiceId}

Authorization

oauth2

Path parameters

invoiceId*string (uuid)

Invoice Id

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

string (uri)

Request

JavaScriptCurlPython

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

Response

200400

https://example.com

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.

GEThttps://api.sandbox.younium.com/Invoices/{id}/Attachments

Authorization

oauth2

Path parameters

id*string (uuid)

Invoice id

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 all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Invoices/{id}/Attachments', {
    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": {
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "attachmentDetail": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "contentType": "text",
    "created": "2024-12-22T11:14:51.793Z",
    "modified": "2024-12-22T11:14:51.793Z",
    "fileURL": "https://example.com",
    "fileURLErrorMessage": "text"
  }
}

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.

GEThttps://api.sandbox.younium.com/Invoices/PostedInvoiceDocumentAttachments

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 all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Invoices/PostedInvoiceDocumentAttachments', {
    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": {
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "attachmentDetail": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "contentType": "text",
    "created": "2024-12-22T11:14:51.793Z",
    "modified": "2024-12-22T11:14:51.793Z",
    "fileURL": "https://example.com",
    "fileURLErrorMessage": "text"
  }
}

Get Invoice Attachment File by Attachment Id

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

GEThttps://api.sandbox.younium.com/Invoices/DownloadAttachment/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Attachment id

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

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

Response

400404

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

Marks Invoice as paid

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

POSThttps://api.sandbox.younium.com/Invoices/paid

Authorization

oauth2

Header parameters

Body

application/json

invoiceId*string (uuid)

paymentDatenullable string (date-time)

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Invoices/paid', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "invoiceId": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

400

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

Generate invoice on Account.

POSThttps://api.sandbox.younium.com/Invoices/onAccountInvoice

Authorization

oauth2

Header parameters

Body

application/json

accountnullable all of

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.

invoiceDatestring (date-time)

yourOrderNumbernullable string

yourReferencenullable string

ourReferencenullable string

accountsReceivablenullable all of

Allowed as string input: Code, FinancialAccount-Id.

Example: "1510"

paymentTermnullable all of

Allowed as string input: Name, PaymentTerm-Id.

Example: "NET30"

invoiceTemplatenullable all of

Allowed as string input: Description, DocumentTemplate_Invoice-Id.

Example: "InvoiceTemplate"

currency*all of

Allowed as string input: Code, Currency-Id.

Example: "SEK"

invoiceDeliveryMethodnullable all of

invoiceAddressnullable all of

deliveryAddressnullable all of

customFieldsnullable object

externalERPIdnullable string

externalCRMIdnullable string

invoiceLinesnullable array of CreateOnAccountInvoiceLineRequest (object)

Response

201400401403

Created

Body

application/json

successfulnullable boolean

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

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

Response

201400

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

Cancel Invoice

POSThttps://api.sandbox.younium.com/Invoices/{id}/cancel

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403

Success

Body

application/json

successfulnullable boolean

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

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

Response

200400

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

Generate Credit Invoice

POSThttps://api.sandbox.younium.com/Invoices/{id}/credit

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/json

creditInvoiceDatenullable string (date-time)

invoiceActionall of

invoiceLineIdsnullable array of string (uuid)

creditAllInvoiceLinesboolean

Response

200400401403

Success

Body

application/json

successfulnullable boolean

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

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

Response

200400

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

Post Invoice

POSThttps://api.sandbox.younium.com/Invoices/{id}/post

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

201400401403

Created

Body

application/json

successfulnullable boolean

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

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

Response

201400

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

Generate Invoice from Order

POSThttps://api.sandbox.younium.com/Invoices/orders/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/json

invoiceDatenullable string (date-time)

customizedTargetDatesnullable all of

targetDatenullable string (date-time)

invoiceActionall of

Response

200400401403

Success

Body

application/json

successfulnullable boolean

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

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

Response

200400

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

Process Stripe Payment for Invoice.

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

POSThttps://api.sandbox.younium.com/Invoices/{id}/ProcessStripePayment

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403

Success

Body

application/json

statusall of

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

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

Response

200400

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

Invoices Online Payment Logs

GEThttps://api.sandbox.younium.com/Invoices/{id}/OnlinePaymentLogs

Authorization

oauth2

Path parameters

id*string (uuid)

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 OnlinePaymentLogResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Invoices/{id}/OnlinePaymentLogs', {
    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": [
    {
      "failedPayment": false,
      "paymentDescription": "text",
      "timeStamp": "2024-12-22T11:14:51.793Z",
      "payoutId": "text",
      "isPayout": false,
      "paymentIntentId": "text"
    }
  ]
}

---