Invoicebatches

PreviousExchangerate NextInvoicebatchgroups

Last updated 3 months ago

Was this helpful?

Get Invoice Batch Log by Id or Reference

get

/InvoiceBatches/{batchIdentifier}/BatchLog

Authorizations

Path parameters

batchIdentifierstringrequired

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

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

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

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

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

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-02-22T08:25:52.201Z",
    "modified": "2025-02-22T08:25:52.201Z"
  }
}

Success

Get status on generate invoice batch job.

get

/InvoiceBatches/BatchJobStatus/{batchReference}/Generated

Authorizations

Path parameters

batchReferencestringrequired

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

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

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

Success

Get status on posted invoice batch job.

get

/InvoiceBatches/BatchJobStatus/{batchReference}/Posted

Authorizations

Path parameters

batchReferencestringrequired

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

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

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

Success

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.

post

/InvoiceBatches

Authorizations

Header parameters

api-versionstring

Body

invoiceDatestring · date-time | nullable

targetDatestring · date-time | nullable

invoiceAllAccountsboolean

invoiceAllBatchGroupsboolean

minimumInvoiceAmountnumber · double | nullable

ensureWebhooksAreEnabledboolean

jobDescriptionstring | nullable

accountsstring · uuid[] | nullable

invoiceBatchGroupsstring · uuid[] | nullable

customizedTargetDatesall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/InvoiceBatches' \
  --header 'Content-Type: application/json' \
  --data '{"accounts":[null],"invoiceBatchGroups":[null],"customizedTargetDates":{}}'

200

400

401

403

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

Success

Get InvoiceBatches

get

/InvoiceBatches

Authorizations

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

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

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

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

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

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

Success

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

post

/InvoiceBatches/{id}/Post

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

ensureWebhooksAreEnabledboolean

jobDescriptionstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/InvoiceBatches/{id}/Post' \
  --header 'Content-Type: application/json'

200

400

401

403

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

Success

Get InvoiceBatches by Id

get

/InvoiceBatches/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

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

Success