> ## Documentation Index > Fetch the complete documentation index at: https://docs.outseta.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve all invoices. > Admins and API key callers see every invoice. Non-admin users see only invoices belonging to the account they are the primary contact of. Pass excludeInvoiceUid as a query parameter to omit a specific invoice from the result set. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/billing/invoices openapi: 3.0.0 info: title: Outseta API description: >- Outseta REST API. See the [API overview](https://docs.outseta.com/api-reference/overview) for authentication, field selection, pagination, filtering, errors, rate limits and webhooks. version: v1 servers: - url: https://{subdomain}.outseta.com description: Your Outseta account variables: subdomain: default: your-subdomain description: >- Your Outseta account subdomain — the part before ".outseta.com" in your admin URL. security: [] paths: /api/v1/billing/invoices: get: tags: - Billing (v2) summary: Retrieve all invoices. description: >- Admins and API key callers see every invoice. Non-admin users see only invoices belonging to the account they are the primary contact of. Pass excludeInvoiceUid as a query parameter to omit a specific invoice from the result set. operationId: Invoice_GetAllInvoices parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: excludeInvoiceUid in: query description: The invoice Uid to omit from the result set. schema: type: string responses: '200': description: '' content: application/json: schema: type: object example: metadata: limit: 0 offset: 0 total: 0 items: - Uid: string _objectType: string Created: string Updated: string ActivityEventData: {} InvoiceDate: string PaymentReminderSentDate: string Number: 0 BillingInvoiceStatus: 1 Subscription: {} Amount: 0 AmountOutstanding: 0 InvoiceLineItems: [] IsUserGenerated: false StripeTaxCalculationId: string StripeTaxBehavior: string AmountCredit: 0 AmountDiscount: 0 AmountPaid: 0 AmountRefunded: 0 AmountSubtotal: 0 AmountTax: 0 AmountTaxRefunded: 0 IsTaxable: false HasPaymentGatewayTransactions: false StripePaymentTransactionIds: string StripeRefundTransactionIds: string StripeTaxRefundTransactionIds: string properties: metadata: $ref: '#/components/schemas/CollectionMetadata' items: type: array items: example: Uid: string _objectType: string Created: string Updated: string ActivityEventData: {} InvoiceDate: string PaymentReminderSentDate: string Number: 0 BillingInvoiceStatus: 1 Subscription: Uid: string _objectType: string Created: string Updated: string ActivityEventData: {} BillingRenewalTerm: 1 Account: {} Plan: {} Quantity: 0 StartDate: string EndDate: string ExpirationDate: string RenewalDate: string NewRequiredQuantity: 0 IsPlanUpgradeRequired: false PlanUpgradeRequiredMessage: string SubscriptionAddOns: [] DiscountCouponSubscriptions: [] DiscountCode: string DiscountCouponExpirationDate: string LatestInvoice: {} Rate: 0 Amount: 0 AmountOutstanding: 0 InvoiceLineItems: - Uid: string _objectType: string Created: string Updated: string ActivityEventData: {} StartDate: string EndDate: string Description: string UnitOfMeasure: string Quantity: 0 Rate: 0 Amount: 0 Tax: 0 Invoice: {} LineItemType: 1 EntityId: 0 StripeTaxReference: string StripeTaxLineItemId: string EntityUid: string IsUserGenerated: false StripeTaxCalculationId: string StripeTaxBehavior: string AmountCredit: 0 AmountDiscount: 0 AmountPaid: 0 AmountRefunded: 0 AmountSubtotal: 0 AmountTax: 0 AmountTaxRefunded: 0 IsTaxable: false HasPaymentGatewayTransactions: false StripePaymentTransactionIds: string StripeRefundTransactionIds: string StripeTaxRefundTransactionIds: string title: Invoice type: object properties: Uid: type: string maxLength: 10 nullable: true _objectType: type: string nullable: true Created: type: string readOnly: true format: date-time minLength: 1 Updated: type: string readOnly: true format: date-time minLength: 1 ActivityEventData: nullable: true InvoiceDate: type: string format: date-time PaymentReminderSentDate: type: string format: date-time nullable: true Number: type: integer format: int32 BillingInvoiceStatus: $ref: '#/components/schemas/BillingInvoiceStatus' Subscription: nullable: true oneOf: - title: Subscription type: object properties: Uid: type: string maxLength: 10 nullable: true _objectType: type: string nullable: true Created: type: string readOnly: true format: date-time minLength: 1 Updated: type: string readOnly: true format: date-time minLength: 1 ActivityEventData: nullable: true BillingRenewalTerm: maximum: 4 minimum: 1 oneOf: - $ref: '#/components/schemas/BillingRenewalTerm' Account: nullable: true oneOf: - type: object title: Account description: >- Related Account. Not included by default; request its fields with the fields parameter, e.g. fields=*,Subscription.Account.* Plan: nullable: true oneOf: - type: object title: Plan description: >- Related Plan. Not included by default; request its fields with the fields parameter, e.g. fields=*,Subscription.Plan.* Quantity: type: integer format: int32 nullable: true StartDate: type: string format: date-time EndDate: type: string format: date-time nullable: true ExpirationDate: type: string format: date-time nullable: true RenewalDate: type: string format: date-time nullable: true NewRequiredQuantity: type: integer format: int32 nullable: true IsPlanUpgradeRequired: type: boolean PlanUpgradeRequiredMessage: type: string nullable: true SubscriptionAddOns: type: array nullable: true items: type: object title: SubscriptionAddOn description: >- Related SubscriptionAddOn. Not included by default; request its fields with the fields parameter, e.g. fields=*,Subscription.SubscriptionAddOns.* DiscountCouponSubscriptions: type: array nullable: true items: type: object title: DiscountCouponSubscription description: >- Related DiscountCouponSubscription. Not included by default; request its fields with the fields parameter, e.g. fields=*,Subscription.DiscountCouponSubscriptions.* DiscountCode: type: string nullable: true DiscountCouponExpirationDate: type: string format: date-time nullable: true LatestInvoice: nullable: true oneOf: - type: object title: Invoice description: >- Related Invoice. Not included by default; request its fields with the fields parameter, e.g. fields=*,Subscription.LatestInvoice.* Rate: type: number format: decimal nullable: true required: - Id - Created - CreatedByUser_Id - Updated - UpdatedByUser_Id - Qcount_Id Amount: type: number format: decimal AmountOutstanding: type: number format: decimal InvoiceLineItems: type: array nullable: true items: title: InvoiceLineItem type: object properties: Uid: type: string maxLength: 10 nullable: true _objectType: type: string nullable: true Created: type: string readOnly: true format: date-time minLength: 1 Updated: type: string readOnly: true format: date-time minLength: 1 ActivityEventData: nullable: true StartDate: type: string format: date-time nullable: true EndDate: type: string format: date-time nullable: true Description: type: string nullable: true UnitOfMeasure: type: string maxLength: 250 nullable: true Quantity: type: number format: decimal nullable: true Rate: type: number format: decimal Amount: type: number format: decimal Tax: type: number format: decimal Invoice: nullable: true oneOf: - type: object title: Invoice description: >- Related Invoice. Not included by default; request its fields with the fields parameter, e.g. fields=*,InvoiceLineItems.Invoice.* LineItemType: nullable: true oneOf: - $ref: '#/components/schemas/LineItemType' EntityId: type: integer format: int64 nullable: true StripeTaxReference: type: string maxLength: 10 nullable: true StripeTaxLineItemId: type: string maxLength: 50 nullable: true EntityUid: type: string nullable: true required: - Id - Created - CreatedByUser_Id - Updated - UpdatedByUser_Id - Qcount_Id IsUserGenerated: type: boolean StripeTaxCalculationId: type: string maxLength: 50 nullable: true StripeTaxBehavior: type: string maxLength: 10 nullable: true AmountCredit: type: number format: decimal AmountDiscount: type: number format: decimal AmountPaid: type: number format: decimal AmountRefunded: type: number format: decimal AmountSubtotal: type: number format: decimal AmountTax: type: number format: decimal AmountTaxRefunded: type: number format: decimal IsTaxable: type: boolean HasPaymentGatewayTransactions: type: boolean StripePaymentTransactionIds: type: string nullable: true StripeRefundTransactionIds: type: string nullable: true StripeTaxRefundTransactionIds: type: string nullable: true required: - Id - Created - CreatedByUser_Id - Updated - UpdatedByUser_Id - Qcount_Id '401': description: Unauthorized security: - Bearer: [] - ApiKey: [] components: parameters: limit: name: limit in: query description: >- Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page. schema: type: integer default: 25 offset: name: offset in: query description: >- Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550). schema: type: integer default: 0 schemas: CollectionMetadata: type: object properties: limit: type: integer offset: type: integer total: type: integer BillingInvoiceStatus: type: integer description: >- `1` - Unpaid, `2` - Paid, `3` - Partial, `4` - Uncollected, `5` - Refunded, `6` - Uncollectible, `7` - Processing x-enumNames: - Unpaid - Paid - Partial - Uncollected - Refunded - Uncollectible - Processing x-enum-descriptions: - '' - '' - '' - '' - '' - '' - '' enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 BillingRenewalTerm: type: integer description: '`1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time' x-enumNames: - Monthly - Yearly - Quarterly - OneTime x-enum-descriptions: - '' - '' - '' - One Time enum: - 1 - 2 - 3 - 4 LineItemType: type: integer description: >- `1` - Plan, `2` - PlanSetupFee, `3` - AddOn, `4` - AddOnSetupFee, `5` - Discount, `6` - Credit, `7` - PlanCredit, `8` - AddOnCredit x-enumNames: - Plan - PlanSetupFee - AddOn - AddOnSetupFee - Discount - Credit - PlanCredit - AddOnCredit x-enum-descriptions: - '' - '' - '' - '' - '' - '' - '' - '' enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 securitySchemes: Bearer: type: http description: Enter your access token (OAuth / JWT). scheme: bearer bearerFormat: JWT ApiKey: type: apiKey description: 'Enter: Outseta {api_key}:{api_secret}' name: Authorization in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.