Invoices | Younium Developer Portal

Younium Developer Portal

Get Invoices

get

Authorizations

Query parameters

Filterstringoptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystringoptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeoptional

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

Example: 03/01/2025 00:00:00

ModifiedBeforestring · date-timeoptional

Filter is also applied on sub entities: 'invoiceLines' and 'customFields' on these entities

Example: 03/01/2025 00:00:00

PageSizeinteger · int32optional

Page Size

Example: 20

PageNumberinteger · int32optional

Page Number

Example: 1

Header parameters

api-versionstringoptional

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",
      "status": "Draft",
      "account": {
        "name": "text",
        "accountNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "notes": "text",
      "invoiceDate": "2025-03-24T23:32:02.731Z",
      "dueDate": "2025-03-24T23:32:02.731Z",
      "paymentDate": "2025-03-24T23:32:02.731Z",
      "lastPaymentDate": "2025-03-24T23:32:02.731Z",
      "daysPastDue": 1,
      "nrOfReminders": 1,
      "paymentTerm": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "days": 1,
        "name": "text"
      },
      "currency": "text",
      "subtotal": 1,
      "tax": 1,
      "totalAmount": 1,
      "totalRoundingAmount": 1,
      "settledAmount": 1,
      "balancedAmount": 1,
      "taxIncluded": true,
      "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": 1,
          "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": 1,
          "unitOfMeasure": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "unitCode": "text",
            "name": "text",
            "displayName": "text"
          },
          "price": 1,
          "subtotal": 1,
          "total": 1,
          "tax": 1,
          "subtotalPreDiscount": 1,
          "totalPreDiscount": 1,
          "taxPreDiscount": 1,
          "servicePeriodStartDate": "2025-03-24T23:32:02.731Z",
          "servicePeriodEndDate": "2025-03-24T23:32:02.731Z",
          "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",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "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": "2025-03-24T23:32:02.731Z",
          "modified": "2025-03-24T23:32:02.731Z",
          "taxCategoryName": "text",
          "taxRate": 1
        }
      ],
      "latestOnlinePaymentLogs": [
        {
          "failedPayment": true,
          "paymentDescription": "text",
          "timeStamp": "2025-03-24T23:32:02.731Z",
          "payoutId": "text",
          "isPayout": true,
          "paymentIntentId": "text"
        }
      ],
      "onlinePaymentStatus": "None",
      "yourReference": "text",
      "ourReference": "text",
      "yourOrderNumber": "text",
      "buyerReference": "text",
      "invoiceType": "Invoice",
      "ocrNumber": "text",
      "sendMethod": "text",
      "exchangeRate": 1,
      "settledNotes": "text",
      "invoiceDeliveryMethod": "Email",
      "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "disableAutomaticInvoiceReminder": true,
      "onlinePaymentLink": "text",
      "accountsReceivable": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "text",
        "name": "text",
        "description": "text",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-03-24T23:32:02.731Z",
      "modified": "2025-03-24T23:32:02.731Z"
    }
  ]
}

Success

Get an Invoice by id

get

Requires permission Invoice Read.

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

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",
  "status": "Draft",
  "account": {
    "name": "text",
    "accountNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "notes": "text",
  "invoiceDate": "2025-03-24T23:32:02.731Z",
  "dueDate": "2025-03-24T23:32:02.731Z",
  "paymentDate": "2025-03-24T23:32:02.731Z",
  "lastPaymentDate": "2025-03-24T23:32:02.731Z",
  "daysPastDue": 1,
  "nrOfReminders": 1,
  "paymentTerm": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "days": 1,
    "name": "text"
  },
  "currency": "text",
  "subtotal": 1,
  "tax": 1,
  "totalAmount": 1,
  "totalRoundingAmount": 1,
  "settledAmount": 1,
  "balancedAmount": 1,
  "taxIncluded": true,
  "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": 1,
      "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": 1,
      "unitOfMeasure": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "unitCode": "text",
        "name": "text",
        "displayName": "text"
      },
      "price": 1,
      "subtotal": 1,
      "total": 1,
      "tax": 1,
      "subtotalPreDiscount": 1,
      "totalPreDiscount": 1,
      "taxPreDiscount": 1,
      "servicePeriodStartDate": "2025-03-24T23:32:02.731Z",
      "servicePeriodEndDate": "2025-03-24T23:32:02.731Z",
      "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",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "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": "2025-03-24T23:32:02.731Z",
      "modified": "2025-03-24T23:32:02.731Z",
      "taxCategoryName": "text",
      "taxRate": 1
    }
  ],
  "latestOnlinePaymentLogs": [
    {
      "failedPayment": true,
      "paymentDescription": "text",
      "timeStamp": "2025-03-24T23:32:02.731Z",
      "payoutId": "text",
      "isPayout": true,
      "paymentIntentId": "text"
    }
  ],
  "onlinePaymentStatus": "None",
  "yourReference": "text",
  "ourReference": "text",
  "yourOrderNumber": "text",
  "buyerReference": "text",
  "invoiceType": "Invoice",
  "ocrNumber": "text",
  "sendMethod": "text",
  "exchangeRate": 1,
  "settledNotes": "text",
  "invoiceDeliveryMethod": "Email",
  "invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "disableAutomaticInvoiceReminder": true,
  "onlinePaymentLink": "text",
  "accountsReceivable": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "code": "text",
    "name": "text",
    "description": "text",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-03-24T23:32:02.731Z",
  "modified": "2025-03-24T23:32:02.731Z"
}

