List all staging invoices for the tenant.
Returns a paginated list of staging invoices that belong to the requesting tenant, with support for filtering by status, invoice number, service provider, and other fields.
Successful Response
| Link | string |
Corresponds to the Link specification.
Only 1 parameter for each link is valid -
So a first page of results might have a
An intermediary page of results might have a
|
Validation Error
{- "data": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "deleted_at": "2019-08-24T14:15:22Z",
- "references": [ ],
- "status": "CREATED",
- "archived": true,
- "rejected_at": "2019-08-24T14:15:22Z",
- "rejected_by_user_id": "string",
- "rejection_reason": "string",
- "invoice_source": "CARRIER_GENERATED",
- "external_id": "string",
- "invoiceable": {
- "id": "string",
- "type": "TRANSPORTATION_ORDER",
- "reference_number": "string",
- "total_amount": {
- "value": "string",
- "currency": "USD"
}, - "references": [ ],
- "mode": "string",
- "custom_data": { },
- "groups_external_ids": [
- "string"
], - "bol_number": "string"
}, - "documents": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "document_type": "OTHER",
- "description": "string",
- "invoiceable_document_id": "string",
- "record_of_truth": false,
}
], - "generated_by": "SERVICE_PROVIDER",
- "service_provider_name": "string",
- "total_amount": {
- "value": "string",
- "currency": "USD"
}, - "invoice_number": "string",
- "due_date": "2019-08-24",
- "invoice_date": "2019-08-24",
- "delivery_date": "2019-08-24",
- "freight_invoice_id": "string",
- "bol_number": "string",
- "notes": "string",
- "currency": "USD",
- "vendor_factoring_company_id": "string",
- "vendor_factoring_company_name": "string",
- "booking_party_tenant_id": "string",
- "service_provider_tenant_id": "string",
- "stops": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "company_name": "string",
- "location_name": "string",
- "references": [ ],
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "string",
- "country": "US",
- "reasons": [
- "LOAD"
], - "sequence_number": 0,
- "latitude": 0,
- "longitude": 0
}
], - "bill_to": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "name": "string",
- "contact_phone_number": "string",
- "contact_email": "user@example.com",
- "entity_type": "INDIVIDUAL",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "string",
- "country": "US"
}, - "remit_to": {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "name": "string",
- "contact_phone_number": "string",
- "contact_email": "user@example.com",
- "entity_type": "INDIVIDUAL",
- "line_1": "string",
- "line_2": "string",
- "line_3": "string",
- "locality": "string",
- "postal_code": "string",
- "region": "string",
- "country": "US"
}, - "charge_line_items": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "charge_code": "string",
- "description": "string",
- "category": "LINE_HAUL",
- "unit_amount": {
- "value": "string",
- "currency": "USD"
}, - "quantity": "string",
- "quantity_unit": "BARREL"
}
], - "product_line_items": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "description": "string",
- "quantity": "string",
- "packaging": "BAG",
- "weight": null,
- "dimensions": null,
- "freight_class": "50"
}
], - "payment_information": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "amount": "string",
- "currency": "USD",
- "date": "2019-08-24",
- "transaction_id": "string",
- "transaction_type": "CHECK"
}
]
}
], - "count": 0,
- "total_count": 0,
- "links": {
}
}