Download OpenAPI specification:Download
The Expenses API allows you to manage accounting and expenses information.
List expenses under the same account. Admin and bookkeeper have access to any expense, and regular users can only access their own.
listExpenses 200 response
Bad request
Unauthorized
Forbidden
{- "next_cursor": "string",
- "items": [
- {
- "id": "string",
- "memo": "string",
- "location_id": "string",
- "location": {
- "id": "string",
- "name": "string"
}, - "department_id": "string",
- "department": {
- "id": "string",
- "name": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "category": "ADVERTISING_AND_MARKETING",
- "receipts": [
- {
- "id": "string",
- "download_uris": [
- "string"
]
}
], - "budget_id": "string"
}
]
}
Get an expense by its ID.
getExpense 200 response
Bad request
Unauthorized
Forbidden
Not Found
{- "id": "string",
- "memo": "string",
- "location_id": "string",
- "location": {
- "id": "string",
- "name": "string"
}, - "department_id": "string",
- "department": {
- "id": "string",
- "name": "string"
}, - "updated_at": "2019-08-24T14:15:22Z",
- "category": "ADVERTISING_AND_MARKETING",
- "receipts": [
- {
- "id": "string",
- "download_uris": [
- "string"
]
}
], - "budget_id": "string"
}
Update an expense. Admin and bookkeeper have access to any expense, and regular users can only access their own.
updateExpense 200 response
Bad request
Unauthorized
Forbidden
Not Found
{- "memo": "string"
}
{- "id": "string",
- "memo": "string",
- "location_id": "string",
- "department_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "category": "ADVERTISING_AND_MARKETING",
- "budget_id": "string"
}
The uri
will be a pre-signed S3 URL allowing you to upload the receipt securely. This URL can only be used for a PUT
operation and expires 30 minutes after its creation. Once your upload is complete, we will try to match the receipt with existing expenses.
Refer to these docs on how to upload to this pre-signed S3 URL. We highly recommend using one of AWS SDKs if they're available for your language to upload these files.
receiptMatch 200 response
Bad request
Unauthorized
{- "receipt_name": "string"
}
{- "id": "string",
- "uri": "string"
}
The uri
will be a pre-signed S3 URL allowing you to upload the receipt securely. This URL can only be used for a PUT
operation and expires 30 minutes after its creation. Once your upload is complete, we will try to match the receipt with existing expenses.
Refer to these docs on how to upload to this pre-signed S3 URL. We highly recommend using one of AWS SDKs if they're available for your language to upload these files.
receiptUpload 200 response
Bad request
Unauthorized
Forbidden
Not Found
{- "receipt_name": "string"
}
{- "id": "string",
- "uri": "string"
}