Revenueschedule

Get revenue schedule by charge number

GEThttps://api.sandbox.younium.com/RevenueSchedule/Charge/{chargeNumber}

Authorization

oauth2

Path parameters

chargeNumber*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 array of RevenueScheduleItemResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/RevenueSchedule/Charge/{chargeNumber}', {
    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",
      "deferredRevenue": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:46:31.206Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "recognizedRevenue": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:46:31.206Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "accountingPeriod": {
        "description": "text",
        "fiscalYear": 0,
        "fiscalPeriod": 0,
        "fiscalQuarter": 0,
        "calendarYear": 0,
        "calendarMonth": 0,
        "startDate": "2024-12-22T11:46:31.206Z",
        "endDate": "2024-12-22T11:46:31.206Z",
        "status": {},
        "closedDate": "2024-12-22T11:46:31.206Z"
      },
      "invoiceLine": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "invoiceDate": "2024-12-22T11:46:31.206Z",
        "quantity": 0,
        "unitCode": "text",
        "price": 0,
        "subtotal": 0,
        "total": 0,
        "tax": 0,
        "subtotalPreDiscount": 0,
        "totalPreDiscount": 0,
        "taxPreDiscount": 0,
        "externalERPId": "text",
        "externalCRMId": "text",
        "servicePeriodStartDate": "2024-12-22T11:46:31.206Z",
        "servicePeriodEndDate": "2024-12-22T11:46:31.206Z",
        "notes": "text",
        "accountsReceivableAccount": "text",
        "deferredRevenueAccount": "text",
        "recognizedRevenueAccount": "text",
        "taxCategoryName": "text",
        "taxRate": 0
      },
      "orderProductCharge": {
        "name": "text",
        "chargeNumber": "OPC-000001",
        "description": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "created": "2024-12-22T11:46:31.206Z",
      "modified": "2024-12-22T11:46:31.206Z"
    }
  ]
}

Get revenue schedule by invoice line id

GEThttps://api.sandbox.younium.com/RevenueSchedule/InvoiceLine/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

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

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/RevenueSchedule/InvoiceLine/{id}', {
    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",
      "deferredRevenue": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:46:31.206Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "recognizedRevenue": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:46:31.206Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "accountingPeriod": {
        "description": "text",
        "fiscalYear": 0,
        "fiscalPeriod": 0,
        "fiscalQuarter": 0,
        "calendarYear": 0,
        "calendarMonth": 0,
        "startDate": "2024-12-22T11:46:31.206Z",
        "endDate": "2024-12-22T11:46:31.206Z",
        "status": {},
        "closedDate": "2024-12-22T11:46:31.206Z"
      },
      "invoiceLine": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "invoiceDate": "2024-12-22T11:46:31.206Z",
        "quantity": 0,
        "unitCode": "text",
        "price": 0,
        "subtotal": 0,
        "total": 0,
        "tax": 0,
        "subtotalPreDiscount": 0,
        "totalPreDiscount": 0,
        "taxPreDiscount": 0,
        "externalERPId": "text",
        "externalCRMId": "text",
        "servicePeriodStartDate": "2024-12-22T11:46:31.206Z",
        "servicePeriodEndDate": "2024-12-22T11:46:31.206Z",
        "notes": "text",
        "accountsReceivableAccount": "text",
        "deferredRevenueAccount": "text",
        "recognizedRevenueAccount": "text",
        "taxCategoryName": "text",
        "taxRate": 0
      },
      "orderProductCharge": {
        "name": "text",
        "chargeNumber": "OPC-000001",
        "description": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "created": "2024-12-22T11:46:31.206Z",
      "modified": "2024-12-22T11:46:31.206Z"
    }
  ]
}

---