Success

Get Related Invoices

get

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

{
  "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": {
    "invoiceType": "Invoice",
    "debitInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "creditInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceNumber": "text",
    "status": "Draft",
    "invoiceDate": "2025-03-24T23:32:02.731Z",
    "currency": "text",
    "subtotal": 1,
    "totalAmount": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  }
}

Success

Get Posted Invoice PDF Attachment

get

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

Authorizations

Path parameters

invoiceIdstring · uuidrequired

Invoice Id

Header parameters

api-versionstringoptional

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

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

Authorizations

Path parameters

invoiceIdstring · uuidrequired

Invoice Id

Query parameters

ExpirationTimeSpanHoursstringoptional

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-versionstringoptional

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

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.

Authorizations

Path parameters

idstring · uuidrequired

Invoice id

Query parameters

ExpirationTimeSpanHoursstringoptional

Filterstringoptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystringoptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeoptional

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

Example: 03/01/2025 00:00:00

ModifiedBeforestring · date-timeoptional

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

Example: 03/01/2025 00:00:00

PageSizeinteger · int32optional

Page Size

Example: 20

PageNumberinteger · int32optional

Page Number

Example: 1

Header parameters

api-versionstringoptional

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-03-24T23:32:02.731Z",
    "modified": "2025-03-24T23:32:02.731Z",
    "fileURL": "https://example.com",
    "fileURLErrorMessage": "text"
  }
}

Success

Get Posted Invoice Document attachments

get

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.

Authorizations

Query parameters

ExpirationTimeSpanHoursstringoptional

Filterstringoptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystringoptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeoptional

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

Example: 03/01/2025 00:00:00

ModifiedBeforestring · date-timeoptional

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

Example: 03/01/2025 00:00:00

PageSizeinteger · int32optional

Page Size

Example: 20

PageNumberinteger · int32optional

Page Number

Example: 1

Header parameters

api-versionstringoptional

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-03-24T23:32:02.731Z",
    "modified": "2025-03-24T23:32:02.731Z",
    "fileURL": "https://example.com",
    "fileURLErrorMessage": "text"
  }
}

Success

Get Invoice Attachment File by Attachment Id

get

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

Authorizations

Path parameters

idstring · uuidrequired

Attachment id

Header parameters

api-versionstringoptional

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

Cancel Invoice

post

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

younium-idempotency-keystringoptional

younium-idempotency-durationInHoursintegeroptional

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

Post Invoice

post

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

younium-idempotency-keystringoptional

younium-idempotency-durationInHoursintegeroptional

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

Process Stripe Payment for Invoice.

post

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

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

younium-idempotency-keystringoptional

younium-idempotency-durationInHoursintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

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

Success

Invoices Online Payment Logs

get

Authorizations

Path parameters

idstring · uuidrequired

Query parameters

Filterstringoptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystringoptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeoptional

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

Example: 03/01/2025 00:00:00

ModifiedBeforestring · date-timeoptional

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

Example: 03/01/2025 00:00:00

PageSizeinteger · int32optional

Page Size

Example: 20

PageNumberinteger · int32optional

Page Number

Example: 1

Header parameters

api-versionstringoptional

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-03-24T23:32:02.731Z",
      "payoutId": "text",
      "isPayout": true,
      "paymentIntentId": "text"
    }
  ]
}

Success

Edit Invoice

patch

Authorizations

Path parameters

idstring · uuidrequired

Invoice Id

Header parameters

api-versionstringoptional

Body

dueDatestring · date-timeoptional

