The Monthly Distribution object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

distribution_id string required
fiscal_year string
The Monthly Distribution object 
{
  "id": "monthly-distribution_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "distribution_id": "distribution_id_example",
  "fiscal_year": "fiscal_year_example"
}
GET /api/accounts/monthly-distribution/{id}

Retrieve a monthly distribution

Retrieves the details of an existing monthly distribution. Supply the unique monthly distribution ID that was returned from a previous request.

Path parameters

id string required

The identifier of the monthly distribution to retrieve.

Returns

Returns the monthly distribution object if a valid identifier was provided.

GET /api/accounts/monthly-distribution/{id} 
curl https://api.overplane.dev/api/accounts/monthly-distribution/monthly-distribution_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "monthly-distribution_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "distribution_id": "distribution_id_example",
  "fiscal_year": "fiscal_year_example"
}
GET /api/accounts/monthly-distribution

List all monthly distributions

Returns a list of monthly distributions. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of monthly distribution objects.

GET /api/accounts/monthly-distribution 
curl https://api.overplane.dev/api/accounts/monthly-distribution \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "monthly-distribution_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "distribution_id": "distribution_id_example",
      "fiscal_year": "fiscal_year_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/monthly-distribution

Create a monthly distribution

Creates a new monthly distribution object.

Body parameters

distribution_id string required
fiscal_year string

Returns

Returns the newly created monthly distribution object if the call succeeded.

POST /api/accounts/monthly-distribution 
curl https://api.overplane.dev/api/accounts/monthly-distribution \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"distribution_id":"distribution_id_example"}'
Response 
{
  "id": "monthly-distribution_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "distribution_id": "distribution_id_example",
  "fiscal_year": "fiscal_year_example"
}
PATCH /api/accounts/monthly-distribution/{id}

Update a monthly distribution

Updates the specified monthly distribution by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the monthly distribution to update.

Body parameters

distribution_id string
fiscal_year string

Returns

Returns the updated monthly distribution object.

PATCH /api/accounts/monthly-distribution/{id} 
curl https://api.overplane.dev/api/accounts/monthly-distribution/monthly-distribution_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"distribution_id":"distribution_id_example","fiscal_year":"fiscal_year_example"}'
Response 
{
  "id": "monthly-distribution_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "distribution_id": "distribution_id_example",
  "fiscal_year": "fiscal_year_example"
}
DELETE /api/accounts/monthly-distribution/{id}

Delete a monthly distribution

Permanently deletes a monthly distribution. This cannot be undone.

Path parameters

id string required

The identifier of the monthly distribution to delete.

Returns

Returns a confirmation that the monthly distribution has been deleted.

DELETE /api/accounts/monthly-distribution/{id} 
curl https://api.overplane.dev/api/accounts/monthly-distribution/monthly-distribution_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "monthly-distribution_abc123",
  "deleted": true
}

Line items

Child objects that belong to this monthly distribution. These are accessed via the parent's ID.

Monthly Distribution Percentage

Attributes

idx integer
monthly_distribution_id string required
month string required
percentage_allocation number

Endpoints

GET /api/accounts/monthly-distribution-percentage?parent_id={id}
POST /api/accounts/monthly-distribution-percentage
PATCH /api/accounts/monthly-distribution-percentage/{id}
DELETE /api/accounts/monthly-distribution-percentage/{id}
POST /api/accounts/monthly-distribution-percentage/reorder
Monthly Distribution Percentage object 
{
  "id": "monthly-distribution-percentage_abc123",
  "idx": 1,
  "monthly_distribution_id": "monthly_distribution_id_example",
  "month": "month_example",
  "percentage_allocation": 0
}