> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withorb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Schema

## Customer

An Orb [customer](/api-reference/customer/fetch-customer)
resource is synced to Salesforce as a custom object `OrbCustomer` with the following schema:

| Orb Field Name               | Salesforce Field Label    | Salesforce Field Name  | Datatype         |
| :--------------------------- | :------------------------ | :--------------------- | :--------------- |
| id                           | Orb ID                    | Id                     | Text             |
| additional\_emails           | Additional Emails         | AdditionalEmails       | Text Area (Long) |
| auto\_collection             | Auto-Collection           | AutoCollection         | Text             |
| balance                      | Balance                   | Balance                | Text             |
| billing\_address             | Billing Address           | BillingAddress         | Text Area (Long) |
| created\_at                  | Created At                | CreatedAt              | DateTime         |
| currency                     | Currency                  | Currency               | Text             |
| deleted\_at                  | Deleted At                | DeletedAt              | DateTime         |
| email                        | Email                     | Email                  | Email            |
| email\_delivery              | Email Delivery            | EmailDelivery          | Text             |
| exempt\_from\_automated\_tax | Exempt From Automated Tax | ExemptFromAutomatedTax | Text             |
| external\_customer\_id       | External Customer ID      | ExternalCustomerId     | Text             |
| metadata                     | Metadata                  | Metadata               | Text Area (Long) |
| name                         | Name                      | Name                   | Text             |
| payment\_provider            | Payment Provider          | PaymentProvider        | Text             |
| payment\_provider\_id        | Payment Provider ID       | PaymentProviderId      | Text             |
| portal\_url                  | Portal URL                | PortalUrl              | URL              |
| shipping\_address            | Shipping Address          | ShippingAddress        | Text Area (Long) |
| tax\_id                      | Tax ID                    | TaxId                  | Text             |
| timezone                     | Timezone                  | Timezone               | Text             |
| updated\_at                  | Updated At                | UpdatedAt              | DateTime         |

## Plan

An Orb [plan](/api-reference/plan/fetch-plan)
resource is synced to Salesforce as a custom object `OrbPlan` with the following schema:

| Orb Field Name         | Salesforce Field Label | Salesforce Field Name | Datatype         |
| :--------------------- | :--------------------- | :-------------------- | :--------------- |
| id                     | Orb ID                 | Id                    | Text             |
| created\_at            | Created At             | CreatedAt             | DateTime         |
| default\_invoice\_memo | Default Invoice Memo   | DefaultInvoiceMemo    | Text             |
| deleted\_at            | Deleted At             | DeletedAt             | DateTime         |
| description            | Description            | Description           | Text             |
| discount               | Discount               | Discount              | Text Area (Long) |
| external\_plan\_id     | External Plan ID       | ExternalPlanId        | Text             |
| invoicing\_currency    | Invoicing Currency     | InvoicingCurrency     | Text             |
| maximum                | Maximum                | Maximum               | Text Area (Long) |
| metadata               | Metadata               | Metadata              | Text Area (Long) |
| minimum                | Minimum                | Minimum               | Text Area (Long) |
| name                   | Name                   | Name                  | Text             |
| net\_terms             | Net Terms              | NetTerms              | Number           |
| product                | Product                | Product               | Text Area (Long) |
| status                 | Status                 | Status                | Text             |
| trial\_config          | Trial Config           | TrialConfig           | Text Area (Long) |
| updated\_at            | Updated At             | UpdatedAt             | DateTime         |
| version                | Version                | Version               | Number           |

## Subscription

An Orb [subscription](/api-reference/subscription/fetch-subscription)
resource is synced to Salesforce as a custom object `OrbSubscription` with the following schema:

| Orb Field Name                        | Salesforce Field Label            | Salesforce Field Name         | Datatype              |
| :------------------------------------ | :-------------------------------- | :---------------------------- | :-------------------- |
| id                                    | Orb ID                            | Id                            | Text                  |
| active\_plan\_phase\_order            | Active Plan Phase Order           | ActivePlanPhaseOrder          | Number                |
| auto\_collection                      | Auto-Collection                   | AutoCollection                | Text                  |
| billing\_cycle\_day                   | Billing Cycle Day                 | BillingCycleDay               | Number                |
| created\_at                           | Created At                        | CreatedAt                     | DateTime              |
| current\_billing\_period\_start\_date | Current Billing Period Start Date | CurrentBillingPeriodStartDate | DateTime              |
| current\_billing\_period\_end\_date   | Current Billing Period End Date   | CurrentBillingPeriodEndDate   | DateTime              |
| customer\_id                          | Customer                          | Customer                      | Lookup (Orb Customer) |
| default\_invoice\_memo                | Default Invoice Memo              | DefaultInvoiceMemo            | Text                  |
| deleted\_at                           | Deleted At                        | DeletedAt                     | DateTime              |
| description                           | Description                       | Description                   | Text                  |
| discount                              | Discount                          | Discount                      | Text Area (Long)      |
| end\_date                             | End Date                          | EndDate                       | DateTime              |
| invoicing\_threshold                  | Invoicing Threshold               | InvoicingThreshold            | Text                  |
| maximum                               | Maximum                           | Maximum                       | Text Area (Long)      |
| metadata                              | Metadata                          | Metadata                      | Text Area (Long)      |
| minimum                               | Minimum                           | Minimum                       | Text Area (Long)      |
| net\_terms                            | Net Terms                         | NetTerms                      | Number                |
| plan\_id                              | Plan                              | Plan                          | Lookup (Orb Plan)     |
| start\_date                           | Start Date                        | StartDate                     | DateTime              |
| status                                | Status                            | Status                        | Text                  |
| trial\_info                           | Trial Info                        | TrialInfo                     | Text Area (Long)      |
| updated\_at                           | Updated At                        | UpdatedAt                     | DateTime              |

## Subscription Version

An Orb [subscription version](/api-reference/subscription/fetch-subscription-schedule)
resource is synced to Salesforce as a custom object `OrbSubscriptionVersion` with the following schema:

| Orb Field Name            | Salesforce Field Label  | Salesforce Field Name | Datatype                  |
| :------------------------ | :---------------------- | :-------------------- | :------------------------ |
| id                        | Orb ID                  | Id                    | Text                      |
| customer\_id              | Customer                | Customer              | Lookup (Orb Customer)     |
| deleted\_at               | Deleted At              | DeletedAt             | DateTime                  |
| ended\_at                 | Ended At                | EndedAt               | DateTime                  |
| modified\_at              | Modified At             | ModifiedAt            | DateTime                  |
| plan\_id                  | Plan                    | Plan                  | Lookup (Orb Plan)         |
| start\_date               | Start Date              | StartDate             | DateTime                  |
| subscription\_id          | Subscription            | Subscription          | Lookup (Orb Subscription) |
| subscription\_ended\_at   | Subscription Ended At   | SubscriptionEndedAt   | DateTime                  |
| subscription\_start\_date | Subscription Start Date | SubscriptionStartDate | DateTime                  |
| updated\_at               | Updated At              | UpdatedAt             | DateTime                  |

## Invoice

An Orb [invoice](/api-reference/invoice/fetch-invoice)
resource is synced to Salesforce as a custom object `OrbInvoice` with the following schema:

| Orb Field Name   | Salesforce Field Label | Salesforce Field Name | Datatype                  |
| :--------------- | :--------------------- | :-------------------- | :------------------------ |
| id               | Orb ID                 | Id                    | Text                      |
| created\_at      | Created At             | CreatedAt             | DateTime                  |
| customer\_id     | Customer               | Customer              | Lookup (Orb Customer)     |
| currency         | Currency               | Currency              | Text                      |
| deleted\_at      | Deleted At             | DeletedAt             | DateTime                  |
| due\_date        | Due Date               | DueDate               | DateTime                  |
| invoice\_number  | Invoice Number         | InvoiceNumber         | Text                      |
| invoice\_type    | Invoice Type           | InvoiceType           | Text                      |
| issued\_at       | Issued At              | IssuedAt              | DateTime                  |
| memo             | Memo                   | Memo                  | Text                      |
| paid\_at         | Paid At                | PaidAt                | DateTime                  |
| plan\_id         | Plan                   | Plan                  | Lookup (Orb Plan)         |
| status           | Status                 | Status                | Text                      |
| subscription\_id | Subscription           | Subscription          | Lookup (Orb Subscription) |
| total            | Total                  | Total                 | Number                    |
| updated\_at      | Updated At             | UpdatedAt             | DateTime                  |
| voided\_at       | Voided At              | VoidedAt              | DateTime                  |

