Revenueschedule

Get revenue schedule by charge number

get

/RevenueSchedule/Charge/{chargeNumber}

Authorizations

Path parameters

chargeNumberstringrequired

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/RevenueSchedule/Charge/{chargeNumber}'

200

400

401

403

200

{
  "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",
      "created": "2025-02-22T07:42:08.463Z",
      "modified": "2025-02-22T07:42:08.463Z",
      "deferredRevenue": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T07:42:08.463Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "recognizedRevenue": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T07:42:08.463Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "accountingPeriod": {
        "description": "text",
        "fiscalYear": 1,
        "fiscalPeriod": 1,
        "fiscalQuarter": 1,
        "calendarYear": 1,
        "calendarMonth": 1,
        "startDate": "2025-02-22T07:42:08.463Z",
        "endDate": "2025-02-22T07:42:08.463Z",
        "closedDate": "2025-02-22T07:42:08.463Z",
        "status": "Open"
      },
      "invoiceLine": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "invoiceDate": "2025-02-22T07:42:08.463Z",
        "quantity": 1,
        "unitCode": "text",
        "price": 1,
        "subtotal": 1,
        "total": 1,
        "tax": 1,
        "subtotalPreDiscount": 1,
        "totalPreDiscount": 1,
        "taxPreDiscount": 1,
        "externalERPId": "text",
        "externalCRMId": "text",
        "servicePeriodStartDate": "2025-02-22T07:42:08.463Z",
        "servicePeriodEndDate": "2025-02-22T07:42:08.463Z",
        "notes": "text",
        "accountsReceivableAccount": "text",
        "deferredRevenueAccount": "text",
        "recognizedRevenueAccount": "text",
        "taxCategoryName": "text",
        "taxRate": 1
      },
      "orderProductCharge": {
        "name": "text",
        "chargeNumber": "OPC-000001",
        "description": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      }
    }
  ]
}

Success

Get revenue schedule by invoice line id

get

/RevenueSchedule/InvoiceLine/{id}

Authorizations

Path parameters

idstring · uuidrequired

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

200

{
  "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",
      "created": "2025-02-22T07:42:08.463Z",
      "modified": "2025-02-22T07:42:08.463Z",
      "deferredRevenue": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T07:42:08.463Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "recognizedRevenue": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T07:42:08.463Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "accountingPeriod": {
        "description": "text",
        "fiscalYear": 1,
        "fiscalPeriod": 1,
        "fiscalQuarter": 1,
        "calendarYear": 1,
        "calendarMonth": 1,
        "startDate": "2025-02-22T07:42:08.463Z",
        "endDate": "2025-02-22T07:42:08.463Z",
        "closedDate": "2025-02-22T07:42:08.463Z",
        "status": "Open"
      },
      "invoiceLine": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "invoiceDate": "2025-02-22T07:42:08.463Z",
        "quantity": 1,
        "unitCode": "text",
        "price": 1,
        "subtotal": 1,
        "total": 1,
        "tax": 1,
        "subtotalPreDiscount": 1,
        "totalPreDiscount": 1,
        "taxPreDiscount": 1,
        "externalERPId": "text",
        "externalCRMId": "text",
        "servicePeriodStartDate": "2025-02-22T07:42:08.463Z",
        "servicePeriodEndDate": "2025-02-22T07:42:08.463Z",
        "notes": "text",
        "accountsReceivableAccount": "text",
        "deferredRevenueAccount": "text",
        "recognizedRevenueAccount": "text",
        "taxCategoryName": "text",
        "taxRate": 1
      },
      "orderProductCharge": {
        "name": "text",
        "chargeNumber": "OPC-000001",
        "description": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      }
    }
  ]
}

Success

---