BudgetIncreases

The budget increases controller.

APIDescription
GET api/BudgetIncreases/{id}

Retrieves a budget increase.
GET api/BudgetIncreases/budget/{budgetId}

Retrieves a list of budget increases by budget.
GET api/BudgetIncreases

Retrieves a list of budget increases.
POST api/BudgetIncreases

Creates a new budget increase.
DELETE api/BudgetIncreases/{id}

Deletes a budget increase.

Allocations

The allocations controller.

APIDescription
GET api/allocations/{id}

Retrieves an allocation.
POST api/allocations/select

Retrieves a list of allocations that match the given criteria.
PUT api/allocations/{id}

Updates an allocation.
DELETE api/allocations/{id}

Deletes an allocation.
GET api/Allocations

Retrieves a list of allocations.
POST api/Allocations

Creates an allocation.

Credits

The credits controller.

APIDescription
GET api/Credits/{id}

Retrieves a credit.
GET api/Credits

Retrieves a list of credits.
GET api/Credits/User

Retrieves a list of credits for the current user.
GET api/Credits/User/{userId}

Retrieves a list of credits by user.
POST api/Credits

Creates a credit.
DELETE api/Credits/{id}

Deletes a credit.

Vouchers

The vouchers controller.

APIDescription
GET api/vouchers/code/{code}

Retrieves a voucher by code in the current tenant.
GET api/vouchers/{id}/users

Retrieves a list of voucher users for a voucher.
POST api/vouchers/select

Retrieves a list of vouchers that match the given criteria.
PUT api/vouchers/{id}

Updates a voucher.
DELETE api/vouchers/{id}

Deletes a voucher.
POST api/vouchers/ValidateVoucher/{voucherCode}/{orderId}

Validates a voucher against an order.
GET api/vouchers/CheckForAutomaticVouchers/{userId}

Retrieves the voucher to be automatically applied to the given user, if applicable.
GET api/vouchers/report

Retrieves the voucher report.
GET api/Vouchers

Retrieves a list of vouchers.
POST api/Vouchers

Creates a voucher.

PaymentRequests

The payment requests controller.

APIDescription
POST api/PaymentRequests/select

Retrieves a list of payment requests that match the given criteria.
GET api/PaymentRequests/{id}

Retrieves a payment request.
POST api/PaymentRequests

Creates a payment request.

Feedback

APIDescription
POST api/feedback/select

No documentation available.
POST api/feedback/complete

No documentation available.
POST api/Feedback

No documentation available.

Campaigns

The campaigns controller.

APIDescription
GET api/campaigns/{id}

Retrieves a campaign.
GET api/campaigns/user

Retrieves a list of campaigns for the current user.
GET api/campaigns/nonTemporaryUser

Retrieves a list of non temporary campaigns for the current user.
POST api/campaigns/select

Retrieves a list of campaigns that match the given criteria.
POST api/campaigns/selectPaged/{pageNumber}/{pageSize}

Retrieves a paged list of campaigns that match the given criteria.
POST api/campaigns/clone

Clones a campaign.
PUT api/campaigns/{id}

Updates a campaign.
DELETE api/campaigns/{id}

Deletes a campaign.
POST api/campaigns/sameNameExistsForUser

Returns whether a campaign already exists with the same name for the current user.
GET api/Campaigns

Retrieves a list of campaigns.
POST api/Campaigns

Creates a campaign.

Reporting

The reporting controller.

APIDescription
POST api/reporting/orders/bymonth

Retrieves a list of order counts by month that match the given criteria.
POST api/reporting/campaigns

Retrieves a list of campaign reports that match the given criteria.

Transactions

The transactions controller

APIDescription
GET api/Transactions/Budgets/{id}?budgetId={budgetId}

Retrieves a list of transactions by budget.
GET api/Transactions/Credits/{id}?creditId={creditId}

Retrieves a list of transactions by credit.
POST api/Transactions/select

Retrieves a list of transactions that match the given criteria.
GET api/Transactions

Retrieves a list of transactions.
GET api/Transactions/{id}

Retrieves a transaction.
POST api/Transactions

Creates a transaction.
PUT api/Transactions/{id}

Updates a transaction.
DELETE api/Transactions/{id}

Deletes a transaction.

CentralMailerCampaigns

The campaigns controller.

APIDescription
GET api/centralmailercampaigns/{id}

Retrieves a campaign.
GET api/centralmailercampaigns/user

Retrieves a list of campaigns for the current user.
GET api/centralmailercampaigns/nonTemporaryUser

Retrieves a list of non temporary campaigns for the current user.
POST api/centralmailercampaigns/select

Retrieves a list of campaigns that match the given criteria.
POST api/centralmailercampaigns/selectPaged/{pageNumber}/{pageSize}

Retrieves a paged list of campaigns that match the given criteria.
PUT api/centralmailercampaigns/{id}

Updates a campaign.
DELETE api/centralmailercampaigns/{id}

Deletes a campaign.
POST api/centralmailercampaigns/sameNameExistsForUser

Returns whether a campaign already exists with the same name for the current user.
POST api/centralmailercampaigns/status

No documentation available.
POST api/centralmailercampaigns/addUserLink

No documentation available.
POST api/centralmailercampaigns/removeUserLink

No documentation available.
POST api/centralmailercampaigns/getUserLinks

No documentation available.
GET api/CentralMailerCampaigns

Retrieves a list of campaigns.
POST api/CentralMailerCampaigns

Creates a campaign.

Budgets

The budgets controller.

APIDescription
GET api/Budgets/{id}

Retrieves a budget.
GET api/Budgets/user

Retrieves a list of budgets for the current user.
GET api/Budgets/{budgetId}/allocations

Retrieves a budget with associated allocations.
GET api/Budgets/allocations

Retrieves a list of budgets with associated allocations.
POST api/Budgets/select

Retrieves a list of budgets that match the given criteria.
PATCH api/Budgets/{id}/Restore

Restores a budget.
PUT api/Budgets/{id}

Updates a budget.
DELETE api/Budgets/{id}

Deletes a budget.
GET api/Budgets

Retrieves a list of budgets.
POST api/Budgets

Creates a budget.

Orders

The orders controller.

APIDescription
GET api/orders/{id}

Retrieves an order.
GET api/orders/Completed

Retrieves a list of completed orders.
GET api/orders/user

Retrieves a list of orders for the current user.
GET api/orders/user/nonTemporary

Retrieves a list of non temporary orders for the current user.
GET api/orders/monthlyInvoices/{month}

Retrieves a zip file of invoices for a month.
POST api/orders/select

Retrieves a list of orders that match the given criteria.
POST api/orders/selectPaged/{pageNumber}/{pageSize}

Retrieves a paged list of orders that match the given criteria.
PUT api/orders/{id}

Updates an order.
POST api/orders/applyVoucher

Applies a voucher to an order.
POST api/orders/status

Sets the status of an order.
POST api/orders/externalProductionId

Sets the external production id of an order.
POST api/orders/consignmentNumber

Sets the consignment number of an order.
GET api/orders/Adyen

POST api/orders/Adyen

GET api/Orders

Retrieves a list of orders.
POST api/Orders

Creates an order.
DELETE api/Orders/{id}

Deletes an order.

PaymentResponses

The payment responses controller.

APIDescription
POST api/PaymentResponses/select

Retrieves a list of payment responses that match the given criteria.
GET api/PaymentResponses/{id}

Retrieves a payment response.
POST api/PaymentResponses

Creates a payment response.