Revenue Accounts

Retrieve available revenue account definitions. Revenue accounts are used for financial categorization of charges.

Endpoints Overview

Method	Endpoint	Description
`GET`	`/v1/revenue-accounts`	Get a page of revenue accounts

Get Revenue Accounts Page

Retrieve a paginated list of revenue accounts.

Endpoint: GET /v1/revenue-accounts

Query Parameters

Parameter	Type	Required	Description
`PageIndex`	integer	No	Page number (default: 1)
`PageSize`	integer	No	Items per page (default: 25, max: 500)
`SearchText`	string	No	Filter by revenue account name or code

Request Example

curl -X GET "https://api.consignlyhq.com/v1/revenue-accounts?PageIndex=1&PageSize=50&SearchText=Sales" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example

{
  "index": 1,
  "total": 15,
  "revenueAccounts": [
    {
      "id": "550e8400-e29b-41d4-a716-446655449300",
      "code": "4000",
      "name": "Sales - Storage"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449301",
      "code": "4100",
      "name": "Sales - Handling"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449302",
      "code": "4200",
      "name": "Sales - Freight"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655449303",
      "code": "4300",
      "name": "Sales - Value Added Services"
    }
  ]
}

Response Fields

Field	Type	Description
`id`	uuid	Revenue account ID
`code`	string	Revenue account code
`name`	string	Revenue account name

Using Revenue Account IDs

Revenue account IDs are used when creating adhoc charges:

{
  "particulars": "Special handling fee",
  "revenueAccountId": "550e8400-e29b-41d4-a716-446655449301",
  "costCentreId": "...",
  "chargeApplication": 2,
  "chargeRateExclTax": 45.00,
  "taxRateId": "..."
}

Consignment Charges - Create charges with revenue accounts
Cost Centres - Cost centre lookup
Tax Rates - Tax rate lookup

Reports

Shipping Ports