Corrigo: Invoice schemas
1 Corrigo schema with complete fields and constraints.
← Invoice operations · All schemas
Create invoice — request body — body entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | integer | Optional | Format: int32 |
isNew | boolean | Optional | Read only: true |
limitMultipleEntitiesNumberBehaviour | boolean | Optional | |
performDeletion | boolean | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | JSON | Each item | |
properties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo PropertyTreeNode. |
properties (anyOf 1)[] (anyOf 2) | null | Alternative | |
properties (anyOf 2) | null | Alternative | |
concurrencyId | integer | Optional | Format: int32 |
amtBase | JSON | Optional | |
amtBase (anyOf 1) | object | Alternative | A Corrigo MoneyValue. |
amtBase (anyOf 2) | null | Alternative | |
amtTax | JSON | Optional | |
amtTax (anyOf 1) | object | Alternative | A Corrigo MoneyValue. |
amtTax (anyOf 2) | null | Alternative | |
amtTotal | JSON | Optional | |
amtTotal (anyOf 1) | object | Alternative | A Corrigo MoneyValue. |
amtTotal (anyOf 2) | null | Alternative | |
billingContact | JSON | Optional | |
billingContact (anyOf 1) | object | Alternative | A Corrigo Contact. |
billingContact (anyOf 2) | null | Alternative | |
canEarlyPayment | boolean | Optional | |
canExpedite | boolean | Optional | |
comments | JSON | Optional | |
comments (anyOf 1) | string | Alternative | |
comments (anyOf 2) | null | Alternative | |
currencyTypeId | Model | Optional | Expand Create rcs action — request body — body entity money Id |
draftProcessStepId | string | Optional | One of: NA, Pending, ReadyToPost, FailedTax, FailedPost, Disputed, Recalled Format: int32 |
dtDue | JSON | Optional | |
dtDue (anyOf 1) | string | Alternative | Format: date-time |
dtDue (anyOf 2) | null | Alternative | |
dtPosted | JSON | Optional | |
dtPosted (anyOf 1) | string | Alternative | Format: date-time |
dtPosted (anyOf 2) | null | Alternative | |
extNumber | JSON | Optional | |
extNumber (anyOf 1) | string | Alternative | |
extNumber (anyOf 2) | null | Alternative | |
glAccount | JSON | Optional | |
glAccount (anyOf 1) | string | Alternative | |
glAccount (anyOf 2) | null | Alternative | |
group | JSON | Optional | |
group (anyOf 1) | object | Alternative | A Corrigo BillingAccount. |
group (anyOf 2) | null | Alternative | |
isAvailableExpeditedInvoiceFlags | boolean | Optional | |
isManuallySent | boolean | Optional | |
isMultiline | boolean | Optional | |
isTaxDirty | boolean | Optional | |
lineItems | JSON | Optional | |
lineItems (anyOf 1) | array | Alternative | |
lineItems (anyOf 1)[] | JSON | Each item | |
lineItems (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo InvoiceLine. |
lineItems (anyOf 1)[] (anyOf 2) | null | Alternative | |
lineItems (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | |
number (anyOf 2) | null | Alternative | |
period | JSON | Optional | |
period (anyOf 1) | object | Alternative | A Corrigo TimePeriod. |
period (anyOf 2) | null | Alternative | |
poNumber | JSON | Optional | |
poNumber (anyOf 1) | string | Alternative | |
poNumber (anyOf 2) | null | Alternative | |
state | string | Optional | One of: Draft, Posted, Credit, CreditUsed, Paid, PaidInFull, Approved, Exported Format: int32 |
taxTransactionId | JSON | Optional | |
taxTransactionId (anyOf 1) | string | Alternative | |
taxTransactionId (anyOf 2) | null | Alternative | |
timeSetId | integer | Optional | Format: int32 |
Referenced models: Create rcs action — request body — body entity money Id