Younium Developer Portal
  • Welcome
  • Get started
  • API:s
    • API 2.0
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Documenttemplate
      • Exchangerate
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Paymentterms
      • Products
      • Quotes
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
    • API 2.1
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Customfieldconfigurations
      • Documenttemplate
      • Exchangerate
      • Invoicebatches
      • Invoicebatchgroups
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Payments
      • Paymentterms
      • Products
      • Quotes
      • Reports
      • Revenueschedule
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
  • Documentation
    • Developer resources
    • Invoice operations
    • Product guide
    • Webhooks
    • Idempotent requests
  • Sandbox
Powered by GitBook
On this page

Was this helpful?

  1. API:s
  2. API 2.0

Invoices

PreviousExchangerateNextJournals

Last updated 7 months ago

Was this helpful?

Get Invoices

get

Requires permission Invoice Read.

Authorizations
Query parameters
Skipinteger · int32Optional

Skip number of records

Example: 10
Takeinteger · int32Optional

Take number of records

Example: 5
FilterstringOptional

Filter the resulsts. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20
SortstringOptional

Sorting the results. See ODATA specificaion for more information

Example: name
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
get
GET /Invoices HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "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-05-28T02:35:56.706Z",
    "dueDate": "2025-05-28T02:35:56.706Z",
    "paymentDate": "2025-05-28T02:35:56.706Z",
    "lastPaymentDate": "2025-05-28T02:35:56.706Z",
    "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-05-28T02:35:56.706Z",
        "servicePeriodEndDate": "2025-05-28T02:35:56.706Z",
        "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-05-28T02:35:56.706Z",
        "modified": "2025-05-28T02:35:56.706Z",
        "taxCategoryName": "text",
        "taxRate": 1
      }
    ],
    "latestOnlinePaymentLogs": [
      {
        "failedPayment": true,
        "paymentDescription": "text",
        "timeStamp": "2025-05-28T02:35:56.706Z",
        "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-05-28T02:35:56.706Z",
    "modified": "2025-05-28T02:35:56.706Z"
  }
]

Get an Invoice by id

get

Requires permission Invoice Read.

Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
get
GET /Invoices/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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-05-28T02:35:56.706Z",
  "dueDate": "2025-05-28T02:35:56.706Z",
  "paymentDate": "2025-05-28T02:35:56.706Z",
  "lastPaymentDate": "2025-05-28T02:35:56.706Z",
  "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-05-28T02:35:56.706Z",
      "servicePeriodEndDate": "2025-05-28T02:35:56.706Z",
      "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-05-28T02:35:56.706Z",
      "modified": "2025-05-28T02:35:56.706Z",
      "taxCategoryName": "text",
      "taxRate": 1
    }
  ],
  "latestOnlinePaymentLogs": [
    {
      "failedPayment": true,
      "paymentDescription": "text",
      "timeStamp": "2025-05-28T02:35:56.706Z",
      "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-05-28T02:35:56.706Z",
  "modified": "2025-05-28T02:35:56.706Z"
}

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
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
get
GET /Invoices/invoiceDownloadAttachment/{invoiceId} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

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
200
Success
application/json
Responsestring · uri
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
get
GET /Invoices/generateAttachmentURL/{invoiceId} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

https://example.com

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

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.

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
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
get
GET /Invoices/{id}/Attachments HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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-05-28T02:35:56.706Z",
    "modified": "2025-05-28T02:35:56.706Z",
    "fileURL": "https://example.com",
    "fileURLErrorMessage": "text"
  }
}

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

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.

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
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
get
GET /Invoices/PostedInvoiceDocumentAttachments HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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-05-28T02:35:56.706Z",
    "modified": "2025-05-28T02:35:56.706Z",
    "fileURL": "https://example.com",
    "fileURLErrorMessage": "text"
  }
}

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
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
get
GET /Invoices/DownloadAttachment/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Cancel Invoice

post
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Invoices/{id}/cancel HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Post Invoice

post
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Responses
201
Created
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Invoices/{id}/post HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

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
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Invoices/{id}/ProcessStripePayment HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

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
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
get
GET /Invoices/{id}/OnlinePaymentLogs HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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-05-28T02:35:56.706Z",
      "payoutId": "text",
      "isPayout": true,
      "paymentIntentId": "text"
    }
  ]
}
  • GETGet Invoices
  • GETGet an Invoice by id
  • PATCHEdit Invoice
  • GETGet Posted Invoice PDF Attachment
  • GETGet Posted Invoice PDF Attachment URL
  • GETGet Invoice Attachments
  • GETGet Posted Invoice Document attachments
  • GETGet Invoice Attachment File by Attachment Id
  • POSTMarks Invoice as paid
  • POSTGenerate invoice on Account.
  • POSTCancel Invoice
  • POSTGenerate Credit Invoice
  • POSTPost Invoice
  • POSTGenerate Invoice from Order
  • POSTProcess Stripe Payment for Invoice.
  • GETInvoices Online Payment Logs

Edit Invoice

patch
Authorizations
Path parameters
idstring · uuidRequired

Invoice Id

Header parameters
api-versionstringOptional
Body
dueDatestring · date-timeOptional
invoiceDeliveryMethodall ofOptional
string · enumOptionalPossible values:
disableAutomaticInvoiceReminderbooleanOptional
notesstring | nullableOptional
externalERPIdstring | nullableOptional
externalCRMIdstring | nullableOptional
yourOrderNumberstring | nullableOptional
referenceNumberstring | nullableOptional
Responses
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
patch
PATCH /Invoices/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 274

{
  "dueDate": "2025-05-28T02:35:56.706Z",
  "invoiceDeliveryMethod": "Email",
  "disableAutomaticInvoiceReminder": true,
  "notes": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "yourOrderNumber": "text",
  "referenceNumber": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
No content

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
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Invoices/paid HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2025-05-28T02:35:56.706Z"
}
No content

Generate invoice on Account.

post
Authorizations
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
201
Created
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Invoices/onAccountInvoice HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1032

{
  "account": "A-000001",
  "invoiceAction": "CreateDraft",
  "invoiceDate": "2025-05-28T02:35:56.706Z",
  "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"
    }
  ]
}
{
  "successful": true,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Generate Credit Invoice

post
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Invoices/{id}/credit HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "creditInvoiceDate": "2025-05-28T02:35:56.706Z",
  "invoiceAction": "CreateDraft",
  "invoiceLineIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "creditAllInvoiceLines": true
}
{
  "successful": true,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Generate Invoice from Order

post
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Invoices/orders/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "invoiceDate": "2025-05-28T02:35:56.706Z",
  "customizedTargetDates": {
    "oneOff": "2025-05-28T02:35:56.706Z",
    "recurringInAdvance": "2025-05-28T02:35:56.706Z",
    "recurringInArrears": "2025-05-28T02:35:56.706Z",
    "usage": "2025-05-28T02:35:56.706Z",
    "measured": "2025-05-28T02:35:56.706Z"
  },
  "targetDate": "2025-05-28T02:35:56.706Z",
  "invoiceAction": "CreateDraft"
}
{
  "successful": true,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}