## Invoice Line Item Billing

An Orb [invoice line item](/api-reference/invoice/fetch-invoice#response-line-items)
resource is synced to Salesforce as a custom object `OrbInvoiceLineItemBilling` with the following schema:

| Orb Field Name              | Salesforce Field Label    | Salesforce Field Name   | Datatype                  |
| :-------------------------- | :------------------------ | :---------------------- | :------------------------ |
| id                          | Orb ID                    | Id                      | Text                      |
| adjusted\_subtotal          | Adjusted Subtotal         | AdjustedSubtotal        | Number                    |
| amount                      | Amount                    | Amount                  | Number                    |
| billable\_metric\_id        | Orb Billable Metric ID    | BillableMetricId        | Text                      |
| conversion\_rate            | Conversion Rate           | ConversionRate          | Number                    |
| correction\_amount          | Correction Amount         | CorrectionAmount        | Number                    |
| credits\_applied            | Credits Applied           | CreditsApplied          | Number                    |
| created\_at                 | Created At                | CreatedAt               | DateTime                  |
| customer\_id                | Customer                  | Customer                | Lookup (Orb Customer)     |
| deleted\_at                 | Deleted At                | DeletedAt               | DateTime                  |
| invoice\_id                 | Invoice                   | Invoice                 | Lookup (Orb Invoice)      |
| invoice\_line\_item\_id     | Orb Invoice Line Item ID  | InvoiceLineItemId       | Text                      |
| item\_id                    | Orb Item ID               | ItemId                  | Text                      |
| invoicing\_currency         | Invoicing Currency        | InvoicingCurrency       | Text                      |
| is\_partial\_invoice        | Is Partial Invoice        | IsPartialInvoiceID      | Text                      |
| name                        | Name                      | Name                    | Text                      |
| price\_id                   | Orb Price ID              | PriceId                 | Text                      |
| partially\_invoiced\_amount | Partially Invoiced Amount | PartiallyInvoicedAmount | Number                    |
| plan\_id                    | Plan                      | Plan                    | Lookup (Orb Plan)         |
| pricing\_currency           | Pricing Currency          | PricingCurrency         | Text                      |
| quantity                    | Quantity                  | Quantity                | Number                    |
| subscription\_id            | Subscription              | Subscription            | Lookup (Orb Subscription) |
| subtotal                    | Subtotal                  | Subtotal                | Number                    |
| tax\_amount                 | Tax Amount                | TaxAmount               | Number                    |
| timeframe\_end              | Timeframe End             | TimeframeEnd            | DateTime                  |
| timeframe\_start            | Timeframe Start           | TimeframeStart          | DateTime                  |
| updated\_at                 | Updated At                | UpdatedAt               | DateTime                  |
| voided\_at                  | Voided At                 | VoidedAt                | DateTime                  |

## Daily Line Item Revenue

An Orb [daily line item revenue](/data-exports/resource-types#daily-line-item-revenue)
resource is synced to Salesforce as a custom object `OrbDailyLineItemRevenue` with the following schema:

| Orb Field Name              | Salesforce Field Label    | Salesforce Field Name   | Datatype                  |
| :-------------------------- | :------------------------ | :---------------------- | :------------------------ |
| id                          | Orb ID                    | Id                      | Text                      |
| adjusted\_subtotal          | Adjusted Subtotal         | AdjustedSubtotal        | Number                    |
| amount                      | Amount                    | Amount                  | Number                    |
| billable\_metric\_id        | Orb Billable Metric ID    | BillableMetricId        | Text                      |
| conversion\_rate            | Conversion Rate           | ConversionRate          | Number                    |
| correction\_amount          | Correction Amount         | CorrectionAmount        | Number                    |
| credits\_applied            | Credits Applied           | CreditsApplied          | Number                    |
| created\_at                 | Created At                | CreatedAt               | DateTime                  |
| customer\_id                | Customer                  | Customer                | Lookup (Orb Customer)     |
| deleted\_at                 | Deleted At                | DeletedAt               | DateTime                  |
| invoice\_id                 | Invoice                   | Invoice                 | Lookup (Orb Invoice)      |
| invoice\_line\_item\_id     | Orb Invoice Line Item ID  | InvoiceLineItemId       | Text                      |
| item\_id                    | Orb Item ID               | ItemId                  | Text                      |
| invoicing\_currency         | Invoicing Currency        | InvoicingCurrency       | Text                      |
| is\_partial\_invoice        | Is Partial Invoice        | IsPartialInvoiceId      | Text                      |
| name                        | Name                      | Name                    | Text                      |
| price\_id                   | Orb Price ID              | PriceId                 | Text                      |
| partially\_invoiced\_amount | Partially Invoiced Amount | PartiallyInvoicedAmount | Number                    |
| plan\_id                    | Plan                      | Plan                    | Lookup (Orb Plan)         |
| pricing\_currency           | Pricing Currency          | PricingCurrency         | Text                      |
| quantity                    | Quantity                  | Quantity                | Number                    |
| reverted\_at                | Reverted At               | RevertedAt              | DateTime                  |
| subscription\_id            | Subscription              | Subscription            | Lookup (Orb Subscription) |
| subtotal                    | Subtotal                  | Subtotal                | Number                    |
| timeframe\_end              | Timeframe End             | TimeframeEnd            | DateTime                  |
| timeframe\_start            | Timeframe Start           | TimeframeStart          | DateTime                  |
| updated\_at                 | Updated At                | UpdatedAt               | DateTime                  |

## Committed Ledger Entry

An Orb [committed ledger entry](/api-reference/credit/fetch-customer-credits-ledger#fetch-customer-credits-ledger)
resource is synced to Salesforce as a custom object `OrbCommittedLedgerEntry` with the following schema:

| Orb Field Name           | Salesforce Field Label | Salesforce Field Name | Datatype              |
| :----------------------- | :--------------------- | :-------------------- | :-------------------- |
| id                       | Orb ID                 | Id                    | Text                  |
| adjusted\_subtotal       | Adjusted Subtotal      | AdjustedSubtotal      | Number                |
| amount                   | Amount                 | Amount                | Number                |
| created\_at              | Created At             | CreatedAt             | DateTime              |
| credit\_block            | Credit Block           | CreditBlock           | Text Area (Long)      |
| currency                 | Currency               | Currency              | Text                  |
| customer\_id             | Customer               | Customer              | Lookup (Orb Customer) |
| deleted\_at              | Deleted At             | DeletedAt             | DateTime              |
| description              | Description            | Description           | Text                  |
| ending\_balance          | Ending Balance         | EndingBalance         | Text                  |
| entry\_status            | Entry Status           | EntryStatus           | Text                  |
| entry\_type              | Entry Type             | EntryType             | Text                  |
| event\_id                | Orb Event ID           | EventId               | Text                  |
| invoice\_id              | Invoice                | Invoice               | Lookup (Orb Invoice)  |
| ledger\_sequence\_number | Ledger Sequence Number | LedgerSequenceNumber  | Number                |
| metadata                 | Metadata               | Metadata              | Text Area (Long)      |
| name                     | Name                   | Name                  | Text                  |
| new\_block\_expiry\_date | New Block Expiry Date  | NewBlockExpiryDate    | DateTime              |
| price\_id                | Orb Price ID           | PriceId               | Text                  |
| reverted\_at             | Reverted At            | RevertedAt            | DateTime              |
| starting\_balance        | Starting Balance       | StartingBalance       | Text                  |
| updated\_at              | Updated At             | UpdatedAt             | DateTime              |
| void\_amount             | Void Amount            | VoidAmount            | Text                  |
| void\_reason             | Void Reason            | VoidReason            | Text                  |
