BillingInvoices
Get Many Invoices
Get multiple invoices with filtering and pagination
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20search?string
Search term to filter invoices by name
Default
""order_by?string
Field to order results by
Default
"created_at"Value in
- "created_at"
- "updated_at"
- "name"
- "total_amount"
- "start_date"
- "end_date"
- "due_date"
order?string
Sort order - "asc" or "desc"
Value in
- "asc"
- "desc"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/invoices"{ "data": [ { "merchant_team_name": "string", "merchant_team_id": "string", "fulfiller_team_name": "string", "fulfiller_team_id": "string", "fulfillment_delegation_id": "string", "error_message": "string", "started_calculation_at": "2019-08-24T14:15:22Z", "credit_amount": 0.1, "subscription_amount": 0.1, "minimum_amount": 0.1, "subtotal_amount": 0.1, "total_amount": 0.1, "status": "PAID", "due_date": "2019-08-24T14:15:22Z", "end_date": "2019-08-24T14:15:22Z", "start_date": "2019-08-24T14:15:22Z", "currency": "string", "invoice_number": "string", "name": "string", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "id": "string" } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}