invoiceDeliveryMethodall ofoptional

disableAutomaticInvoiceReminderbooleanoptional

notesstring | nullableoptional

externalERPIdstring | nullableoptional

externalCRMIdstring | nullableoptional

yourOrderNumberstring | nullableoptional

referenceNumberstring | nullableoptional

customFieldsobject | nullableoptional

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 '{
    "dueDate": "2025-03-24T23:32:02.731Z",
    "invoiceDeliveryMethod": "Email",
    "disableAutomaticInvoiceReminder": true,
    "notes": "text",
    "externalERPId": "text",
    "externalCRMId": "text",
    "yourOrderNumber": "text",
    "referenceNumber": "text",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }'

200

400

401

403

No body

Success

Marks Invoice as paid

post

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

Authorizations

Header parameters

api-versionstringoptional

younium-idempotency-keystringoptional

younium-idempotency-durationInHoursintegeroptional

Body

all ofoptional

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",
    "paymentDate": "2025-03-24T23:32:02.731Z"
  }'

200

400

401

403

No body

Success

Generate invoice on Account.

post

Authorizations

Header parameters

api-versionstringoptional

younium-idempotency-keystringoptional

younium-idempotency-durationInHoursintegeroptional

Body

all ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Invoices/onAccountInvoice' \
  --header 'Content-Type: application/json' \
  --data '{
    "account": "A-000001",
    "invoiceAction": "CreateDraft",
    "invoiceDate": "2025-03-24T23:32:02.731Z",
    "yourOrderNumber": "text",
    "yourReference": "text",
    "ourReference": "text",
    "buyerReference": "text",
    "notes": "text",
    "accountsReceivable": "1510",
    "paymentTerm": "NET30",
    "invoiceTemplate": "InvoiceTemplate",
    "currency": "SEK",
    "invoiceDeliveryMethod": "Email",
    "invoiceAddress": {
      "description": "text",
      "name": "text",
      "street": "text",
      "street2": "text",
      "city": "text",
      "county": "text",
      "state": "text",
      "zip": "text",
      "country": "Sweden"
    },
    "deliveryAddress": {
      "description": "text",
      "name": "text",
      "street": "text",
      "street2": "text",
      "city": "text",
      "county": "text",
      "state": "text",
      "zip": "text",
      "country": "Sweden"
    },
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "externalERPId": "text",
    "externalCRMId": "text",
    "invoiceLines": [
      {
        "productName": "text",
        "price": 1,
        "quantity": 1,
        "notes": "text",
        "unitOfMeasure": "pcs",
        "recognizedRevenueAccount": "1510",
        "taxTemplate": "Sweden standard",
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "externalCRMId": "text",
        "externalERPId": "text"
      }
    ]
  }'

201

400

401

403

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

Created

Generate Credit Invoice

post

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

younium-idempotency-keystringoptional

younium-idempotency-durationInHoursintegeroptional

Body

all ofoptional

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 '{
    "creditInvoiceDate": "2025-03-24T23:32:02.731Z",
    "invoiceAction": "CreateDraft",
    "invoiceLineIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "creditAllInvoiceLines": true
  }'

200

400

401

403

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

Success

Generate Invoice from Order

post

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

younium-idempotency-keystringoptional

younium-idempotency-durationInHoursintegeroptional

Body

all ofoptional

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 '{
    "invoiceDate": "2025-03-24T23:32:02.731Z",
    "customizedTargetDates": {
      "oneOff": "2025-03-24T23:32:02.731Z",
      "recurringInAdvance": "2025-03-24T23:32:02.731Z",
      "recurringInArrears": "2025-03-24T23:32:02.731Z",
      "usage": "2025-03-24T23:32:02.731Z",
      "measured": "2025-03-24T23:32:02.731Z"
    },
    "targetDate": "2025-03-24T23:32:02.731Z",
    "invoiceAction": "CreateDraft"
  }'

200

400

401

403

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

Success

Get Invoices

Get an Invoice by id

Get Related Invoices

Get Posted Invoice PDF Attachment

Get Posted Invoice PDF Attachment URL

Get Invoice Attachments

Get Posted Invoice Document attachments

Get Invoice Attachment File by Attachment Id

Cancel Invoice

Post Invoice

Process Stripe Payment for Invoice.

Invoices Online Payment Logs

Edit Invoice

Show child attributes

Show child attributes

Marks Invoice as paid

Show child attributes

Generate invoice on Account.

Show child attributes

Generate Credit Invoice

Show child attributes

Generate Invoice from Order

Show child attributes