Appearance
InvoiceState
Type: Object
An invoice document for billing a customer
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| attachments | [InvoiceFileAttachment!]! | Document attachments. Requires file:list permission. | ||
| billingAddressId | AddressID | Billing address ID | ||
| contactId | ContactID | Contact person ID | ||
| createdAt | String! | Creation timestamp (ISO8601) | ||
| createdByUser | UserState | User who created this invoice. Requires user:read permission. | ||
| createdByUserId | UserID | ID of the user who created this invoice | ||
| creditedInvoiceId | InvoiceID | ID of the invoice this credit note applies to | ||
| currency | CurrencyISO! | Currency code (e.g. EUR, USD) | ||
| customer | CustomerState | Customer for this invoice. Requires customer:read permission. | ||
| customerId | CustomerID! | Customer ID | ||
| dueDate | ISO8601 | Due date (ISO8601) | ||
| id | InvoiceID! | Unique identifier | ||
| internalNotes | String | Internal notes not visible to the customer | ||
| invoiceLines | [InvoiceLineState!]! | Line items for this invoice. Requires invoice:read permission. | ||
| invoiceNumber | String! | Invoice number | ||
| issueDate | ISO8601! | Issue date (ISO8601) | ||
| kind | InvoiceKind! | Type of invoice document | ||
| notes | String | Notes visible to the customer | ||
| order | OrderState | Source order. Requires order:read permission. | ||
| orderId | OrderID | Associated order ID | ||
| paidAmount | Float! | Amount paid so far | ||
| paidAt | ISO8601 | Payment date (ISO8601) | ||
| paymentMethod | String | Payment method used | ||
| paymentReference | String | Payment reference or transaction ID | ||
| paymentTerms | String | Payment terms (e.g. Net 30) | ||
| status | InvoiceStatus! | Invoice status | ||
| subtotalAmount | Float! | Subtotal amount before tax | ||
| taxAmount | Float! | Tax amount | ||
| taxRate | Float | Tax rate percentage | ||
| totalAmount | Float! | Total amount including tax | ||
| updatedAt | String! | Last update timestamp (ISO8601) |