Invoicebatches | Younium Developer Portal

Younium Developer Portal

Get Invoice Batch Log by Id or Reference

get

Authorizations

Path parameters

batchIdentifierstringrequired

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/InvoiceBatches/{batchIdentifier}/BatchLog'

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": {
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "errorMessage": "text",
    "reference": "text",
    "entityName": "text",
    "created": "2025-03-25T00:08:43.630Z",
    "modified": "2025-03-25T00:08:43.630Z"
  }
}

Success

Get status on generate invoice batch job.

get

Authorizations

Path parameters

batchReferencestringrequired

Accepted references job id, batch id, batch number or event id

Header parameters

api-versionstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/InvoiceBatches/BatchJobStatus/{batchReference}/Generated'

200

400

401

403

{
  "resultBody": {
    "batchId": "123e4567-e89b-12d3-a456-426614174000",
    "batchNumber": "text",
    "eventId": "text",
    "message": "text"
  },
  "resultStatus": "Pending",
  "statusMessage": "text"
}

Success

Get status on posted invoice batch job.

get

Authorizations

Path parameters

batchReferencestringrequired

Accepted references job id, batch id, batch number or event id

Header parameters

api-versionstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/InvoiceBatches/BatchJobStatus/{batchReference}/Posted'

200

400

401

403

{
  "resultBody": [
    {
      "batchId": "123e4567-e89b-12d3-a456-426614174000",
      "batchNumber": "text",
      "eventId": "text",
      "message": "text"
    }
  ],
  "resultStatus": "Pending",
  "statusMessage": "text"
}

Success

Get InvoiceBatches

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

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

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",
      "batchNumber": "text",
      "targetDate": "2025-03-25T00:08:43.630Z",
      "invoiceDate": "2025-03-25T00:08:43.630Z",
      "batchGroups": [
        "text"
      ],
      "invoices": [
        {
          "invoiceNumber": "text",
          "status": "Draft",
          "invoiceDate": "2025-03-25T00:08:43.630Z",
          "currency": "text",
          "subtotal": 1,
          "totalAmount": 1,
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "externalERPId": "text",
          "externalCRMId": "text"
        }
      ],
      "batchLog": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "errorMessage": "text",
          "reference": "text",
          "entityName": "text",
          "created": "2025-03-25T00:08:43.630Z",
          "modified": "2025-03-25T00:08:43.630Z"
        }
      ],
      "created": "2025-03-25T00:08:43.630Z",
      "modified": "2025-03-25T00:08:43.630Z"
    }
  ]
}

Success

Get InvoiceBatches by Id

get

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "batchNumber": "text",
  "targetDate": "2025-03-25T00:08:43.630Z",
  "invoiceDate": "2025-03-25T00:08:43.630Z",
  "batchGroups": [
    "text"
  ],
  "invoices": [
    {
      "invoiceNumber": "text",
      "status": "Draft",
      "invoiceDate": "2025-03-25T00:08:43.630Z",
      "currency": "text",
      "subtotal": 1,
      "totalAmount": 1,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text"
    }
  ],
  "batchLog": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "errorMessage": "text",
      "reference": "text",
      "entityName": "text",
      "created": "2025-03-25T00:08:43.630Z",
      "modified": "2025-03-25T00:08:43.630Z"
    }
  ],
  "created": "2025-03-25T00:08:43.630Z",
  "modified": "2025-03-25T00:08:43.630Z"
}

Success

Generate Invoice Batch

post

Generate invoice batch by running generate invoice batch job. Status on jobs can obtained by batch jobs status endpoints or found in settings > scheduled jobs in the UI.

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/InvoiceBatches' \
  --header 'Content-Type: application/json' \
  --data '{
    "invoiceDate": "2025-03-25T00:08:43.630Z",
    "customizedTargetDates": {
      "oneOff": "2025-03-25T00:08:43.630Z",
      "recurringInAdvance": "2025-03-25T00:08:43.630Z",
      "recurringInArrears": "2025-03-25T00:08:43.630Z",
      "usage": "2025-03-25T00:08:43.630Z",
      "measured": "2025-03-25T00:08:43.630Z"
    },
    "targetDate": "2025-03-25T00:08:43.630Z",
    "invoiceAllAccounts": true,
    "invoiceAllBatchGroups": true,
    "accounts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "invoiceBatchGroups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "minimumInvoiceAmount": 1,
    "ensureWebhooksAreEnabled": true,
    "jobDescription": "text"
  }'

200

400

401

403

{
  "batchNumber": "text",
  "jobId": "123e4567-e89b-12d3-a456-426614174000",
  "resultStatus": "Pending",
  "webhooksTriggeredWhenCompleted": true,
  "webhookEvent": "text",
  "webhooks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text"
    }
  ],
  "eventId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Success

Post Invoice Batch

post

Post invoice batch by running post invoice batch job. Status on jobs can obtained by batch jobs status endpoints or found in settings > scheduled jobs in the UI

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/InvoiceBatches/{id}/Post' \
  --header 'Content-Type: application/json' \
  --data '{
    "ensureWebhooksAreEnabled": true,
    "jobDescription": "text"
  }'

200

400

401

403

{
  "batchNumber": "text",
  "jobId": "123e4567-e89b-12d3-a456-426614174000",
  "resultStatus": "Pending",
  "webhooksTriggeredWhenCompleted": true,
  "webhookEvent": "text",
  "webhooks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text"
    }
  ],
  "eventId": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Success

Get Invoice Batch Log by Id or Reference

Get status on generate invoice batch job.

Get status on posted invoice batch job.

Get InvoiceBatches

Get InvoiceBatches by Id

Generate Invoice Batch

Show child attributes

Post Invoice Batch

Show child attributes