Invoicebatches

Get Invoice Batch Log by Id or Reference

GEThttps://api.sandbox.younium.com/InvoiceBatches/{batchIdentifier}/BatchLog

Authorization

oauth2

Path parameters

batchIdentifier*string

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/InvoiceBatches/{batchIdentifier}/BatchLog', {
    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": {
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "errorMessage": "text",
    "reference": "text",
    "entityName": "text",
    "created": "2024-12-22T11:21:13.890Z",
    "modified": "2024-12-22T11:21:13.890Z"
  }
}

Get status on generate invoice batch job.

GEThttps://api.sandbox.younium.com/InvoiceBatches/BatchJobStatus/{batchReference}/Generated

Authorization

oauth2

Path parameters

batchReference*string

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

Header parameters

Response

200400401403

Success

Body

application/json

resultBodynullable all of

resultStatusnullable all of

statusMessagenullable string

Request

JavaScriptCurlPython

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

Response

200400

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

Get status on posted invoice batch job.

GEThttps://api.sandbox.younium.com/InvoiceBatches/BatchJobStatus/{batchReference}/Posted

Authorization

oauth2

Path parameters

batchReference*string

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

Header parameters

Response

200400401403

Success

Body

application/json

resultBodynullable array of BatchJobDetail (object)

resultStatusnullable all of

statusMessagenullable string

Request

JavaScriptCurlPython

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

Response

200400

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

Generate Invoice Batch

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.

POSThttps://api.sandbox.younium.com/InvoiceBatches

Authorization

oauth2

Header parameters

Body

application/json

invoiceDatenullable string (date-time)

customizedTargetDatesnullable all of

targetDatenullable string (date-time)

invoiceAllAccountsboolean

invoiceAllBatchGroupsboolean

accountsnullable array of string (uuid)

invoiceBatchGroupsnullable array of string (uuid)

minimumInvoiceAmountnullable number (double)

ensureWebhooksAreEnabledboolean

jobDescriptionnullable string

Response

200400401403

Success

Body

application/json

batchNumbernullable string

jobIdnullable string (uuid)

resultStatusnullable all of

webhooksTriggeredWhenCompletedboolean

webhookEventnullable string

webhooksnullable array of SimpleWebhookModel (object)

eventIdnullable string

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

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

Response

200400

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

Get InvoiceBatches

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

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

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/InvoiceBatches', {
    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",
      "batchNumber": "text",
      "targetDate": "2024-12-22T11:21:13.890Z",
      "invoiceDate": "2024-12-22T11:21:13.890Z",
      "batchGroups": [
        "text"
      ],
      "invoices": [
        {
          "invoiceNumber": "text",
          "status": {},
          "invoiceDate": "2024-12-22T11:21:13.890Z",
          "currency": "text",
          "subtotal": 0,
          "totalAmount": 0,
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "externalERPId": "text",
          "externalCRMId": "text"
        }
      ],
      "batchLog": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "errorMessage": "text",
          "reference": "text",
          "entityName": "text",
          "created": "2024-12-22T11:21:13.890Z",
          "modified": "2024-12-22T11:21:13.890Z"
        }
      ],
      "created": "2024-12-22T11:21:13.890Z",
      "modified": "2024-12-22T11:21:13.890Z"
    }
  ]
}

Post Invoice Batch

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

POSThttps://api.sandbox.younium.com/InvoiceBatches/{id}/Post

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/json

ensureWebhooksAreEnabledboolean

jobDescriptionnullable string

Response

200400401403

Success

Body

application/json

batchNumbernullable string

jobIdnullable string (uuid)

resultStatusnullable all of

webhooksTriggeredWhenCompletedboolean

webhookEventnullable string

webhooksnullable array of SimpleWebhookModel (object)

eventIdnullable string

idnullable string (uuid)

messagenullable string

Request

JavaScriptCurlPython

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

Response

200400

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

Get InvoiceBatches by Id

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

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

batchNumbernullable string

targetDatenullable string (date-time)

invoiceDatestring (date-time)

batchGroupsnullable array of string

invoicesnullable array of SimpleInvoiceModel (object)

batchLognullable array of InvoiceBatchLogResponse (object)

createdstring (date-time)

modifiedstring (date-time)

Request

JavaScriptCurlPython

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

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "batchNumber": "text",
  "targetDate": "2024-12-22T11:21:13.890Z",
  "invoiceDate": "2024-12-22T11:21:13.890Z",
  "batchGroups": [
    "text"
  ],
  "invoices": [
    {
      "invoiceNumber": "text",
      "status": {},
      "invoiceDate": "2024-12-22T11:21:13.890Z",
      "currency": "text",
      "subtotal": 0,
      "totalAmount": 0,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text"
    }
  ],
  "batchLog": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "errorMessage": "text",
      "reference": "text",
      "entityName": "text",
      "created": "2024-12-22T11:21:13.890Z",
      "modified": "2024-12-22T11:21:13.890Z"
    }
  ],
  "created": "2024-12-22T11:21:13.890Z",
  "modified": "2024-12-22T11:21:13.890Z"
}

---